Skip to content

Instantly share code, notes, and snippets.

@konsgn
Created January 26, 2018 15:31
Show Gist options
  • Save konsgn/fcd6f0e84c25fc5895e461870caab3da to your computer and use it in GitHub Desktop.
Save konsgn/fcd6f0e84c25fc5895e461870caab3da to your computer and use it in GitHub Desktop.
/*
CircularBuffer.h - circular buffer library for Arduino.
Copyright (c) 2009 Hiroki Yagita.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef CIRCULARROLLINGBUFFER_h
#define CIRCULARROLLINGBUFFER_h
#include <inttypes.h>
template <typename T, uint16_t Size>
class CircularBuffer {
public:
enum {
Empty = 0,
Half = Size / 2,
Full = Size,
};
CircularBuffer() :
wp_(buf_), rp_(buf_), tail_(buf_+Size), remain_(0) {}
~CircularBuffer() {}
void push(T value) {
*wp_++ = value;
if(remain_<Size)remain_++;
else {rp_++;if (rp_ == tail_) rp_ = buf_;}
if (wp_ == tail_) wp_ = buf_;
}
T pop() {
T result = *rp_++;
if(remain_)remain_--;
else {wp_++;if (wp_ == tail_) wp_ = buf_;}
if (rp_ == tail_) rp_ = buf_;
return result;
}
int remain() const {
return remain_;
}
void list(T *list){
T *pt= rp_;
for(uint16_t i=0;i<Size;i++){
list[i]=*pt++;
if (pt == tail_) pt = buf_;
}
return;
}
private:
T buf_[Size];
T *wp_;
T *rp_;
T *tail_;
uint16_t remain_;
};
#endif
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment