gdb/command.h

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