2f2f6b8e542a714d29fe4142a93aa44fc7dd1403
1 /* Header file for command-reading library command.c.
2 Copyright (C) 1986, 1989, 1990, 2000 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA. */
19 #if !defined (COMMAND_H)
22 /* Command classes are top-level categories into which commands are broken
23 down for "help" purposes.
24 Notes on classes: class_alias is for alias commands which are not
25 abbreviations of the original command. class-pseudo is for
26 commands which are not really commands nor help topics ("stop"). */
30 /* Special args to help_list */
31 class_deprecated
, all_classes
= -2, all_commands
= -1,
32 /* Classes of commands */
33 no_class
= -1, class_run
= 0, class_vars
, class_stack
,
34 class_files
, class_support
, class_info
, class_breakpoint
, class_trace
,
35 class_alias
, class_obscure
, class_user
, class_maintenance
,
36 class_pseudo
, class_tui
, class_xdb
39 /* Not a set/show command. Note that some commands which begin with
40 "set" or "show" might be in this category, if their syntax does
41 not fall into one of the following categories. */
42 typedef enum cmd_types
50 /* Reasonable values for an AUTO_BOOLEAN variable. */
53 CMD_AUTO_BOOLEAN_TRUE
,
54 CMD_AUTO_BOOLEAN_FALSE
,
58 /* Types of "set" or "show" command. */
59 typedef enum var_types
61 /* "on" or "off". *VAR is an integer which is nonzero for on,
65 /* "on" / "true" / "enable" or "off" / "false" / "disable" or
66 "auto. *VAR is an ``enum cmd_auto_boolean''. NOTE: In general
67 a custom show command will need to be implemented - one that
68 for "auto" prints both the "auto" and the current auto-selected
72 /* Unsigned Integer. *VAR is an unsigned int. The user can type 0
73 to mean "unlimited", which is stored in *VAR as UINT_MAX. */
76 /* Like var_uinteger but signed. *VAR is an int. The user can type 0
77 to mean "unlimited", which is stored in *VAR as INT_MAX. */
80 /* String which the user enters with escapes (e.g. the user types \n and
81 it is a real newline in the stored string).
82 *VAR is a malloc'd string, or NULL if the string is empty. */
84 /* String which stores what the user types verbatim.
85 *VAR is a malloc'd string, or NULL if the string is empty. */
87 /* String which stores a filename.
88 *VAR is a malloc'd string, or NULL if the string is empty. */
90 /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except
91 that zero really means zero. */
93 /* Enumerated type. Can only have one of the specified values. *VAR is a
94 char pointer to the name of the element that we find. */
99 /* This structure records one command'd definition. */
102 /* This flag is used by the code executing commands to warn the user
103 the first time a deprecated command is used, see the 'flags' field in
104 the following struct.
106 #define CMD_DEPRECATED 0x1
107 #define DEPRECATED_WARN_USER 0x2
108 #define MALLOCED_REPLACEMENT 0x4
110 struct cmd_list_element
112 /* Points to next command in this list. */
113 struct cmd_list_element
*next
;
115 /* Name of this command. */
118 /* Command class; class values are chosen by application program. */
119 enum command_class
class;
121 /* Function definition of this command.
122 NO_FUNCTION for command class names and for help topics that
123 are not really commands. */
126 /* If type is not_set_cmd, call it like this: */
127 void (*cfunc
) (char *args
, int from_tty
);
129 /* If type is cmd_set or show_cmd, first set the variables, and
131 void (*sfunc
) (char *args
, int from_tty
, struct cmd_list_element
* c
);
134 #define NO_FUNCTION ((void (*) (char *args, int from_tty)) 0)
136 /* Documentation of this command (or help topic).
137 First line is brief documentation; remaining lines form, with it,
138 the full documentation. First line should end with a period.
139 Entire string should also end with a period, not a newline. */
142 /* flags : a bitfield
144 bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
145 is deprecated. It may be removed from gdb's command set in the
148 bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
149 this is a deprecated command. The user should only be warned
150 the first time a command is used.
152 bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
153 compile time (this is the way it should, in general, be done)
154 the memory containing the replacement string is statically
155 allocated. In some cases it makes sense to deprecate commands
156 at runtime (the testsuite is one example). In this case the
157 memory for replacement is malloc'ed. When a command is
158 undeprecated or re-deprecated at runtime we don't want to risk
159 calling free on statically allocated memory, so we check this
164 /* if this command is deprecated, this is the replacement name */
167 /* Hook for another command to be executed before this command. */
168 struct cmd_list_element
*hook_pre
;
170 /* Hook for another command to be executed after this command. */
171 struct cmd_list_element
*hook_post
;
173 /* Flag that specifies if this command is already running it's hook. */
174 /* Prevents the possibility of hook recursion. */
177 /* Nonzero identifies a prefix command. For them, the address
178 of the variable containing the list of subcommands. */
179 struct cmd_list_element
**prefixlist
;
181 /* For prefix commands only:
182 String containing prefix commands to get here: this one
183 plus any others needed to get to it. Should end in a space.
184 It is used before the word "command" in describing the
185 commands reached through this prefix. */
188 /* For prefix commands only:
189 nonzero means do not get an error if subcommand is not
190 recognized; call the prefix's own function in that case. */
193 /* Nonzero says this is an abbreviation, and should not
194 be mentioned in lists of commands.
195 This allows "br<tab>" to complete to "break", which it
196 otherwise wouldn't. */
199 /* Completion routine for this command. TEXT is the text beyond
200 what was matched for the command itself (leading whitespace is
201 skipped). It stops where we are supposed to stop completing
202 (rl_point) and is '\0' terminated.
204 Return value is a malloc'd vector of pointers to possible completions
205 terminated with NULL. If there are no completions, returning a pointer
206 to a NULL would work but returning NULL itself is also valid.
207 WORD points in the same buffer as TEXT, and completions should be
208 returned relative to this position. For example, suppose TEXT is "foo"
209 and we want to complete to "foobar". If WORD is "oo", return
210 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
211 char **(*completer
) (char *text
, char *word
);
213 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
217 /* Pointer to variable affected by "set" and "show". Doesn't matter
218 if type is not_set. */
221 /* What kind of variable is *VAR? */
224 /* Pointer to NULL terminated list of enumerated values (like argv). */
227 /* Pointer to command strings of user-defined commands */
228 struct command_line
*user_commands
;
230 /* Pointer to command that is hooked by this one, (by hook_pre)
231 so the hook can be removed when this one is deleted. */
232 struct cmd_list_element
*hookee_pre
;
234 /* Pointer to command that is hooked by this one, (by hook_post)
235 so the hook can be removed when this one is deleted. */
236 struct cmd_list_element
*hookee_post
;
238 /* Pointer to command that is aliased by this one, so the
239 aliased command can be located in case it has been hooked. */
240 struct cmd_list_element
*cmd_pointer
;
243 /* Forward-declarations of the entry-points of command.c. */
245 extern struct cmd_list_element
*add_cmd (char *, enum command_class
,
246 void (*fun
) (char *, int), char *,
247 struct cmd_list_element
**);
249 extern struct cmd_list_element
*add_alias_cmd (char *, char *,
250 enum command_class
, int,
251 struct cmd_list_element
**);
253 extern struct cmd_list_element
*add_prefix_cmd (char *, enum command_class
,
254 void (*fun
) (char *, int),
256 struct cmd_list_element
**,
258 struct cmd_list_element
**);
260 extern struct cmd_list_element
*add_abbrev_prefix_cmd (char *,
265 struct cmd_list_element
267 struct cmd_list_element
270 extern struct cmd_list_element
*lookup_cmd (char **,
271 struct cmd_list_element
*, char *,
274 extern struct cmd_list_element
*lookup_cmd_1 (char **,
275 struct cmd_list_element
*,
276 struct cmd_list_element
**,
279 extern struct cmd_list_element
*
280 deprecate_cmd (struct cmd_list_element
*, char * );
283 deprecated_cmd_warning (char **);
286 lookup_cmd_composition (char *text
,
287 struct cmd_list_element
**alias
,
288 struct cmd_list_element
**prefix_cmd
,
289 struct cmd_list_element
**cmd
);
291 extern struct cmd_list_element
*add_com (char *, enum command_class
,
292 void (*fun
) (char *, int), char *);
294 extern struct cmd_list_element
*add_com_alias (char *, char *,
295 enum command_class
, int);
297 extern struct cmd_list_element
*add_info (char *, void (*fun
) (char *, int),
300 extern struct cmd_list_element
*add_info_alias (char *, char *, int);
302 extern char **complete_on_cmdlist (struct cmd_list_element
*, char *, char *);
304 extern char **complete_on_enum (const char *enumlist
[], char *, char *);
306 extern void delete_cmd (char *, struct cmd_list_element
**);
308 extern void help_cmd (char *, struct ui_file
*);
310 extern void help_list (struct cmd_list_element
*, char *,
311 enum command_class
, struct ui_file
*);
313 extern void help_cmd_list (struct cmd_list_element
*, enum command_class
,
314 char *, int, struct ui_file
*);
316 extern struct cmd_list_element
*add_set_cmd (char *name
, enum
318 var_types var_type
, void *var
,
320 struct cmd_list_element
**list
);
322 extern struct cmd_list_element
*add_set_enum_cmd (char *name
,
323 enum command_class
class,
324 const char *enumlist
[],
327 struct cmd_list_element
**list
);
329 extern struct cmd_list_element
*add_set_auto_boolean_cmd (char *name
,
330 enum command_class
class,
331 enum cmd_auto_boolean
*var
,
333 struct cmd_list_element
**list
);
335 extern struct cmd_list_element
*add_show_from_set (struct cmd_list_element
*,
336 struct cmd_list_element
339 /* Do a "set" or "show" command. ARG is NULL if no argument, or the text
340 of the argument, and FROM_TTY is nonzero if this command is being entered
341 directly by the user (i.e. these are just like any other
342 command). C is the command list element for the command. */
344 extern void do_setshow_command (char *, int, struct cmd_list_element
*);
346 /* Do a "show" command for each thing on a command list. */
348 extern void cmd_show_list (struct cmd_list_element
*, int, char *);
350 extern NORETURN
void error_no_arg (char *) ATTR_NORETURN
;
352 extern void dont_repeat (void);
354 /* Used to mark commands that don't do anything. If we just leave the
355 function field NULL, the command is interpreted as a help topic, or
356 as a class of commands. */
358 extern void not_just_help_class_command (char *, int);
360 #endif /* !defined (COMMAND_H) */