gdb/cli/cli-decode.h

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