1 /* Header file for GDB command decoding library.
2 Copyright 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 (CLI_DECODE_H)
20 #define CLI_DECODE_H 1
22 #include "gdb_regex.h" /* Needed by apropos_cmd. */
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 /* Not a set/show command. Note that some commands which begin with
42 "set" or "show" might be in this category, if their syntax does
43 not fall into one of the following categories. */
44 typedef enum cmd_types
52 /* Reasonable values for an AUTO_BOOLEAN variable. */
55 CMD_AUTO_BOOLEAN_TRUE
,
56 CMD_AUTO_BOOLEAN_FALSE
,
60 /* Types of "set" or "show" command. */
61 typedef enum var_types
63 /* "on" or "off". *VAR is an integer which is nonzero for on,
67 /* "on" / "true" / "enable" or "off" / "false" / "disable" or
68 "auto. *VAR is an ``enum cmd_auto_boolean''. NOTE: In general
69 a custom show command will need to be implemented - one that
70 for "auto" prints both the "auto" and the current auto-selected
74 /* Unsigned Integer. *VAR is an unsigned int. The user can type 0
75 to mean "unlimited", which is stored in *VAR as UINT_MAX. */
78 /* Like var_uinteger but signed. *VAR is an int. The user can type 0
79 to mean "unlimited", which is stored in *VAR as INT_MAX. */
82 /* String which the user enters with escapes (e.g. the user types \n and
83 it is a real newline in the stored string).
84 *VAR is a malloc'd string, or NULL if the string is empty. */
86 /* String which stores what the user types verbatim.
87 *VAR is a malloc'd string, or NULL if the string is empty. */
89 /* String which stores a filename.
90 *VAR is a malloc'd string, or NULL if the string is empty. */
92 /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except
93 that zero really means zero. */
95 /* Enumerated type. Can only have one of the specified values. *VAR is a
96 char pointer to the name of the element that we find. */
101 /* This structure records one command'd definition. */
104 /* This flag is used by the code executing commands to warn the user
105 the first time a deprecated command is used, see the 'flags' field in
106 the following struct.
108 #define CMD_DEPRECATED 0x1
109 #define DEPRECATED_WARN_USER 0x2
110 #define MALLOCED_REPLACEMENT 0x4
112 struct cmd_list_element
114 /* Points to next command in this list. */
115 struct cmd_list_element
*next
;
117 /* Name of this command. */
120 /* Command class; class values are chosen by application program. */
121 enum command_class
class;
123 /* Function definition of this command.
124 NO_FUNCTION for command class names and for help topics that
125 are not really commands. */
128 /* If type is not_set_cmd, call it like this: */
129 void (*cfunc
) (char *args
, int from_tty
);
131 /* If type is set_cmd or show_cmd, first set the variables, and
133 void (*sfunc
) (char *args
, int from_tty
, struct cmd_list_element
* c
);
136 #define NO_FUNCTION ((void (*) (char *args, int from_tty)) 0)
138 /* Documentation of this command (or help topic).
139 First line is brief documentation; remaining lines form, with it,
140 the full documentation. First line should end with a period.
141 Entire string should also end with a period, not a newline. */
144 /* flags : a bitfield
146 bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
147 is deprecated. It may be removed from gdb's command set in the
150 bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
151 this is a deprecated command. The user should only be warned
152 the first time a command is used.
154 bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
155 compile time (this is the way it should, in general, be done)
156 the memory containing the replacement string is statically
157 allocated. In some cases it makes sense to deprecate commands
158 at runtime (the testsuite is one example). In this case the
159 memory for replacement is malloc'ed. When a command is
160 undeprecated or re-deprecated at runtime we don't want to risk
161 calling free on statically allocated memory, so we check this
166 /* if this command is deprecated, this is the replacement name */
169 /* If this command represents a show command, then this function
170 is called before the variable's value is examined. */
171 void (*pre_show_hook
) (struct cmd_list_element
*c
);
173 /* Hook for another command to be executed before this command. */
174 struct cmd_list_element
*hook_pre
;
176 /* Hook for another command to be executed after this command. */
177 struct cmd_list_element
*hook_post
;
179 /* Flag that specifies if this command is already running it's hook. */
180 /* Prevents the possibility of hook recursion. */
183 /* Nonzero identifies a prefix command. For them, the address
184 of the variable containing the list of subcommands. */
185 struct cmd_list_element
**prefixlist
;
187 /* For prefix commands only:
188 String containing prefix commands to get here: this one
189 plus any others needed to get to it. Should end in a space.
190 It is used before the word "command" in describing the
191 commands reached through this prefix. */
194 /* For prefix commands only:
195 nonzero means do not get an error if subcommand is not
196 recognized; call the prefix's own function in that case. */
199 /* Nonzero says this is an abbreviation, and should not
200 be mentioned in lists of commands.
201 This allows "br<tab>" to complete to "break", which it
202 otherwise wouldn't. */
205 /* Completion routine for this command. TEXT is the text beyond
206 what was matched for the command itself (leading whitespace is
207 skipped). It stops where we are supposed to stop completing
208 (rl_point) and is '\0' terminated.
210 Return value is a malloc'd vector of pointers to possible completions
211 terminated with NULL. If there are no completions, returning a pointer
212 to a NULL would work but returning NULL itself is also valid.
213 WORD points in the same buffer as TEXT, and completions should be
214 returned relative to this position. For example, suppose TEXT is "foo"
215 and we want to complete to "foobar". If WORD is "oo", return
216 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
217 char **(*completer
) (char *text
, char *word
);
219 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
223 /* Pointer to variable affected by "set" and "show". Doesn't matter
224 if type is not_set. */
227 /* What kind of variable is *VAR? */
230 /* Pointer to NULL terminated list of enumerated values (like argv). */
233 /* Pointer to command strings of user-defined commands */
234 struct command_line
*user_commands
;
236 /* Pointer to command that is hooked by this one, (by hook_pre)
237 so the hook can be removed when this one is deleted. */
238 struct cmd_list_element
*hookee_pre
;
240 /* Pointer to command that is hooked by this one, (by hook_post)
241 so the hook can be removed when this one is deleted. */
242 struct cmd_list_element
*hookee_post
;
244 /* Pointer to command that is aliased by this one, so the
245 aliased command can be located in case it has been hooked. */
246 struct cmd_list_element
*cmd_pointer
;
249 /* API to the manipulation of command lists. */
251 extern struct cmd_list_element
*add_cmd (char *, enum command_class
,
252 void (*fun
) (char *, int), char *,
253 struct cmd_list_element
**);
255 extern struct cmd_list_element
*add_alias_cmd (char *, char *,
256 enum command_class
, int,
257 struct cmd_list_element
**);
259 extern struct cmd_list_element
*add_prefix_cmd (char *, enum command_class
,
260 void (*fun
) (char *, int),
262 struct cmd_list_element
**,
264 struct cmd_list_element
**);
266 extern struct cmd_list_element
*add_abbrev_prefix_cmd (char *,
271 struct cmd_list_element
273 struct cmd_list_element
276 extern struct cmd_list_element
*lookup_cmd (char **,
277 struct cmd_list_element
*, char *,
280 extern struct cmd_list_element
*lookup_cmd_1 (char **,
281 struct cmd_list_element
*,
282 struct cmd_list_element
**,
285 extern struct cmd_list_element
*
286 deprecate_cmd (struct cmd_list_element
*, char * );
289 deprecated_cmd_warning (char **);
292 lookup_cmd_composition (char *text
,
293 struct cmd_list_element
**alias
,
294 struct cmd_list_element
**prefix_cmd
,
295 struct cmd_list_element
**cmd
);
297 extern struct cmd_list_element
*add_com (char *, enum command_class
,
298 void (*fun
) (char *, int), char *);
300 extern struct cmd_list_element
*add_com_alias (char *, char *,
301 enum command_class
, int);
303 extern struct cmd_list_element
*add_info (char *, void (*fun
) (char *, int),
306 extern struct cmd_list_element
*add_info_alias (char *, char *, int);
308 extern char **complete_on_cmdlist (struct cmd_list_element
*, char *, char *);
310 extern char **complete_on_enum (const char *enumlist
[], char *, char *);
312 extern void delete_cmd (char *, struct cmd_list_element
**);
314 extern void help_cmd_list (struct cmd_list_element
*, enum command_class
,
315 char *, int, struct ui_file
*);
317 extern struct cmd_list_element
*add_set_cmd (char *name
, enum
319 var_types var_type
, void *var
,
321 struct cmd_list_element
**list
);
323 extern struct cmd_list_element
*add_set_enum_cmd (char *name
,
324 enum command_class
class,
325 const char *enumlist
[],
328 struct cmd_list_element
**list
);
330 extern struct cmd_list_element
*add_set_auto_boolean_cmd (char *name
,
331 enum command_class
class,
332 enum cmd_auto_boolean
*var
,
334 struct cmd_list_element
**list
);
336 extern struct cmd_list_element
*add_set_boolean_cmd (char *name
,
337 enum command_class
class,
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 /* Functions that implement commands about CLI commands. */
348 extern void help_cmd (char *, struct ui_file
*);
350 extern void help_list (struct cmd_list_element
*, char *,
351 enum command_class
, struct ui_file
*);
353 extern void apropos_cmd (struct ui_file
*, struct cmd_list_element
*,
354 struct re_pattern_buffer
*, char *);
356 /* Used to mark commands that don't do anything. If we just leave the
357 function field NULL, the command is interpreted as a help topic, or
358 as a class of commands. */
360 extern void not_just_help_class_command (char *arg
, int from_tty
);
362 /* Exported to cli/cli-setshow.c */
364 extern void print_doc_line (struct ui_file
*, char *);
367 #endif /* !defined (CLI_DECODE_H) */
This page took 0.037405 seconds and 5 git commands to generate.