1 /* Header file for GDB command decoding library.
3 Copyright (c) 2000, 2003, 2007, 2008, 2009 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 /* This flag is set if the command is allowed to run when the target
52 has execution, but there's no selected thread. */
53 #define CMD_NO_SELECTED_THREAD_OK 0x10
55 struct cmd_list_element
57 /* Points to next command in this list. */
58 struct cmd_list_element
*next
;
60 /* Name of this command. */
63 /* Command class; class values are chosen by application program. */
64 enum command_class
class;
66 /* Function definition of this command. NULL for command class
67 names and for help topics that are not really commands. NOTE:
68 cagney/2002-02-02: This function signature is evolving. For
69 the moment suggest sticking with either set_cmd_cfunc() or
71 void (*func
) (struct cmd_list_element
*c
, char *args
, int from_tty
);
72 /* The command's real callback. At present func() bounces through
73 to one of the below. */
76 /* If type is not_set_cmd, call it like this: */
77 cmd_cfunc_ftype
*cfunc
;
78 /* If type is set_cmd or show_cmd, first set the variables,
79 and then call this: */
80 cmd_sfunc_ftype
*sfunc
;
84 /* Local state (context) for this command. This can be anything. */
87 /* Documentation of this command (or help topic).
88 First line is brief documentation; remaining lines form, with it,
89 the full documentation. First line should end with a period.
90 Entire string should also end with a period, not a newline. */
93 /* For set/show commands. A method for printing the output to the
95 show_value_ftype
*show_value_func
;
99 bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
100 is deprecated. It may be removed from gdb's command set in the
103 bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
104 this is a deprecated command. The user should only be warned
105 the first time a command is used.
107 bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
108 compile time (this is the way it should, in general, be done)
109 the memory containing the replacement string is statically
110 allocated. In some cases it makes sense to deprecate commands
111 at runtime (the testsuite is one example). In this case the
112 memory for replacement is malloc'ed. When a command is
113 undeprecated or re-deprecated at runtime we don't want to risk
114 calling free on statically allocated memory, so we check this
119 /* If this command is deprecated, this is the replacement name. */
122 /* If this command represents a show command, then this function
123 is called before the variable's value is examined. */
124 void (*pre_show_hook
) (struct cmd_list_element
*c
);
126 /* Hook for another command to be executed before this command. */
127 struct cmd_list_element
*hook_pre
;
129 /* Hook for another command to be executed after this command. */
130 struct cmd_list_element
*hook_post
;
132 /* Flag that specifies if this command is already running its hook. */
133 /* Prevents the possibility of hook recursion. */
136 /* Nonzero identifies a prefix command. For them, the address
137 of the variable containing the list of subcommands. */
138 struct cmd_list_element
**prefixlist
;
140 /* For prefix commands only:
141 String containing prefix commands to get here: this one
142 plus any others needed to get to it. Should end in a space.
143 It is used before the word "command" in describing the
144 commands reached through this prefix. */
147 /* For prefix commands only:
148 nonzero means do not get an error if subcommand is not
149 recognized; call the prefix's own function in that case. */
152 /* Nonzero says this is an abbreviation, and should not
153 be mentioned in lists of commands.
154 This allows "br<tab>" to complete to "break", which it
155 otherwise wouldn't. */
158 /* Completion routine for this command. TEXT is the text beyond
159 what was matched for the command itself (leading whitespace is
160 skipped). It stops where we are supposed to stop completing
161 (rl_point) and is '\0' terminated.
163 Return value is a malloc'd vector of pointers to possible completions
164 terminated with NULL. If there are no completions, returning a pointer
165 to a NULL would work but returning NULL itself is also valid.
166 WORD points in the same buffer as TEXT, and completions should be
167 returned relative to this position. For example, suppose TEXT is "foo"
168 and we want to complete to "foobar". If WORD is "oo", return
169 "oobar"; if WORD is "baz/foo", return "baz/foobar". */
170 char **(*completer
) (struct cmd_list_element
*cmd
, char *text
, char *word
);
172 /* Destruction routine for this command. If non-NULL, this is
173 called when this command instance is destroyed. This may be
174 used to finalize the CONTEXT field, if needed. */
175 void (*destroyer
) (struct cmd_list_element
*self
, void *context
);
177 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
181 /* Pointer to variable affected by "set" and "show". Doesn't matter
182 if type is not_set. */
185 /* What kind of variable is *VAR? */
188 /* Pointer to NULL terminated list of enumerated values (like argv). */
191 /* Pointer to command strings of user-defined commands */
192 struct command_line
*user_commands
;
194 /* Pointer to command that is hooked by this one, (by hook_pre)
195 so the hook can be removed when this one is deleted. */
196 struct cmd_list_element
*hookee_pre
;
198 /* Pointer to command that is hooked by this one, (by hook_post)
199 so the hook can be removed when this one is deleted. */
200 struct cmd_list_element
*hookee_post
;
202 /* Pointer to command that is aliased by this one, so the
203 aliased command can be located in case it has been hooked. */
204 struct cmd_list_element
*cmd_pointer
;
206 /* Start of a linked list of all aliases of this command. */
207 struct cmd_list_element
*aliases
;
209 /* Link pointer for aliases on an alias list. */
210 struct cmd_list_element
*alias_chain
;
213 /* API to the manipulation of command lists. */
215 extern struct cmd_list_element
*add_cmd (char *, enum command_class
,
216 void (*fun
) (char *, int), char *,
217 struct cmd_list_element
**);
219 extern struct cmd_list_element
*add_alias_cmd (char *, char *,
220 enum command_class
, int,
221 struct cmd_list_element
**);
223 extern struct cmd_list_element
*add_prefix_cmd (char *, enum command_class
,
224 void (*fun
) (char *, int),
226 struct cmd_list_element
**,
228 struct cmd_list_element
**);
230 extern struct cmd_list_element
*add_abbrev_prefix_cmd (char *,
235 struct cmd_list_element
237 struct cmd_list_element
240 /* Set the commands corresponding callback. */
242 extern void set_cmd_cfunc (struct cmd_list_element
*cmd
,
243 void (*cfunc
) (char *args
, int from_tty
));
245 extern void set_cmd_sfunc (struct cmd_list_element
*cmd
,
246 void (*sfunc
) (char *args
, int from_tty
,
247 struct cmd_list_element
* c
));
249 extern void set_cmd_completer (struct cmd_list_element
*cmd
,
250 char **(*completer
) (struct cmd_list_element
*self
,
251 char *text
, char *word
));
253 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
254 around in cmd objects to test the value of the commands sfunc(). */
255 extern int cmd_cfunc_eq (struct cmd_list_element
*cmd
,
256 void (*cfunc
) (char *args
, int from_tty
));
258 /* Access to the command's local context. */
259 extern void set_cmd_context (struct cmd_list_element
*cmd
, void *context
);
260 extern void *get_cmd_context (struct cmd_list_element
*cmd
);
262 /* Mark command as ok to call when there is no selected thread. There
263 is no way to disable this once set. */
264 extern void set_cmd_no_selected_thread_ok (struct cmd_list_element
*);
266 /* Return true if command is no-selected-thread-ok. */
267 extern int get_cmd_no_selected_thread_ok (struct cmd_list_element
*);
269 extern struct cmd_list_element
*lookup_cmd (char **,
270 struct cmd_list_element
*, char *,
273 extern struct cmd_list_element
*lookup_cmd_1 (char **,
274 struct cmd_list_element
*,
275 struct cmd_list_element
**,
278 extern struct cmd_list_element
*
279 deprecate_cmd (struct cmd_list_element
*, char * );
282 deprecated_cmd_warning (char **);
285 lookup_cmd_composition (char *text
,
286 struct cmd_list_element
**alias
,
287 struct cmd_list_element
**prefix_cmd
,
288 struct cmd_list_element
**cmd
);
290 extern struct cmd_list_element
*add_com (char *, enum command_class
,
291 void (*fun
) (char *, int), char *);
293 extern struct cmd_list_element
*add_com_alias (char *, char *,
294 enum command_class
, int);
296 extern struct cmd_list_element
*add_info (char *, void (*fun
) (char *, int),
299 extern struct cmd_list_element
*add_info_alias (char *, char *, int);
301 extern char **complete_on_cmdlist (struct cmd_list_element
*, char *, char *);
303 extern char **complete_on_enum (const char *enumlist
[], char *, char *);
305 extern void help_cmd_list (struct cmd_list_element
*, enum command_class
,
306 char *, int, struct ui_file
*);
308 /* Functions that implement commands about CLI commands. */
310 extern void help_cmd (char *, struct ui_file
*);
312 extern void help_list (struct cmd_list_element
*, char *,
313 enum command_class
, struct ui_file
*);
315 extern void apropos_cmd (struct ui_file
*, struct cmd_list_element
*,
316 struct re_pattern_buffer
*, char *);
318 /* Used to mark commands that don't do anything. If we just leave the
319 function field NULL, the command is interpreted as a help topic, or
320 as a class of commands. */
322 extern void not_just_help_class_command (char *arg
, int from_tty
);
324 /* Exported to cli/cli-setshow.c */
326 extern void print_doc_line (struct ui_file
*, char *);
329 #endif /* !defined (CLI_DECODE_H) */
This page took 0.037737 seconds and 4 git commands to generate.