gdb/cli/cli-decode.h

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