1 /* MI Command Set - varobj commands.
3 Copyright (C) 2000, 2002, 2004, 2005, 2007, 2008, 2009, 2010
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 varobj *var, 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;
58 ui_out_field_string (uiout, "name", varobj_get_objname (var));
60 ui_out_field_string (uiout, "exp", varobj_get_expression (var));
61 ui_out_field_int (uiout, "numchild", varobj_get_num_children (var));
63 if (mi_print_value_p (var, print_values))
65 char *val = varobj_get_value (var);
66 ui_out_field_string (uiout, "value", val);
70 type = varobj_get_type (var);
73 ui_out_field_string (uiout, "type", type);
77 thread_id = varobj_get_thread_id (var);
79 ui_out_field_int (uiout, "thread-id", thread_id);
81 if (varobj_get_frozen (var))
82 ui_out_field_int (uiout, "frozen", 1);
84 display_hint = varobj_get_display_hint (var);
87 ui_out_field_string (uiout, "displayhint", display_hint);
91 if (varobj_pretty_printed_p (var))
92 ui_out_field_int (uiout, "dynamic", 1);
95 /* VAROBJ operations */
98 mi_cmd_var_create (char *command, char **argv, int argc)
100 CORE_ADDR frameaddr = 0;
105 struct cleanup *old_cleanups;
106 enum varobj_type var_type;
110 /* mi_error_message = xstrprintf ("mi_cmd_var_create: Usage:
111 ...."); return MI_CMD_ERROR; */
112 error (_("mi_cmd_var_create: Usage: NAME FRAME EXPRESSION."));
115 name = xstrdup (argv[0]);
116 /* Add cleanup for name. Must be free_current_contents as
117 name can be reallocated */
118 old_cleanups = make_cleanup (free_current_contents, &name);
120 frame = xstrdup (argv[1]);
121 make_cleanup (xfree, frame);
123 expr = xstrdup (argv[2]);
124 make_cleanup (xfree, expr);
126 if (strcmp (name, "-") == 0)
129 name = varobj_gen_name ();
131 else if (!isalpha (*name))
132 error (_("mi_cmd_var_create: name of object must begin with a letter"));
134 if (strcmp (frame, "*") == 0)
135 var_type = USE_CURRENT_FRAME;
136 else if (strcmp (frame, "@") == 0)
137 var_type = USE_SELECTED_FRAME;
140 var_type = USE_SPECIFIED_FRAME;
141 frameaddr = string_to_core_addr (frame);
145 fprintf_unfiltered (gdb_stdlog,
146 "Name=\"%s\", Frame=\"%s\" (%s), Expression=\"%s\"\n",
147 name, frame, hex_string (frameaddr), expr);
149 var = varobj_create (name, expr, frameaddr, var_type);
152 error (_("mi_cmd_var_create: unable to create variable object"));
154 print_varobj (var, PRINT_ALL_VALUES, 0 /* don't print expression */);
156 ui_out_field_int (uiout, "has_more", varobj_has_more (var, 0));
158 do_cleanups (old_cleanups);
162 mi_cmd_var_delete (char *command, char **argv, int argc)
167 int children_only_p = 0;
168 struct cleanup *old_cleanups;
170 if (argc < 1 || argc > 2)
171 error (_("mi_cmd_var_delete: Usage: [-c] EXPRESSION."));
173 name = xstrdup (argv[0]);
174 /* Add cleanup for name. Must be free_current_contents as
175 name can be reallocated */
176 old_cleanups = make_cleanup (free_current_contents, &name);
178 /* If we have one single argument it cannot be '-c' or any string
179 starting with '-'. */
182 if (strcmp (name, "-c") == 0)
183 error (_("mi_cmd_var_delete: Missing required argument after '-c': variable object name"));
185 error (_("mi_cmd_var_delete: Illegal variable object name"));
188 /* If we have 2 arguments they must be '-c' followed by a string
189 which would be the variable name. */
192 if (strcmp (name, "-c") != 0)
193 error (_("mi_cmd_var_delete: Invalid option."));
195 do_cleanups (old_cleanups);
196 name = xstrdup (argv[1]);
197 make_cleanup (free_current_contents, &name);
200 /* If we didn't error out, now NAME contains the name of the
203 var = varobj_get_handle (name);
205 numdel = varobj_delete (var, NULL, children_only_p);
207 ui_out_field_int (uiout, "ndeleted", numdel);
209 do_cleanups (old_cleanups);
212 /* Parse a string argument into a format value. */
214 static enum varobj_display_formats
215 mi_parse_format (const char *arg)
223 if (strncmp (arg, "natural", len) == 0)
224 return FORMAT_NATURAL;
225 else if (strncmp (arg, "binary", len) == 0)
226 return FORMAT_BINARY;
227 else if (strncmp (arg, "decimal", len) == 0)
228 return FORMAT_DECIMAL;
229 else if (strncmp (arg, "hexadecimal", len) == 0)
230 return FORMAT_HEXADECIMAL;
231 else if (strncmp (arg, "octal", len) == 0)
235 error (_("Must specify the format as: \"natural\", \"binary\", \"decimal\", \"hexadecimal\", or \"octal\""));
239 mi_cmd_var_set_format (char *command, char **argv, int argc)
241 enum varobj_display_formats format;
246 error (_("mi_cmd_var_set_format: Usage: NAME FORMAT."));
248 /* Get varobj handle, if a valid var obj name was specified */
249 var = varobj_get_handle (argv[0]);
251 format = mi_parse_format (argv[1]);
253 /* Set the format of VAR to given format */
254 varobj_set_display_format (var, format);
256 /* Report the new current format */
257 ui_out_field_string (uiout, "format", varobj_format_string[(int) format]);
259 /* Report the value in the new format */
260 val = varobj_get_value (var);
261 ui_out_field_string (uiout, "value", val);
266 mi_cmd_var_set_visualizer (char *command, char **argv, int argc)
271 error ("Usage: NAME VISUALIZER_FUNCTION.");
273 var = varobj_get_handle (argv[0]);
276 error ("Variable object not found");
278 varobj_set_visualizer (var, argv[1]);
282 mi_cmd_var_set_frozen (char *command, char **argv, int argc)
288 error (_("-var-set-format: Usage: NAME FROZEN_FLAG."));
290 var = varobj_get_handle (argv[0]);
292 if (strcmp (argv[1], "0") == 0)
294 else if (strcmp (argv[1], "1") == 0)
297 error (_("Invalid flag value"));
299 varobj_set_frozen (var, frozen);
301 /* We don't automatically return the new value, or what varobjs got new
302 values during unfreezing. If this information is required, client
303 should call -var-update explicitly. */
308 mi_cmd_var_show_format (char *command, char **argv, int argc)
310 enum varobj_display_formats format;
314 error (_("mi_cmd_var_show_format: Usage: NAME."));
316 /* Get varobj handle, if a valid var obj name was specified */
317 var = varobj_get_handle (argv[0]);
319 format = varobj_get_display_format (var);
321 /* Report the current format */
322 ui_out_field_string (uiout, "format", varobj_format_string[(int) format]);
326 mi_cmd_var_info_num_children (char *command, char **argv, int argc)
331 error (_("mi_cmd_var_info_num_children: Usage: NAME."));
333 /* Get varobj handle, if a valid var obj name was specified */
334 var = varobj_get_handle (argv[0]);
336 ui_out_field_int (uiout, "numchild", varobj_get_num_children (var));
339 /* Parse a string argument into a print_values value. */
341 static enum print_values
342 mi_parse_values_option (const char *arg)
344 if (strcmp (arg, "0") == 0
345 || strcmp (arg, mi_no_values) == 0)
346 return PRINT_NO_VALUES;
347 else if (strcmp (arg, "1") == 0
348 || strcmp (arg, mi_all_values) == 0)
349 return PRINT_ALL_VALUES;
350 else if (strcmp (arg, "2") == 0
351 || strcmp (arg, mi_simple_values) == 0)
352 return PRINT_SIMPLE_VALUES;
354 error (_("Unknown value for PRINT_VALUES\n\
355 Must be: 0 or \"%s\", 1 or \"%s\", 2 or \"%s\""),
356 mi_no_values, mi_simple_values, mi_all_values);
359 /* Return 1 if given the argument PRINT_VALUES we should display
363 mi_print_value_p (struct varobj *var, enum print_values print_values)
367 if (print_values == PRINT_NO_VALUES)
370 if (print_values == PRINT_ALL_VALUES)
373 if (varobj_pretty_printed_p (var))
376 type = varobj_get_gdb_type (var);
381 type = check_typedef (type);
383 /* For PRINT_SIMPLE_VALUES, only print the value if it has a type
384 and that type is not a compound type. */
385 return (TYPE_CODE (type) != TYPE_CODE_ARRAY
386 && TYPE_CODE (type) != TYPE_CODE_STRUCT
387 && TYPE_CODE (type) != TYPE_CODE_UNION);
392 mi_cmd_var_list_children (char *command, char **argv, int argc)
395 VEC(varobj_p) *children;
396 struct varobj *child;
398 enum print_values print_values;
403 if (argc < 1 || argc > 4)
404 error (_("mi_cmd_var_list_children: Usage: [PRINT_VALUES] NAME [FROM TO]"));
406 /* Get varobj handle, if a valid var obj name was specified */
407 if (argc == 1 || argc == 3)
408 var = varobj_get_handle (argv[0]);
410 var = varobj_get_handle (argv[1]);
414 from = atoi (argv[argc - 2]);
415 to = atoi (argv[argc - 1]);
423 children = varobj_list_children (var, &from, &to);
424 ui_out_field_int (uiout, "numchild", to - from);
425 if (argc == 2 || argc == 4)
426 print_values = mi_parse_values_option (argv[0]);
428 print_values = PRINT_NO_VALUES;
430 display_hint = varobj_get_display_hint (var);
433 ui_out_field_string (uiout, "displayhint", display_hint);
434 xfree (display_hint);
439 struct cleanup *cleanup_children;
440 if (mi_version (uiout) == 1)
442 = make_cleanup_ui_out_tuple_begin_end (uiout, "children");
445 = make_cleanup_ui_out_list_begin_end (uiout, "children");
447 ix < to && VEC_iterate (varobj_p, children, ix, child);
450 struct cleanup *cleanup_child;
451 cleanup_child = make_cleanup_ui_out_tuple_begin_end (uiout, "child");
452 print_varobj (child, print_values, 1 /* print expression */);
453 do_cleanups (cleanup_child);
455 do_cleanups (cleanup_children);
458 ui_out_field_int (uiout, "has_more", varobj_has_more (var, to));
462 mi_cmd_var_info_type (char *command, char **argv, int argc)
467 error (_("mi_cmd_var_info_type: Usage: NAME."));
469 /* Get varobj handle, if a valid var obj name was specified */
470 var = varobj_get_handle (argv[0]);
472 ui_out_field_string (uiout, "type", varobj_get_type (var));
476 mi_cmd_var_info_path_expression (char *command, char **argv, int argc)
482 error (_("Usage: NAME."));
484 /* Get varobj handle, if a valid var obj name was specified. */
485 var = varobj_get_handle (argv[0]);
487 path_expr = varobj_get_path_expr (var);
489 ui_out_field_string (uiout, "path_expr", path_expr);
493 mi_cmd_var_info_expression (char *command, char **argv, int argc)
495 enum varobj_languages lang;
499 error (_("mi_cmd_var_info_expression: Usage: NAME."));
501 /* Get varobj handle, if a valid var obj name was specified */
502 var = varobj_get_handle (argv[0]);
504 lang = varobj_get_language (var);
506 ui_out_field_string (uiout, "lang", varobj_language_string[(int) lang]);
507 ui_out_field_string (uiout, "exp", varobj_get_expression (var));
511 mi_cmd_var_show_attributes (char *command, char **argv, int argc)
518 error (_("mi_cmd_var_show_attributes: Usage: NAME."));
520 /* Get varobj handle, if a valid var obj name was specified */
521 var = varobj_get_handle (argv[0]);
523 attr = varobj_get_attributes (var);
524 /* FIXME: define masks for attributes */
525 if (attr & 0x00000001)
528 attstr = "noneditable";
530 ui_out_field_string (uiout, "attr", attstr);
534 mi_cmd_var_evaluate_expression (char *command, char **argv, int argc)
538 enum varobj_display_formats format;
547 static struct mi_opt opts[] =
553 /* Parse arguments */
554 format = FORMAT_NATURAL;
559 int opt = mi_getopt ("-var-evaluate-expression", argc, argv, opts, &optind, &optarg);
562 switch ((enum opt) opt)
566 error (_("Cannot specify format more than once"));
568 format = mi_parse_format (optarg);
575 error (_("Usage: [-f FORMAT] NAME"));
577 if (optind < argc - 1)
578 error (_("Garbage at end of command"));
580 /* Get varobj handle, if a valid var obj name was specified */
581 var = varobj_get_handle (argv[optind]);
585 char *val = varobj_get_formatted_value (var, format);
586 ui_out_field_string (uiout, "value", val);
591 char *val = varobj_get_value (var);
592 ui_out_field_string (uiout, "value", val);
598 mi_cmd_var_assign (char *command, char **argv, int argc)
601 char *expression, *val;
604 error (_("mi_cmd_var_assign: Usage: NAME EXPRESSION."));
606 /* Get varobj handle, if a valid var obj name was specified */
607 var = varobj_get_handle (argv[0]);
609 if (!varobj_editable_p (var))
610 error (_("mi_cmd_var_assign: Variable object is not editable"));
612 expression = xstrdup (argv[1]);
614 if (!varobj_set_value (var, expression))
615 error (_("mi_cmd_var_assign: Could not assign expression to variable object"));
617 val = varobj_get_value (var);
618 ui_out_field_string (uiout, "value", val);
622 /* Type used for parameters passing to mi_cmd_var_update_iter. */
624 struct mi_cmd_var_update
627 enum print_values print_values;
630 /* Helper for mi_cmd_var_update - update each VAR. */
633 mi_cmd_var_update_iter (struct varobj *var, void *data_pointer)
635 struct mi_cmd_var_update *data = data_pointer;
636 int thread_id, thread_stopped;
638 thread_id = varobj_get_thread_id (var);
640 if (thread_id == -1 && is_stopped (inferior_ptid))
644 struct thread_info *tp = find_thread_id (thread_id);
647 thread_stopped = is_stopped (tp->ptid);
653 if (!data->only_floating || varobj_floating_p (var))
654 varobj_update_one (var, data->print_values, 0 /* implicit */);
658 mi_cmd_var_update (char *command, char **argv, int argc)
660 struct cleanup *cleanup;
662 enum print_values print_values;
664 if (argc != 1 && argc != 2)
665 error (_("mi_cmd_var_update: Usage: [PRINT_VALUES] NAME."));
673 print_values = mi_parse_values_option (argv[0]);
675 print_values = PRINT_NO_VALUES;
677 if (mi_version (uiout) <= 1)
678 cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "changelist");
680 cleanup = make_cleanup_ui_out_list_begin_end (uiout, "changelist");
682 /* Check if the parameter is a "*" which means that we want
683 to update all variables */
685 if ((*name == '*' || *name == '@') && (*(name + 1) == '\0'))
687 struct mi_cmd_var_update data;
689 data.only_floating = *name == '@';
690 data.print_values = print_values;
692 /* varobj_update_one automatically updates all the children of VAROBJ.
693 Therefore update each VAROBJ only once by iterating only the root
696 all_root_varobjs (mi_cmd_var_update_iter, &data);
700 /* Get varobj handle, if a valid var obj name was specified */
701 struct varobj *var = varobj_get_handle (name);
703 varobj_update_one (var, print_values, 1 /* explicit */);
706 do_cleanups (cleanup);
709 /* Helper for mi_cmd_var_update(). */
712 varobj_update_one (struct varobj *var, enum print_values print_values,
716 struct cleanup *cleanup = NULL;
717 VEC (varobj_update_result) *changes;
718 varobj_update_result *r;
721 changes = varobj_update (&var, explicit);
723 for (i = 0; VEC_iterate (varobj_update_result, changes, i, r); ++i)
728 if (mi_version (uiout) > 1)
729 cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
730 ui_out_field_string (uiout, "name", varobj_get_objname (r->varobj));
734 case VAROBJ_IN_SCOPE:
735 if (mi_print_value_p (r->varobj, print_values))
737 char *val = varobj_get_value (r->varobj);
738 ui_out_field_string (uiout, "value", val);
741 ui_out_field_string (uiout, "in_scope", "true");
743 case VAROBJ_NOT_IN_SCOPE:
744 ui_out_field_string (uiout, "in_scope", "false");
747 ui_out_field_string (uiout, "in_scope", "invalid");
751 if (r->status != VAROBJ_INVALID)
754 ui_out_field_string (uiout, "type_changed", "true");
756 ui_out_field_string (uiout, "type_changed", "false");
760 ui_out_field_string (uiout, "new_type", varobj_get_type (r->varobj));
762 if (r->type_changed || r->children_changed)
763 ui_out_field_int (uiout, "new_num_children",
764 varobj_get_num_children (r->varobj));
766 display_hint = varobj_get_display_hint (var);
769 ui_out_field_string (uiout, "displayhint", display_hint);
770 xfree (display_hint);
773 if (varobj_pretty_printed_p (var))
774 ui_out_field_int (uiout, "dynamic", 1);
776 varobj_get_child_range (r->varobj, &from, &to);
777 ui_out_field_int (uiout, "has_more",
778 varobj_has_more (r->varobj, to));
784 struct cleanup *cleanup;
786 cleanup = make_cleanup_ui_out_list_begin_end (uiout, "new_children");
787 for (j = 0; VEC_iterate (varobj_p, r->new, j, child); ++j)
789 struct cleanup *cleanup_child;
790 cleanup_child = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
791 print_varobj (child, print_values, 1 /* print_expression */);
792 do_cleanups (cleanup_child);
795 do_cleanups (cleanup);
796 VEC_free (varobj_p, r->new);
797 r->new = NULL; /* Paranoia. */
800 if (mi_version (uiout) > 1)
801 do_cleanups (cleanup);
803 VEC_free (varobj_update_result, changes);
807 mi_cmd_enable_pretty_printing (char *command, char **argv, int argc)
810 error (_("mi_cmd_enable_pretty_printing: no arguments allowed"));
811 varobj_enable_pretty_printing ();
815 mi_cmd_var_set_update_range (char *command, char **argv, int argc)
821 error (_("mi_cmd_var_set_update_range: Usage: VAROBJ FROM TO"));
823 var = varobj_get_handle (argv[0]);
824 from = atoi (argv[1]);
827 varobj_set_child_range (var, from, to);