gdb/command.h

   1 /* Header file for command-reading library command.c.
   2
   3    Copyright (C) 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999, 2000,
   4    2002, 2004, 2007, 2008, 2009 Free Software Foundation, Inc.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #if !defined (COMMAND_H)
  20 #define COMMAND_H 1
  21
  22 /* Command classes are top-level categories into which commands are broken
  23    down for "help" purposes.
  24    Notes on classes: class_alias is for alias commands which are not
  25    abbreviations of the original command.  class-pseudo is for
  26    commands which are not really commands nor help topics ("stop").  */
  27
  28 enum command_class
  29 {
  30   /* Special args to help_list */
  31   class_deprecated = -3, all_classes = -2, all_commands = -1,
  32   /* Classes of commands */
  33   no_class = -1, class_run = 0, class_vars, class_stack,
  34   class_files, class_support, class_info, class_breakpoint, class_trace,
  35   class_alias, class_obscure, class_user, class_maintenance,
  36   class_pseudo, class_tui, class_xdb
  37 };
  38
  39 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
  40    cmd_types'' can be moved from "command.h" to "cli-decode.h".  */
  41 /* Not a set/show command.  Note that some commands which begin with
  42    "set" or "show" might be in this category, if their syntax does
  43    not fall into one of the following categories.  */
  44 typedef enum cmd_types
  45   {
  46     not_set_cmd,
  47     set_cmd,
  48     show_cmd
  49   }
  50 cmd_types;
  51
  52 /* Types of "set" or "show" command.  */
  53 typedef enum var_types
  54   {
  55     /* "on" or "off".  *VAR is an integer which is nonzero for on,
  56        zero for off.  */
  57     var_boolean,
  58
  59     /* "on" / "true" / "enable" or "off" / "false" / "disable" or
  60        "auto.  *VAR is an ``enum auto_boolean''.  NOTE: In general a
  61        custom show command will need to be implemented - one that for
  62        "auto" prints both the "auto" and the current auto-selected
  63        value. */
  64     var_auto_boolean,
  65
  66     /* Unsigned Integer.  *VAR is an unsigned int.  The user can type 0
  67        to mean "unlimited", which is stored in *VAR as UINT_MAX.  */
  68     var_uinteger,
  69
  70     /* Like var_uinteger but signed.  *VAR is an int.  The user can type 0
  71        to mean "unlimited", which is stored in *VAR as INT_MAX.  */
  72     var_integer,
  73
  74     /* String which the user enters with escapes (e.g. the user types \n and
  75        it is a real newline in the stored string).
  76        *VAR is a malloc'd string, or NULL if the string is empty.  */
  77     var_string,
  78     /* String which stores what the user types verbatim.
  79        *VAR is a malloc'd string, or NULL if the string is empty.  */
  80     var_string_noescape,
  81     /* String which stores a filename.  (*VAR) is a malloc'd string,
  82        or "" if the string was empty.  */
  83     var_optional_filename,
  84     /* String which stores a filename.  (*VAR) is a malloc'd
  85        string.  */
  86     var_filename,
  87     /* ZeroableInteger.  *VAR is an int.  Like Unsigned Integer except
  88        that zero really means zero.  */
  89     var_zinteger,
  90     /* ZeroableUnsignedInteger.  *VAR is an unsigned int.  Zero really
  91        means zero.  */
  92     var_zuinteger,
  93     /* Enumerated type.  Can only have one of the specified values.  *VAR is a
  94        char pointer to the name of the element that we find.  */
  95     var_enum
  96   }
  97 var_types;
  98
  99 /* This structure records one command'd definition.  */
 100 struct cmd_list_element;
 101
 102 /* Forward-declarations of the entry-points of cli/cli-decode.c.  */
 103
 104 extern struct cmd_list_element *add_cmd (char *, enum command_class,
 105                                          void (*fun) (char *, int), char *,
 106                                          struct cmd_list_element **);
 107
 108 extern struct cmd_list_element *add_alias_cmd (char *, char *,
 109                                                enum command_class, int,
 110                                                struct cmd_list_element **);
 111
 112 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
 113                                                 void (*fun) (char *, int),
 114                                                 char *,
 115                                                 struct cmd_list_element **,
 116                                                 char *, int,
 117                                                 struct cmd_list_element **);
 118
 119 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
 120                                                        enum command_class,
 121                                                        void (*fun) (char *,
 122                                                                     int),
 123                                                        char *,
 124                                                        struct cmd_list_element
 125                                                        **, char *, int,
 126                                                        struct cmd_list_element
 127                                                        **);
 128
 129 /* Set the commands corresponding callback.  */
 130
 131 typedef void cmd_cfunc_ftype (char *args, int from_tty);
 132 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
 133                            cmd_cfunc_ftype *cfunc);
 134
 135 typedef void cmd_sfunc_ftype (char *args, int from_tty,
 136                               struct cmd_list_element *c);
 137 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
 138                            cmd_sfunc_ftype *sfunc);
 139
 140 extern void set_cmd_completer (struct cmd_list_element *cmd,
 141                                char **(*completer) (char *text, char *word));
 142
 143 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
 144    around in cmd objects to test the value of the commands sfunc().  */
 145 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
 146                          void (*cfunc) (char *args, int from_tty));
 147
 148 /* Each command object has a local context attached to it. .  */
 149 extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
 150 extern void *get_cmd_context (struct cmd_list_element *cmd);
 151
 152
 153 /* Execute CMD's pre/post hook.  Throw an error if the command fails.
 154    If already executing this pre/post hook, or there is no pre/post
 155    hook, the call is silently ignored.  */
 156 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
 157 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
 158
 159 /* Return the type of the command.  */
 160 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
 161
 162
 163 extern struct cmd_list_element *lookup_cmd (char **,
 164                                             struct cmd_list_element *, char *,
 165                                             int, int);
 166
 167 extern struct cmd_list_element *lookup_cmd_1 (char **,
 168                                               struct cmd_list_element *,
 169                                               struct cmd_list_element **,
 170                                               int);
 171
 172 extern struct cmd_list_element *
 173   deprecate_cmd (struct cmd_list_element *, char * );
 174
 175 extern void
 176   deprecated_cmd_warning (char **);
 177
 178 extern int
 179   lookup_cmd_composition (char *text,
 180                         struct cmd_list_element **alias,
 181                         struct cmd_list_element **prefix_cmd,
 182                         struct cmd_list_element **cmd);
 183
 184 extern struct cmd_list_element *add_com (char *, enum command_class,
 185                                          void (*fun) (char *, int), char *);
 186
 187 extern struct cmd_list_element *add_com_alias (char *, char *,
 188                                                enum command_class, int);
 189
 190 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
 191                                           char *);
 192
 193 extern struct cmd_list_element *add_info_alias (char *, char *, int);
 194
 195 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
 196
 197 extern char **complete_on_enum (const char *enumlist[], char *, char *);
 198
 199 extern void help_cmd (char *, struct ui_file *);
 200
 201 extern void help_list (struct cmd_list_element *, char *,
 202                        enum command_class, struct ui_file *);
 203
 204 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
 205                            char *, int, struct ui_file *);
 206
 207 /* NOTE: cagney/2005-02-21: Since every set command should be paired
 208    with a corresponding show command (i.e., add_setshow_*) this call
 209    should not be needed.  Unfortunatly some are not (e.g.,
 210    "maintenance <variable> <value>") and those need to be fixed.  */
 211 extern struct cmd_list_element *deprecated_add_set_cmd (char *name, enum
 212                                                         command_class class,
 213                                                         var_types var_type, void *var,
 214                                                         char *doc,
 215                                                         struct cmd_list_element **list);
 216
 217 /* Method for show a set/show variable's VALUE on FILE.  If this
 218    method isn't supplied deprecated_show_value_hack() is called (which
 219    is not good).  */
 220 typedef void (show_value_ftype) (struct ui_file *file,
 221                                  int from_tty,
 222                                  struct cmd_list_element *cmd,
 223                                  const char *value);
 224 /* NOTE: i18n: This function is not i18n friendly.  Callers should
 225    instead print the value out directly.  */
 226 extern show_value_ftype deprecated_show_value_hack;
 227
 228 extern void add_setshow_enum_cmd (char *name,
 229                                   enum command_class class,
 230                                   const char *enumlist[],
 231                                   const char **var,
 232                                   const char *set_doc,
 233                                   const char *show_doc,
 234                                   const char *help_doc,
 235                                   cmd_sfunc_ftype *set_func,
 236                                   show_value_ftype *show_func,
 237                                   struct cmd_list_element **set_list,
 238                                   struct cmd_list_element **show_list);
 239
 240 extern void add_setshow_auto_boolean_cmd (char *name,
 241                                           enum command_class class,
 242                                           enum auto_boolean *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_boolean_cmd (char *name,
 252                                      enum command_class class,
 253                                      int *var,
 254                                      const char *set_doc, const char *show_doc,
 255                                      const char *help_doc,
 256                                      cmd_sfunc_ftype *set_func,
 257                                      show_value_ftype *show_func,
 258                                      struct cmd_list_element **set_list,
 259                                      struct cmd_list_element **show_list);
 260
 261 extern void add_setshow_filename_cmd (char *name,
 262                                       enum command_class class,
 263                                       char **var,
 264                                       const char *set_doc,
 265                                       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_string_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_noescape_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 void add_setshow_optional_filename_cmd (char *name,
 295                                                enum command_class class,
 296                                                char **var,
 297                                                const char *set_doc,
 298                                                const char *show_doc,
 299                                                const char *help_doc,
 300                                                cmd_sfunc_ftype *set_func,
 301                                                show_value_ftype *show_func,
 302                                                struct cmd_list_element **set_list,
 303                                                struct cmd_list_element **show_list);
 304
 305 extern void add_setshow_integer_cmd (char *name,
 306                                      enum command_class class,
 307                                      int *var,
 308                                      const char *set_doc,
 309                                      const char *show_doc,
 310                                      const char *help_doc,
 311                                      cmd_sfunc_ftype *set_func,
 312                                      show_value_ftype *show_func,
 313                                      struct cmd_list_element **set_list,
 314                                      struct cmd_list_element **show_list);
 315
 316 extern void add_setshow_uinteger_cmd (char *name,
 317                                       enum command_class class,
 318                                       unsigned int *var,
 319                                       const char *set_doc,
 320                                       const char *show_doc,
 321                                       const char *help_doc,
 322                                       cmd_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
 327 extern void add_setshow_zinteger_cmd (char *name,
 328                                       enum command_class class,
 329                                       int *var,
 330                                       const char *set_doc,
 331                                       const char *show_doc,
 332                                       const char *help_doc,
 333                                       cmd_sfunc_ftype *set_func,
 334                                       show_value_ftype *show_func,
 335                                       struct cmd_list_element **set_list,
 336                                       struct cmd_list_element **show_list);
 337
 338 extern void add_setshow_zuinteger_cmd (char *name,
 339                                        enum command_class class,
 340                                        unsigned int *var,
 341                                        const char *set_doc,
 342                                        const char *show_doc,
 343                                        const char *help_doc,
 344                                        cmd_sfunc_ftype *set_func,
 345                                        show_value_ftype *show_func,
 346                                        struct cmd_list_element **set_list,
 347                                        struct cmd_list_element **show_list);
 348
 349 /* Do a "show" command for each thing on a command list.  */
 350
 351 extern void cmd_show_list (struct cmd_list_element *, int, char *);
 352
 353 extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
 354
 355 extern void dont_repeat (void);
 356
 357 /* Used to mark commands that don't do anything.  If we just leave the
 358    function field NULL, the command is interpreted as a help topic, or
 359    as a class of commands.  */
 360
 361 extern void not_just_help_class_command (char *, int);
 362
 363 /* check function pointer */
 364 extern int cmd_func_p (struct cmd_list_element *cmd);
 365
 366 /* call the command function */
 367 extern void cmd_func (struct cmd_list_element *cmd, char *args, int from_tty);
 368
 369 #endif /* !defined (COMMAND_H) */