add jim_handler to command_registration

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

diff --git a/src/helper/command.h b/src/helper/command.h
index 837b4bdd2cc77339f5a252e5f2bc3018d74a95b3..84bdb71e3d6d0123622d3afdee27dfd3631480d0 100644 (file)
--- a/src/helper/command.h
+++ b/src/helper/command.h
@@ -160,9 +160,12 @@ struct command
 {
        char *name;
        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 *next;
 };
@@ -177,13 +180,9 @@ struct command
  */
 char *command_name(struct command *c, char delim);
 
-/**
- * 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.
+/*
+ * 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:
@@ -191,21 +190,82 @@ char *command_name(struct command *c, char delim);
  * "@<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.
+ * 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;
+
+       /**
+        * 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 char *name,
-               command_handler_t handler, enum command_mode mode,
-               const char *help);
+               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.
@@ -225,6 +285,11 @@ int unregister_command(struct command_context *cmd_ctx,
 int unregister_all_commands(struct command_context *cmd_ctx,
                struct command *parent);
 
+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);
+
 void command_set_output_handler(struct command_context* context,
                command_output_handler_t output_handler, void *priv);
 
@@ -258,9 +323,6 @@ void process_jim_events(void);
 
 extern Jim_Interp *interp;
 
-void register_jim(struct command_context *context, const char *name,
-               Jim_CmdProc cmd, const char *help);
-
 int parse_ulong(const char *str, unsigned long *ul);
 int parse_ullong(const char *str, unsigned long long *ul);