1 /* Header file for command-reading library command.c.
3 Copyright 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999,
4 2000, 2002, 2004 Free Software Foundation, Inc.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 #if !defined (COMMAND_H)
24 /* Command classes are top-level categories into which commands are broken
25 down for "help" purposes.
26 Notes on classes: class_alias is for alias commands which are not
27 abbreviations of the original command. class-pseudo is for
28 commands which are not really commands nor help topics ("stop"). */
32 /* Special args to help_list */
33 class_deprecated, all_classes = -2, all_commands = -1,
34 /* Classes of commands */
35 no_class = -1, class_run = 0, class_vars, class_stack,
36 class_files, class_support, class_info, class_breakpoint, class_trace,
37 class_alias, class_obscure, class_user, class_maintenance,
38 class_pseudo, class_tui, class_xdb
41 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
42 cmd_types'' can be moved from "command.h" to "cli-decode.h". */
43 /* Not a set/show command. Note that some commands which begin with
44 "set" or "show" might be in this category, if their syntax does
45 not fall into one of the following categories. */
46 typedef enum cmd_types
54 /* Types of "set" or "show" command. */
55 typedef enum var_types
57 /* "on" or "off". *VAR is an integer which is nonzero for on,
61 /* "on" / "true" / "enable" or "off" / "false" / "disable" or
62 "auto. *VAR is an ``enum auto_boolean''. NOTE: In general a
63 custom show command will need to be implemented - one that for
64 "auto" prints both the "auto" and the current auto-selected
68 /* Unsigned Integer. *VAR is an unsigned int. The user can type 0
69 to mean "unlimited", which is stored in *VAR as UINT_MAX. */
72 /* Like var_uinteger but signed. *VAR is an int. The user can type 0
73 to mean "unlimited", which is stored in *VAR as INT_MAX. */
76 /* String which the user enters with escapes (e.g. the user types \n and
77 it is a real newline in the stored string).
78 *VAR is a malloc'd string, or NULL if the string is empty. */
80 /* String which stores what the user types verbatim.
81 *VAR is a malloc'd string, or NULL if the string is empty. */
83 /* String which stores a filename.
84 *VAR is a malloc'd string, or NULL if the string is empty. */
86 /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except
87 that zero really means zero. */
89 /* Enumerated type. Can only have one of the specified values. *VAR is a
90 char pointer to the name of the element that we find. */
95 /* This structure records one command'd definition. */
96 struct cmd_list_element;
98 /* Forward-declarations of the entry-points of cli/cli-decode.c. */
100 extern struct cmd_list_element *add_cmd (char *, enum command_class,
101 void (*fun) (char *, int), char *,
102 struct cmd_list_element **);
104 extern struct cmd_list_element *add_alias_cmd (char *, char *,
105 enum command_class, int,
106 struct cmd_list_element **);
108 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
109 void (*fun) (char *, int),
111 struct cmd_list_element **,
113 struct cmd_list_element **);
115 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
120 struct cmd_list_element
122 struct cmd_list_element
125 /* Set the commands corresponding callback. */
127 typedef void cmd_cfunc_ftype (char *args, int from_tty);
128 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
129 cmd_cfunc_ftype *cfunc);
131 typedef void cmd_sfunc_ftype (char *args, int from_tty,
132 struct cmd_list_element *c);
133 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
134 cmd_sfunc_ftype *sfunc);
136 extern void set_cmd_completer (struct cmd_list_element *cmd,
137 char **(*completer) (char *text, char *word));
139 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
140 around in cmd objects to test the value of the commands sfunc(). */
141 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
142 void (*cfunc) (char *args, int from_tty));
144 /* Each command object has a local context attached to it. . */
145 extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
146 extern void *get_cmd_context (struct cmd_list_element *cmd);
149 /* Execute CMD's pre/post hook. Throw an error if the command fails.
150 If already executing this pre/post hook, or there is no pre/post
151 hook, the call is silently ignored. */
152 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
153 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
155 /* Return the type of the command. */
156 /* NOTE: cagney/2002-03-17: The deprecated_add_show_from_set()
157 function clones the set command passed as a parameter. The clone
158 operation will include (BUG?) any ``set'' command callback, if
159 present. Commands like ``info set'' call all the ``show'' command
160 callbacks. Unfortunately, for ``show'' commands cloned from
161 ``set'', this includes callbacks belonging to ``set'' commands.
162 Making this worse, this only occures if
163 deprecated_add_show_from_set() is called after add_cmd_sfunc()
165 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
168 extern struct cmd_list_element *lookup_cmd (char **,
169 struct cmd_list_element *, char *,
172 extern struct cmd_list_element *lookup_cmd_1 (char **,
173 struct cmd_list_element *,
174 struct cmd_list_element **,
177 extern struct cmd_list_element *
178 deprecate_cmd (struct cmd_list_element *, char * );
181 deprecated_cmd_warning (char **);
184 lookup_cmd_composition (char *text,
185 struct cmd_list_element **alias,
186 struct cmd_list_element **prefix_cmd,
187 struct cmd_list_element **cmd);
189 extern struct cmd_list_element *add_com (char *, enum command_class,
190 void (*fun) (char *, int), char *);
192 extern struct cmd_list_element *add_com_alias (char *, char *,
193 enum command_class, int);
195 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
198 extern struct cmd_list_element *add_info_alias (char *, char *, int);
200 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
202 extern char **complete_on_enum (const char *enumlist[], char *, char *);
204 extern void delete_cmd (char *, struct cmd_list_element **);
206 extern void help_cmd (char *, struct ui_file *);
208 extern void help_list (struct cmd_list_element *, char *,
209 enum command_class, struct ui_file *);
211 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
212 char *, int, struct ui_file *);
214 extern struct cmd_list_element *add_set_cmd (char *name, enum
216 var_types var_type, void *var,
218 struct cmd_list_element **list);
220 extern struct cmd_list_element *add_set_enum_cmd (char *name,
221 enum command_class class,
222 const char *enumlist[],
225 struct cmd_list_element **list);
227 /* Print the set|show CMD's variable's VALUE on FILE. Do not include
229 typedef void (fprint_setshow_ftype) (struct cmd_list_element *cmd,
230 struct ui_file *file,
233 extern void add_setshow_enum_cmd (char *name,
234 enum command_class class,
235 const char *enumlist[],
238 const char *show_doc,
239 const char *help_doc,
240 fprint_setshow_ftype *fprint_setshow,
241 cmd_sfunc_ftype *set_func,
242 cmd_sfunc_ftype *show_func,
243 struct cmd_list_element **set_list,
244 struct cmd_list_element **show_list);
246 extern void add_setshow_auto_boolean_cmd (char *name,
247 enum command_class class,
248 enum auto_boolean *var,
250 const char *show_doc,
251 const char *help_doc,
252 fprint_setshow_ftype *fprint_setshow,
253 cmd_sfunc_ftype *set_func,
254 cmd_sfunc_ftype *show_func,
255 struct cmd_list_element **set_list,
256 struct cmd_list_element **show_list);
258 extern void add_setshow_boolean_cmd (char *name,
259 enum command_class class,
261 const char *set_doc, const char *show_doc,
262 const char *help_doc, fprint_setshow_ftype *fprint_setshow,
263 cmd_sfunc_ftype *set_func,
264 cmd_sfunc_ftype *show_func,
265 struct cmd_list_element **set_list,
266 struct cmd_list_element **show_list);
268 extern void add_setshow_filename_cmd (char *name,
269 enum command_class class,
272 const char *show_doc,
273 const char *help_doc,
274 fprint_setshow_ftype *fprint_setshow,
275 cmd_sfunc_ftype *set_func,
276 cmd_sfunc_ftype *show_func,
277 struct cmd_list_element **set_list,
278 struct cmd_list_element **show_list);
280 extern void add_setshow_string_cmd (char *name,
281 enum command_class class,
284 const char *show_doc,
285 const char *help_doc,
286 fprint_setshow_ftype *fprint_setshow,
287 cmd_sfunc_ftype *set_func,
288 cmd_sfunc_ftype *show_func,
289 struct cmd_list_element **set_list,
290 struct cmd_list_element **show_list);
292 extern void add_setshow_uinteger_cmd (char *name,
293 enum command_class class,
296 const char *show_doc,
297 const char *help_doc,
298 fprint_setshow_ftype *fprint_setshow,
299 cmd_sfunc_ftype *set_func,
300 cmd_sfunc_ftype *show_func,
301 struct cmd_list_element **set_list,
302 struct cmd_list_element **show_list);
304 extern void add_setshow_zinteger_cmd (char *name,
305 enum command_class class,
308 const char *show_doc,
309 const char *help_doc,
310 fprint_setshow_ftype *fprint_setshow,
311 cmd_sfunc_ftype *set_func,
312 cmd_sfunc_ftype *show_func,
313 struct cmd_list_element **set_list,
314 struct cmd_list_element **show_list);
316 extern struct cmd_list_element *deprecated_add_show_from_set (struct cmd_list_element *,
317 struct cmd_list_element **);
319 /* Do a "show" command for each thing on a command list. */
321 extern void cmd_show_list (struct cmd_list_element *, int, char *);
323 extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
325 extern void dont_repeat (void);
327 /* Used to mark commands that don't do anything. If we just leave the
328 function field NULL, the command is interpreted as a help topic, or
329 as a class of commands. */
331 extern void not_just_help_class_command (char *, int);
333 /* check function pointer */
334 extern int cmd_func_p (struct cmd_list_element *cmd);
336 /* call the command function */
337 extern void cmd_func (struct cmd_list_element *cmd, char *args, int from_tty);
339 #endif /* !defined (COMMAND_H) */