/* MI Command Set - varobj commands. Copyright (C) 2000-2013 Free Software Foundation, Inc. Contributed by Cygnus Solutions (a Red Hat company). This file is part of GDB. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ #include "defs.h" #include "mi-cmds.h" #include "mi-main.h" #include "ui-out.h" #include "mi-out.h" #include "varobj.h" #include "language.h" #include "value.h" #include #include #include "mi-getopt.h" #include "gdbthread.h" #include "mi-parse.h" extern unsigned int varobjdebug; /* defined in varobj.c. */ static void varobj_update_one (struct varobj *var, enum print_values print_values, int explicit); static int mi_print_value_p (struct varobj *var, enum print_values print_values); /* Print variable object VAR. The PRINT_VALUES parameter controls if the value should be printed. The PRINT_EXPRESSION parameter controls if the expression should be printed. */ static void print_varobj (struct varobj *var, enum print_values print_values, int print_expression) { struct ui_out *uiout = current_uiout; char *type; int thread_id; char *display_hint; ui_out_field_string (uiout, "name", varobj_get_objname (var)); if (print_expression) ui_out_field_string (uiout, "exp", varobj_get_expression (var)); ui_out_field_int (uiout, "numchild", varobj_get_num_children (var)); if (mi_print_value_p (var, print_values)) { char *val = varobj_get_value (var); ui_out_field_string (uiout, "value", val); xfree (val); } type = varobj_get_type (var); if (type != NULL) { ui_out_field_string (uiout, "type", type); xfree (type); } thread_id = varobj_get_thread_id (var); if (thread_id > 0) ui_out_field_int (uiout, "thread-id", thread_id); if (varobj_get_frozen (var)) ui_out_field_int (uiout, "frozen", 1); display_hint = varobj_get_display_hint (var); if (display_hint) { ui_out_field_string (uiout, "displayhint", display_hint); xfree (display_hint); } if (varobj_pretty_printed_p (var)) ui_out_field_int (uiout, "dynamic", 1); } /* VAROBJ operations */ void mi_cmd_var_create (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; CORE_ADDR frameaddr = 0; struct varobj *var; char *name; char *frame; char *expr; struct cleanup *old_cleanups; enum varobj_type var_type; if (argc != 3) error (_("-var-create: Usage: NAME FRAME EXPRESSION.")); name = xstrdup (argv[0]); /* Add cleanup for name. Must be free_current_contents as name can be reallocated. */ old_cleanups = make_cleanup (free_current_contents, &name); frame = xstrdup (argv[1]); make_cleanup (xfree, frame); expr = xstrdup (argv[2]); make_cleanup (xfree, expr); if (strcmp (name, "-") == 0) { xfree (name); name = varobj_gen_name (); } else if (!isalpha (*name)) error (_("-var-create: name of object must begin with a letter")); if (strcmp (frame, "*") == 0) var_type = USE_CURRENT_FRAME; else if (strcmp (frame, "@") == 0) var_type = USE_SELECTED_FRAME; else { var_type = USE_SPECIFIED_FRAME; frameaddr = string_to_core_addr (frame); } if (varobjdebug) fprintf_unfiltered (gdb_stdlog, "Name=\"%s\", Frame=\"%s\" (%s), Expression=\"%s\"\n", name, frame, hex_string (frameaddr), expr); var = varobj_create (name, expr, frameaddr, var_type); if (var == NULL) error (_("-var-create: unable to create variable object")); print_varobj (var, PRINT_ALL_VALUES, 0 /* don't print expression */); ui_out_field_int (uiout, "has_more", varobj_has_more (var, 0)); do_cleanups (old_cleanups); } void mi_cmd_var_delete (char *command, char **argv, int argc) { char *name; struct varobj *var; int numdel; int children_only_p = 0; struct cleanup *old_cleanups; struct ui_out *uiout = current_uiout; if (argc < 1 || argc > 2) error (_("-var-delete: Usage: [-c] EXPRESSION.")); name = xstrdup (argv[0]); /* Add cleanup for name. Must be free_current_contents as name can be reallocated. */ old_cleanups = make_cleanup (free_current_contents, &name); /* If we have one single argument it cannot be '-c' or any string starting with '-'. */ if (argc == 1) { if (strcmp (name, "-c") == 0) error (_("-var-delete: Missing required " "argument after '-c': variable object name")); if (*name == '-') error (_("-var-delete: Illegal variable object name")); } /* If we have 2 arguments they must be '-c' followed by a string which would be the variable name. */ if (argc == 2) { if (strcmp (name, "-c") != 0) error (_("-var-delete: Invalid option.")); children_only_p = 1; do_cleanups (old_cleanups); name = xstrdup (argv[1]); old_cleanups = make_cleanup (free_current_contents, &name); } /* If we didn't error out, now NAME contains the name of the variable. */ var = varobj_get_handle (name); numdel = varobj_delete (var, NULL, children_only_p); ui_out_field_int (uiout, "ndeleted", numdel); do_cleanups (old_cleanups); } /* Parse a string argument into a format value. */ static enum varobj_display_formats mi_parse_format (const char *arg) { if (arg != NULL) { int len; len = strlen (arg); if (strncmp (arg, "natural", len) == 0) return FORMAT_NATURAL; else if (strncmp (arg, "binary", len) == 0) return FORMAT_BINARY; else if (strncmp (arg, "decimal", len) == 0) return FORMAT_DECIMAL; else if (strncmp (arg, "hexadecimal", len) == 0) return FORMAT_HEXADECIMAL; else if (strncmp (arg, "octal", len) == 0) return FORMAT_OCTAL; } error (_("Must specify the format as: \"natural\", " "\"binary\", \"decimal\", \"hexadecimal\", or \"octal\"")); } void mi_cmd_var_set_format (char *command, char **argv, int argc) { enum varobj_display_formats format; struct varobj *var; char *val; struct ui_out *uiout = current_uiout; if (argc != 2) error (_("-var-set-format: Usage: NAME FORMAT.")); /* Get varobj handle, if a valid var obj name was specified. */ var = varobj_get_handle (argv[0]); format = mi_parse_format (argv[1]); /* Set the format of VAR to the given format. */ varobj_set_display_format (var, format); /* Report the new current format. */ ui_out_field_string (uiout, "format", varobj_format_string[(int) format]); /* Report the value in the new format. */ val = varobj_get_value (var); ui_out_field_string (uiout, "value", val); xfree (val); } void mi_cmd_var_set_visualizer (char *command, char **argv, int argc) { struct varobj *var; if (argc != 2) error (_("Usage: NAME VISUALIZER_FUNCTION.")); var = varobj_get_handle (argv[0]); if (var == NULL) error (_("Variable object not found")); varobj_set_visualizer (var, argv[1]); } void mi_cmd_var_set_frozen (char *command, char **argv, int argc) { struct varobj *var; int frozen; if (argc != 2) error (_("-var-set-format: Usage: NAME FROZEN_FLAG.")); var = varobj_get_handle (argv[0]); if (strcmp (argv[1], "0") == 0) frozen = 0; else if (strcmp (argv[1], "1") == 0) frozen = 1; else error (_("Invalid flag value")); varobj_set_frozen (var, frozen); /* We don't automatically return the new value, or what varobjs got new values during unfreezing. If this information is required, client should call -var-update explicitly. */ } void mi_cmd_var_show_format (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; enum varobj_display_formats format; struct varobj *var; if (argc != 1) error (_("-var-show-format: Usage: NAME.")); /* Get varobj handle, if a valid var obj name was specified. */ var = varobj_get_handle (argv[0]); format = varobj_get_display_format (var); /* Report the current format. */ ui_out_field_string (uiout, "format", varobj_format_string[(int) format]); } void mi_cmd_var_info_num_children (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; struct varobj *var; if (argc != 1) error (_("-var-info-num-children: Usage: NAME.")); /* Get varobj handle, if a valid var obj name was specified. */ var = varobj_get_handle (argv[0]); ui_out_field_int (uiout, "numchild", varobj_get_num_children (var)); } /* Return 1 if given the argument PRINT_VALUES we should display the varobj VAR. */ static int mi_print_value_p (struct varobj *var, enum print_values print_values) { struct type *type; if (print_values == PRINT_NO_VALUES) return 0; if (print_values == PRINT_ALL_VALUES) return 1; if (varobj_pretty_printed_p (var)) return 1; type = varobj_get_gdb_type (var); if (type == NULL) return 1; else { type = check_typedef (type); /* For PRINT_SIMPLE_VALUES, only print the value if it has a type and that type is not a compound type. */ return (TYPE_CODE (type) != TYPE_CODE_ARRAY && TYPE_CODE (type) != TYPE_CODE_STRUCT && TYPE_CODE (type) != TYPE_CODE_UNION); } } void mi_cmd_var_list_children (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; struct varobj *var; VEC(varobj_p) *children; struct varobj *child; enum print_values print_values; int ix; int from, to; char *display_hint; if (argc < 1 || argc > 4) error (_("-var-list-children: Usage: " "[PRINT_VALUES] NAME [FROM TO]")); /* Get varobj handle, if a valid var obj name was specified. */ if (argc == 1 || argc == 3) var = varobj_get_handle (argv[0]); else var = varobj_get_handle (argv[1]); if (argc > 2) { from = atoi (argv[argc - 2]); to = atoi (argv[argc - 1]); } else { from = -1; to = -1; } children = varobj_list_children (var, &from, &to); ui_out_field_int (uiout, "numchild", to - from); if (argc == 2 || argc == 4) print_values = mi_parse_print_values (argv[0]); else print_values = PRINT_NO_VALUES; display_hint = varobj_get_display_hint (var); if (display_hint) { ui_out_field_string (uiout, "displayhint", display_hint); xfree (display_hint); } if (from < to) { struct cleanup *cleanup_children; if (mi_version (uiout) == 1) cleanup_children = make_cleanup_ui_out_tuple_begin_end (uiout, "children"); else cleanup_children = make_cleanup_ui_out_list_begin_end (uiout, "children"); for (ix = from; ix < to && VEC_iterate (varobj_p, children, ix, child); ++ix) { struct cleanup *cleanup_child; cleanup_child = make_cleanup_ui_out_tuple_begin_end (uiout, "child"); print_varobj (child, print_values, 1 /* print expression */); do_cleanups (cleanup_child); } do_cleanups (cleanup_children); } ui_out_field_int (uiout, "has_more", varobj_has_more (var, to)); } void mi_cmd_var_info_type (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; struct varobj *var; if (argc != 1) error (_("-var-info-type: Usage: NAME.")); /* Get varobj handle, if a valid var obj name was specified. */ var = varobj_get_handle (argv[0]); ui_out_field_string (uiout, "type", varobj_get_type (var)); } void mi_cmd_var_info_path_expression (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; struct varobj *var; char *path_expr; if (argc != 1) error (_("Usage: NAME.")); /* Get varobj handle, if a valid var obj name was specified. */ var = varobj_get_handle (argv[0]); path_expr = varobj_get_path_expr (var); ui_out_field_string (uiout, "path_expr", path_expr); } void mi_cmd_var_info_expression (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; const struct language_defn *lang; struct varobj *var; if (argc != 1) error (_("-var-info-expression: Usage: NAME.")); /* Get varobj handle, if a valid var obj name was specified. */ var = varobj_get_handle (argv[0]); lang = varobj_get_language (var); ui_out_field_string (uiout, "lang", lang->la_natural_name); ui_out_field_string (uiout, "exp", varobj_get_expression (var)); } void mi_cmd_var_show_attributes (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; int attr; char *attstr; struct varobj *var; if (argc != 1) error (_("-var-show-attributes: Usage: NAME.")); /* Get varobj handle, if a valid var obj name was specified */ var = varobj_get_handle (argv[0]); attr = varobj_get_attributes (var); /* FIXME: define masks for attributes */ if (attr & 0x00000001) attstr = "editable"; else attstr = "noneditable"; ui_out_field_string (uiout, "attr", attstr); } void mi_cmd_var_evaluate_expression (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; struct varobj *var; enum varobj_display_formats format; int formatFound; int oind; char *oarg; enum opt { OP_FORMAT }; static const struct mi_opt opts[] = { {"f", OP_FORMAT, 1}, { 0, 0, 0 } }; /* Parse arguments. */ format = FORMAT_NATURAL; formatFound = 0; oind = 0; while (1) { int opt = mi_getopt ("-var-evaluate-expression", argc, argv, opts, &oind, &oarg); if (opt < 0) break; switch ((enum opt) opt) { case OP_FORMAT: if (formatFound) error (_("Cannot specify format more than once")); format = mi_parse_format (oarg); formatFound = 1; break; } } if (oind >= argc) error (_("Usage: [-f FORMAT] NAME")); if (oind < argc - 1) error (_("Garbage at end of command")); /* Get varobj handle, if a valid var obj name was specified. */ var = varobj_get_handle (argv[oind]); if (formatFound) { char *val = varobj_get_formatted_value (var, format); ui_out_field_string (uiout, "value", val); xfree (val); } else { char *val = varobj_get_value (var); ui_out_field_string (uiout, "value", val); xfree (val); } } void mi_cmd_var_assign (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; struct varobj *var; char *expression, *val; struct cleanup *cleanup; if (argc != 2) error (_("-var-assign: Usage: NAME EXPRESSION.")); /* Get varobj handle, if a valid var obj name was specified. */ var = varobj_get_handle (argv[0]); if (!varobj_editable_p (var)) error (_("-var-assign: Variable object is not editable")); expression = xstrdup (argv[1]); /* MI command '-var-assign' may write memory, so suppress memory changed notification if it does. */ cleanup = make_cleanup_restore_integer (&mi_suppress_notification.memory); mi_suppress_notification.memory = 1; if (!varobj_set_value (var, expression)) error (_("-var-assign: Could not assign " "expression to variable object")); val = varobj_get_value (var); ui_out_field_string (uiout, "value", val); xfree (val); do_cleanups (cleanup); } /* Type used for parameters passing to mi_cmd_var_update_iter. */ struct mi_cmd_var_update { int only_floating; enum print_values print_values; }; /* Helper for mi_cmd_var_update - update each VAR. */ static void mi_cmd_var_update_iter (struct varobj *var, void *data_pointer) { struct mi_cmd_var_update *data = data_pointer; int thread_id, thread_stopped; thread_id = varobj_get_thread_id (var); if (thread_id == -1 && is_stopped (inferior_ptid)) thread_stopped = 1; else { struct thread_info *tp = find_thread_id (thread_id); if (tp) thread_stopped = is_stopped (tp->ptid); else thread_stopped = 1; } if (thread_stopped && (!data->only_floating || varobj_floating_p (var))) varobj_update_one (var, data->print_values, 0 /* implicit */); } void mi_cmd_var_update (char *command, char **argv, int argc) { struct ui_out *uiout = current_uiout; struct cleanup *cleanup; char *name; enum print_values print_values; if (argc != 1 && argc != 2) error (_("-var-update: Usage: [PRINT_VALUES] NAME.")); if (argc == 1) name = argv[0]; else name = argv[1]; if (argc == 2) print_values = mi_parse_print_values (argv[0]); else print_values = PRINT_NO_VALUES; if (mi_version (uiout) <= 1) cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "changelist"); else cleanup = make_cleanup_ui_out_list_begin_end (uiout, "changelist"); /* Check if the parameter is a "*", which means that we want to update all variables. */ if ((*name == '*' || *name == '@') && (*(name + 1) == '\0')) { struct mi_cmd_var_update data; data.only_floating = (*name == '@'); data.print_values = print_values; /* varobj_update_one automatically updates all the children of VAROBJ. Therefore update each VAROBJ only once by iterating only the root VAROBJs. */ all_root_varobjs (mi_cmd_var_update_iter, &data); } else { /* Get varobj handle, if a valid var obj name was specified. */ struct varobj *var = varobj_get_handle (name); varobj_update_one (var, print_values, 1 /* explicit */); } do_cleanups (cleanup); } /* Helper for mi_cmd_var_update(). */ static void varobj_update_one (struct varobj *var, enum print_values print_values, int explicit) { struct ui_out *uiout = current_uiout; VEC (varobj_update_result) *changes; varobj_update_result *r; int i; changes = varobj_update (&var, explicit); for (i = 0; VEC_iterate (varobj_update_result, changes, i, r); ++i) { char *display_hint; int from, to; struct cleanup *cleanup = make_cleanup (null_cleanup, NULL); if (mi_version (uiout) > 1) make_cleanup_ui_out_tuple_begin_end (uiout, NULL); ui_out_field_string (uiout, "name", varobj_get_objname (r->varobj)); switch (r->status) { case VAROBJ_IN_SCOPE: if (mi_print_value_p (r->varobj, print_values)) { char *val = varobj_get_value (r->varobj); ui_out_field_string (uiout, "value", val); xfree (val); } ui_out_field_string (uiout, "in_scope", "true"); break; case VAROBJ_NOT_IN_SCOPE: ui_out_field_string (uiout, "in_scope", "false"); break; case VAROBJ_INVALID: ui_out_field_string (uiout, "in_scope", "invalid"); break; } if (r->status != VAROBJ_INVALID) { if (r->type_changed) ui_out_field_string (uiout, "type_changed", "true"); else ui_out_field_string (uiout, "type_changed", "false"); } if (r->type_changed) ui_out_field_string (uiout, "new_type", varobj_get_type (r->varobj)); if (r->type_changed || r->children_changed) ui_out_field_int (uiout, "new_num_children", varobj_get_num_children (r->varobj)); display_hint = varobj_get_display_hint (r->varobj); if (display_hint) { ui_out_field_string (uiout, "displayhint", display_hint); xfree (display_hint); } if (varobj_pretty_printed_p (r->varobj)) ui_out_field_int (uiout, "dynamic", 1); varobj_get_child_range (r->varobj, &from, &to); ui_out_field_int (uiout, "has_more", varobj_has_more (r->varobj, to)); if (r->new) { int j; varobj_p child; struct cleanup *cleanup; cleanup = make_cleanup_ui_out_list_begin_end (uiout, "new_children"); for (j = 0; VEC_iterate (varobj_p, r->new, j, child); ++j) { struct cleanup *cleanup_child; cleanup_child = make_cleanup_ui_out_tuple_begin_end (uiout, NULL); print_varobj (child, print_values, 1 /* print_expression */); do_cleanups (cleanup_child); } do_cleanups (cleanup); VEC_free (varobj_p, r->new); r->new = NULL; /* Paranoia. */ } do_cleanups (cleanup); } VEC_free (varobj_update_result, changes); } void mi_cmd_enable_pretty_printing (char *command, char **argv, int argc) { if (argc != 0) error (_("-enable-pretty-printing: no arguments allowed")); varobj_enable_pretty_printing (); } void mi_cmd_var_set_update_range (char *command, char **argv, int argc) { struct varobj *var; int from, to; if (argc != 3) error (_("-var-set-update-range: Usage: VAROBJ FROM TO")); var = varobj_get_handle (argv[0]); from = atoi (argv[1]); to = atoi (argv[2]); varobj_set_child_range (var, from, to); }