shell: sample: add getopt

Modify an example by adding command that is using shell_getopt funtion.
Extent sample.yaml with getopt configuration.

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

Author: Jakub Rzeszutko

samples/subsys/shell/shell_module/prj_getopt.conf

@@ -0,0 +1,14 @@
+CONFIG_PRINTK=y
+CONFIG_SHELL=y
+CONFIG_SHELL_GETOPT=y
+CONFIG_LOG=y
+CONFIG_INIT_STACKS=y
+CONFIG_THREAD_STACK_INFO=y
+CONFIG_KERNEL_SHELL=y
+CONFIG_THREAD_MONITOR=y
+CONFIG_BOOT_BANNER=n
+CONFIG_THREAD_NAME=y
+CONFIG_DEVICE_SHELL=y
+CONFIG_POSIX_CLOCK=y
+CONFIG_DATE_SHELL=y
+CONFIG_THREAD_RUNTIME_STATS=y

samples/subsys/shell/shell_module/sample.yaml

@@ -20,6 +20,12 @@ tests:
     tags: shell
     harness: keyboard
     extra_args: CONF_FILE="prj_minimal.conf"
+  sample.shell.shell_module.getopt:
+    filter: ( CONFIG_SERIAL and CONFIG_UART_SHELL_ON_DEV_NAME )
+    tags: shell
+    harness: keyboard
+    min_ram: 40
+    extra_args: CONF_FILE="prj_getopt.conf"
   sample.shell.shell_module.minimal_rtt:
     filter: CONFIG_HAS_SEGGER_RTT
     tags: shell

samples/subsys/shell/shell_module/src/main.c

@@ -5,13 +5,13 @@
  */
 
 #include <zephyr.h>
-#include <sys/printk.h>
 #include <shell/shell.h>
 #include <version.h>
 #include <logging/log.h>
 #include <stdlib.h>
 #include <drivers/uart.h>
 #include <usb/usb_device.h>
+#include <ctype.h>
 
 LOG_MODULE_REGISTER(app);
 
@@ -89,6 +89,59 @@ static int cmd_demo_ping(const struct shell *shell, size_t argc, char **argv)
 	return 0;
 }
 
+#if defined CONFIG_SHELL_GETOPT
+static int cmd_demo_getopt(const struct shell *shell, size_t argc, char **argv)
+{
+	struct getopt_state *state;
+	char *cvalue = NULL;
+	int aflag = 0;
+	int bflag = 0;
+	int c;
+
+	while ((c = shell_getopt(shell, argc, argv, "abhc:")) != -1) {
+		state = shell_getopt_state_get(shell);
+		switch (c) {
+		case 'a':
+			aflag = 1;
+			break;
+		case 'b':
+			bflag = 1;
+			break;
+		case 'c':
+			cvalue = state->optarg;
+			break;
+		case 'h':
+			/* When getopt is active shell is not parsing
+			 * command handler to print help message. It must
+			 * be done explicitly.
+			 */
+			shell_help(shell);
+			return SHELL_CMD_HELP_PRINTED;
+		case '?':
+			if (state->optopt == 'c') {
+				shell_print(shell,
+					"Option -%c requires an argument.",
+					state->optopt);
+			} else if (isprint(state->optopt)) {
+				shell_print(shell,
+					"Unknown option `-%c'.",
+					state->optopt);
+			} else {
+				shell_print(shell,
+					"Unknown option character `\\x%x'.",
+					state->optopt);
+			}
+			return 1;
+		default:
+			break;
+		}
+	}
+
+	shell_print(shell, "aflag = %d, bflag = %d", aflag, bflag);
+	return 0;
+}
+#endif
+
 static int cmd_demo_params(const struct shell *shell, size_t argc, char **argv)
 {
 	shell_print(shell, "argc = %d", argc);
@@ -139,6 +192,10 @@ SHELL_STATIC_SUBCMD_SET_CREATE(sub_demo,
 	SHELL_CMD(hexdump, NULL, "Hexdump params command.", cmd_demo_hexdump),
 	SHELL_CMD(params, NULL, "Print params command.", cmd_demo_params),
 	SHELL_CMD(ping, NULL, "Ping command.", cmd_demo_ping),
+#if defined CONFIG_SHELL_GETOPT
+	SHELL_CMD(getopt, NULL,	"Cammand using getopt, looking for: \"abhc:\".",
+		  cmd_demo_getopt),
+#endif
 	SHELL_SUBCMD_SET_END /* Array terminated. */
 );
 SHELL_CMD_REGISTER(demo, &sub_demo, "Demo commands", NULL);