IS_ONE_OF macro to make long chains of conditions more concise and ea…

…sy to follow (#4860) * Is one of macro * Moar * Whoops * Trunk * isOneOf function backed macro
meshtastic · Sep 25, 2024 · 4128d75 · 4128d75
1 parent 9dd7695
commit 4128d75
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 20 deletions.
diff --git a/src/gps/GPS.cpp b/src/gps/GPS.cpp
@@ -7,6 +7,7 @@
 #include "PowerMon.h"
 #include "RTC.h"
 #include "Throttle.h"
+#include "meshUtils.h"
 
 #include "main.h" // pmu_found
 #include "sleep.h"
@@ -511,7 +512,7 @@ bool GPS::setup()
             delay(250);
             _serial_gps->write("$CFGMSG,6,1,0\r\n");
             delay(250);
-        } else if (gnssModel == GNSS_MODEL_AG3335 || gnssModel == GNSS_MODEL_AG3352) {
+        } else if (IS_ONE_OF(gnssModel, GNSS_MODEL_AG3335, GNSS_MODEL_AG3352)) {
 
             _serial_gps->write("$PAIR066,1,0,1,0,0,1*3B\r\n"); // Enable GPS+GALILEO+NAVIC
 
@@ -553,7 +554,7 @@ bool GPS::setup()
             } else {
                 LOG_INFO("GNSS module configuration saved!\n");
             }
-        } else if (gnssModel == GNSS_MODEL_UBLOX7 || gnssModel == GNSS_MODEL_UBLOX8 || gnssModel == GNSS_MODEL_UBLOX9) {
+        } else if (IS_ONE_OF(gnssModel, GNSS_MODEL_UBLOX7, GNSS_MODEL_UBLOX8, GNSS_MODEL_UBLOX9)) {
             if (gnssModel == GNSS_MODEL_UBLOX7) {
                 LOG_DEBUG("Setting GPS+SBAS\n");
                 msglen = makeUBXPacket(0x06, 0x3e, sizeof(_message_GNSS_7), _message_GNSS_7);
@@ -826,8 +827,7 @@ void GPS::setPowerPMU(bool on)
 void GPS::setPowerUBLOX(bool on, uint32_t sleepMs)
 {
     // Abort: if not UBLOX hardware
-    if (!(gnssModel == GNSS_MODEL_UBLOX6 || gnssModel == GNSS_MODEL_UBLOX7 || gnssModel == GNSS_MODEL_UBLOX8 ||
-          gnssModel == GNSS_MODEL_UBLOX9 || gnssModel == GNSS_MODEL_UBLOX10))
+    if (!IS_ONE_OF(gnssModel, GNSS_MODEL_UBLOX6, GNSS_MODEL_UBLOX7, GNSS_MODEL_UBLOX8, GNSS_MODEL_UBLOX9, GNSS_MODEL_UBLOX10))
         return;
 
     // If waking
@@ -910,8 +910,7 @@ void GPS::down()
         // If not, fallback to GPS_HARDSLEEP instead
         bool softsleepSupported = false;
         // U-blox is supported via PMREQ
-        if (gnssModel == GNSS_MODEL_UBLOX6 || gnssModel == GNSS_MODEL_UBLOX7 || gnssModel == GNSS_MODEL_UBLOX8 ||
-            gnssModel == GNSS_MODEL_UBLOX9 || gnssModel == GNSS_MODEL_UBLOX10)
+        if (IS_ONE_OF(gnssModel, GNSS_MODEL_UBLOX6, GNSS_MODEL_UBLOX7, GNSS_MODEL_UBLOX8, GNSS_MODEL_UBLOX9, GNSS_MODEL_UBLOX10))
             softsleepSupported = true;
 #ifdef PIN_GPS_STANDBY // L76B, L76K and clones have a standby pin
         softsleepSupported = true;
@@ -987,8 +986,8 @@ int32_t GPS::runOnce()
         setConnected();
     } else {
         if ((config.position.gps_mode == meshtastic_Config_PositionConfig_GpsMode_ENABLED) &&
-            (gnssModel == GNSS_MODEL_UBLOX6 || gnssModel == GNSS_MODEL_UBLOX7 || gnssModel == GNSS_MODEL_UBLOX8 ||
-             gnssModel == GNSS_MODEL_UBLOX9 || gnssModel == GNSS_MODEL_UBLOX10)) {
+            IS_ONE_OF(gnssModel, GNSS_MODEL_UBLOX6, GNSS_MODEL_UBLOX7, GNSS_MODEL_UBLOX8, GNSS_MODEL_UBLOX9,
+                      GNSS_MODEL_UBLOX10)) {
             // reset the GPS on next bootup
             if (devicestate.did_gps_reset && scheduling.elapsedSearchMs() > 60 * 1000UL && !hasFlow()) {
                 LOG_DEBUG("GPS is not communicating, trying factory reset on next bootup.\n");

diff --git a/src/main.cpp b/src/main.cpp
@@ -32,6 +32,7 @@
 #include "graphics/Screen.h"
 #include "main.h"
 #include "mesh/generated/meshtastic/config.pb.h"
+#include "meshUtils.h"
 #include "modules/Modules.h"
 #include "shutdown.h"
 #include "sleep.h"
@@ -627,9 +628,9 @@ void setup()
 #endif
 
     // only play start melody when role is not tracker or sensor
-    if (config.power.is_power_saving == true && (config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER ||
-                                                 config.device.role == meshtastic_Config_DeviceConfig_Role_TAK_TRACKER ||
-                                                 config.device.role == meshtastic_Config_DeviceConfig_Role_SENSOR))
+    if (config.power.is_power_saving == true &&
+        IS_ONE_OF(config.device.role, meshtastic_Config_DeviceConfig_Role_TRACKER,
+                  meshtastic_Config_DeviceConfig_Role_TAK_TRACKER, meshtastic_Config_DeviceConfig_Role_SENSOR))
         LOG_DEBUG("Tracker/Sensor: Skipping start melody\n");
     else
         playStartMelody();

diff --git a/src/mesh/NodeDB.h b/src/mesh/NodeDB.h
@@ -2,6 +2,7 @@
 
 #include "Observer.h"
 #include <Arduino.h>
+#include <algorithm>
 #include <assert.h>
 #include <vector>
 

diff --git a/src/meshUtils.cpp b/src/meshUtils.cpp
@@ -80,4 +80,19 @@ bool memfll(const uint8_t *mem, uint8_t find, size_t numbytes)
             return false;
     }
     return true;
+}
+
+bool isOneOf(int item, int count, ...)
+{
+    va_list args;
+    va_start(args, count);
+    bool found = false;
+    for (int i = 0; i < count; ++i) {
+        if (item == va_arg(args, int)) {
+            found = true;
+            break;
+        }
+    }
+    va_end(args);
+    return found;
 }
diff --git a/src/meshUtils.h b/src/meshUtils.h
@@ -1,5 +1,8 @@
 #pragma once
 #include "DebugConfiguration.h"
+#include <algorithm>
+#include <cstdarg>
+#include <iterator>
 #include <stdint.h>
 
 /// C++ v17+ clamp function, limits a given value to a range defined by lo and hi
@@ -17,4 +20,8 @@ char *strnstr(const char *s, const char *find, size_t slen);
 void printBytes(const char *label, const uint8_t *p, size_t numbytes);
 
 // is the memory region filled with a single character?
-bool memfll(const uint8_t *mem, uint8_t find, size_t numbytes);
+bool memfll(const uint8_t *mem, uint8_t find, size_t numbytes);
+
+bool isOneOf(int item, int count, ...);
+
+#define IS_ONE_OF(item, ...) isOneOf(item, sizeof((int[]){__VA_ARGS__}) / sizeof(int), __VA_ARGS__)
diff --git a/src/modules/PositionModule.cpp b/src/modules/PositionModule.cpp
@@ -12,6 +12,7 @@
 #include "gps/GeoCoord.h"
 #include "main.h"
 #include "mesh/compression/unishox2.h"
+#include "meshUtils.h"
 #include "meshtastic/atak.pb.h"
 #include "sleep.h"
 #include "target_specific.h"
@@ -347,8 +348,8 @@ void PositionModule::sendOurPosition(NodeNum dest, bool wantReplies, uint8_t cha
 
     service->sendToMesh(p, RX_SRC_LOCAL, true);
 
-    if ((config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER ||
-         config.device.role == meshtastic_Config_DeviceConfig_Role_TAK_TRACKER) &&
+    if (IS_ONE_OF(config.device.role, meshtastic_Config_DeviceConfig_Role_TRACKER,
+                  meshtastic_Config_DeviceConfig_Role_TAK_TRACKER) &&
         config.power.is_power_saving) {
         LOG_DEBUG("Starting next execution in 5 seconds and then going to sleep.\n");
         sleepOnNextExecution = true;

diff --git a/src/modules/Telemetry/DeviceTelemetry.cpp b/src/modules/Telemetry/DeviceTelemetry.cpp
@@ -11,14 +11,15 @@
 #include "main.h"
 #include <OLEDDisplay.h>
 #include <OLEDDisplayUi.h>
+#include <meshUtils.h>
 
 #define MAGIC_USB_BATTERY_LEVEL 101
 
 int32_t DeviceTelemetryModule::runOnce()
 {
     refreshUptime();
-    bool isImpoliteRole = config.device.role == meshtastic_Config_DeviceConfig_Role_SENSOR ||
-                          config.device.role == meshtastic_Config_DeviceConfig_Role_ROUTER;
+    bool isImpoliteRole =
+        IS_ONE_OF(config.device.role, meshtastic_Config_DeviceConfig_Role_SENSOR, meshtastic_Config_DeviceConfig_Role_ROUTER);
     if (((lastSentToMesh == 0) ||
          ((uptimeLastMs - lastSentToMesh) >=
           Default::getConfiguredOrDefaultMsScaled(moduleConfig.telemetry.device_update_interval,

diff --git a/src/platform/nrf52/main-nrf52.cpp b/src/platform/nrf52/main-nrf52.cpp
@@ -12,6 +12,7 @@
 #include "PowerMon.h"
 #include "error.h"
 #include "main.h"
+#include "meshUtils.h"
 
 #ifdef BQ25703A_ADDR
 #include "BQ25713.h"
@@ -157,6 +158,7 @@ void nrf52Loop()
 
 #ifdef USE_SEMIHOSTING
 #include <SemihostingStream.h>
+#include <meshUtils.h>
 
 /**
  * Note: this variable is in BSS and therfore false by default.  But the gdbinit
@@ -261,10 +263,9 @@ void cpuDeepSleep(uint32_t msecToWake)
     // Sleepy trackers or sensors can low power "sleep"
     // Don't enter this if we're sleeping portMAX_DELAY, since that's a shutdown event
     if (msecToWake != portMAX_DELAY &&
-        (config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER ||
-         config.device.role == meshtastic_Config_DeviceConfig_Role_TAK_TRACKER ||
-         config.device.role == meshtastic_Config_DeviceConfig_Role_SENSOR) &&
-        config.power.is_power_saving == true) {
+        (IS_ONE_OF(config.device.role, meshtastic_Config_DeviceConfig_Role_TRACKER,
+                   meshtastic_Config_DeviceConfig_Role_TAK_TRACKER, meshtastic_Config_DeviceConfig_Role_SENSOR) &&
+         config.power.is_power_saving == true)) {
         sd_power_mode_set(NRF_POWER_MODE_LOWPWR);
         delay(msecToWake);
         NVIC_SystemReset();