Merge pull request #16 from esp-arduino-libs/feat/add_plugin

Feat/add plugin

Author: Lzw655

.github/workflows/build_test.yml

@@ -9,12 +9,12 @@ jobs:
   build:
     strategy:
       matrix:
-        idf_ver:    ["release-v5.1", "release-v5.2", "release-v5.3"]
-        idf_target: ["esp32", "esp32s3"]
-    runs-on: ubuntu-22.04
+        idf_ver:    ["release-v5.4", "release-v5.5"]
+        idf_target: ["esp32", "esp32c3", "esp32s3", "esp32p4"]
+    runs-on: ubuntu-latest
     container: espressif/idf:${{ matrix.idf_ver }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Build Test Application
         env:
           IDF_TARGET: ${{ matrix.idf_target }}

CHANGELOG.md

@@ -1,5 +1,21 @@
 # ChangeLog
 
+## v0.3.0 - 2025-07-24
+
+### Breaking Changes:
+
+* break(repo): update esp-idf version to >= 5.4
+* break(repo): update arduino-esp32 version to >= v3.2.0
+* break(repo): enable plugin registry (with `COMPILER_CXX_RTTI`) by default
+
+### Enhancements:
+
+* feat(more): add plugin registry
+
+### Bugfixes:
+
+* fix(check): rename 'err' to avoid name conflicts
+
 ## v0.2.3 - 2025-07-03
 
 ### Enhancements:

Kconfig

@@ -226,5 +226,13 @@ menu "ESP Library Utils Configurations"
                     default ""
             endif # ESP_UTILS_CONF_MEM_ENABLE_CXX_GLOB_ALLOC
         endmenu
+
+        config ESP_UTILS_CONF_PLUGIN_SUPPORT
+            bool "Plugin support"
+            default y
+            select COMPILER_CXX_RTTI
+            help
+                If enabled, the driver will enable `COMPILER_CXX_RTTI` to support plugin mechanism.
+
     endif # ESP_UTILS_CONF_FILE_SKIP
 endmenu

README.md

@@ -45,7 +45,7 @@
 
 |                 **Dependency**                  | **Version** |
 | ----------------------------------------------- | ----------- |
-| [esp-idf](https://github.com/espressif/esp-idf) | >= 5.1      |
+| [esp-idf](https://github.com/espressif/esp-idf) | >= 5.4      |
 
 #### Adding to Project
 
@@ -73,7 +73,7 @@ When developing with esp-idf, users can configure `esp-lib-utils` through the me
 
 |                       **Dependency**                        | **Version** |
 | ----------------------------------------------------------- | ----------- |
-| [arduino-esp32](https://github.com/espressif/arduino-esp32) | >= v3.0.0   |
+| [arduino-esp32](https://github.com/espressif/arduino-esp32) | >= v3.2.0   |
 
 #### Installing the Library
 

esp_utils_conf.h

@@ -131,6 +131,16 @@
 
 #endif // ESP_UTILS_CONF_MEM_ENABLE_CXX_GLOB_ALLOC
 
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////// Plugin Configurations /////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/**
+ * @brief If enabled, the driver will support plugin mechanism
+ *
+ * @note This configuration requires C++ RTTI support
+ */
+#define ESP_UTILS_CONF_PLUGIN_SUPPORT                       (0)
+
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////// File Version ///////////////////////////////////////////////////////////
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -142,7 +152,7 @@
  * 3. Patch version mismatch: No impact on functionality
  */
 #define ESP_UTILS_CONF_FILE_VERSION_MAJOR 1
-#define ESP_UTILS_CONF_FILE_VERSION_MINOR 4
+#define ESP_UTILS_CONF_FILE_VERSION_MINOR 5
 #define ESP_UTILS_CONF_FILE_VERSION_PATCH 0
 
 // *INDENT-ON*

idf_component.yml

@@ -1,7 +1,7 @@
-version: "0.2.3"
+version: "0.3.0"
 description: esp-lib-utils is a library designed for ESP SoCs to provide utility functions, including logging, checking, and memory.
 url: https://github.com/esp-arduino-libs/esp-lib-utils
 repository: https://github.com/esp-arduino-libs/esp-lib-utils.git
 issues: https://github.com/esp-arduino-libs/esp-lib-utils/issues
 dependencies:
-  idf: ">=5.1"
+  idf: ">=5.4"

library.properties

@@ -1,5 +1,5 @@
 name=esp-lib-utils
-version=0.2.3
+version=0.3.0
 author=espressif
 maintainer=espressif
 sentence=esp-lib-utils is a library designed for ESP SoCs to provide utility functions, including logging, checking, and memory.

src/check/esp_utils_check.h

@@ -103,8 +103,7 @@
  * @param ... Additional arguments for the format string
  */
 #define ESP_UTILS_CHECK_ERROR_RETURN(x, ret, fmt, ...) do { \
-            esp_err_t err = (x);                        \
-            if (unlikely(err != ESP_OK)) {                          \
+            if (unlikely((x) != ESP_OK)) {                          \
                 return ret;                              \
             }                                            \
         } while(0)
@@ -310,9 +309,9 @@
  * @param ... Additional arguments for the format string
  */
 #define ESP_UTILS_CHECK_ERROR_RETURN(x, ret, fmt, ...) do { \
-            esp_err_t err = (x);                        \
-            if (unlikely(err != ESP_OK)) {                          \
-                ESP_UTILS_LOGE(fmt " [%s]", ##__VA_ARGS__, esp_err_to_name(err)); \
+            esp_err_t _err_ = (x);                        \
+            if (unlikely(_err_ != ESP_OK)) {                          \
+                ESP_UTILS_LOGE(fmt " [%s]", ##__VA_ARGS__, esp_err_to_name(_err_)); \
                 return ret;                              \
             }                                            \
         } while(0)
@@ -326,9 +325,9 @@
  * @param ... Additional arguments for the format string
  */
 #define ESP_UTILS_CHECK_ERROR_GOTO(x, goto_tag, fmt, ...) do { \
-            esp_err_t err = (x);                        \
-            if (unlikely((err) != ESP_OK)) {                   \
-                ESP_UTILS_LOGE(fmt " [%s]", ##__VA_ARGS__, esp_err_to_name(err)); \
+            esp_err_t _err_ = (x);                        \
+            if (unlikely(_err_ != ESP_OK)) {                   \
+                ESP_UTILS_LOGE(fmt " [%s]", ##__VA_ARGS__, esp_err_to_name(_err_)); \
                 goto goto_tag;                              \
             }                                               \
         } while(0)
@@ -341,9 +340,9 @@
  * @param ... Additional arguments for the format string
  */
 #define ESP_UTILS_CHECK_ERROR_EXIT(x, fmt, ...) do { \
-            esp_err_t err = (x);                        \
-            if (unlikely((err) != ESP_OK)) {                   \
-                ESP_UTILS_LOGE(fmt " [%s]", ##__VA_ARGS__, esp_err_to_name(err)); \
+            esp_err_t _err_ = (x);                        \
+            if (unlikely(_err_ != ESP_OK)) {                   \
+                ESP_UTILS_LOGE(fmt " [%s]", ##__VA_ARGS__, esp_err_to_name(_err_)); \
                 return;                           \
             }                                     \
         } while(0)

src/esp_lib_utils.h

@@ -20,10 +20,18 @@
 #include "memory/esp_utils_mem.h"
 
 #if defined(__cplusplus)
-/* Thread */
-#include "thread/esp_utils_thread.hpp"
+
 /* Log */
 #include "log/esp_utils_log.hpp"
+
+/* Thread */
+#include "thread/esp_utils_thread.hpp"
+
 /* More */
-#include "more/esp_utils_more.hpp"
+#include "more/esp_utils_value_guard.hpp"
+#include "more/esp_utils_function_guard.hpp"
+#if ESP_UTILS_CONF_PLUGIN_SUPPORT
+#   include "more/esp_utils_plugin_registry.hpp"
+#endif
+
 #endif // defined(__cplusplus)

src/esp_utils_conf_kconfig.h

@@ -168,3 +168,14 @@
 #       endif
 #   endif
 #endif
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+////////////////////////////////////////////////// Plugin Configurations /////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+#ifndef ESP_UTILS_CONF_PLUGIN_SUPPORT
+#   ifdef CONFIG_ESP_UTILS_CONF_PLUGIN_SUPPORT
+#       define ESP_UTILS_CONF_PLUGIN_SUPPORT        CONFIG_ESP_UTILS_CONF_PLUGIN_SUPPORT
+#   else
+#       define ESP_UTILS_CONF_PLUGIN_SUPPORT        (0)
+#   endif
+#endif