gdb/cli/cli-decode.h

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