gdb
[deliverable/binutils-gdb.git] / gdb / mi / mi-cmd-var.c
1 /* MI Command Set - varobj commands.
2
3 Copyright (C) 2000, 2002, 2004, 2005, 2007, 2008, 2009
4 Free Software Foundation, Inc.
5
6 Contributed by Cygnus Solutions (a Red Hat company).
7
8 This file is part of GDB.
9
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.
14
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.
19
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/>. */
22
23 #include "defs.h"
24 #include "mi-cmds.h"
25 #include "ui-out.h"
26 #include "mi-out.h"
27 #include "varobj.h"
28 #include "value.h"
29 #include <ctype.h>
30 #include "gdb_string.h"
31 #include "mi-getopt.h"
32 #include "gdbthread.h"
33
34 const char mi_no_values[] = "--no-values";
35 const char mi_simple_values[] = "--simple-values";
36 const char mi_all_values[] = "--all-values";
37
38 extern int varobjdebug; /* defined in varobj.c. */
39
40 static void varobj_update_one (struct varobj *var,
41 enum print_values print_values,
42 int explicit);
43
44 static int mi_print_value_p (struct type *type, enum print_values print_values);
45
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. */
49 static void
50 print_varobj (struct varobj *var, enum print_values print_values,
51 int print_expression)
52 {
53 struct type *gdb_type;
54 char *type;
55 int thread_id;
56
57 ui_out_field_string (uiout, "name", varobj_get_objname (var));
58 if (print_expression)
59 ui_out_field_string (uiout, "exp", varobj_get_expression (var));
60 ui_out_field_int (uiout, "numchild", varobj_get_num_children (var));
61
62 if (mi_print_value_p (varobj_get_gdb_type (var), print_values))
63 ui_out_field_string (uiout, "value", varobj_get_value (var));
64
65 type = varobj_get_type (var);
66 if (type != NULL)
67 {
68 ui_out_field_string (uiout, "type", type);
69 xfree (type);
70 }
71
72 thread_id = varobj_get_thread_id (var);
73 if (thread_id > 0)
74 ui_out_field_int (uiout, "thread-id", thread_id);
75
76 if (varobj_get_frozen (var))
77 ui_out_field_int (uiout, "frozen", 1);
78 }
79
80 /* VAROBJ operations */
81
82 void
83 mi_cmd_var_create (char *command, char **argv, int argc)
84 {
85 CORE_ADDR frameaddr = 0;
86 struct varobj *var;
87 char *name;
88 char *frame;
89 char *expr;
90 struct cleanup *old_cleanups;
91 enum varobj_type var_type;
92
93 if (argc != 3)
94 {
95 /* mi_error_message = xstrprintf ("mi_cmd_var_create: Usage:
96 ...."); return MI_CMD_ERROR; */
97 error (_("mi_cmd_var_create: Usage: NAME FRAME EXPRESSION."));
98 }
99
100 name = xstrdup (argv[0]);
101 /* Add cleanup for name. Must be free_current_contents as
102 name can be reallocated */
103 old_cleanups = make_cleanup (free_current_contents, &name);
104
105 frame = xstrdup (argv[1]);
106 make_cleanup (xfree, frame);
107
108 expr = xstrdup (argv[2]);
109 make_cleanup (xfree, expr);
110
111 if (strcmp (name, "-") == 0)
112 {
113 xfree (name);
114 name = varobj_gen_name ();
115 }
116 else if (!isalpha (*name))
117 error (_("mi_cmd_var_create: name of object must begin with a letter"));
118
119 if (strcmp (frame, "*") == 0)
120 var_type = USE_CURRENT_FRAME;
121 else if (strcmp (frame, "@") == 0)
122 var_type = USE_SELECTED_FRAME;
123 else
124 {
125 var_type = USE_SPECIFIED_FRAME;
126 frameaddr = string_to_core_addr (frame);
127 }
128
129 if (varobjdebug)
130 fprintf_unfiltered (gdb_stdlog,
131 "Name=\"%s\", Frame=\"%s\" (0x%s), Expression=\"%s\"\n",
132 name, frame, paddr (frameaddr), expr);
133
134 var = varobj_create (name, expr, frameaddr, var_type);
135
136 if (var == NULL)
137 error (_("mi_cmd_var_create: unable to create variable object"));
138
139 print_varobj (var, PRINT_ALL_VALUES, 0 /* don't print expression */);
140
141 do_cleanups (old_cleanups);
142 }
143
144 void
145 mi_cmd_var_delete (char *command, char **argv, int argc)
146 {
147 char *name;
148 struct varobj *var;
149 int numdel;
150 int children_only_p = 0;
151 struct cleanup *old_cleanups;
152
153 if (argc < 1 || argc > 2)
154 error (_("mi_cmd_var_delete: Usage: [-c] EXPRESSION."));
155
156 name = xstrdup (argv[0]);
157 /* Add cleanup for name. Must be free_current_contents as
158 name can be reallocated */
159 old_cleanups = make_cleanup (free_current_contents, &name);
160
161 /* If we have one single argument it cannot be '-c' or any string
162 starting with '-'. */
163 if (argc == 1)
164 {
165 if (strcmp (name, "-c") == 0)
166 error (_("mi_cmd_var_delete: Missing required argument after '-c': variable object name"));
167 if (*name == '-')
168 error (_("mi_cmd_var_delete: Illegal variable object name"));
169 }
170
171 /* If we have 2 arguments they must be '-c' followed by a string
172 which would be the variable name. */
173 if (argc == 2)
174 {
175 if (strcmp (name, "-c") != 0)
176 error (_("mi_cmd_var_delete: Invalid option."));
177 children_only_p = 1;
178 do_cleanups (old_cleanups);
179 name = xstrdup (argv[1]);
180 make_cleanup (free_current_contents, &name);
181 }
182
183 /* If we didn't error out, now NAME contains the name of the
184 variable. */
185
186 var = varobj_get_handle (name);
187
188 numdel = varobj_delete (var, NULL, children_only_p);
189
190 ui_out_field_int (uiout, "ndeleted", numdel);
191
192 do_cleanups (old_cleanups);
193 }
194
195 /* Parse a string argument into a format value. */
196
197 static enum varobj_display_formats
198 mi_parse_format (const char *arg)
199 {
200 if (arg != NULL)
201 {
202 int len;
203
204 len = strlen (arg);
205
206 if (strncmp (arg, "natural", len) == 0)
207 return FORMAT_NATURAL;
208 else if (strncmp (arg, "binary", len) == 0)
209 return FORMAT_BINARY;
210 else if (strncmp (arg, "decimal", len) == 0)
211 return FORMAT_DECIMAL;
212 else if (strncmp (arg, "hexadecimal", len) == 0)
213 return FORMAT_HEXADECIMAL;
214 else if (strncmp (arg, "octal", len) == 0)
215 return FORMAT_OCTAL;
216 }
217
218 error (_("Must specify the format as: \"natural\", \"binary\", \"decimal\", \"hexadecimal\", or \"octal\""));
219 }
220
221 void
222 mi_cmd_var_set_format (char *command, char **argv, int argc)
223 {
224 enum varobj_display_formats format;
225 struct varobj *var;
226
227 if (argc != 2)
228 error (_("mi_cmd_var_set_format: Usage: NAME FORMAT."));
229
230 /* Get varobj handle, if a valid var obj name was specified */
231 var = varobj_get_handle (argv[0]);
232
233 format = mi_parse_format (argv[1]);
234
235 /* Set the format of VAR to given format */
236 varobj_set_display_format (var, format);
237
238 /* Report the new current format */
239 ui_out_field_string (uiout, "format", varobj_format_string[(int) format]);
240
241 /* Report the value in the new format */
242 ui_out_field_string (uiout, "value", varobj_get_value (var));
243 }
244
245 void
246 mi_cmd_var_set_visualizer (char *command, char **argv, int argc)
247 {
248 struct varobj *var;
249
250 if (argc != 2)
251 error ("Usage: NAME VISUALIZER_FUNCTION.");
252
253 var = varobj_get_handle (argv[0]);
254
255 if (var == NULL)
256 error ("Variable object not found");
257
258 varobj_set_visualizer (var, argv[1]);
259 }
260
261 void
262 mi_cmd_var_set_frozen (char *command, char **argv, int argc)
263 {
264 struct varobj *var;
265 int frozen;
266
267 if (argc != 2)
268 error (_("-var-set-format: Usage: NAME FROZEN_FLAG."));
269
270 var = varobj_get_handle (argv[0]);
271
272 if (strcmp (argv[1], "0") == 0)
273 frozen = 0;
274 else if (strcmp (argv[1], "1") == 0)
275 frozen = 1;
276 else
277 error (_("Invalid flag value"));
278
279 varobj_set_frozen (var, frozen);
280
281 /* We don't automatically return the new value, or what varobjs got new
282 values during unfreezing. If this information is required, client
283 should call -var-update explicitly. */
284 }
285
286
287 void
288 mi_cmd_var_show_format (char *command, char **argv, int argc)
289 {
290 enum varobj_display_formats format;
291 struct varobj *var;
292
293 if (argc != 1)
294 error (_("mi_cmd_var_show_format: Usage: NAME."));
295
296 /* Get varobj handle, if a valid var obj name was specified */
297 var = varobj_get_handle (argv[0]);
298
299 format = varobj_get_display_format (var);
300
301 /* Report the current format */
302 ui_out_field_string (uiout, "format", varobj_format_string[(int) format]);
303 }
304
305 void
306 mi_cmd_var_info_num_children (char *command, char **argv, int argc)
307 {
308 struct varobj *var;
309
310 if (argc != 1)
311 error (_("mi_cmd_var_info_num_children: Usage: NAME."));
312
313 /* Get varobj handle, if a valid var obj name was specified */
314 var = varobj_get_handle (argv[0]);
315
316 ui_out_field_int (uiout, "numchild", varobj_get_num_children (var));
317 }
318
319 /* Parse a string argument into a print_values value. */
320
321 static enum print_values
322 mi_parse_values_option (const char *arg)
323 {
324 if (strcmp (arg, "0") == 0
325 || strcmp (arg, mi_no_values) == 0)
326 return PRINT_NO_VALUES;
327 else if (strcmp (arg, "1") == 0
328 || strcmp (arg, mi_all_values) == 0)
329 return PRINT_ALL_VALUES;
330 else if (strcmp (arg, "2") == 0
331 || strcmp (arg, mi_simple_values) == 0)
332 return PRINT_SIMPLE_VALUES;
333 else
334 error (_("Unknown value for PRINT_VALUES\n\
335 Must be: 0 or \"%s\", 1 or \"%s\", 2 or \"%s\""),
336 mi_no_values, mi_simple_values, mi_all_values);
337 }
338
339 /* Return 1 if given the argument PRINT_VALUES we should display
340 a value of type TYPE. */
341
342 static int
343 mi_print_value_p (struct type *type, enum print_values print_values)
344 {
345
346 if (print_values == PRINT_NO_VALUES)
347 return 0;
348
349 if (print_values == PRINT_ALL_VALUES)
350 return 1;
351
352 if (type == NULL)
353 return 1;
354 else
355 {
356 type = check_typedef (type);
357
358 /* For PRINT_SIMPLE_VALUES, only print the value if it has a type
359 and that type is not a compound type. */
360 return (TYPE_CODE (type) != TYPE_CODE_ARRAY
361 && TYPE_CODE (type) != TYPE_CODE_STRUCT
362 && TYPE_CODE (type) != TYPE_CODE_UNION);
363 }
364 }
365
366 void
367 mi_cmd_var_list_children (char *command, char **argv, int argc)
368 {
369 struct varobj *var;
370 VEC(varobj_p) *children;
371 struct varobj *child;
372 struct cleanup *cleanup_children;
373 int numchild;
374 enum print_values print_values;
375 int ix;
376 char *display_hint;
377
378 if (argc != 1 && argc != 2)
379 error (_("mi_cmd_var_list_children: Usage: [PRINT_VALUES] NAME"));
380
381 /* Get varobj handle, if a valid var obj name was specified */
382 if (argc == 1)
383 var = varobj_get_handle (argv[0]);
384 else
385 var = varobj_get_handle (argv[1]);
386
387 children = varobj_list_children (var);
388 ui_out_field_int (uiout, "numchild", VEC_length (varobj_p, children));
389 if (argc == 2)
390 print_values = mi_parse_values_option (argv[0]);
391 else
392 print_values = PRINT_NO_VALUES;
393
394 display_hint = varobj_get_display_hint (var);
395 if (display_hint)
396 {
397 ui_out_field_string (uiout, "displayhint", display_hint);
398 xfree (display_hint);
399 }
400
401 if (VEC_length (varobj_p, children) == 0)
402 return;
403
404 if (mi_version (uiout) == 1)
405 cleanup_children = make_cleanup_ui_out_tuple_begin_end (uiout, "children");
406 else
407 cleanup_children = make_cleanup_ui_out_list_begin_end (uiout, "children");
408 for (ix = 0; VEC_iterate (varobj_p, children, ix, child); ++ix)
409 {
410 struct cleanup *cleanup_child;
411 cleanup_child = make_cleanup_ui_out_tuple_begin_end (uiout, "child");
412 print_varobj (child, print_values, 1 /* print expression */);
413 do_cleanups (cleanup_child);
414 }
415 do_cleanups (cleanup_children);
416 }
417
418 void
419 mi_cmd_var_info_type (char *command, char **argv, int argc)
420 {
421 struct varobj *var;
422
423 if (argc != 1)
424 error (_("mi_cmd_var_info_type: Usage: NAME."));
425
426 /* Get varobj handle, if a valid var obj name was specified */
427 var = varobj_get_handle (argv[0]);
428
429 ui_out_field_string (uiout, "type", varobj_get_type (var));
430 }
431
432 void
433 mi_cmd_var_info_path_expression (char *command, char **argv, int argc)
434 {
435 struct varobj *var;
436 char *path_expr;
437
438 if (argc != 1)
439 error (_("Usage: NAME."));
440
441 /* Get varobj handle, if a valid var obj name was specified. */
442 var = varobj_get_handle (argv[0]);
443
444 path_expr = varobj_get_path_expr (var);
445
446 ui_out_field_string (uiout, "path_expr", path_expr);
447 }
448
449 void
450 mi_cmd_var_info_expression (char *command, char **argv, int argc)
451 {
452 enum varobj_languages lang;
453 struct varobj *var;
454
455 if (argc != 1)
456 error (_("mi_cmd_var_info_expression: Usage: NAME."));
457
458 /* Get varobj handle, if a valid var obj name was specified */
459 var = varobj_get_handle (argv[0]);
460
461 lang = varobj_get_language (var);
462
463 ui_out_field_string (uiout, "lang", varobj_language_string[(int) lang]);
464 ui_out_field_string (uiout, "exp", varobj_get_expression (var));
465 }
466
467 void
468 mi_cmd_var_show_attributes (char *command, char **argv, int argc)
469 {
470 int attr;
471 char *attstr;
472 struct varobj *var;
473
474 if (argc != 1)
475 error (_("mi_cmd_var_show_attributes: Usage: NAME."));
476
477 /* Get varobj handle, if a valid var obj name was specified */
478 var = varobj_get_handle (argv[0]);
479
480 attr = varobj_get_attributes (var);
481 /* FIXME: define masks for attributes */
482 if (attr & 0x00000001)
483 attstr = "editable";
484 else
485 attstr = "noneditable";
486
487 ui_out_field_string (uiout, "attr", attstr);
488 }
489
490 void
491 mi_cmd_var_evaluate_expression (char *command, char **argv, int argc)
492 {
493 struct varobj *var;
494
495 enum varobj_display_formats format;
496 int formatFound;
497 int optind;
498 char *optarg;
499
500 enum opt
501 {
502 OP_FORMAT
503 };
504 static struct mi_opt opts[] =
505 {
506 {"f", OP_FORMAT, 1},
507 { 0, 0, 0 }
508 };
509
510 /* Parse arguments */
511 format = FORMAT_NATURAL;
512 formatFound = 0;
513 optind = 0;
514 while (1)
515 {
516 int opt = mi_getopt ("-var-evaluate-expression", argc, argv, opts, &optind, &optarg);
517 if (opt < 0)
518 break;
519 switch ((enum opt) opt)
520 {
521 case OP_FORMAT:
522 if (formatFound)
523 error (_("Cannot specify format more than once"));
524
525 format = mi_parse_format (optarg);
526 formatFound = 1;
527 break;
528 }
529 }
530
531 if (optind >= argc)
532 error (_("Usage: [-f FORMAT] NAME"));
533
534 if (optind < argc - 1)
535 error (_("Garbage at end of command"));
536
537 /* Get varobj handle, if a valid var obj name was specified */
538 var = varobj_get_handle (argv[optind]);
539
540 if (formatFound)
541 ui_out_field_string (uiout, "value", varobj_get_formatted_value (var, format));
542 else
543 ui_out_field_string (uiout, "value", varobj_get_value (var));
544 }
545
546 void
547 mi_cmd_var_assign (char *command, char **argv, int argc)
548 {
549 struct varobj *var;
550 char *expression;
551
552 if (argc != 2)
553 error (_("mi_cmd_var_assign: Usage: NAME EXPRESSION."));
554
555 /* Get varobj handle, if a valid var obj name was specified */
556 var = varobj_get_handle (argv[0]);
557
558 if (!varobj_editable_p (var))
559 error (_("mi_cmd_var_assign: Variable object is not editable"));
560
561 expression = xstrdup (argv[1]);
562
563 if (!varobj_set_value (var, expression))
564 error (_("mi_cmd_var_assign: Could not assign expression to variable object"));
565
566 ui_out_field_string (uiout, "value", varobj_get_value (var));
567 }
568
569 void
570 mi_cmd_var_update (char *command, char **argv, int argc)
571 {
572 struct varobj *var;
573 struct varobj **rootlist;
574 struct varobj **cr;
575 struct cleanup *cleanup;
576 char *name;
577 int nv;
578 enum print_values print_values;
579
580 if (argc != 1 && argc != 2)
581 error (_("mi_cmd_var_update: Usage: [PRINT_VALUES] NAME."));
582
583 if (argc == 1)
584 name = argv[0];
585 else
586 name = (argv[1]);
587
588 if (argc == 2)
589 print_values = mi_parse_values_option (argv[0]);
590 else
591 print_values = PRINT_NO_VALUES;
592
593 /* Check if the parameter is a "*" which means that we want
594 to update all variables */
595
596 if ((*name == '*' || *name == '@') && (*(name + 1) == '\0'))
597 {
598 nv = varobj_list (&rootlist);
599 cleanup = make_cleanup (xfree, rootlist);
600 if (mi_version (uiout) <= 1)
601 make_cleanup_ui_out_tuple_begin_end (uiout, "changelist");
602 else
603 make_cleanup_ui_out_list_begin_end (uiout, "changelist");
604 if (nv <= 0)
605 {
606 do_cleanups (cleanup);
607 return;
608 }
609 cr = rootlist;
610 while (*cr != NULL)
611 {
612 int thread_id = varobj_get_thread_id (*cr);
613 int thread_stopped = 0;
614 if (thread_id == -1 && is_stopped (inferior_ptid))
615 thread_stopped = 1;
616 else
617 {
618 struct thread_info *tp = find_thread_id (thread_id);
619 if (tp)
620 thread_stopped = is_stopped (tp->ptid);
621 else
622 thread_stopped = 1;
623 }
624 if (thread_stopped)
625 if (*name == '*' || varobj_floating_p (*cr))
626 varobj_update_one (*cr, print_values, 0 /* implicit */);
627 cr++;
628 }
629 do_cleanups (cleanup);
630 }
631 else
632 {
633 /* Get varobj handle, if a valid var obj name was specified */
634 var = varobj_get_handle (name);
635
636 if (mi_version (uiout) <= 1)
637 cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, "changelist");
638 else
639 cleanup = make_cleanup_ui_out_list_begin_end (uiout, "changelist");
640 varobj_update_one (var, print_values, 1 /* explicit */);
641 do_cleanups (cleanup);
642 }
643 }
644
645 /* Helper for mi_cmd_var_update(). */
646
647 static void
648 varobj_update_one (struct varobj *var, enum print_values print_values,
649 int explicit)
650 {
651 struct varobj **cc;
652 struct cleanup *cleanup = NULL;
653 VEC (varobj_update_result) *changes;
654 varobj_update_result *r;
655 int i;
656
657 changes = varobj_update (&var, explicit);
658
659 for (i = 0; VEC_iterate (varobj_update_result, changes, i, r); ++i)
660 {
661 char *display_hint;
662
663 if (mi_version (uiout) > 1)
664 cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
665 ui_out_field_string (uiout, "name", varobj_get_objname (r->varobj));
666
667 switch (r->status)
668 {
669 case VAROBJ_IN_SCOPE:
670 if (mi_print_value_p (varobj_get_gdb_type (r->varobj), print_values))
671 ui_out_field_string (uiout, "value", varobj_get_value (r->varobj));
672 ui_out_field_string (uiout, "in_scope", "true");
673 break;
674 case VAROBJ_NOT_IN_SCOPE:
675 ui_out_field_string (uiout, "in_scope", "false");
676 break;
677 case VAROBJ_INVALID:
678 ui_out_field_string (uiout, "in_scope", "invalid");
679 break;
680 }
681
682 if (r->status != VAROBJ_INVALID)
683 {
684 if (r->type_changed)
685 ui_out_field_string (uiout, "type_changed", "true");
686 else
687 ui_out_field_string (uiout, "type_changed", "false");
688 }
689
690 if (r->type_changed)
691 {
692 ui_out_field_string (uiout, "new_type", varobj_get_type (r->varobj));
693 ui_out_field_int (uiout, "new_num_children",
694 varobj_get_num_children (r->varobj));
695 }
696
697 display_hint = varobj_get_display_hint (var);
698 if (display_hint)
699 {
700 ui_out_field_string (uiout, "displayhint", display_hint);
701 xfree (display_hint);
702 }
703
704 if (r->children_changed)
705 {
706 int ix;
707 struct varobj *child;
708 struct cleanup *cleanup =
709 make_cleanup_ui_out_list_begin_end (uiout, "children");
710
711 VEC (varobj_p)* children = varobj_list_children (r->varobj);
712
713 for (ix = 0; VEC_iterate (varobj_p, children, ix, child); ++ix)
714 {
715 struct cleanup *cleanup_child;
716 cleanup_child = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
717 print_varobj (child, print_values, 1 /* print expression */);
718 do_cleanups (cleanup_child);
719 }
720
721 do_cleanups (cleanup);
722 }
723
724 if (mi_version (uiout) > 1)
725 do_cleanups (cleanup);
726 }
727 VEC_free (varobj_update_result, changes);
728 }
This page took 0.045506 seconds and 4 git commands to generate.