auracaster/openocd
3
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

help: re-implement 'help' independent from tree of struct command

Browse Source 
The current implementation of "help" related commands is tightly
connected to the tree of struct command.
The TCL commands 'add_usage_text' and 'add_help_text' have to add
fake commands in the tree of struct command to handle the help of
TCL procs.

Move all the help texts in a list accessible from the struct
command_context and register the commands through their full name.
Keep the list sorted alphabetically by the command name, so the
result of commands 'help' and 'usage' will be sorted too.

Remove the associated help and usage during commands un-register,
but call help_del_all_commands() for the text added through TCL
commands 'add_usage_text' and 'add_help_text'.

The resulting help and usage output is not changed by this patch
(tested on all the help and usage strings in current master
branch).

Change-Id: Ifd37bb5bd374cba1a22cd7aac208505b4ae1e6fc
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/5670
Tested-by: jenkins
Reviewed-by: Oleksij Rempel <linux@rempel-privat.de>
This commit is contained in:
Antonio Borneo
2021-03-27 16:12:11 +01:00
parent cb83bc747c
commit aacc26559e
3 changed files with 150 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/helper/command.h
View File

@@ -26,6 +26,7 @@
#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
@@ -41,6 +42,7 @@ enum command_mode {
COMMAND_EXEC,
COMMAND_CONFIG,
COMMAND_ANY,
COMMAND_UNKNOWN = -1, /* error condition */
};
struct command_context;
@@ -64,6 +66,7 @@ struct command_context {
*/
command_output_handler_t output_handler;
void *output_handler_priv;
struct list_head *help_list;
};
struct command;
@@ -179,8 +182,6 @@ typedef __COMMAND_HANDLER((*command_handler_t));
struct command {
char *name;
char *help;
char *usage;
struct command *parent;
struct command *children;
command_handler_t handler;
@@ -316,6 +317,14 @@ static inline int register_commands_with_data(struct command_context *cmd_ctx,
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);