1 /* MI Command Set - varobj commands.
3 Copyright (C) 2000, 2002, 2004, 2005, 2007 Free Software Foundation, Inc.
5 Contributed by Cygnus Solutions (a Red Hat company).
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
29 #include "gdb_string.h"
31 const char mi_no_values
[] = "--no-values";
32 const char mi_simple_values
[] = "--simple-values";
33 const char mi_all_values
[] = "--all-values";
35 extern 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 type
*type
, enum print_values print_values
);
43 /* Print variable object VAR. The PRINT_VALUES parameter controls
44 if the value should be printed. The PRINT_EXPRESSION parameter
45 controls if the expression should be printed. */
47 print_varobj (struct varobj
*var
, enum print_values print_values
,
50 struct type
*gdb_type
;
53 ui_out_field_string (uiout
, "name", varobj_get_objname (var
));
55 ui_out_field_string (uiout
, "exp", varobj_get_expression (var
));
56 ui_out_field_int (uiout
, "numchild", varobj_get_num_children (var
));
58 gdb_type
= varobj_get_gdb_type (var
);
59 if (gdb_type
&& mi_print_value_p (gdb_type
, print_values
))
60 ui_out_field_string (uiout
, "value", varobj_get_value (var
));
62 type
= varobj_get_type (var
);
65 ui_out_field_string (uiout
, "type", type
);
69 if (varobj_get_frozen (var
))
70 ui_out_field_int (uiout
, "frozen", 1);
73 /* VAROBJ operations */
76 mi_cmd_var_create (char *command
, char **argv
, int argc
)
78 CORE_ADDR frameaddr
= 0;
83 struct cleanup
*old_cleanups
;
84 enum varobj_type var_type
;
88 /* mi_error_message = xstrprintf ("mi_cmd_var_create: Usage:
89 ...."); return MI_CMD_ERROR; */
90 error (_("mi_cmd_var_create: Usage: NAME FRAME EXPRESSION."));
93 name
= xstrdup (argv
[0]);
94 /* Add cleanup for name. Must be free_current_contents as
95 name can be reallocated */
96 old_cleanups
= make_cleanup (free_current_contents
, &name
);
98 frame
= xstrdup (argv
[1]);
99 make_cleanup (xfree
, frame
);
101 expr
= xstrdup (argv
[2]);
102 make_cleanup (xfree
, expr
);
104 if (strcmp (name
, "-") == 0)
107 name
= varobj_gen_name ();
109 else if (!isalpha (*name
))
110 error (_("mi_cmd_var_create: name of object must begin with a letter"));
112 if (strcmp (frame
, "*") == 0)
113 var_type
= USE_CURRENT_FRAME
;
114 else if (strcmp (frame
, "@") == 0)
115 var_type
= USE_SELECTED_FRAME
;
118 var_type
= USE_SPECIFIED_FRAME
;
119 frameaddr
= string_to_core_addr (frame
);
123 fprintf_unfiltered (gdb_stdlog
,
124 "Name=\"%s\", Frame=\"%s\" (0x%s), Expression=\"%s\"\n",
125 name
, frame
, paddr (frameaddr
), expr
);
127 var
= varobj_create (name
, expr
, frameaddr
, var_type
);
130 error (_("mi_cmd_var_create: unable to create variable object"));
132 print_varobj (var
, PRINT_ALL_VALUES
, 0 /* don't print expression */);
134 do_cleanups (old_cleanups
);
139 mi_cmd_var_delete (char *command
, char **argv
, int argc
)
144 int children_only_p
= 0;
145 struct cleanup
*old_cleanups
;
147 if (argc
< 1 || argc
> 2)
148 error (_("mi_cmd_var_delete: Usage: [-c] EXPRESSION."));
150 name
= xstrdup (argv
[0]);
151 /* Add cleanup for name. Must be free_current_contents as
152 name can be reallocated */
153 old_cleanups
= make_cleanup (free_current_contents
, &name
);
155 /* If we have one single argument it cannot be '-c' or any string
156 starting with '-'. */
159 if (strcmp (name
, "-c") == 0)
160 error (_("mi_cmd_var_delete: Missing required argument after '-c': variable object name"));
162 error (_("mi_cmd_var_delete: Illegal variable object name"));
165 /* If we have 2 arguments they must be '-c' followed by a string
166 which would be the variable name. */
169 if (strcmp (name
, "-c") != 0)
170 error (_("mi_cmd_var_delete: Invalid option."));
172 do_cleanups (old_cleanups
);
173 name
= xstrdup (argv
[1]);
174 make_cleanup (free_current_contents
, &name
);
177 /* If we didn't error out, now NAME contains the name of the
180 var
= varobj_get_handle (name
);
183 error (_("mi_cmd_var_delete: Variable object not found."));
185 numdel
= varobj_delete (var
, NULL
, children_only_p
);
187 ui_out_field_int (uiout
, "ndeleted", numdel
);
189 do_cleanups (old_cleanups
);
194 mi_cmd_var_set_format (char *command
, char **argv
, int argc
)
196 enum varobj_display_formats format
;
202 error (_("mi_cmd_var_set_format: Usage: NAME FORMAT."));
204 /* Get varobj handle, if a valid var obj name was specified */
205 var
= varobj_get_handle (argv
[0]);
208 error (_("mi_cmd_var_set_format: Variable object not found"));
211 if (formspec
== NULL
)
212 error (_("mi_cmd_var_set_format: Must specify the format as: \"natural\", \"binary\", \"decimal\", \"hexadecimal\", or \"octal\""));
214 len
= strlen (formspec
);
216 if (strncmp (formspec
, "natural", len
) == 0)
217 format
= FORMAT_NATURAL
;
218 else if (strncmp (formspec
, "binary", len
) == 0)
219 format
= FORMAT_BINARY
;
220 else if (strncmp (formspec
, "decimal", len
) == 0)
221 format
= FORMAT_DECIMAL
;
222 else if (strncmp (formspec
, "hexadecimal", len
) == 0)
223 format
= FORMAT_HEXADECIMAL
;
224 else if (strncmp (formspec
, "octal", len
) == 0)
225 format
= FORMAT_OCTAL
;
227 error (_("mi_cmd_var_set_format: Unknown display format: must be: \"natural\", \"binary\", \"decimal\", \"hexadecimal\", or \"octal\""));
229 /* Set the format of VAR to given format */
230 varobj_set_display_format (var
, format
);
232 /* Report the new current format */
233 ui_out_field_string (uiout
, "format", varobj_format_string
[(int) format
]);
238 mi_cmd_var_set_frozen (char *command
, char **argv
, int argc
)
244 error (_("-var-set-format: Usage: NAME FROZEN_FLAG."));
246 var
= varobj_get_handle (argv
[0]);
248 error (_("Variable object not found"));
250 if (strcmp (argv
[1], "0") == 0)
252 else if (strcmp (argv
[1], "1") == 0)
255 error (_("Invalid flag value"));
257 varobj_set_frozen (var
, frozen
);
259 /* We don't automatically return the new value, or what varobjs got new
260 values during unfreezing. If this information is required, client
261 should call -var-update explicitly. */
267 mi_cmd_var_show_format (char *command
, char **argv
, int argc
)
269 enum varobj_display_formats format
;
273 error (_("mi_cmd_var_show_format: Usage: NAME."));
275 /* Get varobj handle, if a valid var obj name was specified */
276 var
= varobj_get_handle (argv
[0]);
278 error (_("mi_cmd_var_show_format: Variable object not found"));
280 format
= varobj_get_display_format (var
);
282 /* Report the current format */
283 ui_out_field_string (uiout
, "format", varobj_format_string
[(int) format
]);
288 mi_cmd_var_info_num_children (char *command
, char **argv
, int argc
)
293 error (_("mi_cmd_var_info_num_children: Usage: NAME."));
295 /* Get varobj handle, if a valid var obj name was specified */
296 var
= varobj_get_handle (argv
[0]);
298 error (_("mi_cmd_var_info_num_children: Variable object not found"));
300 ui_out_field_int (uiout
, "numchild", varobj_get_num_children (var
));
304 /* Parse a string argument into a print_values value. */
306 static enum print_values
307 mi_parse_values_option (const char *arg
)
309 if (strcmp (arg
, "0") == 0
310 || strcmp (arg
, mi_no_values
) == 0)
311 return PRINT_NO_VALUES
;
312 else if (strcmp (arg
, "1") == 0
313 || strcmp (arg
, mi_all_values
) == 0)
314 return PRINT_ALL_VALUES
;
315 else if (strcmp (arg
, "2") == 0
316 || strcmp (arg
, mi_simple_values
) == 0)
317 return PRINT_SIMPLE_VALUES
;
319 error (_("Unknown value for PRINT_VALUES\n\
320 Must be: 0 or \"%s\", 1 or \"%s\", 2 or \"%s\""),
321 mi_no_values
, mi_simple_values
, mi_all_values
);
324 /* Return 1 if given the argument PRINT_VALUES we should display
325 a value of type TYPE. */
328 mi_print_value_p (struct type
*type
, enum print_values print_values
)
330 type
= check_typedef (type
);
332 if (print_values
== PRINT_NO_VALUES
)
335 if (print_values
== PRINT_ALL_VALUES
)
338 /* For PRINT_SIMPLE_VALUES, only print the value if it has a type
339 and that type is not a compound type. */
341 return (TYPE_CODE (type
) != TYPE_CODE_ARRAY
342 && TYPE_CODE (type
) != TYPE_CODE_STRUCT
343 && TYPE_CODE (type
) != TYPE_CODE_UNION
);
347 mi_cmd_var_list_children (char *command
, char **argv
, int argc
)
350 struct varobj
**childlist
;
352 struct cleanup
*cleanup_children
;
354 enum print_values print_values
;
356 if (argc
!= 1 && argc
!= 2)
357 error (_("mi_cmd_var_list_children: Usage: [PRINT_VALUES] NAME"));
359 /* Get varobj handle, if a valid var obj name was specified */
361 var
= varobj_get_handle (argv
[0]);
363 var
= varobj_get_handle (argv
[1]);
365 error (_("Variable object not found"));
367 numchild
= varobj_list_children (var
, &childlist
);
368 ui_out_field_int (uiout
, "numchild", numchild
);
370 print_values
= mi_parse_values_option (argv
[0]);
372 print_values
= PRINT_NO_VALUES
;
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");
387 struct cleanup
*cleanup_child
;
388 cleanup_child
= make_cleanup_ui_out_tuple_begin_end (uiout
, "child");
389 print_varobj (*cc
, print_values
, 1 /* print expression */);
391 do_cleanups (cleanup_child
);
393 do_cleanups (cleanup_children
);
399 mi_cmd_var_info_type (char *command
, char **argv
, int argc
)
404 error (_("mi_cmd_var_info_type: Usage: NAME."));
406 /* Get varobj handle, if a valid var obj name was specified */
407 var
= varobj_get_handle (argv
[0]);
409 error (_("mi_cmd_var_info_type: Variable object not found"));
411 ui_out_field_string (uiout
, "type", varobj_get_type (var
));
416 mi_cmd_var_info_path_expression (char *command
, char **argv
, int argc
)
422 error (_("Usage: NAME."));
424 /* Get varobj handle, if a valid var obj name was specified. */
425 var
= varobj_get_handle (argv
[0]);
427 error (_("Variable object not found"));
429 path_expr
= varobj_get_path_expr (var
);
431 ui_out_field_string (uiout
, "path_expr", path_expr
);
437 mi_cmd_var_info_expression (char *command
, char **argv
, int argc
)
439 enum varobj_languages lang
;
443 error (_("mi_cmd_var_info_expression: Usage: NAME."));
445 /* Get varobj handle, if a valid var obj name was specified */
446 var
= varobj_get_handle (argv
[0]);
448 error (_("mi_cmd_var_info_expression: Variable object not found"));
450 lang
= varobj_get_language (var
);
452 ui_out_field_string (uiout
, "lang", varobj_language_string
[(int) lang
]);
453 ui_out_field_string (uiout
, "exp", varobj_get_expression (var
));
458 mi_cmd_var_show_attributes (char *command
, char **argv
, int argc
)
465 error (_("mi_cmd_var_show_attributes: Usage: NAME."));
467 /* Get varobj handle, if a valid var obj name was specified */
468 var
= varobj_get_handle (argv
[0]);
470 error (_("mi_cmd_var_show_attributes: Variable object not found"));
472 attr
= varobj_get_attributes (var
);
473 /* FIXME: define masks for attributes */
474 if (attr
& 0x00000001)
477 attstr
= "noneditable";
479 ui_out_field_string (uiout
, "attr", attstr
);
484 mi_cmd_var_evaluate_expression (char *command
, char **argv
, int argc
)
489 error (_("mi_cmd_var_evaluate_expression: Usage: NAME."));
491 /* Get varobj handle, if a valid var obj name was specified */
492 var
= varobj_get_handle (argv
[0]);
494 error (_("mi_cmd_var_evaluate_expression: Variable object not found"));
496 ui_out_field_string (uiout
, "value", varobj_get_value (var
));
501 mi_cmd_var_assign (char *command
, char **argv
, int argc
)
507 error (_("mi_cmd_var_assign: Usage: NAME EXPRESSION."));
509 /* Get varobj handle, if a valid var obj name was specified */
510 var
= varobj_get_handle (argv
[0]);
512 error (_("mi_cmd_var_assign: Variable object not found"));
514 /* FIXME: define masks for attributes */
515 if (!(varobj_get_attributes (var
) & 0x00000001))
516 error (_("mi_cmd_var_assign: Variable object is not editable"));
518 expression
= xstrdup (argv
[1]);
520 if (!varobj_set_value (var
, expression
))
521 error (_("mi_cmd_var_assign: Could not assign expression to variable object"));
523 ui_out_field_string (uiout
, "value", varobj_get_value (var
));
528 mi_cmd_var_update (char *command
, char **argv
, int argc
)
531 struct varobj
**rootlist
;
533 struct cleanup
*cleanup
;
536 enum print_values print_values
;
538 if (argc
!= 1 && argc
!= 2)
539 error (_("mi_cmd_var_update: Usage: [PRINT_VALUES] NAME."));
547 print_values
= mi_parse_values_option (argv
[0]);
549 print_values
= PRINT_NO_VALUES
;
551 /* Check if the parameter is a "*" which means that we want
552 to update all variables */
554 if ((*name
== '*') && (*(name
+ 1) == '\0'))
556 nv
= varobj_list (&rootlist
);
557 cleanup
= make_cleanup (xfree
, rootlist
);
558 if (mi_version (uiout
) <= 1)
559 make_cleanup_ui_out_tuple_begin_end (uiout
, "changelist");
561 make_cleanup_ui_out_list_begin_end (uiout
, "changelist");
564 do_cleanups (cleanup
);
570 varobj_update_one (*cr
, print_values
, 0 /* implicit */);
573 do_cleanups (cleanup
);
577 /* Get varobj handle, if a valid var obj name was specified */
578 var
= varobj_get_handle (name
);
580 error (_("mi_cmd_var_update: Variable object not found"));
582 if (mi_version (uiout
) <= 1)
583 cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, "changelist");
585 cleanup
= make_cleanup_ui_out_list_begin_end (uiout
, "changelist");
586 varobj_update_one (var
, print_values
, 1 /* explicit */);
587 do_cleanups (cleanup
);
592 /* Helper for mi_cmd_var_update(). */
595 varobj_update_one (struct varobj
*var
, enum print_values print_values
,
598 struct varobj
**changelist
;
600 struct cleanup
*cleanup
= NULL
;
603 nc
= varobj_update (&var
, &changelist
, explicit);
605 /* nc >= 0 represents the number of changes reported into changelist.
606 nc < 0 means that an error occured or the the variable has
607 changed type (TYPE_CHANGED). */
613 if (mi_version (uiout
) > 1)
614 cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
615 ui_out_field_string (uiout
, "name", varobj_get_objname(var
));
620 ui_out_field_string (uiout
, "in_scope", "false");
623 ui_out_field_string (uiout
, "in_scope", "invalid");
626 ui_out_field_string (uiout
, "in_scope", "true");
627 ui_out_field_string (uiout
, "new_type", varobj_get_type(var
));
628 ui_out_field_int (uiout
, "new_num_children",
629 varobj_get_num_children(var
));
632 if (mi_version (uiout
) > 1)
633 do_cleanups (cleanup
);
640 if (mi_version (uiout
) > 1)
641 cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
642 ui_out_field_string (uiout
, "name", varobj_get_objname (*cc
));
643 if (mi_print_value_p (varobj_get_gdb_type (*cc
), print_values
))
644 ui_out_field_string (uiout
, "value", varobj_get_value (*cc
));
645 ui_out_field_string (uiout
, "in_scope", "true");
646 ui_out_field_string (uiout
, "type_changed", "false");
647 if (mi_version (uiout
) > 1)
648 do_cleanups (cleanup
);