X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.h;h=bddb053ee587e59fda4cfdea63f9bf23fa36b5fb;hp=c574efd507e2f03511e4b84e1c46f4cc5a4a604f;hb=f973320cbb98d661bc0e4ba4fa9939ce8bce2b83;hpb=73349dc5ac33e904a1311829f2e42d923309e744 diff --git a/src/helper/command.h b/src/helper/command.h index c574efd507..bddb053ee5 100644 --- a/src/helper/command.h +++ b/src/helper/command.h @@ -35,9 +35,10 @@ #include "jim.h" #endif -/* To achieve C99 printf compatibility in MinGW, gnu_printf should */ -/* be used for __attribute__((format( ... ))) */ -#ifdef IS_MINGW +/* 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 @@ -50,6 +51,12 @@ enum command_mode COMMAND_ANY, }; +struct command_context_s; + +/// The type signature for command context's output handler. +typedef int (*command_output_handler_t)(struct command_context_s *context, + const char* line); + typedef struct command_context_s { enum command_mode mode; @@ -69,39 +76,108 @@ typedef struct command_context_s * 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); + command_output_handler_t output_handler; void *output_handler_priv; } command_context_t; + +/** + * Command handlers may be defined with more parameters than the base + * set provided by command.c. This macro uses C99 magic to allow + * defining all such derivative types using this macro. + */ +#define __COMMAND_HANDLER(name, extra...) \ + int name(struct command_context_s *cmd_ctx, \ + const char *args[], unsigned argc, ##extra) + +/** + * Use this to macro to call a command helper (or a nested handler). + * It provides command handler authors protection against reordering or + * removal of unused parameters. + * + * @b Note: This macro uses lexical capture to provide some arguments. + * As a result, this macro should be used @b only within functions + * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those + * macros provide the expected lexical context captured by this macro. + * Furthermore, it should be used only from the top-level of handler or + * helper function, or care must be taken to avoid redefining the same + * variables in intervening scope(s) by accident. + */ +#define CALL_COMMAND_HANDLER(name, extra...) \ + name(cmd_ctx, args, argc, ##extra) + +/** + * Always use this macro to define new command handler functions. + * It ensures the parameters are ordered, typed, and named properly, so + * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER). + * All command handler functions must be defined as static in scope. + */ +#define COMMAND_HANDLER(name) static __COMMAND_HANDLER(name) + +/** + * Similar to COMMAND_HANDLER, except some parameters are expected. + * A helper is globally-scoped because it may be shared between several + * source files (e.g. the s3c24xx device command helper). + */ +#define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra) + +/** + * Use this macro to access the name of the command being handled, + * rather than accessing the variable directly. It may be moved. + */ +#define CMD_NAME args[-1] + + +/// The type signature for commands' handler functions. +typedef __COMMAND_HANDLER((*command_handler_t)); + typedef struct command_s { char *name; struct command_s *parent; struct command_s *children; - int (*handler)(struct command_context_s *context, char* name, char** args, int argc); + command_handler_t handler; enum command_mode mode; 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 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(void); -extern int command_done(command_context_t *context); +/** + * @param c The command to be named. + * @param delim The character to place between command names. + * @returns A malloc'd string containing the full command name, + * which may include one or more ancestor components. Multiple names + * are separated by single spaces. The caller must free() the string + * when done with it. + */ +char *command_name(struct command_s *c, char delim); + +command_t* register_command(command_context_t *context, + command_t *parent, char *name, command_handler_t handler, + enum command_mode mode, char *help); + +int unregister_command(command_context_t *context, char *name); +int unregister_all_commands(command_context_t *context); + +void command_set_output_handler(command_context_t* context, + command_output_handler_t output_handler, void *priv); + +command_context_t* copy_command_context(command_context_t* context); + +int command_context_mode(command_context_t *context, enum command_mode mode); + +command_context_t* command_init(void); +int command_done(command_context_t *context); -extern void command_print(command_context_t *context, const char *format, ...) +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, ...) +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_linef(command_context_t *context, const char *format, ...) +int command_run_line(command_context_t *context, char *line); +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); +void command_output_text(command_context_t *context, const char *data); -extern void process_jim_events(void); +void process_jim_events(void); #define ERROR_COMMAND_CLOSE_CONNECTION (-600) #define ERROR_COMMAND_SYNTAX_ERROR (-601) @@ -137,6 +213,28 @@ 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); +/** + * @brief parses the string @a in into @a out as a @a type, or prints + * a command error and passes the error code to the caller. If an error + * does occur, the calling function will return the error code produced + * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*). + * + * This function may cause the calling function to return immediately, + * so it should be used carefully to avoid leaking resources. In most + * situations, parsing should be completed in full before proceding + * to allocate resources, and this strategy will most prevents leaks. + */ +#define COMMAND_PARSE_NUMBER(type, in, out) \ + do { \ + int retval = parse_##type(in, &(out)); \ + if (ERROR_OK != retval) { \ + command_print(cmd_ctx, stringify(out) \ + " option value ('%s') is not valid", in); \ + return retval; \ + } \ + } while (0) + +void script_debug(Jim_Interp *interp, const char *cmd, + unsigned argc, Jim_Obj *const *argv); #endif /* COMMAND_H */