feat(esp_repl): Add esp_linenoise and esp_commands dependencies

Author: SoucheSouche

esp_repl/CMakeLists.txt

@@ -5,4 +5,4 @@ set(srcs "esp_repl.c")
 idf_component_register(
                     SRCS ${srcs}
                     INCLUDE_DIRS include
-                    PRIV_INCLUDE_DIRS private_include)
+                    REQUIRES esp_linenoise esp_commands)

esp_repl/esp_repl.c

@@ -1,3 +1,4 @@
+
 /*
  * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
  *
@@ -9,7 +10,8 @@
 #include "freertos/semphr.h"
 #include "esp_repl.h"
 #include "esp_err.h"
-
+#include "esp_commands.h"
+#include "esp_linenoise.h"
 typedef enum {
     ESP_REPL_STATE_RUNNING,
     ESP_REPL_STATE_STOPPED
@@ -32,10 +34,9 @@ typedef struct esp_repl_instance {
     }                                                                                                 \
 } while(0)
 
-esp_err_t esp_repl_create(esp_repl_instance_handle_t *handle, const esp_repl_config_t *config)
+esp_err_t   esp_repl_create(esp_repl_instance_handle_t *handle, const esp_repl_config_t *config)
 {
-    if ((config->executor.func == NULL) ||
-            (config->reader.func == NULL) ||
+    if ((config->linenoise_handle == NULL) ||
             (config->max_cmd_line_size == 0)) {
         return ESP_ERR_INVALID_ARG;
     }
@@ -106,7 +107,21 @@ esp_err_t esp_repl_stop(esp_repl_instance_handle_t handle)
     /* update the state to force the while loop in esp_repl to return */
     state->state = ESP_REPL_STATE_STOPPED;
 
-    /* Call the on_stop callback to let the user unblock reader.func, if provided */
+    /* Call the abort function from esp_linenoise to force esp_linenoise_get_line to return.
+     * This function is expected to return ESP_OK only if the user has registered a custom
+     * read to the esp_linenoise instance and if the abort function succeeds.
+     * ESP_ERR_INVALID_STATE is expected to be returned by esp_linenoise_abort if it is called
+     * when the user has registered a custom read to the esp_linenoise instance. From the point
+     * of view of esp_repl_stop, this return value if indicating that the user will have to take
+     * care of returning from its own custom read by himself through the call of the on_stop callback,
+     * therefore set the return value of esp_repl_stop to ESP_OK. */
+    esp_err_t ret_val = esp_linenoise_abort(config->linenoise_handle);
+    if (ret_val == ESP_ERR_INVALID_STATE) {
+        ret_val = ESP_OK;
+    }
+
+    /* Call the on_stop callback to let the user unblock esp_linenoise
+     * if a custom read is provided */
     if (config->on_stop.func != NULL) {
         config->on_stop.func(config->on_stop.ctx, handle);
     }
@@ -117,7 +132,7 @@ esp_err_t esp_repl_stop(esp_repl_instance_handle_t handle)
     /* give it back so destroy can also take/give symmetrically */
     xSemaphoreGive(state->mux);
 
-    return ESP_OK;
+    return ret_val;
 }
 
 void esp_repl(esp_repl_instance_handle_t handle)
@@ -140,11 +155,22 @@ void esp_repl(esp_repl_instance_handle_t handle)
      * function is called. */
     xSemaphoreTake(state->mux, portMAX_DELAY);
 
+    esp_linenoise_handle_t l_hdl = config->linenoise_handle;
+    esp_command_set_handle_t c_set = config->command_set_handle;
+
     /* REPL loop */
     while (state->state == ESP_REPL_STATE_RUNNING) {
 
         /* try to read a command line */
-        const esp_err_t read_ret = config->reader.func(config->reader.ctx, cmd_line, cmd_line_size);
+        const esp_err_t read_ret = esp_linenoise_get_line(l_hdl, cmd_line, cmd_line_size);
+
+        /* Add the command to the history */
+        esp_linenoise_history_add(l_hdl, cmd_line);
+
+        /* Save command history to filesystem */
+        if (config->history_save_path) {
+            esp_linenoise_history_save(l_hdl, config->history_save_path);
+        }
 
         /* forward the raw command line to the pre executor callback (e.g., save in history).
          * this callback is not necessary for the user to register, continue if it isn't */
@@ -159,7 +185,7 @@ void esp_repl(esp_repl_instance_handle_t handle)
 
         /* try to run the command */
         int cmd_func_ret;
-        const esp_err_t exec_ret = config->executor.func(config->executor.ctx, cmd_line, &cmd_func_ret);
+        const esp_err_t exec_ret = esp_commands_execute(c_set, cmd_line, &cmd_func_ret);
 
         /* forward the raw command line to the post executor callback (e.g., save in history).
          * this callback is not necessary for the user to register, continue if it isn't */
@@ -181,4 +207,6 @@ void esp_repl(esp_repl_instance_handle_t handle)
     if (config->on_exit.func != NULL) {
         config->on_exit.func(config->on_exit.ctx, handle);
     }
+
+    printf("returned from get_line\n");
 }

esp_repl/idf_component.yml

@@ -2,7 +2,12 @@ version: "1.0.0"
 description: "esp_repl - Read Eval Print Loop component"
 url: https://github.com/espressif/idf-extra-components/tree/master/esp_repl
 dependencies:
-  idf: ">=6.0"
+  SoucheSouche/esp_linenoise:
+    version: "*"
+    registry_url: https://components-staging.espressif.com
+  SoucheSouche/esp_commands:
+    version: "*"
+    registry_url: https://components-staging.espressif.com
 sbom:
   manifests:
     - path: sbom_esp_repl.yml

esp_repl/include/esp_repl.h

@@ -11,31 +11,14 @@ extern "C" {
 
 #include <stdbool.h>
 #include "esp_err.h"
+#include "esp_linenoise.h"
+#include "esp_commands.h"
 
 /**
  * @brief Handle to a REPL instance.
  */
 typedef struct esp_repl_instance *esp_repl_instance_handle_t;
 
-/**
- * @brief Function prototype for reading input for the REPL.
- *
- * @param ctx User-defined context pointer.
- * @param buf Buffer to store the read data.
- * @param buf_size Size of the buffer in bytes.
- *
- * @return ESP_OK on success, error code otherwise.
- */
-typedef esp_err_t (*esp_repl_reader_fn)(void *ctx, char *buf, size_t buf_size);
-
-/**
- * @brief Reader configuration structure for the REPL.
- */
-typedef struct esp_repl_reader {
-    esp_repl_reader_fn func; /**!< Function to read input */
-    void *ctx;               /**!< Context passed to the reader function */
-} esp_repl_reader_t;
-
 /**
  * @brief Function prototype called before executing a command.
  *
@@ -55,25 +38,6 @@ typedef struct esp_repl_pre_executor {
     void *ctx;                      /**!< Context passed to the pre-executor function */
 } esp_repl_pre_executor_t;
 
-/**
- * @brief Function prototype to execute a REPL command.
- *
- * @param ctx User-defined context pointer.
- * @param buf Null-terminated command string.
- * @param ret_val Pointer to store the command return value.
- *
- * @return ESP_OK on success, error code otherwise.
- */
-typedef esp_err_t (*esp_repl_executor_fn)(void *ctx, const char *buf, int *ret_val);
-
-/**
- * @brief Executor configuration structure for the REPL.
- */
-typedef struct esp_repl_executor {
-    esp_repl_executor_fn func; /**!< Function to execute commands */
-    void *ctx;                  /**!< Context passed to the executor function */
-} esp_repl_executor_t;
-
 /**
  * @brief Function prototype called after executing a command.
  *
@@ -133,13 +97,14 @@ typedef struct esp_repl_on_exit {
  * @brief Configuration structure to initialize a REPL instance.
  */
 typedef struct esp_repl_config {
-    size_t max_cmd_line_size;        /**!< Maximum allowed command line size */
-    esp_repl_reader_t reader;        /**!< Reader callback and context */
-    esp_repl_pre_executor_t pre_executor;   /**!< Pre-executor callback and context */
-    esp_repl_executor_t executor;           /**!< Executor callback and context */
-    esp_repl_post_executor_t post_executor; /**!< Post-executor callback and context */
-    esp_repl_on_stop_t on_stop;             /**!< Stop callback and context */
-    esp_repl_on_exit_t on_exit;             /**!< Exit callback and context */
+    esp_linenoise_handle_t linenoise_handle;    /**!< Handle to the esp_linenoise instance */
+    esp_command_set_handle_t command_set_handle;   /**!< Handle to a set of commands */
+    size_t max_cmd_line_size;                   /**!< Maximum allowed command line size */
+    const char *history_save_path;              /**!< Path to file to save the history */
+    esp_repl_pre_executor_t pre_executor;       /**!< Pre-executor callback and context */
+    esp_repl_post_executor_t post_executor;     /**!< Post-executor callback and context */
+    esp_repl_on_stop_t on_stop;                 /**!< Stop callback and context */
+    esp_repl_on_exit_t on_exit;                 /**!< Exit callback and context */
 } esp_repl_config_t;
 
 /**

esp_repl/test_apps/main/CMakeLists.txt

@@ -1,3 +1,4 @@
+
 idf_component_register(SRCS "test_esp_repl.c" "test_main.c"
                     PRIV_INCLUDE_DIRS "." "include"
                     PRIV_REQUIRES unity