1 /* Header file for GDB command decoding library.
3 Copyright (c) 2000, 2003, 2007, 2008 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 it's 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) (char *text, char *word);
172 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
176 /* Pointer to variable affected by "set" and "show". Doesn't matter
177 if type is not_set. */
180 /* What kind of variable is *VAR? */
183 /* Pointer to NULL terminated list of enumerated values (like argv). */
186 /* Pointer to command strings of user-defined commands */
187 struct command_line *user_commands;
189 /* Pointer to command that is hooked by this one, (by hook_pre)
190 so the hook can be removed when this one is deleted. */
191 struct cmd_list_element *hookee_pre;
193 /* Pointer to command that is hooked by this one, (by hook_post)
194 so the hook can be removed when this one is deleted. */
195 struct cmd_list_element *hookee_post;
197 /* Pointer to command that is aliased by this one, so the
198 aliased command can be located in case it has been hooked. */
199 struct cmd_list_element *cmd_pointer;
201 /* Start of a linked list of all aliases of this command. */
202 struct cmd_list_element *aliases;
204 /* Link pointer for aliases on an alias list. */
205 struct cmd_list_element *alias_chain;
208 /* API to the manipulation of command lists. */
210 extern struct cmd_list_element *add_cmd (char *, enum command_class,
211 void (*fun) (char *, int), char *,
212 struct cmd_list_element **);
214 extern struct cmd_list_element *add_alias_cmd (char *, char *,
215 enum command_class, int,
216 struct cmd_list_element **);
218 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
219 void (*fun) (char *, int),
221 struct cmd_list_element **,
223 struct cmd_list_element **);
225 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
230 struct cmd_list_element
232 struct cmd_list_element
235 /* Set the commands corresponding callback. */
237 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
238 void (*cfunc) (char *args, int from_tty));
240 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
241 void (*sfunc) (char *args, int from_tty,
242 struct cmd_list_element * c));
244 extern void set_cmd_completer (struct cmd_list_element *cmd,
245 char **(*completer) (char *text, char *word));
247 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
248 around in cmd objects to test the value of the commands sfunc(). */
249 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
250 void (*cfunc) (char *args, int from_tty));
252 /* Access to the command's local context. */
253 extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
254 extern void *get_cmd_context (struct cmd_list_element *cmd);
256 /* Mark command as ok to call when there is no selected thread. There
257 is no way to disable this once set. */
258 extern void set_cmd_no_selected_thread_ok (struct cmd_list_element *);
260 /* Return true if command is no-selected-thread-ok. */
261 extern int get_cmd_no_selected_thread_ok (struct cmd_list_element *);
263 extern struct cmd_list_element *lookup_cmd (char **,
264 struct cmd_list_element *, char *,
267 extern struct cmd_list_element *lookup_cmd_1 (char **,
268 struct cmd_list_element *,
269 struct cmd_list_element **,
272 extern struct cmd_list_element *
273 deprecate_cmd (struct cmd_list_element *, char * );
276 deprecated_cmd_warning (char **);
279 lookup_cmd_composition (char *text,
280 struct cmd_list_element **alias,
281 struct cmd_list_element **prefix_cmd,
282 struct cmd_list_element **cmd);
284 extern struct cmd_list_element *add_com (char *, enum command_class,
285 void (*fun) (char *, int), char *);
287 extern struct cmd_list_element *add_com_alias (char *, char *,
288 enum command_class, int);
290 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
293 extern struct cmd_list_element *add_info_alias (char *, char *, int);
295 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
297 extern char **complete_on_enum (const char *enumlist[], char *, char *);
299 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
300 char *, int, struct ui_file *);
302 /* Functions that implement commands about CLI commands. */
304 extern void help_cmd (char *, struct ui_file *);
306 extern void help_list (struct cmd_list_element *, char *,
307 enum command_class, struct ui_file *);
309 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
310 struct re_pattern_buffer *, char *);
312 /* Used to mark commands that don't do anything. If we just leave the
313 function field NULL, the command is interpreted as a help topic, or
314 as a class of commands. */
316 extern void not_just_help_class_command (char *arg, int from_tty);
318 /* Exported to cli/cli-setshow.c */
320 extern void print_doc_line (struct ui_file *, char *);
323 #endif /* !defined (CLI_DECODE_H) */