gdb/command.h

   1 /* ***DEPRECATED***  The gdblib files must not be calling/using things in any
   2    of the possible command languages.  If necessary, a hook (that may be
   3    present or not) must be used and set to the appropriate routine by any
   4    command language that cares about it.  If you are having to include this
   5    file you are possibly doing things the old way.  This file will disapear.
   6    2000-12-01 fnasser@redhat.com    */
   7
   8 /* Header file for command-reading library command.c.
   9    Copyright 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999, 2000
  10    Free Software Foundation, Inc.
  11
  12    This program is free software; you can redistribute it and/or modify
  13    it under the terms of the GNU General Public License as published by
  14    the Free Software Foundation; either version 2 of the License, or
  15    (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program; if not, write to the Free Software
  24    Foundation, Inc., 59 Temple Place - Suite 330,
  25    Boston, MA 02111-1307, USA.  */
  26
  27 #if !defined (COMMAND_H)
  28 #define COMMAND_H 1
  29
  30 /* Command classes are top-level categories into which commands are broken
  31    down for "help" purposes.
  32    Notes on classes: class_alias is for alias commands which are not
  33    abbreviations of the original command.  class-pseudo is for
  34    commands which are not really commands nor help topics ("stop").  */
  35
  36 enum command_class
  37 {
  38   /* Special args to help_list */
  39   class_deprecated, all_classes = -2, all_commands = -1,
  40   /* Classes of commands */
  41   no_class = -1, class_run = 0, class_vars, class_stack,
  42   class_files, class_support, class_info, class_breakpoint, class_trace,
  43   class_alias, class_obscure, class_user, class_maintenance,
  44   class_pseudo, class_tui, class_xdb
  45 };
  46
  47 /* Not a set/show command.  Note that some commands which begin with
  48    "set" or "show" might be in this category, if their syntax does
  49    not fall into one of the following categories.  */
  50 typedef enum cmd_types
  51   {
  52     not_set_cmd,
  53     set_cmd,
  54     show_cmd
  55   }
  56 cmd_types;
  57
  58 /* Reasonable values for an AUTO_BOOLEAN variable. */
  59 enum cmd_auto_boolean
  60 {
  61   CMD_AUTO_BOOLEAN_TRUE,
  62   CMD_AUTO_BOOLEAN_FALSE,
  63   CMD_AUTO_BOOLEAN_AUTO
  64 };
  65
  66 /* Types of "set" or "show" command.  */
  67 typedef enum var_types
  68   {
  69     /* "on" or "off".  *VAR is an integer which is nonzero for on,
  70        zero for off.  */
  71     var_boolean,
  72
  73     /* "on" / "true" / "enable" or "off" / "false" / "disable" or
  74        "auto.  *VAR is an ``enum cmd_auto_boolean''.  NOTE: In general
  75        a custom show command will need to be implemented - one that
  76        for "auto" prints both the "auto" and the current auto-selected
  77        value. */
  78     var_auto_boolean,
  79
  80     /* Unsigned Integer.  *VAR is an unsigned int.  The user can type 0
  81        to mean "unlimited", which is stored in *VAR as UINT_MAX.  */
  82     var_uinteger,
  83
  84     /* Like var_uinteger but signed.  *VAR is an int.  The user can type 0
  85        to mean "unlimited", which is stored in *VAR as INT_MAX.  */
  86     var_integer,
  87
  88     /* String which the user enters with escapes (e.g. the user types \n and
  89        it is a real newline in the stored string).
  90        *VAR is a malloc'd string, or NULL if the string is empty.  */
  91     var_string,
  92     /* String which stores what the user types verbatim.
  93        *VAR is a malloc'd string, or NULL if the string is empty.  */
  94     var_string_noescape,
  95     /* String which stores a filename.
  96        *VAR is a malloc'd string, or NULL if the string is empty.  */
  97     var_filename,
  98     /* ZeroableInteger.  *VAR is an int.  Like Unsigned Integer except
  99        that zero really means zero.  */
 100     var_zinteger,
 101     /* Enumerated type.  Can only have one of the specified values.  *VAR is a
 102        char pointer to the name of the element that we find.  */
 103     var_enum
 104   }
 105 var_types;
 106
 107 /* This structure records one command'd definition.  */
 108
 109
 110 /* This flag is used by the code executing commands to warn the user
 111    the first time a deprecated command is used, see the 'flags' field in
 112    the following struct.
 113 */
 114 #define CMD_DEPRECATED            0x1
 115 #define DEPRECATED_WARN_USER      0x2
 116 #define MALLOCED_REPLACEMENT      0x4
 117
 118 struct cmd_list_element
 119   {
 120     /* Points to next command in this list.  */
 121     struct cmd_list_element *next;
 122
 123     /* Name of this command.  */
 124     char *name;
 125
 126     /* Command class; class values are chosen by application program.  */
 127     enum command_class class;
 128
 129     /* Function definition of this command.  NULL for command class
 130        names and for help topics that are not really commands.  */
 131     union
 132       {
 133         /* If type is not_set_cmd, call it like this:  */
 134         void (*cfunc) (char *args, int from_tty);
 135
 136         /* If type is set_cmd or show_cmd, first set the variables, and
 137            then call this.  */
 138         void (*sfunc) (char *args, int from_tty, struct cmd_list_element * c);
 139       }
 140     function;
 141
 142     /* Documentation of this command (or help topic).
 143        First line is brief documentation; remaining lines form, with it,
 144        the full documentation.  First line should end with a period.
 145        Entire string should also end with a period, not a newline.  */
 146     char *doc;
 147
 148     /* flags : a bitfield
 149
 150        bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
 151        is deprecated. It may be removed from gdb's command set in the
 152        future.
 153
 154        bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
 155        this is a deprecated command.  The user should only be warned
 156        the first time a command is used.
 157
 158        bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
 159        compile time (this is the way it should, in general, be done)
 160        the memory containing the replacement string is statically
 161        allocated.  In some cases it makes sense to deprecate commands
 162        at runtime (the testsuite is one example).  In this case the
 163        memory for replacement is malloc'ed.  When a command is
 164        undeprecated or re-deprecated at runtime we don't want to risk
 165        calling free on statically allocated memory, so we check this
 166        flag.
 167      */
 168     int flags;
 169
 170     /* if this command is deprecated, this is the replacement name */
 171     char *replacement;
 172
 173     /* If this command represents a show command, then this function
 174        is called before the variable's value is examined.  */
 175     void (*pre_show_hook) (struct cmd_list_element *c);
 176
 177     /* Hook for another command to be executed before this command.  */
 178     struct cmd_list_element *hook_pre;
 179
 180     /* Hook for another command to be executed after this command.  */
 181     struct cmd_list_element *hook_post;
 182
 183     /* Flag that specifies if this command is already running it's hook. */
 184     /* Prevents the possibility of hook recursion. */
 185     int hook_in;
 186
 187     /* Nonzero identifies a prefix command.  For them, the address
 188        of the variable containing the list of subcommands.  */
 189     struct cmd_list_element **prefixlist;
 190
 191     /* For prefix commands only:
 192        String containing prefix commands to get here: this one
 193        plus any others needed to get to it.  Should end in a space.
 194        It is used before the word "command" in describing the
 195        commands reached through this prefix.  */
 196     char *prefixname;
 197
 198     /* For prefix commands only:
 199        nonzero means do not get an error if subcommand is not
 200        recognized; call the prefix's own function in that case.  */
 201     char allow_unknown;
 202
 203     /* Nonzero says this is an abbreviation, and should not
 204        be mentioned in lists of commands.
 205        This allows "br<tab>" to complete to "break", which it
 206        otherwise wouldn't.  */
 207     char abbrev_flag;
 208
 209     /* Completion routine for this command.  TEXT is the text beyond
 210        what was matched for the command itself (leading whitespace is
 211        skipped).  It stops where we are supposed to stop completing
 212        (rl_point) and is '\0' terminated.
 213
 214        Return value is a malloc'd vector of pointers to possible completions
 215        terminated with NULL.  If there are no completions, returning a pointer
 216        to a NULL would work but returning NULL itself is also valid.
 217        WORD points in the same buffer as TEXT, and completions should be
 218        returned relative to this position.  For example, suppose TEXT is "foo"
 219        and we want to complete to "foobar".  If WORD is "oo", return
 220        "oobar"; if WORD is "baz/foo", return "baz/foobar".  */
 221     char **(*completer) (char *text, char *word);
 222
 223     /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
 224        or "show").  */
 225     cmd_types type;
 226
 227     /* Pointer to variable affected by "set" and "show".  Doesn't matter
 228        if type is not_set.  */
 229     void *var;
 230
 231     /* What kind of variable is *VAR?  */
 232     var_types var_type;
 233
 234     /* Pointer to NULL terminated list of enumerated values (like argv).  */
 235     const char **enums;
 236
 237     /* Pointer to command strings of user-defined commands */
 238     struct command_line *user_commands;
 239
 240     /* Pointer to command that is hooked by this one, (by hook_pre)
 241        so the hook can be removed when this one is deleted.  */
 242     struct cmd_list_element *hookee_pre;
 243
 244     /* Pointer to command that is hooked by this one, (by hook_post)
 245        so the hook can be removed when this one is deleted.  */
 246     struct cmd_list_element *hookee_post;
 247
 248     /* Pointer to command that is aliased by this one, so the
 249        aliased command can be located in case it has been hooked.  */
 250     struct cmd_list_element *cmd_pointer;
 251   };
 252
 253 /* Forward-declarations of the entry-points of command.c.  */
 254
 255 extern struct cmd_list_element *add_cmd (char *, enum command_class,
 256                                          void (*fun) (char *, int), char *,
 257                                          struct cmd_list_element **);
 258
 259 extern struct cmd_list_element *add_alias_cmd (char *, char *,
 260                                                enum command_class, int,
 261                                                struct cmd_list_element **);
 262
 263 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
 264                                                 void (*fun) (char *, int),
 265                                                 char *,
 266                                                 struct cmd_list_element **,
 267                                                 char *, int,
 268                                                 struct cmd_list_element **);
 269
 270 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
 271                                                        enum command_class,
 272                                                        void (*fun) (char *,
 273                                                                     int),
 274                                                        char *,
 275                                                        struct cmd_list_element
 276                                                        **, char *, int,
 277                                                        struct cmd_list_element
 278                                                        **);
 279
 280 extern struct cmd_list_element *lookup_cmd (char **,
 281                                             struct cmd_list_element *, char *,
 282                                             int, int);
 283
 284 extern struct cmd_list_element *lookup_cmd_1 (char **,
 285                                               struct cmd_list_element *,
 286                                               struct cmd_list_element **,
 287                                               int);
 288
 289 extern struct cmd_list_element *
 290   deprecate_cmd (struct cmd_list_element *, char * );
 291
 292 extern void
 293   deprecated_cmd_warning (char **);
 294
 295 extern int
 296   lookup_cmd_composition (char *text,
 297                         struct cmd_list_element **alias,
 298                         struct cmd_list_element **prefix_cmd,
 299                         struct cmd_list_element **cmd);
 300
 301 extern struct cmd_list_element *add_com (char *, enum command_class,
 302                                          void (*fun) (char *, int), char *);
 303
 304 extern struct cmd_list_element *add_com_alias (char *, char *,
 305                                                enum command_class, int);
 306
 307 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
 308                                           char *);
 309
 310 extern struct cmd_list_element *add_info_alias (char *, char *, int);
 311
 312 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
 313
 314 extern char **complete_on_enum (const char *enumlist[], char *, char *);
 315
 316 extern void delete_cmd (char *, struct cmd_list_element **);
 317
 318 extern void help_cmd (char *, struct ui_file *);
 319
 320 extern void help_list (struct cmd_list_element *, char *,
 321                        enum command_class, struct ui_file *);
 322
 323 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
 324                            char *, int, struct ui_file *);
 325
 326 extern struct cmd_list_element *add_set_cmd (char *name, enum
 327                                              command_class class,
 328                                              var_types var_type, void *var,
 329                                              char *doc,
 330                                              struct cmd_list_element **list);
 331
 332 extern struct cmd_list_element *add_set_enum_cmd (char *name,
 333                                                   enum command_class class,
 334                                                   const char *enumlist[],
 335                                                   const char **var,
 336                                                   char *doc,
 337                                                   struct cmd_list_element **list);
 338
 339 extern struct cmd_list_element *add_set_auto_boolean_cmd (char *name,
 340                                                           enum command_class class,
 341                                                           enum cmd_auto_boolean *var,
 342                                                           char *doc,
 343                                                           struct cmd_list_element **list);
 344
 345 extern struct cmd_list_element *add_set_boolean_cmd (char *name,
 346                                                      enum command_class class,
 347                                                      int *var,
 348                                                      char *doc,
 349                                                      struct cmd_list_element **list);
 350
 351 extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *,
 352                                                    struct cmd_list_element
 353                                                    **);
 354
 355 /* Do a "show" command for each thing on a command list.  */
 356
 357 extern void cmd_show_list (struct cmd_list_element *, int, char *);
 358
 359 extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
 360
 361 extern void dont_repeat (void);
 362
 363 /* Used to mark commands that don't do anything.  If we just leave the
 364    function field NULL, the command is interpreted as a help topic, or
 365    as a class of commands.  */
 366
 367 extern void not_just_help_class_command (char *, int);
 368
 369 #endif /* !defined (COMMAND_H) */