1 /* ***DEPRECATED*** The gdblib files must not be calling/using things in any
2 of the possible command languages. If necessary, a hook (that may be
3 present or not) must be used and set to the appropriate routine by any
4 command language that cares about it. If you are having to include this
5 file you are possibly doing things the old way. This file will disapear.
6 2000-12-01 fnasser@redhat.com */
8 /* Header file for command-reading library command.c.
9 Copyright 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999, 2000
10 Free Software Foundation, Inc.
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place - Suite 330,
25 Boston, MA 02111-1307, USA. */
27 #if !defined (COMMAND_H)
30 /* Command classes are top-level categories into which commands are broken
31 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, all_classes = -2, all_commands = -1,
40 /* Classes of commands */
41 no_class = -1, class_run = 0, class_vars, class_stack,
42 class_files, class_support, class_info, class_breakpoint, class_trace,
43 class_alias, class_obscure, class_user, class_maintenance,
44 class_pseudo, class_tui, class_xdb
47 /* Not a set/show command. Note that some commands which begin with
48 "set" or "show" might be in this category, if their syntax does
49 not fall into one of the following categories. */
50 typedef enum cmd_types
58 /* Reasonable values for an AUTO_BOOLEAN variable. */
61 CMD_AUTO_BOOLEAN_TRUE,
62 CMD_AUTO_BOOLEAN_FALSE,
66 /* Types of "set" or "show" command. */
67 typedef enum var_types
69 /* "on" or "off". *VAR is an integer which is nonzero for on,
73 /* "on" / "true" / "enable" or "off" / "false" / "disable" or
74 "auto. *VAR is an ``enum cmd_auto_boolean''. NOTE: In general
75 a custom show command will need to be implemented - one that
76 for "auto" prints both the "auto" and the current auto-selected
80 /* Unsigned Integer. *VAR is an unsigned int. The user can type 0
81 to mean "unlimited", which is stored in *VAR as UINT_MAX. */
84 /* Like var_uinteger but signed. *VAR is an int. The user can type 0
85 to mean "unlimited", which is stored in *VAR as INT_MAX. */
88 /* String which the user enters with escapes (e.g. the user types \n and
89 it is a real newline in the stored string).
90 *VAR is a malloc'd string, or NULL if the string is empty. */
92 /* String which stores what the user types verbatim.
93 *VAR is a malloc'd string, or NULL if the string is empty. */
95 /* String which stores a filename.
96 *VAR is a malloc'd string, or NULL if the string is empty. */
98 /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except
99 that zero really means zero. */
101 /* Enumerated type. Can only have one of the specified values. *VAR is a
102 char pointer to the name of the element that we find. */
107 /* This structure records one command'd definition. */
110 /* This flag is used by the code executing commands to warn the user
111 the first time a deprecated command is used, see the 'flags' field in
112 the following struct.
114 #define CMD_DEPRECATED 0x1
115 #define DEPRECATED_WARN_USER 0x2
116 #define MALLOCED_REPLACEMENT 0x4
118 struct cmd_list_element
120 /* Points to next command in this list. */
121 struct cmd_list_element *next;
123 /* Name of this command. */
126 /* Command class; class values are chosen by application program. */
127 enum command_class class;
129 /* Function definition of this command.
130 NO_FUNCTION for command class names and for help topics that
131 are not really commands. */
134 /* If type is not_set_cmd, call it like this: */
135 void (*cfunc) (char *args, int from_tty);
137 /* If type is set_cmd or show_cmd, first set the variables, and
139 void (*sfunc) (char *args, int from_tty, struct cmd_list_element * c);
142 #define NO_FUNCTION ((void (*) (char *args, int from_tty)) 0)
144 /* Documentation of this command (or help topic).
145 First line is brief documentation; remaining lines form, with it,
146 the full documentation. First line should end with a period.
147 Entire string should also end with a period, not a newline. */
150 /* flags : a bitfield
152 bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
153 is deprecated. It may be removed from gdb's command set in the
156 bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
157 this is a deprecated command. The user should only be warned
158 the first time a command is used.
160 bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
161 compile time (this is the way it should, in general, be done)
162 the memory containing the replacement string is statically
163 allocated. In some cases it makes sense to deprecate commands
164 at runtime (the testsuite is one example). In this case the
165 memory for replacement is malloc'ed. When a command is
166 undeprecated or re-deprecated at runtime we don't want to risk
167 calling free on statically allocated memory, so we check this
172 /* if this command is deprecated, this is the replacement name */
175 /* If this command represents a show command, then this function
176 is called before the variable's value is examined. */
177 void (*pre_show_hook) (struct cmd_list_element *c);
179 /* Hook for another command to be executed before this command. */
180 struct cmd_list_element *hook_pre;
182 /* Hook for another command to be executed after this command. */
183 struct cmd_list_element *hook_post;
185 /* Flag that specifies if this command is already running it's hook. */
186 /* Prevents the possibility of hook recursion. */
189 /* Nonzero identifies a prefix command. For them, the address
190 of the variable containing the list of subcommands. */
191 struct cmd_list_element **prefixlist;
193 /* For prefix commands only:
194 String containing prefix commands to get here: this one
195 plus any others needed to get to it. Should end in a space.
196 It is used before the word "command" in describing the
197 commands reached through this prefix. */
200 /* For prefix commands only:
201 nonzero means do not get an error if subcommand is not
202 recognized; call the prefix's own function in that case. */
205 /* Nonzero says this is an abbreviation, and should not
206 be mentioned in lists of commands.
207 This allows "br<tab>" to complete to "break", which it
208 otherwise wouldn't. */
211 /* Completion routine for this command. TEXT is the text beyond
212 what was matched for the command itself (leading whitespace is
213 skipped). It stops where we are supposed to stop completing
214 (rl_point) and is '\0' terminated.
216 Return value is a malloc'd vector of pointers to possible completions
217 terminated with NULL. If there are no completions, returning a pointer
218 to a NULL would work but returning NULL itself is also valid.
219 WORD points in the same buffer as TEXT, and completions should be
220 returned relative to this position. For example, suppose TEXT is "foo"
221 and we want to complete to "foobar". If WORD is "oo", return
222 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
223 char **(*completer) (char *text, char *word);
225 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
229 /* Pointer to variable affected by "set" and "show". Doesn't matter
230 if type is not_set. */
233 /* What kind of variable is *VAR? */
236 /* Pointer to NULL terminated list of enumerated values (like argv). */
239 /* Pointer to command strings of user-defined commands */
240 struct command_line *user_commands;
242 /* Pointer to command that is hooked by this one, (by hook_pre)
243 so the hook can be removed when this one is deleted. */
244 struct cmd_list_element *hookee_pre;
246 /* Pointer to command that is hooked by this one, (by hook_post)
247 so the hook can be removed when this one is deleted. */
248 struct cmd_list_element *hookee_post;
250 /* Pointer to command that is aliased by this one, so the
251 aliased command can be located in case it has been hooked. */
252 struct cmd_list_element *cmd_pointer;
255 /* Forward-declarations of the entry-points of command.c. */
257 extern struct cmd_list_element *add_cmd (char *, enum command_class,
258 void (*fun) (char *, int), char *,
259 struct cmd_list_element **);
261 extern struct cmd_list_element *add_alias_cmd (char *, char *,
262 enum command_class, int,
263 struct cmd_list_element **);
265 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
266 void (*fun) (char *, int),
268 struct cmd_list_element **,
270 struct cmd_list_element **);
272 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
277 struct cmd_list_element
279 struct cmd_list_element
282 extern struct cmd_list_element *lookup_cmd (char **,
283 struct cmd_list_element *, char *,
286 extern struct cmd_list_element *lookup_cmd_1 (char **,
287 struct cmd_list_element *,
288 struct cmd_list_element **,
291 extern struct cmd_list_element *
292 deprecate_cmd (struct cmd_list_element *, char * );
295 deprecated_cmd_warning (char **);
298 lookup_cmd_composition (char *text,
299 struct cmd_list_element **alias,
300 struct cmd_list_element **prefix_cmd,
301 struct cmd_list_element **cmd);
303 extern struct cmd_list_element *add_com (char *, enum command_class,
304 void (*fun) (char *, int), char *);
306 extern struct cmd_list_element *add_com_alias (char *, char *,
307 enum command_class, int);
309 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
312 extern struct cmd_list_element *add_info_alias (char *, char *, int);
314 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
316 extern char **complete_on_enum (const char *enumlist[], char *, char *);
318 extern void delete_cmd (char *, struct cmd_list_element **);
320 extern void help_cmd (char *, struct ui_file *);
322 extern void help_list (struct cmd_list_element *, char *,
323 enum command_class, struct ui_file *);
325 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
326 char *, int, struct ui_file *);
328 extern struct cmd_list_element *add_set_cmd (char *name, enum
330 var_types var_type, void *var,
332 struct cmd_list_element **list);
334 extern struct cmd_list_element *add_set_enum_cmd (char *name,
335 enum command_class class,
336 const char *enumlist[],
339 struct cmd_list_element **list);
341 extern struct cmd_list_element *add_set_auto_boolean_cmd (char *name,
342 enum command_class class,
343 enum cmd_auto_boolean *var,
345 struct cmd_list_element **list);
347 extern struct cmd_list_element *add_set_boolean_cmd (char *name,
348 enum command_class class,
351 struct cmd_list_element **list);
353 extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *,
354 struct cmd_list_element
357 /* Do a "show" command for each thing on a command list. */
359 extern void cmd_show_list (struct cmd_list_element *, int, char *);
361 extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
363 extern void dont_repeat (void);
365 /* Used to mark commands that don't do anything. If we just leave the
366 function field NULL, the command is interpreted as a help topic, or
367 as a class of commands. */
369 extern void not_just_help_class_command (char *, int);
371 #endif /* !defined (COMMAND_H) */