Code Review / openocd.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
don't add confusing source info to Jim
[openocd.git] / src / helper / command.c
diff --git a/src/helper/command.c b/src/helper/command.c
index 0ddcd019c1fd3055849f648ae370dd12aa3c57b5..ea768b2d16bd21d34112dc08a57f7dad214599fd 100644 (file)
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -108,10 +108,15 @@ static int command_retval_set(Jim_Interp *interp, int retval)
 
 extern struct command_context *global_cmd_ctx;
 
+/* dump a single line to the log for the command.
+ * Do nothing in case we are not at debug level 3 */
 void script_debug(Jim_Interp *interp, const char *name,
                unsigned argc, Jim_Obj *const *argv)
 {
-       LOG_DEBUG("command - %s", name);
+       if (debug_level < LOG_LVL_DEBUG)
+               return;
+
+       char * dbg = alloc_printf("command - %s", name);
        for (unsigned i = 0; i < argc; i++)
        {
                int len;
@@ -121,8 +126,12 @@ void script_debug(Jim_Interp *interp, const char *name,
                if (*w == '#')
                        break;
 
-               LOG_DEBUG("%s - argv[%d]=%s", name, i, w);
+               char * t = alloc_printf("%s %s", dbg, w);
+               free (dbg);
+               dbg = t;
        }
+       LOG_DEBUG("%s", dbg);
+       free(dbg);
 }
 
 static void script_command_args_free(const char **words, unsigned nwords)
@@ -158,14 +167,18 @@ static const char **script_command_args_alloc(
        return words;
 }
 
-static struct command_context *current_command_context(Jim_Interp *interp)
+struct command_context *current_command_context(Jim_Interp *interp)
 {
        /* 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.
+                * happen when the Jim Tcl interpreter is provided by eCos or if we are running
+                * commands in a startup script.
+                *
+                * A telnet or gdb server would provide a non-default command context to
+                * handle piping of error output, have a separate current target, etc.
                 */
                cmd_ctx = global_cmd_ctx;
        }
@@ -349,7 +362,7 @@ static int register_command_handler(struct command_context *cmd_ctx,
        if (NULL == override_name)
                return JIM_ERR;
 
-       retval = Jim_Eval_Named(interp, override_name, __FILE__, __LINE__);
+       retval = Jim_Eval_Named(interp, override_name, 0, 0);
        free((void *)override_name);
 
        return retval;
@@ -366,7 +379,10 @@ struct command* register_command(struct command_context *context,
        struct command *c = command_find(*head, name);
        if (NULL != c)
        {
-               LOG_ERROR("command '%s' is already registered in '%s' context",
+               /* TODO: originally we treated attempting to register a cmd twice as an error
+                * Sometimes we need this behaviour, such as with flash banks.
+                * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
+               LOG_DEBUG("command '%s' is already registered in '%s' context",
                                name, parent ? parent->name : "<global>");
                return c;
        }
@@ -635,7 +651,7 @@ int command_run_line(struct command_context *context, char *line)
                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, 0, 0);
 
                        Jim_DeleteAssocData(interp, "retval");
                }
@@ -1087,6 +1103,7 @@ static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        struct command_context *cmd_ctx = current_command_context(interp);
        enum command_mode mode;
+
        if (argc > 1)
        {
                struct command *c = cmd_ctx->commands;
@@ -1223,7 +1240,7 @@ COMMAND_HANDLER(handle_help_add_command)
        return help_add_command(CMD_CTX, c, cmd_name, help, usage);
 }
 
-/* sleep command sleeps for <n> miliseconds
+/* sleep command sleeps for <n> milliseconds
  * this is useful in target startup scripts
  */
 COMMAND_HANDLER(handle_sleep_command)
@@ -1263,19 +1280,22 @@ static const struct command_registration command_subcommand_handlers[] = {
        {
                .name = "mode",
                .mode = COMMAND_ANY,
-               .jim_handler = &jim_command_mode,
-               .usage = "[<name> ...]",
+               .jim_handler = jim_command_mode,
+               .usage = "[command_name ...]",
                .help = "Returns the command modes allowed by a  command:"
                        "'any', 'config', or 'exec'.  If no command is"
-                       "specified, returns the current command mode.",
+                       "specified, returns the current command mode.  "
+                       "Returns 'unknown' if an unknown command is given. "
+                       "Command can be multiple tokens.",
        },
        {
                .name = "type",
                .mode = COMMAND_ANY,
-               .jim_handler = &jim_command_type,
-               .usage = "<name> ...",
+               .jim_handler = jim_command_type,
+               .usage = "command_name [...]",
                .help = "Returns the type of built-in command:"
-                       "'native', 'simple', 'group', or 'unknown'",
+                       "'native', 'simple', 'group', or 'unknown'. "
+                       "Command can be multiple tokens.",
        },
        COMMAND_REGISTRATION_DONE
 };
@@ -1283,39 +1303,43 @@ static const struct command_registration command_subcommand_handlers[] = {
 static const struct command_registration command_builtin_handlers[] = {
        {
                .name = "add_help_text",
-               .handler = &handle_help_add_command,
+               .handler = handle_help_add_command,
                .mode = COMMAND_ANY,
-               .help = "add new command help text",
-               .usage = "<command> [...] <help_text>]",
+               .help = "Add new command help text; "
+                       "Command can be multiple tokens.",
+               .usage = "command_name helptext_string",
        },
        {
                .name = "add_usage_text",
-               .handler = &handle_help_add_command,
+               .handler = handle_help_add_command,
                .mode = COMMAND_ANY,
-               .help = "add new command usage text",
-               .usage = "<command> [...] <usage_text>]",
+               .help = "Add new command usage text; "
+                       "command can be multiple tokens.",
+               .usage = "command_name usage_string",
        },
        {
                .name = "sleep",
-               .handler = &handle_sleep_command,
+               .handler = handle_sleep_command,
                .mode = COMMAND_ANY,
-               .help = "sleep for n milliseconds.  "
-                       "\"busy\" will busy wait",
-               .usage = "<n> [busy]",
+               .help = "Sleep for specified number of milliseconds.  "
+                       "\"busy\" will busy wait instead (avoid this).",
+               .usage = "milliseconds ['busy']",
        },
        {
                .name = "help",
-               .handler = &handle_help_command,
+               .handler = handle_help_command,
                .mode = COMMAND_ANY,
-               .help = "show full command help",
-               .usage = "[<command> ...]",
+               .help = "Show full command help; "
+                       "command can be multiple tokens.",
+               .usage = "[command_name]",
        },
        {
                .name = "usage",
-               .handler = &handle_help_command,
+               .handler = handle_help_command,
                .mode = COMMAND_ANY,
-               .help = "show basic command usage",
-               .usage = "[<command> ...]",
+               .help = "Show basic command usage; "
+                       "command can be multiple tokens.",
+               .usage = "[command_name]",
        },
        {
                .name = "command",
@@ -1350,6 +1374,7 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp
 #endif
        context->interp = interp;
 
+       /* Stick to lowercase for HostOS strings. */
 #if defined(_MSC_VER)
        /* WinXX - is generic, the forward
         * looking problem is this:
@@ -1369,6 +1394,8 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp
        HostOs = "mingw32";
 #elif defined(__ECOS)
        HostOs = "ecos";
+#elif defined(__FreeBSD__)
+       HostOs = "freebsd";
 #else
 #warning "Unrecognized host OS..."
        HostOs = "other";
Open On-Chip Debugger

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)