/**************************************************************************** * apps/nshlib/nsh_command.c * * Copyright (C) 2007-2018 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************/ /**************************************************************************** * Included Files ****************************************************************************/ #include #include #ifdef CONFIG_NSH_BUILTIN_APPS # include #endif #if defined(CONFIG_SYSTEM_READLINE) && defined(CONFIG_READLINE_HAVE_EXTMATCH) # include "system/readline.h" #endif #include "nsh.h" #include "nsh_console.h" /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /* Help command summary layout */ #define HELP_LINELEN 80 #define NUM_CMDS ((sizeof(g_cmdmap)/sizeof(struct cmdmap_s)) - 1) /**************************************************************************** * Private Types ****************************************************************************/ struct cmdmap_s { FAR const char *cmd; /* Name of the command */ nsh_cmd_t handler; /* Function that handles the command */ uint8_t minargs; /* Minimum number of arguments (including command) */ uint8_t maxargs; /* Maximum number of arguments (including command) */ FAR const char *usage; /* Usage instructions for 'help' command */ }; /**************************************************************************** * Private Function Prototypes ****************************************************************************/ #ifndef CONFIG_NSH_DISABLE_HELP static int cmd_help(FAR struct nsh_vtbl_s *vtbl, int argc, char **argv); #endif #ifndef CONFIG_NSH_DISABLESCRIPT static int cmd_true(FAR struct nsh_vtbl_s *vtbl, int argc, char **argv); static int cmd_false(FAR struct nsh_vtbl_s *vtbl, int argc, char **argv); #endif #ifndef CONFIG_NSH_DISABLE_EXIT static int cmd_exit(FAR struct nsh_vtbl_s *vtbl, int argc, char **argv); #endif static int cmd_unrecognized(FAR struct nsh_vtbl_s *vtbl, int argc, char **argv); /**************************************************************************** * Private Data ****************************************************************************/ static const struct cmdmap_s g_cmdmap[] = { #if !defined(CONFIG_NSH_DISABLESCRIPT) && !defined(CONFIG_NSH_DISABLE_TEST) { "[", cmd_lbracket, 4, CONFIG_NSH_MAXARGUMENTS, " ]" }, #endif #ifndef CONFIG_NSH_DISABLE_HELP { "?", cmd_help, 1, 1, NULL }, #endif #if defined(CONFIG_NET) && defined(CONFIG_NET_ROUTE) && !defined(CONFIG_NSH_DISABLE_ADDROUTE) { "addroute", cmd_addroute, 3, 4, " [] " }, #endif #if defined(CONFIG_NET) && defined(CONFIG_NET_ARP) && !defined(CONFIG_NSH_DISABLE_ARP) { "arp", cmd_arp, 3, 4, "[-a |-d |-s ]" }, #endif #if defined(CONFIG_NETUTILS_CODECS) && defined(CONFIG_CODECS_BASE64) # ifndef CONFIG_NSH_DISABLE_BASE64DEC { "base64dec", cmd_base64decode, 2, 4, "[-w] [-f] " }, # endif # ifndef CONFIG_NSH_DISABLE_BASE64ENC { "base64enc", cmd_base64encode, 2, 4, "[-w] [-f] " }, # endif #endif #ifndef CONFIG_NSH_DISABLE_BASENAME { "basename", cmd_basename, 2, 3, " []" }, #endif #if !defined(CONFIG_NSH_DISABLESCRIPT) && !defined(CONFIG_NSH_DISABLE_LOOPS) { "break", cmd_break, 1, 1, NULL }, #endif #ifndef CONFIG_NSH_DISABLE_CAT { "cat", cmd_cat, 2, CONFIG_NSH_MAXARGUMENTS, " [ [ ...]]" }, #endif #ifndef CONFIG_DISABLE_ENVIRON # ifndef CONFIG_NSH_DISABLE_CD { "cd", cmd_cd, 1, 2, "[|-|~|..]" }, # endif #endif #ifndef CONFIG_NSH_DISABLE_CP { "cp", cmd_cp, 3, 3, " " }, #endif #ifndef CONFIG_NSH_DISABLE_CMP { "cmp", cmd_cmp, 3, 3, " " }, #endif #ifndef CONFIG_NSH_DISABLE_DIRNAME { "dirname", cmd_dirname, 2, 2, "" }, #endif #ifndef CONFIG_NSH_DISABLE_DATE { "date", cmd_date, 1, 3, "[-s \"MMM DD HH:MM:SS YYYY\"]" }, #endif #ifndef CONFIG_NSH_DISABLE_DD { "dd", cmd_dd, 3, 6, "if= of= [bs=] [count=] [skip=]" }, # endif #if defined(CONFIG_NET) && defined(CONFIG_NET_ROUTE) && !defined(CONFIG_NSH_DISABLE_DELROUTE) { "delroute", cmd_delroute, 2, 3, " []" }, #endif #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_FS_READABLE) && \ !defined(CONFIG_NSH_DISABLE_DF) #ifdef NSH_HAVE_CATFILE #if defined(HAVE_DF_HUMANREADBLE) && defined(HAVE_DF_BLOCKOUTPUT) { "df", cmd_df, 1, 2, "[-h]" }, #else { "df", cmd_df, 1, 1, NULL }, #endif #endif #endif #if defined(CONFIG_RAMLOG_SYSLOG) && !defined(CONFIG_NSH_DISABLE_DMESG) { "dmesg", cmd_dmesg, 1, 1, NULL }, #endif #ifndef CONFIG_NSH_DISABLE_ECHO # ifndef CONFIG_DISABLE_ENVIRON { "echo", cmd_echo, 1, CONFIG_NSH_MAXARGUMENTS, "[-n] [ [...]]" }, # else { "echo", cmd_echo, 1, CONFIG_NSH_MAXARGUMENTS, "[-n] [ [...]]" }, # endif #endif #ifndef CONFIG_NSH_DISABLE_ENV { "env", cmd_env, 1, 1, NULL }, #endif #ifndef CONFIG_NSH_DISABLE_EXEC { "exec", cmd_exec, 2, 3, "" }, #endif #ifndef CONFIG_NSH_DISABLE_EXIT { "exit", cmd_exit, 1, 1, NULL }, #endif #ifndef CONFIG_NSH_DISABLE_EXPORT { "export", cmd_export, 2, 3, "[ []]" }, #endif #ifndef CONFIG_NSH_DISABLESCRIPT { "false", cmd_false, 1, 1, NULL }, #endif #ifndef CONFIG_NSH_DISABLE_FREE { "free", cmd_free, 1, 1, NULL }, #endif #ifdef CONFIG_NET_UDP # ifndef CONFIG_NSH_DISABLE_GET { "get", cmd_get, 4, 7, "[-b|-n] [-f ] -h " }, # endif #endif #ifndef CONFIG_NSH_DISABLE_HELP # ifdef CONFIG_NSH_HELP_TERSE { "help", cmd_help, 1, 2, "[]" }, #else { "help", cmd_help, 1, 3, "[-v] []" }, # endif #endif #ifndef CONFIG_NSH_DISABLE_HEXDUMP #ifndef CONFIG_NSH_CMDOPT_HEXDUMP { "hexdump", cmd_hexdump, 2, 2, "" }, #else { "hexdump", cmd_hexdump, 2, 4, " [skip=] [count=]" }, #endif #endif #ifdef CONFIG_NET # ifndef CONFIG_NSH_DISABLE_IFCONFIG { "ifconfig", cmd_ifconfig, 1, 11, "[interface [|dhcp]] [dr|gw|gateway ] [netmask ] [dns ] [hw ]" }, # endif # ifndef CONFIG_NSH_DISABLE_IFUPDOWN { "ifdown", cmd_ifdown, 2, 2, "" }, { "ifup", cmd_ifup, 2, 2, "" }, # endif #endif #if defined(CONFIG_MODULE) && !defined(CONFIG_NSH_DISABLE_MODCMDS) { "insmod", cmd_insmod, 3, 3, " " }, #endif #ifdef HAVE_IRQINFO { "irqinfo", cmd_irqinfo, 1, 1, NULL }, #endif #ifndef CONFIG_NSH_DISABLE_KILL { "kill", cmd_kill, 3, 3, "- " }, #endif #ifndef CONFIG_DISABLE_MOUNTPOINT # if defined(CONFIG_DEV_LOOP) && !defined(CONFIG_NSH_DISABLE_LOSETUP) { "losetup", cmd_losetup, 3, 6, "[-d ] | [[-o ] [-r] ]" }, # endif #endif #ifndef CONFIG_DISABLE_MOUNTPOINT # if defined(CONFIG_SMART_DEV_LOOP) && !defined(CONFIG_NSH_DISABLE_LOSMART) { "losmart", cmd_losmart, 2, 11, "[-d ] | [[-m ] [-o ] [-e ] [-s ] [-r] ]" }, # endif #endif #if !defined(CONFIG_NSH_DISABLE_LN) && defined(CONFIG_PSEUDOFS_SOFTLINKS) { "ln", cmd_ln, 3, 4, "[-s] " }, #endif #ifndef CONFIG_NSH_DISABLE_LS { "ls", cmd_ls, 1, 5, "[-lRs] " }, #endif #if defined(CONFIG_MODULE) && !defined(CONFIG_NSH_DISABLE_MODCMDS) #if defined(CONFIG_FS_PROCFS) && !defined(CONFIG_FS_PROCFS_EXCLUDE_MODULE) { "lsmod", cmd_lsmod, 1, 1, NULL }, #endif #endif #ifndef CONFIG_NSH_DISABLE_MB { "mb", cmd_mb, 2, 3, "[=][ ]" }, #endif #if defined(CONFIG_NETUTILS_CODECS) && defined(CONFIG_CODECS_HASH_MD5) # ifndef CONFIG_NSH_DISABLE_MD5 { "md5", cmd_md5, 2, 3, "[-f] " }, # endif #endif #ifdef NSH_HAVE_DIROPTS # ifndef CONFIG_NSH_DISABLE_MKDIR { "mkdir", cmd_mkdir, 2, 2, "" }, # endif #endif #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_FSUTILS_MKFATFS) # ifndef CONFIG_NSH_DISABLE_MKFATFS { "mkfatfs", cmd_mkfatfs, 2, 6, "[-F ] [-r ] " }, # endif #endif #ifndef CONFIG_DISABLE_MOUNTPOINT # if defined(CONFIG_PIPES) && CONFIG_DEV_FIFO_SIZE > 0 && \ !defined(CONFIG_NSH_DISABLE_MKFIFO) { "mkfifo", cmd_mkfifo, 2, 2, "" }, # endif #endif #ifdef NSH_HAVE_WRITABLE_MOUNTPOINT # ifndef CONFIG_NSH_DISABLE_MKRD { "mkrd", cmd_mkrd, 2, 6, "[-m ] [-s ] " }, # endif #endif #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_FS_SMARTFS) && \ defined(CONFIG_FSUTILS_MKSMARTFS) # ifndef CONFIG_NSH_DISABLE_MKSMARTFS # ifdef CONFIG_SMARTFS_MULTI_ROOT_DIRS { "mksmartfs", cmd_mksmartfs, 2, 6, "[-s ] [-f] []" }, # else { "mksmartfs", cmd_mksmartfs, 2, 5, "[-s ] [-f] " }, # endif # endif #endif #ifndef CONFIG_NSH_DISABLE_MH { "mh", cmd_mh, 2, 3, "[=][ ]" }, #endif #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_FS_READABLE) #ifndef CONFIG_NSH_DISABLE_MOUNT #if defined(NSH_HAVE_CATFILE) && defined(HAVE_MOUNT_LIST) { "mount", cmd_mount, 1, 7, "[-t [-o ] [] ]" }, #else { "mount", cmd_mount, 4, 7, "-t [-o ] [] " }, #endif #endif #endif #ifdef NSH_HAVE_DIROPTS # ifndef CONFIG_NSH_DISABLE_MV { "mv", cmd_mv, 3, 3, " " }, # endif #endif #ifndef CONFIG_NSH_DISABLE_MW { "mw", cmd_mw, 2, 3, "[=][ ]" }, #endif #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_NET) && \ defined(CONFIG_NFS) # ifndef CONFIG_NSH_DISABLE_NFSMOUNT { "nfsmount", cmd_nfsmount, 4, 4, " " }, # endif #endif #if defined(CONFIG_LIBC_NETDB) && defined(CONFIG_NETDB_DNSCLIENT) && \ !defined(CONFIG_NSH_DISABLE_NSLOOKUP) { "nslookup", cmd_nslookup, 2, 2, "" }, #endif #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_FS_WRITABLE) && \ defined(CONFIG_NSH_LOGIN_PASSWD) && \ !defined(CONFIG_FSUTILS_PASSWD_READONLY) # ifndef CONFIG_NSH_DISABLE_PASSWD { "passwd", cmd_passwd, 3, 3, " " }, # endif #endif #if defined(CONFIG_BOARDCTL_POWEROFF) && !defined(CONFIG_NSH_DISABLE_POWEROFF) { "poweroff", cmd_poweroff, 1, 2, NULL }, #endif #ifndef CONFIG_NSH_DISABLE_PRINTF # ifndef CONFIG_DISABLE_ENVIRON { "printf", cmd_printf, 1, CONFIG_NSH_MAXARGUMENTS, "[\\xNN] [\\n\\r\\t] [ [...]]" }, # else { "printf", cmd_printf, 1, CONFIG_NSH_MAXARGUMENTS, "[\\xNN] [\\n\\r\\t] [ [...]]" }, # endif #endif #ifndef CONFIG_NSH_DISABLE_PS { "ps", cmd_ps, 1, 1, NULL }, #endif #ifdef CONFIG_NET_UDP # ifndef CONFIG_NSH_DISABLE_PUT { "put", cmd_put, 4, 7, "[-b|-n] [-f ] -h " }, # endif #endif #ifndef CONFIG_DISABLE_ENVIRON # ifndef CONFIG_NSH_DISABLE_PWD { "pwd", cmd_pwd, 1, 1, NULL }, # endif #endif #if !defined(CONFIG_NSH_DISABLE_READLINK) && defined(CONFIG_PSEUDOFS_SOFTLINKS) { "readlink", cmd_readlink, 2, 2, "" }, #endif #if defined(CONFIG_BOARDCTL_RESET) && !defined(CONFIG_NSH_DISABLE_REBOOT) { "reboot", cmd_reboot, 1, 2, NULL }, #endif #ifdef NSH_HAVE_DIROPTS # ifndef CONFIG_NSH_DISABLE_RM { "rm", cmd_rm, 2, 2, "" }, # endif #endif #ifdef NSH_HAVE_DIROPTS # ifndef CONFIG_NSH_DISABLE_RMDIR { "rmdir", cmd_rmdir, 2, 2, "" }, # endif #endif #if defined(CONFIG_MODULE) && !defined(CONFIG_NSH_DISABLE_MODCMDS) { "rmmod", cmd_rmmod, 2, 2, "" }, #endif #ifndef CONFIG_NSH_DISABLE_ROUTE #if defined(CONFIG_NET_IPv4) && defined(CONFIG_NET_IPv6) { "route", cmd_route, 2, 2, "ipv4|ipv6" }, #elif defined(CONFIG_NET_IPv4) { "route", cmd_route, 1, 2, "[ipv4]" }, #elif defined(CONFIG_NET_IPv6) { "route", cmd_route, 1, 2, "[ipv6]" }, #endif #endif #ifndef CONFIG_NSH_DISABLE_SET #ifdef CONFIG_NSH_VARS # if !defined(CONFIG_DISABLE_ENVIRON) && !defined(CONFIG_NSH_DISABLESCRIPT) { "set", cmd_set, 1, 4, "[{+|-}{e|x|xe|ex}] [ ]" }, # elif !defined(CONFIG_DISABLE_ENVIRON) && defined(CONFIG_NSH_DISABLESCRIPT) { "set", cmd_set, 1, 3, "[ ]" }, # elif defined(CONFIG_DISABLE_ENVIRON) && !defined(CONFIG_NSH_DISABLESCRIPT) { "set", cmd_set, 1, 2, "[{+|-}{e|x|xe|ex}]" }, # endif #else # if !defined(CONFIG_DISABLE_ENVIRON) && !defined(CONFIG_NSH_DISABLESCRIPT) { "set", cmd_set, 2, 4, "[{+|-}{e|x|xe|ex}] [ ]" }, # elif !defined(CONFIG_DISABLE_ENVIRON) && defined(CONFIG_NSH_DISABLESCRIPT) { "set", cmd_set, 3, 3, " " }, # elif defined(CONFIG_DISABLE_ENVIRON) && !defined(CONFIG_NSH_DISABLESCRIPT) { "set", cmd_set, 2, 2, "{+|-}{e|x|xe|ex}" }, # endif #endif #endif /* CONFIG_NSH_DISABLE_SET */ #if CONFIG_NFILE_STREAMS > 0 && !defined(CONFIG_NSH_DISABLESCRIPT) # ifndef CONFIG_NSH_DISABLE_SH { "sh", cmd_sh, 2, 2, "" }, # endif #endif #ifndef CONFIG_NSH_DISABLE_SHUTDOWN #if defined(CONFIG_BOARDCTL_POWEROFF) && defined(CONFIG_BOARDCTL_RESET) { "shutdown", cmd_shutdown, 1, 2, "[--reboot]" }, #elif defined(CONFIG_BOARDCTL_POWEROFF) { "shutdown", cmd_shutdown, 1, 1, NULL }, #elif defined(CONFIG_BOARDCTL_RESET) { "shutdown", cmd_shutdown, 2, 2, "--reboot" }, #endif #endif #ifndef CONFIG_NSH_DISABLE_SLEEP { "sleep", cmd_sleep, 2, 2, "" }, #endif #if !defined(CONFIG_NSH_DISABLESCRIPT) && !defined(CONFIG_NSH_DISABLE_TEST) { "test", cmd_test, 3, CONFIG_NSH_MAXARGUMENTS, "" }, #endif #if defined(CONFIG_NSH_TELNET) && !defined(CONFIG_NSH_DISABLE_TELNETD) #if defined(CONFIG_NET_IPv4) && defined(CONFIG_NET_IPv6) {"telnetd", cmd_telnetd, 2, 2, "[ipv4|ipv6]" }, #else {"telnetd", cmd_telnetd, 1, 1, NULL }, #endif #endif #ifndef CONFIG_NSH_DISABLE_TIME { "time", cmd_time, 2, 2, "\"\"" }, #endif #ifndef CONFIG_NSH_DISABLESCRIPT { "true", cmd_true, 1, 1, NULL }, #endif #ifndef CONFIG_DISABLE_MOUNTPOINT # ifndef CONFIG_NSH_DISABLE_TRUNCATE { "truncate", cmd_truncate, 4, 4, "-s " }, # endif #endif #ifndef CONFIG_NSH_DISABLE_UNAME #ifdef CONFIG_NET { "uname", cmd_uname, 1, 7, "[-a | -imnoprsv]" }, #else { "uname", cmd_uname, 1, 7, "[-a | -imoprsv]" }, #endif #endif #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_FS_READABLE) # ifndef CONFIG_NSH_DISABLE_UMOUNT { "umount", cmd_umount, 2, 2, "" }, # endif #endif #ifndef CONFIG_NSH_DISABLE_UNSET { "unset", cmd_unset, 2, 2, "" }, #endif #if defined(CONFIG_NETUTILS_CODECS) && defined(CONFIG_CODECS_URLCODE) # ifndef CONFIG_NSH_DISABLE_URLDECODE { "urldecode", cmd_urldecode, 2, 3, "[-f] " }, # endif # ifndef CONFIG_NSH_DISABLE_URLENCODE { "urlencode", cmd_urlencode, 2, 3, "[-f] " }, # endif #endif #if !defined(CONFIG_DISABLE_MOUNTPOINT) && defined(CONFIG_FS_WRITABLE) && \ defined(CONFIG_NSH_LOGIN_PASSWD) && \ !defined(CONFIG_FSUTILS_PASSWD_READONLY) # ifndef CONFIG_NSH_DISABLE_USERADD { "useradd", cmd_useradd, 3, 3, " " }, # endif # ifndef CONFIG_NSH_DISABLE_USERDEL { "userdel", cmd_userdel, 2, 2, "" }, # endif #endif #ifndef CONFIG_NSH_DISABLE_USLEEP { "usleep", cmd_usleep, 2, 2, "" }, #endif #ifdef CONFIG_NET_TCP # ifndef CONFIG_NSH_DISABLE_WGET { "wget", cmd_wget, 2, 4, "[-o ] " }, # endif #endif #ifndef CONFIG_NSH_DISABLE_XD { "xd", cmd_xd, 3, 3, " " }, #endif { NULL, NULL, 1, 1, NULL } }; /**************************************************************************** * Private Functions ****************************************************************************/ /**************************************************************************** * Name: help_cmdlist ****************************************************************************/ #ifndef CONFIG_NSH_DISABLE_HELP static inline void help_cmdlist(FAR struct nsh_vtbl_s *vtbl) { unsigned int colwidth; unsigned int cmdwidth; unsigned int cmdsperline; unsigned int ncmdrows; unsigned int i; unsigned int j; unsigned int k; /* Pick an optimal column width */ for (k = 0, colwidth = 0; k < NUM_CMDS; k++) { cmdwidth = strlen(g_cmdmap[k].cmd); if (cmdwidth > colwidth) { colwidth = cmdwidth; } } colwidth += 2; /* Determine the number of commands to put on one line */ if (colwidth > HELP_LINELEN) { cmdsperline = 1; } else { cmdsperline = HELP_LINELEN / colwidth; } /* Determine the total number of lines to output */ ncmdrows = (NUM_CMDS + (cmdsperline - 1)) / cmdsperline; /* Print the command name in 'ncmdrows' rows with 'cmdsperline' commands * on each line. */ for (i = 0; i < ncmdrows; i++) { nsh_output(vtbl, " "); for (j = 0, k = i; j < cmdsperline && k < NUM_CMDS; j++, k += ncmdrows) { nsh_output(vtbl, "%s", g_cmdmap[k].cmd); for (cmdwidth = strlen(g_cmdmap[k].cmd); cmdwidth < colwidth; cmdwidth++) { nsh_output(vtbl, " "); } } nsh_output(vtbl, "\n"); } } #endif /**************************************************************************** * Name: help_usage ****************************************************************************/ #if !defined(CONFIG_NSH_DISABLE_HELP) && !defined(CONFIG_NSH_HELP_TERSE) static inline void help_usage(FAR struct nsh_vtbl_s *vtbl) { nsh_output(vtbl, "NSH command forms:\n"); #ifndef CONFIG_NSH_DISABLEBG nsh_output(vtbl, " [nice [-d >]] [> |>> ] [&]\n\n"); #else nsh_output(vtbl, " [> |>> ]\n\n"); #endif #ifndef CONFIG_NSH_DISABLESCRIPT #ifndef CONFIG_NSH_DISABLE_ITEF nsh_output(vtbl, "OR\n"); nsh_output(vtbl, " if \n"); nsh_output(vtbl, " then\n"); nsh_output(vtbl, " [sequence of ]\n"); nsh_output(vtbl, " else\n"); nsh_output(vtbl, " [sequence of ]\n"); nsh_output(vtbl, " fi\n\n"); #endif #ifndef CONFIG_NSH_DISABLE_LOOPS nsh_output(vtbl, "OR\n"); nsh_output(vtbl, " while \n"); nsh_output(vtbl, " do\n"); nsh_output(vtbl, " [sequence of ]\n"); nsh_output(vtbl, " done\n\n"); nsh_output(vtbl, "OR\n"); nsh_output(vtbl, " until \n"); nsh_output(vtbl, " do\n"); nsh_output(vtbl, " [sequence of ]\n"); nsh_output(vtbl, " done\n\n"); #endif #endif } #endif /**************************************************************************** * Name: help_showcmd ****************************************************************************/ #ifndef CONFIG_NSH_DISABLE_HELP static void help_showcmd(FAR struct nsh_vtbl_s *vtbl, FAR const struct cmdmap_s *cmdmap) { if (cmdmap->usage) { nsh_output(vtbl, " %s %s\n", cmdmap->cmd, cmdmap->usage); } else { nsh_output(vtbl, " %s\n", cmdmap->cmd); } } #endif /**************************************************************************** * Name: help_cmd ****************************************************************************/ #ifndef CONFIG_NSH_DISABLE_HELP static int help_cmd(FAR struct nsh_vtbl_s *vtbl, FAR const char *cmd) { FAR const struct cmdmap_s *cmdmap; /* Find the command in the command table */ for (cmdmap = g_cmdmap; cmdmap->cmd; cmdmap++) { /* Is this the one we are looking for? */ if (strcmp(cmdmap->cmd, cmd) == 0) { /* Yes... show it */ nsh_output(vtbl, "%s usage:", cmd); help_showcmd(vtbl, cmdmap); return OK; } } nsh_error(vtbl, g_fmtcmdnotfound, cmd); return ERROR; } #endif /**************************************************************************** * Name: help_allcmds ****************************************************************************/ #if !defined(CONFIG_NSH_DISABLE_HELP) && !defined(CONFIG_NSH_HELP_TERSE) static inline void help_allcmds(FAR struct nsh_vtbl_s *vtbl) { FAR const struct cmdmap_s *cmdmap; /* Show all of the commands in the command table */ for (cmdmap = g_cmdmap; cmdmap->cmd; cmdmap++) { help_showcmd(vtbl, cmdmap); } } #endif /**************************************************************************** * Name: help_builtins ****************************************************************************/ #ifndef CONFIG_NSH_DISABLE_HELP static inline void help_builtins(FAR struct nsh_vtbl_s *vtbl) { #ifdef CONFIG_NSH_BUILTIN_APPS FAR const char *name; unsigned int num_builtins; unsigned int column_width; unsigned int builtin_width; unsigned int builtins_per_line; unsigned int num_builtin_rows; unsigned int i; unsigned int j; unsigned int k; /* Count the number of built-in commands and get the optimal column width */ num_builtins = 0; column_width = 0; for (i = 0; (name = builtin_getname(i)) != NULL; i++) { num_builtins++; builtin_width = strlen(name); if (builtin_width > column_width) { column_width = builtin_width; } } column_width += 2; /* Determine the number of commands to put on one line */ if (column_width > HELP_LINELEN) { builtins_per_line = 1; } else { builtins_per_line = HELP_LINELEN / column_width; } /* Determine the total number of lines to output */ num_builtin_rows = ((num_builtins + (builtins_per_line - 1)) / builtins_per_line); /* List the set of available built-in commands */ nsh_output(vtbl, "\nBuiltin Apps:\n"); for (i = 0; i < num_builtin_rows; i++) { nsh_output(vtbl, " "); for (j = 0, k = i; j < builtins_per_line && k < num_builtins; j++, k += num_builtin_rows) { name = builtin_getname(k); nsh_output(vtbl, "%s", name); for (builtin_width = strlen(name); builtin_width < column_width; builtin_width++) { nsh_output(vtbl, " "); } } nsh_output(vtbl, "\n"); } #endif } #endif /**************************************************************************** * Name: cmd_help ****************************************************************************/ #ifndef CONFIG_NSH_DISABLE_HELP static int cmd_help(FAR struct nsh_vtbl_s *vtbl, int argc, char **argv) { FAR const char *cmd = NULL; #ifndef CONFIG_NSH_HELP_TERSE bool verbose = false; int i; #endif /* The command may be followed by a verbose option */ #ifndef CONFIG_NSH_HELP_TERSE i = 1; if (argc > i) { if (strcmp(argv[i], "-v") == 0) { verbose = true; i++; } } /* The command line may end with a command name */ if (argc > i) { cmd = argv[i]; } /* Show the generic usage if verbose is requested */ if (verbose) { help_usage(vtbl); } #else if (argc > 1) { cmd = argv[1]; } #endif /* Are we showing help on a single command? */ if (cmd) { /* Yes.. show the single command */ help_cmd(vtbl, cmd); } else { /* In verbose mode, show detailed help for all commands */ #ifndef CONFIG_NSH_HELP_TERSE if (verbose) { nsh_output(vtbl, "Where is one of:\n"); help_allcmds(vtbl); } /* Otherwise, just show the list of command names */ else #endif { help_cmd(vtbl, "help"); nsh_output(vtbl, "\n"); help_cmdlist(vtbl); } /* And show the list of built-in applications */ help_builtins(vtbl); } return OK; } #endif /**************************************************************************** * Name: cmd_unrecognized ****************************************************************************/ static int cmd_unrecognized(FAR struct nsh_vtbl_s *vtbl, int argc, char **argv) { nsh_error(vtbl, g_fmtcmdnotfound, argv[0]); return ERROR; } /**************************************************************************** * Name: cmd_true ****************************************************************************/ #ifndef CONFIG_NSH_DISABLESCRIPT static int cmd_true(FAR struct nsh_vtbl_s *vtbl, int argc, char **argv) { return OK; } #endif /**************************************************************************** * Name: cmd_false ****************************************************************************/ #ifndef CONFIG_NSH_DISABLESCRIPT static int cmd_false(FAR struct nsh_vtbl_s *vtbl, int argc, char **argv) { return ERROR; } #endif /**************************************************************************** * Name: cmd_exit ****************************************************************************/ #ifndef CONFIG_NSH_DISABLE_EXIT static int cmd_exit(FAR struct nsh_vtbl_s *vtbl, int argc, char **argv) { nsh_exit(vtbl, 0); return OK; } #endif /**************************************************************************** * Public Functions ****************************************************************************/ /**************************************************************************** * Name: nsh_command * * Description: * Execute the command in argv[0] * * Returned Value: * -1 (ERRROR) if the command was unsuccessful * 0 (OK) if the command was successful * ****************************************************************************/ int nsh_command(FAR struct nsh_vtbl_s *vtbl, int argc, char *argv[]) { const struct cmdmap_s *cmdmap; const char *cmd; nsh_cmd_t handler = cmd_unrecognized; int ret; /* The form of argv is: * * argv[0]: The command name. This is argv[0] when the arguments * are, finally, received by the command vtblr * argv[1]: The beginning of argument (up to CONFIG_NSH_MAXARGUMENTS) * argv[argc]: NULL terminating pointer */ cmd = argv[0]; /* See if the command is one that we understand */ for (cmdmap = g_cmdmap; cmdmap->cmd; cmdmap++) { if (strcmp(cmdmap->cmd, cmd) == 0) { /* Check if a valid number of arguments was provided. We * do this simple, imperfect checking here so that it does * not have to be performed in each command. */ if (argc < cmdmap->minargs) { /* Fewer than the minimum number were provided */ nsh_error(vtbl, g_fmtargrequired, cmd); return ERROR; } else if (argc > cmdmap->maxargs) { /* More than the maximum number were provided */ nsh_error(vtbl, g_fmttoomanyargs, cmd); return ERROR; } else { /* A valid number of arguments were provided (this does * not mean they are right). */ handler = cmdmap->handler; break; } } } ret = handler(vtbl, argc, argv); return ret; } /**************************************************************************** * Name: nsh_extmatch_count * * Description: * This support function is used to provide support for realine tab- * completion logic nsh_extmatch_count() counts the number of matching * nsh command names * * Input Parameters: * name - A point to the name containing the name to be matched. * matches - A table is size CONFIG_READLINE_MAX_EXTCMDS that can * be used to remember matching name indices. * namelen - The lenght of the name to match * * Returned Values: * The number commands that match to the first namelen characters. * ****************************************************************************/ #if defined(CONFIG_NSH_READLINE) && defined(CONFIG_READLINE_TABCOMPLETION) && \ defined(CONFIG_READLINE_HAVE_EXTMATCH) int nsh_extmatch_count(FAR char *name, FAR int *matches, int namelen) { int nr_matches = 0; int i; for (i = 0; i < NUM_CMDS; i++) { if (strncmp(name, g_cmdmap[i].cmd, namelen) == 0) { matches[nr_matches] = i; nr_matches++; if (nr_matches >= CONFIG_READLINE_MAX_EXTCMDS) { break; } } } return nr_matches; } #endif /**************************************************************************** * Name: nsh_extmatch_getname * * Description: * This support function is used to provide support for realine tab- * completion logic nsh_extmatch_getname() will return the full command * string from an index that was previously saved by nsh_exmatch_count(). * * Input Parameters: * index - The index of the command name to be returned. * * Returned Values: * The numb * ****************************************************************************/ #if defined(CONFIG_NSH_READLINE) && defined(CONFIG_READLINE_TABCOMPLETION) && \ defined(CONFIG_READLINE_HAVE_EXTMATCH) FAR const char *nsh_extmatch_getname(int index) { DEBUGASSERT(index > 0 && index <= NUM_CMDS); return g_cmdmap[index].cmd; } #endif