gdb/command.h

   1 /* Header file for command-reading library command.c.
   2
   3    Copyright 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999,
   4    2000, 2002, 2004 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 2 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, write to the Free Software
  18    Foundation, Inc., 59 Temple Place - Suite 330,
  19    Boston, MA 02111-1307, USA.  */
  20
  21 #if !defined (COMMAND_H)
  22 #define COMMAND_H 1
  23
  24 /* Command classes are top-level categories into which commands are broken
  25    down for "help" purposes.
  26    Notes on classes: class_alias is for alias commands which are not
  27    abbreviations of the original command.  class-pseudo is for
  28    commands which are not really commands nor help topics ("stop").  */
  29
  30 enum command_class
  31 {
  32   /* Special args to help_list */
  33   class_deprecated, all_classes = -2, all_commands = -1,
  34   /* Classes of commands */
  35   no_class = -1, class_run = 0, class_vars, class_stack,
  36   class_files, class_support, class_info, class_breakpoint, class_trace,
  37   class_alias, class_obscure, class_user, class_maintenance,
  38   class_pseudo, class_tui, class_xdb
  39 };
  40
  41 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
  42    cmd_types'' can be moved from "command.h" to "cli-decode.h".  */
  43 /* Not a set/show command.  Note that some commands which begin with
  44    "set" or "show" might be in this category, if their syntax does
  45    not fall into one of the following categories.  */
  46 typedef enum cmd_types
  47   {
  48     not_set_cmd,
  49     set_cmd,
  50     show_cmd
  51   }
  52 cmd_types;
  53
  54 /* Types of "set" or "show" command.  */
  55 typedef enum var_types
  56   {
  57     /* "on" or "off".  *VAR is an integer which is nonzero for on,
  58        zero for off.  */
  59     var_boolean,
  60
  61     /* "on" / "true" / "enable" or "off" / "false" / "disable" or
  62        "auto.  *VAR is an ``enum auto_boolean''.  NOTE: In general a
  63        custom show command will need to be implemented - one that for
  64        "auto" prints both the "auto" and the current auto-selected
  65        value. */
  66     var_auto_boolean,
  67
  68     /* Unsigned Integer.  *VAR is an unsigned int.  The user can type 0
  69        to mean "unlimited", which is stored in *VAR as UINT_MAX.  */
  70     var_uinteger,
  71
  72     /* Like var_uinteger but signed.  *VAR is an int.  The user can type 0
  73        to mean "unlimited", which is stored in *VAR as INT_MAX.  */
  74     var_integer,
  75
  76     /* String which the user enters with escapes (e.g. the user types \n and
  77        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     /* Enumerated type.  Can only have one of the specified values.  *VAR is a
  93        char pointer to the name of the element that we find.  */
  94     var_enum
  95   }
  96 var_types;
  97
  98 /* This structure records one command'd definition.  */
  99 struct cmd_list_element;
 100
 101 /* Forward-declarations of the entry-points of cli/cli-decode.c.  */
 102
 103 extern struct cmd_list_element *add_cmd (char *, enum command_class,
 104                                          void (*fun) (char *, int), char *,
 105                                          struct cmd_list_element **);
 106
 107 extern struct cmd_list_element *add_alias_cmd (char *, char *,
 108                                                enum command_class, int,
 109                                                struct cmd_list_element **);
 110
 111 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
 112                                                 void (*fun) (char *, int),
 113                                                 char *,
 114                                                 struct cmd_list_element **,
 115                                                 char *, int,
 116                                                 struct cmd_list_element **);
 117
 118 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
 119                                                        enum command_class,
 120                                                        void (*fun) (char *,
 121                                                                     int),
 122                                                        char *,
 123                                                        struct cmd_list_element
 124                                                        **, char *, int,
 125                                                        struct cmd_list_element
 126                                                        **);
 127
 128 /* Set the commands corresponding callback.  */
 129
 130 typedef void cmd_cfunc_ftype (char *args, int from_tty);
 131 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
 132                            cmd_cfunc_ftype *cfunc);
 133
 134 typedef void cmd_sfunc_ftype (char *args, int from_tty,
 135                               struct cmd_list_element *c);
 136 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
 137                            cmd_sfunc_ftype *sfunc);
 138
 139 extern void set_cmd_completer (struct cmd_list_element *cmd,
 140                                char **(*completer) (char *text, char *word));
 141
 142 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
 143    around in cmd objects to test the value of the commands sfunc().  */
 144 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
 145                          void (*cfunc) (char *args, int from_tty));
 146
 147 /* Each command object has a local context attached to it. .  */
 148 extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
 149 extern void *get_cmd_context (struct cmd_list_element *cmd);
 150
 151
 152 /* Execute CMD's pre/post hook.  Throw an error if the command fails.
 153    If already executing this pre/post hook, or there is no pre/post
 154    hook, the call is silently ignored.  */
 155 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
 156 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
 157
 158 /* Return the type of the command.  */
 159 /* NOTE: cagney/2002-03-17: The deprecated_add_show_from_set()
 160    function clones the set command passed as a parameter.  The clone
 161    operation will include (BUG?) any ``set'' command callback, if
 162    present.  Commands like ``info set'' call all the ``show'' command
 163    callbacks.  Unfortunately, for ``show'' commands cloned from
 164    ``set'', this includes callbacks belonging to ``set'' commands.
 165    Making this worse, this only occures if
 166    deprecated_add_show_from_set() is called after add_cmd_sfunc()
 167    (BUG?).  */
 168 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
 169
 170
 171 extern struct cmd_list_element *lookup_cmd (char **,
 172                                             struct cmd_list_element *, char *,
 173                                             int, int);
 174
 175 extern struct cmd_list_element *lookup_cmd_1 (char **,
 176                                               struct cmd_list_element *,
 177                                               struct cmd_list_element **,
 178                                               int);
 179
 180 extern struct cmd_list_element *
 181   deprecate_cmd (struct cmd_list_element *, char * );
 182
 183 extern void
 184   deprecated_cmd_warning (char **);
 185
 186 extern int
 187   lookup_cmd_composition (char *text,
 188                         struct cmd_list_element **alias,
 189                         struct cmd_list_element **prefix_cmd,
 190                         struct cmd_list_element **cmd);
 191
 192 extern struct cmd_list_element *add_com (char *, enum command_class,
 193                                          void (*fun) (char *, int), char *);
 194
 195 extern struct cmd_list_element *add_com_alias (char *, char *,
 196                                                enum command_class, int);
 197
 198 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
 199                                           char *);
 200
 201 extern struct cmd_list_element *add_info_alias (char *, char *, int);
 202
 203 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
 204
 205 extern char **complete_on_enum (const char *enumlist[], char *, char *);
 206
 207 extern void delete_cmd (char *, struct cmd_list_element **);
 208
 209 extern void help_cmd (char *, struct ui_file *);
 210
 211 extern void help_list (struct cmd_list_element *, char *,
 212                        enum command_class, struct ui_file *);
 213
 214 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
 215                            char *, int, struct ui_file *);
 216
 217 extern struct cmd_list_element *add_set_cmd (char *name, enum
 218                                              command_class class,
 219                                              var_types var_type, void *var,
 220                                              char *doc,
 221                                              struct cmd_list_element **list);
 222
 223 extern struct cmd_list_element *add_set_enum_cmd (char *name,
 224                                                   enum command_class class,
 225                                                   const char *enumlist[],
 226                                                   const char **var,
 227                                                   char *doc,
 228                                                   struct cmd_list_element **list);
 229
 230 /* Method for show a set/show variable's VALUE on FILE.  If this
 231    method isn't supplied deprecated_show_value_hack() is called (which
 232    is not good).  */
 233 typedef void (show_value_ftype) (struct ui_file *file,
 234                                  int from_tty,
 235                                  struct cmd_list_element *cmd,
 236                                  const char *value);
 237 /* NOTE: i18n: This function is not i18n friendly.  Callers should
 238    instead print the value out directly.  */
 239 extern show_value_ftype deprecated_show_value_hack;
 240
 241 extern void add_setshow_enum_cmd (char *name,
 242                                   enum command_class class,
 243                                   const char *enumlist[],
 244                                   const char **var,
 245                                   const char *set_doc,
 246                                   const char *show_doc,
 247                                   const char *help_doc,
 248                                   cmd_sfunc_ftype *set_func,
 249                                   show_value_ftype *show_func,
 250                                   struct cmd_list_element **set_list,
 251                                   struct cmd_list_element **show_list);
 252
 253 extern void add_setshow_auto_boolean_cmd (char *name,
 254                                           enum command_class class,
 255                                           enum auto_boolean *var,
 256                                           const char *set_doc,
 257                                           const char *show_doc,
 258                                           const char *help_doc,
 259                                           cmd_sfunc_ftype *set_func,
 260                                           show_value_ftype *show_func,
 261                                           struct cmd_list_element **set_list,
 262                                           struct cmd_list_element **show_list);
 263
 264 extern void add_setshow_boolean_cmd (char *name,
 265                                      enum command_class class,
 266                                      int *var,
 267                                      const char *set_doc, const char *show_doc,
 268                                      const char *help_doc,
 269                                      cmd_sfunc_ftype *set_func,
 270                                      show_value_ftype *show_func,
 271                                      struct cmd_list_element **set_list,
 272                                      struct cmd_list_element **show_list);
 273
 274 extern void add_setshow_filename_cmd (char *name,
 275                                       enum command_class class,
 276                                       char **var,
 277                                       const char *set_doc,
 278                                       const char *show_doc,
 279                                       const char *help_doc,
 280                                       cmd_sfunc_ftype *set_func,
 281                                       show_value_ftype *show_func,
 282                                       struct cmd_list_element **set_list,
 283                                       struct cmd_list_element **show_list);
 284
 285 extern void add_setshow_string_cmd (char *name,
 286                                     enum command_class class,
 287                                     char **var,
 288                                     const char *set_doc,
 289                                     const char *show_doc,
 290                                     const char *help_doc,
 291                                     cmd_sfunc_ftype *set_func,
 292                                     show_value_ftype *show_func,
 293                                     struct cmd_list_element **set_list,
 294                                     struct cmd_list_element **show_list);
 295
 296 extern void add_setshow_string_noescape_cmd (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 (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 (char *name,
 319                                      enum command_class class,
 320                                      unsigned 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 (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 (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 struct cmd_list_element *deprecated_add_show_from_set (struct cmd_list_element *,
 352                                                               struct cmd_list_element **);
 353
 354 /* Do a "show" command for each thing on a command list.  */
 355
 356 extern void cmd_show_list (struct cmd_list_element *, int, char *);
 357
 358 extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
 359
 360 extern void dont_repeat (void);
 361
 362 /* Used to mark commands that don't do anything.  If we just leave the
 363    function field NULL, the command is interpreted as a help topic, or
 364    as a class of commands.  */
 365
 366 extern void not_just_help_class_command (char *, int);
 367
 368 /* check function pointer */
 369 extern int cmd_func_p (struct cmd_list_element *cmd);
 370
 371 /* call the command function */
 372 extern void cmd_func (struct cmd_list_element *cmd, char *args, int from_tty);
 373
 374 #endif /* !defined (COMMAND_H) */