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