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