Commit | Line | Data |
---|---|---|
50aeff07 | 1 | /* Header file for command creation. |
18a642a1 | 2 | |
ecd75fc8 | 3 | Copyright (C) 1986-2014 Free Software Foundation, Inc. |
c906108c | 4 | |
c5aa993b JM |
5 | This program is free software; you can redistribute it and/or modify |
6 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 7 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 8 | (at your option) any later version. |
c906108c | 9 | |
c5aa993b JM |
10 | This program is distributed in the hope that it will be useful, |
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | GNU General Public License for more details. | |
c906108c | 14 | |
c5aa993b | 15 | You should have received a copy of the GNU General Public License |
a9762ec7 | 16 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
17 | |
18 | #if !defined (COMMAND_H) | |
19 | #define COMMAND_H 1 | |
20 | ||
49c4e619 TT |
21 | #include "gdb_vecs.h" |
22 | ||
50aeff07 PA |
23 | /* This file defines the public interface for any code wanting to |
24 | create commands. */ | |
25 | ||
aff410f1 MS |
26 | /* Command classes are top-level categories into which commands are |
27 | broken down for "help" purposes. | |
28 | ||
6426a772 JM |
29 | Notes on classes: class_alias is for alias commands which are not |
30 | abbreviations of the original command. class-pseudo is for | |
31 | commands which are not really commands nor help topics ("stop"). */ | |
32 | ||
33 | enum command_class | |
34 | { | |
35 | /* Special args to help_list */ | |
6e381ba0 | 36 | class_deprecated = -3, all_classes = -2, all_commands = -1, |
6426a772 | 37 | /* Classes of commands */ |
aff410f1 MS |
38 | no_class = -1, class_run = 0, class_vars, class_stack, class_files, |
39 | class_support, class_info, class_breakpoint, class_trace, | |
6b04bdb7 | 40 | class_alias, class_bookmark, class_obscure, class_maintenance, |
db5f229b MS |
41 | class_pseudo, class_tui, class_user, class_xdb, |
42 | no_set_class /* Used for "show" commands that have no corresponding | |
43 | "set" command. */ | |
6426a772 JM |
44 | }; |
45 | ||
18a642a1 AC |
46 | /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum |
47 | cmd_types'' can be moved from "command.h" to "cli-decode.h". */ | |
c906108c SS |
48 | /* Not a set/show command. Note that some commands which begin with |
49 | "set" or "show" might be in this category, if their syntax does | |
50 | not fall into one of the following categories. */ | |
c5aa993b JM |
51 | typedef enum cmd_types |
52 | { | |
53 | not_set_cmd, | |
54 | set_cmd, | |
55 | show_cmd | |
56 | } | |
57 | cmd_types; | |
c906108c SS |
58 | |
59 | /* Types of "set" or "show" command. */ | |
c5aa993b JM |
60 | typedef enum var_types |
61 | { | |
62 | /* "on" or "off". *VAR is an integer which is nonzero for on, | |
63 | zero for off. */ | |
64 | var_boolean, | |
97c3646f AC |
65 | |
66 | /* "on" / "true" / "enable" or "off" / "false" / "disable" or | |
7f19b9a2 AC |
67 | "auto. *VAR is an ``enum auto_boolean''. NOTE: In general a |
68 | custom show command will need to be implemented - one that for | |
69 | "auto" prints both the "auto" and the current auto-selected | |
ebcd3b23 | 70 | value. */ |
97c3646f AC |
71 | var_auto_boolean, |
72 | ||
aff410f1 MS |
73 | /* Unsigned Integer. *VAR is an unsigned int. The user can type |
74 | 0 to mean "unlimited", which is stored in *VAR as UINT_MAX. */ | |
c5aa993b JM |
75 | var_uinteger, |
76 | ||
aff410f1 MS |
77 | /* Like var_uinteger but signed. *VAR is an int. The user can |
78 | type 0 to mean "unlimited", which is stored in *VAR as | |
6fc1c773 YQ |
79 | INT_MAX. The only remaining use of it is the Python API. |
80 | Don't use it elsewhere. */ | |
c5aa993b JM |
81 | var_integer, |
82 | ||
aff410f1 MS |
83 | /* String which the user enters with escapes (e.g. the user types |
84 | \n and it is a real newline in the stored string). | |
c5aa993b JM |
85 | *VAR is a malloc'd string, or NULL if the string is empty. */ |
86 | var_string, | |
87 | /* String which stores what the user types verbatim. | |
88 | *VAR is a malloc'd string, or NULL if the string is empty. */ | |
89 | var_string_noescape, | |
b4b4ac0b AC |
90 | /* String which stores a filename. (*VAR) is a malloc'd string, |
91 | or "" if the string was empty. */ | |
92 | var_optional_filename, | |
93 | /* String which stores a filename. (*VAR) is a malloc'd | |
94 | string. */ | |
c5aa993b | 95 | var_filename, |
a7c3d162 | 96 | /* ZeroableInteger. *VAR is an int. Like var_integer except |
c5aa993b JM |
97 | that zero really means zero. */ |
98 | var_zinteger, | |
1e8fb976 PA |
99 | /* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really |
100 | means zero. */ | |
101 | var_zuinteger, | |
b69b1fb1 YQ |
102 | /* ZeroableUnsignedInteger with unlimited value. *VAR is an int, |
103 | but its range is [0, INT_MAX]. -1 stands for unlimited and | |
104 | other negative numbers are not allowed. */ | |
6fc1c773 | 105 | var_zuinteger_unlimited, |
aff410f1 MS |
106 | /* Enumerated type. Can only have one of the specified values. |
107 | *VAR is a char pointer to the name of the element that we | |
108 | find. */ | |
c5aa993b JM |
109 | var_enum |
110 | } | |
111 | var_types; | |
c906108c SS |
112 | |
113 | /* This structure records one command'd definition. */ | |
18a642a1 | 114 | struct cmd_list_element; |
c906108c | 115 | |
82ae6c8d TT |
116 | typedef void cmd_cfunc_ftype (char *args, int from_tty); |
117 | ||
18d5d590 | 118 | /* Forward-declarations of the entry-points of cli/cli-decode.c. */ |
c906108c | 119 | |
50aeff07 PA |
120 | /* API to the manipulation of command lists. */ |
121 | ||
5a56e9c5 DE |
122 | extern int valid_user_defined_cmd_name_p (const char *name); |
123 | ||
6f937416 | 124 | extern struct cmd_list_element *add_cmd (const char *, enum command_class, |
82ae6c8d | 125 | cmd_cfunc_ftype *fun, |
1947513d | 126 | const char *, |
a14ed312 KB |
127 | struct cmd_list_element **); |
128 | ||
6f937416 | 129 | extern struct cmd_list_element *add_alias_cmd (const char *, const char *, |
a14ed312 KB |
130 | enum command_class, int, |
131 | struct cmd_list_element **); | |
132 | ||
6f937416 | 133 | extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class, |
82ae6c8d | 134 | cmd_cfunc_ftype *fun, |
1947513d | 135 | const char *, |
a14ed312 | 136 | struct cmd_list_element **, |
64e61d29 | 137 | const char *, int, |
a14ed312 KB |
138 | struct cmd_list_element **); |
139 | ||
6f937416 | 140 | extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *, |
a14ed312 | 141 | enum command_class, |
82ae6c8d | 142 | cmd_cfunc_ftype *fun, |
1947513d | 143 | const char *, |
a14ed312 | 144 | struct cmd_list_element |
64e61d29 | 145 | **, const char *, int, |
a14ed312 KB |
146 | struct cmd_list_element |
147 | **); | |
148 | ||
9f60d481 AC |
149 | /* Set the commands corresponding callback. */ |
150 | ||
151 | extern void set_cmd_cfunc (struct cmd_list_element *cmd, | |
9773a94b | 152 | cmd_cfunc_ftype *cfunc); |
9f60d481 | 153 | |
9773a94b AC |
154 | typedef void cmd_sfunc_ftype (char *args, int from_tty, |
155 | struct cmd_list_element *c); | |
9f60d481 | 156 | extern void set_cmd_sfunc (struct cmd_list_element *cmd, |
9773a94b | 157 | cmd_sfunc_ftype *sfunc); |
9f60d481 | 158 | |
49c4e619 | 159 | typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *, |
6f937416 | 160 | const char *, const char *); |
625e8578 TT |
161 | |
162 | extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *); | |
5ba2abeb | 163 | |
bbaca940 AC |
164 | /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs |
165 | around in cmd objects to test the value of the commands sfunc(). */ | |
166 | extern int cmd_cfunc_eq (struct cmd_list_element *cmd, | |
82ae6c8d | 167 | cmd_cfunc_ftype *cfun); |
9f60d481 | 168 | |
ebcd3b23 | 169 | /* Each command object has a local context attached to it. */ |
aff410f1 MS |
170 | extern void set_cmd_context (struct cmd_list_element *cmd, |
171 | void *context); | |
7d0766f3 AC |
172 | extern void *get_cmd_context (struct cmd_list_element *cmd); |
173 | ||
174 | ||
5913bcb0 AC |
175 | /* Execute CMD's pre/post hook. Throw an error if the command fails. |
176 | If already executing this pre/post hook, or there is no pre/post | |
177 | hook, the call is silently ignored. */ | |
178 | extern void execute_cmd_pre_hook (struct cmd_list_element *cmd); | |
179 | extern void execute_cmd_post_hook (struct cmd_list_element *cmd); | |
180 | ||
1868c04e | 181 | /* Return the type of the command. */ |
1868c04e AC |
182 | extern enum cmd_types cmd_type (struct cmd_list_element *cmd); |
183 | ||
50aeff07 PA |
184 | /* Flag for an ambiguous cmd_list result. */ |
185 | #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1) | |
1868c04e | 186 | |
6f937416 | 187 | extern struct cmd_list_element *lookup_cmd (const char **, |
a14ed312 KB |
188 | struct cmd_list_element *, char *, |
189 | int, int); | |
190 | ||
6f937416 | 191 | extern struct cmd_list_element *lookup_cmd_1 (const char **, |
a14ed312 KB |
192 | struct cmd_list_element *, |
193 | struct cmd_list_element **, | |
194 | int); | |
c906108c | 195 | |
aff410f1 | 196 | extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *, |
429e55ea | 197 | const char * ); |
56382845 | 198 | |
6f937416 | 199 | extern void deprecated_cmd_warning (const char *); |
56382845 | 200 | |
6f937416 | 201 | extern int lookup_cmd_composition (const char *text, |
aff410f1 MS |
202 | struct cmd_list_element **alias, |
203 | struct cmd_list_element **prefix_cmd, | |
204 | struct cmd_list_element **cmd); | |
56382845 | 205 | |
6f937416 | 206 | extern struct cmd_list_element *add_com (const char *, enum command_class, |
82ae6c8d | 207 | cmd_cfunc_ftype *fun, |
1947513d | 208 | const char *); |
c906108c | 209 | |
6f937416 | 210 | extern struct cmd_list_element *add_com_alias (const char *, const char *, |
a14ed312 | 211 | enum command_class, int); |
c906108c | 212 | |
6f937416 | 213 | extern struct cmd_list_element *add_info (const char *, |
82ae6c8d | 214 | cmd_cfunc_ftype *fun, |
1947513d | 215 | const char *); |
c906108c | 216 | |
1947513d TT |
217 | extern struct cmd_list_element *add_info_alias (const char *, const char *, |
218 | int); | |
c906108c | 219 | |
49c4e619 | 220 | extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *, |
6f937416 | 221 | const char *, const char *, int); |
c906108c | 222 | |
49c4e619 | 223 | extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist, |
6f937416 | 224 | const char *, const char *); |
c906108c | 225 | |
50aeff07 | 226 | /* Functions that implement commands about CLI commands. */ |
c906108c | 227 | |
64e61d29 | 228 | extern void help_list (struct cmd_list_element *, const char *, |
d9fcf2fb | 229 | enum command_class, struct ui_file *); |
c906108c | 230 | |
08546159 AC |
231 | /* Method for show a set/show variable's VALUE on FILE. If this |
232 | method isn't supplied deprecated_show_value_hack() is called (which | |
233 | is not good). */ | |
234 | typedef void (show_value_ftype) (struct ui_file *file, | |
235 | int from_tty, | |
236 | struct cmd_list_element *cmd, | |
237 | const char *value); | |
238 | /* NOTE: i18n: This function is not i18n friendly. Callers should | |
239 | instead print the value out directly. */ | |
240 | extern show_value_ftype deprecated_show_value_hack; | |
241 | ||
6f937416 | 242 | extern void add_setshow_enum_cmd (const char *name, |
1b295c3d | 243 | enum command_class class, |
40478521 | 244 | const char *const *enumlist, |
1b295c3d AC |
245 | const char **var, |
246 | const char *set_doc, | |
247 | const char *show_doc, | |
248 | const char *help_doc, | |
1b295c3d | 249 | cmd_sfunc_ftype *set_func, |
08546159 | 250 | show_value_ftype *show_func, |
1b295c3d | 251 | struct cmd_list_element **set_list, |
7376b4c2 | 252 | struct cmd_list_element **show_list); |
c906108c | 253 | |
6f937416 | 254 | extern void add_setshow_auto_boolean_cmd (const char *name, |
e9e68a56 AC |
255 | enum command_class class, |
256 | enum auto_boolean *var, | |
3b64bf98 AC |
257 | const char *set_doc, |
258 | const char *show_doc, | |
259 | const char *help_doc, | |
e9e68a56 | 260 | cmd_sfunc_ftype *set_func, |
08546159 | 261 | show_value_ftype *show_func, |
e9e68a56 AC |
262 | struct cmd_list_element **set_list, |
263 | struct cmd_list_element **show_list); | |
97c3646f | 264 | |
6f937416 | 265 | extern void add_setshow_boolean_cmd (const char *name, |
e707bbc2 AC |
266 | enum command_class class, |
267 | int *var, | |
3b64bf98 | 268 | const char *set_doc, const char *show_doc, |
2c5b56ce | 269 | const char *help_doc, |
e707bbc2 | 270 | cmd_sfunc_ftype *set_func, |
08546159 | 271 | show_value_ftype *show_func, |
e707bbc2 AC |
272 | struct cmd_list_element **set_list, |
273 | struct cmd_list_element **show_list); | |
f3796e26 | 274 | |
6f937416 | 275 | extern void add_setshow_filename_cmd (const char *name, |
b3f42336 AC |
276 | enum command_class class, |
277 | char **var, | |
278 | const char *set_doc, | |
279 | const char *show_doc, | |
280 | const char *help_doc, | |
b3f42336 | 281 | cmd_sfunc_ftype *set_func, |
08546159 | 282 | show_value_ftype *show_func, |
b3f42336 AC |
283 | struct cmd_list_element **set_list, |
284 | struct cmd_list_element **show_list); | |
285 | ||
6f937416 | 286 | extern void add_setshow_string_cmd (const char *name, |
5efd5804 PA |
287 | enum command_class class, |
288 | char **var, | |
289 | const char *set_doc, | |
290 | const char *show_doc, | |
291 | const char *help_doc, | |
292 | cmd_sfunc_ftype *set_func, | |
293 | show_value_ftype *show_func, | |
294 | struct cmd_list_element **set_list, | |
295 | struct cmd_list_element **show_list); | |
296 | ||
44478ab3 | 297 | extern struct cmd_list_element *add_setshow_string_noescape_cmd |
6f937416 | 298 | (const char *name, |
44478ab3 TT |
299 | enum command_class class, |
300 | char **var, | |
301 | const char *set_doc, | |
302 | const char *show_doc, | |
303 | const char *help_doc, | |
304 | cmd_sfunc_ftype *set_func, | |
305 | show_value_ftype *show_func, | |
306 | struct cmd_list_element **set_list, | |
307 | struct cmd_list_element **show_list); | |
26c41df3 | 308 | |
6f937416 | 309 | extern void add_setshow_optional_filename_cmd (const char *name, |
b4b4ac0b AC |
310 | enum command_class class, |
311 | char **var, | |
312 | const char *set_doc, | |
313 | const char *show_doc, | |
314 | const char *help_doc, | |
315 | cmd_sfunc_ftype *set_func, | |
316 | show_value_ftype *show_func, | |
317 | struct cmd_list_element **set_list, | |
318 | struct cmd_list_element **show_list); | |
319 | ||
6f937416 | 320 | extern void add_setshow_integer_cmd (const char *name, |
5efd5804 PA |
321 | enum command_class class, |
322 | int *var, | |
323 | const char *set_doc, | |
324 | const char *show_doc, | |
325 | const char *help_doc, | |
326 | cmd_sfunc_ftype *set_func, | |
327 | show_value_ftype *show_func, | |
328 | struct cmd_list_element **set_list, | |
329 | struct cmd_list_element **show_list); | |
c0d88b1b | 330 | |
6f937416 | 331 | extern void add_setshow_uinteger_cmd (const char *name, |
5efd5804 PA |
332 | enum command_class class, |
333 | unsigned int *var, | |
334 | const char *set_doc, | |
335 | const char *show_doc, | |
336 | const char *help_doc, | |
337 | cmd_sfunc_ftype *set_func, | |
338 | show_value_ftype *show_func, | |
339 | struct cmd_list_element **set_list, | |
340 | struct cmd_list_element **show_list); | |
15170568 | 341 | |
6f937416 | 342 | extern void add_setshow_zinteger_cmd (const char *name, |
5efd5804 PA |
343 | enum command_class class, |
344 | int *var, | |
345 | const char *set_doc, | |
346 | const char *show_doc, | |
347 | const char *help_doc, | |
348 | cmd_sfunc_ftype *set_func, | |
349 | show_value_ftype *show_func, | |
350 | struct cmd_list_element **set_list, | |
351 | struct cmd_list_element **show_list); | |
25d29d70 | 352 | |
6f937416 | 353 | extern void add_setshow_zuinteger_cmd (const char *name, |
5efd5804 PA |
354 | enum command_class class, |
355 | unsigned int *var, | |
356 | const char *set_doc, | |
357 | const char *show_doc, | |
358 | const char *help_doc, | |
6fc1c773 YQ |
359 | cmd_sfunc_ftype *set_func, |
360 | show_value_ftype *show_func, | |
361 | struct cmd_list_element **set_list, | |
362 | struct cmd_list_element **show_list); | |
363 | ||
364 | extern void | |
6f937416 | 365 | add_setshow_zuinteger_unlimited_cmd (const char *name, |
6fc1c773 | 366 | enum command_class class, |
b69b1fb1 | 367 | int *var, |
6fc1c773 YQ |
368 | const char *set_doc, |
369 | const char *show_doc, | |
370 | const char *help_doc, | |
5efd5804 PA |
371 | cmd_sfunc_ftype *set_func, |
372 | show_value_ftype *show_func, | |
373 | struct cmd_list_element **set_list, | |
374 | struct cmd_list_element **show_list); | |
1e8fb976 | 375 | |
c906108c SS |
376 | /* Do a "show" command for each thing on a command list. */ |
377 | ||
64e61d29 | 378 | extern void cmd_show_list (struct cmd_list_element *, int, const char *); |
c906108c | 379 | |
c25c4a8b | 380 | /* Used everywhere whenever at least one parameter is required and |
ebcd3b23 | 381 | none is specified. */ |
c25c4a8b | 382 | |
5b10184c | 383 | extern void error_no_arg (const char *) ATTRIBUTE_NORETURN; |
c906108c | 384 | |
a14ed312 | 385 | extern void dont_repeat (void); |
c906108c | 386 | |
47a80e90 TT |
387 | extern struct cleanup *prevent_dont_repeat (void); |
388 | ||
c906108c SS |
389 | /* Used to mark commands that don't do anything. If we just leave the |
390 | function field NULL, the command is interpreted as a help topic, or | |
391 | as a class of commands. */ | |
392 | ||
a14ed312 | 393 | extern void not_just_help_class_command (char *, int); |
c906108c | 394 | |
aff410f1 | 395 | /* Check function pointer. */ |
f436dd25 MH |
396 | extern int cmd_func_p (struct cmd_list_element *cmd); |
397 | ||
aff410f1 MS |
398 | /* Call the command function. */ |
399 | extern void cmd_func (struct cmd_list_element *cmd, | |
400 | char *args, int from_tty); | |
f436dd25 | 401 | |
c906108c | 402 | #endif /* !defined (COMMAND_H) */ |