]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/command.h
Mention PR ld/12327 in ChangeLog entry.
[thirdparty/binutils-gdb.git] / gdb / command.h
CommitLineData
c906108c 1/* Header file for command-reading library command.c.
18a642a1 2
6aba47ca 3 Copyright (C) 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999, 2000,
4c38e0a4 4 2002, 2004, 2007, 2008, 2009, 2010 Free 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
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
28enum command_class
29{
30 /* Special args to help_list */
6e381ba0 31 class_deprecated = -3, all_classes = -2, all_commands = -1,
6426a772
JM
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,
6b04bdb7
MS
35 class_alias, class_bookmark, class_obscure, class_maintenance,
36 class_pseudo, class_tui, class_user, class_xdb
6426a772
JM
37};
38
18a642a1
AC
39/* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
40 cmd_types'' can be moved from "command.h" to "cli-decode.h". */
c906108c
SS
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. */
c5aa993b
JM
44typedef enum cmd_types
45 {
46 not_set_cmd,
47 set_cmd,
48 show_cmd
49 }
50cmd_types;
c906108c
SS
51
52/* Types of "set" or "show" command. */
c5aa993b
JM
53typedef enum var_types
54 {
55 /* "on" or "off". *VAR is an integer which is nonzero for on,
56 zero for off. */
57 var_boolean,
97c3646f
AC
58
59 /* "on" / "true" / "enable" or "off" / "false" / "disable" or
7f19b9a2
AC
60 "auto. *VAR is an ``enum auto_boolean''. NOTE: In general a
61 custom show command will need to be implemented - one that for
62 "auto" prints both the "auto" and the current auto-selected
97c3646f
AC
63 value. */
64 var_auto_boolean,
65
c5aa993b
JM
66 /* Unsigned Integer. *VAR is an unsigned int. The user can type 0
67 to mean "unlimited", which is stored in *VAR as UINT_MAX. */
68 var_uinteger,
69
70 /* Like var_uinteger but signed. *VAR is an int. The user can type 0
71 to mean "unlimited", which is stored in *VAR as INT_MAX. */
72 var_integer,
73
74 /* String which the user enters with escapes (e.g. the user types \n and
75 it is a real newline in the stored string).
76 *VAR is a malloc'd string, or NULL if the string is empty. */
77 var_string,
78 /* String which stores what the user types verbatim.
79 *VAR is a malloc'd string, or NULL if the string is empty. */
80 var_string_noescape,
b4b4ac0b
AC
81 /* String which stores a filename. (*VAR) is a malloc'd string,
82 or "" if the string was empty. */
83 var_optional_filename,
84 /* String which stores a filename. (*VAR) is a malloc'd
85 string. */
c5aa993b
JM
86 var_filename,
87 /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except
88 that zero really means zero. */
89 var_zinteger,
1e8fb976
PA
90 /* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really
91 means zero. */
92 var_zuinteger,
c5aa993b
JM
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 }
97var_types;
c906108c
SS
98
99/* This structure records one command'd definition. */
18a642a1 100struct cmd_list_element;
c906108c 101
18d5d590 102/* Forward-declarations of the entry-points of cli/cli-decode.c. */
c906108c 103
a14ed312
KB
104extern struct cmd_list_element *add_cmd (char *, enum command_class,
105 void (*fun) (char *, int), char *,
106 struct cmd_list_element **);
107
108extern struct cmd_list_element *add_alias_cmd (char *, char *,
109 enum command_class, int,
110 struct cmd_list_element **);
111
112extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
113 void (*fun) (char *, int),
114 char *,
115 struct cmd_list_element **,
116 char *, int,
117 struct cmd_list_element **);
118
119extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
120 enum command_class,
121 void (*fun) (char *,
122 int),
123 char *,
124 struct cmd_list_element
125 **, char *, int,
126 struct cmd_list_element
127 **);
128
9f60d481
AC
129/* Set the commands corresponding callback. */
130
9773a94b 131typedef void cmd_cfunc_ftype (char *args, int from_tty);
9f60d481 132extern void set_cmd_cfunc (struct cmd_list_element *cmd,
9773a94b 133 cmd_cfunc_ftype *cfunc);
9f60d481 134
9773a94b
AC
135typedef void cmd_sfunc_ftype (char *args, int from_tty,
136 struct cmd_list_element *c);
9f60d481 137extern void set_cmd_sfunc (struct cmd_list_element *cmd,
9773a94b 138 cmd_sfunc_ftype *sfunc);
9f60d481 139
5ba2abeb 140extern void set_cmd_completer (struct cmd_list_element *cmd,
d8906c6f
TJB
141 char **(*completer) (struct cmd_list_element *cmd,
142 char *text, char *word));
5ba2abeb 143
bbaca940
AC
144/* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
145 around in cmd objects to test the value of the commands sfunc(). */
146extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
147 void (*cfunc) (char *args, int from_tty));
9f60d481 148
7d0766f3
AC
149/* Each command object has a local context attached to it. . */
150extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
151extern void *get_cmd_context (struct cmd_list_element *cmd);
152
153
5913bcb0
AC
154/* Execute CMD's pre/post hook. Throw an error if the command fails.
155 If already executing this pre/post hook, or there is no pre/post
156 hook, the call is silently ignored. */
157extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
158extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
159
1868c04e 160/* Return the type of the command. */
1868c04e
AC
161extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
162
163
a14ed312
KB
164extern struct cmd_list_element *lookup_cmd (char **,
165 struct cmd_list_element *, char *,
166 int, int);
167
168extern struct cmd_list_element *lookup_cmd_1 (char **,
169 struct cmd_list_element *,
170 struct cmd_list_element **,
171 int);
c906108c 172
56382845
FN
173extern struct cmd_list_element *
174 deprecate_cmd (struct cmd_list_element *, char * );
175
c906108c 176extern void
56382845
FN
177 deprecated_cmd_warning (char **);
178
179extern int
180 lookup_cmd_composition (char *text,
181 struct cmd_list_element **alias,
182 struct cmd_list_element **prefix_cmd,
183 struct cmd_list_element **cmd);
184
a14ed312
KB
185extern struct cmd_list_element *add_com (char *, enum command_class,
186 void (*fun) (char *, int), char *);
c906108c 187
a14ed312
KB
188extern struct cmd_list_element *add_com_alias (char *, char *,
189 enum command_class, int);
c906108c 190
a14ed312
KB
191extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
192 char *);
c906108c 193
a14ed312 194extern struct cmd_list_element *add_info_alias (char *, char *, int);
c906108c 195
a14ed312 196extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
c906108c 197
53904c9e 198extern char **complete_on_enum (const char *enumlist[], char *, char *);
c906108c 199
d9fcf2fb 200extern void help_cmd (char *, struct ui_file *);
c906108c 201
d9fcf2fb
JM
202extern void help_list (struct cmd_list_element *, char *,
203 enum command_class, struct ui_file *);
c906108c 204
d9fcf2fb
JM
205extern void help_cmd_list (struct cmd_list_element *, enum command_class,
206 char *, int, struct ui_file *);
c906108c 207
08546159
AC
208/* Method for show a set/show variable's VALUE on FILE. If this
209 method isn't supplied deprecated_show_value_hack() is called (which
210 is not good). */
211typedef void (show_value_ftype) (struct ui_file *file,
212 int from_tty,
213 struct cmd_list_element *cmd,
214 const char *value);
215/* NOTE: i18n: This function is not i18n friendly. Callers should
216 instead print the value out directly. */
217extern show_value_ftype deprecated_show_value_hack;
218
1b295c3d
AC
219extern void add_setshow_enum_cmd (char *name,
220 enum command_class class,
221 const char *enumlist[],
222 const char **var,
223 const char *set_doc,
224 const char *show_doc,
225 const char *help_doc,
1b295c3d 226 cmd_sfunc_ftype *set_func,
08546159 227 show_value_ftype *show_func,
1b295c3d 228 struct cmd_list_element **set_list,
7376b4c2 229 struct cmd_list_element **show_list);
c906108c 230
e9e68a56
AC
231extern void add_setshow_auto_boolean_cmd (char *name,
232 enum command_class class,
233 enum auto_boolean *var,
3b64bf98
AC
234 const char *set_doc,
235 const char *show_doc,
236 const char *help_doc,
e9e68a56 237 cmd_sfunc_ftype *set_func,
08546159 238 show_value_ftype *show_func,
e9e68a56
AC
239 struct cmd_list_element **set_list,
240 struct cmd_list_element **show_list);
97c3646f 241
e707bbc2
AC
242extern void add_setshow_boolean_cmd (char *name,
243 enum command_class class,
244 int *var,
3b64bf98 245 const char *set_doc, const char *show_doc,
2c5b56ce 246 const char *help_doc,
e707bbc2 247 cmd_sfunc_ftype *set_func,
08546159 248 show_value_ftype *show_func,
e707bbc2
AC
249 struct cmd_list_element **set_list,
250 struct cmd_list_element **show_list);
f3796e26 251
b3f42336
AC
252extern void add_setshow_filename_cmd (char *name,
253 enum command_class class,
254 char **var,
255 const char *set_doc,
256 const char *show_doc,
257 const char *help_doc,
b3f42336 258 cmd_sfunc_ftype *set_func,
08546159 259 show_value_ftype *show_func,
b3f42336
AC
260 struct cmd_list_element **set_list,
261 struct cmd_list_element **show_list);
262
5efd5804
PA
263extern void add_setshow_string_cmd (char *name,
264 enum command_class class,
265 char **var,
266 const char *set_doc,
267 const char *show_doc,
268 const char *help_doc,
269 cmd_sfunc_ftype *set_func,
270 show_value_ftype *show_func,
271 struct cmd_list_element **set_list,
272 struct cmd_list_element **show_list);
273
274extern void add_setshow_string_noescape_cmd (char *name,
275 enum command_class class,
276 char **var,
277 const char *set_doc,
278 const char *show_doc,
279 const char *help_doc,
280 cmd_sfunc_ftype *set_func,
281 show_value_ftype *show_func,
282 struct cmd_list_element **set_list,
283 struct cmd_list_element **show_list);
26c41df3 284
b4b4ac0b
AC
285extern void add_setshow_optional_filename_cmd (char *name,
286 enum command_class class,
287 char **var,
288 const char *set_doc,
289 const char *show_doc,
290 const char *help_doc,
291 cmd_sfunc_ftype *set_func,
292 show_value_ftype *show_func,
293 struct cmd_list_element **set_list,
294 struct cmd_list_element **show_list);
295
5efd5804
PA
296extern void add_setshow_integer_cmd (char *name,
297 enum command_class class,
298 int *var,
299 const char *set_doc,
300 const char *show_doc,
301 const char *help_doc,
302 cmd_sfunc_ftype *set_func,
303 show_value_ftype *show_func,
304 struct cmd_list_element **set_list,
305 struct cmd_list_element **show_list);
c0d88b1b 306
5efd5804
PA
307extern void add_setshow_uinteger_cmd (char *name,
308 enum command_class class,
309 unsigned int *var,
310 const char *set_doc,
311 const char *show_doc,
312 const char *help_doc,
313 cmd_sfunc_ftype *set_func,
314 show_value_ftype *show_func,
315 struct cmd_list_element **set_list,
316 struct cmd_list_element **show_list);
15170568 317
5efd5804
PA
318extern void add_setshow_zinteger_cmd (char *name,
319 enum command_class class,
320 int *var,
321 const char *set_doc,
322 const char *show_doc,
323 const char *help_doc,
324 cmd_sfunc_ftype *set_func,
325 show_value_ftype *show_func,
326 struct cmd_list_element **set_list,
327 struct cmd_list_element **show_list);
25d29d70 328
5efd5804
PA
329extern void add_setshow_zuinteger_cmd (char *name,
330 enum command_class class,
331 unsigned int *var,
332 const char *set_doc,
333 const char *show_doc,
334 const char *help_doc,
335 cmd_sfunc_ftype *set_func,
336 show_value_ftype *show_func,
337 struct cmd_list_element **set_list,
338 struct cmd_list_element **show_list);
1e8fb976 339
c906108c
SS
340/* Do a "show" command for each thing on a command list. */
341
a14ed312 342extern void cmd_show_list (struct cmd_list_element *, int, char *);
c906108c 343
c25c4a8b
JK
344/* Used everywhere whenever at least one parameter is required and
345 none is specified. */
346
347extern void error_no_arg (char *) ATTRIBUTE_NORETURN;
c906108c 348
a14ed312 349extern void dont_repeat (void);
c906108c
SS
350
351/* Used to mark commands that don't do anything. If we just leave the
352 function field NULL, the command is interpreted as a help topic, or
353 as a class of commands. */
354
a14ed312 355extern void not_just_help_class_command (char *, int);
c906108c 356
f436dd25
MH
357/* check function pointer */
358extern int cmd_func_p (struct cmd_list_element *cmd);
359
360/* call the command function */
361extern void cmd_func (struct cmd_list_element *cmd, char *args, int from_tty);
362
c906108c 363#endif /* !defined (COMMAND_H) */