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;
+};
+
+/**
+ * When run_command is called, a new instance will be created on the
+ * stack, filled with the proper values, and passed by reference to the
+ * required COMMAND_HANDLER routine.
+ */
+struct command_invocation {
+ struct command_context *ctx;
+ const char *name;
+ unsigned argc;
+ const char **argv;
+};
+
+/**
+ * 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_invocation *cmd, ##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, ##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 cmd->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 cmd->argv
+/**
+ * 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->name
-typedef struct command_s
+
+/// The type signature for commands' handler functions.
+typedef __COMMAND_HANDLER((*command_handler_t));
+
+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);
+ const char *help;
+ const char *usage;
+ struct command *parent;
+ struct command *children;
+ command_handler_t handler;
+ Jim_CmdProc jim_handler;
+ void *jim_handler_data;
enum command_mode mode;
- struct command_s *next;
-} command_t;
+ struct command *next;
+};
-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);
+/**
+ * @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);
-int unregister_command(command_context_t *context, char *name);
-int unregister_all_commands(command_context_t *context);
+/*
+ * Commands should be registered by filling in one or more of these
+ * structures and passing them to register_command().
+ *
+ * A conventioal format should be used for help strings, to provide both
+ * usage and basic information:
+ * @code
+ * "@<options@> ... - some explanation text"
+ * @endcode
+ *
+ * @param name The name of the command to register, which must not have
+ * been registered previously in the intended context.
+ * @param handler The callback function that will be called. If NULL,
+ * then the command serves as a placeholder for its children or a script.
+ * @param mode The command mode(s) in which this command may be run.
+ * @param help The help text that will be displayed to the user.
+ */
+struct command_registration {
+ const char *name;
+ command_handler_t handler;
+ Jim_CmdProc jim_handler;
+ void *jim_handler_data;
+ enum command_mode mode;
+ const char *help;
+ /// a string listing the options and arguments, required or optional
+ const char *usage;
-void command_set_output_handler(command_context_t* context,
- int (*output_handler)(struct command_context_s *context,
- const char* line), void *priv);
+ /**
+ * If non-NULL, the commands in @c chain will be registered in
+ * the same context and scope of this registration record.
+ * This allows modules to inherit lists commands from other
+ * modules.
+ */
+ const struct command_registration *chain;
+};
+
+/// Use this as the last entry in an array of command_registration records.
+#define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
+
+/**
+ * Register a command @c handler that can be called from scripts during
+ * the execution @c mode specified.
+ *
+ * If @c parent is non-NULL, the new command will be registered as a
+ * sub-command under it; otherwise, it will be available as a top-level
+ * command.
+ *
+ * @param cmd_ctx The command_context in which to register the command.
+ * @param parent Register this command as a child of this, or NULL to
+ * register a top-level command.
+ * @param rec A command_registration record that contains the desired
+ * command parameters.
+ * @returns The new command, if successful; otherwise, NULL.
+ */
+struct command* register_command(struct command_context *cmd_ctx,
+ struct command *parent, const struct command_registration *rec);
+
+#define COMMAND_REGISTER(_cmd_ctx, _parent, _name, _handler, _mode, _help) \
+ ({ \
+ struct command_registration cr = { \
+ .name = _name, \
+ .handler = _handler, \
+ .mode = _mode, \
+ .help = _help, \
+ }; \
+ register_command(_cmd_ctx, _parent, &cr); \
+ })
+
+/**
+ * Register one or more commands in the specified context, as children
+ * of @c parent (or top-level commends, if NULL). In a registration's
+ * record contains a non-NULL @c chain member and name is NULL, the
+ * commands on the chain will be registered in the same context.
+ * Otherwise, the chained commands are added as children of the command.
+ *
+ * @param cmd_ctx The command_context in which to register the command.
+ * @param parent Register this command as a child of this, or NULL to
+ * register a top-level command.
+ * @param cmds Pointer to an array of command_registration records that
+ * contains the desired command parameters. The last record must have
+ * NULL for all fields.
+ * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
+ */
+int register_commands(struct command_context *cmd_ctx, struct command *parent,
+ const struct command_registration *cmds);
+
+
+/**
+ * Unregisters command @c name from the given context, @c cmd_ctx.
+ * @param cmd_ctx The context of the registered command.
+ * @param parent The parent of the given command, or NULL.
+ * @param name The name of the command to unregister.
+ * @returns ERROR_OK on success, or an error code.
+ */
+int unregister_command(struct command_context *cmd_ctx,
+ struct command *parent, const char *name);
+/**
+ * Unregisters all commands from the specfied context.
+ * @param cmd_ctx The context that will be cleared of registered commands.
+ * @param parent If given, only clear commands from under this one command.
+ * @returns ERROR_OK on success, or an error code.
+ */
+int unregister_all_commands(struct command_context *cmd_ctx,
+ struct command *parent);
-command_context_t* copy_command_context(command_context_t* context);
+struct command *command_find_in_context(struct command_context *cmd_ctx,
+ const char *name);
+struct command *command_find_in_parent(struct command *parent,
+ const char *name);
-int command_context_mode(command_context_t *context, enum command_mode mode);
+void command_set_output_handler(struct command_context* context,
+ command_output_handler_t output_handler, void *priv);
-command_context_t* command_init(void);
-int command_done(command_context_t *context);
+struct command_context* copy_command_context(struct command_context* context);
-void command_print(command_context_t *context, const char *format, ...)
+int command_context_mode(struct command_context *context, enum command_mode mode);
+
+/**
+ * Creates a new command context using the startup TCL provided.
+ */
+struct command_context* command_init(const char *startup_tcl);
+int command_done(struct command_context *context);
+
+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);
#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);
do { \
int retval = parse_##type(in, &(out)); \
if (ERROR_OK != retval) { \
- command_print(cmd_ctx, stringify(out) \
+ command_print(CMD_CTX, stringify(out) \
+ " option value ('%s') is not valid", in); \
+ return retval; \
+ } \
+ } while (0)
+
+/**
+ * Parse the string @c as a binary parameter, storing the boolean value
+ * in @c out. The strings @c on and @c off are used to match different
+ * strings for true and false options (e.g. "on" and "off" or
+ * "enable" and "disable").
+ */
+#define COMMAND_PARSE_BOOL(in, out, on, off) \
+ do { \
+ bool value; \
+ int retval = command_parse_bool_arg(in, &value); \
+ if (ERROR_OK != retval) { \
+ command_print(CMD_CTX, stringify(out) \
" option value ('%s') is not valid", in); \
+ command_print(CMD_CTX, " choices are '%s' or '%s'", \
+ on, off); \
return retval; \
} \
+ out = value; \
} while (0)
+int command_parse_bool_arg(const char *in, bool *out);
+COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
+
+/// parses an on/off command argument
+#define COMMAND_PARSE_ON_OFF(in, out) \
+ COMMAND_PARSE_BOOL(in, out, "on", "off")
+/// parses an enable/disable command argument
+#define COMMAND_PARSE_ENABLE(in, out) \
+ COMMAND_PARSE_BOOL(in, out, "enable", "disable")
+
void script_debug(Jim_Interp *interp, const char *cmd,
unsigned argc, Jim_Obj *const *argv);
Code Review / openocd.git / blobdiff