- Replace 'if(' with 'if ('.
[fw/openocd] / src / helper / command.c
index 9ca64dd2df37bb50ca3934b4bea5b5453baf9940..ec1d637f15abebca01d195eaf5869eacf32fecb0 100644 (file)
 #include "config.h"
 #endif
 
-#include "replacements.h"
+#if !BUILD_ECOSBOARD
+/* see Embedder-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
+#define JIM_EMBEDDED
+#endif
+
+// @todo the inclusion of target.h here is a layering violation
 #include "target.h"
 #include "command.h"
 #include "configuration.h"
-
 #include "log.h"
 #include "time_support.h"
 #include "jim-eventloop.h"
 
-#include <stdlib.h>
-#include <string.h>
-#include <ctype.h>
-#include <stdarg.h>
-#include <stdio.h>
-#include <unistd.h>
-#include <errno.h>
 
 int fast_and_dangerous = 0;
 Jim_Interp *interp = NULL;
@@ -64,6 +61,23 @@ static void tcl_output(void *privData, const char *file, int line, const char *f
 
 extern command_context_t *global_cmd_ctx;
 
+void script_debug(Jim_Interp *interp, const char *name, int argc, Jim_Obj *const *argv)
+{
+       int i;
+
+       LOG_DEBUG("command - %s", name);
+       for (i = 0; i < argc; i++) {
+               int len;
+               const char *w = Jim_GetString(argv[i], &len);
+
+               /* end of line comment? */
+               if (*w == '#')
+                       break;
+
+               LOG_DEBUG("%s - argv[%d]=%s", name, i, w);
+       }
+}
+
 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        /* the private data is stashed in the interp structure */
@@ -88,7 +102,7 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        target_call_timer_callbacks_now();
        LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
 
-       LOG_DEBUG("script_command - %s", c->name);
+       script_debug(interp, c->name, argc, argv);
 
        words = malloc(sizeof(char *) * argc);
        for (i = 0; i < argc; i++)
@@ -105,7 +119,6 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
                {
                        return JIM_ERR;
                }
-               LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]);
        }
        nwords = i;
 
@@ -147,6 +160,9 @@ static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        return (retval==ERROR_OK)?JIM_OK:JIM_ERR;
 }
 
+/* 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)
 {
        command_t *c, *p;
@@ -221,14 +237,14 @@ command_t* register_command(command_context_t *context, command_t *parent, char
        free((void *)full_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, __FILE__, __LINE__ );
+       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__ );
        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 *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);
@@ -286,7 +302,9 @@ int unregister_command(command_context_t *context, char *name)
                return ERROR_INVALID_ARGUMENTS;
 
        /* find command */
-       for (c = context->commands; c; c = c->next)
+       c = context->commands;
+
+       while(NULL != c)
        {
                if (strcmp(name, c->name) == 0)
                {
@@ -297,26 +315,32 @@ int unregister_command(command_context_t *context, char *name)
                        }
                        else
                        {
+                               /* first element in command list */
                                context->commands = c->next;
                        }
 
                        /* unregister children */
-                       if (c->children)
+                       while(NULL != c->children)
                        {
-                               for (c2 = c->children; c2; c2 = c2->next)
-                               {
-                                       free(c2->name);
-                                       free(c2);
-                               }
+                               c2 = c->children;
+                               c->children = c->children->next;
+                               free(c2->name);
+                               c2->name = NULL;
+                               free(c2);
+                               c2 = NULL;
                        }
 
                        /* delete command */
                        free(c->name);
+                       c->name = NULL;
                        free(c);
+                       c = NULL;
+                       return ERROR_OK;
                }
 
                /* remember the last command for unlinking */
                p = c;
+               c = c->next;
        }
 
        return ERROR_OK;
@@ -324,12 +348,12 @@ int unregister_command(command_context_t *context, char *name)
 
 void command_output_text(command_context_t *context, const char *data)
 {
-       if( context && context->output_handler && data  ){
+       if ( context && context->output_handler && data  ){
                context->output_handler( context, data );
        }
 }
 
-void command_print_n(command_context_t *context, char *format, ...)
+void command_print_sameline(command_context_t *context, const char *format, ...)
 {
        char *string;
 
@@ -345,15 +369,15 @@ void command_print_n(command_context_t *context, char *format, ...)
                 * The latter bit isn't precisely neat, but will do for now.
                 */
                LOG_USER_N("%s", string);
-               // We already printed it above
-               //command_output_text(context, string);
+               /* We already printed it above */
+               /* command_output_text(context, string); */
                free(string);
        }
 
        va_end(ap);
 }
 
-void command_print(command_context_t *context, char *format, ...)
+void command_print(command_context_t *context, const char *format, ...)
 {
        char *string;
 
@@ -370,8 +394,8 @@ void command_print(command_context_t *context, char *format, ...)
                 * The latter bit isn't precisely neat, but will do for now.
                 */
                LOG_USER_N("%s", string);
-               // We already printed it above
-               //command_output_text(context, string);
+               /* We already printed it above */
+               /* command_output_text(context, string); */
                free(string);
        }
 
@@ -384,7 +408,7 @@ int run_command(command_context_t *context, command_t *c, char *words[], int num
        if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
        {
                /* Config commands can not run after the config stage */
-               LOG_ERROR("Illegal mode for command");
+               LOG_ERROR("Command '%s' only runs during configuration stage", c->name);
                return ERROR_FAIL;
        }
 
@@ -442,7 +466,7 @@ int command_run_line(command_context_t *context, char *line)
                retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
                if (retcode == JIM_OK)
                {
-                       retcode = Jim_Eval_Named(interp, line, __FILE__, __LINE__ );
+                       retcode = Jim_Eval_Named(interp, line, __THIS__FILE__, __LINE__ );
 
                        Jim_DeleteAssocData(interp, "retval");
                }
@@ -468,7 +492,8 @@ int command_run_line(command_context_t *context, char *line)
                int reslen;
 
                result = Jim_GetString(Jim_GetResult(interp), &reslen);
-               if (reslen) {
+               if (reslen>0)
+               {
                        int i;
                        char buff[256+1];
                        for (i = 0; i < reslen; i += 256)
@@ -483,11 +508,12 @@ int command_run_line(command_context_t *context, char *line)
                        }
                        LOG_USER_N("%s", "\n");
                }
+               retval=ERROR_OK;
        }
        return retval;
 }
 
-int command_run_linef(command_context_t *context, char *format, ...)
+int command_run_linef(command_context_t *context, const char *format, ...)
 {
        int retval=ERROR_FAIL;
        char *string;
@@ -633,7 +659,6 @@ static char* openocd_jim_fgets(char *s, int size, void *cookie)
        return NULL;
 }
 
-
 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
        if (argc != 2)
@@ -648,7 +673,7 @@ static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
        log_add_callback(tcl_output, tclOutput);
 
-       retcode = Jim_Eval_Named(interp, str, __FILE__, __LINE__ );
+       retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__ );
 
        log_remove_callback(tcl_output, tclOutput);
 
@@ -663,6 +688,7 @@ command_context_t* command_init()
 {
        command_context_t* context = malloc(sizeof(command_context_t));
        extern const char startup_tcl[];
+       const char *HostOs;
 
        context->mode = COMMAND_EXEC;
        context->commands = NULL;
@@ -670,7 +696,7 @@ command_context_t* command_init()
        context->output_handler = NULL;
        context->output_handler_priv = NULL;
 
-#ifdef JIM_EMBEDDED
+#if !BUILD_ECOSBOARD
        Jim_InitEmbedded();
        /* Create an interpreter */
        interp = Jim_CreateInterp();
@@ -678,6 +704,28 @@ command_context_t* command_init()
        Jim_RegisterCoreCommands(interp);
 #endif
 
+#if defined( _MSC_VER )
+       /* WinXX - is generic, the forward
+        * looking problem is this:
+        *
+        *   "win32" or "win64"
+        *
+        * "winxx" is generic.
+        */
+       HostOs = "winxx";
+#elif defined( __LINUX__)
+       HostOs = "linux";
+#elif defined( __DARWIN__ )
+       HostOs = "darwin";
+#elif defined( __CYGWIN__ )
+       HostOs = "cygwin";
+#elif defined( __MINGW32__ )
+       HostOs = "mingw32";
+#else
+       HostOs = "other";
+#endif
+       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);
        Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
@@ -694,7 +742,7 @@ command_context_t* command_init()
 
        add_default_dirs();
 
-#ifdef JIM_EMBEDDED
+#if !BUILD_ECOSBOARD
        Jim_EventLoopOnLoad(interp);
 #endif
        if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl",1)==JIM_ERR)
@@ -725,38 +773,36 @@ int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
 /* 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)
+int handle_sleep_command(struct command_context_s *cmd_ctx,
+               char *cmd, char **args, int argc)
 {
-       unsigned long duration = 0;
-       int busy = 0;
-
-       if (argc==1)
+       bool busy = false;
+       if (argc == 2)
        {
-
-       } else if (argc==2)
-       {
-               if (strcmp(args[1], "busy")!=0)
+               if (strcmp(args[1], "busy") == 0)
+                       busy = true;
+               else
                        return ERROR_COMMAND_SYNTAX_ERROR;
-               busy = 1;
-       } else
-       {
-               return ERROR_COMMAND_SYNTAX_ERROR;
        }
+       else if (argc < 1 || argc > 2)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-       duration = strtoul(args[0], NULL, 0);
+       unsigned long duration = 0;
+       int retval = parse_ulong(args[0], &duration);
+       if (ERROR_OK != retval)
+               return retval;
 
-       if (busy)
-       {
-               busy_sleep(duration);
-       } else
+       if (!busy)
        {
-               long long then=timeval_ms();
-               while ((timeval_ms()-then)<duration)
+               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;
 }
@@ -773,7 +819,7 @@ int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
 
 void process_jim_events(void)
 {
-#ifdef JIM_EMBEDDED
+#if !BUILD_ECOSBOARD
        static int recursion = 0;
 
        if (!recursion)
@@ -790,7 +836,7 @@ void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd
        Jim_CreateCommand(interp, name, cmd, NULL, NULL);
 
        /* FIX!!! it would be prettier to invoke add_help_text...
-          accumulate help text in Tcl helptext list.  */
+        * 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);
@@ -805,7 +851,6 @@ void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd
        Jim_ListAppendElement(interp, helptext, cmd_entry);
 }
 
-
 /* return global variable long value or 0 upon failure */
 long jim_global_long(const char *variable)
 {
@@ -817,3 +862,52 @@ long jim_global_long(const char *variable)
        }
        return 0;
 }
+
+#define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
+       int parse##name(const char *str, type *ul) \
+       { \
+               if (!*str) \
+                       return ERROR_COMMAND_ARGUMENT_INVALID; \
+               char *end; \
+               *ul = func(str, &end, 0); \
+               if (*end) \
+                       return ERROR_COMMAND_ARGUMENT_INVALID; \
+               if ((max == *ul) && (ERANGE == errno)) \
+                       return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
+               if (min && (min == *ul) && (ERANGE == errno)) \
+                       return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
+               return ERROR_OK; \
+       }
+DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long , strtoul, 0, ULONG_MAX)
+DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
+DEFINE_PARSE_NUM_TYPE(_long, long , strtol, LONG_MIN, LONG_MAX)
+DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
+
+#define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
+       int parse##name(const char *str, type *ul) \
+       { \
+               functype n; \
+               int retval = parse##funcname(str, &n); \
+               if (ERROR_OK != retval) \
+                       return retval; \
+               if (n > max) \
+                       return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
+               if (min) \
+                       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)
+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)