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. NULL for command class
124 names and for help topics that are not really commands. */
127 /* If type is not_set_cmd, call it like this: */
128 void (*cfunc
) (char *args
, int from_tty
);
130 /* If type is set_cmd or show_cmd, first set the variables, and
132 void (*sfunc
) (char *args
, int from_tty
, struct cmd_list_element
* c
);
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 /* If this command represents a show command, then this function
168 is called before the variable's value is examined. */
169 void (*pre_show_hook
) (struct cmd_list_element
*c
);
171 /* Hook for another command to be executed before this command. */
172 struct cmd_list_element
*hook_pre
;
174 /* Hook for another command to be executed after this command. */
175 struct cmd_list_element
*hook_post
;
177 /* Flag that specifies if this command is already running it's hook. */
178 /* Prevents the possibility of hook recursion. */
181 /* Nonzero identifies a prefix command. For them, the address
182 of the variable containing the list of subcommands. */
183 struct cmd_list_element
**prefixlist
;
185 /* For prefix commands only:
186 String containing prefix commands to get here: this one
187 plus any others needed to get to it. Should end in a space.
188 It is used before the word "command" in describing the
189 commands reached through this prefix. */
192 /* For prefix commands only:
193 nonzero means do not get an error if subcommand is not
194 recognized; call the prefix's own function in that case. */
197 /* Nonzero says this is an abbreviation, and should not
198 be mentioned in lists of commands.
199 This allows "br<tab>" to complete to "break", which it
200 otherwise wouldn't. */
203 /* Completion routine for this command. TEXT is the text beyond
204 what was matched for the command itself (leading whitespace is
205 skipped). It stops where we are supposed to stop completing
206 (rl_point) and is '\0' terminated.
208 Return value is a malloc'd vector of pointers to possible completions
209 terminated with NULL. If there are no completions, returning a pointer
210 to a NULL would work but returning NULL itself is also valid.
211 WORD points in the same buffer as TEXT, and completions should be
212 returned relative to this position. For example, suppose TEXT is "foo"
213 and we want to complete to "foobar". If WORD is "oo", return
214 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
215 char **(*completer
) (char *text
, char *word
);
217 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
221 /* Pointer to variable affected by "set" and "show". Doesn't matter
222 if type is not_set. */
225 /* What kind of variable is *VAR? */
228 /* Pointer to NULL terminated list of enumerated values (like argv). */
231 /* Pointer to command strings of user-defined commands */
232 struct command_line
*user_commands
;
234 /* Pointer to command that is hooked by this one, (by hook_pre)
235 so the hook can be removed when this one is deleted. */
236 struct cmd_list_element
*hookee_pre
;
238 /* Pointer to command that is hooked by this one, (by hook_post)
239 so the hook can be removed when this one is deleted. */
240 struct cmd_list_element
*hookee_post
;
242 /* Pointer to command that is aliased by this one, so the
243 aliased command can be located in case it has been hooked. */
244 struct cmd_list_element
*cmd_pointer
;
247 /* API to the manipulation of command lists. */
249 extern struct cmd_list_element
*add_cmd (char *, enum command_class
,
250 void (*fun
) (char *, int), char *,
251 struct cmd_list_element
**);
253 extern struct cmd_list_element
*add_alias_cmd (char *, char *,
254 enum command_class
, int,
255 struct cmd_list_element
**);
257 extern struct cmd_list_element
*add_prefix_cmd (char *, enum command_class
,
258 void (*fun
) (char *, int),
260 struct cmd_list_element
**,
262 struct cmd_list_element
**);
264 extern struct cmd_list_element
*add_abbrev_prefix_cmd (char *,
269 struct cmd_list_element
271 struct cmd_list_element
274 extern struct cmd_list_element
*lookup_cmd (char **,
275 struct cmd_list_element
*, char *,
278 extern struct cmd_list_element
*lookup_cmd_1 (char **,
279 struct cmd_list_element
*,
280 struct cmd_list_element
**,
283 extern struct cmd_list_element
*
284 deprecate_cmd (struct cmd_list_element
*, char * );
287 deprecated_cmd_warning (char **);
290 lookup_cmd_composition (char *text
,
291 struct cmd_list_element
**alias
,
292 struct cmd_list_element
**prefix_cmd
,
293 struct cmd_list_element
**cmd
);
295 extern struct cmd_list_element
*add_com (char *, enum command_class
,
296 void (*fun
) (char *, int), char *);
298 extern struct cmd_list_element
*add_com_alias (char *, char *,
299 enum command_class
, int);
301 extern struct cmd_list_element
*add_info (char *, void (*fun
) (char *, int),
304 extern struct cmd_list_element
*add_info_alias (char *, char *, int);
306 extern char **complete_on_cmdlist (struct cmd_list_element
*, char *, char *);
308 extern char **complete_on_enum (const char *enumlist
[], char *, char *);
310 extern void delete_cmd (char *, struct cmd_list_element
**);
312 extern void help_cmd_list (struct cmd_list_element
*, enum command_class
,
313 char *, int, struct ui_file
*);
315 extern struct cmd_list_element
*add_set_cmd (char *name
, enum
317 var_types var_type
, void *var
,
319 struct cmd_list_element
**list
);
321 extern struct cmd_list_element
*add_set_enum_cmd (char *name
,
322 enum command_class
class,
323 const char *enumlist
[],
326 struct cmd_list_element
**list
);
328 extern struct cmd_list_element
*add_set_auto_boolean_cmd (char *name
,
329 enum command_class
class,
330 enum cmd_auto_boolean
*var
,
332 struct cmd_list_element
**list
);
334 extern struct cmd_list_element
*add_set_boolean_cmd (char *name
,
335 enum command_class
class,
338 struct cmd_list_element
**list
);
340 extern struct cmd_list_element
*add_show_from_set (struct cmd_list_element
*,
341 struct cmd_list_element
344 /* Functions that implement commands about CLI commands. */
346 extern void help_cmd (char *, struct ui_file
*);
348 extern void help_list (struct cmd_list_element
*, char *,
349 enum command_class
, struct ui_file
*);
351 extern void apropos_cmd (struct ui_file
*, struct cmd_list_element
*,
352 struct re_pattern_buffer
*, char *);
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 *arg
, int from_tty
);
360 /* Exported to cli/cli-setshow.c */
362 extern void print_doc_line (struct ui_file
*, char *);
365 #endif /* !defined (CLI_DECODE_H) */
This page took 0.046541 seconds and 4 git commands to generate.