gdb/cli/cli-decode.h

   1 /* Header file for GDB command decoding library.
   2    Copyright 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 (CLI_DECODE_H)
  20 #define CLI_DECODE_H 1
  21
  22 #include "gdb_regex.h"          /* Needed by apropos_cmd.  */
  23
  24 /* Command classes are top-level categories into which commands are broken
  25    down for "help" purposes.
  26    Notes on classes: class_alias is for alias commands which are not
  27    abbreviations of the original command.  class-pseudo is for
  28    commands which are not really commands nor help topics ("stop").  */
  29
  30 enum command_class
  31 {
  32   /* Special args to help_list */
  33   class_deprecated, all_classes = -2, all_commands = -1,
  34   /* Classes of commands */
  35   no_class = -1, class_run = 0, class_vars, class_stack,
  36   class_files, class_support, class_info, class_breakpoint, class_trace,
  37   class_alias, class_obscure, class_user, class_maintenance,
  38   class_pseudo, class_tui, class_xdb
  39 };
  40
  41 /* Not a set/show command.  Note that some commands which begin with
  42    "set" or "show" might be in this category, if their syntax does
  43    not fall into one of the following categories.  */
  44 typedef enum cmd_types
  45   {
  46     not_set_cmd,
  47     set_cmd,
  48     show_cmd
  49   }
  50 cmd_types;
  51
  52 /* Reasonable values for an AUTO_BOOLEAN variable. */
  53 enum cmd_auto_boolean
  54 {
  55   CMD_AUTO_BOOLEAN_TRUE,
  56   CMD_AUTO_BOOLEAN_FALSE,
  57   CMD_AUTO_BOOLEAN_AUTO
  58 };
  59
  60 /* Types of "set" or "show" command.  */
  61 typedef enum var_types
  62   {
  63     /* "on" or "off".  *VAR is an integer which is nonzero for on,
  64        zero for off.  */
  65     var_boolean,
  66
  67     /* "on" / "true" / "enable" or "off" / "false" / "disable" or
  68        "auto.  *VAR is an ``enum cmd_auto_boolean''.  NOTE: In general
  69        a custom show command will need to be implemented - one that
  70        for "auto" prints both the "auto" and the current auto-selected
  71        value. */
  72     var_auto_boolean,
  73
  74     /* Unsigned Integer.  *VAR is an unsigned int.  The user can type 0
  75        to mean "unlimited", which is stored in *VAR as UINT_MAX.  */
  76     var_uinteger,
  77
  78     /* Like var_uinteger but signed.  *VAR is an int.  The user can type 0
  79        to mean "unlimited", which is stored in *VAR as INT_MAX.  */
  80     var_integer,
  81
  82     /* String which the user enters with escapes (e.g. the user types \n and
  83        it is a real newline in the stored string).
  84        *VAR is a malloc'd string, or NULL if the string is empty.  */
  85     var_string,
  86     /* String which stores what the user types verbatim.
  87        *VAR is a malloc'd string, or NULL if the string is empty.  */
  88     var_string_noescape,
  89     /* String which stores a filename.
  90        *VAR is a malloc'd string, or NULL if the string is empty.  */
  91     var_filename,
  92     /* ZeroableInteger.  *VAR is an int.  Like Unsigned Integer except
  93        that zero really means zero.  */
  94     var_zinteger,
  95     /* Enumerated type.  Can only have one of the specified values.  *VAR is a
  96        char pointer to the name of the element that we find.  */
  97     var_enum
  98   }
  99 var_types;
 100
 101 /* This structure records one command'd definition.  */
 102
 103
 104 /* This flag is used by the code executing commands to warn the user
 105    the first time a deprecated command is used, see the 'flags' field in
 106    the following struct.
 107 */
 108 #define CMD_DEPRECATED            0x1
 109 #define DEPRECATED_WARN_USER      0x2
 110 #define MALLOCED_REPLACEMENT      0x4
 111
 112 struct cmd_list_element
 113   {
 114     /* Points to next command in this list.  */
 115     struct cmd_list_element *next;
 116
 117     /* Name of this command.  */
 118     char *name;
 119
 120     /* Command class; class values are chosen by application program.  */
 121     enum command_class class;
 122
 123     /* Function definition of this command.  NULL for command class
 124        names and for help topics that are not really commands.  NOTE:
 125        cagney/2002-02-02: This function signature is evolving.  For
 126        the moment suggest sticking with either set_cmd_cfunc() or
 127        set_cmd_sfunc().  */
 128     void (*func) (struct cmd_list_element *c, char *args, int from_tty);
 129     /* The command's real callback.  At present func() bounces through
 130        to one of the below.  */
 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 /* API to the manipulation of command lists.  */
 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 /* Set the commands corresponding callback.  */
 281
 282 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
 283                            void (*cfunc) (char *args, int from_tty));
 284
 285 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
 286                            void (*sfunc) (char *args, int from_tty,
 287                                           struct cmd_list_element * c));
 288
 289 extern void set_cmd_completer (struct cmd_list_element *cmd,
 290                                char **(*completer) (char *text, char *word));
 291
 292 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
 293    around in cmd objects to test the value of the commands sfunc().  */
 294 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
 295                          void (*cfunc) (char *args, int from_tty));
 296
 297 extern struct cmd_list_element *lookup_cmd (char **,
 298                                             struct cmd_list_element *, char *,
 299                                             int, int);
 300
 301 extern struct cmd_list_element *lookup_cmd_1 (char **,
 302                                               struct cmd_list_element *,
 303                                               struct cmd_list_element **,
 304                                               int);
 305
 306 extern struct cmd_list_element *
 307   deprecate_cmd (struct cmd_list_element *, char * );
 308
 309 extern void
 310   deprecated_cmd_warning (char **);
 311
 312 extern int
 313   lookup_cmd_composition (char *text,
 314                         struct cmd_list_element **alias,
 315                         struct cmd_list_element **prefix_cmd,
 316                         struct cmd_list_element **cmd);
 317
 318 extern struct cmd_list_element *add_com (char *, enum command_class,
 319                                          void (*fun) (char *, int), char *);
 320
 321 extern struct cmd_list_element *add_com_alias (char *, char *,
 322                                                enum command_class, int);
 323
 324 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
 325                                           char *);
 326
 327 extern struct cmd_list_element *add_info_alias (char *, char *, int);
 328
 329 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
 330
 331 extern char **complete_on_enum (const char *enumlist[], char *, char *);
 332
 333 extern void delete_cmd (char *, struct cmd_list_element **);
 334
 335 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
 336                            char *, int, struct ui_file *);
 337
 338 extern struct cmd_list_element *add_set_cmd (char *name, enum
 339                                              command_class class,
 340                                              var_types var_type, void *var,
 341                                              char *doc,
 342                                              struct cmd_list_element **list);
 343
 344 extern struct cmd_list_element *add_set_enum_cmd (char *name,
 345                                                   enum command_class class,
 346                                                   const char *enumlist[],
 347                                                   const char **var,
 348                                                   char *doc,
 349                                                   struct cmd_list_element **list);
 350
 351 extern struct cmd_list_element *add_set_auto_boolean_cmd (char *name,
 352                                                           enum command_class class,
 353                                                           enum cmd_auto_boolean *var,
 354                                                           char *doc,
 355                                                           struct cmd_list_element **list);
 356
 357 extern struct cmd_list_element *add_set_boolean_cmd (char *name,
 358                                                      enum command_class class,
 359                                                      int *var,
 360                                                      char *doc,
 361                                                      struct cmd_list_element **list);
 362
 363 extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *,
 364                                                    struct cmd_list_element
 365                                                    **);
 366
 367 /* Functions that implement commands about CLI commands. */
 368
 369 extern void help_cmd (char *, struct ui_file *);
 370
 371 extern void help_list (struct cmd_list_element *, char *,
 372                        enum command_class, struct ui_file *);
 373
 374 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
 375                          struct re_pattern_buffer *, char *);
 376
 377 /* Used to mark commands that don't do anything.  If we just leave the
 378    function field NULL, the command is interpreted as a help topic, or
 379    as a class of commands.  */
 380
 381 extern void not_just_help_class_command (char *arg, int from_tty);
 382
 383 /* Exported to cli/cli-setshow.c */
 384
 385 extern void print_doc_line (struct ui_file *, char *);
 386
 387
 388 #endif /* !defined (CLI_DECODE_H) */