X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.h;h=c90ed0f69628a23a57eaa048dcb666d268e0aa8f;hp=de90d4ae4d03d12e5498a87331a8ea59e7092afa;hb=44928321e6d4d67bcb3da7022ff9d23e0c8ee78b;hpb=5c0e8efa051f4e266add8b3685020970fe394a4c diff --git a/src/helper/command.h b/src/helper/command.h index de90d4ae4d..c90ed0f696 100644 --- a/src/helper/command.h +++ b/src/helper/command.h @@ -34,8 +34,21 @@ typedef struct command_context_s enum command_mode mode; struct command_s *commands; int current_target; - int echo; - 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; @@ -46,23 +59,28 @@ 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 int command_context_mode(command_context_t *context, enum command_mode mode); 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); +extern int command_run_linef(command_context_t *context, char *format, ...); +extern void command_output_text(command_context_t *context, const char *data); #define ERROR_COMMAND_CLOSE_CONNECTION (-600) #define ERROR_COMMAND_SYNTAX_ERROR (-601) +#define ERROR_COMMAND_NOTFOUND (-602) + +extern int fast_and_dangerous; #endif /* COMMAND_H */