1 /* Header file for GDB command decoding library.
3 Copyright (C) 2000-2017 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 /* Points to next command in this list. */
49 struct cmd_list_element *next;
51 /* Name of this command. */
54 /* Command class; class values are chosen by application program. */
55 enum command_class theclass;
57 /* When 1 indicated that this command is deprecated. It may be
58 removed from gdb's command set in the future. */
60 unsigned int cmd_deprecated : 1;
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
66 unsigned int deprecated_warn_user : 1;
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. */
77 unsigned int malloced_replacement : 1;
79 /* Set if the doc field should be xfree'd. */
81 unsigned int doc_allocated : 1;
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;
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;
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;
98 /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
100 ENUM_BITFIELD (cmd_types) type : 2;
102 /* What kind of variable is *VAR? */
103 ENUM_BITFIELD (var_types) var_type : 4;
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
110 void (*func) (struct cmd_list_element *c, char *args, int from_tty);
111 /* The command's real callback. At present func() bounces through
112 to one of the below. */
115 /* If type is not_set_cmd, call it like this: */
116 cmd_cfunc_ftype *cfunc;
117 /* ... or like this. */
118 cmd_const_cfunc_ftype *const_cfunc;
119 /* If type is set_cmd or show_cmd, first set the variables,
120 and then call this: */
121 cmd_sfunc_ftype *sfunc;
125 /* Local state (context) for this command. This can be anything. */
128 /* Documentation of this command (or help topic).
129 First line is brief documentation; remaining lines form, with it,
130 the full documentation. First line should end with a period.
131 Entire string should also end with a period, not a newline. */
134 /* For set/show commands. A method for printing the output to the
136 show_value_ftype *show_value_func;
138 /* If this command is deprecated, this is the replacement name. */
139 const char *replacement;
141 /* If this command represents a show command, then this function
142 is called before the variable's value is examined. */
143 void (*pre_show_hook) (struct cmd_list_element *c);
145 /* Hook for another command to be executed before this command. */
146 struct cmd_list_element *hook_pre;
148 /* Hook for another command to be executed after this command. */
149 struct cmd_list_element *hook_post;
151 /* Nonzero identifies a prefix command. For them, the address
152 of the variable containing the list of subcommands. */
153 struct cmd_list_element **prefixlist;
155 /* For prefix commands only:
156 String containing prefix commands to get here: this one
157 plus any others needed to get to it. Should end in a space.
158 It is used before the word "command" in describing the
159 commands reached through this prefix. */
160 const char *prefixname;
162 /* The prefix command of this command. */
163 struct cmd_list_element *prefix;
165 /* Completion routine for this command. */
166 completer_ftype *completer;
168 /* Handle the word break characters for this completer. Usually
169 this function need not be defined, but for some types of
170 completers (e.g., Python completers declared as methods inside
171 a class) the word break chars may need to be redefined
172 depending on the completer type (e.g., for filename
174 completer_handle_brkchars_ftype *completer_handle_brkchars;
176 /* Destruction routine for this command. If non-NULL, this is
177 called when this command instance is destroyed. This may be
178 used to finalize the CONTEXT field, if needed. */
179 void (*destroyer) (struct cmd_list_element *self, void *context);
181 /* Pointer to variable affected by "set" and "show". Doesn't
182 matter if type is not_set. */
185 /* Pointer to NULL terminated list of enumerated values (like
187 const char *const *enums;
189 /* Pointer to command strings of user-defined commands */
190 struct command_line *user_commands;
192 /* Pointer to command that is hooked by this one, (by hook_pre)
193 so the hook can be removed when this one is deleted. */
194 struct cmd_list_element *hookee_pre;
196 /* Pointer to command that is hooked by this one, (by hook_post)
197 so the hook can be removed when this one is deleted. */
198 struct cmd_list_element *hookee_post;
200 /* Pointer to command that is aliased by this one, so the
201 aliased command can be located in case it has been hooked. */
202 struct cmd_list_element *cmd_pointer;
204 /* Start of a linked list of all aliases of this command. */
205 struct cmd_list_element *aliases;
207 /* Link pointer for aliases on an alias list. */
208 struct cmd_list_element *alias_chain;
210 /* If non-null, the pointer to a field in 'struct
211 cli_suppress_notification', which will be set to true in cmd_func
212 when this command is being executed. It will be set back to false
213 when the command has been executed. */
214 int *suppress_notification;
217 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
218 const char *, int, struct ui_file *);
220 /* Functions that implement commands about CLI commands. */
222 extern void help_cmd (const char *, struct ui_file *);
224 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
225 compiled_regex &, const char *);
227 /* Used to mark commands that don't do anything. If we just leave the
228 function field NULL, the command is interpreted as a help topic, or
229 as a class of commands. */
231 extern void not_just_help_class_command (const char *arg, int from_tty);
233 /* Exported to cli/cli-setshow.c */
235 extern void print_doc_line (struct ui_file *, const char *);
237 extern const char * const auto_boolean_enums[];
239 /* Verify whether a given cmd_list_element is a user-defined command.
240 Return 1 if it is user-defined. Return 0 otherwise. */
242 extern int cli_user_command_p (struct cmd_list_element *);
244 extern int find_command_name_length (const char *);
246 #endif /* !defined (CLI_DECODE_H) */