Created C++ wrapper class and changed void* to const void*

Author: wizard97

README.md

@@ -29,6 +29,25 @@ Feel free to improve this library. Fork it, make your changes, then submit a pul
 
 ## API
 
+## But I like C++'s object syntax... :(
+
+Fine. I reluctantly wrapped the C in a C++ class called `RingBufC`. All the methods are the same, except you no longer have to pass the this/self pointer. You can use either.
+
+```
+// If you want to use C...
+
+RingBuf *buf = RingBuf_new(sizeof(char*), 100);
+buf->add(buf, "I like C.");
+```
+
+```
+// If you want to use the C++ wrapper
+
+RingBufC buf(sizeof(char*), 100);
+buf.add("C++ has pretty object.method() syntax");
+```
+
+
 
 ### Constructor
 

RingBuf.c

@@ -82,7 +82,7 @@ int RingBufIncrStart(RingBuf *self)
 /////// PUBLIC METHODS //////////
 
 // Add an object struct to RingBuf
-int RingBufAdd(RingBuf *self, void *object)
+int RingBufAdd(RingBuf *self, const void *object)
 {
   int index;
   // Perform all atomic opertaions

RingBuf.h

@@ -9,6 +9,12 @@
 
 #include "Arduino.h"
 
+#ifndef __cplusplus
+#ifndef bool
+#define bool uint8_t
+#endif
+#endif
+
 typedef struct RingBuf RingBuf;
 
 typedef struct RingBuf
@@ -31,7 +37,7 @@ typedef struct RingBuf
   // Returns number of elemnts in buffer
   unsigned int (*numElements)(RingBuf*);
   // Add Event, Returns index where added in buffer, -1 on full buffer
-  int (*add) (RingBuf*, void*);
+  int (*add) (RingBuf*, const void*);
   // Returns pointer to nth element, NULL when nth element is empty
   void *(*peek) (RingBuf*, unsigned int);
   // Removes element and copies it to location pointed to by void *
@@ -51,7 +57,7 @@ int RingBuf_delete(RingBuf *self);
 int RingBufNextEndIndex(RingBuf *self);
 int RingBufIncrEnd(RingBuf *self);
 int RingBufIncrStart(RingBuf *self);
-int RingBufAdd(RingBuf *self, void *object);
+int RingBufAdd(RingBuf *self, const void *object);
 void *RingBufPeek(RingBuf *self, unsigned int num);
 void *RingBufPull(RingBuf *self, void *object);
 bool RingBufIsFull(RingBuf *self);
@@ -62,4 +68,31 @@ unsigned int RingBufNumElements(RingBuf *self);
 }
 #endif
 
+
+// For those of you who cant live without pretty C++ objects....
+#ifdef __cplusplus
+class RingBufC
+{
+
+public:
+    RingBufC(int size, int len) { buf = RingBuf_new(size, len); }
+    ~RingBufC() { RingBuf_delete(buf); }
+
+    bool isFull() { return RingBufIsFull(buf); }
+    bool isEmpty() { return RingBufIsEmpty(buf); }
+    unsigned int numElements() { return RingBufNumElements(buf); }
+
+    unsigned int add(const void *object) { return RingBufAdd(buf, object); }
+    void *peek(unsigned int num) { return RingBufPeek(buf, num); }
+    void *pull(void *object) { return RingBufPull(buf, object); }
+
+    // Use this to check if memory allocation failed
+    bool allocFailed() { return !buf; }
+
+private:
+    RingBuf *buf;
+};
+#endif
+
+
 #endif

keywords.txt

@@ -1,11 +1,13 @@
 RingBuf		KEYWORD1
+RingBufC	KEYWORD1
 
 RingBuf_new	KEYWORD2
-RingBuf_delete		KEYWORD2
+RingBuf_delete	KEYWORD2
 
-isFull		KEYWORD2
-isEmpty		KEYWORD2
+isFull	KEYWORD2
+isEmpty	KEYWORD2
 numElements	KEYWORD2
 add	KEYWORD2
 peek	KEYWORD2
-pull	KEYWORD2
+pull	KEYWORD2
+allocFailed	KEYWORD2