Commit | Line | Data |
---|---|---|
d318976c | 1 | /* Header file for GDB command decoding library. |
1bac305b | 2 | |
0b302171 | 3 | Copyright (c) 2000, 2003, 2007-2012 Free Software Foundation, Inc. |
d318976c FN |
4 | |
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 | |
a9762ec7 | 7 | the Free Software Foundation; either version 3 of the License, or |
d318976c FN |
8 | (at your option) any later version. |
9 | ||
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. | |
14 | ||
15 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 16 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
d318976c FN |
17 | |
18 | #if !defined (CLI_DECODE_H) | |
19 | #define CLI_DECODE_H 1 | |
20 | ||
18a642a1 | 21 | #include "command.h" |
d318976c | 22 | |
8fe84d01 MK |
23 | struct re_pattern_buffer; |
24 | ||
18a642a1 AC |
25 | #if 0 |
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". */ | |
d318976c FN |
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 | |
32 | { | |
33 | not_set_cmd, | |
34 | set_cmd, | |
35 | show_cmd | |
36 | } | |
37 | cmd_types; | |
18a642a1 | 38 | #endif |
d318976c FN |
39 | |
40 | /* This structure records one command'd definition. */ | |
41 | ||
42 | ||
ebcd3b23 MS |
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 | |
45 | in the following struct. | |
d318976c FN |
46 | */ |
47 | #define CMD_DEPRECATED 0x1 | |
48 | #define DEPRECATED_WARN_USER 0x2 | |
49 | #define MALLOCED_REPLACEMENT 0x4 | |
50 | ||
51 | struct cmd_list_element | |
52 | { | |
53 | /* Points to next command in this list. */ | |
54 | struct cmd_list_element *next; | |
55 | ||
56 | /* Name of this command. */ | |
57 | char *name; | |
58 | ||
59 | /* Command class; class values are chosen by application program. */ | |
60 | enum command_class class; | |
61 | ||
e00d1dc8 | 62 | /* Function definition of this command. NULL for command class |
9f60d481 AC |
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 | |
66 | set_cmd_sfunc(). */ | |
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. */ | |
d318976c FN |
70 | union |
71 | { | |
9773a94b AC |
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; | |
d318976c FN |
77 | } |
78 | function; | |
d318976c | 79 | |
7d0766f3 AC |
80 | /* Local state (context) for this command. This can be anything. */ |
81 | void *context; | |
82 | ||
d318976c FN |
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. */ | |
87 | char *doc; | |
88 | ||
335cca0d AC |
89 | /* For set/show commands. A method for printing the output to the |
90 | specified stream. */ | |
08546159 | 91 | show_value_ftype *show_value_func; |
335cca0d | 92 | |
d318976c FN |
93 | /* flags : a bitfield |
94 | ||
95 | bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command | |
ebcd3b23 | 96 | is deprecated. It may be removed from gdb's command set in the |
d318976c FN |
97 | future. |
98 | ||
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. | |
102 | ||
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 | |
ebcd3b23 MS |
111 | flag. */ |
112 | ||
d318976c FN |
113 | int flags; |
114 | ||
4e18e2de | 115 | /* If this command is deprecated, this is the replacement name. */ |
d318976c FN |
116 | char *replacement; |
117 | ||
552c04a7 TT |
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); | |
121 | ||
d318976c FN |
122 | /* Hook for another command to be executed before this command. */ |
123 | struct cmd_list_element *hook_pre; | |
124 | ||
125 | /* Hook for another command to be executed after this command. */ | |
126 | struct cmd_list_element *hook_post; | |
127 | ||
0fb0cc75 | 128 | /* Flag that specifies if this command is already running its hook. */ |
4e18e2de | 129 | /* Prevents the possibility of hook recursion. */ |
d318976c FN |
130 | int hook_in; |
131 | ||
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; | |
135 | ||
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. */ | |
141 | char *prefixname; | |
142 | ||
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. */ | |
146 | char allow_unknown; | |
147 | ||
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. */ | |
152 | char abbrev_flag; | |
153 | ||
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. | |
158 | ||
ebcd3b23 MS |
159 | Return value is a malloc'd vector of pointers to possible |
160 | completions terminated with NULL. If there are no completions, | |
161 | returning a pointer to a NULL would work but returning NULL | |
162 | itself is also valid. WORD points in the same buffer as TEXT, | |
163 | and completions should be returned relative to this position. | |
164 | For example, suppose TEXT is "foo" and we want to complete to | |
165 | "foobar". If WORD is "oo", return "oobar"; if WORD is | |
166 | "baz/foo", return "baz/foobar". */ | |
167 | char **(*completer) (struct cmd_list_element *cmd, | |
168 | char *text, char *word); | |
d8906c6f TJB |
169 | |
170 | /* Destruction routine for this command. If non-NULL, this is | |
171 | called when this command instance is destroyed. This may be | |
172 | used to finalize the CONTEXT field, if needed. */ | |
173 | void (*destroyer) (struct cmd_list_element *self, void *context); | |
d318976c FN |
174 | |
175 | /* Type of "set" or "show" command (or SET_NOT_SET if not "set" | |
176 | or "show"). */ | |
177 | cmd_types type; | |
178 | ||
ebcd3b23 MS |
179 | /* Pointer to variable affected by "set" and "show". Doesn't |
180 | matter if type is not_set. */ | |
d318976c FN |
181 | void *var; |
182 | ||
183 | /* What kind of variable is *VAR? */ | |
184 | var_types var_type; | |
185 | ||
ebcd3b23 MS |
186 | /* Pointer to NULL terminated list of enumerated values (like |
187 | argv). */ | |
d318976c FN |
188 | const char **enums; |
189 | ||
190 | /* Pointer to command strings of user-defined commands */ | |
191 | struct command_line *user_commands; | |
192 | ||
193 | /* Pointer to command that is hooked by this one, (by hook_pre) | |
194 | so the hook can be removed when this one is deleted. */ | |
195 | struct cmd_list_element *hookee_pre; | |
196 | ||
197 | /* Pointer to command that is hooked by this one, (by hook_post) | |
198 | so the hook can be removed when this one is deleted. */ | |
199 | struct cmd_list_element *hookee_post; | |
200 | ||
201 | /* Pointer to command that is aliased by this one, so the | |
202 | aliased command can be located in case it has been hooked. */ | |
203 | struct cmd_list_element *cmd_pointer; | |
b05dcbb7 TT |
204 | |
205 | /* Start of a linked list of all aliases of this command. */ | |
206 | struct cmd_list_element *aliases; | |
207 | ||
208 | /* Link pointer for aliases on an alias list. */ | |
209 | struct cmd_list_element *alias_chain; | |
d318976c FN |
210 | }; |
211 | ||
1427fe5e MS |
212 | /* Flag for an ambiguous cmd_list result. */ |
213 | #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1) | |
214 | ||
d318976c FN |
215 | /* API to the manipulation of command lists. */ |
216 | ||
217 | extern struct cmd_list_element *add_cmd (char *, enum command_class, | |
218 | void (*fun) (char *, int), char *, | |
219 | struct cmd_list_element **); | |
220 | ||
221 | extern struct cmd_list_element *add_alias_cmd (char *, char *, | |
222 | enum command_class, int, | |
223 | struct cmd_list_element **); | |
224 | ||
225 | extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class, | |
226 | void (*fun) (char *, int), | |
227 | char *, | |
228 | struct cmd_list_element **, | |
229 | char *, int, | |
230 | struct cmd_list_element **); | |
231 | ||
232 | extern struct cmd_list_element *add_abbrev_prefix_cmd (char *, | |
233 | enum command_class, | |
234 | void (*fun) (char *, | |
235 | int), | |
236 | char *, | |
237 | struct cmd_list_element | |
238 | **, char *, int, | |
239 | struct cmd_list_element | |
240 | **); | |
241 | ||
9f60d481 AC |
242 | /* Set the commands corresponding callback. */ |
243 | ||
244 | extern void set_cmd_cfunc (struct cmd_list_element *cmd, | |
245 | void (*cfunc) (char *args, int from_tty)); | |
246 | ||
247 | extern void set_cmd_sfunc (struct cmd_list_element *cmd, | |
248 | void (*sfunc) (char *args, int from_tty, | |
249 | struct cmd_list_element * c)); | |
250 | ||
5ba2abeb | 251 | extern void set_cmd_completer (struct cmd_list_element *cmd, |
d8906c6f TJB |
252 | char **(*completer) (struct cmd_list_element *self, |
253 | char *text, char *word)); | |
5ba2abeb | 254 | |
bbaca940 AC |
255 | /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs |
256 | around in cmd objects to test the value of the commands sfunc(). */ | |
257 | extern int cmd_cfunc_eq (struct cmd_list_element *cmd, | |
258 | void (*cfunc) (char *args, int from_tty)); | |
9f60d481 | 259 | |
7d0766f3 AC |
260 | /* Access to the command's local context. */ |
261 | extern void set_cmd_context (struct cmd_list_element *cmd, void *context); | |
262 | extern void *get_cmd_context (struct cmd_list_element *cmd); | |
263 | ||
d318976c FN |
264 | extern struct cmd_list_element *lookup_cmd (char **, |
265 | struct cmd_list_element *, char *, | |
266 | int, int); | |
267 | ||
268 | extern struct cmd_list_element *lookup_cmd_1 (char **, | |
269 | struct cmd_list_element *, | |
270 | struct cmd_list_element **, | |
271 | int); | |
272 | ||
273 | extern struct cmd_list_element * | |
274 | deprecate_cmd (struct cmd_list_element *, char * ); | |
275 | ||
276 | extern void | |
277 | deprecated_cmd_warning (char **); | |
278 | ||
279 | extern int | |
280 | lookup_cmd_composition (char *text, | |
281 | struct cmd_list_element **alias, | |
282 | struct cmd_list_element **prefix_cmd, | |
283 | struct cmd_list_element **cmd); | |
284 | ||
285 | extern struct cmd_list_element *add_com (char *, enum command_class, | |
286 | void (*fun) (char *, int), char *); | |
287 | ||
288 | extern struct cmd_list_element *add_com_alias (char *, char *, | |
289 | enum command_class, int); | |
290 | ||
291 | extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int), | |
292 | char *); | |
293 | ||
294 | extern struct cmd_list_element *add_info_alias (char *, char *, int); | |
295 | ||
296 | extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *); | |
297 | ||
298 | extern char **complete_on_enum (const char *enumlist[], char *, char *); | |
299 | ||
d318976c FN |
300 | extern void help_cmd_list (struct cmd_list_element *, enum command_class, |
301 | char *, int, struct ui_file *); | |
302 | ||
ebcd3b23 | 303 | /* Functions that implement commands about CLI commands. */ |
d318976c FN |
304 | |
305 | extern void help_cmd (char *, struct ui_file *); | |
306 | ||
307 | extern void help_list (struct cmd_list_element *, char *, | |
308 | enum command_class, struct ui_file *); | |
309 | ||
310 | extern void apropos_cmd (struct ui_file *, struct cmd_list_element *, | |
311 | struct re_pattern_buffer *, char *); | |
312 | ||
313 | /* Used to mark commands that don't do anything. If we just leave the | |
314 | function field NULL, the command is interpreted as a help topic, or | |
315 | as a class of commands. */ | |
316 | ||
317 | extern void not_just_help_class_command (char *arg, int from_tty); | |
318 | ||
319 | /* Exported to cli/cli-setshow.c */ | |
320 | ||
321 | extern void print_doc_line (struct ui_file *, char *); | |
322 | ||
323 | ||
324 | #endif /* !defined (CLI_DECODE_H) */ |