Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Header file for command-reading library command.c. |
d9fcf2fb | 2 | Copyright (C) 1986, 1989, 1990, 2000 Free Software Foundation, Inc. |
c906108c | 3 | |
c5aa993b JM |
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. | |
c906108c | 8 | |
c5aa993b JM |
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. | |
c906108c | 13 | |
c5aa993b JM |
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. */ | |
c906108c SS |
18 | |
19 | #if !defined (COMMAND_H) | |
20 | #define COMMAND_H 1 | |
21 | ||
6426a772 JM |
22 | /* Command classes are top-level categories into which commands are broken |
23 | down for "help" purposes. | |
24 | Notes on classes: class_alias is for alias commands which are not | |
25 | abbreviations of the original command. class-pseudo is for | |
26 | commands which are not really commands nor help topics ("stop"). */ | |
27 | ||
28 | enum command_class | |
29 | { | |
30 | /* Special args to help_list */ | |
31 | class_deprecated, all_classes = -2, all_commands = -1, | |
32 | /* Classes of commands */ | |
33 | no_class = -1, class_run = 0, class_vars, class_stack, | |
34 | class_files, class_support, class_info, class_breakpoint, class_trace, | |
35 | class_alias, class_obscure, class_user, class_maintenance, | |
9285ab80 | 36 | class_pseudo, class_tui, class_xdb |
6426a772 JM |
37 | }; |
38 | ||
c906108c SS |
39 | /* Not a set/show command. Note that some commands which begin with |
40 | "set" or "show" might be in this category, if their syntax does | |
41 | not fall into one of the following categories. */ | |
c5aa993b JM |
42 | typedef enum cmd_types |
43 | { | |
44 | not_set_cmd, | |
45 | set_cmd, | |
46 | show_cmd | |
47 | } | |
48 | cmd_types; | |
c906108c | 49 | |
97c3646f AC |
50 | /* Reasonable values for an AUTO_BOOLEAN variable. */ |
51 | enum cmd_auto_boolean | |
52 | { | |
53 | CMD_AUTO_BOOLEAN_TRUE, | |
54 | CMD_AUTO_BOOLEAN_FALSE, | |
55 | CMD_AUTO_BOOLEAN_AUTO | |
56 | }; | |
57 | ||
c906108c | 58 | /* Types of "set" or "show" command. */ |
c5aa993b JM |
59 | typedef enum var_types |
60 | { | |
61 | /* "on" or "off". *VAR is an integer which is nonzero for on, | |
62 | zero for off. */ | |
63 | var_boolean, | |
97c3646f AC |
64 | |
65 | /* "on" / "true" / "enable" or "off" / "false" / "disable" or | |
66 | "auto. *VAR is an ``enum cmd_auto_boolean''. NOTE: In general | |
67 | a custom show command will need to be implemented - one that | |
68 | for "auto" prints both the "auto" and the current auto-selected | |
69 | value. */ | |
70 | var_auto_boolean, | |
71 | ||
c5aa993b JM |
72 | /* Unsigned Integer. *VAR is an unsigned int. The user can type 0 |
73 | to mean "unlimited", which is stored in *VAR as UINT_MAX. */ | |
74 | var_uinteger, | |
75 | ||
76 | /* Like var_uinteger but signed. *VAR is an int. The user can type 0 | |
77 | to mean "unlimited", which is stored in *VAR as INT_MAX. */ | |
78 | var_integer, | |
79 | ||
80 | /* String which the user enters with escapes (e.g. the user types \n and | |
81 | it is a real newline in the stored string). | |
82 | *VAR is a malloc'd string, or NULL if the string is empty. */ | |
83 | var_string, | |
84 | /* String which stores what the user types verbatim. | |
85 | *VAR is a malloc'd string, or NULL if the string is empty. */ | |
86 | var_string_noescape, | |
87 | /* String which stores a filename. | |
88 | *VAR is a malloc'd string, or NULL if the string is empty. */ | |
89 | var_filename, | |
90 | /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except | |
91 | that zero really means zero. */ | |
92 | var_zinteger, | |
93 | /* Enumerated type. Can only have one of the specified values. *VAR is a | |
94 | char pointer to the name of the element that we find. */ | |
95 | var_enum | |
96 | } | |
97 | var_types; | |
c906108c SS |
98 | |
99 | /* This structure records one command'd definition. */ | |
100 | ||
56382845 FN |
101 | |
102 | /* This flag is used by the code executing commands to warn the user | |
103 | the first time a deprecated command is used, see the 'flags' field in | |
104 | the following struct. | |
105 | */ | |
106 | #define CMD_DEPRECATED 0x1 | |
107 | #define DEPRECATED_WARN_USER 0x2 | |
108 | #define MALLOCED_REPLACEMENT 0x4 | |
109 | ||
c906108c SS |
110 | struct cmd_list_element |
111 | { | |
112 | /* Points to next command in this list. */ | |
113 | struct cmd_list_element *next; | |
114 | ||
115 | /* Name of this command. */ | |
116 | char *name; | |
117 | ||
118 | /* Command class; class values are chosen by application program. */ | |
119 | enum command_class class; | |
120 | ||
121 | /* Function definition of this command. | |
122 | NO_FUNCTION for command class names and for help topics that | |
123 | are not really commands. */ | |
124 | union | |
125 | { | |
126 | /* If type is not_set_cmd, call it like this: */ | |
507f3c78 | 127 | void (*cfunc) (char *args, int from_tty); |
c906108c SS |
128 | |
129 | /* If type is cmd_set or show_cmd, first set the variables, and | |
130 | then call this. */ | |
507f3c78 | 131 | void (*sfunc) (char *args, int from_tty, struct cmd_list_element * c); |
c5aa993b JM |
132 | } |
133 | function; | |
dee8b1a1 | 134 | #define NO_FUNCTION ((void (*) (char *args, int from_tty)) 0) |
c906108c SS |
135 | |
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. */ | |
140 | char *doc; | |
141 | ||
56382845 FN |
142 | /* flags : a bitfield |
143 | ||
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 | |
146 | future. | |
147 | ||
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. | |
151 | ||
152 | bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at | |
153 | compile time (this is the way it should, in general, be done) | |
c0c9b0b8 | 154 | the memory containing the replacement string is statically |
56382845 FN |
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 | |
160 | flag. | |
161 | */ | |
162 | int flags; | |
163 | ||
164 | /* if this command is deprecated, this is the replacement name */ | |
165 | char *replacement; | |
166 | ||
c906108c SS |
167 | /* Hook for another command to be executed before this command. */ |
168 | struct cmd_list_element *hook; | |
169 | ||
170 | /* Nonzero identifies a prefix command. For them, the address | |
171 | of the variable containing the list of subcommands. */ | |
172 | struct cmd_list_element **prefixlist; | |
173 | ||
174 | /* For prefix commands only: | |
175 | String containing prefix commands to get here: this one | |
176 | plus any others needed to get to it. Should end in a space. | |
177 | It is used before the word "command" in describing the | |
178 | commands reached through this prefix. */ | |
179 | char *prefixname; | |
180 | ||
181 | /* For prefix commands only: | |
182 | nonzero means do not get an error if subcommand is not | |
183 | recognized; call the prefix's own function in that case. */ | |
184 | char allow_unknown; | |
185 | ||
186 | /* Nonzero says this is an abbreviation, and should not | |
187 | be mentioned in lists of commands. | |
188 | This allows "br<tab>" to complete to "break", which it | |
189 | otherwise wouldn't. */ | |
190 | char abbrev_flag; | |
191 | ||
192 | /* Completion routine for this command. TEXT is the text beyond | |
193 | what was matched for the command itself (leading whitespace is | |
194 | skipped). It stops where we are supposed to stop completing | |
195 | (rl_point) and is '\0' terminated. | |
196 | ||
197 | Return value is a malloc'd vector of pointers to possible completions | |
198 | terminated with NULL. If there are no completions, returning a pointer | |
199 | to a NULL would work but returning NULL itself is also valid. | |
200 | WORD points in the same buffer as TEXT, and completions should be | |
201 | returned relative to this position. For example, suppose TEXT is "foo" | |
202 | and we want to complete to "foobar". If WORD is "oo", return | |
203 | "oobar"; if WORD is "baz/foo", return "baz/foobar". */ | |
507f3c78 | 204 | char **(*completer) (char *text, char *word); |
c906108c SS |
205 | |
206 | /* Type of "set" or "show" command (or SET_NOT_SET if not "set" | |
207 | or "show"). */ | |
208 | cmd_types type; | |
209 | ||
210 | /* Pointer to variable affected by "set" and "show". Doesn't matter | |
211 | if type is not_set. */ | |
1ed2a135 | 212 | void *var; |
c906108c SS |
213 | |
214 | /* What kind of variable is *VAR? */ | |
215 | var_types var_type; | |
216 | ||
217 | /* Pointer to NULL terminated list of enumerated values (like argv). */ | |
53904c9e | 218 | const char **enums; |
c906108c SS |
219 | |
220 | /* Pointer to command strings of user-defined commands */ | |
221 | struct command_line *user_commands; | |
222 | ||
223 | /* Pointer to command that is hooked by this one, | |
224 | so the hook can be removed when this one is deleted. */ | |
225 | struct cmd_list_element *hookee; | |
226 | ||
227 | /* Pointer to command that is aliased by this one, so the | |
228 | aliased command can be located in case it has been hooked. */ | |
229 | struct cmd_list_element *cmd_pointer; | |
230 | }; | |
231 | ||
232 | /* Forward-declarations of the entry-points of command.c. */ | |
233 | ||
a14ed312 KB |
234 | extern struct cmd_list_element *add_cmd (char *, enum command_class, |
235 | void (*fun) (char *, int), char *, | |
236 | struct cmd_list_element **); | |
237 | ||
238 | extern struct cmd_list_element *add_alias_cmd (char *, char *, | |
239 | enum command_class, int, | |
240 | struct cmd_list_element **); | |
241 | ||
242 | extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class, | |
243 | void (*fun) (char *, int), | |
244 | char *, | |
245 | struct cmd_list_element **, | |
246 | char *, int, | |
247 | struct cmd_list_element **); | |
248 | ||
249 | extern struct cmd_list_element *add_abbrev_prefix_cmd (char *, | |
250 | enum command_class, | |
251 | void (*fun) (char *, | |
252 | int), | |
253 | char *, | |
254 | struct cmd_list_element | |
255 | **, char *, int, | |
256 | struct cmd_list_element | |
257 | **); | |
258 | ||
259 | extern struct cmd_list_element *lookup_cmd (char **, | |
260 | struct cmd_list_element *, char *, | |
261 | int, int); | |
262 | ||
263 | extern struct cmd_list_element *lookup_cmd_1 (char **, | |
264 | struct cmd_list_element *, | |
265 | struct cmd_list_element **, | |
266 | int); | |
c906108c | 267 | |
56382845 FN |
268 | extern struct cmd_list_element * |
269 | deprecate_cmd (struct cmd_list_element *, char * ); | |
270 | ||
c906108c | 271 | extern void |
56382845 FN |
272 | deprecated_cmd_warning (char **); |
273 | ||
274 | extern int | |
275 | lookup_cmd_composition (char *text, | |
276 | struct cmd_list_element **alias, | |
277 | struct cmd_list_element **prefix_cmd, | |
278 | struct cmd_list_element **cmd); | |
279 | ||
a14ed312 KB |
280 | extern struct cmd_list_element *add_com (char *, enum command_class, |
281 | void (*fun) (char *, int), char *); | |
c906108c | 282 | |
a14ed312 KB |
283 | extern struct cmd_list_element *add_com_alias (char *, char *, |
284 | enum command_class, int); | |
c906108c | 285 | |
a14ed312 KB |
286 | extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int), |
287 | char *); | |
c906108c | 288 | |
a14ed312 | 289 | extern struct cmd_list_element *add_info_alias (char *, char *, int); |
c906108c | 290 | |
a14ed312 | 291 | extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *); |
c906108c | 292 | |
53904c9e | 293 | extern char **complete_on_enum (const char *enumlist[], char *, char *); |
c906108c | 294 | |
a14ed312 | 295 | extern void delete_cmd (char *, struct cmd_list_element **); |
c906108c | 296 | |
d9fcf2fb | 297 | extern void help_cmd (char *, struct ui_file *); |
c906108c | 298 | |
d9fcf2fb JM |
299 | extern void help_list (struct cmd_list_element *, char *, |
300 | enum command_class, struct ui_file *); | |
c906108c | 301 | |
d9fcf2fb JM |
302 | extern void help_cmd_list (struct cmd_list_element *, enum command_class, |
303 | char *, int, struct ui_file *); | |
c906108c | 304 | |
1ed2a135 AC |
305 | extern struct cmd_list_element *add_set_cmd (char *name, enum |
306 | command_class class, | |
307 | var_types var_type, void *var, | |
308 | char *doc, | |
309 | struct cmd_list_element **list); | |
310 | ||
311 | extern struct cmd_list_element *add_set_enum_cmd (char *name, | |
312 | enum command_class class, | |
53904c9e AC |
313 | const char *enumlist[], |
314 | const char **var, | |
1ed2a135 AC |
315 | char *doc, |
316 | struct cmd_list_element **list); | |
c906108c | 317 | |
97c3646f AC |
318 | extern struct cmd_list_element *add_set_auto_boolean_cmd (char *name, |
319 | enum command_class class, | |
320 | enum cmd_auto_boolean *var, | |
321 | char *doc, | |
322 | struct cmd_list_element **list); | |
323 | ||
a14ed312 KB |
324 | extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *, |
325 | struct cmd_list_element | |
326 | **); | |
c906108c SS |
327 | |
328 | /* Do a "set" or "show" command. ARG is NULL if no argument, or the text | |
329 | of the argument, and FROM_TTY is nonzero if this command is being entered | |
330 | directly by the user (i.e. these are just like any other | |
331 | command). C is the command list element for the command. */ | |
332 | ||
a14ed312 | 333 | extern void do_setshow_command (char *, int, struct cmd_list_element *); |
c906108c SS |
334 | |
335 | /* Do a "show" command for each thing on a command list. */ | |
336 | ||
a14ed312 | 337 | extern void cmd_show_list (struct cmd_list_element *, int, char *); |
c906108c | 338 | |
a14ed312 | 339 | extern void error_no_arg (char *); |
c906108c | 340 | |
a14ed312 | 341 | extern void dont_repeat (void); |
c906108c SS |
342 | |
343 | /* Used to mark commands that don't do anything. If we just leave the | |
344 | function field NULL, the command is interpreted as a help topic, or | |
345 | as a class of commands. */ | |
346 | ||
a14ed312 | 347 | extern void not_just_help_class_command (char *, int); |
c906108c SS |
348 | |
349 | #endif /* !defined (COMMAND_H) */ |