1 /* Header file for command-reading library command.c. 2 Copyright (C) 1986, 1989, 1990 Free Software Foundation, Inc. 3 4 This program is free software; you can redistribute it and/or modify 5 it under the terms of the GNU General Public License as published by 6 the Free Software Foundation; either version 2 of the License, or 7 (at your option) any later version. 8 9 This program is distributed in the hope that it will be useful, 10 but WITHOUT ANY WARRANTY; without even the implied warranty of 11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 GNU General Public License for more details. 13 14 You should have received a copy of the GNU General Public License 15 along with this program; if not, write to the Free Software 16 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ 17 18 #if !defined (COMMAND_H) 19 #define COMMAND_H 1 20 21 /* Not a set/show command. Note that some commands which begin with 22 "set" or "show" might be in this category, if their syntax does 23 not fall into one of the following categories. */ 24 typedef enum cmd_types { 25 not_set_cmd, 26 set_cmd, 27 show_cmd 28 } cmd_types; 29 30 /* Types of "set" or "show" command. */ 31 typedef enum var_types { 32 /* "on" or "off". *VAR is an integer which is nonzero for on, 33 zero for off. */ 34 var_boolean, 35 /* Unsigned Integer. *VAR is an unsigned int. The user can type 0 36 to mean "unlimited", which is stored in *VAR as UINT_MAX. */ 37 var_uinteger, 38 39 /* Like var_uinteger but signed. *VAR is an int. The user can type 0 40 to mean "unlimited", which is stored in *VAR as INT_MAX. */ 41 var_integer, 42 43 /* String which the user enters with escapes (e.g. the user types \n and 44 it is a real newline in the stored string). 45 *VAR is a malloc'd string, or NULL if the string is empty. */ 46 var_string, 47 /* String which stores what the user types verbatim. 48 *VAR is a malloc'd string, or NULL if the string is empty. */ 49 var_string_noescape, 50 /* String which stores a filename. 51 *VAR is a malloc'd string, or NULL if the string is empty. */ 52 var_filename, 53 /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except 54 that zero really means zero. */ 55 var_zinteger, 56 /* Enumerated type. Can only have one of the specified values. *VAR is a 57 char pointer to the name of the element that we find. */ 58 var_enum 59 } var_types; 60 61 /* This structure records one command'd definition. */ 62 63 struct cmd_list_element 64 { 65 /* Points to next command in this list. */ 66 struct cmd_list_element *next; 67 68 /* Name of this command. */ 69 char *name; 70 71 /* Command class; class values are chosen by application program. */ 72 enum command_class class; 73 74 /* Function definition of this command. 75 NO_FUNCTION for command class names and for help topics that 76 are not really commands. */ 77 union 78 { 79 /* If type is not_set_cmd, call it like this: */ 80 void (*cfunc) PARAMS ((char *args, int from_tty)); 81 82 /* If type is cmd_set or show_cmd, first set the variables, and 83 then call this. */ 84 void (*sfunc) PARAMS ((char *args, int from_tty, 85 struct cmd_list_element *c)); 86 } function; 87 # define NO_FUNCTION ((void (*) PARAMS((char *args, int from_tty))) 0) 88 89 /* Documentation of this command (or help topic). 90 First line is brief documentation; remaining lines form, with it, 91 the full documentation. First line should end with a period. 92 Entire string should also end with a period, not a newline. */ 93 char *doc; 94 95 /* Hook for another command to be executed before this command. */ 96 struct cmd_list_element *hook; 97 98 /* Nonzero identifies a prefix command. For them, the address 99 of the variable containing the list of subcommands. */ 100 struct cmd_list_element **prefixlist; 101 102 /* For prefix commands only: 103 String containing prefix commands to get here: this one 104 plus any others needed to get to it. Should end in a space. 105 It is used before the word "command" in describing the 106 commands reached through this prefix. */ 107 char *prefixname; 108 109 /* For prefix commands only: 110 nonzero means do not get an error if subcommand is not 111 recognized; call the prefix's own function in that case. */ 112 char allow_unknown; 113 114 /* Nonzero says this is an abbreviation, and should not 115 be mentioned in lists of commands. 116 This allows "br<tab>" to complete to "break", which it 117 otherwise wouldn't. */ 118 char abbrev_flag; 119 120 /* Completion routine for this command. TEXT is the text beyond 121 what was matched for the command itself (leading whitespace is 122 skipped). It stops where we are supposed to stop completing 123 (rl_point) and is '\0' terminated. 124 125 Return value is a malloc'd vector of pointers to possible completions 126 terminated with NULL. If there are no completions, returning a pointer 127 to a NULL would work but returning NULL itself is also valid. 128 WORD points in the same buffer as TEXT, and completions should be 129 returned relative to this position. For example, suppose TEXT is "foo" 130 and we want to complete to "foobar". If WORD is "oo", return 131 "oobar"; if WORD is "baz/foo", return "baz/foobar". */ 132 char ** (*completer) PARAMS ((char *text, char *word)); 133 134 /* Type of "set" or "show" command (or SET_NOT_SET if not "set" 135 or "show"). */ 136 cmd_types type; 137 138 /* Pointer to variable affected by "set" and "show". Doesn't matter 139 if type is not_set. */ 140 char *var; 141 142 /* What kind of variable is *VAR? */ 143 var_types var_type; 144 145 /* Pointer to NULL terminated list of enumerated values (like argv). */ 146 char **enums; 147 148 /* Pointer to command strings of user-defined commands */ 149 struct command_line *user_commands; 150 151 /* Pointer to command that is hooked by this one, 152 so the hook can be removed when this one is deleted. */ 153 struct cmd_list_element *hookee; 154 155 /* Pointer to command that is aliased by this one, so the 156 aliased command can be located in case it has been hooked. */ 157 struct cmd_list_element *cmd_pointer; 158 }; 159 160 /* Forward-declarations of the entry-points of command.c. */ 161 162 extern struct cmd_list_element * 163 add_cmd PARAMS ((char *, enum command_class, void (*fun) (char *, int), 164 char *, struct cmd_list_element **)); 165 166 extern struct cmd_list_element * 167 add_alias_cmd PARAMS ((char *, char *, enum command_class, int, 168 struct cmd_list_element **)); 169 170 extern struct cmd_list_element * 171 add_prefix_cmd PARAMS ((char *, enum command_class, void (*fun) (char *, int), 172 char *, struct cmd_list_element **, char *, int, 173 struct cmd_list_element **)); 174 175 extern struct cmd_list_element * 176 add_abbrev_prefix_cmd PARAMS ((char *, enum command_class, 177 void (*fun) (char *, int), char *, 178 struct cmd_list_element **, char *, int, 179 struct cmd_list_element **)); 180 181 extern struct cmd_list_element * 182 lookup_cmd PARAMS ((char **, struct cmd_list_element *, char *, int, int)); 183 184 extern struct cmd_list_element * 185 lookup_cmd_1 PARAMS ((char **, struct cmd_list_element *, 186 struct cmd_list_element **, int)); 187 188 extern void 189 add_com PARAMS ((char *, enum command_class, void (*fun)(char *, int), 190 char *)); 191 192 extern void 193 add_com_alias PARAMS ((char *, char *, enum command_class, int)); 194 195 extern void 196 add_info PARAMS ((char *, void (*fun) (char *, int), char *)); 197 198 extern void 199 add_info_alias PARAMS ((char *, char *, int)); 200 201 extern char ** 202 complete_on_cmdlist PARAMS ((struct cmd_list_element *, char *, char *)); 203 204 extern char ** 205 complete_on_enum PARAMS ((char **enumlist, char *, char *)); 206 207 extern void 208 delete_cmd PARAMS ((char *, struct cmd_list_element **)); 209 210 extern void 211 help_cmd PARAMS ((char *, GDB_FILE *)); 212 213 extern void 214 help_list PARAMS ((struct cmd_list_element *, char *, enum command_class, 215 GDB_FILE *)); 216 217 extern void 218 help_cmd_list PARAMS ((struct cmd_list_element *, enum command_class, char *, 219 int, GDB_FILE *)); 220 221 extern struct cmd_list_element * 222 add_set_cmd PARAMS ((char *, enum command_class, var_types, char *, char *, 223 struct cmd_list_element **)); 224 225 extern struct cmd_list_element * 226 add_set_enum_cmd PARAMS ((char *name, enum command_class, char *list[], 227 char *var, char *doc, struct cmd_list_element **c)); 228 229 extern struct cmd_list_element * 230 add_show_from_set PARAMS ((struct cmd_list_element *, 231 struct cmd_list_element **)); 232 233 /* Do a "set" or "show" command. ARG is NULL if no argument, or the text 234 of the argument, and FROM_TTY is nonzero if this command is being entered 235 directly by the user (i.e. these are just like any other 236 command). C is the command list element for the command. */ 237 238 extern void 239 do_setshow_command PARAMS ((char *, int, struct cmd_list_element *)); 240 241 /* Do a "show" command for each thing on a command list. */ 242 243 extern void 244 cmd_show_list PARAMS ((struct cmd_list_element *, int, char *)); 245 246 extern void 247 error_no_arg PARAMS ((char *)); 248 249 extern void 250 dont_repeat PARAMS ((void)); 251 252 /* Used to mark commands that don't do anything. If we just leave the 253 function field NULL, the command is interpreted as a help topic, or 254 as a class of commands. */ 255 256 extern void 257 not_just_help_class_command PARAMS ((char *, int)); 258 259 #endif /* !defined (COMMAND_H) */ 260