X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=3cb36ea27590850c4f18131f10d265604b6af7d4;hb=17a9dea53a71e9d7e241262725f3dd707b620d37;hp=87a898f293eb9b868a3ea1287e7ce82c788f60c5;hpb=9e9633c6b98cc9243ae78cd12ab657d041eaa73e;p=openocd.git

diff --git a/src/helper/command.c b/src/helper/command.c
index 87a898f293..3cb36ea275 100644
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -108,11 +108,24 @@ static const char **script_command_args_alloc(
 	return words;
 }
 
+static struct command_context *current_command_context(void)
+{
+	/* grab the command context from the associated data */
+	struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
+	if (NULL == cmd_ctx)
+	{
+		/* Tcl can invoke commands directly instead of via command_run_line(). This would
+		 * happen when the Jim Tcl interpreter is provided by eCos.
+		 */
+		cmd_ctx = global_cmd_ctx;
+	}
+	return cmd_ctx;
+}
+
 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;
 
 	/* DANGER!!!! be careful what we invoke here, since interp->cmdPrivData might
@@ -136,16 +149,6 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 	if (NULL == words)
 		return JIM_ERR;
 
-	/* grab the command context from the associated data */
-	context = Jim_GetAssocData(interp, "context");
-	if (context == NULL)
-	{
-		/* Tcl can invoke commands directly instead of via command_run_line(). This would
-		 * happen when the Jim Tcl interpreter is provided by eCos.
-		 */
-		context = global_cmd_ctx;
-	}
-
 	/* capture log output and return it */
 	Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
 	/* a garbage collect can happen, so we need a reference count to this object */
@@ -153,7 +156,8 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
 	log_add_callback(tcl_output, tclOutput);
 
-	retval = run_command(context, c, (const char **)words, nwords);
+	struct command_context *cmd_ctx = current_command_context();
+	retval = run_command(cmd_ctx, c, (const char **)words, nwords);
 
 	log_remove_callback(tcl_output, tclOutput);
 
@@ -172,38 +176,13 @@ 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"
 
 /**
  * Find a command by name from a list of commands.
- * @returns The named command if found, or NULL.
+ * @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)
 {
@@ -214,11 +193,22 @@ static struct command *command_find(struct command *head, const char *name)
 	}
 	return NULL;
 }
+struct command *command_find_in_context(struct command_context *cmd_ctx,
+		const char *name)
+{
+	return command_find(cmd_ctx->commands, name);
+}
+struct command *command_find_in_parent(struct command *parent,
+		const char *name)
+{
+	return command_find(parent->children, name);
+}
 
 /**
- * Add the command to the end of linked list.
- * @returns Returns false if the named command already exists in the list.
- * Returns true otherwise.
+ * 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)
 {
@@ -228,9 +218,17 @@ static void command_add_child(struct command **head, struct command *c)
 		*head = c;
 		return;
 	}
-	struct command *cc = *head;
-	while (cc->next) cc = cc->next;
-	cc->next = c;
+
+	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(
@@ -240,24 +238,26 @@ static struct command **command_list_for_parent(
 }
 
 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)
+		struct command *parent, const struct command_registration *cr)
 {
-	assert(name);
+	assert(cr->name);
 
 	struct command *c = malloc(sizeof(struct command));
 	memset(c, 0, sizeof(struct command));
 
-	c->name = strdup(name);
+	c->name = strdup(cr->name);
+	if (cr->help)
+		c->help = strdup(cr->help);
+	if (cr->usage)
+		c->usage = strdup(cr->usage);
 	c->parent = parent;
-	c->handler = handler;
-	c->mode = mode;
+	c->handler = cr->handler;
+	c->jim_handler = cr->jim_handler;
+	c->jim_handler_data = cr->jim_handler_data;
+	c->mode = cr->mode;
 
 	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)
@@ -273,34 +273,24 @@ static void command_free(struct command *c)
 
 	if (c->name)
 		free(c->name);
+	if (c->help)
+		free((void*)c->help);
+	if (c->usage)
+		free((void*)c->usage);
 	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)
+static int register_command_handler(struct command *c)
 {
-	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;
-
+	int retval = -ENOMEM;
 	const char *full_name = command_name(c, '_');
+	if (NULL == full_name)
+		return retval;
 
 	const char *ocd_name = alloc_printf("ocd_%s", full_name);
+	if (NULL == full_name)
+		goto free_full_name;
+
 	Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
 	free((void *)ocd_name);
 
@@ -309,14 +299,90 @@ struct command* register_command(struct command_context *context,
 			"if {[catch {eval ocd_%s $args}] == 0} "
 			"{return \"\"} else {return -code error}}",
 			full_name, full_name);
+	if (NULL == full_name)
+		goto free_full_name;
+
 	Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
 	free((void *)override_name);
 
+	retval = ERROR_OK;
+
+free_full_name:
 	free((void *)full_name);
+	return retval;
+}
+
+struct command* register_command(struct command_context *context,
+		struct command *parent, const struct command_registration *cr)
+{
+	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)
+	{
+		LOG_ERROR("command '%s' is already registered in '%s' context",
+				name, parent ? parent->name : "<global>");
+		return c;
+	}
+
+	c = command_new(context, parent, cr);
+	if (NULL == c)
+		return NULL;
+
+	if (NULL != c->handler)
+	{
+		int retval = register_command_handler(c);
+		if (ERROR_OK != retval)
+		{
+			unregister_command(context, parent, name);
+			return NULL;
+		}
+	}
+
+	if (NULL != cr->jim_handler && NULL == parent)
+		Jim_CreateCommand(interp, cr->name, cr->jim_handler, cr->jim_handler_data, NULL);
 
 	return c;
 }
 
+int register_commands(struct command_context *cmd_ctx, struct command *parent,
+		const struct command_registration *cmds)
+{
+	int retval = ERROR_OK;
+	unsigned i;
+	for (i = 0; cmds[i].name || cmds[i].chain; i++)
+	{
+		const struct command_registration *cr = cmds + i;
+
+		struct command *c = NULL;
+		if (NULL != cr->name)
+		{
+			c = register_command(cmd_ctx, parent, cr);
+			if (NULL == c)
+			{
+				retval = ERROR_FAIL;
+				break;
+			}
+		}
+		if (NULL != cr->chain)
+		{
+			struct command *p = c ? : parent;
+			retval = register_commands(cmd_ctx, p, cr->chain);
+			if (ERROR_OK != retval)
+				break;
+		}
+	}
+	if (ERROR_OK != retval)
+	{
+		for (unsigned j = 0; j < i; j++)
+			unregister_command(cmd_ctx, parent, cmds[j].name);
+	}
+	return retval;
+}
+
 int unregister_all_commands(struct command_context *context,
 		struct command *parent)
 {
@@ -721,6 +787,213 @@ 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,
+		bool show_help);
+
+static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
+		bool show_help)
+{
+	for (struct command *c = head; NULL != c; c = c->next)
+		CALL_COMMAND_HANDLER(command_help_show, c, n, show_help);
+	return ERROR_OK;
+}
+static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
+		bool show_help)
+{
+	const char *usage = c->usage ? : "";
+	const char *help = "";
+	const char *sep = "";
+	if (show_help && c->help)
+	{
+		help = c->help ? : "";
+		sep = c->usage ? " | " : "";
+	}
+	command_run_linef(CMD_CTX, "cmd_help {%s} {%s%s%s} %d",
+			command_name(c, ' '), usage, sep, help, n);
+
+	if (++n >= 2)
+		return ERROR_OK;
+
+	return CALL_COMMAND_HANDLER(command_help_show_list,
+			c->children, n, show_help);
+}
+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, true);
+
+	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, true);
+}
+
+COMMAND_HANDLER(handle_usage_command)
+{
+	struct command *c = CMD_CTX->commands;
+
+	if (0 == CMD_ARGC)
+		return CALL_COMMAND_HANDLER(command_help_show_list, c, 0, false);
+
+	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, false);
+}
+
+static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
+		struct command *head, struct command **out)
+{
+	if (0 == argc)
+		return argc;
+	struct command *c = command_find(head, Jim_GetString(argv[0], NULL));
+	if (NULL == c)
+		return argc;
+	*out = c;
+	return command_unknown_find(--argc, ++argv, (*out)->children, out);
+}
+
+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);
+
+	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);
+	// if nothing could be consumed, then it's really an unknown command
+	if (remaining == argc - 1)
+	{
+		const char *cmd = Jim_GetString(argv[1], NULL);
+		LOG_ERROR("Unknown command:\n  %s", cmd);
+		return JIM_OK;
+	}
+
+	bool found = true;
+	Jim_Obj *const *start;
+	unsigned count;
+	if (c->handler || c->jim_handler)
+	{
+		// include the command name in the list
+		count = remaining + 1;
+		start = argv + (argc - remaining - 1);
+	}
+	else
+	{
+		c = command_find(cmd_ctx->commands, "help");
+		if (NULL == c)
+		{
+			LOG_ERROR("unknown command, but help is missing too");
+			return JIM_ERR;
+		}
+		count = argc - remaining;
+		start = argv;
+		found = false;
+	}
+	// pass the command through to the intended handler
+	if (c->jim_handler)
+	{
+		interp->cmdPrivData = c->jim_handler_data;
+		return (*c->jim_handler)(interp, count, start);
+	}
+
+	unsigned nwords;
+	const char **words = script_command_args_alloc(count, start, &nwords);
+	if (NULL == words)
+		return JIM_ERR;
+
+	int retval = run_command(cmd_ctx, c, words, nwords);
+
+	script_command_args_free(words, nwords);
+
+	if (!found && ERROR_OK == retval)
+		retval = ERROR_FAIL;
+
+	return retval;
+}
+
+int help_add_command(struct command_context *cmd_ctx, struct command *parent,
+		const char *cmd_name, const char *help_text, const char *usage)
+{
+	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
+		struct command_registration cr = {
+				.name = cmd_name,
+				.mode = COMMAND_ANY,
+				.help = help_text,
+				.usage = usage,
+			};
+		nc = register_command(cmd_ctx, parent, &cr);
+		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, NULL);
+}
+
 /* sleep command sleeps for <n> miliseconds
  * this is useful in target startup scripts
  */
@@ -757,6 +1030,39 @@ COMMAND_HANDLER(handle_sleep_command)
 	return ERROR_OK;
 }
 
+static const struct command_registration command_builtin_handlers[] = {
+	{
+		.name = "add_help_text",
+		.handler = &handle_help_add_command,
+		.mode = COMMAND_ANY,
+		.help = "add new command help text",
+		.usage = "<command> [...] <help_text>]",
+	},
+	{
+		.name = "sleep",
+		.handler = &handle_sleep_command,
+		.mode = COMMAND_ANY,
+		.help = "sleep for n milliseconds.  "
+			"\"busy\" will busy wait",
+		.usage = "<n> [busy]",
+	},
+	{
+		.name = "help",
+		.handler = &handle_help_command,
+		.mode = COMMAND_ANY,
+		.help = "show built-in command help",
+		.usage = "[<command_name> ...]",
+	},
+	{
+		.name = "usage",
+		.handler = &handle_usage_command,
+		.mode = COMMAND_ANY,
+		.help = "show command usage",
+		.usage = "[<command_name> ...]",
+	},
+	COMMAND_REGISTRATION_DONE
+};
+
 struct command_context* command_init(const char *startup_tcl)
 {
 	struct command_context* context = malloc(sizeof(struct command_context));
@@ -802,6 +1108,7 @@ struct command_context* command_init(const char *startup_tcl)
 	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);
@@ -816,20 +1123,19 @@ struct command_context* command_init(const char *startup_tcl)
 	interp->cb_fflush = openocd_jim_fflush;
 	interp->cb_fgets = openocd_jim_fgets;
 
+	register_commands(context, NULL, command_builtin_handlers);
+
 #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);
 	}
-
-	register_command(context, NULL, "sleep",
-			handle_sleep_command, COMMAND_ANY,
-			"<n> [busy] - sleep for n milliseconds. "
-			"\"busy\" means busy wait");
+	Jim_DeleteAssocData(interp, "context");
 
 	return context;
 }
@@ -857,18 +1163,6 @@ void process_jim_events(void)
 #endif
 }
 
-void register_jim(struct command_context *cmd_ctx, const char *name,
-		Jim_CmdProc cmd, const char *help)
-{
-	Jim_CreateCommand(interp, name, cmd, NULL, NULL);
-
-	Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
-	Jim_ListAppendElement(interp, cmd_list,
-			Jim_NewStringObj(interp, name, -1));
-
-	command_helptext_add(cmd_list, help);
-}
-
 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
 	int parse##name(const char *str, type *ul) \
 	{ \
@@ -977,5 +1271,3 @@ COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
 	}
 	return ERROR_OK;
 }
-
-