1 /* Header file for command-reading library command.c.
3 Copyright 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999,
4 2000, 2002 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 add_show_from_set() function clones
157 the set command passed as a parameter. The clone operation will
158 include (BUG?) any ``set'' command callback, if present. Commands
159 like ``info set'' call all the ``show'' command callbacks.
160 Unfortunatly, for ``show'' commands cloned from ``set'', this
161 includes callbacks belonging to ``set'' commands. Making this
162 worse, this only occures if add_show_from_set() is called after
163 add_cmd_sfunc() (BUG?). */
164 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
167 extern struct cmd_list_element *lookup_cmd (char **,
168 struct cmd_list_element *, char *,
171 extern struct cmd_list_element *lookup_cmd_1 (char **,
172 struct cmd_list_element *,
173 struct cmd_list_element **,
176 extern struct cmd_list_element *
177 deprecate_cmd (struct cmd_list_element *, char * );
180 deprecated_cmd_warning (char **);
183 lookup_cmd_composition (char *text,
184 struct cmd_list_element **alias,
185 struct cmd_list_element **prefix_cmd,
186 struct cmd_list_element **cmd);
188 extern struct cmd_list_element *add_com (char *, enum command_class,
189 void (*fun) (char *, int), char *);
191 extern struct cmd_list_element *add_com_alias (char *, char *,
192 enum command_class, int);
194 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
197 extern struct cmd_list_element *add_info_alias (char *, char *, int);
199 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
201 extern char **complete_on_enum (const char *enumlist[], char *, char *);
203 extern void delete_cmd (char *, struct cmd_list_element **);
205 extern void help_cmd (char *, struct ui_file *);
207 extern void help_list (struct cmd_list_element *, char *,
208 enum command_class, struct ui_file *);
210 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
211 char *, int, struct ui_file *);
213 extern struct cmd_list_element *add_set_cmd (char *name, enum
215 var_types var_type, void *var,
217 struct cmd_list_element **list);
219 extern struct cmd_list_element *add_set_enum_cmd (char *name,
220 enum command_class class,
221 const char *enumlist[],
224 struct cmd_list_element **list);
226 extern struct cmd_list_element *add_set_auto_boolean_cmd (char *name,
227 enum command_class class,
228 enum auto_boolean *var,
230 struct cmd_list_element **list);
232 extern void add_setshow_boolean_cmd (char *name,
233 enum command_class class,
237 cmd_sfunc_ftype *set_func,
238 cmd_sfunc_ftype *show_func,
239 struct cmd_list_element **set_list,
240 struct cmd_list_element **show_list);
242 extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *,
243 struct cmd_list_element
246 /* Do a "show" command for each thing on a command list. */
248 extern void cmd_show_list (struct cmd_list_element *, int, char *);
250 extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
252 extern void dont_repeat (void);
254 /* Used to mark commands that don't do anything. If we just leave the
255 function field NULL, the command is interpreted as a help topic, or
256 as a class of commands. */
258 extern void not_just_help_class_command (char *, int);
260 #endif /* !defined (COMMAND_H) */