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