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 cmd_set 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 /* Hook for another command to be executed before this command. */
170 struct cmd_list_element *hook_pre;
172 /* Hook for another command to be executed after this command. */
173 struct cmd_list_element *hook_post;
175 /* Flag that specifies if this command is already running it's hook. */
176 /* Prevents the possibility of hook recursion. */
179 /* Nonzero identifies a prefix command. For them, the address
180 of the variable containing the list of subcommands. */
181 struct cmd_list_element **prefixlist;
183 /* For prefix commands only:
184 String containing prefix commands to get here: this one
185 plus any others needed to get to it. Should end in a space.
186 It is used before the word "command" in describing the
187 commands reached through this prefix. */
190 /* For prefix commands only:
191 nonzero means do not get an error if subcommand is not
192 recognized; call the prefix's own function in that case. */
195 /* Nonzero says this is an abbreviation, and should not
196 be mentioned in lists of commands.
197 This allows "br<tab>" to complete to "break", which it
198 otherwise wouldn't. */
201 /* Completion routine for this command. TEXT is the text beyond
202 what was matched for the command itself (leading whitespace is
203 skipped). It stops where we are supposed to stop completing
204 (rl_point) and is '\0' terminated.
206 Return value is a malloc'd vector of pointers to possible completions
207 terminated with NULL. If there are no completions, returning a pointer
208 to a NULL would work but returning NULL itself is also valid.
209 WORD points in the same buffer as TEXT, and completions should be
210 returned relative to this position. For example, suppose TEXT is "foo"
211 and we want to complete to "foobar". If WORD is "oo", return
212 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
213 char **(*completer) (char *text, char *word);
215 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
219 /* Pointer to variable affected by "set" and "show". Doesn't matter
220 if type is not_set. */
223 /* What kind of variable is *VAR? */
226 /* Pointer to NULL terminated list of enumerated values (like argv). */
229 /* Pointer to command strings of user-defined commands */
230 struct command_line *user_commands;
232 /* Pointer to command that is hooked by this one, (by hook_pre)
233 so the hook can be removed when this one is deleted. */
234 struct cmd_list_element *hookee_pre;
236 /* Pointer to command that is hooked by this one, (by hook_post)
237 so the hook can be removed when this one is deleted. */
238 struct cmd_list_element *hookee_post;
240 /* Pointer to command that is aliased by this one, so the
241 aliased command can be located in case it has been hooked. */
242 struct cmd_list_element *cmd_pointer;
245 /* API to the manipulation of command lists. */
247 extern struct cmd_list_element *add_cmd (char *, enum command_class,
248 void (*fun) (char *, int), char *,
249 struct cmd_list_element **);
251 extern struct cmd_list_element *add_alias_cmd (char *, char *,
252 enum command_class, int,
253 struct cmd_list_element **);
255 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
256 void (*fun) (char *, int),
258 struct cmd_list_element **,
260 struct cmd_list_element **);
262 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
267 struct cmd_list_element
269 struct cmd_list_element
272 extern struct cmd_list_element *lookup_cmd (char **,
273 struct cmd_list_element *, char *,
276 extern struct cmd_list_element *lookup_cmd_1 (char **,
277 struct cmd_list_element *,
278 struct cmd_list_element **,
281 extern struct cmd_list_element *
282 deprecate_cmd (struct cmd_list_element *, char * );
285 deprecated_cmd_warning (char **);
288 lookup_cmd_composition (char *text,
289 struct cmd_list_element **alias,
290 struct cmd_list_element **prefix_cmd,
291 struct cmd_list_element **cmd);
293 extern struct cmd_list_element *add_com (char *, enum command_class,
294 void (*fun) (char *, int), char *);
296 extern struct cmd_list_element *add_com_alias (char *, char *,
297 enum command_class, int);
299 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
302 extern struct cmd_list_element *add_info_alias (char *, char *, int);
304 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
306 extern char **complete_on_enum (const char *enumlist[], char *, char *);
308 extern void delete_cmd (char *, struct cmd_list_element **);
310 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
311 char *, int, struct ui_file *);
313 extern struct cmd_list_element *add_set_cmd (char *name, enum
315 var_types var_type, void *var,
317 struct cmd_list_element **list);
319 extern struct cmd_list_element *add_set_enum_cmd (char *name,
320 enum command_class class,
321 const char *enumlist[],
324 struct cmd_list_element **list);
326 extern struct cmd_list_element *add_set_auto_boolean_cmd (char *name,
327 enum command_class class,
328 enum cmd_auto_boolean *var,
330 struct cmd_list_element **list);
332 extern struct cmd_list_element *add_set_boolean_cmd (char *name,
333 enum command_class class,
336 struct cmd_list_element **list);
338 extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *,
339 struct cmd_list_element
342 /* Functions that implement commands about CLI commands. */
344 extern void help_cmd (char *, struct ui_file *);
346 extern void help_list (struct cmd_list_element *, char *,
347 enum command_class, struct ui_file *);
349 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
350 struct re_pattern_buffer *, char *);
352 /* Used to mark commands that don't do anything. If we just leave the
353 function field NULL, the command is interpreted as a help topic, or
354 as a class of commands. */
356 extern void not_just_help_class_command (char *arg, int from_tty);
358 /* Exported to cli/cli-setshow.c */
360 extern void print_doc_line (struct ui_file *, char *);
363 #endif /* !defined (CLI_DECODE_H) */