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