Commit | Line | Data |
---|---|---|
d318976c | 1 | /* Header file for GDB command decoding library. |
1bac305b | 2 | |
e2882c85 | 3 | Copyright (C) 2000-2018 Free Software Foundation, Inc. |
d318976c FN |
4 | |
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 | |
a9762ec7 | 7 | the Free Software Foundation; either version 3 of the License, or |
d318976c FN |
8 | (at your option) any later version. |
9 | ||
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. | |
14 | ||
15 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 16 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
d318976c FN |
17 | |
18 | #if !defined (CLI_DECODE_H) | |
19 | #define CLI_DECODE_H 1 | |
20 | ||
50aeff07 PA |
21 | /* This file defines the private interfaces for any code implementing |
22 | command internals. */ | |
23 | ||
24 | /* Include the public interfaces. */ | |
18a642a1 | 25 | #include "command.h" |
2d7cc5c7 | 26 | #include "gdb_regex.h" |
8fe84d01 | 27 | |
18a642a1 AC |
28 | #if 0 |
29 | /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum | |
30 | cmd_types'' can be moved from "command.h" to "cli-decode.h". */ | |
d318976c FN |
31 | /* Not a set/show command. Note that some commands which begin with |
32 | "set" or "show" might be in this category, if their syntax does | |
33 | not fall into one of the following categories. */ | |
34 | typedef enum cmd_types | |
35 | { | |
36 | not_set_cmd, | |
37 | set_cmd, | |
38 | show_cmd | |
39 | } | |
40 | cmd_types; | |
18a642a1 | 41 | #endif |
d318976c FN |
42 | |
43 | /* This structure records one command'd definition. */ | |
44 | ||
45 | ||
d318976c FN |
46 | struct cmd_list_element |
47 | { | |
48 | /* Points to next command in this list. */ | |
49 | struct cmd_list_element *next; | |
50 | ||
51 | /* Name of this command. */ | |
6f937416 | 52 | const char *name; |
d318976c FN |
53 | |
54 | /* Command class; class values are chosen by application program. */ | |
fe978cb0 | 55 | enum command_class theclass; |
d318976c | 56 | |
9ea4267d TT |
57 | /* When 1 indicated that this command is deprecated. It may be |
58 | removed from gdb's command set in the future. */ | |
59 | ||
60 | unsigned int cmd_deprecated : 1; | |
61 | ||
62 | /* The user needs to be warned that this is a deprecated command. | |
63 | The user should only be warned the first time a command is | |
64 | used. */ | |
65 | ||
66 | unsigned int deprecated_warn_user : 1; | |
67 | ||
68 | /* When functions are deprecated at compile time (this is the way | |
69 | it should, in general, be done) the memory containing the | |
70 | replacement string is statically allocated. In some cases it | |
71 | makes sense to deprecate commands at runtime (the testsuite is | |
72 | one example). In this case the memory for replacement is | |
73 | malloc'ed. When a command is undeprecated or re-deprecated at | |
74 | runtime we don't want to risk calling free on statically | |
75 | allocated memory, so we check this flag. */ | |
76 | ||
77 | unsigned int malloced_replacement : 1; | |
78 | ||
79 | /* Set if the doc field should be xfree'd. */ | |
80 | ||
81 | unsigned int doc_allocated : 1; | |
82 | ||
83 | /* Flag that specifies if this command is already running its hook. */ | |
84 | /* Prevents the possibility of hook recursion. */ | |
85 | unsigned int hook_in : 1; | |
86 | ||
87 | /* For prefix commands only: | |
88 | nonzero means do not get an error if subcommand is not | |
89 | recognized; call the prefix's own function in that case. */ | |
90 | unsigned int allow_unknown : 1; | |
91 | ||
92 | /* Nonzero says this is an abbreviation, and should not | |
93 | be mentioned in lists of commands. | |
94 | This allows "br<tab>" to complete to "break", which it | |
95 | otherwise wouldn't. */ | |
96 | unsigned int abbrev_flag : 1; | |
97 | ||
98 | /* Type of "set" or "show" command (or SET_NOT_SET if not "set" | |
99 | or "show"). */ | |
100 | ENUM_BITFIELD (cmd_types) type : 2; | |
101 | ||
102 | /* What kind of variable is *VAR? */ | |
103 | ENUM_BITFIELD (var_types) var_type : 4; | |
104 | ||
e00d1dc8 | 105 | /* Function definition of this command. NULL for command class |
9f60d481 AC |
106 | names and for help topics that are not really commands. NOTE: |
107 | cagney/2002-02-02: This function signature is evolving. For | |
108 | the moment suggest sticking with either set_cmd_cfunc() or | |
109 | set_cmd_sfunc(). */ | |
95a6b0a1 | 110 | void (*func) (struct cmd_list_element *c, const char *args, int from_tty); |
9f60d481 AC |
111 | /* The command's real callback. At present func() bounces through |
112 | to one of the below. */ | |
d318976c FN |
113 | union |
114 | { | |
9773a94b | 115 | /* If type is not_set_cmd, call it like this: */ |
0450cc4c | 116 | cmd_const_cfunc_ftype *const_cfunc; |
9773a94b AC |
117 | /* If type is set_cmd or show_cmd, first set the variables, |
118 | and then call this: */ | |
eb4c3f4a | 119 | cmd_const_sfunc_ftype *sfunc; |
d318976c FN |
120 | } |
121 | function; | |
d318976c | 122 | |
7d0766f3 AC |
123 | /* Local state (context) for this command. This can be anything. */ |
124 | void *context; | |
125 | ||
d318976c FN |
126 | /* Documentation of this command (or help topic). |
127 | First line is brief documentation; remaining lines form, with it, | |
128 | the full documentation. First line should end with a period. | |
129 | Entire string should also end with a period, not a newline. */ | |
1947513d | 130 | const char *doc; |
d318976c | 131 | |
335cca0d AC |
132 | /* For set/show commands. A method for printing the output to the |
133 | specified stream. */ | |
08546159 | 134 | show_value_ftype *show_value_func; |
335cca0d | 135 | |
4e18e2de | 136 | /* If this command is deprecated, this is the replacement name. */ |
429e55ea | 137 | const char *replacement; |
d318976c | 138 | |
552c04a7 TT |
139 | /* If this command represents a show command, then this function |
140 | is called before the variable's value is examined. */ | |
141 | void (*pre_show_hook) (struct cmd_list_element *c); | |
142 | ||
d318976c FN |
143 | /* Hook for another command to be executed before this command. */ |
144 | struct cmd_list_element *hook_pre; | |
145 | ||
1f2bdf09 TT |
146 | /* Hook for another command to be executed after this command. */ |
147 | struct cmd_list_element *hook_post; | |
d318976c FN |
148 | |
149 | /* Nonzero identifies a prefix command. For them, the address | |
150 | of the variable containing the list of subcommands. */ | |
151 | struct cmd_list_element **prefixlist; | |
152 | ||
153 | /* For prefix commands only: | |
154 | String containing prefix commands to get here: this one | |
155 | plus any others needed to get to it. Should end in a space. | |
156 | It is used before the word "command" in describing the | |
157 | commands reached through this prefix. */ | |
64e61d29 | 158 | const char *prefixname; |
d318976c | 159 | |
5b9afe8a YQ |
160 | /* The prefix command of this command. */ |
161 | struct cmd_list_element *prefix; | |
162 | ||
6e1dbf8c | 163 | /* Completion routine for this command. */ |
625e8578 | 164 | completer_ftype *completer; |
d8906c6f | 165 | |
7d793aa9 SDJ |
166 | /* Handle the word break characters for this completer. Usually |
167 | this function need not be defined, but for some types of | |
168 | completers (e.g., Python completers declared as methods inside | |
169 | a class) the word break chars may need to be redefined | |
170 | depending on the completer type (e.g., for filename | |
171 | completers). */ | |
6e1dbf8c | 172 | completer_handle_brkchars_ftype *completer_handle_brkchars; |
7d793aa9 | 173 | |
d8906c6f TJB |
174 | /* Destruction routine for this command. If non-NULL, this is |
175 | called when this command instance is destroyed. This may be | |
176 | used to finalize the CONTEXT field, if needed. */ | |
177 | void (*destroyer) (struct cmd_list_element *self, void *context); | |
d318976c | 178 | |
ebcd3b23 MS |
179 | /* Pointer to variable affected by "set" and "show". Doesn't |
180 | matter if type is not_set. */ | |
d318976c FN |
181 | void *var; |
182 | ||
ebcd3b23 MS |
183 | /* Pointer to NULL terminated list of enumerated values (like |
184 | argv). */ | |
40478521 | 185 | const char *const *enums; |
d318976c FN |
186 | |
187 | /* Pointer to command strings of user-defined commands */ | |
188 | struct command_line *user_commands; | |
189 | ||
190 | /* Pointer to command that is hooked by this one, (by hook_pre) | |
191 | so the hook can be removed when this one is deleted. */ | |
192 | struct cmd_list_element *hookee_pre; | |
193 | ||
194 | /* Pointer to command that is hooked by this one, (by hook_post) | |
195 | so the hook can be removed when this one is deleted. */ | |
196 | struct cmd_list_element *hookee_post; | |
197 | ||
198 | /* Pointer to command that is aliased by this one, so the | |
199 | aliased command can be located in case it has been hooked. */ | |
200 | struct cmd_list_element *cmd_pointer; | |
b05dcbb7 TT |
201 | |
202 | /* Start of a linked list of all aliases of this command. */ | |
203 | struct cmd_list_element *aliases; | |
204 | ||
205 | /* Link pointer for aliases on an alias list. */ | |
206 | struct cmd_list_element *alias_chain; | |
4034d0ff AT |
207 | |
208 | /* If non-null, the pointer to a field in 'struct | |
209 | cli_suppress_notification', which will be set to true in cmd_func | |
210 | when this command is being executed. It will be set back to false | |
211 | when the command has been executed. */ | |
212 | int *suppress_notification; | |
d318976c FN |
213 | }; |
214 | ||
d318976c | 215 | extern void help_cmd_list (struct cmd_list_element *, enum command_class, |
64e61d29 | 216 | const char *, int, struct ui_file *); |
d318976c | 217 | |
ebcd3b23 | 218 | /* Functions that implement commands about CLI commands. */ |
d318976c | 219 | |
64669f3b | 220 | extern void help_cmd (const char *, struct ui_file *); |
d318976c | 221 | |
d318976c | 222 | extern void apropos_cmd (struct ui_file *, struct cmd_list_element *, |
2d7cc5c7 | 223 | compiled_regex &, const char *); |
d318976c FN |
224 | |
225 | /* Used to mark commands that don't do anything. If we just leave the | |
226 | function field NULL, the command is interpreted as a help topic, or | |
227 | as a class of commands. */ | |
228 | ||
eb7c454d | 229 | extern void not_just_help_class_command (const char *arg, int from_tty); |
d318976c FN |
230 | |
231 | /* Exported to cli/cli-setshow.c */ | |
232 | ||
1947513d | 233 | extern void print_doc_line (struct ui_file *, const char *); |
d318976c | 234 | |
5b9afe8a | 235 | extern const char * const auto_boolean_enums[]; |
d318976c | 236 | |
a9f116cb GKB |
237 | /* Verify whether a given cmd_list_element is a user-defined command. |
238 | Return 1 if it is user-defined. Return 0 otherwise. */ | |
239 | ||
240 | extern int cli_user_command_p (struct cmd_list_element *); | |
241 | ||
604c4576 JG |
242 | extern int find_command_name_length (const char *); |
243 | ||
d318976c | 244 | #endif /* !defined (CLI_DECODE_H) */ |