c7d7b5eeaaf8487ff4f25ab3ffbaaa253343f7f9
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. NULL for command class
130 names and for help topics that are not really commands. NOTE:
131 cagney/2002-02-02: This function signature is evolving. For
132 the moment suggest sticking with either set_cmd_cfunc() or
134 void (*func
) (struct cmd_list_element
*c
, char *args
, int from_tty
);
135 /* The command's real callback. At present func() bounces through
136 to one of the below. */
139 /* If type is not_set_cmd, call it like this: */
140 void (*cfunc
) (char *args
, int from_tty
);
142 /* If type is set_cmd or show_cmd, first set the variables, and
144 void (*sfunc
) (char *args
, int from_tty
, struct cmd_list_element
* c
);
148 /* Documentation of this command (or help topic).
149 First line is brief documentation; remaining lines form, with it,
150 the full documentation. First line should end with a period.
151 Entire string should also end with a period, not a newline. */
154 /* flags : a bitfield
156 bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
157 is deprecated. It may be removed from gdb's command set in the
160 bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
161 this is a deprecated command. The user should only be warned
162 the first time a command is used.
164 bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
165 compile time (this is the way it should, in general, be done)
166 the memory containing the replacement string is statically
167 allocated. In some cases it makes sense to deprecate commands
168 at runtime (the testsuite is one example). In this case the
169 memory for replacement is malloc'ed. When a command is
170 undeprecated or re-deprecated at runtime we don't want to risk
171 calling free on statically allocated memory, so we check this
176 /* if this command is deprecated, this is the replacement name */
179 /* If this command represents a show command, then this function
180 is called before the variable's value is examined. */
181 void (*pre_show_hook
) (struct cmd_list_element
*c
);
183 /* Hook for another command to be executed before this command. */
184 struct cmd_list_element
*hook_pre
;
186 /* Hook for another command to be executed after this command. */
187 struct cmd_list_element
*hook_post
;
189 /* Flag that specifies if this command is already running it's hook. */
190 /* Prevents the possibility of hook recursion. */
193 /* Nonzero identifies a prefix command. For them, the address
194 of the variable containing the list of subcommands. */
195 struct cmd_list_element
**prefixlist
;
197 /* For prefix commands only:
198 String containing prefix commands to get here: this one
199 plus any others needed to get to it. Should end in a space.
200 It is used before the word "command" in describing the
201 commands reached through this prefix. */
204 /* For prefix commands only:
205 nonzero means do not get an error if subcommand is not
206 recognized; call the prefix's own function in that case. */
209 /* Nonzero says this is an abbreviation, and should not
210 be mentioned in lists of commands.
211 This allows "br<tab>" to complete to "break", which it
212 otherwise wouldn't. */
215 /* Completion routine for this command. TEXT is the text beyond
216 what was matched for the command itself (leading whitespace is
217 skipped). It stops where we are supposed to stop completing
218 (rl_point) and is '\0' terminated.
220 Return value is a malloc'd vector of pointers to possible completions
221 terminated with NULL. If there are no completions, returning a pointer
222 to a NULL would work but returning NULL itself is also valid.
223 WORD points in the same buffer as TEXT, and completions should be
224 returned relative to this position. For example, suppose TEXT is "foo"
225 and we want to complete to "foobar". If WORD is "oo", return
226 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
227 char **(*completer
) (char *text
, char *word
);
229 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
233 /* Pointer to variable affected by "set" and "show". Doesn't matter
234 if type is not_set. */
237 /* What kind of variable is *VAR? */
240 /* Pointer to NULL terminated list of enumerated values (like argv). */
243 /* Pointer to command strings of user-defined commands */
244 struct command_line
*user_commands
;
246 /* Pointer to command that is hooked by this one, (by hook_pre)
247 so the hook can be removed when this one is deleted. */
248 struct cmd_list_element
*hookee_pre
;
250 /* Pointer to command that is hooked by this one, (by hook_post)
251 so the hook can be removed when this one is deleted. */
252 struct cmd_list_element
*hookee_post
;
254 /* Pointer to command that is aliased by this one, so the
255 aliased command can be located in case it has been hooked. */
256 struct cmd_list_element
*cmd_pointer
;
259 /* Forward-declarations of the entry-points of command.c. */
261 extern struct cmd_list_element
*add_cmd (char *, enum command_class
,
262 void (*fun
) (char *, int), char *,
263 struct cmd_list_element
**);
265 extern struct cmd_list_element
*add_alias_cmd (char *, char *,
266 enum command_class
, int,
267 struct cmd_list_element
**);
269 extern struct cmd_list_element
*add_prefix_cmd (char *, enum command_class
,
270 void (*fun
) (char *, int),
272 struct cmd_list_element
**,
274 struct cmd_list_element
**);
276 extern struct cmd_list_element
*add_abbrev_prefix_cmd (char *,
281 struct cmd_list_element
283 struct cmd_list_element
286 /* Set the commands corresponding callback. */
288 extern void set_cmd_cfunc (struct cmd_list_element
*cmd
,
289 void (*cfunc
) (char *args
, int from_tty
));
291 extern void set_cmd_sfunc (struct cmd_list_element
*cmd
,
292 void (*sfunc
) (char *args
, int from_tty
,
293 struct cmd_list_element
* c
));
296 extern struct cmd_list_element
*lookup_cmd (char **,
297 struct cmd_list_element
*, char *,
300 extern struct cmd_list_element
*lookup_cmd_1 (char **,
301 struct cmd_list_element
*,
302 struct cmd_list_element
**,
305 extern struct cmd_list_element
*
306 deprecate_cmd (struct cmd_list_element
*, char * );
309 deprecated_cmd_warning (char **);
312 lookup_cmd_composition (char *text
,
313 struct cmd_list_element
**alias
,
314 struct cmd_list_element
**prefix_cmd
,
315 struct cmd_list_element
**cmd
);
317 extern struct cmd_list_element
*add_com (char *, enum command_class
,
318 void (*fun
) (char *, int), char *);
320 extern struct cmd_list_element
*add_com_alias (char *, char *,
321 enum command_class
, int);
323 extern struct cmd_list_element
*add_info (char *, void (*fun
) (char *, int),
326 extern struct cmd_list_element
*add_info_alias (char *, char *, int);
328 extern char **complete_on_cmdlist (struct cmd_list_element
*, char *, char *);
330 extern char **complete_on_enum (const char *enumlist
[], char *, char *);
332 extern void delete_cmd (char *, struct cmd_list_element
**);
334 extern void help_cmd (char *, struct ui_file
*);
336 extern void help_list (struct cmd_list_element
*, char *,
337 enum command_class
, struct ui_file
*);
339 extern void help_cmd_list (struct cmd_list_element
*, enum command_class
,
340 char *, int, struct ui_file
*);
342 extern struct cmd_list_element
*add_set_cmd (char *name
, enum
344 var_types var_type
, void *var
,
346 struct cmd_list_element
**list
);
348 extern struct cmd_list_element
*add_set_enum_cmd (char *name
,
349 enum command_class
class,
350 const char *enumlist
[],
353 struct cmd_list_element
**list
);
355 extern struct cmd_list_element
*add_set_auto_boolean_cmd (char *name
,
356 enum command_class
class,
357 enum cmd_auto_boolean
*var
,
359 struct cmd_list_element
**list
);
361 extern struct cmd_list_element
*add_set_boolean_cmd (char *name
,
362 enum command_class
class,
365 struct cmd_list_element
**list
);
367 extern struct cmd_list_element
*add_show_from_set (struct cmd_list_element
*,
368 struct cmd_list_element
371 /* Do a "show" command for each thing on a command list. */
373 extern void cmd_show_list (struct cmd_list_element
*, int, char *);
375 extern NORETURN
void error_no_arg (char *) ATTR_NORETURN
;
377 extern void dont_repeat (void);
379 /* Used to mark commands that don't do anything. If we just leave the
380 function field NULL, the command is interpreted as a help topic, or
381 as a class of commands. */
383 extern void not_just_help_class_command (char *, int);
385 #endif /* !defined (COMMAND_H) */