GDB (xrefs)

cli-decode.h
Go to the documentation of this file.
1 /* Header file for GDB command decoding library.
2
3 Copyright (C) 2000-2018 Free Software Foundation, Inc.
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
7 the Free Software Foundation; either version 3 of the License, or
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
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17
18 #if !defined (CLI_DECODE_H)
19 #define CLI_DECODE_H 1
20
21 /* This file defines the private interfaces for any code implementing
22 command internals. */
23
24 /* Include the public interfaces. */
25 #include "command.h"
26 #include "gdb_regex.h"
27
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". */
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;
41 #endif
42
43 /* This structure records one command'd definition. */
44
45
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. */
52 const char *name;
53
54 /* Command class; class values are chosen by application program. */
55 enum command_class theclass;
56
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
105 /* Function definition of this command. NULL for command class
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(). */
110 void (*func) (struct cmd_list_element *c, const char *args, int from_tty);
111 /* The command's real callback. At present func() bounces through
112 to one of the below. */
113 union
114 {
115 /* If type is not_set_cmd, call it like this: */
116 cmd_const_cfunc_ftype *const_cfunc;
117 /* If type is set_cmd or show_cmd, first set the variables,
118 and then call this: */
119 cmd_const_sfunc_ftype *sfunc;
120 }
121 function;
122
123 /* Local state (context) for this command. This can be anything. */
124 void *context;
125
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. */
130 const char *doc;
131
132 /* For set/show commands. A method for printing the output to the
133 specified stream. */
134 show_value_ftype *show_value_func;
135
136 /* If this command is deprecated, this is the replacement name. */
137 const char *replacement;
138
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
143 /* Hook for another command to be executed before this command. */
144 struct cmd_list_element *hook_pre;
145
146 /* Hook for another command to be executed after this command. */
147 struct cmd_list_element *hook_post;
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. */
158 const char *prefixname;
159
160 /* The prefix command of this command. */
161 struct cmd_list_element *prefix;
162
163 /* Completion routine for this command. */
164 completer_ftype *completer;
165
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). */
172 completer_handle_brkchars_ftype *completer_handle_brkchars;
173
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);
178
179 /* Pointer to variable affected by "set" and "show". Doesn't
180 matter if type is not_set. */
181 void *var;
182
183 /* Pointer to NULL terminated list of enumerated values (like
184 argv). */
185 const char *const *enums;
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;
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;
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;
213 };
214
215 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
216 const char *, int, struct ui_file *);
217
218 /* Functions that implement commands about CLI commands. */
219
220 extern void help_cmd (const char *, struct ui_file *);
221
222 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
223 compiled_regex &, const char *);
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
229 extern void not_just_help_class_command (const char *arg, int from_tty);
230
231 /* Exported to cli/cli-setshow.c */
232
233 extern void print_doc_line (struct ui_file *, const char *);
234
235 extern const char * const auto_boolean_enums[];
236
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
242 extern int find_command_name_length (const char *);
243
244 #endif /* !defined (CLI_DECODE_H) */
cmd_list_element::doc_allocated
unsigned int doc_allocated
Definition: cli-decode.h:81
command_line
Definition: cli-script.h:51
cmd_list_element::name
const char * name
Definition: cli-decode.h:52
cmd_list_element::deprecated_warn_user
unsigned int deprecated_warn_user
Definition: cli-decode.h:66
cmd_list_element::next
struct cmd_list_element * next
Definition: cli-decode.h:49
cmd_list_element::context
void * context
Definition: cli-decode.h:124
cli_user_command_p
int cli_user_command_p(struct cmd_list_element *)
Definition: cli-decode.c:1893
auto_boolean_enums
const char *const auto_boolean_enums[]
Definition: cli-decode.c:537
cmd_list_element::cmd_deprecated
unsigned int cmd_deprecated
Definition: cli-decode.h:60
cmd_list_element::completer_handle_brkchars
completer_handle_brkchars_ftype * completer_handle_brkchars
Definition: cli-decode.h:172
command.h
cmd_list_element::type
__extension__ enum cmd_types type
Definition: cli-decode.h:100
cmd_const_sfunc_ftype
void cmd_const_sfunc_ftype(const char *args, int from_tty, struct cmd_list_element *c)
Definition: command.h:177
cmd_list_element
Definition: cli-decode.h:46
gdb_regex.h
print_doc_line
void print_doc_line(struct ui_file *, const char *)
Definition: cli-decode.c:1170
apropos_cmd
void apropos_cmd(struct ui_file *, struct cmd_list_element *, compiled_regex &, const char *)
Definition: cli-decode.c:938
cmd_list_element::hook_post
struct cmd_list_element * hook_post
Definition: cli-decode.h:147
cmd_list_element::enums
const char *const * enums
Definition: cli-decode.h:185
cmd_list_element::hook_in
unsigned int hook_in
Definition: cli-decode.h:85
cmd_list_element::allow_unknown
unsigned int allow_unknown
Definition: cli-decode.h:90
cmd_list_element::aliases
struct cmd_list_element * aliases
Definition: cli-decode.h:203
find_command_name_length
int find_command_name_length(const char *)
Definition: cli-decode.c:1294
cmd_list_element::hookee_post
struct cmd_list_element * hookee_post
Definition: cli-decode.h:196
ui_file
Definition: ui-file.h:26
cmd_list_element::prefix
struct cmd_list_element * prefix
Definition: cli-decode.h:161
var_types
var_types
Definition: command.h:63
cmd_list_element::user_commands
struct command_line * user_commands
Definition: cli-decode.h:188
cmd_list_element::cmd_pointer
struct cmd_list_element * cmd_pointer
Definition: cli-decode.h:200
set_cmd
Definition: command.h:57
cmd_list_element::hook_pre
struct cmd_list_element * hook_pre
Definition: cli-decode.h:144
cmd_types
cmd_types
Definition: command.h:54
cmd_list_element::destroyer
void(* destroyer)(struct cmd_list_element *self, void *context)
Definition: cli-decode.h:177
cmd_list_element::var_type
__extension__ enum var_types var_type
Definition: cli-decode.h:103
cmd_list_element::var
void * var
Definition: cli-decode.h:181
cmd_list_element::sfunc
cmd_const_sfunc_ftype * sfunc
Definition: cli-decode.h:119
cmd_list_element::abbrev_flag
unsigned int abbrev_flag
Definition: cli-decode.h:96
completer_ftype
void completer_ftype(struct cmd_list_element *, completion_tracker &tracker, const char *text, const char *word)
Definition: command.h:191
not_set_cmd
Definition: command.h:56
cmd_list_element::pre_show_hook
void(* pre_show_hook)(struct cmd_list_element *c)
Definition: cli-decode.h:141
cmd_list_element::suppress_notification
int * suppress_notification
Definition: cli-decode.h:212
help_cmd
void help_cmd(const char *, struct ui_file *)
Definition: cli-decode.c:996
cmd_list_element::replacement
const char * replacement
Definition: cli-decode.h:137
command_class
command_class
Definition: command.h:36
cmd_const_cfunc_ftype
void cmd_const_cfunc_ftype(const char *args, int from_tty)
Definition: command.h:119
cmd_list_element::theclass
enum command_class theclass
Definition: cli-decode.h:55
help_cmd_list
void help_cmd_list(struct cmd_list_element *, enum command_class, const char *, int, struct ui_file *)
Definition: cli-decode.c:1238
cmd_list_element::func
void(* func)(struct cmd_list_element *c, const char *args, int from_tty)
Definition: cli-decode.h:110
show_cmd
Definition: command.h:58
cmd_list_element::alias_chain
struct cmd_list_element * alias_chain
Definition: cli-decode.h:206
cmd_list_element::show_value_func
show_value_ftype * show_value_func
Definition: cli-decode.h:134
completer_handle_brkchars_ftype
void completer_handle_brkchars_ftype(struct cmd_list_element *, completion_tracker &tracker, const char *text, const char *word)
Definition: command.h:196
cmd_list_element::const_cfunc
cmd_const_cfunc_ftype * const_cfunc
Definition: cli-decode.h:116
cmd_list_element::doc
const char * doc
Definition: cli-decode.h:130
cmd_list_element::prefixlist
struct cmd_list_element ** prefixlist
Definition: cli-decode.h:151
compiled_regex
Definition: gdb_regex.h:35
cmd_list_element::hookee_pre
struct cmd_list_element * hookee_pre
Definition: cli-decode.h:192
cmd_list_element::malloced_replacement
unsigned int malloced_replacement
Definition: cli-decode.h:77
cmd_list_element::completer
completer_ftype * completer
Definition: cli-decode.h:164
cmd_list_element::prefixname
const char * prefixname
Definition: cli-decode.h:158
not_just_help_class_command
void not_just_help_class_command(const char *arg, int from_tty)
Definition: cli-decode.c:412
show_value_ftype
void() show_value_ftype(struct ui_file *file, int from_tty, struct cmd_list_element *cmd, const char *value)
Definition: command.h:285