gdb/mi/mi-cmd-var.c

   1 /* MI Command Set - varobj commands.
   2
   3    Copyright 2000, 2002 Free Software Foundation, Inc.
   4
   5    Contributed by Cygnus Solutions (a Red Hat company).
   6
   7    This file is part of GDB.
   8
   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.
  13
  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.
  18
  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.  */
  23
  24 #include "defs.h"
  25 #include "mi-cmds.h"
  26 #include "ui-out.h"
  27 #include "mi-out.h"
  28 #include "varobj.h"
  29 #include "value.h"
  30 #include <ctype.h>
  31
  32 extern int varobjdebug;         /* defined in varobj.c */
  33
  34 static int varobj_update_one (struct varobj *var);
  35
  36 /* VAROBJ operations */
  37
  38 enum mi_cmd_result
  39 mi_cmd_var_create (char *command, char **argv, int argc)
  40 {
  41   CORE_ADDR frameaddr = 0;
  42   struct varobj *var;
  43   char *name;
  44   char *frame;
  45   char *expr;
  46   char *type;
  47   struct cleanup *old_cleanups;
  48   enum varobj_type var_type;
  49
  50   if (argc != 3)
  51     {
  52       /*      xasprintf (&mi_error_message,
  53          "mi_cmd_var_create: Usage: .");
  54          return MI_CMD_ERROR; */
  55       error ("mi_cmd_var_create: Usage: NAME FRAME EXPRESSION.");
  56     }
  57
  58   name = xstrdup (argv[0]);
  59   /* Add cleanup for name. Must be free_current_contents as
  60      name can be reallocated */
  61   old_cleanups = make_cleanup (free_current_contents, &name);
  62
  63   frame = xstrdup (argv[1]);
  64   old_cleanups = make_cleanup (xfree, frame);
  65
  66   expr = xstrdup (argv[2]);
  67
  68   if (strcmp (name, "-") == 0)
  69     {
  70       xfree (name);
  71       name = varobj_gen_name ();
  72     }
  73   else if (!isalpha (*name))
  74     error ("mi_cmd_var_create: name of object must begin with a letter");
  75
  76   if (strcmp (frame, "*") == 0)
  77     var_type = USE_CURRENT_FRAME;
  78   else if (strcmp (frame, "@") == 0)
  79     var_type = USE_SELECTED_FRAME;
  80   else
  81     {
  82       var_type = USE_SPECIFIED_FRAME;
  83       frameaddr = parse_and_eval_address (frame);
  84     }
  85
  86   if (varobjdebug)
  87     fprintf_unfiltered (gdb_stdlog,
  88                     "Name=\"%s\", Frame=\"%s\" (0x%s), Expression=\"%s\"\n",
  89                         name, frame, paddr (frameaddr), expr);
  90
  91   var = varobj_create (name, expr, frameaddr, var_type);
  92
  93   if (var == NULL)
  94     error ("mi_cmd_var_create: unable to create variable object");
  95
  96   ui_out_field_string (uiout, "name", name);
  97   ui_out_field_int (uiout, "numchild", varobj_get_num_children (var));
  98   type = varobj_get_type (var);
  99   if (type == NULL)
 100     ui_out_field_string (uiout, "type", "");
 101   else
 102     {
 103       ui_out_field_string (uiout, "type", type);
 104       xfree (type);
 105     }
 106
 107   do_cleanups (old_cleanups);
 108   return MI_CMD_DONE;
 109 }
 110
 111 enum mi_cmd_result
 112 mi_cmd_var_delete (char *command, char **argv, int argc)
 113 {
 114   char *name;
 115   char *expr;
 116   struct varobj *var;
 117   int numdel;
 118   int children_only_p = 0;
 119   struct cleanup *old_cleanups;
 120
 121   if (argc < 1 || argc > 2)
 122     error ("mi_cmd_var_delete: Usage: [-c] EXPRESSION.");
 123
 124   name = xstrdup (argv[0]);
 125   /* Add cleanup for name. Must be free_current_contents as
 126      name can be reallocated */
 127   old_cleanups = make_cleanup (free_current_contents, &name);
 128
 129   /* If we have one single argument it cannot be '-c' or any string
 130      starting with '-'. */
 131   if (argc == 1)
 132     {
 133       if (strcmp (name, "-c") == 0)
 134         error ("mi_cmd_var_delete: Missing required argument after '-c': variable object name");
 135       if (*name == '-')
 136         error ("mi_cmd_var_delete: Illegal variable object name");
 137     }
 138
 139   /* If we have 2 arguments they must be '-c' followed by a string
 140      which would be the variable name. */
 141   if (argc == 2)
 142     {
 143       expr = xstrdup (argv[1]);
 144       if (strcmp (name, "-c") != 0)
 145         error ("mi_cmd_var_delete: Invalid option.");
 146       children_only_p = 1;
 147       xfree (name);
 148       name = xstrdup (expr);
 149       xfree (expr);
 150     }
 151
 152   /* If we didn't error out, now NAME contains the name of the
 153      variable. */
 154
 155   var = varobj_get_handle (name);
 156
 157   if (var == NULL)
 158     error ("mi_cmd_var_delete: Variable object not found.");
 159
 160   numdel = varobj_delete (var, NULL, children_only_p);
 161
 162   ui_out_field_int (uiout, "ndeleted", numdel);
 163
 164   do_cleanups (old_cleanups);
 165   return MI_CMD_DONE;
 166 }
 167
 168 enum mi_cmd_result
 169 mi_cmd_var_set_format (char *command, char **argv, int argc)
 170 {
 171   enum varobj_display_formats format;
 172   int len;
 173   struct varobj *var;
 174   char *formspec;
 175
 176   if (argc != 2)
 177     error ("mi_cmd_var_set_format: Usage: NAME FORMAT.");
 178
 179   /* Get varobj handle, if a valid var obj name was specified */
 180   var = varobj_get_handle (argv[0]);
 181
 182   if (var == NULL)
 183     error ("mi_cmd_var_set_format: Variable object not found");
 184
 185   formspec = xstrdup (argv[1]);
 186   if (formspec == NULL)
 187     error ("mi_cmd_var_set_format: Must specify the format as: \"natural\", \"binary\", \"decimal\", \"hexadecimal\", or \"octal\"");
 188
 189   len = strlen (formspec);
 190
 191   if (STREQN (formspec, "natural", len))
 192     format = FORMAT_NATURAL;
 193   else if (STREQN (formspec, "binary", len))
 194     format = FORMAT_BINARY;
 195   else if (STREQN (formspec, "decimal", len))
 196     format = FORMAT_DECIMAL;
 197   else if (STREQN (formspec, "hexadecimal", len))
 198     format = FORMAT_HEXADECIMAL;
 199   else if (STREQN (formspec, "octal", len))
 200     format = FORMAT_OCTAL;
 201   else
 202     error ("mi_cmd_var_set_format: Unknown display format: must be: \"natural\", \"binary\", \"decimal\", \"hexadecimal\", or \"octal\"");
 203
 204   /* Set the format of VAR to given format */
 205   varobj_set_display_format (var, format);
 206
 207   /* Report the new current format */
 208   ui_out_field_string (uiout, "format", varobj_format_string[(int) format]);
 209   return MI_CMD_DONE;
 210 }
 211
 212 enum mi_cmd_result
 213 mi_cmd_var_show_format (char *command, char **argv, int argc)
 214 {
 215   enum varobj_display_formats format;
 216   struct varobj *var;
 217
 218   if (argc != 1)
 219     error ("mi_cmd_var_show_format: Usage: NAME.");
 220
 221   /* Get varobj handle, if a valid var obj name was specified */
 222   var = varobj_get_handle (argv[0]);
 223   if (var == NULL)
 224     error ("mi_cmd_var_show_format: Variable object not found");
 225
 226   format = varobj_get_display_format (var);
 227
 228   /* Report the current format */
 229   ui_out_field_string (uiout, "format", varobj_format_string[(int) format]);
 230   return MI_CMD_DONE;
 231 }
 232
 233 enum mi_cmd_result
 234 mi_cmd_var_info_num_children (char *command, char **argv, int argc)
 235 {
 236   struct varobj *var;
 237
 238   if (argc != 1)
 239     error ("mi_cmd_var_info_num_children: Usage: NAME.");
 240
 241   /* Get varobj handle, if a valid var obj name was specified */
 242   var = varobj_get_handle (argv[0]);
 243   if (var == NULL)
 244     error ("mi_cmd_var_info_num_children: Variable object not found");
 245
 246   ui_out_field_int (uiout, "numchild", varobj_get_num_children (var));
 247   return MI_CMD_DONE;
 248 }
 249
 250 enum mi_cmd_result
 251 mi_cmd_var_list_children (char *command, char **argv, int argc)
 252 {
 253   struct varobj *var;
 254   struct varobj **childlist;
 255   struct varobj **cc;
 256   int numchild;
 257   char *type;
 258
 259   if (argc != 1)
 260     error ("mi_cmd_var_list_children: Usage: NAME.");
 261
 262   /* Get varobj handle, if a valid var obj name was specified */
 263   var = varobj_get_handle (argv[0]);
 264   if (var == NULL)
 265     error ("mi_cmd_var_list_children: Variable object not found");
 266
 267   numchild = varobj_list_children (var, &childlist);
 268   ui_out_field_int (uiout, "numchild", numchild);
 269
 270   if (numchild <= 0)
 271     return MI_CMD_DONE;
 272
 273   ui_out_tuple_begin (uiout, "children");
 274   cc = childlist;
 275   while (*cc != NULL)
 276     {
 277       ui_out_tuple_begin (uiout, "child");
 278       ui_out_field_string (uiout, "name", varobj_get_objname (*cc));
 279       ui_out_field_string (uiout, "exp", varobj_get_expression (*cc));
 280       ui_out_field_int (uiout, "numchild", varobj_get_num_children (*cc));
 281       type = varobj_get_type (*cc);
 282       /* C++ pseudo-variables (public, private, protected) do not have a type */
 283       if (type)
 284         ui_out_field_string (uiout, "type", varobj_get_type (*cc));
 285       ui_out_tuple_end (uiout);
 286       cc++;
 287     }
 288   ui_out_tuple_end (uiout);
 289   xfree (childlist);
 290   return MI_CMD_DONE;
 291 }
 292
 293 enum mi_cmd_result
 294 mi_cmd_var_info_type (char *command, char **argv, int argc)
 295 {
 296   struct varobj *var;
 297
 298   if (argc != 1)
 299     error ("mi_cmd_var_info_type: Usage: NAME.");
 300
 301   /* Get varobj handle, if a valid var obj name was specified */
 302   var = varobj_get_handle (argv[0]);
 303   if (var == NULL)
 304     error ("mi_cmd_var_info_type: Variable object not found");
 305
 306   ui_out_field_string (uiout, "type", varobj_get_type (var));
 307   return MI_CMD_DONE;
 308 }
 309
 310 enum mi_cmd_result
 311 mi_cmd_var_info_expression (char *command, char **argv, int argc)
 312 {
 313   enum varobj_languages lang;
 314   struct varobj *var;
 315
 316   if (argc != 1)
 317     error ("mi_cmd_var_info_expression: Usage: NAME.");
 318
 319   /* Get varobj handle, if a valid var obj name was specified */
 320   var = varobj_get_handle (argv[0]);
 321   if (var == NULL)
 322     error ("mi_cmd_var_info_expression: Variable object not found");
 323
 324   lang = varobj_get_language (var);
 325
 326   ui_out_field_string (uiout, "lang", varobj_language_string[(int) lang]);
 327   ui_out_field_string (uiout, "exp", varobj_get_expression (var));
 328   return MI_CMD_DONE;
 329 }
 330
 331 enum mi_cmd_result
 332 mi_cmd_var_show_attributes (char *command, char **argv, int argc)
 333 {
 334   int attr;
 335   char *attstr;
 336   struct varobj *var;
 337
 338   if (argc != 1)
 339     error ("mi_cmd_var_show_attributes: Usage: NAME.");
 340
 341   /* Get varobj handle, if a valid var obj name was specified */
 342   var = varobj_get_handle (argv[0]);
 343   if (var == NULL)
 344     error ("mi_cmd_var_show_attributes: Variable object not found");
 345
 346   attr = varobj_get_attributes (var);
 347   /* FIXME: define masks for attributes */
 348   if (attr & 0x00000001)
 349     attstr = "editable";
 350   else
 351     attstr = "noneditable";
 352
 353   ui_out_field_string (uiout, "attr", attstr);
 354   return MI_CMD_DONE;
 355 }
 356
 357 enum mi_cmd_result
 358 mi_cmd_var_evaluate_expression (char *command, char **argv, int argc)
 359 {
 360   struct varobj *var;
 361
 362   if (argc != 1)
 363     error ("mi_cmd_var_evaluate_expression: Usage: NAME.");
 364
 365   /* Get varobj handle, if a valid var obj name was specified */
 366   var = varobj_get_handle (argv[0]);
 367   if (var == NULL)
 368     error ("mi_cmd_var_evaluate_expression: Variable object not found");
 369
 370   ui_out_field_string (uiout, "value", varobj_get_value (var));
 371   return MI_CMD_DONE;
 372 }
 373
 374 enum mi_cmd_result
 375 mi_cmd_var_assign (char *command, char **argv, int argc)
 376 {
 377   struct varobj *var;
 378   char *expression;
 379
 380   if (argc != 2)
 381     error ("mi_cmd_var_assign: Usage: NAME EXPRESSION.");
 382
 383   /* Get varobj handle, if a valid var obj name was specified */
 384   var = varobj_get_handle (argv[0]);
 385   if (var == NULL)
 386     error ("mi_cmd_var_assign: Variable object not found");
 387
 388   /* FIXME: define masks for attributes */
 389   if (!(varobj_get_attributes (var) & 0x00000001))
 390     error ("mi_cmd_var_assign: Variable object is not editable");
 391
 392   expression = xstrdup (argv[1]);
 393
 394   if (!varobj_set_value (var, expression))
 395     error ("mi_cmd_var_assign: Could not assign expression to varible object");
 396
 397   ui_out_field_string (uiout, "value", varobj_get_value (var));
 398   return MI_CMD_DONE;
 399 }
 400
 401 enum mi_cmd_result
 402 mi_cmd_var_update (char *command, char **argv, int argc)
 403 {
 404   struct varobj *var;
 405   struct varobj **rootlist;
 406   struct varobj **cr;
 407   char *name;
 408   int nv;
 409
 410   if (argc != 1)
 411     error ("mi_cmd_var_update: Usage: NAME.");
 412
 413   name = argv[0];
 414
 415   /* Check if the parameter is a "*" which means that we want
 416      to update all variables */
 417
 418   if ((*name == '*') && (*(name + 1) == '\0'))
 419     {
 420       nv = varobj_list (&rootlist);
 421       ui_out_tuple_begin (uiout, "changelist");
 422       if (nv <= 0)
 423         {
 424           ui_out_tuple_end (uiout);
 425           return MI_CMD_DONE;
 426         }
 427       cr = rootlist;
 428       while (*cr != NULL)
 429         {
 430           varobj_update_one (*cr);
 431           cr++;
 432         }
 433       xfree (rootlist);
 434       ui_out_tuple_end (uiout);
 435     }
 436   else
 437     {
 438       /* Get varobj handle, if a valid var obj name was specified */
 439       var = varobj_get_handle (name);
 440       if (var == NULL)
 441         error ("mi_cmd_var_update: Variable object not found");
 442
 443       ui_out_tuple_begin (uiout, "changelist");
 444       varobj_update_one (var);
 445       ui_out_tuple_end (uiout);
 446     }
 447     return MI_CMD_DONE;
 448 }
 449
 450 /* Helper for mi_cmd_var_update() Returns 0 if the update for
 451    the variable fails (usually because the variable is out of
 452    scope), and 1 if it succeeds. */
 453
 454 static int
 455 varobj_update_one (struct varobj *var)
 456 {
 457   struct varobj **changelist;
 458   struct varobj **cc;
 459   int nc;
 460
 461   nc = varobj_update (&var, &changelist);
 462
 463   /* nc == 0 means that nothing has changed.
 464      nc == -1 means that an error occured in updating the variable.
 465      nc == -2 means the variable has changed type. */
 466
 467   if (nc == 0)
 468     return 1;
 469   else if (nc == -1)
 470     {
 471       ui_out_field_string (uiout, "name", varobj_get_objname(var));
 472       ui_out_field_string (uiout, "in_scope", "false");
 473       return -1;
 474     }
 475   else if (nc == -2)
 476     {
 477       ui_out_field_string (uiout, "name", varobj_get_objname (var));
 478       ui_out_field_string (uiout, "in_scope", "true");
 479       ui_out_field_string (uiout, "new_type", varobj_get_type(var));
 480       ui_out_field_int (uiout, "new_num_children",
 481                            varobj_get_num_children(var));
 482     }
 483   else
 484     {
 485
 486       cc = changelist;
 487       while (*cc != NULL)
 488         {
 489           ui_out_field_string (uiout, "name", varobj_get_objname (*cc));
 490           ui_out_field_string (uiout, "in_scope", "true");
 491           ui_out_field_string (uiout, "type_changed", "false");
 492           cc++;
 493         }
 494       xfree (changelist);
 495       return 1;
 496     }
 497   return 1;
 498 }