gdb/cli/cli-decode.h

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