helper: shutdown command should return with 0 exit status

[openocd.git] / src / helper / command.c

diff --git a/src/helper/command.c b/src/helper/command.c
index ef0afa2b56bca06e5b88e13ce4c5ca2c97b4ec2b..9d19cff4f870630555d545565bfdbf0e7a445bfa 100644 (file)
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -24,14 +24,14 @@
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-/* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
+/* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
 #define JIM_EMBEDDED
 
 /* @todo the inclusion of target.h here is a layering violation */
@@ -57,7 +57,7 @@ struct log_capture_state {
 static void tcl_output(void *privData, const char *file, unsigned line,
        const char *function, const char *string)
 {
-       struct log_capture_state *state = (struct log_capture_state *)privData;
+       struct log_capture_state *state = privData;
        Jim_AppendString(state->interp, state->output, string, strlen(string));
 }
 
@@ -146,16 +146,17 @@ void script_debug(Jim_Interp *interp, const char *name,
        free(dbg);
 }
 
-static void script_command_args_free(const char **words, unsigned nwords)
+static void script_command_args_free(char **words, unsigned nwords)
 {
        for (unsigned i = 0; i < nwords; i++)
-               free((void *)words[i]);
+               free(words[i]);
        free(words);
 }
-static const char **script_command_args_alloc(
+
+static char **script_command_args_alloc(
        unsigned argc, Jim_Obj * const *argv, unsigned *nwords)
 {
-       const char **words = malloc(argc * sizeof(char *));
+       char **words = malloc(argc * sizeof(char *));
        if (NULL == words)
                return NULL;
 
@@ -197,7 +198,7 @@ static int script_command_run(Jim_Interp *interp,
        LOG_USER_N("%s", "");   /* Keep GDB connection alive*/
 
        unsigned nwords;
-       const char **words = script_command_args_alloc(argc, argv, &nwords);
+       char **words = script_command_args_alloc(argc, argv, &nwords);
        if (NULL == words)
                return JIM_ERR;
 
@@ -244,6 +245,7 @@ static struct command *command_find(struct command *head, const char *name)
        }
        return NULL;
 }
+
 struct command *command_find_in_context(struct command_context *cmd_ctx,
        const char *name)
 {
@@ -297,12 +299,9 @@ static void command_free(struct command *c)
                command_free(tmp);
        }
 
-       if (c->name)
-               free((void *)c->name);
-       if (c->help)
-               free((void *)c->help);
-       if (c->usage)
-               free((void *)c->usage);
+       free(c->name);
+       free(c->help);
+       free(c->usage);
        free(c);
 }
 
@@ -360,27 +359,27 @@ static int register_command_handler(struct command_context *cmd_ctx,
        struct command *c)
 {
        Jim_Interp *interp = cmd_ctx->interp;
-       const char *ocd_name = alloc_printf("ocd_%s", c->name);
+       char *ocd_name = alloc_printf("ocd_%s", c->name);
        if (NULL == ocd_name)
                return JIM_ERR;
 
        LOG_DEBUG("registering '%s'...", ocd_name);
 
-       Jim_CmdProc func = c->handler ? &script_command : &command_unknown;
+       Jim_CmdProc *func = c->handler ? &script_command : &command_unknown;
        int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
-       free((void *)ocd_name);
+       free(ocd_name);
        if (JIM_OK != retval)
                return retval;
 
        /* we now need to add an overrideable proc */
-       const char *override_name = alloc_printf(
+       char *override_name = alloc_printf(
                        "proc %s {args} {eval ocd_bouncer %s $args}",
                        c->name, c->name);
        if (NULL == override_name)
                return JIM_ERR;
 
        retval = Jim_Eval_Named(interp, override_name, 0, 0);
-       free((void *)override_name);
+       free(override_name);
 
        return retval;
 }
@@ -570,6 +569,7 @@ static char *__command_name(struct command *c, char delim, unsigned extra)
        }
        return name;
 }
+
 char *command_name(struct command *c, char delim)
 {
        return __command_name(c, delim, 0);
@@ -660,7 +660,10 @@ int command_run_line(struct command_context *context, char *line)
                Jim_DeleteAssocData(interp, "context");
        }
        if (retcode == JIM_ERR) {
-               if (retval != ERROR_COMMAND_CLOSE_CONNECTION) {
+               if (retval == ERROR_COMMAND_CLOSE_CONNECTION) {
+                       /* Shutdown request is not an error */
+                       return ERROR_OK;
+               } else {
                        /* We do not print the connection closed error message */
                        Jim_MakeErrorMessage(interp);
                        LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
@@ -777,7 +780,7 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        /* disable polling during capture. This avoids capturing output
         * from polling.
         *
-        * This is necessary in order to avoid accidentially getting a non-empty
+        * This is necessary in order to avoid accidentally getting a non-empty
         * string for tcl fn's.
         */
        bool save_poll = jtag_poll_get_enabled();
@@ -811,13 +814,13 @@ static COMMAND_HELPER(command_help_find, struct command *head,
 }
 
 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
-       bool show_help, const char *match);
+       bool show_help, const char *cmd_match);
 
 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
-       bool show_help, const char *match)
+       bool show_help, const char *cmd_match)
 {
        for (struct command *c = head; NULL != c; c = c->next)
-               CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, match);
+               CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, cmd_match);
        return ERROR_OK;
 }
 
@@ -847,8 +850,9 @@ static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
                n = n2;
        }
 }
+
 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
-       bool show_help, const char *match)
+       bool show_help, const char *cmd_match)
 {
        char *cmd_name = command_name(c, ' ');
        if (NULL == cmd_name)
@@ -856,9 +860,9 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
 
        /* 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));
+       bool is_match = (strstr(cmd_name, cmd_match) != NULL) ||
+               ((c->usage != NULL) && (strstr(c->usage, cmd_match) != NULL)) ||
+               ((c->help != NULL) && (strstr(c->help, cmd_match) != NULL));
 
        if (is_match) {
                command_help_show_indent(n);
@@ -867,7 +871,7 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
        free(cmd_name);
 
        if (is_match) {
-               if (c->usage) {
+               if (c->usage && strlen(c->usage) > 0) {
                        LOG_USER_N(" ");
                        command_help_show_wrap(c->usage, 0, n + 5);
                } else
@@ -909,37 +913,35 @@ static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
        }
 
        return CALL_COMMAND_HANDLER(command_help_show_list,
-               c->children, n, show_help, match);
+               c->children, n, show_help, cmd_match);
 }
+
 COMMAND_HANDLER(handle_help_command)
 {
        bool full = strcmp(CMD_NAME, "help") == 0;
        int retval;
        struct command *c = CMD_CTX->commands;
-       char *match = NULL;
+       char *cmd_match = NULL;
 
        if (CMD_ARGC == 0)
-               match = "";
+               cmd_match = "";
        else if (CMD_ARGC >= 1) {
                unsigned i;
 
                for (i = 0; i < CMD_ARGC; ++i) {
-                       if (NULL != match) {
-                               char *prev = match;
+                       if (NULL != cmd_match) {
+                               char *prev = cmd_match;
 
-                               match = alloc_printf("%s %s", match,
-                                               CMD_ARGV[i]);
+                               cmd_match = alloc_printf("%s %s", cmd_match, CMD_ARGV[i]);
                                free(prev);
-                               if (NULL == match) {
-                                       LOG_ERROR("unable to build "
-                                               "search string");
+                               if (NULL == cmd_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");
+                               cmd_match = alloc_printf("%s", CMD_ARGV[i]);
+                               if (NULL == cmd_match) {
+                                       LOG_ERROR("unable to build search string");
                                        return -ENOMEM;
                                }
                        }
@@ -948,10 +950,10 @@ COMMAND_HANDLER(handle_help_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        retval = CALL_COMMAND_HANDLER(command_help_show_list,
-                       c, 0, full, match);
+                       c, 0, full, cmd_match);
 
        if (CMD_ARGC >= 1)
-               free(match);
+               free(cmd_match);
        return retval;
 }
 
@@ -1071,8 +1073,10 @@ static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                Jim_SetResultString(interp, "native", -1);
        else if (c->handler)
                Jim_SetResultString(interp, "simple", -1);
-       else
+       else if (remaining == 0)
                Jim_SetResultString(interp, "group", -1);
+       else
+               Jim_SetResultString(interp, "unknown", -1);
 
        return JIM_OK;
 }
@@ -1101,7 +1105,7 @@ int help_add_command(struct command_context *cmd_ctx, struct command *parent,
        if (help_text) {
                bool replaced = false;
                if (nc->help) {
-                       free((void *)nc->help);
+                       free(nc->help);
                        replaced = true;
                }
                nc->help = strdup(help_text);
@@ -1113,7 +1117,7 @@ int help_add_command(struct command_context *cmd_ctx, struct command *parent,
        if (usage) {
                bool replaced = false;
                if (nc->usage) {
-                       free((void *)nc->usage);
+                       free(nc->usage);
                        replaced = true;
                }
                nc->usage = strdup(usage);
@@ -1311,6 +1315,8 @@ struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp
        HostOs = "ecos";
 #elif defined(__FreeBSD__)
        HostOs = "freebsd";
+#elif defined(__NetBSD__)
+       HostOs = "netbsd";
 #elif defined(__OpenBSD__)
        HostOs = "openbsd";
 #else
@@ -1400,19 +1406,21 @@ DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
                return ERROR_OK; \
        }
 
-#define DEFINE_PARSE_ULONG(name, type, min, max) \
-       DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
-DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
-DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
-DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
-DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
-
-#define DEFINE_PARSE_LONG(name, type, min, max)        \
-       DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
-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)
+#define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
+       DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
+DEFINE_PARSE_ULONGLONG(_uint, unsigned, 0, UINT_MAX)
+DEFINE_PARSE_ULONGLONG(_u64,  uint64_t, 0, UINT64_MAX)
+DEFINE_PARSE_ULONGLONG(_u32,  uint32_t, 0, UINT32_MAX)
+DEFINE_PARSE_ULONGLONG(_u16,  uint16_t, 0, UINT16_MAX)
+DEFINE_PARSE_ULONGLONG(_u8,   uint8_t,  0, UINT8_MAX)
+
+#define DEFINE_PARSE_LONGLONG(name, type, min, max) \
+       DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
+DEFINE_PARSE_LONGLONG(_int, int,     n < INT_MIN,   INT_MAX)
+DEFINE_PARSE_LONGLONG(_s64, int64_t, n < INT64_MIN, INT64_MAX)
+DEFINE_PARSE_LONGLONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
+DEFINE_PARSE_LONGLONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
+DEFINE_PARSE_LONGLONG(_s8,  int8_t,  n < INT8_MIN,  INT8_MAX)
 
 static int command_parse_bool(const char *in, bool *out,
        const char *on, const char *off)