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 /* Reasonable values for an AUTO_BOOLEAN variable. */
  55 enum cmd_auto_boolean
  56 {
  57   CMD_AUTO_BOOLEAN_TRUE,
  58   CMD_AUTO_BOOLEAN_FALSE,
  59   CMD_AUTO_BOOLEAN_AUTO
  60 };
  61
  62 /* Types of "set" or "show" command.  */
  63 typedef enum var_types
  64   {
  65     /* "on" or "off".  *VAR is an integer which is nonzero for on,
  66        zero for off.  */
  67     var_boolean,
  68
  69     /* "on" / "true" / "enable" or "off" / "false" / "disable" or
  70        "auto.  *VAR is an ``enum cmd_auto_boolean''.  NOTE: In general
  71        a custom show command will need to be implemented - one that
  72        for "auto" prints both the "auto" and the current auto-selected
  73        value. */
  74     var_auto_boolean,
  75
  76     /* Unsigned Integer.  *VAR is an unsigned int.  The user can type 0
  77        to mean "unlimited", which is stored in *VAR as UINT_MAX.  */
  78     var_uinteger,
  79
  80     /* Like var_uinteger but signed.  *VAR is an int.  The user can type 0
  81        to mean "unlimited", which is stored in *VAR as INT_MAX.  */
  82     var_integer,
  83
  84     /* String which the user enters with escapes (e.g. the user types \n and
  85        it is a real newline in the stored string).
  86        *VAR is a malloc'd string, or NULL if the string is empty.  */
  87     var_string,
  88     /* String which stores what the user types verbatim.
  89        *VAR is a malloc'd string, or NULL if the string is empty.  */
  90     var_string_noescape,
  91     /* String which stores a filename.
  92        *VAR is a malloc'd string, or NULL if the string is empty.  */
  93     var_filename,
  94     /* ZeroableInteger.  *VAR is an int.  Like Unsigned Integer except
  95        that zero really means zero.  */
  96     var_zinteger,
  97     /* Enumerated type.  Can only have one of the specified values.  *VAR is a
  98        char pointer to the name of the element that we find.  */
  99     var_enum
 100   }
 101 var_types;
 102
 103 /* This structure records one command'd definition.  */
 104 struct cmd_list_element;
 105
 106 /* Forward-declarations of the entry-points of cli/cli-decode.c.  */
 107
 108 extern struct cmd_list_element *add_cmd (char *, enum command_class,
 109                                          void (*fun) (char *, int), char *,
 110                                          struct cmd_list_element **);
 111
 112 extern struct cmd_list_element *add_alias_cmd (char *, char *,
 113                                                enum command_class, int,
 114                                                struct cmd_list_element **);
 115
 116 extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
 117                                                 void (*fun) (char *, int),
 118                                                 char *,
 119                                                 struct cmd_list_element **,
 120                                                 char *, int,
 121                                                 struct cmd_list_element **);
 122
 123 extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
 124                                                        enum command_class,
 125                                                        void (*fun) (char *,
 126                                                                     int),
 127                                                        char *,
 128                                                        struct cmd_list_element
 129                                                        **, char *, int,
 130                                                        struct cmd_list_element
 131                                                        **);
 132
 133 /* Set the commands corresponding callback.  */
 134
 135 extern void set_cmd_cfunc (struct cmd_list_element *cmd,
 136                            void (*cfunc) (char *args, int from_tty));
 137
 138 extern void set_cmd_sfunc (struct cmd_list_element *cmd,
 139                            void (*sfunc) (char *args, int from_tty,
 140                                           struct cmd_list_element * c));
 141
 142 extern void set_cmd_completer (struct cmd_list_element *cmd,
 143                                char **(*completer) (char *text, char *word));
 144
 145 /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
 146    around in cmd objects to test the value of the commands sfunc().  */
 147 extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
 148                          void (*cfunc) (char *args, int from_tty));
 149
 150 /* Each command object has a local context attached to it. .  */
 151 extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
 152 extern void *get_cmd_context (struct cmd_list_element *cmd);
 153
 154
 155 /* Execute CMD's pre/post hook.  Throw an error if the command fails.
 156    If already executing this pre/post hook, or there is no pre/post
 157    hook, the call is silently ignored.  */
 158 extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
 159 extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
 160
 161 /* Return the type of the command.  */
 162 /* NOTE: cagney/2002-03-17: The add_show_from_set() function clones
 163    the set command passed as a parameter.  The clone operation will
 164    include (BUG?) any ``set'' command callback, if present.  Commands
 165    like ``info set'' call all the ``show'' command callbacks.
 166    Unfortunatly, for ``show'' commands cloned from ``set'', this
 167    includes callbacks belonging to ``set'' commands.  Making this
 168    worse, this only occures if add_show_from_set() is called after
 169    add_cmd_sfunc() (BUG?).  */
 170 extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
 171
 172
 173 extern struct cmd_list_element *lookup_cmd (char **,
 174                                             struct cmd_list_element *, char *,
 175                                             int, int);
 176
 177 extern struct cmd_list_element *lookup_cmd_1 (char **,
 178                                               struct cmd_list_element *,
 179                                               struct cmd_list_element **,
 180                                               int);
 181
 182 extern struct cmd_list_element *
 183   deprecate_cmd (struct cmd_list_element *, char * );
 184
 185 extern void
 186   deprecated_cmd_warning (char **);
 187
 188 extern int
 189   lookup_cmd_composition (char *text,
 190                         struct cmd_list_element **alias,
 191                         struct cmd_list_element **prefix_cmd,
 192                         struct cmd_list_element **cmd);
 193
 194 extern struct cmd_list_element *add_com (char *, enum command_class,
 195                                          void (*fun) (char *, int), char *);
 196
 197 extern struct cmd_list_element *add_com_alias (char *, char *,
 198                                                enum command_class, int);
 199
 200 extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
 201                                           char *);
 202
 203 extern struct cmd_list_element *add_info_alias (char *, char *, int);
 204
 205 extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
 206
 207 extern char **complete_on_enum (const char *enumlist[], char *, char *);
 208
 209 extern void delete_cmd (char *, struct cmd_list_element **);
 210
 211 extern void help_cmd (char *, struct ui_file *);
 212
 213 extern void help_list (struct cmd_list_element *, char *,
 214                        enum command_class, struct ui_file *);
 215
 216 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
 217                            char *, int, struct ui_file *);
 218
 219 extern struct cmd_list_element *add_set_cmd (char *name, enum
 220                                              command_class class,
 221                                              var_types var_type, void *var,
 222                                              char *doc,
 223                                              struct cmd_list_element **list);
 224
 225 extern struct cmd_list_element *add_set_enum_cmd (char *name,
 226                                                   enum command_class class,
 227                                                   const char *enumlist[],
 228                                                   const char **var,
 229                                                   char *doc,
 230                                                   struct cmd_list_element **list);
 231
 232 extern struct cmd_list_element *add_set_auto_boolean_cmd (char *name,
 233                                                           enum command_class class,
 234                                                           enum cmd_auto_boolean *var,
 235                                                           char *doc,
 236                                                           struct cmd_list_element **list);
 237
 238 extern struct cmd_list_element *add_set_boolean_cmd (char *name,
 239                                                      enum command_class class,
 240                                                      int *var,
 241                                                      char *doc,
 242                                                      struct cmd_list_element **list);
 243
 244 extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *,
 245                                                    struct cmd_list_element
 246                                                    **);
 247
 248 /* Do a "show" command for each thing on a command list.  */
 249
 250 extern void cmd_show_list (struct cmd_list_element *, int, char *);
 251
 252 extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
 253
 254 extern void dont_repeat (void);
 255
 256 /* Used to mark commands that don't do anything.  If we just leave the
 257    function field NULL, the command is interpreted as a help topic, or
 258    as a class of commands.  */
 259
 260 extern void not_just_help_class_command (char *, int);
 261
 262 #endif /* !defined (COMMAND_H) */