gdb/command.h

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