jim-subcmd.c

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