RingBuffer.h

/*
  Copyright (c) 2014 Arduino.  All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  See the GNU Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef _RING_BUFFER_
#define _RING_BUFFER_

#include <stdint.h>

// Define constants and variables for buffering incoming serial data.  We're
// using a ring buffer (I think), in which head is the index of the location
// to which to write the next incoming character and tail is the index of the
// location from which to read.

#define RINGBUFFER_HAS_ADDITIONAL_STORAGE_API

#ifdef RINGBUFFER_FORCE_SMALL_SIZE
typedef uint8_t rb_index_type;
#else
typedef unsigned int rb_index_type;
#endif

class RingBuffer
{
    public:
    RingBuffer( rb_index_type size ) ;
    void store_char( uint8_t c ) ;
    void clear();
    int read_char();
    int available();
    int peek();
    bool isFull();
    void addStorage(uint8_t* _buffer, rb_index_type _size) {
        additionalSize = _size;
        additionalBuffer = _buffer;
    };

    private:
    rb_index_type nextIndex(rb_index_type index);
    uint8_t* additionalBuffer;
    int additionalSize = 0;
    rb_index_type size;
    uint8_t* _aucBuffer;
    volatile rb_index_type _iHead ;
    volatile rb_index_type _iTail ;
};

#endif /* _RING_BUFFER_ */