v1.6: added getRemainingCount inline & eaxmple sketch

Author: SMFSW

Clean.bat

@@ -28,12 +28,14 @@ This library was designed for Arduino, yet may be compiled without change with g
   - `q.isEmpty()`: `true` if full, `false` otherwise
   - `q.isFull()`: `true` if empty, `false` otherwise
   - `q.sizeOf()`: queue size in bytes (returns 0 in case queue allocation failed)
-  - `q.getCount()` or `q.nbRecs()`: number of records in the queue
+  - `q.getCount()` or `q.nbRecs()`: number of records stored in the queue
+  - `q.getRemainingCount()`: number of records left in the queue
   - `q.clean()` or `q.flush()`: remove all items in the queue
 
 ## Examples included
 
 - [SimpleQueue.ino](examples/SimpleQueue/SimpleQueue.ino): Simple queue example (both LIFO FIFO implementations can be tested)
+- [PointersQueue.ino](examples/PointersQueue/PointersQueue.ino): Queue of string pointers for string processing
 - [RolloverTest.ino](examples/RolloverTest/RolloverTest.ino): Simple test to test queue rollover (for lib testing purposes mainly)
 - [LibTst.ino](examples/LibTst/LibTst.ino): flexible test (for lib testing purposes mainly)
 

README.md

@@ -10,13 +10,15 @@ Feel free to share your thoughts @ [email protected] about:
 
 ** Actual:
 
-v1.6	21 May 2018:
+v1.6	26 May 2018:
 - Constructor does not check anymore if class instance is already allocated (as it supposedly isn't)
+- Added getRemainingCount inline returning how much records are left in the queue
 - Added sizeOf inline to check full queue size in byte (may also be used to check if queue has been allocated properly)
 - Adding support for unit tests and doxygen documentation generation with Travis CI (using travis-ci-arduino from adafruit before custom bash files needed)
 - Travis bash scripts found in SMFSW travis-ci-arduino forked repository
 - Removed Doxygen anchor with version in source headers
 - Updated README.md
+- Added more example sketches & updated LibTst example using latest inlines additions
 
 v1.5	14 March 2018:
 - Added isInitialized inline to be able to check after init if queue has been properly allocated

ReleaseNotes.md

@@ -6,7 +6,7 @@
   This example code is in the public domain.
 
   created 22 March 2017
-  modified 21 May 2018
+  modified 26 May 2018
   by SMFSW
  */
 
@@ -57,6 +57,8 @@ void loop() {
 		Serial.print(rec.entry2, HEX);
 		Serial.print(" Count ");
 		Serial.print(q.getCount());
+		Serial.print(" Remaining ");
+		Serial.print(q.getRemainingCount());
 		Serial.print(" Full? ");
 		Serial.println(q.isFull());
 	}

examples/LibTst/LibTst.ino

@@ -0,0 +1,52 @@
+/*
+  Pointers Queue
+  Pointers queue demonstration
+
+  This example code is in the public domain.
+
+  created 25 May 2018
+  by SMFSW
+ */
+
+#include <cppQueue.h>
+
+
+const char * str[3] = {
+	">>> This example demonstrates how to strip quotes",
+	">>> from strings using a queue of pointers",
+	">>> to access methods from the string class."
+};
+
+Queue	q(sizeof(String *), 3, FIFO);	// Instantiate queue
+
+
+// the setup function runs once when you press reset or power the board
+void setup() {
+	Serial.begin(115200);
+}
+
+// the loop function runs over and over again forever
+void loop() {
+	String strings[3];
+	String * pStr;
+	
+	Serial.println("Original text:");
+	for (unsigned int i = 0 ; i < 3 ; i++)
+	{
+		strings[i] = str[i];
+		pStr = &strings[i];
+		q.push(&pStr);
+		Serial.println(strings[i]);
+	}
+	
+	Serial.println("");
+	Serial.println("Processed text:");
+	for (unsigned int i = 0 ; i < 3 ; i++)
+	{
+		q.pop(&pStr);
+		pStr->remove(0, 4);
+		Serial.println(*pStr);
+	}
+	
+	while(1);
+}

examples/PointersQueue/PointersQueue.ino

@@ -20,6 +20,7 @@ isFull	KEYWORD2
 sizeOf	KEYWORD2
 getCount	KEYWORD2
 nbRecs	KEYWORD2
+getRemainingCount	KEYWORD2
 push	KEYWORD2
 pop	KEYWORD2
 pull	KEYWORD2

keywords.txt

@@ -1,6 +1,6 @@
 /*!\file cppQueue.cpp
 ** \author SMFSW
-** \date 2018/05/21
+** \date 2018/05/26
 ** \copyright BSD 3-Clause License (c) 2017-2018, SMFSW
 ** \brief Queue handling library (designed on Arduino)
 ** \details Queue handling library (designed on Arduino)

src/cppQueue.cpp

@@ -1,6 +1,6 @@
 /*!\file cppQueue.h
 ** \author SMFSW
-** \date 2018/05/21
+** \date 2018/05/26
 ** \copyright BSD 3-Clause License (c) 2017-2018, SMFSW
 ** \brief Queue handling library (designed on Arduino)
 ** \details Queue handling library (designed on Arduino)
@@ -99,18 +99,24 @@ class Queue
 		return queue_sz; }
 
 	/*!	\brief get number of records in the queue
-	**	\return Number of records left in the queue
+	**	\return Number of records stored in the queue
 	**/
 	inline uint16_t getCount(void) __attribute__((always_inline)) {
 		return cnt; }
 
 	/*!	\brief get number of records in the queue (same as getCount)
 	**	\deprecated nbRecs was already used in Queue lib, alias is made to keep compatibility with earlier versions
-	**	\return Number of records left in the queue
+	**	\return Number of records stored in the queue
 	**/
 	inline uint16_t nbRecs(void) __attribute__((always_inline)) {
 		return getCount(); }
 
+	/*!	\brief get number of records left in the queue
+	**	\return Number of records left in the queue
+	**/
+	inline uint16_t getRemainingCount(void) __attribute__((always_inline)) {
+		return rec_nb - cnt; }
+
 	/*!	\brief Push record to queue
 	**	\param [in] record - pointer to record to be pushed into queue
 	**	\return Push status