shell: Add wildcard support

Extended shell to support wildcard characters: * and ? and expand
commands accordingly.
Increased default stack size.

Signed-off-by: Jakub Rzeszutko <[email protected]>
Signed-off-by: Krzysztof Chruscinski <[email protected]>

Author: nordic-krch

subsys/shell/CMakeLists.txt

@@ -33,3 +33,8 @@ zephyr_sources_ifdef(
   CONFIG_LOG
   shell_log_backend.c
 )
+
+zephyr_sources_ifdef(
+  CONFIG_SHELL_WILDCARD
+  shell_wildcard.c
+)

subsys/shell/Kconfig

@@ -7,9 +7,10 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
+menu "Shell Options"
 
-config CONSOLE_SHELL
-	bool "Enable console input handler [ Experimental ]"
+menuconfig CONSOLE_SHELL
+	bool "Enable legacy shell [ Experimental ]"
 	select CONSOLE_HANDLER
 	select CONSOLE_SUBSYS
 	help
@@ -34,7 +35,7 @@ source "subsys/shell/modules/Kconfig"
 
 endif
 
-config SHELL
+menuconfig SHELL
 	bool "Enable shell"
 	select LOG_RUNTIME_FILTERING
 	select POLL
@@ -47,7 +48,7 @@ source "subsys/logging/Kconfig.template.log_config"
 
 config SHELL_STACK_SIZE
 	int "Shell thread stack size"
-	default 1024 if MULTITHREADING
+	default 2048 if MULTITHREADING
 	default 0 if !MULTITHREADING
 	help
 	  Stack size for thread created for each instance.
@@ -89,6 +90,12 @@ config SHELL_ARGC_MAX
 	  If command is composed of more than defined, argument SHELL_ARGC_MAX
 	  and following are passed as one argument in the string.
 
+config SHELL_WILDCARD
+	bool "Enable wildcard support in shell"
+	select FNMATCH
+	help
+	  Enables using * in shell.
+
 config SHELL_ECHO_STATUS
 	bool "Enable echo on shell"
 	default y
@@ -116,6 +123,7 @@ config SHELL_HELP
 
 config SHELL_HELP_ON_WRONG_ARGUMENT_COUNT
 	bool "Enable printing help on wrong argument count"
+	depends on SHELL_HELP
 	default y
 
 config SHELL_HISTORY
@@ -163,3 +171,5 @@ config SHELL_CMDS_RESIZE
 	  Resize command can be turned off to safe code memory (~0,5k).
 
 endif #SHELL
+endmenu
+

subsys/shell/shell.c

@@ -10,6 +10,7 @@
 #include <shell/shell.h>
 #include "shell_utils.h"
 #include "shell_ops.h"
+#include "shell_wildcard.h"
 #include "shell_vt100.h"
 #include <assert.h>
 #include <atomic.h>
@@ -381,6 +382,15 @@ static const struct shell_static_entry *get_last_command(
 	*match_arg = SHELL_CMD_ROOT_LVL;
 
 	while (*match_arg < argc) {
+
+		if (IS_ENABLED(CONFIG_SHELL_WILDCARD)) {
+			/* ignore wildcard argument */
+			if (shell_wildcard_character_exist(argv[*match_arg])) {
+				(*match_arg)++;
+				continue;
+			}
+		}
+
 		entry = find_cmd(prev_cmd, *match_arg, argv[*match_arg],
 				 d_entry);
 		if (entry) {
@@ -922,6 +932,7 @@ static void shell_execute(const struct shell *shell)
 	const struct shell_cmd_entry *p_cmd = NULL;
 	size_t cmd_lvl = SHELL_CMD_ROOT_LVL;
 	size_t cmd_with_handler_lvl = 0;
+	bool wildcard_found = false;
 	size_t cmd_idx;
 	size_t argc;
 	char quote;
@@ -938,6 +949,10 @@ static void shell_execute(const struct shell *shell)
 	history_put(shell, shell->ctx->cmd_buff,
 		    shell->ctx->cmd_buff_len);
 
+	if (IS_ENABLED(CONFIG_SHELL_WILDCARD)) {
+		shell_wildcard_prepare(shell);
+	}
+
 	/* create argument list */
 	quote = shell_make_argv(&argc, &argv[0], shell->ctx->cmd_buff,
 				CONFIG_SHELL_ARGC_MAX);
@@ -985,6 +1000,28 @@ static void shell_execute(const struct shell *shell)
 			break;
 		}
 
+		if (IS_ENABLED(CONFIG_SHELL_WILDCARD)) {
+			enum shell_wildcard_status status;
+
+			status = shell_wildcard_process(shell, p_cmd,
+							 argv[cmd_lvl]);
+			/* Wildcard character found but there is no matching
+			 * command.
+			 */
+			if (status == SHELL_WILDCARD_CMD_NO_MATCH_FOUND) {
+				break;
+			}
+
+			/* Wildcard character was not found function can process
+			 * argument.
+			 */
+			if (status != SHELL_WILDCARD_NOT_FOUND) {
+				++cmd_lvl;
+				wildcard_found = true;
+				continue;
+			}
+		}
+
 		cmd_get(p_cmd, cmd_lvl, cmd_idx++, &p_static_entry, &d_entry);
 
 		if ((cmd_idx == 0) || (p_static_entry == NULL)) {
@@ -994,6 +1031,28 @@ static void shell_execute(const struct shell *shell)
 		if (strcmp(argv[cmd_lvl], p_static_entry->syntax) == 0) {
 			/* checking if command has a handler */
 			if (p_static_entry->handler != NULL) {
+				if (IS_ENABLED(CONFIG_SHELL_WILDCARD)) {
+					if (wildcard_found) {
+						shell_op_cursor_end_move(shell);
+						shell_op_cond_next_line(shell);
+
+						/* An error occurred, fnmatch
+						 * argument cannot be followed
+						 * by argument with a handler to
+						 * avoid multiple function
+						 * calls.
+						 */
+						shell_fprintf(shell,
+							      SHELL_ERROR,
+							"Error: requested"
+							" multiple function"
+							" executions\r\n");
+						help_flag_clear(shell);
+
+						return;
+					}
+				}
+
 				shell->ctx->active_cmd = *p_static_entry;
 				cmd_with_handler_lvl = cmd_lvl;
 			}
@@ -1004,6 +1063,17 @@ static void shell_execute(const struct shell *shell)
 		}
 	}
 
+	if (IS_ENABLED(CONFIG_SHELL_WILDCARD)) {
+		shell_wildcard_finalize(shell);
+		/* cmd_buffer has been overwritten by function finalize function
+		 * with all expanded commands. Hence shell_make_argv needs to
+		 * be called again.
+		 */
+		(void)shell_make_argv(&argc, &argv[0],
+				      shell->ctx->cmd_buff,
+				      CONFIG_SHELL_ARGC_MAX);
+	}
+
 	/* Executing the deepest found handler. */
 	if (shell->ctx->active_cmd.handler == NULL) {
 		if (shell->ctx->active_cmd.help) {