gdb/command.h

   1 /* Header file for command creation.
   2
   3    Copyright (C) 1986-2013 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 unsigned
 103        int, but its range is [0, INT_MAX].  -1 stands for unlimited.  */
 104     var_zuinteger_unlimited,
 105     /* Enumerated type.  Can only have one of the specified values.
 106        *VAR is a char pointer to the name of the element that we
 107        find.  */
 108     var_enum
 109   }
 110 var_types;
 111
 112 /* This structure records one command'd definition.  */
 113 struct cmd_list_element;
 114
 115 /* Forward-declarations of the entry-points of cli/cli-decode.c.  */
 116
 117 /* API to the manipulation of command lists.  */
 118
 119 extern int valid_user_defined_cmd_name_p (const char *name);
 120
 121 extern struct cmd_list_element *add_cmd (char *, enum command_class,
 122                                          void (*fun) (char *, int), char *,
 123                                          struct cmd_list_element **);
 124
 125 extern struct cmd_list_element *add_alias_cmd (char *, char *,
 126                                                enum command_class, int,
 127                                                struct cmd_list_element **);
 128
 129 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
 130                                                 void (*fun) (char *, int),
 131                                                 char *,
 132                                                 struct cmd_list_element **,
 133                                                 char *, int,
 134                                                 struct cmd_list_element **);
 135
 136 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
 137                                                        enum command_class,
 138                                                        void (*fun) (char *,
 139                                                                     int),
 140                                                        char *,
 141                                                        struct cmd_list_element
 142                                                        **, char *, int,
 143                                                        struct cmd_list_element
 144                                                        **);
 145
 146 /* Set the commands corresponding callback.  */
 147
 148 typedef void cmd_cfunc_ftype (char *args, int from_tty);
 149 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
 150                            cmd_cfunc_ftype *cfunc);
 151
 152 typedef void cmd_sfunc_ftype (char *args, int from_tty,
 153                               struct cmd_list_element *c);
 154 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
 155                            cmd_sfunc_ftype *sfunc);
 156
 157 typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *,
 158                                          char *, char *);
 159
 160 extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *);
 161
 162 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
 163    around in cmd objects to test the value of the commands sfunc().  */
 164 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
 165                          void (*cfunc) (char *args, int from_tty));
 166
 167 /* Each command object has a local context attached to it.  */
 168 extern void set_cmd_context (struct cmd_list_element *cmd,
 169                              void *context);
 170 extern void *get_cmd_context (struct cmd_list_element *cmd);
 171
 172
 173 /* Execute CMD's pre/post hook.  Throw an error if the command fails.
 174    If already executing this pre/post hook, or there is no pre/post
 175    hook, the call is silently ignored.  */
 176 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
 177 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
 178
 179 /* Return the type of the command.  */
 180 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
 181
 182 /* Flag for an ambiguous cmd_list result.  */
 183 #define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
 184
 185 extern struct cmd_list_element *lookup_cmd (char **,
 186                                             struct cmd_list_element *, char *,
 187                                             int, int);
 188
 189 extern struct cmd_list_element *lookup_cmd_1 (char **,
 190                                               struct cmd_list_element *,
 191                                               struct cmd_list_element **,
 192                                               int);
 193
 194 extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
 195                                                char * );
 196
 197 extern void deprecated_cmd_warning (char **);
 198
 199 extern int lookup_cmd_composition (char *text,
 200                                    struct cmd_list_element **alias,
 201                                    struct cmd_list_element **prefix_cmd,
 202                                    struct cmd_list_element **cmd);
 203
 204 extern struct cmd_list_element *add_com (char *, enum command_class,
 205                                          void (*fun) (char *, int),
 206                                          char *);
 207
 208 extern struct cmd_list_element *add_com_alias (char *, char *,
 209                                                enum command_class, int);
 210
 211 extern struct cmd_list_element *add_info (char *,
 212                                           void (*fun) (char *, int),
 213                                           char *);
 214
 215 extern struct cmd_list_element *add_info_alias (char *, char *, int);
 216
 217 extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *,
 218                                             char *, char *, int);
 219
 220 extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist,
 221                                          char *, char *);
 222
 223 /* Functions that implement commands about CLI commands.  */
 224
 225 extern void help_list (struct cmd_list_element *, char *,
 226                        enum command_class, struct ui_file *);
 227
 228 /* Method for show a set/show variable's VALUE on FILE.  If this
 229    method isn't supplied deprecated_show_value_hack() is called (which
 230    is not good).  */
 231 typedef void (show_value_ftype) (struct ui_file *file,
 232                                  int from_tty,
 233                                  struct cmd_list_element *cmd,
 234                                  const char *value);
 235 /* NOTE: i18n: This function is not i18n friendly.  Callers should
 236    instead print the value out directly.  */
 237 extern show_value_ftype deprecated_show_value_hack;
 238
 239 extern void add_setshow_enum_cmd (char *name,
 240                                   enum command_class class,
 241                                   const char *const *enumlist,
 242                                   const char **var,
 243                                   const char *set_doc,
 244                                   const char *show_doc,
 245                                   const char *help_doc,
 246                                   cmd_sfunc_ftype *set_func,
 247                                   show_value_ftype *show_func,
 248                                   struct cmd_list_element **set_list,
 249                                   struct cmd_list_element **show_list);
 250
 251 extern void add_setshow_auto_boolean_cmd (char *name,
 252                                           enum command_class class,
 253                                           enum auto_boolean *var,
 254                                           const char *set_doc,
 255                                           const char *show_doc,
 256                                           const char *help_doc,
 257                                           cmd_sfunc_ftype *set_func,
 258                                           show_value_ftype *show_func,
 259                                           struct cmd_list_element **set_list,
 260                                           struct cmd_list_element **show_list);
 261
 262 extern void add_setshow_boolean_cmd (char *name,
 263                                      enum command_class class,
 264                                      int *var,
 265                                      const char *set_doc, const char *show_doc,
 266                                      const char *help_doc,
 267                                      cmd_sfunc_ftype *set_func,
 268                                      show_value_ftype *show_func,
 269                                      struct cmd_list_element **set_list,
 270                                      struct cmd_list_element **show_list);
 271
 272 extern void add_setshow_filename_cmd (char *name,
 273                                       enum command_class class,
 274                                       char **var,
 275                                       const char *set_doc,
 276                                       const char *show_doc,
 277                                       const char *help_doc,
 278                                       cmd_sfunc_ftype *set_func,
 279                                       show_value_ftype *show_func,
 280                                       struct cmd_list_element **set_list,
 281                                       struct cmd_list_element **show_list);
 282
 283 extern void add_setshow_string_cmd (char *name,
 284                                     enum command_class class,
 285                                     char **var,
 286                                     const char *set_doc,
 287                                     const char *show_doc,
 288                                     const char *help_doc,
 289                                     cmd_sfunc_ftype *set_func,
 290                                     show_value_ftype *show_func,
 291                                     struct cmd_list_element **set_list,
 292                                     struct cmd_list_element **show_list);
 293
 294 extern struct cmd_list_element *add_setshow_string_noescape_cmd
 295                       (char *name,
 296                        enum command_class class,
 297                        char **var,
 298                        const char *set_doc,
 299                        const char *show_doc,
 300                        const char *help_doc,
 301                        cmd_sfunc_ftype *set_func,
 302                        show_value_ftype *show_func,
 303                        struct cmd_list_element **set_list,
 304                        struct cmd_list_element **show_list);
 305
 306 extern void add_setshow_optional_filename_cmd (char *name,
 307                                                enum command_class class,
 308                                                char **var,
 309                                                const char *set_doc,
 310                                                const char *show_doc,
 311                                                const char *help_doc,
 312                                                cmd_sfunc_ftype *set_func,
 313                                                show_value_ftype *show_func,
 314                                                struct cmd_list_element **set_list,
 315                                                struct cmd_list_element **show_list);
 316
 317 extern void add_setshow_integer_cmd (char *name,
 318                                      enum command_class class,
 319                                      int *var,
 320                                      const char *set_doc,
 321                                      const char *show_doc,
 322                                      const char *help_doc,
 323                                      cmd_sfunc_ftype *set_func,
 324                                      show_value_ftype *show_func,
 325                                      struct cmd_list_element **set_list,
 326                                      struct cmd_list_element **show_list);
 327
 328 extern void add_setshow_uinteger_cmd (char *name,
 329                                       enum command_class class,
 330                                       unsigned int *var,
 331                                       const char *set_doc,
 332                                       const char *show_doc,
 333                                       const char *help_doc,
 334                                       cmd_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 void add_setshow_zinteger_cmd (char *name,
 340                                       enum command_class class,
 341                                       int *var,
 342                                       const char *set_doc,
 343                                       const char *show_doc,
 344                                       const char *help_doc,
 345                                       cmd_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_zuinteger_cmd (char *name,
 351                                        enum command_class class,
 352                                        unsigned int *var,
 353                                        const char *set_doc,
 354                                        const char *show_doc,
 355                                        const char *help_doc,
 356                                        cmd_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
 362   add_setshow_zuinteger_unlimited_cmd (char *name,
 363                                        enum command_class class,
 364                                        unsigned int *var,
 365                                        const char *set_doc,
 366                                        const char *show_doc,
 367                                        const char *help_doc,
 368                                        cmd_sfunc_ftype *set_func,
 369                                        show_value_ftype *show_func,
 370                                        struct cmd_list_element **set_list,
 371                                        struct cmd_list_element **show_list);
 372
 373 /* Do a "show" command for each thing on a command list.  */
 374
 375 extern void cmd_show_list (struct cmd_list_element *, int, char *);
 376
 377 /* Used everywhere whenever at least one parameter is required and
 378    none is specified.  */
 379
 380 extern void error_no_arg (char *) ATTRIBUTE_NORETURN;
 381
 382 extern void dont_repeat (void);
 383
 384 extern struct cleanup *prevent_dont_repeat (void);
 385
 386 /* Used to mark commands that don't do anything.  If we just leave the
 387    function field NULL, the command is interpreted as a help topic, or
 388    as a class of commands.  */
 389
 390 extern void not_just_help_class_command (char *, int);
 391
 392 /* Check function pointer.  */
 393 extern int cmd_func_p (struct cmd_list_element *cmd);
 394
 395 /* Call the command function.  */
 396 extern void cmd_func (struct cmd_list_element *cmd,
 397                       char *args, int from_tty);
 398
 399 #endif /* !defined (COMMAND_H) */