Commit | Line | Data |
---|---|---|
50aeff07 | 1 | /* Header file for command creation. |
18a642a1 | 2 | |
b811d2c2 | 3 | Copyright (C) 1986-2020 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 | ||
268a13a5 TT |
21 | #include "gdbsupport/gdb_vecs.h" |
22 | #include "gdbsupport/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 | { | |
491144b5 CB |
65 | /* "on" or "off". *VAR is a bool which is true for on, |
66 | false for off. */ | |
c5aa993b | 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 | |
0450cc4c | 119 | typedef void cmd_const_cfunc_ftype (const char *args, int from_tty); |
82ae6c8d | 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 | ||
be09caf1 PW |
136 | /* Return TRUE if NAME is a valid user-defined command name. |
137 | This is a stricter subset of all gdb commands, | |
138 | see find_command_name_length. */ | |
139 | ||
7f008c9e | 140 | extern bool valid_user_defined_cmd_name_p (const char *name); |
5a56e9c5 | 141 | |
be09caf1 PW |
142 | /* Return TRUE if C is a valid command character. */ |
143 | ||
144 | extern bool valid_cmd_char_p (int c); | |
145 | ||
0450cc4c TT |
146 | /* Const-correct variant of the above. */ |
147 | ||
148 | extern struct cmd_list_element *add_cmd (const char *, enum command_class, | |
149 | cmd_const_cfunc_ftype *fun, | |
150 | const char *, | |
151 | struct cmd_list_element **); | |
152 | ||
153 | /* Like add_cmd, but no command function is specified. */ | |
154 | ||
155 | extern struct cmd_list_element *add_cmd (const char *, enum command_class, | |
156 | const char *, | |
157 | struct cmd_list_element **); | |
158 | ||
f67ffa6a AB |
159 | extern struct cmd_list_element *add_cmd_suppress_notification |
160 | (const char *name, enum command_class theclass, | |
161 | cmd_const_cfunc_ftype *fun, const char *doc, | |
162 | struct cmd_list_element **list, | |
163 | int *suppress_notification); | |
164 | ||
6f937416 | 165 | extern struct cmd_list_element *add_alias_cmd (const char *, const char *, |
a14ed312 KB |
166 | enum command_class, int, |
167 | struct cmd_list_element **); | |
168 | ||
21873064 YQ |
169 | extern struct cmd_list_element *add_alias_cmd (const char *, |
170 | cmd_list_element *, | |
171 | enum command_class, int, | |
172 | struct cmd_list_element **); | |
173 | ||
174 | ||
6f937416 | 175 | extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class, |
981a3fb3 | 176 | cmd_const_cfunc_ftype *fun, |
1947513d | 177 | const char *, |
a14ed312 | 178 | struct cmd_list_element **, |
64e61d29 | 179 | const char *, int, |
a14ed312 KB |
180 | struct cmd_list_element **); |
181 | ||
0743fc83 TT |
182 | /* Like add_prefix_cmd, but sets the callback to a function that |
183 | simply calls help_list. */ | |
184 | ||
185 | extern struct cmd_list_element *add_basic_prefix_cmd | |
186 | (const char *, enum command_class, const char *, struct cmd_list_element **, | |
187 | const char *, int, struct cmd_list_element **); | |
188 | ||
189 | /* Like add_prefix_cmd, but useful for "show" prefixes. This sets the | |
190 | callback to a function that simply calls cmd_show_list. */ | |
191 | ||
192 | extern struct cmd_list_element *add_show_prefix_cmd | |
193 | (const char *, enum command_class, const char *, struct cmd_list_element **, | |
194 | const char *, int, struct cmd_list_element **); | |
195 | ||
f67ffa6a AB |
196 | extern struct cmd_list_element *add_prefix_cmd_suppress_notification |
197 | (const char *name, enum command_class theclass, | |
198 | cmd_const_cfunc_ftype *fun, | |
199 | const char *doc, struct cmd_list_element **prefixlist, | |
200 | const char *prefixname, int allow_unknown, | |
201 | struct cmd_list_element **list, | |
202 | int *suppress_notification); | |
203 | ||
6f937416 | 204 | extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *, |
a14ed312 | 205 | enum command_class, |
ee7ddd71 | 206 | cmd_const_cfunc_ftype *fun, |
1947513d | 207 | const char *, |
a14ed312 | 208 | struct cmd_list_element |
64e61d29 | 209 | **, const char *, int, |
a14ed312 KB |
210 | struct cmd_list_element |
211 | **); | |
212 | ||
eb4c3f4a TT |
213 | typedef void cmd_const_sfunc_ftype (const char *args, int from_tty, |
214 | struct cmd_list_element *c); | |
9f60d481 | 215 | extern void set_cmd_sfunc (struct cmd_list_element *cmd, |
eb4c3f4a | 216 | cmd_const_sfunc_ftype *sfunc); |
9f60d481 | 217 | |
eb3ff9a5 | 218 | /* A completion routine. Add possible completions to tracker. |
6e1dbf8c PA |
219 | |
220 | TEXT is the text beyond what was matched for the command itself | |
221 | (leading whitespace is skipped). It stops where we are supposed to | |
222 | stop completing (rl_point) and is '\0' terminated. WORD points in | |
223 | the same buffer as TEXT, and completions should be returned | |
224 | relative to this position. For example, suppose TEXT is "foo" and | |
225 | we want to complete to "foobar". If WORD is "oo", return "oobar"; | |
226 | if WORD is "baz/foo", return "baz/foobar". */ | |
eb3ff9a5 PA |
227 | typedef void completer_ftype (struct cmd_list_element *, |
228 | completion_tracker &tracker, | |
229 | const char *text, const char *word); | |
625e8578 | 230 | |
6e1dbf8c PA |
231 | /* Same, but for set_cmd_completer_handle_brkchars. */ |
232 | typedef void completer_handle_brkchars_ftype (struct cmd_list_element *, | |
eb3ff9a5 | 233 | completion_tracker &tracker, |
6e1dbf8c | 234 | const char *text, const char *word); |
7d793aa9 | 235 | |
625e8578 | 236 | extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *); |
5ba2abeb | 237 | |
7d793aa9 SDJ |
238 | /* Set the completer_handle_brkchars callback. */ |
239 | ||
240 | extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *, | |
6e1dbf8c | 241 | completer_handle_brkchars_ftype *); |
7d793aa9 | 242 | |
bbaca940 AC |
243 | /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs |
244 | around in cmd objects to test the value of the commands sfunc(). */ | |
0450cc4c TT |
245 | extern int cmd_cfunc_eq (struct cmd_list_element *cmd, |
246 | cmd_const_cfunc_ftype *cfun); | |
9f60d481 | 247 | |
ebcd3b23 | 248 | /* Each command object has a local context attached to it. */ |
aff410f1 MS |
249 | extern void set_cmd_context (struct cmd_list_element *cmd, |
250 | void *context); | |
7d0766f3 AC |
251 | extern void *get_cmd_context (struct cmd_list_element *cmd); |
252 | ||
253 | ||
5913bcb0 AC |
254 | /* Execute CMD's pre/post hook. Throw an error if the command fails. |
255 | If already executing this pre/post hook, or there is no pre/post | |
256 | hook, the call is silently ignored. */ | |
257 | extern void execute_cmd_pre_hook (struct cmd_list_element *cmd); | |
258 | extern void execute_cmd_post_hook (struct cmd_list_element *cmd); | |
259 | ||
1868c04e | 260 | /* Return the type of the command. */ |
1868c04e AC |
261 | extern enum cmd_types cmd_type (struct cmd_list_element *cmd); |
262 | ||
50aeff07 PA |
263 | /* Flag for an ambiguous cmd_list result. */ |
264 | #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1) | |
1868c04e | 265 | |
6f937416 | 266 | extern struct cmd_list_element *lookup_cmd (const char **, |
a121b7c1 PA |
267 | struct cmd_list_element *, |
268 | const char *, | |
a14ed312 KB |
269 | int, int); |
270 | ||
6f937416 | 271 | extern struct cmd_list_element *lookup_cmd_1 (const char **, |
a14ed312 KB |
272 | struct cmd_list_element *, |
273 | struct cmd_list_element **, | |
274 | int); | |
c906108c | 275 | |
aff410f1 | 276 | extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *, |
429e55ea | 277 | const char * ); |
56382845 | 278 | |
6f937416 | 279 | extern void deprecated_cmd_warning (const char *); |
56382845 | 280 | |
6f937416 | 281 | extern int lookup_cmd_composition (const char *text, |
aff410f1 MS |
282 | struct cmd_list_element **alias, |
283 | struct cmd_list_element **prefix_cmd, | |
284 | struct cmd_list_element **cmd); | |
56382845 | 285 | |
6f937416 | 286 | extern struct cmd_list_element *add_com (const char *, enum command_class, |
0b39b52e | 287 | cmd_const_cfunc_ftype *fun, |
1947513d | 288 | const char *); |
c906108c | 289 | |
6f937416 | 290 | extern struct cmd_list_element *add_com_alias (const char *, const char *, |
a14ed312 | 291 | enum command_class, int); |
c906108c | 292 | |
4034d0ff AT |
293 | extern struct cmd_list_element *add_com_suppress_notification |
294 | (const char *name, enum command_class theclass, | |
1ee870c5 | 295 | cmd_const_cfunc_ftype *fun, const char *doc, |
4034d0ff AT |
296 | int *supress_notification); |
297 | ||
6f937416 | 298 | extern struct cmd_list_element *add_info (const char *, |
1d12d88f | 299 | cmd_const_cfunc_ftype *fun, |
1947513d | 300 | const char *); |
c906108c | 301 | |
1947513d TT |
302 | extern struct cmd_list_element *add_info_alias (const char *, const char *, |
303 | int); | |
c906108c | 304 | |
eb3ff9a5 PA |
305 | extern void complete_on_cmdlist (struct cmd_list_element *, |
306 | completion_tracker &tracker, | |
307 | const char *, const char *, int); | |
c906108c | 308 | |
eb3ff9a5 PA |
309 | extern void complete_on_enum (completion_tracker &tracker, |
310 | const char *const *enumlist, | |
311 | const char *, const char *); | |
c906108c | 312 | |
50aeff07 | 313 | /* Functions that implement commands about CLI commands. */ |
c906108c | 314 | |
64e61d29 | 315 | extern void help_list (struct cmd_list_element *, const char *, |
d9fcf2fb | 316 | enum command_class, struct ui_file *); |
c906108c | 317 | |
08546159 AC |
318 | /* Method for show a set/show variable's VALUE on FILE. If this |
319 | method isn't supplied deprecated_show_value_hack() is called (which | |
320 | is not good). */ | |
321 | typedef void (show_value_ftype) (struct ui_file *file, | |
322 | int from_tty, | |
323 | struct cmd_list_element *cmd, | |
324 | const char *value); | |
325 | /* NOTE: i18n: This function is not i18n friendly. Callers should | |
326 | instead print the value out directly. */ | |
327 | extern show_value_ftype deprecated_show_value_hack; | |
328 | ||
6f937416 | 329 | extern void add_setshow_enum_cmd (const char *name, |
fe978cb0 | 330 | enum command_class theclass, |
40478521 | 331 | const char *const *enumlist, |
1b295c3d AC |
332 | const char **var, |
333 | const char *set_doc, | |
334 | const char *show_doc, | |
335 | const char *help_doc, | |
eb4c3f4a | 336 | cmd_const_sfunc_ftype *set_func, |
08546159 | 337 | show_value_ftype *show_func, |
1b295c3d | 338 | struct cmd_list_element **set_list, |
7170dadf TT |
339 | struct cmd_list_element **show_list, |
340 | void *context = nullptr); | |
c906108c | 341 | |
6f937416 | 342 | extern void add_setshow_auto_boolean_cmd (const char *name, |
fe978cb0 | 343 | enum command_class theclass, |
e9e68a56 | 344 | enum auto_boolean *var, |
3b64bf98 AC |
345 | const char *set_doc, |
346 | const char *show_doc, | |
347 | const char *help_doc, | |
eb4c3f4a | 348 | cmd_const_sfunc_ftype *set_func, |
08546159 | 349 | show_value_ftype *show_func, |
e9e68a56 AC |
350 | struct cmd_list_element **set_list, |
351 | struct cmd_list_element **show_list); | |
97c3646f | 352 | |
2daf894e PA |
353 | extern cmd_list_element * |
354 | add_setshow_boolean_cmd (const char *name, | |
355 | enum command_class theclass, | |
491144b5 | 356 | bool *var, |
2daf894e PA |
357 | const char *set_doc, const char *show_doc, |
358 | const char *help_doc, | |
359 | cmd_const_sfunc_ftype *set_func, | |
360 | show_value_ftype *show_func, | |
361 | struct cmd_list_element **set_list, | |
362 | struct cmd_list_element **show_list); | |
f3796e26 | 363 | |
6f937416 | 364 | extern void add_setshow_filename_cmd (const char *name, |
fe978cb0 | 365 | enum command_class theclass, |
b3f42336 AC |
366 | char **var, |
367 | const char *set_doc, | |
368 | const char *show_doc, | |
369 | const char *help_doc, | |
eb4c3f4a | 370 | cmd_const_sfunc_ftype *set_func, |
08546159 | 371 | show_value_ftype *show_func, |
b3f42336 AC |
372 | struct cmd_list_element **set_list, |
373 | struct cmd_list_element **show_list); | |
374 | ||
6f937416 | 375 | extern void add_setshow_string_cmd (const char *name, |
fe978cb0 | 376 | enum command_class theclass, |
5efd5804 PA |
377 | char **var, |
378 | const char *set_doc, | |
379 | const char *show_doc, | |
380 | const char *help_doc, | |
eb4c3f4a | 381 | cmd_const_sfunc_ftype *set_func, |
5efd5804 PA |
382 | show_value_ftype *show_func, |
383 | struct cmd_list_element **set_list, | |
384 | struct cmd_list_element **show_list); | |
385 | ||
44478ab3 | 386 | extern struct cmd_list_element *add_setshow_string_noescape_cmd |
6f937416 | 387 | (const char *name, |
fe978cb0 | 388 | enum command_class theclass, |
44478ab3 TT |
389 | char **var, |
390 | const char *set_doc, | |
391 | const char *show_doc, | |
392 | const char *help_doc, | |
eb4c3f4a | 393 | cmd_const_sfunc_ftype *set_func, |
44478ab3 TT |
394 | show_value_ftype *show_func, |
395 | struct cmd_list_element **set_list, | |
396 | struct cmd_list_element **show_list); | |
26c41df3 | 397 | |
6f937416 | 398 | extern void add_setshow_optional_filename_cmd (const char *name, |
fe978cb0 | 399 | enum command_class theclass, |
b4b4ac0b AC |
400 | char **var, |
401 | const char *set_doc, | |
402 | const char *show_doc, | |
403 | const char *help_doc, | |
eb4c3f4a | 404 | cmd_const_sfunc_ftype *set_func, |
b4b4ac0b AC |
405 | show_value_ftype *show_func, |
406 | struct cmd_list_element **set_list, | |
407 | struct cmd_list_element **show_list); | |
408 | ||
6f937416 | 409 | extern void add_setshow_integer_cmd (const char *name, |
fe978cb0 | 410 | enum command_class theclass, |
5efd5804 PA |
411 | int *var, |
412 | const char *set_doc, | |
413 | const char *show_doc, | |
414 | const char *help_doc, | |
eb4c3f4a | 415 | cmd_const_sfunc_ftype *set_func, |
5efd5804 PA |
416 | show_value_ftype *show_func, |
417 | struct cmd_list_element **set_list, | |
418 | struct cmd_list_element **show_list); | |
c0d88b1b | 419 | |
6f937416 | 420 | extern void add_setshow_uinteger_cmd (const char *name, |
fe978cb0 | 421 | enum command_class theclass, |
5efd5804 PA |
422 | unsigned int *var, |
423 | const char *set_doc, | |
424 | const char *show_doc, | |
425 | const char *help_doc, | |
eb4c3f4a | 426 | cmd_const_sfunc_ftype *set_func, |
5efd5804 PA |
427 | show_value_ftype *show_func, |
428 | struct cmd_list_element **set_list, | |
429 | struct cmd_list_element **show_list); | |
15170568 | 430 | |
6f937416 | 431 | extern void add_setshow_zinteger_cmd (const char *name, |
fe978cb0 | 432 | enum command_class theclass, |
5efd5804 PA |
433 | int *var, |
434 | const char *set_doc, | |
435 | const char *show_doc, | |
436 | const char *help_doc, | |
eb4c3f4a | 437 | cmd_const_sfunc_ftype *set_func, |
5efd5804 PA |
438 | show_value_ftype *show_func, |
439 | struct cmd_list_element **set_list, | |
440 | struct cmd_list_element **show_list); | |
25d29d70 | 441 | |
6f937416 | 442 | extern void add_setshow_zuinteger_cmd (const char *name, |
fe978cb0 | 443 | enum command_class theclass, |
5efd5804 PA |
444 | unsigned int *var, |
445 | const char *set_doc, | |
446 | const char *show_doc, | |
447 | const char *help_doc, | |
eb4c3f4a | 448 | cmd_const_sfunc_ftype *set_func, |
6fc1c773 YQ |
449 | show_value_ftype *show_func, |
450 | struct cmd_list_element **set_list, | |
451 | struct cmd_list_element **show_list); | |
452 | ||
453 | extern void | |
6f937416 | 454 | add_setshow_zuinteger_unlimited_cmd (const char *name, |
fe978cb0 | 455 | enum command_class theclass, |
b69b1fb1 | 456 | int *var, |
6fc1c773 YQ |
457 | const char *set_doc, |
458 | const char *show_doc, | |
459 | const char *help_doc, | |
eb4c3f4a | 460 | cmd_const_sfunc_ftype *set_func, |
5efd5804 PA |
461 | show_value_ftype *show_func, |
462 | struct cmd_list_element **set_list, | |
463 | struct cmd_list_element **show_list); | |
1e8fb976 | 464 | |
c906108c SS |
465 | /* Do a "show" command for each thing on a command list. */ |
466 | ||
64e61d29 | 467 | extern void cmd_show_list (struct cmd_list_element *, int, const char *); |
c906108c | 468 | |
c25c4a8b | 469 | /* Used everywhere whenever at least one parameter is required and |
ebcd3b23 | 470 | none is specified. */ |
c25c4a8b | 471 | |
5b10184c | 472 | extern void error_no_arg (const char *) ATTRIBUTE_NORETURN; |
c906108c | 473 | |
68bb5386 PW |
474 | |
475 | /* Command line saving and repetition. | |
476 | Each input line executed is saved to possibly be repeated either | |
477 | when the user types an empty line, or be repeated by a command | |
478 | that wants to repeat the previously executed command. The below | |
479 | functions control command repetition. */ | |
480 | ||
481 | /* Commands call dont_repeat if they do not want to be repeated by null | |
482 | lines or by repeat_previous (). */ | |
483 | ||
484 | extern void dont_repeat (); | |
485 | ||
fdbc9870 PA |
486 | /* Commands call repeat_previous if they want to repeat the previous |
487 | command. Such commands that repeat the previous command must | |
488 | indicate to not repeat themselves, to avoid recursive repeat. | |
489 | repeat_previous marks the current command as not repeating, and | |
490 | ensures get_saved_command_line returns the previous command, so | |
491 | that the currently executing command can repeat it. If there's no | |
492 | previous command, throws an error. Otherwise, returns the result | |
493 | of get_saved_command_line, which now points at the command to | |
494 | repeat. */ | |
495 | ||
496 | extern const char *repeat_previous (); | |
68bb5386 PW |
497 | |
498 | /* Prevent dont_repeat from working, and return a cleanup that | |
499 | restores the previous state. */ | |
c906108c | 500 | |
1ac32117 | 501 | extern scoped_restore_tmpl<int> prevent_dont_repeat (void); |
47a80e90 | 502 | |
85c4be7c TT |
503 | /* Set the arguments that will be passed if the current command is |
504 | repeated. Note that the passed-in string must be a constant. */ | |
505 | ||
506 | extern void set_repeat_arguments (const char *args); | |
507 | ||
68bb5386 PW |
508 | /* Returns the saved command line to repeat. |
509 | When a command is being executed, this is the currently executing | |
510 | command line, unless the currently executing command has called | |
511 | repeat_previous (): in this case, get_saved_command_line returns | |
512 | the previously saved command line. */ | |
513 | ||
514 | extern char *get_saved_command_line (); | |
515 | ||
516 | /* Takes a copy of CMD, for possible repetition. */ | |
517 | ||
518 | extern void save_command_line (const char *cmd); | |
519 | ||
c906108c SS |
520 | /* Used to mark commands that don't do anything. If we just leave the |
521 | function field NULL, the command is interpreted as a help topic, or | |
522 | as a class of commands. */ | |
523 | ||
eb7c454d | 524 | extern void not_just_help_class_command (const char *, int); |
c906108c | 525 | |
aff410f1 | 526 | /* Check function pointer. */ |
f436dd25 MH |
527 | extern int cmd_func_p (struct cmd_list_element *cmd); |
528 | ||
aff410f1 MS |
529 | /* Call the command function. */ |
530 | extern void cmd_func (struct cmd_list_element *cmd, | |
95a6b0a1 | 531 | const char *args, int from_tty); |
f436dd25 | 532 | |
c906108c | 533 | #endif /* !defined (COMMAND_H) */ |