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