X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=d8b78759e28ae0ccf0123ae969d88fb911ec6c98;hp=ad09e3de27878f4dfb626e77e8bbc098b55b535d;hb=a19aaf913688424dbd6384028854c178c9eb5bf2;hpb=cfaf7bdd0aedb23a4837078db808be450e5efc30

diff --git a/src/helper/command.c b/src/helper/command.c
index ad09e3de27..d8b78759e2 100644
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -44,7 +44,6 @@
 #include "jim-eventloop.h"
 
 
-int fast_and_dangerous = 0;
 Jim_Interp *interp = NULL;
 
 static int run_command(struct command_context *context,
@@ -76,15 +75,45 @@ void script_debug(Jim_Interp *interp, const char *name,
 	}
 }
 
+static void script_command_args_free(const char **words, unsigned nwords)
+{
+	for (unsigned i = 0; i < nwords; i++)
+		free((void *)words[i]);
+	free(words);
+}
+static const char **script_command_args_alloc(
+		unsigned argc, Jim_Obj *const *argv, unsigned *nwords)
+{
+	const char **words = malloc(argc * sizeof(char *));
+	if (NULL == words)
+		return NULL;
+
+	unsigned i;
+	for (i = 0; i < argc; i++)
+	{
+		int len;
+		const char *w = Jim_GetString(argv[i], &len);
+		/* a comment may end the line early */
+		if (*w == '#')
+			break;
+
+		words[i] = strdup(w);
+		if (words[i] == NULL)
+		{
+			script_command_args_free(words, i);
+			return NULL;
+		}
+	}
+	*nwords = i;
+	return words;
+}
+
 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
 	/* the private data is stashed in the interp structure */
 	struct command *c;
 	struct command_context *context;
 	int retval;
-	int i;
-	int nwords;
-	char **words;
 
 	/* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
 	 * get overwritten by running other Jim commands! Treat it as an
@@ -102,27 +131,10 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
 	script_debug(interp, c->name, argc, argv);
 
-	words = malloc(argc * sizeof(char *));
-	for (i = 0; i < argc; i++)
-	{
-		int len;
-		const char *w = Jim_GetString(argv[i], &len);
-		if (*w=='#')
-		{
-			/* hit an end of line comment */
-			break;
-		}
-		words[i] = strdup(w);
-		if (words[i] == NULL)
-		{
-			int j;
-			for (j = 0; j < i; j++)
-				free(words[j]);
-			free(words);
-			return JIM_ERR;
-		}
-	}
-	nwords = i;
+	unsigned nwords;
+	const char **words = script_command_args_alloc(argc, argv, &nwords);
+	if (NULL == words)
+		return JIM_ERR;
 
 	/* grab the command context from the associated data */
 	context = Jim_GetAssocData(interp, "context");
@@ -141,7 +153,6 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
 	log_add_callback(tcl_output, tclOutput);
 
-	// turn words[0] into CMD_ARGV[-1] with this cast
 	retval = run_command(context, c, (const char **)words, nwords);
 
 	log_remove_callback(tcl_output, tclOutput);
@@ -150,9 +161,7 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 	Jim_SetResult(interp, tclOutput);
 	Jim_DecrRefCount(interp, tclOutput);
 
-	for (i = 0; i < nwords; i++)
-		free(words[i]);
-	free(words);
+	script_command_args_free(words, nwords);
 
 	int *return_retval = Jim_GetAssocData(interp, "retval");
 	if (return_retval != NULL)
@@ -163,32 +172,6 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 	return (retval == ERROR_OK)?JIM_OK:JIM_ERR;
 }
 
-static Jim_Obj *command_name_list(struct command *c)
-{
-	Jim_Obj *cmd_list = c->parent ?
-			command_name_list(c->parent) :
-			Jim_NewListObj(interp, NULL, 0);
-	Jim_ListAppendElement(interp, cmd_list,
-			Jim_NewStringObj(interp, c->name, -1));
-
-	return cmd_list;
-}
-
-static void command_helptext_add(Jim_Obj *cmd_list, const char *help)
-{
-	Jim_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
-	Jim_ListAppendElement(interp, cmd_entry, cmd_list);
-	Jim_ListAppendElement(interp, cmd_entry,
-			Jim_NewStringObj(interp, help ? : "", -1));
-
-	/* accumulate help text in Tcl helptext list.  */
-	Jim_Obj *helptext = Jim_GetGlobalVariableStr(interp,
-			"ocd_helptext", JIM_ERRMSG);
-	if (Jim_IsShared(helptext))
-		helptext = Jim_DuplicateObj(interp, helptext);
-	Jim_ListAppendElement(interp, helptext, cmd_entry);
-}
-
 /* nice short description of source file */
 #define __THIS__FILE__ "command.c"
 
@@ -196,10 +179,9 @@ static void command_helptext_add(Jim_Obj *cmd_list, const char *help)
  * Find a command by name from a list of commands.
  * @returns The named command if found, or NULL.
  */
-static struct command *command_find(struct command **head, const char *name)
+static struct command *command_find(struct command *head, const char *name)
 {
-	assert(head);
-	for (struct command *cc = *head; cc; cc = cc->next)
+	for (struct command *cc = head; cc; cc = cc->next)
 	{
 		if (strcmp(cc->name, name) == 0)
 			return cc;
@@ -225,33 +207,71 @@ static void command_add_child(struct command **head, struct command *c)
 	cc->next = c;
 }
 
-struct command* register_command(struct command_context *context,
-		struct command *parent, char *name, command_handler_t handler,
-		enum command_mode mode, char *help)
+static struct command **command_list_for_parent(
+		struct command_context *cmd_ctx, struct command *parent)
 {
-	if (!context || !name)
-		return NULL;
+	return parent ? &parent->children : &cmd_ctx->commands;
+}
 
-	struct command **head = parent ? &parent->children : &context->commands;
-	struct command *c = command_find(head, name);
-	if (NULL != c)
-		return c;
+static struct command *command_new(struct command_context *cmd_ctx,
+		struct command *parent, const char *name,
+		command_handler_t handler, enum command_mode mode,
+		const char *help)
+{
+	assert(name);
 
-	c = malloc(sizeof(struct command));
+	struct command *c = malloc(sizeof(struct command));
+	memset(c, 0, sizeof(struct command));
 
 	c->name = strdup(name);
+	if (help)
+		c->help = strdup(help);
 	c->parent = parent;
-	c->children = NULL;
 	c->handler = handler;
 	c->mode = mode;
-	c->next = NULL;
 
-	command_add_child(head, c);
+	command_add_child(command_list_for_parent(cmd_ctx, parent), c);
 
-	command_helptext_add(command_name_list(c), help);
+	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);
+	}
 
-	/* just a placeholder, no handler */
-	if (c->handler == NULL)
+	if (c->name)
+		free(c->name);
+	if (c->help)
+		free((void*)c->help);
+	free(c);
+}
+
+struct command* register_command(struct command_context *context,
+		struct command *parent, const char *name,
+		command_handler_t handler, enum command_mode mode,
+		const char *help)
+{
+	if (!context || !name)
+		return NULL;
+
+	struct command **head = command_list_for_parent(context, parent);
+	struct command *c = command_find(*head, name);
+	if (NULL != c)
+	{
+		LOG_ERROR("command '%s' is already registered in '%s' context",
+				name, parent ? parent->name : "<global>");
+		return c;
+	}
+
+	c = command_new(context, parent, name, handler, mode, help);
+	/* if allocation failed or it is a placeholder (no handler), we're done */
+	if (NULL == c || NULL == c->handler)
 		return c;
 
 	const char *full_name = command_name(c, '_');
@@ -273,85 +293,43 @@ struct command* register_command(struct command_context *context,
 	return c;
 }
 
-int unregister_all_commands(struct command_context *context)
+int unregister_all_commands(struct command_context *context,
+		struct command *parent)
 {
-	struct command *c, *c2;
-
 	if (context == NULL)
 		return ERROR_OK;
 
-	while (NULL != context->commands)
+	struct command **head = command_list_for_parent(context, parent);
+	while (NULL != *head)
 	{
-		c = context->commands;
-
-		while (NULL != c->children)
-		{
-			c2 = c->children;
-			c->children = c->children->next;
-			free(c2->name);
-			c2->name = NULL;
-			free(c2);
-			c2 = NULL;
-		}
-
-		context->commands = context->commands->next;
-
-		free(c->name);
-		c->name = NULL;
-		free(c);
-		c = NULL;
+		struct command *tmp = *head;
+		*head = tmp->next;
+		command_free(tmp);
 	}
 
 	return ERROR_OK;
 }
 
-int unregister_command(struct command_context *context, char *name)
+int unregister_command(struct command_context *context,
+		struct command *parent, const char *name)
 {
-	struct command *c, *p = NULL, *c2;
-
 	if ((!context) || (!name))
 		return ERROR_INVALID_ARGUMENTS;
 
-	/* find command */
-	c = context->commands;
-
-	while (NULL != c)
+	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)
-		{
-			/* unlink command */
-			if (p)
-			{
-				p->next = c->next;
-			}
-			else
-			{
-				/* first element in command list */
-				context->commands = c->next;
-			}
+		if (strcmp(name, c->name) != 0)
+			continue;
 
-			/* unregister children */
-			while (NULL != c->children)
-			{
-				c2 = c->children;
-				c->children = c->children->next;
-				free(c2->name);
-				c2->name = NULL;
-				free(c2);
-				c2 = NULL;
-			}
-
-			/* delete command */
-			free(c->name);
-			c->name = NULL;
-			free(c);
-			c = NULL;
-			return ERROR_OK;
-		}
+		if (p)
+			p->next = c->next;
+		else
+			*head = c->next;
 
-		/* remember the last command for unlinking */
-		p = c;
-		c = c->next;
+		command_free(c);
+		return ERROR_OK;
 	}
 
 	return ERROR_OK;
@@ -719,6 +697,112 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 	return retcode;
 }
 
+static COMMAND_HELPER(command_help_find, struct command *head,
+		struct command **out)
+{
+	if (0 == CMD_ARGC)
+		return ERROR_INVALID_ARGUMENTS;
+	*out = command_find(head, CMD_ARGV[0]);
+	if (NULL == *out)
+		return ERROR_INVALID_ARGUMENTS;
+	if (--CMD_ARGC == 0)
+		return ERROR_OK;
+	CMD_ARGV++;
+	return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
+}
+
+static COMMAND_HELPER(command_help_show, struct command *c, unsigned n);
+
+static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n)
+{
+	for (struct command *c = head; NULL != c; c = c->next)
+		CALL_COMMAND_HANDLER(command_help_show, c, n);
+	return ERROR_OK;
+}
+static COMMAND_HELPER(command_help_show, struct command *c, unsigned n)
+{
+	command_run_linef(CMD_CTX, "cmd_help {%s} {%s} %d", command_name(c, ' '),
+			c->help ? : "no help available", n);
+
+	if (++n >= 2)
+		return ERROR_OK;
+
+	return CALL_COMMAND_HANDLER(command_help_show_list, c->children, n);
+}
+COMMAND_HANDLER(handle_help_command)
+{
+	struct command *c = CMD_CTX->commands;
+
+	if (0 == CMD_ARGC)
+		return CALL_COMMAND_HANDLER(command_help_show_list, c, 0);
+
+	int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
+	if (ERROR_OK != retval)
+		return retval;
+
+	return CALL_COMMAND_HANDLER(command_help_show, c, 0);
+}
+
+
+int help_add_command(struct command_context *cmd_ctx, struct command *parent,
+		const char *cmd_name, const char *help_text)
+{
+	struct command **head = command_list_for_parent(cmd_ctx, parent);
+	struct command *nc = command_find(*head, cmd_name);
+	if (NULL == nc)
+	{
+		// add a new command with help text
+		nc = register_command(cmd_ctx, parent, cmd_name,
+				NULL, COMMAND_ANY, help_text);
+		if (NULL == nc)
+		{
+			LOG_ERROR("failed to add '%s' help text", cmd_name);
+			return ERROR_FAIL;
+		}
+		LOG_DEBUG("added '%s' help text", cmd_name);
+	}
+	else
+	{
+		bool replaced = false;
+		if (nc->help)
+		{
+			free((void *)nc->help);
+			replaced = true;
+		}
+		nc->help = strdup(help_text);
+
+		if (replaced)
+			LOG_INFO("replaced existing '%s' help", cmd_name);
+		else
+			LOG_DEBUG("added '%s' help text", cmd_name);
+	}
+	return ERROR_OK;
+}
+
+COMMAND_HANDLER(handle_help_add_command)
+{
+	if (CMD_ARGC < 2)
+	{
+		LOG_ERROR("%s: insufficient arguments", CMD_NAME);
+		return ERROR_INVALID_ARGUMENTS;
+	}
+
+	// save help text and remove it from argument list
+	const char *help_text = CMD_ARGV[--CMD_ARGC];
+	// likewise for the leaf command name
+	const char *cmd_name = CMD_ARGV[--CMD_ARGC];
+
+	struct command *c = NULL;
+	if (CMD_ARGC > 0)
+	{
+		c = CMD_CTX->commands;
+		int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
+		if (ERROR_OK != retval)
+			return retval;
+	}
+	return help_add_command(CMD_CTX, c, cmd_name, help_text);
+}
+
 /* sleep command sleeps for <n> miliseconds
  * this is useful in target startup scripts
  */
@@ -755,21 +839,9 @@ COMMAND_HANDLER(handle_sleep_command)
 	return ERROR_OK;
 }
 
-COMMAND_HANDLER(handle_fast_command)
-{
-	if (CMD_ARGC != 1)
-		return ERROR_COMMAND_SYNTAX_ERROR;
-
-	fast_and_dangerous = strcmp("enable", CMD_ARGV[0]) == 0;
-
-	return ERROR_OK;
-}
-
-
-struct command_context* command_init()
+struct command_context* command_init(const char *startup_tcl)
 {
 	struct command_context* context = malloc(sizeof(struct command_context));
-	extern const char startup_tcl[];
 	const char *HostOs;
 
 	context->mode = COMMAND_EXEC;
@@ -826,24 +898,31 @@ struct command_context* command_init()
 	interp->cb_fflush = openocd_jim_fflush;
 	interp->cb_fgets = openocd_jim_fgets;
 
+	register_command(context, NULL, "add_help_text",
+			handle_help_add_command, COMMAND_ANY,
+			"<command> [...] <help_text>] - "
+			"add new command help text");
+
 #if !BUILD_ECOSBOARD
 	Jim_EventLoopOnLoad(interp);
 #endif
+	Jim_SetAssocData(interp, "context", NULL, context);
 	if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
 	{
 		LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
 		Jim_PrintErrorMessage(interp);
 		exit(-1);
 	}
+	Jim_DeleteAssocData(interp, "context");
 
 	register_command(context, NULL, "sleep",
 			handle_sleep_command, COMMAND_ANY,
 			"<n> [busy] - sleep for n milliseconds. "
 			"\"busy\" means busy wait");
-	register_command(context, NULL, "fast",
-			handle_fast_command, COMMAND_ANY,
-			"fast <enable/disable> - place at beginning of "
-			"config files. Sets defaults to fast and dangerous.");
+
+	register_command(context, NULL, "help",
+			&handle_help_command, COMMAND_ANY,
+			"[<command_name> ...] - show built-in command help");
 
 	return context;
 }
@@ -880,19 +959,7 @@ void register_jim(struct command_context *cmd_ctx, const char *name,
 	Jim_ListAppendElement(interp, cmd_list,
 			Jim_NewStringObj(interp, name, -1));
 
-	command_helptext_add(cmd_list, help);
-}
-
-/* return global variable long value or 0 upon failure */
-long jim_global_long(const char *variable)
-{
-	Jim_Obj *objPtr = Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
-	long t;
-	if (Jim_GetLong(interp, objPtr, &t) == JIM_OK)
-	{
-		return t;
-	}
-	return 0;
+	help_add_command(cmd_ctx, NULL, name, help);
 }
 
 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
@@ -955,3 +1022,51 @@ DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
+
+static int command_parse_bool(const char *in, bool *out,
+		const char *on, const char *off)
+{
+	if (strcasecmp(in, on) == 0)
+		*out = true;
+	else if (strcasecmp(in, off) == 0)
+		*out = false;
+	else
+		return ERROR_COMMAND_SYNTAX_ERROR;
+	return  ERROR_OK;
+}
+
+int command_parse_bool_arg(const char *in, bool *out)
+{
+	if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
+		return ERROR_OK;
+	if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
+		return ERROR_OK;
+	if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
+		return ERROR_OK;
+	if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
+		return ERROR_OK;
+	if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
+		return ERROR_OK;
+	return ERROR_INVALID_ARGUMENTS;
+}
+
+COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
+{
+	switch (CMD_ARGC) {
+	case 1: {
+		const char *in = CMD_ARGV[0];
+		if (command_parse_bool_arg(in, out) != ERROR_OK)
+		{
+			LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
+			return ERROR_INVALID_ARGUMENTS;
+		}
+		// fall through
+	}
+	case 0:
+		LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
+		break;
+	default:
+		return ERROR_INVALID_ARGUMENTS;
+	}
+	return ERROR_OK;
+}