X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=3b531807f3dd1aba1d0364aaf6278c84d7982905;hb=aacc26559e4984b649083ac046db2cbcb54e2f70;hp=b44e4667f9dadee286abb6e2b8e9bf3ab6676821;hpb=a510c8e23c23b7a888623faf0c4a9982489ddf83;p=openocd.git

diff --git a/src/helper/command.c b/src/helper/command.c
index b44e4667f9..3b531807f3 100644
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -44,9 +44,6 @@
 /* nice short description of source file */
 #define __THIS__FILE__ "command.c"
 
-static int run_command(struct command_context *context,
-		struct command *c, const char *words[], unsigned num_words);
-
 struct log_capture_state {
 	Jim_Interp *interp;
 	Jim_Obj *output;
@@ -55,6 +52,15 @@ struct log_capture_state {
 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 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);
+
+/* wrap jimtcl internal data */
+static inline bool jimcmd_is_proc(Jim_Cmd *cmd)
+{
+	return cmd->isproc;
+}
 
 static void tcl_output(void *privData, const char *file, unsigned line,
 	const char *function, const char *string)
@@ -226,34 +232,6 @@ struct command_context *current_command_context(Jim_Interp *interp)
 	return cmd_ctx;
 }
 
-static int script_command_run(Jim_Interp *interp,
-	int argc, Jim_Obj * const *argv, struct command *c)
-{
-	target_call_timer_callbacks_now();
-	LOG_USER_N("%s", "");	/* Keep GDB connection alive*/
-
-	unsigned nwords;
-	char **words = script_command_args_alloc(argc, argv, &nwords);
-	if (NULL == words)
-		return JIM_ERR;
-
-	struct command_context *cmd_ctx = current_command_context(interp);
-	int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
-
-	script_command_args_free(words, nwords);
-	return command_retval_set(interp, retval);
-}
-
-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 = jim_to_command(interp);
-	assert(c);
-	script_debug(interp, argc, argv);
-	return script_command_run(interp, argc, argv, c);
-}
-
 static struct command *command_root(struct command *c)
 {
 	while (NULL != c->parent)
@@ -275,12 +253,6 @@ 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);
-}
-
 /**
  * Add the command into the linked list, sorted by name.
  * @param head Address to head of command list pointer, which may be
@@ -324,8 +296,6 @@ static void command_free(struct command *c)
 	}
 
 	free(c->name);
-	free(c->help);
-	free(c->usage);
 	free(c);
 }
 
@@ -354,12 +324,7 @@ static struct command *command_new(struct command_context *cmd_ctx,
 		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))
+	if (!c->name)
 		goto command_new_error;
 
 	c->parent = parent;
@@ -369,6 +334,12 @@ static struct command *command_new(struct command_context *cmd_ctx,
 
 	command_add_child(command_list_for_parent(cmd_ctx, parent), c);
 
+	if (cr->help || cr->usage) {
+		char *full_name = command_name(c, ' ');
+		help_add_command(cmd_ctx, full_name, cr->help, cr->usage);
+		free(full_name);
+	}
+
 	return c;
 
 command_new_error:
@@ -387,10 +358,7 @@ static int register_command_handler(struct command_context *cmd_ctx,
 	LOG_DEBUG("registering '%s'...", c->name);
 #endif
 
-	Jim_CmdProc *func = c->handler ? &script_command : &command_unknown;
-	int retval = Jim_CreateCommand(interp, c->name, func, c, NULL);
-
-	return retval;
+	return Jim_CreateCommand(interp, c->name, command_unknown, c, NULL);
 }
 
 static struct command *register_command(struct command_context *context,
@@ -415,22 +383,19 @@ static struct command *register_command(struct command_context *context,
 	if (NULL == c)
 		return NULL;
 
-	int retval = JIM_OK;
-	if (NULL != cr->jim_handler && NULL == parent) {
-		retval = Jim_CreateCommand(context->interp, cr->name,
-				cr->jim_handler, c, NULL);
-	} else if (NULL != cr->handler || NULL != parent)
-		retval = register_command_handler(context, command_root(c));
-
-	if (retval != JIM_OK) {
-		unregister_command(context, parent, name);
-		c = NULL;
+	if (cr->jim_handler || cr->handler) {
+		int retval = register_command_handler(context, command_root(c));
+		if (retval != JIM_OK) {
+			unregister_command(context, parent, name);
+			return NULL;
+		}
 	}
 	return c;
 }
 
-int register_commands(struct command_context *cmd_ctx, struct command *parent,
-	const struct command_registration *cmds)
+static int ___register_commands(struct command_context *cmd_ctx, struct command *parent,
+	const struct command_registration *cmds, void *data,
+	struct target *override_target)
 {
 	int retval = ERROR_OK;
 	unsigned i;
@@ -444,10 +409,12 @@ int register_commands(struct command_context *cmd_ctx, struct command *parent,
 				retval = ERROR_FAIL;
 				break;
 			}
+			c->jim_handler_data = data;
+			c->jim_override_target = override_target;
 		}
 		if (NULL != cr->chain) {
 			struct command *p = c ? : parent;
-			retval = register_commands(cmd_ctx, p, cr->chain);
+			retval = ___register_commands(cmd_ctx, p, cr->chain, data, override_target);
 			if (ERROR_OK != retval)
 				break;
 		}
@@ -459,6 +426,18 @@ int register_commands(struct command_context *cmd_ctx, struct command *parent,
 	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);
+}
+
 int unregister_all_commands(struct command_context *context,
 	struct command *parent)
 {
@@ -487,6 +466,10 @@ static int unregister_command(struct command_context *context,
 		if (strcmp(name, c->name) != 0)
 			continue;
 
+		char *full_name = command_name(c, ' ');
+		help_del_command(context, full_name);
+		free(full_name);
+
 		if (p)
 			p->next = c->next;
 		else
@@ -499,13 +482,6 @@ static int unregister_command(struct command_context *context,
 	return ERROR_OK;
 }
 
-void command_set_handler_data(struct command *c, void *p)
-{
-	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)
@@ -614,11 +590,8 @@ static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
 }
 
 static int run_command(struct command_context *context,
-	struct command *c, const char *words[], unsigned num_words)
+	struct command *c, const char **words, unsigned num_words)
 {
-	if (!command_can_run(context, c))
-		return ERROR_FAIL;
-
 	struct command_invocation cmd = {
 		.ctx = context,
 		.current = c,
@@ -626,26 +599,11 @@ static int run_command(struct command_context *context,
 		.argc = num_words - 1,
 		.argv = words + 1,
 	};
-	/* Black magic of overridden current target:
-	 * If the command we are going to handle has a target prefix,
-	 * override the current target temporarily for the time
-	 * of processing the command.
-	 * 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 run_command() is re-entered. */
-	struct target *saved_target_override = context->current_target_override;
-	if (c->jim_handler_data)
-		context->current_target_override = c->jim_handler_data;
 
 	cmd.output = Jim_NewEmptyStringObj(context->interp);
 	Jim_IncrRefCount(cmd.output);
 
 	int retval = c->handler(&cmd);
-
-	if (c->jim_handler_data)
-		context->current_target_override = saved_target_override;
-
 	if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
 		/* Print help for command */
 		char *full_name = command_name(c, ' ');
@@ -833,28 +791,22 @@ 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_COMMAND_SYNTAX_ERROR;
-	*out = command_find(head, CMD_ARGV[0]);
-	if (NULL == *out)
-		return ERROR_COMMAND_SYNTAX_ERROR;
-	if (--CMD_ARGC == 0)
-		return ERROR_OK;
-	CMD_ARGV++;
-	return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
-}
+struct help_entry {
+	struct list_head lh;
+	char *cmd_name;
+	char *help;
+	char *usage;
+};
 
-static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
+static COMMAND_HELPER(command_help_show, struct help_entry *c,
 	bool show_help, const char *cmd_match);
 
-static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
-	bool show_help, const char *cmd_match)
+static COMMAND_HELPER(command_help_show_list, bool show_help, const char *cmd_match)
 {
-	for (struct command *c = head; NULL != c; c = c->next)
-		CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, cmd_match);
+	struct help_entry *entry;
+
+	list_for_each_entry(entry, CMD_CTX->help_list, lh)
+		CALL_COMMAND_HANDLER(command_help_show, entry, show_help, cmd_match);
 	return ERROR_OK;
 }
 
@@ -885,26 +837,23 @@ static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
 	}
 }
 
-static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
+static COMMAND_HELPER(command_help_show, struct help_entry *c,
 	bool show_help, const char *cmd_match)
 {
-	char *cmd_name = command_name(c, ' ');
-	if (NULL == cmd_name)
-		return ERROR_FAIL;
+	unsigned int n = 0;
+	for (const char *s = strchr(c->cmd_name, ' '); s; s = strchr(s + 1, ' '))
+		n++;
 
 	/* If the match string occurs anywhere, we print out
 	 * stuff for this command. */
-	bool is_match = (strstr(cmd_name, cmd_match) != NULL) ||
+	bool is_match = (strstr(c->cmd_name, cmd_match) != NULL) ||
 		((c->usage != NULL) && (strstr(c->usage, cmd_match) != NULL)) ||
 		((c->help != NULL) && (strstr(c->help, cmd_match) != NULL));
 
 	if (is_match) {
 		command_help_show_indent(n);
-		LOG_USER_N("%s", cmd_name);
-	}
-	free(cmd_name);
+		LOG_USER_N("%s", c->cmd_name);
 
-	if (is_match) {
 		if (c->usage && strlen(c->usage) > 0) {
 			LOG_USER_N(" ");
 			command_help_show_wrap(c->usage, 0, n + 5);
@@ -915,11 +864,30 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
 	if (is_match && show_help) {
 		char *msg;
 
+		/* TODO: factorize jim_command_mode() to avoid running jim command here */
+		char *request = alloc_printf("command mode %s", c->cmd_name);
+		if (!request) {
+			LOG_ERROR("Out of memory");
+			return ERROR_FAIL;
+		}
+		int retval = Jim_Eval(CMD_CTX->interp, request);
+		free(request);
+		enum command_mode mode = COMMAND_UNKNOWN;
+		if (retval != JIM_ERR) {
+			const char *result = Jim_GetString(Jim_GetResult(CMD_CTX->interp), NULL);
+			if (!strcmp(result, "any"))
+				mode = COMMAND_ANY;
+			else if (!strcmp(result, "config"))
+				mode = COMMAND_CONFIG;
+			else if (!strcmp(result, "exec"))
+				mode = COMMAND_EXEC;
+		}
+
 		/* Normal commands are runtime-only; highlight exceptions */
-		if (c->mode != COMMAND_EXEC) {
+		if (mode != COMMAND_EXEC) {
 			const char *stage_msg = "";
 
-			switch (c->mode) {
+			switch (mode) {
 				case COMMAND_CONFIG:
 					stage_msg = " (configuration command)";
 					break;
@@ -941,20 +909,13 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
 			return -ENOMEM;
 	}
 
-	if (++n > 5) {
-		LOG_ERROR("command recursion exceeded");
-		return ERROR_FAIL;
-	}
-
-	return CALL_COMMAND_HANDLER(command_help_show_list,
-		c->children, n, show_help, cmd_match);
+	return ERROR_OK;
 }
 
 COMMAND_HANDLER(handle_help_command)
 {
 	bool full = strcmp(CMD_NAME, "help") == 0;
 	int retval;
-	struct command *c = CMD_CTX->commands;
 	char *cmd_match;
 
 	if (CMD_ARGC <= 0)
@@ -974,8 +935,7 @@ COMMAND_HANDLER(handle_help_command)
 		LOG_ERROR("unable to build search string");
 		return -ENOMEM;
 	}
-	retval = CALL_COMMAND_HANDLER(command_help_show_list,
-			c, 0, full, cmd_match);
+	retval = CALL_COMMAND_HANDLER(command_help_show_list, full, cmd_match);
 
 	free(cmd_match);
 	return retval;
@@ -1053,6 +1013,23 @@ static int run_usage(Jim_Interp *interp, int argc_valid, int argc, Jim_Obj * con
 	return retval;
 }
 
+static int exec_command(Jim_Interp *interp, struct command_context *cmd_ctx,
+		struct command *c, int argc, Jim_Obj *const *argv)
+{
+	if (c->jim_handler)
+		return c->jim_handler(interp, argc, argv);
+
+	/* use c->handler */
+	unsigned int nwords;
+	char **words = script_command_args_alloc(argc, argv, &nwords);
+	if (!words)
+		return JIM_ERR;
+
+	int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
+	script_command_args_free(words, nwords);
+	return command_retval_set(interp, retval);
+}
+
 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
 	script_debug(interp, argc, argv);
@@ -1079,15 +1056,32 @@ static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 		run_usage(interp, count, argc, start);
 		return JIM_ERR;
 	}
-	/* pass the command through to the intended handler */
-	if (c->jim_handler) {
-		if (!command_can_run(cmd_ctx, c))
-			return JIM_ERR;
 
-		return (*c->jim_handler)(interp, count, start);
-	}
+	if (!command_can_run(cmd_ctx, c))
+		return JIM_ERR;
 
-	return script_command_run(interp, count, start, c);
+	target_call_timer_callbacks_now();
+
+	/*
+	 * Black magic of overridden current target:
+	 * If the command we are going to handle has a target prefix,
+	 * override the current target temporarily for the time
+	 * of processing the command.
+	 * 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.
+	 */
+	struct target *saved_target_override = cmd_ctx->current_target_override;
+	if (c->jim_override_target)
+		cmd_ctx->current_target_override = c->jim_override_target;
+
+	int retval = exec_command(interp, cmd_ctx, c, count, start);
+
+	if (c->jim_override_target)
+		cmd_ctx->current_target_override = saved_target_override;
+
+	return retval;
 }
 
 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
@@ -1096,6 +1090,18 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 	enum command_mode mode;
 
 	if (argc > 1) {
+		char *full_name = alloc_concatenate_strings(argc - 1, argv + 1);
+		if (!full_name)
+			return JIM_ERR;
+		Jim_Obj *s = Jim_NewStringObj(interp, full_name, -1);
+		Jim_IncrRefCount(s);
+		Jim_Cmd *cmd = Jim_GetCommand(interp, s, JIM_NONE);
+		Jim_DecrRefCount(interp, s);
+		free(full_name);
+		if (cmd && jimcmd_is_proc(cmd)) {
+			Jim_SetResultString(interp, "any", -1);
+			return JIM_OK;
+		}
 		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 an unknown command */
@@ -1126,81 +1132,104 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 	return JIM_OK;
 }
 
-int help_add_command(struct command_context *cmd_ctx, struct command *parent,
-	const char *cmd_name, const char *help_text, const char *usage)
+int help_del_all_commands(struct command_context *cmd_ctx)
 {
-	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);
+	struct help_entry *curr, *n;
+
+	list_for_each_entry_safe(curr, n, cmd_ctx->help_list, lh) {
+		list_del(&curr->lh);
+		free(curr->cmd_name);
+		free(curr->help);
+		free(curr->usage);
+		free(curr);
+	}
+	return ERROR_OK;
+}
+
+static int help_del_command(struct command_context *cmd_ctx, const char *cmd_name)
+{
+	struct help_entry *curr;
+
+	list_for_each_entry(curr, cmd_ctx->help_list, lh) {
+		if (!strcmp(cmd_name, curr->cmd_name)) {
+			list_del(&curr->lh);
+			free(curr->cmd_name);
+			free(curr->help);
+			free(curr->usage);
+			free(curr);
+			break;
+		}
+	}
+
+	return ERROR_OK;
+}
+
+static int help_add_command(struct command_context *cmd_ctx,
+	const char *cmd_name, const char *help_text, const char *usage_text)
+{
+	int cmp = -1; /* add after curr */
+	struct help_entry *curr;
+
+	list_for_each_entry_reverse(curr, cmd_ctx->help_list, lh) {
+		cmp = strcmp(cmd_name, curr->cmd_name);
+		if (cmp >= 0)
+			break;
+	}
+
+	struct help_entry *entry;
+	if (cmp) {
+		entry = calloc(1, sizeof(*entry));
+		if (!entry) {
+			LOG_ERROR("Out of memory");
 			return ERROR_FAIL;
 		}
-		LOG_DEBUG("added '%s' help text", cmd_name);
-		return ERROR_OK;
+		entry->cmd_name = strdup(cmd_name);
+		if (!entry->cmd_name) {
+			LOG_ERROR("Out of memory");
+			free(entry);
+			return ERROR_FAIL;
+		}
+		list_add(&entry->lh, &curr->lh);
+	} else {
+		entry = curr;
 	}
+
 	if (help_text) {
-		bool replaced = false;
-		if (nc->help) {
-			free(nc->help);
-			replaced = true;
+		char *text = strdup(help_text);
+		if (!text) {
+			LOG_ERROR("Out of memory");
+			return ERROR_FAIL;
 		}
-		nc->help = strdup(help_text);
-		if (replaced)
-			LOG_INFO("replaced existing '%s' help", cmd_name);
-		else
-			LOG_DEBUG("added '%s' help text", cmd_name);
+		free(entry->help);
+		entry->help = text;
 	}
-	if (usage) {
-		bool replaced = false;
-		if (nc->usage) {
-			if (*nc->usage)
-				replaced = true;
-			free(nc->usage);
+
+	if (usage_text) {
+		char *text = strdup(usage_text);
+		if (!text) {
+			LOG_ERROR("Out of memory");
+			return ERROR_FAIL;
 		}
-		nc->usage = strdup(usage);
-		if (replaced)
-			LOG_INFO("replaced existing '%s' usage", cmd_name);
-		else
-			LOG_DEBUG("added '%s' usage text", cmd_name);
+		free(entry->usage);
+		entry->usage = text;
 	}
+
 	return ERROR_OK;
 }
 
 COMMAND_HANDLER(handle_help_add_command)
 {
-	if (CMD_ARGC < 2) {
-		LOG_ERROR("%s: insufficient arguments", CMD_NAME);
+	if (CMD_ARGC != 2)
 		return ERROR_COMMAND_SYNTAX_ERROR;
-	}
 
-	/* save help text and remove it from argument list */
-	const char *str = CMD_ARGV[--CMD_ARGC];
-	const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
-	const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
+	const char *help = !strcmp(CMD_NAME, "add_help_text") ? CMD_ARGV[1] : NULL;
+	const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? CMD_ARGV[1] : NULL;
 	if (!help && !usage) {
 		LOG_ERROR("command name '%s' is unknown", CMD_NAME);
 		return ERROR_COMMAND_SYNTAX_ERROR;
 	}
-	/* 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, usage);
+	const char *cmd_name = CMD_ARGV[0];
+	return help_add_command(CMD_CTX, cmd_name, help, usage);
 }
 
 /* sleep command sleeps for <n> milliseconds
@@ -1331,6 +1360,10 @@ struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp
 
 	context->mode = COMMAND_EXEC;
 
+	/* context can be duplicated. Put list head on separate mem-chunk to keep list consistent */
+	context->help_list = malloc(sizeof(*context->help_list));
+	INIT_LIST_HEAD(context->help_list);
+
 	/* Create a jim interpreter if we were not handed one */
 	if (interp == NULL) {
 		/* Create an interpreter */
@@ -1395,6 +1428,7 @@ void command_exit(struct command_context *context)
 		return;
 
 	Jim_FreeInterp(context->interp);
+	free(context->help_list);
 	command_done(context);
 }