gdb/command.h

   1 /* Header file for command creation.
   2
   3    Copyright (C) 1986-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 #if !defined (COMMAND_H)
  19 #define COMMAND_H 1
  20
  21 #include "gdbsupport/gdb_vecs.h"
  22 #include "gdbsupport/scoped_restore.h"
  23
  24 struct completion_tracker;
  25
  26 /* This file defines the public interface for any code wanting to
  27    create commands.  */
  28
  29 /* Command classes are top-level categories into which commands are
  30    broken down for "help" purposes.
  31
  32    Notes on classes: class_alias is for alias commands which are not
  33    abbreviations of the original command.  class-pseudo is for
  34    commands which are not really commands nor help topics ("stop").  */
  35
  36 enum command_class
  37 {
  38   /* Special args to help_list */
  39   class_deprecated = -3, all_classes = -2, all_commands = -1,
  40   /* Classes of commands */
  41   no_class = -1, class_run = 0, class_vars, class_stack, class_files,
  42   class_support, class_info, class_breakpoint, class_trace,
  43   class_alias, class_bookmark, class_obscure, class_maintenance,
  44   class_pseudo, class_tui, class_user, class_xdb,
  45   no_set_class  /* Used for "show" commands that have no corresponding
  46                    "set" command.  */
  47 };
  48
  49 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
  50    cmd_types'' can be moved from "command.h" to "cli-decode.h".  */
  51 /* Not a set/show command.  Note that some commands which begin with
  52    "set" or "show" might be in this category, if their syntax does
  53    not fall into one of the following categories.  */
  54 typedef enum cmd_types
  55   {
  56     not_set_cmd,
  57     set_cmd,
  58     show_cmd
  59   }
  60 cmd_types;
  61
  62 /* Types of "set" or "show" command.  */
  63 typedef enum var_types
  64   {
  65     /* "on" or "off".  *VAR is a bool which is true for on,
  66        false for off.  */
  67     var_boolean,
  68
  69     /* "on" / "true" / "enable" or "off" / "false" / "disable" or
  70        "auto.  *VAR is an ``enum auto_boolean''.  NOTE: In general a
  71        custom show command will need to be implemented - one that for
  72        "auto" prints both the "auto" and the current auto-selected
  73        value.  */
  74     var_auto_boolean,
  75
  76     /* Unsigned Integer.  *VAR is an unsigned int.  The user can type
  77        0 to mean "unlimited", which is stored in *VAR as UINT_MAX.  */
  78     var_uinteger,
  79
  80     /* Like var_uinteger but signed.  *VAR is an int.  The user can
  81        type 0 to mean "unlimited", which is stored in *VAR as
  82        INT_MAX.  The only remaining use of it is the Python API.
  83        Don't use it elsewhere.  */
  84     var_integer,
  85
  86     /* String which the user enters with escapes (e.g. the user types
  87        \n and it is a real newline in the stored string).
  88        *VAR is a malloc'd string, or NULL if the string is empty.  */
  89     var_string,
  90     /* String which stores what the user types verbatim.
  91        *VAR is a malloc'd string, or NULL if the string is empty.  */
  92     var_string_noescape,
  93     /* String which stores a filename.  (*VAR) is a malloc'd string,
  94        or "" if the string was empty.  */
  95     var_optional_filename,
  96     /* String which stores a filename.  (*VAR) is a malloc'd
  97        string.  */
  98     var_filename,
  99     /* ZeroableInteger.  *VAR is an int.  Like var_integer except
 100        that zero really means zero.  */
 101     var_zinteger,
 102     /* ZeroableUnsignedInteger.  *VAR is an unsigned int.  Zero really
 103        means zero.  */
 104     var_zuinteger,
 105     /* ZeroableUnsignedInteger with unlimited value.  *VAR is an int,
 106        but its range is [0, INT_MAX].  -1 stands for unlimited and
 107        other negative numbers are not allowed.  */
 108     var_zuinteger_unlimited,
 109     /* Enumerated type.  Can only have one of the specified values.
 110        *VAR is a char pointer to the name of the element that we
 111        find.  */
 112     var_enum
 113   }
 114 var_types;
 115
 116 /* This structure records one command'd definition.  */
 117 struct cmd_list_element;
 118
 119 typedef void cmd_const_cfunc_ftype (const char *args, int from_tty);
 120
 121 /* This structure specifies notifications to be suppressed by a cli
 122    command interpreter.  */
 123
 124 struct cli_suppress_notification
 125 {
 126   /* Inferior, thread, frame selected notification suppressed?  */
 127   int user_selected_context;
 128 };
 129
 130 extern struct cli_suppress_notification cli_suppress_notification;
 131
 132 /* Forward-declarations of the entry-points of cli/cli-decode.c.  */
 133
 134 /* API to the manipulation of command lists.  */
 135
 136 /* Return TRUE if NAME is a valid user-defined command name.
 137    This is a stricter subset of all gdb commands,
 138    see find_command_name_length.  */
 139
 140 extern bool valid_user_defined_cmd_name_p (const char *name);
 141
 142 /* Return TRUE if C is a valid command character.  */
 143
 144 extern bool valid_cmd_char_p (int c);
 145
 146 /* Const-correct variant of the above.  */
 147
 148 extern struct cmd_list_element *add_cmd (const char *, enum command_class,
 149                                          cmd_const_cfunc_ftype *fun,
 150                                          const char *,
 151                                          struct cmd_list_element **);
 152
 153 /* Like add_cmd, but no command function is specified.  */
 154
 155 extern struct cmd_list_element *add_cmd (const char *, enum command_class,
 156                                          const char *,
 157                                          struct cmd_list_element **);
 158
 159 extern struct cmd_list_element *add_cmd_suppress_notification
 160                         (const char *name, enum command_class theclass,
 161                          cmd_const_cfunc_ftype *fun, const char *doc,
 162                          struct cmd_list_element **list,
 163                          int *suppress_notification);
 164
 165 extern struct cmd_list_element *add_alias_cmd (const char *, const char *,
 166                                                enum command_class, int,
 167                                                struct cmd_list_element **);
 168
 169 extern struct cmd_list_element *add_alias_cmd (const char *,
 170                                                cmd_list_element *,
 171                                                enum command_class, int,
 172                                                struct cmd_list_element **);
 173
 174
 175 extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class,
 176                                                 cmd_const_cfunc_ftype *fun,
 177                                                 const char *,
 178                                                 struct cmd_list_element **,
 179                                                 const char *, int,
 180                                                 struct cmd_list_element **);
 181
 182 extern struct cmd_list_element *add_prefix_cmd_suppress_notification
 183                         (const char *name, enum command_class theclass,
 184                          cmd_const_cfunc_ftype *fun,
 185                          const char *doc, struct cmd_list_element **prefixlist,
 186                          const char *prefixname, int allow_unknown,
 187                          struct cmd_list_element **list,
 188                          int *suppress_notification);
 189
 190 extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *,
 191                                                        enum command_class,
 192                                                        cmd_const_cfunc_ftype *fun,
 193                                                        const char *,
 194                                                        struct cmd_list_element
 195                                                        **, const char *, int,
 196                                                        struct cmd_list_element
 197                                                        **);
 198
 199 typedef void cmd_const_sfunc_ftype (const char *args, int from_tty,
 200                                     struct cmd_list_element *c);
 201 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
 202                            cmd_const_sfunc_ftype *sfunc);
 203
 204 /* A completion routine.  Add possible completions to tracker.
 205
 206    TEXT is the text beyond what was matched for the command itself
 207    (leading whitespace is skipped).  It stops where we are supposed to
 208    stop completing (rl_point) and is '\0' terminated.  WORD points in
 209    the same buffer as TEXT, and completions should be returned
 210    relative to this position.  For example, suppose TEXT is "foo" and
 211    we want to complete to "foobar".  If WORD is "oo", return "oobar";
 212    if WORD is "baz/foo", return "baz/foobar".  */
 213 typedef void completer_ftype (struct cmd_list_element *,
 214                               completion_tracker &tracker,
 215                               const char *text, const char *word);
 216
 217 /* Same, but for set_cmd_completer_handle_brkchars.  */
 218 typedef void completer_handle_brkchars_ftype (struct cmd_list_element *,
 219                                               completion_tracker &tracker,
 220                                               const char *text, const char *word);
 221
 222 extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *);
 223
 224 /* Set the completer_handle_brkchars callback.  */
 225
 226 extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *,
 227                                                completer_handle_brkchars_ftype *);
 228
 229 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
 230    around in cmd objects to test the value of the commands sfunc().  */
 231 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
 232                          cmd_const_cfunc_ftype *cfun);
 233
 234 /* Each command object has a local context attached to it.  */
 235 extern void set_cmd_context (struct cmd_list_element *cmd,
 236                              void *context);
 237 extern void *get_cmd_context (struct cmd_list_element *cmd);
 238
 239
 240 /* Execute CMD's pre/post hook.  Throw an error if the command fails.
 241    If already executing this pre/post hook, or there is no pre/post
 242    hook, the call is silently ignored.  */
 243 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
 244 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
 245
 246 /* Return the type of the command.  */
 247 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
 248
 249 /* Flag for an ambiguous cmd_list result.  */
 250 #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
 251
 252 extern struct cmd_list_element *lookup_cmd (const char **,
 253                                             struct cmd_list_element *,
 254                                             const char *,
 255                                             int, int);
 256
 257 extern struct cmd_list_element *lookup_cmd_1 (const char **,
 258                                               struct cmd_list_element *,
 259                                               struct cmd_list_element **,
 260                                               int);
 261
 262 extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
 263                                                const char * );
 264
 265 extern void deprecated_cmd_warning (const char *);
 266
 267 extern int lookup_cmd_composition (const char *text,
 268                                    struct cmd_list_element **alias,
 269                                    struct cmd_list_element **prefix_cmd,
 270                                    struct cmd_list_element **cmd);
 271
 272 extern struct cmd_list_element *add_com (const char *, enum command_class,
 273                                          cmd_const_cfunc_ftype *fun,
 274                                          const char *);
 275
 276 extern struct cmd_list_element *add_com_alias (const char *, const char *,
 277                                                enum command_class, int);
 278
 279 extern struct cmd_list_element *add_com_suppress_notification
 280                        (const char *name, enum command_class theclass,
 281                         cmd_const_cfunc_ftype *fun, const char *doc,
 282                         int *supress_notification);
 283
 284 extern struct cmd_list_element *add_info (const char *,
 285                                           cmd_const_cfunc_ftype *fun,
 286                                           const char *);
 287
 288 extern struct cmd_list_element *add_info_alias (const char *, const char *,
 289                                                 int);
 290
 291 extern void complete_on_cmdlist (struct cmd_list_element *,
 292                                  completion_tracker &tracker,
 293                                  const char *, const char *, int);
 294
 295 extern void complete_on_enum (completion_tracker &tracker,
 296                               const char *const *enumlist,
 297                               const char *, const char *);
 298
 299 /* Functions that implement commands about CLI commands.  */
 300
 301 extern void help_list (struct cmd_list_element *, const char *,
 302                        enum command_class, struct ui_file *);
 303
 304 /* Method for show a set/show variable's VALUE on FILE.  If this
 305    method isn't supplied deprecated_show_value_hack() is called (which
 306    is not good).  */
 307 typedef void (show_value_ftype) (struct ui_file *file,
 308                                  int from_tty,
 309                                  struct cmd_list_element *cmd,
 310                                  const char *value);
 311 /* NOTE: i18n: This function is not i18n friendly.  Callers should
 312    instead print the value out directly.  */
 313 extern show_value_ftype deprecated_show_value_hack;
 314
 315 extern void add_setshow_enum_cmd (const char *name,
 316                                   enum command_class theclass,
 317                                   const char *const *enumlist,
 318                                   const char **var,
 319                                   const char *set_doc,
 320                                   const char *show_doc,
 321                                   const char *help_doc,
 322                                   cmd_const_sfunc_ftype *set_func,
 323                                   show_value_ftype *show_func,
 324                                   struct cmd_list_element **set_list,
 325                                   struct cmd_list_element **show_list,
 326                                   void *context = nullptr);
 327
 328 extern void add_setshow_auto_boolean_cmd (const char *name,
 329                                           enum command_class theclass,
 330                                           enum auto_boolean *var,
 331                                           const char *set_doc,
 332                                           const char *show_doc,
 333                                           const char *help_doc,
 334                                           cmd_const_sfunc_ftype *set_func,
 335                                           show_value_ftype *show_func,
 336                                           struct cmd_list_element **set_list,
 337                                           struct cmd_list_element **show_list);
 338
 339 extern cmd_list_element *
 340   add_setshow_boolean_cmd (const char *name,
 341                            enum command_class theclass,
 342                            bool *var,
 343                            const char *set_doc, const char *show_doc,
 344                            const char *help_doc,
 345                            cmd_const_sfunc_ftype *set_func,
 346                            show_value_ftype *show_func,
 347                            struct cmd_list_element **set_list,
 348                            struct cmd_list_element **show_list);
 349
 350 extern void add_setshow_filename_cmd (const char *name,
 351                                       enum command_class theclass,
 352                                       char **var,
 353                                       const char *set_doc,
 354                                       const char *show_doc,
 355                                       const char *help_doc,
 356                                       cmd_const_sfunc_ftype *set_func,
 357                                       show_value_ftype *show_func,
 358                                       struct cmd_list_element **set_list,
 359                                       struct cmd_list_element **show_list);
 360
 361 extern void add_setshow_string_cmd (const char *name,
 362                                     enum command_class theclass,
 363                                     char **var,
 364                                     const char *set_doc,
 365                                     const char *show_doc,
 366                                     const char *help_doc,
 367                                     cmd_const_sfunc_ftype *set_func,
 368                                     show_value_ftype *show_func,
 369                                     struct cmd_list_element **set_list,
 370                                     struct cmd_list_element **show_list);
 371
 372 extern struct cmd_list_element *add_setshow_string_noescape_cmd
 373                       (const char *name,
 374                        enum command_class theclass,
 375                        char **var,
 376                        const char *set_doc,
 377                        const char *show_doc,
 378                        const char *help_doc,
 379                        cmd_const_sfunc_ftype *set_func,
 380                        show_value_ftype *show_func,
 381                        struct cmd_list_element **set_list,
 382                        struct cmd_list_element **show_list);
 383
 384 extern void add_setshow_optional_filename_cmd (const char *name,
 385                                                enum command_class theclass,
 386                                                char **var,
 387                                                const char *set_doc,
 388                                                const char *show_doc,
 389                                                const char *help_doc,
 390                                                cmd_const_sfunc_ftype *set_func,
 391                                                show_value_ftype *show_func,
 392                                                struct cmd_list_element **set_list,
 393                                                struct cmd_list_element **show_list);
 394
 395 extern void add_setshow_integer_cmd (const char *name,
 396                                      enum command_class theclass,
 397                                      int *var,
 398                                      const char *set_doc,
 399                                      const char *show_doc,
 400                                      const char *help_doc,
 401                                      cmd_const_sfunc_ftype *set_func,
 402                                      show_value_ftype *show_func,
 403                                      struct cmd_list_element **set_list,
 404                                      struct cmd_list_element **show_list);
 405
 406 extern void add_setshow_uinteger_cmd (const char *name,
 407                                       enum command_class theclass,
 408                                       unsigned int *var,
 409                                       const char *set_doc,
 410                                       const char *show_doc,
 411                                       const char *help_doc,
 412                                       cmd_const_sfunc_ftype *set_func,
 413                                       show_value_ftype *show_func,
 414                                       struct cmd_list_element **set_list,
 415                                       struct cmd_list_element **show_list);
 416
 417 extern void add_setshow_zinteger_cmd (const char *name,
 418                                       enum command_class theclass,
 419                                       int *var,
 420                                       const char *set_doc,
 421                                       const char *show_doc,
 422                                       const char *help_doc,
 423                                       cmd_const_sfunc_ftype *set_func,
 424                                       show_value_ftype *show_func,
 425                                       struct cmd_list_element **set_list,
 426                                       struct cmd_list_element **show_list);
 427
 428 extern void add_setshow_zuinteger_cmd (const char *name,
 429                                        enum command_class theclass,
 430                                        unsigned int *var,
 431                                        const char *set_doc,
 432                                        const char *show_doc,
 433                                        const char *help_doc,
 434                                        cmd_const_sfunc_ftype *set_func,
 435                                        show_value_ftype *show_func,
 436                                        struct cmd_list_element **set_list,
 437                                        struct cmd_list_element **show_list);
 438
 439 extern void
 440   add_setshow_zuinteger_unlimited_cmd (const char *name,
 441                                        enum command_class theclass,
 442                                        int *var,
 443                                        const char *set_doc,
 444                                        const char *show_doc,
 445                                        const char *help_doc,
 446                                        cmd_const_sfunc_ftype *set_func,
 447                                        show_value_ftype *show_func,
 448                                        struct cmd_list_element **set_list,
 449                                        struct cmd_list_element **show_list);
 450
 451 /* Do a "show" command for each thing on a command list.  */
 452
 453 extern void cmd_show_list (struct cmd_list_element *, int, const char *);
 454
 455 /* Used everywhere whenever at least one parameter is required and
 456    none is specified.  */
 457
 458 extern void error_no_arg (const char *) ATTRIBUTE_NORETURN;
 459
 460
 461 /* Command line saving and repetition.
 462    Each input line executed is saved to possibly be repeated either
 463    when the user types an empty line, or be repeated by a command
 464    that wants to repeat the previously executed command.  The below
 465    functions control command repetition.  */
 466
 467 /* Commands call dont_repeat if they do not want to be repeated by null
 468    lines or by repeat_previous ().  */
 469
 470 extern void dont_repeat ();
 471
 472 /* Commands call repeat_previous if they want to repeat the previous
 473    command.  Such commands that repeat the previous command must
 474    indicate to not repeat themselves, to avoid recursive repeat.
 475    repeat_previous marks the current command as not repeating, and
 476    ensures get_saved_command_line returns the previous command, so
 477    that the currently executing command can repeat it.  If there's no
 478    previous command, throws an error.  Otherwise, returns the result
 479    of get_saved_command_line, which now points at the command to
 480    repeat.  */
 481
 482 extern const char *repeat_previous ();
 483
 484 /* Prevent dont_repeat from working, and return a cleanup that
 485    restores the previous state.  */
 486
 487 extern scoped_restore_tmpl<int> prevent_dont_repeat (void);
 488
 489 /* Set the arguments that will be passed if the current command is
 490    repeated.  Note that the passed-in string must be a constant.  */
 491
 492 extern void set_repeat_arguments (const char *args);
 493
 494 /* Returns the saved command line to repeat.
 495    When a command is being executed, this is the currently executing
 496    command line, unless the currently executing command has called
 497    repeat_previous (): in this case, get_saved_command_line returns
 498    the previously saved command line.  */
 499
 500 extern char *get_saved_command_line ();
 501
 502 /* Takes a copy of CMD, for possible repetition.  */
 503
 504 extern void save_command_line (const char *cmd);
 505
 506 /* Used to mark commands that don't do anything.  If we just leave the
 507    function field NULL, the command is interpreted as a help topic, or
 508    as a class of commands.  */
 509
 510 extern void not_just_help_class_command (const char *, int);
 511
 512 /* Check function pointer.  */
 513 extern int cmd_func_p (struct cmd_list_element *cmd);
 514
 515 /* Call the command function.  */
 516 extern void cmd_func (struct cmd_list_element *cmd,
 517                       const char *args, int from_tty);
 518
 519 #endif /* !defined (COMMAND_H) */