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