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)
23 /* This file defines the public interface for any code wanting to
26 /* Command classes are top-level categories into which commands are
27 broken down for "help" purposes.
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"). */
35 /* Special args to help_list */
36 class_deprecated = -3, all_classes = -2, all_commands = -1,
37 /* Classes of commands */
38 no_class = -1, class_run = 0, class_vars, class_stack, class_files,
39 class_support, class_info, class_breakpoint, class_trace,
40 class_alias, class_bookmark, class_obscure, class_maintenance,
41 class_pseudo, class_tui, class_user, class_xdb,
42 no_set_class /* Used for "show" commands that have no corresponding
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". */
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. */
51 typedef enum cmd_types
59 /* Types of "set" or "show" command. */
60 typedef enum var_types
62 /* "on" or "off". *VAR is an integer which is nonzero for on,
66 /* "on" / "true" / "enable" or "off" / "false" / "disable" or
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
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. */
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
79 INT_MAX. The only remaining use of it is the Python API.
80 Don't use it elsewhere. */
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).
85 *VAR is a malloc'd string, or NULL if the string is empty. */
87 /* String which stores what the user types verbatim.
88 *VAR is a malloc'd string, or NULL if the string is empty. */
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
96 /* ZeroableInteger. *VAR is an int. Like var_integer except
97 that zero really means zero. */
99 /* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really
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. */
105 var_zuinteger_unlimited,
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
113 /* This structure records one command'd definition. */
114 struct cmd_list_element;
116 typedef void cmd_cfunc_ftype (char *args, int from_tty);
118 /* This structure specifies notifications to be suppressed by a cli
119 command interpreter. */
121 struct cli_suppress_notification
123 /* Inferior, thread, frame selected notification suppressed? */
124 int user_selected_context;
127 extern struct cli_suppress_notification cli_suppress_notification;
129 /* Forward-declarations of the entry-points of cli/cli-decode.c. */
131 /* API to the manipulation of command lists. */
133 extern int valid_user_defined_cmd_name_p (const char *name);
135 extern struct cmd_list_element *add_cmd (const char *, enum command_class,
136 cmd_cfunc_ftype *fun,
138 struct cmd_list_element **);
140 extern struct cmd_list_element *add_alias_cmd (const char *, const char *,
141 enum command_class, int,
142 struct cmd_list_element **);
144 extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class,
145 cmd_cfunc_ftype *fun,
147 struct cmd_list_element **,
149 struct cmd_list_element **);
151 extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *,
153 cmd_cfunc_ftype *fun,
155 struct cmd_list_element
156 **, const char *, int,
157 struct cmd_list_element
160 /* Set the commands corresponding callback. */
162 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
163 cmd_cfunc_ftype *cfunc);
165 typedef void cmd_sfunc_ftype (char *args, int from_tty,
166 struct cmd_list_element *c);
167 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
168 cmd_sfunc_ftype *sfunc);
170 typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *,
171 const char *, const char *);
173 typedef void completer_ftype_void (struct cmd_list_element *,
174 const char *, const char *);
176 extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *);
178 /* Set the completer_handle_brkchars callback. */
180 extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *,
181 completer_ftype_void *);
183 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
184 around in cmd objects to test the value of the commands sfunc(). */
185 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
186 cmd_cfunc_ftype *cfun);
188 /* Each command object has a local context attached to it. */
189 extern void set_cmd_context (struct cmd_list_element *cmd,
191 extern void *get_cmd_context (struct cmd_list_element *cmd);
194 /* Execute CMD's pre/post hook. Throw an error if the command fails.
195 If already executing this pre/post hook, or there is no pre/post
196 hook, the call is silently ignored. */
197 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
198 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
200 /* Return the type of the command. */
201 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
203 /* Flag for an ambiguous cmd_list result. */
204 #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
206 extern struct cmd_list_element *lookup_cmd (const char **,
207 struct cmd_list_element *, char *,
210 extern struct cmd_list_element *lookup_cmd_1 (const char **,
211 struct cmd_list_element *,
212 struct cmd_list_element **,
215 extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
218 extern void deprecated_cmd_warning (const char *);
220 extern int lookup_cmd_composition (const char *text,
221 struct cmd_list_element **alias,
222 struct cmd_list_element **prefix_cmd,
223 struct cmd_list_element **cmd);
225 extern struct cmd_list_element *add_com (const char *, enum command_class,
226 cmd_cfunc_ftype *fun,
229 extern struct cmd_list_element *add_com_alias (const char *, const char *,
230 enum command_class, int);
232 extern struct cmd_list_element *add_com_suppress_notification
233 (const char *name, enum command_class theclass,
234 cmd_cfunc_ftype *fun, const char *doc,
235 int *supress_notification);
237 extern struct cmd_list_element *add_info (const char *,
238 cmd_cfunc_ftype *fun,
241 extern struct cmd_list_element *add_info_alias (const char *, const char *,
244 extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *,
245 const char *, const char *, int);
247 extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist,
248 const char *, const char *);
250 /* Functions that implement commands about CLI commands. */
252 extern void help_list (struct cmd_list_element *, const char *,
253 enum command_class, struct ui_file *);
255 /* Method for show a set/show variable's VALUE on FILE. If this
256 method isn't supplied deprecated_show_value_hack() is called (which
258 typedef void (show_value_ftype) (struct ui_file *file,
260 struct cmd_list_element *cmd,
262 /* NOTE: i18n: This function is not i18n friendly. Callers should
263 instead print the value out directly. */
264 extern show_value_ftype deprecated_show_value_hack;
266 extern void add_setshow_enum_cmd (const char *name,
267 enum command_class theclass,
268 const char *const *enumlist,
271 const char *show_doc,
272 const char *help_doc,
273 cmd_sfunc_ftype *set_func,
274 show_value_ftype *show_func,
275 struct cmd_list_element **set_list,
276 struct cmd_list_element **show_list);
278 extern void add_setshow_auto_boolean_cmd (const char *name,
279 enum command_class theclass,
280 enum auto_boolean *var,
282 const char *show_doc,
283 const char *help_doc,
284 cmd_sfunc_ftype *set_func,
285 show_value_ftype *show_func,
286 struct cmd_list_element **set_list,
287 struct cmd_list_element **show_list);
289 extern void add_setshow_boolean_cmd (const char *name,
290 enum command_class theclass,
292 const char *set_doc, const char *show_doc,
293 const char *help_doc,
294 cmd_sfunc_ftype *set_func,
295 show_value_ftype *show_func,
296 struct cmd_list_element **set_list,
297 struct cmd_list_element **show_list);
299 extern void add_setshow_filename_cmd (const char *name,
300 enum command_class theclass,
303 const char *show_doc,
304 const char *help_doc,
305 cmd_sfunc_ftype *set_func,
306 show_value_ftype *show_func,
307 struct cmd_list_element **set_list,
308 struct cmd_list_element **show_list);
310 extern void add_setshow_string_cmd (const char *name,
311 enum command_class theclass,
314 const char *show_doc,
315 const char *help_doc,
316 cmd_sfunc_ftype *set_func,
317 show_value_ftype *show_func,
318 struct cmd_list_element **set_list,
319 struct cmd_list_element **show_list);
321 extern struct cmd_list_element *add_setshow_string_noescape_cmd
323 enum command_class theclass,
326 const char *show_doc,
327 const char *help_doc,
328 cmd_sfunc_ftype *set_func,
329 show_value_ftype *show_func,
330 struct cmd_list_element **set_list,
331 struct cmd_list_element **show_list);
333 extern void add_setshow_optional_filename_cmd (const char *name,
334 enum command_class theclass,
337 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_integer_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_uinteger_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 void add_setshow_zinteger_cmd (const char *name,
367 enum command_class theclass,
370 const char *show_doc,
371 const char *help_doc,
372 cmd_sfunc_ftype *set_func,
373 show_value_ftype *show_func,
374 struct cmd_list_element **set_list,
375 struct cmd_list_element **show_list);
377 extern void add_setshow_zuinteger_cmd (const char *name,
378 enum command_class theclass,
381 const char *show_doc,
382 const char *help_doc,
383 cmd_sfunc_ftype *set_func,
384 show_value_ftype *show_func,
385 struct cmd_list_element **set_list,
386 struct cmd_list_element **show_list);
389 add_setshow_zuinteger_unlimited_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 /* Do a "show" command for each thing on a command list. */
402 extern void cmd_show_list (struct cmd_list_element *, int, const char *);
404 /* Used everywhere whenever at least one parameter is required and
405 none is specified. */
407 extern void error_no_arg (const char *) ATTRIBUTE_NORETURN;
409 extern void dont_repeat (void);
411 extern struct cleanup *prevent_dont_repeat (void);
413 /* Used to mark commands that don't do anything. If we just leave the
414 function field NULL, the command is interpreted as a help topic, or
415 as a class of commands. */
417 extern void not_just_help_class_command (char *, int);
419 /* Check function pointer. */
420 extern int cmd_func_p (struct cmd_list_element *cmd);
422 /* Call the command function. */
423 extern void cmd_func (struct cmd_list_element *cmd,
424 char *args, int from_tty);
426 #endif /* !defined (COMMAND_H) */