Skip to content

Allow push to front of the buffer #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow push to front of the buffer #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 114 additions & 0 deletions src/RingBuf.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,14 @@ class RingBuf {
bool push(const ET inElement) __attribute__((noinline));
/* Push a data at the end of the buffer. Copy it from its pointer */
bool push(const ET *const inElement) __attribute__((noinline));
/* Push a data at the beginning (head) of the buffer */
bool pushFront(const ET inElement) __attribute__((noinline));
/* Push a data at the beginning (head) of the buffer. Copy it from its pointer */
bool pushFront(const ET *const inElement) __attribute__((noinline));
/* Push a data at the beginning and overwrite the older data at the end if full */
bool pushFrontOverwrite(const ET inElement) __attribute__((noinline));
/* Push a data at the beginning and overwrite the older data at the end if full. Copy it from its pointer */
bool pushFrontOverwrite(const ET *const inElement) __attribute__((noinline));
/* Push a data at the end of the buffer with interrupts disabled */
bool lockedPush(const ET inElement);
/* Push a data at the end of the buffer with interrupts disabled. Copy it from
Expand All @@ -125,6 +133,14 @@ class RingBuf {
/* Push a data in the buffer and overwrite the older data if any with
* interrupts disabled. Copy it from its pointer */
bool lockedPushOverwrite(const ET *const inElement);
/* Push a data at the beginning with interrupts disabled */
bool lockedPushFront(const ET inElement);
/* Push a data at the beginning with interrupts disabled. Copy it from its pointer */
bool lockedPushFront(const ET *const inElement);
/* Push a data at the beginning and overwrite if full with interrupts disabled */
bool lockedPushFrontOverwrite(const ET inElement);
/* Push a data at the beginning and overwrite if full with interrupts disabled. Copy it from its pointer */
bool lockedPushFrontOverwrite(const ET *const inElement);
/* Pop the data at the beginning of the buffer */
bool pop(ET &outElement) __attribute__((noinline));
/* Pop the data at the beginning of the buffer with interrupt disabled */
Expand Down Expand Up @@ -191,6 +207,72 @@ bool RingBuf<ET, S, IT, BT>::push(const ET *const inElement) {
return true;
}

/*
* Push at the beginning (head) of the buffer.
* If the buffer is full, returns false and does not modify the buffer.
*/
template <typename ET, size_t S, typename IT, typename BT>
bool RingBuf<ET, S, IT, BT>::pushFront(const ET inElement) {
if (isFull())
return false;
if (mReadIndex == 0)
mReadIndex = S - 1;
else
mReadIndex--;
mBuffer[mReadIndex] = inElement;
mSize++;
return true;
}

template <typename ET, size_t S, typename IT, typename BT>
bool RingBuf<ET, S, IT, BT>::pushFront(const ET *const inElement) {
if (isFull())
return false;
if (mReadIndex == 0)
mReadIndex = S - 1;
else
mReadIndex--;
mBuffer[mReadIndex] = *inElement;
mSize++;
return true;
}

/*
* Push at the beginning (head) of the buffer, overwriting the oldest tail
* element if the buffer is full. Mirrors pushOverwrite() semantics:
* returns false when an overwrite happened, true otherwise.
*/
template <typename ET, size_t S, typename IT, typename BT>
bool RingBuf<ET, S, IT, BT>::pushFrontOverwrite(const ET inElement) {
if (mReadIndex == 0)
mReadIndex = S - 1;
else
mReadIndex--;
mBuffer[mReadIndex] = inElement;
if (isFull()) {
// size stays S; we've effectively dropped the former last element
return false;
} else {
mSize++;
return true;
}
}

template <typename ET, size_t S, typename IT, typename BT>
bool RingBuf<ET, S, IT, BT>::pushFrontOverwrite(const ET *const inElement) {
if (mReadIndex == 0)
mReadIndex = S - 1;
else
mReadIndex--;
mBuffer[mReadIndex] = *inElement;
if (isFull()) {
return false;
} else {
mSize++;
return true;
}
}

template <typename ET, size_t S, typename IT, typename BT>
bool RingBuf<ET, S, IT, BT>::pushOverwrite(const ET inElement) {
mBuffer[writeIndex()] = inElement;
Expand Down Expand Up @@ -231,6 +313,38 @@ bool RingBuf<ET, S, IT, BT>::lockedPush(const ET *const inElement) {
return result;
}

template <typename ET, size_t S, typename IT, typename BT>
bool RingBuf<ET, S, IT, BT>::lockedPushFront(const ET inElement) {
noInterrupts();
bool result = pushFront(inElement);
interrupts();
return result;
}

template <typename ET, size_t S, typename IT, typename BT>
bool RingBuf<ET, S, IT, BT>::lockedPushFront(const ET *const inElement) {
noInterrupts();
bool result = pushFront(inElement);
interrupts();
return result;
}

template <typename ET, size_t S, typename IT, typename BT>
bool RingBuf<ET, S, IT, BT>::lockedPushFrontOverwrite(const ET inElement) {
noInterrupts();
bool result = pushFrontOverwrite(inElement);
interrupts();
return result;
}

template <typename ET, size_t S, typename IT, typename BT>
bool RingBuf<ET, S, IT, BT>::lockedPushFrontOverwrite(const ET *const inElement) {
noInterrupts();
bool result = pushFrontOverwrite(inElement);
interrupts();
return result;
}

template <typename ET, size_t S, typename IT, typename BT>
bool RingBuf<ET, S, IT, BT>::lockedPushOverwrite(const ET inElement) {
noInterrupts();
Expand Down