gdb/cli/cli-decode.h

   1 /* Header file for GDB command decoding library.
   2
   3    Copyright (c) 2000, 2003, 2007-2012 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 /* This flag is used by the code executing commands to warn the user
  48    the first time a deprecated command is used, see the 'flags' field
  49    in the following struct.
  50 */
  51 #define CMD_DEPRECATED            0x1
  52 #define DEPRECATED_WARN_USER      0x2
  53 #define MALLOCED_REPLACEMENT      0x4
  54
  55 struct cmd_list_element
  56   {
  57     /* Points to next command in this list.  */
  58     struct cmd_list_element *next;
  59
  60     /* Name of this command.  */
  61     char *name;
  62
  63     /* Command class; class values are chosen by application program.  */
  64     enum command_class class;
  65
  66     /* Function definition of this command.  NULL for command class
  67        names and for help topics that are not really commands.  NOTE:
  68        cagney/2002-02-02: This function signature is evolving.  For
  69        the moment suggest sticking with either set_cmd_cfunc() or
  70        set_cmd_sfunc().  */
  71     void (*func) (struct cmd_list_element *c, char *args, int from_tty);
  72     /* The command's real callback.  At present func() bounces through
  73        to one of the below.  */
  74     union
  75       {
  76         /* If type is not_set_cmd, call it like this: */
  77         cmd_cfunc_ftype *cfunc;
  78         /* If type is set_cmd or show_cmd, first set the variables,
  79            and then call this: */
  80         cmd_sfunc_ftype *sfunc;
  81       }
  82     function;
  83
  84     /* Local state (context) for this command.  This can be anything.  */
  85     void *context;
  86
  87     /* Documentation of this command (or help topic).
  88        First line is brief documentation; remaining lines form, with it,
  89        the full documentation.  First line should end with a period.
  90        Entire string should also end with a period, not a newline.  */
  91     char *doc;
  92
  93     /* For set/show commands.  A method for printing the output to the
  94        specified stream.  */
  95     show_value_ftype *show_value_func;
  96
  97     /* flags : a bitfield
  98
  99        bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
 100        is deprecated.  It may be removed from gdb's command set in the
 101        future.
 102
 103        bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
 104        this is a deprecated command.  The user should only be warned
 105        the first time a command is used.
 106
 107        bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
 108        compile time (this is the way it should, in general, be done)
 109        the memory containing the replacement string is statically
 110        allocated.  In some cases it makes sense to deprecate commands
 111        at runtime (the testsuite is one example).  In this case the
 112        memory for replacement is malloc'ed.  When a command is
 113        undeprecated or re-deprecated at runtime we don't want to risk
 114        calling free on statically allocated memory, so we check this
 115        flag.  */
 116
 117     int flags;
 118
 119     /* If this command is deprecated, this is the replacement name.  */
 120     char *replacement;
 121
 122     /* If this command represents a show command, then this function
 123        is called before the variable's value is examined.  */
 124     void (*pre_show_hook) (struct cmd_list_element *c);
 125
 126     /* Hook for another command to be executed before this command.  */
 127     struct cmd_list_element *hook_pre;
 128
 129     /* Hook for another command to be executed after this command.  */
 130     struct cmd_list_element *hook_post;
 131
 132     /* Flag that specifies if this command is already running its hook.  */
 133     /* Prevents the possibility of hook recursion.  */
 134     int hook_in;
 135
 136     /* Nonzero identifies a prefix command.  For them, the address
 137        of the variable containing the list of subcommands.  */
 138     struct cmd_list_element **prefixlist;
 139
 140     /* For prefix commands only:
 141        String containing prefix commands to get here: this one
 142        plus any others needed to get to it.  Should end in a space.
 143        It is used before the word "command" in describing the
 144        commands reached through this prefix.  */
 145     char *prefixname;
 146
 147     /* For prefix commands only:
 148        nonzero means do not get an error if subcommand is not
 149        recognized; call the prefix's own function in that case.  */
 150     char allow_unknown;
 151
 152     /* Nonzero says this is an abbreviation, and should not
 153        be mentioned in lists of commands.
 154        This allows "br<tab>" to complete to "break", which it
 155        otherwise wouldn't.  */
 156     char abbrev_flag;
 157
 158     /* Completion routine for this command.  TEXT is the text beyond
 159        what was matched for the command itself (leading whitespace is
 160        skipped).  It stops where we are supposed to stop completing
 161        (rl_point) and is '\0' terminated.
 162
 163        Return value is a malloc'd vector of pointers to possible
 164        completions terminated with NULL.  If there are no completions,
 165        returning a pointer to a NULL would work but returning NULL
 166        itself is also valid.  WORD points in the same buffer as TEXT,
 167        and completions should be returned relative to this position.
 168        For example, suppose TEXT is "foo" and we want to complete to
 169        "foobar".  If WORD is "oo", return "oobar"; if WORD is
 170        "baz/foo", return "baz/foobar".  */
 171     completer_ftype *completer;
 172
 173     /* Destruction routine for this command.  If non-NULL, this is
 174        called when this command instance is destroyed.  This may be
 175        used to finalize the CONTEXT field, if needed.  */
 176     void (*destroyer) (struct cmd_list_element *self, void *context);
 177
 178     /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
 179        or "show").  */
 180     cmd_types type;
 181
 182     /* Pointer to variable affected by "set" and "show".  Doesn't
 183        matter if type is not_set.  */
 184     void *var;
 185
 186     /* What kind of variable is *VAR?  */
 187     var_types var_type;
 188
 189     /* Pointer to NULL terminated list of enumerated values (like
 190        argv).  */
 191     const char *const *enums;
 192
 193     /* Pointer to command strings of user-defined commands */
 194     struct command_line *user_commands;
 195
 196     /* Pointer to command that is hooked by this one, (by hook_pre)
 197        so the hook can be removed when this one is deleted.  */
 198     struct cmd_list_element *hookee_pre;
 199
 200     /* Pointer to command that is hooked by this one, (by hook_post)
 201        so the hook can be removed when this one is deleted.  */
 202     struct cmd_list_element *hookee_post;
 203
 204     /* Pointer to command that is aliased by this one, so the
 205        aliased command can be located in case it has been hooked.  */
 206     struct cmd_list_element *cmd_pointer;
 207
 208     /* Start of a linked list of all aliases of this command.  */
 209     struct cmd_list_element *aliases;
 210
 211     /* Link pointer for aliases on an alias list.  */
 212     struct cmd_list_element *alias_chain;
 213   };
 214
 215 extern void help_cmd_list (struct cmd_list_element *, enum command_class,
 216                            char *, int, struct ui_file *);
 217
 218 /* Functions that implement commands about CLI commands.  */
 219
 220 extern void help_cmd (char *, struct ui_file *);
 221
 222 extern void apropos_cmd (struct ui_file *, struct cmd_list_element *,
 223                          struct re_pattern_buffer *, char *);
 224
 225 /* Used to mark commands that don't do anything.  If we just leave the
 226    function field NULL, the command is interpreted as a help topic, or
 227    as a class of commands.  */
 228
 229 extern void not_just_help_class_command (char *arg, int from_tty);
 230
 231 /* Exported to cli/cli-setshow.c */
 232
 233 extern void print_doc_line (struct ui_file *, char *);
 234
 235
 236 #endif /* !defined (CLI_DECODE_H) */