This matters for embedded devices, but is probably not observably better for PC hoste...

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

diff --git a/src/helper/command.h b/src/helper/command.h
index 262786a82ac52d6cdac464edf7860e7c9990087e..ed6a96a70d259f95b0985e5d71bb784e75ac6896 100644 (file)
--- a/src/helper/command.h
+++ b/src/helper/command.h
@@ -34,7 +34,20 @@ typedef struct command_context_s
        enum command_mode mode;
        struct command_s *commands;
        int current_target;
-       int echo;
+       /* 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, char* line);
        void *output_handler_priv;
 } command_context_t;
@@ -53,15 +66,21 @@ typedef struct command_s
 
 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 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, char* line), void *priv);
 extern command_context_t* copy_command_context(command_context_t* context);
 extern command_context_t* command_init();
 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 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);
 
 
 #define                ERROR_COMMAND_CLOSE_CONNECTION          (-600)
+#define                ERROR_COMMAND_SYNTAX_ERROR                      (-601)
+
+
+extern int fast_and_dangerous;
 
 #endif /* COMMAND_H */