2009-07-11 Hui Zhu <teawater@gmail.com>

[deliverable/binutils-gdb.git] / gdb / varobj.h

diff --git a/gdb/varobj.h b/gdb/varobj.h
index 28c5fac4d16b4cc3e81148fa79879d567a612b14..c1ad09904f7415c26774b497b828d59a5a4643c1 100644 (file)
--- a/gdb/varobj.h
+++ b/gdb/varobj.h
@@ -1,9 +1,10 @@
 /* GDB variable objects API.
-   Copyright 1999 Free Software Foundation, Inc.
+   Copyright (C) 1999, 2000, 2001, 2005, 2007, 2008, 2009
+   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,14 @@
    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/>.  */
 
 #ifndef VAROBJ_H
 #define VAROBJ_H 1
 
 #include "symtab.h"
 #include "gdbtypes.h"
+#include "vec.h"
 
 /* Enumeration for the format types */
 enum varobj_display_formats
@@ -32,6 +32,23 @@ enum varobj_display_formats
     FORMAT_OCTAL               /* Octal display                     */
   };
 
+enum varobj_type
+  {
+    USE_SPECIFIED_FRAME,        /* Use the frame passed to varobj_create */
+    USE_CURRENT_FRAME,          /* Use the current frame */
+    USE_SELECTED_FRAME          /* Always reevaluate in selected frame */
+  };
+
+/* Enumerator describing if a variable object is in scope.  */
+enum varobj_scope_status
+  {
+    VAROBJ_IN_SCOPE = 0,        /* Varobj is scope, value available.  */
+    VAROBJ_NOT_IN_SCOPE = 1,    /* Varobj is not in scope, value not available, 
+                                  but varobj can become in scope later.  */
+    VAROBJ_INVALID = 2,         /* Varobj no longer has any value, and never
+                                  will.  */
+  };
+
 /* String representations of gdb's format codes (defined in varobj.c) */
 extern char *varobj_format_string[];
 
@@ -47,10 +64,29 @@ extern char *varobj_language_string[];
 /* Struct thar describes a variable object instance */
 struct varobj;
 
+typedef struct varobj *varobj_p;
+DEF_VEC_P (varobj_p);
+
+typedef struct varobj_update_result_t
+{
+  struct varobj *varobj;
+  int type_changed;
+  int children_changed;
+  int changed;
+  enum varobj_scope_status status;
+  /* This variable is used internally by varobj_update to indicate if the
+     new value of varobj is already computed and installed, or has to
+     be yet installed.  Don't use this outside varobj.c */
+  int value_installed;  
+} varobj_update_result;
+
+DEF_VEC_O (varobj_update_result);
+
 /* API functions */
 
 extern struct varobj *varobj_create (char *objname,
-                                    char *expression, CORE_ADDR frame);
+                                    char *expression, CORE_ADDR frame,
+                                    enum varobj_type type);
 
 extern char *varobj_gen_name (void);
 
@@ -70,23 +106,48 @@ extern enum varobj_display_formats varobj_set_display_format (
 extern enum varobj_display_formats varobj_get_display_format (
                                                        struct varobj *var);
 
+extern int varobj_get_thread_id (struct varobj *var);
+
+extern void varobj_set_frozen (struct varobj *var, int frozen);
+
+extern int varobj_get_frozen (struct varobj *var);
+
+extern char *varobj_get_display_hint (struct varobj *var);
+
 extern int varobj_get_num_children (struct varobj *var);
 
-extern int varobj_list_children (struct varobj *var,
-                                struct varobj ***childlist);
+/* Return the list of children of VAR.  The returned vector
+   should not be modified in any way.  */
+extern VEC (varobj_p)* varobj_list_children (struct varobj *var);
 
 extern char *varobj_get_type (struct varobj *var);
 
+extern struct type *varobj_get_gdb_type (struct varobj *var);
+
+extern char *varobj_get_path_expr (struct varobj *var);
+
 extern enum varobj_languages varobj_get_language (struct varobj *var);
 
 extern int varobj_get_attributes (struct varobj *var);
 
+extern char *varobj_get_formatted_value (struct varobj *var,
+                                        enum varobj_display_formats format);
+
 extern char *varobj_get_value (struct varobj *var);
 
 extern int varobj_set_value (struct varobj *var, char *expression);
 
 extern int varobj_list (struct varobj ***rootlist);
 
-extern int varobj_update (struct varobj *var, struct varobj ***changelist);
+extern VEC(varobj_update_result) *varobj_update (struct varobj **varp, 
+                                                int explicit);
+
+extern void varobj_invalidate (void);
+
+extern int varobj_editable_p (struct varobj *var);
+
+extern int varobj_floating_p (struct varobj *var);
+
+extern void varobj_set_visualizer (struct varobj *var, const char *visualizer);
 
 #endif /* VAROBJ_H */