Charles Hardin <ckhardin@gmail.com> and Øyvind Harboe

This patch just uses the command.c interface to create tcl commands for the root level commands and avoids a bit of the "TCL" bleed into the rest of the openocd code.

Multilevel commands also supported.


git-svn-id: svn://svn.berlios.de/openocd/trunk@818 b42882b7-edfa-0310-969c-e2dbd0fdcd60

1 files changed, 144 insertions, 193 deletions

diff --git a/src/helper/command.c b/src/helper/command.c
index f86777cd..d31c3588 100644
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -41,15 +41,69 @@
 #include <openocd_tcl.h>
 
 int fast_and_dangerous = 0;
+extern command_context_t *active_cmd_ctx;
 
 int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
+{		
+	Jim_Obj *tclOutput=(Jim_Obj *)privData;
 
-/* forward declaration of jim_command */
-extern int jim_command(command_context_t *context, char *line);
+	Jim_AppendString(interp, tclOutput, string, strlen(string));
+}
+
+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;
+	int *retval;
+	int i;
+	int nwords;
+	char **words;
+
+	target_call_timer_callbacks_now();
+	LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ 
+	
+	c = interp->cmdPrivData;
+	LOG_DEBUG("script_command - %s", c->name);
+
+	nwords = argc;
+	words = malloc(sizeof(char *) * nwords);
+	for (i = 0; i < nwords; i++)
+	{
+		int len;
+
+		words[i] = strdup(Jim_GetString(argv[i], &len));
+		if (words[i] == NULL) 
+		{
+			return JIM_ERR;
+		}
+		LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]);
+	}
+
+	/* grab the command context from the associated data */
+	context = Jim_GetAssocData(interp, "context");
+	retval = Jim_GetAssocData(interp, "retval"); 
+	if (context != NULL && retval != NULL)
+	{
+		/* capture log output and return it */
+		Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
+		log_add_callback(tcl_output, tclOutput);
+		
+		*retval = run_command(context, c, words, nwords);
+		
+		log_remove_callback(tcl_output, tclOutput);
+		Jim_SetResult(interp, tclOutput);
+		
+	}
 
+	for (i = 0; i < nwords; i++)
+		free(words[i]);
+	free(words);
 
+	return (*retval==ERROR_OK)?JIM_OK:JIM_ERR;
+}
 
 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)
 {
@@ -98,6 +152,33 @@ command_t* register_command(command_context_t *context, command_t *parent, char
 			context->commands = c;
 		}
 	}
+	
+	/* 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("%s%s%s", t1, t2, t3);
+	Jim_CreateCommand(interp, full_name, script_command, c, NULL);
+	free((void *)full_name);
+	
+	
 	/* accumulate help text in Tcl helptext list.  */
     Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
     if (Jim_IsShared(helptext))
@@ -196,75 +277,6 @@ int unregister_command(command_context_t *context, char *name)
 	return ERROR_OK;
 }
 
-int parse_line(char *line, char *words[], int max_words)
-{
-	int nwords = 0;
-	char *p = line;
-	char *word_start = line;
-	int inquote = 0;
-
-	while (nwords < max_words - 1)
-	{
-		/* check if we reached
-		 * a terminating NUL
-		 * a matching closing quote character " or '
-		 * we're inside a word but not a quote, and the current character is whitespace
-		 */
-		if (!*p || *p == inquote || (word_start && !inquote && isspace(*p)))
-		{
-			/* we're inside a word or quote, and reached its end*/
-			if (word_start)
-			{
-				int len;
-				char *word_end=p;
-				
-				/* This will handle extra whitespace within quotes */
-				while (isspace(*word_start)&&(word_start<word_end))
-					word_start++;
-				while (isspace(*(word_end-1))&&(word_start<word_end))
-					word_end--;
-				len = word_end - word_start;
-				
-				if (len>0)
-				{
-					/* copy the word */
-					memcpy(words[nwords] = malloc(len + 1), word_start, len);
-					/* add terminating NUL */
-					words[nwords++][len] = 0;
-				}
-			}
-			/* we're done parsing the line */
-			if (!*p)
-				break;
-
-			/* skip over trailing quote or whitespace*/
-			if (inquote || isspace(*p))
-				p++;
-			while (isspace(*p))
-				p++;
-			
-			inquote = 0;
-			word_start = 0;
-		}
-		else if (*p == '"' || *p == '\'')
-		{
-			/* we've reached the beginning of a quote */
-			inquote = *p++;
-			word_start = p;
-		}
-		else
-		{
-			/* we've reached the beginning of a new word */
-			if (!word_start)
-				word_start = p;
-			
-			/* normal character, skip */
-			p++;
-		}
-	}
-	
-	return nwords;
-}
 
 void command_output_text(command_context_t *context, const char *data)
 {
@@ -308,51 +320,13 @@ void command_print(command_context_t *context, char *format, ...)
 	va_end(ap);
 }
 
-command_t *find_command(command_context_t *context, command_t *commands, char *words[], int num_words, int start_word, int *new_start_word)
-{
-	command_t *c;
-	
-	for (c = commands; c; c = c->next)
-	{
-		if (strcasecmp(c->name, words[start_word]))
-			continue;
-
-		if ((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) )
-		{
-			if (!c->children)
-			{
-				if (!c->handler)
-				{
-					return NULL;
-				}
-				else
-				{
-					*new_start_word=start_word;
-					return c;
-				}
-			}
-			else
-			{
-				if (start_word == num_words - 1)
-				{
-					return NULL;
-				}
-				return find_command(context, c->children, words, num_words, start_word + 1, new_start_word);
-			}
-		}
-	}
-	return NULL;
-}
-
-int find_and_run_command(command_context_t *context, command_t *commands, char *words[], int num_words)
+int run_command(command_context_t *context, command_t *c, char *words[], int num_words)
 {
 	int start_word=0;
-	command_t *c;
-	c = find_command(context, commands, words, num_words, start_word, &start_word);
-	if (c == NULL)
+	if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
 	{
-		/* just return command not found */
-		return ERROR_COMMAND_NOTFOUND;
+		/* Config commands can not run after the config stage */
+		return ERROR_FAIL;
 	}
 	
 	int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
@@ -370,8 +344,6 @@ int find_and_run_command(command_context_t *context, command_t *commands, char *
 		}
 		t3=c->name;
 		command_run_linef(context, "help {%s%s%s}", t1, t2, t3);
-		
-		
 	}
 	else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
 	{
@@ -388,55 +360,58 @@ int find_and_run_command(command_context_t *context, command_t *commands, char *
 	return retval; 
 }
 
-int command_run_line_internal(command_context_t *context, char *line)
+int command_run_line(command_context_t *context, char *line)
 {
-	LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ 
-	
-	int nwords;
-	char *words[128] = {0};
+	/* all the parent commands have been registered with the interpreter
+	 * so, can just evaluate the line as a script and check for
+	 * results
+	 */
+	/* run the line thru a script engine */
 	int retval;
-	int i;
-
-	/* skip preceding whitespace */
-	while (isspace(*line))
-		line++;
-	
-	/* empty line, ignore */
-	if (!*line)
-		return ERROR_OK;
-	
-	/* ignore comments */
-	if (*line && (line[0] == '#'))
-		return ERROR_OK;
-	
-	LOG_DEBUG("%s", line);
-
-	nwords = parse_line(line, words, sizeof(words) / sizeof(words[0]));
-	
-	if (nwords > 0)
-	{
-		retval = find_and_run_command(context, context->commands, words, nwords);
+	int retcode;
+
+	Jim_DeleteAssocData(interp, "context"); /* remove existing */
+	retcode = Jim_SetAssocData(interp, "context", NULL, context);
+	if (retcode != JIM_OK)
+		return ERROR_FAIL;
+
+	/* associated the return value */
+	retval = ERROR_OK;
+	Jim_DeleteAssocData(interp, "retval"); /* remove existing */
+	retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
+	if (retcode != JIM_OK)
+		return ERROR_FAIL;
+
+	retcode = Jim_Eval(interp, line);	
+	if (retcode == JIM_ERR) {
+		Jim_PrintErrorMessage(interp);
+	} else if (retcode == JIM_EXIT) {
+		/* ignore. */
+		/* exit(Jim_GetExitCode(interp)); */
+	} else {
+		const char *result;
+		int reslen;
+
+		result = Jim_GetString(Jim_GetResult(interp), &reslen);
+		if (reslen) {
+			int i;
+			char buff[256+1];
+			for (i = 0; i < reslen; i += 256)
+			{
+				int chunk;
+				chunk = reslen - i;
+				if (chunk > 256)
+					chunk = 256;
+				strncpy(buff, result+i, chunk);
+				buff[chunk] = 0; 
+				LOG_USER_N("%s", buff);
+			}
+			LOG_USER_N("%s", "\n");
+		}
 	}
-	else
-		return ERROR_INVALID_ARGUMENTS;
-	
-	for (i = 0; i < nwords; i++)
-		free(words[i]);
-	
 	return retval;
 }
 
-int command_run_line(command_context_t *context, char *line)
-{
-	/* if a command is unknown to the "unknown" proc in tcl/commands.tcl will
-	 * redirect it to OpenOCD.
-	 * 
-	 * This avoids having to type the "openocd" prefix and makes OpenOCD
-	 * commands "native" to Tcl.
-	 */
-	return jim_command(context, line);
-}
-
 
 int command_run_linef(command_context_t *context, char *format, ...)
 {
@@ -466,7 +441,7 @@ command_context_t* copy_command_context(command_context_t* context)
 	command_context_t* copy_context = malloc(sizeof(command_context_t));
 
 	*copy_context = *context;
-	
+
 	return copy_context;
 }
 
@@ -491,15 +466,21 @@ command_context_t* command_init()
 	register_command(context, NULL, "sleep", handle_sleep_command,
 					 COMMAND_ANY, "sleep for <n> milliseconds");
 	
-	register_command(context, NULL, "time", handle_time_command,
-					 COMMAND_ANY, "time <cmd + args> - execute <cmd + args> and print time it took");
-	
 	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.");
 	
 	return context;
 }
 
+int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
+{
+	if (!cmd_ctx)
+		return ERROR_INVALID_ARGUMENTS;
+
+	cmd_ctx->mode = mode;
+	return ERROR_OK;
+}
+
 /* sleep command sleeps for <n> miliseconds
  * this is useful in target startup scripts
  */
@@ -525,33 +506,3 @@ int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
 	
 	return ERROR_OK;
 }
-
-
-int handle_time_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
-{
-	duration_t duration;
-	char *duration_text;
-	int retval;
-	float t;
-	
-	if (argc<1)
-		return ERROR_COMMAND_SYNTAX_ERROR;
-	
-	duration_start_measure(&duration);
-	
-	retval = find_and_run_command(cmd_ctx, cmd_ctx->commands, args, argc);
-	if (retval == ERROR_COMMAND_NOTFOUND)
-	{
-		command_print(cmd_ctx, "Command %s not found", args[0]);
-	}
-	
-	duration_stop_measure(&duration, &duration_text);
-	
-	t=duration.duration.tv_sec;
-	t+=((float)duration.duration.tv_usec / 1000000.0);
-	command_print(cmd_ctx, "%s took %fs", args[0], t);
-	
-	free(duration_text);
-
-	return retval;
-}