feat(cli): Update to no longer require exception support (#519)

finger563 · web-flow · commit d1d5a8b0b316 · 2025-09-16T09:30:11.000-05:00
* feat(cli): Update to no longer require exception support

* fix drv and iperf menu examples

* minor update to cli component to reduce overhead when packaging

* minor update
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -95,15 +95,9 @@ jobs:
         - path: 'components/i2c/example'
           target: esp32
           command: idf.py -DSDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.defaults.legacy_api" build
-        - path: 'components/i2c/example'
-          target: esp32
-          command: idf.py -DSDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.defaults.legacy_api;sdkconfig.defaults.cli" build
         - path: 'components/i2c/example'
           target: esp32
           command: idf.py -DSDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.defaults.new_api" build
-        - path: 'components/i2c/example'
-          target: esp32
-          command: idf.py -DSDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.defaults.new_api;sdkconfig.defaults.cli;" build
 
         - path: 'components/icm20948/example'
           target: esp32s3
diff --git a/components/binary-log/example/sdkconfig.defaults b/components/binary-log/example/sdkconfig.defaults
@@ -2,9 +2,6 @@ CONFIG_IDF_TARGET="esp32s3"
 
 # Common ESP-related
 #
-# binary_log requires exceptions right now...
-# CONFIG_COMPILER_CXX_EXCEPTIONS=y
-
 CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
 CONFIG_ESPTOOLPY_FLASHSIZE="4MB"
 
diff --git a/components/ble_gatt_server/example/main/ble_gatt_server_example.cpp b/components/ble_gatt_server/example/main/ble_gatt_server_example.cpp
@@ -105,7 +105,6 @@ extern "C" void app_main(void) {
     adv_data.addTxPower();
     ble_gatt_server.set_advertisement_data(adv_data);
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS
     // let's test and use the BLE menu (CLI)
     // turn off some of the logs so that it doesn't clutter up the CLI
     ble_gatt_server.set_log_level(espp::Logger::Verbosity::WARN);
@@ -118,7 +117,6 @@ extern "C" void app_main(void) {
     espp::Cli input(cli);
     input.SetInputHistorySize(10);
     input.Start(); // this will not return until the user enters the `exit` command.
-#endif
 
     logger.info("Menu has finished, starting advertising");
     // The menu has finished, so let's go into a loop to keep the device running
diff --git a/components/ble_gatt_server/example/sdkconfig.defaults b/components/ble_gatt_server/example/sdkconfig.defaults
@@ -36,6 +36,3 @@ CONFIG_BT_NIMBLE_HOST_TASK_STACK_SIZE=8192
 
 # Set the ESP-NIMBLE-CPP Config
 CONFIG_NIMBLE_CPP_LOG_LEVEL_NONE=y
-
-# the cli library requires exceptions right now...
-CONFIG_COMPILER_CXX_EXCEPTIONS=y
diff --git a/components/ble_gatt_server/include/ble_gatt_server_menu.hpp b/components/ble_gatt_server/include/ble_gatt_server_menu.hpp
@@ -2,7 +2,6 @@
 
 #include <sdkconfig.h>
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
 #if CONFIG_BT_NIMBLE_ENABLED || defined(_DOXYGEN_)
 
 #include <functional>
@@ -400,4 +399,3 @@ class BleGattServerMenu {
 } // namespace espp
 
 #endif // CONFIG_BT_NIMBLE_ENABLED || defined(_DOXYGEN_)
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
diff --git a/components/cli/CMakeLists.txt b/components/cli/CMakeLists.txt
@@ -1,12 +1,4 @@
-set(CLI_INCLUDES "include")
-
-if (CONFIG_COMPILER_CXX_EXCEPTIONS)
-  list(APPEND CLI_INCLUDES "detail/cli/include")
-else()
-  message(WARNING "C++ exceptions are disabled, CLI is disabled")
-endif()
-
 idf_component_register(
-  INCLUDE_DIRS ${CLI_INCLUDES}
+  INCLUDE_DIRS "include" "detail/cli/include"
   SRC_DIRS "src"
   REQUIRES driver esp_driver_uart esp_driver_usb_serial_jtag vfs logger)
diff --git a/components/cli/detail/cli b/components/cli/detail/cli
@@ -1 +1 @@
-Subproject commit cd9caa5192873d3d8a7e3832f92ed4f497233805
+Subproject commit 8d69ecae6e8695659e30e32e83cd1781dd2d8ce7
diff --git a/components/cli/example/main/cli_example.cpp b/components/cli/example/main/cli_example.cpp
@@ -18,6 +18,9 @@ extern "C" void app_main(void) {
         "hello_everysession",
         [](std::ostream &) { cli::Cli::cout() << "Hello everybody" << std::endl; },
         "Print hello everybody on all open sessions");
+    root_menu->Insert(
+        "add", [](std::ostream &out, float x, float y) { out << (x + y) << "\n"; },
+        "Add two numbers");
     root_menu->Insert(
         "answer", [](std::ostream &out, int x) { out << "The answer is: " << x << "\n"; },
         "Print the answer to Life, the Universe and Everything ");
diff --git a/components/cli/example/sdkconfig.defaults b/components/cli/example/sdkconfig.defaults
@@ -2,6 +2,3 @@
 #
 CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE=4096
 CONFIG_ESP_MAIN_TASK_STACK_SIZE=8192
-
-# the cli library requires exceptions right now...
-CONFIG_COMPILER_CXX_EXCEPTIONS=y
diff --git a/components/cli/idf_component.yml b/components/cli/idf_component.yml
@@ -14,6 +14,11 @@ tags:
   - Command-Line
   - CLI
   - Input
+files:
+  exclude:
+    - "detail/cli/**/*" # exclude everything in the cli repo
+  include:
+    - "detail/cli/include/**/*" # explicitly only include the include folder
 dependencies:
   idf:
     version: '>=5.0'
diff --git a/components/cli/include/cli.hpp b/components/cli/include/cli.hpp
@@ -3,8 +3,6 @@
 #if defined(ESP_PLATFORM)
 #include <sdkconfig.h>
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
-
 #define __linux__
 
 #include "driver/uart.h"
@@ -283,7 +281,6 @@ class Cli : private cli::CliSession {
    * @brief Construct a Cli object and call
    *        espp::Cli::configure_stdin_stdout() to ensure that std::cin works
    *        as needed.
-   * @throw std::invalid_argument if @c _in or @c out are invalid streams
    * @param _cli the cli::Cli object containing the menus and functions to
    *        run.
    * @param _in The input stream from which to read characters.
@@ -293,10 +290,8 @@ class Cli : private cli::CliSession {
       : CliSession(_cli, _out, 1)
       , exit(false)
       , in(_in) {
-    if (!_in.good())
-      throw std::invalid_argument("istream invalid");
-    if (!_out.good())
-      throw std::invalid_argument("ostream invalid");
+    if (!_in.good() || !_out.good())
+      exit = true;
     ExitAction([this](std::ostream &) { exit = true; });
     // for std::cin to work (it must be blocking), we need to configure the uart
     // driver to have it block. see
@@ -308,7 +303,10 @@ class Cli : private cli::CliSession {
    * @brief Set the input history size for this session.
    * @param history_size new History size. Must be >= 1.
    */
-  void SetInputHistorySize(size_t history_size) { line_input_.set_history_size(history_size); }
+  void SetInputHistorySize(size_t history_size) {
+    line_input_.set_history_size(history_size);
+    SetHistoryMaxSize(history_size);
+  }
 
   /**
    * @brief Set the input history - replaces any existing history.
@@ -391,6 +389,4 @@ class Cli : private cli::CliSession {
 };
 } // namespace espp
 
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS
-
 #endif // ESP_PLATFORM
diff --git a/components/cli/include/line_input.hpp b/components/cli/include/line_input.hpp
@@ -4,8 +4,6 @@
 
 #include <sdkconfig.h>
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
-
 #include <algorithm>
 #include <atomic>
 #include <deque>
@@ -428,6 +426,4 @@ class LineInput {
 };
 } // namespace espp
 
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS
-
 #endif // ESP_PLATFORM
diff --git a/components/cli/src/cli.cpp b/components/cli/src/cli.cpp
@@ -1,5 +1,3 @@
 #include "cli.hpp"
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
 bool espp::Cli::configured_ = false;
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS
diff --git a/components/drv2605/example/main/drv2605_example.cpp b/components/drv2605/example/main/drv2605_example.cpp
@@ -7,10 +7,7 @@
 #include "logger.hpp"
 #include "task.hpp"
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS
-#include "cli.hpp"
 #include "drv2605_menu.hpp"
-#endif
 
 using namespace std::chrono_literals;
 
@@ -49,7 +46,6 @@ extern "C" void app_main(void) {
       logger.error("select library failed: {}", ec.message());
     }
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS
     //! [drv2605 menu example]
     using DriverPtr = std::shared_ptr<Driver>;
     // since we're wrapping a stack-allocated object, we need to ensure that the
@@ -68,7 +64,6 @@ extern "C" void app_main(void) {
     // the user enters the `exit` command.
     input.Start();
     //! [drv2605 menu example]
-#endif
 
     // do the calibration for the LRA motor
     Driver::LraCalibrationSettings lra_calibration_settings{};
diff --git a/components/drv2605/include/drv2605_menu.hpp b/components/drv2605/include/drv2605_menu.hpp
@@ -2,8 +2,6 @@
 
 #include <sdkconfig.h>
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
-
 #include <functional>
 #include <memory>
 #include <vector>
@@ -115,20 +113,18 @@ class Drv2605Menu {
           // convert the string IDs to integers
           std::vector<uint8_t> waveform_ids;
           for (const auto &id_str : waveforms) {
-            try {
-              int id = std::stoi(id_str);
-              if (id < 1 || id > 123) {
-                throw std::out_of_range("ID out of range");
-              }
-              waveform_ids.push_back(id);
-            } catch (const std::invalid_argument &) {
+            char *endptr = nullptr;
+            int id = static_cast<int>(std::strtol(id_str.c_str(), &endptr, 10));
+            if (endptr != id_str.c_str() + id_str.size()) {
               out << "Invalid waveform ID: " << id_str
                   << ". Must be an integer between 1 and 123.\n";
               return;
-            } catch (const std::out_of_range &) {
+            }
+            if (id < 1 || id > 123) {
               out << "Waveform ID out of range: " << id_str << ". Must be between 1 and 123.\n";
               return;
             }
+            waveform_ids.push_back(id);
           }
           set_waveforms(out, waveform_ids);
         },
@@ -314,4 +310,3 @@ class Drv2605Menu {
   std::vector<std::shared_ptr<Driver>> drivers_;
 }; // class Drv2605Menu
 } // namespace espp
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
diff --git a/components/i2c/example/main/i2c_example.cpp b/components/i2c/example/main/i2c_example.cpp
@@ -24,7 +24,6 @@ extern "C" void app_main(void) {
 //////////////////////////////////
 #if defined(CONFIG_ESPP_I2C_USE_LEGACY_API)
   {
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
     //! [i2c menu example]
     espp::I2c i2c({
         .port = I2C_NUM_0,
@@ -45,9 +44,6 @@ extern "C" void app_main(void) {
 
     input.Start();
     //! [i2c menu example]
-#else
-    logger.warn("C++ exceptions are not enabled, skipping I2C menu example");
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
   }
 
   {
@@ -126,7 +122,6 @@ extern "C" void app_main(void) {
     }
     logger.info("[NEW API] Created device with address {:#02x}", dev->get_device_address());
     //! [i2c master device creation example]
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
     //! [i2c master menu example]
     using espp::I2cMasterDeviceMenu;
     using espp::I2cMasterMenu;
@@ -143,7 +138,6 @@ extern "C" void app_main(void) {
     input.SetInputHistorySize(10);
     input.Start();
     //! [i2c master menu example]
-#else // CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
 
     //! [i2c master bus probe example]
     // NOTE: we turn off logging for this so we don't spam the console
@@ -177,8 +171,6 @@ extern "C" void app_main(void) {
     }
     //! [i2c master device read example]
 
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
-
     // test manually calling the deinit methods
     dev->deinit(ec);
     // you must ensure the bus is not destroyed or deinitialized until after all
diff --git a/components/i2c/example/sdkconfig.defaults.cli b/components/i2c/example/sdkconfig.defaults.cli
diff --git a/components/i2c/include/i2c_master_device_menu.hpp b/components/i2c/include/i2c_master_device_menu.hpp
@@ -4,8 +4,6 @@
 
 #if defined(CONFIG_ESPP_I2C_USE_NEW_API) || defined(__DOXYGEN__)
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(__DOXYGEN__)
-
 #include <functional>
 #include <memory>
 #include <vector>
@@ -166,6 +164,4 @@ template <typename RegisterType = uint8_t> class I2cMasterDeviceMenu {
 
 } // namespace espp
 
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS || defined(__DOXYGEN__)
-
 #endif // CONFIG_ESPP_I2C_USE_NEW_API || defined(__DOXYGEN__)
diff --git a/components/i2c/include/i2c_master_menu.hpp b/components/i2c/include/i2c_master_menu.hpp
@@ -5,8 +5,6 @@
 // Only include this menu if the new API is selected
 #if defined(CONFIG_ESPP_I2C_USE_NEW_API) || defined(__DOXYGEN__)
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(__DOXYGEN__)
-
 #include <functional>
 #include <memory>
 #include <vector>
@@ -202,6 +200,4 @@ class I2cMasterMenu {
 
 } // namespace espp
 
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS || defined(__DOXYGEN__)
-
 #endif // CONFIG_ESPP_I2C_USE_NEW_API || defined(__DOXYGEN__)
diff --git a/components/i2c/include/i2c_menu.hpp b/components/i2c/include/i2c_menu.hpp
@@ -5,8 +5,6 @@
 // Only include this menu if the legacy API is selected
 #if defined(CONFIG_ESPP_I2C_USE_LEGACY_API) || defined(__DOXYGEN__)
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
-
 #include <functional>
 #include <memory>
 #include <vector>
@@ -216,6 +214,4 @@ class I2cMenu {
 };
 } // namespace espp
 
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
-
 #endif // CONFIG_ESPP_I2C_USE_LEGACY_API
diff --git a/components/i2c/include/i2c_slave_menu.hpp b/components/i2c/include/i2c_slave_menu.hpp
@@ -5,8 +5,6 @@
 // Only include this menu if the new API is selected
 #if defined(CONFIG_ESPP_I2C_USE_NEW_API) || defined(__DOXYGEN__)
 
-#if CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
-
 #include <functional>
 #include <memory>
 #include <string>
@@ -109,6 +107,4 @@ class I2cSlaveMenu {
 
 } // namespace espp
 
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS || defined(_DOXYGEN_)
-
 #endif // CONFIG_ESPP_I2C_USE_NEW_API
diff --git a/components/iperf_menu/CMakeLists.txt b/components/iperf_menu/CMakeLists.txt
@@ -1,3 +1,3 @@
 idf_component_register(
   INCLUDE_DIRS "include"
-  PRIV_REQUIRES format cli iperf)
+  REQUIRES format cli iperf)
diff --git a/components/iperf_menu/example/CMakeLists.txt b/components/iperf_menu/example/CMakeLists.txt
@@ -6,8 +6,10 @@ include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
 # add the component directories that we want to use
 set(EXTRA_COMPONENT_DIRS
+  "../../../components/cli"
   "../../../components/format"
   "../../../components/iperf_menu"
+  "../../../components/logger"
   "../../../components/task"
   "../../../components/wifi"
 )
diff --git a/components/iperf_menu/example/main/iperf_menu_example.cpp b/components/iperf_menu/example/main/iperf_menu_example.cpp
diff --git a/components/iperf_menu/example/sdkconfig.defaults b/components/iperf_menu/example/sdkconfig.defaults
diff --git a/components/iperf_menu/include/iperf_menu.hpp b/components/iperf_menu/include/iperf_menu.hpp
diff --git a/components/state_machine/example/sdkconfig.defaults b/components/state_machine/example/sdkconfig.defaults
diff --git a/components/wifi/example/main/wifi_example.cpp b/components/wifi/example/main/wifi_example.cpp
diff --git a/components/wifi/include/wifi_ap_menu.hpp b/components/wifi/include/wifi_ap_menu.hpp
diff --git a/components/wifi/include/wifi_sta_menu.hpp b/components/wifi/include/wifi_sta_menu.hpp
diff --git a/doc/Doxyfile b/doc/Doxyfile

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,6 @@ CONFIG_IDF_TARGET="esp32s3"`
`2`	`2`
`3`	`3`	`# Common ESP-related`
`4`	`4`	`#`
`5`		`-# binary_log requires exceptions right now...`
`6`		`-# CONFIG_COMPILER_CXX_EXCEPTIONS=y`
`7`		`-`
`8`	`5`	`CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y`
`9`	`6`	`CONFIG_ESPTOOLPY_FLASHSIZE="4MB"`
`10`	`7`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,3 @@`
`2`	`2`	`#`
`3`	`3`	`CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE=4096`
`4`	`4`	`CONFIG_ESP_MAIN_TASK_STACK_SIZE=8192`
`5`		`-`
`6`		`-# the cli library requires exceptions right now...`
`7`		`-CONFIG_COMPILER_CXX_EXCEPTIONS=y`