2012-01-11 Pedro Alves <palves@redhat.com>
[deliverable/binutils-gdb.git] / gdb / varobj.c
CommitLineData
8b93c638 1/* Implementation of the GDB variable objects API.
bc8332bb 2
c5a57081 3 Copyright (C) 1999-2012 Free Software Foundation, Inc.
8b93c638
JM
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
a9762ec7 7 the Free Software Foundation; either version 3 of the License, or
8b93c638
JM
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
a9762ec7 16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
8b93c638
JM
17
18#include "defs.h"
a6c442d8 19#include "exceptions.h"
8b93c638
JM
20#include "value.h"
21#include "expression.h"
22#include "frame.h"
8b93c638 23#include "language.h"
8b93c638 24#include "gdbcmd.h"
d2353924 25#include "block.h"
79a45b7d 26#include "valprint.h"
a6c442d8
MK
27
28#include "gdb_assert.h"
b66d6d2e 29#include "gdb_string.h"
0cc7d26f 30#include "gdb_regex.h"
8b93c638
JM
31
32#include "varobj.h"
28335dcc 33#include "vec.h"
6208b47d
VP
34#include "gdbthread.h"
35#include "inferior.h"
8b93c638 36
b6313243
TT
37#if HAVE_PYTHON
38#include "python/python.h"
39#include "python/python-internal.h"
50389644
PA
40#else
41typedef int PyObject;
b6313243
TT
42#endif
43
8b93c638
JM
44/* Non-zero if we want to see trace of varobj level stuff. */
45
46int varobjdebug = 0;
920d2a44
AC
47static void
48show_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}
8b93c638 53
581e13c1 54/* String representations of gdb's format codes. */
8b93c638 55char *varobj_format_string[] =
72330bd6 56 { "natural", "binary", "decimal", "hexadecimal", "octal" };
8b93c638 57
581e13c1 58/* String representations of gdb's known languages. */
72330bd6 59char *varobj_language_string[] = { "unknown", "C", "C++", "Java" };
8b93c638 60
0cc7d26f
TT
61/* True if we want to allow Python-based pretty-printing. */
62static int pretty_printing = 0;
63
64void
65varobj_enable_pretty_printing (void)
66{
67 pretty_printing = 1;
68}
69
8b93c638
JM
70/* Data structures */
71
72/* Every root variable has one of these structures saved in its
581e13c1 73 varobj. Members which must be free'd are noted. */
8b93c638 74struct varobj_root
72330bd6 75{
8b93c638 76
581e13c1 77 /* Alloc'd expression for this parent. */
72330bd6 78 struct expression *exp;
8b93c638 79
581e13c1 80 /* Block for which this expression is valid. */
72330bd6 81 struct block *valid_block;
8b93c638 82
44a67aa7
VP
83 /* The frame for this expression. This field is set iff valid_block is
84 not NULL. */
e64d9b3d 85 struct frame_id frame;
8b93c638 86
c5b48eac 87 /* The thread ID that this varobj_root belong to. This field
581e13c1 88 is only valid if valid_block is not NULL.
c5b48eac
VP
89 When not 0, indicates which thread 'frame' belongs to.
90 When 0, indicates that the thread list was empty when the varobj_root
91 was created. */
92 int thread_id;
93
a5defcdc
VP
94 /* If 1, the -var-update always recomputes the value in the
95 current thread and frame. Otherwise, variable object is
581e13c1 96 always updated in the specific scope/thread/frame. */
a5defcdc 97 int floating;
73a93a32 98
8756216b
DP
99 /* Flag that indicates validity: set to 0 when this varobj_root refers
100 to symbols that do not exist anymore. */
101 int is_valid;
102
581e13c1 103 /* Language info for this variable and its children. */
72330bd6 104 struct language_specific *lang;
8b93c638 105
581e13c1 106 /* The varobj for this root node. */
72330bd6 107 struct varobj *rootvar;
8b93c638 108
72330bd6
AC
109 /* Next root variable */
110 struct varobj_root *next;
111};
8b93c638
JM
112
113/* Every variable in the system has a structure of this type defined
581e13c1
MS
114 for it. This structure holds all information necessary to manipulate
115 a particular object variable. Members which must be freed are noted. */
8b93c638 116struct varobj
72330bd6 117{
8b93c638 118
581e13c1 119 /* Alloc'd name of the variable for this object. If this variable is a
72330bd6 120 child, then this name will be the child's source name.
581e13c1
MS
121 (bar, not foo.bar). */
122 /* NOTE: This is the "expression". */
72330bd6 123 char *name;
8b93c638 124
02142340
VP
125 /* Alloc'd expression for this child. Can be used to create a
126 root variable corresponding to this child. */
127 char *path_expr;
128
581e13c1
MS
129 /* The alloc'd name for this variable's object. This is here for
130 convenience when constructing this object's children. */
72330bd6 131 char *obj_name;
8b93c638 132
581e13c1 133 /* Index of this variable in its parent or -1. */
72330bd6 134 int index;
8b93c638 135
202ddcaa
VP
136 /* The type of this variable. This can be NULL
137 for artifial variable objects -- currently, the "accessibility"
138 variable objects in C++. */
72330bd6 139 struct type *type;
8b93c638 140
b20d8971
VP
141 /* The value of this expression or subexpression. A NULL value
142 indicates there was an error getting this value.
b2c2bd75
VP
143 Invariant: if varobj_value_is_changeable_p (this) is non-zero,
144 the value is either NULL, or not lazy. */
30b28db1 145 struct value *value;
8b93c638 146
581e13c1 147 /* The number of (immediate) children this variable has. */
72330bd6 148 int num_children;
8b93c638 149
581e13c1 150 /* If this object is a child, this points to its immediate parent. */
72330bd6 151 struct varobj *parent;
8b93c638 152
28335dcc
VP
153 /* Children of this object. */
154 VEC (varobj_p) *children;
8b93c638 155
b6313243
TT
156 /* Whether the children of this varobj were requested. This field is
157 used to decide if dynamic varobj should recompute their children.
158 In the event that the frontend never asked for the children, we
159 can avoid that. */
160 int children_requested;
161
581e13c1
MS
162 /* Description of the root variable. Points to root variable for
163 children. */
72330bd6 164 struct varobj_root *root;
8b93c638 165
581e13c1 166 /* The format of the output for this object. */
72330bd6 167 enum varobj_display_formats format;
fb9b6b35 168
581e13c1 169 /* Was this variable updated via a varobj_set_value operation. */
fb9b6b35 170 int updated;
85265413
NR
171
172 /* Last print value. */
173 char *print_value;
25d5ea92
VP
174
175 /* Is this variable frozen. Frozen variables are never implicitly
176 updated by -var-update *
177 or -var-update <direct-or-indirect-parent>. */
178 int frozen;
179
180 /* Is the value of this variable intentionally not fetched? It is
181 not fetched if either the variable is frozen, or any parents is
182 frozen. */
183 int not_fetched;
b6313243 184
0cc7d26f
TT
185 /* Sub-range of children which the MI consumer has requested. If
186 FROM < 0 or TO < 0, means that all children have been
187 requested. */
188 int from;
189 int to;
190
191 /* The pretty-printer constructor. If NULL, then the default
192 pretty-printer will be looked up. If None, then no
193 pretty-printer will be installed. */
194 PyObject *constructor;
195
b6313243
TT
196 /* The pretty-printer that has been constructed. If NULL, then a
197 new printer object is needed, and one will be constructed. */
198 PyObject *pretty_printer;
0cc7d26f
TT
199
200 /* The iterator returned by the printer's 'children' method, or NULL
201 if not available. */
202 PyObject *child_iter;
203
204 /* We request one extra item from the iterator, so that we can
205 report to the caller whether there are more items than we have
206 already reported. However, we don't want to install this value
207 when we read it, because that will mess up future updates. So,
208 we stash it here instead. */
209 PyObject *saved_item;
72330bd6 210};
8b93c638 211
8b93c638 212struct cpstack
72330bd6
AC
213{
214 char *name;
215 struct cpstack *next;
216};
8b93c638
JM
217
218/* A list of varobjs */
219
220struct vlist
72330bd6
AC
221{
222 struct varobj *var;
223 struct vlist *next;
224};
8b93c638
JM
225
226/* Private function prototypes */
227
581e13c1 228/* Helper functions for the above subcommands. */
8b93c638 229
a14ed312 230static int delete_variable (struct cpstack **, struct varobj *, int);
8b93c638 231
a14ed312
KB
232static void delete_variable_1 (struct cpstack **, int *,
233 struct varobj *, int, int);
8b93c638 234
a14ed312 235static int install_variable (struct varobj *);
8b93c638 236
a14ed312 237static void uninstall_variable (struct varobj *);
8b93c638 238
a14ed312 239static struct varobj *create_child (struct varobj *, int, char *);
8b93c638 240
b6313243
TT
241static struct varobj *
242create_child_with_value (struct varobj *parent, int index, const char *name,
243 struct value *value);
244
8b93c638
JM
245/* Utility routines */
246
a14ed312 247static struct varobj *new_variable (void);
8b93c638 248
a14ed312 249static struct varobj *new_root_variable (void);
8b93c638 250
a14ed312 251static void free_variable (struct varobj *var);
8b93c638 252
74b7792f
AC
253static struct cleanup *make_cleanup_free_variable (struct varobj *var);
254
a14ed312 255static struct type *get_type (struct varobj *var);
8b93c638 256
6e2a9270
VP
257static struct type *get_value_type (struct varobj *var);
258
a14ed312 259static struct type *get_target_type (struct type *);
8b93c638 260
a14ed312 261static enum varobj_display_formats variable_default_display (struct varobj *);
8b93c638 262
a14ed312 263static void cppush (struct cpstack **pstack, char *name);
8b93c638 264
a14ed312 265static char *cppop (struct cpstack **pstack);
8b93c638 266
acd65feb
VP
267static int install_new_value (struct varobj *var, struct value *value,
268 int initial);
269
581e13c1 270/* Language-specific routines. */
8b93c638 271
a14ed312 272static enum varobj_languages variable_language (struct varobj *var);
8b93c638 273
a14ed312 274static int number_of_children (struct varobj *);
8b93c638 275
a14ed312 276static char *name_of_variable (struct varobj *);
8b93c638 277
a14ed312 278static char *name_of_child (struct varobj *, int);
8b93c638 279
30b28db1 280static struct value *value_of_root (struct varobj **var_handle, int *);
8b93c638 281
30b28db1 282static struct value *value_of_child (struct varobj *parent, int index);
8b93c638 283
de051565
MK
284static char *my_value_of_variable (struct varobj *var,
285 enum varobj_display_formats format);
8b93c638 286
85265413 287static char *value_get_print_value (struct value *value,
b6313243 288 enum varobj_display_formats format,
d452c4bc 289 struct varobj *var);
85265413 290
b2c2bd75
VP
291static int varobj_value_is_changeable_p (struct varobj *var);
292
293static int is_root_p (struct varobj *var);
8b93c638 294
d8b65138
JK
295#if HAVE_PYTHON
296
9a1edae6
PM
297static struct varobj *varobj_add_child (struct varobj *var,
298 const char *name,
299 struct value *value);
b6313243 300
d8b65138
JK
301#endif /* HAVE_PYTHON */
302
8b93c638
JM
303/* C implementation */
304
a14ed312 305static int c_number_of_children (struct varobj *var);
8b93c638 306
a14ed312 307static char *c_name_of_variable (struct varobj *parent);
8b93c638 308
a14ed312 309static char *c_name_of_child (struct varobj *parent, int index);
8b93c638 310
02142340
VP
311static char *c_path_expr_of_child (struct varobj *child);
312
30b28db1 313static struct value *c_value_of_root (struct varobj **var_handle);
8b93c638 314
30b28db1 315static struct value *c_value_of_child (struct varobj *parent, int index);
8b93c638 316
a14ed312 317static struct type *c_type_of_child (struct varobj *parent, int index);
8b93c638 318
de051565
MK
319static char *c_value_of_variable (struct varobj *var,
320 enum varobj_display_formats format);
8b93c638
JM
321
322/* C++ implementation */
323
a14ed312 324static int cplus_number_of_children (struct varobj *var);
8b93c638 325
a14ed312 326static void cplus_class_num_children (struct type *type, int children[3]);
8b93c638 327
a14ed312 328static char *cplus_name_of_variable (struct varobj *parent);
8b93c638 329
a14ed312 330static char *cplus_name_of_child (struct varobj *parent, int index);
8b93c638 331
02142340
VP
332static char *cplus_path_expr_of_child (struct varobj *child);
333
30b28db1 334static struct value *cplus_value_of_root (struct varobj **var_handle);
8b93c638 335
30b28db1 336static struct value *cplus_value_of_child (struct varobj *parent, int index);
8b93c638 337
a14ed312 338static struct type *cplus_type_of_child (struct varobj *parent, int index);
8b93c638 339
de051565
MK
340static char *cplus_value_of_variable (struct varobj *var,
341 enum varobj_display_formats format);
8b93c638
JM
342
343/* Java implementation */
344
a14ed312 345static int java_number_of_children (struct varobj *var);
8b93c638 346
a14ed312 347static char *java_name_of_variable (struct varobj *parent);
8b93c638 348
a14ed312 349static char *java_name_of_child (struct varobj *parent, int index);
8b93c638 350
02142340
VP
351static char *java_path_expr_of_child (struct varobj *child);
352
30b28db1 353static struct value *java_value_of_root (struct varobj **var_handle);
8b93c638 354
30b28db1 355static struct value *java_value_of_child (struct varobj *parent, int index);
8b93c638 356
a14ed312 357static struct type *java_type_of_child (struct varobj *parent, int index);
8b93c638 358
de051565
MK
359static char *java_value_of_variable (struct varobj *var,
360 enum varobj_display_formats format);
8b93c638 361
40591b7d
JCD
362/* Ada implementation */
363
364static int ada_number_of_children (struct varobj *var);
365
366static char *ada_name_of_variable (struct varobj *parent);
367
368static char *ada_name_of_child (struct varobj *parent, int index);
369
370static char *ada_path_expr_of_child (struct varobj *child);
371
372static struct value *ada_value_of_root (struct varobj **var_handle);
373
374static struct value *ada_value_of_child (struct varobj *parent, int index);
375
376static struct type *ada_type_of_child (struct varobj *parent, int index);
377
378static char *ada_value_of_variable (struct varobj *var,
379 enum varobj_display_formats format);
380
8b93c638
JM
381/* The language specific vector */
382
383struct language_specific
72330bd6 384{
8b93c638 385
581e13c1 386 /* The language of this variable. */
72330bd6 387 enum varobj_languages language;
8b93c638 388
581e13c1 389 /* The number of children of PARENT. */
72330bd6 390 int (*number_of_children) (struct varobj * parent);
8b93c638 391
581e13c1 392 /* The name (expression) of a root varobj. */
72330bd6 393 char *(*name_of_variable) (struct varobj * parent);
8b93c638 394
581e13c1 395 /* The name of the INDEX'th child of PARENT. */
72330bd6 396 char *(*name_of_child) (struct varobj * parent, int index);
8b93c638 397
02142340
VP
398 /* Returns the rooted expression of CHILD, which is a variable
399 obtain that has some parent. */
400 char *(*path_expr_of_child) (struct varobj * child);
401
581e13c1 402 /* The ``struct value *'' of the root variable ROOT. */
30b28db1 403 struct value *(*value_of_root) (struct varobj ** root_handle);
8b93c638 404
581e13c1 405 /* The ``struct value *'' of the INDEX'th child of PARENT. */
30b28db1 406 struct value *(*value_of_child) (struct varobj * parent, int index);
8b93c638 407
581e13c1 408 /* The type of the INDEX'th child of PARENT. */
72330bd6 409 struct type *(*type_of_child) (struct varobj * parent, int index);
8b93c638 410
581e13c1 411 /* The current value of VAR. */
de051565
MK
412 char *(*value_of_variable) (struct varobj * var,
413 enum varobj_display_formats format);
72330bd6 414};
8b93c638 415
581e13c1 416/* Array of known source language routines. */
d5d6fca5 417static struct language_specific languages[vlang_end] = {
581e13c1 418 /* Unknown (try treating as C). */
8b93c638 419 {
72330bd6
AC
420 vlang_unknown,
421 c_number_of_children,
422 c_name_of_variable,
423 c_name_of_child,
02142340 424 c_path_expr_of_child,
72330bd6
AC
425 c_value_of_root,
426 c_value_of_child,
427 c_type_of_child,
72330bd6 428 c_value_of_variable}
8b93c638
JM
429 ,
430 /* C */
431 {
72330bd6
AC
432 vlang_c,
433 c_number_of_children,
434 c_name_of_variable,
435 c_name_of_child,
02142340 436 c_path_expr_of_child,
72330bd6
AC
437 c_value_of_root,
438 c_value_of_child,
439 c_type_of_child,
72330bd6 440 c_value_of_variable}
8b93c638
JM
441 ,
442 /* C++ */
443 {
72330bd6
AC
444 vlang_cplus,
445 cplus_number_of_children,
446 cplus_name_of_variable,
447 cplus_name_of_child,
02142340 448 cplus_path_expr_of_child,
72330bd6
AC
449 cplus_value_of_root,
450 cplus_value_of_child,
451 cplus_type_of_child,
72330bd6 452 cplus_value_of_variable}
8b93c638
JM
453 ,
454 /* Java */
455 {
72330bd6
AC
456 vlang_java,
457 java_number_of_children,
458 java_name_of_variable,
459 java_name_of_child,
02142340 460 java_path_expr_of_child,
72330bd6
AC
461 java_value_of_root,
462 java_value_of_child,
463 java_type_of_child,
40591b7d
JCD
464 java_value_of_variable},
465 /* Ada */
466 {
467 vlang_ada,
468 ada_number_of_children,
469 ada_name_of_variable,
470 ada_name_of_child,
471 ada_path_expr_of_child,
472 ada_value_of_root,
473 ada_value_of_child,
474 ada_type_of_child,
475 ada_value_of_variable}
8b93c638
JM
476};
477
581e13c1 478/* A little convenience enum for dealing with C++/Java. */
8b93c638 479enum vsections
72330bd6
AC
480{
481 v_public = 0, v_private, v_protected
482};
8b93c638
JM
483
484/* Private data */
485
581e13c1 486/* Mappings of varobj_display_formats enums to gdb's format codes. */
72330bd6 487static int format_code[] = { 0, 't', 'd', 'x', 'o' };
8b93c638 488
581e13c1 489/* Header of the list of root variable objects. */
8b93c638 490static struct varobj_root *rootlist;
8b93c638 491
581e13c1
MS
492/* Prime number indicating the number of buckets in the hash table. */
493/* A prime large enough to avoid too many colisions. */
8b93c638
JM
494#define VAROBJ_TABLE_SIZE 227
495
581e13c1 496/* Pointer to the varobj hash table (built at run time). */
8b93c638
JM
497static struct vlist **varobj_table;
498
581e13c1 499/* Is the variable X one of our "fake" children? */
8b93c638
JM
500#define CPLUS_FAKE_CHILD(x) \
501((x) != NULL && (x)->type == NULL && (x)->value == NULL)
502\f
503
504/* API Implementation */
b2c2bd75
VP
505static int
506is_root_p (struct varobj *var)
507{
508 return (var->root->rootvar == var);
509}
8b93c638 510
d452c4bc
UW
511#ifdef HAVE_PYTHON
512/* Helper function to install a Python environment suitable for
513 use during operations on VAR. */
514struct cleanup *
515varobj_ensure_python_env (struct varobj *var)
516{
517 return ensure_python_env (var->root->exp->gdbarch,
518 var->root->exp->language_defn);
519}
520#endif
521
581e13c1 522/* Creates a varobj (not its children). */
8b93c638 523
7d8547c9
AC
524/* Return the full FRAME which corresponds to the given CORE_ADDR
525 or NULL if no FRAME on the chain corresponds to CORE_ADDR. */
526
527static struct frame_info *
528find_frame_addr_in_frame_chain (CORE_ADDR frame_addr)
529{
530 struct frame_info *frame = NULL;
531
532 if (frame_addr == (CORE_ADDR) 0)
533 return NULL;
534
9d49bdc2
PA
535 for (frame = get_current_frame ();
536 frame != NULL;
537 frame = get_prev_frame (frame))
7d8547c9 538 {
1fac167a
UW
539 /* The CORE_ADDR we get as argument was parsed from a string GDB
540 output as $fp. This output got truncated to gdbarch_addr_bit.
541 Truncate the frame base address in the same manner before
542 comparing it against our argument. */
543 CORE_ADDR frame_base = get_frame_base_address (frame);
544 int addr_bit = gdbarch_addr_bit (get_frame_arch (frame));
a109c7c1 545
1fac167a
UW
546 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
547 frame_base &= ((CORE_ADDR) 1 << addr_bit) - 1;
548
549 if (frame_base == frame_addr)
7d8547c9
AC
550 return frame;
551 }
9d49bdc2
PA
552
553 return NULL;
7d8547c9
AC
554}
555
8b93c638
JM
556struct varobj *
557varobj_create (char *objname,
72330bd6 558 char *expression, CORE_ADDR frame, enum varobj_type type)
8b93c638
JM
559{
560 struct varobj *var;
8b93c638
JM
561 struct cleanup *old_chain;
562
581e13c1 563 /* Fill out a varobj structure for the (root) variable being constructed. */
8b93c638 564 var = new_root_variable ();
74b7792f 565 old_chain = make_cleanup_free_variable (var);
8b93c638
JM
566
567 if (expression != NULL)
568 {
e4195b40 569 struct frame_info *fi;
35633fef 570 struct frame_id old_id = null_frame_id;
e4195b40 571 struct block *block;
8b93c638
JM
572 char *p;
573 enum varobj_languages lang;
e55dccf0 574 struct value *value = NULL;
8e7b59a5 575 volatile struct gdb_exception except;
8b93c638 576
9d49bdc2
PA
577 /* Parse and evaluate the expression, filling in as much of the
578 variable's data as possible. */
579
580 if (has_stack_frames ())
581 {
581e13c1 582 /* Allow creator to specify context of variable. */
9d49bdc2
PA
583 if ((type == USE_CURRENT_FRAME) || (type == USE_SELECTED_FRAME))
584 fi = get_selected_frame (NULL);
585 else
586 /* FIXME: cagney/2002-11-23: This code should be doing a
587 lookup using the frame ID and not just the frame's
588 ``address''. This, of course, means an interface
589 change. However, with out that interface change ISAs,
590 such as the ia64 with its two stacks, won't work.
591 Similar goes for the case where there is a frameless
592 function. */
593 fi = find_frame_addr_in_frame_chain (frame);
594 }
8b93c638 595 else
9d49bdc2 596 fi = NULL;
8b93c638 597
581e13c1 598 /* frame = -2 means always use selected frame. */
73a93a32 599 if (type == USE_SELECTED_FRAME)
a5defcdc 600 var->root->floating = 1;
73a93a32 601
8b93c638
JM
602 block = NULL;
603 if (fi != NULL)
ae767bfb 604 block = get_frame_block (fi, 0);
8b93c638
JM
605
606 p = expression;
607 innermost_block = NULL;
73a93a32 608 /* Wrap the call to parse expression, so we can
581e13c1 609 return a sensible error. */
8e7b59a5
KS
610 TRY_CATCH (except, RETURN_MASK_ERROR)
611 {
612 var->root->exp = parse_exp_1 (&p, block, 0);
613 }
614
615 if (except.reason < 0)
73a93a32 616 {
f748fb40 617 do_cleanups (old_chain);
73a93a32
JI
618 return NULL;
619 }
8b93c638 620
581e13c1 621 /* Don't allow variables to be created for types. */
8b93c638
JM
622 if (var->root->exp->elts[0].opcode == OP_TYPE)
623 {
624 do_cleanups (old_chain);
bc8332bb
AC
625 fprintf_unfiltered (gdb_stderr, "Attempt to use a type name"
626 " as an expression.\n");
8b93c638
JM
627 return NULL;
628 }
629
630 var->format = variable_default_display (var);
631 var->root->valid_block = innermost_block;
1b36a34b 632 var->name = xstrdup (expression);
02142340 633 /* For a root var, the name and the expr are the same. */
1b36a34b 634 var->path_expr = xstrdup (expression);
8b93c638
JM
635
636 /* When the frame is different from the current frame,
637 we must select the appropriate frame before parsing
638 the expression, otherwise the value will not be current.
581e13c1 639 Since select_frame is so benign, just call it for all cases. */
4e22772d 640 if (innermost_block)
8b93c638 641 {
4e22772d
JK
642 /* User could specify explicit FRAME-ADDR which was not found but
643 EXPRESSION is frame specific and we would not be able to evaluate
644 it correctly next time. With VALID_BLOCK set we must also set
645 FRAME and THREAD_ID. */
646 if (fi == NULL)
647 error (_("Failed to find the specified frame"));
648
7a424e99 649 var->root->frame = get_frame_id (fi);
c5b48eac 650 var->root->thread_id = pid_to_thread_id (inferior_ptid);
35633fef 651 old_id = get_frame_id (get_selected_frame (NULL));
c5b48eac 652 select_frame (fi);
8b93c638
JM
653 }
654
340a7723 655 /* We definitely need to catch errors here.
8b93c638 656 If evaluate_expression succeeds we got the value we wanted.
581e13c1 657 But if it fails, we still go on with a call to evaluate_type(). */
8e7b59a5
KS
658 TRY_CATCH (except, RETURN_MASK_ERROR)
659 {
660 value = evaluate_expression (var->root->exp);
661 }
662
663 if (except.reason < 0)
e55dccf0
VP
664 {
665 /* Error getting the value. Try to at least get the
666 right type. */
667 struct value *type_only_value = evaluate_type (var->root->exp);
a109c7c1 668
e55dccf0
VP
669 var->type = value_type (type_only_value);
670 }
671 else
672 var->type = value_type (value);
acd65feb 673
acd65feb 674 install_new_value (var, value, 1 /* Initial assignment */);
8b93c638
JM
675
676 /* Set language info */
677 lang = variable_language (var);
d5d6fca5 678 var->root->lang = &languages[lang];
8b93c638 679
581e13c1 680 /* Set ourselves as our root. */
8b93c638
JM
681 var->root->rootvar = var;
682
581e13c1 683 /* Reset the selected frame. */
35633fef
JK
684 if (frame_id_p (old_id))
685 select_frame (frame_find_by_id (old_id));
8b93c638
JM
686 }
687
73a93a32 688 /* If the variable object name is null, that means this
581e13c1 689 is a temporary variable, so don't install it. */
73a93a32
JI
690
691 if ((var != NULL) && (objname != NULL))
8b93c638 692 {
1b36a34b 693 var->obj_name = xstrdup (objname);
8b93c638
JM
694
695 /* If a varobj name is duplicated, the install will fail so
581e13c1 696 we must cleanup. */
8b93c638
JM
697 if (!install_variable (var))
698 {
699 do_cleanups (old_chain);
700 return NULL;
701 }
702 }
703
704 discard_cleanups (old_chain);
705 return var;
706}
707
581e13c1 708/* Generates an unique name that can be used for a varobj. */
8b93c638
JM
709
710char *
711varobj_gen_name (void)
712{
713 static int id = 0;
e64d9b3d 714 char *obj_name;
8b93c638 715
581e13c1 716 /* Generate a name for this object. */
8b93c638 717 id++;
b435e160 718 obj_name = xstrprintf ("var%d", id);
8b93c638 719
e64d9b3d 720 return obj_name;
8b93c638
JM
721}
722
61d8f275
JK
723/* Given an OBJNAME, returns the pointer to the corresponding varobj. Call
724 error if OBJNAME cannot be found. */
8b93c638
JM
725
726struct varobj *
727varobj_get_handle (char *objname)
728{
729 struct vlist *cv;
730 const char *chp;
731 unsigned int index = 0;
732 unsigned int i = 1;
733
734 for (chp = objname; *chp; chp++)
735 {
736 index = (index + (i++ * (unsigned int) *chp)) % VAROBJ_TABLE_SIZE;
737 }
738
739 cv = *(varobj_table + index);
740 while ((cv != NULL) && (strcmp (cv->var->obj_name, objname) != 0))
741 cv = cv->next;
742
743 if (cv == NULL)
8a3fe4f8 744 error (_("Variable object not found"));
8b93c638
JM
745
746 return cv->var;
747}
748
581e13c1 749/* Given the handle, return the name of the object. */
8b93c638
JM
750
751char *
752varobj_get_objname (struct varobj *var)
753{
754 return var->obj_name;
755}
756
581e13c1 757/* Given the handle, return the expression represented by the object. */
8b93c638
JM
758
759char *
760varobj_get_expression (struct varobj *var)
761{
762 return name_of_variable (var);
763}
764
765/* Deletes a varobj and all its children if only_children == 0,
3e43a32a
MS
766 otherwise deletes only the children; returns a malloc'ed list of
767 all the (malloc'ed) names of the variables that have been deleted
581e13c1 768 (NULL terminated). */
8b93c638
JM
769
770int
771varobj_delete (struct varobj *var, char ***dellist, int only_children)
772{
773 int delcount;
774 int mycount;
775 struct cpstack *result = NULL;
776 char **cp;
777
581e13c1 778 /* Initialize a stack for temporary results. */
8b93c638
JM
779 cppush (&result, NULL);
780
781 if (only_children)
581e13c1 782 /* Delete only the variable children. */
8b93c638
JM
783 delcount = delete_variable (&result, var, 1 /* only the children */ );
784 else
581e13c1 785 /* Delete the variable and all its children. */
8b93c638
JM
786 delcount = delete_variable (&result, var, 0 /* parent+children */ );
787
581e13c1 788 /* We may have been asked to return a list of what has been deleted. */
8b93c638
JM
789 if (dellist != NULL)
790 {
791 *dellist = xmalloc ((delcount + 1) * sizeof (char *));
792
793 cp = *dellist;
794 mycount = delcount;
795 *cp = cppop (&result);
796 while ((*cp != NULL) && (mycount > 0))
797 {
798 mycount--;
799 cp++;
800 *cp = cppop (&result);
801 }
802
803 if (mycount || (*cp != NULL))
8a3fe4f8 804 warning (_("varobj_delete: assertion failed - mycount(=%d) <> 0"),
72330bd6 805 mycount);
8b93c638
JM
806 }
807
808 return delcount;
809}
810
d8b65138
JK
811#if HAVE_PYTHON
812
b6313243
TT
813/* Convenience function for varobj_set_visualizer. Instantiate a
814 pretty-printer for a given value. */
815static PyObject *
816instantiate_pretty_printer (PyObject *constructor, struct value *value)
817{
b6313243
TT
818 PyObject *val_obj = NULL;
819 PyObject *printer;
b6313243 820
b6313243 821 val_obj = value_to_value_object (value);
b6313243
TT
822 if (! val_obj)
823 return NULL;
824
825 printer = PyObject_CallFunctionObjArgs (constructor, val_obj, NULL);
826 Py_DECREF (val_obj);
827 return printer;
b6313243
TT
828}
829
d8b65138
JK
830#endif
831
581e13c1 832/* Set/Get variable object display format. */
8b93c638
JM
833
834enum varobj_display_formats
835varobj_set_display_format (struct varobj *var,
836 enum varobj_display_formats format)
837{
838 switch (format)
839 {
840 case FORMAT_NATURAL:
841 case FORMAT_BINARY:
842 case FORMAT_DECIMAL:
843 case FORMAT_HEXADECIMAL:
844 case FORMAT_OCTAL:
845 var->format = format;
846 break;
847
848 default:
849 var->format = variable_default_display (var);
850 }
851
ae7d22a6
VP
852 if (varobj_value_is_changeable_p (var)
853 && var->value && !value_lazy (var->value))
854 {
6c761d9c 855 xfree (var->print_value);
d452c4bc 856 var->print_value = value_get_print_value (var->value, var->format, var);
ae7d22a6
VP
857 }
858
8b93c638
JM
859 return var->format;
860}
861
862enum varobj_display_formats
863varobj_get_display_format (struct varobj *var)
864{
865 return var->format;
866}
867
b6313243
TT
868char *
869varobj_get_display_hint (struct varobj *var)
870{
871 char *result = NULL;
872
873#if HAVE_PYTHON
d452c4bc
UW
874 struct cleanup *back_to = varobj_ensure_python_env (var);
875
b6313243
TT
876 if (var->pretty_printer)
877 result = gdbpy_get_display_hint (var->pretty_printer);
d452c4bc
UW
878
879 do_cleanups (back_to);
b6313243
TT
880#endif
881
882 return result;
883}
884
0cc7d26f
TT
885/* Return true if the varobj has items after TO, false otherwise. */
886
887int
888varobj_has_more (struct varobj *var, int to)
889{
890 if (VEC_length (varobj_p, var->children) > to)
891 return 1;
892 return ((to == -1 || VEC_length (varobj_p, var->children) == to)
893 && var->saved_item != NULL);
894}
895
c5b48eac
VP
896/* If the variable object is bound to a specific thread, that
897 is its evaluation can always be done in context of a frame
898 inside that thread, returns GDB id of the thread -- which
581e13c1 899 is always positive. Otherwise, returns -1. */
c5b48eac
VP
900int
901varobj_get_thread_id (struct varobj *var)
902{
903 if (var->root->valid_block && var->root->thread_id > 0)
904 return var->root->thread_id;
905 else
906 return -1;
907}
908
25d5ea92
VP
909void
910varobj_set_frozen (struct varobj *var, int frozen)
911{
912 /* When a variable is unfrozen, we don't fetch its value.
913 The 'not_fetched' flag remains set, so next -var-update
914 won't complain.
915
916 We don't fetch the value, because for structures the client
917 should do -var-update anyway. It would be bad to have different
918 client-size logic for structure and other types. */
919 var->frozen = frozen;
920}
921
922int
923varobj_get_frozen (struct varobj *var)
924{
925 return var->frozen;
926}
927
0cc7d26f
TT
928/* A helper function that restricts a range to what is actually
929 available in a VEC. This follows the usual rules for the meaning
930 of FROM and TO -- if either is negative, the entire range is
931 used. */
932
933static void
934restrict_range (VEC (varobj_p) *children, int *from, int *to)
935{
936 if (*from < 0 || *to < 0)
937 {
938 *from = 0;
939 *to = VEC_length (varobj_p, children);
940 }
941 else
942 {
943 if (*from > VEC_length (varobj_p, children))
944 *from = VEC_length (varobj_p, children);
945 if (*to > VEC_length (varobj_p, children))
946 *to = VEC_length (varobj_p, children);
947 if (*from > *to)
948 *from = *to;
949 }
950}
951
d8b65138
JK
952#if HAVE_PYTHON
953
0cc7d26f
TT
954/* A helper for update_dynamic_varobj_children that installs a new
955 child when needed. */
956
957static void
958install_dynamic_child (struct varobj *var,
959 VEC (varobj_p) **changed,
960 VEC (varobj_p) **new,
961 VEC (varobj_p) **unchanged,
962 int *cchanged,
963 int index,
964 const char *name,
965 struct value *value)
966{
967 if (VEC_length (varobj_p, var->children) < index + 1)
968 {
969 /* There's no child yet. */
970 struct varobj *child = varobj_add_child (var, name, value);
a109c7c1 971
0cc7d26f
TT
972 if (new)
973 {
974 VEC_safe_push (varobj_p, *new, child);
975 *cchanged = 1;
976 }
977 }
978 else
979 {
980 varobj_p existing = VEC_index (varobj_p, var->children, index);
a109c7c1 981
0cc7d26f
TT
982 if (install_new_value (existing, value, 0))
983 {
984 if (changed)
985 VEC_safe_push (varobj_p, *changed, existing);
986 }
987 else if (unchanged)
988 VEC_safe_push (varobj_p, *unchanged, existing);
989 }
990}
991
0cc7d26f
TT
992static int
993dynamic_varobj_has_child_method (struct varobj *var)
994{
995 struct cleanup *back_to;
996 PyObject *printer = var->pretty_printer;
997 int result;
998
999 back_to = varobj_ensure_python_env (var);
1000 result = PyObject_HasAttr (printer, gdbpy_children_cst);
1001 do_cleanups (back_to);
1002 return result;
1003}
1004
1005#endif
1006
b6313243
TT
1007static int
1008update_dynamic_varobj_children (struct varobj *var,
1009 VEC (varobj_p) **changed,
0cc7d26f
TT
1010 VEC (varobj_p) **new,
1011 VEC (varobj_p) **unchanged,
1012 int *cchanged,
1013 int update_children,
1014 int from,
1015 int to)
b6313243
TT
1016{
1017#if HAVE_PYTHON
b6313243
TT
1018 struct cleanup *back_to;
1019 PyObject *children;
b6313243 1020 int i;
b6313243 1021 PyObject *printer = var->pretty_printer;
b6313243 1022
d452c4bc 1023 back_to = varobj_ensure_python_env (var);
b6313243
TT
1024
1025 *cchanged = 0;
1026 if (!PyObject_HasAttr (printer, gdbpy_children_cst))
1027 {
1028 do_cleanups (back_to);
1029 return 0;
1030 }
1031
0cc7d26f 1032 if (update_children || !var->child_iter)
b6313243 1033 {
0cc7d26f
TT
1034 children = PyObject_CallMethodObjArgs (printer, gdbpy_children_cst,
1035 NULL);
b6313243 1036
0cc7d26f
TT
1037 if (!children)
1038 {
1039 gdbpy_print_stack ();
1040 error (_("Null value returned for children"));
1041 }
b6313243 1042
0cc7d26f 1043 make_cleanup_py_decref (children);
b6313243 1044
0cc7d26f
TT
1045 if (!PyIter_Check (children))
1046 error (_("Returned value is not iterable"));
1047
1048 Py_XDECREF (var->child_iter);
1049 var->child_iter = PyObject_GetIter (children);
1050 if (!var->child_iter)
1051 {
1052 gdbpy_print_stack ();
1053 error (_("Could not get children iterator"));
1054 }
1055
1056 Py_XDECREF (var->saved_item);
1057 var->saved_item = NULL;
1058
1059 i = 0;
b6313243 1060 }
0cc7d26f
TT
1061 else
1062 i = VEC_length (varobj_p, var->children);
b6313243 1063
0cc7d26f
TT
1064 /* We ask for one extra child, so that MI can report whether there
1065 are more children. */
1066 for (; to < 0 || i < to + 1; ++i)
b6313243 1067 {
0cc7d26f 1068 PyObject *item;
a4c8e806 1069 int force_done = 0;
b6313243 1070
0cc7d26f
TT
1071 /* See if there was a leftover from last time. */
1072 if (var->saved_item)
1073 {
1074 item = var->saved_item;
1075 var->saved_item = NULL;
1076 }
1077 else
1078 item = PyIter_Next (var->child_iter);
b6313243 1079
0cc7d26f 1080 if (!item)
a4c8e806
TT
1081 {
1082 /* Normal end of iteration. */
1083 if (!PyErr_Occurred ())
1084 break;
1085
1086 /* If we got a memory error, just use the text as the
1087 item. */
1088 if (PyErr_ExceptionMatches (gdbpy_gdb_memory_error))
1089 {
1090 PyObject *type, *value, *trace;
1091 char *name_str, *value_str;
1092
1093 PyErr_Fetch (&type, &value, &trace);
1094 value_str = gdbpy_exception_to_string (type, value);
1095 Py_XDECREF (type);
1096 Py_XDECREF (value);
1097 Py_XDECREF (trace);
1098 if (!value_str)
1099 {
1100 gdbpy_print_stack ();
1101 break;
1102 }
1103
1104 name_str = xstrprintf ("<error at %d>", i);
1105 item = Py_BuildValue ("(ss)", name_str, value_str);
1106 xfree (name_str);
1107 xfree (value_str);
1108 if (!item)
1109 {
1110 gdbpy_print_stack ();
1111 break;
1112 }
1113
1114 force_done = 1;
1115 }
1116 else
1117 {
1118 /* Any other kind of error. */
1119 gdbpy_print_stack ();
1120 break;
1121 }
1122 }
b6313243 1123
0cc7d26f
TT
1124 /* We don't want to push the extra child on any report list. */
1125 if (to < 0 || i < to)
b6313243 1126 {
0cc7d26f 1127 PyObject *py_v;
ddd49eee 1128 const char *name;
0cc7d26f
TT
1129 struct value *v;
1130 struct cleanup *inner;
1131 int can_mention = from < 0 || i >= from;
1132
1133 inner = make_cleanup_py_decref (item);
1134
1135 if (!PyArg_ParseTuple (item, "sO", &name, &py_v))
a4c8e806
TT
1136 {
1137 gdbpy_print_stack ();
1138 error (_("Invalid item from the child list"));
1139 }
0cc7d26f
TT
1140
1141 v = convert_value_from_python (py_v);
8dc78533
JK
1142 if (v == NULL)
1143 gdbpy_print_stack ();
0cc7d26f
TT
1144 install_dynamic_child (var, can_mention ? changed : NULL,
1145 can_mention ? new : NULL,
1146 can_mention ? unchanged : NULL,
1147 can_mention ? cchanged : NULL, i, name, v);
1148 do_cleanups (inner);
b6313243 1149 }
0cc7d26f 1150 else
b6313243 1151 {
0cc7d26f
TT
1152 Py_XDECREF (var->saved_item);
1153 var->saved_item = item;
b6313243 1154
0cc7d26f
TT
1155 /* We want to truncate the child list just before this
1156 element. */
1157 break;
1158 }
a4c8e806
TT
1159
1160 if (force_done)
1161 break;
b6313243
TT
1162 }
1163
1164 if (i < VEC_length (varobj_p, var->children))
1165 {
0cc7d26f 1166 int j;
a109c7c1 1167
0cc7d26f
TT
1168 *cchanged = 1;
1169 for (j = i; j < VEC_length (varobj_p, var->children); ++j)
1170 varobj_delete (VEC_index (varobj_p, var->children, j), NULL, 0);
1171 VEC_truncate (varobj_p, var->children, i);
b6313243 1172 }
0cc7d26f
TT
1173
1174 /* If there are fewer children than requested, note that the list of
1175 children changed. */
1176 if (to >= 0 && VEC_length (varobj_p, var->children) < to)
1177 *cchanged = 1;
1178
b6313243
TT
1179 var->num_children = VEC_length (varobj_p, var->children);
1180
1181 do_cleanups (back_to);
1182
b6313243
TT
1183 return 1;
1184#else
1185 gdb_assert (0 && "should never be called if Python is not enabled");
1186#endif
1187}
25d5ea92 1188
8b93c638
JM
1189int
1190varobj_get_num_children (struct varobj *var)
1191{
1192 if (var->num_children == -1)
b6313243 1193 {
0cc7d26f
TT
1194 if (var->pretty_printer)
1195 {
1196 int dummy;
1197
1198 /* If we have a dynamic varobj, don't report -1 children.
1199 So, try to fetch some children first. */
1200 update_dynamic_varobj_children (var, NULL, NULL, NULL, &dummy,
1201 0, 0, 0);
1202 }
1203 else
b6313243
TT
1204 var->num_children = number_of_children (var);
1205 }
8b93c638 1206
0cc7d26f 1207 return var->num_children >= 0 ? var->num_children : 0;
8b93c638
JM
1208}
1209
1210/* Creates a list of the immediate children of a variable object;
581e13c1 1211 the return code is the number of such children or -1 on error. */
8b93c638 1212
d56d46f5 1213VEC (varobj_p)*
0cc7d26f 1214varobj_list_children (struct varobj *var, int *from, int *to)
8b93c638 1215{
8b93c638 1216 char *name;
b6313243
TT
1217 int i, children_changed;
1218
1219 var->children_requested = 1;
1220
0cc7d26f
TT
1221 if (var->pretty_printer)
1222 {
b6313243
TT
1223 /* This, in theory, can result in the number of children changing without
1224 frontend noticing. But well, calling -var-list-children on the same
1225 varobj twice is not something a sane frontend would do. */
0cc7d26f
TT
1226 update_dynamic_varobj_children (var, NULL, NULL, NULL, &children_changed,
1227 0, 0, *to);
1228 restrict_range (var->children, from, to);
1229 return var->children;
1230 }
8b93c638 1231
8b93c638
JM
1232 if (var->num_children == -1)
1233 var->num_children = number_of_children (var);
1234
74a44383
DJ
1235 /* If that failed, give up. */
1236 if (var->num_children == -1)
d56d46f5 1237 return var->children;
74a44383 1238
28335dcc
VP
1239 /* If we're called when the list of children is not yet initialized,
1240 allocate enough elements in it. */
1241 while (VEC_length (varobj_p, var->children) < var->num_children)
1242 VEC_safe_push (varobj_p, var->children, NULL);
1243
8b93c638
JM
1244 for (i = 0; i < var->num_children; i++)
1245 {
d56d46f5 1246 varobj_p existing = VEC_index (varobj_p, var->children, i);
28335dcc
VP
1247
1248 if (existing == NULL)
1249 {
1250 /* Either it's the first call to varobj_list_children for
1251 this variable object, and the child was never created,
1252 or it was explicitly deleted by the client. */
1253 name = name_of_child (var, i);
1254 existing = create_child (var, i, name);
1255 VEC_replace (varobj_p, var->children, i, existing);
1256 }
8b93c638
JM
1257 }
1258
0cc7d26f 1259 restrict_range (var->children, from, to);
d56d46f5 1260 return var->children;
8b93c638
JM
1261}
1262
d8b65138
JK
1263#if HAVE_PYTHON
1264
b6313243
TT
1265static struct varobj *
1266varobj_add_child (struct varobj *var, const char *name, struct value *value)
1267{
1268 varobj_p v = create_child_with_value (var,
1269 VEC_length (varobj_p, var->children),
1270 name, value);
a109c7c1 1271
b6313243 1272 VEC_safe_push (varobj_p, var->children, v);
b6313243
TT
1273 return v;
1274}
1275
d8b65138
JK
1276#endif /* HAVE_PYTHON */
1277
8b93c638 1278/* Obtain the type of an object Variable as a string similar to the one gdb
581e13c1 1279 prints on the console. */
8b93c638
JM
1280
1281char *
1282varobj_get_type (struct varobj *var)
1283{
581e13c1 1284 /* For the "fake" variables, do not return a type. (It's type is
8756216b
DP
1285 NULL, too.)
1286 Do not return a type for invalid variables as well. */
1287 if (CPLUS_FAKE_CHILD (var) || !var->root->is_valid)
8b93c638
JM
1288 return NULL;
1289
1a4300e9 1290 return type_to_string (var->type);
8b93c638
JM
1291}
1292
1ecb4ee0
DJ
1293/* Obtain the type of an object variable. */
1294
1295struct type *
1296varobj_get_gdb_type (struct varobj *var)
1297{
1298 return var->type;
1299}
1300
02142340
VP
1301/* Return a pointer to the full rooted expression of varobj VAR.
1302 If it has not been computed yet, compute it. */
1303char *
1304varobj_get_path_expr (struct varobj *var)
1305{
1306 if (var->path_expr != NULL)
1307 return var->path_expr;
1308 else
1309 {
1310 /* For root varobjs, we initialize path_expr
1311 when creating varobj, so here it should be
1312 child varobj. */
1313 gdb_assert (!is_root_p (var));
1314 return (*var->root->lang->path_expr_of_child) (var);
1315 }
1316}
1317
8b93c638
JM
1318enum varobj_languages
1319varobj_get_language (struct varobj *var)
1320{
1321 return variable_language (var);
1322}
1323
1324int
1325varobj_get_attributes (struct varobj *var)
1326{
1327 int attributes = 0;
1328
340a7723 1329 if (varobj_editable_p (var))
581e13c1 1330 /* FIXME: define masks for attributes. */
8b93c638
JM
1331 attributes |= 0x00000001; /* Editable */
1332
1333 return attributes;
1334}
1335
0cc7d26f
TT
1336int
1337varobj_pretty_printed_p (struct varobj *var)
1338{
1339 return var->pretty_printer != NULL;
1340}
1341
de051565
MK
1342char *
1343varobj_get_formatted_value (struct varobj *var,
1344 enum varobj_display_formats format)
1345{
1346 return my_value_of_variable (var, format);
1347}
1348
8b93c638
JM
1349char *
1350varobj_get_value (struct varobj *var)
1351{
de051565 1352 return my_value_of_variable (var, var->format);
8b93c638
JM
1353}
1354
1355/* Set the value of an object variable (if it is editable) to the
581e13c1
MS
1356 value of the given expression. */
1357/* Note: Invokes functions that can call error(). */
8b93c638
JM
1358
1359int
1360varobj_set_value (struct varobj *var, char *expression)
1361{
34365054 1362 struct value *val = NULL; /* Initialize to keep gcc happy. */
8b93c638 1363 /* The argument "expression" contains the variable's new value.
581e13c1
MS
1364 We need to first construct a legal expression for this -- ugh! */
1365 /* Does this cover all the bases? */
8b93c638 1366 struct expression *exp;
34365054 1367 struct value *value = NULL; /* Initialize to keep gcc happy. */
8b93c638 1368 int saved_input_radix = input_radix;
340a7723 1369 char *s = expression;
8e7b59a5 1370 volatile struct gdb_exception except;
8b93c638 1371
340a7723 1372 gdb_assert (varobj_editable_p (var));
8b93c638 1373
581e13c1 1374 input_radix = 10; /* ALWAYS reset to decimal temporarily. */
340a7723 1375 exp = parse_exp_1 (&s, 0, 0);
8e7b59a5
KS
1376 TRY_CATCH (except, RETURN_MASK_ERROR)
1377 {
1378 value = evaluate_expression (exp);
1379 }
1380
1381 if (except.reason < 0)
340a7723 1382 {
581e13c1 1383 /* We cannot proceed without a valid expression. */
340a7723
NR
1384 xfree (exp);
1385 return 0;
8b93c638
JM
1386 }
1387
340a7723
NR
1388 /* All types that are editable must also be changeable. */
1389 gdb_assert (varobj_value_is_changeable_p (var));
1390
1391 /* The value of a changeable variable object must not be lazy. */
1392 gdb_assert (!value_lazy (var->value));
1393
1394 /* Need to coerce the input. We want to check if the
1395 value of the variable object will be different
1396 after assignment, and the first thing value_assign
1397 does is coerce the input.
1398 For example, if we are assigning an array to a pointer variable we
b021a221 1399 should compare the pointer with the array's address, not with the
340a7723
NR
1400 array's content. */
1401 value = coerce_array (value);
1402
8e7b59a5
KS
1403 /* The new value may be lazy. value_assign, or
1404 rather value_contents, will take care of this. */
1405 TRY_CATCH (except, RETURN_MASK_ERROR)
1406 {
1407 val = value_assign (var->value, value);
1408 }
1409
1410 if (except.reason < 0)
340a7723 1411 return 0;
8e7b59a5 1412
340a7723
NR
1413 /* If the value has changed, record it, so that next -var-update can
1414 report this change. If a variable had a value of '1', we've set it
1415 to '333' and then set again to '1', when -var-update will report this
1416 variable as changed -- because the first assignment has set the
1417 'updated' flag. There's no need to optimize that, because return value
1418 of -var-update should be considered an approximation. */
581e13c1 1419 var->updated = install_new_value (var, val, 0 /* Compare values. */);
340a7723
NR
1420 input_radix = saved_input_radix;
1421 return 1;
8b93c638
JM
1422}
1423
0cc7d26f
TT
1424#if HAVE_PYTHON
1425
1426/* A helper function to install a constructor function and visualizer
1427 in a varobj. */
1428
1429static void
1430install_visualizer (struct varobj *var, PyObject *constructor,
1431 PyObject *visualizer)
1432{
1433 Py_XDECREF (var->constructor);
1434 var->constructor = constructor;
1435
1436 Py_XDECREF (var->pretty_printer);
1437 var->pretty_printer = visualizer;
1438
1439 Py_XDECREF (var->child_iter);
1440 var->child_iter = NULL;
1441}
1442
1443/* Install the default visualizer for VAR. */
1444
1445static void
1446install_default_visualizer (struct varobj *var)
1447{
d65aec65
PM
1448 /* Do not install a visualizer on a CPLUS_FAKE_CHILD. */
1449 if (CPLUS_FAKE_CHILD (var))
1450 return;
1451
0cc7d26f
TT
1452 if (pretty_printing)
1453 {
1454 PyObject *pretty_printer = NULL;
1455
1456 if (var->value)
1457 {
1458 pretty_printer = gdbpy_get_varobj_pretty_printer (var->value);
1459 if (! pretty_printer)
1460 {
1461 gdbpy_print_stack ();
1462 error (_("Cannot instantiate printer for default visualizer"));
1463 }
1464 }
1465
1466 if (pretty_printer == Py_None)
1467 {
1468 Py_DECREF (pretty_printer);
1469 pretty_printer = NULL;
1470 }
1471
1472 install_visualizer (var, NULL, pretty_printer);
1473 }
1474}
1475
1476/* Instantiate and install a visualizer for VAR using CONSTRUCTOR to
1477 make a new object. */
1478
1479static void
1480construct_visualizer (struct varobj *var, PyObject *constructor)
1481{
1482 PyObject *pretty_printer;
1483
d65aec65
PM
1484 /* Do not install a visualizer on a CPLUS_FAKE_CHILD. */
1485 if (CPLUS_FAKE_CHILD (var))
1486 return;
1487
0cc7d26f
TT
1488 Py_INCREF (constructor);
1489 if (constructor == Py_None)
1490 pretty_printer = NULL;
1491 else
1492 {
1493 pretty_printer = instantiate_pretty_printer (constructor, var->value);
1494 if (! pretty_printer)
1495 {
1496 gdbpy_print_stack ();
1497 Py_DECREF (constructor);
1498 constructor = Py_None;
1499 Py_INCREF (constructor);
1500 }
1501
1502 if (pretty_printer == Py_None)
1503 {
1504 Py_DECREF (pretty_printer);
1505 pretty_printer = NULL;
1506 }
1507 }
1508
1509 install_visualizer (var, constructor, pretty_printer);
1510}
1511
1512#endif /* HAVE_PYTHON */
1513
1514/* A helper function for install_new_value. This creates and installs
1515 a visualizer for VAR, if appropriate. */
1516
1517static void
1518install_new_value_visualizer (struct varobj *var)
1519{
1520#if HAVE_PYTHON
1521 /* If the constructor is None, then we want the raw value. If VAR
1522 does not have a value, just skip this. */
1523 if (var->constructor != Py_None && var->value)
1524 {
1525 struct cleanup *cleanup;
0cc7d26f
TT
1526
1527 cleanup = varobj_ensure_python_env (var);
1528
1529 if (!var->constructor)
1530 install_default_visualizer (var);
1531 else
1532 construct_visualizer (var, var->constructor);
1533
1534 do_cleanups (cleanup);
1535 }
1536#else
1537 /* Do nothing. */
1538#endif
1539}
1540
acd65feb
VP
1541/* Assign a new value to a variable object. If INITIAL is non-zero,
1542 this is the first assignement after the variable object was just
1543 created, or changed type. In that case, just assign the value
1544 and return 0.
581e13c1
MS
1545 Otherwise, assign the new value, and return 1 if the value is
1546 different from the current one, 0 otherwise. The comparison is
1547 done on textual representation of value. Therefore, some types
1548 need not be compared. E.g. for structures the reported value is
1549 always "{...}", so no comparison is necessary here. If the old
1550 value was NULL and new one is not, or vice versa, we always return 1.
b26ed50d
VP
1551
1552 The VALUE parameter should not be released -- the function will
1553 take care of releasing it when needed. */
acd65feb
VP
1554static int
1555install_new_value (struct varobj *var, struct value *value, int initial)
1556{
1557 int changeable;
1558 int need_to_fetch;
1559 int changed = 0;
25d5ea92 1560 int intentionally_not_fetched = 0;
7a4d50bf 1561 char *print_value = NULL;
acd65feb 1562
acd65feb 1563 /* We need to know the varobj's type to decide if the value should
3e43a32a 1564 be fetched or not. C++ fake children (public/protected/private)
581e13c1 1565 don't have a type. */
acd65feb 1566 gdb_assert (var->type || CPLUS_FAKE_CHILD (var));
b2c2bd75 1567 changeable = varobj_value_is_changeable_p (var);
b6313243
TT
1568
1569 /* If the type has custom visualizer, we consider it to be always
581e13c1 1570 changeable. FIXME: need to make sure this behaviour will not
b6313243
TT
1571 mess up read-sensitive values. */
1572 if (var->pretty_printer)
1573 changeable = 1;
1574
acd65feb
VP
1575 need_to_fetch = changeable;
1576
b26ed50d
VP
1577 /* We are not interested in the address of references, and given
1578 that in C++ a reference is not rebindable, it cannot
1579 meaningfully change. So, get hold of the real value. */
1580 if (value)
0cc7d26f 1581 value = coerce_ref (value);
b26ed50d 1582
acd65feb
VP
1583 if (var->type && TYPE_CODE (var->type) == TYPE_CODE_UNION)
1584 /* For unions, we need to fetch the value implicitly because
1585 of implementation of union member fetch. When gdb
1586 creates a value for a field and the value of the enclosing
1587 structure is not lazy, it immediately copies the necessary
1588 bytes from the enclosing values. If the enclosing value is
1589 lazy, the call to value_fetch_lazy on the field will read
1590 the data from memory. For unions, that means we'll read the
1591 same memory more than once, which is not desirable. So
1592 fetch now. */
1593 need_to_fetch = 1;
1594
1595 /* The new value might be lazy. If the type is changeable,
1596 that is we'll be comparing values of this type, fetch the
1597 value now. Otherwise, on the next update the old value
1598 will be lazy, which means we've lost that old value. */
1599 if (need_to_fetch && value && value_lazy (value))
1600 {
25d5ea92
VP
1601 struct varobj *parent = var->parent;
1602 int frozen = var->frozen;
a109c7c1 1603
25d5ea92
VP
1604 for (; !frozen && parent; parent = parent->parent)
1605 frozen |= parent->frozen;
1606
1607 if (frozen && initial)
1608 {
1609 /* For variables that are frozen, or are children of frozen
1610 variables, we don't do fetch on initial assignment.
1611 For non-initial assignemnt we do the fetch, since it means we're
1612 explicitly asked to compare the new value with the old one. */
1613 intentionally_not_fetched = 1;
1614 }
8e7b59a5 1615 else
acd65feb 1616 {
8e7b59a5
KS
1617 volatile struct gdb_exception except;
1618
1619 TRY_CATCH (except, RETURN_MASK_ERROR)
1620 {
1621 value_fetch_lazy (value);
1622 }
1623
1624 if (except.reason < 0)
1625 {
1626 /* Set the value to NULL, so that for the next -var-update,
1627 we don't try to compare the new value with this value,
1628 that we couldn't even read. */
1629 value = NULL;
1630 }
acd65feb 1631 }
acd65feb
VP
1632 }
1633
e848a8a5
TT
1634 /* Get a reference now, before possibly passing it to any Python
1635 code that might release it. */
1636 if (value != NULL)
1637 value_incref (value);
b6313243 1638
7a4d50bf
VP
1639 /* Below, we'll be comparing string rendering of old and new
1640 values. Don't get string rendering if the value is
1641 lazy -- if it is, the code above has decided that the value
1642 should not be fetched. */
0cc7d26f 1643 if (value && !value_lazy (value) && !var->pretty_printer)
d452c4bc 1644 print_value = value_get_print_value (value, var->format, var);
7a4d50bf 1645
acd65feb
VP
1646 /* If the type is changeable, compare the old and the new values.
1647 If this is the initial assignment, we don't have any old value
1648 to compare with. */
7a4d50bf 1649 if (!initial && changeable)
acd65feb 1650 {
3e43a32a
MS
1651 /* If the value of the varobj was changed by -var-set-value,
1652 then the value in the varobj and in the target is the same.
1653 However, that value is different from the value that the
581e13c1 1654 varobj had after the previous -var-update. So need to the
3e43a32a 1655 varobj as changed. */
acd65feb 1656 if (var->updated)
57e66780 1657 {
57e66780
DJ
1658 changed = 1;
1659 }
0cc7d26f 1660 else if (! var->pretty_printer)
acd65feb
VP
1661 {
1662 /* Try to compare the values. That requires that both
1663 values are non-lazy. */
25d5ea92
VP
1664 if (var->not_fetched && value_lazy (var->value))
1665 {
1666 /* This is a frozen varobj and the value was never read.
1667 Presumably, UI shows some "never read" indicator.
1668 Now that we've fetched the real value, we need to report
1669 this varobj as changed so that UI can show the real
1670 value. */
1671 changed = 1;
1672 }
1673 else if (var->value == NULL && value == NULL)
581e13c1 1674 /* Equal. */
acd65feb
VP
1675 ;
1676 else if (var->value == NULL || value == NULL)
57e66780 1677 {
57e66780
DJ
1678 changed = 1;
1679 }
acd65feb
VP
1680 else
1681 {
1682 gdb_assert (!value_lazy (var->value));
1683 gdb_assert (!value_lazy (value));
85265413 1684
57e66780 1685 gdb_assert (var->print_value != NULL && print_value != NULL);
85265413 1686 if (strcmp (var->print_value, print_value) != 0)
7a4d50bf 1687 changed = 1;
acd65feb
VP
1688 }
1689 }
1690 }
85265413 1691
ee342b23
VP
1692 if (!initial && !changeable)
1693 {
1694 /* For values that are not changeable, we don't compare the values.
1695 However, we want to notice if a value was not NULL and now is NULL,
1696 or vise versa, so that we report when top-level varobjs come in scope
1697 and leave the scope. */
1698 changed = (var->value != NULL) != (value != NULL);
1699 }
1700
acd65feb 1701 /* We must always keep the new value, since children depend on it. */
25d5ea92 1702 if (var->value != NULL && var->value != value)
acd65feb
VP
1703 value_free (var->value);
1704 var->value = value;
25d5ea92
VP
1705 if (value && value_lazy (value) && intentionally_not_fetched)
1706 var->not_fetched = 1;
1707 else
1708 var->not_fetched = 0;
acd65feb 1709 var->updated = 0;
85265413 1710
0cc7d26f
TT
1711 install_new_value_visualizer (var);
1712
1713 /* If we installed a pretty-printer, re-compare the printed version
1714 to see if the variable changed. */
1715 if (var->pretty_printer)
1716 {
1717 xfree (print_value);
1718 print_value = value_get_print_value (var->value, var->format, var);
e8f781e2
TT
1719 if ((var->print_value == NULL && print_value != NULL)
1720 || (var->print_value != NULL && print_value == NULL)
1721 || (var->print_value != NULL && print_value != NULL
1722 && strcmp (var->print_value, print_value) != 0))
0cc7d26f
TT
1723 changed = 1;
1724 }
1725 if (var->print_value)
1726 xfree (var->print_value);
1727 var->print_value = print_value;
1728
b26ed50d 1729 gdb_assert (!var->value || value_type (var->value));
acd65feb
VP
1730
1731 return changed;
1732}
acd65feb 1733
0cc7d26f
TT
1734/* Return the requested range for a varobj. VAR is the varobj. FROM
1735 and TO are out parameters; *FROM and *TO will be set to the
1736 selected sub-range of VAR. If no range was selected using
1737 -var-set-update-range, then both will be -1. */
1738void
1739varobj_get_child_range (struct varobj *var, int *from, int *to)
b6313243 1740{
0cc7d26f
TT
1741 *from = var->from;
1742 *to = var->to;
b6313243
TT
1743}
1744
0cc7d26f
TT
1745/* Set the selected sub-range of children of VAR to start at index
1746 FROM and end at index TO. If either FROM or TO is less than zero,
1747 this is interpreted as a request for all children. */
1748void
1749varobj_set_child_range (struct varobj *var, int from, int to)
b6313243 1750{
0cc7d26f
TT
1751 var->from = from;
1752 var->to = to;
b6313243
TT
1753}
1754
1755void
1756varobj_set_visualizer (struct varobj *var, const char *visualizer)
1757{
1758#if HAVE_PYTHON
34fa1d9d
MS
1759 PyObject *mainmod, *globals, *constructor;
1760 struct cleanup *back_to;
b6313243 1761
d452c4bc 1762 back_to = varobj_ensure_python_env (var);
b6313243
TT
1763
1764 mainmod = PyImport_AddModule ("__main__");
1765 globals = PyModule_GetDict (mainmod);
1766 Py_INCREF (globals);
1767 make_cleanup_py_decref (globals);
1768
1769 constructor = PyRun_String (visualizer, Py_eval_input, globals, globals);
b6313243 1770
0cc7d26f 1771 if (! constructor)
b6313243
TT
1772 {
1773 gdbpy_print_stack ();
da1f2771 1774 error (_("Could not evaluate visualizer expression: %s"), visualizer);
b6313243
TT
1775 }
1776
0cc7d26f
TT
1777 construct_visualizer (var, constructor);
1778 Py_XDECREF (constructor);
b6313243 1779
0cc7d26f
TT
1780 /* If there are any children now, wipe them. */
1781 varobj_delete (var, NULL, 1 /* children only */);
1782 var->num_children = -1;
b6313243
TT
1783
1784 do_cleanups (back_to);
1785#else
da1f2771 1786 error (_("Python support required"));
b6313243
TT
1787#endif
1788}
1789
8b93c638
JM
1790/* Update the values for a variable and its children. This is a
1791 two-pronged attack. First, re-parse the value for the root's
1792 expression to see if it's changed. Then go all the way
1793 through its children, reconstructing them and noting if they've
1794 changed.
1795
25d5ea92
VP
1796 The EXPLICIT parameter specifies if this call is result
1797 of MI request to update this specific variable, or
581e13c1 1798 result of implicit -var-update *. For implicit request, we don't
25d5ea92 1799 update frozen variables.
705da579 1800
581e13c1 1801 NOTE: This function may delete the caller's varobj. If it
8756216b
DP
1802 returns TYPE_CHANGED, then it has done this and VARP will be modified
1803 to point to the new varobj. */
8b93c638 1804
1417b39d
JB
1805VEC(varobj_update_result) *
1806varobj_update (struct varobj **varp, int explicit)
8b93c638
JM
1807{
1808 int changed = 0;
25d5ea92 1809 int type_changed = 0;
8b93c638 1810 int i;
30b28db1 1811 struct value *new;
b6313243 1812 VEC (varobj_update_result) *stack = NULL;
f7f9ae2c 1813 VEC (varobj_update_result) *result = NULL;
8b93c638 1814
25d5ea92
VP
1815 /* Frozen means frozen -- we don't check for any change in
1816 this varobj, including its going out of scope, or
1817 changing type. One use case for frozen varobjs is
1818 retaining previously evaluated expressions, and we don't
1819 want them to be reevaluated at all. */
1820 if (!explicit && (*varp)->frozen)
f7f9ae2c 1821 return result;
8756216b
DP
1822
1823 if (!(*varp)->root->is_valid)
f7f9ae2c 1824 {
cfce2ea2 1825 varobj_update_result r = {0};
a109c7c1 1826
cfce2ea2 1827 r.varobj = *varp;
f7f9ae2c
VP
1828 r.status = VAROBJ_INVALID;
1829 VEC_safe_push (varobj_update_result, result, &r);
1830 return result;
1831 }
8b93c638 1832
25d5ea92 1833 if ((*varp)->root->rootvar == *varp)
ae093f96 1834 {
cfce2ea2 1835 varobj_update_result r = {0};
a109c7c1 1836
cfce2ea2 1837 r.varobj = *varp;
f7f9ae2c
VP
1838 r.status = VAROBJ_IN_SCOPE;
1839
581e13c1 1840 /* Update the root variable. value_of_root can return NULL
25d5ea92 1841 if the variable is no longer around, i.e. we stepped out of
581e13c1 1842 the frame in which a local existed. We are letting the
25d5ea92
VP
1843 value_of_root variable dispose of the varobj if the type
1844 has changed. */
25d5ea92 1845 new = value_of_root (varp, &type_changed);
f7f9ae2c
VP
1846 r.varobj = *varp;
1847
1848 r.type_changed = type_changed;
ea56f9c2 1849 if (install_new_value ((*varp), new, type_changed))
f7f9ae2c 1850 r.changed = 1;
ea56f9c2 1851
25d5ea92 1852 if (new == NULL)
f7f9ae2c 1853 r.status = VAROBJ_NOT_IN_SCOPE;
b6313243 1854 r.value_installed = 1;
f7f9ae2c
VP
1855
1856 if (r.status == VAROBJ_NOT_IN_SCOPE)
b6313243 1857 {
0b4bc29a
JK
1858 if (r.type_changed || r.changed)
1859 VEC_safe_push (varobj_update_result, result, &r);
b6313243
TT
1860 return result;
1861 }
1862
1863 VEC_safe_push (varobj_update_result, stack, &r);
1864 }
1865 else
1866 {
cfce2ea2 1867 varobj_update_result r = {0};
a109c7c1 1868
cfce2ea2 1869 r.varobj = *varp;
b6313243 1870 VEC_safe_push (varobj_update_result, stack, &r);
b20d8971 1871 }
8b93c638 1872
8756216b 1873 /* Walk through the children, reconstructing them all. */
b6313243 1874 while (!VEC_empty (varobj_update_result, stack))
8b93c638 1875 {
b6313243
TT
1876 varobj_update_result r = *(VEC_last (varobj_update_result, stack));
1877 struct varobj *v = r.varobj;
1878
1879 VEC_pop (varobj_update_result, stack);
1880
1881 /* Update this variable, unless it's a root, which is already
1882 updated. */
1883 if (!r.value_installed)
1884 {
1885 new = value_of_child (v->parent, v->index);
1886 if (install_new_value (v, new, 0 /* type not changed */))
1887 {
1888 r.changed = 1;
1889 v->updated = 0;
1890 }
1891 }
1892
1893 /* We probably should not get children of a varobj that has a
1894 pretty-printer, but for which -var-list-children was never
581e13c1 1895 invoked. */
b6313243
TT
1896 if (v->pretty_printer)
1897 {
0cc7d26f 1898 VEC (varobj_p) *changed = 0, *new = 0, *unchanged = 0;
26f9bcee 1899 int i, children_changed = 0;
b6313243
TT
1900
1901 if (v->frozen)
1902 continue;
1903
0cc7d26f
TT
1904 if (!v->children_requested)
1905 {
1906 int dummy;
1907
1908 /* If we initially did not have potential children, but
1909 now we do, consider the varobj as changed.
1910 Otherwise, if children were never requested, consider
1911 it as unchanged -- presumably, such varobj is not yet
1912 expanded in the UI, so we need not bother getting
1913 it. */
1914 if (!varobj_has_more (v, 0))
1915 {
1916 update_dynamic_varobj_children (v, NULL, NULL, NULL,
1917 &dummy, 0, 0, 0);
1918 if (varobj_has_more (v, 0))
1919 r.changed = 1;
1920 }
1921
1922 if (r.changed)
1923 VEC_safe_push (varobj_update_result, result, &r);
1924
1925 continue;
1926 }
1927
b6313243
TT
1928 /* If update_dynamic_varobj_children returns 0, then we have
1929 a non-conforming pretty-printer, so we skip it. */
0cc7d26f
TT
1930 if (update_dynamic_varobj_children (v, &changed, &new, &unchanged,
1931 &children_changed, 1,
1932 v->from, v->to))
b6313243 1933 {
0cc7d26f 1934 if (children_changed || new)
b6313243 1935 {
0cc7d26f
TT
1936 r.children_changed = 1;
1937 r.new = new;
b6313243 1938 }
0cc7d26f
TT
1939 /* Push in reverse order so that the first child is
1940 popped from the work stack first, and so will be
1941 added to result first. This does not affect
1942 correctness, just "nicer". */
1943 for (i = VEC_length (varobj_p, changed) - 1; i >= 0; --i)
b6313243 1944 {
0cc7d26f 1945 varobj_p tmp = VEC_index (varobj_p, changed, i);
cfce2ea2 1946 varobj_update_result r = {0};
a109c7c1 1947
cfce2ea2 1948 r.varobj = tmp;
0cc7d26f 1949 r.changed = 1;
b6313243
TT
1950 r.value_installed = 1;
1951 VEC_safe_push (varobj_update_result, stack, &r);
1952 }
0cc7d26f
TT
1953 for (i = VEC_length (varobj_p, unchanged) - 1; i >= 0; --i)
1954 {
1955 varobj_p tmp = VEC_index (varobj_p, unchanged, i);
a109c7c1 1956
0cc7d26f
TT
1957 if (!tmp->frozen)
1958 {
cfce2ea2 1959 varobj_update_result r = {0};
a109c7c1 1960
cfce2ea2 1961 r.varobj = tmp;
0cc7d26f
TT
1962 r.value_installed = 1;
1963 VEC_safe_push (varobj_update_result, stack, &r);
1964 }
1965 }
b6313243
TT
1966 if (r.changed || r.children_changed)
1967 VEC_safe_push (varobj_update_result, result, &r);
0cc7d26f
TT
1968
1969 /* Free CHANGED and UNCHANGED, but not NEW, because NEW
1970 has been put into the result vector. */
1971 VEC_free (varobj_p, changed);
1972 VEC_free (varobj_p, unchanged);
1973
b6313243
TT
1974 continue;
1975 }
1976 }
28335dcc
VP
1977
1978 /* Push any children. Use reverse order so that the first
1979 child is popped from the work stack first, and so
1980 will be added to result first. This does not
1981 affect correctness, just "nicer". */
1982 for (i = VEC_length (varobj_p, v->children)-1; i >= 0; --i)
8b93c638 1983 {
28335dcc 1984 varobj_p c = VEC_index (varobj_p, v->children, i);
a109c7c1 1985
28335dcc 1986 /* Child may be NULL if explicitly deleted by -var-delete. */
25d5ea92 1987 if (c != NULL && !c->frozen)
28335dcc 1988 {
cfce2ea2 1989 varobj_update_result r = {0};
a109c7c1 1990
cfce2ea2 1991 r.varobj = c;
b6313243 1992 VEC_safe_push (varobj_update_result, stack, &r);
28335dcc 1993 }
8b93c638 1994 }
b6313243
TT
1995
1996 if (r.changed || r.type_changed)
1997 VEC_safe_push (varobj_update_result, result, &r);
8b93c638
JM
1998 }
1999
b6313243
TT
2000 VEC_free (varobj_update_result, stack);
2001
f7f9ae2c 2002 return result;
8b93c638
JM
2003}
2004\f
2005
2006/* Helper functions */
2007
2008/*
2009 * Variable object construction/destruction
2010 */
2011
2012static int
fba45db2
KB
2013delete_variable (struct cpstack **resultp, struct varobj *var,
2014 int only_children_p)
8b93c638
JM
2015{
2016 int delcount = 0;
2017
2018 delete_variable_1 (resultp, &delcount, var,
2019 only_children_p, 1 /* remove_from_parent_p */ );
2020
2021 return delcount;
2022}
2023
581e13c1 2024/* Delete the variable object VAR and its children. */
8b93c638
JM
2025/* IMPORTANT NOTE: If we delete a variable which is a child
2026 and the parent is not removed we dump core. It must be always
581e13c1 2027 initially called with remove_from_parent_p set. */
8b93c638 2028static void
72330bd6
AC
2029delete_variable_1 (struct cpstack **resultp, int *delcountp,
2030 struct varobj *var, int only_children_p,
2031 int remove_from_parent_p)
8b93c638 2032{
28335dcc 2033 int i;
8b93c638 2034
581e13c1 2035 /* Delete any children of this variable, too. */
28335dcc
VP
2036 for (i = 0; i < VEC_length (varobj_p, var->children); ++i)
2037 {
2038 varobj_p child = VEC_index (varobj_p, var->children, i);
a109c7c1 2039
214270ab
VP
2040 if (!child)
2041 continue;
8b93c638 2042 if (!remove_from_parent_p)
28335dcc
VP
2043 child->parent = NULL;
2044 delete_variable_1 (resultp, delcountp, child, 0, only_children_p);
8b93c638 2045 }
28335dcc 2046 VEC_free (varobj_p, var->children);
8b93c638 2047
581e13c1 2048 /* if we were called to delete only the children we are done here. */
8b93c638
JM
2049 if (only_children_p)
2050 return;
2051
581e13c1 2052 /* Otherwise, add it to the list of deleted ones and proceed to do so. */
73a93a32 2053 /* If the name is null, this is a temporary variable, that has not
581e13c1 2054 yet been installed, don't report it, it belongs to the caller... */
73a93a32 2055 if (var->obj_name != NULL)
8b93c638 2056 {
5b616ba1 2057 cppush (resultp, xstrdup (var->obj_name));
8b93c638
JM
2058 *delcountp = *delcountp + 1;
2059 }
2060
581e13c1 2061 /* If this variable has a parent, remove it from its parent's list. */
8b93c638
JM
2062 /* OPTIMIZATION: if the parent of this variable is also being deleted,
2063 (as indicated by remove_from_parent_p) we don't bother doing an
2064 expensive list search to find the element to remove when we are
581e13c1 2065 discarding the list afterwards. */
72330bd6 2066 if ((remove_from_parent_p) && (var->parent != NULL))
8b93c638 2067 {
28335dcc 2068 VEC_replace (varobj_p, var->parent->children, var->index, NULL);
8b93c638 2069 }
72330bd6 2070
73a93a32
JI
2071 if (var->obj_name != NULL)
2072 uninstall_variable (var);
8b93c638 2073
581e13c1 2074 /* Free memory associated with this variable. */
8b93c638
JM
2075 free_variable (var);
2076}
2077
581e13c1 2078/* Install the given variable VAR with the object name VAR->OBJ_NAME. */
8b93c638 2079static int
fba45db2 2080install_variable (struct varobj *var)
8b93c638
JM
2081{
2082 struct vlist *cv;
2083 struct vlist *newvl;
2084 const char *chp;
2085 unsigned int index = 0;
2086 unsigned int i = 1;
2087
2088 for (chp = var->obj_name; *chp; chp++)
2089 {
2090 index = (index + (i++ * (unsigned int) *chp)) % VAROBJ_TABLE_SIZE;
2091 }
2092
2093 cv = *(varobj_table + index);
2094 while ((cv != NULL) && (strcmp (cv->var->obj_name, var->obj_name) != 0))
2095 cv = cv->next;
2096
2097 if (cv != NULL)
8a3fe4f8 2098 error (_("Duplicate variable object name"));
8b93c638 2099
581e13c1 2100 /* Add varobj to hash table. */
8b93c638
JM
2101 newvl = xmalloc (sizeof (struct vlist));
2102 newvl->next = *(varobj_table + index);
2103 newvl->var = var;
2104 *(varobj_table + index) = newvl;
2105
581e13c1 2106 /* If root, add varobj to root list. */
b2c2bd75 2107 if (is_root_p (var))
8b93c638 2108 {
581e13c1 2109 /* Add to list of root variables. */
8b93c638
JM
2110 if (rootlist == NULL)
2111 var->root->next = NULL;
2112 else
2113 var->root->next = rootlist;
2114 rootlist = var->root;
8b93c638
JM
2115 }
2116
2117 return 1; /* OK */
2118}
2119
581e13c1 2120/* Unistall the object VAR. */
8b93c638 2121static void
fba45db2 2122uninstall_variable (struct varobj *var)
8b93c638
JM
2123{
2124 struct vlist *cv;
2125 struct vlist *prev;
2126 struct varobj_root *cr;
2127 struct varobj_root *prer;
2128 const char *chp;
2129 unsigned int index = 0;
2130 unsigned int i = 1;
2131
581e13c1 2132 /* Remove varobj from hash table. */
8b93c638
JM
2133 for (chp = var->obj_name; *chp; chp++)
2134 {
2135 index = (index + (i++ * (unsigned int) *chp)) % VAROBJ_TABLE_SIZE;
2136 }
2137
2138 cv = *(varobj_table + index);
2139 prev = NULL;
2140 while ((cv != NULL) && (strcmp (cv->var->obj_name, var->obj_name) != 0))
2141 {
2142 prev = cv;
2143 cv = cv->next;
2144 }
2145
2146 if (varobjdebug)
2147 fprintf_unfiltered (gdb_stdlog, "Deleting %s\n", var->obj_name);
2148
2149 if (cv == NULL)
2150 {
72330bd6
AC
2151 warning
2152 ("Assertion failed: Could not find variable object \"%s\" to delete",
2153 var->obj_name);
8b93c638
JM
2154 return;
2155 }
2156
2157 if (prev == NULL)
2158 *(varobj_table + index) = cv->next;
2159 else
2160 prev->next = cv->next;
2161
b8c9b27d 2162 xfree (cv);
8b93c638 2163
581e13c1 2164 /* If root, remove varobj from root list. */
b2c2bd75 2165 if (is_root_p (var))
8b93c638 2166 {
581e13c1 2167 /* Remove from list of root variables. */
8b93c638
JM
2168 if (rootlist == var->root)
2169 rootlist = var->root->next;
2170 else
2171 {
2172 prer = NULL;
2173 cr = rootlist;
2174 while ((cr != NULL) && (cr->rootvar != var))
2175 {
2176 prer = cr;
2177 cr = cr->next;
2178 }
2179 if (cr == NULL)
2180 {
8f7e195f
JB
2181 warning (_("Assertion failed: Could not find "
2182 "varobj \"%s\" in root list"),
3e43a32a 2183 var->obj_name);
8b93c638
JM
2184 return;
2185 }
2186 if (prer == NULL)
2187 rootlist = NULL;
2188 else
2189 prer->next = cr->next;
2190 }
8b93c638
JM
2191 }
2192
2193}
2194
581e13c1 2195/* Create and install a child of the parent of the given name. */
8b93c638 2196static struct varobj *
fba45db2 2197create_child (struct varobj *parent, int index, char *name)
b6313243
TT
2198{
2199 return create_child_with_value (parent, index, name,
2200 value_of_child (parent, index));
2201}
2202
2203static struct varobj *
2204create_child_with_value (struct varobj *parent, int index, const char *name,
2205 struct value *value)
8b93c638
JM
2206{
2207 struct varobj *child;
2208 char *childs_name;
2209
2210 child = new_variable ();
2211
581e13c1 2212 /* Name is allocated by name_of_child. */
b6313243
TT
2213 /* FIXME: xstrdup should not be here. */
2214 child->name = xstrdup (name);
8b93c638 2215 child->index = index;
8b93c638
JM
2216 child->parent = parent;
2217 child->root = parent->root;
b435e160 2218 childs_name = xstrprintf ("%s.%s", parent->obj_name, name);
8b93c638
JM
2219 child->obj_name = childs_name;
2220 install_variable (child);
2221
acd65feb
VP
2222 /* Compute the type of the child. Must do this before
2223 calling install_new_value. */
2224 if (value != NULL)
2225 /* If the child had no evaluation errors, var->value
581e13c1 2226 will be non-NULL and contain a valid type. */
acd65feb
VP
2227 child->type = value_type (value);
2228 else
581e13c1 2229 /* Otherwise, we must compute the type. */
acd65feb
VP
2230 child->type = (*child->root->lang->type_of_child) (child->parent,
2231 child->index);
2232 install_new_value (child, value, 1);
2233
8b93c638
JM
2234 return child;
2235}
8b93c638
JM
2236\f
2237
2238/*
2239 * Miscellaneous utility functions.
2240 */
2241
581e13c1 2242/* Allocate memory and initialize a new variable. */
8b93c638
JM
2243static struct varobj *
2244new_variable (void)
2245{
2246 struct varobj *var;
2247
2248 var = (struct varobj *) xmalloc (sizeof (struct varobj));
2249 var->name = NULL;
02142340 2250 var->path_expr = NULL;
8b93c638
JM
2251 var->obj_name = NULL;
2252 var->index = -1;
2253 var->type = NULL;
2254 var->value = NULL;
8b93c638
JM
2255 var->num_children = -1;
2256 var->parent = NULL;
2257 var->children = NULL;
2258 var->format = 0;
2259 var->root = NULL;
fb9b6b35 2260 var->updated = 0;
85265413 2261 var->print_value = NULL;
25d5ea92
VP
2262 var->frozen = 0;
2263 var->not_fetched = 0;
b6313243 2264 var->children_requested = 0;
0cc7d26f
TT
2265 var->from = -1;
2266 var->to = -1;
2267 var->constructor = 0;
b6313243 2268 var->pretty_printer = 0;
0cc7d26f
TT
2269 var->child_iter = 0;
2270 var->saved_item = 0;
8b93c638
JM
2271
2272 return var;
2273}
2274
581e13c1 2275/* Allocate memory and initialize a new root variable. */
8b93c638
JM
2276static struct varobj *
2277new_root_variable (void)
2278{
2279 struct varobj *var = new_variable ();
a109c7c1 2280
3e43a32a 2281 var->root = (struct varobj_root *) xmalloc (sizeof (struct varobj_root));
8b93c638
JM
2282 var->root->lang = NULL;
2283 var->root->exp = NULL;
2284 var->root->valid_block = NULL;
7a424e99 2285 var->root->frame = null_frame_id;
a5defcdc 2286 var->root->floating = 0;
8b93c638 2287 var->root->rootvar = NULL;
8756216b 2288 var->root->is_valid = 1;
8b93c638
JM
2289
2290 return var;
2291}
2292
581e13c1 2293/* Free any allocated memory associated with VAR. */
8b93c638 2294static void
fba45db2 2295free_variable (struct varobj *var)
8b93c638 2296{
d452c4bc
UW
2297#if HAVE_PYTHON
2298 if (var->pretty_printer)
2299 {
2300 struct cleanup *cleanup = varobj_ensure_python_env (var);
0cc7d26f
TT
2301 Py_XDECREF (var->constructor);
2302 Py_XDECREF (var->pretty_printer);
2303 Py_XDECREF (var->child_iter);
2304 Py_XDECREF (var->saved_item);
d452c4bc
UW
2305 do_cleanups (cleanup);
2306 }
2307#endif
2308
36746093
JK
2309 value_free (var->value);
2310
581e13c1 2311 /* Free the expression if this is a root variable. */
b2c2bd75 2312 if (is_root_p (var))
8b93c638 2313 {
3038237c 2314 xfree (var->root->exp);
8038e1e2 2315 xfree (var->root);
8b93c638
JM
2316 }
2317
8038e1e2
AC
2318 xfree (var->name);
2319 xfree (var->obj_name);
85265413 2320 xfree (var->print_value);
02142340 2321 xfree (var->path_expr);
8038e1e2 2322 xfree (var);
8b93c638
JM
2323}
2324
74b7792f
AC
2325static void
2326do_free_variable_cleanup (void *var)
2327{
2328 free_variable (var);
2329}
2330
2331static struct cleanup *
2332make_cleanup_free_variable (struct varobj *var)
2333{
2334 return make_cleanup (do_free_variable_cleanup, var);
2335}
2336
581e13c1 2337/* This returns the type of the variable. It also skips past typedefs
6766a268 2338 to return the real type of the variable.
94b66fa7
KS
2339
2340 NOTE: TYPE_TARGET_TYPE should NOT be used anywhere in this file
581e13c1 2341 except within get_target_type and get_type. */
8b93c638 2342static struct type *
fba45db2 2343get_type (struct varobj *var)
8b93c638
JM
2344{
2345 struct type *type;
8b93c638 2346
a109c7c1 2347 type = var->type;
6766a268
DJ
2348 if (type != NULL)
2349 type = check_typedef (type);
8b93c638
JM
2350
2351 return type;
2352}
2353
6e2a9270
VP
2354/* Return the type of the value that's stored in VAR,
2355 or that would have being stored there if the
581e13c1 2356 value were accessible.
6e2a9270
VP
2357
2358 This differs from VAR->type in that VAR->type is always
2359 the true type of the expession in the source language.
2360 The return value of this function is the type we're
2361 actually storing in varobj, and using for displaying
2362 the values and for comparing previous and new values.
2363
2364 For example, top-level references are always stripped. */
2365static struct type *
2366get_value_type (struct varobj *var)
2367{
2368 struct type *type;
2369
2370 if (var->value)
2371 type = value_type (var->value);
2372 else
2373 type = var->type;
2374
2375 type = check_typedef (type);
2376
2377 if (TYPE_CODE (type) == TYPE_CODE_REF)
2378 type = get_target_type (type);
2379
2380 type = check_typedef (type);
2381
2382 return type;
2383}
2384
8b93c638 2385/* This returns the target type (or NULL) of TYPE, also skipping
94b66fa7
KS
2386 past typedefs, just like get_type ().
2387
2388 NOTE: TYPE_TARGET_TYPE should NOT be used anywhere in this file
581e13c1 2389 except within get_target_type and get_type. */
8b93c638 2390static struct type *
fba45db2 2391get_target_type (struct type *type)
8b93c638
JM
2392{
2393 if (type != NULL)
2394 {
2395 type = TYPE_TARGET_TYPE (type);
6766a268
DJ
2396 if (type != NULL)
2397 type = check_typedef (type);
8b93c638
JM
2398 }
2399
2400 return type;
2401}
2402
2403/* What is the default display for this variable? We assume that
581e13c1 2404 everything is "natural". Any exceptions? */
8b93c638 2405static enum varobj_display_formats
fba45db2 2406variable_default_display (struct varobj *var)
8b93c638
JM
2407{
2408 return FORMAT_NATURAL;
2409}
2410
581e13c1 2411/* FIXME: The following should be generic for any pointer. */
8b93c638 2412static void
fba45db2 2413cppush (struct cpstack **pstack, char *name)
8b93c638
JM
2414{
2415 struct cpstack *s;
2416
2417 s = (struct cpstack *) xmalloc (sizeof (struct cpstack));
2418 s->name = name;
2419 s->next = *pstack;
2420 *pstack = s;
2421}
2422
581e13c1 2423/* FIXME: The following should be generic for any pointer. */
8b93c638 2424static char *
fba45db2 2425cppop (struct cpstack **pstack)
8b93c638
JM
2426{
2427 struct cpstack *s;
2428 char *v;
2429
2430 if ((*pstack)->name == NULL && (*pstack)->next == NULL)
2431 return NULL;
2432
2433 s = *pstack;
2434 v = s->name;
2435 *pstack = (*pstack)->next;
b8c9b27d 2436 xfree (s);
8b93c638
JM
2437
2438 return v;
2439}
2440\f
2441/*
2442 * Language-dependencies
2443 */
2444
2445/* Common entry points */
2446
581e13c1 2447/* Get the language of variable VAR. */
8b93c638 2448static enum varobj_languages
fba45db2 2449variable_language (struct varobj *var)
8b93c638
JM
2450{
2451 enum varobj_languages lang;
2452
2453 switch (var->root->exp->language_defn->la_language)
2454 {
2455 default:
2456 case language_c:
2457 lang = vlang_c;
2458 break;
2459 case language_cplus:
2460 lang = vlang_cplus;
2461 break;
2462 case language_java:
2463 lang = vlang_java;
2464 break;
40591b7d
JCD
2465 case language_ada:
2466 lang = vlang_ada;
2467 break;
8b93c638
JM
2468 }
2469
2470 return lang;
2471}
2472
2473/* Return the number of children for a given variable.
2474 The result of this function is defined by the language
581e13c1 2475 implementation. The number of children returned by this function
8b93c638 2476 is the number of children that the user will see in the variable
581e13c1 2477 display. */
8b93c638 2478static int
fba45db2 2479number_of_children (struct varobj *var)
8b93c638 2480{
82ae4854 2481 return (*var->root->lang->number_of_children) (var);
8b93c638
JM
2482}
2483
3e43a32a 2484/* What is the expression for the root varobj VAR? Returns a malloc'd
581e13c1 2485 string. */
8b93c638 2486static char *
fba45db2 2487name_of_variable (struct varobj *var)
8b93c638
JM
2488{
2489 return (*var->root->lang->name_of_variable) (var);
2490}
2491
3e43a32a 2492/* What is the name of the INDEX'th child of VAR? Returns a malloc'd
581e13c1 2493 string. */
8b93c638 2494static char *
fba45db2 2495name_of_child (struct varobj *var, int index)
8b93c638
JM
2496{
2497 return (*var->root->lang->name_of_child) (var, index);
2498}
2499
a5defcdc
VP
2500/* What is the ``struct value *'' of the root variable VAR?
2501 For floating variable object, evaluation can get us a value
2502 of different type from what is stored in varobj already. In
2503 that case:
2504 - *type_changed will be set to 1
2505 - old varobj will be freed, and new one will be
2506 created, with the same name.
2507 - *var_handle will be set to the new varobj
2508 Otherwise, *type_changed will be set to 0. */
30b28db1 2509static struct value *
fba45db2 2510value_of_root (struct varobj **var_handle, int *type_changed)
8b93c638 2511{
73a93a32
JI
2512 struct varobj *var;
2513
2514 if (var_handle == NULL)
2515 return NULL;
2516
2517 var = *var_handle;
2518
2519 /* This should really be an exception, since this should
581e13c1 2520 only get called with a root variable. */
73a93a32 2521
b2c2bd75 2522 if (!is_root_p (var))
73a93a32
JI
2523 return NULL;
2524
a5defcdc 2525 if (var->root->floating)
73a93a32
JI
2526 {
2527 struct varobj *tmp_var;
2528 char *old_type, *new_type;
6225abfa 2529
73a93a32
JI
2530 tmp_var = varobj_create (NULL, var->name, (CORE_ADDR) 0,
2531 USE_SELECTED_FRAME);
2532 if (tmp_var == NULL)
2533 {
2534 return NULL;
2535 }
6225abfa 2536 old_type = varobj_get_type (var);
73a93a32 2537 new_type = varobj_get_type (tmp_var);
72330bd6 2538 if (strcmp (old_type, new_type) == 0)
73a93a32 2539 {
fcacd99f
VP
2540 /* The expression presently stored inside var->root->exp
2541 remembers the locations of local variables relatively to
2542 the frame where the expression was created (in DWARF location
2543 button, for example). Naturally, those locations are not
2544 correct in other frames, so update the expression. */
2545
2546 struct expression *tmp_exp = var->root->exp;
a109c7c1 2547
fcacd99f
VP
2548 var->root->exp = tmp_var->root->exp;
2549 tmp_var->root->exp = tmp_exp;
2550
73a93a32
JI
2551 varobj_delete (tmp_var, NULL, 0);
2552 *type_changed = 0;
2553 }
2554 else
2555 {
1b36a34b 2556 tmp_var->obj_name = xstrdup (var->obj_name);
0cc7d26f
TT
2557 tmp_var->from = var->from;
2558 tmp_var->to = var->to;
a5defcdc
VP
2559 varobj_delete (var, NULL, 0);
2560
73a93a32
JI
2561 install_variable (tmp_var);
2562 *var_handle = tmp_var;
705da579 2563 var = *var_handle;
73a93a32
JI
2564 *type_changed = 1;
2565 }
74dddad3
MS
2566 xfree (old_type);
2567 xfree (new_type);
73a93a32
JI
2568 }
2569 else
2570 {
2571 *type_changed = 0;
2572 }
2573
2574 return (*var->root->lang->value_of_root) (var_handle);
8b93c638
JM
2575}
2576
581e13c1 2577/* What is the ``struct value *'' for the INDEX'th child of PARENT? */
30b28db1 2578static struct value *
fba45db2 2579value_of_child (struct varobj *parent, int index)
8b93c638 2580{
30b28db1 2581 struct value *value;
8b93c638
JM
2582
2583 value = (*parent->root->lang->value_of_child) (parent, index);
2584
8b93c638
JM
2585 return value;
2586}
2587
581e13c1 2588/* GDB already has a command called "value_of_variable". Sigh. */
8b93c638 2589static char *
de051565 2590my_value_of_variable (struct varobj *var, enum varobj_display_formats format)
8b93c638 2591{
8756216b 2592 if (var->root->is_valid)
0cc7d26f
TT
2593 {
2594 if (var->pretty_printer)
2595 return value_get_print_value (var->value, var->format, var);
2596 return (*var->root->lang->value_of_variable) (var, format);
2597 }
8756216b
DP
2598 else
2599 return NULL;
8b93c638
JM
2600}
2601
85265413 2602static char *
b6313243 2603value_get_print_value (struct value *value, enum varobj_display_formats format,
d452c4bc 2604 struct varobj *var)
85265413 2605{
57e66780 2606 struct ui_file *stb;
621c8364 2607 struct cleanup *old_chain;
fbb8f299 2608 gdb_byte *thevalue = NULL;
79a45b7d 2609 struct value_print_options opts;
be759fcf
PM
2610 struct type *type = NULL;
2611 long len = 0;
2612 char *encoding = NULL;
2613 struct gdbarch *gdbarch = NULL;
3a182a69
JK
2614 /* Initialize it just to avoid a GCC false warning. */
2615 CORE_ADDR str_addr = 0;
09ca9e2e 2616 int string_print = 0;
57e66780
DJ
2617
2618 if (value == NULL)
2619 return NULL;
2620
621c8364
TT
2621 stb = mem_fileopen ();
2622 old_chain = make_cleanup_ui_file_delete (stb);
2623
be759fcf 2624 gdbarch = get_type_arch (value_type (value));
b6313243
TT
2625#if HAVE_PYTHON
2626 {
d452c4bc
UW
2627 PyObject *value_formatter = var->pretty_printer;
2628
09ca9e2e
TT
2629 varobj_ensure_python_env (var);
2630
0cc7d26f 2631 if (value_formatter)
b6313243 2632 {
0cc7d26f
TT
2633 /* First check to see if we have any children at all. If so,
2634 we simply return {...}. */
2635 if (dynamic_varobj_has_child_method (var))
621c8364
TT
2636 {
2637 do_cleanups (old_chain);
2638 return xstrdup ("{...}");
2639 }
b6313243 2640
0cc7d26f 2641 if (PyObject_HasAttr (value_formatter, gdbpy_to_string_cst))
b6313243 2642 {
0cc7d26f 2643 struct value *replacement;
0cc7d26f
TT
2644 PyObject *output = NULL;
2645
0cc7d26f 2646 output = apply_varobj_pretty_printer (value_formatter,
621c8364
TT
2647 &replacement,
2648 stb);
00bd41d6
PM
2649
2650 /* If we have string like output ... */
0cc7d26f
TT
2651 if (output)
2652 {
09ca9e2e
TT
2653 make_cleanup_py_decref (output);
2654
00bd41d6
PM
2655 /* If this is a lazy string, extract it. For lazy
2656 strings we always print as a string, so set
2657 string_print. */
be759fcf 2658 if (gdbpy_is_lazy_string (output))
0cc7d26f 2659 {
09ca9e2e
TT
2660 gdbpy_extract_lazy_string (output, &str_addr, &type,
2661 &len, &encoding);
2662 make_cleanup (free_current_contents, &encoding);
be759fcf
PM
2663 string_print = 1;
2664 }
2665 else
2666 {
00bd41d6
PM
2667 /* If it is a regular (non-lazy) string, extract
2668 it and copy the contents into THEVALUE. If the
2669 hint says to print it as a string, set
2670 string_print. Otherwise just return the extracted
2671 string as a value. */
2672
be759fcf
PM
2673 PyObject *py_str
2674 = python_string_to_target_python_string (output);
a109c7c1 2675
be759fcf
PM
2676 if (py_str)
2677 {
2678 char *s = PyString_AsString (py_str);
00bd41d6
PM
2679 char *hint;
2680
2681 hint = gdbpy_get_display_hint (value_formatter);
2682 if (hint)
2683 {
2684 if (!strcmp (hint, "string"))
2685 string_print = 1;
2686 xfree (hint);
2687 }
a109c7c1 2688
be759fcf
PM
2689 len = PyString_Size (py_str);
2690 thevalue = xmemdup (s, len + 1, len + 1);
2691 type = builtin_type (gdbarch)->builtin_char;
2692 Py_DECREF (py_str);
09ca9e2e
TT
2693
2694 if (!string_print)
2695 {
2696 do_cleanups (old_chain);
2697 return thevalue;
2698 }
2699
2700 make_cleanup (xfree, thevalue);
be759fcf 2701 }
8dc78533
JK
2702 else
2703 gdbpy_print_stack ();
0cc7d26f 2704 }
0cc7d26f 2705 }
00bd41d6
PM
2706 /* If the printer returned a replacement value, set VALUE
2707 to REPLACEMENT. If there is not a replacement value,
2708 just use the value passed to this function. */
0cc7d26f
TT
2709 if (replacement)
2710 value = replacement;
b6313243 2711 }
b6313243 2712 }
b6313243
TT
2713 }
2714#endif
2715
79a45b7d
TT
2716 get_formatted_print_options (&opts, format_code[(int) format]);
2717 opts.deref_ref = 0;
b6313243 2718 opts.raw = 1;
00bd41d6
PM
2719
2720 /* If the THEVALUE has contents, it is a regular string. */
b6313243 2721 if (thevalue)
09ca9e2e
TT
2722 LA_PRINT_STRING (stb, type, thevalue, len, encoding, 0, &opts);
2723 else if (string_print)
00bd41d6
PM
2724 /* Otherwise, if string_print is set, and it is not a regular
2725 string, it is a lazy string. */
09ca9e2e 2726 val_print_string (type, encoding, str_addr, len, stb, &opts);
b6313243 2727 else
00bd41d6 2728 /* All other cases. */
b6313243 2729 common_val_print (value, stb, 0, &opts, current_language);
00bd41d6 2730
759ef836 2731 thevalue = ui_file_xstrdup (stb, NULL);
57e66780 2732
85265413
NR
2733 do_cleanups (old_chain);
2734 return thevalue;
2735}
2736
340a7723
NR
2737int
2738varobj_editable_p (struct varobj *var)
2739{
2740 struct type *type;
340a7723
NR
2741
2742 if (!(var->root->is_valid && var->value && VALUE_LVAL (var->value)))
2743 return 0;
2744
2745 type = get_value_type (var);
2746
2747 switch (TYPE_CODE (type))
2748 {
2749 case TYPE_CODE_STRUCT:
2750 case TYPE_CODE_UNION:
2751 case TYPE_CODE_ARRAY:
2752 case TYPE_CODE_FUNC:
2753 case TYPE_CODE_METHOD:
2754 return 0;
2755 break;
2756
2757 default:
2758 return 1;
2759 break;
2760 }
2761}
2762
acd65feb
VP
2763/* Return non-zero if changes in value of VAR
2764 must be detected and reported by -var-update.
2765 Return zero is -var-update should never report
2766 changes of such values. This makes sense for structures
2767 (since the changes in children values will be reported separately),
2768 or for artifical objects (like 'public' pseudo-field in C++).
2769
2770 Return value of 0 means that gdb need not call value_fetch_lazy
2771 for the value of this variable object. */
8b93c638 2772static int
b2c2bd75 2773varobj_value_is_changeable_p (struct varobj *var)
8b93c638
JM
2774{
2775 int r;
2776 struct type *type;
2777
2778 if (CPLUS_FAKE_CHILD (var))
2779 return 0;
2780
6e2a9270 2781 type = get_value_type (var);
8b93c638
JM
2782
2783 switch (TYPE_CODE (type))
2784 {
72330bd6
AC
2785 case TYPE_CODE_STRUCT:
2786 case TYPE_CODE_UNION:
2787 case TYPE_CODE_ARRAY:
2788 r = 0;
2789 break;
8b93c638 2790
72330bd6
AC
2791 default:
2792 r = 1;
8b93c638
JM
2793 }
2794
2795 return r;
2796}
2797
5a413362
VP
2798/* Return 1 if that varobj is floating, that is is always evaluated in the
2799 selected frame, and not bound to thread/frame. Such variable objects
2800 are created using '@' as frame specifier to -var-create. */
2801int
2802varobj_floating_p (struct varobj *var)
2803{
2804 return var->root->floating;
2805}
2806
2024f65a
VP
2807/* Given the value and the type of a variable object,
2808 adjust the value and type to those necessary
2809 for getting children of the variable object.
2810 This includes dereferencing top-level references
2811 to all types and dereferencing pointers to
581e13c1 2812 structures.
2024f65a 2813
581e13c1 2814 Both TYPE and *TYPE should be non-null. VALUE
2024f65a
VP
2815 can be null if we want to only translate type.
2816 *VALUE can be null as well -- if the parent
581e13c1 2817 value is not known.
02142340
VP
2818
2819 If WAS_PTR is not NULL, set *WAS_PTR to 0 or 1
b6313243 2820 depending on whether pointer was dereferenced
02142340 2821 in this function. */
2024f65a
VP
2822static void
2823adjust_value_for_child_access (struct value **value,
02142340
VP
2824 struct type **type,
2825 int *was_ptr)
2024f65a
VP
2826{
2827 gdb_assert (type && *type);
2828
02142340
VP
2829 if (was_ptr)
2830 *was_ptr = 0;
2831
2024f65a
VP
2832 *type = check_typedef (*type);
2833
2834 /* The type of value stored in varobj, that is passed
2835 to us, is already supposed to be
2836 reference-stripped. */
2837
2838 gdb_assert (TYPE_CODE (*type) != TYPE_CODE_REF);
2839
2840 /* Pointers to structures are treated just like
2841 structures when accessing children. Don't
2842 dererences pointers to other types. */
2843 if (TYPE_CODE (*type) == TYPE_CODE_PTR)
2844 {
2845 struct type *target_type = get_target_type (*type);
2846 if (TYPE_CODE (target_type) == TYPE_CODE_STRUCT
2847 || TYPE_CODE (target_type) == TYPE_CODE_UNION)
2848 {
2849 if (value && *value)
3f4178d6 2850 {
8e7b59a5 2851 volatile struct gdb_exception except;
a109c7c1 2852
8e7b59a5
KS
2853 TRY_CATCH (except, RETURN_MASK_ERROR)
2854 {
2855 *value = value_ind (*value);
2856 }
2857
2858 if (except.reason < 0)
3f4178d6
DJ
2859 *value = NULL;
2860 }
2024f65a 2861 *type = target_type;
02142340
VP
2862 if (was_ptr)
2863 *was_ptr = 1;
2024f65a
VP
2864 }
2865 }
2866
2867 /* The 'get_target_type' function calls check_typedef on
2868 result, so we can immediately check type code. No
2869 need to call check_typedef here. */
2870}
2871
8b93c638
JM
2872/* C */
2873static int
fba45db2 2874c_number_of_children (struct varobj *var)
8b93c638 2875{
2024f65a
VP
2876 struct type *type = get_value_type (var);
2877 int children = 0;
8b93c638 2878 struct type *target;
8b93c638 2879
02142340 2880 adjust_value_for_child_access (NULL, &type, NULL);
8b93c638 2881 target = get_target_type (type);
8b93c638
JM
2882
2883 switch (TYPE_CODE (type))
2884 {
2885 case TYPE_CODE_ARRAY:
2886 if (TYPE_LENGTH (type) > 0 && TYPE_LENGTH (target) > 0
d78df370 2887 && !TYPE_ARRAY_UPPER_BOUND_IS_UNDEFINED (type))
8b93c638
JM
2888 children = TYPE_LENGTH (type) / TYPE_LENGTH (target);
2889 else
74a44383
DJ
2890 /* If we don't know how many elements there are, don't display
2891 any. */
2892 children = 0;
8b93c638
JM
2893 break;
2894
2895 case TYPE_CODE_STRUCT:
2896 case TYPE_CODE_UNION:
2897 children = TYPE_NFIELDS (type);
2898 break;
2899
2900 case TYPE_CODE_PTR:
581e13c1 2901 /* The type here is a pointer to non-struct. Typically, pointers
2024f65a
VP
2902 have one child, except for function ptrs, which have no children,
2903 and except for void*, as we don't know what to show.
2904
0755e6c1
FN
2905 We can show char* so we allow it to be dereferenced. If you decide
2906 to test for it, please mind that a little magic is necessary to
2907 properly identify it: char* has TYPE_CODE == TYPE_CODE_INT and
581e13c1 2908 TYPE_NAME == "char". */
2024f65a
VP
2909 if (TYPE_CODE (target) == TYPE_CODE_FUNC
2910 || TYPE_CODE (target) == TYPE_CODE_VOID)
2911 children = 0;
2912 else
2913 children = 1;
8b93c638
JM
2914 break;
2915
2916 default:
581e13c1 2917 /* Other types have no children. */
8b93c638
JM
2918 break;
2919 }
2920
2921 return children;
2922}
2923
2924static char *
fba45db2 2925c_name_of_variable (struct varobj *parent)
8b93c638 2926{
1b36a34b 2927 return xstrdup (parent->name);
8b93c638
JM
2928}
2929
bbec2603
VP
2930/* Return the value of element TYPE_INDEX of a structure
2931 value VALUE. VALUE's type should be a structure,
581e13c1 2932 or union, or a typedef to struct/union.
bbec2603
VP
2933
2934 Returns NULL if getting the value fails. Never throws. */
2935static struct value *
2936value_struct_element_index (struct value *value, int type_index)
8b93c638 2937{
bbec2603
VP
2938 struct value *result = NULL;
2939 volatile struct gdb_exception e;
bbec2603 2940 struct type *type = value_type (value);
a109c7c1 2941
bbec2603
VP
2942 type = check_typedef (type);
2943
2944 gdb_assert (TYPE_CODE (type) == TYPE_CODE_STRUCT
2945 || TYPE_CODE (type) == TYPE_CODE_UNION);
8b93c638 2946
bbec2603
VP
2947 TRY_CATCH (e, RETURN_MASK_ERROR)
2948 {
d6a843b5 2949 if (field_is_static (&TYPE_FIELD (type, type_index)))
bbec2603
VP
2950 result = value_static_field (type, type_index);
2951 else
2952 result = value_primitive_field (value, 0, type_index, type);
2953 }
2954 if (e.reason < 0)
2955 {
2956 return NULL;
2957 }
2958 else
2959 {
2960 return result;
2961 }
2962}
2963
2964/* Obtain the information about child INDEX of the variable
581e13c1 2965 object PARENT.
bbec2603
VP
2966 If CNAME is not null, sets *CNAME to the name of the child relative
2967 to the parent.
2968 If CVALUE is not null, sets *CVALUE to the value of the child.
2969 If CTYPE is not null, sets *CTYPE to the type of the child.
2970
2971 If any of CNAME, CVALUE, or CTYPE is not null, but the corresponding
2972 information cannot be determined, set *CNAME, *CVALUE, or *CTYPE
2973 to NULL. */
2974static void
2975c_describe_child (struct varobj *parent, int index,
02142340
VP
2976 char **cname, struct value **cvalue, struct type **ctype,
2977 char **cfull_expression)
bbec2603
VP
2978{
2979 struct value *value = parent->value;
2024f65a 2980 struct type *type = get_value_type (parent);
02142340
VP
2981 char *parent_expression = NULL;
2982 int was_ptr;
8e7b59a5 2983 volatile struct gdb_exception except;
bbec2603
VP
2984
2985 if (cname)
2986 *cname = NULL;
2987 if (cvalue)
2988 *cvalue = NULL;
2989 if (ctype)
2990 *ctype = NULL;
02142340
VP
2991 if (cfull_expression)
2992 {
2993 *cfull_expression = NULL;
2994 parent_expression = varobj_get_path_expr (parent);
2995 }
2996 adjust_value_for_child_access (&value, &type, &was_ptr);
bbec2603 2997
8b93c638
JM
2998 switch (TYPE_CODE (type))
2999 {
3000 case TYPE_CODE_ARRAY:
bbec2603 3001 if (cname)
3e43a32a
MS
3002 *cname
3003 = xstrdup (int_string (index
3004 + TYPE_LOW_BOUND (TYPE_INDEX_TYPE (type)),
3005 10, 1, 0, 0));
bbec2603
VP
3006
3007 if (cvalue && value)
3008 {
3009 int real_index = index + TYPE_LOW_BOUND (TYPE_INDEX_TYPE (type));
a109c7c1 3010
8e7b59a5
KS
3011 TRY_CATCH (except, RETURN_MASK_ERROR)
3012 {
3013 *cvalue = value_subscript (value, real_index);
3014 }
bbec2603
VP
3015 }
3016
3017 if (ctype)
3018 *ctype = get_target_type (type);
3019
02142340 3020 if (cfull_expression)
43bbcdc2
PH
3021 *cfull_expression =
3022 xstrprintf ("(%s)[%s]", parent_expression,
3023 int_string (index
3024 + TYPE_LOW_BOUND (TYPE_INDEX_TYPE (type)),
3025 10, 1, 0, 0));
02142340
VP
3026
3027
8b93c638
JM
3028 break;
3029
3030 case TYPE_CODE_STRUCT:
3031 case TYPE_CODE_UNION:
bbec2603 3032 if (cname)
1b36a34b 3033 *cname = xstrdup (TYPE_FIELD_NAME (type, index));
bbec2603
VP
3034
3035 if (cvalue && value)
3036 {
3037 /* For C, varobj index is the same as type index. */
3038 *cvalue = value_struct_element_index (value, index);
3039 }
3040
3041 if (ctype)
3042 *ctype = TYPE_FIELD_TYPE (type, index);
3043
02142340
VP
3044 if (cfull_expression)
3045 {
3046 char *join = was_ptr ? "->" : ".";
a109c7c1 3047
02142340
VP
3048 *cfull_expression = xstrprintf ("(%s)%s%s", parent_expression, join,
3049 TYPE_FIELD_NAME (type, index));
3050 }
3051
8b93c638
JM
3052 break;
3053
3054 case TYPE_CODE_PTR:
bbec2603
VP
3055 if (cname)
3056 *cname = xstrprintf ("*%s", parent->name);
8b93c638 3057
bbec2603 3058 if (cvalue && value)
3f4178d6 3059 {
8e7b59a5
KS
3060 TRY_CATCH (except, RETURN_MASK_ERROR)
3061 {
3062 *cvalue = value_ind (value);
3063 }
a109c7c1 3064
8e7b59a5 3065 if (except.reason < 0)
3f4178d6
DJ
3066 *cvalue = NULL;
3067 }
bbec2603 3068
2024f65a
VP
3069 /* Don't use get_target_type because it calls
3070 check_typedef and here, we want to show the true
3071 declared type of the variable. */
bbec2603 3072 if (ctype)
2024f65a 3073 *ctype = TYPE_TARGET_TYPE (type);
02142340
VP
3074
3075 if (cfull_expression)
3076 *cfull_expression = xstrprintf ("*(%s)", parent_expression);
bbec2603 3077
8b93c638
JM
3078 break;
3079
3080 default:
581e13c1 3081 /* This should not happen. */
bbec2603
VP
3082 if (cname)
3083 *cname = xstrdup ("???");
02142340
VP
3084 if (cfull_expression)
3085 *cfull_expression = xstrdup ("???");
581e13c1 3086 /* Don't set value and type, we don't know then. */
8b93c638 3087 }
bbec2603 3088}
8b93c638 3089
bbec2603
VP
3090static char *
3091c_name_of_child (struct varobj *parent, int index)
3092{
3093 char *name;
a109c7c1 3094
02142340 3095 c_describe_child (parent, index, &name, NULL, NULL, NULL);
8b93c638
JM
3096 return name;
3097}
3098
02142340
VP
3099static char *
3100c_path_expr_of_child (struct varobj *child)
3101{
3102 c_describe_child (child->parent, child->index, NULL, NULL, NULL,
3103 &child->path_expr);
3104 return child->path_expr;
3105}
3106
c5b48eac
VP
3107/* If frame associated with VAR can be found, switch
3108 to it and return 1. Otherwise, return 0. */
3109static int
3110check_scope (struct varobj *var)
3111{
3112 struct frame_info *fi;
3113 int scope;
3114
3115 fi = frame_find_by_id (var->root->frame);
3116 scope = fi != NULL;
3117
3118 if (fi)
3119 {
3120 CORE_ADDR pc = get_frame_pc (fi);
a109c7c1 3121
c5b48eac
VP
3122 if (pc < BLOCK_START (var->root->valid_block) ||
3123 pc >= BLOCK_END (var->root->valid_block))
3124 scope = 0;
3125 else
3126 select_frame (fi);
3127 }
3128 return scope;
3129}
3130
30b28db1 3131static struct value *
fba45db2 3132c_value_of_root (struct varobj **var_handle)
8b93c638 3133{
5e572bb4 3134 struct value *new_val = NULL;
73a93a32 3135 struct varobj *var = *var_handle;
c5b48eac 3136 int within_scope = 0;
6208b47d
VP
3137 struct cleanup *back_to;
3138
581e13c1 3139 /* Only root variables can be updated... */
b2c2bd75 3140 if (!is_root_p (var))
581e13c1 3141 /* Not a root var. */
73a93a32
JI
3142 return NULL;
3143
4f8d22e3 3144 back_to = make_cleanup_restore_current_thread ();
72330bd6 3145
581e13c1 3146 /* Determine whether the variable is still around. */
a5defcdc 3147 if (var->root->valid_block == NULL || var->root->floating)
8b93c638 3148 within_scope = 1;
c5b48eac
VP
3149 else if (var->root->thread_id == 0)
3150 {
3151 /* The program was single-threaded when the variable object was
3152 created. Technically, it's possible that the program became
3153 multi-threaded since then, but we don't support such
3154 scenario yet. */
3155 within_scope = check_scope (var);
3156 }
8b93c638
JM
3157 else
3158 {
c5b48eac
VP
3159 ptid_t ptid = thread_id_to_pid (var->root->thread_id);
3160 if (in_thread_list (ptid))
d2353924 3161 {
c5b48eac
VP
3162 switch_to_thread (ptid);
3163 within_scope = check_scope (var);
3164 }
8b93c638 3165 }
72330bd6 3166
8b93c638
JM
3167 if (within_scope)
3168 {
8e7b59a5
KS
3169 volatile struct gdb_exception except;
3170
73a93a32 3171 /* We need to catch errors here, because if evaluate
85d93f1d 3172 expression fails we want to just return NULL. */
8e7b59a5
KS
3173 TRY_CATCH (except, RETURN_MASK_ERROR)
3174 {
3175 new_val = evaluate_expression (var->root->exp);
3176 }
3177
8b93c638
JM
3178 return new_val;
3179 }
3180
6208b47d
VP
3181 do_cleanups (back_to);
3182
8b93c638
JM
3183 return NULL;
3184}
3185
30b28db1 3186static struct value *
fba45db2 3187c_value_of_child (struct varobj *parent, int index)
8b93c638 3188{
bbec2603 3189 struct value *value = NULL;
8b93c638 3190
a109c7c1 3191 c_describe_child (parent, index, NULL, &value, NULL, NULL);
8b93c638
JM
3192 return value;
3193}
3194
3195static struct type *
fba45db2 3196c_type_of_child (struct varobj *parent, int index)
8b93c638 3197{
bbec2603 3198 struct type *type = NULL;
a109c7c1 3199
02142340 3200 c_describe_child (parent, index, NULL, NULL, &type, NULL);
8b93c638
JM
3201 return type;
3202}
3203
8b93c638 3204static char *
de051565 3205c_value_of_variable (struct varobj *var, enum varobj_display_formats format)
8b93c638 3206{
14b3d9c9
JB
3207 /* BOGUS: if val_print sees a struct/class, or a reference to one,
3208 it will print out its children instead of "{...}". So we need to
3209 catch that case explicitly. */
3210 struct type *type = get_type (var);
e64d9b3d 3211
b6313243
TT
3212 /* If we have a custom formatter, return whatever string it has
3213 produced. */
3214 if (var->pretty_printer && var->print_value)
3215 return xstrdup (var->print_value);
3216
581e13c1 3217 /* Strip top-level references. */
14b3d9c9
JB
3218 while (TYPE_CODE (type) == TYPE_CODE_REF)
3219 type = check_typedef (TYPE_TARGET_TYPE (type));
3220
3221 switch (TYPE_CODE (type))
8b93c638
JM
3222 {
3223 case TYPE_CODE_STRUCT:
3224 case TYPE_CODE_UNION:
3225 return xstrdup ("{...}");
3226 /* break; */
3227
3228 case TYPE_CODE_ARRAY:
3229 {
e64d9b3d 3230 char *number;
a109c7c1 3231
b435e160 3232 number = xstrprintf ("[%d]", var->num_children);
e64d9b3d 3233 return (number);
8b93c638
JM
3234 }
3235 /* break; */
3236
3237 default:
3238 {
575bbeb6
KS
3239 if (var->value == NULL)
3240 {
3241 /* This can happen if we attempt to get the value of a struct
581e13c1
MS
3242 member when the parent is an invalid pointer. This is an
3243 error condition, so we should tell the caller. */
575bbeb6
KS
3244 return NULL;
3245 }
3246 else
3247 {
25d5ea92
VP
3248 if (var->not_fetched && value_lazy (var->value))
3249 /* Frozen variable and no value yet. We don't
3250 implicitly fetch the value. MI response will
3251 use empty string for the value, which is OK. */
3252 return NULL;
3253
b2c2bd75 3254 gdb_assert (varobj_value_is_changeable_p (var));
acd65feb 3255 gdb_assert (!value_lazy (var->value));
de051565
MK
3256
3257 /* If the specified format is the current one,
581e13c1 3258 we can reuse print_value. */
de051565
MK
3259 if (format == var->format)
3260 return xstrdup (var->print_value);
3261 else
d452c4bc 3262 return value_get_print_value (var->value, format, var);
85265413 3263 }
e64d9b3d 3264 }
8b93c638
JM
3265 }
3266}
3267\f
3268
3269/* C++ */
3270
3271static int
fba45db2 3272cplus_number_of_children (struct varobj *var)
8b93c638
JM
3273{
3274 struct type *type;
3275 int children, dont_know;
3276
3277 dont_know = 1;
3278 children = 0;
3279
3280 if (!CPLUS_FAKE_CHILD (var))
3281 {
2024f65a 3282 type = get_value_type (var);
02142340 3283 adjust_value_for_child_access (NULL, &type, NULL);
8b93c638
JM
3284
3285 if (((TYPE_CODE (type)) == TYPE_CODE_STRUCT) ||
72330bd6 3286 ((TYPE_CODE (type)) == TYPE_CODE_UNION))
8b93c638
JM
3287 {
3288 int kids[3];
3289
3290 cplus_class_num_children (type, kids);
3291 if (kids[v_public] != 0)
3292 children++;
3293 if (kids[v_private] != 0)
3294 children++;
3295 if (kids[v_protected] != 0)
3296 children++;
3297
581e13c1 3298 /* Add any baseclasses. */
8b93c638
JM
3299 children += TYPE_N_BASECLASSES (type);
3300 dont_know = 0;
3301
581e13c1 3302 /* FIXME: save children in var. */
8b93c638
JM
3303 }
3304 }
3305 else
3306 {
3307 int kids[3];
3308
2024f65a 3309 type = get_value_type (var->parent);
02142340 3310 adjust_value_for_child_access (NULL, &type, NULL);
8b93c638
JM
3311
3312 cplus_class_num_children (type, kids);
6e382aa3 3313 if (strcmp (var->name, "public") == 0)
8b93c638 3314 children = kids[v_public];
6e382aa3 3315 else if (strcmp (var->name, "private") == 0)
8b93c638
JM
3316 children = kids[v_private];
3317 else
3318 children = kids[v_protected];
3319 dont_know = 0;
3320 }
3321
3322 if (dont_know)
3323 children = c_number_of_children (var);
3324
3325 return children;
3326}
3327
3328/* Compute # of public, private, and protected variables in this class.
3329 That means we need to descend into all baseclasses and find out
581e13c1 3330 how many are there, too. */
8b93c638 3331static void
1669605f 3332cplus_class_num_children (struct type *type, int children[3])
8b93c638 3333{
d48cc9dd
DJ
3334 int i, vptr_fieldno;
3335 struct type *basetype = NULL;
8b93c638
JM
3336
3337 children[v_public] = 0;
3338 children[v_private] = 0;
3339 children[v_protected] = 0;
3340
d48cc9dd 3341 vptr_fieldno = get_vptr_fieldno (type, &basetype);
8b93c638
JM
3342 for (i = TYPE_N_BASECLASSES (type); i < TYPE_NFIELDS (type); i++)
3343 {
d48cc9dd
DJ
3344 /* If we have a virtual table pointer, omit it. Even if virtual
3345 table pointers are not specifically marked in the debug info,
3346 they should be artificial. */
3347 if ((type == basetype && i == vptr_fieldno)
3348 || TYPE_FIELD_ARTIFICIAL (type, i))
8b93c638
JM
3349 continue;
3350
3351 if (TYPE_FIELD_PROTECTED (type, i))
3352 children[v_protected]++;
3353 else if (TYPE_FIELD_PRIVATE (type, i))
3354 children[v_private]++;
3355 else
3356 children[v_public]++;
3357 }
3358}
3359
3360static char *
fba45db2 3361cplus_name_of_variable (struct varobj *parent)
8b93c638
JM
3362{
3363 return c_name_of_variable (parent);
3364}
3365
2024f65a
VP
3366enum accessibility { private_field, protected_field, public_field };
3367
3368/* Check if field INDEX of TYPE has the specified accessibility.
3369 Return 0 if so and 1 otherwise. */
3370static int
3371match_accessibility (struct type *type, int index, enum accessibility acc)
8b93c638 3372{
2024f65a
VP
3373 if (acc == private_field && TYPE_FIELD_PRIVATE (type, index))
3374 return 1;
3375 else if (acc == protected_field && TYPE_FIELD_PROTECTED (type, index))
3376 return 1;
3377 else if (acc == public_field && !TYPE_FIELD_PRIVATE (type, index)
3378 && !TYPE_FIELD_PROTECTED (type, index))
3379 return 1;
3380 else
3381 return 0;
3382}
3383
3384static void
3385cplus_describe_child (struct varobj *parent, int index,
02142340
VP
3386 char **cname, struct value **cvalue, struct type **ctype,
3387 char **cfull_expression)
2024f65a 3388{
2024f65a 3389 struct value *value;
8b93c638 3390 struct type *type;
02142340
VP
3391 int was_ptr;
3392 char *parent_expression = NULL;
8b93c638 3393
2024f65a
VP
3394 if (cname)
3395 *cname = NULL;
3396 if (cvalue)
3397 *cvalue = NULL;
3398 if (ctype)
3399 *ctype = NULL;
02142340
VP
3400 if (cfull_expression)
3401 *cfull_expression = NULL;
2024f65a 3402
8b93c638
JM
3403 if (CPLUS_FAKE_CHILD (parent))
3404 {
2024f65a
VP
3405 value = parent->parent->value;
3406 type = get_value_type (parent->parent);
02142340
VP
3407 if (cfull_expression)
3408 parent_expression = varobj_get_path_expr (parent->parent);
8b93c638
JM
3409 }
3410 else
2024f65a
VP
3411 {
3412 value = parent->value;
3413 type = get_value_type (parent);
02142340
VP
3414 if (cfull_expression)
3415 parent_expression = varobj_get_path_expr (parent);
2024f65a 3416 }
8b93c638 3417
02142340 3418 adjust_value_for_child_access (&value, &type, &was_ptr);
2024f65a
VP
3419
3420 if (TYPE_CODE (type) == TYPE_CODE_STRUCT
3f4178d6 3421 || TYPE_CODE (type) == TYPE_CODE_UNION)
8b93c638 3422 {
02142340 3423 char *join = was_ptr ? "->" : ".";
a109c7c1 3424
8b93c638
JM
3425 if (CPLUS_FAKE_CHILD (parent))
3426 {
6e382aa3
JJ
3427 /* The fields of the class type are ordered as they
3428 appear in the class. We are given an index for a
3429 particular access control type ("public","protected",
3430 or "private"). We must skip over fields that don't
3431 have the access control we are looking for to properly
581e13c1 3432 find the indexed field. */
6e382aa3 3433 int type_index = TYPE_N_BASECLASSES (type);
2024f65a 3434 enum accessibility acc = public_field;
d48cc9dd
DJ
3435 int vptr_fieldno;
3436 struct type *basetype = NULL;
3437
3438 vptr_fieldno = get_vptr_fieldno (type, &basetype);
6e382aa3 3439 if (strcmp (parent->name, "private") == 0)
2024f65a 3440 acc = private_field;
6e382aa3 3441 else if (strcmp (parent->name, "protected") == 0)
2024f65a
VP
3442 acc = protected_field;
3443
3444 while (index >= 0)
6e382aa3 3445 {
d48cc9dd
DJ
3446 if ((type == basetype && type_index == vptr_fieldno)
3447 || TYPE_FIELD_ARTIFICIAL (type, type_index))
2024f65a
VP
3448 ; /* ignore vptr */
3449 else if (match_accessibility (type, type_index, acc))
6e382aa3
JJ
3450 --index;
3451 ++type_index;
6e382aa3 3452 }
2024f65a
VP
3453 --type_index;
3454
3455 if (cname)
3456 *cname = xstrdup (TYPE_FIELD_NAME (type, type_index));
3457
3458 if (cvalue && value)
3459 *cvalue = value_struct_element_index (value, type_index);
3460
3461 if (ctype)
3462 *ctype = TYPE_FIELD_TYPE (type, type_index);
02142340
VP
3463
3464 if (cfull_expression)
3e43a32a
MS
3465 *cfull_expression
3466 = xstrprintf ("((%s)%s%s)", parent_expression,
3467 join,
3468 TYPE_FIELD_NAME (type, type_index));
2024f65a
VP
3469 }
3470 else if (index < TYPE_N_BASECLASSES (type))
3471 {
3472 /* This is a baseclass. */
3473 if (cname)
3474 *cname = xstrdup (TYPE_FIELD_NAME (type, index));
3475
3476 if (cvalue && value)
0cc7d26f 3477 *cvalue = value_cast (TYPE_FIELD_TYPE (type, index), value);
6e382aa3 3478
2024f65a
VP
3479 if (ctype)
3480 {
3481 *ctype = TYPE_FIELD_TYPE (type, index);
3482 }
02142340
VP
3483
3484 if (cfull_expression)
3485 {
3486 char *ptr = was_ptr ? "*" : "";
a109c7c1 3487
581e13c1 3488 /* Cast the parent to the base' type. Note that in gdb,
02142340
VP
3489 expression like
3490 (Base1)d
3491 will create an lvalue, for all appearences, so we don't
3492 need to use more fancy:
3493 *(Base1*)(&d)
0d932b2f
MK
3494 construct.
3495
3496 When we are in the scope of the base class or of one
3497 of its children, the type field name will be interpreted
3498 as a constructor, if it exists. Therefore, we must
3499 indicate that the name is a class name by using the
3500 'class' keyword. See PR mi/11912 */
3501 *cfull_expression = xstrprintf ("(%s(class %s%s) %s)",
02142340
VP
3502 ptr,
3503 TYPE_FIELD_NAME (type, index),
3504 ptr,
3505 parent_expression);
3506 }
8b93c638 3507 }
8b93c638
JM
3508 else
3509 {
348144ba 3510 char *access = NULL;
6e382aa3 3511 int children[3];
a109c7c1 3512
2024f65a 3513 cplus_class_num_children (type, children);
6e382aa3 3514
8b93c638 3515 /* Everything beyond the baseclasses can
6e382aa3
JJ
3516 only be "public", "private", or "protected"
3517
3518 The special "fake" children are always output by varobj in
581e13c1 3519 this order. So if INDEX == 2, it MUST be "protected". */
8b93c638
JM
3520 index -= TYPE_N_BASECLASSES (type);
3521 switch (index)
3522 {
3523 case 0:
6e382aa3 3524 if (children[v_public] > 0)
2024f65a 3525 access = "public";
6e382aa3 3526 else if (children[v_private] > 0)
2024f65a 3527 access = "private";
6e382aa3 3528 else
2024f65a 3529 access = "protected";
6e382aa3 3530 break;
8b93c638 3531 case 1:
6e382aa3 3532 if (children[v_public] > 0)
8b93c638 3533 {
6e382aa3 3534 if (children[v_private] > 0)
2024f65a 3535 access = "private";
6e382aa3 3536 else
2024f65a 3537 access = "protected";
8b93c638 3538 }
6e382aa3 3539 else if (children[v_private] > 0)
2024f65a 3540 access = "protected";
6e382aa3 3541 break;
8b93c638 3542 case 2:
581e13c1 3543 /* Must be protected. */
2024f65a 3544 access = "protected";
6e382aa3 3545 break;
8b93c638 3546 default:
581e13c1 3547 /* error! */
8b93c638
JM
3548 break;
3549 }
348144ba
MS
3550
3551 gdb_assert (access);
2024f65a
VP
3552 if (cname)
3553 *cname = xstrdup (access);
8b93c638 3554
02142340 3555 /* Value and type and full expression are null here. */
2024f65a 3556 }
8b93c638 3557 }
8b93c638
JM
3558 else
3559 {
02142340 3560 c_describe_child (parent, index, cname, cvalue, ctype, cfull_expression);
2024f65a
VP
3561 }
3562}
8b93c638 3563
2024f65a
VP
3564static char *
3565cplus_name_of_child (struct varobj *parent, int index)
3566{
3567 char *name = NULL;
a109c7c1 3568
02142340 3569 cplus_describe_child (parent, index, &name, NULL, NULL, NULL);
8b93c638
JM
3570 return name;
3571}
3572
02142340
VP
3573static char *
3574cplus_path_expr_of_child (struct varobj *child)
3575{
3576 cplus_describe_child (child->parent, child->index, NULL, NULL, NULL,
3577 &child->path_expr);
3578 return child->path_expr;
3579}
3580
30b28db1 3581static struct value *
fba45db2 3582cplus_value_of_root (struct varobj **var_handle)
8b93c638 3583{
73a93a32 3584 return c_value_of_root (var_handle);
8b93c638
JM
3585}
3586
30b28db1 3587static struct value *
fba45db2 3588cplus_value_of_child (struct varobj *parent, int index)
8b93c638 3589{
2024f65a 3590 struct value *value = NULL;
a109c7c1 3591
02142340 3592 cplus_describe_child (parent, index, NULL, &value, NULL, NULL);
8b93c638
JM
3593 return value;
3594}
3595
3596static struct type *
fba45db2 3597cplus_type_of_child (struct varobj *parent, int index)
8b93c638 3598{
2024f65a 3599 struct type *type = NULL;
a109c7c1 3600
02142340 3601 cplus_describe_child (parent, index, NULL, NULL, &type, NULL);
8b93c638
JM
3602 return type;
3603}
3604
8b93c638 3605static char *
a109c7c1
MS
3606cplus_value_of_variable (struct varobj *var,
3607 enum varobj_display_formats format)
8b93c638
JM
3608{
3609
3610 /* If we have one of our special types, don't print out
581e13c1 3611 any value. */
8b93c638
JM
3612 if (CPLUS_FAKE_CHILD (var))
3613 return xstrdup ("");
3614
de051565 3615 return c_value_of_variable (var, format);
8b93c638
JM
3616}
3617\f
3618/* Java */
3619
3620static int
fba45db2 3621java_number_of_children (struct varobj *var)
8b93c638
JM
3622{
3623 return cplus_number_of_children (var);
3624}
3625
3626static char *
fba45db2 3627java_name_of_variable (struct varobj *parent)
8b93c638
JM
3628{
3629 char *p, *name;
3630
3631 name = cplus_name_of_variable (parent);
3632 /* If the name has "-" in it, it is because we
581e13c1 3633 needed to escape periods in the name... */
8b93c638
JM
3634 p = name;
3635
3636 while (*p != '\000')
3637 {
3638 if (*p == '-')
3639 *p = '.';
3640 p++;
3641 }
3642
3643 return name;
3644}
3645
3646static char *
fba45db2 3647java_name_of_child (struct varobj *parent, int index)
8b93c638
JM
3648{
3649 char *name, *p;
3650
3651 name = cplus_name_of_child (parent, index);
581e13c1 3652 /* Escape any periods in the name... */
8b93c638
JM
3653 p = name;
3654
3655 while (*p != '\000')
3656 {
3657 if (*p == '.')
3658 *p = '-';
3659 p++;
3660 }
3661
3662 return name;
3663}
3664
02142340
VP
3665static char *
3666java_path_expr_of_child (struct varobj *child)
3667{
3668 return NULL;
3669}
3670
30b28db1 3671static struct value *
fba45db2 3672java_value_of_root (struct varobj **var_handle)
8b93c638 3673{
73a93a32 3674 return cplus_value_of_root (var_handle);
8b93c638
JM
3675}
3676
30b28db1 3677static struct value *
fba45db2 3678java_value_of_child (struct varobj *parent, int index)
8b93c638
JM
3679{
3680 return cplus_value_of_child (parent, index);
3681}
3682
3683static struct type *
fba45db2 3684java_type_of_child (struct varobj *parent, int index)
8b93c638
JM
3685{
3686 return cplus_type_of_child (parent, index);
3687}
3688
8b93c638 3689static char *
de051565 3690java_value_of_variable (struct varobj *var, enum varobj_display_formats format)
8b93c638 3691{
de051565 3692 return cplus_value_of_variable (var, format);
8b93c638 3693}
54333c3b 3694
40591b7d
JCD
3695/* Ada specific callbacks for VAROBJs. */
3696
3697static int
3698ada_number_of_children (struct varobj *var)
3699{
3700 return c_number_of_children (var);
3701}
3702
3703static char *
3704ada_name_of_variable (struct varobj *parent)
3705{
3706 return c_name_of_variable (parent);
3707}
3708
3709static char *
3710ada_name_of_child (struct varobj *parent, int index)
3711{
3712 return c_name_of_child (parent, index);
3713}
3714
3715static char*
3716ada_path_expr_of_child (struct varobj *child)
3717{
3718 return c_path_expr_of_child (child);
3719}
3720
3721static struct value *
3722ada_value_of_root (struct varobj **var_handle)
3723{
3724 return c_value_of_root (var_handle);
3725}
3726
3727static struct value *
3728ada_value_of_child (struct varobj *parent, int index)
3729{
3730 return c_value_of_child (parent, index);
3731}
3732
3733static struct type *
3734ada_type_of_child (struct varobj *parent, int index)
3735{
3736 return c_type_of_child (parent, index);
3737}
3738
3739static char *
3740ada_value_of_variable (struct varobj *var, enum varobj_display_formats format)
3741{
3742 return c_value_of_variable (var, format);
3743}
3744
54333c3b
JK
3745/* Iterate all the existing _root_ VAROBJs and call the FUNC callback for them
3746 with an arbitrary caller supplied DATA pointer. */
3747
3748void
3749all_root_varobjs (void (*func) (struct varobj *var, void *data), void *data)
3750{
3751 struct varobj_root *var_root, *var_root_next;
3752
3753 /* Iterate "safely" - handle if the callee deletes its passed VAROBJ. */
3754
3755 for (var_root = rootlist; var_root != NULL; var_root = var_root_next)
3756 {
3757 var_root_next = var_root->next;
3758
3759 (*func) (var_root->rootvar, data);
3760 }
3761}
8b93c638
JM
3762\f
3763extern void _initialize_varobj (void);
3764void
3765_initialize_varobj (void)
3766{
3767 int sizeof_table = sizeof (struct vlist *) * VAROBJ_TABLE_SIZE;
3768
3769 varobj_table = xmalloc (sizeof_table);
3770 memset (varobj_table, 0, sizeof_table);
3771
85c07804 3772 add_setshow_zinteger_cmd ("debugvarobj", class_maintenance,
3e43a32a
MS
3773 &varobjdebug,
3774 _("Set varobj debugging."),
3775 _("Show varobj debugging."),
3776 _("When non-zero, varobj debugging is enabled."),
3777 NULL, show_varobjdebug,
85c07804 3778 &setlist, &showlist);
8b93c638 3779}
8756216b 3780
54333c3b
JK
3781/* Invalidate varobj VAR if it is tied to locals and re-create it if it is
3782 defined on globals. It is a helper for varobj_invalidate. */
2dbd25e5 3783
54333c3b
JK
3784static void
3785varobj_invalidate_iter (struct varobj *var, void *unused)
8756216b 3786{
54333c3b
JK
3787 /* Floating varobjs are reparsed on each stop, so we don't care if the
3788 presently parsed expression refers to something that's gone. */
3789 if (var->root->floating)
3790 return;
8756216b 3791
54333c3b
JK
3792 /* global var must be re-evaluated. */
3793 if (var->root->valid_block == NULL)
2dbd25e5 3794 {
54333c3b 3795 struct varobj *tmp_var;
2dbd25e5 3796
54333c3b
JK
3797 /* Try to create a varobj with same expression. If we succeed
3798 replace the old varobj, otherwise invalidate it. */
3799 tmp_var = varobj_create (NULL, var->name, (CORE_ADDR) 0,
3800 USE_CURRENT_FRAME);
3801 if (tmp_var != NULL)
3802 {
3803 tmp_var->obj_name = xstrdup (var->obj_name);
3804 varobj_delete (var, NULL, 0);
3805 install_variable (tmp_var);
2dbd25e5 3806 }
54333c3b
JK
3807 else
3808 var->root->is_valid = 0;
2dbd25e5 3809 }
54333c3b
JK
3810 else /* locals must be invalidated. */
3811 var->root->is_valid = 0;
3812}
3813
3814/* Invalidate the varobjs that are tied to locals and re-create the ones that
3815 are defined on globals.
3816 Invalidated varobjs will be always printed in_scope="invalid". */
3817
3818void
3819varobj_invalidate (void)
3820{
3821 all_root_varobjs (varobj_invalidate_iter, NULL);
8756216b 3822}
This page took 1.471425 seconds and 4 git commands to generate.