gdb/cli/cli-decode.h

   1 /* Header file for GDB command decoding library.
   2
   3    Copyright (C) 2000-2014 Free Software Foundation, Inc.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #if !defined (CLI_DECODE_H)
  19 #define CLI_DECODE_H 1
  20
  21 /* This file defines the private interfaces for any code implementing
  22    command internals.  */
  23
  24 /* Include the public interfaces.  */
  25 #include "command.h"
  26
  27 struct re_pattern_buffer;
  28
  29 #if 0
  30 /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
  31    cmd_types'' can be moved from "command.h" to "cli-decode.h".  */
  32 /* Not a set/show command.  Note that some commands which begin with
  33    "set" or "show" might be in this category, if their syntax does
  34    not fall into one of the following categories.  */
  35 typedef enum cmd_types
  36   {
  37     not_set_cmd,
  38     set_cmd,
  39     show_cmd
  40   }
  41 cmd_types;
  42 #endif
  43
  44 /* This structure records one command'd definition.  */
  45
  46
  47 struct cmd_list_element
  48   {
  49     /* Points to next command in this list.  */
  50     struct cmd_list_element *next;
  51
  52     /* Name of this command.  */
  53     const char *name;
  54
  55     /* Command class; class values are chosen by application program.  */
  56     enum command_class class;
  57
  58     /* When 1 indicated that this command is deprecated.  It may be
  59        removed from gdb's command set in the future.  */
  60
  61     unsigned int cmd_deprecated : 1;
  62
  63     /* The user needs to be warned that this is a deprecated command.
  64        The user should only be warned the first time a command is
  65        used.  */
  66
  67     unsigned int deprecated_warn_user : 1;
  68
  69     /* When functions are deprecated at compile time (this is the way
  70        it should, in general, be done) the memory containing the
  71        replacement string is statically allocated.  In some cases it
  72        makes sense to deprecate commands at runtime (the testsuite is
  73        one example).  In this case the memory for replacement is
  74        malloc'ed.  When a command is undeprecated or re-deprecated at
  75        runtime we don't want to risk calling free on statically
  76        allocated memory, so we check this flag.  */
  77
  78     unsigned int malloced_replacement : 1;
  79
  80     /* Set if the doc field should be xfree'd.  */
  81
  82     unsigned int doc_allocated : 1;
  83
  84     /* Flag that specifies if this command is already running its hook.  */
  85     /* Prevents the possibility of hook recursion.  */
  86     unsigned int hook_in : 1;
  87
  88     /* For prefix commands only:
  89        nonzero means do not get an error if subcommand is not
  90        recognized; call the prefix's own function in that case.  */
  91     unsigned int allow_unknown : 1;
  92
  93     /* Nonzero says this is an abbreviation, and should not
  94        be mentioned in lists of commands.
  95        This allows "br<tab>" to complete to "break", which it
  96        otherwise wouldn't.  */
  97     unsigned int abbrev_flag : 1;
  98
  99     /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
 100        or "show").  */
 101     ENUM_BITFIELD (cmd_types) type : 2;
 102
 103     /* What kind of variable is *VAR?  */
 104     ENUM_BITFIELD (var_types) var_type : 4;
 105
 106     /* Function definition of this command.  NULL for command class
 107        names and for help topics that are not really commands.  NOTE:
 108        cagney/2002-02-02: This function signature is evolving.  For
 109        the moment suggest sticking with either set_cmd_cfunc() or
 110        set_cmd_sfunc().  */
 111     void (*func) (struct cmd_list_element *c, char *args, int from_tty);
 112     /* The command's real callback.  At present func() bounces through
 113        to one of the below.  */
 114     union
 115       {
 116         /* If type is not_set_cmd, call it like this: */
 117         cmd_cfunc_ftype *cfunc;
 118         /* If type is set_cmd or show_cmd, first set the variables,
 119            and then call this: */
 120         cmd_sfunc_ftype *sfunc;
 121       }
 122     function;
 123
 124     /* Local state (context) for this command.  This can be anything.  */
 125     void *context;
 126
 127     /* Documentation of this command (or help topic).
 128        First line is brief documentation; remaining lines form, with it,
 129        the full documentation.  First line should end with a period.
 130        Entire string should also end with a period, not a newline.  */
 131     char *doc;
 132
 133     /* For set/show commands.  A method for printing the output to the
 134        specified stream.  */
 135     show_value_ftype *show_value_func;
 136
 137     /* If this command is deprecated, this is the replacement name.  */
 138     char *replacement;
 139
 140     /* If this command represents a show command, then this function
 141        is called before the variable's value is examined.  */
 142     void (*pre_show_hook) (struct cmd_list_element *c);
 143
 144     /* Hook for another command to be executed before this command.  */
 145     struct cmd_list_element *hook_pre;
 146
 147     /* Hook for another command to be executed after this command.  */
 148     struct cmd_list_element *hook_post;
 149
 150     /* Nonzero identifies a prefix command.  For them, the address
 151        of the variable containing the list of subcommands.  */
 152     struct cmd_list_element **prefixlist;
 153
 154     /* For prefix commands only:
 155        String containing prefix commands to get here: this one
 156        plus any others needed to get to it.  Should end in a space.
 157        It is used before the word "command" in describing the
 158        commands reached through this prefix.  */
 159     char *prefixname;
 160
 161     /* The prefix command of this command.  */
 162     struct cmd_list_element *prefix;
 163
 164     /* Completion routine for this command.  TEXT is the text beyond
 165        what was matched for the command itself (leading whitespace is
 166        skipped).  It stops where we are supposed to stop completing
 167        (rl_point) and is '\0' terminated.
 168
 169        Return value is a malloc'd vector of pointers to possible
 170        completions terminated with NULL.  If there are no completions,
 171        returning a pointer to a NULL would work but returning NULL
 172        itself is also valid.  WORD points in the same buffer as TEXT,
 173        and completions should be returned relative to this position.
 174        For example, suppose TEXT is "foo" and we want to complete to
 175        "foobar".  If WORD is "oo", return "oobar"; if WORD is
 176        "baz/foo", return "baz/foobar".  */
 177     completer_ftype *completer;
 178
 179     /* Destruction routine for this command.  If non-NULL, this is
 180        called when this command instance is destroyed.  This may be
 181        used to finalize the CONTEXT field, if needed.  */
 182     void (*destroyer) (struct cmd_list_element *self, void *context);
 183
 184     /* Pointer to variable affected by "set" and "show".  Doesn't
 185        matter if type is not_set.  */
 186     void *var;
 187
 188     /* Pointer to NULL terminated list of enumerated values (like
 189        argv).  */
 190     const char *const *enums;
 191
 192     /* Pointer to command strings of user-defined commands */
 193     struct command_line *user_commands;
 194
 195     /* Pointer to command that is hooked by this one, (by hook_pre)
 196        so the hook can be removed when this one is deleted.  */
 197     struct cmd_list_element *hookee_pre;
 198
 199     /* Pointer to command that is hooked by this one, (by hook_post)
 200        so the hook can be removed when this one is deleted.  */
 201     struct cmd_list_element *hookee_post;
 202
 203     /* Pointer to command that is aliased by this one, so the
 204        aliased command can be located in case it has been hooked.  */
 205     struct cmd_list_element *cmd_pointer;
 206
 207     /* Start of a linked list of all aliases of this command.  */
 208     struct cmd_list_element *aliases;
 209
 210     /* Link pointer for aliases on an alias list.  */
 211     struct cmd_list_element *alias_chain;
 212   };
 213
 214 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
 215                            char *, int, struct ui_file *);
 216
 217 /* Functions that implement commands about CLI commands.  */
 218
 219 extern void help_cmd (char *, struct ui_file *);
 220
 221 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
 222                          struct re_pattern_buffer *, char *);
 223
 224 /* Used to mark commands that don't do anything.  If we just leave the
 225    function field NULL, the command is interpreted as a help topic, or
 226    as a class of commands.  */
 227
 228 extern void not_just_help_class_command (char *arg, int from_tty);
 229
 230 /* Exported to cli/cli-setshow.c */
 231
 232 extern void print_doc_line (struct ui_file *, char *);
 233
 234 extern const char * const auto_boolean_enums[];
 235
 236 #endif /* !defined (CLI_DECODE_H) */