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.
  84        *VAR is a malloc'd string, or NULL if the string is empty.  */
  85     var_filename,
  86     /* ZeroableInteger.  *VAR is an int.  Like Unsigned Integer except
  87        that zero really means zero.  */
  88     var_zinteger,
  89     /* Enumerated type.  Can only have one of the specified values.  *VAR is a
  90        char pointer to the name of the element that we find.  */
  91     var_enum
  92   }
  93 var_types;
  94
  95 /* This structure records one command'd definition.  */
  96 struct cmd_list_element;
  97
  98 /* Forward-declarations of the entry-points of cli/cli-decode.c.  */
  99
 100 extern struct cmd_list_element *add_cmd (char *, enum command_class,
 101                                          void (*fun) (char *, int), char *,
 102                                          struct cmd_list_element **);
 103
 104 extern struct cmd_list_element *add_alias_cmd (char *, char *,
 105                                                enum command_class, int,
 106                                                struct cmd_list_element **);
 107
 108 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
 109                                                 void (*fun) (char *, int),
 110                                                 char *,
 111                                                 struct cmd_list_element **,
 112                                                 char *, int,
 113                                                 struct cmd_list_element **);
 114
 115 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
 116                                                        enum command_class,
 117                                                        void (*fun) (char *,
 118                                                                     int),
 119                                                        char *,
 120                                                        struct cmd_list_element
 121                                                        **, char *, int,
 122                                                        struct cmd_list_element
 123                                                        **);
 124
 125 /* Set the commands corresponding callback.  */
 126
 127 typedef void cmd_cfunc_ftype (char *args, int from_tty);
 128 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
 129                            cmd_cfunc_ftype *cfunc);
 130
 131 typedef void cmd_sfunc_ftype (char *args, int from_tty,
 132                               struct cmd_list_element *c);
 133 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
 134                            cmd_sfunc_ftype *sfunc);
 135
 136 extern void set_cmd_completer (struct cmd_list_element *cmd,
 137                                char **(*completer) (char *text, char *word));
 138
 139 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
 140    around in cmd objects to test the value of the commands sfunc().  */
 141 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
 142                          void (*cfunc) (char *args, int from_tty));
 143
 144 /* Each command object has a local context attached to it. .  */
 145 extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
 146 extern void *get_cmd_context (struct cmd_list_element *cmd);
 147
 148
 149 /* Execute CMD's pre/post hook.  Throw an error if the command fails.
 150    If already executing this pre/post hook, or there is no pre/post
 151    hook, the call is silently ignored.  */
 152 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
 153 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
 154
 155 /* Return the type of the command.  */
 156 /* NOTE: cagney/2002-03-17: The deprecated_add_show_from_set()
 157    function clones the set command passed as a parameter.  The clone
 158    operation will include (BUG?) any ``set'' command callback, if
 159    present.  Commands like ``info set'' call all the ``show'' command
 160    callbacks.  Unfortunately, for ``show'' commands cloned from
 161    ``set'', this includes callbacks belonging to ``set'' commands.
 162    Making this worse, this only occures if
 163    deprecated_add_show_from_set() is called after add_cmd_sfunc()
 164    (BUG?).  */
 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 *
 178   deprecate_cmd (struct cmd_list_element *, char * );
 179
 180 extern void
 181   deprecated_cmd_warning (char **);
 182
 183 extern int
 184   lookup_cmd_composition (char *text,
 185                         struct cmd_list_element **alias,
 186                         struct cmd_list_element **prefix_cmd,
 187                         struct cmd_list_element **cmd);
 188
 189 extern struct cmd_list_element *add_com (char *, enum command_class,
 190                                          void (*fun) (char *, int), char *);
 191
 192 extern struct cmd_list_element *add_com_alias (char *, char *,
 193                                                enum command_class, int);
 194
 195 extern struct cmd_list_element *add_info (char *, 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 *, char *, char *);
 201
 202 extern char **complete_on_enum (const char *enumlist[], char *, char *);
 203
 204 extern void delete_cmd (char *, struct cmd_list_element **);
 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 *, enum command_class,
 212                            char *, int, struct ui_file *);
 213
 214 extern void add_setshow_cmd (char *name,
 215                              enum command_class class,
 216                              var_types var_type, void *var,
 217                              const char *set_doc, const char *show_doc,
 218                              const char *help_doc, const char *print,
 219                              cmd_sfunc_ftype *set_func,
 220                              cmd_sfunc_ftype *show_func,
 221                              struct cmd_list_element **set_list,
 222                              struct cmd_list_element **show_list);
 223
 224 extern void add_setshow_cmd_full (char *name,
 225                                   enum command_class class,
 226                                   var_types var_type, void *var,
 227                                   const char *set_doc, const char *show_doc,
 228                                   const char *help_doc, const char *print,
 229                                   cmd_sfunc_ftype *set_func,
 230                                   cmd_sfunc_ftype *show_func,
 231                                   struct cmd_list_element **set_list,
 232                                   struct cmd_list_element **show_list,
 233                                   struct cmd_list_element **set_result,
 234                                   struct cmd_list_element **show_result);
 235
 236 extern struct cmd_list_element *add_set_cmd (char *name, enum
 237                                              command_class class,
 238                                              var_types var_type, void *var,
 239                                              char *doc,
 240                                              struct cmd_list_element **list);
 241
 242 extern struct cmd_list_element *add_set_enum_cmd (char *name,
 243                                                   enum command_class class,
 244                                                   const char *enumlist[],
 245                                                   const char **var,
 246                                                   char *doc,
 247                                                   struct cmd_list_element **list);
 248
 249 extern void add_setshow_auto_boolean_cmd (char *name,
 250                                           enum command_class class,
 251                                           enum auto_boolean *var,
 252                                           const char *set_doc,
 253                                           const char *show_doc,
 254                                           const char *help_doc,
 255                                           const char *print,
 256                                           cmd_sfunc_ftype *set_func,
 257                                           cmd_sfunc_ftype *show_func,
 258                                           struct cmd_list_element **set_list,
 259                                           struct cmd_list_element **show_list);
 260
 261 extern void add_setshow_boolean_cmd (char *name,
 262                                      enum command_class class,
 263                                      int *var,
 264                                      const char *set_doc, const char *show_doc,
 265                                      const char *help_doc, const char *print,
 266                                      cmd_sfunc_ftype *set_func,
 267                                      cmd_sfunc_ftype *show_func,
 268                                      struct cmd_list_element **set_list,
 269                                      struct cmd_list_element **show_list);
 270
 271 extern void add_setshow_uinteger_cmd (char *name,
 272                                       enum command_class class,
 273                                       unsigned int *var,
 274                                       const char *set_doc,
 275                                       const char *show_doc,
 276                                       const char *help_doc,
 277                                       const char *print,
 278                                       cmd_sfunc_ftype *set_func,
 279                                       cmd_sfunc_ftype *show_func,
 280                                       struct cmd_list_element **set_list,
 281                                       struct cmd_list_element **show_list);
 282
 283 extern void add_setshow_zinteger_cmd (char *name,
 284                                       enum command_class class,
 285                                       int *var,
 286                                       const char *set_doc,
 287                                       const char *show_doc,
 288                                       const char *help_doc,
 289                                       const char *print,
 290                                       cmd_sfunc_ftype *set_func,
 291                                       cmd_sfunc_ftype *show_func,
 292                                       struct cmd_list_element **set_list,
 293                                       struct cmd_list_element **show_list);
 294
 295 extern struct cmd_list_element *deprecated_add_show_from_set (struct cmd_list_element *,
 296                                                               struct cmd_list_element **);
 297
 298 /* Do a "show" command for each thing on a command list.  */
 299
 300 extern void cmd_show_list (struct cmd_list_element *, int, char *);
 301
 302 extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
 303
 304 extern void dont_repeat (void);
 305
 306 /* Used to mark commands that don't do anything.  If we just leave the
 307    function field NULL, the command is interpreted as a help topic, or
 308    as a class of commands.  */
 309
 310 extern void not_just_help_class_command (char *, int);
 311
 312 /* check function pointer */
 313 extern int cmd_func_p (struct cmd_list_element *cmd);
 314
 315 /* call the command function */
 316 extern void cmd_func (struct cmd_list_element *cmd, char *args, int from_tty);
 317
 318 #endif /* !defined (COMMAND_H) */