1 /* Header file for GDB command decoding library. 2 3 Copyright (c) 2000, 2003, 2007, 2008, 2009 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 #include "command.h" 22 23 struct re_pattern_buffer; 24 25 #if 0 26 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum 27 cmd_types'' can be moved from "command.h" to "cli-decode.h". */ 28 /* Not a set/show command. Note that some commands which begin with 29 "set" or "show" might be in this category, if their syntax does 30 not fall into one of the following categories. */ 31 typedef enum cmd_types 32 { 33 not_set_cmd, 34 set_cmd, 35 show_cmd 36 } 37 cmd_types; 38 #endif 39 40 /* This structure records one command'd definition. */ 41 42 43 /* This flag is used by the code executing commands to warn the user 44 the first time a deprecated command is used, see the 'flags' field in 45 the following struct. 46 */ 47 #define CMD_DEPRECATED 0x1 48 #define DEPRECATED_WARN_USER 0x2 49 #define MALLOCED_REPLACEMENT 0x4 50 51 struct cmd_list_element 52 { 53 /* Points to next command in this list. */ 54 struct cmd_list_element *next; 55 56 /* Name of this command. */ 57 char *name; 58 59 /* Command class; class values are chosen by application program. */ 60 enum command_class class; 61 62 /* Function definition of this command. NULL for command class 63 names and for help topics that are not really commands. NOTE: 64 cagney/2002-02-02: This function signature is evolving. For 65 the moment suggest sticking with either set_cmd_cfunc() or 66 set_cmd_sfunc(). */ 67 void (*func) (struct cmd_list_element *c, char *args, int from_tty); 68 /* The command's real callback. At present func() bounces through 69 to one of the below. */ 70 union 71 { 72 /* If type is not_set_cmd, call it like this: */ 73 cmd_cfunc_ftype *cfunc; 74 /* If type is set_cmd or show_cmd, first set the variables, 75 and then call this: */ 76 cmd_sfunc_ftype *sfunc; 77 } 78 function; 79 80 /* Local state (context) for this command. This can be anything. */ 81 void *context; 82 83 /* Documentation of this command (or help topic). 84 First line is brief documentation; remaining lines form, with it, 85 the full documentation. First line should end with a period. 86 Entire string should also end with a period, not a newline. */ 87 char *doc; 88 89 /* For set/show commands. A method for printing the output to the 90 specified stream. */ 91 show_value_ftype *show_value_func; 92 93 /* flags : a bitfield 94 95 bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command 96 is deprecated. It may be removed from gdb's command set in the 97 future. 98 99 bit 1: DEPRECATED_WARN_USER, the user needs to be warned that 100 this is a deprecated command. The user should only be warned 101 the first time a command is used. 102 103 bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at 104 compile time (this is the way it should, in general, be done) 105 the memory containing the replacement string is statically 106 allocated. In some cases it makes sense to deprecate commands 107 at runtime (the testsuite is one example). In this case the 108 memory for replacement is malloc'ed. When a command is 109 undeprecated or re-deprecated at runtime we don't want to risk 110 calling free on statically allocated memory, so we check this 111 flag. 112 */ 113 int flags; 114 115 /* If this command is deprecated, this is the replacement name. */ 116 char *replacement; 117 118 /* If this command represents a show command, then this function 119 is called before the variable's value is examined. */ 120 void (*pre_show_hook) (struct cmd_list_element *c); 121 122 /* Hook for another command to be executed before this command. */ 123 struct cmd_list_element *hook_pre; 124 125 /* Hook for another command to be executed after this command. */ 126 struct cmd_list_element *hook_post; 127 128 /* Flag that specifies if this command is already running its hook. */ 129 /* Prevents the possibility of hook recursion. */ 130 int hook_in; 131 132 /* Nonzero identifies a prefix command. For them, the address 133 of the variable containing the list of subcommands. */ 134 struct cmd_list_element **prefixlist; 135 136 /* For prefix commands only: 137 String containing prefix commands to get here: this one 138 plus any others needed to get to it. Should end in a space. 139 It is used before the word "command" in describing the 140 commands reached through this prefix. */ 141 char *prefixname; 142 143 /* For prefix commands only: 144 nonzero means do not get an error if subcommand is not 145 recognized; call the prefix's own function in that case. */ 146 char allow_unknown; 147 148 /* Nonzero says this is an abbreviation, and should not 149 be mentioned in lists of commands. 150 This allows "br<tab>" to complete to "break", which it 151 otherwise wouldn't. */ 152 char abbrev_flag; 153 154 /* Completion routine for this command. TEXT is the text beyond 155 what was matched for the command itself (leading whitespace is 156 skipped). It stops where we are supposed to stop completing 157 (rl_point) and is '\0' terminated. 158 159 Return value is a malloc'd vector of pointers to possible completions 160 terminated with NULL. If there are no completions, returning a pointer 161 to a NULL would work but returning NULL itself is also valid. 162 WORD points in the same buffer as TEXT, and completions should be 163 returned relative to this position. For example, suppose TEXT is "foo" 164 and we want to complete to "foobar". If WORD is "oo", return 165 "oobar"; if WORD is "baz/foo", return "baz/foobar". */ 166 char **(*completer) (struct cmd_list_element *cmd, char *text, char *word); 167 168 /* Destruction routine for this command. If non-NULL, this is 169 called when this command instance is destroyed. This may be 170 used to finalize the CONTEXT field, if needed. */ 171 void (*destroyer) (struct cmd_list_element *self, void *context); 172 173 /* Type of "set" or "show" command (or SET_NOT_SET if not "set" 174 or "show"). */ 175 cmd_types type; 176 177 /* Pointer to variable affected by "set" and "show". Doesn't matter 178 if type is not_set. */ 179 void *var; 180 181 /* What kind of variable is *VAR? */ 182 var_types var_type; 183 184 /* Pointer to NULL terminated list of enumerated values (like argv). */ 185 const char **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 209 /* API to the manipulation of command lists. */ 210 211 extern struct cmd_list_element *add_cmd (char *, enum command_class, 212 void (*fun) (char *, int), char *, 213 struct cmd_list_element **); 214 215 extern struct cmd_list_element *add_alias_cmd (char *, char *, 216 enum command_class, int, 217 struct cmd_list_element **); 218 219 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class, 220 void (*fun) (char *, int), 221 char *, 222 struct cmd_list_element **, 223 char *, int, 224 struct cmd_list_element **); 225 226 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *, 227 enum command_class, 228 void (*fun) (char *, 229 int), 230 char *, 231 struct cmd_list_element 232 **, char *, int, 233 struct cmd_list_element 234 **); 235 236 /* Set the commands corresponding callback. */ 237 238 extern void set_cmd_cfunc (struct cmd_list_element *cmd, 239 void (*cfunc) (char *args, int from_tty)); 240 241 extern void set_cmd_sfunc (struct cmd_list_element *cmd, 242 void (*sfunc) (char *args, int from_tty, 243 struct cmd_list_element * c)); 244 245 extern void set_cmd_completer (struct cmd_list_element *cmd, 246 char **(*completer) (struct cmd_list_element *self, 247 char *text, char *word)); 248 249 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs 250 around in cmd objects to test the value of the commands sfunc(). */ 251 extern int cmd_cfunc_eq (struct cmd_list_element *cmd, 252 void (*cfunc) (char *args, int from_tty)); 253 254 /* Access to the command's local context. */ 255 extern void set_cmd_context (struct cmd_list_element *cmd, void *context); 256 extern void *get_cmd_context (struct cmd_list_element *cmd); 257 258 extern struct cmd_list_element *lookup_cmd (char **, 259 struct cmd_list_element *, char *, 260 int, int); 261 262 extern struct cmd_list_element *lookup_cmd_1 (char **, 263 struct cmd_list_element *, 264 struct cmd_list_element **, 265 int); 266 267 extern struct cmd_list_element * 268 deprecate_cmd (struct cmd_list_element *, char * ); 269 270 extern void 271 deprecated_cmd_warning (char **); 272 273 extern int 274 lookup_cmd_composition (char *text, 275 struct cmd_list_element **alias, 276 struct cmd_list_element **prefix_cmd, 277 struct cmd_list_element **cmd); 278 279 extern struct cmd_list_element *add_com (char *, enum command_class, 280 void (*fun) (char *, int), char *); 281 282 extern struct cmd_list_element *add_com_alias (char *, char *, 283 enum command_class, int); 284 285 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int), 286 char *); 287 288 extern struct cmd_list_element *add_info_alias (char *, char *, int); 289 290 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *); 291 292 extern char **complete_on_enum (const char *enumlist[], char *, char *); 293 294 extern void help_cmd_list (struct cmd_list_element *, enum command_class, 295 char *, int, struct ui_file *); 296 297 /* Functions that implement commands about CLI commands. */ 298 299 extern void help_cmd (char *, struct ui_file *); 300 301 extern void help_list (struct cmd_list_element *, char *, 302 enum command_class, struct ui_file *); 303 304 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *, 305 struct re_pattern_buffer *, char *); 306 307 /* Used to mark commands that don't do anything. If we just leave the 308 function field NULL, the command is interpreted as a help topic, or 309 as a class of commands. */ 310 311 extern void not_just_help_class_command (char *arg, int from_tty); 312 313 /* Exported to cli/cli-setshow.c */ 314 315 extern void print_doc_line (struct ui_file *, char *); 316 317 318 #endif /* !defined (CLI_DECODE_H) */ 319