feat(esp_linenoise): Expose esp_linenoise_probe API

this commit also adds a getter and setter function for the
esp_linenoise_config_t prompt field.

this makes the re-probing and update of prompt possible.

Author: SoucheSouche

esp_linenoise/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.0.2"
+version: "1.0.3"
 description: "ESP Linenoise - Line editing C library"
 url: https://github.com/espressif/idf-extra-components/tree/master/esp_linenoise
 license: Apache-2.0

esp_linenoise/include/esp_linenoise.h

@@ -126,6 +126,14 @@ typedef struct esp_linenoise_config {
  */
 typedef struct esp_linenoise_instance *esp_linenoise_handle_t;
 
+/**
+ * @brief Probe the terminal to check weather it supports escape sequences
+ *
+ * @param handle The linenoise handle used to check
+ * @return int 0 if the terminal supports escape sequences
+ */
+int esp_linenoise_probe(esp_linenoise_handle_t handle);
+
 /**
  * @brief Returns the default parameters for creating a linenoise instance.
  *
@@ -307,6 +315,24 @@ esp_err_t esp_linenoise_set_max_cmd_line_length(esp_linenoise_handle_t handle, s
  */
 esp_err_t esp_linenoise_get_max_cmd_line_length(esp_linenoise_handle_t handle, size_t *max_cmd_line_length);
 
+/**
+ * @brief Sets the prompt used by the esp_linenoise instance.
+ *
+ * @param handle Handle to the linenoise instance.
+ * @param prompt Prompt to be set.
+ * @return ESP_OK on success, or error code on failure.
+ */
+esp_err_t esp_linenoise_set_prompt(esp_linenoise_handle_t handle, const char *prompt);
+
+/**
+ * @brief Gets the current esp_linenoise instance prompt.
+ *
+ * @param handle Handle to the linenoise instance.
+ * @param prompt esp_linenoise instance current prompt.
+ * @return ESP_OK on success, or error code on failure.
+ */
+esp_err_t esp_linenoise_get_prompt(esp_linenoise_handle_t handle, const char **prompt);
+
 /**
  * @brief Return the output file descriptor used by esp_linenoise
  *

esp_linenoise/private_include/esp_linenoise_private.h

@@ -89,14 +89,6 @@ esp_linenoise_instance_t *esp_linenoise_create_instance_static(void)
     return instance;
 }
 
-/**
- * @brief Probe the terminal to check weather it supports escape sequences
- *
- * @param instance The linenoise instance used to check
- * @return int 0 if the terminal supports escape sequences
- */
-int esp_linenoise_probe(esp_linenoise_instance_t *instance);
-
 /**
  * @brief This function is used by the callback function registered by the user
  * in order to add completion options given the input string when the

esp_linenoise/src/esp_linenoise.c

@@ -1041,9 +1041,9 @@ static void esp_linenoise_sanitize(char *src)
     *dst = 0;
 }
 
-int esp_linenoise_probe(esp_linenoise_instance_t *instance)
+int esp_linenoise_probe(esp_linenoise_handle_t handle)
 {
-    esp_linenoise_config_t *config = &instance->config;
+    esp_linenoise_instance_t *instance = (esp_linenoise_instance_t *)handle;
 
     /* Make sure we are in non blocking mode before performing the terminal probing */
     int fd_in = instance->config.in_fd;
@@ -1057,7 +1057,7 @@ int esp_linenoise_probe(esp_linenoise_instance_t *instance)
 
     /* Device status request */
     char status_request_str[] = "\x1b[5n";
-    config->write_bytes_cb(out_fd, status_request_str, sizeof(status_request_str));
+    instance->config.write_bytes_cb(out_fd, status_request_str, sizeof(status_request_str));
 
     /* Try to read response */
     int timeout_ms = 500;
@@ -1067,7 +1067,7 @@ int esp_linenoise_probe(esp_linenoise_instance_t *instance)
         usleep(retry_ms * 1000);
         timeout_ms -= retry_ms;
         char c;
-        int cb = config->read_bytes_cb(fd_in, &c, 1);
+        int cb = instance->config.read_bytes_cb(fd_in, &c, 1);
         if (cb < 0) {
             continue;
         }
@@ -1580,6 +1580,30 @@ esp_err_t esp_linenoise_get_max_cmd_line_length(esp_linenoise_handle_t handle, s
     return ESP_OK;
 }
 
+esp_err_t esp_linenoise_set_prompt(esp_linenoise_handle_t handle, const char *prompt)
+{
+    ESP_LINENOISE_CHECK_INSTANCE(handle);
+
+    if (prompt == NULL || strlen(prompt) == 0) {
+        return ESP_ERR_INVALID_ARG;
+    }
+
+    ((esp_linenoise_instance_t *)handle)->config.prompt = prompt;
+    return ESP_OK;
+}
+
+esp_err_t esp_linenoise_get_prompt(esp_linenoise_handle_t handle, const char **prompt)
+{
+    ESP_LINENOISE_CHECK_INSTANCE(handle);
+
+    if (prompt == NULL) {
+        return ESP_ERR_INVALID_ARG;
+    }
+
+    *prompt = ((esp_linenoise_instance_t *)handle)->config.prompt;
+    return ESP_OK;
+}
+
 esp_err_t esp_linenoise_get_out_fd(esp_linenoise_handle_t handle, int *fd)
 {
     ESP_LINENOISE_CHECK_INSTANCE(handle);

esp_linenoise/test_apps/main/test_esp_linenoise_get_set.c

@@ -72,6 +72,20 @@ TEST_CASE("set and get empty line flag", "[esp_linenoise]")
     TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_delete_instance(h));
 }
 
+TEST_CASE("set and get prompt", "[esp_linenoise]")
+{
+    esp_linenoise_handle_t h = get_linenoise_instance_default_config();
+
+    const char *test_prompt = "test";
+    const char *ret_prompt = NULL;
+
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_set_prompt(h, test_prompt));
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_get_prompt(h, &ret_prompt));
+    TEST_ASSERT_TRUE(strcmp(test_prompt, ret_prompt) == 0);
+
+    TEST_ASSERT_EQUAL(ESP_OK, esp_linenoise_delete_instance(h));
+}
+
 TEST_CASE("default max line length and max history length", "[esp_linenoise]")
 {
     esp_linenoise_config_t config;