};
static int unregister_command(struct command_context *context,
- struct command *parent, const char *name);
-static char *command_name(struct command *c, char delim);
-static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj * const *argv);
+ const char *cmd_prefix, const char *name);
+static int jim_command_dispatch(Jim_Interp *interp, int argc, Jim_Obj * const *argv);
static int help_add_command(struct command_context *cmd_ctx,
const char *cmd_name, const char *help_text, const char *usage_text);
static int help_del_command(struct command_context *cmd_ctx, const char *cmd_name);
return cmd->isproc;
}
-static inline bool jimcmd_is_ocd_command(Jim_Cmd *cmd)
+bool jimcmd_is_oocd_command(Jim_Cmd *cmd)
{
- return !cmd->isproc && cmd->u.native.cmdProc == command_unknown;
+ return !cmd->isproc && cmd->u.native.cmdProc == jim_command_dispatch;
}
-static inline void *jimcmd_privdata(Jim_Cmd *cmd)
+void *jimcmd_privdata(Jim_Cmd *cmd)
{
return cmd->isproc ? NULL : cmd->u.native.privData;
}
{
/* capture log output and return it. A garbage collect can
* happen, so we need a reference count to this object */
- Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
- if (NULL == tclOutput)
+ Jim_Obj *jim_output = Jim_NewStringObj(interp, "", 0);
+ if (!jim_output)
return NULL;
+ Jim_IncrRefCount(jim_output);
+
struct log_capture_state *state = malloc(sizeof(*state));
- if (NULL == state)
+ if (!state) {
+ LOG_ERROR("Out of memory");
+ Jim_DecrRefCount(interp, jim_output);
return NULL;
+ }
state->interp = interp;
- Jim_IncrRefCount(tclOutput);
- state->output = tclOutput;
+ state->output = jim_output;
log_add_callback(tcl_output, state);
* Use the internal jimtcl API Jim_CreateCommandObj, not exported by jim.h,
* and override the bugged API through preprocessor's macro.
* This workaround works only when jimtcl is compiled as OpenOCD submodule.
+ * It's broken on macOS, so it's currently restricted on Linux only.
* If jimtcl is linked-in from a precompiled library, either static or dynamic,
* the symbol Jim_CreateCommandObj is not exported and the build will use the
* bugged API.
* To be removed when OpenOCD will switch to jimtcl 0.81
*/
-#if JIM_VERSION == 80
+#if JIM_VERSION == 80 && defined __linux__
static int workaround_createcommand(Jim_Interp *interp, const char *cmdName,
Jim_CmdProc *cmdProc, void *privData, Jim_DelCmdProc *delProc);
int Jim_CreateCommandObj(Jim_Interp *interp, Jim_Obj *cmdNameObj,
return retval;
}
#define Jim_CreateCommand workaround_createcommand
-#endif /* JIM_VERSION == 80 */
+#endif /* JIM_VERSION == 80 && defined __linux__*/
/* FIXME: end of workaround for memory leak in jimtcl 0.80 */
static int command_retval_set(Jim_Interp *interp, int retval)
/* dump a single line to the log for the command.
* Do nothing in case we are not at debug level 3 */
-void script_debug(Jim_Interp *interp, unsigned int argc, Jim_Obj * const *argv)
+static void script_debug(Jim_Interp *interp, unsigned int argc, Jim_Obj * const *argv)
{
if (debug_level < LOG_LVL_DEBUG)
return;
Jim_IncrRefCount(jim_name);
Jim_Cmd *cmd = Jim_GetCommand(interp, jim_name, JIM_NONE);
Jim_DecrRefCount(interp, jim_name);
- if (!cmd || jimcmd_is_proc(cmd) || !jimcmd_is_ocd_command(cmd))
+ if (!cmd || jimcmd_is_proc(cmd) || !jimcmd_is_oocd_command(cmd))
return NULL;
return jimcmd_privdata(cmd);
}
-/**
- * Find a command by name from a list of commands.
- * @returns Returns the named command if it exists in the list.
- * Returns NULL otherwise.
- */
-static struct command *command_find(struct command *head, const char *name)
-{
- for (struct command *cc = head; cc; cc = cc->next) {
- if (strcmp(cc->name, name) == 0)
- return cc;
- }
- return NULL;
-}
-
-/**
- * Add the command into the linked list, sorted by name.
- * @param head Address to head of command list pointer, which may be
- * updated if @c c gets inserted at the beginning of the list.
- * @param c The command to add to the list pointed to by @c head.
- */
-static void command_add_child(struct command **head, struct command *c)
-{
- assert(head);
- if (NULL == *head) {
- *head = c;
- return;
- }
-
- while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
- head = &(*head)->next;
-
- if (strcmp(c->name, (*head)->name) > 0) {
- c->next = (*head)->next;
- (*head)->next = c;
- } else {
- c->next = *head;
- *head = c;
- }
-}
-
-static struct command **command_list_for_parent(
- struct command_context *cmd_ctx, struct command *parent)
-{
- 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);
- }
-
- free(c->name);
- free(c);
-}
-
static struct command *command_new(struct command_context *cmd_ctx,
- struct command *parent, const struct command_registration *cr)
+ const char *full_name, const struct command_registration *cr)
{
assert(cr->name);
* strlen(.usage) == 0 means that the command takes no
* arguments.
*/
- if ((cr->jim_handler == NULL) && (cr->usage == NULL)) {
- LOG_ERROR("BUG: command '%s%s%s' does not have the "
+ if (!cr->jim_handler && !cr->usage)
+ LOG_ERROR("BUG: command '%s' does not have the "
"'.usage' field filled out",
- parent && parent->name ? parent->name : "",
- parent && parent->name ? " " : "",
- cr->name);
- }
+ full_name);
struct command *c = calloc(1, sizeof(struct command));
if (NULL == c)
return NULL;
c->name = strdup(cr->name);
- if (!c->name)
- goto command_new_error;
+ if (!c->name) {
+ free(c);
+ return NULL;
+ }
- c->parent = parent;
c->handler = cr->handler;
c->jim_handler = cr->jim_handler;
c->mode = cr->mode;
- command_add_child(command_list_for_parent(cmd_ctx, parent), c);
-
- if (cr->help || cr->usage) {
- char *full_name = command_name(c, ' ');
+ if (cr->help || cr->usage)
help_add_command(cmd_ctx, full_name, cr->help, cr->usage);
- free(full_name);
- }
return c;
+}
+
+static void command_free(struct Jim_Interp *interp, void *priv)
+{
+ struct command *c = priv;
-command_new_error:
- command_free(c);
- return NULL;
+ free(c->name);
+ free(c);
}
static struct command *register_command(struct command_context *context,
- struct command *parent, const struct command_registration *cr)
+ const char *cmd_prefix, const struct command_registration *cr)
{
+ char *full_name;
+
if (!context || !cr->name)
return NULL;
- const char *name = cr->name;
- struct command **head = command_list_for_parent(context, parent);
- struct command *c = command_find(*head, name);
- if (NULL != c) {
+ if (cmd_prefix)
+ full_name = alloc_printf("%s %s", cmd_prefix, cr->name);
+ else
+ full_name = strdup(cr->name);
+ if (!full_name)
+ return NULL;
+
+ struct command *c = command_find_from_name(context->interp, full_name);
+ if (c) {
/* TODO: originally we treated attempting to register a cmd twice as an error
* Sometimes we need this behaviour, such as with flash banks.
* http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
- LOG_DEBUG("command '%s' is already registered in '%s' context",
- name, parent ? parent->name : "<global>");
+ LOG_DEBUG("command '%s' is already registered", full_name);
+ free(full_name);
return c;
}
- c = command_new(context, parent, cr);
- if (NULL == c)
+ c = command_new(context, full_name, cr);
+ if (!c) {
+ free(full_name);
return NULL;
+ }
- char *full_name = command_name(c, ' ');
- LOG_DEBUG("registering '%s'...", full_name);
+ if (false) /* too noisy with debug_level 3 */
+ LOG_DEBUG("registering '%s'...", full_name);
int retval = Jim_CreateCommand(context->interp, full_name,
- command_unknown, c, NULL);
+ jim_command_dispatch, c, command_free);
if (retval != JIM_OK) {
- unregister_command(context, parent, name);
+ command_run_linef(context, "del_help_text {%s}", full_name);
+ command_run_linef(context, "del_usage_text {%s}", full_name);
+ free(c);
+ free(full_name);
return NULL;
}
+
+ free(full_name);
return c;
}
-static int ___register_commands(struct command_context *cmd_ctx, struct command *parent,
+int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
const struct command_registration *cmds, void *data,
struct target *override_target)
{
struct command *c = NULL;
if (NULL != cr->name) {
- c = register_command(cmd_ctx, parent, cr);
+ c = register_command(cmd_ctx, cmd_prefix, cr);
if (NULL == c) {
retval = ERROR_FAIL;
break;
c->jim_override_target = override_target;
}
if (NULL != cr->chain) {
- struct command *p = c ? : parent;
- retval = ___register_commands(cmd_ctx, p, cr->chain, data, override_target);
- if (ERROR_OK != retval)
+ if (cr->name) {
+ if (cmd_prefix) {
+ char *new_prefix = alloc_printf("%s %s", cmd_prefix, cr->name);
+ if (!new_prefix) {
+ retval = ERROR_FAIL;
+ break;
+ }
+ retval = __register_commands(cmd_ctx, new_prefix, cr->chain, data, override_target);
+ free(new_prefix);
+ } else {
+ retval = __register_commands(cmd_ctx, cr->name, cr->chain, data, override_target);
+ }
+ } else {
+ retval = __register_commands(cmd_ctx, cmd_prefix, cr->chain, data, override_target);
+ }
+ if (retval != ERROR_OK)
break;
}
}
- if (ERROR_OK != retval) {
+ if (retval != ERROR_OK) {
for (unsigned j = 0; j < i; j++)
- unregister_command(cmd_ctx, parent, cmds[j].name);
+ unregister_command(cmd_ctx, cmd_prefix, cmds[j].name);
}
return retval;
}
-int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
- const struct command_registration *cmds, void *data,
- struct target *override_target)
-{
- struct command *parent = NULL;
-
- if (cmd_prefix)
- parent = command_find(cmd_ctx->commands, cmd_prefix);
-
- return ___register_commands(cmd_ctx, parent, cmds, data, override_target);
-}
-
static __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)))
int unregister_commands_match(struct command_context *cmd_ctx, const char *format, ...)
{
Jim_DecrRefCount(interp, elem);
continue;
}
- LOG_DEBUG("delete command \"%s\"", name);
+ if (false) /* too noisy with debug_level 3 */
+ LOG_DEBUG("delete command \"%s\"", name);
+#if JIM_VERSION >= 80
Jim_DeleteCommand(interp, elem);
+#else
+ Jim_DeleteCommand(interp, name);
+#endif
help_del_command(cmd_ctx, name);
int unregister_all_commands(struct command_context *context,
const char *cmd_prefix)
{
- struct command *parent = NULL;
-
if (!context)
return ERROR_OK;
- if (!cmd_prefix || !*cmd_prefix) {
- int retval = unregister_commands_match(context, "*");
- if (retval != ERROR_OK)
- return retval;
- } else {
- Jim_Cmd *cmd = Jim_GetCommand(context->interp, Jim_NewStringObj(context->interp, cmd_prefix, -1), JIM_NONE);
- if (cmd && jimcmd_is_ocd_command(cmd))
- parent = jimcmd_privdata(cmd);
+ if (!cmd_prefix || !*cmd_prefix)
+ return unregister_commands_match(context, "*");
- int retval = unregister_commands_match(context, "%s *", cmd_prefix);
- if (retval != ERROR_OK)
- return retval;
- retval = unregister_commands_match(context, "%s", cmd_prefix);
- if (retval != ERROR_OK)
- return retval;
- }
-
- struct command **head = command_list_for_parent(context, parent);
- while (NULL != *head) {
- struct command *tmp = *head;
- *head = tmp->next;
- command_free(tmp);
- }
+ int retval = unregister_commands_match(context, "%s *", cmd_prefix);
+ if (retval != ERROR_OK)
+ return retval;
- return ERROR_OK;
+ return unregister_commands_match(context, "%s", cmd_prefix);
}
static int unregister_command(struct command_context *context,
- struct command *parent, const char *name)
+ const char *cmd_prefix, const char *name)
{
- if ((!context) || (!name))
+ if (!context || !name)
return ERROR_COMMAND_SYNTAX_ERROR;
- struct command *p = NULL;
- struct command **head = command_list_for_parent(context, parent);
- for (struct command *c = *head; NULL != c; p = c, c = c->next) {
- if (strcmp(name, c->name) != 0)
- continue;
-
- char *full_name = command_name(c, ' ');
-
- int retval = unregister_commands_match(context, "%s", full_name);
- if (retval != ERROR_OK)
- return retval;
-
- free(full_name);
-
- if (p)
- p->next = c->next;
- else
- *head = c->next;
-
- command_free(c);
- return ERROR_OK;
- }
+ if (!cmd_prefix || !*cmd_prefix)
+ return unregister_commands_match(context, "%s", name);
- return ERROR_OK;
+ return unregister_commands_match(context, "%s %s", cmd_prefix, name);
}
void command_output_text(struct command_context *context, const char *data)
va_end(ap);
}
-static char *__command_name(struct command *c, char delim, unsigned extra)
-{
- char *name;
- unsigned len = strlen(c->name);
- if (NULL == c->parent) {
- /* allocate enough for the name, child names, and '\0' */
- name = malloc(len + extra + 1);
- if (!name) {
- LOG_ERROR("Out of memory");
- return NULL;
- }
- strcpy(name, c->name);
- } else {
- /* parent's extra must include both the space and name */
- name = __command_name(c->parent, delim, 1 + len + extra);
- char dstr[2] = { delim, 0 };
- strcat(name, dstr);
- strcat(name, c->name);
- }
- return name;
-}
-
-static char *command_name(struct command *c, char delim)
-{
- return __command_name(c, delim, 0);
-}
-
static bool command_can_run(struct command_context *cmd_ctx, struct command *c, const char *full_name)
{
if (c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode)
((c->help != NULL) && (strstr(c->help, cmd_match) != NULL));
if (is_match) {
- command_help_show_indent(n);
- LOG_USER_N("%s", c->cmd_name);
-
if (c->usage && strlen(c->usage) > 0) {
- LOG_USER_N(" ");
- command_help_show_wrap(c->usage, 0, n + 5);
- } else
- LOG_USER_N("\n");
+ char *msg = alloc_printf("%s %s", c->cmd_name, c->usage);
+ command_help_show_wrap(msg, n, n + 5);
+ free(msg);
+ } else {
+ command_help_show_wrap(c->cmd_name, n, n + 5);
+ }
}
if (is_match && show_help) {
stage_msg = " (?mode error?)";
break;
}
- msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
+ msg = alloc_printf("%s%s", c->help ? c->help : "", stage_msg);
} else
- msg = alloc_printf("%s", c->help ? : "");
+ msg = alloc_printf("%s", c->help ? c->help : "");
if (NULL != msg) {
command_help_show_wrap(msg, n + 3, n + 3);
return command_retval_set(interp, retval);
}
-static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+static int jim_command_dispatch(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
{
script_debug(interp, argc, argv);
* current_target_override is used also for event handlers
* therefore we prevent touching it if command has no prefix.
* Previous override is saved and restored back to ensure
- * correct work when command_unknown() is re-entered.
+ * correct work when jim_command_dispatch() is re-entered.
*/
struct target *saved_target_override = cmd_ctx->current_target_override;
if (c->jim_override_target)
Jim_Cmd *cmd = Jim_GetCommand(interp, s, JIM_NONE);
Jim_DecrRefCount(interp, s);
free(full_name);
- if (!cmd || !(jimcmd_is_proc(cmd) || jimcmd_is_ocd_command(cmd))) {
+ if (!cmd || !(jimcmd_is_proc(cmd) || jimcmd_is_oocd_command(cmd))) {
Jim_SetResultString(interp, "unknown", -1);
return JIM_OK;
}
unsigned long duration = 0;
int retval = parse_ulong(CMD_ARGV[0], &duration);
- if (ERROR_OK != retval)
+ if (retval != ERROR_OK)
return retval;
if (!busy) {
.handler = jim_echo,
.mode = COMMAND_ANY,
.help = "Logs a message at \"user\" priority. "
- "Output message to stdout. "
"Option \"-n\" suppresses trailing newline",
.usage = "[-n] string",
},
struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp)
{
struct command_context *context = calloc(1, sizeof(struct command_context));
- const char *HostOs;
context->mode = COMMAND_EXEC;
context->interp = interp;
- /* Stick to lowercase for HostOS strings. */
-#if defined(_MSC_VER)
- /* WinXX - is generic, the forward
- * looking problem is this:
- *
- * "win32" or "win64"
- *
- * "winxx" is generic.
- */
- HostOs = "winxx";
-#elif defined(__linux__)
- HostOs = "linux";
-#elif defined(__APPLE__) || defined(__DARWIN__)
- HostOs = "darwin";
-#elif defined(__CYGWIN__)
- HostOs = "cygwin";
-#elif defined(__MINGW32__)
- HostOs = "mingw32";
-#elif defined(__ECOS)
- HostOs = "ecos";
-#elif defined(__FreeBSD__)
- HostOs = "freebsd";
-#elif defined(__NetBSD__)
- HostOs = "netbsd";
-#elif defined(__OpenBSD__)
- HostOs = "openbsd";
-#else
-#warning "Unrecognized host OS..."
- HostOs = "other";
-#endif
- Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
- Jim_NewStringObj(interp, HostOs, strlen(HostOs)));
-
register_commands(context, NULL, command_builtin_handlers);
Jim_SetAssocData(interp, "context", NULL, context);
LOG_ERROR("Invalid command argument"); \
return ERROR_COMMAND_ARGUMENT_INVALID; \
} \
- if ((max == *ul) && (ERANGE == errno)) { \
+ if ((max == *ul) && (errno == ERANGE)) { \
LOG_ERROR("Argument overflow"); \
return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
} \
- if (min && (min == *ul) && (ERANGE == errno)) { \
+ if (min && (min == *ul) && (errno == ERANGE)) { \
LOG_ERROR("Argument underflow"); \
return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
} \
{ \
functype n; \
int retval = parse ## funcname(str, &n); \
- if (ERROR_OK != retval) \
+ if (retval != ERROR_OK) \
return retval; \
if (n > max) \
return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
Code Review / openocd.git / blobdiff