Header dependencies: separate helper pre-processor macros from utilities.h (speeduino#1360)

* Header dependencies: move helper pre-processor macros into their own header file. They are unrelated to utilities

* Suppress SonarQube warnings

Author: adbancroft

speeduino/auxiliaries.cpp

@@ -9,7 +9,7 @@ A full copy of the license may be found in the projects root directory
 #include "src/PID_v1/PID_v1.h"
 #include "decoders.h"
 #include "timers.h"
-#include "utilities.h"
+#include "preprocessor.h"
 #include "units.h"
 
 static long vvt1_pwm_value;

speeduino/comms_legacy.cpp

@@ -12,7 +12,7 @@ A full copy of the license may be found in the projects root directory
 #include "comms_secondary.h"
 #include "storage.h"
 #include "maths.h"
-#include "utilities.h"
+#include "preprocessor.h"
 #include "decoders.h"
 #include "TS_CommandButtonHandler.h"
 #include "pages.h"

speeduino/comms_secondary.cpp

@@ -20,7 +20,7 @@ sendcancommand is called when a command is to be sent either to serial3
 #include "comms_secondary.h"
 #include "comms_CAN.h"
 #include "maths.h"
-#include "utilities.h"
+#include "preprocessor.h"
 #include "comms_legacy.h"
 #include "logger.h"
 #include "page_crc.h"

speeduino/corrections.cpp

@@ -29,7 +29,7 @@ There are 2 top level functions that call more detailed corrections for Fuel and
 #include "maths.h"
 #include "sensors.h"
 #include "unit_testing.h"
-#include "utilities.h"
+#include "preprocessor.h"
 #include "src/PID_v1/PID_v1.h"
 #include "units.h"
 #include "fuel_calcs.h"

speeduino/engineProtection.cpp

@@ -1,9 +1,8 @@
 #include "globals.h"
 #include "engineProtection.h"
 #include "maths.h"
-#include "utilities.h"
 #include "units.h"
-#include "crankMaths.h"
+#include "preprocessor.h"
 
 byte oilProtStartTime = 0;
 static table2D_u8_u8_4 oilPressureProtectTable(&configPage10.oilPressureProtRPM, &configPage10.oilPressureProtMins);

speeduino/idle.cpp

@@ -6,7 +6,7 @@ A full copy of the license may be found in the projects root directory
 #include "idle.h"
 #include "maths.h"
 #include "timers.h"
-#include "utilities.h"
+#include "preprocessor.h"
 #include "src/PID_v1/PID_v1.h"
 #include "units.h"
 

speeduino/logger.cpp

@@ -4,6 +4,7 @@
 #include "init.h"
 #include "maths.h"
 #include "utilities.h"
+#include "preprocessor.h"
 #include "units.h"
 #include "board_definition.h" 
 

speeduino/pages.cpp

@@ -1,6 +1,6 @@
 #include "pages.h"
 #include "globals.h"
-#include "utilities.h"
+#include "preprocessor.h"
 
 // Maps from virtual page "addresses" to addresses/bytes of real in memory entities
 //

speeduino/preprocessor.h

@@ -0,0 +1,65 @@
+#pragma once
+
+/** @file 
+ * This file contains various shared utility macros that make writing function
+ * style macros easier.
+*/
+
+#if !defined(UNUSED)
+/** @brief Used to suppress unused parameter compiler warnings */
+#define UNUSED(x) \
+    (void)(x)
+#endif
+
+/** @brief Compile time calculation of an array size */
+#if !defined(_countof)
+#define _countof(x) \
+    (sizeof((x)) / sizeof ((x)[0]))
+#endif
+
+/** @brief Obtain a pointer to 1 *element* past the end of an array */
+#if !defined(_end_range_address)
+#define _end_range_address(array) \
+    ((array) + _countof((array)))
+#endif
+
+/** @brief Obtain a pointer to 1 *byte* past the end of an array */
+#if !defined(_end_range_byte_address)
+#define _end_range_byte_address(array) \
+    (((byte*)(array)) + sizeof((array)))
+#endif
+
+/** @brief Pre-processor arithmetic increment (pulled from Boost.Preprocessor) */
+#if !defined(PP_INC)
+#define PP_INC(x) \
+    PP_INC_I(x)
+#endif
+
+/// @cond 
+// PP_INC() support macros
+#define PP_INC_I(x) PP_INC_ ## x
+#define PP_INC_0 1 // NOSONAR
+#define PP_INC_1 2 // NOSONAR
+#define PP_INC_2 3 // NOSONAR
+#define PP_INC_3 4 // NOSONAR
+#define PP_INC_4 5 // NOSONAR
+#define PP_INC_5 6 // NOSONAR
+#define PP_INC_6 7 // NOSONAR
+#define PP_INC_7 8 // NOSONAR
+#define PP_INC_8 9 // NOSONAR
+#define PP_INC_9 10 // NOSONAR
+#define PP_INC_10 11 // NOSONAR
+#define PP_INC_11 12 // NOSONAR
+#define PP_INC_12 13 // NOSONAR
+/// @endcond
+
+/// @cond 
+// CONCAT() support macros
+#define CAT_HELPER(a, b) a ## b
+/// @endcond
+
+/** @brief Concatenate A & B *after* macro expansion */
+#if !defined(CONCAT)
+#define CONCAT(A, B) \
+    CAT_HELPER(A, B)
+#endif

speeduino/scheduler.cpp

@@ -29,7 +29,7 @@ A full copy of the license may be found in the projects root directory
 #include "scheduledIO.h"
 #include "timers.h"
 #include "schedule_calcs.h"
-#include "utilities.h"
+#include "preprocessor.h"
 #include "units.h"
 
 FuelSchedule fuelSchedule1(FUEL1_COUNTER, FUEL1_COMPARE, FUEL1_TIMER_DISABLE, FUEL1_TIMER_ENABLE);