return parent ? &parent->children : &cmd_ctx->commands;
}
+static void command_free(struct command *c)
+{
+ /// @todo if command has a handler, unregister its jim command!
+
+ while (NULL != c->children)
+ {
+ struct command *tmp = c->children;
+ c->children = tmp->next;
+ command_free(tmp);
+ }
+
+ if (c->name)
+ free(c->name);
+ if (c->help)
+ free((void*)c->help);
+ if (c->usage)
+ free((void*)c->usage);
+ free(c);
+}
+
static struct command *command_new(struct command_context *cmd_ctx,
struct command *parent, const struct command_registration *cr)
{
assert(cr->name);
- struct command *c = malloc(sizeof(struct command));
- memset(c, 0, sizeof(struct command));
+ struct command *c = calloc(1, sizeof(struct command));
+ if (NULL == c)
+ return NULL;
c->name = strdup(cr->name);
if (cr->help)
c->help = strdup(cr->help);
if (cr->usage)
c->usage = strdup(cr->usage);
+
+ if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
+ goto command_new_error;
+
c->parent = parent;
c->handler = cr->handler;
c->jim_handler = cr->jim_handler;
command_add_child(command_list_for_parent(cmd_ctx, parent), c);
return c;
-}
-static void command_free(struct command *c)
-{
- /// @todo if command has a handler, unregister its jim command!
- while (NULL != c->children)
- {
- struct command *tmp = c->children;
- c->children = tmp->next;
- command_free(tmp);
- }
-
- if (c->name)
- free(c->name);
- if (c->help)
- free((void*)c->help);
- if (c->usage)
- free((void*)c->usage);
- free(c);
+command_new_error:
+ command_free(c);
+ return NULL;
}
+static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
+
static int register_command_handler(struct command *c)
{
- int retval = -ENOMEM;
- const char *full_name = command_name(c, '_');
- if (NULL == full_name)
- return retval;
+ const char *ocd_name = alloc_printf("ocd_%s", c->name);
+ if (NULL == ocd_name)
+ return JIM_ERR;
- if (NULL != c->handler)
- {
- const char *ocd_name = alloc_printf("ocd_%s", full_name);
- if (NULL == full_name)
- goto free_full_name;
+ LOG_DEBUG("registering '%s'...", ocd_name);
- Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
- free((void *)ocd_name);
- }
+ Jim_CmdProc func = c->handler ? &script_command : &command_unknown;
+ int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
+ free((void *)ocd_name);
+ if (JIM_OK != retval)
+ return retval;
/* we now need to add an overrideable proc */
const char *override_name = alloc_printf(
"proc %s {args} {eval ocd_bouncer %s $args}",
- full_name, full_name);
+ c->name, c->name);
if (NULL == override_name)
- goto free_full_name;
+ return JIM_ERR;
- Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
+ retval = Jim_Eval_Named(interp, override_name, __FILE__, __LINE__);
free((void *)override_name);
- retval = ERROR_OK;
-
-free_full_name:
- free((void *)full_name);
return retval;
}
if (NULL == c)
return NULL;
- if (NULL != c->handler)
+ int retval = ERROR_OK;
+ if (NULL != cr->jim_handler && NULL == parent)
{
- int retval = register_command_handler(command_root(c));
- if (ERROR_OK != retval)
- {
- unregister_command(context, parent, name);
- return NULL;
- }
+ retval = Jim_CreateCommand(interp, cr->name,
+ cr->jim_handler, cr->jim_handler_data, NULL);
}
+ else if (NULL != cr->handler || NULL != parent)
+ retval = register_command_handler(command_root(c));
- if (NULL != cr->jim_handler && NULL == parent)
- Jim_CreateCommand(interp, cr->name, cr->jim_handler, cr->jim_handler_data, NULL);
-
+ if (ERROR_OK != retval)
+ {
+ unregister_command(context, parent, name);
+ c = NULL;
+ }
return c;
}
return ERROR_OK;
}
+void command_set_handler_data(struct command *c, void *p)
+{
+ if (NULL != c->handler || NULL != c->jim_handler)
+ c->jim_handler_data = p;
+ for (struct command *cc = c->children; NULL != cc; cc = cc->next)
+ command_set_handler_data(cc, p);
+}
+
void command_output_text(struct command_context *context, const char *data)
{
if (context && context->output_handler && data) {
return __command_name(c, delim, 0);
}
+static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
+{
+ return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
+}
+
static int run_command(struct command_context *context,
struct command *c, const char *words[], unsigned num_words)
{
- if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
+ if (!command_can_run(context, c))
{
/* Config commands can not run after the config stage */
- LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
+ LOG_ERROR("The '%s' command must be used before 'init'.", c->name);
return ERROR_FAIL;
}
return copy_context;
}
-int command_done(struct command_context *context)
+void command_done(struct command_context *cmd_ctx)
{
- free(context);
- context = NULL;
+ if (NULL == cmd_ctx)
+ return;
- return ERROR_OK;
+ free(cmd_ctx);
}
/* find full path to file */
static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
bool show_help)
{
+ if (!command_can_run(CMD_CTX, c))
+ return ERROR_OK;
+
+ char *cmd_name = command_name(c, ' ');
+ if (NULL == cmd_name)
+ return -ENOMEM;
+
command_help_show_indent(n);
- LOG_USER_N("%s", command_name(c, ' '));
+ LOG_USER_N("%s", cmd_name);
+ free(cmd_name);
+
if (c->usage) {
LOG_USER_N(" ");
command_help_show_wrap(c->usage, 0, n + 5);
}
else
LOG_USER_N("\n");
- if (show_help && c->help)
- command_help_show_wrap(c->help, n + 3, n + 3);
+
+ if (show_help)
+ {
+ const char *stage_msg;
+ switch (c->mode) {
+ case COMMAND_CONFIG: stage_msg = "CONFIG"; break;
+ case COMMAND_EXEC: stage_msg = "EXEC"; break;
+ case COMMAND_ANY: stage_msg = "CONFIG or EXEC"; break;
+ default: stage_msg = "***UNKNOWN***"; break;
+ }
+ char *msg = alloc_printf("%s%sValid Modes: %s",
+ c->help ? : "", c->help ? " " : "", stage_msg);
+ if (NULL != msg)
+ {
+ command_help_show_wrap(msg, n + 3, n + 3);
+ free(msg);
+ } else
+ return -ENOMEM;
+ }
+
if (++n >= 2)
return ERROR_OK;
static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
{
const char *cmd_name = Jim_GetString(argv[0], NULL);
- script_debug(interp, cmd_name, argc - 1, argv + 1);
+ if (strcmp(cmd_name, "unknown") == 0)
+ {
+ if (argc == 1)
+ return JIM_OK;
+ argc--;
+ argv++;
+ }
+ script_debug(interp, cmd_name, argc, argv);
struct command_context *cmd_ctx = current_command_context();
struct command *c = cmd_ctx->commands;
- int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
+ int remaining = command_unknown_find(argc, argv, c, &c, true);
// if nothing could be consumed, then it's really an unknown command
- if (remaining == argc - 1)
+ if (remaining == argc)
{
- const char *cmd = Jim_GetString(argv[1], NULL);
+ const char *cmd = Jim_GetString(argv[0], NULL);
LOG_ERROR("Unknown command:\n %s", cmd);
return JIM_OK;
}
return script_command_run(interp, count, start, c, found);
}
+static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+ struct command_context *cmd_ctx = current_command_context();
+ enum command_mode mode;
+ if (argc > 1)
+ {
+ struct command *c = cmd_ctx->commands;
+ int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
+ // if nothing could be consumed, then it's an unknown command
+ if (remaining == argc - 1)
+ {
+ Jim_SetResultString(interp, "unknown", -1);
+ return JIM_OK;
+ }
+ mode = c->mode;
+ }
+ else
+ mode = cmd_ctx->mode;
+
+ const char *mode_str;
+ switch (mode) {
+ case COMMAND_ANY: mode_str = "any"; break;
+ case COMMAND_CONFIG: mode_str = "config"; break;
+ case COMMAND_EXEC: mode_str = "exec"; break;
+ default: mode_str = "unknown"; break;
+ }
+ Jim_SetResultString(interp, mode_str, -1);
+ return JIM_OK;
+}
+
static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
{
if (1 == argc)
}
static const struct command_registration command_subcommand_handlers[] = {
+ {
+ .name = "mode",
+ .mode = COMMAND_ANY,
+ .jim_handler = &jim_command_mode,
+ .usage = "[<name> ...]",
+ .help = "Returns the command modes allowed by a command:"
+ "'any', 'config', or 'exec'. If no command is"
+ "specified, returns the current command mode.",
+ },
{
.name = "type",
.mode = COMMAND_ANY,
Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
- Jim_CreateCommand(interp, "unknown", &command_unknown, NULL, NULL);
Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
Code Review / openocd.git / blobdiff