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 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 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
 128                            void (*cfunc) (char *args, int from_tty));
 129
 130 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
 131                            void (*sfunc) (char *args, int from_tty,
 132                                           struct cmd_list_element * c));
 133
 134 extern void set_cmd_completer (struct cmd_list_element *cmd,
 135                                char **(*completer) (char *text, char *word));
 136
 137 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
 138    around in cmd objects to test the value of the commands sfunc().  */
 139 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
 140                          void (*cfunc) (char *args, int from_tty));
 141
 142 /* Each command object has a local context attached to it. .  */
 143 extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
 144 extern void *get_cmd_context (struct cmd_list_element *cmd);
 145
 146
 147 /* Execute CMD's pre/post hook.  Throw an error if the command fails.
 148    If already executing this pre/post hook, or there is no pre/post
 149    hook, the call is silently ignored.  */
 150 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
 151 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
 152
 153 /* Return the type of the command.  */
 154 /* NOTE: cagney/2002-03-17: The add_show_from_set() function clones
 155    the set command passed as a parameter.  The clone operation will
 156    include (BUG?) any ``set'' command callback, if present.  Commands
 157    like ``info set'' call all the ``show'' command callbacks.
 158    Unfortunatly, for ``show'' commands cloned from ``set'', this
 159    includes callbacks belonging to ``set'' commands.  Making this
 160    worse, this only occures if add_show_from_set() is called after
 161    add_cmd_sfunc() (BUG?).  */
 162 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
 163
 164
 165 extern struct cmd_list_element *lookup_cmd (char **,
 166                                             struct cmd_list_element *, char *,
 167                                             int, int);
 168
 169 extern struct cmd_list_element *lookup_cmd_1 (char **,
 170                                               struct cmd_list_element *,
 171                                               struct cmd_list_element **,
 172                                               int);
 173
 174 extern struct cmd_list_element *
 175   deprecate_cmd (struct cmd_list_element *, char * );
 176
 177 extern void
 178   deprecated_cmd_warning (char **);
 179
 180 extern int
 181   lookup_cmd_composition (char *text,
 182                         struct cmd_list_element **alias,
 183                         struct cmd_list_element **prefix_cmd,
 184                         struct cmd_list_element **cmd);
 185
 186 extern struct cmd_list_element *add_com (char *, enum command_class,
 187                                          void (*fun) (char *, int), char *);
 188
 189 extern struct cmd_list_element *add_com_alias (char *, char *,
 190                                                enum command_class, int);
 191
 192 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
 193                                           char *);
 194
 195 extern struct cmd_list_element *add_info_alias (char *, char *, int);
 196
 197 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
 198
 199 extern char **complete_on_enum (const char *enumlist[], char *, char *);
 200
 201 extern void delete_cmd (char *, struct cmd_list_element **);
 202
 203 extern void help_cmd (char *, struct ui_file *);
 204
 205 extern void help_list (struct cmd_list_element *, char *,
 206                        enum command_class, struct ui_file *);
 207
 208 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
 209                            char *, int, struct ui_file *);
 210
 211 extern struct cmd_list_element *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 extern struct cmd_list_element *add_set_enum_cmd (char *name,
 218                                                   enum command_class class,
 219                                                   const char *enumlist[],
 220                                                   const char **var,
 221                                                   char *doc,
 222                                                   struct cmd_list_element **list);
 223
 224 extern struct cmd_list_element *add_set_auto_boolean_cmd (char *name,
 225                                                           enum command_class class,
 226                                                           enum auto_boolean *var,
 227                                                           char *doc,
 228                                                           struct cmd_list_element **list);
 229
 230 extern struct cmd_list_element *add_set_boolean_cmd (char *name,
 231                                                      enum command_class class,
 232                                                      int *var,
 233                                                      char *doc,
 234                                                      struct cmd_list_element **list);
 235
 236 extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *,
 237                                                    struct cmd_list_element
 238                                                    **);
 239
 240 /* Do a "show" command for each thing on a command list.  */
 241
 242 extern void cmd_show_list (struct cmd_list_element *, int, char *);
 243
 244 extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
 245
 246 extern void dont_repeat (void);
 247
 248 /* Used to mark commands that don't do anything.  If we just leave the
 249    function field NULL, the command is interpreted as a help topic, or
 250    as a class of commands.  */
 251
 252 extern void not_just_help_class_command (char *, int);
 253
 254 #endif /* !defined (COMMAND_H) */