v1.6: Added sizeOf inline

Author: SMFSW

.travis.yml

@@ -2,9 +2,9 @@ language: c
 sudo: false
 
 addons:
-    apt:
-        packages:
-            - graphviz
+  apt:
+    packages:
+      - graphviz
 
 # Blacklist
 branches:

Doxyfile

@@ -768,7 +768,7 @@ WARN_FORMAT            = "$file:$line: $text"
 # messages should be written. If left blank the output is written to standard
 # error (stderr).
 
-WARN_LOGFILE           = doxy.log
+WARN_LOGFILE           = workdir/doxy.log
 
 #---------------------------------------------------------------------------
 # Configuration options related to the input files

README.md

@@ -27,6 +27,7 @@ This library was designed for Arduino, yet may be compiled without change with g
   - `q.IsInitialized()`: `true` if initialized properly, `false` otherwise
   - `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.clean()` or `q.flush()`: remove all items in the queue
 

ReleaseNotes.md

@@ -3,15 +3,16 @@ Queue handling library (designed on Arduino)
 
 Feel free to share your thoughts @ [email protected] about:
 	- issues encountered
-	- optimisations
+	- optimizations
 	- improvements & new functionalities
 
 ------------
 
 ** Actual:
 
-v1.6	3 May 2018:
+v1.6	21 May 2018:
 - Constructor does not check anymore if class instance is already allocated (as it supposedly isn't)
+- 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
@@ -27,7 +28,7 @@ v1.4	21 November 2017:
 - Added const qualifier for function parameters
 
 v1.3	12 July 2017:
-- #2 fix for esp8266: reanamed cpp/h files : header name already used in compiler sys includes
+- #2 fix for esp8266: renamed cpp/h files : header name already used in compiler sys includes
 - examples updated with new header file name (cppQueue.h)
 - comply with Arduino v1.5+ IDE source located in src subfolder
 

examples/LibTst/LibTst.ino

@@ -6,7 +6,7 @@
   This example code is in the public domain.
 
   created 22 March 2017
-  modified 22 March 2018
+  modified 21 May 2018
   by SMFSW
  */
 
@@ -38,6 +38,10 @@ Queue	q(sizeof(Rec), 10, IMPLEMENTATION, OVERWRITE);	// Instantiate queue
 // the setup function runs once when you press reset or power the board
 void setup() {
 	Serial.begin(115200);
+
+	Serial.print("Queue is ");
+	Serial.print(q.sizeOf());
+	Serial.println(" bytes long.");
 }
 
 // the loop function runs over and over again forever

keywords.txt

@@ -17,8 +17,9 @@ flush	KEYWORD2
 isInitialized	KEYWORD2
 isEmpty	KEYWORD2
 isFull	KEYWORD2
-nbRecs	KEYWORD2
+sizeOf	KEYWORD2
 getCount	KEYWORD2
+nbRecs	KEYWORD2
 push	KEYWORD2
 pop	KEYWORD2
 pull	KEYWORD2

src/cppQueue.cpp

@@ -1,20 +1,19 @@
 /*!\file cppQueue.cpp
 ** \author SMFSW
-** \date 2018/03/14
+** \date 2018/05/21
 ** \copyright BSD 3-Clause License (c) 2017-2018, SMFSW
 ** \brief Queue handling library (designed on Arduino)
 ** \details Queue handling library (designed on Arduino)
-**			This library was designed for Arduino, yet may be compiled without change with gcc for other purporses/targets
+**			This library was designed for Arduino, yet may be compiled without change with gcc for other purposes/targets
 **/
-
-
-extern "C"
-{
+/****************************************************************/
+extern "C" {
 	#include <string.h>
 	#include <stdlib.h>
 }
 
 #include "cppQueue.h"
+/****************************************************************/
 
 
 #define INC_IDX(ctr, end, start)	if (ctr < (end-1))	{ ctr++; }		\
@@ -26,6 +25,8 @@ extern "C"
 
 Queue::Queue(const uint16_t size_rec, const uint16_t nb_recs, const QueueType type, const bool overwrite)
 {
+	uint32_t size = nb_recs * size_rec;
+
 	rec_nb = nb_recs;
 	rec_sz = size_rec;
 	impl = type;
@@ -34,9 +35,10 @@ Queue::Queue(const uint16_t size_rec, const uint16_t nb_recs, const QueueType ty
 	init = 0;
 
 	//if (queue)	{ free(queue); }	// Free existing data (if any)
-	queue = (uint8_t *) malloc(nb_recs * size_rec);
+	queue = (uint8_t *) malloc(size);
 
-	if (queue == NULL)	{ return; }	// Return here if Queue not allocated
+	if (queue == NULL)	{ queue_sz = 0; return; }	// Return here if Queue not allocated
+	else				{ queue_sz = size; }
 
 	init = QUEUE_INITIALIZED;
 	flush();

src/cppQueue.h

@@ -1,16 +1,17 @@
 /*!\file cppQueue.h
 ** \author SMFSW
-** \date 2018/03/14
+** \date 2018/05/21
 ** \copyright BSD 3-Clause License (c) 2017-2018, SMFSW
 ** \brief Queue handling library (designed on Arduino)
 ** \details Queue handling library (designed on Arduino)
-**			This library was designed for Arduino, yet may be compiled without change with gcc for other purporses/targets
+**			This library was designed for Arduino, yet may be compiled without change with gcc for other purposes/targets
 **/
-
-#ifndef __CPPQUEUE_H__
-#define __CPPQUEUE_H__
+/****************************************************************/
+#ifndef __CPPQUEUE_H
+	#define __CPPQUEUE_H
 
 #include <inttypes.h>
+/****************************************************************/
 
 
 #define QUEUE_INITIALIZED	0x5AA5		//!< Queue initialized control value
@@ -35,6 +36,7 @@ class Queue
 	bool		ovw;		//!< Overwrite previous records when queue is full allowed
 	uint16_t	rec_nb;		//!< number of records in the queue
 	uint16_t	rec_sz;		//!< Size of a record
+	uint32_t	queue_sz;	//!< Size of the full queue
 	uint8_t *	queue;		//!< Queue start pointer (when allocated)
 
 	uint16_t	in;			//!< number of records pushed into the queue
@@ -89,6 +91,13 @@ class Queue
 	inline bool isFull(void) __attribute__((always_inline)) {
 		return (cnt == rec_nb) ? true : false; }
 
+	/*!	\brief get size of queue
+	**	\remark Size in bytes (like sizeof)
+	**	\return Size of queue in bytes
+	**/
+	inline uint32_t sizeOf(void) __attribute__((always_inline)) {
+		return queue_sz; }
+
 	/*!	\brief get number of records in the queue
 	**	\return Number of records left in the queue
 	**/
@@ -152,4 +161,4 @@ class Queue
 	bool drop(void);
 };
 
-#endif /* __CPPQUEUE_H__ */
+#endif /* __CPPQUEUE_H */