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