gdb/command.h

   1 /* Header file for command creation.
   2
   3    Copyright (C) 1986-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 (COMMAND_H)
  19 #define COMMAND_H 1
  20
  21 #include "gdb_vecs.h"
  22
  23 /* This file defines the public interface for any code wanting to
  24    create commands.  */
  25
  26 /* Command classes are top-level categories into which commands are
  27    broken down for "help" purposes.
  28
  29    Notes on classes: class_alias is for alias commands which are not
  30    abbreviations of the original command.  class-pseudo is for
  31    commands which are not really commands nor help topics ("stop").  */
  32
  33 enum command_class
  34 {
  35   /* Special args to help_list */
  36   class_deprecated = -3, all_classes = -2, all_commands = -1,
  37   /* Classes of commands */
  38   no_class = -1, class_run = 0, class_vars, class_stack, class_files,
  39   class_support, class_info, class_breakpoint, class_trace,
  40   class_alias, class_bookmark, class_obscure, class_maintenance,
  41   class_pseudo, class_tui, class_user, class_xdb,
  42   no_set_class  /* Used for "show" commands that have no corresponding
  43                    "set" command.  */
  44 };
  45
  46 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
  47    cmd_types'' can be moved from "command.h" to "cli-decode.h".  */
  48 /* Not a set/show command.  Note that some commands which begin with
  49    "set" or "show" might be in this category, if their syntax does
  50    not fall into one of the following categories.  */
  51 typedef enum cmd_types
  52   {
  53     not_set_cmd,
  54     set_cmd,
  55     show_cmd
  56   }
  57 cmd_types;
  58
  59 /* Types of "set" or "show" command.  */
  60 typedef enum var_types
  61   {
  62     /* "on" or "off".  *VAR is an integer which is nonzero for on,
  63        zero for off.  */
  64     var_boolean,
  65
  66     /* "on" / "true" / "enable" or "off" / "false" / "disable" or
  67        "auto.  *VAR is an ``enum auto_boolean''.  NOTE: In general a
  68        custom show command will need to be implemented - one that for
  69        "auto" prints both the "auto" and the current auto-selected
  70        value.  */
  71     var_auto_boolean,
  72
  73     /* Unsigned Integer.  *VAR is an unsigned int.  The user can type
  74        0 to mean "unlimited", which is stored in *VAR as UINT_MAX.  */
  75     var_uinteger,
  76
  77     /* Like var_uinteger but signed.  *VAR is an int.  The user can
  78        type 0 to mean "unlimited", which is stored in *VAR as
  79        INT_MAX.  The only remaining use of it is the Python API.
  80        Don't use it elsewhere.  */
  81     var_integer,
  82
  83     /* String which the user enters with escapes (e.g. the user types
  84        \n and it is a real newline in the stored string).
  85        *VAR is a malloc'd string, or NULL if the string is empty.  */
  86     var_string,
  87     /* String which stores what the user types verbatim.
  88        *VAR is a malloc'd string, or NULL if the string is empty.  */
  89     var_string_noescape,
  90     /* String which stores a filename.  (*VAR) is a malloc'd string,
  91        or "" if the string was empty.  */
  92     var_optional_filename,
  93     /* String which stores a filename.  (*VAR) is a malloc'd
  94        string.  */
  95     var_filename,
  96     /* ZeroableInteger.  *VAR is an int.  Like var_integer except
  97        that zero really means zero.  */
  98     var_zinteger,
  99     /* ZeroableUnsignedInteger.  *VAR is an unsigned int.  Zero really
 100        means zero.  */
 101     var_zuinteger,
 102     /* ZeroableUnsignedInteger with unlimited value.  *VAR is an int,
 103        but its range is [0, INT_MAX].  -1 stands for unlimited and
 104        other negative numbers are not allowed.  */
 105     var_zuinteger_unlimited,
 106     /* Enumerated type.  Can only have one of the specified values.
 107        *VAR is a char pointer to the name of the element that we
 108        find.  */
 109     var_enum
 110   }
 111 var_types;
 112
 113 /* This structure records one command'd definition.  */
 114 struct cmd_list_element;
 115
 116 typedef void cmd_cfunc_ftype (char *args, int from_tty);
 117
 118 /* This structure specifies notifications to be suppressed by a cli
 119    command interpreter.  */
 120
 121 struct cli_suppress_notification
 122 {
 123   /* Inferior, thread, frame selected notification suppressed?  */
 124   int user_selected_context;
 125 };
 126
 127 extern struct cli_suppress_notification cli_suppress_notification;
 128
 129 /* Forward-declarations of the entry-points of cli/cli-decode.c.  */
 130
 131 /* API to the manipulation of command lists.  */
 132
 133 extern int valid_user_defined_cmd_name_p (const char *name);
 134
 135 extern struct cmd_list_element *add_cmd (const char *, enum command_class,
 136                                          cmd_cfunc_ftype *fun,
 137                                          const char *,
 138                                          struct cmd_list_element **);
 139
 140 extern struct cmd_list_element *add_alias_cmd (const char *, const char *,
 141                                                enum command_class, int,
 142                                                struct cmd_list_element **);
 143
 144 extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class,
 145                                                 cmd_cfunc_ftype *fun,
 146                                                 const char *,
 147                                                 struct cmd_list_element **,
 148                                                 const char *, int,
 149                                                 struct cmd_list_element **);
 150
 151 extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *,
 152                                                        enum command_class,
 153                                                        cmd_cfunc_ftype *fun,
 154                                                        const char *,
 155                                                        struct cmd_list_element
 156                                                        **, const char *, int,
 157                                                        struct cmd_list_element
 158                                                        **);
 159
 160 /* Set the commands corresponding callback.  */
 161
 162 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
 163                            cmd_cfunc_ftype *cfunc);
 164
 165 typedef void cmd_sfunc_ftype (char *args, int from_tty,
 166                               struct cmd_list_element *c);
 167 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
 168                            cmd_sfunc_ftype *sfunc);
 169
 170 typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *,
 171                                          const char *, const char *);
 172
 173 typedef void completer_ftype_void (struct cmd_list_element *,
 174                                    const char *, const char *);
 175
 176 extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *);
 177
 178 /* Set the completer_handle_brkchars callback.  */
 179
 180 extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *,
 181                                                completer_ftype_void *);
 182
 183 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
 184    around in cmd objects to test the value of the commands sfunc().  */
 185 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
 186                          cmd_cfunc_ftype *cfun);
 187
 188 /* Each command object has a local context attached to it.  */
 189 extern void set_cmd_context (struct cmd_list_element *cmd,
 190                              void *context);
 191 extern void *get_cmd_context (struct cmd_list_element *cmd);
 192
 193
 194 /* Execute CMD's pre/post hook.  Throw an error if the command fails.
 195    If already executing this pre/post hook, or there is no pre/post
 196    hook, the call is silently ignored.  */
 197 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
 198 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
 199
 200 /* Return the type of the command.  */
 201 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
 202
 203 /* Flag for an ambiguous cmd_list result.  */
 204 #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
 205
 206 extern struct cmd_list_element *lookup_cmd (const char **,
 207                                             struct cmd_list_element *,
 208                                             const char *,
 209                                             int, int);
 210
 211 extern struct cmd_list_element *lookup_cmd_1 (const char **,
 212                                               struct cmd_list_element *,
 213                                               struct cmd_list_element **,
 214                                               int);
 215
 216 extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
 217                                                const char * );
 218
 219 extern void deprecated_cmd_warning (const char *);
 220
 221 extern int lookup_cmd_composition (const char *text,
 222                                    struct cmd_list_element **alias,
 223                                    struct cmd_list_element **prefix_cmd,
 224                                    struct cmd_list_element **cmd);
 225
 226 extern struct cmd_list_element *add_com (const char *, enum command_class,
 227                                          cmd_cfunc_ftype *fun,
 228                                          const char *);
 229
 230 extern struct cmd_list_element *add_com_alias (const char *, const char *,
 231                                                enum command_class, int);
 232
 233 extern struct cmd_list_element *add_com_suppress_notification
 234                        (const char *name, enum command_class theclass,
 235                         cmd_cfunc_ftype *fun, const char *doc,
 236                         int *supress_notification);
 237
 238 extern struct cmd_list_element *add_info (const char *,
 239                                           cmd_cfunc_ftype *fun,
 240                                           const char *);
 241
 242 extern struct cmd_list_element *add_info_alias (const char *, const char *,
 243                                                 int);
 244
 245 extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *,
 246                                             const char *, const char *, int);
 247
 248 extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist,
 249                                          const char *, const char *);
 250
 251 /* Functions that implement commands about CLI commands.  */
 252
 253 extern void help_list (struct cmd_list_element *, const char *,
 254                        enum command_class, struct ui_file *);
 255
 256 /* Method for show a set/show variable's VALUE on FILE.  If this
 257    method isn't supplied deprecated_show_value_hack() is called (which
 258    is not good).  */
 259 typedef void (show_value_ftype) (struct ui_file *file,
 260                                  int from_tty,
 261                                  struct cmd_list_element *cmd,
 262                                  const char *value);
 263 /* NOTE: i18n: This function is not i18n friendly.  Callers should
 264    instead print the value out directly.  */
 265 extern show_value_ftype deprecated_show_value_hack;
 266
 267 extern void add_setshow_enum_cmd (const char *name,
 268                                   enum command_class theclass,
 269                                   const char *const *enumlist,
 270                                   const char **var,
 271                                   const char *set_doc,
 272                                   const char *show_doc,
 273                                   const char *help_doc,
 274                                   cmd_sfunc_ftype *set_func,
 275                                   show_value_ftype *show_func,
 276                                   struct cmd_list_element **set_list,
 277                                   struct cmd_list_element **show_list);
 278
 279 extern void add_setshow_auto_boolean_cmd (const char *name,
 280                                           enum command_class theclass,
 281                                           enum auto_boolean *var,
 282                                           const char *set_doc,
 283                                           const char *show_doc,
 284                                           const char *help_doc,
 285                                           cmd_sfunc_ftype *set_func,
 286                                           show_value_ftype *show_func,
 287                                           struct cmd_list_element **set_list,
 288                                           struct cmd_list_element **show_list);
 289
 290 extern void add_setshow_boolean_cmd (const char *name,
 291                                      enum command_class theclass,
 292                                      int *var,
 293                                      const char *set_doc, const char *show_doc,
 294                                      const char *help_doc,
 295                                      cmd_sfunc_ftype *set_func,
 296                                      show_value_ftype *show_func,
 297                                      struct cmd_list_element **set_list,
 298                                      struct cmd_list_element **show_list);
 299
 300 extern void add_setshow_filename_cmd (const char *name,
 301                                       enum command_class theclass,
 302                                       char **var,
 303                                       const char *set_doc,
 304                                       const char *show_doc,
 305                                       const char *help_doc,
 306                                       cmd_sfunc_ftype *set_func,
 307                                       show_value_ftype *show_func,
 308                                       struct cmd_list_element **set_list,
 309                                       struct cmd_list_element **show_list);
 310
 311 extern void add_setshow_string_cmd (const char *name,
 312                                     enum command_class theclass,
 313                                     char **var,
 314                                     const char *set_doc,
 315                                     const char *show_doc,
 316                                     const char *help_doc,
 317                                     cmd_sfunc_ftype *set_func,
 318                                     show_value_ftype *show_func,
 319                                     struct cmd_list_element **set_list,
 320                                     struct cmd_list_element **show_list);
 321
 322 extern struct cmd_list_element *add_setshow_string_noescape_cmd
 323                       (const char *name,
 324                        enum command_class theclass,
 325                        char **var,
 326                        const char *set_doc,
 327                        const char *show_doc,
 328                        const char *help_doc,
 329                        cmd_sfunc_ftype *set_func,
 330                        show_value_ftype *show_func,
 331                        struct cmd_list_element **set_list,
 332                        struct cmd_list_element **show_list);
 333
 334 extern void add_setshow_optional_filename_cmd (const char *name,
 335                                                enum command_class theclass,
 336                                                char **var,
 337                                                const char *set_doc,
 338                                                const char *show_doc,
 339                                                const char *help_doc,
 340                                                cmd_sfunc_ftype *set_func,
 341                                                show_value_ftype *show_func,
 342                                                struct cmd_list_element **set_list,
 343                                                struct cmd_list_element **show_list);
 344
 345 extern void add_setshow_integer_cmd (const char *name,
 346                                      enum command_class theclass,
 347                                      int *var,
 348                                      const char *set_doc,
 349                                      const char *show_doc,
 350                                      const char *help_doc,
 351                                      cmd_sfunc_ftype *set_func,
 352                                      show_value_ftype *show_func,
 353                                      struct cmd_list_element **set_list,
 354                                      struct cmd_list_element **show_list);
 355
 356 extern void add_setshow_uinteger_cmd (const char *name,
 357                                       enum command_class theclass,
 358                                       unsigned int *var,
 359                                       const char *set_doc,
 360                                       const char *show_doc,
 361                                       const char *help_doc,
 362                                       cmd_sfunc_ftype *set_func,
 363                                       show_value_ftype *show_func,
 364                                       struct cmd_list_element **set_list,
 365                                       struct cmd_list_element **show_list);
 366
 367 extern void add_setshow_zinteger_cmd (const char *name,
 368                                       enum command_class theclass,
 369                                       int *var,
 370                                       const char *set_doc,
 371                                       const char *show_doc,
 372                                       const char *help_doc,
 373                                       cmd_sfunc_ftype *set_func,
 374                                       show_value_ftype *show_func,
 375                                       struct cmd_list_element **set_list,
 376                                       struct cmd_list_element **show_list);
 377
 378 extern void add_setshow_zuinteger_cmd (const char *name,
 379                                        enum command_class theclass,
 380                                        unsigned int *var,
 381                                        const char *set_doc,
 382                                        const char *show_doc,
 383                                        const char *help_doc,
 384                                        cmd_sfunc_ftype *set_func,
 385                                        show_value_ftype *show_func,
 386                                        struct cmd_list_element **set_list,
 387                                        struct cmd_list_element **show_list);
 388
 389 extern void
 390   add_setshow_zuinteger_unlimited_cmd (const char *name,
 391                                        enum command_class theclass,
 392                                        int *var,
 393                                        const char *set_doc,
 394                                        const char *show_doc,
 395                                        const char *help_doc,
 396                                        cmd_sfunc_ftype *set_func,
 397                                        show_value_ftype *show_func,
 398                                        struct cmd_list_element **set_list,
 399                                        struct cmd_list_element **show_list);
 400
 401 /* Do a "show" command for each thing on a command list.  */
 402
 403 extern void cmd_show_list (struct cmd_list_element *, int, const char *);
 404
 405 /* Used everywhere whenever at least one parameter is required and
 406    none is specified.  */
 407
 408 extern void error_no_arg (const char *) ATTRIBUTE_NORETURN;
 409
 410 extern void dont_repeat (void);
 411
 412 extern scoped_restore_tmpl<int> prevent_dont_repeat (void);
 413
 414 /* Used to mark commands that don't do anything.  If we just leave the
 415    function field NULL, the command is interpreted as a help topic, or
 416    as a class of commands.  */
 417
 418 extern void not_just_help_class_command (char *, int);
 419
 420 /* Check function pointer.  */
 421 extern int cmd_func_p (struct cmd_list_element *cmd);
 422
 423 /* Call the command function.  */
 424 extern void cmd_func (struct cmd_list_element *cmd,
 425                       char *args, int from_tty);
 426
 427 #endif /* !defined (COMMAND_H) */