v2.1 (minor update):

- Internal functions name refactoring
- Unused tags removal
- always_inline attribute removal for index manipulation functions
- c-cast updated to cpp static_cast
- Legacy standard library headers replaced by their cpp equivalents

Author: SMFSW

Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = Queue
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.0
+PROJECT_NUMBER         = 2.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Doxyfile.auto

@@ -48,7 +48,7 @@ PROJECT_NAME           = Queue
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.0
+PROJECT_NUMBER         = 2.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2017-2025, SMFSW
+Copyright (c) 2017-2026, SMFSW
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

ReleaseNotes.md

@@ -1,5 +1,5 @@
 Queue handling library (designed on Arduino)
-2017-2025 SMFSW
+2017-2026 SMFSW
 
 Feel free to share your thoughts @ [email protected] about:
 	- issues encountered
@@ -10,6 +10,13 @@ Feel free to share your thoughts @ [email protected] about:
 
 ** Actual:
 
+v2.1:	02 Jan 2026:
+- Internal functions name refactoring
+- Unused tags removal
+- always_inline attribute removal for index manipulation functions
+- c-cast updated to cpp static_cast
+- Legacy standard library headers replaced by their cpp equivalents
+
 v2.0:	15 Apr 2024:
 - No more inlines in header file (to generate proper static library)
 - MISRA refactoring

library.properties

@@ -1,5 +1,5 @@
 name=Queue
-version=2.0
+version=2.1
 author=SMFSW <[email protected]>
 maintainer=SMFSW <[email protected]>
 sentence=Queue handling library.

src/cppQueue.cpp

@@ -1,13 +1,13 @@
 /*!\file cppQueue.cpp
 ** \author SMFSW
-** \copyright BSD 3-Clause License (c) 2017-2025, SMFSW
+** \copyright BSD 3-Clause License (c) 2017-2026, SMFSW
 ** \brief cppQueue handling library (designed on Arduino)
 ** \details cppQueue handling library (designed on Arduino)
 **			This library was designed for Arduino, yet may be compiled without change with gcc for other purposes/targets
 **/
 /****************************************************************/
-#include <string.h>
-#include <stdlib.h>
+#include <cstring>
+#include <cstdlib>
 
 #include "cppQueue.h"
 /****************************************************************/
@@ -25,7 +25,7 @@
 **	\param [in] end - counter upper limit value
 **	\param [in] start - counter lower limit value
 **/
-static inline void __attribute__((nonnull, always_inline)) _inc_idx(uint16_t * const pIdx, const uint16_t end, const uint16_t start)
+static inline void __attribute__((nonnull)) cppq_inc_idx(uint16_t * const pIdx, const uint16_t end, const uint16_t start)
 {
 	if (*pIdx < (end - 1U))	{ (*pIdx)++; }
 	else					{ *pIdx = start; }
@@ -37,7 +37,7 @@ static inline void __attribute__((nonnull, always_inline)) _inc_idx(uint16_t * c
 **	\param [in] end - counter upper limit value
 **	\param [in] start - counter lower limit value
 **/
-static inline void __attribute__((nonnull, always_inline)) _dec_idx(uint16_t * const pIdx, const uint16_t end, const uint16_t start)
+static inline void __attribute__((nonnull)) cppq_dec_idx(uint16_t * const pIdx, const uint16_t end, const uint16_t start)
 {
 	if (*pIdx > start)		{ (*pIdx)--; }
 	else					{ *pIdx = end - 1U; }
@@ -49,30 +49,30 @@ static inline void __attribute__((nonnull, always_inline)) _dec_idx(uint16_t * c
 **	\retval true if queue is allocated
 **	\retval false is queue is not allocated
 **/
-inline bool __attribute__((always_inline)) cppQueue::_isInitialized(void) {
-	return (init == QUEUE_INITIALIZED) ? true : false; }
+inline const bool __attribute__((always_inline)) cppQueue::_isInitialized(void) {
+	return (init == QUEUE_INITIALIZED); }
 
 /*!	\brief get emptiness state of the queue
 **	\return cppQueue emptiness status
 **	\retval true if queue is empty
 **	\retval false is not empty
 **/
-inline bool __attribute__((always_inline)) cppQueue::_isEmpty(void) {
-	return (cnt == 0U) ? true : false; }
+inline const bool __attribute__((always_inline)) cppQueue::_isEmpty(void) {
+	return (cnt == 0U); }
 
 /*!	\brief get fullness state of the queue
 **	\return cppQueue fullness status
 **	\retval true if queue is full
 **	\retval false is not full
 **/
-inline bool __attribute__((always_inline)) cppQueue::_isFull(void) {
-	return (cnt == rec_nb) ? true : false; }
+inline const bool __attribute__((always_inline)) cppQueue::_isFull(void) {
+	return (cnt == rec_nb); }
 
 
 /*!	\brief get number of records in the queue
 **	\return Number of records stored in the queue
 **/
-inline uint16_t __attribute__((always_inline)) cppQueue::_getCount(void) {
+inline const uint16_t __attribute__((always_inline)) cppQueue::_getCount(void) {
 	return cnt; }
 
 
@@ -82,16 +82,16 @@ inline uint16_t __attribute__((always_inline)) cppQueue::_getCount(void) {
 cppQueue::cppQueue(const size_t size_rec, const uint16_t nb_recs, const cppQueueType type, const bool overwrite, void * const pQDat, const size_t lenQDat)
 {
 	init = 0;
-	rec_nb = 0;	// rec_nb needs to be 0 to ensure proper push behavior when queue is not allocated
-	ovw = 0;	// ovw needs to be 0 to ensure proper push behavior when queue is not allocated
-	flush();	// other variables needs to be 0 to ensure proper functions behavior when queue is not allocated
+	rec_nb = 0;		// rec_nb needs to be 0 to ensure proper push behavior when queue is not allocated
+	ovw = false;	// ovw needs to be false to ensure proper push behavior when queue is not allocated
+	flush();		// other variables needs to be 0 to ensure proper functions behavior when queue is not allocated
 
 	const size_t size = nb_recs * size_rec;
 
-	dynamic = (pQDat == NULL) ? true : false;
+	dynamic = (pQDat == NULL);
 
-	if (dynamic)				{ queue = (uint8_t *) malloc(size); }
-	else if (lenQDat >= size)	{ queue = (uint8_t *) pQDat; }
+	if (dynamic)				{ queue = static_cast<uint8_t *>(malloc(size)); }
+	else if (lenQDat >= size)	{ queue = static_cast<uint8_t *>(pQDat); }
 	else						{ queue = NULL; }
 
 	if (queue != NULL)
@@ -130,7 +130,7 @@ bool __attribute__((nonnull)) cppQueue::push(const void * const record)
 		{
 			if (impl == FIFO)
 			{
-				_inc_idx(&out, rec_nb, 0);	// as oldest record is overwritten, increment out
+				cppq_inc_idx(&out, rec_nb, 0);	// as oldest record is overwritten, increment out
 			}
 			//else if (impl == LIFO)	{}	// Nothing to do in this case
 		}
@@ -148,7 +148,7 @@ bool __attribute__((nonnull)) cppQueue::push(const void * const record)
 	{
 		uint8_t * const pStart = queue + (rec_sz * in);
 		memcpy(pStart, record, rec_sz);
-		_inc_idx(&in, rec_nb, 0);
+		cppq_inc_idx(&in, rec_nb, 0);
 	}
 
 	return ret;
@@ -169,11 +169,11 @@ bool __attribute__((nonnull)) cppQueue::pop(void * const record)
 		if (impl == FIFO)
 		{
 			pStart = queue + (rec_sz * out);
-			_inc_idx(&out, rec_nb, 0);
+			cppq_inc_idx(&out, rec_nb, 0);
 		}
 		else /* if (impl == LIFO) */
 		{
-			_dec_idx(&in, rec_nb, 0);
+			cppq_dec_idx(&in, rec_nb, 0);
 			pStart = queue + (rec_sz * in);
 		}
 
@@ -205,7 +205,7 @@ bool __attribute__((nonnull)) cppQueue::peek(void * const record)
 		else /*if (impl == LIFO)*/
 		{
 			uint16_t rec = in;	// Temporary var for peek (no change on in with dec_idx)
-			_dec_idx(&rec, rec_nb, 0);
+			cppq_dec_idx(&rec, rec_nb, 0);
 			pStart = queue + (rec_sz * rec);
 		}
 
@@ -228,11 +228,11 @@ bool cppQueue::drop(void)
 	{
 		if (impl == FIFO)
 		{
-			_inc_idx(&out, rec_nb, 0);
+			cppq_inc_idx(&out, rec_nb, 0);
 		}
 		else /*if (impl == LIFO)*/
 		{
-			_dec_idx(&in, rec_nb, 0);
+			cppq_dec_idx(&in, rec_nb, 0);
 		}
 
 		cnt--;	// Decrease records count
@@ -280,21 +280,21 @@ bool __attribute__((nonnull)) cppQueue::peekPrevious(void * const record)
 /**********************/
 /*** PUBLIC GETTERS ***/
 /**********************/
-bool cppQueue::isInitialized(void) {
+const bool cppQueue::isInitialized(void) {
 	return _isInitialized(); }
 
-bool cppQueue::isEmpty(void) {
+const bool cppQueue::isEmpty(void) {
 	return _isEmpty(); }
 
-bool cppQueue::isFull(void) {
+const bool cppQueue::isFull(void) {
 	return _isFull(); }
 
-uint32_t cppQueue::sizeOf(void) {
+const uint32_t cppQueue::sizeOf(void) {
 	return queue_sz; }
 
-uint16_t cppQueue::getCount(void) {
+const uint16_t cppQueue::getCount(void) {
 	return _getCount(); }
 
-uint16_t cppQueue::getRemainingCount(void) {
+const uint16_t cppQueue::getRemainingCount(void) {
 	return rec_nb - cnt; }
 

src/cppQueue.h

@@ -1,6 +1,6 @@
 /*!\file cppQueue.h
 ** \author SMFSW
-** \copyright BSD 3-Clause License (c) 2017-2025, SMFSW
+** \copyright BSD 3-Clause License (c) 2017-2026, SMFSW
 ** \brief cppQueue handling library (designed on Arduino)
 ** \details cppQueue handling library (designed on Arduino)
 **			This library was designed for Arduino, yet may be compiled without change with gcc for other purposes/targets
@@ -9,15 +9,15 @@
 #ifndef CPPQUEUE_H_
 	#define CPPQUEUE_H_
 
-#include <inttypes.h>
-#include <stddef.h>
+#include <cinttypes>
+#include <cstddef>
 /****************************************************************/
 
 
-/*!\enum enumcppQueueType
+/*!\enum cppQueueType
 ** \brief cppQueue behavior enumeration (FIFO, LIFO)
 **/
-typedef enum enumcppQueueType {
+typedef enum {
 	FIFO = 0,	//!< First In First Out behavior
 	LIFO = 1	//!< Last In First Out behavior
 } cppQueueType;
@@ -42,10 +42,10 @@ class cppQueue
 	uint16_t		cnt;		//!< number of records not retrieved from the queue
 	uint16_t		init;		//!< set to QUEUE_INITIALIZED after successful init of the queue, 0 otherwise
 
-	inline bool _isInitialized(void) __attribute__((always_inline));
-	inline bool _isEmpty(void) __attribute__((always_inline));
-	inline bool _isFull(void) __attribute__((always_inline));
-	inline uint16_t _getCount(void) __attribute__((always_inline));
+	inline const bool _isInitialized(void) __attribute__((always_inline));
+	inline const bool _isEmpty(void) __attribute__((always_inline));
+	inline const bool _isFull(void) __attribute__((always_inline));
+	inline const uint16_t _getCount(void) __attribute__((always_inline));
 public:
 	/*!	\brief cppQueue constructor
 	**	\param [in] size_rec - size of a record in the queue
@@ -77,44 +77,44 @@ class cppQueue
 	**	\retval true if queue is allocated
 	**	\retval false is queue is not allocated
 	**/
-	bool isInitialized(void);
+	const bool isInitialized(void);
 
 	/*!	\brief get emptiness state of the queue
 	**	\return cppQueue emptiness status
 	**	\retval true if queue is empty
 	**	\retval false is not empty
 	**/
-	bool isEmpty(void);
+	const bool isEmpty(void);
 
 	/*!	\brief get fullness state of the queue
 	**	\return cppQueue fullness status
 	**	\retval true if queue is full
 	**	\retval false is not full
 	**/
-	bool isFull(void);
+	const bool isFull(void);
 
 	/*!	\brief get size of queue
 	**	\remark Size in bytes (like sizeof)
 	**	\return Size of queue in bytes
 	**/
-	uint32_t sizeOf(void);
+	const uint32_t sizeOf(void);
 
 	/*!	\brief get number of records in the queue
 	**	\return Number of records stored in the queue
 	**/
-	uint16_t getCount(void);
+	const uint16_t getCount(void);
 
 	/*!	\brief get number of records in the queue (same as getCount)
 	**	\deprecated nbRecs was already used in cppQueue lib, alias is made to keep compatibility with earlier versions
 	**	\return Number of records stored in the queue
 	**/
-	inline uint16_t nbRecs(void) __attribute__((always_inline)) {
+	inline const 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
 	**/
-	uint16_t getRemainingCount(void);
+	const uint16_t getRemainingCount(void);
 
 	/*!	\brief Push record to queue
 	**	\param [in] record - pointer to record to be pushed into queue