fix: CircularBuffer breaks when popping from an empty buffer #125
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GabeMillikan
added
the
Bug
dchansen06
added
Enhancement
XuChe777
approved these changes
Nov 14, 2025
Contributor
XuChe777
left a comment
XuChe777
left a comment
There was a problem hiding this comment.
Good Catch! Looks good to me.
dchansen06
pushed a commit
that referenced
this pull request
Dec 4, 2025
Right now, this psuedocode outputs `false`: ```c buffer = GR_CircularBuffer_Create(5); GR_CircularBuffer_Pop(buffer_ptr); empty = GR_CircularBuffer_IsEmpty(buffer_ptr) print(empty) // outputs false ``` i.e., it thinks that an empty buffer is not empty. This is because `Pop()` always increments `head++` even if there is nothing to pop. I added a simple check to fix this, as well as a test to prevent regression. I verified that the test fails without my addition, and all tests succeed with it. --------- Co-authored-by: Thomas Xu <thomas.xu.7@outlook.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Right now, this psuedocode outputs
false:i.e., it thinks that an empty buffer is not empty. This is because
Pop()always incrementshead++even if there is nothing to pop.I added a simple check to fix this, as well as a test to prevent regression. I verified that the test fails without my addition, and all tests succeed with it.