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