[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 12/16] monitor: support sub command in help
From: |
Luiz Capitulino |
Subject: |
[Qemu-devel] [PULL 12/16] monitor: support sub command in help |
Date: |
Fri, 30 Aug 2013 08:22:33 -0400 |
From: Wenchao Xia <address@hidden>
The old code in help_cmd() uses global 'info_cmds' and treats it as a
special case. Actually 'info_cmds' is a sub command group of 'mon_cmds',
in order to avoid direct use of it, help_cmd() needs to change its work
mechanism to support sub command and not treat it as a special case
any more.
To support sub command, help_cmd() will first parse the input and then call
help_cmd_dump(), which works as a reentrant function. When it meets a sub
command, it simply enters the function again. Since help dumping needs to
know whole input to printf full help message include prefix, for example,
"help info block" need to printf prefix "info", so help_cmd_dump() takes all
args from input and extra parameter arg_index to identify the progress.
Another function help_cmd_dump_one() is introduced to printf the prefix
and command's help message.
Now help supports sub command, so later if another sub command group is
added in any depth, help will automatically work for it. Still "help info
block" will show error since command parser reject additional parameter,
which can be improved later. "log" is still treated as a special case.
Signed-off-by: Wenchao Xia <address@hidden>
Signed-off-by: Luiz Capitulino <address@hidden>
---
monitor.c | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++----------
1 file changed, 52 insertions(+), 10 deletions(-)
diff --git a/monitor.c b/monitor.c
index aae1bab..39c8753 100644
--- a/monitor.c
+++ b/monitor.c
@@ -880,33 +880,75 @@ static int parse_cmdline(const char *cmdline,
return -1;
}
+static void help_cmd_dump_one(Monitor *mon,
+ const mon_cmd_t *cmd,
+ char **prefix_args,
+ int prefix_args_nb)
+{
+ int i;
+
+ for (i = 0; i < prefix_args_nb; i++) {
+ monitor_printf(mon, "%s ", prefix_args[i]);
+ }
+ monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
+}
+
+/* @address@hidden is the valid command need to find in @cmds */
static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
- const char *prefix, const char *name)
+ char **args, int nb_args, int arg_index)
{
const mon_cmd_t *cmd;
- for(cmd = cmds; cmd->name != NULL; cmd++) {
- if (!name || !strcmp(name, cmd->name))
- monitor_printf(mon, "%s%s %s -- %s\n", prefix, cmd->name,
- cmd->params, cmd->help);
+ /* No valid arg need to compare with, dump all in *cmds */
+ if (arg_index >= nb_args) {
+ for (cmd = cmds; cmd->name != NULL; cmd++) {
+ help_cmd_dump_one(mon, cmd, args, arg_index);
+ }
+ return;
+ }
+
+ /* Find one entry to dump */
+ for (cmd = cmds; cmd->name != NULL; cmd++) {
+ if (compare_cmd(args[arg_index], cmd->name)) {
+ if (cmd->sub_table) {
+ /* continue with next arg */
+ help_cmd_dump(mon, cmd->sub_table,
+ args, nb_args, arg_index + 1);
+ } else {
+ help_cmd_dump_one(mon, cmd, args, arg_index);
+ }
+ break;
+ }
}
}
static void help_cmd(Monitor *mon, const char *name)
{
- if (name && !strcmp(name, "info")) {
- help_cmd_dump(mon, info_cmds, "info ", NULL);
- } else {
- help_cmd_dump(mon, mon->cmd_table, "", name);
- if (name && !strcmp(name, "log")) {
+ char *args[MAX_ARGS];
+ int nb_args = 0;
+
+ /* 1. parse user input */
+ if (name) {
+ /* special case for log, directly dump and return */
+ if (!strcmp(name, "log")) {
const QEMULogItem *item;
monitor_printf(mon, "Log items (comma separated):\n");
monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
for (item = qemu_log_items; item->mask != 0; item++) {
monitor_printf(mon, "%-10s %s\n", item->name, item->help);
}
+ return;
+ }
+
+ if (parse_cmdline(name, &nb_args, args) < 0) {
+ return;
}
}
+
+ /* 2. dump the contents according to parsed args */
+ help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
+
+ free_cmdline_args(args, nb_args);
}
static void do_help_cmd(Monitor *mon, const QDict *qdict)
--
1.8.1.4
- [Qemu-devel] [PULL 02/16] monitor: avoid use of global *cur_mon in cmd_completion(), (continued)
- [Qemu-devel] [PULL 02/16] monitor: avoid use of global *cur_mon in cmd_completion(), Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 04/16] monitor: avoid use of global *cur_mon in block_completion_it(), Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 03/16] monitor: avoid use of global *cur_mon in file_completion(), Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 05/16] monitor: avoid use of global *cur_mon in monitor_find_completion(), Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 06/16] monitor: avoid use of global *cur_mon in readline_completion(), Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 07/16] monitor: call sortcmdlist() only one time, Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 08/16] monitor: split off monitor_data_init(), Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 09/16] monitor: avoid direct use of global variable *mon_cmds, Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 10/16] monitor: code move for parse_cmdline(), Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 11/16] monitor: refine parse_cmdline(), Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 12/16] monitor: support sub command in help,
Luiz Capitulino <=
- [Qemu-devel] [PULL 13/16] monitor: refine monitor_find_completion(), Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 14/16] monitor: support sub command in auto completion, Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 15/16] monitor: allow "help" show message for single command in sub group, Luiz Capitulino, 2013/08/30
- [Qemu-devel] [PULL 16/16] monitor: improve auto complete of "help" for single command in sub group, Luiz Capitulino, 2013/08/30