refactor command registration

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

diff --git a/src/helper/command.h b/src/helper/command.h
index 05088b56f619c941c9d63b6597a9f47dabdf75ef..a7b422adf899594a818dd8d05ac27634b40158e3 100644 (file)
--- a/src/helper/command.h
+++ b/src/helper/command.h
@@ -176,12 +176,53 @@ struct command
  */
 char *command_name(struct command *c, char delim);
 
-struct command* register_command(struct command_context *context,
-               struct command *parent, char *name, command_handler_t handler,
-               enum command_mode mode, char *help);
+/**
+ * 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.
+ *
+ * A conventioal format should be used for help strings, to provide both
+ * usage and basic information:
+ * @code
+ * "@<options@> ... - some explanation text"
+ * @endcode
+ *
+ * @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 name The name of the command to register, which must not have
+ * been registered previously.
+ * @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.
+ * @returns The new command, if successful; otherwise, NULL.
+ */
+struct command* register_command(struct command_context *cmd_ctx,
+               struct command *parent, const char *name,
+               command_handler_t handler, enum command_mode mode,
+               const char *help);
 
-int unregister_command(struct command_context *context, char *name);
-int unregister_all_commands(struct command_context *context);
+/**
+ * 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);
 
 void command_set_output_handler(struct command_context* context,
                command_output_handler_t output_handler, void *priv);
@@ -214,15 +255,11 @@ 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(struct command_context *context, const char *name,
                Jim_CmdProc cmd, 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);
 
@@ -263,6 +300,36 @@ DECLARE_PARSE_WRAPPER(_s8, int8_t);
                } \
        } 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);