Home | History | Annotate | Line # | Download | only in gdb
varobj.c revision 1.1.1.2
      1 /* Implementation of the GDB variable objects API.
      2 
      3    Copyright (C) 1999-2015 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 #include "defs.h"
     19 #include "value.h"
     20 #include "expression.h"
     21 #include "frame.h"
     22 #include "language.h"
     23 #include "gdbcmd.h"
     24 #include "block.h"
     25 #include "valprint.h"
     26 #include "gdb_regex.h"
     27 
     28 #include "varobj.h"
     29 #include "vec.h"
     30 #include "gdbthread.h"
     31 #include "inferior.h"
     32 #include "varobj-iter.h"
     33 
     34 #if HAVE_PYTHON
     35 #include "python/python.h"
     36 #include "python/python-internal.h"
     37 #else
     38 typedef int PyObject;
     39 #endif
     40 
     41 /* Non-zero if we want to see trace of varobj level stuff.  */
     42 
     43 unsigned int varobjdebug = 0;
     44 static void
     45 show_varobjdebug (struct ui_file *file, int from_tty,
     46 		  struct cmd_list_element *c, const char *value)
     47 {
     48   fprintf_filtered (file, _("Varobj debugging is %s.\n"), value);
     49 }
     50 
     51 /* String representations of gdb's format codes.  */
     52 char *varobj_format_string[] =
     53   { "natural", "binary", "decimal", "hexadecimal", "octal" };
     54 
     55 /* True if we want to allow Python-based pretty-printing.  */
     56 static int pretty_printing = 0;
     57 
     58 void
     59 varobj_enable_pretty_printing (void)
     60 {
     61   pretty_printing = 1;
     62 }
     63 
     64 /* Data structures */
     65 
     66 /* Every root variable has one of these structures saved in its
     67    varobj.  Members which must be free'd are noted.  */
     68 struct varobj_root
     69 {
     70 
     71   /* Alloc'd expression for this parent.  */
     72   struct expression *exp;
     73 
     74   /* Block for which this expression is valid.  */
     75   const struct block *valid_block;
     76 
     77   /* The frame for this expression.  This field is set iff valid_block is
     78      not NULL.  */
     79   struct frame_id frame;
     80 
     81   /* The thread ID that this varobj_root belong to.  This field
     82      is only valid if valid_block is not NULL.
     83      When not 0, indicates which thread 'frame' belongs to.
     84      When 0, indicates that the thread list was empty when the varobj_root
     85      was created.  */
     86   int thread_id;
     87 
     88   /* If 1, the -var-update always recomputes the value in the
     89      current thread and frame.  Otherwise, variable object is
     90      always updated in the specific scope/thread/frame.  */
     91   int floating;
     92 
     93   /* Flag that indicates validity: set to 0 when this varobj_root refers
     94      to symbols that do not exist anymore.  */
     95   int is_valid;
     96 
     97   /* Language-related operations for this variable and its
     98      children.  */
     99   const struct lang_varobj_ops *lang_ops;
    100 
    101   /* The varobj for this root node.  */
    102   struct varobj *rootvar;
    103 
    104   /* Next root variable */
    105   struct varobj_root *next;
    106 };
    107 
    108 /* Dynamic part of varobj.  */
    109 
    110 struct varobj_dynamic
    111 {
    112   /* Whether the children of this varobj were requested.  This field is
    113      used to decide if dynamic varobj should recompute their children.
    114      In the event that the frontend never asked for the children, we
    115      can avoid that.  */
    116   int children_requested;
    117 
    118   /* The pretty-printer constructor.  If NULL, then the default
    119      pretty-printer will be looked up.  If None, then no
    120      pretty-printer will be installed.  */
    121   PyObject *constructor;
    122 
    123   /* The pretty-printer that has been constructed.  If NULL, then a
    124      new printer object is needed, and one will be constructed.  */
    125   PyObject *pretty_printer;
    126 
    127   /* The iterator returned by the printer's 'children' method, or NULL
    128      if not available.  */
    129   struct varobj_iter *child_iter;
    130 
    131   /* We request one extra item from the iterator, so that we can
    132      report to the caller whether there are more items than we have
    133      already reported.  However, we don't want to install this value
    134      when we read it, because that will mess up future updates.  So,
    135      we stash it here instead.  */
    136   varobj_item *saved_item;
    137 };
    138 
    139 struct cpstack
    140 {
    141   char *name;
    142   struct cpstack *next;
    143 };
    144 
    145 /* A list of varobjs */
    146 
    147 struct vlist
    148 {
    149   struct varobj *var;
    150   struct vlist *next;
    151 };
    152 
    153 /* Private function prototypes */
    154 
    155 /* Helper functions for the above subcommands.  */
    156 
    157 static int delete_variable (struct cpstack **, struct varobj *, int);
    158 
    159 static void delete_variable_1 (struct cpstack **, int *,
    160 			       struct varobj *, int, int);
    161 
    162 static int install_variable (struct varobj *);
    163 
    164 static void uninstall_variable (struct varobj *);
    165 
    166 static struct varobj *create_child (struct varobj *, int, char *);
    167 
    168 static struct varobj *
    169 create_child_with_value (struct varobj *parent, int index,
    170 			 struct varobj_item *item);
    171 
    172 /* Utility routines */
    173 
    174 static struct varobj *new_variable (void);
    175 
    176 static struct varobj *new_root_variable (void);
    177 
    178 static void free_variable (struct varobj *var);
    179 
    180 static struct cleanup *make_cleanup_free_variable (struct varobj *var);
    181 
    182 static enum varobj_display_formats variable_default_display (struct varobj *);
    183 
    184 static void cppush (struct cpstack **pstack, char *name);
    185 
    186 static char *cppop (struct cpstack **pstack);
    187 
    188 static int update_type_if_necessary (struct varobj *var,
    189 				     struct value *new_value);
    190 
    191 static int install_new_value (struct varobj *var, struct value *value,
    192 			      int initial);
    193 
    194 /* Language-specific routines.  */
    195 
    196 static int number_of_children (struct varobj *);
    197 
    198 static char *name_of_variable (struct varobj *);
    199 
    200 static char *name_of_child (struct varobj *, int);
    201 
    202 static struct value *value_of_root (struct varobj **var_handle, int *);
    203 
    204 static struct value *value_of_child (struct varobj *parent, int index);
    205 
    206 static char *my_value_of_variable (struct varobj *var,
    207 				   enum varobj_display_formats format);
    208 
    209 static int is_root_p (struct varobj *var);
    210 
    211 static struct varobj *varobj_add_child (struct varobj *var,
    212 					struct varobj_item *item);
    213 
    214 /* Private data */
    215 
    216 /* Mappings of varobj_display_formats enums to gdb's format codes.  */
    217 static int format_code[] = { 0, 't', 'd', 'x', 'o' };
    218 
    219 /* Header of the list of root variable objects.  */
    220 static struct varobj_root *rootlist;
    221 
    222 /* Prime number indicating the number of buckets in the hash table.  */
    223 /* A prime large enough to avoid too many colisions.  */
    224 #define VAROBJ_TABLE_SIZE 227
    225 
    226 /* Pointer to the varobj hash table (built at run time).  */
    227 static struct vlist **varobj_table;
    228 
    229 
    230 
    232 /* API Implementation */
    233 static int
    234 is_root_p (struct varobj *var)
    235 {
    236   return (var->root->rootvar == var);
    237 }
    238 
    239 #ifdef HAVE_PYTHON
    240 /* Helper function to install a Python environment suitable for
    241    use during operations on VAR.  */
    242 struct cleanup *
    243 varobj_ensure_python_env (struct varobj *var)
    244 {
    245   return ensure_python_env (var->root->exp->gdbarch,
    246 			    var->root->exp->language_defn);
    247 }
    248 #endif
    249 
    250 /* Creates a varobj (not its children).  */
    251 
    252 /* Return the full FRAME which corresponds to the given CORE_ADDR
    253    or NULL if no FRAME on the chain corresponds to CORE_ADDR.  */
    254 
    255 static struct frame_info *
    256 find_frame_addr_in_frame_chain (CORE_ADDR frame_addr)
    257 {
    258   struct frame_info *frame = NULL;
    259 
    260   if (frame_addr == (CORE_ADDR) 0)
    261     return NULL;
    262 
    263   for (frame = get_current_frame ();
    264        frame != NULL;
    265        frame = get_prev_frame (frame))
    266     {
    267       /* The CORE_ADDR we get as argument was parsed from a string GDB
    268 	 output as $fp.  This output got truncated to gdbarch_addr_bit.
    269 	 Truncate the frame base address in the same manner before
    270 	 comparing it against our argument.  */
    271       CORE_ADDR frame_base = get_frame_base_address (frame);
    272       int addr_bit = gdbarch_addr_bit (get_frame_arch (frame));
    273 
    274       if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
    275 	frame_base &= ((CORE_ADDR) 1 << addr_bit) - 1;
    276 
    277       if (frame_base == frame_addr)
    278 	return frame;
    279     }
    280 
    281   return NULL;
    282 }
    283 
    284 struct varobj *
    285 varobj_create (char *objname,
    286 	       char *expression, CORE_ADDR frame, enum varobj_type type)
    287 {
    288   struct varobj *var;
    289   struct cleanup *old_chain;
    290 
    291   /* Fill out a varobj structure for the (root) variable being constructed.  */
    292   var = new_root_variable ();
    293   old_chain = make_cleanup_free_variable (var);
    294 
    295   if (expression != NULL)
    296     {
    297       struct frame_info *fi;
    298       struct frame_id old_id = null_frame_id;
    299       const struct block *block;
    300       const char *p;
    301       struct value *value = NULL;
    302       volatile struct gdb_exception except;
    303       CORE_ADDR pc;
    304 
    305       /* Parse and evaluate the expression, filling in as much of the
    306          variable's data as possible.  */
    307 
    308       if (has_stack_frames ())
    309 	{
    310 	  /* Allow creator to specify context of variable.  */
    311 	  if ((type == USE_CURRENT_FRAME) || (type == USE_SELECTED_FRAME))
    312 	    fi = get_selected_frame (NULL);
    313 	  else
    314 	    /* FIXME: cagney/2002-11-23: This code should be doing a
    315 	       lookup using the frame ID and not just the frame's
    316 	       ``address''.  This, of course, means an interface
    317 	       change.  However, with out that interface change ISAs,
    318 	       such as the ia64 with its two stacks, won't work.
    319 	       Similar goes for the case where there is a frameless
    320 	       function.  */
    321 	    fi = find_frame_addr_in_frame_chain (frame);
    322 	}
    323       else
    324 	fi = NULL;
    325 
    326       /* frame = -2 means always use selected frame.  */
    327       if (type == USE_SELECTED_FRAME)
    328 	var->root->floating = 1;
    329 
    330       pc = 0;
    331       block = NULL;
    332       if (fi != NULL)
    333 	{
    334 	  block = get_frame_block (fi, 0);
    335 	  pc = get_frame_pc (fi);
    336 	}
    337 
    338       p = expression;
    339       innermost_block = NULL;
    340       /* Wrap the call to parse expression, so we can
    341          return a sensible error.  */
    342       TRY_CATCH (except, RETURN_MASK_ERROR)
    343 	{
    344 	  var->root->exp = parse_exp_1 (&p, pc, block, 0);
    345 	}
    346 
    347       if (except.reason < 0)
    348 	{
    349 	  do_cleanups (old_chain);
    350 	  return NULL;
    351 	}
    352 
    353       /* Don't allow variables to be created for types.  */
    354       if (var->root->exp->elts[0].opcode == OP_TYPE
    355 	  || var->root->exp->elts[0].opcode == OP_TYPEOF
    356 	  || var->root->exp->elts[0].opcode == OP_DECLTYPE)
    357 	{
    358 	  do_cleanups (old_chain);
    359 	  fprintf_unfiltered (gdb_stderr, "Attempt to use a type name"
    360 			      " as an expression.\n");
    361 	  return NULL;
    362 	}
    363 
    364       var->format = variable_default_display (var);
    365       var->root->valid_block = innermost_block;
    366       var->name = xstrdup (expression);
    367       /* For a root var, the name and the expr are the same.  */
    368       var->path_expr = xstrdup (expression);
    369 
    370       /* When the frame is different from the current frame,
    371          we must select the appropriate frame before parsing
    372          the expression, otherwise the value will not be current.
    373          Since select_frame is so benign, just call it for all cases.  */
    374       if (innermost_block)
    375 	{
    376 	  /* User could specify explicit FRAME-ADDR which was not found but
    377 	     EXPRESSION is frame specific and we would not be able to evaluate
    378 	     it correctly next time.  With VALID_BLOCK set we must also set
    379 	     FRAME and THREAD_ID.  */
    380 	  if (fi == NULL)
    381 	    error (_("Failed to find the specified frame"));
    382 
    383 	  var->root->frame = get_frame_id (fi);
    384 	  var->root->thread_id = pid_to_thread_id (inferior_ptid);
    385 	  old_id = get_frame_id (get_selected_frame (NULL));
    386 	  select_frame (fi);
    387 	}
    388 
    389       /* We definitely need to catch errors here.
    390          If evaluate_expression succeeds we got the value we wanted.
    391          But if it fails, we still go on with a call to evaluate_type().  */
    392       TRY_CATCH (except, RETURN_MASK_ERROR)
    393 	{
    394 	  value = evaluate_expression (var->root->exp);
    395 	}
    396 
    397       if (except.reason < 0)
    398 	{
    399 	  /* Error getting the value.  Try to at least get the
    400 	     right type.  */
    401 	  struct value *type_only_value = evaluate_type (var->root->exp);
    402 
    403 	  var->type = value_type (type_only_value);
    404 	}
    405 	else
    406 	  {
    407 	    int real_type_found = 0;
    408 
    409 	    var->type = value_actual_type (value, 0, &real_type_found);
    410 	    if (real_type_found)
    411 	      value = value_cast (var->type, value);
    412 	  }
    413 
    414       /* Set language info */
    415       var->root->lang_ops = var->root->exp->language_defn->la_varobj_ops;
    416 
    417       install_new_value (var, value, 1 /* Initial assignment */);
    418 
    419       /* Set ourselves as our root.  */
    420       var->root->rootvar = var;
    421 
    422       /* Reset the selected frame.  */
    423       if (frame_id_p (old_id))
    424 	select_frame (frame_find_by_id (old_id));
    425     }
    426 
    427   /* If the variable object name is null, that means this
    428      is a temporary variable, so don't install it.  */
    429 
    430   if ((var != NULL) && (objname != NULL))
    431     {
    432       var->obj_name = xstrdup (objname);
    433 
    434       /* If a varobj name is duplicated, the install will fail so
    435          we must cleanup.  */
    436       if (!install_variable (var))
    437 	{
    438 	  do_cleanups (old_chain);
    439 	  return NULL;
    440 	}
    441     }
    442 
    443   discard_cleanups (old_chain);
    444   return var;
    445 }
    446 
    447 /* Generates an unique name that can be used for a varobj.  */
    448 
    449 char *
    450 varobj_gen_name (void)
    451 {
    452   static int id = 0;
    453   char *obj_name;
    454 
    455   /* Generate a name for this object.  */
    456   id++;
    457   obj_name = xstrprintf ("var%d", id);
    458 
    459   return obj_name;
    460 }
    461 
    462 /* Given an OBJNAME, returns the pointer to the corresponding varobj.  Call
    463    error if OBJNAME cannot be found.  */
    464 
    465 struct varobj *
    466 varobj_get_handle (char *objname)
    467 {
    468   struct vlist *cv;
    469   const char *chp;
    470   unsigned int index = 0;
    471   unsigned int i = 1;
    472 
    473   for (chp = objname; *chp; chp++)
    474     {
    475       index = (index + (i++ * (unsigned int) *chp)) % VAROBJ_TABLE_SIZE;
    476     }
    477 
    478   cv = *(varobj_table + index);
    479   while ((cv != NULL) && (strcmp (cv->var->obj_name, objname) != 0))
    480     cv = cv->next;
    481 
    482   if (cv == NULL)
    483     error (_("Variable object not found"));
    484 
    485   return cv->var;
    486 }
    487 
    488 /* Given the handle, return the name of the object.  */
    489 
    490 char *
    491 varobj_get_objname (struct varobj *var)
    492 {
    493   return var->obj_name;
    494 }
    495 
    496 /* Given the handle, return the expression represented by the object.  */
    497 
    498 char *
    499 varobj_get_expression (struct varobj *var)
    500 {
    501   return name_of_variable (var);
    502 }
    503 
    504 /* Deletes a varobj and all its children if only_children == 0,
    505    otherwise deletes only the children; returns a malloc'ed list of
    506    all the (malloc'ed) names of the variables that have been deleted
    507    (NULL terminated).  */
    508 
    509 int
    510 varobj_delete (struct varobj *var, char ***dellist, int only_children)
    511 {
    512   int delcount;
    513   int mycount;
    514   struct cpstack *result = NULL;
    515   char **cp;
    516 
    517   /* Initialize a stack for temporary results.  */
    518   cppush (&result, NULL);
    519 
    520   if (only_children)
    521     /* Delete only the variable children.  */
    522     delcount = delete_variable (&result, var, 1 /* only the children */ );
    523   else
    524     /* Delete the variable and all its children.  */
    525     delcount = delete_variable (&result, var, 0 /* parent+children */ );
    526 
    527   /* We may have been asked to return a list of what has been deleted.  */
    528   if (dellist != NULL)
    529     {
    530       *dellist = xmalloc ((delcount + 1) * sizeof (char *));
    531 
    532       cp = *dellist;
    533       mycount = delcount;
    534       *cp = cppop (&result);
    535       while ((*cp != NULL) && (mycount > 0))
    536 	{
    537 	  mycount--;
    538 	  cp++;
    539 	  *cp = cppop (&result);
    540 	}
    541 
    542       if (mycount || (*cp != NULL))
    543 	warning (_("varobj_delete: assertion failed - mycount(=%d) <> 0"),
    544 		 mycount);
    545     }
    546 
    547   return delcount;
    548 }
    549 
    550 #if HAVE_PYTHON
    551 
    552 /* Convenience function for varobj_set_visualizer.  Instantiate a
    553    pretty-printer for a given value.  */
    554 static PyObject *
    555 instantiate_pretty_printer (PyObject *constructor, struct value *value)
    556 {
    557   PyObject *val_obj = NULL;
    558   PyObject *printer;
    559 
    560   val_obj = value_to_value_object (value);
    561   if (! val_obj)
    562     return NULL;
    563 
    564   printer = PyObject_CallFunctionObjArgs (constructor, val_obj, NULL);
    565   Py_DECREF (val_obj);
    566   return printer;
    567 }
    568 
    569 #endif
    570 
    571 /* Set/Get variable object display format.  */
    572 
    573 enum varobj_display_formats
    574 varobj_set_display_format (struct varobj *var,
    575 			   enum varobj_display_formats format)
    576 {
    577   switch (format)
    578     {
    579     case FORMAT_NATURAL:
    580     case FORMAT_BINARY:
    581     case FORMAT_DECIMAL:
    582     case FORMAT_HEXADECIMAL:
    583     case FORMAT_OCTAL:
    584       var->format = format;
    585       break;
    586 
    587     default:
    588       var->format = variable_default_display (var);
    589     }
    590 
    591   if (varobj_value_is_changeable_p (var)
    592       && var->value && !value_lazy (var->value))
    593     {
    594       xfree (var->print_value);
    595       var->print_value = varobj_value_get_print_value (var->value,
    596 						       var->format, var);
    597     }
    598 
    599   return var->format;
    600 }
    601 
    602 enum varobj_display_formats
    603 varobj_get_display_format (struct varobj *var)
    604 {
    605   return var->format;
    606 }
    607 
    608 char *
    609 varobj_get_display_hint (struct varobj *var)
    610 {
    611   char *result = NULL;
    612 
    613 #if HAVE_PYTHON
    614   struct cleanup *back_to;
    615 
    616   if (!gdb_python_initialized)
    617     return NULL;
    618 
    619   back_to = varobj_ensure_python_env (var);
    620 
    621   if (var->dynamic->pretty_printer != NULL)
    622     result = gdbpy_get_display_hint (var->dynamic->pretty_printer);
    623 
    624   do_cleanups (back_to);
    625 #endif
    626 
    627   return result;
    628 }
    629 
    630 /* Return true if the varobj has items after TO, false otherwise.  */
    631 
    632 int
    633 varobj_has_more (struct varobj *var, int to)
    634 {
    635   if (VEC_length (varobj_p, var->children) > to)
    636     return 1;
    637   return ((to == -1 || VEC_length (varobj_p, var->children) == to)
    638 	  && (var->dynamic->saved_item != NULL));
    639 }
    640 
    641 /* If the variable object is bound to a specific thread, that
    642    is its evaluation can always be done in context of a frame
    643    inside that thread, returns GDB id of the thread -- which
    644    is always positive.  Otherwise, returns -1.  */
    645 int
    646 varobj_get_thread_id (struct varobj *var)
    647 {
    648   if (var->root->valid_block && var->root->thread_id > 0)
    649     return var->root->thread_id;
    650   else
    651     return -1;
    652 }
    653 
    654 void
    655 varobj_set_frozen (struct varobj *var, int frozen)
    656 {
    657   /* When a variable is unfrozen, we don't fetch its value.
    658      The 'not_fetched' flag remains set, so next -var-update
    659      won't complain.
    660 
    661      We don't fetch the value, because for structures the client
    662      should do -var-update anyway.  It would be bad to have different
    663      client-size logic for structure and other types.  */
    664   var->frozen = frozen;
    665 }
    666 
    667 int
    668 varobj_get_frozen (struct varobj *var)
    669 {
    670   return var->frozen;
    671 }
    672 
    673 /* A helper function that restricts a range to what is actually
    674    available in a VEC.  This follows the usual rules for the meaning
    675    of FROM and TO -- if either is negative, the entire range is
    676    used.  */
    677 
    678 void
    679 varobj_restrict_range (VEC (varobj_p) *children, int *from, int *to)
    680 {
    681   if (*from < 0 || *to < 0)
    682     {
    683       *from = 0;
    684       *to = VEC_length (varobj_p, children);
    685     }
    686   else
    687     {
    688       if (*from > VEC_length (varobj_p, children))
    689 	*from = VEC_length (varobj_p, children);
    690       if (*to > VEC_length (varobj_p, children))
    691 	*to = VEC_length (varobj_p, children);
    692       if (*from > *to)
    693 	*from = *to;
    694     }
    695 }
    696 
    697 /* A helper for update_dynamic_varobj_children that installs a new
    698    child when needed.  */
    699 
    700 static void
    701 install_dynamic_child (struct varobj *var,
    702 		       VEC (varobj_p) **changed,
    703 		       VEC (varobj_p) **type_changed,
    704 		       VEC (varobj_p) **new,
    705 		       VEC (varobj_p) **unchanged,
    706 		       int *cchanged,
    707 		       int index,
    708 		       struct varobj_item *item)
    709 {
    710   if (VEC_length (varobj_p, var->children) < index + 1)
    711     {
    712       /* There's no child yet.  */
    713       struct varobj *child = varobj_add_child (var, item);
    714 
    715       if (new)
    716 	{
    717 	  VEC_safe_push (varobj_p, *new, child);
    718 	  *cchanged = 1;
    719 	}
    720     }
    721   else
    722     {
    723       varobj_p existing = VEC_index (varobj_p, var->children, index);
    724       int type_updated = update_type_if_necessary (existing, item->value);
    725 
    726       if (type_updated)
    727 	{
    728 	  if (type_changed)
    729 	    VEC_safe_push (varobj_p, *type_changed, existing);
    730 	}
    731       if (install_new_value (existing, item->value, 0))
    732 	{
    733 	  if (!type_updated && changed)
    734 	    VEC_safe_push (varobj_p, *changed, existing);
    735 	}
    736       else if (!type_updated && unchanged)
    737 	VEC_safe_push (varobj_p, *unchanged, existing);
    738     }
    739 }
    740 
    741 #if HAVE_PYTHON
    742 
    743 static int
    744 dynamic_varobj_has_child_method (struct varobj *var)
    745 {
    746   struct cleanup *back_to;
    747   PyObject *printer = var->dynamic->pretty_printer;
    748   int result;
    749 
    750   if (!gdb_python_initialized)
    751     return 0;
    752 
    753   back_to = varobj_ensure_python_env (var);
    754   result = PyObject_HasAttr (printer, gdbpy_children_cst);
    755   do_cleanups (back_to);
    756   return result;
    757 }
    758 #endif
    759 
    760 /* A factory for creating dynamic varobj's iterators.  Returns an
    761    iterator object suitable for iterating over VAR's children.  */
    762 
    763 static struct varobj_iter *
    764 varobj_get_iterator (struct varobj *var)
    765 {
    766 #if HAVE_PYTHON
    767   if (var->dynamic->pretty_printer)
    768     return py_varobj_get_iterator (var, var->dynamic->pretty_printer);
    769 #endif
    770 
    771   gdb_assert_not_reached (_("\
    772 requested an iterator from a non-dynamic varobj"));
    773 }
    774 
    775 /* Release and clear VAR's saved item, if any.  */
    776 
    777 static void
    778 varobj_clear_saved_item (struct varobj_dynamic *var)
    779 {
    780   if (var->saved_item != NULL)
    781     {
    782       value_free (var->saved_item->value);
    783       xfree (var->saved_item);
    784       var->saved_item = NULL;
    785     }
    786 }
    787 
    788 static int
    789 update_dynamic_varobj_children (struct varobj *var,
    790 				VEC (varobj_p) **changed,
    791 				VEC (varobj_p) **type_changed,
    792 				VEC (varobj_p) **new,
    793 				VEC (varobj_p) **unchanged,
    794 				int *cchanged,
    795 				int update_children,
    796 				int from,
    797 				int to)
    798 {
    799   int i;
    800 
    801   *cchanged = 0;
    802 
    803   if (update_children || var->dynamic->child_iter == NULL)
    804     {
    805       varobj_iter_delete (var->dynamic->child_iter);
    806       var->dynamic->child_iter = varobj_get_iterator (var);
    807 
    808       varobj_clear_saved_item (var->dynamic);
    809 
    810       i = 0;
    811 
    812       if (var->dynamic->child_iter == NULL)
    813 	return 0;
    814     }
    815   else
    816     i = VEC_length (varobj_p, var->children);
    817 
    818   /* We ask for one extra child, so that MI can report whether there
    819      are more children.  */
    820   for (; to < 0 || i < to + 1; ++i)
    821     {
    822       varobj_item *item;
    823 
    824       /* See if there was a leftover from last time.  */
    825       if (var->dynamic->saved_item != NULL)
    826 	{
    827 	  item = var->dynamic->saved_item;
    828 	  var->dynamic->saved_item = NULL;
    829 	}
    830       else
    831 	{
    832 	  item = varobj_iter_next (var->dynamic->child_iter);
    833 	  /* Release vitem->value so its lifetime is not bound to the
    834 	     execution of a command.  */
    835 	  if (item != NULL && item->value != NULL)
    836 	    release_value_or_incref (item->value);
    837 	}
    838 
    839       if (item == NULL)
    840 	{
    841 	  /* Iteration is done.  Remove iterator from VAR.  */
    842 	  varobj_iter_delete (var->dynamic->child_iter);
    843 	  var->dynamic->child_iter = NULL;
    844 	  break;
    845 	}
    846       /* We don't want to push the extra child on any report list.  */
    847       if (to < 0 || i < to)
    848 	{
    849 	  int can_mention = from < 0 || i >= from;
    850 
    851 	  install_dynamic_child (var, can_mention ? changed : NULL,
    852 				 can_mention ? type_changed : NULL,
    853 				 can_mention ? new : NULL,
    854 				 can_mention ? unchanged : NULL,
    855 				 can_mention ? cchanged : NULL, i,
    856 				 item);
    857 
    858 	  xfree (item);
    859 	}
    860       else
    861 	{
    862 	  var->dynamic->saved_item = item;
    863 
    864 	  /* We want to truncate the child list just before this
    865 	     element.  */
    866 	  break;
    867 	}
    868     }
    869 
    870   if (i < VEC_length (varobj_p, var->children))
    871     {
    872       int j;
    873 
    874       *cchanged = 1;
    875       for (j = i; j < VEC_length (varobj_p, var->children); ++j)
    876 	varobj_delete (VEC_index (varobj_p, var->children, j), NULL, 0);
    877       VEC_truncate (varobj_p, var->children, i);
    878     }
    879 
    880   /* If there are fewer children than requested, note that the list of
    881      children changed.  */
    882   if (to >= 0 && VEC_length (varobj_p, var->children) < to)
    883     *cchanged = 1;
    884 
    885   var->num_children = VEC_length (varobj_p, var->children);
    886 
    887   return 1;
    888 }
    889 
    890 int
    891 varobj_get_num_children (struct varobj *var)
    892 {
    893   if (var->num_children == -1)
    894     {
    895       if (varobj_is_dynamic_p (var))
    896 	{
    897 	  int dummy;
    898 
    899 	  /* If we have a dynamic varobj, don't report -1 children.
    900 	     So, try to fetch some children first.  */
    901 	  update_dynamic_varobj_children (var, NULL, NULL, NULL, NULL, &dummy,
    902 					  0, 0, 0);
    903 	}
    904       else
    905 	var->num_children = number_of_children (var);
    906     }
    907 
    908   return var->num_children >= 0 ? var->num_children : 0;
    909 }
    910 
    911 /* Creates a list of the immediate children of a variable object;
    912    the return code is the number of such children or -1 on error.  */
    913 
    914 VEC (varobj_p)*
    915 varobj_list_children (struct varobj *var, int *from, int *to)
    916 {
    917   char *name;
    918   int i, children_changed;
    919 
    920   var->dynamic->children_requested = 1;
    921 
    922   if (varobj_is_dynamic_p (var))
    923     {
    924       /* This, in theory, can result in the number of children changing without
    925 	 frontend noticing.  But well, calling -var-list-children on the same
    926 	 varobj twice is not something a sane frontend would do.  */
    927       update_dynamic_varobj_children (var, NULL, NULL, NULL, NULL,
    928 				      &children_changed, 0, 0, *to);
    929       varobj_restrict_range (var->children, from, to);
    930       return var->children;
    931     }
    932 
    933   if (var->num_children == -1)
    934     var->num_children = number_of_children (var);
    935 
    936   /* If that failed, give up.  */
    937   if (var->num_children == -1)
    938     return var->children;
    939 
    940   /* If we're called when the list of children is not yet initialized,
    941      allocate enough elements in it.  */
    942   while (VEC_length (varobj_p, var->children) < var->num_children)
    943     VEC_safe_push (varobj_p, var->children, NULL);
    944 
    945   for (i = 0; i < var->num_children; i++)
    946     {
    947       varobj_p existing = VEC_index (varobj_p, var->children, i);
    948 
    949       if (existing == NULL)
    950 	{
    951 	  /* Either it's the first call to varobj_list_children for
    952 	     this variable object, and the child was never created,
    953 	     or it was explicitly deleted by the client.  */
    954 	  name = name_of_child (var, i);
    955 	  existing = create_child (var, i, name);
    956 	  VEC_replace (varobj_p, var->children, i, existing);
    957 	}
    958     }
    959 
    960   varobj_restrict_range (var->children, from, to);
    961   return var->children;
    962 }
    963 
    964 static struct varobj *
    965 varobj_add_child (struct varobj *var, struct varobj_item *item)
    966 {
    967   varobj_p v = create_child_with_value (var,
    968 					VEC_length (varobj_p, var->children),
    969 					item);
    970 
    971   VEC_safe_push (varobj_p, var->children, v);
    972   return v;
    973 }
    974 
    975 /* Obtain the type of an object Variable as a string similar to the one gdb
    976    prints on the console.  */
    977 
    978 char *
    979 varobj_get_type (struct varobj *var)
    980 {
    981   /* For the "fake" variables, do not return a type.  (Its type is
    982      NULL, too.)
    983      Do not return a type for invalid variables as well.  */
    984   if (CPLUS_FAKE_CHILD (var) || !var->root->is_valid)
    985     return NULL;
    986 
    987   return type_to_string (var->type);
    988 }
    989 
    990 /* Obtain the type of an object variable.  */
    991 
    992 struct type *
    993 varobj_get_gdb_type (struct varobj *var)
    994 {
    995   return var->type;
    996 }
    997 
    998 /* Is VAR a path expression parent, i.e., can it be used to construct
    999    a valid path expression?  */
   1000 
   1001 static int
   1002 is_path_expr_parent (struct varobj *var)
   1003 {
   1004   gdb_assert (var->root->lang_ops->is_path_expr_parent != NULL);
   1005   return var->root->lang_ops->is_path_expr_parent (var);
   1006 }
   1007 
   1008 /* Is VAR a path expression parent, i.e., can it be used to construct
   1009    a valid path expression?  By default we assume any VAR can be a path
   1010    parent.  */
   1011 
   1012 int
   1013 varobj_default_is_path_expr_parent (struct varobj *var)
   1014 {
   1015   return 1;
   1016 }
   1017 
   1018 /* Return the path expression parent for VAR.  */
   1019 
   1020 struct varobj *
   1021 varobj_get_path_expr_parent (struct varobj *var)
   1022 {
   1023   struct varobj *parent = var;
   1024 
   1025   while (!is_root_p (parent) && !is_path_expr_parent (parent))
   1026     parent = parent->parent;
   1027 
   1028   return parent;
   1029 }
   1030 
   1031 /* Return a pointer to the full rooted expression of varobj VAR.
   1032    If it has not been computed yet, compute it.  */
   1033 char *
   1034 varobj_get_path_expr (struct varobj *var)
   1035 {
   1036   if (var->path_expr != NULL)
   1037     return var->path_expr;
   1038   else
   1039     {
   1040       /* For root varobjs, we initialize path_expr
   1041 	 when creating varobj, so here it should be
   1042 	 child varobj.  */
   1043       gdb_assert (!is_root_p (var));
   1044       return (*var->root->lang_ops->path_expr_of_child) (var);
   1045     }
   1046 }
   1047 
   1048 const struct language_defn *
   1049 varobj_get_language (struct varobj *var)
   1050 {
   1051   return var->root->exp->language_defn;
   1052 }
   1053 
   1054 int
   1055 varobj_get_attributes (struct varobj *var)
   1056 {
   1057   int attributes = 0;
   1058 
   1059   if (varobj_editable_p (var))
   1060     /* FIXME: define masks for attributes.  */
   1061     attributes |= 0x00000001;	/* Editable */
   1062 
   1063   return attributes;
   1064 }
   1065 
   1066 /* Return true if VAR is a dynamic varobj.  */
   1067 
   1068 int
   1069 varobj_is_dynamic_p (struct varobj *var)
   1070 {
   1071   return var->dynamic->pretty_printer != NULL;
   1072 }
   1073 
   1074 char *
   1075 varobj_get_formatted_value (struct varobj *var,
   1076 			    enum varobj_display_formats format)
   1077 {
   1078   return my_value_of_variable (var, format);
   1079 }
   1080 
   1081 char *
   1082 varobj_get_value (struct varobj *var)
   1083 {
   1084   return my_value_of_variable (var, var->format);
   1085 }
   1086 
   1087 /* Set the value of an object variable (if it is editable) to the
   1088    value of the given expression.  */
   1089 /* Note: Invokes functions that can call error().  */
   1090 
   1091 int
   1092 varobj_set_value (struct varobj *var, char *expression)
   1093 {
   1094   struct value *val = NULL; /* Initialize to keep gcc happy.  */
   1095   /* The argument "expression" contains the variable's new value.
   1096      We need to first construct a legal expression for this -- ugh!  */
   1097   /* Does this cover all the bases?  */
   1098   struct expression *exp;
   1099   struct value *value = NULL; /* Initialize to keep gcc happy.  */
   1100   int saved_input_radix = input_radix;
   1101   const char *s = expression;
   1102   volatile struct gdb_exception except;
   1103 
   1104   gdb_assert (varobj_editable_p (var));
   1105 
   1106   input_radix = 10;		/* ALWAYS reset to decimal temporarily.  */
   1107   exp = parse_exp_1 (&s, 0, 0, 0);
   1108   TRY_CATCH (except, RETURN_MASK_ERROR)
   1109     {
   1110       value = evaluate_expression (exp);
   1111     }
   1112 
   1113   if (except.reason < 0)
   1114     {
   1115       /* We cannot proceed without a valid expression.  */
   1116       xfree (exp);
   1117       return 0;
   1118     }
   1119 
   1120   /* All types that are editable must also be changeable.  */
   1121   gdb_assert (varobj_value_is_changeable_p (var));
   1122 
   1123   /* The value of a changeable variable object must not be lazy.  */
   1124   gdb_assert (!value_lazy (var->value));
   1125 
   1126   /* Need to coerce the input.  We want to check if the
   1127      value of the variable object will be different
   1128      after assignment, and the first thing value_assign
   1129      does is coerce the input.
   1130      For example, if we are assigning an array to a pointer variable we
   1131      should compare the pointer with the array's address, not with the
   1132      array's content.  */
   1133   value = coerce_array (value);
   1134 
   1135   /* The new value may be lazy.  value_assign, or
   1136      rather value_contents, will take care of this.  */
   1137   TRY_CATCH (except, RETURN_MASK_ERROR)
   1138     {
   1139       val = value_assign (var->value, value);
   1140     }
   1141 
   1142   if (except.reason < 0)
   1143     return 0;
   1144 
   1145   /* If the value has changed, record it, so that next -var-update can
   1146      report this change.  If a variable had a value of '1', we've set it
   1147      to '333' and then set again to '1', when -var-update will report this
   1148      variable as changed -- because the first assignment has set the
   1149      'updated' flag.  There's no need to optimize that, because return value
   1150      of -var-update should be considered an approximation.  */
   1151   var->updated = install_new_value (var, val, 0 /* Compare values.  */);
   1152   input_radix = saved_input_radix;
   1153   return 1;
   1154 }
   1155 
   1156 #if HAVE_PYTHON
   1157 
   1158 /* A helper function to install a constructor function and visualizer
   1159    in a varobj_dynamic.  */
   1160 
   1161 static void
   1162 install_visualizer (struct varobj_dynamic *var, PyObject *constructor,
   1163 		    PyObject *visualizer)
   1164 {
   1165   Py_XDECREF (var->constructor);
   1166   var->constructor = constructor;
   1167 
   1168   Py_XDECREF (var->pretty_printer);
   1169   var->pretty_printer = visualizer;
   1170 
   1171   varobj_iter_delete (var->child_iter);
   1172   var->child_iter = NULL;
   1173 }
   1174 
   1175 /* Install the default visualizer for VAR.  */
   1176 
   1177 static void
   1178 install_default_visualizer (struct varobj *var)
   1179 {
   1180   /* Do not install a visualizer on a CPLUS_FAKE_CHILD.  */
   1181   if (CPLUS_FAKE_CHILD (var))
   1182     return;
   1183 
   1184   if (pretty_printing)
   1185     {
   1186       PyObject *pretty_printer = NULL;
   1187 
   1188       if (var->value)
   1189 	{
   1190 	  pretty_printer = gdbpy_get_varobj_pretty_printer (var->value);
   1191 	  if (! pretty_printer)
   1192 	    {
   1193 	      gdbpy_print_stack ();
   1194 	      error (_("Cannot instantiate printer for default visualizer"));
   1195 	    }
   1196 	}
   1197 
   1198       if (pretty_printer == Py_None)
   1199 	{
   1200 	  Py_DECREF (pretty_printer);
   1201 	  pretty_printer = NULL;
   1202 	}
   1203 
   1204       install_visualizer (var->dynamic, NULL, pretty_printer);
   1205     }
   1206 }
   1207 
   1208 /* Instantiate and install a visualizer for VAR using CONSTRUCTOR to
   1209    make a new object.  */
   1210 
   1211 static void
   1212 construct_visualizer (struct varobj *var, PyObject *constructor)
   1213 {
   1214   PyObject *pretty_printer;
   1215 
   1216   /* Do not install a visualizer on a CPLUS_FAKE_CHILD.  */
   1217   if (CPLUS_FAKE_CHILD (var))
   1218     return;
   1219 
   1220   Py_INCREF (constructor);
   1221   if (constructor == Py_None)
   1222     pretty_printer = NULL;
   1223   else
   1224     {
   1225       pretty_printer = instantiate_pretty_printer (constructor, var->value);
   1226       if (! pretty_printer)
   1227 	{
   1228 	  gdbpy_print_stack ();
   1229 	  Py_DECREF (constructor);
   1230 	  constructor = Py_None;
   1231 	  Py_INCREF (constructor);
   1232 	}
   1233 
   1234       if (pretty_printer == Py_None)
   1235 	{
   1236 	  Py_DECREF (pretty_printer);
   1237 	  pretty_printer = NULL;
   1238 	}
   1239     }
   1240 
   1241   install_visualizer (var->dynamic, constructor, pretty_printer);
   1242 }
   1243 
   1244 #endif /* HAVE_PYTHON */
   1245 
   1246 /* A helper function for install_new_value.  This creates and installs
   1247    a visualizer for VAR, if appropriate.  */
   1248 
   1249 static void
   1250 install_new_value_visualizer (struct varobj *var)
   1251 {
   1252 #if HAVE_PYTHON
   1253   /* If the constructor is None, then we want the raw value.  If VAR
   1254      does not have a value, just skip this.  */
   1255   if (!gdb_python_initialized)
   1256     return;
   1257 
   1258   if (var->dynamic->constructor != Py_None && var->value != NULL)
   1259     {
   1260       struct cleanup *cleanup;
   1261 
   1262       cleanup = varobj_ensure_python_env (var);
   1263 
   1264       if (var->dynamic->constructor == NULL)
   1265 	install_default_visualizer (var);
   1266       else
   1267 	construct_visualizer (var, var->dynamic->constructor);
   1268 
   1269       do_cleanups (cleanup);
   1270     }
   1271 #else
   1272   /* Do nothing.  */
   1273 #endif
   1274 }
   1275 
   1276 /* When using RTTI to determine variable type it may be changed in runtime when
   1277    the variable value is changed.  This function checks whether type of varobj
   1278    VAR will change when a new value NEW_VALUE is assigned and if it is so
   1279    updates the type of VAR.  */
   1280 
   1281 static int
   1282 update_type_if_necessary (struct varobj *var, struct value *new_value)
   1283 {
   1284   if (new_value)
   1285     {
   1286       struct value_print_options opts;
   1287 
   1288       get_user_print_options (&opts);
   1289       if (opts.objectprint)
   1290 	{
   1291 	  struct type *new_type;
   1292 	  char *curr_type_str, *new_type_str;
   1293 	  int rv;
   1294 
   1295 	  new_type = value_actual_type (new_value, 0, 0);
   1296 	  new_type_str = type_to_string (new_type);
   1297 	  curr_type_str = varobj_get_type (var);
   1298 	  rv = strcmp (curr_type_str, new_type_str) != 0;
   1299 	  if (rv)
   1300 	    {
   1301 	      var->type = new_type;
   1302 
   1303 	      /* This information may be not valid for a new type.  */
   1304 	      varobj_delete (var, NULL, 1);
   1305 	      VEC_free (varobj_p, var->children);
   1306 	      var->num_children = -1;
   1307 	    }
   1308 	  xfree (new_type_str);
   1309 	  xfree (curr_type_str);
   1310 	  return rv;
   1311 	}
   1312     }
   1313 
   1314   return 0;
   1315 }
   1316 
   1317 /* Assign a new value to a variable object.  If INITIAL is non-zero,
   1318    this is the first assignement after the variable object was just
   1319    created, or changed type.  In that case, just assign the value
   1320    and return 0.
   1321    Otherwise, assign the new value, and return 1 if the value is
   1322    different from the current one, 0 otherwise.  The comparison is
   1323    done on textual representation of value.  Therefore, some types
   1324    need not be compared.  E.g.  for structures the reported value is
   1325    always "{...}", so no comparison is necessary here.  If the old
   1326    value was NULL and new one is not, or vice versa, we always return 1.
   1327 
   1328    The VALUE parameter should not be released -- the function will
   1329    take care of releasing it when needed.  */
   1330 static int
   1331 install_new_value (struct varobj *var, struct value *value, int initial)
   1332 {
   1333   int changeable;
   1334   int need_to_fetch;
   1335   int changed = 0;
   1336   int intentionally_not_fetched = 0;
   1337   char *print_value = NULL;
   1338 
   1339   /* We need to know the varobj's type to decide if the value should
   1340      be fetched or not.  C++ fake children (public/protected/private)
   1341      don't have a type.  */
   1342   gdb_assert (var->type || CPLUS_FAKE_CHILD (var));
   1343   changeable = varobj_value_is_changeable_p (var);
   1344 
   1345   /* If the type has custom visualizer, we consider it to be always
   1346      changeable.  FIXME: need to make sure this behaviour will not
   1347      mess up read-sensitive values.  */
   1348   if (var->dynamic->pretty_printer != NULL)
   1349     changeable = 1;
   1350 
   1351   need_to_fetch = changeable;
   1352 
   1353   /* We are not interested in the address of references, and given
   1354      that in C++ a reference is not rebindable, it cannot
   1355      meaningfully change.  So, get hold of the real value.  */
   1356   if (value)
   1357     value = coerce_ref (value);
   1358 
   1359   if (var->type && TYPE_CODE (var->type) == TYPE_CODE_UNION)
   1360     /* For unions, we need to fetch the value implicitly because
   1361        of implementation of union member fetch.  When gdb
   1362        creates a value for a field and the value of the enclosing
   1363        structure is not lazy,  it immediately copies the necessary
   1364        bytes from the enclosing values.  If the enclosing value is
   1365        lazy, the call to value_fetch_lazy on the field will read
   1366        the data from memory.  For unions, that means we'll read the
   1367        same memory more than once, which is not desirable.  So
   1368        fetch now.  */
   1369     need_to_fetch = 1;
   1370 
   1371   /* The new value might be lazy.  If the type is changeable,
   1372      that is we'll be comparing values of this type, fetch the
   1373      value now.  Otherwise, on the next update the old value
   1374      will be lazy, which means we've lost that old value.  */
   1375   if (need_to_fetch && value && value_lazy (value))
   1376     {
   1377       struct varobj *parent = var->parent;
   1378       int frozen = var->frozen;
   1379 
   1380       for (; !frozen && parent; parent = parent->parent)
   1381 	frozen |= parent->frozen;
   1382 
   1383       if (frozen && initial)
   1384 	{
   1385 	  /* For variables that are frozen, or are children of frozen
   1386 	     variables, we don't do fetch on initial assignment.
   1387 	     For non-initial assignemnt we do the fetch, since it means we're
   1388 	     explicitly asked to compare the new value with the old one.  */
   1389 	  intentionally_not_fetched = 1;
   1390 	}
   1391       else
   1392 	{
   1393 	  volatile struct gdb_exception except;
   1394 
   1395 	  TRY_CATCH (except, RETURN_MASK_ERROR)
   1396 	    {
   1397 	      value_fetch_lazy (value);
   1398 	    }
   1399 
   1400 	  if (except.reason < 0)
   1401 	    {
   1402 	      /* Set the value to NULL, so that for the next -var-update,
   1403 		 we don't try to compare the new value with this value,
   1404 		 that we couldn't even read.  */
   1405 	      value = NULL;
   1406 	    }
   1407 	}
   1408     }
   1409 
   1410   /* Get a reference now, before possibly passing it to any Python
   1411      code that might release it.  */
   1412   if (value != NULL)
   1413     value_incref (value);
   1414 
   1415   /* Below, we'll be comparing string rendering of old and new
   1416      values.  Don't get string rendering if the value is
   1417      lazy -- if it is, the code above has decided that the value
   1418      should not be fetched.  */
   1419   if (value != NULL && !value_lazy (value)
   1420       && var->dynamic->pretty_printer == NULL)
   1421     print_value = varobj_value_get_print_value (value, var->format, var);
   1422 
   1423   /* If the type is changeable, compare the old and the new values.
   1424      If this is the initial assignment, we don't have any old value
   1425      to compare with.  */
   1426   if (!initial && changeable)
   1427     {
   1428       /* If the value of the varobj was changed by -var-set-value,
   1429 	 then the value in the varobj and in the target is the same.
   1430 	 However, that value is different from the value that the
   1431 	 varobj had after the previous -var-update.  So need to the
   1432 	 varobj as changed.  */
   1433       if (var->updated)
   1434 	{
   1435 	  changed = 1;
   1436 	}
   1437       else if (var->dynamic->pretty_printer == NULL)
   1438 	{
   1439 	  /* Try to compare the values.  That requires that both
   1440 	     values are non-lazy.  */
   1441 	  if (var->not_fetched && value_lazy (var->value))
   1442 	    {
   1443 	      /* This is a frozen varobj and the value was never read.
   1444 		 Presumably, UI shows some "never read" indicator.
   1445 		 Now that we've fetched the real value, we need to report
   1446 		 this varobj as changed so that UI can show the real
   1447 		 value.  */
   1448 	      changed = 1;
   1449 	    }
   1450           else  if (var->value == NULL && value == NULL)
   1451 	    /* Equal.  */
   1452 	    ;
   1453 	  else if (var->value == NULL || value == NULL)
   1454 	    {
   1455 	      changed = 1;
   1456 	    }
   1457 	  else
   1458 	    {
   1459 	      gdb_assert (!value_lazy (var->value));
   1460 	      gdb_assert (!value_lazy (value));
   1461 
   1462 	      gdb_assert (var->print_value != NULL && print_value != NULL);
   1463 	      if (strcmp (var->print_value, print_value) != 0)
   1464 		changed = 1;
   1465 	    }
   1466 	}
   1467     }
   1468 
   1469   if (!initial && !changeable)
   1470     {
   1471       /* For values that are not changeable, we don't compare the values.
   1472 	 However, we want to notice if a value was not NULL and now is NULL,
   1473 	 or vise versa, so that we report when top-level varobjs come in scope
   1474 	 and leave the scope.  */
   1475       changed = (var->value != NULL) != (value != NULL);
   1476     }
   1477 
   1478   /* We must always keep the new value, since children depend on it.  */
   1479   if (var->value != NULL && var->value != value)
   1480     value_free (var->value);
   1481   var->value = value;
   1482   if (value && value_lazy (value) && intentionally_not_fetched)
   1483     var->not_fetched = 1;
   1484   else
   1485     var->not_fetched = 0;
   1486   var->updated = 0;
   1487 
   1488   install_new_value_visualizer (var);
   1489 
   1490   /* If we installed a pretty-printer, re-compare the printed version
   1491      to see if the variable changed.  */
   1492   if (var->dynamic->pretty_printer != NULL)
   1493     {
   1494       xfree (print_value);
   1495       print_value = varobj_value_get_print_value (var->value, var->format,
   1496 						  var);
   1497       if ((var->print_value == NULL && print_value != NULL)
   1498 	  || (var->print_value != NULL && print_value == NULL)
   1499 	  || (var->print_value != NULL && print_value != NULL
   1500 	      && strcmp (var->print_value, print_value) != 0))
   1501 	changed = 1;
   1502     }
   1503   if (var->print_value)
   1504     xfree (var->print_value);
   1505   var->print_value = print_value;
   1506 
   1507   gdb_assert (!var->value || value_type (var->value));
   1508 
   1509   return changed;
   1510 }
   1511 
   1512 /* Return the requested range for a varobj.  VAR is the varobj.  FROM
   1513    and TO are out parameters; *FROM and *TO will be set to the
   1514    selected sub-range of VAR.  If no range was selected using
   1515    -var-set-update-range, then both will be -1.  */
   1516 void
   1517 varobj_get_child_range (struct varobj *var, int *from, int *to)
   1518 {
   1519   *from = var->from;
   1520   *to = var->to;
   1521 }
   1522 
   1523 /* Set the selected sub-range of children of VAR to start at index
   1524    FROM and end at index TO.  If either FROM or TO is less than zero,
   1525    this is interpreted as a request for all children.  */
   1526 void
   1527 varobj_set_child_range (struct varobj *var, int from, int to)
   1528 {
   1529   var->from = from;
   1530   var->to = to;
   1531 }
   1532 
   1533 void
   1534 varobj_set_visualizer (struct varobj *var, const char *visualizer)
   1535 {
   1536 #if HAVE_PYTHON
   1537   PyObject *mainmod, *globals, *constructor;
   1538   struct cleanup *back_to;
   1539 
   1540   if (!gdb_python_initialized)
   1541     return;
   1542 
   1543   back_to = varobj_ensure_python_env (var);
   1544 
   1545   mainmod = PyImport_AddModule ("__main__");
   1546   globals = PyModule_GetDict (mainmod);
   1547   Py_INCREF (globals);
   1548   make_cleanup_py_decref (globals);
   1549 
   1550   constructor = PyRun_String (visualizer, Py_eval_input, globals, globals);
   1551 
   1552   if (! constructor)
   1553     {
   1554       gdbpy_print_stack ();
   1555       error (_("Could not evaluate visualizer expression: %s"), visualizer);
   1556     }
   1557 
   1558   construct_visualizer (var, constructor);
   1559   Py_XDECREF (constructor);
   1560 
   1561   /* If there are any children now, wipe them.  */
   1562   varobj_delete (var, NULL, 1 /* children only */);
   1563   var->num_children = -1;
   1564 
   1565   do_cleanups (back_to);
   1566 #else
   1567   error (_("Python support required"));
   1568 #endif
   1569 }
   1570 
   1571 /* If NEW_VALUE is the new value of the given varobj (var), return
   1572    non-zero if var has mutated.  In other words, if the type of
   1573    the new value is different from the type of the varobj's old
   1574    value.
   1575 
   1576    NEW_VALUE may be NULL, if the varobj is now out of scope.  */
   1577 
   1578 static int
   1579 varobj_value_has_mutated (struct varobj *var, struct value *new_value,
   1580 			  struct type *new_type)
   1581 {
   1582   /* If we haven't previously computed the number of children in var,
   1583      it does not matter from the front-end's perspective whether
   1584      the type has mutated or not.  For all intents and purposes,
   1585      it has not mutated.  */
   1586   if (var->num_children < 0)
   1587     return 0;
   1588 
   1589   if (var->root->lang_ops->value_has_mutated)
   1590     {
   1591       /* The varobj module, when installing new values, explicitly strips
   1592 	 references, saying that we're not interested in those addresses.
   1593 	 But detection of mutation happens before installing the new
   1594 	 value, so our value may be a reference that we need to strip
   1595 	 in order to remain consistent.  */
   1596       if (new_value != NULL)
   1597 	new_value = coerce_ref (new_value);
   1598       return var->root->lang_ops->value_has_mutated (var, new_value, new_type);
   1599     }
   1600   else
   1601     return 0;
   1602 }
   1603 
   1604 /* Update the values for a variable and its children.  This is a
   1605    two-pronged attack.  First, re-parse the value for the root's
   1606    expression to see if it's changed.  Then go all the way
   1607    through its children, reconstructing them and noting if they've
   1608    changed.
   1609 
   1610    The EXPLICIT parameter specifies if this call is result
   1611    of MI request to update this specific variable, or
   1612    result of implicit -var-update *.  For implicit request, we don't
   1613    update frozen variables.
   1614 
   1615    NOTE: This function may delete the caller's varobj.  If it
   1616    returns TYPE_CHANGED, then it has done this and VARP will be modified
   1617    to point to the new varobj.  */
   1618 
   1619 VEC(varobj_update_result) *
   1620 varobj_update (struct varobj **varp, int explicit)
   1621 {
   1622   int type_changed = 0;
   1623   int i;
   1624   struct value *new;
   1625   VEC (varobj_update_result) *stack = NULL;
   1626   VEC (varobj_update_result) *result = NULL;
   1627 
   1628   /* Frozen means frozen -- we don't check for any change in
   1629      this varobj, including its going out of scope, or
   1630      changing type.  One use case for frozen varobjs is
   1631      retaining previously evaluated expressions, and we don't
   1632      want them to be reevaluated at all.  */
   1633   if (!explicit && (*varp)->frozen)
   1634     return result;
   1635 
   1636   if (!(*varp)->root->is_valid)
   1637     {
   1638       varobj_update_result r = {0};
   1639 
   1640       r.varobj = *varp;
   1641       r.status = VAROBJ_INVALID;
   1642       VEC_safe_push (varobj_update_result, result, &r);
   1643       return result;
   1644     }
   1645 
   1646   if ((*varp)->root->rootvar == *varp)
   1647     {
   1648       varobj_update_result r = {0};
   1649 
   1650       r.varobj = *varp;
   1651       r.status = VAROBJ_IN_SCOPE;
   1652 
   1653       /* Update the root variable.  value_of_root can return NULL
   1654 	 if the variable is no longer around, i.e. we stepped out of
   1655 	 the frame in which a local existed.  We are letting the
   1656 	 value_of_root variable dispose of the varobj if the type
   1657 	 has changed.  */
   1658       new = value_of_root (varp, &type_changed);
   1659       if (update_type_if_necessary(*varp, new))
   1660 	  type_changed = 1;
   1661       r.varobj = *varp;
   1662       r.type_changed = type_changed;
   1663       if (install_new_value ((*varp), new, type_changed))
   1664 	r.changed = 1;
   1665 
   1666       if (new == NULL)
   1667 	r.status = VAROBJ_NOT_IN_SCOPE;
   1668       r.value_installed = 1;
   1669 
   1670       if (r.status == VAROBJ_NOT_IN_SCOPE)
   1671 	{
   1672 	  if (r.type_changed || r.changed)
   1673 	    VEC_safe_push (varobj_update_result, result, &r);
   1674 	  return result;
   1675 	}
   1676 
   1677       VEC_safe_push (varobj_update_result, stack, &r);
   1678     }
   1679   else
   1680     {
   1681       varobj_update_result r = {0};
   1682 
   1683       r.varobj = *varp;
   1684       VEC_safe_push (varobj_update_result, stack, &r);
   1685     }
   1686 
   1687   /* Walk through the children, reconstructing them all.  */
   1688   while (!VEC_empty (varobj_update_result, stack))
   1689     {
   1690       varobj_update_result r = *(VEC_last (varobj_update_result, stack));
   1691       struct varobj *v = r.varobj;
   1692 
   1693       VEC_pop (varobj_update_result, stack);
   1694 
   1695       /* Update this variable, unless it's a root, which is already
   1696 	 updated.  */
   1697       if (!r.value_installed)
   1698 	{
   1699 	  struct type *new_type;
   1700 
   1701 	  new = value_of_child (v->parent, v->index);
   1702 	  if (update_type_if_necessary(v, new))
   1703 	    r.type_changed = 1;
   1704 	  if (new)
   1705 	    new_type = value_type (new);
   1706 	  else
   1707 	    new_type = v->root->lang_ops->type_of_child (v->parent, v->index);
   1708 
   1709 	  if (varobj_value_has_mutated (v, new, new_type))
   1710 	    {
   1711 	      /* The children are no longer valid; delete them now.
   1712 	         Report the fact that its type changed as well.  */
   1713 	      varobj_delete (v, NULL, 1 /* only_children */);
   1714 	      v->num_children = -1;
   1715 	      v->to = -1;
   1716 	      v->from = -1;
   1717 	      v->type = new_type;
   1718 	      r.type_changed = 1;
   1719 	    }
   1720 
   1721 	  if (install_new_value (v, new, r.type_changed))
   1722 	    {
   1723 	      r.changed = 1;
   1724 	      v->updated = 0;
   1725 	    }
   1726 	}
   1727 
   1728       /* We probably should not get children of a dynamic varobj, but
   1729 	 for which -var-list-children was never invoked.  */
   1730       if (varobj_is_dynamic_p (v))
   1731 	{
   1732 	  VEC (varobj_p) *changed = 0, *type_changed = 0, *unchanged = 0;
   1733 	  VEC (varobj_p) *new = 0;
   1734 	  int i, children_changed = 0;
   1735 
   1736 	  if (v->frozen)
   1737 	    continue;
   1738 
   1739 	  if (!v->dynamic->children_requested)
   1740 	    {
   1741 	      int dummy;
   1742 
   1743 	      /* If we initially did not have potential children, but
   1744 		 now we do, consider the varobj as changed.
   1745 		 Otherwise, if children were never requested, consider
   1746 		 it as unchanged -- presumably, such varobj is not yet
   1747 		 expanded in the UI, so we need not bother getting
   1748 		 it.  */
   1749 	      if (!varobj_has_more (v, 0))
   1750 		{
   1751 		  update_dynamic_varobj_children (v, NULL, NULL, NULL, NULL,
   1752 						  &dummy, 0, 0, 0);
   1753 		  if (varobj_has_more (v, 0))
   1754 		    r.changed = 1;
   1755 		}
   1756 
   1757 	      if (r.changed)
   1758 		VEC_safe_push (varobj_update_result, result, &r);
   1759 
   1760 	      continue;
   1761 	    }
   1762 
   1763 	  /* If update_dynamic_varobj_children returns 0, then we have
   1764 	     a non-conforming pretty-printer, so we skip it.  */
   1765 	  if (update_dynamic_varobj_children (v, &changed, &type_changed, &new,
   1766 					      &unchanged, &children_changed, 1,
   1767 					      v->from, v->to))
   1768 	    {
   1769 	      if (children_changed || new)
   1770 		{
   1771 		  r.children_changed = 1;
   1772 		  r.new = new;
   1773 		}
   1774 	      /* Push in reverse order so that the first child is
   1775 		 popped from the work stack first, and so will be
   1776 		 added to result first.  This does not affect
   1777 		 correctness, just "nicer".  */
   1778 	      for (i = VEC_length (varobj_p, type_changed) - 1; i >= 0; --i)
   1779 		{
   1780 		  varobj_p tmp = VEC_index (varobj_p, type_changed, i);
   1781 		  varobj_update_result r = {0};
   1782 
   1783 		  /* Type may change only if value was changed.  */
   1784 		  r.varobj = tmp;
   1785 		  r.changed = 1;
   1786 		  r.type_changed = 1;
   1787 		  r.value_installed = 1;
   1788 		  VEC_safe_push (varobj_update_result, stack, &r);
   1789 		}
   1790 	      for (i = VEC_length (varobj_p, changed) - 1; i >= 0; --i)
   1791 		{
   1792 		  varobj_p tmp = VEC_index (varobj_p, changed, i);
   1793 		  varobj_update_result r = {0};
   1794 
   1795 		  r.varobj = tmp;
   1796 		  r.changed = 1;
   1797 		  r.value_installed = 1;
   1798 		  VEC_safe_push (varobj_update_result, stack, &r);
   1799 		}
   1800 	      for (i = VEC_length (varobj_p, unchanged) - 1; i >= 0; --i)
   1801 	      	{
   1802 		  varobj_p tmp = VEC_index (varobj_p, unchanged, i);
   1803 
   1804 	      	  if (!tmp->frozen)
   1805 	      	    {
   1806 	      	      varobj_update_result r = {0};
   1807 
   1808 		      r.varobj = tmp;
   1809 	      	      r.value_installed = 1;
   1810 	      	      VEC_safe_push (varobj_update_result, stack, &r);
   1811 	      	    }
   1812 	      	}
   1813 	      if (r.changed || r.children_changed)
   1814 		VEC_safe_push (varobj_update_result, result, &r);
   1815 
   1816 	      /* Free CHANGED, TYPE_CHANGED and UNCHANGED, but not NEW,
   1817 		 because NEW has been put into the result vector.  */
   1818 	      VEC_free (varobj_p, changed);
   1819 	      VEC_free (varobj_p, type_changed);
   1820 	      VEC_free (varobj_p, unchanged);
   1821 
   1822 	      continue;
   1823 	    }
   1824 	}
   1825 
   1826       /* Push any children.  Use reverse order so that the first
   1827 	 child is popped from the work stack first, and so
   1828 	 will be added to result first.  This does not
   1829 	 affect correctness, just "nicer".  */
   1830       for (i = VEC_length (varobj_p, v->children)-1; i >= 0; --i)
   1831 	{
   1832 	  varobj_p c = VEC_index (varobj_p, v->children, i);
   1833 
   1834 	  /* Child may be NULL if explicitly deleted by -var-delete.  */
   1835 	  if (c != NULL && !c->frozen)
   1836 	    {
   1837 	      varobj_update_result r = {0};
   1838 
   1839 	      r.varobj = c;
   1840 	      VEC_safe_push (varobj_update_result, stack, &r);
   1841 	    }
   1842 	}
   1843 
   1844       if (r.changed || r.type_changed)
   1845 	VEC_safe_push (varobj_update_result, result, &r);
   1846     }
   1847 
   1848   VEC_free (varobj_update_result, stack);
   1849 
   1850   return result;
   1851 }
   1852 
   1853 
   1855 /* Helper functions */
   1856 
   1857 /*
   1858  * Variable object construction/destruction
   1859  */
   1860 
   1861 static int
   1862 delete_variable (struct cpstack **resultp, struct varobj *var,
   1863 		 int only_children_p)
   1864 {
   1865   int delcount = 0;
   1866 
   1867   delete_variable_1 (resultp, &delcount, var,
   1868 		     only_children_p, 1 /* remove_from_parent_p */ );
   1869 
   1870   return delcount;
   1871 }
   1872 
   1873 /* Delete the variable object VAR and its children.  */
   1874 /* IMPORTANT NOTE: If we delete a variable which is a child
   1875    and the parent is not removed we dump core.  It must be always
   1876    initially called with remove_from_parent_p set.  */
   1877 static void
   1878 delete_variable_1 (struct cpstack **resultp, int *delcountp,
   1879 		   struct varobj *var, int only_children_p,
   1880 		   int remove_from_parent_p)
   1881 {
   1882   int i;
   1883 
   1884   /* Delete any children of this variable, too.  */
   1885   for (i = 0; i < VEC_length (varobj_p, var->children); ++i)
   1886     {
   1887       varobj_p child = VEC_index (varobj_p, var->children, i);
   1888 
   1889       if (!child)
   1890 	continue;
   1891       if (!remove_from_parent_p)
   1892 	child->parent = NULL;
   1893       delete_variable_1 (resultp, delcountp, child, 0, only_children_p);
   1894     }
   1895   VEC_free (varobj_p, var->children);
   1896 
   1897   /* if we were called to delete only the children we are done here.  */
   1898   if (only_children_p)
   1899     return;
   1900 
   1901   /* Otherwise, add it to the list of deleted ones and proceed to do so.  */
   1902   /* If the name is null, this is a temporary variable, that has not
   1903      yet been installed, don't report it, it belongs to the caller...  */
   1904   if (var->obj_name != NULL)
   1905     {
   1906       cppush (resultp, xstrdup (var->obj_name));
   1907       *delcountp = *delcountp + 1;
   1908     }
   1909 
   1910   /* If this variable has a parent, remove it from its parent's list.  */
   1911   /* OPTIMIZATION: if the parent of this variable is also being deleted,
   1912      (as indicated by remove_from_parent_p) we don't bother doing an
   1913      expensive list search to find the element to remove when we are
   1914      discarding the list afterwards.  */
   1915   if ((remove_from_parent_p) && (var->parent != NULL))
   1916     {
   1917       VEC_replace (varobj_p, var->parent->children, var->index, NULL);
   1918     }
   1919 
   1920   if (var->obj_name != NULL)
   1921     uninstall_variable (var);
   1922 
   1923   /* Free memory associated with this variable.  */
   1924   free_variable (var);
   1925 }
   1926 
   1927 /* Install the given variable VAR with the object name VAR->OBJ_NAME.  */
   1928 static int
   1929 install_variable (struct varobj *var)
   1930 {
   1931   struct vlist *cv;
   1932   struct vlist *newvl;
   1933   const char *chp;
   1934   unsigned int index = 0;
   1935   unsigned int i = 1;
   1936 
   1937   for (chp = var->obj_name; *chp; chp++)
   1938     {
   1939       index = (index + (i++ * (unsigned int) *chp)) % VAROBJ_TABLE_SIZE;
   1940     }
   1941 
   1942   cv = *(varobj_table + index);
   1943   while ((cv != NULL) && (strcmp (cv->var->obj_name, var->obj_name) != 0))
   1944     cv = cv->next;
   1945 
   1946   if (cv != NULL)
   1947     error (_("Duplicate variable object name"));
   1948 
   1949   /* Add varobj to hash table.  */
   1950   newvl = xmalloc (sizeof (struct vlist));
   1951   newvl->next = *(varobj_table + index);
   1952   newvl->var = var;
   1953   *(varobj_table + index) = newvl;
   1954 
   1955   /* If root, add varobj to root list.  */
   1956   if (is_root_p (var))
   1957     {
   1958       /* Add to list of root variables.  */
   1959       if (rootlist == NULL)
   1960 	var->root->next = NULL;
   1961       else
   1962 	var->root->next = rootlist;
   1963       rootlist = var->root;
   1964     }
   1965 
   1966   return 1;			/* OK */
   1967 }
   1968 
   1969 /* Unistall the object VAR.  */
   1970 static void
   1971 uninstall_variable (struct varobj *var)
   1972 {
   1973   struct vlist *cv;
   1974   struct vlist *prev;
   1975   struct varobj_root *cr;
   1976   struct varobj_root *prer;
   1977   const char *chp;
   1978   unsigned int index = 0;
   1979   unsigned int i = 1;
   1980 
   1981   /* Remove varobj from hash table.  */
   1982   for (chp = var->obj_name; *chp; chp++)
   1983     {
   1984       index = (index + (i++ * (unsigned int) *chp)) % VAROBJ_TABLE_SIZE;
   1985     }
   1986 
   1987   cv = *(varobj_table + index);
   1988   prev = NULL;
   1989   while ((cv != NULL) && (strcmp (cv->var->obj_name, var->obj_name) != 0))
   1990     {
   1991       prev = cv;
   1992       cv = cv->next;
   1993     }
   1994 
   1995   if (varobjdebug)
   1996     fprintf_unfiltered (gdb_stdlog, "Deleting %s\n", var->obj_name);
   1997 
   1998   if (cv == NULL)
   1999     {
   2000       warning
   2001 	("Assertion failed: Could not find variable object \"%s\" to delete",
   2002 	 var->obj_name);
   2003       return;
   2004     }
   2005 
   2006   if (prev == NULL)
   2007     *(varobj_table + index) = cv->next;
   2008   else
   2009     prev->next = cv->next;
   2010 
   2011   xfree (cv);
   2012 
   2013   /* If root, remove varobj from root list.  */
   2014   if (is_root_p (var))
   2015     {
   2016       /* Remove from list of root variables.  */
   2017       if (rootlist == var->root)
   2018 	rootlist = var->root->next;
   2019       else
   2020 	{
   2021 	  prer = NULL;
   2022 	  cr = rootlist;
   2023 	  while ((cr != NULL) && (cr->rootvar != var))
   2024 	    {
   2025 	      prer = cr;
   2026 	      cr = cr->next;
   2027 	    }
   2028 	  if (cr == NULL)
   2029 	    {
   2030 	      warning (_("Assertion failed: Could not find "
   2031 		         "varobj \"%s\" in root list"),
   2032 		       var->obj_name);
   2033 	      return;
   2034 	    }
   2035 	  if (prer == NULL)
   2036 	    rootlist = NULL;
   2037 	  else
   2038 	    prer->next = cr->next;
   2039 	}
   2040     }
   2041 
   2042 }
   2043 
   2044 /* Create and install a child of the parent of the given name.  */
   2045 static struct varobj *
   2046 create_child (struct varobj *parent, int index, char *name)
   2047 {
   2048   struct varobj_item item;
   2049 
   2050   item.name = name;
   2051   item.value = value_of_child (parent, index);
   2052 
   2053   return create_child_with_value (parent, index, &item);
   2054 }
   2055 
   2056 static struct varobj *
   2057 create_child_with_value (struct varobj *parent, int index,
   2058 			 struct varobj_item *item)
   2059 {
   2060   struct varobj *child;
   2061   char *childs_name;
   2062 
   2063   child = new_variable ();
   2064 
   2065   /* NAME is allocated by caller.  */
   2066   child->name = item->name;
   2067   child->index = index;
   2068   child->parent = parent;
   2069   child->root = parent->root;
   2070 
   2071   if (varobj_is_anonymous_child (child))
   2072     childs_name = xstrprintf ("%s.%d_anonymous", parent->obj_name, index);
   2073   else
   2074     childs_name = xstrprintf ("%s.%s", parent->obj_name, item->name);
   2075   child->obj_name = childs_name;
   2076 
   2077   install_variable (child);
   2078 
   2079   /* Compute the type of the child.  Must do this before
   2080      calling install_new_value.  */
   2081   if (item->value != NULL)
   2082     /* If the child had no evaluation errors, var->value
   2083        will be non-NULL and contain a valid type.  */
   2084     child->type = value_actual_type (item->value, 0, NULL);
   2085   else
   2086     /* Otherwise, we must compute the type.  */
   2087     child->type = (*child->root->lang_ops->type_of_child) (child->parent,
   2088 							   child->index);
   2089   install_new_value (child, item->value, 1);
   2090 
   2091   return child;
   2092 }
   2093 
   2094 
   2096 /*
   2097  * Miscellaneous utility functions.
   2098  */
   2099 
   2100 /* Allocate memory and initialize a new variable.  */
   2101 static struct varobj *
   2102 new_variable (void)
   2103 {
   2104   struct varobj *var;
   2105 
   2106   var = (struct varobj *) xmalloc (sizeof (struct varobj));
   2107   var->name = NULL;
   2108   var->path_expr = NULL;
   2109   var->obj_name = NULL;
   2110   var->index = -1;
   2111   var->type = NULL;
   2112   var->value = NULL;
   2113   var->num_children = -1;
   2114   var->parent = NULL;
   2115   var->children = NULL;
   2116   var->format = 0;
   2117   var->root = NULL;
   2118   var->updated = 0;
   2119   var->print_value = NULL;
   2120   var->frozen = 0;
   2121   var->not_fetched = 0;
   2122   var->dynamic
   2123     = (struct varobj_dynamic *) xmalloc (sizeof (struct varobj_dynamic));
   2124   var->dynamic->children_requested = 0;
   2125   var->from = -1;
   2126   var->to = -1;
   2127   var->dynamic->constructor = 0;
   2128   var->dynamic->pretty_printer = 0;
   2129   var->dynamic->child_iter = 0;
   2130   var->dynamic->saved_item = 0;
   2131 
   2132   return var;
   2133 }
   2134 
   2135 /* Allocate memory and initialize a new root variable.  */
   2136 static struct varobj *
   2137 new_root_variable (void)
   2138 {
   2139   struct varobj *var = new_variable ();
   2140 
   2141   var->root = (struct varobj_root *) xmalloc (sizeof (struct varobj_root));
   2142   var->root->lang_ops = NULL;
   2143   var->root->exp = NULL;
   2144   var->root->valid_block = NULL;
   2145   var->root->frame = null_frame_id;
   2146   var->root->floating = 0;
   2147   var->root->rootvar = NULL;
   2148   var->root->is_valid = 1;
   2149 
   2150   return var;
   2151 }
   2152 
   2153 /* Free any allocated memory associated with VAR.  */
   2154 static void
   2155 free_variable (struct varobj *var)
   2156 {
   2157 #if HAVE_PYTHON
   2158   if (var->dynamic->pretty_printer != NULL)
   2159     {
   2160       struct cleanup *cleanup = varobj_ensure_python_env (var);
   2161 
   2162       Py_XDECREF (var->dynamic->constructor);
   2163       Py_XDECREF (var->dynamic->pretty_printer);
   2164       do_cleanups (cleanup);
   2165     }
   2166 #endif
   2167 
   2168   varobj_iter_delete (var->dynamic->child_iter);
   2169   varobj_clear_saved_item (var->dynamic);
   2170   value_free (var->value);
   2171 
   2172   /* Free the expression if this is a root variable.  */
   2173   if (is_root_p (var))
   2174     {
   2175       xfree (var->root->exp);
   2176       xfree (var->root);
   2177     }
   2178 
   2179   xfree (var->name);
   2180   xfree (var->obj_name);
   2181   xfree (var->print_value);
   2182   xfree (var->path_expr);
   2183   xfree (var->dynamic);
   2184   xfree (var);
   2185 }
   2186 
   2187 static void
   2188 do_free_variable_cleanup (void *var)
   2189 {
   2190   free_variable (var);
   2191 }
   2192 
   2193 static struct cleanup *
   2194 make_cleanup_free_variable (struct varobj *var)
   2195 {
   2196   return make_cleanup (do_free_variable_cleanup, var);
   2197 }
   2198 
   2199 /* Return the type of the value that's stored in VAR,
   2200    or that would have being stored there if the
   2201    value were accessible.
   2202 
   2203    This differs from VAR->type in that VAR->type is always
   2204    the true type of the expession in the source language.
   2205    The return value of this function is the type we're
   2206    actually storing in varobj, and using for displaying
   2207    the values and for comparing previous and new values.
   2208 
   2209    For example, top-level references are always stripped.  */
   2210 struct type *
   2211 varobj_get_value_type (struct varobj *var)
   2212 {
   2213   struct type *type;
   2214 
   2215   if (var->value)
   2216     type = value_type (var->value);
   2217   else
   2218     type = var->type;
   2219 
   2220   type = check_typedef (type);
   2221 
   2222   if (TYPE_CODE (type) == TYPE_CODE_REF)
   2223     type = get_target_type (type);
   2224 
   2225   type = check_typedef (type);
   2226 
   2227   return type;
   2228 }
   2229 
   2230 /* What is the default display for this variable? We assume that
   2231    everything is "natural".  Any exceptions?  */
   2232 static enum varobj_display_formats
   2233 variable_default_display (struct varobj *var)
   2234 {
   2235   return FORMAT_NATURAL;
   2236 }
   2237 
   2238 /* FIXME: The following should be generic for any pointer.  */
   2239 static void
   2240 cppush (struct cpstack **pstack, char *name)
   2241 {
   2242   struct cpstack *s;
   2243 
   2244   s = (struct cpstack *) xmalloc (sizeof (struct cpstack));
   2245   s->name = name;
   2246   s->next = *pstack;
   2247   *pstack = s;
   2248 }
   2249 
   2250 /* FIXME: The following should be generic for any pointer.  */
   2251 static char *
   2252 cppop (struct cpstack **pstack)
   2253 {
   2254   struct cpstack *s;
   2255   char *v;
   2256 
   2257   if ((*pstack)->name == NULL && (*pstack)->next == NULL)
   2258     return NULL;
   2259 
   2260   s = *pstack;
   2261   v = s->name;
   2262   *pstack = (*pstack)->next;
   2263   xfree (s);
   2264 
   2265   return v;
   2266 }
   2267 
   2268 /*
   2270  * Language-dependencies
   2271  */
   2272 
   2273 /* Common entry points */
   2274 
   2275 /* Return the number of children for a given variable.
   2276    The result of this function is defined by the language
   2277    implementation.  The number of children returned by this function
   2278    is the number of children that the user will see in the variable
   2279    display.  */
   2280 static int
   2281 number_of_children (struct varobj *var)
   2282 {
   2283   return (*var->root->lang_ops->number_of_children) (var);
   2284 }
   2285 
   2286 /* What is the expression for the root varobj VAR? Returns a malloc'd
   2287    string.  */
   2288 static char *
   2289 name_of_variable (struct varobj *var)
   2290 {
   2291   return (*var->root->lang_ops->name_of_variable) (var);
   2292 }
   2293 
   2294 /* What is the name of the INDEX'th child of VAR? Returns a malloc'd
   2295    string.  */
   2296 static char *
   2297 name_of_child (struct varobj *var, int index)
   2298 {
   2299   return (*var->root->lang_ops->name_of_child) (var, index);
   2300 }
   2301 
   2302 /* If frame associated with VAR can be found, switch
   2303    to it and return 1.  Otherwise, return 0.  */
   2304 
   2305 static int
   2306 check_scope (struct varobj *var)
   2307 {
   2308   struct frame_info *fi;
   2309   int scope;
   2310 
   2311   fi = frame_find_by_id (var->root->frame);
   2312   scope = fi != NULL;
   2313 
   2314   if (fi)
   2315     {
   2316       CORE_ADDR pc = get_frame_pc (fi);
   2317 
   2318       if (pc <  BLOCK_START (var->root->valid_block) ||
   2319 	  pc >= BLOCK_END (var->root->valid_block))
   2320 	scope = 0;
   2321       else
   2322 	select_frame (fi);
   2323     }
   2324   return scope;
   2325 }
   2326 
   2327 /* Helper function to value_of_root.  */
   2328 
   2329 static struct value *
   2330 value_of_root_1 (struct varobj **var_handle)
   2331 {
   2332   struct value *new_val = NULL;
   2333   struct varobj *var = *var_handle;
   2334   int within_scope = 0;
   2335   struct cleanup *back_to;
   2336 
   2337   /*  Only root variables can be updated...  */
   2338   if (!is_root_p (var))
   2339     /* Not a root var.  */
   2340     return NULL;
   2341 
   2342   back_to = make_cleanup_restore_current_thread ();
   2343 
   2344   /* Determine whether the variable is still around.  */
   2345   if (var->root->valid_block == NULL || var->root->floating)
   2346     within_scope = 1;
   2347   else if (var->root->thread_id == 0)
   2348     {
   2349       /* The program was single-threaded when the variable object was
   2350 	 created.  Technically, it's possible that the program became
   2351 	 multi-threaded since then, but we don't support such
   2352 	 scenario yet.  */
   2353       within_scope = check_scope (var);
   2354     }
   2355   else
   2356     {
   2357       ptid_t ptid = thread_id_to_pid (var->root->thread_id);
   2358       if (in_thread_list (ptid))
   2359 	{
   2360 	  switch_to_thread (ptid);
   2361 	  within_scope = check_scope (var);
   2362 	}
   2363     }
   2364 
   2365   if (within_scope)
   2366     {
   2367       volatile struct gdb_exception except;
   2368 
   2369       /* We need to catch errors here, because if evaluate
   2370          expression fails we want to just return NULL.  */
   2371       TRY_CATCH (except, RETURN_MASK_ERROR)
   2372 	{
   2373 	  new_val = evaluate_expression (var->root->exp);
   2374 	}
   2375     }
   2376 
   2377   do_cleanups (back_to);
   2378 
   2379   return new_val;
   2380 }
   2381 
   2382 /* What is the ``struct value *'' of the root variable VAR?
   2383    For floating variable object, evaluation can get us a value
   2384    of different type from what is stored in varobj already.  In
   2385    that case:
   2386    - *type_changed will be set to 1
   2387    - old varobj will be freed, and new one will be
   2388    created, with the same name.
   2389    - *var_handle will be set to the new varobj
   2390    Otherwise, *type_changed will be set to 0.  */
   2391 static struct value *
   2392 value_of_root (struct varobj **var_handle, int *type_changed)
   2393 {
   2394   struct varobj *var;
   2395 
   2396   if (var_handle == NULL)
   2397     return NULL;
   2398 
   2399   var = *var_handle;
   2400 
   2401   /* This should really be an exception, since this should
   2402      only get called with a root variable.  */
   2403 
   2404   if (!is_root_p (var))
   2405     return NULL;
   2406 
   2407   if (var->root->floating)
   2408     {
   2409       struct varobj *tmp_var;
   2410       char *old_type, *new_type;
   2411 
   2412       tmp_var = varobj_create (NULL, var->name, (CORE_ADDR) 0,
   2413 			       USE_SELECTED_FRAME);
   2414       if (tmp_var == NULL)
   2415 	{
   2416 	  return NULL;
   2417 	}
   2418       old_type = varobj_get_type (var);
   2419       new_type = varobj_get_type (tmp_var);
   2420       if (strcmp (old_type, new_type) == 0)
   2421 	{
   2422 	  /* The expression presently stored inside var->root->exp
   2423 	     remembers the locations of local variables relatively to
   2424 	     the frame where the expression was created (in DWARF location
   2425 	     button, for example).  Naturally, those locations are not
   2426 	     correct in other frames, so update the expression.  */
   2427 
   2428          struct expression *tmp_exp = var->root->exp;
   2429 
   2430          var->root->exp = tmp_var->root->exp;
   2431          tmp_var->root->exp = tmp_exp;
   2432 
   2433 	  varobj_delete (tmp_var, NULL, 0);
   2434 	  *type_changed = 0;
   2435 	}
   2436       else
   2437 	{
   2438 	  tmp_var->obj_name = xstrdup (var->obj_name);
   2439 	  tmp_var->from = var->from;
   2440 	  tmp_var->to = var->to;
   2441 	  varobj_delete (var, NULL, 0);
   2442 
   2443 	  install_variable (tmp_var);
   2444 	  *var_handle = tmp_var;
   2445 	  var = *var_handle;
   2446 	  *type_changed = 1;
   2447 	}
   2448       xfree (old_type);
   2449       xfree (new_type);
   2450     }
   2451   else
   2452     {
   2453       *type_changed = 0;
   2454     }
   2455 
   2456   {
   2457     struct value *value;
   2458 
   2459     value = value_of_root_1 (var_handle);
   2460     if (var->value == NULL || value == NULL)
   2461       {
   2462 	/* For root varobj-s, a NULL value indicates a scoping issue.
   2463 	   So, nothing to do in terms of checking for mutations.  */
   2464       }
   2465     else if (varobj_value_has_mutated (var, value, value_type (value)))
   2466       {
   2467 	/* The type has mutated, so the children are no longer valid.
   2468 	   Just delete them, and tell our caller that the type has
   2469 	   changed.  */
   2470 	varobj_delete (var, NULL, 1 /* only_children */);
   2471 	var->num_children = -1;
   2472 	var->to = -1;
   2473 	var->from = -1;
   2474 	*type_changed = 1;
   2475       }
   2476     return value;
   2477   }
   2478 }
   2479 
   2480 /* What is the ``struct value *'' for the INDEX'th child of PARENT?  */
   2481 static struct value *
   2482 value_of_child (struct varobj *parent, int index)
   2483 {
   2484   struct value *value;
   2485 
   2486   value = (*parent->root->lang_ops->value_of_child) (parent, index);
   2487 
   2488   return value;
   2489 }
   2490 
   2491 /* GDB already has a command called "value_of_variable".  Sigh.  */
   2492 static char *
   2493 my_value_of_variable (struct varobj *var, enum varobj_display_formats format)
   2494 {
   2495   if (var->root->is_valid)
   2496     {
   2497       if (var->dynamic->pretty_printer != NULL)
   2498 	return varobj_value_get_print_value (var->value, var->format, var);
   2499       return (*var->root->lang_ops->value_of_variable) (var, format);
   2500     }
   2501   else
   2502     return NULL;
   2503 }
   2504 
   2505 void
   2506 varobj_formatted_print_options (struct value_print_options *opts,
   2507 				enum varobj_display_formats format)
   2508 {
   2509   get_formatted_print_options (opts, format_code[(int) format]);
   2510   opts->deref_ref = 0;
   2511   opts->raw = 1;
   2512 }
   2513 
   2514 char *
   2515 varobj_value_get_print_value (struct value *value,
   2516 			      enum varobj_display_formats format,
   2517 			      struct varobj *var)
   2518 {
   2519   struct ui_file *stb;
   2520   struct cleanup *old_chain;
   2521   char *thevalue = NULL;
   2522   struct value_print_options opts;
   2523   struct type *type = NULL;
   2524   long len = 0;
   2525   char *encoding = NULL;
   2526   struct gdbarch *gdbarch = NULL;
   2527   /* Initialize it just to avoid a GCC false warning.  */
   2528   CORE_ADDR str_addr = 0;
   2529   int string_print = 0;
   2530 
   2531   if (value == NULL)
   2532     return NULL;
   2533 
   2534   stb = mem_fileopen ();
   2535   old_chain = make_cleanup_ui_file_delete (stb);
   2536 
   2537   gdbarch = get_type_arch (value_type (value));
   2538 #if HAVE_PYTHON
   2539   if (gdb_python_initialized)
   2540     {
   2541       PyObject *value_formatter =  var->dynamic->pretty_printer;
   2542 
   2543       varobj_ensure_python_env (var);
   2544 
   2545       if (value_formatter)
   2546 	{
   2547 	  /* First check to see if we have any children at all.  If so,
   2548 	     we simply return {...}.  */
   2549 	  if (dynamic_varobj_has_child_method (var))
   2550 	    {
   2551 	      do_cleanups (old_chain);
   2552 	      return xstrdup ("{...}");
   2553 	    }
   2554 
   2555 	  if (PyObject_HasAttr (value_formatter, gdbpy_to_string_cst))
   2556 	    {
   2557 	      struct value *replacement;
   2558 	      PyObject *output = NULL;
   2559 
   2560 	      output = apply_varobj_pretty_printer (value_formatter,
   2561 						    &replacement,
   2562 						    stb);
   2563 
   2564 	      /* If we have string like output ...  */
   2565 	      if (output)
   2566 		{
   2567 		  make_cleanup_py_decref (output);
   2568 
   2569 		  /* If this is a lazy string, extract it.  For lazy
   2570 		     strings we always print as a string, so set
   2571 		     string_print.  */
   2572 		  if (gdbpy_is_lazy_string (output))
   2573 		    {
   2574 		      gdbpy_extract_lazy_string (output, &str_addr, &type,
   2575 						 &len, &encoding);
   2576 		      make_cleanup (free_current_contents, &encoding);
   2577 		      string_print = 1;
   2578 		    }
   2579 		  else
   2580 		    {
   2581 		      /* If it is a regular (non-lazy) string, extract
   2582 			 it and copy the contents into THEVALUE.  If the
   2583 			 hint says to print it as a string, set
   2584 			 string_print.  Otherwise just return the extracted
   2585 			 string as a value.  */
   2586 
   2587 		      char *s = python_string_to_target_string (output);
   2588 
   2589 		      if (s)
   2590 			{
   2591 			  char *hint;
   2592 
   2593 			  hint = gdbpy_get_display_hint (value_formatter);
   2594 			  if (hint)
   2595 			    {
   2596 			      if (!strcmp (hint, "string"))
   2597 				string_print = 1;
   2598 			      xfree (hint);
   2599 			    }
   2600 
   2601 			  len = strlen (s);
   2602 			  thevalue = xmemdup (s, len + 1, len + 1);
   2603 			  type = builtin_type (gdbarch)->builtin_char;
   2604 			  xfree (s);
   2605 
   2606 			  if (!string_print)
   2607 			    {
   2608 			      do_cleanups (old_chain);
   2609 			      return thevalue;
   2610 			    }
   2611 
   2612 			  make_cleanup (xfree, thevalue);
   2613 			}
   2614 		      else
   2615 			gdbpy_print_stack ();
   2616 		    }
   2617 		}
   2618 	      /* If the printer returned a replacement value, set VALUE
   2619 		 to REPLACEMENT.  If there is not a replacement value,
   2620 		 just use the value passed to this function.  */
   2621 	      if (replacement)
   2622 		value = replacement;
   2623 	    }
   2624 	}
   2625     }
   2626 #endif
   2627 
   2628   varobj_formatted_print_options (&opts, format);
   2629 
   2630   /* If the THEVALUE has contents, it is a regular string.  */
   2631   if (thevalue)
   2632     LA_PRINT_STRING (stb, type, (gdb_byte *) thevalue, len, encoding, 0, &opts);
   2633   else if (string_print)
   2634     /* Otherwise, if string_print is set, and it is not a regular
   2635        string, it is a lazy string.  */
   2636     val_print_string (type, encoding, str_addr, len, stb, &opts);
   2637   else
   2638     /* All other cases.  */
   2639     common_val_print (value, stb, 0, &opts, current_language);
   2640 
   2641   thevalue = ui_file_xstrdup (stb, NULL);
   2642 
   2643   do_cleanups (old_chain);
   2644   return thevalue;
   2645 }
   2646 
   2647 int
   2648 varobj_editable_p (struct varobj *var)
   2649 {
   2650   struct type *type;
   2651 
   2652   if (!(var->root->is_valid && var->value && VALUE_LVAL (var->value)))
   2653     return 0;
   2654 
   2655   type = varobj_get_value_type (var);
   2656 
   2657   switch (TYPE_CODE (type))
   2658     {
   2659     case TYPE_CODE_STRUCT:
   2660     case TYPE_CODE_UNION:
   2661     case TYPE_CODE_ARRAY:
   2662     case TYPE_CODE_FUNC:
   2663     case TYPE_CODE_METHOD:
   2664       return 0;
   2665       break;
   2666 
   2667     default:
   2668       return 1;
   2669       break;
   2670     }
   2671 }
   2672 
   2673 /* Call VAR's value_is_changeable_p language-specific callback.  */
   2674 
   2675 int
   2676 varobj_value_is_changeable_p (struct varobj *var)
   2677 {
   2678   return var->root->lang_ops->value_is_changeable_p (var);
   2679 }
   2680 
   2681 /* Return 1 if that varobj is floating, that is is always evaluated in the
   2682    selected frame, and not bound to thread/frame.  Such variable objects
   2683    are created using '@' as frame specifier to -var-create.  */
   2684 int
   2685 varobj_floating_p (struct varobj *var)
   2686 {
   2687   return var->root->floating;
   2688 }
   2689 
   2690 /* Implement the "value_is_changeable_p" varobj callback for most
   2691    languages.  */
   2692 
   2693 int
   2694 varobj_default_value_is_changeable_p (struct varobj *var)
   2695 {
   2696   int r;
   2697   struct type *type;
   2698 
   2699   if (CPLUS_FAKE_CHILD (var))
   2700     return 0;
   2701 
   2702   type = varobj_get_value_type (var);
   2703 
   2704   switch (TYPE_CODE (type))
   2705     {
   2706     case TYPE_CODE_STRUCT:
   2707     case TYPE_CODE_UNION:
   2708     case TYPE_CODE_ARRAY:
   2709       r = 0;
   2710       break;
   2711 
   2712     default:
   2713       r = 1;
   2714     }
   2715 
   2716   return r;
   2717 }
   2718 
   2719 /* Iterate all the existing _root_ VAROBJs and call the FUNC callback for them
   2720    with an arbitrary caller supplied DATA pointer.  */
   2721 
   2722 void
   2723 all_root_varobjs (void (*func) (struct varobj *var, void *data), void *data)
   2724 {
   2725   struct varobj_root *var_root, *var_root_next;
   2726 
   2727   /* Iterate "safely" - handle if the callee deletes its passed VAROBJ.  */
   2728 
   2729   for (var_root = rootlist; var_root != NULL; var_root = var_root_next)
   2730     {
   2731       var_root_next = var_root->next;
   2732 
   2733       (*func) (var_root->rootvar, data);
   2734     }
   2735 }
   2736 
   2737 /* Invalidate varobj VAR if it is tied to locals and re-create it if it is
   2738    defined on globals.  It is a helper for varobj_invalidate.
   2739 
   2740    This function is called after changing the symbol file, in this case the
   2741    pointers to "struct type" stored by the varobj are no longer valid.  All
   2742    varobj must be either re-evaluated, or marked as invalid here.  */
   2743 
   2744 static void
   2745 varobj_invalidate_iter (struct varobj *var, void *unused)
   2746 {
   2747   /* global and floating var must be re-evaluated.  */
   2748   if (var->root->floating || var->root->valid_block == NULL)
   2749     {
   2750       struct varobj *tmp_var;
   2751 
   2752       /* Try to create a varobj with same expression.  If we succeed
   2753 	 replace the old varobj, otherwise invalidate it.  */
   2754       tmp_var = varobj_create (NULL, var->name, (CORE_ADDR) 0,
   2755 			       USE_CURRENT_FRAME);
   2756       if (tmp_var != NULL)
   2757 	{
   2758 	  tmp_var->obj_name = xstrdup (var->obj_name);
   2759 	  varobj_delete (var, NULL, 0);
   2760 	  install_variable (tmp_var);
   2761 	}
   2762       else
   2763 	var->root->is_valid = 0;
   2764     }
   2765   else /* locals must be invalidated.  */
   2766     var->root->is_valid = 0;
   2767 }
   2768 
   2769 /* Invalidate the varobjs that are tied to locals and re-create the ones that
   2770    are defined on globals.
   2771    Invalidated varobjs will be always printed in_scope="invalid".  */
   2772 
   2773 void
   2774 varobj_invalidate (void)
   2775 {
   2776   all_root_varobjs (varobj_invalidate_iter, NULL);
   2777 }
   2778 
   2779 extern void _initialize_varobj (void);
   2781 void
   2782 _initialize_varobj (void)
   2783 {
   2784   int sizeof_table = sizeof (struct vlist *) * VAROBJ_TABLE_SIZE;
   2785 
   2786   varobj_table = xmalloc (sizeof_table);
   2787   memset (varobj_table, 0, sizeof_table);
   2788 
   2789   add_setshow_zuinteger_cmd ("varobj", class_maintenance,
   2790 			     &varobjdebug,
   2791 			     _("Set varobj debugging."),
   2792 			     _("Show varobj debugging."),
   2793 			     _("When non-zero, varobj debugging is enabled."),
   2794 			     NULL, show_varobjdebug,
   2795 			     &setdebuglist, &showdebuglist);
   2796 }
   2797