UserModManager - use vectors to remove need for nullptr checks

Author: netmindz

wled00/fcn_declare.h

@@ -380,7 +380,7 @@ const unsigned int um_data_size = sizeof(um_data_t);  // 12 bytes
 class Usermod {
   protected:
     um_data_t *um_data; // um_data should be allocated using new in (derived) Usermod's setup() or constructor
-    bool enabled = true; // maintain compatibility for usermods that don't use this
+    bool enabled = false;
     const char *_name;
 
   public:
@@ -436,7 +436,6 @@ class Usermod {
 };
 
 namespace UsermodManager {
-  extern byte numMods;
   void loop();
   void handleOverlayDraw();
   bool handleButton(uint8_t b);
@@ -460,7 +459,7 @@ namespace UsermodManager {
   void onStateChange(uint8_t);
   bool add(Usermod* um);
   Usermod* lookup(uint16_t mod_id);
-  inline byte getModCount() {return numMods;};
+  byte getModCount();
 };
 
 //usermods_list.cpp

wled00/set.cpp

@@ -750,6 +750,7 @@ void handleSettingsSet(AsyncWebServerRequest *request, byte subPage)
         DEBUG_PRINTF_P(PSTR(" = %s\n"), value.c_str());
       }
     }
+    DEBUG_PRINTLN(F("Re-init UsermodManager::"));
     UsermodManager::readFromConfig(um);  // force change of usermod parameters
     DEBUG_PRINTLN(F("Done re-init UsermodManager::"));
     releaseJSONBufferLock();

wled00/um_manager.cpp

@@ -3,20 +3,19 @@
  * Registration and management utility for v2 usermods
  */
 
-static Usermod* ums[WLED_MAX_USERMODS] = {nullptr};
-byte UsermodManager::numMods = 0;
-static Usermod* umsEnabled[WLED_MAX_USERMODS] = {nullptr};
+static std::vector<Usermod*> ums;
+static std::vector<Usermod*> umsEnabled;
 
 //Usermod Manager internals
-void UsermodManager::setup()             { for (Usermod* um : umsEnabled) if(um) if(um) { um->setup(); } }
-void UsermodManager::connected()         { for (Usermod* um : umsEnabled) if(um) { um->connected(); } }
-void UsermodManager::loop()              { for (Usermod* um : umsEnabled) if(um) { um->loop();  } }
-void UsermodManager::handleOverlayDraw() { for (Usermod* um : umsEnabled) if(um) { um->handleOverlayDraw(); } }
-void UsermodManager::appendConfigData(Print& dest)  { for (Usermod* um : ums) if(um) { um->appendConfigData(dest); } }
+void UsermodManager::setup()             { for (Usermod* um : umsEnabled) um->setup(); }
+void UsermodManager::connected()         { for (Usermod* um : umsEnabled) um->connected(); }
+void UsermodManager::loop()              { for (Usermod* um : umsEnabled) um->loop();  }
+void UsermodManager::handleOverlayDraw() { for (Usermod* um : umsEnabled) um->handleOverlayDraw(); }
+void UsermodManager::appendConfigData(Print& dest)  { for (Usermod* um : ums) um->appendConfigData(dest); }
 bool UsermodManager::handleButton(uint8_t b) {
   bool overrideIO = false;
-  for (unsigned i = 0; i < numMods; i++) {
-    if (ums[i]->handleButton(b)) overrideIO = true;
+  for (Usermod* um : umsEnabled) {
+    if (um->handleButton(b)) overrideIO = true;
   }
   return overrideIO;
 }
@@ -27,58 +26,57 @@ bool UsermodManager::getUMData(um_data_t **data, uint8_t mod_id) {
   }
   return false;
 }
-void UsermodManager::addToJsonState(JsonObject& obj)    { for (Usermod* um : umsEnabled) if(um) { um->addToJsonState(obj); } }
-void UsermodManager::addToJsonInfo(JsonObject& obj)     { for (Usermod* um : ums) if(um) { um->addToJsonInfo(obj); } } 
-void UsermodManager::readFromJsonState(JsonObject& obj) { for (Usermod* um : umsEnabled) if(um) { um->readFromJsonState(obj); } }
-void UsermodManager::addToConfig(JsonObject& obj)       { for (Usermod* um : ums) if(um) { um->addToConfig(obj); } }
+void UsermodManager::addToJsonState(JsonObject& obj)    { for (Usermod* um : umsEnabled) um->addToJsonState(obj); }
+void UsermodManager::addToJsonInfo(JsonObject& obj)     { for (Usermod* um : ums) um->addToJsonInfo(obj); }
+void UsermodManager::readFromJsonState(JsonObject& obj) { for (Usermod* um : umsEnabled) um->readFromJsonState(obj); }
+void UsermodManager::addToConfig(JsonObject& obj)       { for (Usermod* um : ums) um->addToConfig(obj); }
 bool UsermodManager::readFromConfig(JsonObject& obj)    {
   bool allComplete = true;
-  for (unsigned i = 0; i < numMods; i++) {
-    if (!ums[i]->readFromConfig(obj)) allComplete = false;
-    if(!ums[i]->isEnabled()) {
-      umsEnabled[i] = ums[i];
-    }
-    else {
-      umsEnabled[i] = nullptr;
+  umsEnabled.clear();
+  for (Usermod* um : ums) {
+    if (!um->readFromConfig(obj)) allComplete = false;
+    if(!um->isEnabled()) {
+      umsEnabled.push_back(um);
     }
   }
   return allComplete;
 }
 #ifndef WLED_DISABLE_MQTT
-void UsermodManager::onMqttConnect(bool sessionPresent) { for (Usermod* um : umsEnabled) if(um) { um->onMqttConnect(sessionPresent); } }
+void UsermodManager::onMqttConnect(bool sessionPresent) { for (Usermod* um : umsEnabled) um->onMqttConnect(sessionPresent); }
 bool UsermodManager::onMqttMessage(char* topic, char* payload) {
-  for (Usermod* um : umsEnabled) if (um && um->onMqttMessage(topic, payload)) return true;
+  for (Usermod* um : umsEnabled) if (um->onMqttMessage(topic, payload)) return true;
   return false;
 }
 #endif
 #ifndef WLED_DISABLE_ESPNOW
 bool UsermodManager::onEspNowMessage(uint8_t* sender, uint8_t* payload, uint8_t len) {
-  for (Usermod* um : umsEnabled) if (um && um->onEspNowMessage(sender, payload, len)) return true;
+  for (Usermod* um : umsEnabled) if (um->onEspNowMessage(sender, payload, len)) return true;
   return false;
 }
 #endif
-void UsermodManager::onUpdateBegin(bool init) { for (Usermod* um : umsEnabled) if(um) { um->onUpdateBegin(init); } } // notify usermods that update is to begin
-void UsermodManager::onStateChange(uint8_t mode) { for (Usermod* um : umsEnabled) if(um) { um->onStateChange(mode); } } // notify usermods that WLED state changed
+void UsermodManager::onUpdateBegin(bool init) { for (Usermod* um : umsEnabled) um->onUpdateBegin(init); } // notify usermods that update is to begin
+void UsermodManager::onStateChange(uint8_t mode) { for (Usermod* um : umsEnabled) um->onStateChange(mode); } // notify usermods that WLED state changed
 
 /*
  * Enables usermods to lookup another Usermod.
  */
 Usermod* UsermodManager::lookup(uint16_t mod_id) {
-  for (unsigned i = 0; i < numMods; i++) {
-    if (ums[i]->getId() == mod_id) {
-      return ums[i];
+  for (Usermod* um : ums) {
+    if (um->getId() == mod_id) {
+      return um;
     }
   }
   return nullptr;
 }
 
 bool UsermodManager::add(Usermod* um)
 {
-  if (numMods >= WLED_MAX_USERMODS || um == nullptr) return false;
-  ums[numMods++] = um;
+  if (ums.size() >= WLED_MAX_USERMODS || um == nullptr) return false;
+  ums.push_back(um);
   return true;
 }
 
+byte UsermodManager::getModCount() { return ums.size(); }
 
 /* Usermod v2 interface shim for oappend */
 Print* Usermod::oappend_shim = nullptr;