1 /* Header file for command creation.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
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
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
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.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
18 #if !defined (COMMAND_H)
21 #include "common/gdb_vecs.h"
22 #include "common/scoped_restore.h"
24 struct completion_tracker;
26 /* This file defines the public interface for any code wanting to
29 /* Command classes are top-level categories into which commands are
30 broken down for "help" purposes.
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"). */
38 /* Special args to help_list */
39 class_deprecated = -3, all_classes = -2, all_commands = -1,
40 /* Classes of commands */
41 no_class = -1, class_run = 0, class_vars, class_stack, class_files,
42 class_support, class_info, class_breakpoint, class_trace,
43 class_alias, class_bookmark, class_obscure, class_maintenance,
44 class_pseudo, class_tui, class_user, class_xdb,
45 no_set_class /* Used for "show" commands that have no corresponding
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". */
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. */
54 typedef enum cmd_types
62 /* Types of "set" or "show" command. */
63 typedef enum var_types
65 /* "on" or "off". *VAR is an integer which is nonzero for on,
69 /* "on" / "true" / "enable" or "off" / "false" / "disable" or
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
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. */
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
82 INT_MAX. The only remaining use of it is the Python API.
83 Don't use it elsewhere. */
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).
88 *VAR is a malloc'd string, or NULL if the string is empty. */
90 /* String which stores what the user types verbatim.
91 *VAR is a malloc'd string, or NULL if the string is empty. */
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
99 /* ZeroableInteger. *VAR is an int. Like var_integer except
100 that zero really means zero. */
102 /* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really
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. */
108 var_zuinteger_unlimited,
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
116 /* This structure records one command'd definition. */
117 struct cmd_list_element;
119 typedef void cmd_const_cfunc_ftype (const char *args, int from_tty);
121 /* This structure specifies notifications to be suppressed by a cli
122 command interpreter. */
124 struct cli_suppress_notification
126 /* Inferior, thread, frame selected notification suppressed? */
127 int user_selected_context;
130 extern struct cli_suppress_notification cli_suppress_notification;
132 /* Forward-declarations of the entry-points of cli/cli-decode.c. */
134 /* API to the manipulation of command lists. */
136 extern bool valid_user_defined_cmd_name_p (const char *name);
138 /* Const-correct variant of the above. */
140 extern struct cmd_list_element *add_cmd (const char *, enum command_class,
141 cmd_const_cfunc_ftype *fun,
143 struct cmd_list_element **);
145 /* Like add_cmd, but no command function is specified. */
147 extern struct cmd_list_element *add_cmd (const char *, enum command_class,
149 struct cmd_list_element **);
151 extern struct cmd_list_element *add_cmd_suppress_notification
152 (const char *name, enum command_class theclass,
153 cmd_const_cfunc_ftype *fun, const char *doc,
154 struct cmd_list_element **list,
155 int *suppress_notification);
157 extern struct cmd_list_element *add_alias_cmd (const char *, const char *,
158 enum command_class, int,
159 struct cmd_list_element **);
161 extern struct cmd_list_element *add_alias_cmd (const char *,
163 enum command_class, int,
164 struct cmd_list_element **);
167 extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class,
168 cmd_const_cfunc_ftype *fun,
170 struct cmd_list_element **,
172 struct cmd_list_element **);
174 extern struct cmd_list_element *add_prefix_cmd_suppress_notification
175 (const char *name, enum command_class theclass,
176 cmd_const_cfunc_ftype *fun,
177 const char *doc, struct cmd_list_element **prefixlist,
178 const char *prefixname, int allow_unknown,
179 struct cmd_list_element **list,
180 int *suppress_notification);
182 extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *,
184 cmd_const_cfunc_ftype *fun,
186 struct cmd_list_element
187 **, const char *, int,
188 struct cmd_list_element
191 typedef void cmd_const_sfunc_ftype (const char *args, int from_tty,
192 struct cmd_list_element *c);
193 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
194 cmd_const_sfunc_ftype *sfunc);
196 /* A completion routine. Add possible completions to tracker.
198 TEXT is the text beyond what was matched for the command itself
199 (leading whitespace is skipped). It stops where we are supposed to
200 stop completing (rl_point) and is '\0' terminated. WORD points in
201 the same buffer as TEXT, and completions should be returned
202 relative to this position. For example, suppose TEXT is "foo" and
203 we want to complete to "foobar". If WORD is "oo", return "oobar";
204 if WORD is "baz/foo", return "baz/foobar". */
205 typedef void completer_ftype (struct cmd_list_element *,
206 completion_tracker &tracker,
207 const char *text, const char *word);
209 /* Same, but for set_cmd_completer_handle_brkchars. */
210 typedef void completer_handle_brkchars_ftype (struct cmd_list_element *,
211 completion_tracker &tracker,
212 const char *text, const char *word);
214 extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *);
216 /* Set the completer_handle_brkchars callback. */
218 extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *,
219 completer_handle_brkchars_ftype *);
221 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
222 around in cmd objects to test the value of the commands sfunc(). */
223 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
224 cmd_const_cfunc_ftype *cfun);
226 /* Each command object has a local context attached to it. */
227 extern void set_cmd_context (struct cmd_list_element *cmd,
229 extern void *get_cmd_context (struct cmd_list_element *cmd);
232 /* Execute CMD's pre/post hook. Throw an error if the command fails.
233 If already executing this pre/post hook, or there is no pre/post
234 hook, the call is silently ignored. */
235 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
236 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
238 /* Return the type of the command. */
239 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
241 /* Flag for an ambiguous cmd_list result. */
242 #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
244 extern struct cmd_list_element *lookup_cmd (const char **,
245 struct cmd_list_element *,
249 extern struct cmd_list_element *lookup_cmd_1 (const char **,
250 struct cmd_list_element *,
251 struct cmd_list_element **,
254 extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
257 extern void deprecated_cmd_warning (const char *);
259 extern int lookup_cmd_composition (const char *text,
260 struct cmd_list_element **alias,
261 struct cmd_list_element **prefix_cmd,
262 struct cmd_list_element **cmd);
264 extern struct cmd_list_element *add_com (const char *, enum command_class,
265 cmd_const_cfunc_ftype *fun,
268 extern struct cmd_list_element *add_com_alias (const char *, const char *,
269 enum command_class, int);
271 extern struct cmd_list_element *add_com_suppress_notification
272 (const char *name, enum command_class theclass,
273 cmd_const_cfunc_ftype *fun, const char *doc,
274 int *supress_notification);
276 extern struct cmd_list_element *add_info (const char *,
277 cmd_const_cfunc_ftype *fun,
280 extern struct cmd_list_element *add_info_alias (const char *, const char *,
283 extern void complete_on_cmdlist (struct cmd_list_element *,
284 completion_tracker &tracker,
285 const char *, const char *, int);
287 extern void complete_on_enum (completion_tracker &tracker,
288 const char *const *enumlist,
289 const char *, const char *);
291 /* Functions that implement commands about CLI commands. */
293 extern void help_list (struct cmd_list_element *, const char *,
294 enum command_class, struct ui_file *);
296 /* Method for show a set/show variable's VALUE on FILE. If this
297 method isn't supplied deprecated_show_value_hack() is called (which
299 typedef void (show_value_ftype) (struct ui_file *file,
301 struct cmd_list_element *cmd,
303 /* NOTE: i18n: This function is not i18n friendly. Callers should
304 instead print the value out directly. */
305 extern show_value_ftype deprecated_show_value_hack;
307 extern void add_setshow_enum_cmd (const char *name,
308 enum command_class theclass,
309 const char *const *enumlist,
312 const char *show_doc,
313 const char *help_doc,
314 cmd_const_sfunc_ftype *set_func,
315 show_value_ftype *show_func,
316 struct cmd_list_element **set_list,
317 struct cmd_list_element **show_list,
318 void *context = nullptr);
320 extern void add_setshow_auto_boolean_cmd (const char *name,
321 enum command_class theclass,
322 enum auto_boolean *var,
324 const char *show_doc,
325 const char *help_doc,
326 cmd_const_sfunc_ftype *set_func,
327 show_value_ftype *show_func,
328 struct cmd_list_element **set_list,
329 struct cmd_list_element **show_list);
331 extern void add_setshow_boolean_cmd (const char *name,
332 enum command_class theclass,
334 const char *set_doc, const char *show_doc,
335 const char *help_doc,
336 cmd_const_sfunc_ftype *set_func,
337 show_value_ftype *show_func,
338 struct cmd_list_element **set_list,
339 struct cmd_list_element **show_list);
341 extern void add_setshow_filename_cmd (const char *name,
342 enum command_class theclass,
345 const char *show_doc,
346 const char *help_doc,
347 cmd_const_sfunc_ftype *set_func,
348 show_value_ftype *show_func,
349 struct cmd_list_element **set_list,
350 struct cmd_list_element **show_list);
352 extern void add_setshow_string_cmd (const char *name,
353 enum command_class theclass,
356 const char *show_doc,
357 const char *help_doc,
358 cmd_const_sfunc_ftype *set_func,
359 show_value_ftype *show_func,
360 struct cmd_list_element **set_list,
361 struct cmd_list_element **show_list);
363 extern struct cmd_list_element *add_setshow_string_noescape_cmd
365 enum command_class theclass,
368 const char *show_doc,
369 const char *help_doc,
370 cmd_const_sfunc_ftype *set_func,
371 show_value_ftype *show_func,
372 struct cmd_list_element **set_list,
373 struct cmd_list_element **show_list);
375 extern void add_setshow_optional_filename_cmd (const char *name,
376 enum command_class theclass,
379 const char *show_doc,
380 const char *help_doc,
381 cmd_const_sfunc_ftype *set_func,
382 show_value_ftype *show_func,
383 struct cmd_list_element **set_list,
384 struct cmd_list_element **show_list);
386 extern void add_setshow_integer_cmd (const char *name,
387 enum command_class theclass,
390 const char *show_doc,
391 const char *help_doc,
392 cmd_const_sfunc_ftype *set_func,
393 show_value_ftype *show_func,
394 struct cmd_list_element **set_list,
395 struct cmd_list_element **show_list);
397 extern void add_setshow_uinteger_cmd (const char *name,
398 enum command_class theclass,
401 const char *show_doc,
402 const char *help_doc,
403 cmd_const_sfunc_ftype *set_func,
404 show_value_ftype *show_func,
405 struct cmd_list_element **set_list,
406 struct cmd_list_element **show_list);
408 extern void add_setshow_zinteger_cmd (const char *name,
409 enum command_class theclass,
412 const char *show_doc,
413 const char *help_doc,
414 cmd_const_sfunc_ftype *set_func,
415 show_value_ftype *show_func,
416 struct cmd_list_element **set_list,
417 struct cmd_list_element **show_list);
419 extern void add_setshow_zuinteger_cmd (const char *name,
420 enum command_class theclass,
423 const char *show_doc,
424 const char *help_doc,
425 cmd_const_sfunc_ftype *set_func,
426 show_value_ftype *show_func,
427 struct cmd_list_element **set_list,
428 struct cmd_list_element **show_list);
431 add_setshow_zuinteger_unlimited_cmd (const char *name,
432 enum command_class theclass,
435 const char *show_doc,
436 const char *help_doc,
437 cmd_const_sfunc_ftype *set_func,
438 show_value_ftype *show_func,
439 struct cmd_list_element **set_list,
440 struct cmd_list_element **show_list);
442 /* Do a "show" command for each thing on a command list. */
444 extern void cmd_show_list (struct cmd_list_element *, int, const char *);
446 /* Used everywhere whenever at least one parameter is required and
447 none is specified. */
449 extern void error_no_arg (const char *) ATTRIBUTE_NORETURN;
452 /* Command line saving and repetition.
453 Each input line executed is saved to possibly be repeated either
454 when the user types an empty line, or be repeated by a command
455 that wants to repeat the previously executed command. The below
456 functions control command repetition. */
458 /* Commands call dont_repeat if they do not want to be repeated by null
459 lines or by repeat_previous (). */
461 extern void dont_repeat ();
463 /* Commands call repeat_previous if they want to repeat the previous command.
464 Such commands that repeat the previous command must indicate
465 to not repeat themselves, to avoid recursive repeat.
466 repeat_previous will mark the current command as not repeating,
467 and will ensure get_saved_command_line returns the previous command,
468 so that the currently executing command can repeat it. */
470 extern void repeat_previous ();
472 /* Prevent dont_repeat from working, and return a cleanup that
473 restores the previous state. */
475 extern scoped_restore_tmpl<int> prevent_dont_repeat (void);
477 /* Set the arguments that will be passed if the current command is
478 repeated. Note that the passed-in string must be a constant. */
480 extern void set_repeat_arguments (const char *args);
482 /* Returns the saved command line to repeat.
483 When a command is being executed, this is the currently executing
484 command line, unless the currently executing command has called
485 repeat_previous (): in this case, get_saved_command_line returns
486 the previously saved command line. */
488 extern char *get_saved_command_line ();
490 /* Takes a copy of CMD, for possible repetition. */
492 extern void save_command_line (const char *cmd);
494 /* Used to mark commands that don't do anything. If we just leave the
495 function field NULL, the command is interpreted as a help topic, or
496 as a class of commands. */
498 extern void not_just_help_class_command (const char *, int);
500 /* Check function pointer. */
501 extern int cmd_func_p (struct cmd_list_element *cmd);
503 /* Call the command function. */
504 extern void cmd_func (struct cmd_list_element *cmd,
505 const char *args, int from_tty);
507 #endif /* !defined (COMMAND_H) */