X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.c;h=b7c44efc91033058c43adab890945504eac0d0e5;hp=d29b6ec327a00a30f7d47baf898ba9f5503924f3;hb=4d8d1d32d0f0e0b8866a06cb1d3f304563fa6796;hpb=841721929a63bb77379b1598d91ed85b85021734

diff --git a/src/helper/command.c b/src/helper/command.c
index d29b6ec327..b7c44efc91 100644
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -47,23 +47,24 @@
 int fast_and_dangerous = 0;
 Jim_Interp *interp = NULL;
 
-int run_command(command_context_t *context, command_t *c, char *words[], int num_words);
+static int run_command(struct command_context *context,
+		struct command *c, const char *words[], unsigned num_words);
 
-static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
+static void tcl_output(void *privData, const char *file, unsigned line,
+		const char *function, const char *string)
 {
 	Jim_Obj *tclOutput = (Jim_Obj *)privData;
-
 	Jim_AppendString(interp, tclOutput, string, strlen(string));
 }
 
-extern command_context_t *global_cmd_ctx;
+extern struct command_context *global_cmd_ctx;
 
-void script_debug(Jim_Interp *interp, const char *name, int argc, Jim_Obj *const *argv)
+void script_debug(Jim_Interp *interp, const char *name,
+		unsigned argc, Jim_Obj *const *argv)
 {
-	int i;
-
 	LOG_DEBUG("command - %s", name);
-	for (i = 0; i < argc; i++) {
+	for (unsigned i = 0; i < argc; i++)
+	{
 		int len;
 		const char *w = Jim_GetString(argv[i], &len);
 
@@ -78,8 +79,8 @@ void script_debug(Jim_Interp *interp, const char *name, int argc, Jim_Obj *const
 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
 	/* the private data is stashed in the interp structure */
-	command_t *c;
-	command_context_t *context;
+	struct command *c;
+	struct command_context *context;
 	int retval;
 	int i;
 	int nwords;
@@ -101,7 +102,7 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
 	script_debug(interp, c->name, argc, argv);
 
-	words = malloc(sizeof(char *) * argc);
+	words = malloc(argc * sizeof(char *));
 	for (i = 0; i < argc; i++)
 	{
 		int len;
@@ -140,7 +141,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, words, nwords);
+	// 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);
 
@@ -161,111 +163,119 @@ 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"
 
-command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, 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)
 {
-	command_t *c, *p;
+	assert(head);
+	for (struct command *cc = *head; cc; cc = cc->next)
+	{
+		if (strcmp(cc->name, name) == 0)
+			return cc;
+	}
+	return NULL;
+}
+
+/**
+ * Add the command to the end of linked list.
+ * @returns Returns false if the named command already exists in the list.
+ * Returns true otherwise.
+ */
+static void command_add_child(struct command **head, struct command *c)
+{
+	assert(head);
+	if (NULL == *head)
+	{
+		*head = c;
+		return;
+	}
+	struct command *cc = *head;
+	while (cc->next) cc = cc->next;
+	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)
+{
 	if (!context || !name)
 		return NULL;
 
-	c = malloc(sizeof(command_t));
+	struct command **head = parent ? &parent->children : &context->commands;
+	struct command *c = command_find(head, name);
+	if (NULL != c)
+		return c;
+
+	c = malloc(sizeof(struct command));
 
 	c->name = strdup(name);
 	c->parent = parent;
 	c->children = NULL;
 	c->handler = handler;
 	c->mode = mode;
-	if (!help)
-		help="";
 	c->next = NULL;
 
-	/* place command in tree */
-	if (parent)
-	{
-		if (parent->children)
-		{
-			/* find last child */
-			for (p = parent->children; p && p->next; p = p->next);
-			if (p)
-				p->next = c;
-		}
-		else
-		{
-			parent->children = c;
-		}
-	}
-	else
-	{
-		if (context->commands)
-		{
-			/* find last command */
-			for (p = context->commands; p && p->next; p = p->next);
-			if (p)
-				p->next = c;
-		}
-		else
-		{
-			context->commands = c;
-		}
-	}
+	command_add_child(head, c);
+
+	command_helptext_add(command_name_list(c), help);
 
 	/* just a placeholder, no handler */
 	if (c->handler == NULL)
 		return c;
 
-	/* If this is a two level command, e.g. "flash banks", then the
-	 * "unknown" proc in startup.tcl must redirect to  this command.
-	 *
-	 * "flash banks" is translated by "unknown" to "flash_banks"
-	 * if such a proc exists
-	 */
-	/* Print help for command */
-	const char *t1="";
-	const char *t2="";
-	const char *t3="";
-	/* maximum of two levels :-) */
-	if (c->parent != NULL)
-	{
-		t1 = c->parent->name;
-		t2="_";
-	}
-	t3 = c->name;
-	const char *full_name = alloc_printf("ocd_%s%s%s", t1, t2, t3);
-	Jim_CreateCommand(interp, full_name, script_command, c, NULL);
-	free((void *)full_name);
+	const char *full_name = command_name(c, '_');
+
+	const char *ocd_name = alloc_printf("ocd_%s", full_name);
+	Jim_CreateCommand(interp, ocd_name, script_command, c, NULL);
+	free((void *)ocd_name);
 
 	/* we now need to add an overrideable proc */
-	const char *override_name = alloc_printf("proc %s%s%s {args} {if {[catch {eval ocd_%s%s%s $args}]==0} {return \"\"} else { return -code error }", t1, t2, t3, t1, t2, t3);
+	const char *override_name = alloc_printf("proc %s {args} {"
+			"if {[catch {eval ocd_%s $args}] == 0} "
+			"{return \"\"} else {return -code error}}",
+			full_name, full_name);
 	Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__);
 	free((void *)override_name);
 
-	/* 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_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
-
-	Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
-
-	/* maximum of two levels :-) */
-	if (c->parent != NULL)
-	{
-		Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1));
-	}
-	Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->name, -1));
+	free((void *)full_name);
 
-	Jim_ListAppendElement(interp, cmd_entry, cmd_list);
-	Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
-	Jim_ListAppendElement(interp, helptext, cmd_entry);
 	return c;
 }
 
-int unregister_all_commands(command_context_t *context)
+int unregister_all_commands(struct command_context *context)
 {
-	command_t *c, *c2;
+	struct command *c, *c2;
 
 	if (context == NULL)
 		return ERROR_OK;
@@ -295,9 +305,9 @@ int unregister_all_commands(command_context_t *context)
 	return ERROR_OK;
 }
 
-int unregister_command(command_context_t *context, char *name)
+int unregister_command(struct command_context *context, char *name)
 {
-	command_t *c, *p = NULL, *c2;
+	struct command *c, *p = NULL, *c2;
 
 	if ((!context) || (!name))
 		return ERROR_INVALID_ARGUMENTS;
@@ -347,14 +357,14 @@ int unregister_command(command_context_t *context, char *name)
 	return ERROR_OK;
 }
 
-void command_output_text(command_context_t *context, const char *data)
+void command_output_text(struct command_context *context, const char *data)
 {
 	if (context && context->output_handler && data) {
 		context->output_handler(context, data);
 	}
 }
 
-void command_print_sameline(command_context_t *context, const char *format, ...)
+void command_print_sameline(struct command_context *context, const char *format, ...)
 {
 	char *string;
 
@@ -378,7 +388,7 @@ void command_print_sameline(command_context_t *context, const char *format, ...)
 	va_end(ap);
 }
 
-void command_print(command_context_t *context, const char *format, ...)
+void command_print(struct command_context *context, const char *format, ...)
 {
 	char *string;
 
@@ -403,9 +413,31 @@ void command_print(command_context_t *context, const char *format, ...)
 	va_end(ap);
 }
 
-int run_command(command_context_t *context, command_t *c, char *words[], int num_words)
+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);
+		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;
+}
+char *command_name(struct command *c, char delim)
+{
+	return __command_name(c, delim, 0);
+}
+
+static int run_command(struct command_context *context,
+		struct command *c, const char *words[], unsigned num_words)
 {
-	int start_word = 0;
 	if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode)))
 	{
 		/* Config commands can not run after the config stage */
@@ -413,21 +445,22 @@ int run_command(command_context_t *context, command_t *c, char *words[], int num
 		return ERROR_FAIL;
 	}
 
-	int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
+	struct command_invocation cmd = {
+			.ctx = context,
+			.name = c->name,
+			.argc = num_words - 1,
+			.argv = words + 1,
+		};
+	int retval = c->handler(&cmd);
 	if (retval == ERROR_COMMAND_SYNTAX_ERROR)
 	{
 		/* Print help for command */
-		const char *t1="";
-		const char *t2="";
-		const char *t3="";
-		/* maximum of two levels :-) */
-		if (c->parent != NULL)
-		{
-			t1 = c->parent->name;
-			t2=" ";
-		}
-		t3 = c->name;
-		command_run_linef(context, "help {%s%s%s}", t1, t2, t3);
+		char *full_name = command_name(c, ' ');
+		if (NULL != full_name) {
+			command_run_linef(context, "help %s", full_name);
+			free(full_name);
+		} else
+			retval = -ENOMEM;
 	}
 	else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
 	{
@@ -444,7 +477,7 @@ int run_command(command_context_t *context, command_t *c, char *words[], int num
 	return retval;
 }
 
-int command_run_line(command_context_t *context, char *line)
+int command_run_line(struct command_context *context, char *line)
 {
 	/* all the parent commands have been registered with the interpreter
 	 * so, can just evaluate the line as a script and check for
@@ -514,7 +547,7 @@ int command_run_line(command_context_t *context, char *line)
 	return retval;
 }
 
-int command_run_linef(command_context_t *context, const char *format, ...)
+int command_run_linef(struct command_context *context, const char *format, ...)
 {
 	int retval = ERROR_FAIL;
 	char *string;
@@ -529,22 +562,23 @@ int command_run_linef(command_context_t *context, const char *format, ...)
 	return retval;
 }
 
-void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv)
+void command_set_output_handler(struct command_context* context,
+		command_output_handler_t output_handler, void *priv)
 {
 	context->output_handler = output_handler;
 	context->output_handler_priv = priv;
 }
 
-command_context_t* copy_command_context(command_context_t* context)
+struct command_context* copy_command_context(struct command_context* context)
 {
-	command_context_t* copy_context = malloc(sizeof(command_context_t));
+	struct command_context* copy_context = malloc(sizeof(struct command_context));
 
 	*copy_context = *context;
 
 	return copy_context;
 }
 
-int command_done(command_context_t *context)
+int command_done(struct command_context *context)
 {
 	free(context);
 	context = NULL;
@@ -688,22 +722,21 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 /* sleep command sleeps for <n> miliseconds
  * this is useful in target startup scripts
  */
-static int handle_sleep_command(struct command_context_s *cmd_ctx,
-		char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_sleep_command)
 {
 	bool busy = false;
-	if (argc == 2)
+	if (CMD_ARGC == 2)
 	{
-		if (strcmp(args[1], "busy") == 0)
+		if (strcmp(CMD_ARGV[1], "busy") == 0)
 			busy = true;
 		else
 			return ERROR_COMMAND_SYNTAX_ERROR;
 	}
-	else if (argc < 1 || argc > 2)
+	else if (CMD_ARGC < 1 || CMD_ARGC > 2)
 		return ERROR_COMMAND_SYNTAX_ERROR;
 
 	unsigned long duration = 0;
-	int retval = parse_ulong(args[0], &duration);
+	int retval = parse_ulong(CMD_ARGV[0], &duration);
 	if (ERROR_OK != retval)
 		return retval;
 
@@ -722,21 +755,20 @@ static int handle_sleep_command(struct command_context_s *cmd_ctx,
 	return ERROR_OK;
 }
 
-static int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_fast_command)
 {
-	if (argc != 1)
+	if (CMD_ARGC != 1)
 		return ERROR_COMMAND_SYNTAX_ERROR;
 
-	fast_and_dangerous = strcmp("enable", args[0]) == 0;
+	fast_and_dangerous = strcmp("enable", CMD_ARGV[0]) == 0;
 
 	return ERROR_OK;
 }
 
 
-command_context_t* command_init()
+struct command_context* command_init(const char *startup_tcl)
 {
-	command_context_t* context = malloc(sizeof(command_context_t));
-	extern const char startup_tcl[];
+	struct command_context* context = malloc(sizeof(struct command_context));
 	const char *HostOs;
 
 	context->mode = COMMAND_EXEC;
@@ -770,6 +802,8 @@ command_context_t* command_init()
 	HostOs = "cygwin";
 #elif defined(__MINGW32__)
 	HostOs = "mingw32";
+#elif defined(__ECOS)
+	HostOs = "ecos";
 #else
 #warn unrecognized host OS...
 	HostOs = "other";
@@ -813,7 +847,7 @@ command_context_t* command_init()
 	return context;
 }
 
-int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
+int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
 {
 	if (!cmd_ctx)
 		return ERROR_INVALID_ARGUMENTS;
@@ -836,24 +870,16 @@ void process_jim_events(void)
 #endif
 }
 
-void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help)
+void register_jim(struct command_context *cmd_ctx, const char *name,
+		Jim_CmdProc cmd, const char *help)
 {
 	Jim_CreateCommand(interp, name, cmd, NULL, NULL);
 
-	/* FIX!!! it would be prettier to invoke add_help_text...
-	 * 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_Obj *cmd_entry = Jim_NewListObj(interp, NULL, 0);
-
 	Jim_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
-	Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1));
+	Jim_ListAppendElement(interp, cmd_list,
+			Jim_NewStringObj(interp, name, -1));
 
-	Jim_ListAppendElement(interp, cmd_entry, cmd_list);
-	Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
-	Jim_ListAppendElement(interp, helptext, cmd_entry);
+	command_helptext_add(cmd_list, help);
 }
 
 /* return global variable long value or 0 upon failure */
@@ -928,3 +954,53 @@ 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;
+}
+
+