1 /* Header file for GDB command decoding library.
3 Copyright (C) 2000-2018 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. */
26 #include "gdb_regex.h"
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". */
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
43 /* This structure records one command'd definition. */
46 struct cmd_list_element
48 cmd_list_element (const char *name_
, enum command_class theclass_
,
53 deprecated_warn_user (0),
54 malloced_replacement (0),
60 var_type (var_boolean
),
63 memset (&function
, 0, sizeof (function
));
68 if (doc
&& doc_allocated
)
72 DISABLE_COPY_AND_ASSIGN (cmd_list_element
);
75 /* Points to next command in this list. */
76 struct cmd_list_element
*next
= nullptr;
78 /* Name of this command. */
81 /* Command class; class values are chosen by application program. */
82 enum command_class theclass
;
84 /* When 1 indicated that this command is deprecated. It may be
85 removed from gdb's command set in the future. */
87 unsigned int cmd_deprecated
: 1;
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
93 unsigned int deprecated_warn_user
: 1;
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. */
104 unsigned int malloced_replacement
: 1;
106 /* Set if the doc field should be xfree'd. */
108 unsigned int doc_allocated
: 1;
110 /* Flag that specifies if this command is already running its hook. */
111 /* Prevents the possibility of hook recursion. */
112 unsigned int hook_in
: 1;
114 /* For prefix commands only:
115 nonzero means do not get an error if subcommand is not
116 recognized; call the prefix's own function in that case. */
117 unsigned int allow_unknown
: 1;
119 /* Nonzero says this is an abbreviation, and should not
120 be mentioned in lists of commands.
121 This allows "br<tab>" to complete to "break", which it
122 otherwise wouldn't. */
123 unsigned int abbrev_flag
: 1;
125 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
127 ENUM_BITFIELD (cmd_types
) type
: 2;
129 /* What kind of variable is *VAR? */
130 ENUM_BITFIELD (var_types
) var_type
: 4;
132 /* Function definition of this command. NULL for command class
133 names and for help topics that are not really commands. NOTE:
134 cagney/2002-02-02: This function signature is evolving. For
135 the moment suggest sticking with either set_cmd_cfunc() or
137 void (*func
) (struct cmd_list_element
*c
, const char *args
, int from_tty
)
139 /* The command's real callback. At present func() bounces through
140 to one of the below. */
143 /* If type is not_set_cmd, call it like this: */
144 cmd_const_cfunc_ftype
*const_cfunc
;
145 /* If type is set_cmd or show_cmd, first set the variables,
146 and then call this: */
147 cmd_const_sfunc_ftype
*sfunc
;
151 /* Local state (context) for this command. This can be anything. */
152 void *context
= nullptr;
154 /* Documentation of this command (or help topic).
155 First line is brief documentation; remaining lines form, with it,
156 the full documentation. First line should end with a period.
157 Entire string should also end with a period, not a newline. */
160 /* For set/show commands. A method for printing the output to the
162 show_value_ftype
*show_value_func
= nullptr;
164 /* If this command is deprecated, this is the replacement name. */
165 const char *replacement
= nullptr;
167 /* If this command represents a show command, then this function
168 is called before the variable's value is examined. */
169 void (*pre_show_hook
) (struct cmd_list_element
*c
) = nullptr;
171 /* Hook for another command to be executed before this command. */
172 struct cmd_list_element
*hook_pre
= nullptr;
174 /* Hook for another command to be executed after this command. */
175 struct cmd_list_element
*hook_post
= nullptr;
177 /* Nonzero identifies a prefix command. For them, the address
178 of the variable containing the list of subcommands. */
179 struct cmd_list_element
**prefixlist
= nullptr;
181 /* For prefix commands only:
182 String containing prefix commands to get here: this one
183 plus any others needed to get to it. Should end in a space.
184 It is used before the word "command" in describing the
185 commands reached through this prefix. */
186 const char *prefixname
= nullptr;
188 /* The prefix command of this command. */
189 struct cmd_list_element
*prefix
= nullptr;
191 /* Completion routine for this command. */
192 completer_ftype
*completer
= symbol_completer
;
194 /* Handle the word break characters for this completer. Usually
195 this function need not be defined, but for some types of
196 completers (e.g., Python completers declared as methods inside
197 a class) the word break chars may need to be redefined
198 depending on the completer type (e.g., for filename
200 completer_handle_brkchars_ftype
*completer_handle_brkchars
= nullptr;
202 /* Destruction routine for this command. If non-NULL, this is
203 called when this command instance is destroyed. This may be
204 used to finalize the CONTEXT field, if needed. */
205 void (*destroyer
) (struct cmd_list_element
*self
, void *context
) = nullptr;
207 /* Pointer to variable affected by "set" and "show". Doesn't
208 matter if type is not_set. */
211 /* Pointer to NULL terminated list of enumerated values (like
213 const char *const *enums
= nullptr;
215 /* Pointer to command strings of user-defined commands */
216 struct command_line
*user_commands
= nullptr;
218 /* Pointer to command that is hooked by this one, (by hook_pre)
219 so the hook can be removed when this one is deleted. */
220 struct cmd_list_element
*hookee_pre
= nullptr;
222 /* Pointer to command that is hooked by this one, (by hook_post)
223 so the hook can be removed when this one is deleted. */
224 struct cmd_list_element
*hookee_post
= nullptr;
226 /* Pointer to command that is aliased by this one, so the
227 aliased command can be located in case it has been hooked. */
228 struct cmd_list_element
*cmd_pointer
= nullptr;
230 /* Start of a linked list of all aliases of this command. */
231 struct cmd_list_element
*aliases
= nullptr;
233 /* Link pointer for aliases on an alias list. */
234 struct cmd_list_element
*alias_chain
= nullptr;
236 /* If non-null, the pointer to a field in 'struct
237 cli_suppress_notification', which will be set to true in cmd_func
238 when this command is being executed. It will be set back to false
239 when the command has been executed. */
240 int *suppress_notification
= nullptr;
243 extern void help_cmd_list (struct cmd_list_element
*, enum command_class
,
244 const char *, int, struct ui_file
*);
246 /* Functions that implement commands about CLI commands. */
248 extern void help_cmd (const char *, struct ui_file
*);
250 extern void apropos_cmd (struct ui_file
*, struct cmd_list_element
*,
251 compiled_regex
&, const char *);
253 /* Used to mark commands that don't do anything. If we just leave the
254 function field NULL, the command is interpreted as a help topic, or
255 as a class of commands. */
257 extern void not_just_help_class_command (const char *arg
, int from_tty
);
259 /* Exported to cli/cli-setshow.c */
261 extern void print_doc_line (struct ui_file
*, const char *);
263 extern const char * const auto_boolean_enums
[];
265 /* Verify whether a given cmd_list_element is a user-defined command.
266 Return 1 if it is user-defined. Return 0 otherwise. */
268 extern int cli_user_command_p (struct cmd_list_element
*);
270 extern int find_command_name_length (const char *);
272 #endif /* !defined (CLI_DECODE_H) */