feat(esp_repl): Add option for esp_repl to register quit cmd

Author: SoucheSouche

esp_repl/Kconfig

@@ -0,0 +1,10 @@
+menu "esp_repl configuration"
+
+    config ESP_REPL_HAS_QUIT_CMD
+        bool "Register quit command"
+        default n
+        help
+            Register a static command "quit" that allows the user to return from the esp_repl main loop.
+            The command is registered through the ESP_COMMAND_REGISTER macro provided by esp_commands component
+            and is placed in the dedicated flash section.
+endmenu

esp_repl/esp_repl.c

@@ -29,6 +29,31 @@ typedef struct esp_repl_instance {
     esp_repl_state_t state;
 } esp_repl_instance_t;
 
+#if CONFIG_ESP_REPL_HAS_QUIT_CMD
+#define _ESP_REPL_STRINGIFY(x) #x
+#define ESP_REPL_GET_STR(x) _ESP_REPL_STRINGIFY(x)
+
+#define ESP_REPL_QUIT_CMD quit
+#define ESP_REPL_QUIT_CMD_STR ESP_REPL_GET_STR(ESP_REPL_QUIT_CMD)
+#define ESP_REPL_QUIT_CMD_SIZE strlen(ESP_REPL_QUIT_CMD_STR)
+
+/* dummy command function callback to allow the registration for the quit command
+ * to succeed */
+static int esp_repl_quit_cmd(void *context, const int fd_out, int argc, char **argv)
+{
+    return 0;
+}
+
+ESP_COMMAND_REGISTER(ESP_REPL_QUIT_CMD,
+                     "esp_repl",
+                     "This command will trigger the exit mechanism to exit from esp_repl() main loop",
+                     esp_repl_quit_cmd,
+                     NULL,
+                     NULL,
+                     NULL
+                    );
+#endif // CONFIG_ESP_REPL_HAS_QUIT_CMD
+
 #define ESP_REPL_CHECK_INSTANCE(handle) do {    \
         if(handle == NULL) {                    \
             return ESP_ERR_INVALID_ARG;         \
@@ -204,9 +229,30 @@ void esp_repl(esp_repl_handle_t handle)
             continue;
         }
 
+#if CONFIG_ESP_REPL_HAS_QUIT_CMD
+        /* evaluate the command name. make sure that the first argument of the cmd_line
+         * is ESP_REPL_QUIT_CMD_STR and the character following that is either a space
+         * or a null character */
+        if ((strncmp(ESP_REPL_QUIT_CMD_STR, cmd_line, ESP_REPL_QUIT_CMD_SIZE) == 0) &&
+                ((cmd_line[ESP_REPL_QUIT_CMD_SIZE] == ' ') || (cmd_line[ESP_REPL_QUIT_CMD_SIZE] == '\0'))) {
+            /* quit command received, call esp_repl_stop() */
+            if (esp_repl_stop(handle) == ESP_OK) {
+                /* if esp_repl_stop() was successful, retry the while condition.
+                 * the esp_repl state should have been changed which will force
+                 * the while to break */
+                continue;
+            }
+        }
+#endif // CONFIG_ESP_REPL_HAS_QUIT_CMD
+
         /* try to run the command */
         int cmd_func_ret;
-        const esp_err_t exec_ret = esp_commands_execute(c_set, -1, cmd_line, &cmd_func_ret);
+        int out_fd = -1;
+        const esp_err_t set_ret = esp_linenoise_get_out_fd(handle->config.linenoise_handle, &out_fd);
+        if (set_ret != ESP_OK) {
+            out_fd = STDOUT_FILENO;
+        }
+        const esp_err_t exec_ret = esp_commands_execute(c_set, out_fd, 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 */

esp_repl/idf_component.yml

@@ -2,7 +2,9 @@ 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:
-  espressif/esp_linenoise: '*'
+  SoucheSouche/esp_linenoise:
+    version: "*"
+    registry_url: https://components-staging.espressif.com
   SoucheSouche/esp_commands:
     version: "*"
     registry_url: https://components-staging.espressif.com

esp_repl/test_apps/main/test_esp_repl.c

@@ -71,13 +71,13 @@ static void test_send_characters(int socket_fd, const char *msg)
     TEST_ASSERT_EQUAL(msg_len, nwrite);
 }
 
-esp_err_t test_pre_executor(void *ctx, char *buf, const esp_err_t reader_ret_val)
+esp_err_t test_pre_executor(void *ctx, const char *buf, esp_err_t reader_ret_val)
 {
     s_pre_executor_nb_of_calls++;
     return ESP_OK;
 }
 
-esp_err_t test_post_executor(void *ctx, const char *buf, const esp_err_t executor_ret_val, const int cmd_ret_val)
+esp_err_t test_post_executor(void *ctx, const char *buf, esp_err_t executor_ret_val, int cmd_ret_val)
 {
     s_post_executor_nb_of_calls++;
     return ESP_OK;
@@ -222,14 +222,6 @@ TEST_CASE("esp_repl() loop calls all callbacks and exit on call to esp_repl_stop
     test_socket_teardown(s_socket_fd);
 }
 
-static int quit_command(void *context, const int fd_out, int argc, char **argv)
-{
-    esp_repl_handle_t repl_handle = (esp_repl_handle_t)context;
-    TEST_ASSERT_EQUAL(ESP_OK, esp_repl_stop(repl_handle));
-
-    return 0;
-}
-
 TEST_CASE("esp_repl() exits when esp_repl_stop() called from the task running esp_repl()", "[esp_repl]")
 {
     /* create semaphores */
@@ -274,18 +266,6 @@ TEST_CASE("esp_repl() exits when esp_repl_stop() called from the task running es
     BaseType_t rc = xTaskCreate(repl_task, "repl_task", 4096, &args, 5, NULL);
     TEST_ASSERT_EQUAL(pdPASS, rc);
 
-    /* register a quit command to esp_commands */
-    esp_command_t quit_cmd = {
-        .name = "quit",
-        .group = "quit",
-        .help = "-",
-        .func = quit_command,
-        .func_ctx = repl_handle,
-        .hint_cb = NULL,
-        .glossary_cb = NULL
-    };
-    TEST_ASSERT_EQUAL(ESP_OK, esp_commands_register_cmd(&quit_cmd));
-
     /* start repl */
     TEST_ASSERT_EQUAL(ESP_OK, esp_repl_start(repl_handle));
 
@@ -295,7 +275,7 @@ TEST_CASE("esp_repl() exits when esp_repl_stop() called from the task running es
     TEST_ASSERT_TRUE(xSemaphoreTake(start_sem, pdMS_TO_TICKS(2000)));
 
     /* send the quit command */
-    const char *quit_cmd_line = "quit\n";
+    const char *quit_cmd_line = "quit  \n";
     test_send_characters(s_socket_fd[1], quit_cmd_line);
 
     /* wait for the repl task to signal completion */

esp_repl/test_apps/sdkconfig.defaults

@@ -1 +1,2 @@
-CONFIG_ESP_TASK_WDT_EN=n
+CONFIG_ESP_TASK_WDT_EN=n
+CONFIG_ESP_REPL_HAS_QUIT_CMD=y