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