[Debug] Add option to include filename:linenr on PCONFIG debug logs

src/_Plugin_Helper.cpp

@@ -17,25 +17,78 @@ PluginTaskData_base *Plugin_task_data[TASKS_MAX] = {};
 
 #if DEBUG_PCONFIG_RANGE_CHECK
 
-bool PCONFIGxxx_outOfBounds(const __FlashStringHelper *prefix, const struct EventStruct *event, const uint8_t n, const uint8_t max_n)
+bool PCONFIGxxx_outOfBounds(
+  const __FlashStringHelper   *prefix,
+  const struct EventStruct    *event,
+  const uint8_t                n,
+  const uint8_t max_n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  , uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  , const __FlashStringHelper *filename
+#  endif
+# endif 
+
+  )
 {
   if (validTaskIndex(event->TaskIndex) && (n < max_n)) { return false; }
 
   if (loglevelActiveFor(LOG_LEVEL_ERROR)) {
+# if DEBUG_PCONFIG_RANGE_CHECK > 2
     addLog(LOG_LEVEL_ERROR, strformat(
-             F("%s(%u) out of range for taskIndex %u"),
+             F("%s(%u) out of range (max: %u) for taskIndex %u (%s:%u)"),
              FsP(prefix),
              n,
-             event->TaskIndex));
+             max_n,
+             event->TaskIndex + 1,
+             FsP(filename),
+             linenr));
+# elif DEBUG_PCONFIG_RANGE_CHECK > 1
+    addLog(LOG_LEVEL_ERROR, strformat(
+             F("%s(%u) out of range (max: %u) for taskIndex %u (line: %u)"),
+             FsP(prefix),
+             n,
+             max_n,
+             event->TaskIndex + 1,
+             linenr));
+# else 
+    addLog(LOG_LEVEL_ERROR, strformat(
+             F("%s(%u) out of range (max: %u) for taskIndex %u"),
+             FsP(prefix),
+             n,
+             max_n,
+             event->TaskIndex + 1));
+# endif 
   }
   return true;
 }
 
-int16_t& do_PCONFIG(struct EventStruct *event, uint8_t n)
+int16_t& do_PCONFIG(
+  const struct EventStruct *event,
+  uint8_t                   n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  ,
+  uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  , const __FlashStringHelper *filename
+#  endif
+# endif 
+  )
 {
   constexpr uint8_t max_n = NR_ELEMENTS(Settings.TaskDevicePluginConfig[0]);
 
-  if (!PCONFIGxxx_outOfBounds(F("PCONFIG"), event, n, max_n)) {
+  if (!PCONFIGxxx_outOfBounds(
+        F("PCONFIG"),
+        event,
+        n,
+        max_n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+        , linenr
+# endif
+# if DEBUG_PCONFIG_RANGE_CHECK > 2
+        , filename
+# endif
+        )) {
     return Settings.TaskDevicePluginConfig[event->TaskIndex][(n)];
   }
   static int16_t invalid{};
@@ -43,11 +96,32 @@ int16_t& do_PCONFIG(struct EventStruct *event, uint8_t n)
   return invalid;
 }
 
-float& do_PCONFIG_FLOAT(struct EventStruct *event, uint8_t n)
+float& do_PCONFIG_FLOAT(
+  const struct EventStruct *event,
+  uint8_t                   n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  ,
+  uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  , const __FlashStringHelper *filename
+#  endif
+# endif 
+  )
 {
   constexpr uint8_t max_n = NR_ELEMENTS(Settings.TaskDevicePluginConfigFloat[0]);
 
-  if (!PCONFIGxxx_outOfBounds(F("PCONFIG_FLOAT"), event, n, max_n)) {
+  if (!PCONFIGxxx_outOfBounds(
+        F("PCONFIG_FLOAT"),
+        event,
+        n,
+        max_n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+        , linenr
+# endif
+# if DEBUG_PCONFIG_RANGE_CHECK > 2
+        , filename
+# endif
+        )) {
     return Settings.TaskDevicePluginConfigFloat[event->TaskIndex][(n)];
   }
 
@@ -56,11 +130,32 @@ float& do_PCONFIG_FLOAT(struct EventStruct *event, uint8_t n)
   return invalid;
 }
 
-int32_t& do_PCONFIG_LONG(struct EventStruct *event, uint8_t n)
+int32_t& do_PCONFIG_LONG(
+  const struct EventStruct *event,
+  uint8_t                   n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  ,
+  uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  , const __FlashStringHelper *filename
+#  endif
+# endif 
+  )
 {
   constexpr uint8_t max_n = NR_ELEMENTS(Settings.TaskDevicePluginConfigLong[0]);
 
-  if (!PCONFIGxxx_outOfBounds(F("PCONFIG_LONG"), event, n, max_n)) {
+  if (!PCONFIGxxx_outOfBounds(
+        F("PCONFIG_LONG"),
+        event,
+        n,
+        max_n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+        , linenr
+# endif
+# if DEBUG_PCONFIG_RANGE_CHECK > 2
+        , filename
+# endif
+        )) {
     return Settings.TaskDevicePluginConfigLong[event->TaskIndex][(n)];
   }
   static int32_t invalid{};
@@ -68,11 +163,32 @@ int32_t& do_PCONFIG_LONG(struct EventStruct *event, uint8_t n)
   return invalid;
 }
 
-uint32_t& do_PCONFIG_ULONG(struct EventStruct *event, uint8_t n)
+uint32_t& do_PCONFIG_ULONG(
+  const struct EventStruct *event,
+  uint8_t                   n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  ,
+  uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  , const __FlashStringHelper *filename
+#  endif
+# endif 
+  )
 {
   constexpr uint8_t max_n = NR_ELEMENTS(Settings.TaskDevicePluginConfigULong[0]);
 
-  if (!PCONFIGxxx_outOfBounds(F("PCONFIG_ULONG"), event, n, max_n)) {
+  if (!PCONFIGxxx_outOfBounds(
+        F("PCONFIG_ULONG"),
+        event,
+        n,
+        max_n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+        , linenr
+# endif
+# if DEBUG_PCONFIG_RANGE_CHECK > 2
+        , filename
+# endif
+        )) {
     return Settings.TaskDevicePluginConfigULong[event->TaskIndex][(n)];
   }
   static uint32_t invalid{};
@@ -80,12 +196,33 @@ uint32_t& do_PCONFIG_ULONG(struct EventStruct *event, uint8_t n)
   return invalid;
 }
 
-int8_t& do_PIN(struct EventStruct *event, uint8_t n)
+int8_t& do_PIN(
+  const struct EventStruct *event,
+  uint8_t                   n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  ,
+  uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  , const __FlashStringHelper *filename
+#  endif
+# endif 
+  )
 {
   // N.B. order of array indices taskIndex_t and n differs from the other PCONFIGxxx
   constexpr uint8_t max_n = 3;
 
-  if (!PCONFIGxxx_outOfBounds(F("PIN"), event, n, max_n)) {
+  if (!PCONFIGxxx_outOfBounds(
+        F("PIN"),
+        event,
+        n,
+        max_n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+        , linenr
+# endif
+# if DEBUG_PCONFIG_RANGE_CHECK > 2
+        , filename
+# endif
+        )) {
     return Settings.TaskDevicePin[n][event->TaskIndex];
   }
   static int8_t invalid{};
@@ -126,9 +263,9 @@ bool initPluginTaskData(taskIndex_t taskIndex, PluginTaskData_base *data) {
   }
 
   // 2nd heap may have been active to allocate the PluginTaskData, but here we need to keep the default heap active
-  #ifdef USE_SECOND_HEAP
+#ifdef USE_SECOND_HEAP
   HeapSelectDram ephemeral;
-  #endif // ifdef USE_SECOND_HEAP
+#endif // ifdef USE_SECOND_HEAP
 
 
   clearPluginTaskData(taskIndex);
@@ -138,7 +275,7 @@ bool initPluginTaskData(taskIndex_t taskIndex, PluginTaskData_base *data) {
       Plugin_task_data[taskIndex]                     = data;
       Plugin_task_data[taskIndex]->_taskdata_pluginID = Settings.getPluginID_for_task(taskIndex);
 
-  #if FEATURE_PLUGIN_STATS
+#if FEATURE_PLUGIN_STATS
       const uint8_t valueCount = getValueCountForTask(taskIndex);
 
       for (size_t i = 0; i < valueCount; ++i) {
@@ -146,12 +283,12 @@ bool initPluginTaskData(taskIndex_t taskIndex, PluginTaskData_base *data) {
           Plugin_task_data[taskIndex]->initPluginStats(i);
         }
       }
-  #endif // if FEATURE_PLUGIN_STATS
-  #if FEATURE_PLUGIN_FILTER
+#endif // if FEATURE_PLUGIN_STATS
+#if FEATURE_PLUGIN_FILTER
 
       // TODO TD-er: Implement init
 
-  #endif // if FEATURE_PLUGIN_FILTER
+#endif // if FEATURE_PLUGIN_FILTER
 
     } else {
       delete data;

src/_Plugin_Helper.h

@@ -63,68 +63,148 @@
 #include "src/WebServer/ESPEasy_WebServer.h"
 
 #if DEBUG_PCONFIG_RANGE_CHECK
-int16_t&  do_PCONFIG(struct EventStruct *event,
-                     uint8_t             n);
-float&    do_PCONFIG_FLOAT(struct EventStruct *event,
-                           uint8_t             n);
-int32_t&  do_PCONFIG_LONG(struct EventStruct *event,
-                          uint8_t             n);
-uint32_t& do_PCONFIG_ULONG(struct EventStruct *event,
-                           uint8_t             n);
-int8_t&   do_PIN(struct EventStruct *event,
-                 uint8_t             n);
+int16_t& do_PCONFIG(
+  const struct EventStruct *event,
+  uint8_t                   n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  ,
+  uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  ,
+  const __FlashStringHelper *filename
+#  endif // if DEBUG_PCONFIG_RANGE_CHECK > 2
+# endif // if DEBUG_PCONFIG_RANGE_CHECK > 1
+  );
+float& do_PCONFIG_FLOAT(
+  const struct EventStruct *event,
+  uint8_t                   n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  ,
+  uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  ,
+  const __FlashStringHelper *filename
+#  endif // if DEBUG_PCONFIG_RANGE_CHECK > 2
+# endif // if DEBUG_PCONFIG_RANGE_CHECK > 1
+  );
+int32_t& do_PCONFIG_LONG(
+  const struct EventStruct *event,
+  uint8_t                   n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  ,
+  uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  ,
+  const __FlashStringHelper *filename
+#  endif // if DEBUG_PCONFIG_RANGE_CHECK > 2
+# endif // if DEBUG_PCONFIG_RANGE_CHECK > 1
+  );
+uint32_t& do_PCONFIG_ULONG(
+  const struct EventStruct *event,
+  uint8_t                   n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  ,
+  uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  ,
+  const __FlashStringHelper *filename
+#  endif // if DEBUG_PCONFIG_RANGE_CHECK > 2
+# endif // if DEBUG_PCONFIG_RANGE_CHECK > 1
+  );
+int8_t& do_PIN(
+  const struct EventStruct *event,
+  uint8_t                   n
+# if DEBUG_PCONFIG_RANGE_CHECK > 1
+  ,
+  uint16_t                  linenr
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+  ,
+  const __FlashStringHelper *filename
+#  endif // if DEBUG_PCONFIG_RANGE_CHECK > 2
+# endif // if DEBUG_PCONFIG_RANGE_CHECK > 1
+  );
 #endif // if DEBUG_PCONFIG_RANGE_CHECK
 
 
 // Defines to make plugins more readable.
 #ifndef PCONFIG
-  # if DEBUG_PCONFIG_RANGE_CHECK
-    #  define PCONFIG(n) do_PCONFIG(event, n)
-  # else
-    #  define PCONFIG(n) (Settings.TaskDevicePluginConfig[event->TaskIndex][(n)])
-  # endif // if DEBUG_PCONFIG_RANGE_CHECK
+# if DEBUG_PCONFIG_RANGE_CHECK
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+#   define PCONFIG(n) do_PCONFIG(event, n, __LINE__, F(__FILE__))
+#  elif DEBUG_PCONFIG_RANGE_CHECK > 1
+#   define PCONFIG(n) do_PCONFIG(event, n, __LINE__)
+#  else // if DEBUG_PCONFIG_RANGE_CHECK > 2
+#   define PCONFIG(n) do_PCONFIG(event, n)
+#  endif // if DEBUG_PCONFIG_RANGE_CHECK > 2
+# else // if DEBUG_PCONFIG_RANGE_CHECK
+#  define PCONFIG(n) (Settings.TaskDevicePluginConfig[event->TaskIndex][(n)])
+# endif // if DEBUG_PCONFIG_RANGE_CHECK
 #endif // ifndef PCONFIG
 #ifndef PCONFIG_FLOAT
-  # if DEBUG_PCONFIG_RANGE_CHECK
-    #  define PCONFIG_FLOAT(n) do_PCONFIG_FLOAT(event, n)
-  # else
-    #  define PCONFIG_FLOAT(n) (Settings.TaskDevicePluginConfigFloat[event->TaskIndex][(n)])
-  # endif // if DEBUG_PCONFIG_RANGE_CHECK
+# if DEBUG_PCONFIG_RANGE_CHECK
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+#   define PCONFIG_FLOAT(n) do_PCONFIG_FLOAT(event, n, __LINE__, F(__FILE__))
+#  elif DEBUG_PCONFIG_RANGE_CHECK > 1
+#   define PCONFIG_FLOAT(n) do_PCONFIG_FLOAT(event, n, __LINE__)
+#  else // if DEBUG_PCONFIG_RANGE_CHECK > 2
+#   define PCONFIG_FLOAT(n) do_PCONFIG_FLOAT(event, n)
+#  endif // if DEBUG_PCONFIG_RANGE_CHECK > 2
+# else // if DEBUG_PCONFIG_RANGE_CHECK
+#  define PCONFIG_FLOAT(n) (Settings.TaskDevicePluginConfigFloat[event->TaskIndex][(n)])
+# endif // if DEBUG_PCONFIG_RANGE_CHECK
 #endif // ifndef PCONFIG_FLOAT
 #ifndef PCONFIG_LONG
-  # if DEBUG_PCONFIG_RANGE_CHECK
-    #  define PCONFIG_LONG(n) do_PCONFIG_LONG(event, n)
-  # else
-    #  define PCONFIG_LONG(n) (Settings.TaskDevicePluginConfigLong[event->TaskIndex][(n)])
-  # endif // if DEBUG_PCONFIG_RANGE_CHECK
+# if DEBUG_PCONFIG_RANGE_CHECK
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+#   define PCONFIG_LONG(n) do_PCONFIG_LONG(event, n, __LINE__, F(__FILE__))
+#  elif DEBUG_PCONFIG_RANGE_CHECK > 1
+#   define PCONFIG_LONG(n) do_PCONFIG_LONG(event, n, __LINE__)
+#  else // if DEBUG_PCONFIG_RANGE_CHECK > 2
+#   define PCONFIG_LONG(n) do_PCONFIG_LONG(event, n)
+#  endif // if DEBUG_PCONFIG_RANGE_CHECK > 2
+# else // if DEBUG_PCONFIG_RANGE_CHECK
+#  define PCONFIG_LONG(n) (Settings.TaskDevicePluginConfigLong[event->TaskIndex][(n)])
+# endif // if DEBUG_PCONFIG_RANGE_CHECK
 #endif // ifndef PCONFIG_LONG
 #ifndef PCONFIG_ULONG
-  # if DEBUG_PCONFIG_RANGE_CHECK
-    #  define PCONFIG_ULONG(n) do_PCONFIG_ULONG(event, n)
-  # else
-    #  define PCONFIG_ULONG(n) (Settings.TaskDevicePluginConfigULong[event->TaskIndex][(n)])
-  # endif // if DEBUG_PCONFIG_RANGE_CHECK
+# if DEBUG_PCONFIG_RANGE_CHECK
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+#   define PCONFIG_ULONG(n) do_PCONFIG_ULONG(event, n, __LINE__, F(__FILE__))
+#  elif DEBUG_PCONFIG_RANGE_CHECK > 1
+#   define PCONFIG_ULONG(n) do_PCONFIG_ULONG(event, n, __LINE__)
+#  else // if DEBUG_PCONFIG_RANGE_CHECK > 2
+#   define PCONFIG_ULONG(n) do_PCONFIG_ULONG(event, n)
+#  endif // if DEBUG_PCONFIG_RANGE_CHECK > 2
+# else // if DEBUG_PCONFIG_RANGE_CHECK
+#  define PCONFIG_ULONG(n) (Settings.TaskDevicePluginConfigULong[event->TaskIndex][(n)])
+# endif // if DEBUG_PCONFIG_RANGE_CHECK
 #endif // ifndef PCONFIG_ULONG
 #ifndef PIN
 
 // Please note the 'offset' of N compared to normal pin numbering.
-  # if DEBUG_PCONFIG_RANGE_CHECK
-    #  define PIN(n) do_PIN(event, n)
-  # else
-  #  define PIN(n) (Settings.TaskDevicePin[n][event->TaskIndex])
-  # endif // if DEBUG_PCONFIG_RANGE_CHECK
+# if DEBUG_PCONFIG_RANGE_CHECK
+#  if DEBUG_PCONFIG_RANGE_CHECK > 2
+#   define PIN(n) do_PIN(event, n, __LINE__, F(__FILE__))
+#  elif DEBUG_PCONFIG_RANGE_CHECK > 1
+#   define PIN(n) do_PIN(event, n, __LINE__)
+#  else // if DEBUG_PCONFIG_RANGE_CHECK > 2
+#   define PIN(n) do_PIN(event, n)
+#  endif // if DEBUG_PCONFIG_RANGE_CHECK > 2
+# else // if DEBUG_PCONFIG_RANGE_CHECK
+#  define PIN(n) (Settings.TaskDevicePin[n][event->TaskIndex])
+# endif // if DEBUG_PCONFIG_RANGE_CHECK
 #endif // ifndef PIN
 #ifndef CONFIG_PIN1
-  # define CONFIG_PIN1 (Settings.TaskDevicePin1[event->TaskIndex])
+# define CONFIG_PIN1 (Settings.TaskDevicePin1[event->TaskIndex])
 #endif // ifndef CONFIG_PIN1
 #ifndef CONFIG_PIN2
-  # define CONFIG_PIN2 (Settings.TaskDevicePin2[event->TaskIndex])
+# define CONFIG_PIN2 (Settings.TaskDevicePin2[event->TaskIndex])
 #endif // ifndef CONFIG_PIN2
 #ifndef CONFIG_PIN3
-  # define CONFIG_PIN3 (Settings.TaskDevicePin3[event->TaskIndex])
+# define CONFIG_PIN3 (Settings.TaskDevicePin3[event->TaskIndex])
 #endif // ifndef CONFIG_PIN3
 #ifndef CONFIG_PORT
-  # define CONFIG_PORT (Settings.TaskDevicePort[event->TaskIndex])
+# define CONFIG_PORT (Settings.TaskDevicePort[event->TaskIndex])
 #endif // ifndef CONFIG_PORT
 
 

src/src/CustomBuild/define_plugin_sets.h

@@ -4654,11 +4654,19 @@ To create/register a plugin, you have to :
 
 
 #ifndef DEBUG_PCONFIG_RANGE_CHECK
-#ifndef BUILD_NO_DEBUG
-#define DEBUG_PCONFIG_RANGE_CHECK 1
-#else
-#define DEBUG_PCONFIG_RANGE_CHECK 0
-#endif 
+// 0: no range check (use for builds with already build size issues)
+// 1: Basic range check, log when out of bounds
+// 2: Include line nr of file where error occured
+// 3: include filename
+# ifndef BUILD_NO_DEBUG
+#  ifdef PLUGIN_BUILD_MAX_ESP32
+#   define DEBUG_PCONFIG_RANGE_CHECK 2
+#  else
+#   define DEBUG_PCONFIG_RANGE_CHECK 1
+#  endif
+# else
+#  define DEBUG_PCONFIG_RANGE_CHECK 0
+# endif 
 #endif