1 /* MI Command Set - varobj commands.
3 Copyright (C) 2000, 2002, 2004, 2005, 2007, 2008, 2009
4 Free Software Foundation, Inc.
6 Contributed by Cygnus Solutions (a Red Hat company).
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
30 #include "gdb_string.h"
31 #include "mi-getopt.h"
32 #include "gdbthread.h"
34 const char mi_no_values
[] = "--no-values";
35 const char mi_simple_values
[] = "--simple-values";
36 const char mi_all_values
[] = "--all-values";
38 extern int varobjdebug
; /* defined in varobj.c. */
40 static void varobj_update_one (struct varobj
*var
,
41 enum print_values print_values
,
44 static int mi_print_value_p (struct type
*type
, enum print_values print_values
);
46 /* Print variable object VAR. The PRINT_VALUES parameter controls
47 if the value should be printed. The PRINT_EXPRESSION parameter
48 controls if the expression should be printed. */
50 print_varobj (struct varobj
*var
, enum print_values print_values
,
53 struct type
*gdb_type
;
57 ui_out_field_string (uiout
, "name", varobj_get_objname (var
));
59 ui_out_field_string (uiout
, "exp", varobj_get_expression (var
));
60 ui_out_field_int (uiout
, "numchild", varobj_get_num_children (var
));
62 if (mi_print_value_p (varobj_get_gdb_type (var
), print_values
))
63 ui_out_field_string (uiout
, "value", varobj_get_value (var
));
65 type
= varobj_get_type (var
);
68 ui_out_field_string (uiout
, "type", type
);
72 thread_id
= varobj_get_thread_id (var
);
74 ui_out_field_int (uiout
, "thread-id", thread_id
);
76 if (varobj_get_frozen (var
))
77 ui_out_field_int (uiout
, "frozen", 1);
80 /* VAROBJ operations */
83 mi_cmd_var_create (char *command
, char **argv
, int argc
)
85 CORE_ADDR frameaddr
= 0;
90 struct cleanup
*old_cleanups
;
91 enum varobj_type var_type
;
95 /* mi_error_message = xstrprintf ("mi_cmd_var_create: Usage:
96 ...."); return MI_CMD_ERROR; */
97 error (_("mi_cmd_var_create: Usage: NAME FRAME EXPRESSION."));
100 name
= xstrdup (argv
[0]);
101 /* Add cleanup for name. Must be free_current_contents as
102 name can be reallocated */
103 old_cleanups
= make_cleanup (free_current_contents
, &name
);
105 frame
= xstrdup (argv
[1]);
106 make_cleanup (xfree
, frame
);
108 expr
= xstrdup (argv
[2]);
109 make_cleanup (xfree
, expr
);
111 if (strcmp (name
, "-") == 0)
114 name
= varobj_gen_name ();
116 else if (!isalpha (*name
))
117 error (_("mi_cmd_var_create: name of object must begin with a letter"));
119 if (strcmp (frame
, "*") == 0)
120 var_type
= USE_CURRENT_FRAME
;
121 else if (strcmp (frame
, "@") == 0)
122 var_type
= USE_SELECTED_FRAME
;
125 var_type
= USE_SPECIFIED_FRAME
;
126 frameaddr
= string_to_core_addr (frame
);
130 fprintf_unfiltered (gdb_stdlog
,
131 "Name=\"%s\", Frame=\"%s\" (0x%s), Expression=\"%s\"\n",
132 name
, frame
, paddr (frameaddr
), expr
);
134 var
= varobj_create (name
, expr
, frameaddr
, var_type
);
137 error (_("mi_cmd_var_create: unable to create variable object"));
139 print_varobj (var
, PRINT_ALL_VALUES
, 0 /* don't print expression */);
141 do_cleanups (old_cleanups
);
145 mi_cmd_var_delete (char *command
, char **argv
, int argc
)
150 int children_only_p
= 0;
151 struct cleanup
*old_cleanups
;
153 if (argc
< 1 || argc
> 2)
154 error (_("mi_cmd_var_delete: Usage: [-c] EXPRESSION."));
156 name
= xstrdup (argv
[0]);
157 /* Add cleanup for name. Must be free_current_contents as
158 name can be reallocated */
159 old_cleanups
= make_cleanup (free_current_contents
, &name
);
161 /* If we have one single argument it cannot be '-c' or any string
162 starting with '-'. */
165 if (strcmp (name
, "-c") == 0)
166 error (_("mi_cmd_var_delete: Missing required argument after '-c': variable object name"));
168 error (_("mi_cmd_var_delete: Illegal variable object name"));
171 /* If we have 2 arguments they must be '-c' followed by a string
172 which would be the variable name. */
175 if (strcmp (name
, "-c") != 0)
176 error (_("mi_cmd_var_delete: Invalid option."));
178 do_cleanups (old_cleanups
);
179 name
= xstrdup (argv
[1]);
180 make_cleanup (free_current_contents
, &name
);
183 /* If we didn't error out, now NAME contains the name of the
186 var
= varobj_get_handle (name
);
188 numdel
= varobj_delete (var
, NULL
, children_only_p
);
190 ui_out_field_int (uiout
, "ndeleted", numdel
);
192 do_cleanups (old_cleanups
);
195 /* Parse a string argument into a format value. */
197 static enum varobj_display_formats
198 mi_parse_format (const char *arg
)
206 if (strncmp (arg
, "natural", len
) == 0)
207 return FORMAT_NATURAL
;
208 else if (strncmp (arg
, "binary", len
) == 0)
209 return FORMAT_BINARY
;
210 else if (strncmp (arg
, "decimal", len
) == 0)
211 return FORMAT_DECIMAL
;
212 else if (strncmp (arg
, "hexadecimal", len
) == 0)
213 return FORMAT_HEXADECIMAL
;
214 else if (strncmp (arg
, "octal", len
) == 0)
218 error (_("Must specify the format as: \"natural\", \"binary\", \"decimal\", \"hexadecimal\", or \"octal\""));
222 mi_cmd_var_set_format (char *command
, char **argv
, int argc
)
224 enum varobj_display_formats format
;
228 error (_("mi_cmd_var_set_format: Usage: NAME FORMAT."));
230 /* Get varobj handle, if a valid var obj name was specified */
231 var
= varobj_get_handle (argv
[0]);
233 format
= mi_parse_format (argv
[1]);
235 /* Set the format of VAR to given format */
236 varobj_set_display_format (var
, format
);
238 /* Report the new current format */
239 ui_out_field_string (uiout
, "format", varobj_format_string
[(int) format
]);
241 /* Report the value in the new format */
242 ui_out_field_string (uiout
, "value", varobj_get_value (var
));
246 mi_cmd_var_set_frozen (char *command
, char **argv
, int argc
)
252 error (_("-var-set-format: Usage: NAME FROZEN_FLAG."));
254 var
= varobj_get_handle (argv
[0]);
256 if (strcmp (argv
[1], "0") == 0)
258 else if (strcmp (argv
[1], "1") == 0)
261 error (_("Invalid flag value"));
263 varobj_set_frozen (var
, frozen
);
265 /* We don't automatically return the new value, or what varobjs got new
266 values during unfreezing. If this information is required, client
267 should call -var-update explicitly. */
272 mi_cmd_var_show_format (char *command
, char **argv
, int argc
)
274 enum varobj_display_formats format
;
278 error (_("mi_cmd_var_show_format: Usage: NAME."));
280 /* Get varobj handle, if a valid var obj name was specified */
281 var
= varobj_get_handle (argv
[0]);
283 format
= varobj_get_display_format (var
);
285 /* Report the current format */
286 ui_out_field_string (uiout
, "format", varobj_format_string
[(int) format
]);
290 mi_cmd_var_info_num_children (char *command
, char **argv
, int argc
)
295 error (_("mi_cmd_var_info_num_children: Usage: NAME."));
297 /* Get varobj handle, if a valid var obj name was specified */
298 var
= varobj_get_handle (argv
[0]);
300 ui_out_field_int (uiout
, "numchild", varobj_get_num_children (var
));
303 /* Parse a string argument into a print_values value. */
305 static enum print_values
306 mi_parse_values_option (const char *arg
)
308 if (strcmp (arg
, "0") == 0
309 || strcmp (arg
, mi_no_values
) == 0)
310 return PRINT_NO_VALUES
;
311 else if (strcmp (arg
, "1") == 0
312 || strcmp (arg
, mi_all_values
) == 0)
313 return PRINT_ALL_VALUES
;
314 else if (strcmp (arg
, "2") == 0
315 || strcmp (arg
, mi_simple_values
) == 0)
316 return PRINT_SIMPLE_VALUES
;
318 error (_("Unknown value for PRINT_VALUES\n\
319 Must be: 0 or \"%s\", 1 or \"%s\", 2 or \"%s\""),
320 mi_no_values
, mi_simple_values
, mi_all_values
);
323 /* Return 1 if given the argument PRINT_VALUES we should display
324 a value of type TYPE. */
327 mi_print_value_p (struct type
*type
, enum print_values print_values
)
330 if (print_values
== PRINT_NO_VALUES
)
333 if (print_values
== PRINT_ALL_VALUES
)
340 type
= check_typedef (type
);
342 /* For PRINT_SIMPLE_VALUES, only print the value if it has a type
343 and that type is not a compound type. */
344 return (TYPE_CODE (type
) != TYPE_CODE_ARRAY
345 && TYPE_CODE (type
) != TYPE_CODE_STRUCT
346 && TYPE_CODE (type
) != TYPE_CODE_UNION
);
351 mi_cmd_var_list_children (char *command
, char **argv
, int argc
)
354 VEC(varobj_p
) *children
;
355 struct varobj
*child
;
356 struct cleanup
*cleanup_children
;
358 enum print_values print_values
;
361 if (argc
!= 1 && argc
!= 2)
362 error (_("mi_cmd_var_list_children: Usage: [PRINT_VALUES] NAME"));
364 /* Get varobj handle, if a valid var obj name was specified */
366 var
= varobj_get_handle (argv
[0]);
368 var
= varobj_get_handle (argv
[1]);
370 children
= varobj_list_children (var
);
371 ui_out_field_int (uiout
, "numchild", VEC_length (varobj_p
, children
));
373 print_values
= mi_parse_values_option (argv
[0]);
375 print_values
= PRINT_NO_VALUES
;
377 if (VEC_length (varobj_p
, children
) == 0)
380 if (mi_version (uiout
) == 1)
381 cleanup_children
= make_cleanup_ui_out_tuple_begin_end (uiout
, "children");
383 cleanup_children
= make_cleanup_ui_out_list_begin_end (uiout
, "children");
384 for (ix
= 0; VEC_iterate (varobj_p
, children
, ix
, child
); ++ix
)
386 struct cleanup
*cleanup_child
;
387 cleanup_child
= make_cleanup_ui_out_tuple_begin_end (uiout
, "child");
388 print_varobj (child
, print_values
, 1 /* print expression */);
389 do_cleanups (cleanup_child
);
391 do_cleanups (cleanup_children
);
395 mi_cmd_var_info_type (char *command
, char **argv
, int argc
)
400 error (_("mi_cmd_var_info_type: Usage: NAME."));
402 /* Get varobj handle, if a valid var obj name was specified */
403 var
= varobj_get_handle (argv
[0]);
405 ui_out_field_string (uiout
, "type", varobj_get_type (var
));
409 mi_cmd_var_info_path_expression (char *command
, char **argv
, int argc
)
415 error (_("Usage: NAME."));
417 /* Get varobj handle, if a valid var obj name was specified. */
418 var
= varobj_get_handle (argv
[0]);
420 path_expr
= varobj_get_path_expr (var
);
422 ui_out_field_string (uiout
, "path_expr", path_expr
);
426 mi_cmd_var_info_expression (char *command
, char **argv
, int argc
)
428 enum varobj_languages lang
;
432 error (_("mi_cmd_var_info_expression: Usage: NAME."));
434 /* Get varobj handle, if a valid var obj name was specified */
435 var
= varobj_get_handle (argv
[0]);
437 lang
= varobj_get_language (var
);
439 ui_out_field_string (uiout
, "lang", varobj_language_string
[(int) lang
]);
440 ui_out_field_string (uiout
, "exp", varobj_get_expression (var
));
444 mi_cmd_var_show_attributes (char *command
, char **argv
, int argc
)
451 error (_("mi_cmd_var_show_attributes: Usage: NAME."));
453 /* Get varobj handle, if a valid var obj name was specified */
454 var
= varobj_get_handle (argv
[0]);
456 attr
= varobj_get_attributes (var
);
457 /* FIXME: define masks for attributes */
458 if (attr
& 0x00000001)
461 attstr
= "noneditable";
463 ui_out_field_string (uiout
, "attr", attstr
);
467 mi_cmd_var_evaluate_expression (char *command
, char **argv
, int argc
)
471 enum varobj_display_formats format
;
480 static struct mi_opt opts
[] =
486 /* Parse arguments */
487 format
= FORMAT_NATURAL
;
492 int opt
= mi_getopt ("-var-evaluate-expression", argc
, argv
, opts
, &optind
, &optarg
);
495 switch ((enum opt
) opt
)
499 error (_("Cannot specify format more than once"));
501 format
= mi_parse_format (optarg
);
508 error (_("Usage: [-f FORMAT] NAME"));
510 if (optind
< argc
- 1)
511 error (_("Garbage at end of command"));
513 /* Get varobj handle, if a valid var obj name was specified */
514 var
= varobj_get_handle (argv
[optind
]);
517 ui_out_field_string (uiout
, "value", varobj_get_formatted_value (var
, format
));
519 ui_out_field_string (uiout
, "value", varobj_get_value (var
));
523 mi_cmd_var_assign (char *command
, char **argv
, int argc
)
529 error (_("mi_cmd_var_assign: Usage: NAME EXPRESSION."));
531 /* Get varobj handle, if a valid var obj name was specified */
532 var
= varobj_get_handle (argv
[0]);
534 if (!varobj_editable_p (var
))
535 error (_("mi_cmd_var_assign: Variable object is not editable"));
537 expression
= xstrdup (argv
[1]);
539 if (!varobj_set_value (var
, expression
))
540 error (_("mi_cmd_var_assign: Could not assign expression to variable object"));
542 ui_out_field_string (uiout
, "value", varobj_get_value (var
));
546 mi_cmd_var_update (char *command
, char **argv
, int argc
)
549 struct varobj
**rootlist
;
551 struct cleanup
*cleanup
;
554 enum print_values print_values
;
556 if (argc
!= 1 && argc
!= 2)
557 error (_("mi_cmd_var_update: Usage: [PRINT_VALUES] NAME."));
565 print_values
= mi_parse_values_option (argv
[0]);
567 print_values
= PRINT_NO_VALUES
;
569 /* Check if the parameter is a "*" which means that we want
570 to update all variables */
572 if ((*name
== '*' || *name
== '@') && (*(name
+ 1) == '\0'))
574 nv
= varobj_list (&rootlist
);
575 cleanup
= make_cleanup (xfree
, rootlist
);
576 if (mi_version (uiout
) <= 1)
577 make_cleanup_ui_out_tuple_begin_end (uiout
, "changelist");
579 make_cleanup_ui_out_list_begin_end (uiout
, "changelist");
582 do_cleanups (cleanup
);
588 int thread_id
= varobj_get_thread_id (*cr
);
589 int thread_stopped
= 0;
590 if (thread_id
== -1 && is_stopped (inferior_ptid
))
594 struct thread_info
*tp
= find_thread_id (thread_id
);
596 thread_stopped
= is_stopped (tp
->ptid
);
601 if (*name
== '*' || varobj_floating_p (*cr
))
602 varobj_update_one (*cr
, print_values
, 0 /* implicit */);
605 do_cleanups (cleanup
);
609 /* Get varobj handle, if a valid var obj name was specified */
610 var
= varobj_get_handle (name
);
612 if (mi_version (uiout
) <= 1)
613 cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, "changelist");
615 cleanup
= make_cleanup_ui_out_list_begin_end (uiout
, "changelist");
616 varobj_update_one (var
, print_values
, 1 /* explicit */);
617 do_cleanups (cleanup
);
621 /* Helper for mi_cmd_var_update(). */
624 varobj_update_one (struct varobj
*var
, enum print_values print_values
,
628 struct cleanup
*cleanup
= NULL
;
629 VEC (varobj_update_result
) *changes
;
630 varobj_update_result
*r
;
633 changes
= varobj_update (&var
, explicit);
635 for (i
= 0; VEC_iterate (varobj_update_result
, changes
, i
, r
); ++i
)
637 if (mi_version (uiout
) > 1)
638 cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
639 ui_out_field_string (uiout
, "name", varobj_get_objname (r
->varobj
));
643 case VAROBJ_IN_SCOPE
:
644 if (mi_print_value_p (varobj_get_gdb_type (r
->varobj
), print_values
))
645 ui_out_field_string (uiout
, "value", varobj_get_value (r
->varobj
));
646 ui_out_field_string (uiout
, "in_scope", "true");
648 case VAROBJ_NOT_IN_SCOPE
:
649 ui_out_field_string (uiout
, "in_scope", "false");
652 ui_out_field_string (uiout
, "in_scope", "invalid");
656 if (r
->status
!= VAROBJ_INVALID
)
659 ui_out_field_string (uiout
, "type_changed", "true");
661 ui_out_field_string (uiout
, "type_changed", "false");
666 ui_out_field_string (uiout
, "new_type", varobj_get_type (r
->varobj
));
667 ui_out_field_int (uiout
, "new_num_children",
668 varobj_get_num_children (r
->varobj
));
671 if (mi_version (uiout
) > 1)
672 do_cleanups (cleanup
);
674 VEC_free (varobj_update_result
, changes
);