feat: Add option for static commands, add option to disable default dynamic commands

Author: MaJerle

.vscode/settings.json

@@ -4,7 +4,11 @@
         "lwevt_type.h": "c",
         "lwevt.h": "c",
         "string.h": "c",
-        "lwevt_opt.h": "c"
+        "lwevt_opt.h": "c",
+        "lwshell.h": "c",
+        "lwshell_opt.h": "c",
+        "lwshell_opts.h": "c",
+        "typeinfo": "c"
     },
     "esbonio.sphinx.confDir": ""
 }

CHANGELOG.md

@@ -5,6 +5,8 @@
 - Change license year to 2022
 - Update code style with astyle
 - Add `.clang-format` draft
+- Add option for statically allocated commands array (improvement for small devices w/ little memory)
+- Add option to disable dynamic commands allocation (default value)
 
 ## v1.1.1
 

TODO.md

@@ -1,5 +1,4 @@
 # TODO
 
 - Add option to decide for delimiter string (`\r\n`)
-- Improve helper functions for number parsing (do not use math.h to reduce memory footprint)
-- Add option to statically allocate array of commands and assign them to parser -> use of flash memory on embedded systems
+- Improve helper functions for number parsing (do not use math.h to reduce memory footprint)

dev/lwshell_opts.h

@@ -38,7 +38,9 @@
 
 #include "windows.h"
 
-#define LWSHELL_CFG_USE_OUTPUT              1
-#define LWSHELL_CFG_USE_ENABLE_LIST_CMD     1
+#define LWSHELL_CFG_USE_OUTPUT           0
+#define LWSHELL_CFG_USE_LIST_CMD         1
+#define LWSHELL_CFG_USE_DYNAMIC_COMMANDS 1
+#define LWSHELL_CFG_USE_STATIC_COMMANDS  1
 
 #endif /* LWSHELL_HDR_OPTS_H */

dev/main.c

@@ -10,14 +10,34 @@
  * Please note that conio.h is a windows only header
  */
 #ifndef LWSHELL_TEST_READ_SINGLE_CHAR
-#define LWSHELL_TEST_READ_SINGLE_CHAR           0
+#define LWSHELL_TEST_READ_SINGLE_CHAR 0
 #endif
 
 #if LWSHELL_TEST_READ_SINGLE_CHAR
 #include <conio.h>
 #endif
 
-void    example_minimal(void);
+void example_minimal(void);
+
+#if LWSHELL_CFG_USE_OUTPUT
+
+/**
+ * \brief           Application output function
+ * \param[in]       str: String to print, null-terminated
+ * \param[in]       lw: LwSHELL instance
+ */
+static void
+shell_output(const char* str, lwshell_t* lw) {
+    (void)lw;
+    printf("%s", str);
+    if (*str == '\r') {
+        printf("\n");
+    }
+}
+
+#endif /* LWSHELL_CFG_USE_OUTPUT */
+
+/* Commands ... */
 
 int32_t
 addint_cmd(int32_t argc, char** argv) {
@@ -28,7 +48,7 @@ addint_cmd(int32_t argc, char** argv) {
     i1 = lwshell_parse_long_long(argv[1]);
     i2 = lwshell_parse_long_long(argv[2]);
 
-    printf("%lld\r\n", i1 + i2);
+    printf("%lld\r\n", (i1 + i2));
     return 0;
 }
 
@@ -41,7 +61,7 @@ subint_cmd(int32_t argc, char** argv) {
     i1 = lwshell_parse_long_long(argv[1]);
     i2 = lwshell_parse_long_long(argv[2]);
 
-    printf("%lld\r\n", i1 - i2);
+    printf("%lld\r\n", (i1 - i2));
     return 0;
 }
 
@@ -71,34 +91,67 @@ subdbl_cmd(int32_t argc, char** argv) {
     return 0;
 }
 
-/**
- * \brief           Application output function
- * \param[in]       str: String to print, null-terminated
- * \param[in]       lw: LwSHELL instance
- */
-void
-shell_output(const char* str, lwshell_t* lw) {
-    (void)lw;
-    printf("%s", str);
-    if (*str == '\r') {
-        printf("\n");
-    }
+#if LWSHELL_CFG_USE_STATIC_COMMANDS
+
+int32_t
+addintstatic_cmd(int32_t argc, char** argv) {
+    printf("Static command...\r\n");
+    return addint_cmd(argc, argv);
+}
+
+int32_t
+subintstatic_cmd(int32_t argc, char** argv) {
+    printf("Static command...\r\n");
+    return subint_cmd(argc, argv);
 }
 
+int32_t
+adddblstatic_cmd(int32_t argc, char** argv) {
+    printf("Static command...\r\n");
+    return adddbl_cmd(argc, argv);
+}
+
+int32_t
+subdblstatic_cmd(int32_t argc, char** argv) {
+    printf("Static command...\r\n");
+    return subdbl_cmd(argc, argv);
+}
+
+/*
+ * Define some static commands, set as const.
+ */
+static const lwshell_cmd_t static_cmds[] = {
+    {.name = "addintstatic", .desc = "Add 2 integers, a static implementation", .fn = addintstatic_cmd},
+    {.name = "subintstatic", .desc = "Add 2 integers, a static implementation", .fn = subintstatic_cmd},
+    {.name = "adddblstatic", .desc = "Add 2 integers, a static implementation", .fn = adddblstatic_cmd},
+    {.name = "subdblstatic", .desc = "Add 2 integers, a static implementation", .fn = subdblstatic_cmd},
+};
+
+#endif /* LWSHELL_CFG_USE_STATIC_COMMANDS */
+
 /* Program entry point */
 int
 main(void) {
     /* Init library */
     lwshell_init();
 
+#if LWSHELL_CFG_USE_OUTPUT
     /* Add optional output function for the purpose of the feedback */
     lwshell_set_output_fn(shell_output);
+#endif /* LWSHELL_CFG_USE_OUTPUT */
 
+#if LWSHELL_CFG_USE_DYNAMIC_COMMANDS
     /* Define shell commands */
     lwshell_register_cmd("addint", addint_cmd, "Adds 2 integer numbers and prints them");
     lwshell_register_cmd("subint", subint_cmd, "Substitute 2 integer numbers and prints them");
     lwshell_register_cmd("adddbl", adddbl_cmd, "Adds 2 double numbers and prints them");
     lwshell_register_cmd("subdbl", subdbl_cmd, "Substitute 2 double numbers and prints them");
+#endif /* LWSHELL_CFG_USE_DYNAMIC_COMMANDS */
+
+#if LWSHELL_CFG_USE_STATIC_COMMANDS
+    /* Register static commands -> one-time call for all commands */
+    lwshell_register_static_cmds(static_cmds, LWSHELL_ARRAYSIZE(static_cmds));
+#endif /* LWSHELL_CFG_USE_STATIC_COMMANDS */
 
     /* User input to process every character */
     printf("Start entering your command and press enter...\r\n");

lwshell/src/include/lwshell/lwshell.h

@@ -95,20 +95,32 @@ typedef struct {
  * \brief           LwSHELL main structure
  */
 typedef struct lwshell {
+#if LWSHELL_CFG_USE_OUTPUT || __DOXYGEN__
     lwshell_output_fn out_fn;                 /*!< Optional output function */
+#endif                                        /* LWSHELL_CFG_USE_OUTPUT || __DOXYGEN__ */
     char buff[LWSHELL_CFG_MAX_INPUT_LEN + 1]; /*!< Shell command input buffer */
     size_t buff_ptr;                          /*!< Buffer pointer for input */
     int32_t argc;                             /*!< Number of arguments parsed in command */
-    char* argv[LWSHELL_CFG_MAX_CMD_ARGS];     /*!< Array of all arguments */
-    lwshell_cmd_t cmds[LWSHELL_CFG_MAX_CMDS]; /*!< Shell registered commands */
-    size_t cmds_cnt;                          /*!< Number of registered commands */
+    char* argv[LWSHELL_CFG_MAX_CMD_ARGS];     /*!< Array of pointers to all arguments */
+
+#if LWSHELL_CFG_USE_DYNAMIC_COMMANDS || __DOXYGEN__
+    lwshell_cmd_t dynamic_cmds[LWSHELL_CFG_MAX_DYNAMIC_CMDS]; /*!< Shell registered dynamic commands */
+    size_t dynamic_cmds_cnt;                                  /*!< Number of registered dynamic commands */
+#endif                                                        /* LWSHELL_CFG_USE_DYNAMIC_COMMANDS || __DOXYGEN__ */
+
+#if LWSHELL_CFG_USE_STATIC_COMMANDS || __DOXYGEN__
+    const lwshell_cmd_t* static_cmds; /*!< Pointer to an array of static commands */
+    size_t static_cmds_cnt;           /*!< Length of status commands array */
+#endif                                /* LWSHELL_CFG_USE_STATIC_COMMANDS || __DOXYGEN__ */
 } lwshell_t;
 
 lwshellr_t lwshell_init_ex(lwshell_t* lwobj);
 lwshellr_t lwshell_set_output_fn_ex(lwshell_t* lwobj, lwshell_output_fn out_fn);
 lwshellr_t lwshell_register_cmd_ex(lwshell_t* lwobj, const char* cmd_name, lwshell_cmd_fn cmd_fn, const char* desc);
 lwshellr_t lwshell_input_ex(lwshell_t* lwobj, const void* in_data, size_t len);
 
+lwshellr_t lwshell_register_static_cmds_ex(lwshell_t* lwobj, const lwshell_cmd_t* cmds, size_t cmds_len);
+
 /**
  * \brief           Initialize shell interface
  * \note            It applies to default shell instance
@@ -132,6 +144,7 @@ lwshellr_t lwshell_input_ex(lwshell_t* lwobj, const void* in_data, size_t len);
  * \param[in]       cmd_fn: Function to call on command match
  * \param[in]       desc: Custom command description
  * \return          \ref lwshellOK on success, member of \ref lwshellr_t otherwise
+ * \note            Available only when \ref LWSHELL_CFG_USE_DYNAMIC_COMMANDS is enabled
  */
 #define lwshell_register_cmd(cmd_name, cmd_fn, desc) lwshell_register_cmd_ex(NULL, (cmd_name), (cmd_fn), (desc))
 
@@ -144,6 +157,16 @@ lwshellr_t lwshell_input_ex(lwshell_t* lwobj, const void* in_data, size_t len);
  */
 #define lwshell_input(in_data, len)                  lwshell_input_ex(NULL, (in_data), (len))
 
+/**
+ * \brief           Register new command to shell
+ * \note            It applies to default shell instance
+ * \param[in]       cmds: Array of const static commands. It can be from non-volatile memory
+ * \param[in]       cmds_len: Length of array elements
+ * \return          \ref lwshellOK on success, member of \ref lwshellr_t otherwise
+ * \note            Available only when \ref LWSHELL_CFG_USE_STATIC_COMMANDS is enabled
+ */
+#define lwshell_register_static_cmds(cmds, cmds_len) lwshell_register_static_cmds_ex(NULL, (cmds), (cmds_len))
+
 /**
  * \brief           Parse input string as `integer`
  * \param[in]       str: String to parse

lwshell/src/include/lwshell/lwshell_opt.h

@@ -53,13 +53,49 @@ extern "C" {
  */
 
 /**
- * \brief           Maximum number of different commands to be registered
- *
+ * \brief           Enables `1` or disables `0` dynamic command register with \ref lwshell_register_cmd or \ref lwshell_register_cmd_ex functions
+ * 
+ * \note            Set to `1` by default for backward compatibility
+ * \sa              LWSHELL_CFG_USE_STATIC_COMMANDS
+ */
+#ifndef LWSHELL_CFG_USE_DYNAMIC_COMMANDS
+#define LWSHELL_CFG_USE_DYNAMIC_COMMANDS 1
+#endif
+
+/**
+ * \brief           Enables `1` or disables `0` static command registration.
+ * 
+ * When enabled, a single register call is used where application
+ * can pass constant array of the commands and respective callback functions.
+ * 
+ * This allows RAM reduction as lookup tables can be stored in the non-volatile memory
+ * 
+ * \note            Set to `0` by default for backward compatibility
+ * \sa              LWSHELL_CFG_USE_DYNAMIC_COMMANDS
+ */
+#ifndef LWSHELL_CFG_USE_STATIC_COMMANDS
+#define LWSHELL_CFG_USE_STATIC_COMMANDS 0
+#endif
+
+/**
+ * \brief           Maximum number of different dynamic registered commands
+ * 
+ * \warning         Deprecated and replaced with \ref LWSHELL_CFG_MAX_DYNAMIC_CMDS
+ * \deprecated
  */
 #ifndef LWSHELL_CFG_MAX_CMDS
 #define LWSHELL_CFG_MAX_CMDS 8
 #endif
 
+/**
+ * \brief           Maximum number of different dynamic registered commands
+ *
+ * \note            Used only when \ref LWSHELL_CFG_USE_DYNAMIC_COMMANDS is enabled
+ */
+#ifndef LWSHELL_CFG_MAX_DYNAMIC_CMDS
+#define LWSHELL_CFG_MAX_DYNAMIC_CMDS LWSHELL_CFG_MAX_CMDS
+#endif
+
 /**
  * \brief           Maximum characters for command line input
  *
@@ -71,8 +107,9 @@ extern "C" {
 #endif
 
 /**
- * \brief           Maximum characters for command name
- *
+ * \brief           Maximum characters for command name in bytes.
+ * 
+ * \note            Used only when \ref LWSHELL_CFG_USE_DYNAMIC_COMMANDS is enabled
  */
 #ifndef LWSHELL_CFG_MAX_CMD_NAME_LEN
 #define LWSHELL_CFG_MAX_CMD_NAME_LEN 16
@@ -102,8 +139,8 @@ extern "C" {
  *
  * \ref LWSHELL_CFG_USE_OUTPUT must be enabled to use this feature
  */
-#ifndef LWSHELL_CFG_USE_ENABLE_LIST_CMD
-#define LWSHELL_CFG_USE_ENABLE_LIST_CMD 0
+#ifndef LWSHELL_CFG_USE_LIST_CMD
+#define LWSHELL_CFG_USE_LIST_CMD 0
 #endif
 
 /**