1 /* Header file for command creation.
3 Copyright (C) 1986-2017 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)
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_cfunc_ftype (char *args, int from_tty);
120 typedef void cmd_const_cfunc_ftype (const char *args, int from_tty);
122 /* This structure specifies notifications to be suppressed by a cli
123 command interpreter. */
125 struct cli_suppress_notification
127 /* Inferior, thread, frame selected notification suppressed? */
128 int user_selected_context;
131 extern struct cli_suppress_notification cli_suppress_notification;
133 /* Forward-declarations of the entry-points of cli/cli-decode.c. */
135 /* API to the manipulation of command lists. */
137 extern int valid_user_defined_cmd_name_p (const char *name);
139 extern struct cmd_list_element *add_cmd (const char *, enum command_class,
140 cmd_cfunc_ftype *fun,
142 struct cmd_list_element **);
144 /* Const-correct variant of the above. */
146 extern struct cmd_list_element *add_cmd (const char *, enum command_class,
147 cmd_const_cfunc_ftype *fun,
149 struct cmd_list_element **);
151 /* Like add_cmd, but no command function is specified. */
153 extern struct cmd_list_element *add_cmd (const char *, enum command_class,
155 struct cmd_list_element **);
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_abbrev_prefix_cmd (const char *,
176 cmd_const_cfunc_ftype *fun,
178 struct cmd_list_element
179 **, const char *, int,
180 struct cmd_list_element
183 /* Set the commands corresponding callback. */
185 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
186 cmd_cfunc_ftype *cfunc);
188 /* Const-correct variant of the above. */
190 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
191 cmd_const_cfunc_ftype *cfunc);
193 typedef void cmd_sfunc_ftype (char *args, int from_tty,
194 struct cmd_list_element *c);
195 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
196 cmd_sfunc_ftype *sfunc);
198 /* A completion routine. Add possible completions to tracker.
200 TEXT is the text beyond what was matched for the command itself
201 (leading whitespace is skipped). It stops where we are supposed to
202 stop completing (rl_point) and is '\0' terminated. WORD points in
203 the same buffer as TEXT, and completions should be returned
204 relative to this position. For example, suppose TEXT is "foo" and
205 we want to complete to "foobar". If WORD is "oo", return "oobar";
206 if WORD is "baz/foo", return "baz/foobar". */
207 typedef void completer_ftype (struct cmd_list_element *,
208 completion_tracker &tracker,
209 const char *text, const char *word);
211 /* Same, but for set_cmd_completer_handle_brkchars. */
212 typedef void completer_handle_brkchars_ftype (struct cmd_list_element *,
213 completion_tracker &tracker,
214 const char *text, const char *word);
216 extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *);
218 /* Set the completer_handle_brkchars callback. */
220 extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *,
221 completer_handle_brkchars_ftype *);
223 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
224 around in cmd objects to test the value of the commands sfunc(). */
225 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
226 cmd_cfunc_ftype *cfun);
227 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
228 cmd_const_cfunc_ftype *cfun);
230 /* Each command object has a local context attached to it. */
231 extern void set_cmd_context (struct cmd_list_element *cmd,
233 extern void *get_cmd_context (struct cmd_list_element *cmd);
236 /* Execute CMD's pre/post hook. Throw an error if the command fails.
237 If already executing this pre/post hook, or there is no pre/post
238 hook, the call is silently ignored. */
239 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
240 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
242 /* Return the type of the command. */
243 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
245 /* Flag for an ambiguous cmd_list result. */
246 #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
248 extern struct cmd_list_element *lookup_cmd (const char **,
249 struct cmd_list_element *,
253 extern struct cmd_list_element *lookup_cmd_1 (const char **,
254 struct cmd_list_element *,
255 struct cmd_list_element **,
258 extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
261 extern void deprecated_cmd_warning (const char *);
263 extern int lookup_cmd_composition (const char *text,
264 struct cmd_list_element **alias,
265 struct cmd_list_element **prefix_cmd,
266 struct cmd_list_element **cmd);
268 extern struct cmd_list_element *add_com (const char *, enum command_class,
269 cmd_cfunc_ftype *fun,
272 extern struct cmd_list_element *add_com_alias (const char *, const char *,
273 enum command_class, int);
275 extern struct cmd_list_element *add_com_suppress_notification
276 (const char *name, enum command_class theclass,
277 cmd_cfunc_ftype *fun, const char *doc,
278 int *supress_notification);
280 extern struct cmd_list_element *add_info (const char *,
281 cmd_cfunc_ftype *fun,
284 extern struct cmd_list_element *add_info_alias (const char *, const char *,
287 extern void complete_on_cmdlist (struct cmd_list_element *,
288 completion_tracker &tracker,
289 const char *, const char *, int);
291 extern void complete_on_enum (completion_tracker &tracker,
292 const char *const *enumlist,
293 const char *, const char *);
295 /* Functions that implement commands about CLI commands. */
297 extern void help_list (struct cmd_list_element *, const char *,
298 enum command_class, struct ui_file *);
300 /* Method for show a set/show variable's VALUE on FILE. If this
301 method isn't supplied deprecated_show_value_hack() is called (which
303 typedef void (show_value_ftype) (struct ui_file *file,
305 struct cmd_list_element *cmd,
307 /* NOTE: i18n: This function is not i18n friendly. Callers should
308 instead print the value out directly. */
309 extern show_value_ftype deprecated_show_value_hack;
311 extern void add_setshow_enum_cmd (const char *name,
312 enum command_class theclass,
313 const char *const *enumlist,
316 const char *show_doc,
317 const char *help_doc,
318 cmd_sfunc_ftype *set_func,
319 show_value_ftype *show_func,
320 struct cmd_list_element **set_list,
321 struct cmd_list_element **show_list);
323 extern void add_setshow_auto_boolean_cmd (const char *name,
324 enum command_class theclass,
325 enum auto_boolean *var,
327 const char *show_doc,
328 const char *help_doc,
329 cmd_sfunc_ftype *set_func,
330 show_value_ftype *show_func,
331 struct cmd_list_element **set_list,
332 struct cmd_list_element **show_list);
334 extern void add_setshow_boolean_cmd (const char *name,
335 enum command_class theclass,
337 const char *set_doc, const char *show_doc,
338 const char *help_doc,
339 cmd_sfunc_ftype *set_func,
340 show_value_ftype *show_func,
341 struct cmd_list_element **set_list,
342 struct cmd_list_element **show_list);
344 extern void add_setshow_filename_cmd (const char *name,
345 enum command_class theclass,
348 const char *show_doc,
349 const char *help_doc,
350 cmd_sfunc_ftype *set_func,
351 show_value_ftype *show_func,
352 struct cmd_list_element **set_list,
353 struct cmd_list_element **show_list);
355 extern void add_setshow_string_cmd (const char *name,
356 enum command_class theclass,
359 const char *show_doc,
360 const char *help_doc,
361 cmd_sfunc_ftype *set_func,
362 show_value_ftype *show_func,
363 struct cmd_list_element **set_list,
364 struct cmd_list_element **show_list);
366 extern struct cmd_list_element *add_setshow_string_noescape_cmd
368 enum command_class theclass,
371 const char *show_doc,
372 const char *help_doc,
373 cmd_sfunc_ftype *set_func,
374 show_value_ftype *show_func,
375 struct cmd_list_element **set_list,
376 struct cmd_list_element **show_list);
378 extern void add_setshow_optional_filename_cmd (const char *name,
379 enum command_class theclass,
382 const char *show_doc,
383 const char *help_doc,
384 cmd_sfunc_ftype *set_func,
385 show_value_ftype *show_func,
386 struct cmd_list_element **set_list,
387 struct cmd_list_element **show_list);
389 extern void add_setshow_integer_cmd (const char *name,
390 enum command_class theclass,
393 const char *show_doc,
394 const char *help_doc,
395 cmd_sfunc_ftype *set_func,
396 show_value_ftype *show_func,
397 struct cmd_list_element **set_list,
398 struct cmd_list_element **show_list);
400 extern void add_setshow_uinteger_cmd (const char *name,
401 enum command_class theclass,
404 const char *show_doc,
405 const char *help_doc,
406 cmd_sfunc_ftype *set_func,
407 show_value_ftype *show_func,
408 struct cmd_list_element **set_list,
409 struct cmd_list_element **show_list);
411 extern void add_setshow_zinteger_cmd (const char *name,
412 enum command_class theclass,
415 const char *show_doc,
416 const char *help_doc,
417 cmd_sfunc_ftype *set_func,
418 show_value_ftype *show_func,
419 struct cmd_list_element **set_list,
420 struct cmd_list_element **show_list);
422 extern void add_setshow_zuinteger_cmd (const char *name,
423 enum command_class theclass,
426 const char *show_doc,
427 const char *help_doc,
428 cmd_sfunc_ftype *set_func,
429 show_value_ftype *show_func,
430 struct cmd_list_element **set_list,
431 struct cmd_list_element **show_list);
434 add_setshow_zuinteger_unlimited_cmd (const char *name,
435 enum command_class theclass,
438 const char *show_doc,
439 const char *help_doc,
440 cmd_sfunc_ftype *set_func,
441 show_value_ftype *show_func,
442 struct cmd_list_element **set_list,
443 struct cmd_list_element **show_list);
445 /* Do a "show" command for each thing on a command list. */
447 extern void cmd_show_list (struct cmd_list_element *, int, const char *);
449 /* Used everywhere whenever at least one parameter is required and
450 none is specified. */
452 extern void error_no_arg (const char *) ATTRIBUTE_NORETURN;
454 extern void dont_repeat (void);
456 extern scoped_restore_tmpl<int> prevent_dont_repeat (void);
458 /* Used to mark commands that don't do anything. If we just leave the
459 function field NULL, the command is interpreted as a help topic, or
460 as a class of commands. */
462 extern void not_just_help_class_command (const char *, int);
464 /* Check function pointer. */
465 extern int cmd_func_p (struct cmd_list_element *cmd);
467 /* Call the command function. */
468 extern void cmd_func (struct cmd_list_element *cmd,
469 char *args, int from_tty);
471 #endif /* !defined (COMMAND_H) */