Code Review / openocd.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
corrective fix for MinGW GNU C99 printf compliance
[openocd.git] / src / helper / command.h
diff --git a/src/helper/command.h b/src/helper/command.h
index 3acb8b1821b72eec8bd91aaf015987145fd80439..ba825bcb48485a9e61d22efc0cd943b6908ffb57 100644 (file)
--- a/src/helper/command.h
+++ b/src/helper/command.h
@@ -2,6 +2,9 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
@@ -20,7 +23,26 @@
 #ifndef COMMAND_H
 #define COMMAND_H
 
+#include "types.h"
+
+/* Integrate the JIM TCL interpretor into the command processing. */
+#if BUILD_ECOSBOARD
 #include <stdio.h>
+#include <stdarg.h>
+/* Jim is provied by eCos */
+#include <cyg/jimtcl/jim.h>
+#else
+#include "jim.h"
+#endif
+
+/* To achieve C99 printf compatibility in MinGW, gnu_printf should be
+ * used for __attribute__((format( ... ))), with GCC v4.4 or later
+ */
+#if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
+#define PRINTF_ATTRIBUTE_FORMAT gnu_printf
+#else
+#define PRINTF_ATTRIBUTE_FORMAT printf
+#endif
 
 enum command_mode
 {
@@ -34,7 +56,21 @@ typedef struct command_context_s
        enum command_mode mode;
        struct command_s *commands;
        int current_target;
-       int (*output_handler)(struct command_context_s *context, char* line);
+       /* Execute a command.
+        *
+        * If the command fails, it *MUST* return a value != ERROR_OK
+        * (many commands break this rule, patches welcome!)
+        *
+        * This is *especially* important for commands such as writing
+        * to flash or verifying memory. The reason is that those commands
+        * can be used by programs to determine if the operation succeded
+        * or not. If the operation failed, then a program can try
+        * an alternative approach.
+        *
+        * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
+        * printing out the syntax of the command.
+        */
+       int (*output_handler)(struct command_context_s *context, const char* line);
        void *output_handler_priv;
 } command_context_t;
 
@@ -45,24 +81,63 @@ typedef struct command_s
        struct command_s *children;
        int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
        enum command_mode mode;
-       char *help;
-       int unique_len;
        struct command_s *next;
 } command_t;
 
 extern 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);
 extern int unregister_command(command_context_t *context, char *name);
-extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv);
+extern int unregister_all_commands(command_context_t *context);
+extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv);
 extern command_context_t* copy_command_context(command_context_t* context);
-extern command_context_t* command_init();
+extern int command_context_mode(command_context_t *context, enum command_mode mode);
+extern command_context_t* command_init(void);
 extern int command_done(command_context_t *context);
-extern void command_print(command_context_t *context, char *format, ...);
-extern void command_print_sameline(command_context_t *context, char *format, ...);
+
+extern void command_print(command_context_t *context, const char *format, ...)
+               __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
+extern void command_print_sameline(command_context_t *context, const char *format, ...)
+               __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
 extern int command_run_line(command_context_t *context, char *line);
-extern int command_run_file(command_context_t *context, FILE *file, enum command_mode mode);
+extern int command_run_linef(command_context_t *context, const char *format, ...)
+               __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
+extern void command_output_text(command_context_t *context, const char *data);
 
+extern void process_jim_events(void);
 
 #define                ERROR_COMMAND_CLOSE_CONNECTION          (-600)
 #define                ERROR_COMMAND_SYNTAX_ERROR                      (-601)
+#define                ERROR_COMMAND_NOTFOUND                          (-602)
+#define                ERROR_COMMAND_ARGUMENT_INVALID          (-603)
+#define                ERROR_COMMAND_ARGUMENT_OVERFLOW         (-604)
+#define                ERROR_COMMAND_ARGUMENT_UNDERFLOW        (-605)
+
+extern int fast_and_dangerous;
+
+extern Jim_Interp *interp;
+
+void register_jim(command_context_t *context, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help);
+
+long jim_global_long(const char *variable);
+
+int parse_ulong(const char *str, unsigned long *ul);
+int parse_ullong(const char *str, unsigned long long *ul);
+
+int parse_long(const char *str, long *ul);
+int parse_llong(const char *str, long long *ul);
+
+#define DECLARE_PARSE_WRAPPER(name, type) \
+       int parse##name(const char *str, type *ul)
+
+DECLARE_PARSE_WRAPPER(_uint, unsigned);
+DECLARE_PARSE_WRAPPER(_u32, uint32_t);
+DECLARE_PARSE_WRAPPER(_u16, uint16_t);
+DECLARE_PARSE_WRAPPER(_u8, uint8_t);
+
+DECLARE_PARSE_WRAPPER(_int, int);
+DECLARE_PARSE_WRAPPER(_s32, int32_t);
+DECLARE_PARSE_WRAPPER(_s16, int16_t);
+DECLARE_PARSE_WRAPPER(_s8, int8_t);
+
+void script_debug(Jim_Interp *interp, const char *cmd, int argc, Jim_Obj *const *argv);
 
 #endif /* COMMAND_H */
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)