jim-subcmd.c

   1 #include <stdio.h>
   2 #include <string.h>
   3
   4 #include "jim-subcmd.h"
   5 #include "jimautoconf.h"
   6
   7 /**
   8  * Implements the common 'commands' subcommand
   9  */
  10 static int subcmd_null(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
  11 {
  12     /* Nothing to do, since the result has already been created */
  13     return JIM_OK;
  14 }
  15
  16 /**
  17  * Do-nothing command to support -commands and -usage
  18  */
  19 static const jim_subcmd_type dummy_subcmd = {
  20     "dummy", NULL, subcmd_null, 0, 0, JIM_MODFLAG_HIDDEN
  21 };
  22
  23 static void add_commands(Jim_Interp *interp, const jim_subcmd_type * ct, const char *sep)
  24 {
  25     const char *s = "";
  26
  27     for (; ct->cmd; ct++) {
  28         if (!(ct->flags & JIM_MODFLAG_HIDDEN)) {
  29             Jim_AppendStrings(interp, Jim_GetResult(interp), s, ct->cmd, NULL);
  30             s = sep;
  31         }
  32     }
  33 }
  34
  35 static void bad_subcmd(Jim_Interp *interp, const jim_subcmd_type * command_table, const char *type,
  36     Jim_Obj *cmd, Jim_Obj *subcmd)
  37 {
  38     Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
  39     Jim_AppendStrings(interp, Jim_GetResult(interp), Jim_String(cmd), ", ", type,
  40         " command \"", Jim_String(subcmd), "\": should be ", NULL);
  41     add_commands(interp, command_table, ", ");
  42 }
  43
  44 static void show_cmd_usage(Jim_Interp *interp, const jim_subcmd_type * command_table, int argc,
  45     Jim_Obj *const *argv)
  46 {
  47     Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
  48     Jim_AppendStrings(interp, Jim_GetResult(interp), "Usage: \"", Jim_String(argv[0]),
  49         " command ... \", where command is one of: ", NULL);
  50     add_commands(interp, command_table, ", ");
  51 }
  52
  53 static void add_cmd_usage(Jim_Interp *interp, const jim_subcmd_type * ct, Jim_Obj *cmd)
  54 {
  55     if (cmd) {
  56         Jim_AppendStrings(interp, Jim_GetResult(interp), Jim_String(cmd), " ", NULL);
  57     }
  58     Jim_AppendStrings(interp, Jim_GetResult(interp), ct->cmd, NULL);
  59     if (ct->args && *ct->args) {
  60         Jim_AppendStrings(interp, Jim_GetResult(interp), " ", ct->args, NULL);
  61     }
  62 }
  63
  64 static void set_wrong_args(Jim_Interp *interp, const jim_subcmd_type * command_table, Jim_Obj *subcmd)
  65 {
  66     Jim_SetResultString(interp, "wrong # args: must be \"", -1);
  67     add_cmd_usage(interp, command_table, subcmd);
  68     Jim_AppendStrings(interp, Jim_GetResult(interp), "\"", NULL);
  69 }
  70
  71 const jim_subcmd_type *Jim_ParseSubCmd(Jim_Interp *interp, const jim_subcmd_type * command_table,
  72     int argc, Jim_Obj *const *argv)
  73 {
  74     const jim_subcmd_type *ct;
  75     const jim_subcmd_type *partial = 0;
  76     int cmdlen;
  77     Jim_Obj *cmd;
  78     const char *cmdstr;
  79     const char *cmdname;
  80     int help = 0;
  81
  82     cmdname = Jim_String(argv[0]);
  83
  84     if (argc < 2) {
  85         Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
  86         Jim_AppendStrings(interp, Jim_GetResult(interp), "wrong # args: should be \"", cmdname,
  87             " command ...\"\n", NULL);
  88         Jim_AppendStrings(interp, Jim_GetResult(interp), "Use \"", cmdname, " -help ?command?\" for help", NULL);
  89         return 0;
  90     }
  91
  92     cmd = argv[1];
  93
  94     /* Check for the help command */
  95     if (Jim_CompareStringImmediate(interp, cmd, "-help")) {
  96         if (argc == 2) {
  97             /* Usage for the command, not the subcommand */
  98             show_cmd_usage(interp, command_table, argc, argv);
  99             return &dummy_subcmd;
 100         }
 101         help = 1;
 102
 103         /* Skip the 'help' command */
 104         cmd = argv[2];
 105     }
 106
 107     /* Check for special builtin '-commands' command first */
 108     if (Jim_CompareStringImmediate(interp, cmd, "-commands")) {
 109         /* Build the result here */
 110         Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
 111         add_commands(interp, command_table, " ");
 112         return &dummy_subcmd;
 113     }
 114
 115     cmdstr = Jim_GetString(cmd, &cmdlen);
 116
 117     for (ct = command_table; ct->cmd; ct++) {
 118         if (Jim_CompareStringImmediate(interp, cmd, ct->cmd)) {
 119             /* Found an exact match */
 120             break;
 121         }
 122         if (strncmp(cmdstr, ct->cmd, cmdlen) == 0) {
 123             if (partial) {
 124                 /* Ambiguous */
 125                 if (help) {
 126                     /* Just show the top level help here */
 127                     show_cmd_usage(interp, command_table, argc, argv);
 128                     return &dummy_subcmd;
 129                 }
 130                 bad_subcmd(interp, command_table, "ambiguous", argv[0], argv[1 + help]);
 131                 return 0;
 132             }
 133             partial = ct;
 134         }
 135         continue;
 136     }
 137
 138     /* If we had an unambiguous partial match */
 139     if (partial && !ct->cmd) {
 140         ct = partial;
 141     }
 142
 143     if (!ct->cmd) {
 144         /* No matching command */
 145         if (help) {
 146             /* Just show the top level help here */
 147             show_cmd_usage(interp, command_table, argc, argv);
 148             return &dummy_subcmd;
 149         }
 150         bad_subcmd(interp, command_table, "unknown", argv[0], argv[1 + help]);
 151         return 0;
 152     }
 153
 154     if (help) {
 155         Jim_SetResultString(interp, "Usage: ", -1);
 156         /* subcmd */
 157         add_cmd_usage(interp, ct, argv[0]);
 158         return &dummy_subcmd;
 159     }
 160
 161     /* Check the number of args */
 162     if (argc - 2 < ct->minargs || (ct->maxargs >= 0 && argc - 2 > ct->maxargs)) {
 163         Jim_SetResultString(interp, "wrong # args: must be \"", -1);
 164         /* subcmd */
 165         add_cmd_usage(interp, ct, argv[0]);
 166         Jim_AppendStrings(interp, Jim_GetResult(interp), "\"", NULL);
 167
 168         return 0;
 169     }
 170
 171     /* Good command */
 172     return ct;
 173 }
 174
 175 int Jim_CallSubCmd(Jim_Interp *interp, const jim_subcmd_type * ct, int argc, Jim_Obj *const *argv)
 176 {
 177     int ret = JIM_ERR;
 178
 179     if (ct) {
 180         if (ct->flags & JIM_MODFLAG_FULLARGV) {
 181             ret = ct->function(interp, argc, argv);
 182         }
 183         else {
 184             ret = ct->function(interp, argc - 2, argv + 2);
 185         }
 186         if (ret < 0) {
 187             set_wrong_args(interp, ct, argv[0]);
 188             ret = JIM_ERR;
 189         }
 190     }
 191     return ret;
 192 }
 193
 194 int Jim_SubCmdProc(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 195 {
 196     const jim_subcmd_type *ct =
 197         Jim_ParseSubCmd(interp, (const jim_subcmd_type *)Jim_CmdPrivData(interp), argc, argv);
 198
 199     return Jim_CallSubCmd(interp, ct, argc, argv);
 200 }