1 /* MI Command Set - varobj commands.
3 Copyright 2000, 2002, 2004 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 2 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, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
31 #include "gdb_string.h"
33 extern int varobjdebug
; /* defined in varobj.c */
35 static int varobj_update_one (struct varobj
*var
);
37 /* VAROBJ operations */
40 mi_cmd_var_create (char *command
, char **argv
, int argc
)
42 CORE_ADDR frameaddr
= 0;
48 struct cleanup
*old_cleanups
;
49 enum varobj_type var_type
;
53 /* xasprintf (&mi_error_message,
54 "mi_cmd_var_create: Usage: .");
55 return MI_CMD_ERROR; */
56 error ("mi_cmd_var_create: Usage: NAME FRAME EXPRESSION.");
59 name
= xstrdup (argv
[0]);
60 /* Add cleanup for name. Must be free_current_contents as
61 name can be reallocated */
62 old_cleanups
= make_cleanup (free_current_contents
, &name
);
64 frame
= xstrdup (argv
[1]);
65 old_cleanups
= make_cleanup (xfree
, frame
);
67 expr
= xstrdup (argv
[2]);
69 if (strcmp (name
, "-") == 0)
72 name
= varobj_gen_name ();
74 else if (!isalpha (*name
))
75 error ("mi_cmd_var_create: name of object must begin with a letter");
77 if (strcmp (frame
, "*") == 0)
78 var_type
= USE_CURRENT_FRAME
;
79 else if (strcmp (frame
, "@") == 0)
80 var_type
= USE_SELECTED_FRAME
;
83 var_type
= USE_SPECIFIED_FRAME
;
84 frameaddr
= string_to_core_addr (frame
);
88 fprintf_unfiltered (gdb_stdlog
,
89 "Name=\"%s\", Frame=\"%s\" (0x%s), Expression=\"%s\"\n",
90 name
, frame
, paddr (frameaddr
), expr
);
92 var
= varobj_create (name
, expr
, frameaddr
, var_type
);
95 error ("mi_cmd_var_create: unable to create variable object");
97 ui_out_field_string (uiout
, "name", name
);
98 ui_out_field_int (uiout
, "numchild", varobj_get_num_children (var
));
99 type
= varobj_get_type (var
);
101 ui_out_field_string (uiout
, "type", "");
104 ui_out_field_string (uiout
, "type", type
);
108 do_cleanups (old_cleanups
);
113 mi_cmd_var_delete (char *command
, char **argv
, int argc
)
119 int children_only_p
= 0;
120 struct cleanup
*old_cleanups
;
122 if (argc
< 1 || argc
> 2)
123 error ("mi_cmd_var_delete: Usage: [-c] EXPRESSION.");
125 name
= xstrdup (argv
[0]);
126 /* Add cleanup for name. Must be free_current_contents as
127 name can be reallocated */
128 old_cleanups
= make_cleanup (free_current_contents
, &name
);
130 /* If we have one single argument it cannot be '-c' or any string
131 starting with '-'. */
134 if (strcmp (name
, "-c") == 0)
135 error ("mi_cmd_var_delete: Missing required argument after '-c': variable object name");
137 error ("mi_cmd_var_delete: Illegal variable object name");
140 /* If we have 2 arguments they must be '-c' followed by a string
141 which would be the variable name. */
144 expr
= xstrdup (argv
[1]);
145 if (strcmp (name
, "-c") != 0)
146 error ("mi_cmd_var_delete: Invalid option.");
149 name
= xstrdup (expr
);
153 /* If we didn't error out, now NAME contains the name of the
156 var
= varobj_get_handle (name
);
159 error ("mi_cmd_var_delete: Variable object not found.");
161 numdel
= varobj_delete (var
, NULL
, children_only_p
);
163 ui_out_field_int (uiout
, "ndeleted", numdel
);
165 do_cleanups (old_cleanups
);
170 mi_cmd_var_set_format (char *command
, char **argv
, int argc
)
172 enum varobj_display_formats format
;
178 error ("mi_cmd_var_set_format: Usage: NAME FORMAT.");
180 /* Get varobj handle, if a valid var obj name was specified */
181 var
= varobj_get_handle (argv
[0]);
184 error ("mi_cmd_var_set_format: Variable object not found");
186 formspec
= xstrdup (argv
[1]);
187 if (formspec
== NULL
)
188 error ("mi_cmd_var_set_format: Must specify the format as: \"natural\", \"binary\", \"decimal\", \"hexadecimal\", or \"octal\"");
190 len
= strlen (formspec
);
192 if (strncmp (formspec
, "natural", len
) == 0)
193 format
= FORMAT_NATURAL
;
194 else if (strncmp (formspec
, "binary", len
) == 0)
195 format
= FORMAT_BINARY
;
196 else if (strncmp (formspec
, "decimal", len
) == 0)
197 format
= FORMAT_DECIMAL
;
198 else if (strncmp (formspec
, "hexadecimal", len
) == 0)
199 format
= FORMAT_HEXADECIMAL
;
200 else if (strncmp (formspec
, "octal", len
) == 0)
201 format
= FORMAT_OCTAL
;
203 error ("mi_cmd_var_set_format: Unknown display format: must be: \"natural\", \"binary\", \"decimal\", \"hexadecimal\", or \"octal\"");
205 /* Set the format of VAR to given format */
206 varobj_set_display_format (var
, format
);
208 /* Report the new current format */
209 ui_out_field_string (uiout
, "format", varobj_format_string
[(int) format
]);
214 mi_cmd_var_show_format (char *command
, char **argv
, int argc
)
216 enum varobj_display_formats format
;
220 error ("mi_cmd_var_show_format: Usage: NAME.");
222 /* Get varobj handle, if a valid var obj name was specified */
223 var
= varobj_get_handle (argv
[0]);
225 error ("mi_cmd_var_show_format: Variable object not found");
227 format
= varobj_get_display_format (var
);
229 /* Report the current format */
230 ui_out_field_string (uiout
, "format", varobj_format_string
[(int) format
]);
235 mi_cmd_var_info_num_children (char *command
, char **argv
, int argc
)
240 error ("mi_cmd_var_info_num_children: Usage: NAME.");
242 /* Get varobj handle, if a valid var obj name was specified */
243 var
= varobj_get_handle (argv
[0]);
245 error ("mi_cmd_var_info_num_children: Variable object not found");
247 ui_out_field_int (uiout
, "numchild", varobj_get_num_children (var
));
252 mi_cmd_var_list_children (char *command
, char **argv
, int argc
)
255 struct varobj
**childlist
;
257 struct cleanup
*cleanup_children
;
260 enum print_values print_values
;
262 if (argc
!= 1 && argc
!= 2)
263 error ("mi_cmd_var_list_children: Usage: [PRINT_VALUES] NAME");
265 /* Get varobj handle, if a valid var obj name was specified */
266 if (argc
== 1) var
= varobj_get_handle (argv
[0]);
267 else var
= varobj_get_handle (argv
[1]);
269 error ("Variable object not found");
271 numchild
= varobj_list_children (var
, &childlist
);
272 ui_out_field_int (uiout
, "numchild", numchild
);
274 if (strcmp (argv
[0], "0") == 0
275 || strcmp (argv
[0], "--no-values") == 0)
276 print_values
= PRINT_NO_VALUES
;
277 else if (strcmp (argv
[0], "1") == 0
278 || strcmp (argv
[0], "--all-values") == 0)
279 print_values
= PRINT_ALL_VALUES
;
281 error ("Unknown value for PRINT_VALUES: must be: 0 or \"--no-values\", 1 or \"--all-values\"");
282 else print_values
= PRINT_NO_VALUES
;
287 if (mi_version (uiout
) == 1)
288 cleanup_children
= make_cleanup_ui_out_tuple_begin_end (uiout
, "children");
290 cleanup_children
= make_cleanup_ui_out_list_begin_end (uiout
, "children");
294 struct cleanup
*cleanup_child
;
295 cleanup_child
= make_cleanup_ui_out_tuple_begin_end (uiout
, "child");
296 ui_out_field_string (uiout
, "name", varobj_get_objname (*cc
));
297 ui_out_field_string (uiout
, "exp", varobj_get_expression (*cc
));
298 ui_out_field_int (uiout
, "numchild", varobj_get_num_children (*cc
));
300 ui_out_field_string (uiout
, "value", varobj_get_value (*cc
));
301 type
= varobj_get_type (*cc
);
302 /* C++ pseudo-variables (public, private, protected) do not have a type */
304 ui_out_field_string (uiout
, "type", varobj_get_type (*cc
));
305 do_cleanups (cleanup_child
);
308 do_cleanups (cleanup_children
);
314 mi_cmd_var_info_type (char *command
, char **argv
, int argc
)
319 error ("mi_cmd_var_info_type: Usage: NAME.");
321 /* Get varobj handle, if a valid var obj name was specified */
322 var
= varobj_get_handle (argv
[0]);
324 error ("mi_cmd_var_info_type: Variable object not found");
326 ui_out_field_string (uiout
, "type", varobj_get_type (var
));
331 mi_cmd_var_info_expression (char *command
, char **argv
, int argc
)
333 enum varobj_languages lang
;
337 error ("mi_cmd_var_info_expression: Usage: NAME.");
339 /* Get varobj handle, if a valid var obj name was specified */
340 var
= varobj_get_handle (argv
[0]);
342 error ("mi_cmd_var_info_expression: Variable object not found");
344 lang
= varobj_get_language (var
);
346 ui_out_field_string (uiout
, "lang", varobj_language_string
[(int) lang
]);
347 ui_out_field_string (uiout
, "exp", varobj_get_expression (var
));
352 mi_cmd_var_show_attributes (char *command
, char **argv
, int argc
)
359 error ("mi_cmd_var_show_attributes: Usage: NAME.");
361 /* Get varobj handle, if a valid var obj name was specified */
362 var
= varobj_get_handle (argv
[0]);
364 error ("mi_cmd_var_show_attributes: Variable object not found");
366 attr
= varobj_get_attributes (var
);
367 /* FIXME: define masks for attributes */
368 if (attr
& 0x00000001)
371 attstr
= "noneditable";
373 ui_out_field_string (uiout
, "attr", attstr
);
378 mi_cmd_var_evaluate_expression (char *command
, char **argv
, int argc
)
383 error ("mi_cmd_var_evaluate_expression: Usage: NAME.");
385 /* Get varobj handle, if a valid var obj name was specified */
386 var
= varobj_get_handle (argv
[0]);
388 error ("mi_cmd_var_evaluate_expression: Variable object not found");
390 ui_out_field_string (uiout
, "value", varobj_get_value (var
));
395 mi_cmd_var_assign (char *command
, char **argv
, int argc
)
401 error ("mi_cmd_var_assign: Usage: NAME EXPRESSION.");
403 /* Get varobj handle, if a valid var obj name was specified */
404 var
= varobj_get_handle (argv
[0]);
406 error ("mi_cmd_var_assign: Variable object not found");
408 /* FIXME: define masks for attributes */
409 if (!(varobj_get_attributes (var
) & 0x00000001))
410 error ("mi_cmd_var_assign: Variable object is not editable");
412 expression
= xstrdup (argv
[1]);
414 if (!varobj_set_value (var
, expression
))
415 error ("mi_cmd_var_assign: Could not assign expression to varible object");
417 ui_out_field_string (uiout
, "value", varobj_get_value (var
));
422 mi_cmd_var_update (char *command
, char **argv
, int argc
)
425 struct varobj
**rootlist
;
427 struct cleanup
*cleanup
;
432 error ("mi_cmd_var_update: Usage: NAME.");
436 /* Check if the parameter is a "*" which means that we want
437 to update all variables */
439 if ((*name
== '*') && (*(name
+ 1) == '\0'))
441 nv
= varobj_list (&rootlist
);
442 if (mi_version (uiout
) <= 1)
443 cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, "changelist");
445 cleanup
= make_cleanup_ui_out_list_begin_end (uiout
, "changelist");
448 do_cleanups (cleanup
);
454 varobj_update_one (*cr
);
458 do_cleanups (cleanup
);
462 /* Get varobj handle, if a valid var obj name was specified */
463 var
= varobj_get_handle (name
);
465 error ("mi_cmd_var_update: Variable object not found");
467 if (mi_version (uiout
) <= 1)
468 cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, "changelist");
470 cleanup
= make_cleanup_ui_out_list_begin_end (uiout
, "changelist");
471 varobj_update_one (var
);
472 do_cleanups (cleanup
);
477 /* Helper for mi_cmd_var_update() Returns 0 if the update for
478 the variable fails (usually because the variable is out of
479 scope), and 1 if it succeeds. */
482 varobj_update_one (struct varobj
*var
)
484 struct varobj
**changelist
;
486 struct cleanup
*cleanup
= NULL
;
489 nc
= varobj_update (&var
, &changelist
);
491 /* nc == 0 means that nothing has changed.
492 nc == -1 means that an error occured in updating the variable.
493 nc == -2 means the variable has changed type. */
499 if (mi_version (uiout
) > 1)
500 cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
501 ui_out_field_string (uiout
, "name", varobj_get_objname(var
));
502 ui_out_field_string (uiout
, "in_scope", "false");
503 if (mi_version (uiout
) > 1)
504 do_cleanups (cleanup
);
509 if (mi_version (uiout
) > 1)
510 cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
511 ui_out_field_string (uiout
, "name", varobj_get_objname (var
));
512 ui_out_field_string (uiout
, "in_scope", "true");
513 ui_out_field_string (uiout
, "new_type", varobj_get_type(var
));
514 ui_out_field_int (uiout
, "new_num_children",
515 varobj_get_num_children(var
));
516 if (mi_version (uiout
) > 1)
517 do_cleanups (cleanup
);
525 if (mi_version (uiout
) > 1)
526 cleanup
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
527 ui_out_field_string (uiout
, "name", varobj_get_objname (*cc
));
528 ui_out_field_string (uiout
, "in_scope", "true");
529 ui_out_field_string (uiout
, "type_changed", "false");
530 if (mi_version (uiout
) > 1)
531 do_cleanups (cleanup
);