1 /* Header file for GDB command decoding library.
3 Copyright (C) 2000-2019 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 #ifndef CLI_CLI_DECODE_H
19 #define CLI_CLI_DECODE_H
21 /* This file defines the private interfaces for any code implementing
24 /* Include the public interfaces. */
26 #include "gdb_regex.h"
27 #include "cli-script.h"
28 #include "completer.h"
31 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
32 cmd_types'' can be moved from "command.h" to "cli-decode.h". */
33 /* Not a set/show command. Note that some commands which begin with
34 "set" or "show" might be in this category, if their syntax does
35 not fall into one of the following categories. */
36 typedef enum cmd_types
45 /* This structure records one command'd definition. */
48 struct cmd_list_element
50 cmd_list_element (const char *name_
, enum command_class theclass_
,
55 deprecated_warn_user (0),
56 malloced_replacement (0),
62 var_type (var_boolean
),
65 memset (&function
, 0, sizeof (function
));
70 if (doc
&& doc_allocated
)
74 DISABLE_COPY_AND_ASSIGN (cmd_list_element
);
77 /* Points to next command in this list. */
78 struct cmd_list_element
*next
= nullptr;
80 /* Name of this command. */
83 /* Command class; class values are chosen by application program. */
84 enum command_class theclass
;
86 /* When 1 indicated that this command is deprecated. It may be
87 removed from gdb's command set in the future. */
89 unsigned int cmd_deprecated
: 1;
91 /* The user needs to be warned that this is a deprecated command.
92 The user should only be warned the first time a command is
95 unsigned int deprecated_warn_user
: 1;
97 /* When functions are deprecated at compile time (this is the way
98 it should, in general, be done) the memory containing the
99 replacement string is statically allocated. In some cases it
100 makes sense to deprecate commands at runtime (the testsuite is
101 one example). In this case the memory for replacement is
102 malloc'ed. When a command is undeprecated or re-deprecated at
103 runtime we don't want to risk calling free on statically
104 allocated memory, so we check this flag. */
106 unsigned int malloced_replacement
: 1;
108 /* Set if the doc field should be xfree'd. */
110 unsigned int doc_allocated
: 1;
112 /* Flag that specifies if this command is already running its hook. */
113 /* Prevents the possibility of hook recursion. */
114 unsigned int hook_in
: 1;
116 /* For prefix commands only:
117 nonzero means do not get an error if subcommand is not
118 recognized; call the prefix's own function in that case. */
119 unsigned int allow_unknown
: 1;
121 /* Nonzero says this is an abbreviation, and should not
122 be mentioned in lists of commands.
123 This allows "br<tab>" to complete to "break", which it
124 otherwise wouldn't. */
125 unsigned int abbrev_flag
: 1;
127 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
129 ENUM_BITFIELD (cmd_types
) type
: 2;
131 /* What kind of variable is *VAR? */
132 ENUM_BITFIELD (var_types
) var_type
: 4;
134 /* Function definition of this command. NULL for command class
135 names and for help topics that are not really commands. NOTE:
136 cagney/2002-02-02: This function signature is evolving. For
137 the moment suggest sticking with either set_cmd_cfunc() or
139 void (*func
) (struct cmd_list_element
*c
, const char *args
, int from_tty
)
141 /* The command's real callback. At present func() bounces through
142 to one of the below. */
145 /* If type is not_set_cmd, call it like this: */
146 cmd_const_cfunc_ftype
*const_cfunc
;
147 /* If type is set_cmd or show_cmd, first set the variables,
148 and then call this: */
149 cmd_const_sfunc_ftype
*sfunc
;
153 /* Local state (context) for this command. This can be anything. */
154 void *context
= nullptr;
156 /* Documentation of this command (or help topic).
157 First line is brief documentation; remaining lines form, with it,
158 the full documentation. First line should end with a period.
159 Entire string should also end with a period, not a newline. */
162 /* For set/show commands. A method for printing the output to the
164 show_value_ftype
*show_value_func
= nullptr;
166 /* If this command is deprecated, this is the replacement name. */
167 const char *replacement
= nullptr;
169 /* If this command represents a show command, then this function
170 is called before the variable's value is examined. */
171 void (*pre_show_hook
) (struct cmd_list_element
*c
) = nullptr;
173 /* Hook for another command to be executed before this command. */
174 struct cmd_list_element
*hook_pre
= nullptr;
176 /* Hook for another command to be executed after this command. */
177 struct cmd_list_element
*hook_post
= nullptr;
179 /* Nonzero identifies a prefix command. For them, the address
180 of the variable containing the list of subcommands. */
181 struct cmd_list_element
**prefixlist
= nullptr;
183 /* For prefix commands only:
184 String containing prefix commands to get here: this one
185 plus any others needed to get to it. Should end in a space.
186 It is used before the word "command" in describing the
187 commands reached through this prefix. */
188 const char *prefixname
= nullptr;
190 /* The prefix command of this command. */
191 struct cmd_list_element
*prefix
= nullptr;
193 /* Completion routine for this command. */
194 completer_ftype
*completer
= symbol_completer
;
196 /* Handle the word break characters for this completer. Usually
197 this function need not be defined, but for some types of
198 completers (e.g., Python completers declared as methods inside
199 a class) the word break chars may need to be redefined
200 depending on the completer type (e.g., for filename
202 completer_handle_brkchars_ftype
*completer_handle_brkchars
= nullptr;
204 /* Destruction routine for this command. If non-NULL, this is
205 called when this command instance is destroyed. This may be
206 used to finalize the CONTEXT field, if needed. */
207 void (*destroyer
) (struct cmd_list_element
*self
, void *context
) = nullptr;
209 /* Pointer to variable affected by "set" and "show". Doesn't
210 matter if type is not_set. */
213 /* Pointer to NULL terminated list of enumerated values (like
215 const char *const *enums
= nullptr;
217 /* Pointer to command strings of user-defined commands */
218 counted_command_line user_commands
;
220 /* Pointer to command that is hooked by this one, (by hook_pre)
221 so the hook can be removed when this one is deleted. */
222 struct cmd_list_element
*hookee_pre
= nullptr;
224 /* Pointer to command that is hooked by this one, (by hook_post)
225 so the hook can be removed when this one is deleted. */
226 struct cmd_list_element
*hookee_post
= nullptr;
228 /* Pointer to command that is aliased by this one, so the
229 aliased command can be located in case it has been hooked. */
230 struct cmd_list_element
*cmd_pointer
= nullptr;
232 /* Start of a linked list of all aliases of this command. */
233 struct cmd_list_element
*aliases
= nullptr;
235 /* Link pointer for aliases on an alias list. */
236 struct cmd_list_element
*alias_chain
= nullptr;
238 /* If non-null, the pointer to a field in 'struct
239 cli_suppress_notification', which will be set to true in cmd_func
240 when this command is being executed. It will be set back to false
241 when the command has been executed. */
242 int *suppress_notification
= nullptr;
245 extern void help_cmd_list (struct cmd_list_element
*, enum command_class
,
246 const char *, int, struct ui_file
*);
248 /* Functions that implement commands about CLI commands. */
250 extern void help_cmd (const char *, struct ui_file
*);
252 extern void apropos_cmd (struct ui_file
*, struct cmd_list_element
*,
253 bool verbose
, compiled_regex
&, const char *);
255 /* Used to mark commands that don't do anything. If we just leave the
256 function field NULL, the command is interpreted as a help topic, or
257 as a class of commands. */
259 extern void not_just_help_class_command (const char *arg
, int from_tty
);
261 /* Exported to cli/cli-setshow.c */
263 extern void print_doc_line (struct ui_file
*, const char *);
265 /* The enums of boolean commands. */
266 extern const char * const boolean_enums
[];
268 /* The enums of auto-boolean commands. */
269 extern const char * const auto_boolean_enums
[];
271 /* Verify whether a given cmd_list_element is a user-defined command.
272 Return 1 if it is user-defined. Return 0 otherwise. */
274 extern int cli_user_command_p (struct cmd_list_element
*);
276 extern int find_command_name_length (const char *);
278 #endif /* CLI_CLI_DECODE_H */