1 /* Header file for GDB command decoding library.
3 Copyright (C) 2000-2014 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
21 /* This file defines the private interfaces for any code implementing
24 /* Include the public interfaces. */
27 struct re_pattern_buffer;
30 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
31 cmd_types'' can be moved from "command.h" to "cli-decode.h". */
32 /* Not a set/show command. Note that some commands which begin with
33 "set" or "show" might be in this category, if their syntax does
34 not fall into one of the following categories. */
35 typedef enum cmd_types
44 /* This structure records one command'd definition. */
47 struct cmd_list_element
49 /* Points to next command in this list. */
50 struct cmd_list_element *next;
52 /* Name of this command. */
55 /* Command class; class values are chosen by application program. */
56 enum command_class class;
58 /* Function definition of this command. NULL for command class
59 names and for help topics that are not really commands. NOTE:
60 cagney/2002-02-02: This function signature is evolving. For
61 the moment suggest sticking with either set_cmd_cfunc() or
63 void (*func) (struct cmd_list_element *c, char *args, int from_tty);
64 /* The command's real callback. At present func() bounces through
65 to one of the below. */
68 /* If type is not_set_cmd, call it like this: */
69 cmd_cfunc_ftype *cfunc;
70 /* If type is set_cmd or show_cmd, first set the variables,
71 and then call this: */
72 cmd_sfunc_ftype *sfunc;
76 /* Local state (context) for this command. This can be anything. */
79 /* Documentation of this command (or help topic).
80 First line is brief documentation; remaining lines form, with it,
81 the full documentation. First line should end with a period.
82 Entire string should also end with a period, not a newline. */
85 /* For set/show commands. A method for printing the output to the
87 show_value_ftype *show_value_func;
89 /* When 1 indicated that this command is deprecated. It may be
90 removed from gdb's command set in the future. */
92 unsigned int cmd_deprecated : 1;
94 /* The user needs to be warned that this is a deprecated command.
95 The user should only be warned the first time a command is
98 unsigned int deprecated_warn_user : 1;
100 /* When functions are deprecated at compile time (this is the way
101 it should, in general, be done) the memory containing the
102 replacement string is statically allocated. In some cases it
103 makes sense to deprecate commands at runtime (the testsuite is
104 one example). In this case the memory for replacement is
105 malloc'ed. When a command is undeprecated or re-deprecated at
106 runtime we don't want to risk calling free on statically
107 allocated memory, so we check this flag. */
109 unsigned int malloced_replacement : 1;
111 /* Set if the doc field should be xfree'd. */
113 unsigned int doc_allocated : 1;
115 /* If this command is deprecated, this is the replacement name. */
118 /* If this command represents a show command, then this function
119 is called before the variable's value is examined. */
120 void (*pre_show_hook) (struct cmd_list_element *c);
122 /* Hook for another command to be executed before this command. */
123 struct cmd_list_element *hook_pre;
125 /* Flag that specifies if this command is already running its hook. */
126 /* Prevents the possibility of hook recursion. */
127 unsigned int hook_in : 1;
129 /* Hook for another command to be executed after this command. */
130 struct cmd_list_element *hook_post;
132 /* Nonzero identifies a prefix command. For them, the address
133 of the variable containing the list of subcommands. */
134 struct cmd_list_element **prefixlist;
136 /* For prefix commands only:
137 String containing prefix commands to get here: this one
138 plus any others needed to get to it. Should end in a space.
139 It is used before the word "command" in describing the
140 commands reached through this prefix. */
143 /* For prefix commands only:
144 nonzero means do not get an error if subcommand is not
145 recognized; call the prefix's own function in that case. */
146 unsigned int allow_unknown : 1;
148 /* The prefix command of this command. */
149 struct cmd_list_element *prefix;
151 /* Nonzero says this is an abbreviation, and should not
152 be mentioned in lists of commands.
153 This allows "br<tab>" to complete to "break", which it
154 otherwise wouldn't. */
155 unsigned int abbrev_flag : 1;
157 /* Completion routine for this command. TEXT is the text beyond
158 what was matched for the command itself (leading whitespace is
159 skipped). It stops where we are supposed to stop completing
160 (rl_point) and is '\0' terminated.
162 Return value is a malloc'd vector of pointers to possible
163 completions terminated with NULL. If there are no completions,
164 returning a pointer to a NULL would work but returning NULL
165 itself is also valid. WORD points in the same buffer as TEXT,
166 and completions should be returned relative to this position.
167 For example, suppose TEXT is "foo" and we want to complete to
168 "foobar". If WORD is "oo", return "oobar"; if WORD is
169 "baz/foo", return "baz/foobar". */
170 completer_ftype *completer;
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"
179 ENUM_BITFIELD (cmd_types) type : 2;
181 /* Pointer to variable affected by "set" and "show". Doesn't
182 matter if type is not_set. */
185 /* What kind of variable is *VAR? */
186 ENUM_BITFIELD (var_types) var_type : 4;
188 /* Pointer to NULL terminated list of enumerated values (like
190 const char *const *enums;
192 /* Pointer to command strings of user-defined commands */
193 struct command_line *user_commands;
195 /* Pointer to command that is hooked by this one, (by hook_pre)
196 so the hook can be removed when this one is deleted. */
197 struct cmd_list_element *hookee_pre;
199 /* Pointer to command that is hooked by this one, (by hook_post)
200 so the hook can be removed when this one is deleted. */
201 struct cmd_list_element *hookee_post;
203 /* Pointer to command that is aliased by this one, so the
204 aliased command can be located in case it has been hooked. */
205 struct cmd_list_element *cmd_pointer;
207 /* Start of a linked list of all aliases of this command. */
208 struct cmd_list_element *aliases;
210 /* Link pointer for aliases on an alias list. */
211 struct cmd_list_element *alias_chain;
214 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
215 char *, int, struct ui_file *);
217 /* Functions that implement commands about CLI commands. */
219 extern void help_cmd (char *, struct ui_file *);
221 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
222 struct re_pattern_buffer *, char *);
224 /* Used to mark commands that don't do anything. If we just leave the
225 function field NULL, the command is interpreted as a help topic, or
226 as a class of commands. */
228 extern void not_just_help_class_command (char *arg, int from_tty);
230 /* Exported to cli/cli-setshow.c */
232 extern void print_doc_line (struct ui_file *, char *);
234 extern const char * const auto_boolean_enums[];
236 #endif /* !defined (CLI_DECODE_H) */