#include <stdbool.h>
#include <jim-nvp.h>
+#include <helper/list.h>
#include <helper/types.h>
/* To achieve C99 printf compatibility in MinGW, gnu_printf should be
COMMAND_EXEC,
COMMAND_CONFIG,
COMMAND_ANY,
+ COMMAND_UNKNOWN = -1, /* error condition */
};
struct command_context;
*/
command_output_handler_t output_handler;
void *output_handler_priv;
+ struct list_head *help_list;
};
struct command;
struct command {
char *name;
- char *help;
- char *usage;
struct command *parent;
struct command *children;
command_handler_t handler;
int unregister_all_commands(struct command_context *cmd_ctx,
struct command *parent);
+/**
+ * Unregisters the help for all commands. Used at exit to remove the help
+ * added through the commands 'add_help_text' and 'add_usage_text'.
+ * @param cmd_ctx The context that will be cleared of registered helps.
+ * @returns ERROR_OK on success, or an error code.
+ */
+int help_del_all_commands(struct command_context *cmd_ctx);
+
void command_set_output_handler(struct command_context *context,
command_output_handler_t output_handler, void *priv);