ec75b679b6afd339fb913dfe2cc155355a8db8e4
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 (C) 1986, 1989, 1990, 2000 Free Software Foundation, Inc.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 59 Temple Place - Suite 330,
24 Boston, MA 02111-1307, USA. */
26 #if !defined (COMMAND_H)
29 /* Command classes are top-level categories into which commands are broken
30 down for "help" purposes.
31 Notes on classes: class_alias is for alias commands which are not
32 abbreviations of the original command. class-pseudo is for
33 commands which are not really commands nor help topics ("stop"). */
37 /* Special args to help_list */
38 class_deprecated
, all_classes
= -2, all_commands
= -1,
39 /* Classes of commands */
40 no_class
= -1, class_run
= 0, class_vars
, class_stack
,
41 class_files
, class_support
, class_info
, class_breakpoint
, class_trace
,
42 class_alias
, class_obscure
, class_user
, class_maintenance
,
43 class_pseudo
, class_tui
, class_xdb
46 /* Not a set/show command. Note that some commands which begin with
47 "set" or "show" might be in this category, if their syntax does
48 not fall into one of the following categories. */
49 typedef enum cmd_types
57 /* Reasonable values for an AUTO_BOOLEAN variable. */
60 CMD_AUTO_BOOLEAN_TRUE
,
61 CMD_AUTO_BOOLEAN_FALSE
,
65 /* Types of "set" or "show" command. */
66 typedef enum var_types
68 /* "on" or "off". *VAR is an integer which is nonzero for on,
72 /* "on" / "true" / "enable" or "off" / "false" / "disable" or
73 "auto. *VAR is an ``enum cmd_auto_boolean''. NOTE: In general
74 a custom show command will need to be implemented - one that
75 for "auto" prints both the "auto" and the current auto-selected
79 /* Unsigned Integer. *VAR is an unsigned int. The user can type 0
80 to mean "unlimited", which is stored in *VAR as UINT_MAX. */
83 /* Like var_uinteger but signed. *VAR is an int. The user can type 0
84 to mean "unlimited", which is stored in *VAR as INT_MAX. */
87 /* String which the user enters with escapes (e.g. the user types \n and
88 it is a real newline in the stored string).
89 *VAR is a malloc'd string, or NULL if the string is empty. */
91 /* String which stores what the user types verbatim.
92 *VAR is a malloc'd string, or NULL if the string is empty. */
94 /* String which stores a filename.
95 *VAR is a malloc'd string, or NULL if the string is empty. */
97 /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except
98 that zero really means zero. */
100 /* Enumerated type. Can only have one of the specified values. *VAR is a
101 char pointer to the name of the element that we find. */
106 /* This structure records one command'd definition. */
109 /* This flag is used by the code executing commands to warn the user
110 the first time a deprecated command is used, see the 'flags' field in
111 the following struct.
113 #define CMD_DEPRECATED 0x1
114 #define DEPRECATED_WARN_USER 0x2
115 #define MALLOCED_REPLACEMENT 0x4
117 struct cmd_list_element
119 /* Points to next command in this list. */
120 struct cmd_list_element
*next
;
122 /* Name of this command. */
125 /* Command class; class values are chosen by application program. */
126 enum command_class
class;
128 /* Function definition of this command.
129 NO_FUNCTION for command class names and for help topics that
130 are not really commands. */
133 /* If type is not_set_cmd, call it like this: */
134 void (*cfunc
) (char *args
, int from_tty
);
136 /* If type is cmd_set or show_cmd, first set the variables, and
138 void (*sfunc
) (char *args
, int from_tty
, struct cmd_list_element
* c
);
141 #define NO_FUNCTION ((void (*) (char *args, int from_tty)) 0)
143 /* Documentation of this command (or help topic).
144 First line is brief documentation; remaining lines form, with it,
145 the full documentation. First line should end with a period.
146 Entire string should also end with a period, not a newline. */
149 /* flags : a bitfield
151 bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
152 is deprecated. It may be removed from gdb's command set in the
155 bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
156 this is a deprecated command. The user should only be warned
157 the first time a command is used.
159 bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
160 compile time (this is the way it should, in general, be done)
161 the memory containing the replacement string is statically
162 allocated. In some cases it makes sense to deprecate commands
163 at runtime (the testsuite is one example). In this case the
164 memory for replacement is malloc'ed. When a command is
165 undeprecated or re-deprecated at runtime we don't want to risk
166 calling free on statically allocated memory, so we check this
171 /* if this command is deprecated, this is the replacement name */
174 /* Hook for another command to be executed before this command. */
175 struct cmd_list_element
*hook_pre
;
177 /* Hook for another command to be executed after this command. */
178 struct cmd_list_element
*hook_post
;
180 /* Flag that specifies if this command is already running it's hook. */
181 /* Prevents the possibility of hook recursion. */
184 /* Nonzero identifies a prefix command. For them, the address
185 of the variable containing the list of subcommands. */
186 struct cmd_list_element
**prefixlist
;
188 /* For prefix commands only:
189 String containing prefix commands to get here: this one
190 plus any others needed to get to it. Should end in a space.
191 It is used before the word "command" in describing the
192 commands reached through this prefix. */
195 /* For prefix commands only:
196 nonzero means do not get an error if subcommand is not
197 recognized; call the prefix's own function in that case. */
200 /* Nonzero says this is an abbreviation, and should not
201 be mentioned in lists of commands.
202 This allows "br<tab>" to complete to "break", which it
203 otherwise wouldn't. */
206 /* Completion routine for this command. TEXT is the text beyond
207 what was matched for the command itself (leading whitespace is
208 skipped). It stops where we are supposed to stop completing
209 (rl_point) and is '\0' terminated.
211 Return value is a malloc'd vector of pointers to possible completions
212 terminated with NULL. If there are no completions, returning a pointer
213 to a NULL would work but returning NULL itself is also valid.
214 WORD points in the same buffer as TEXT, and completions should be
215 returned relative to this position. For example, suppose TEXT is "foo"
216 and we want to complete to "foobar". If WORD is "oo", return
217 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
218 char **(*completer
) (char *text
, char *word
);
220 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
224 /* Pointer to variable affected by "set" and "show". Doesn't matter
225 if type is not_set. */
228 /* What kind of variable is *VAR? */
231 /* Pointer to NULL terminated list of enumerated values (like argv). */
234 /* Pointer to command strings of user-defined commands */
235 struct command_line
*user_commands
;
237 /* Pointer to command that is hooked by this one, (by hook_pre)
238 so the hook can be removed when this one is deleted. */
239 struct cmd_list_element
*hookee_pre
;
241 /* Pointer to command that is hooked by this one, (by hook_post)
242 so the hook can be removed when this one is deleted. */
243 struct cmd_list_element
*hookee_post
;
245 /* Pointer to command that is aliased by this one, so the
246 aliased command can be located in case it has been hooked. */
247 struct cmd_list_element
*cmd_pointer
;
250 /* Forward-declarations of the entry-points of command.c. */
252 extern struct cmd_list_element
*add_cmd (char *, enum command_class
,
253 void (*fun
) (char *, int), char *,
254 struct cmd_list_element
**);
256 extern struct cmd_list_element
*add_alias_cmd (char *, char *,
257 enum command_class
, int,
258 struct cmd_list_element
**);
260 extern struct cmd_list_element
*add_prefix_cmd (char *, enum command_class
,
261 void (*fun
) (char *, int),
263 struct cmd_list_element
**,
265 struct cmd_list_element
**);
267 extern struct cmd_list_element
*add_abbrev_prefix_cmd (char *,
272 struct cmd_list_element
274 struct cmd_list_element
277 extern struct cmd_list_element
*lookup_cmd (char **,
278 struct cmd_list_element
*, char *,
281 extern struct cmd_list_element
*lookup_cmd_1 (char **,
282 struct cmd_list_element
*,
283 struct cmd_list_element
**,
286 extern struct cmd_list_element
*
287 deprecate_cmd (struct cmd_list_element
*, char * );
290 deprecated_cmd_warning (char **);
293 lookup_cmd_composition (char *text
,
294 struct cmd_list_element
**alias
,
295 struct cmd_list_element
**prefix_cmd
,
296 struct cmd_list_element
**cmd
);
298 extern struct cmd_list_element
*add_com (char *, enum command_class
,
299 void (*fun
) (char *, int), char *);
301 extern struct cmd_list_element
*add_com_alias (char *, char *,
302 enum command_class
, int);
304 extern struct cmd_list_element
*add_info (char *, void (*fun
) (char *, int),
307 extern struct cmd_list_element
*add_info_alias (char *, char *, int);
309 extern char **complete_on_cmdlist (struct cmd_list_element
*, char *, char *);
311 extern char **complete_on_enum (const char *enumlist
[], char *, char *);
313 extern void delete_cmd (char *, struct cmd_list_element
**);
315 extern void help_cmd (char *, struct ui_file
*);
317 extern void help_list (struct cmd_list_element
*, char *,
318 enum command_class
, struct ui_file
*);
320 extern void help_cmd_list (struct cmd_list_element
*, enum command_class
,
321 char *, int, struct ui_file
*);
323 extern struct cmd_list_element
*add_set_cmd (char *name
, enum
325 var_types var_type
, void *var
,
327 struct cmd_list_element
**list
);
329 extern struct cmd_list_element
*add_set_enum_cmd (char *name
,
330 enum command_class
class,
331 const char *enumlist
[],
334 struct cmd_list_element
**list
);
336 extern struct cmd_list_element
*add_set_auto_boolean_cmd (char *name
,
337 enum command_class
class,
338 enum cmd_auto_boolean
*var
,
340 struct cmd_list_element
**list
);
342 extern struct cmd_list_element
*add_show_from_set (struct cmd_list_element
*,
343 struct cmd_list_element
346 /* Do a "set" or "show" command. ARG is NULL if no argument, or the text
347 of the argument, and FROM_TTY is nonzero if this command is being entered
348 directly by the user (i.e. these are just like any other
349 command). C is the command list element for the command. */
351 extern void do_setshow_command (char *, int, struct cmd_list_element
*);
353 /* Do a "show" command for each thing on a command list. */
355 extern void cmd_show_list (struct cmd_list_element
*, int, char *);
357 extern NORETURN
void error_no_arg (char *) ATTR_NORETURN
;
359 extern void dont_repeat (void);
361 /* Used to mark commands that don't do anything. If we just leave the
362 function field NULL, the command is interpreted as a help topic, or
363 as a class of commands. */
365 extern void not_just_help_class_command (char *, int);
367 #endif /* !defined (COMMAND_H) */