diff options
author | Steve Bennett <steveb@workware.net.au> | 2023-06-22 13:55:33 +1000 |
---|---|---|
committer | Steve Bennett <steveb@workware.net.au> | 2023-07-04 10:08:32 +1000 |
commit | b4401224612367bba465d15e1f940fcf00173142 (patch) | |
tree | 3e7733e130c06462c2c1fe46672a88f370d714a6 /jim-subcmd.h | |
parent | 8edfa0eee24e0477d20fa25f0ee2f2f50ffa15ab (diff) | |
download | jimtcl-b4401224612367bba465d15e1f940fcf00173142.zip jimtcl-b4401224612367bba465d15e1f940fcf00173142.tar.gz jimtcl-b4401224612367bba465d15e1f940fcf00173142.tar.bz2 |
subcmd: minor improvements
Add support for modulo maxarg count. If maxargs is (e.g.) -2, then a
multiple of 2 args is expected.
Also expose Jim_SubCmdArgError() to make it easy to add additional
arg validation but still have subcmd report the usage.
Signed-off-by: Steve Bennett <steveb@workware.net.au>
Diffstat (limited to 'jim-subcmd.h')
-rw-r--r-- | jim-subcmd.h | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/jim-subcmd.h b/jim-subcmd.h index ab30f37..2d05821 100644 --- a/jim-subcmd.h +++ b/jim-subcmd.h @@ -31,6 +31,11 @@ typedef struct { unsigned short flags; /* JIM_MODFLAG_... plus custom flags */ } jim_subcmd_type; +/* This makes it easy to define a jim_subcmd_type array with function=NULL + * see jim-namespace.c for an example + */ +#define JIM_DEF_SUBCMD(name, args, minargs, maxargs) { name, args, NULL, minargs, maxargs } + /** * Looks up the appropriate subcommand in the given command table and return * the command function which implements the subcommand. @@ -70,6 +75,13 @@ int Jim_SubCmdProc(Jim_Interp *interp, int argc, Jim_Obj *const *argv); */ int Jim_CallSubCmd(Jim_Interp *interp, const jim_subcmd_type *ct, int argc, Jim_Obj *const *argv); +/** + * Sets an error result indicating the usage of the subcmd 'ct'. + * Typically this will be called with the result of Jim_ParseSubCmd() after + * additional checks if the args are wrong. + */ +void Jim_SubCmdArgError(Jim_Interp *interp, const jim_subcmd_type *ct, Jim_Obj *subcmd); + #ifdef __cplusplus } #endif |