gdb/parse.c

   1 /* Parse expressions for GDB.
   2
   3    Copyright (C) 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
   4    1998, 1999, 2000, 2001, 2004, 2005, 2007, 2008, 2009
   5    Free Software Foundation, Inc.
   6
   7    Modified from expread.y by the Department of Computer Science at the
   8    State University of New York at Buffalo, 1991.
   9
  10    This file is part of GDB.
  11
  12    This program is free software; you can redistribute it and/or modify
  13    it under the terms of the GNU General Public License as published by
  14    the Free Software Foundation; either version 3 of the License, or
  15    (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  24
  25 /* Parse an expression from text in a string,
  26    and return the result as a  struct expression  pointer.
  27    That structure contains arithmetic operations in reverse polish,
  28    with constants represented by operations that are followed by special data.
  29    See expression.h for the details of the format.
  30    What is important here is that it can be built up sequentially
  31    during the process of parsing; the lower levels of the tree always
  32    come first in the result.  */
  33
  34 #include <ctype.h>
  35
  36 #include "defs.h"
  37 #include "gdb_string.h"
  38 #include "symtab.h"
  39 #include "gdbtypes.h"
  40 #include "frame.h"
  41 #include "expression.h"
  42 #include "value.h"
  43 #include "command.h"
  44 #include "language.h"
  45 #include "f-lang.h"
  46 #include "parser-defs.h"
  47 #include "gdbcmd.h"
  48 #include "symfile.h"            /* for overlay functions */
  49 #include "inferior.h"
  50 #include "doublest.h"
  51 #include "gdb_assert.h"
  52 #include "block.h"
  53 #include "source.h"
  54 #include "objfiles.h"
  55 #include "exceptions.h"
  56 #include "user-regs.h"
  57
  58 /* Standard set of definitions for printing, dumping, prefixifying,
  59  * and evaluating expressions.  */
  60
  61 const struct exp_descriptor exp_descriptor_standard =
  62   {
  63     print_subexp_standard,
  64     operator_length_standard,
  65     op_name_standard,
  66     dump_subexp_body_standard,
  67     evaluate_subexp_standard
  68   };
  69 \f
  70 /* Global variables declared in parser-defs.h (and commented there).  */
  71 struct expression *expout;
  72 int expout_size;
  73 int expout_ptr;
  74 struct block *expression_context_block;
  75 CORE_ADDR expression_context_pc;
  76 struct block *innermost_block;
  77 int arglist_len;
  78 union type_stack_elt *type_stack;
  79 int type_stack_depth, type_stack_size;
  80 char *lexptr;
  81 char *prev_lexptr;
  82 int paren_depth;
  83 int comma_terminates;
  84
  85 /* True if parsing an expression to find a field reference.  This is
  86    only used by completion.  */
  87 int in_parse_field;
  88
  89 /* The index of the last struct expression directly before a '.' or
  90    '->'.  This is set when parsing and is only used when completing a
  91    field name.  It is -1 if no dereference operation was found.  */
  92 static int expout_last_struct = -1;
  93
  94 /* A temporary buffer for identifiers, so we can null-terminate them.
  95
  96    We allocate this with xrealloc.  parse_exp_1 used to allocate with
  97    alloca, using the size of the whole expression as a conservative
  98    estimate of the space needed.  However, macro expansion can
  99    introduce names longer than the original expression; there's no
 100    practical way to know beforehand how large that might be.  */
 101 char *namecopy;
 102 size_t namecopy_size;
 103 \f
 104 static int expressiondebug = 0;
 105 static void
 106 show_expressiondebug (struct ui_file *file, int from_tty,
 107                       struct cmd_list_element *c, const char *value)
 108 {
 109   fprintf_filtered (file, _("Expression debugging is %s.\n"), value);
 110 }
 111
 112 static void free_funcalls (void *ignore);
 113
 114 static int prefixify_expression (struct expression *);
 115
 116 static int prefixify_subexp (struct expression *, struct expression *, int,
 117                              int);
 118
 119 static struct expression *parse_exp_in_context (char **, struct block *, int,
 120                                                 int, int *);
 121
 122 void _initialize_parse (void);
 123
 124 /* Data structure for saving values of arglist_len for function calls whose
 125    arguments contain other function calls.  */
 126
 127 struct funcall
 128   {
 129     struct funcall *next;
 130     int arglist_len;
 131   };
 132
 133 static struct funcall *funcall_chain;
 134
 135 /* Begin counting arguments for a function call,
 136    saving the data about any containing call.  */
 137
 138 void
 139 start_arglist (void)
 140 {
 141   struct funcall *new;
 142
 143   new = (struct funcall *) xmalloc (sizeof (struct funcall));
 144   new->next = funcall_chain;
 145   new->arglist_len = arglist_len;
 146   arglist_len = 0;
 147   funcall_chain = new;
 148 }
 149
 150 /* Return the number of arguments in a function call just terminated,
 151    and restore the data for the containing function call.  */
 152
 153 int
 154 end_arglist (void)
 155 {
 156   int val = arglist_len;
 157   struct funcall *call = funcall_chain;
 158   funcall_chain = call->next;
 159   arglist_len = call->arglist_len;
 160   xfree (call);
 161   return val;
 162 }
 163
 164 /* Free everything in the funcall chain.
 165    Used when there is an error inside parsing.  */
 166
 167 static void
 168 free_funcalls (void *ignore)
 169 {
 170   struct funcall *call, *next;
 171
 172   for (call = funcall_chain; call; call = next)
 173     {
 174       next = call->next;
 175       xfree (call);
 176     }
 177 }
 178 \f
 179 /* This page contains the functions for adding data to the  struct expression
 180    being constructed.  */
 181
 182 /* Add one element to the end of the expression.  */
 183
 184 /* To avoid a bug in the Sun 4 compiler, we pass things that can fit into
 185    a register through here */
 186
 187 void
 188 write_exp_elt (union exp_element expelt)
 189 {
 190   if (expout_ptr >= expout_size)
 191     {
 192       expout_size *= 2;
 193       expout = (struct expression *)
 194         xrealloc ((char *) expout, sizeof (struct expression)
 195                   + EXP_ELEM_TO_BYTES (expout_size));
 196     }
 197   expout->elts[expout_ptr++] = expelt;
 198 }
 199
 200 void
 201 write_exp_elt_opcode (enum exp_opcode expelt)
 202 {
 203   union exp_element tmp;
 204   memset (&tmp, 0, sizeof (union exp_element));
 205
 206   tmp.opcode = expelt;
 207
 208   write_exp_elt (tmp);
 209 }
 210
 211 void
 212 write_exp_elt_sym (struct symbol *expelt)
 213 {
 214   union exp_element tmp;
 215   memset (&tmp, 0, sizeof (union exp_element));
 216
 217   tmp.symbol = expelt;
 218
 219   write_exp_elt (tmp);
 220 }
 221
 222 void
 223 write_exp_elt_block (struct block *b)
 224 {
 225   union exp_element tmp;
 226   memset (&tmp, 0, sizeof (union exp_element));
 227   tmp.block = b;
 228   write_exp_elt (tmp);
 229 }
 230
 231 void
 232 write_exp_elt_objfile (struct objfile *objfile)
 233 {
 234   union exp_element tmp;
 235   memset (&tmp, 0, sizeof (union exp_element));
 236   tmp.objfile = objfile;
 237   write_exp_elt (tmp);
 238 }
 239
 240 void
 241 write_exp_elt_longcst (LONGEST expelt)
 242 {
 243   union exp_element tmp;
 244   memset (&tmp, 0, sizeof (union exp_element));
 245
 246   tmp.longconst = expelt;
 247
 248   write_exp_elt (tmp);
 249 }
 250
 251 void
 252 write_exp_elt_dblcst (DOUBLEST expelt)
 253 {
 254   union exp_element tmp;
 255   memset (&tmp, 0, sizeof (union exp_element));
 256
 257   tmp.doubleconst = expelt;
 258
 259   write_exp_elt (tmp);
 260 }
 261
 262 void
 263 write_exp_elt_decfloatcst (gdb_byte expelt[16])
 264 {
 265   union exp_element tmp;
 266   int index;
 267
 268   for (index = 0; index < 16; index++)
 269     tmp.decfloatconst[index] = expelt[index];
 270
 271   write_exp_elt (tmp);
 272 }
 273
 274 void
 275 write_exp_elt_type (struct type *expelt)
 276 {
 277   union exp_element tmp;
 278   memset (&tmp, 0, sizeof (union exp_element));
 279
 280   tmp.type = expelt;
 281
 282   write_exp_elt (tmp);
 283 }
 284
 285 void
 286 write_exp_elt_intern (struct internalvar *expelt)
 287 {
 288   union exp_element tmp;
 289   memset (&tmp, 0, sizeof (union exp_element));
 290
 291   tmp.internalvar = expelt;
 292
 293   write_exp_elt (tmp);
 294 }
 295
 296 /* Add a string constant to the end of the expression.
 297
 298    String constants are stored by first writing an expression element
 299    that contains the length of the string, then stuffing the string
 300    constant itself into however many expression elements are needed
 301    to hold it, and then writing another expression element that contains
 302    the length of the string.  I.E. an expression element at each end of
 303    the string records the string length, so you can skip over the
 304    expression elements containing the actual string bytes from either
 305    end of the string.  Note that this also allows gdb to handle
 306    strings with embedded null bytes, as is required for some languages.
 307
 308    Don't be fooled by the fact that the string is null byte terminated,
 309    this is strictly for the convenience of debugging gdb itself.  Gdb
 310    Gdb does not depend up the string being null terminated, since the
 311    actual length is recorded in expression elements at each end of the
 312    string.  The null byte is taken into consideration when computing how
 313    many expression elements are required to hold the string constant, of
 314    course. */
 315
 316
 317 void
 318 write_exp_string (struct stoken str)
 319 {
 320   int len = str.length;
 321   int lenelt;
 322   char *strdata;
 323
 324   /* Compute the number of expression elements required to hold the string
 325      (including a null byte terminator), along with one expression element
 326      at each end to record the actual string length (not including the
 327      null byte terminator). */
 328
 329   lenelt = 2 + BYTES_TO_EXP_ELEM (len + 1);
 330
 331   /* Ensure that we have enough available expression elements to store
 332      everything. */
 333
 334   if ((expout_ptr + lenelt) >= expout_size)
 335     {
 336       expout_size = max (expout_size * 2, expout_ptr + lenelt + 10);
 337       expout = (struct expression *)
 338         xrealloc ((char *) expout, (sizeof (struct expression)
 339                                     + EXP_ELEM_TO_BYTES (expout_size)));
 340     }
 341
 342   /* Write the leading length expression element (which advances the current
 343      expression element index), then write the string constant followed by a
 344      terminating null byte, and then write the trailing length expression
 345      element. */
 346
 347   write_exp_elt_longcst ((LONGEST) len);
 348   strdata = (char *) &expout->elts[expout_ptr];
 349   memcpy (strdata, str.ptr, len);
 350   *(strdata + len) = '\0';
 351   expout_ptr += lenelt - 2;
 352   write_exp_elt_longcst ((LONGEST) len);
 353 }
 354
 355 /* Add a vector of string constants to the end of the expression.
 356
 357    This adds an OP_STRING operation, but encodes the contents
 358    differently from write_exp_string.  The language is expected to
 359    handle evaluation of this expression itself.
 360
 361    After the usual OP_STRING header, TYPE is written into the
 362    expression as a long constant.  The interpretation of this field is
 363    up to the language evaluator.
 364
 365    Next, each string in VEC is written.  The length is written as a
 366    long constant, followed by the contents of the string.  */
 367
 368 void
 369 write_exp_string_vector (int type, struct stoken_vector *vec)
 370 {
 371   int i, n_slots, len;
 372
 373   /* Compute the size.  We compute the size in number of slots to
 374      avoid issues with string padding.  */
 375   n_slots = 0;
 376   for (i = 0; i < vec->len; ++i)
 377     {
 378       /* One slot for the length of this element, plus the number of
 379          slots needed for this string.  */
 380       n_slots += 1 + BYTES_TO_EXP_ELEM (vec->tokens[i].length);
 381     }
 382
 383   /* One more slot for the type of the string.  */
 384   ++n_slots;
 385
 386   /* Now compute a phony string length.  */
 387   len = EXP_ELEM_TO_BYTES (n_slots) - 1;
 388
 389   n_slots += 4;
 390   if ((expout_ptr + n_slots) >= expout_size)
 391     {
 392       expout_size = max (expout_size * 2, expout_ptr + n_slots + 10);
 393       expout = (struct expression *)
 394         xrealloc ((char *) expout, (sizeof (struct expression)
 395                                     + EXP_ELEM_TO_BYTES (expout_size)));
 396     }
 397
 398   write_exp_elt_opcode (OP_STRING);
 399   write_exp_elt_longcst (len);
 400   write_exp_elt_longcst (type);
 401
 402   for (i = 0; i < vec->len; ++i)
 403     {
 404       write_exp_elt_longcst (vec->tokens[i].length);
 405       memcpy (&expout->elts[expout_ptr], vec->tokens[i].ptr,
 406               vec->tokens[i].length);
 407       expout_ptr += BYTES_TO_EXP_ELEM (vec->tokens[i].length);
 408     }
 409
 410   write_exp_elt_longcst (len);
 411   write_exp_elt_opcode (OP_STRING);
 412 }
 413
 414 /* Add a bitstring constant to the end of the expression.
 415
 416    Bitstring constants are stored by first writing an expression element
 417    that contains the length of the bitstring (in bits), then stuffing the
 418    bitstring constant itself into however many expression elements are
 419    needed to hold it, and then writing another expression element that
 420    contains the length of the bitstring.  I.E. an expression element at
 421    each end of the bitstring records the bitstring length, so you can skip
 422    over the expression elements containing the actual bitstring bytes from
 423    either end of the bitstring. */
 424
 425 void
 426 write_exp_bitstring (struct stoken str)
 427 {
 428   int bits = str.length;        /* length in bits */
 429   int len = (bits + HOST_CHAR_BIT - 1) / HOST_CHAR_BIT;
 430   int lenelt;
 431   char *strdata;
 432
 433   /* Compute the number of expression elements required to hold the bitstring,
 434      along with one expression element at each end to record the actual
 435      bitstring length in bits. */
 436
 437   lenelt = 2 + BYTES_TO_EXP_ELEM (len);
 438
 439   /* Ensure that we have enough available expression elements to store
 440      everything. */
 441
 442   if ((expout_ptr + lenelt) >= expout_size)
 443     {
 444       expout_size = max (expout_size * 2, expout_ptr + lenelt + 10);
 445       expout = (struct expression *)
 446         xrealloc ((char *) expout, (sizeof (struct expression)
 447                                     + EXP_ELEM_TO_BYTES (expout_size)));
 448     }
 449
 450   /* Write the leading length expression element (which advances the current
 451      expression element index), then write the bitstring constant, and then
 452      write the trailing length expression element. */
 453
 454   write_exp_elt_longcst ((LONGEST) bits);
 455   strdata = (char *) &expout->elts[expout_ptr];
 456   memcpy (strdata, str.ptr, len);
 457   expout_ptr += lenelt - 2;
 458   write_exp_elt_longcst ((LONGEST) bits);
 459 }
 460
 461 /* Add the appropriate elements for a minimal symbol to the end of
 462    the expression.  */
 463
 464 void
 465 write_exp_msymbol (struct minimal_symbol *msymbol)
 466 {
 467   struct objfile *objfile = msymbol_objfile (msymbol);
 468   struct gdbarch *gdbarch = get_objfile_arch (objfile);
 469
 470   CORE_ADDR addr = SYMBOL_VALUE_ADDRESS (msymbol);
 471   struct obj_section *section = SYMBOL_OBJ_SECTION (msymbol);
 472   enum minimal_symbol_type type = MSYMBOL_TYPE (msymbol);
 473   CORE_ADDR pc;
 474
 475   /* The minimal symbol might point to a function descriptor;
 476      resolve it to the actual code address instead.  */
 477   pc = gdbarch_convert_from_func_ptr_addr (gdbarch, addr, &current_target);
 478   if (pc != addr)
 479     {
 480       /* In this case, assume we have a code symbol instead of
 481          a data symbol.  */
 482       type = mst_text;
 483       section = NULL;
 484       addr = pc;
 485     }
 486
 487   if (overlay_debugging)
 488     addr = symbol_overlayed_address (addr, section);
 489
 490   write_exp_elt_opcode (OP_LONG);
 491   /* Let's make the type big enough to hold a 64-bit address.  */
 492   write_exp_elt_type (builtin_type (gdbarch)->builtin_core_addr);
 493   write_exp_elt_longcst ((LONGEST) addr);
 494   write_exp_elt_opcode (OP_LONG);
 495
 496   if (section && section->the_bfd_section->flags & SEC_THREAD_LOCAL)
 497     {
 498       write_exp_elt_opcode (UNOP_MEMVAL_TLS);
 499       write_exp_elt_objfile (objfile);
 500       write_exp_elt_type (builtin_type (gdbarch)->nodebug_tls_symbol);
 501       write_exp_elt_opcode (UNOP_MEMVAL_TLS);
 502       return;
 503     }
 504
 505   write_exp_elt_opcode (UNOP_MEMVAL);
 506   switch (type)
 507     {
 508     case mst_text:
 509     case mst_file_text:
 510     case mst_solib_trampoline:
 511       write_exp_elt_type (builtin_type (gdbarch)->nodebug_text_symbol);
 512       break;
 513
 514     case mst_data:
 515     case mst_file_data:
 516     case mst_bss:
 517     case mst_file_bss:
 518       write_exp_elt_type (builtin_type (gdbarch)->nodebug_data_symbol);
 519       break;
 520
 521     default:
 522       write_exp_elt_type (builtin_type (gdbarch)->nodebug_unknown_symbol);
 523       break;
 524     }
 525   write_exp_elt_opcode (UNOP_MEMVAL);
 526 }
 527
 528 /* Mark the current index as the starting location of a structure
 529    expression.  This is used when completing on field names.  */
 530
 531 void
 532 mark_struct_expression (void)
 533 {
 534   expout_last_struct = expout_ptr;
 535 }
 536
 537 \f
 538 /* Recognize tokens that start with '$'.  These include:
 539
 540    $regname     A native register name or a "standard
 541    register name".
 542
 543    $variable    A convenience variable with a name chosen
 544    by the user.
 545
 546    $digits              Value history with index <digits>, starting
 547    from the first value which has index 1.
 548
 549    $$digits     Value history with index <digits> relative
 550    to the last value.  I.E. $$0 is the last
 551    value, $$1 is the one previous to that, $$2
 552    is the one previous to $$1, etc.
 553
 554    $ | $0 | $$0 The last value in the value history.
 555
 556    $$           An abbreviation for the second to the last
 557    value in the value history, I.E. $$1
 558
 559  */
 560
 561 void
 562 write_dollar_variable (struct stoken str)
 563 {
 564   struct symbol *sym = NULL;
 565   struct minimal_symbol *msym = NULL;
 566   struct internalvar *isym = NULL;
 567
 568   /* Handle the tokens $digits; also $ (short for $0) and $$ (short for $$1)
 569      and $$digits (equivalent to $<-digits> if you could type that). */
 570
 571   int negate = 0;
 572   int i = 1;
 573   /* Double dollar means negate the number and add -1 as well.
 574      Thus $$ alone means -1.  */
 575   if (str.length >= 2 && str.ptr[1] == '$')
 576     {
 577       negate = 1;
 578       i = 2;
 579     }
 580   if (i == str.length)
 581     {
 582       /* Just dollars (one or two) */
 583       i = -negate;
 584       goto handle_last;
 585     }
 586   /* Is the rest of the token digits?  */
 587   for (; i < str.length; i++)
 588     if (!(str.ptr[i] >= '0' && str.ptr[i] <= '9'))
 589       break;
 590   if (i == str.length)
 591     {
 592       i = atoi (str.ptr + 1 + negate);
 593       if (negate)
 594         i = -i;
 595       goto handle_last;
 596     }
 597
 598   /* Handle tokens that refer to machine registers:
 599      $ followed by a register name.  */
 600   i = user_reg_map_name_to_regnum (current_gdbarch,
 601                                    str.ptr + 1, str.length - 1);
 602   if (i >= 0)
 603     goto handle_register;
 604
 605   /* Any names starting with $ are probably debugger internal variables.  */
 606
 607   isym = lookup_only_internalvar (copy_name (str) + 1);
 608   if (isym)
 609     {
 610       write_exp_elt_opcode (OP_INTERNALVAR);
 611       write_exp_elt_intern (isym);
 612       write_exp_elt_opcode (OP_INTERNALVAR);
 613       return;
 614     }
 615
 616   /* On some systems, such as HP-UX and hppa-linux, certain system routines
 617      have names beginning with $ or $$.  Check for those, first. */
 618
 619   sym = lookup_symbol (copy_name (str), (struct block *) NULL,
 620                        VAR_DOMAIN, (int *) NULL);
 621   if (sym)
 622     {
 623       write_exp_elt_opcode (OP_VAR_VALUE);
 624       write_exp_elt_block (block_found);        /* set by lookup_symbol */
 625       write_exp_elt_sym (sym);
 626       write_exp_elt_opcode (OP_VAR_VALUE);
 627       return;
 628     }
 629   msym = lookup_minimal_symbol (copy_name (str), NULL, NULL);
 630   if (msym)
 631     {
 632       write_exp_msymbol (msym);
 633       return;
 634     }
 635
 636   /* Any other names are assumed to be debugger internal variables.  */
 637
 638   write_exp_elt_opcode (OP_INTERNALVAR);
 639   write_exp_elt_intern (create_internalvar (copy_name (str) + 1));
 640   write_exp_elt_opcode (OP_INTERNALVAR);
 641   return;
 642 handle_last:
 643   write_exp_elt_opcode (OP_LAST);
 644   write_exp_elt_longcst ((LONGEST) i);
 645   write_exp_elt_opcode (OP_LAST);
 646   return;
 647 handle_register:
 648   write_exp_elt_opcode (OP_REGISTER);
 649   str.length--;
 650   str.ptr++;
 651   write_exp_string (str);
 652   write_exp_elt_opcode (OP_REGISTER);
 653   return;
 654 }
 655
 656
 657 char *
 658 find_template_name_end (char *p)
 659 {
 660   int depth = 1;
 661   int just_seen_right = 0;
 662   int just_seen_colon = 0;
 663   int just_seen_space = 0;
 664
 665   if (!p || (*p != '<'))
 666     return 0;
 667
 668   while (*++p)
 669     {
 670       switch (*p)
 671         {
 672         case '\'':
 673         case '\"':
 674         case '{':
 675         case '}':
 676           /* In future, may want to allow these?? */
 677           return 0;
 678         case '<':
 679           depth++;              /* start nested template */
 680           if (just_seen_colon || just_seen_right || just_seen_space)
 681             return 0;           /* but not after : or :: or > or space */
 682           break;
 683         case '>':
 684           if (just_seen_colon || just_seen_right)
 685             return 0;           /* end a (nested?) template */
 686           just_seen_right = 1;  /* but not after : or :: */
 687           if (--depth == 0)     /* also disallow >>, insist on > > */
 688             return ++p;         /* if outermost ended, return */
 689           break;
 690         case ':':
 691           if (just_seen_space || (just_seen_colon > 1))
 692             return 0;           /* nested class spec coming up */
 693           just_seen_colon++;    /* we allow :: but not :::: */
 694           break;
 695         case ' ':
 696           break;
 697         default:
 698           if (!((*p >= 'a' && *p <= 'z') ||     /* allow token chars */
 699                 (*p >= 'A' && *p <= 'Z') ||
 700                 (*p >= '0' && *p <= '9') ||
 701                 (*p == '_') || (*p == ',') ||   /* commas for template args */
 702                 (*p == '&') || (*p == '*') ||   /* pointer and ref types */
 703                 (*p == '(') || (*p == ')') ||   /* function types */
 704                 (*p == '[') || (*p == ']')))    /* array types */
 705             return 0;
 706         }
 707       if (*p != ' ')
 708         just_seen_space = 0;
 709       if (*p != ':')
 710         just_seen_colon = 0;
 711       if (*p != '>')
 712         just_seen_right = 0;
 713     }
 714   return 0;
 715 }
 716 \f
 717
 718
 719 /* Return a null-terminated temporary copy of the name
 720    of a string token.  */
 721
 722 char *
 723 copy_name (struct stoken token)
 724 {
 725   /* Make sure there's enough space for the token.  */
 726   if (namecopy_size < token.length + 1)
 727     {
 728       namecopy_size = token.length + 1;
 729       namecopy = xrealloc (namecopy, token.length + 1);
 730     }
 731
 732   memcpy (namecopy, token.ptr, token.length);
 733   namecopy[token.length] = 0;
 734
 735   return namecopy;
 736 }
 737 \f
 738 /* Reverse an expression from suffix form (in which it is constructed)
 739    to prefix form (in which we can conveniently print or execute it).
 740    Ordinarily this always returns -1.  However, if EXPOUT_LAST_STRUCT
 741    is not -1 (i.e., we are trying to complete a field name), it will
 742    return the index of the subexpression which is the left-hand-side
 743    of the struct operation at EXPOUT_LAST_STRUCT.  */
 744
 745 static int
 746 prefixify_expression (struct expression *expr)
 747 {
 748   int len = sizeof (struct expression) + EXP_ELEM_TO_BYTES (expr->nelts);
 749   struct expression *temp;
 750   int inpos = expr->nelts, outpos = 0;
 751
 752   temp = (struct expression *) alloca (len);
 753
 754   /* Copy the original expression into temp.  */
 755   memcpy (temp, expr, len);
 756
 757   return prefixify_subexp (temp, expr, inpos, outpos);
 758 }
 759
 760 /* Return the number of exp_elements in the postfix subexpression
 761    of EXPR whose operator is at index ENDPOS - 1 in EXPR.  */
 762
 763 int
 764 length_of_subexp (struct expression *expr, int endpos)
 765 {
 766   int oplen, args, i;
 767
 768   operator_length (expr, endpos, &oplen, &args);
 769
 770   while (args > 0)
 771     {
 772       oplen += length_of_subexp (expr, endpos - oplen);
 773       args--;
 774     }
 775
 776   return oplen;
 777 }
 778
 779 /* Sets *OPLENP to the length of the operator whose (last) index is
 780    ENDPOS - 1 in EXPR, and sets *ARGSP to the number of arguments that
 781    operator takes.  */
 782
 783 void
 784 operator_length (struct expression *expr, int endpos, int *oplenp, int *argsp)
 785 {
 786   expr->language_defn->la_exp_desc->operator_length (expr, endpos,
 787                                                      oplenp, argsp);
 788 }
 789
 790 /* Default value for operator_length in exp_descriptor vectors.  */
 791
 792 void
 793 operator_length_standard (struct expression *expr, int endpos,
 794                           int *oplenp, int *argsp)
 795 {
 796   int oplen = 1;
 797   int args = 0;
 798   enum f90_range_type range_type;
 799   int i;
 800
 801   if (endpos < 1)
 802     error (_("?error in operator_length_standard"));
 803
 804   i = (int) expr->elts[endpos - 1].opcode;
 805
 806   switch (i)
 807     {
 808       /* C++  */
 809     case OP_SCOPE:
 810       oplen = longest_to_int (expr->elts[endpos - 2].longconst);
 811       oplen = 5 + BYTES_TO_EXP_ELEM (oplen + 1);
 812       break;
 813
 814     case OP_LONG:
 815     case OP_DOUBLE:
 816     case OP_DECFLOAT:
 817     case OP_VAR_VALUE:
 818       oplen = 4;
 819       break;
 820
 821     case OP_TYPE:
 822     case OP_BOOL:
 823     case OP_LAST:
 824     case OP_INTERNALVAR:
 825       oplen = 3;
 826       break;
 827
 828     case OP_COMPLEX:
 829       oplen = 3;
 830       args = 2;
 831       break;
 832
 833     case OP_FUNCALL:
 834     case OP_F77_UNDETERMINED_ARGLIST:
 835       oplen = 3;
 836       args = 1 + longest_to_int (expr->elts[endpos - 2].longconst);
 837       break;
 838
 839     case OP_OBJC_MSGCALL:       /* Objective C message (method) call */
 840       oplen = 4;
 841       args = 1 + longest_to_int (expr->elts[endpos - 2].longconst);
 842       break;
 843
 844     case UNOP_MAX:
 845     case UNOP_MIN:
 846       oplen = 3;
 847       break;
 848
 849     case BINOP_VAL:
 850     case UNOP_CAST:
 851     case UNOP_MEMVAL:
 852       oplen = 3;
 853       args = 1;
 854       break;
 855
 856     case UNOP_MEMVAL_TLS:
 857       oplen = 4;
 858       args = 1;
 859       break;
 860
 861     case UNOP_ABS:
 862     case UNOP_CAP:
 863     case UNOP_CHR:
 864     case UNOP_FLOAT:
 865     case UNOP_HIGH:
 866     case UNOP_ODD:
 867     case UNOP_ORD:
 868     case UNOP_TRUNC:
 869       oplen = 1;
 870       args = 1;
 871       break;
 872
 873     case OP_LABELED:
 874     case STRUCTOP_STRUCT:
 875     case STRUCTOP_PTR:
 876       args = 1;
 877       /* fall through */
 878     case OP_REGISTER:
 879     case OP_M2_STRING:
 880     case OP_STRING:
 881     case OP_OBJC_NSSTRING:      /* Objective C Foundation Class NSString constant */
 882     case OP_OBJC_SELECTOR:      /* Objective C "@selector" pseudo-op */
 883     case OP_NAME:
 884       oplen = longest_to_int (expr->elts[endpos - 2].longconst);
 885       oplen = 4 + BYTES_TO_EXP_ELEM (oplen + 1);
 886       break;
 887
 888     case OP_BITSTRING:
 889       oplen = longest_to_int (expr->elts[endpos - 2].longconst);
 890       oplen = (oplen + HOST_CHAR_BIT - 1) / HOST_CHAR_BIT;
 891       oplen = 4 + BYTES_TO_EXP_ELEM (oplen);
 892       break;
 893
 894     case OP_ARRAY:
 895       oplen = 4;
 896       args = longest_to_int (expr->elts[endpos - 2].longconst);
 897       args -= longest_to_int (expr->elts[endpos - 3].longconst);
 898       args += 1;
 899       break;
 900
 901     case TERNOP_COND:
 902     case TERNOP_SLICE:
 903     case TERNOP_SLICE_COUNT:
 904       args = 3;
 905       break;
 906
 907       /* Modula-2 */
 908     case MULTI_SUBSCRIPT:
 909       oplen = 3;
 910       args = 1 + longest_to_int (expr->elts[endpos - 2].longconst);
 911       break;
 912
 913     case BINOP_ASSIGN_MODIFY:
 914       oplen = 3;
 915       args = 2;
 916       break;
 917
 918       /* C++ */
 919     case OP_THIS:
 920     case OP_OBJC_SELF:
 921       oplen = 2;
 922       break;
 923
 924     case OP_F90_RANGE:
 925       oplen = 3;
 926
 927       range_type = longest_to_int (expr->elts[endpos - 2].longconst);
 928       switch (range_type)
 929         {
 930         case LOW_BOUND_DEFAULT:
 931         case HIGH_BOUND_DEFAULT:
 932           args = 1;
 933           break;
 934         case BOTH_BOUND_DEFAULT:
 935           args = 0;
 936           break;
 937         case NONE_BOUND_DEFAULT:
 938           args = 2;
 939           break;
 940         }
 941
 942       break;
 943
 944     default:
 945       args = 1 + (i < (int) BINOP_END);
 946     }
 947
 948   *oplenp = oplen;
 949   *argsp = args;
 950 }
 951
 952 /* Copy the subexpression ending just before index INEND in INEXPR
 953    into OUTEXPR, starting at index OUTBEG.
 954    In the process, convert it from suffix to prefix form.
 955    If EXPOUT_LAST_STRUCT is -1, then this function always returns -1.
 956    Otherwise, it returns the index of the subexpression which is the
 957    left-hand-side of the expression at EXPOUT_LAST_STRUCT.  */
 958
 959 static int
 960 prefixify_subexp (struct expression *inexpr,
 961                   struct expression *outexpr, int inend, int outbeg)
 962 {
 963   int oplen;
 964   int args;
 965   int i;
 966   int *arglens;
 967   enum exp_opcode opcode;
 968   int result = -1;
 969
 970   operator_length (inexpr, inend, &oplen, &args);
 971
 972   /* Copy the final operator itself, from the end of the input
 973      to the beginning of the output.  */
 974   inend -= oplen;
 975   memcpy (&outexpr->elts[outbeg], &inexpr->elts[inend],
 976           EXP_ELEM_TO_BYTES (oplen));
 977   outbeg += oplen;
 978
 979   if (expout_last_struct == inend)
 980     result = outbeg - oplen;
 981
 982   /* Find the lengths of the arg subexpressions.  */
 983   arglens = (int *) alloca (args * sizeof (int));
 984   for (i = args - 1; i >= 0; i--)
 985     {
 986       oplen = length_of_subexp (inexpr, inend);
 987       arglens[i] = oplen;
 988       inend -= oplen;
 989     }
 990
 991   /* Now copy each subexpression, preserving the order of
 992      the subexpressions, but prefixifying each one.
 993      In this loop, inend starts at the beginning of
 994      the expression this level is working on
 995      and marches forward over the arguments.
 996      outbeg does similarly in the output.  */
 997   for (i = 0; i < args; i++)
 998     {
 999       int r;
1000       oplen = arglens[i];
1001       inend += oplen;
1002       r = prefixify_subexp (inexpr, outexpr, inend, outbeg);
1003       if (r != -1)
1004         {
1005           /* Return immediately.  We probably have only parsed a
1006              partial expression, so we don't want to try to reverse
1007              the other operands.  */
1008           return r;
1009         }
1010       outbeg += oplen;
1011     }
1012
1013   return result;
1014 }
1015 \f
1016 /* This page contains the two entry points to this file.  */
1017
1018 /* Read an expression from the string *STRINGPTR points to,
1019    parse it, and return a pointer to a  struct expression  that we malloc.
1020    Use block BLOCK as the lexical context for variable names;
1021    if BLOCK is zero, use the block of the selected stack frame.
1022    Meanwhile, advance *STRINGPTR to point after the expression,
1023    at the first nonwhite character that is not part of the expression
1024    (possibly a null character).
1025
1026    If COMMA is nonzero, stop if a comma is reached.  */
1027
1028 struct expression *
1029 parse_exp_1 (char **stringptr, struct block *block, int comma)
1030 {
1031   return parse_exp_in_context (stringptr, block, comma, 0, NULL);
1032 }
1033
1034 /* As for parse_exp_1, except that if VOID_CONTEXT_P, then
1035    no value is expected from the expression.
1036    OUT_SUBEXP is set when attempting to complete a field name; in this
1037    case it is set to the index of the subexpression on the
1038    left-hand-side of the struct op.  If not doing such completion, it
1039    is left untouched.  */
1040
1041 static struct expression *
1042 parse_exp_in_context (char **stringptr, struct block *block, int comma,
1043                       int void_context_p, int *out_subexp)
1044 {
1045   volatile struct gdb_exception except;
1046   struct cleanup *old_chain;
1047   int subexp;
1048
1049   lexptr = *stringptr;
1050   prev_lexptr = NULL;
1051
1052   paren_depth = 0;
1053   type_stack_depth = 0;
1054   expout_last_struct = -1;
1055
1056   comma_terminates = comma;
1057
1058   if (lexptr == 0 || *lexptr == 0)
1059     error_no_arg (_("expression to compute"));
1060
1061   old_chain = make_cleanup (free_funcalls, 0 /*ignore*/);
1062   funcall_chain = 0;
1063
1064   expression_context_block = block;
1065
1066   /* If no context specified, try using the current frame, if any.  */
1067   if (!expression_context_block)
1068     expression_context_block = get_selected_block (&expression_context_pc);
1069   else
1070     expression_context_pc = BLOCK_START (expression_context_block);
1071
1072   /* Fall back to using the current source static context, if any.  */
1073
1074   if (!expression_context_block)
1075     {
1076       struct symtab_and_line cursal = get_current_source_symtab_and_line ();
1077       if (cursal.symtab)
1078         expression_context_block
1079           = BLOCKVECTOR_BLOCK (BLOCKVECTOR (cursal.symtab), STATIC_BLOCK);
1080       if (expression_context_block)
1081         expression_context_pc = BLOCK_START (expression_context_block);
1082     }
1083
1084   expout_size = 10;
1085   expout_ptr = 0;
1086   expout = (struct expression *)
1087     xmalloc (sizeof (struct expression) + EXP_ELEM_TO_BYTES (expout_size));
1088   expout->language_defn = current_language;
1089   expout->gdbarch = current_gdbarch;
1090
1091   TRY_CATCH (except, RETURN_MASK_ALL)
1092     {
1093       if (current_language->la_parser ())
1094         current_language->la_error (NULL);
1095     }
1096   if (except.reason < 0)
1097     {
1098       if (! in_parse_field)
1099         {
1100           xfree (expout);
1101           throw_exception (except);
1102         }
1103     }
1104
1105   discard_cleanups (old_chain);
1106
1107   /* Record the actual number of expression elements, and then
1108      reallocate the expression memory so that we free up any
1109      excess elements. */
1110
1111   expout->nelts = expout_ptr;
1112   expout = (struct expression *)
1113     xrealloc ((char *) expout,
1114               sizeof (struct expression) + EXP_ELEM_TO_BYTES (expout_ptr));;
1115
1116   /* Convert expression from postfix form as generated by yacc
1117      parser, to a prefix form. */
1118
1119   if (expressiondebug)
1120     dump_raw_expression (expout, gdb_stdlog,
1121                          "before conversion to prefix form");
1122
1123   subexp = prefixify_expression (expout);
1124   if (out_subexp)
1125     *out_subexp = subexp;
1126
1127   current_language->la_post_parser (&expout, void_context_p);
1128
1129   if (expressiondebug)
1130     dump_prefix_expression (expout, gdb_stdlog);
1131
1132   *stringptr = lexptr;
1133   return expout;
1134 }
1135
1136 /* Parse STRING as an expression, and complain if this fails
1137    to use up all of the contents of STRING.  */
1138
1139 struct expression *
1140 parse_expression (char *string)
1141 {
1142   struct expression *exp;
1143   exp = parse_exp_1 (&string, 0, 0);
1144   if (*string)
1145     error (_("Junk after end of expression."));
1146   return exp;
1147 }
1148
1149 /* Parse STRING as an expression.  If parsing ends in the middle of a
1150    field reference, return the type of the left-hand-side of the
1151    reference; furthermore, if the parsing ends in the field name,
1152    return the field name in *NAME.  In all other cases, return NULL.
1153    Returned non-NULL *NAME must be freed by the caller.  */
1154
1155 struct type *
1156 parse_field_expression (char *string, char **name)
1157 {
1158   struct expression *exp = NULL;
1159   struct value *val;
1160   int subexp;
1161   volatile struct gdb_exception except;
1162
1163   TRY_CATCH (except, RETURN_MASK_ALL)
1164     {
1165       in_parse_field = 1;
1166       exp = parse_exp_in_context (&string, 0, 0, 0, &subexp);
1167     }
1168   in_parse_field = 0;
1169   if (except.reason < 0 || ! exp)
1170     return NULL;
1171   if (expout_last_struct == -1)
1172     {
1173       xfree (exp);
1174       return NULL;
1175     }
1176
1177   *name = extract_field_op (exp, &subexp);
1178   if (!*name)
1179     {
1180       xfree (exp);
1181       return NULL;
1182     }
1183   /* (*NAME) is a part of the EXP memory block freed below.  */
1184   *name = xstrdup (*name);
1185
1186   val = evaluate_subexpression_type (exp, subexp);
1187   xfree (exp);
1188
1189   return value_type (val);
1190 }
1191
1192 /* A post-parser that does nothing */
1193
1194 void
1195 null_post_parser (struct expression **exp, int void_context_p)
1196 {
1197 }
1198 \f
1199 /* Stuff for maintaining a stack of types.  Currently just used by C, but
1200    probably useful for any language which declares its types "backwards".  */
1201
1202 static void
1203 check_type_stack_depth (void)
1204 {
1205   if (type_stack_depth == type_stack_size)
1206     {
1207       type_stack_size *= 2;
1208       type_stack = (union type_stack_elt *)
1209         xrealloc ((char *) type_stack, type_stack_size * sizeof (*type_stack));
1210     }
1211 }
1212
1213 void
1214 push_type (enum type_pieces tp)
1215 {
1216   check_type_stack_depth ();
1217   type_stack[type_stack_depth++].piece = tp;
1218 }
1219
1220 void
1221 push_type_int (int n)
1222 {
1223   check_type_stack_depth ();
1224   type_stack[type_stack_depth++].int_val = n;
1225 }
1226
1227 void
1228 push_type_address_space (char *string)
1229 {
1230   push_type_int (address_space_name_to_int (string));
1231 }
1232
1233 enum type_pieces
1234 pop_type (void)
1235 {
1236   if (type_stack_depth)
1237     return type_stack[--type_stack_depth].piece;
1238   return tp_end;
1239 }
1240
1241 int
1242 pop_type_int (void)
1243 {
1244   if (type_stack_depth)
1245     return type_stack[--type_stack_depth].int_val;
1246   /* "Can't happen".  */
1247   return 0;
1248 }
1249
1250 /* Pop the type stack and return the type which corresponds to FOLLOW_TYPE
1251    as modified by all the stuff on the stack.  */
1252 struct type *
1253 follow_types (struct type *follow_type)
1254 {
1255   int done = 0;
1256   int make_const = 0;
1257   int make_volatile = 0;
1258   int make_addr_space = 0;
1259   int array_size;
1260   struct type *range_type;
1261
1262   while (!done)
1263     switch (pop_type ())
1264       {
1265       case tp_end:
1266         done = 1;
1267         if (make_const)
1268           follow_type = make_cv_type (make_const,
1269                                       TYPE_VOLATILE (follow_type),
1270                                       follow_type, 0);
1271         if (make_volatile)
1272           follow_type = make_cv_type (TYPE_CONST (follow_type),
1273                                       make_volatile,
1274                                       follow_type, 0);
1275         if (make_addr_space)
1276           follow_type = make_type_with_address_space (follow_type,
1277                                                       make_addr_space);
1278         make_const = make_volatile = 0;
1279         make_addr_space = 0;
1280         break;
1281       case tp_const:
1282         make_const = 1;
1283         break;
1284       case tp_volatile:
1285         make_volatile = 1;
1286         break;
1287       case tp_space_identifier:
1288         make_addr_space = pop_type_int ();
1289         break;
1290       case tp_pointer:
1291         follow_type = lookup_pointer_type (follow_type);
1292         if (make_const)
1293           follow_type = make_cv_type (make_const,
1294                                       TYPE_VOLATILE (follow_type),
1295                                       follow_type, 0);
1296         if (make_volatile)
1297           follow_type = make_cv_type (TYPE_CONST (follow_type),
1298                                       make_volatile,
1299                                       follow_type, 0);
1300         if (make_addr_space)
1301           follow_type = make_type_with_address_space (follow_type,
1302                                                       make_addr_space);
1303         make_const = make_volatile = 0;
1304         make_addr_space = 0;
1305         break;
1306       case tp_reference:
1307         follow_type = lookup_reference_type (follow_type);
1308         if (make_const)
1309           follow_type = make_cv_type (make_const,
1310                                       TYPE_VOLATILE (follow_type),
1311                                       follow_type, 0);
1312         if (make_volatile)
1313           follow_type = make_cv_type (TYPE_CONST (follow_type),
1314                                       make_volatile,
1315                                       follow_type, 0);
1316         if (make_addr_space)
1317           follow_type = make_type_with_address_space (follow_type,
1318                                                       make_addr_space);
1319         make_const = make_volatile = 0;
1320         make_addr_space = 0;
1321         break;
1322       case tp_array:
1323         array_size = pop_type_int ();
1324         /* FIXME-type-allocation: need a way to free this type when we are
1325            done with it.  */
1326         range_type =
1327           create_range_type ((struct type *) NULL,
1328                              builtin_type_int32, 0,
1329                              array_size >= 0 ? array_size - 1 : 0);
1330         follow_type =
1331           create_array_type ((struct type *) NULL,
1332                              follow_type, range_type);
1333         if (array_size < 0)
1334           TYPE_ARRAY_UPPER_BOUND_IS_UNDEFINED (follow_type) = 1;
1335         break;
1336       case tp_function:
1337         /* FIXME-type-allocation: need a way to free this type when we are
1338            done with it.  */
1339         follow_type = lookup_function_type (follow_type);
1340         break;
1341       }
1342   return follow_type;
1343 }
1344 \f
1345 /* This function avoids direct calls to fprintf
1346    in the parser generated debug code.  */
1347 void
1348 parser_fprintf (FILE *x, const char *y, ...)
1349 {
1350   va_list args;
1351   va_start (args, y);
1352   if (x == stderr)
1353     vfprintf_unfiltered (gdb_stderr, y, args);
1354   else
1355     {
1356       fprintf_unfiltered (gdb_stderr, " Unknown FILE used.\n");
1357       vfprintf_unfiltered (gdb_stderr, y, args);
1358     }
1359   va_end (args);
1360 }
1361
1362 void
1363 _initialize_parse (void)
1364 {
1365   type_stack_size = 80;
1366   type_stack_depth = 0;
1367   type_stack = (union type_stack_elt *)
1368     xmalloc (type_stack_size * sizeof (*type_stack));
1369
1370   add_setshow_zinteger_cmd ("expression", class_maintenance,
1371                             &expressiondebug, _("\
1372 Set expression debugging."), _("\
1373 Show expression debugging."), _("\
1374 When non-zero, the internal representation of expressions will be printed."),
1375                             NULL,
1376                             show_expressiondebug,
1377                             &setdebuglist, &showdebuglist);
1378 }