1 /* Header file for GDB command decoding library.
3 Copyright (c) 2000, 2003, 2007, 2008 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
18 #if !defined (CLI_DECODE_H)
19 #define CLI_DECODE_H 1
23 struct re_pattern_buffer;
26 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
27 cmd_types'' can be moved from "command.h" to "cli-decode.h". */
28 /* Not a set/show command. Note that some commands which begin with
29 "set" or "show" might be in this category, if their syntax does
30 not fall into one of the following categories. */
31 typedef enum cmd_types
40 /* This structure records one command'd definition. */
43 /* This flag is used by the code executing commands to warn the user
44 the first time a deprecated command is used, see the 'flags' field in
47 #define CMD_DEPRECATED 0x1
48 #define DEPRECATED_WARN_USER 0x2
49 #define MALLOCED_REPLACEMENT 0x4
51 struct cmd_list_element
53 /* Points to next command in this list. */
54 struct cmd_list_element *next;
56 /* Name of this command. */
59 /* Command class; class values are chosen by application program. */
60 enum command_class class;
62 /* Function definition of this command. NULL for command class
63 names and for help topics that are not really commands. NOTE:
64 cagney/2002-02-02: This function signature is evolving. For
65 the moment suggest sticking with either set_cmd_cfunc() or
67 void (*func) (struct cmd_list_element *c, char *args, int from_tty);
68 /* The command's real callback. At present func() bounces through
69 to one of the below. */
72 /* If type is not_set_cmd, call it like this: */
73 cmd_cfunc_ftype *cfunc;
74 /* If type is set_cmd or show_cmd, first set the variables,
75 and then call this: */
76 cmd_sfunc_ftype *sfunc;
80 /* Local state (context) for this command. This can be anything. */
83 /* Documentation of this command (or help topic).
84 First line is brief documentation; remaining lines form, with it,
85 the full documentation. First line should end with a period.
86 Entire string should also end with a period, not a newline. */
89 /* For set/show commands. A method for printing the output to the
91 show_value_ftype *show_value_func;
95 bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
96 is deprecated. It may be removed from gdb's command set in the
99 bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
100 this is a deprecated command. The user should only be warned
101 the first time a command is used.
103 bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
104 compile time (this is the way it should, in general, be done)
105 the memory containing the replacement string is statically
106 allocated. In some cases it makes sense to deprecate commands
107 at runtime (the testsuite is one example). In this case the
108 memory for replacement is malloc'ed. When a command is
109 undeprecated or re-deprecated at runtime we don't want to risk
110 calling free on statically allocated memory, so we check this
115 /* If this command is deprecated, this is the replacement name. */
118 /* If this command represents a show command, then this function
119 is called before the variable's value is examined. */
120 void (*pre_show_hook) (struct cmd_list_element *c);
122 /* Hook for another command to be executed before this command. */
123 struct cmd_list_element *hook_pre;
125 /* Hook for another command to be executed after this command. */
126 struct cmd_list_element *hook_post;
128 /* Flag that specifies if this command is already running it's hook. */
129 /* Prevents the possibility of hook recursion. */
132 /* Nonzero identifies a prefix command. For them, the address
133 of the variable containing the list of subcommands. */
134 struct cmd_list_element **prefixlist;
136 /* For prefix commands only:
137 String containing prefix commands to get here: this one
138 plus any others needed to get to it. Should end in a space.
139 It is used before the word "command" in describing the
140 commands reached through this prefix. */
143 /* For prefix commands only:
144 nonzero means do not get an error if subcommand is not
145 recognized; call the prefix's own function in that case. */
148 /* Nonzero says this is an abbreviation, and should not
149 be mentioned in lists of commands.
150 This allows "br<tab>" to complete to "break", which it
151 otherwise wouldn't. */
154 /* Completion routine for this command. TEXT is the text beyond
155 what was matched for the command itself (leading whitespace is
156 skipped). It stops where we are supposed to stop completing
157 (rl_point) and is '\0' terminated.
159 Return value is a malloc'd vector of pointers to possible completions
160 terminated with NULL. If there are no completions, returning a pointer
161 to a NULL would work but returning NULL itself is also valid.
162 WORD points in the same buffer as TEXT, and completions should be
163 returned relative to this position. For example, suppose TEXT is "foo"
164 and we want to complete to "foobar". If WORD is "oo", return
165 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
166 char **(*completer) (char *text, char *word);
168 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
172 /* Pointer to variable affected by "set" and "show". Doesn't matter
173 if type is not_set. */
176 /* What kind of variable is *VAR? */
179 /* Pointer to NULL terminated list of enumerated values (like argv). */
182 /* Pointer to command strings of user-defined commands */
183 struct command_line *user_commands;
185 /* Pointer to command that is hooked by this one, (by hook_pre)
186 so the hook can be removed when this one is deleted. */
187 struct cmd_list_element *hookee_pre;
189 /* Pointer to command that is hooked by this one, (by hook_post)
190 so the hook can be removed when this one is deleted. */
191 struct cmd_list_element *hookee_post;
193 /* Pointer to command that is aliased by this one, so the
194 aliased command can be located in case it has been hooked. */
195 struct cmd_list_element *cmd_pointer;
198 /* API to the manipulation of command lists. */
200 extern struct cmd_list_element *add_cmd (char *, enum command_class,
201 void (*fun) (char *, int), char *,
202 struct cmd_list_element **);
204 extern struct cmd_list_element *add_alias_cmd (char *, char *,
205 enum command_class, int,
206 struct cmd_list_element **);
208 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
209 void (*fun) (char *, int),
211 struct cmd_list_element **,
213 struct cmd_list_element **);
215 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
220 struct cmd_list_element
222 struct cmd_list_element
225 /* Set the commands corresponding callback. */
227 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
228 void (*cfunc) (char *args, int from_tty));
230 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
231 void (*sfunc) (char *args, int from_tty,
232 struct cmd_list_element * c));
234 extern void set_cmd_completer (struct cmd_list_element *cmd,
235 char **(*completer) (char *text, char *word));
237 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
238 around in cmd objects to test the value of the commands sfunc(). */
239 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
240 void (*cfunc) (char *args, int from_tty));
242 /* Access to the command's local context. */
243 extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
244 extern void *get_cmd_context (struct cmd_list_element *cmd);
246 extern struct cmd_list_element *lookup_cmd (char **,
247 struct cmd_list_element *, char *,
250 extern struct cmd_list_element *lookup_cmd_1 (char **,
251 struct cmd_list_element *,
252 struct cmd_list_element **,
255 extern struct cmd_list_element *
256 deprecate_cmd (struct cmd_list_element *, char * );
259 deprecated_cmd_warning (char **);
262 lookup_cmd_composition (char *text,
263 struct cmd_list_element **alias,
264 struct cmd_list_element **prefix_cmd,
265 struct cmd_list_element **cmd);
267 extern struct cmd_list_element *add_com (char *, enum command_class,
268 void (*fun) (char *, int), char *);
270 extern struct cmd_list_element *add_com_alias (char *, char *,
271 enum command_class, int);
273 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
276 extern struct cmd_list_element *add_info_alias (char *, char *, int);
278 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
280 extern char **complete_on_enum (const char *enumlist[], char *, char *);
282 extern void delete_cmd (char *, struct cmd_list_element **);
284 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
285 char *, int, struct ui_file *);
287 /* Functions that implement commands about CLI commands. */
289 extern void help_cmd (char *, struct ui_file *);
291 extern void help_list (struct cmd_list_element *, char *,
292 enum command_class, struct ui_file *);
294 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
295 struct re_pattern_buffer *, char *);
297 /* Used to mark commands that don't do anything. If we just leave the
298 function field NULL, the command is interpreted as a help topic, or
299 as a class of commands. */
301 extern void not_just_help_class_command (char *arg, int from_tty);
303 /* Exported to cli/cli-setshow.c */
305 extern void print_doc_line (struct ui_file *, char *);
308 #endif /* !defined (CLI_DECODE_H) */