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.  NOTE:
 131        cagney/2002-02-02: This function signature is evolving.  For
 132        the moment suggest sticking with either set_cmd_cfunc() or
 133        set_cmd_sfunc().  */
 134     void (*func) (struct cmd_list_element *c, char *args, int from_tty);
 135     /* The command's real callback.  At present func() bounces through
 136        to one of the below.  */
 137     union
 138       {
 139         /* If type is not_set_cmd, call it like this:  */
 140         void (*cfunc) (char *args, int from_tty);
 141
 142         /* If type is set_cmd or show_cmd, first set the variables, and
 143            then call this.  */
 144         void (*sfunc) (char *args, int from_tty, struct cmd_list_element * c);
 145       }
 146     function;
 147
 148     /* Local state (context) for this command.  This can be anything.  */
 149     void *context;
 150
 151     /* Documentation of this command (or help topic).
 152        First line is brief documentation; remaining lines form, with it,
 153        the full documentation.  First line should end with a period.
 154        Entire string should also end with a period, not a newline.  */
 155     char *doc;
 156
 157     /* flags : a bitfield
 158
 159        bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
 160        is deprecated. It may be removed from gdb's command set in the
 161        future.
 162
 163        bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
 164        this is a deprecated command.  The user should only be warned
 165        the first time a command is used.
 166
 167        bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
 168        compile time (this is the way it should, in general, be done)
 169        the memory containing the replacement string is statically
 170        allocated.  In some cases it makes sense to deprecate commands
 171        at runtime (the testsuite is one example).  In this case the
 172        memory for replacement is malloc'ed.  When a command is
 173        undeprecated or re-deprecated at runtime we don't want to risk
 174        calling free on statically allocated memory, so we check this
 175        flag.
 176      */
 177     int flags;
 178
 179     /* if this command is deprecated, this is the replacement name */
 180     char *replacement;
 181
 182     /* If this command represents a show command, then this function
 183        is called before the variable's value is examined.  */
 184     void (*pre_show_hook) (struct cmd_list_element *c);
 185
 186     /* Hook for another command to be executed before this command.  */
 187     struct cmd_list_element *hook_pre;
 188
 189     /* Hook for another command to be executed after this command.  */
 190     struct cmd_list_element *hook_post;
 191
 192     /* Flag that specifies if this command is already running it's hook. */
 193     /* Prevents the possibility of hook recursion. */
 194     int hook_in;
 195
 196     /* Nonzero identifies a prefix command.  For them, the address
 197        of the variable containing the list of subcommands.  */
 198     struct cmd_list_element **prefixlist;
 199
 200     /* For prefix commands only:
 201        String containing prefix commands to get here: this one
 202        plus any others needed to get to it.  Should end in a space.
 203        It is used before the word "command" in describing the
 204        commands reached through this prefix.  */
 205     char *prefixname;
 206
 207     /* For prefix commands only:
 208        nonzero means do not get an error if subcommand is not
 209        recognized; call the prefix's own function in that case.  */
 210     char allow_unknown;
 211
 212     /* Nonzero says this is an abbreviation, and should not
 213        be mentioned in lists of commands.
 214        This allows "br<tab>" to complete to "break", which it
 215        otherwise wouldn't.  */
 216     char abbrev_flag;
 217
 218     /* Completion routine for this command.  TEXT is the text beyond
 219        what was matched for the command itself (leading whitespace is
 220        skipped).  It stops where we are supposed to stop completing
 221        (rl_point) and is '\0' terminated.
 222
 223        Return value is a malloc'd vector of pointers to possible completions
 224        terminated with NULL.  If there are no completions, returning a pointer
 225        to a NULL would work but returning NULL itself is also valid.
 226        WORD points in the same buffer as TEXT, and completions should be
 227        returned relative to this position.  For example, suppose TEXT is "foo"
 228        and we want to complete to "foobar".  If WORD is "oo", return
 229        "oobar"; if WORD is "baz/foo", return "baz/foobar".  */
 230     char **(*completer) (char *text, char *word);
 231
 232     /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
 233        or "show").  */
 234     cmd_types type;
 235
 236     /* Pointer to variable affected by "set" and "show".  Doesn't matter
 237        if type is not_set.  */
 238     void *var;
 239
 240     /* What kind of variable is *VAR?  */
 241     var_types var_type;
 242
 243     /* Pointer to NULL terminated list of enumerated values (like argv).  */
 244     const char **enums;
 245
 246     /* Pointer to command strings of user-defined commands */
 247     struct command_line *user_commands;
 248
 249     /* Pointer to command that is hooked by this one, (by hook_pre)
 250        so the hook can be removed when this one is deleted.  */
 251     struct cmd_list_element *hookee_pre;
 252
 253     /* Pointer to command that is hooked by this one, (by hook_post)
 254        so the hook can be removed when this one is deleted.  */
 255     struct cmd_list_element *hookee_post;
 256
 257     /* Pointer to command that is aliased by this one, so the
 258        aliased command can be located in case it has been hooked.  */
 259     struct cmd_list_element *cmd_pointer;
 260   };
 261
 262 /* Forward-declarations of the entry-points of cli/cli-decode.c.  */
 263
 264 extern struct cmd_list_element *add_cmd (char *, enum command_class,
 265                                          void (*fun) (char *, int), char *,
 266                                          struct cmd_list_element **);
 267
 268 extern struct cmd_list_element *add_alias_cmd (char *, char *,
 269                                                enum command_class, int,
 270                                                struct cmd_list_element **);
 271
 272 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
 273                                                 void (*fun) (char *, int),
 274                                                 char *,
 275                                                 struct cmd_list_element **,
 276                                                 char *, int,
 277                                                 struct cmd_list_element **);
 278
 279 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
 280                                                        enum command_class,
 281                                                        void (*fun) (char *,
 282                                                                     int),
 283                                                        char *,
 284                                                        struct cmd_list_element
 285                                                        **, char *, int,
 286                                                        struct cmd_list_element
 287                                                        **);
 288
 289 /* Set the commands corresponding callback.  */
 290
 291 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
 292                            void (*cfunc) (char *args, int from_tty));
 293
 294 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
 295                            void (*sfunc) (char *args, int from_tty,
 296                                           struct cmd_list_element * c));
 297
 298 extern void set_cmd_completer (struct cmd_list_element *cmd,
 299                                char **(*completer) (char *text, char *word));
 300
 301 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
 302    around in cmd objects to test the value of the commands sfunc().  */
 303 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
 304                          void (*cfunc) (char *args, int from_tty));
 305
 306 /* Each command object has a local context attached to it. .  */
 307 extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
 308 extern void *get_cmd_context (struct cmd_list_element *cmd);
 309
 310
 311 /* Execute CMD's pre/post hook.  Throw an error if the command fails.
 312    If already executing this pre/post hook, or there is no pre/post
 313    hook, the call is silently ignored.  */
 314 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
 315 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
 316
 317 /* Return the type of the command.  */
 318 /* NOTE: cagney/2002-03-17: The add_show_from_set() function clones
 319    the set command passed as a parameter.  The clone operation will
 320    include (BUG?) any ``set'' command callback, if present.  Commands
 321    like ``info set'' call all the ``show'' command callbacks.
 322    Unfortunatly, for ``show'' commands cloned from ``set'', this
 323    includes callbacks belonging to ``set'' commands.  Making this
 324    worse, this only occures if add_show_from_set() is called after
 325    add_cmd_sfunc() (BUG?).  */
 326 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
 327
 328
 329 extern struct cmd_list_element *lookup_cmd (char **,
 330                                             struct cmd_list_element *, char *,
 331                                             int, int);
 332
 333 extern struct cmd_list_element *lookup_cmd_1 (char **,
 334                                               struct cmd_list_element *,
 335                                               struct cmd_list_element **,
 336                                               int);
 337
 338 extern struct cmd_list_element *
 339   deprecate_cmd (struct cmd_list_element *, char * );
 340
 341 extern void
 342   deprecated_cmd_warning (char **);
 343
 344 extern int
 345   lookup_cmd_composition (char *text,
 346                         struct cmd_list_element **alias,
 347                         struct cmd_list_element **prefix_cmd,
 348                         struct cmd_list_element **cmd);
 349
 350 extern struct cmd_list_element *add_com (char *, enum command_class,
 351                                          void (*fun) (char *, int), char *);
 352
 353 extern struct cmd_list_element *add_com_alias (char *, char *,
 354                                                enum command_class, int);
 355
 356 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
 357                                           char *);
 358
 359 extern struct cmd_list_element *add_info_alias (char *, char *, int);
 360
 361 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
 362
 363 extern char **complete_on_enum (const char *enumlist[], char *, char *);
 364
 365 extern void delete_cmd (char *, struct cmd_list_element **);
 366
 367 extern void help_cmd (char *, struct ui_file *);
 368
 369 extern void help_list (struct cmd_list_element *, char *,
 370                        enum command_class, struct ui_file *);
 371
 372 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
 373                            char *, int, struct ui_file *);
 374
 375 extern struct cmd_list_element *add_set_cmd (char *name, enum
 376                                              command_class class,
 377                                              var_types var_type, void *var,
 378                                              char *doc,
 379                                              struct cmd_list_element **list);
 380
 381 extern struct cmd_list_element *add_set_enum_cmd (char *name,
 382                                                   enum command_class class,
 383                                                   const char *enumlist[],
 384                                                   const char **var,
 385                                                   char *doc,
 386                                                   struct cmd_list_element **list);
 387
 388 extern struct cmd_list_element *add_set_auto_boolean_cmd (char *name,
 389                                                           enum command_class class,
 390                                                           enum cmd_auto_boolean *var,
 391                                                           char *doc,
 392                                                           struct cmd_list_element **list);
 393
 394 extern struct cmd_list_element *add_set_boolean_cmd (char *name,
 395                                                      enum command_class class,
 396                                                      int *var,
 397                                                      char *doc,
 398                                                      struct cmd_list_element **list);
 399
 400 extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *,
 401                                                    struct cmd_list_element
 402                                                    **);
 403
 404 /* Do a "show" command for each thing on a command list.  */
 405
 406 extern void cmd_show_list (struct cmd_list_element *, int, char *);
 407
 408 extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
 409
 410 extern void dont_repeat (void);
 411
 412 /* Used to mark commands that don't do anything.  If we just leave the
 413    function field NULL, the command is interpreted as a help topic, or
 414    as a class of commands.  */
 415
 416 extern void not_just_help_class_command (char *, int);
 417
 418 #endif /* !defined (COMMAND_H) */