]> git.proxmox.com Git - grub2.git/blob - grub-core/commands/help.c
pull-in emu-lite
[grub2.git] / grub-core / commands / help.c
1 /* help.c - command to show a help text. */
2 /*
3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 2005,2007,2008,2009 Free Software Foundation, Inc.
5 *
6 * GRUB is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * GRUB is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include <grub/dl.h>
21 #include <grub/misc.h>
22 #include <grub/term.h>
23 #include <grub/extcmd.h>
24 #include <grub/i18n.h>
25 #include <grub/mm.h>
26 #include <grub/normal.h>
27 #include <grub/charset.h>
28
29 static grub_err_t
30 grub_cmd_help (grub_extcmd_t ext __attribute__ ((unused)), int argc,
31 char **args)
32 {
33 int cnt = 0;
34 char *currarg;
35
36 auto int print_command_info (grub_command_t cmd);
37 auto int print_command_help (grub_command_t cmd);
38
39 int print_command_info (grub_command_t cmd)
40 {
41 if ((cmd->prio & GRUB_PRIO_LIST_FLAG_ACTIVE) &&
42 (cmd->flags & GRUB_COMMAND_FLAG_CMDLINE))
43 {
44 struct grub_term_output *term;
45 const char *summary_translated = _(cmd->summary);
46 char *command_help;
47 grub_uint32_t *unicode_command_help;
48 grub_uint32_t *unicode_last_position;
49
50 command_help = grub_xasprintf ("%s %s", cmd->name, summary_translated);
51 if (!command_help)
52 return 1;
53
54 grub_utf8_to_ucs4_alloc (command_help, &unicode_command_help,
55 &unicode_last_position);
56
57 FOR_ACTIVE_TERM_OUTPUTS(term)
58 {
59 unsigned stringwidth;
60 grub_uint32_t *unicode_last_screen_position;
61
62 unicode_last_screen_position = unicode_command_help;
63
64 stringwidth = 0;
65
66 while (unicode_last_screen_position < unicode_last_position &&
67 stringwidth < ((grub_term_width (term) / 2) - 2))
68 {
69 stringwidth
70 += grub_term_getcharwidth (term,
71 *unicode_last_screen_position);
72 unicode_last_screen_position++;
73 }
74
75 grub_print_ucs4 (unicode_command_help,
76 unicode_last_screen_position, term);
77 if (!(cnt % 2))
78 grub_print_spaces (term, grub_term_width (term) / 2
79 - stringwidth);
80 }
81 if (cnt % 2)
82 grub_printf ("\n");
83 cnt++;
84
85 grub_free (command_help);
86 grub_free (unicode_command_help);
87 }
88 return 0;
89 }
90
91 int print_command_help (grub_command_t cmd)
92 {
93 if (cmd->prio & GRUB_PRIO_LIST_FLAG_ACTIVE)
94 {
95 if (! grub_strncmp (cmd->name, currarg, grub_strlen (currarg)))
96 {
97 if (cnt++ > 0)
98 grub_printf ("\n\n");
99
100 if (cmd->flags & GRUB_COMMAND_FLAG_EXTCMD)
101 grub_arg_show_help ((grub_extcmd_t) cmd->data);
102 else
103 grub_printf ("%s %s %s\n%s\n", _("Usage:"), cmd->name, _(cmd->summary),
104 _(cmd->description));
105 }
106 }
107 return 0;
108 }
109
110 if (argc == 0)
111 {
112 grub_command_iterate (print_command_info);
113 if (!(cnt % 2))
114 grub_printf ("\n");
115 }
116 else
117 {
118 int i;
119
120 for (i = 0; i < argc; i++)
121 {
122 currarg = args[i];
123 grub_command_iterate (print_command_help);
124 }
125 }
126
127 return 0;
128 }
129
130 static grub_extcmd_t cmd;
131 \f
132 GRUB_MOD_INIT(help)
133 {
134 cmd = grub_register_extcmd ("help", grub_cmd_help,
135 GRUB_COMMAND_FLAG_CMDLINE,
136 N_("[PATTERN ...]"),
137 N_("Show a help message."), 0);
138 }
139
140 GRUB_MOD_FINI(help)
141 {
142 grub_unregister_extcmd (cmd);
143 }