gdb/cli/cli-decode.h

   1 /* Header file for GDB command decoding library.
   2
   3    Copyright (C) 2000-2017 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 /* This file defines the private interfaces for any code implementing
  22    command internals.  */
  23
  24 /* Include the public interfaces.  */
  25 #include "command.h"
  26 #include "gdb_regex.h"
  27
  28 #if 0
  29 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
  30    cmd_types'' can be moved from "command.h" to "cli-decode.h".  */
  31 /* Not a set/show command.  Note that some commands which begin with
  32    "set" or "show" might be in this category, if their syntax does
  33    not fall into one of the following categories.  */
  34 typedef enum cmd_types
  35   {
  36     not_set_cmd,
  37     set_cmd,
  38     show_cmd
  39   }
  40 cmd_types;
  41 #endif
  42
  43 /* This structure records one command'd definition.  */
  44
  45
  46 struct cmd_list_element
  47   {
  48     /* Points to next command in this list.  */
  49     struct cmd_list_element *next;
  50
  51     /* Name of this command.  */
  52     const char *name;
  53
  54     /* Command class; class values are chosen by application program.  */
  55     enum command_class theclass;
  56
  57     /* When 1 indicated that this command is deprecated.  It may be
  58        removed from gdb's command set in the future.  */
  59
  60     unsigned int cmd_deprecated : 1;
  61
  62     /* The user needs to be warned that this is a deprecated command.
  63        The user should only be warned the first time a command is
  64        used.  */
  65
  66     unsigned int deprecated_warn_user : 1;
  67
  68     /* When functions are deprecated at compile time (this is the way
  69        it should, in general, be done) the memory containing the
  70        replacement string is statically allocated.  In some cases it
  71        makes sense to deprecate commands at runtime (the testsuite is
  72        one example).  In this case the memory for replacement is
  73        malloc'ed.  When a command is undeprecated or re-deprecated at
  74        runtime we don't want to risk calling free on statically
  75        allocated memory, so we check this flag.  */
  76
  77     unsigned int malloced_replacement : 1;
  78
  79     /* Set if the doc field should be xfree'd.  */
  80
  81     unsigned int doc_allocated : 1;
  82
  83     /* Flag that specifies if this command is already running its hook.  */
  84     /* Prevents the possibility of hook recursion.  */
  85     unsigned int hook_in : 1;
  86
  87     /* For prefix commands only:
  88        nonzero means do not get an error if subcommand is not
  89        recognized; call the prefix's own function in that case.  */
  90     unsigned int allow_unknown : 1;
  91
  92     /* Nonzero says this is an abbreviation, and should not
  93        be mentioned in lists of commands.
  94        This allows "br<tab>" to complete to "break", which it
  95        otherwise wouldn't.  */
  96     unsigned int abbrev_flag : 1;
  97
  98     /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
  99        or "show").  */
 100     ENUM_BITFIELD (cmd_types) type : 2;
 101
 102     /* What kind of variable is *VAR?  */
 103     ENUM_BITFIELD (var_types) var_type : 4;
 104
 105     /* Function definition of this command.  NULL for command class
 106        names and for help topics that are not really commands.  NOTE:
 107        cagney/2002-02-02: This function signature is evolving.  For
 108        the moment suggest sticking with either set_cmd_cfunc() or
 109        set_cmd_sfunc().  */
 110     void (*func) (struct cmd_list_element *c, char *args, int from_tty);
 111     /* The command's real callback.  At present func() bounces through
 112        to one of the below.  */
 113     union
 114       {
 115         /* If type is not_set_cmd, call it like this: */
 116         cmd_cfunc_ftype *cfunc;
 117         /* If type is set_cmd or show_cmd, first set the variables,
 118            and then call this: */
 119         cmd_sfunc_ftype *sfunc;
 120       }
 121     function;
 122
 123     /* Local state (context) for this command.  This can be anything.  */
 124     void *context;
 125
 126     /* Documentation of this command (or help topic).
 127        First line is brief documentation; remaining lines form, with it,
 128        the full documentation.  First line should end with a period.
 129        Entire string should also end with a period, not a newline.  */
 130     const char *doc;
 131
 132     /* For set/show commands.  A method for printing the output to the
 133        specified stream.  */
 134     show_value_ftype *show_value_func;
 135
 136     /* If this command is deprecated, this is the replacement name.  */
 137     const char *replacement;
 138
 139     /* If this command represents a show command, then this function
 140        is called before the variable's value is examined.  */
 141     void (*pre_show_hook) (struct cmd_list_element *c);
 142
 143     /* Hook for another command to be executed before this command.  */
 144     struct cmd_list_element *hook_pre;
 145
 146     /* Hook for another command to be executed after this command.  */
 147     struct cmd_list_element *hook_post;
 148
 149     /* Nonzero identifies a prefix command.  For them, the address
 150        of the variable containing the list of subcommands.  */
 151     struct cmd_list_element **prefixlist;
 152
 153     /* For prefix commands only:
 154        String containing prefix commands to get here: this one
 155        plus any others needed to get to it.  Should end in a space.
 156        It is used before the word "command" in describing the
 157        commands reached through this prefix.  */
 158     const char *prefixname;
 159
 160     /* The prefix command of this command.  */
 161     struct cmd_list_element *prefix;
 162
 163     /* Completion routine for this command.  TEXT is the text beyond
 164        what was matched for the command itself (leading whitespace is
 165        skipped).  It stops where we are supposed to stop completing
 166        (rl_point) and is '\0' terminated.
 167
 168        Return value is a malloc'd vector of pointers to possible
 169        completions terminated with NULL.  If there are no completions,
 170        returning a pointer to a NULL would work but returning NULL
 171        itself is also valid.  WORD points in the same buffer as TEXT,
 172        and completions should be returned relative to this position.
 173        For example, suppose TEXT is "foo" and we want to complete to
 174        "foobar".  If WORD is "oo", return "oobar"; if WORD is
 175        "baz/foo", return "baz/foobar".  */
 176     completer_ftype *completer;
 177
 178     /* Handle the word break characters for this completer.  Usually
 179        this function need not be defined, but for some types of
 180        completers (e.g., Python completers declared as methods inside
 181        a class) the word break chars may need to be redefined
 182        depending on the completer type (e.g., for filename
 183        completers).  */
 184
 185     completer_ftype_void *completer_handle_brkchars;
 186
 187     /* Destruction routine for this command.  If non-NULL, this is
 188        called when this command instance is destroyed.  This may be
 189        used to finalize the CONTEXT field, if needed.  */
 190     void (*destroyer) (struct cmd_list_element *self, void *context);
 191
 192     /* Pointer to variable affected by "set" and "show".  Doesn't
 193        matter if type is not_set.  */
 194     void *var;
 195
 196     /* Pointer to NULL terminated list of enumerated values (like
 197        argv).  */
 198     const char *const *enums;
 199
 200     /* Pointer to command strings of user-defined commands */
 201     struct command_line *user_commands;
 202
 203     /* Pointer to command that is hooked by this one, (by hook_pre)
 204        so the hook can be removed when this one is deleted.  */
 205     struct cmd_list_element *hookee_pre;
 206
 207     /* Pointer to command that is hooked by this one, (by hook_post)
 208        so the hook can be removed when this one is deleted.  */
 209     struct cmd_list_element *hookee_post;
 210
 211     /* Pointer to command that is aliased by this one, so the
 212        aliased command can be located in case it has been hooked.  */
 213     struct cmd_list_element *cmd_pointer;
 214
 215     /* Start of a linked list of all aliases of this command.  */
 216     struct cmd_list_element *aliases;
 217
 218     /* Link pointer for aliases on an alias list.  */
 219     struct cmd_list_element *alias_chain;
 220
 221     /* If non-null, the pointer to a field in 'struct
 222        cli_suppress_notification', which will be set to true in cmd_func
 223        when this command is being executed.  It will be set back to false
 224        when the command has been executed.  */
 225     int *suppress_notification;
 226   };
 227
 228 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
 229                            const char *, int, struct ui_file *);
 230
 231 /* Functions that implement commands about CLI commands.  */
 232
 233 extern void help_cmd (const char *, struct ui_file *);
 234
 235 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
 236                          compiled_regex &, const char *);
 237
 238 /* Used to mark commands that don't do anything.  If we just leave the
 239    function field NULL, the command is interpreted as a help topic, or
 240    as a class of commands.  */
 241
 242 extern void not_just_help_class_command (char *arg, int from_tty);
 243
 244 /* Exported to cli/cli-setshow.c */
 245
 246 extern void print_doc_line (struct ui_file *, const char *);
 247
 248 extern const char * const auto_boolean_enums[];
 249
 250 /* Verify whether a given cmd_list_element is a user-defined command.
 251    Return 1 if it is user-defined.  Return 0 otherwise.  */
 252
 253 extern int cli_user_command_p (struct cmd_list_element *);
 254
 255 extern int find_command_name_length (const char *);
 256
 257 #endif /* !defined (CLI_DECODE_H) */