COMMAND_ANY,
};
-typedef struct command_context_s
+struct command_context;
+
+/// The type signature for command context's output handler.
+typedef int (*command_output_handler_t)(struct command_context *context,
+ const char* line);
+
+struct command_context
{
enum command_mode mode;
- struct command_s *commands;
+ struct command *commands;
int current_target;
/* Execute a command.
*
* 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 *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 context of the command being handled,
+ * rather than accessing the variable directly. It may be moved.
+ */
+#define CMD_CTX cmd_ctx
+/**
+ * Use this macro to access the number of arguments for the command being
+ * handled, rather than accessing the variable directly. It may be moved.
+ */
+#define CMD_ARGC argc
+/**
+ * Use this macro to access the arguments for the command being handled,
+ * rather than accessing the variable directly. It may be moved.
+ */
+#define CMD_ARGV args
+/**
+ * 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 CMD_ARGV[-1]
+
+
+/// The type signature for commands' handler functions.
+typedef __COMMAND_HANDLER((*command_handler_t));
-typedef struct command_s
+struct command
{
char *name;
- struct command_s *parent;
- struct command_s *children;
- int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
+ struct command *parent;
+ struct command *children;
+ command_handler_t handler;
enum command_mode mode;
- struct command_s *next;
-} command_t;
+ struct command *next;
+};
+
+/**
+ * @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 *c, char delim);
-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),
+struct command* register_command(struct command_context *context,
+ struct command *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);
+int unregister_command(struct command_context *context, char *name);
+int unregister_all_commands(struct command_context *context);
-void command_set_output_handler(command_context_t* context,
- int (*output_handler)(struct command_context_s *context,
- const char* line), void *priv);
+void command_set_output_handler(struct command_context* context,
+ command_output_handler_t output_handler, void *priv);
-command_context_t* copy_command_context(command_context_t* context);
+struct command_context* copy_command_context(struct command_context* context);
-int command_context_mode(command_context_t *context, enum command_mode mode);
+int command_context_mode(struct command_context *context, enum command_mode mode);
-command_context_t* command_init(void);
-int command_done(command_context_t *context);
+struct command_context* command_init(void);
+int command_done(struct command_context *context);
-void command_print(command_context_t *context, const char *format, ...)
+void command_print(struct command_context *context, const char *format, ...)
__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
-void command_print_sameline(command_context_t *context, const char *format, ...)
+void command_print_sameline(struct command_context *context, const char *format, ...)
__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
-int command_run_line(command_context_t *context, char *line);
-int command_run_linef(command_context_t *context, const char *format, ...)
+int command_run_line(struct command_context *context, char *line);
+int command_run_linef(struct command_context *context, const char *format, ...)
__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
-void command_output_text(command_context_t *context, const char *data);
+void command_output_text(struct command_context *context, const char *data);
void process_jim_events(void);
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);
+void register_jim(struct command_context *context, const char *name,
+ Jim_CmdProc cmd, const char *help);
long jim_global_long(const char *variable);
} \
} while (0)
-void script_debug(Jim_Interp *interp, const char *cmd, int argc, Jim_Obj *const *argv);
+void script_debug(Jim_Interp *interp, const char *cmd,
+ unsigned argc, Jim_Obj *const *argv);
#endif /* COMMAND_H */
Code Review / openocd.git / blobdiff