* Copyright (C) 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
- * Copyright (C) 2007,2008 Øyvind Harboe *
+ * Copyright (C) 2007,2008 Øyvind Harboe *
* oyvind.harboe@zylin.com *
* *
* Copyright (C) 2008, Duane Ellis *
int fast_and_dangerous = 0;
Jim_Interp *interp = NULL;
-int handle_sleep_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 int run_command(command_context_t *context,
+ command_t *c, const char *words[], unsigned num_words);
-int run_command(command_context_t *context, command_t *c, char *words[], int 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_Obj *tclOutput = (Jim_Obj *)privData;
Jim_AppendString(interp, tclOutput, string, strlen(string));
}
extern command_context_t *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);
script_debug(interp, c->name, argc, argv);
- words = malloc(sizeof(char *) * argc);
+ words = malloc(sizeof(char *) * (argc + 1));
+ words[0] = c->name;
for (i = 0; i < argc; i++)
{
int len;
- const char *w=Jim_GetString(argv[i], &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)
+ words[i + 1] = strdup(w);
+ if (words[i + 1] == NULL)
{
+ int j;
+ for (j = 0; j < i; j++)
+ free(words[j + 1]);
+ free(words);
return JIM_ERR;
}
}
log_add_callback(tcl_output, tclOutput);
- retval = run_command(context, c, words, nwords);
+ // turn words[0] into args[-1] with this cast
+ retval = run_command(context, c, (const char **)words + 1, nwords);
log_remove_callback(tcl_output, tclOutput);
Jim_DecrRefCount(interp, tclOutput);
for (i = 0; i < nwords; i++)
- free(words[i]);
+ free(words[i + 1]);
free(words);
int *return_retval = Jim_GetAssocData(interp, "retval");
return (retval == ERROR_OK)?JIM_OK:JIM_ERR;
}
+static Jim_Obj *command_name_list(struct command_s *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_s *command_find(struct command_s **head, const char *name)
+{
+ assert(head);
+ for (struct command_s *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_s **head, struct command_s *c)
{
- command_t *c, *p;
+ assert(head);
+ if (NULL == *head)
+ {
+ *head = c;
+ return;
+ }
+ struct command_s *cc = *head;
+ while (cc->next) cc = cc->next;
+ cc->next = c;
+}
+command_t* register_command(command_context_t *context,
+ command_t *parent, char *name, command_handler_t handler,
+ enum command_mode mode, char *help)
+{
if (!context || !name)
return NULL;
+ struct command_s **head = parent ? &parent->children : &context->commands;
+ struct command_s *c = command_find(head, name);
+ if (NULL != c)
+ return c;
+
c = malloc(sizeof(command_t));
c->name = strdup(name);
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);
- Jim_Eval_Named(interp, override_name, __THIS__FILE__, __LINE__ );
+ 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;
}
void command_output_text(command_context_t *context, const char *data)
{
- if ( context && context->output_handler && data ){
- context->output_handler( context, data );
+ if (context && context->output_handler && data) {
+ context->output_handler(context, data);
}
}
va_end(ap);
}
-int run_command(command_context_t *context, command_t *c, char *words[], int num_words)
+static char *__command_name(struct command_s *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_s *c, char delim)
{
- int start_word=0;
- if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
+ return __command_name(c, delim, 0);
+}
+
+static int run_command(command_context_t *context,
+ command_t *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 */
LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
return ERROR_FAIL;
}
- int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
+ unsigned argc = num_words - start_word - 1;
+ const char **args = words + start_word + 1;
+ int retval = c->handler(context, args, argc);
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)
{
* results
*/
/* run the line thru a script engine */
- int retval=ERROR_FAIL;
+ int retval = ERROR_FAIL;
int retcode;
/* Beware! This code needs to be reentrant. It is also possible
* for OpenOCD commands to be invoked directly from Tcl. This would
retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
if (retcode == JIM_OK)
{
- retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__ );
+ retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__);
Jim_DeleteAssocData(interp, "retval");
}
int reslen;
result = Jim_GetString(Jim_GetResult(interp), &reslen);
- if (reslen>0)
+ if (reslen > 0)
{
int i;
- char buff[256+1];
+ 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);
+ strncpy(buff, result + i, chunk);
buff[chunk] = 0;
LOG_USER_N("%s", buff);
}
LOG_USER_N("%s", "\n");
}
- retval=ERROR_OK;
+ retval = ERROR_OK;
}
return retval;
}
int command_run_linef(command_context_t *context, const char *format, ...)
{
- int retval=ERROR_FAIL;
+ int retval = ERROR_FAIL;
char *string;
va_list ap;
va_start(ap, format);
string = alloc_vprintf(format, ap);
if (string != NULL)
{
- retval=command_run_line(context, string);
+ retval = command_run_line(context, string);
}
va_end(ap);
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(command_context_t* context,
+ command_output_handler_t output_handler, void *priv)
{
context->output_handler = output_handler;
context->output_handler_priv = priv;
}
/* GRR we must chunk - not null terminated */
while (nbytes) {
- char chunk[128+1];
+ char chunk[128 + 1];
int x;
x = nbytes;
log_add_callback(tcl_output, tclOutput);
- retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__ );
+ retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
log_remove_callback(tcl_output, tclOutput);
return retcode;
}
+/* sleep command sleeps for <n> miliseconds
+ * this is useful in target startup scripts
+ */
+COMMAND_HANDLER(handle_sleep_command)
+{
+ bool busy = false;
+ if (argc == 2)
+ {
+ if (strcmp(args[1], "busy") == 0)
+ busy = true;
+ else
+ return ERROR_COMMAND_SYNTAX_ERROR;
+ }
+ else if (argc < 1 || argc > 2)
+ return ERROR_COMMAND_SYNTAX_ERROR;
+
+ unsigned long duration = 0;
+ int retval = parse_ulong(args[0], &duration);
+ if (ERROR_OK != retval)
+ return retval;
+
+ if (!busy)
+ {
+ long long then = timeval_ms();
+ while (timeval_ms() - then < (long long)duration)
+ {
+ target_call_timer_callbacks_now();
+ usleep(1000);
+ }
+ }
+ else
+ busy_sleep(duration);
+
+ return ERROR_OK;
+}
+
+COMMAND_HANDLER(handle_fast_command)
+{
+ if (argc != 1)
+ return ERROR_COMMAND_SYNTAX_ERROR;
+
+ fast_and_dangerous = strcmp("enable", args[0]) == 0;
+
+ return ERROR_OK;
+}
+
+
command_context_t* command_init()
{
command_context_t* context = malloc(sizeof(command_context_t));
Jim_RegisterCoreCommands(interp);
#endif
-#if defined( _MSC_VER )
+#if defined(_MSC_VER)
/* WinXX - is generic, the forward
* looking problem is this:
*
* "winxx" is generic.
*/
HostOs = "winxx";
-#elif defined( __LINUX__)
+#elif defined(__linux__)
HostOs = "linux";
-#elif defined( __DARWIN__ )
+#elif defined(__DARWIN__)
HostOs = "darwin";
-#elif defined( __CYGWIN__ )
+#elif defined(__CYGWIN__)
HostOs = "cygwin";
-#elif defined( __MINGW32__ )
+#elif defined(__MINGW32__)
HostOs = "mingw32";
+#elif defined(__ECOS)
+ HostOs = "ecos";
#else
+#warn unrecognized host OS...
HostOs = "other";
#endif
- Jim_SetGlobalVariableStr( interp, "ocd_HOSTOS", Jim_NewStringObj( interp, HostOs , strlen(HostOs)) );
+ Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
+ Jim_NewStringObj(interp, HostOs , strlen(HostOs)));
Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);
interp->cb_fflush = openocd_jim_fflush;
interp->cb_fgets = openocd_jim_fgets;
- add_default_dirs();
-
#if !BUILD_ECOSBOARD
Jim_EventLoopOnLoad(interp);
#endif
if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1) == JIM_ERR)
{
- LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
+ 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");
-
- 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, "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.");
return context;
}
return ERROR_OK;
}
-/* sleep command sleeps for <n> miliseconds
- * this is useful in target startup scripts
- */
-int handle_sleep_command(struct command_context_s *cmd_ctx,
- char *cmd, char **args, int argc)
-{
- bool busy = false;
- if (argc == 2)
- {
- if (strcmp(args[1], "busy") == 0)
- busy = true;
- else
- return ERROR_COMMAND_SYNTAX_ERROR;
- }
- else if (argc < 1 || argc > 2)
- return ERROR_COMMAND_SYNTAX_ERROR;
-
- unsigned long duration = 0;
- int retval = parse_ulong(args[0], &duration);
- if (ERROR_OK != retval)
- return retval;
-
- if (!busy)
- {
- long long then = timeval_ms();
- while (timeval_ms() - then < (long long)duration)
- {
- target_call_timer_callbacks_now();
- usleep(1000);
- }
- }
- else
- busy_sleep(duration);
-
- return ERROR_OK;
-}
-
-int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
-{
- if (argc != 1)
- return ERROR_COMMAND_SYNTAX_ERROR;
-
- fast_and_dangerous = strcmp("enable", args[0]) == 0;
-
- return ERROR_OK;
-}
-
void process_jim_events(void)
{
#if !BUILD_ECOSBOARD
if (!recursion)
{
recursion++;
- Jim_ProcessEvents (interp, JIM_ALL_EVENTS|JIM_DONT_WAIT);
+ Jim_ProcessEvents (interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
recursion--;
}
#endif
{
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_Obj *cmd_list = Jim_NewListObj(interp, NULL, 0);
+ 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 */
long jim_global_long(const char *variable)
{
- Jim_Obj *objPtr=Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
+ Jim_Obj *objPtr = Jim_GetGlobalVariableStr(interp, variable, JIM_ERRMSG);
long t;
if (Jim_GetLong(interp, objPtr, &t) == JIM_OK)
{
int parse##name(const char *str, type *ul) \
{ \
if (!*str) \
+ { \
+ LOG_ERROR("Invalid command argument"); \
return ERROR_COMMAND_ARGUMENT_INVALID; \
+ } \
char *end; \
*ul = func(str, &end, 0); \
if (*end) \
+ { \
+ LOG_ERROR("Invalid command argument"); \
return ERROR_COMMAND_ARGUMENT_INVALID; \
+ } \
if ((max == *ul) && (ERANGE == errno)) \
+ { \
+ LOG_ERROR("Argument overflow"); \
return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
+ } \
if (min && (min == *ul) && (ERANGE == errno)) \
+ { \
+ LOG_ERROR("Argument underflow"); \
return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
+ } \
return ERROR_OK; \
}
DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
*ul = n; \
return ERROR_OK; \
- }
+ }
#define DEFINE_PARSE_ULONG(name, type, min, max) \
DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
Code Review / openocd.git / blobdiff