Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Header file for command-reading library command.c. |
18a642a1 | 2 | |
197e01b6 | 3 | Copyright (C) 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999, |
3b64bf98 | 4 | 2000, 2002, 2004 Free Software Foundation, Inc. |
c906108c | 5 | |
c5aa993b JM |
6 | This program 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 2 of the License, or | |
9 | (at your option) any later version. | |
c906108c | 10 | |
c5aa993b JM |
11 | This program 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. | |
c906108c | 15 | |
c5aa993b JM |
16 | You should have received a copy of the GNU General Public License |
17 | along with this program; if not, write to the Free Software | |
197e01b6 EZ |
18 | Foundation, Inc., 51 Franklin Street, Fifth Floor, |
19 | Boston, MA 02110-1301, USA. */ | |
c906108c SS |
20 | |
21 | #if !defined (COMMAND_H) | |
22 | #define COMMAND_H 1 | |
23 | ||
6426a772 JM |
24 | /* Command classes are top-level categories into which commands are broken |
25 | down for "help" purposes. | |
26 | Notes on classes: class_alias is for alias commands which are not | |
27 | abbreviations of the original command. class-pseudo is for | |
28 | commands which are not really commands nor help topics ("stop"). */ | |
29 | ||
30 | enum command_class | |
31 | { | |
32 | /* Special args to help_list */ | |
33 | class_deprecated, all_classes = -2, all_commands = -1, | |
34 | /* Classes of commands */ | |
35 | no_class = -1, class_run = 0, class_vars, class_stack, | |
36 | class_files, class_support, class_info, class_breakpoint, class_trace, | |
37 | class_alias, class_obscure, class_user, class_maintenance, | |
9285ab80 | 38 | class_pseudo, class_tui, class_xdb |
6426a772 JM |
39 | }; |
40 | ||
18a642a1 AC |
41 | /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum |
42 | cmd_types'' can be moved from "command.h" to "cli-decode.h". */ | |
c906108c SS |
43 | /* Not a set/show command. Note that some commands which begin with |
44 | "set" or "show" might be in this category, if their syntax does | |
45 | not fall into one of the following categories. */ | |
c5aa993b JM |
46 | typedef enum cmd_types |
47 | { | |
48 | not_set_cmd, | |
49 | set_cmd, | |
50 | show_cmd | |
51 | } | |
52 | cmd_types; | |
c906108c SS |
53 | |
54 | /* Types of "set" or "show" command. */ | |
c5aa993b JM |
55 | typedef enum var_types |
56 | { | |
57 | /* "on" or "off". *VAR is an integer which is nonzero for on, | |
58 | zero for off. */ | |
59 | var_boolean, | |
97c3646f AC |
60 | |
61 | /* "on" / "true" / "enable" or "off" / "false" / "disable" or | |
7f19b9a2 AC |
62 | "auto. *VAR is an ``enum auto_boolean''. NOTE: In general a |
63 | custom show command will need to be implemented - one that for | |
64 | "auto" prints both the "auto" and the current auto-selected | |
97c3646f AC |
65 | value. */ |
66 | var_auto_boolean, | |
67 | ||
c5aa993b JM |
68 | /* Unsigned Integer. *VAR is an unsigned int. The user can type 0 |
69 | to mean "unlimited", which is stored in *VAR as UINT_MAX. */ | |
70 | var_uinteger, | |
71 | ||
72 | /* Like var_uinteger but signed. *VAR is an int. The user can type 0 | |
73 | to mean "unlimited", which is stored in *VAR as INT_MAX. */ | |
74 | var_integer, | |
75 | ||
76 | /* String which the user enters with escapes (e.g. the user types \n and | |
77 | it is a real newline in the stored string). | |
78 | *VAR is a malloc'd string, or NULL if the string is empty. */ | |
79 | var_string, | |
80 | /* String which stores what the user types verbatim. | |
81 | *VAR is a malloc'd string, or NULL if the string is empty. */ | |
82 | var_string_noescape, | |
b4b4ac0b AC |
83 | /* String which stores a filename. (*VAR) is a malloc'd string, |
84 | or "" if the string was empty. */ | |
85 | var_optional_filename, | |
86 | /* String which stores a filename. (*VAR) is a malloc'd | |
87 | string. */ | |
c5aa993b JM |
88 | var_filename, |
89 | /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except | |
90 | that zero really means zero. */ | |
91 | var_zinteger, | |
92 | /* Enumerated type. Can only have one of the specified values. *VAR is a | |
93 | char pointer to the name of the element that we find. */ | |
94 | var_enum | |
95 | } | |
96 | var_types; | |
c906108c SS |
97 | |
98 | /* This structure records one command'd definition. */ | |
18a642a1 | 99 | struct cmd_list_element; |
c906108c | 100 | |
18d5d590 | 101 | /* Forward-declarations of the entry-points of cli/cli-decode.c. */ |
c906108c | 102 | |
a14ed312 KB |
103 | extern struct cmd_list_element *add_cmd (char *, enum command_class, |
104 | void (*fun) (char *, int), char *, | |
105 | struct cmd_list_element **); | |
106 | ||
107 | extern struct cmd_list_element *add_alias_cmd (char *, char *, | |
108 | enum command_class, int, | |
109 | struct cmd_list_element **); | |
110 | ||
111 | extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class, | |
112 | void (*fun) (char *, int), | |
113 | char *, | |
114 | struct cmd_list_element **, | |
115 | char *, int, | |
116 | struct cmd_list_element **); | |
117 | ||
118 | extern struct cmd_list_element *add_abbrev_prefix_cmd (char *, | |
119 | enum command_class, | |
120 | void (*fun) (char *, | |
121 | int), | |
122 | char *, | |
123 | struct cmd_list_element | |
124 | **, char *, int, | |
125 | struct cmd_list_element | |
126 | **); | |
127 | ||
9f60d481 AC |
128 | /* Set the commands corresponding callback. */ |
129 | ||
9773a94b | 130 | typedef void cmd_cfunc_ftype (char *args, int from_tty); |
9f60d481 | 131 | extern void set_cmd_cfunc (struct cmd_list_element *cmd, |
9773a94b | 132 | cmd_cfunc_ftype *cfunc); |
9f60d481 | 133 | |
9773a94b AC |
134 | typedef void cmd_sfunc_ftype (char *args, int from_tty, |
135 | struct cmd_list_element *c); | |
9f60d481 | 136 | extern void set_cmd_sfunc (struct cmd_list_element *cmd, |
9773a94b | 137 | cmd_sfunc_ftype *sfunc); |
9f60d481 | 138 | |
5ba2abeb AC |
139 | extern void set_cmd_completer (struct cmd_list_element *cmd, |
140 | char **(*completer) (char *text, char *word)); | |
141 | ||
bbaca940 AC |
142 | /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs |
143 | around in cmd objects to test the value of the commands sfunc(). */ | |
144 | extern int cmd_cfunc_eq (struct cmd_list_element *cmd, | |
145 | void (*cfunc) (char *args, int from_tty)); | |
9f60d481 | 146 | |
7d0766f3 AC |
147 | /* Each command object has a local context attached to it. . */ |
148 | extern void set_cmd_context (struct cmd_list_element *cmd, void *context); | |
149 | extern void *get_cmd_context (struct cmd_list_element *cmd); | |
150 | ||
151 | ||
5913bcb0 AC |
152 | /* Execute CMD's pre/post hook. Throw an error if the command fails. |
153 | If already executing this pre/post hook, or there is no pre/post | |
154 | hook, the call is silently ignored. */ | |
155 | extern void execute_cmd_pre_hook (struct cmd_list_element *cmd); | |
156 | extern void execute_cmd_post_hook (struct cmd_list_element *cmd); | |
157 | ||
1868c04e | 158 | /* Return the type of the command. */ |
1868c04e AC |
159 | extern enum cmd_types cmd_type (struct cmd_list_element *cmd); |
160 | ||
161 | ||
a14ed312 KB |
162 | extern struct cmd_list_element *lookup_cmd (char **, |
163 | struct cmd_list_element *, char *, | |
164 | int, int); | |
165 | ||
166 | extern struct cmd_list_element *lookup_cmd_1 (char **, | |
167 | struct cmd_list_element *, | |
168 | struct cmd_list_element **, | |
169 | int); | |
c906108c | 170 | |
56382845 FN |
171 | extern struct cmd_list_element * |
172 | deprecate_cmd (struct cmd_list_element *, char * ); | |
173 | ||
c906108c | 174 | extern void |
56382845 FN |
175 | deprecated_cmd_warning (char **); |
176 | ||
177 | extern int | |
178 | lookup_cmd_composition (char *text, | |
179 | struct cmd_list_element **alias, | |
180 | struct cmd_list_element **prefix_cmd, | |
181 | struct cmd_list_element **cmd); | |
182 | ||
a14ed312 KB |
183 | extern struct cmd_list_element *add_com (char *, enum command_class, |
184 | void (*fun) (char *, int), char *); | |
c906108c | 185 | |
a14ed312 KB |
186 | extern struct cmd_list_element *add_com_alias (char *, char *, |
187 | enum command_class, int); | |
c906108c | 188 | |
a14ed312 KB |
189 | extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int), |
190 | char *); | |
c906108c | 191 | |
a14ed312 | 192 | extern struct cmd_list_element *add_info_alias (char *, char *, int); |
c906108c | 193 | |
a14ed312 | 194 | extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *); |
c906108c | 195 | |
53904c9e | 196 | extern char **complete_on_enum (const char *enumlist[], char *, char *); |
c906108c | 197 | |
a14ed312 | 198 | extern void delete_cmd (char *, struct cmd_list_element **); |
c906108c | 199 | |
d9fcf2fb | 200 | extern void help_cmd (char *, struct ui_file *); |
c906108c | 201 | |
d9fcf2fb JM |
202 | extern void help_list (struct cmd_list_element *, char *, |
203 | enum command_class, struct ui_file *); | |
c906108c | 204 | |
d9fcf2fb JM |
205 | extern void help_cmd_list (struct cmd_list_element *, enum command_class, |
206 | char *, int, struct ui_file *); | |
c906108c | 207 | |
b66df561 AC |
208 | /* NOTE: cagney/2005-02-21: Since every set command should be paired |
209 | with a corresponding show command (i.e., add_setshow_*) this call | |
210 | should not be needed. Unfortunatly some are not (e.g., | |
211 | "maintenance <variable> <value>") and those need to be fixed. */ | |
212 | extern struct cmd_list_element *deprecated_add_set_cmd (char *name, enum | |
213 | command_class class, | |
214 | var_types var_type, void *var, | |
215 | char *doc, | |
216 | struct cmd_list_element **list); | |
1ed2a135 | 217 | |
08546159 AC |
218 | /* Method for show a set/show variable's VALUE on FILE. If this |
219 | method isn't supplied deprecated_show_value_hack() is called (which | |
220 | is not good). */ | |
221 | typedef void (show_value_ftype) (struct ui_file *file, | |
222 | int from_tty, | |
223 | struct cmd_list_element *cmd, | |
224 | const char *value); | |
225 | /* NOTE: i18n: This function is not i18n friendly. Callers should | |
226 | instead print the value out directly. */ | |
227 | extern show_value_ftype deprecated_show_value_hack; | |
228 | ||
1b295c3d AC |
229 | extern void add_setshow_enum_cmd (char *name, |
230 | enum command_class class, | |
231 | const char *enumlist[], | |
232 | const char **var, | |
233 | const char *set_doc, | |
234 | const char *show_doc, | |
235 | const char *help_doc, | |
1b295c3d | 236 | cmd_sfunc_ftype *set_func, |
08546159 | 237 | show_value_ftype *show_func, |
1b295c3d | 238 | struct cmd_list_element **set_list, |
7376b4c2 | 239 | struct cmd_list_element **show_list); |
c906108c | 240 | |
e9e68a56 AC |
241 | extern void add_setshow_auto_boolean_cmd (char *name, |
242 | enum command_class class, | |
243 | enum auto_boolean *var, | |
3b64bf98 AC |
244 | const char *set_doc, |
245 | const char *show_doc, | |
246 | const char *help_doc, | |
e9e68a56 | 247 | cmd_sfunc_ftype *set_func, |
08546159 | 248 | show_value_ftype *show_func, |
e9e68a56 AC |
249 | struct cmd_list_element **set_list, |
250 | struct cmd_list_element **show_list); | |
97c3646f | 251 | |
e707bbc2 AC |
252 | extern void add_setshow_boolean_cmd (char *name, |
253 | enum command_class class, | |
254 | int *var, | |
3b64bf98 | 255 | const char *set_doc, const char *show_doc, |
2c5b56ce | 256 | const char *help_doc, |
e707bbc2 | 257 | cmd_sfunc_ftype *set_func, |
08546159 | 258 | show_value_ftype *show_func, |
e707bbc2 AC |
259 | struct cmd_list_element **set_list, |
260 | struct cmd_list_element **show_list); | |
f3796e26 | 261 | |
b3f42336 AC |
262 | extern void add_setshow_filename_cmd (char *name, |
263 | enum command_class class, | |
264 | char **var, | |
265 | const char *set_doc, | |
266 | const char *show_doc, | |
267 | const char *help_doc, | |
b3f42336 | 268 | cmd_sfunc_ftype *set_func, |
08546159 | 269 | show_value_ftype *show_func, |
b3f42336 AC |
270 | struct cmd_list_element **set_list, |
271 | struct cmd_list_element **show_list); | |
272 | ||
273 | extern void add_setshow_string_cmd (char *name, | |
274 | enum command_class class, | |
275 | char **var, | |
276 | const char *set_doc, | |
277 | const char *show_doc, | |
278 | const char *help_doc, | |
b3f42336 | 279 | cmd_sfunc_ftype *set_func, |
08546159 | 280 | show_value_ftype *show_func, |
b3f42336 AC |
281 | struct cmd_list_element **set_list, |
282 | struct cmd_list_element **show_list); | |
283 | ||
26c41df3 AC |
284 | extern void add_setshow_string_noescape_cmd (char *name, |
285 | enum command_class class, | |
286 | char **var, | |
287 | const char *set_doc, | |
288 | const char *show_doc, | |
289 | const char *help_doc, | |
290 | cmd_sfunc_ftype *set_func, | |
291 | show_value_ftype *show_func, | |
292 | struct cmd_list_element **set_list, | |
293 | struct cmd_list_element **show_list); | |
294 | ||
b4b4ac0b AC |
295 | extern void add_setshow_optional_filename_cmd (char *name, |
296 | enum command_class class, | |
297 | char **var, | |
298 | const char *set_doc, | |
299 | const char *show_doc, | |
300 | const char *help_doc, | |
301 | cmd_sfunc_ftype *set_func, | |
302 | show_value_ftype *show_func, | |
303 | struct cmd_list_element **set_list, | |
304 | struct cmd_list_element **show_list); | |
305 | ||
c0d88b1b AC |
306 | extern void add_setshow_integer_cmd (char *name, |
307 | enum command_class class, | |
47b667de | 308 | int *var, |
c0d88b1b AC |
309 | const char *set_doc, |
310 | const char *show_doc, | |
311 | const char *help_doc, | |
312 | cmd_sfunc_ftype *set_func, | |
313 | show_value_ftype *show_func, | |
314 | struct cmd_list_element **set_list, | |
315 | struct cmd_list_element **show_list); | |
316 | ||
25d29d70 AC |
317 | extern void add_setshow_uinteger_cmd (char *name, |
318 | enum command_class class, | |
319 | unsigned int *var, | |
3b64bf98 AC |
320 | const char *set_doc, |
321 | const char *show_doc, | |
322 | const char *help_doc, | |
15170568 | 323 | cmd_sfunc_ftype *set_func, |
08546159 | 324 | show_value_ftype *show_func, |
15170568 AC |
325 | struct cmd_list_element **set_list, |
326 | struct cmd_list_element **show_list); | |
327 | ||
328 | extern void add_setshow_zinteger_cmd (char *name, | |
329 | enum command_class class, | |
330 | int *var, | |
3b64bf98 AC |
331 | const char *set_doc, |
332 | const char *show_doc, | |
333 | const char *help_doc, | |
25d29d70 | 334 | cmd_sfunc_ftype *set_func, |
08546159 | 335 | show_value_ftype *show_func, |
25d29d70 AC |
336 | struct cmd_list_element **set_list, |
337 | struct cmd_list_element **show_list); | |
338 | ||
c906108c SS |
339 | /* Do a "show" command for each thing on a command list. */ |
340 | ||
a14ed312 | 341 | extern void cmd_show_list (struct cmd_list_element *, int, char *); |
c906108c | 342 | |
c3eb0c00 | 343 | extern NORETURN void error_no_arg (char *) ATTR_NORETURN; |
c906108c | 344 | |
a14ed312 | 345 | extern void dont_repeat (void); |
c906108c SS |
346 | |
347 | /* Used to mark commands that don't do anything. If we just leave the | |
348 | function field NULL, the command is interpreted as a help topic, or | |
349 | as a class of commands. */ | |
350 | ||
a14ed312 | 351 | extern void not_just_help_class_command (char *, int); |
c906108c | 352 | |
f436dd25 MH |
353 | /* check function pointer */ |
354 | extern int cmd_func_p (struct cmd_list_element *cmd); | |
355 | ||
356 | /* call the command function */ | |
357 | extern void cmd_func (struct cmd_list_element *cmd, char *args, int from_tty); | |
358 | ||
c906108c | 359 | #endif /* !defined (COMMAND_H) */ |