X-Git-Url: http://drtracing.org/?a=blobdiff_plain;f=gdb%2Fcommand.h;h=bdf625b5cfb2463283faea276b2eb1544d3c9057;hb=5e7cf0784c9b543b1870b974a78244c40105c523;hp=469df9f8cb97b426ee96bb68478c9c63a043f7b7;hpb=dee8b1a1c52bb43245e6b0ac2958ea6de4f6ba29;p=deliverable%2Fbinutils-gdb.git

diff --git a/gdb/command.h b/gdb/command.h
index 469df9f8cb..bdf625b5cf 100644
--- a/gdb/command.h
+++ b/gdb/command.h
@@ -1,9 +1,10 @@
-/* Header file for command-reading library command.c.
-   Copyright (C) 1986, 1989, 1990, 2000 Free Software Foundation, Inc.
+/* Header file for command creation.
+
+   Copyright (C) 1986-2015 Free Software Foundation, Inc.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
@@ -12,15 +13,19 @@
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #if !defined (COMMAND_H)
 #define COMMAND_H 1
 
-/* Command classes are top-level categories into which commands are broken
-   down for "help" purposes.  
+#include "gdb_vecs.h"
+
+/* This file defines the public interface for any code wanting to
+   create commands.  */
+
+/* Command classes are top-level categories into which commands are
+   broken down for "help" purposes.
+
    Notes on classes: class_alias is for alias commands which are not
    abbreviations of the original command.  class-pseudo is for
    commands which are not really commands nor help topics ("stop").  */
@@ -28,14 +33,18 @@
 enum command_class
 {
   /* Special args to help_list */
-  class_deprecated, all_classes = -2, all_commands = -1,
+  class_deprecated = -3, all_classes = -2, all_commands = -1,
   /* Classes of commands */
-  no_class = -1, class_run = 0, class_vars, class_stack,
-  class_files, class_support, class_info, class_breakpoint, class_trace,
-  class_alias, class_obscure, class_user, class_maintenance,
-  class_pseudo, class_tui, class_xdb
+  no_class = -1, class_run = 0, class_vars, class_stack, class_files,
+  class_support, class_info, class_breakpoint, class_trace,
+  class_alias, class_bookmark, class_obscure, class_maintenance,
+  class_pseudo, class_tui, class_user, class_xdb,
+  no_set_class	/* Used for "show" commands that have no corresponding
+		   "set" command.  */
 };
 
+/* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
+   cmd_types'' can be moved from "command.h" to "cli-decode.h".  */
 /* Not a set/show command.  Note that some commands which begin with
    "set" or "show" might be in this category, if their syntax does
    not fall into one of the following categories.  */
@@ -53,275 +62,349 @@ typedef enum var_types
     /* "on" or "off".  *VAR is an integer which is nonzero for on,
        zero for off.  */
     var_boolean,
-    /* Unsigned Integer.  *VAR is an unsigned int.  The user can type 0
-       to mean "unlimited", which is stored in *VAR as UINT_MAX.  */
+
+    /* "on" / "true" / "enable" or "off" / "false" / "disable" or
+       "auto.  *VAR is an ``enum auto_boolean''.  NOTE: In general a
+       custom show command will need to be implemented - one that for
+       "auto" prints both the "auto" and the current auto-selected
+       value.  */
+    var_auto_boolean,
+
+    /* Unsigned Integer.  *VAR is an unsigned int.  The user can type
+       0 to mean "unlimited", which is stored in *VAR as UINT_MAX.  */
     var_uinteger,
 
-    /* Like var_uinteger but signed.  *VAR is an int.  The user can type 0
-       to mean "unlimited", which is stored in *VAR as INT_MAX.  */
+    /* Like var_uinteger but signed.  *VAR is an int.  The user can
+       type 0 to mean "unlimited", which is stored in *VAR as
+       INT_MAX.  The only remaining use of it is the Python API.
+       Don't use it elsewhere.  */
     var_integer,
 
-    /* String which the user enters with escapes (e.g. the user types \n and
-       it is a real newline in the stored string).
+    /* String which the user enters with escapes (e.g. the user types
+       \n and it is a real newline in the stored string).
        *VAR is a malloc'd string, or NULL if the string is empty.  */
     var_string,
     /* String which stores what the user types verbatim.
        *VAR is a malloc'd string, or NULL if the string is empty.  */
     var_string_noescape,
-    /* String which stores a filename.
-       *VAR is a malloc'd string, or NULL if the string is empty.  */
+    /* String which stores a filename.  (*VAR) is a malloc'd string,
+       or "" if the string was empty.  */
+    var_optional_filename,
+    /* String which stores a filename.  (*VAR) is a malloc'd
+       string.  */
     var_filename,
-    /* ZeroableInteger.  *VAR is an int.  Like Unsigned Integer except
+    /* ZeroableInteger.  *VAR is an int.  Like var_integer except
        that zero really means zero.  */
     var_zinteger,
-    /* Enumerated type.  Can only have one of the specified values.  *VAR is a
-       char pointer to the name of the element that we find.  */
+    /* ZeroableUnsignedInteger.  *VAR is an unsigned int.  Zero really
+       means zero.  */
+    var_zuinteger,
+    /* ZeroableUnsignedInteger with unlimited value.  *VAR is an int,
+       but its range is [0, INT_MAX].  -1 stands for unlimited and
+       other negative numbers are not allowed.  */
+    var_zuinteger_unlimited,
+    /* Enumerated type.  Can only have one of the specified values.
+       *VAR is a char pointer to the name of the element that we
+       find.  */
     var_enum
   }
 var_types;
 
 /* This structure records one command'd definition.  */
+struct cmd_list_element;
 
+typedef void cmd_cfunc_ftype (char *args, int from_tty);
 
-/* This flag is used by the code executing commands to warn the user 
-   the first time a deprecated command is used, see the 'flags' field in
-   the following struct.
-*/
-#define CMD_DEPRECATED            0x1
-#define DEPRECATED_WARN_USER      0x2
-#define MALLOCED_REPLACEMENT      0x4
+/* Forward-declarations of the entry-points of cli/cli-decode.c.  */
 
-struct cmd_list_element
-  {
-    /* Points to next command in this list.  */
-    struct cmd_list_element *next;
-
-    /* Name of this command.  */
-    char *name;
-
-    /* Command class; class values are chosen by application program.  */
-    enum command_class class;
-
-    /* Function definition of this command.
-       NO_FUNCTION for command class names and for help topics that
-       are not really commands.  */
-    union
-      {
-	/* If type is not_set_cmd, call it like this:  */
-	void (*cfunc) (char *args, int from_tty);
-
-	/* If type is cmd_set or show_cmd, first set the variables, and
-	   then call this.  */
-	void (*sfunc) (char *args, int from_tty, struct cmd_list_element * c);
-      }
-    function;
-#define NO_FUNCTION ((void (*) (char *args, int from_tty)) 0)
-
-    /* Documentation of this command (or help topic).
-       First line is brief documentation; remaining lines form, with it,
-       the full documentation.  First line should end with a period.
-       Entire string should also end with a period, not a newline.  */
-    char *doc;
-
-    /* flags : a bitfield 
-       
-       bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
-       is deprecated. It may be removed from gdb's command set in the
-       future.
-
-       bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
-       this is a deprecated command.  The user should only be warned
-       the first time a command is used.
-        
-       bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
-       compile time (this is the way it should, in general, be done)
-       the memory containing the replacement string is statically
-       allocated.  In some cases it makes sense to deprecate commands
-       at runtime (the testsuite is one example).  In this case the
-       memory for replacement is malloc'ed.  When a command is
-       undeprecated or re-deprecated at runtime we don't want to risk
-       calling free on statically allocated memory, so we check this
-       flag.  
-     */
-    int flags;
-
-    /* if this command is deprecated, this is the replacement name */
-    char *replacement;
-
-    /* Hook for another command to be executed before this command.  */
-    struct cmd_list_element *hook;
-
-    /* Nonzero identifies a prefix command.  For them, the address
-       of the variable containing the list of subcommands.  */
-    struct cmd_list_element **prefixlist;
-
-    /* For prefix commands only:
-       String containing prefix commands to get here: this one
-       plus any others needed to get to it.  Should end in a space.
-       It is used before the word "command" in describing the
-       commands reached through this prefix.  */
-    char *prefixname;
-
-    /* For prefix commands only:
-       nonzero means do not get an error if subcommand is not
-       recognized; call the prefix's own function in that case.  */
-    char allow_unknown;
-
-    /* Nonzero says this is an abbreviation, and should not
-       be mentioned in lists of commands.
-       This allows "br<tab>" to complete to "break", which it
-       otherwise wouldn't.  */
-    char abbrev_flag;
-
-    /* Completion routine for this command.  TEXT is the text beyond
-       what was matched for the command itself (leading whitespace is
-       skipped).  It stops where we are supposed to stop completing
-       (rl_point) and is '\0' terminated.
-
-       Return value is a malloc'd vector of pointers to possible completions
-       terminated with NULL.  If there are no completions, returning a pointer
-       to a NULL would work but returning NULL itself is also valid.
-       WORD points in the same buffer as TEXT, and completions should be
-       returned relative to this position.  For example, suppose TEXT is "foo"
-       and we want to complete to "foobar".  If WORD is "oo", return
-       "oobar"; if WORD is "baz/foo", return "baz/foobar".  */
-    char **(*completer) (char *text, char *word);
-
-    /* Type of "set" or "show" command (or SET_NOT_SET if not "set"
-       or "show").  */
-    cmd_types type;
-
-    /* Pointer to variable affected by "set" and "show".  Doesn't matter
-       if type is not_set.  */
-    void *var;
-
-    /* What kind of variable is *VAR?  */
-    var_types var_type;
-
-    /* Pointer to NULL terminated list of enumerated values (like argv).  */
-    const char **enums;
-
-    /* Pointer to command strings of user-defined commands */
-    struct command_line *user_commands;
-
-    /* Pointer to command that is hooked by this one,
-       so the hook can be removed when this one is deleted.  */
-    struct cmd_list_element *hookee;
-
-    /* Pointer to command that is aliased by this one, so the
-       aliased command can be located in case it has been hooked.  */
-    struct cmd_list_element *cmd_pointer;
-  };
-
-/* Forward-declarations of the entry-points of command.c.  */
-
-extern struct cmd_list_element *add_cmd (char *, enum command_class,
-					 void (*fun) (char *, int), char *,
+/* API to the manipulation of command lists.  */
+
+extern int valid_user_defined_cmd_name_p (const char *name);
+
+extern struct cmd_list_element *add_cmd (const char *, enum command_class,
+					 cmd_cfunc_ftype *fun,
+					 const char *,
 					 struct cmd_list_element **);
 
-extern struct cmd_list_element *add_alias_cmd (char *, char *,
+extern struct cmd_list_element *add_alias_cmd (const char *, const char *,
 					       enum command_class, int,
 					       struct cmd_list_element **);
 
-extern struct cmd_list_element *add_prefix_cmd (char *, enum command_class,
-						void (*fun) (char *, int),
-						char *,
+extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class,
+						cmd_cfunc_ftype *fun,
+						const char *,
 						struct cmd_list_element **,
-						char *, int,
+						const char *, int,
 						struct cmd_list_element **);
 
-extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
+extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *,
 						       enum command_class,
-						       void (*fun) (char *,
-								    int),
-						       char *,
+						       cmd_cfunc_ftype *fun,
+						       const char *,
 						       struct cmd_list_element
-						       **, char *, int,
+						       **, const char *, int,
 						       struct cmd_list_element
 						       **);
 
-extern struct cmd_list_element *lookup_cmd (char **,
+/* Set the commands corresponding callback.  */
+
+extern void set_cmd_cfunc (struct cmd_list_element *cmd,
+			   cmd_cfunc_ftype *cfunc);
+
+typedef void cmd_sfunc_ftype (char *args, int from_tty,
+			      struct cmd_list_element *c);
+extern void set_cmd_sfunc (struct cmd_list_element *cmd,
+			   cmd_sfunc_ftype *sfunc);
+
+typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *,
+					 const char *, const char *);
+
+typedef void completer_ftype_void (struct cmd_list_element *,
+				   const char *, const char *);
+
+extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *);
+
+/* Set the completer_handle_brkchars callback.  */
+
+extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *,
+					       completer_ftype_void *);
+
+/* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
+   around in cmd objects to test the value of the commands sfunc().  */
+extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
+			 cmd_cfunc_ftype *cfun);
+
+/* Each command object has a local context attached to it.  */
+extern void set_cmd_context (struct cmd_list_element *cmd,
+			     void *context);
+extern void *get_cmd_context (struct cmd_list_element *cmd);
+
+
+/* Execute CMD's pre/post hook.  Throw an error if the command fails.
+   If already executing this pre/post hook, or there is no pre/post
+   hook, the call is silently ignored.  */
+extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
+extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
+
+/* Return the type of the command.  */
+extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
+
+/* Flag for an ambiguous cmd_list result.  */
+#define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
+
+extern struct cmd_list_element *lookup_cmd (const char **,
 					    struct cmd_list_element *, char *,
 					    int, int);
 
-extern struct cmd_list_element *lookup_cmd_1 (char **,
+extern struct cmd_list_element *lookup_cmd_1 (const char **,
 					      struct cmd_list_element *,
 					      struct cmd_list_element **,
 					      int);
 
-extern struct cmd_list_element *
-  deprecate_cmd (struct cmd_list_element *, char * );
+extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
+					       const char * );
 
-extern void
-  deprecated_cmd_warning (char **);
+extern void deprecated_cmd_warning (const char *);
 
-extern int
-  lookup_cmd_composition (char *text,
-                        struct cmd_list_element **alias,
-                        struct cmd_list_element **prefix_cmd,
-                        struct cmd_list_element **cmd);
+extern int lookup_cmd_composition (const char *text,
+				   struct cmd_list_element **alias,
+				   struct cmd_list_element **prefix_cmd,
+				   struct cmd_list_element **cmd);
 
-extern struct cmd_list_element *add_com (char *, enum command_class,
-					 void (*fun) (char *, int), char *);
+extern struct cmd_list_element *add_com (const char *, enum command_class,
+					 cmd_cfunc_ftype *fun,
+					 const char *);
 
-extern struct cmd_list_element *add_com_alias (char *, char *,
+extern struct cmd_list_element *add_com_alias (const char *, const char *,
 					       enum command_class, int);
 
-extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
-					  char *);
+extern struct cmd_list_element *add_info (const char *,
+					  cmd_cfunc_ftype *fun,
+					  const char *);
 
-extern struct cmd_list_element *add_info_alias (char *, char *, int);
+extern struct cmd_list_element *add_info_alias (const char *, const char *,
+						int);
 
-extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
+extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *,
+					    const char *, const char *, int);
 
-extern char **complete_on_enum (const char *enumlist[], char *, char *);
+extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist,
+					 const char *, const char *);
 
-extern void delete_cmd (char *, struct cmd_list_element **);
+/* Functions that implement commands about CLI commands.  */
 
-extern void help_cmd (char *, struct ui_file *);
-
-extern void help_list (struct cmd_list_element *, char *,
+extern void help_list (struct cmd_list_element *, const char *,
 		       enum command_class, struct ui_file *);
 
-extern void help_cmd_list (struct cmd_list_element *, enum command_class,
-			   char *, int, struct ui_file *);
-
-extern struct cmd_list_element *add_set_cmd (char *name, enum
-					     command_class class,
-					     var_types var_type, void *var,
-					     char *doc,
-					     struct cmd_list_element **list);
+/* Method for show a set/show variable's VALUE on FILE.  If this
+   method isn't supplied deprecated_show_value_hack() is called (which
+   is not good).  */
+typedef void (show_value_ftype) (struct ui_file *file,
+				 int from_tty,
+				 struct cmd_list_element *cmd,
+				 const char *value);
+/* NOTE: i18n: This function is not i18n friendly.  Callers should
+   instead print the value out directly.  */
+extern show_value_ftype deprecated_show_value_hack;
+
+extern void add_setshow_enum_cmd (const char *name,
+				  enum command_class theclass,
+				  const char *const *enumlist,
+				  const char **var,
+				  const char *set_doc,
+				  const char *show_doc,
+				  const char *help_doc,
+				  cmd_sfunc_ftype *set_func,
+				  show_value_ftype *show_func,
+				  struct cmd_list_element **set_list,
+				  struct cmd_list_element **show_list);
+
+extern void add_setshow_auto_boolean_cmd (const char *name,
+					  enum command_class theclass,
+					  enum auto_boolean *var,
+					  const char *set_doc,
+					  const char *show_doc,
+					  const char *help_doc,
+					  cmd_sfunc_ftype *set_func,
+					  show_value_ftype *show_func,
+					  struct cmd_list_element **set_list,
+					  struct cmd_list_element **show_list);
+
+extern void add_setshow_boolean_cmd (const char *name,
+				     enum command_class theclass,
+				     int *var,
+				     const char *set_doc, const char *show_doc,
+				     const char *help_doc,
+				     cmd_sfunc_ftype *set_func,
+				     show_value_ftype *show_func,
+				     struct cmd_list_element **set_list,
+				     struct cmd_list_element **show_list);
+
+extern void add_setshow_filename_cmd (const char *name,
+				      enum command_class theclass,
+				      char **var,
+				      const char *set_doc,
+				      const char *show_doc,
+				      const char *help_doc,
+				      cmd_sfunc_ftype *set_func,
+				      show_value_ftype *show_func,
+				      struct cmd_list_element **set_list,
+				      struct cmd_list_element **show_list);
+
+extern void add_setshow_string_cmd (const char *name,
+				    enum command_class theclass,
+				    char **var,
+				    const char *set_doc,
+				    const char *show_doc,
+				    const char *help_doc,
+				    cmd_sfunc_ftype *set_func,
+				    show_value_ftype *show_func,
+				    struct cmd_list_element **set_list,
+				    struct cmd_list_element **show_list);
+
+extern struct cmd_list_element *add_setshow_string_noescape_cmd
+		      (const char *name,
+		       enum command_class theclass,
+		       char **var,
+		       const char *set_doc,
+		       const char *show_doc,
+		       const char *help_doc,
+		       cmd_sfunc_ftype *set_func,
+		       show_value_ftype *show_func,
+		       struct cmd_list_element **set_list,
+		       struct cmd_list_element **show_list);
+
+extern void add_setshow_optional_filename_cmd (const char *name,
+					       enum command_class theclass,
+					       char **var,
+					       const char *set_doc,
+					       const char *show_doc,
+					       const char *help_doc,
+					       cmd_sfunc_ftype *set_func,
+					       show_value_ftype *show_func,
+					       struct cmd_list_element **set_list,
+					       struct cmd_list_element **show_list);
+
+extern void add_setshow_integer_cmd (const char *name,
+				     enum command_class theclass,
+				     int *var,
+				     const char *set_doc,
+				     const char *show_doc,
+				     const char *help_doc,
+				     cmd_sfunc_ftype *set_func,
+				     show_value_ftype *show_func,
+				     struct cmd_list_element **set_list,
+				     struct cmd_list_element **show_list);
+
+extern void add_setshow_uinteger_cmd (const char *name,
+				      enum command_class theclass,
+				      unsigned int *var,
+				      const char *set_doc,
+				      const char *show_doc,
+				      const char *help_doc,
+				      cmd_sfunc_ftype *set_func,
+				      show_value_ftype *show_func,
+				      struct cmd_list_element **set_list,
+				      struct cmd_list_element **show_list);
+
+extern void add_setshow_zinteger_cmd (const char *name,
+				      enum command_class theclass,
+				      int *var,
+				      const char *set_doc,
+				      const char *show_doc,
+				      const char *help_doc,
+				      cmd_sfunc_ftype *set_func,
+				      show_value_ftype *show_func,
+				      struct cmd_list_element **set_list,
+				      struct cmd_list_element **show_list);
+
+extern void add_setshow_zuinteger_cmd (const char *name,
+				       enum command_class theclass,
+				       unsigned int *var,
+				       const char *set_doc,
+				       const char *show_doc,
+				       const char *help_doc,
+				       cmd_sfunc_ftype *set_func,
+				       show_value_ftype *show_func,
+				       struct cmd_list_element **set_list,
+				       struct cmd_list_element **show_list);
 
-extern struct cmd_list_element *add_set_enum_cmd (char *name,
-						  enum command_class class,
-						  const char *enumlist[],
-						  const char **var,
-						  char *doc,
-						  struct cmd_list_element **list);
-
-extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *,
-						   struct cmd_list_element
-						   **);
-
-/* Do a "set" or "show" command.  ARG is NULL if no argument, or the text
-   of the argument, and FROM_TTY is nonzero if this command is being entered
-   directly by the user (i.e. these are just like any other
-   command).  C is the command list element for the command.  */
-
-extern void do_setshow_command (char *, int, struct cmd_list_element *);
+extern void
+  add_setshow_zuinteger_unlimited_cmd (const char *name,
+				       enum command_class theclass,
+				       int *var,
+				       const char *set_doc,
+				       const char *show_doc,
+				       const char *help_doc,
+				       cmd_sfunc_ftype *set_func,
+				       show_value_ftype *show_func,
+				       struct cmd_list_element **set_list,
+				       struct cmd_list_element **show_list);
 
 /* Do a "show" command for each thing on a command list.  */
 
-extern void cmd_show_list (struct cmd_list_element *, int, char *);
+extern void cmd_show_list (struct cmd_list_element *, int, const char *);
 
-extern void error_no_arg (char *);
+/* Used everywhere whenever at least one parameter is required and
+   none is specified.  */
+
+extern void error_no_arg (const char *) ATTRIBUTE_NORETURN;
 
 extern void dont_repeat (void);
 
+extern struct cleanup *prevent_dont_repeat (void);
+
 /* Used to mark commands that don't do anything.  If we just leave the
    function field NULL, the command is interpreted as a help topic, or
    as a class of commands.  */
 
 extern void not_just_help_class_command (char *, int);
 
+/* Check function pointer.  */
+extern int cmd_func_p (struct cmd_list_element *cmd);
+
+/* Call the command function.  */
+extern void cmd_func (struct cmd_list_element *cmd,
+		      char *args, int from_tty);
+
 #endif /* !defined (COMMAND_H) */