Add Semaphore::Type, fix warnings, bump version to 0.9.2

Author: Floessie

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Flössie <[email protected]>
+Copyright (c) 2018-2020 Flössie <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -89,11 +89,11 @@ Semaphores synchronize actions like, "Proceed only when I told you so!" Thus, se
 
 There are two kinds of semaphores:
 1. Binary semaphores, which only remember if they were posted but not how often. This is often sufficient and the default for a `frt::Semaphore`.
-2. Counting semaphores, that remember how often they were posted so that the waiting task can proceed exactly that many times without blocking. Such a semaphore is created by passing `true` to the constructor:
+2. Counting semaphores, that remember how often they were posted so that the waiting task can proceed exactly that many times without blocking. Such a semaphore is created by passing `frt::Semaphore::Type::COUNTING` to the constructor:
 
 ```c++
 frt::Semaphore my_binary_semaphore;
-frt::Semaphore my_counting_semaphore(true);
+frt::Semaphore my_counting_semaphore(frt::Semaphore::Type::COUNTING);
 ```
 
 If you want to share data via a buffer (and don't want to use `frt::Queue`), you need a mutex to protect the buffer and a semaphore to notify the consumer. When sharing between an ISR and a task, you can't use a mutex, but must employ a *critical section*.

keywords.txt

@@ -5,6 +5,8 @@ Mutex	KEYWORD1
 Semaphore	KEYWORD1
 Queue	KEYWORD1
 
+Type	KEYWORD1
+
 start	KEYWORD2
 stop	KEYWORD2
 stopFromIdleTask	KEYWORD2
@@ -30,3 +32,6 @@ pop	KEYWORD2
 preparePopFromInterrupt	KEYWORD2
 popFromInterrupt	KEYWORD2
 finalizePopFromInterrupt	KEYWORD2
+
+BINARY	LITERAL1
+COUNTING	LITERAL1

library.properties

@@ -1,5 +1,5 @@
 name=frt
-version=0.9.1
+version=0.9.2
 author=Flössie <[email protected]>
 maintainer=Flössie <[email protected]>
 sentence=Lightweight, easy-to-use wrapper around the Arduino_FreeRTOS_Library.

src/frt.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Flössie <[email protected]>
+ * Copyright (c) 2018-2020 Flössie <[email protected]>
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
@@ -155,7 +155,7 @@ namespace frt
 		{
 			const TickType_t ticks = msecs / portTICK_PERIOD_MS;
 
-			vTaskDelay(max(1, ticks));
+			vTaskDelay(max(1U, ticks));
 		}
 
 		void msleep(unsigned int msecs, unsigned int& remainder)
@@ -164,7 +164,7 @@ namespace frt
 			const TickType_t ticks = msecs / portTICK_PERIOD_MS;
 			remainder = msecs % portTICK_PERIOD_MS * static_cast<bool>(ticks);
 
-			vTaskDelay(max(1, ticks));
+			vTaskDelay(max(1U, ticks));
 		}
 
 		void wait()
@@ -176,7 +176,7 @@ namespace frt
 		{
 			const TickType_t ticks = msecs / portTICK_PERIOD_MS;
 
-			return ulTaskNotifyTake(pdTRUE, max(1, ticks));
+			return ulTaskNotifyTake(pdTRUE, max(1U, ticks));
 		}
 
 		bool wait(unsigned int msecs, unsigned int& remainder)
@@ -185,7 +185,7 @@ namespace frt
 			const TickType_t ticks = msecs / portTICK_PERIOD_MS;
 			remainder = msecs % portTICK_PERIOD_MS * static_cast<bool>(ticks);
 
-			if (ulTaskNotifyTake(pdTRUE, max(1, ticks))) {
+			if (ulTaskNotifyTake(pdTRUE, max(1U, ticks))) {
 				remainder = 0;
 				return true;
 			}
@@ -306,16 +306,21 @@ namespace frt
 	class Semaphore final
 	{
 	public:
-		Semaphore(bool counting = false) :
+		enum class Type {
+			BINARY,
+			COUNTING
+		};
+
+		Semaphore(Type type = Type::BINARY) :
 			handle(
 #if configSUPPORT_STATIC_ALLOCATION > 0
-				counting
-					? xSemaphoreCreateCountingStatic(static_cast<UBaseType_t>(-1), 0, &buffer)
-					: xSemaphoreCreateBinaryStatic(&buffer)
+				type == Type::BINARY
+					? xSemaphoreCreateBinaryStatic(&buffer)
+					: xSemaphoreCreateCountingStatic(static_cast<UBaseType_t>(-1), 0, &buffer)
 #else
-				counting
-					? xSemaphoreCreateCounting(static_cast<UBaseType_t>(-1), 0)
-					: xSemaphoreCreateBinary()
+				type == Type::BINARY
+					? xSemaphoreCreateBinary()
+					: xSemaphoreCreateCounting(static_cast<UBaseType_t>(-1), 0)
 #endif
 			)
 		{
@@ -338,7 +343,7 @@ namespace frt
 		{
 			const TickType_t ticks = msecs / portTICK_PERIOD_MS;
 
-			return xSemaphoreTake(handle, max(1, ticks)) == pdTRUE;
+			return xSemaphoreTake(handle, max(1U, ticks)) == pdTRUE;
 		}
 
 		bool wait(unsigned int msecs, unsigned int& remainder)
@@ -347,7 +352,7 @@ namespace frt
 			const TickType_t ticks = msecs / portTICK_PERIOD_MS;
 			remainder = msecs % portTICK_PERIOD_MS * static_cast<bool>(ticks);
 
-			if (xSemaphoreTake(handle, max(1, ticks)) == pdTRUE) {
+			if (xSemaphoreTake(handle, max(1U, ticks)) == pdTRUE) {
 				remainder = 0;
 				return true;
 			}
@@ -422,7 +427,7 @@ namespace frt
 		{
 			const TickType_t ticks = msecs / portTICK_PERIOD_MS;
 
-			return xQueueSend(handle, &item, max(1, ticks)) == pdTRUE;
+			return xQueueSend(handle, &item, max(1U, ticks)) == pdTRUE;
 		}
 
 		bool push(const T& item, unsigned int msecs, unsigned int& remainder)
@@ -431,7 +436,7 @@ namespace frt
 			const TickType_t ticks = msecs / portTICK_PERIOD_MS;
 			remainder = msecs % portTICK_PERIOD_MS * static_cast<bool>(ticks);
 
-			if (xQueueSend(handle, &item, max(1, ticks)) == pdTRUE) {
+			if (xQueueSend(handle, &item, max(1U, ticks)) == pdTRUE) {
 				remainder = 0;
 				return true;
 			}
@@ -465,7 +470,7 @@ namespace frt
 		{
 			const TickType_t ticks = msecs / portTICK_PERIOD_MS;
 
-			return xQueueReceive(handle, &item, max(1, ticks)) == pdTRUE;
+			return xQueueReceive(handle, &item, max(1U, ticks)) == pdTRUE;
 		}
 
 		bool pop(T& item, unsigned int msecs, unsigned int& remainder)
@@ -474,7 +479,7 @@ namespace frt
 			const TickType_t ticks = msecs / portTICK_PERIOD_MS;
 			remainder = msecs % portTICK_PERIOD_MS * static_cast<bool>(ticks);
 
-			if (xQueueReceive(handle, &item, max(1, ticks)) == pdTRUE) {
+			if (xQueueReceive(handle, &item, max(1U, ticks)) == pdTRUE) {
 				remainder = 0;
 				return true;
 			}