src/helper: usage/help updates

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

diff --git a/src/helper/command.h b/src/helper/command.h
index 2d3348468f3ca541a4e57c868e80693bdebb3df7..8a418d367d04f604ad6084adb47f381a420c58de 100644 (file)
--- a/src/helper/command.h
+++ b/src/helper/command.h
@@ -23,7 +23,7 @@
 #ifndef COMMAND_H
 #define COMMAND_H
 
-#include "types.h"
+#include <helper/types.h>
 
 /* Integrate the JIM TCL interpretor into the command processing. */
 #if BUILD_ECOSBOARD
@@ -32,7 +32,7 @@
 /* Jim is provied by eCos */
 #include <cyg/jimtcl/jim.h>
 #else
-#include "jim.h"
+#include <helper/jim.h>
 #endif
 
 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
@@ -59,23 +59,10 @@ typedef int (*command_output_handler_t)(struct command_context *context,
 
 struct command_context
 {
+       Jim_Interp *interp;
        enum command_mode mode;
        struct command *commands;
        int current_target;
-       /* Execute a command.
-        *
-        * If the command fails, it *MUST* return a value != ERROR_OK
-        * (many commands break this rule, patches welcome!)
-        *
-        * This is *especially* important for commands such as writing
-        * to flash or verifying memory. The reason is that those commands
-        * can be used by programs to determine if the operation succeded
-        * or not. If the operation failed, then a program can try
-        * an alternative approach.
-        *
-        * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
-        * printing out the syntax of the command.
-        */
        command_output_handler_t output_handler;
        void *output_handler_priv;
 };
@@ -166,7 +153,23 @@ struct command_invocation {
 #define CMD_DATA CMD_CURRENT->jim_handler_data
 
 
-/// The type signature for commands' handler functions.
+/**
+ * The type signature for command handling functions.  They are
+ * usually registered as part of command_registration, providing
+ * a high-level means for executing a command.
+ *
+ * If the command fails, it *MUST* return a value != ERROR_OK
+ * (many commands break this rule, patches welcome!)
+ *
+ * This is *especially* important for commands such as writing
+ * to flash or verifying memory. The reason is that those commands
+ * can be used by programs to determine if the operation succeded
+ * or not. If the operation failed, then a program can try
+ * an alternative approach.
+ *
+ * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
+ * printing out the syntax of the command.
+ */
 typedef __COMMAND_HANDLER((*command_handler_t));
 
 struct command
@@ -250,17 +253,6 @@ struct command_registration {
 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
@@ -316,15 +308,30 @@ void command_set_handler_data(struct command *c, void *p);
 void command_set_output_handler(struct command_context* context,
                command_output_handler_t output_handler, void *priv);
 
-struct command_context* copy_command_context(struct command_context* context);
 
 int command_context_mode(struct command_context *context, enum command_mode mode);
 
 /**
- * Creates a new command context using the startup TCL provided.
+ * Creates a new command context using the startup TCL provided and
+ * the existing Jim interpreter, if any. If interp == NULL, then command_init
+ * creates a command interpreter.
+ */
+struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp);
+/**
+ * Creates a copy of an existing command context.  This does not create
+ * a deep copy of the command list, so modifications in one context will
+ * affect all shared contexts.  The caller must track reference counting
+ * and ensure the commands are freed before destroying the last instance.
+ * @param cmd_ctx The command_context that will be copied.
+ * @returns A new command_context with the same state as the original.
  */
-struct command_context* command_init(const char *startup_tcl);
-int command_done(struct command_context *context);
+struct command_context* copy_command_context(struct command_context* cmd_ctx);
+/**
+ * Frees the resources associated with a command context.  The commands
+ * are not removed, so unregister_all_commands() must be called first.
+ * @param context The command_context that will be destroyed.
+ */
+void command_done(struct command_context *context);
 
 void command_print(struct command_context *context, const char *format, ...)
                __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
@@ -335,7 +342,7 @@ int command_run_linef(struct command_context *context, const char *format, ...)
                __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
 void command_output_text(struct command_context *context, const char *data);
 
-void process_jim_events(void);
+void process_jim_events(struct command_context *cmd_ctx);
 
 #define                ERROR_COMMAND_CLOSE_CONNECTION          (-600)
 #define                ERROR_COMMAND_SYNTAX_ERROR                      (-601)
@@ -344,8 +351,6 @@ void process_jim_events(void);
 #define                ERROR_COMMAND_ARGUMENT_OVERFLOW         (-604)
 #define                ERROR_COMMAND_ARGUMENT_UNDERFLOW        (-605)
 
-extern Jim_Interp *interp;
-
 int parse_ulong(const char *str, unsigned long *ul);
 int parse_ullong(const char *str, unsigned long long *ul);