1 /* MI Command Set - varobj commands.
2 Copyright (C) 2000-2017 Free Software Foundation, Inc.
4 Contributed by Cygnus Solutions (a Red Hat company).
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
30 #include "mi-getopt.h"
31 #include "gdbthread.h"
33 #include "common/gdb_optional.h"
35 extern unsigned int varobjdebug; /* defined in varobj.c. */
37 static void varobj_update_one (struct varobj *var,
38 enum print_values print_values,
41 static int mi_print_value_p (struct varobj *var,
42 enum print_values print_values);
44 /* Print variable object VAR. The PRINT_VALUES parameter controls
45 if the value should be printed. The PRINT_EXPRESSION parameter
46 controls if the expression should be printed. */
49 print_varobj (struct varobj *var, enum print_values print_values,
52 struct ui_out *uiout = current_uiout;
55 uiout->field_string ("name", varobj_get_objname (var));
58 std::string exp = varobj_get_expression (var);
60 uiout->field_string ("exp", exp.c_str ());
62 uiout->field_int ("numchild", varobj_get_num_children (var));
64 if (mi_print_value_p (var, print_values))
66 std::string val = varobj_get_value (var);
68 uiout->field_string ("value", val.c_str ());
71 std::string type = varobj_get_type (var);
73 uiout->field_string ("type", type.c_str ());
75 thread_id = varobj_get_thread_id (var);
77 uiout->field_int ("thread-id", thread_id);
79 if (varobj_get_frozen (var))
80 uiout->field_int ("frozen", 1);
82 gdb::unique_xmalloc_ptr<char> display_hint = varobj_get_display_hint (var);
84 uiout->field_string ("displayhint", display_hint.get ());
86 if (varobj_is_dynamic_p (var))
87 uiout->field_int ("dynamic", 1);
90 /* VAROBJ operations */
93 mi_cmd_var_create (const char *command, char **argv, int argc)
95 struct ui_out *uiout = current_uiout;
96 CORE_ADDR frameaddr = 0;
101 struct cleanup *old_cleanups;
102 enum varobj_type var_type;
105 error (_("-var-create: Usage: NAME FRAME EXPRESSION."));
107 name = xstrdup (argv[0]);
108 /* Add cleanup for name. Must be free_current_contents as name can
110 old_cleanups = make_cleanup (free_current_contents, &name);
112 frame = xstrdup (argv[1]);
113 make_cleanup (xfree, frame);
115 expr = xstrdup (argv[2]);
116 make_cleanup (xfree, expr);
118 if (strcmp (name, "-") == 0)
121 name = varobj_gen_name ();
123 else if (!isalpha (*name))
124 error (_("-var-create: name of object must begin with a letter"));
126 if (strcmp (frame, "*") == 0)
127 var_type = USE_CURRENT_FRAME;
128 else if (strcmp (frame, "@") == 0)
129 var_type = USE_SELECTED_FRAME;
132 var_type = USE_SPECIFIED_FRAME;
133 frameaddr = string_to_core_addr (frame);
137 fprintf_unfiltered (gdb_stdlog,
138 "Name=\"%s\", Frame=\"%s\" (%s), Expression=\"%s\"\n",
139 name, frame, hex_string (frameaddr), expr);
141 var = varobj_create (name, expr, frameaddr, var_type);
144 error (_("-var-create: unable to create variable object"));
146 print_varobj (var, PRINT_ALL_VALUES, 0 /* don't print expression */);
148 uiout->field_int ("has_more", varobj_has_more (var, 0));
150 do_cleanups (old_cleanups);
154 mi_cmd_var_delete (const char *command, char **argv, int argc)
159 int children_only_p = 0;
160 struct cleanup *old_cleanups;
161 struct ui_out *uiout = current_uiout;
163 if (argc < 1 || argc > 2)
164 error (_("-var-delete: Usage: [-c] EXPRESSION."));
166 name = xstrdup (argv[0]);
167 /* Add cleanup for name. Must be free_current_contents as name can
169 old_cleanups = make_cleanup (free_current_contents, &name);
171 /* If we have one single argument it cannot be '-c' or any string
172 starting with '-'. */
175 if (strcmp (name, "-c") == 0)
176 error (_("-var-delete: Missing required "
177 "argument after '-c': variable object name"));
179 error (_("-var-delete: Illegal variable object name"));
182 /* If we have 2 arguments they must be '-c' followed by a string
183 which would be the variable name. */
186 if (strcmp (name, "-c") != 0)
187 error (_("-var-delete: Invalid option."));
189 do_cleanups (old_cleanups);
190 name = xstrdup (argv[1]);
191 old_cleanups = make_cleanup (free_current_contents, &name);
194 /* If we didn't error out, now NAME contains the name of the
197 var = varobj_get_handle (name);
199 numdel = varobj_delete (var, children_only_p);
201 uiout->field_int ("ndeleted", numdel);
203 do_cleanups (old_cleanups);
206 /* Parse a string argument into a format value. */
208 static enum varobj_display_formats
209 mi_parse_format (const char *arg)
217 if (strncmp (arg, "natural", len) == 0)
218 return FORMAT_NATURAL;
219 else if (strncmp (arg, "binary", len) == 0)
220 return FORMAT_BINARY;
221 else if (strncmp (arg, "decimal", len) == 0)
222 return FORMAT_DECIMAL;
223 else if (strncmp (arg, "hexadecimal", len) == 0)
224 return FORMAT_HEXADECIMAL;
225 else if (strncmp (arg, "octal", len) == 0)
227 else if (strncmp (arg, "zero-hexadecimal", len) == 0)
228 return FORMAT_ZHEXADECIMAL;
231 error (_("Must specify the format as: \"natural\", "
232 "\"binary\", \"decimal\", \"hexadecimal\", \"octal\" or \"zero-hexadecimal\""));
236 mi_cmd_var_set_format (const char *command, char **argv, int argc)
238 enum varobj_display_formats format;
240 struct ui_out *uiout = current_uiout;
243 error (_("-var-set-format: Usage: NAME FORMAT."));
245 /* Get varobj handle, if a valid var obj name was specified. */
246 var = varobj_get_handle (argv[0]);
248 format = mi_parse_format (argv[1]);
250 /* Set the format of VAR to the given format. */
251 varobj_set_display_format (var, format);
253 /* Report the new current format. */
254 uiout->field_string ("format", varobj_format_string[(int) format]);
256 /* Report the value in the new format. */
257 std::string val = varobj_get_value (var);
258 uiout->field_string ("value", val.c_str ());
262 mi_cmd_var_set_visualizer (const char *command, char **argv, int argc)
267 error (_("Usage: NAME VISUALIZER_FUNCTION."));
269 var = varobj_get_handle (argv[0]);
272 error (_("Variable object not found"));
274 varobj_set_visualizer (var, argv[1]);
278 mi_cmd_var_set_frozen (const char *command, char **argv, int argc)
284 error (_("-var-set-format: Usage: NAME FROZEN_FLAG."));
286 var = varobj_get_handle (argv[0]);
288 if (strcmp (argv[1], "0") == 0)
290 else if (strcmp (argv[1], "1") == 0)
293 error (_("Invalid flag value"));
295 varobj_set_frozen (var, frozen);
297 /* We don't automatically return the new value, or what varobjs got
298 new values during unfreezing. If this information is required,
299 client should call -var-update explicitly. */
303 mi_cmd_var_show_format (const char *command, char **argv, int argc)
305 struct ui_out *uiout = current_uiout;
306 enum varobj_display_formats format;
310 error (_("-var-show-format: Usage: NAME."));
312 /* Get varobj handle, if a valid var obj name was specified. */
313 var = varobj_get_handle (argv[0]);
315 format = varobj_get_display_format (var);
317 /* Report the current format. */
318 uiout->field_string ("format", varobj_format_string[(int) format]);
322 mi_cmd_var_info_num_children (const char *command, char **argv, int argc)
324 struct ui_out *uiout = current_uiout;
328 error (_("-var-info-num-children: Usage: NAME."));
330 /* Get varobj handle, if a valid var obj name was specified. */
331 var = varobj_get_handle (argv[0]);
333 uiout->field_int ("numchild", varobj_get_num_children (var));
336 /* Return 1 if given the argument PRINT_VALUES we should display
340 mi_print_value_p (struct varobj *var, enum print_values print_values)
344 if (print_values == PRINT_NO_VALUES)
347 if (print_values == PRINT_ALL_VALUES)
350 if (varobj_is_dynamic_p (var))
353 type = varobj_get_gdb_type (var);
358 type = check_typedef (type);
360 /* For PRINT_SIMPLE_VALUES, only print the value if it has a type
361 and that type is not a compound type. */
362 return (TYPE_CODE (type) != TYPE_CODE_ARRAY
363 && TYPE_CODE (type) != TYPE_CODE_STRUCT
364 && TYPE_CODE (type) != TYPE_CODE_UNION);
369 mi_cmd_var_list_children (const char *command, char **argv, int argc)
371 struct ui_out *uiout = current_uiout;
373 VEC(varobj_p) *children;
374 struct varobj *child;
375 enum print_values print_values;
379 if (argc < 1 || argc > 4)
380 error (_("-var-list-children: Usage: "
381 "[PRINT_VALUES] NAME [FROM TO]"));
383 /* Get varobj handle, if a valid var obj name was specified. */
384 if (argc == 1 || argc == 3)
385 var = varobj_get_handle (argv[0]);
387 var = varobj_get_handle (argv[1]);
391 from = atoi (argv[argc - 2]);
392 to = atoi (argv[argc - 1]);
400 children = varobj_list_children (var, &from, &to);
401 uiout->field_int ("numchild", to - from);
402 if (argc == 2 || argc == 4)
403 print_values = mi_parse_print_values (argv[0]);
405 print_values = PRINT_NO_VALUES;
407 gdb::unique_xmalloc_ptr<char> display_hint = varobj_get_display_hint (var);
409 uiout->field_string ("displayhint", display_hint.get ());
413 struct cleanup *cleanup_children;
415 if (mi_version (uiout) == 1)
417 = make_cleanup_ui_out_tuple_begin_end (uiout, "children");
420 = make_cleanup_ui_out_list_begin_end (uiout, "children");
422 ix < to && VEC_iterate (varobj_p, children, ix, child);
425 ui_out_emit_tuple child_emitter (uiout, "child");
427 print_varobj (child, print_values, 1 /* print expression */);
429 do_cleanups (cleanup_children);
432 uiout->field_int ("has_more", varobj_has_more (var, to));
436 mi_cmd_var_info_type (const char *command, char **argv, int argc)
438 struct ui_out *uiout = current_uiout;
442 error (_("-var-info-type: Usage: NAME."));
444 /* Get varobj handle, if a valid var obj name was specified. */
445 var = varobj_get_handle (argv[0]);
447 std::string type_name = varobj_get_type (var);
448 uiout->field_string ("type", type_name.c_str ());
452 mi_cmd_var_info_path_expression (const char *command, char **argv, int argc)
454 struct ui_out *uiout = current_uiout;
458 error (_("Usage: NAME."));
460 /* Get varobj handle, if a valid var obj name was specified. */
461 var = varobj_get_handle (argv[0]);
463 const char *path_expr = varobj_get_path_expr (var);
465 uiout->field_string ("path_expr", path_expr);
469 mi_cmd_var_info_expression (const char *command, char **argv, int argc)
471 struct ui_out *uiout = current_uiout;
472 const struct language_defn *lang;
476 error (_("-var-info-expression: Usage: NAME."));
478 /* Get varobj handle, if a valid var obj name was specified. */
479 var = varobj_get_handle (argv[0]);
481 lang = varobj_get_language (var);
483 uiout->field_string ("lang", lang->la_natural_name);
485 std::string exp = varobj_get_expression (var);
486 uiout->field_string ("exp", exp.c_str ());
490 mi_cmd_var_show_attributes (const char *command, char **argv, int argc)
492 struct ui_out *uiout = current_uiout;
498 error (_("-var-show-attributes: Usage: NAME."));
500 /* Get varobj handle, if a valid var obj name was specified */
501 var = varobj_get_handle (argv[0]);
503 attr = varobj_get_attributes (var);
504 /* FIXME: define masks for attributes */
505 if (attr & 0x00000001)
508 attstr = "noneditable";
510 uiout->field_string ("attr", attstr);
514 mi_cmd_var_evaluate_expression (const char *command, char **argv, int argc)
516 struct ui_out *uiout = current_uiout;
519 enum varobj_display_formats format;
528 static const struct mi_opt opts[] =
534 /* Parse arguments. */
535 format = FORMAT_NATURAL;
540 int opt = mi_getopt ("-var-evaluate-expression", argc, argv,
545 switch ((enum opt) opt)
549 error (_("Cannot specify format more than once"));
551 format = mi_parse_format (oarg);
558 error (_("Usage: [-f FORMAT] NAME"));
561 error (_("Garbage at end of command"));
563 /* Get varobj handle, if a valid var obj name was specified. */
564 var = varobj_get_handle (argv[oind]);
568 std::string val = varobj_get_formatted_value (var, format);
570 uiout->field_string ("value", val.c_str ());
574 std::string val = varobj_get_value (var);
576 uiout->field_string ("value", val.c_str ());
581 mi_cmd_var_assign (const char *command, char **argv, int argc)
583 struct ui_out *uiout = current_uiout;
587 error (_("-var-assign: Usage: NAME EXPRESSION."));
589 /* Get varobj handle, if a valid var obj name was specified. */
590 var = varobj_get_handle (argv[0]);
592 if (!varobj_editable_p (var))
593 error (_("-var-assign: Variable object is not editable"));
595 const char *expression = argv[1];
597 /* MI command '-var-assign' may write memory, so suppress memory
598 changed notification if it does. */
599 scoped_restore save_suppress
600 = make_scoped_restore (&mi_suppress_notification.memory, 1);
602 if (!varobj_set_value (var, expression))
603 error (_("-var-assign: Could not assign "
604 "expression to variable object"));
606 std::string val = varobj_get_value (var);
607 uiout->field_string ("value", val.c_str ());
610 /* Type used for parameters passing to mi_cmd_var_update_iter. */
612 struct mi_cmd_var_update
615 enum print_values print_values;
618 /* Helper for mi_cmd_var_update - update each VAR. */
621 mi_cmd_var_update_iter (struct varobj *var, void *data_pointer)
623 struct mi_cmd_var_update *data = (struct mi_cmd_var_update *) data_pointer;
624 int thread_id, thread_stopped;
626 thread_id = varobj_get_thread_id (var);
629 && (ptid_equal (inferior_ptid, null_ptid)
630 || is_stopped (inferior_ptid)))
634 struct thread_info *tp = find_thread_global_id (thread_id);
637 thread_stopped = is_stopped (tp->ptid);
643 && (!data->only_floating || varobj_floating_p (var)))
644 varobj_update_one (var, data->print_values, 0 /* implicit */);
648 mi_cmd_var_update (const char *command, char **argv, int argc)
650 struct ui_out *uiout = current_uiout;
651 struct cleanup *cleanup;
653 enum print_values print_values;
655 if (argc != 1 && argc != 2)
656 error (_("-var-update: Usage: [PRINT_VALUES] NAME."));
664 print_values = mi_parse_print_values (argv[0]);
666 print_values = PRINT_NO_VALUES;
668 if (mi_version (uiout) <= 1)
669 cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "changelist");
671 cleanup = make_cleanup_ui_out_list_begin_end (uiout, "changelist");
673 /* Check if the parameter is a "*", which means that we want to
674 update all variables. */
676 if ((*name == '*' || *name == '@') && (*(name + 1) == '\0'))
678 struct mi_cmd_var_update data;
680 data.only_floating = (*name == '@');
681 data.print_values = print_values;
683 /* varobj_update_one automatically updates all the children of
684 VAROBJ. Therefore update each VAROBJ only once by iterating
685 only the root VAROBJs. */
687 all_root_varobjs (mi_cmd_var_update_iter, &data);
691 /* Get varobj handle, if a valid var obj name was specified. */
692 struct varobj *var = varobj_get_handle (name);
694 varobj_update_one (var, print_values, 1 /* explicit */);
697 do_cleanups (cleanup);
700 /* Helper for mi_cmd_var_update(). */
703 varobj_update_one (struct varobj *var, enum print_values print_values,
706 struct ui_out *uiout = current_uiout;
707 VEC (varobj_update_result) *changes;
708 varobj_update_result *r;
711 changes = varobj_update (&var, is_explicit);
713 for (i = 0; VEC_iterate (varobj_update_result, changes, i, r); ++i)
717 gdb::optional<ui_out_emit_tuple> tuple_emitter;
718 if (mi_version (uiout) > 1)
719 tuple_emitter.emplace (uiout, nullptr);
720 uiout->field_string ("name", varobj_get_objname (r->varobj));
724 case VAROBJ_IN_SCOPE:
725 if (mi_print_value_p (r->varobj, print_values))
727 std::string val = varobj_get_value (r->varobj);
729 uiout->field_string ("value", val.c_str ());
731 uiout->field_string ("in_scope", "true");
733 case VAROBJ_NOT_IN_SCOPE:
734 uiout->field_string ("in_scope", "false");
737 uiout->field_string ("in_scope", "invalid");
741 if (r->status != VAROBJ_INVALID)
744 uiout->field_string ("type_changed", "true");
746 uiout->field_string ("type_changed", "false");
751 std::string type_name = varobj_get_type (r->varobj);
753 uiout->field_string ("new_type", type_name.c_str ());
756 if (r->type_changed || r->children_changed)
757 uiout->field_int ("new_num_children",
758 varobj_get_num_children (r->varobj));
760 gdb::unique_xmalloc_ptr<char> display_hint
761 = varobj_get_display_hint (r->varobj);
763 uiout->field_string ("displayhint", display_hint.get ());
765 if (varobj_is_dynamic_p (r->varobj))
766 uiout->field_int ("dynamic", 1);
768 varobj_get_child_range (r->varobj, &from, &to);
769 uiout->field_int ("has_more", varobj_has_more (r->varobj, to));
776 ui_out_emit_list list_emitter (uiout, "new_children");
777 for (j = 0; VEC_iterate (varobj_p, r->newobj, j, child); ++j)
779 ui_out_emit_tuple tuple_emitter (uiout, NULL);
780 print_varobj (child, print_values, 1 /* print_expression */);
783 VEC_free (varobj_p, r->newobj);
784 r->newobj = NULL; /* Paranoia. */
787 VEC_free (varobj_update_result, changes);
791 mi_cmd_enable_pretty_printing (const char *command, char **argv, int argc)
794 error (_("-enable-pretty-printing: no arguments allowed"));
796 varobj_enable_pretty_printing ();
800 mi_cmd_var_set_update_range (const char *command, char **argv, int argc)
806 error (_("-var-set-update-range: Usage: VAROBJ FROM TO"));
808 var = varobj_get_handle (argv[0]);
809 from = atoi (argv[1]);
812 varobj_set_child_range (var, from, to);