FreeBSD build fixes
[openocd.git] / src / helper / command.c
index dcad6a198e39ff9de78f6a740263f66af2ece812..568596d17b96afe4c92bd30aef2f44eb8988ad2c 100644 (file)
@@ -36,7 +36,7 @@
 #endif
 
 // @todo the inclusion of target.h here is a layering violation
-#include "target.h"
+#include <target/target.h>
 #include "command.h"
 #include "configuration.h"
 #include "log.h"
@@ -580,6 +580,7 @@ static int run_command(struct command_context *context,
 
        struct command_invocation cmd = {
                        .ctx = context,
+                       .current = c,
                        .name = c->name,
                        .argc = num_words - 1,
                        .argv = words + 1,
@@ -860,13 +861,13 @@ static COMMAND_HELPER(command_help_find, struct command *head,
 }
 
 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
-               bool show_help);
+               bool show_help, const char *match);
 
 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
-               bool show_help)
+               bool show_help, const char *match)
 {
        for (struct command *c = head; NULL != c; c = c->next)
-               CALL_COMMAND_HANDLER(command_help_show, c, n, show_help);
+               CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, match);
        return ERROR_OK;
 }
 
@@ -899,7 +900,7 @@ static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
        }
 }
 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
-               bool show_help)
+               bool show_help, const char *match)
 {
        if (!command_can_run(CMD_CTX, c))
                return ERROR_OK;
@@ -908,28 +909,52 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
        if (NULL == cmd_name)
                return -ENOMEM;
 
-       command_help_show_indent(n);
-       LOG_USER_N("%s", cmd_name);
-       free(cmd_name);
+       /* If the match string occurs anywhere, we print out
+        * stuff for this command. */
+       bool is_match = (strstr(cmd_name, match) != NULL) ||
+       ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) ||
+       ((c->help != NULL) && (strstr(c->help, match) != NULL));
 
-       if (c->usage) {
-               LOG_USER_N(" ");
-               command_help_show_wrap(c->usage, 0, n + 5);
+       if (is_match)
+       {
+               command_help_show_indent(n);
+               LOG_USER_N("%s", cmd_name);
        }
-       else
-               LOG_USER_N("\n");
+       free(cmd_name);
 
-       if (show_help)
+       if (is_match)
        {
-               const char *stage_msg;
-               switch (c->mode) {
-               case COMMAND_CONFIG: stage_msg = "CONFIG"; break;
-               case COMMAND_EXEC: stage_msg = "EXEC"; break;
-               case COMMAND_ANY: stage_msg = "CONFIG or EXEC"; break;
-               default: stage_msg = "***UNKNOWN***"; break;
+               if (c->usage) {
+                       LOG_USER_N(" ");
+                       command_help_show_wrap(c->usage, 0, n + 5);
                }
-               char *msg = alloc_printf("%s%sValid Modes: %s",
-                       c->help ? : "", c->help ? "  " : "", stage_msg);
+               else
+                       LOG_USER_N("\n");
+       }
+
+       if (is_match && show_help)
+       {
+               char *msg;
+
+               /* Normal commands are runtime-only; highlight exceptions */
+               if (c->mode != COMMAND_EXEC) {
+                       const char *stage_msg = "";
+
+                       switch (c->mode) {
+                       case COMMAND_CONFIG:
+                               stage_msg = " (configuration command)";
+                               break;
+                       case COMMAND_ANY:
+                               stage_msg = " (command valid any time)";
+                               break;
+                       default:
+                               stage_msg = " (?mode error?)";
+                               break;
+                       }
+                       msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
+               } else
+                       msg = alloc_printf("%s", c->help ? : "");
+
                if (NULL != msg)
                {
                        command_help_show_wrap(msg, n + 3, n + 3);
@@ -942,22 +967,50 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
                return ERROR_OK;
 
        return CALL_COMMAND_HANDLER(command_help_show_list,
-                       c->children, n, show_help);
+                       c->children, n, show_help, match);
 }
 COMMAND_HANDLER(handle_help_command)
 {
        bool full = strcmp(CMD_NAME, "help") == 0;
-
+       int retval;
        struct command *c = CMD_CTX->commands;
+       char *match = NULL;
+
+       if (CMD_ARGC == 0)
+               match = "";
+       else if (CMD_ARGC >= 1) {
+               unsigned i;
+
+               for (i = 0; i < CMD_ARGC; ++i) {
+                       if (NULL != match) {
+                               char *prev = match;
+
+                               match = alloc_printf("%s %s", match,
+                                               CMD_ARGV[i]);
+                               free(prev);
+                               if (NULL == match) {
+                                       LOG_ERROR("unable to build "
+                                                       "search string");
+                                       return -ENOMEM;
+                               }
+                       } else {
+                               match = alloc_printf("%s", CMD_ARGV[i]);
+                               if (NULL == match) {
+                                       LOG_ERROR("unable to build "
+                                                       "search string");
+                                       return -ENOMEM;
+                               }
+                       }
+               }
+       } else
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-       if (0 == CMD_ARGC)
-               return CALL_COMMAND_HANDLER(command_help_show_list, c, 0, full);
+       retval = CALL_COMMAND_HANDLER(command_help_show_list,
+                       c, 0, full, match);
 
-       int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
-       if (ERROR_OK != retval)
-               return retval;
-
-       return CALL_COMMAND_HANDLER(command_help_show, c, 0, full);
+       if (CMD_ARGC >= 1)
+               free(match);
+       return retval;
 }
 
 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
@@ -975,6 +1028,7 @@ static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
        return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
 }
 
+
 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        const char *cmd_name = Jim_GetString(argv[0], NULL);
@@ -1033,6 +1087,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;
@@ -1169,7 +1224,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)
@@ -1209,19 +1264,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
 };
@@ -1229,39 +1287,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",
@@ -1272,7 +1334,7 @@ static const struct command_registration command_builtin_handlers[] = {
        COMMAND_REGISTRATION_DONE
 };
 
-struct command_context* command_init(const char *startup_tcl)
+struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp)
 {
        struct command_context* context = malloc(sizeof(struct command_context));
        const char *HostOs;
@@ -1284,14 +1346,19 @@ struct command_context* command_init(const char *startup_tcl)
        context->output_handler_priv = NULL;
 
 #if !BUILD_ECOSBOARD
-       Jim_InitEmbedded();
-       /* Create an interpreter */
-       context->interp = Jim_CreateInterp();
-       /* Add all the Jim core commands */
-       Jim_RegisterCoreCommands(context->interp);
+       /* Create a jim interpreter if we were not handed one */
+       if (interp == NULL)
+       {
+               Jim_InitEmbedded();
+               /* Create an interpreter */
+               interp = Jim_CreateInterp();
+               /* Add all the Jim core commands */
+               Jim_RegisterCoreCommands(interp);
+       }
 #endif
+       context->interp = interp;
 
-       Jim_Interp *interp = context->interp;
+       /* Stick to lowercase for HostOS strings. */
 #if defined(_MSC_VER)
        /* WinXX - is generic, the forward
         * looking problem is this:
@@ -1303,7 +1370,7 @@ struct command_context* command_init(const char *startup_tcl)
        HostOs = "winxx";
 #elif defined(__linux__)
        HostOs = "linux";
-#elif defined(__DARWIN__)
+#elif defined(__APPLE__) || defined(__DARWIN__)
        HostOs = "darwin";
 #elif defined(__CYGWIN__)
        HostOs = "cygwin";
@@ -1311,8 +1378,10 @@ struct command_context* command_init(const char *startup_tcl)
        HostOs = "mingw32";
 #elif defined(__ECOS)
        HostOs = "ecos";
+#elif defined(__FreeBSD__)
+       HostOs = "freebsd";
 #else
-#warn unrecognized host OS...
+#warning "Unrecognized host OS..."
        HostOs = "other";
 #endif
        Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",

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)