gdb/cli/cli-decode.h

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