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 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 | ||
4034d0ff AT |
118 | /* This structure specifies notifications to be suppressed by a cli |
119 | command interpreter. */ | |
120 | ||
121 | struct cli_suppress_notification | |
122 | { | |
123 | /* Inferior, thread, frame selected notification suppressed? */ | |
124 | int user_selected_context; | |
125 | }; | |
126 | ||
127 | extern struct cli_suppress_notification cli_suppress_notification; | |
128 | ||
18d5d590 | 129 | /* Forward-declarations of the entry-points of cli/cli-decode.c. */ |
c906108c | 130 | |
50aeff07 PA |
131 | /* API to the manipulation of command lists. */ |
132 | ||
5a56e9c5 DE |
133 | extern int valid_user_defined_cmd_name_p (const char *name); |
134 | ||
6f937416 | 135 | extern struct cmd_list_element *add_cmd (const char *, enum command_class, |
82ae6c8d | 136 | cmd_cfunc_ftype *fun, |
1947513d | 137 | const char *, |
a14ed312 KB |
138 | struct cmd_list_element **); |
139 | ||
6f937416 | 140 | extern struct cmd_list_element *add_alias_cmd (const char *, const char *, |
a14ed312 KB |
141 | enum command_class, int, |
142 | struct cmd_list_element **); | |
143 | ||
21873064 YQ |
144 | extern struct cmd_list_element *add_alias_cmd (const char *, |
145 | cmd_list_element *, | |
146 | enum command_class, int, | |
147 | struct cmd_list_element **); | |
148 | ||
149 | ||
6f937416 | 150 | extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class, |
82ae6c8d | 151 | cmd_cfunc_ftype *fun, |
1947513d | 152 | const char *, |
a14ed312 | 153 | struct cmd_list_element **, |
64e61d29 | 154 | const char *, int, |
a14ed312 KB |
155 | struct cmd_list_element **); |
156 | ||
6f937416 | 157 | extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *, |
a14ed312 | 158 | enum command_class, |
82ae6c8d | 159 | cmd_cfunc_ftype *fun, |
1947513d | 160 | const char *, |
a14ed312 | 161 | struct cmd_list_element |
64e61d29 | 162 | **, const char *, int, |
a14ed312 KB |
163 | struct cmd_list_element |
164 | **); | |
165 | ||
9f60d481 AC |
166 | /* Set the commands corresponding callback. */ |
167 | ||
168 | extern void set_cmd_cfunc (struct cmd_list_element *cmd, | |
9773a94b | 169 | cmd_cfunc_ftype *cfunc); |
9f60d481 | 170 | |
9773a94b AC |
171 | typedef void cmd_sfunc_ftype (char *args, int from_tty, |
172 | struct cmd_list_element *c); | |
9f60d481 | 173 | extern void set_cmd_sfunc (struct cmd_list_element *cmd, |
9773a94b | 174 | cmd_sfunc_ftype *sfunc); |
9f60d481 | 175 | |
49c4e619 | 176 | typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *, |
6f937416 | 177 | const char *, const char *); |
625e8578 | 178 | |
7d793aa9 SDJ |
179 | typedef void completer_ftype_void (struct cmd_list_element *, |
180 | const char *, const char *); | |
181 | ||
625e8578 | 182 | extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *); |
5ba2abeb | 183 | |
7d793aa9 SDJ |
184 | /* Set the completer_handle_brkchars callback. */ |
185 | ||
186 | extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *, | |
187 | completer_ftype_void *); | |
188 | ||
bbaca940 AC |
189 | /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs |
190 | around in cmd objects to test the value of the commands sfunc(). */ | |
191 | extern int cmd_cfunc_eq (struct cmd_list_element *cmd, | |
82ae6c8d | 192 | cmd_cfunc_ftype *cfun); |
9f60d481 | 193 | |
ebcd3b23 | 194 | /* Each command object has a local context attached to it. */ |
aff410f1 MS |
195 | extern void set_cmd_context (struct cmd_list_element *cmd, |
196 | void *context); | |
7d0766f3 AC |
197 | extern void *get_cmd_context (struct cmd_list_element *cmd); |
198 | ||
199 | ||
5913bcb0 AC |
200 | /* Execute CMD's pre/post hook. Throw an error if the command fails. |
201 | If already executing this pre/post hook, or there is no pre/post | |
202 | hook, the call is silently ignored. */ | |
203 | extern void execute_cmd_pre_hook (struct cmd_list_element *cmd); | |
204 | extern void execute_cmd_post_hook (struct cmd_list_element *cmd); | |
205 | ||
1868c04e | 206 | /* Return the type of the command. */ |
1868c04e AC |
207 | extern enum cmd_types cmd_type (struct cmd_list_element *cmd); |
208 | ||
50aeff07 PA |
209 | /* Flag for an ambiguous cmd_list result. */ |
210 | #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1) | |
1868c04e | 211 | |
6f937416 | 212 | extern struct cmd_list_element *lookup_cmd (const char **, |
a121b7c1 PA |
213 | struct cmd_list_element *, |
214 | const char *, | |
a14ed312 KB |
215 | int, int); |
216 | ||
6f937416 | 217 | extern struct cmd_list_element *lookup_cmd_1 (const char **, |
a14ed312 KB |
218 | struct cmd_list_element *, |
219 | struct cmd_list_element **, | |
220 | int); | |
c906108c | 221 | |
aff410f1 | 222 | extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *, |
429e55ea | 223 | const char * ); |
56382845 | 224 | |
6f937416 | 225 | extern void deprecated_cmd_warning (const char *); |
56382845 | 226 | |
6f937416 | 227 | extern int lookup_cmd_composition (const char *text, |
aff410f1 MS |
228 | struct cmd_list_element **alias, |
229 | struct cmd_list_element **prefix_cmd, | |
230 | struct cmd_list_element **cmd); | |
56382845 | 231 | |
6f937416 | 232 | extern struct cmd_list_element *add_com (const char *, enum command_class, |
82ae6c8d | 233 | cmd_cfunc_ftype *fun, |
1947513d | 234 | const char *); |
c906108c | 235 | |
6f937416 | 236 | extern struct cmd_list_element *add_com_alias (const char *, const char *, |
a14ed312 | 237 | enum command_class, int); |
c906108c | 238 | |
4034d0ff AT |
239 | extern struct cmd_list_element *add_com_suppress_notification |
240 | (const char *name, enum command_class theclass, | |
241 | cmd_cfunc_ftype *fun, const char *doc, | |
242 | int *supress_notification); | |
243 | ||
6f937416 | 244 | extern struct cmd_list_element *add_info (const char *, |
82ae6c8d | 245 | cmd_cfunc_ftype *fun, |
1947513d | 246 | const char *); |
c906108c | 247 | |
1947513d TT |
248 | extern struct cmd_list_element *add_info_alias (const char *, const char *, |
249 | int); | |
c906108c | 250 | |
49c4e619 | 251 | extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *, |
6f937416 | 252 | const char *, const char *, int); |
c906108c | 253 | |
49c4e619 | 254 | extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist, |
6f937416 | 255 | const char *, const char *); |
c906108c | 256 | |
50aeff07 | 257 | /* Functions that implement commands about CLI commands. */ |
c906108c | 258 | |
64e61d29 | 259 | extern void help_list (struct cmd_list_element *, const char *, |
d9fcf2fb | 260 | enum command_class, struct ui_file *); |
c906108c | 261 | |
08546159 AC |
262 | /* Method for show a set/show variable's VALUE on FILE. If this |
263 | method isn't supplied deprecated_show_value_hack() is called (which | |
264 | is not good). */ | |
265 | typedef void (show_value_ftype) (struct ui_file *file, | |
266 | int from_tty, | |
267 | struct cmd_list_element *cmd, | |
268 | const char *value); | |
269 | /* NOTE: i18n: This function is not i18n friendly. Callers should | |
270 | instead print the value out directly. */ | |
271 | extern show_value_ftype deprecated_show_value_hack; | |
272 | ||
6f937416 | 273 | extern void add_setshow_enum_cmd (const char *name, |
fe978cb0 | 274 | enum command_class theclass, |
40478521 | 275 | const char *const *enumlist, |
1b295c3d AC |
276 | const char **var, |
277 | const char *set_doc, | |
278 | const char *show_doc, | |
279 | const char *help_doc, | |
1b295c3d | 280 | cmd_sfunc_ftype *set_func, |
08546159 | 281 | show_value_ftype *show_func, |
1b295c3d | 282 | struct cmd_list_element **set_list, |
7376b4c2 | 283 | struct cmd_list_element **show_list); |
c906108c | 284 | |
6f937416 | 285 | extern void add_setshow_auto_boolean_cmd (const char *name, |
fe978cb0 | 286 | enum command_class theclass, |
e9e68a56 | 287 | enum auto_boolean *var, |
3b64bf98 AC |
288 | const char *set_doc, |
289 | const char *show_doc, | |
290 | const char *help_doc, | |
e9e68a56 | 291 | cmd_sfunc_ftype *set_func, |
08546159 | 292 | show_value_ftype *show_func, |
e9e68a56 AC |
293 | struct cmd_list_element **set_list, |
294 | struct cmd_list_element **show_list); | |
97c3646f | 295 | |
6f937416 | 296 | extern void add_setshow_boolean_cmd (const char *name, |
fe978cb0 | 297 | enum command_class theclass, |
e707bbc2 | 298 | int *var, |
3b64bf98 | 299 | const char *set_doc, const char *show_doc, |
2c5b56ce | 300 | const char *help_doc, |
e707bbc2 | 301 | cmd_sfunc_ftype *set_func, |
08546159 | 302 | show_value_ftype *show_func, |
e707bbc2 AC |
303 | struct cmd_list_element **set_list, |
304 | struct cmd_list_element **show_list); | |
f3796e26 | 305 | |
6f937416 | 306 | extern void add_setshow_filename_cmd (const char *name, |
fe978cb0 | 307 | enum command_class theclass, |
b3f42336 AC |
308 | char **var, |
309 | const char *set_doc, | |
310 | const char *show_doc, | |
311 | const char *help_doc, | |
b3f42336 | 312 | cmd_sfunc_ftype *set_func, |
08546159 | 313 | show_value_ftype *show_func, |
b3f42336 AC |
314 | struct cmd_list_element **set_list, |
315 | struct cmd_list_element **show_list); | |
316 | ||
6f937416 | 317 | extern void add_setshow_string_cmd (const char *name, |
fe978cb0 | 318 | enum command_class theclass, |
5efd5804 PA |
319 | char **var, |
320 | const char *set_doc, | |
321 | const char *show_doc, | |
322 | const char *help_doc, | |
323 | cmd_sfunc_ftype *set_func, | |
324 | show_value_ftype *show_func, | |
325 | struct cmd_list_element **set_list, | |
326 | struct cmd_list_element **show_list); | |
327 | ||
44478ab3 | 328 | extern struct cmd_list_element *add_setshow_string_noescape_cmd |
6f937416 | 329 | (const char *name, |
fe978cb0 | 330 | enum command_class theclass, |
44478ab3 TT |
331 | char **var, |
332 | const char *set_doc, | |
333 | const char *show_doc, | |
334 | const char *help_doc, | |
335 | cmd_sfunc_ftype *set_func, | |
336 | show_value_ftype *show_func, | |
337 | struct cmd_list_element **set_list, | |
338 | struct cmd_list_element **show_list); | |
26c41df3 | 339 | |
6f937416 | 340 | extern void add_setshow_optional_filename_cmd (const char *name, |
fe978cb0 | 341 | enum command_class theclass, |
b4b4ac0b AC |
342 | char **var, |
343 | const char *set_doc, | |
344 | const char *show_doc, | |
345 | const char *help_doc, | |
346 | cmd_sfunc_ftype *set_func, | |
347 | show_value_ftype *show_func, | |
348 | struct cmd_list_element **set_list, | |
349 | struct cmd_list_element **show_list); | |
350 | ||
6f937416 | 351 | extern void add_setshow_integer_cmd (const char *name, |
fe978cb0 | 352 | enum command_class theclass, |
5efd5804 PA |
353 | int *var, |
354 | const char *set_doc, | |
355 | const char *show_doc, | |
356 | const char *help_doc, | |
357 | cmd_sfunc_ftype *set_func, | |
358 | show_value_ftype *show_func, | |
359 | struct cmd_list_element **set_list, | |
360 | struct cmd_list_element **show_list); | |
c0d88b1b | 361 | |
6f937416 | 362 | extern void add_setshow_uinteger_cmd (const char *name, |
fe978cb0 | 363 | enum command_class theclass, |
5efd5804 PA |
364 | unsigned int *var, |
365 | const char *set_doc, | |
366 | const char *show_doc, | |
367 | const char *help_doc, | |
368 | cmd_sfunc_ftype *set_func, | |
369 | show_value_ftype *show_func, | |
370 | struct cmd_list_element **set_list, | |
371 | struct cmd_list_element **show_list); | |
15170568 | 372 | |
6f937416 | 373 | extern void add_setshow_zinteger_cmd (const char *name, |
fe978cb0 | 374 | enum command_class theclass, |
5efd5804 PA |
375 | int *var, |
376 | const char *set_doc, | |
377 | const char *show_doc, | |
378 | const char *help_doc, | |
379 | cmd_sfunc_ftype *set_func, | |
380 | show_value_ftype *show_func, | |
381 | struct cmd_list_element **set_list, | |
382 | struct cmd_list_element **show_list); | |
25d29d70 | 383 | |
6f937416 | 384 | extern void add_setshow_zuinteger_cmd (const char *name, |
fe978cb0 | 385 | enum command_class theclass, |
5efd5804 PA |
386 | unsigned int *var, |
387 | const char *set_doc, | |
388 | const char *show_doc, | |
389 | const char *help_doc, | |
6fc1c773 YQ |
390 | cmd_sfunc_ftype *set_func, |
391 | show_value_ftype *show_func, | |
392 | struct cmd_list_element **set_list, | |
393 | struct cmd_list_element **show_list); | |
394 | ||
395 | extern void | |
6f937416 | 396 | add_setshow_zuinteger_unlimited_cmd (const char *name, |
fe978cb0 | 397 | enum command_class theclass, |
b69b1fb1 | 398 | int *var, |
6fc1c773 YQ |
399 | const char *set_doc, |
400 | const char *show_doc, | |
401 | const char *help_doc, | |
5efd5804 PA |
402 | cmd_sfunc_ftype *set_func, |
403 | show_value_ftype *show_func, | |
404 | struct cmd_list_element **set_list, | |
405 | struct cmd_list_element **show_list); | |
1e8fb976 | 406 | |
c906108c SS |
407 | /* Do a "show" command for each thing on a command list. */ |
408 | ||
64e61d29 | 409 | extern void cmd_show_list (struct cmd_list_element *, int, const char *); |
c906108c | 410 | |
c25c4a8b | 411 | /* Used everywhere whenever at least one parameter is required and |
ebcd3b23 | 412 | none is specified. */ |
c25c4a8b | 413 | |
5b10184c | 414 | extern void error_no_arg (const char *) ATTRIBUTE_NORETURN; |
c906108c | 415 | |
a14ed312 | 416 | extern void dont_repeat (void); |
c906108c | 417 | |
1ac32117 | 418 | extern scoped_restore_tmpl<int> prevent_dont_repeat (void); |
47a80e90 | 419 | |
c906108c SS |
420 | /* Used to mark commands that don't do anything. If we just leave the |
421 | function field NULL, the command is interpreted as a help topic, or | |
422 | as a class of commands. */ | |
423 | ||
a14ed312 | 424 | extern void not_just_help_class_command (char *, int); |
c906108c | 425 | |
aff410f1 | 426 | /* Check function pointer. */ |
f436dd25 MH |
427 | extern int cmd_func_p (struct cmd_list_element *cmd); |
428 | ||
aff410f1 MS |
429 | /* Call the command function. */ |
430 | extern void cmd_func (struct cmd_list_element *cmd, | |
431 | char *args, int from_tty); | |
f436dd25 | 432 | |
c906108c | 433 | #endif /* !defined (COMMAND_H) */ |