Commit | Line | Data |
---|---|---|
50aeff07 | 1 | /* Header file for command creation. |
18a642a1 | 2 | |
0b302171 JB |
3 | Copyright (C) 1986, 1989-1995, 1999-2000, 2002, 2004, 2007-2012 Free |
4 | Software Foundation, Inc. | |
c906108c | 5 | |
c5aa993b JM |
6 | This program is free software; you can redistribute it and/or modify |
7 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 8 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 9 | (at your option) any later version. |
c906108c | 10 | |
c5aa993b JM |
11 | This program is distributed in the hope that it will be useful, |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
c906108c | 15 | |
c5aa993b | 16 | You should have received a copy of the GNU General Public License |
a9762ec7 | 17 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
18 | |
19 | #if !defined (COMMAND_H) | |
20 | #define COMMAND_H 1 | |
21 | ||
49c4e619 TT |
22 | #include "gdb_vecs.h" |
23 | ||
50aeff07 PA |
24 | /* This file defines the public interface for any code wanting to |
25 | create commands. */ | |
26 | ||
aff410f1 MS |
27 | /* Command classes are top-level categories into which commands are |
28 | broken down for "help" purposes. | |
29 | ||
6426a772 JM |
30 | Notes on classes: class_alias is for alias commands which are not |
31 | abbreviations of the original command. class-pseudo is for | |
32 | commands which are not really commands nor help topics ("stop"). */ | |
33 | ||
34 | enum command_class | |
35 | { | |
36 | /* Special args to help_list */ | |
6e381ba0 | 37 | class_deprecated = -3, all_classes = -2, all_commands = -1, |
6426a772 | 38 | /* Classes of commands */ |
aff410f1 MS |
39 | no_class = -1, class_run = 0, class_vars, class_stack, class_files, |
40 | class_support, class_info, class_breakpoint, class_trace, | |
6b04bdb7 | 41 | class_alias, class_bookmark, class_obscure, class_maintenance, |
db5f229b MS |
42 | class_pseudo, class_tui, class_user, class_xdb, |
43 | no_set_class /* Used for "show" commands that have no corresponding | |
44 | "set" command. */ | |
6426a772 JM |
45 | }; |
46 | ||
18a642a1 AC |
47 | /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum |
48 | cmd_types'' can be moved from "command.h" to "cli-decode.h". */ | |
c906108c SS |
49 | /* Not a set/show command. Note that some commands which begin with |
50 | "set" or "show" might be in this category, if their syntax does | |
51 | not fall into one of the following categories. */ | |
c5aa993b JM |
52 | typedef enum cmd_types |
53 | { | |
54 | not_set_cmd, | |
55 | set_cmd, | |
56 | show_cmd | |
57 | } | |
58 | cmd_types; | |
c906108c SS |
59 | |
60 | /* Types of "set" or "show" command. */ | |
c5aa993b JM |
61 | typedef enum var_types |
62 | { | |
63 | /* "on" or "off". *VAR is an integer which is nonzero for on, | |
64 | zero for off. */ | |
65 | var_boolean, | |
97c3646f AC |
66 | |
67 | /* "on" / "true" / "enable" or "off" / "false" / "disable" or | |
7f19b9a2 AC |
68 | "auto. *VAR is an ``enum auto_boolean''. NOTE: In general a |
69 | custom show command will need to be implemented - one that for | |
70 | "auto" prints both the "auto" and the current auto-selected | |
ebcd3b23 | 71 | value. */ |
97c3646f AC |
72 | var_auto_boolean, |
73 | ||
aff410f1 MS |
74 | /* Unsigned Integer. *VAR is an unsigned int. The user can type |
75 | 0 to mean "unlimited", which is stored in *VAR as UINT_MAX. */ | |
c5aa993b JM |
76 | var_uinteger, |
77 | ||
aff410f1 MS |
78 | /* Like var_uinteger but signed. *VAR is an int. The user can |
79 | type 0 to mean "unlimited", which is stored in *VAR as | |
6fc1c773 YQ |
80 | INT_MAX. The only remaining use of it is the Python API. |
81 | Don't use it elsewhere. */ | |
c5aa993b JM |
82 | var_integer, |
83 | ||
aff410f1 MS |
84 | /* String which the user enters with escapes (e.g. the user types |
85 | \n and it is a real newline in the stored string). | |
c5aa993b JM |
86 | *VAR is a malloc'd string, or NULL if the string is empty. */ |
87 | var_string, | |
88 | /* String which stores what the user types verbatim. | |
89 | *VAR is a malloc'd string, or NULL if the string is empty. */ | |
90 | var_string_noescape, | |
b4b4ac0b AC |
91 | /* String which stores a filename. (*VAR) is a malloc'd string, |
92 | or "" if the string was empty. */ | |
93 | var_optional_filename, | |
94 | /* String which stores a filename. (*VAR) is a malloc'd | |
95 | string. */ | |
c5aa993b | 96 | var_filename, |
a7c3d162 | 97 | /* ZeroableInteger. *VAR is an int. Like var_integer except |
c5aa993b JM |
98 | that zero really means zero. */ |
99 | var_zinteger, | |
1e8fb976 PA |
100 | /* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really |
101 | means zero. */ | |
102 | var_zuinteger, | |
6fc1c773 YQ |
103 | /* ZeroableUnsignedInteger with unlimited value. *VAR is an unsigned |
104 | int, but its range is [0, INT_MAX]. -1 stands for unlimited. */ | |
105 | var_zuinteger_unlimited, | |
aff410f1 MS |
106 | /* Enumerated type. Can only have one of the specified values. |
107 | *VAR is a char pointer to the name of the element that we | |
108 | find. */ | |
c5aa993b JM |
109 | var_enum |
110 | } | |
111 | var_types; | |
c906108c SS |
112 | |
113 | /* This structure records one command'd definition. */ | |
18a642a1 | 114 | struct cmd_list_element; |
c906108c | 115 | |
18d5d590 | 116 | /* Forward-declarations of the entry-points of cli/cli-decode.c. */ |
c906108c | 117 | |
50aeff07 PA |
118 | /* API to the manipulation of command lists. */ |
119 | ||
5a56e9c5 DE |
120 | extern int valid_user_defined_cmd_name_p (const char *name); |
121 | ||
a14ed312 KB |
122 | extern struct cmd_list_element *add_cmd (char *, enum command_class, |
123 | void (*fun) (char *, int), char *, | |
124 | struct cmd_list_element **); | |
125 | ||
126 | extern struct cmd_list_element *add_alias_cmd (char *, char *, | |
127 | enum command_class, int, | |
128 | struct cmd_list_element **); | |
129 | ||
130 | extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class, | |
131 | void (*fun) (char *, int), | |
132 | char *, | |
133 | struct cmd_list_element **, | |
134 | char *, int, | |
135 | struct cmd_list_element **); | |
136 | ||
137 | extern struct cmd_list_element *add_abbrev_prefix_cmd (char *, | |
138 | enum command_class, | |
139 | void (*fun) (char *, | |
140 | int), | |
141 | char *, | |
142 | struct cmd_list_element | |
143 | **, char *, int, | |
144 | struct cmd_list_element | |
145 | **); | |
146 | ||
9f60d481 AC |
147 | /* Set the commands corresponding callback. */ |
148 | ||
9773a94b | 149 | typedef void cmd_cfunc_ftype (char *args, int from_tty); |
9f60d481 | 150 | extern void set_cmd_cfunc (struct cmd_list_element *cmd, |
9773a94b | 151 | cmd_cfunc_ftype *cfunc); |
9f60d481 | 152 | |
9773a94b AC |
153 | typedef void cmd_sfunc_ftype (char *args, int from_tty, |
154 | struct cmd_list_element *c); | |
9f60d481 | 155 | extern void set_cmd_sfunc (struct cmd_list_element *cmd, |
9773a94b | 156 | cmd_sfunc_ftype *sfunc); |
9f60d481 | 157 | |
49c4e619 TT |
158 | typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *, |
159 | char *, char *); | |
625e8578 TT |
160 | |
161 | extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *); | |
5ba2abeb | 162 | |
bbaca940 AC |
163 | /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs |
164 | around in cmd objects to test the value of the commands sfunc(). */ | |
165 | extern int cmd_cfunc_eq (struct cmd_list_element *cmd, | |
166 | void (*cfunc) (char *args, int from_tty)); | |
9f60d481 | 167 | |
ebcd3b23 | 168 | /* Each command object has a local context attached to it. */ |
aff410f1 MS |
169 | extern void set_cmd_context (struct cmd_list_element *cmd, |
170 | void *context); | |
7d0766f3 AC |
171 | extern void *get_cmd_context (struct cmd_list_element *cmd); |
172 | ||
173 | ||
5913bcb0 AC |
174 | /* Execute CMD's pre/post hook. Throw an error if the command fails. |
175 | If already executing this pre/post hook, or there is no pre/post | |
176 | hook, the call is silently ignored. */ | |
177 | extern void execute_cmd_pre_hook (struct cmd_list_element *cmd); | |
178 | extern void execute_cmd_post_hook (struct cmd_list_element *cmd); | |
179 | ||
1868c04e | 180 | /* Return the type of the command. */ |
1868c04e AC |
181 | extern enum cmd_types cmd_type (struct cmd_list_element *cmd); |
182 | ||
50aeff07 PA |
183 | /* Flag for an ambiguous cmd_list result. */ |
184 | #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1) | |
1868c04e | 185 | |
a14ed312 KB |
186 | extern struct cmd_list_element *lookup_cmd (char **, |
187 | struct cmd_list_element *, char *, | |
188 | int, int); | |
189 | ||
190 | extern struct cmd_list_element *lookup_cmd_1 (char **, | |
191 | struct cmd_list_element *, | |
192 | struct cmd_list_element **, | |
193 | int); | |
c906108c | 194 | |
aff410f1 MS |
195 | extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *, |
196 | char * ); | |
56382845 | 197 | |
aff410f1 | 198 | extern void deprecated_cmd_warning (char **); |
56382845 | 199 | |
aff410f1 MS |
200 | extern int lookup_cmd_composition (char *text, |
201 | struct cmd_list_element **alias, | |
202 | struct cmd_list_element **prefix_cmd, | |
203 | struct cmd_list_element **cmd); | |
56382845 | 204 | |
a14ed312 | 205 | extern struct cmd_list_element *add_com (char *, enum command_class, |
aff410f1 MS |
206 | void (*fun) (char *, int), |
207 | char *); | |
c906108c | 208 | |
a14ed312 KB |
209 | extern struct cmd_list_element *add_com_alias (char *, char *, |
210 | enum command_class, int); | |
c906108c | 211 | |
aff410f1 MS |
212 | extern struct cmd_list_element *add_info (char *, |
213 | void (*fun) (char *, int), | |
a14ed312 | 214 | char *); |
c906108c | 215 | |
a14ed312 | 216 | extern struct cmd_list_element *add_info_alias (char *, char *, int); |
c906108c | 217 | |
49c4e619 | 218 | extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *, |
ace21957 | 219 | char *, char *, int); |
c906108c | 220 | |
49c4e619 TT |
221 | extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist, |
222 | char *, char *); | |
c906108c | 223 | |
50aeff07 | 224 | /* Functions that implement commands about CLI commands. */ |
c906108c | 225 | |
d9fcf2fb JM |
226 | extern void help_list (struct cmd_list_element *, char *, |
227 | enum command_class, struct ui_file *); | |
c906108c | 228 | |
08546159 AC |
229 | /* Method for show a set/show variable's VALUE on FILE. If this |
230 | method isn't supplied deprecated_show_value_hack() is called (which | |
231 | is not good). */ | |
232 | typedef void (show_value_ftype) (struct ui_file *file, | |
233 | int from_tty, | |
234 | struct cmd_list_element *cmd, | |
235 | const char *value); | |
236 | /* NOTE: i18n: This function is not i18n friendly. Callers should | |
237 | instead print the value out directly. */ | |
238 | extern show_value_ftype deprecated_show_value_hack; | |
239 | ||
1b295c3d AC |
240 | extern void add_setshow_enum_cmd (char *name, |
241 | enum command_class class, | |
40478521 | 242 | const char *const *enumlist, |
1b295c3d AC |
243 | const char **var, |
244 | const char *set_doc, | |
245 | const char *show_doc, | |
246 | const char *help_doc, | |
1b295c3d | 247 | cmd_sfunc_ftype *set_func, |
08546159 | 248 | show_value_ftype *show_func, |
1b295c3d | 249 | struct cmd_list_element **set_list, |
7376b4c2 | 250 | struct cmd_list_element **show_list); |
c906108c | 251 | |
e9e68a56 AC |
252 | extern void add_setshow_auto_boolean_cmd (char *name, |
253 | enum command_class class, | |
254 | enum auto_boolean *var, | |
3b64bf98 AC |
255 | const char *set_doc, |
256 | const char *show_doc, | |
257 | const char *help_doc, | |
e9e68a56 | 258 | cmd_sfunc_ftype *set_func, |
08546159 | 259 | show_value_ftype *show_func, |
e9e68a56 AC |
260 | struct cmd_list_element **set_list, |
261 | struct cmd_list_element **show_list); | |
97c3646f | 262 | |
e707bbc2 AC |
263 | extern void add_setshow_boolean_cmd (char *name, |
264 | enum command_class class, | |
265 | int *var, | |
3b64bf98 | 266 | const char *set_doc, const char *show_doc, |
2c5b56ce | 267 | const char *help_doc, |
e707bbc2 | 268 | cmd_sfunc_ftype *set_func, |
08546159 | 269 | show_value_ftype *show_func, |
e707bbc2 AC |
270 | struct cmd_list_element **set_list, |
271 | struct cmd_list_element **show_list); | |
f3796e26 | 272 | |
b3f42336 AC |
273 | extern void add_setshow_filename_cmd (char *name, |
274 | enum command_class class, | |
275 | char **var, | |
276 | const char *set_doc, | |
277 | const char *show_doc, | |
278 | const char *help_doc, | |
b3f42336 | 279 | cmd_sfunc_ftype *set_func, |
08546159 | 280 | show_value_ftype *show_func, |
b3f42336 AC |
281 | struct cmd_list_element **set_list, |
282 | struct cmd_list_element **show_list); | |
283 | ||
5efd5804 PA |
284 | extern void add_setshow_string_cmd (char *name, |
285 | enum command_class class, | |
286 | char **var, | |
287 | const char *set_doc, | |
288 | const char *show_doc, | |
289 | const char *help_doc, | |
290 | cmd_sfunc_ftype *set_func, | |
291 | show_value_ftype *show_func, | |
292 | struct cmd_list_element **set_list, | |
293 | struct cmd_list_element **show_list); | |
294 | ||
295 | extern void add_setshow_string_noescape_cmd (char *name, | |
296 | enum command_class class, | |
297 | char **var, | |
298 | const char *set_doc, | |
299 | const char *show_doc, | |
300 | const char *help_doc, | |
301 | cmd_sfunc_ftype *set_func, | |
302 | show_value_ftype *show_func, | |
303 | struct cmd_list_element **set_list, | |
304 | struct cmd_list_element **show_list); | |
26c41df3 | 305 | |
b4b4ac0b AC |
306 | extern void add_setshow_optional_filename_cmd (char *name, |
307 | enum command_class class, | |
308 | char **var, | |
309 | const char *set_doc, | |
310 | const char *show_doc, | |
311 | const char *help_doc, | |
312 | cmd_sfunc_ftype *set_func, | |
313 | show_value_ftype *show_func, | |
314 | struct cmd_list_element **set_list, | |
315 | struct cmd_list_element **show_list); | |
316 | ||
5efd5804 PA |
317 | extern void add_setshow_integer_cmd (char *name, |
318 | enum command_class class, | |
319 | int *var, | |
320 | const char *set_doc, | |
321 | const char *show_doc, | |
322 | const char *help_doc, | |
323 | cmd_sfunc_ftype *set_func, | |
324 | show_value_ftype *show_func, | |
325 | struct cmd_list_element **set_list, | |
326 | struct cmd_list_element **show_list); | |
c0d88b1b | 327 | |
5efd5804 PA |
328 | extern void add_setshow_uinteger_cmd (char *name, |
329 | enum command_class class, | |
330 | unsigned int *var, | |
331 | const char *set_doc, | |
332 | const char *show_doc, | |
333 | const char *help_doc, | |
334 | cmd_sfunc_ftype *set_func, | |
335 | show_value_ftype *show_func, | |
336 | struct cmd_list_element **set_list, | |
337 | struct cmd_list_element **show_list); | |
15170568 | 338 | |
5efd5804 PA |
339 | extern void add_setshow_zinteger_cmd (char *name, |
340 | enum command_class class, | |
341 | int *var, | |
342 | const char *set_doc, | |
343 | const char *show_doc, | |
344 | const char *help_doc, | |
345 | cmd_sfunc_ftype *set_func, | |
346 | show_value_ftype *show_func, | |
347 | struct cmd_list_element **set_list, | |
348 | struct cmd_list_element **show_list); | |
25d29d70 | 349 | |
5efd5804 PA |
350 | extern void add_setshow_zuinteger_cmd (char *name, |
351 | enum command_class class, | |
352 | unsigned int *var, | |
353 | const char *set_doc, | |
354 | const char *show_doc, | |
355 | const char *help_doc, | |
6fc1c773 YQ |
356 | cmd_sfunc_ftype *set_func, |
357 | show_value_ftype *show_func, | |
358 | struct cmd_list_element **set_list, | |
359 | struct cmd_list_element **show_list); | |
360 | ||
361 | extern void | |
362 | add_setshow_zuinteger_unlimited_cmd (char *name, | |
363 | enum command_class class, | |
364 | unsigned int *var, | |
365 | const char *set_doc, | |
366 | const char *show_doc, | |
367 | const char *help_doc, | |
5efd5804 PA |
368 | cmd_sfunc_ftype *set_func, |
369 | show_value_ftype *show_func, | |
370 | struct cmd_list_element **set_list, | |
371 | struct cmd_list_element **show_list); | |
1e8fb976 | 372 | |
c906108c SS |
373 | /* Do a "show" command for each thing on a command list. */ |
374 | ||
a14ed312 | 375 | extern void cmd_show_list (struct cmd_list_element *, int, char *); |
c906108c | 376 | |
c25c4a8b | 377 | /* Used everywhere whenever at least one parameter is required and |
ebcd3b23 | 378 | none is specified. */ |
c25c4a8b JK |
379 | |
380 | extern void error_no_arg (char *) ATTRIBUTE_NORETURN; | |
c906108c | 381 | |
a14ed312 | 382 | extern void dont_repeat (void); |
c906108c | 383 | |
47a80e90 TT |
384 | extern struct cleanup *prevent_dont_repeat (void); |
385 | ||
c906108c SS |
386 | /* Used to mark commands that don't do anything. If we just leave the |
387 | function field NULL, the command is interpreted as a help topic, or | |
388 | as a class of commands. */ | |
389 | ||
a14ed312 | 390 | extern void not_just_help_class_command (char *, int); |
c906108c | 391 | |
aff410f1 | 392 | /* Check function pointer. */ |
f436dd25 MH |
393 | extern int cmd_func_p (struct cmd_list_element *cmd); |
394 | ||
aff410f1 MS |
395 | /* Call the command function. */ |
396 | extern void cmd_func (struct cmd_list_element *cmd, | |
397 | char *args, int from_tty); | |
f436dd25 | 398 | |
c906108c | 399 | #endif /* !defined (COMMAND_H) */ |