Make copy_name return std::string
[external/binutils.git] / gdb / parse.c
1 /* Parse expressions for GDB.
2
3    Copyright (C) 1986-2019 Free Software Foundation, Inc.
4
5    Modified from expread.y by the Department of Computer Science at the
6    State University of New York at Buffalo, 1991.
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 /* Parse an expression from text in a string,
24    and return the result as a struct expression pointer.
25    That structure contains arithmetic operations in reverse polish,
26    with constants represented by operations that are followed by special data.
27    See expression.h for the details of the format.
28    What is important here is that it can be built up sequentially
29    during the process of parsing; the lower levels of the tree always
30    come first in the result.  */
31
32 #include "defs.h"
33 #include <ctype.h>
34 #include "arch-utils.h"
35 #include "symtab.h"
36 #include "gdbtypes.h"
37 #include "frame.h"
38 #include "expression.h"
39 #include "value.h"
40 #include "command.h"
41 #include "language.h"
42 #include "f-lang.h"
43 #include "parser-defs.h"
44 #include "gdbcmd.h"
45 #include "symfile.h"            /* for overlay functions */
46 #include "inferior.h"
47 #include "target-float.h"
48 #include "block.h"
49 #include "source.h"
50 #include "objfiles.h"
51 #include "user-regs.h"
52 #include <algorithm>
53 #include "common/gdb_optional.h"
54
55 /* Standard set of definitions for printing, dumping, prefixifying,
56  * and evaluating expressions.  */
57
58 const struct exp_descriptor exp_descriptor_standard = 
59   {
60     print_subexp_standard,
61     operator_length_standard,
62     operator_check_standard,
63     op_name_standard,
64     dump_subexp_body_standard,
65     evaluate_subexp_standard
66   };
67 \f
68 static unsigned int expressiondebug = 0;
69 static void
70 show_expressiondebug (struct ui_file *file, int from_tty,
71                       struct cmd_list_element *c, const char *value)
72 {
73   fprintf_filtered (file, _("Expression debugging is %s.\n"), value);
74 }
75
76
77 /* Non-zero if an expression parser should set yydebug.  */
78 int parser_debug;
79
80 static void
81 show_parserdebug (struct ui_file *file, int from_tty,
82                   struct cmd_list_element *c, const char *value)
83 {
84   fprintf_filtered (file, _("Parser debugging is %s.\n"), value);
85 }
86
87
88 static int prefixify_subexp (struct expression *, struct expression *, int,
89                              int, int);
90
91 static expression_up parse_exp_in_context (const char **, CORE_ADDR,
92                                            const struct block *, int,
93                                            int, int *,
94                                            innermost_block_tracker *,
95                                            expr_completion_state *);
96
97 static void increase_expout_size (struct expr_builder *ps, size_t lenelt);
98
99
100 /* Documented at it's declaration.  */
101
102 void
103 innermost_block_tracker::update (const struct block *b,
104                                  innermost_block_tracker_types t)
105 {
106   if ((m_types & t) != 0
107       && (m_innermost_block == NULL
108           || contained_in (b, m_innermost_block)))
109     m_innermost_block = b;
110 }
111
112 \f
113
114 /* See definition in parser-defs.h.  */
115
116 expr_builder::expr_builder (const struct language_defn *lang,
117                             struct gdbarch *gdbarch)
118   : expout_size (10),
119     expout (XNEWVAR (expression,
120                      (sizeof (expression)
121                       + EXP_ELEM_TO_BYTES (expout_size)))),
122     expout_ptr (0)
123 {
124   expout->language_defn = lang;
125   expout->gdbarch = gdbarch;
126 }
127
128 expression_up
129 expr_builder::release ()
130 {
131   /* Record the actual number of expression elements, and then
132      reallocate the expression memory so that we free up any
133      excess elements.  */
134
135   expout->nelts = expout_ptr;
136   expout.reset (XRESIZEVAR (expression, expout.release (),
137                             (sizeof (expression)
138                              + EXP_ELEM_TO_BYTES (expout_ptr))));
139
140   return std::move (expout);
141 }
142
143 /* This page contains the functions for adding data to the struct expression
144    being constructed.  */
145
146 /* Add one element to the end of the expression.  */
147
148 /* To avoid a bug in the Sun 4 compiler, we pass things that can fit into
149    a register through here.  */
150
151 static void
152 write_exp_elt (struct expr_builder *ps, const union exp_element *expelt)
153 {
154   if (ps->expout_ptr >= ps->expout_size)
155     {
156       ps->expout_size *= 2;
157       ps->expout.reset (XRESIZEVAR (expression, ps->expout.release (),
158                                     (sizeof (expression)
159                                      + EXP_ELEM_TO_BYTES (ps->expout_size))));
160     }
161   ps->expout->elts[ps->expout_ptr++] = *expelt;
162 }
163
164 void
165 write_exp_elt_opcode (struct expr_builder *ps, enum exp_opcode expelt)
166 {
167   union exp_element tmp;
168
169   memset (&tmp, 0, sizeof (union exp_element));
170   tmp.opcode = expelt;
171   write_exp_elt (ps, &tmp);
172 }
173
174 void
175 write_exp_elt_sym (struct expr_builder *ps, struct symbol *expelt)
176 {
177   union exp_element tmp;
178
179   memset (&tmp, 0, sizeof (union exp_element));
180   tmp.symbol = expelt;
181   write_exp_elt (ps, &tmp);
182 }
183
184 void
185 write_exp_elt_msym (struct expr_builder *ps, minimal_symbol *expelt)
186 {
187   union exp_element tmp;
188
189   memset (&tmp, 0, sizeof (union exp_element));
190   tmp.msymbol = expelt;
191   write_exp_elt (ps, &tmp);
192 }
193
194 void
195 write_exp_elt_block (struct expr_builder *ps, const struct block *b)
196 {
197   union exp_element tmp;
198
199   memset (&tmp, 0, sizeof (union exp_element));
200   tmp.block = b;
201   write_exp_elt (ps, &tmp);
202 }
203
204 void
205 write_exp_elt_objfile (struct expr_builder *ps, struct objfile *objfile)
206 {
207   union exp_element tmp;
208
209   memset (&tmp, 0, sizeof (union exp_element));
210   tmp.objfile = objfile;
211   write_exp_elt (ps, &tmp);
212 }
213
214 void
215 write_exp_elt_longcst (struct expr_builder *ps, LONGEST expelt)
216 {
217   union exp_element tmp;
218
219   memset (&tmp, 0, sizeof (union exp_element));
220   tmp.longconst = expelt;
221   write_exp_elt (ps, &tmp);
222 }
223
224 void
225 write_exp_elt_floatcst (struct expr_builder *ps, const gdb_byte expelt[16])
226 {
227   union exp_element tmp;
228   int index;
229
230   for (index = 0; index < 16; index++)
231     tmp.floatconst[index] = expelt[index];
232
233   write_exp_elt (ps, &tmp);
234 }
235
236 void
237 write_exp_elt_type (struct expr_builder *ps, struct type *expelt)
238 {
239   union exp_element tmp;
240
241   memset (&tmp, 0, sizeof (union exp_element));
242   tmp.type = expelt;
243   write_exp_elt (ps, &tmp);
244 }
245
246 void
247 write_exp_elt_intern (struct expr_builder *ps, struct internalvar *expelt)
248 {
249   union exp_element tmp;
250
251   memset (&tmp, 0, sizeof (union exp_element));
252   tmp.internalvar = expelt;
253   write_exp_elt (ps, &tmp);
254 }
255
256 /* Add a string constant to the end of the expression.
257
258    String constants are stored by first writing an expression element
259    that contains the length of the string, then stuffing the string
260    constant itself into however many expression elements are needed
261    to hold it, and then writing another expression element that contains
262    the length of the string.  I.e. an expression element at each end of
263    the string records the string length, so you can skip over the 
264    expression elements containing the actual string bytes from either
265    end of the string.  Note that this also allows gdb to handle
266    strings with embedded null bytes, as is required for some languages.
267
268    Don't be fooled by the fact that the string is null byte terminated,
269    this is strictly for the convenience of debugging gdb itself.
270    Gdb does not depend up the string being null terminated, since the
271    actual length is recorded in expression elements at each end of the
272    string.  The null byte is taken into consideration when computing how
273    many expression elements are required to hold the string constant, of
274    course.  */
275
276
277 void
278 write_exp_string (struct expr_builder *ps, struct stoken str)
279 {
280   int len = str.length;
281   size_t lenelt;
282   char *strdata;
283
284   /* Compute the number of expression elements required to hold the string
285      (including a null byte terminator), along with one expression element
286      at each end to record the actual string length (not including the
287      null byte terminator).  */
288
289   lenelt = 2 + BYTES_TO_EXP_ELEM (len + 1);
290
291   increase_expout_size (ps, lenelt);
292
293   /* Write the leading length expression element (which advances the current
294      expression element index), then write the string constant followed by a
295      terminating null byte, and then write the trailing length expression
296      element.  */
297
298   write_exp_elt_longcst (ps, (LONGEST) len);
299   strdata = (char *) &ps->expout->elts[ps->expout_ptr];
300   memcpy (strdata, str.ptr, len);
301   *(strdata + len) = '\0';
302   ps->expout_ptr += lenelt - 2;
303   write_exp_elt_longcst (ps, (LONGEST) len);
304 }
305
306 /* Add a vector of string constants to the end of the expression.
307
308    This adds an OP_STRING operation, but encodes the contents
309    differently from write_exp_string.  The language is expected to
310    handle evaluation of this expression itself.
311    
312    After the usual OP_STRING header, TYPE is written into the
313    expression as a long constant.  The interpretation of this field is
314    up to the language evaluator.
315    
316    Next, each string in VEC is written.  The length is written as a
317    long constant, followed by the contents of the string.  */
318
319 void
320 write_exp_string_vector (struct expr_builder *ps, int type,
321                          struct stoken_vector *vec)
322 {
323   int i, len;
324   size_t n_slots;
325
326   /* Compute the size.  We compute the size in number of slots to
327      avoid issues with string padding.  */
328   n_slots = 0;
329   for (i = 0; i < vec->len; ++i)
330     {
331       /* One slot for the length of this element, plus the number of
332          slots needed for this string.  */
333       n_slots += 1 + BYTES_TO_EXP_ELEM (vec->tokens[i].length);
334     }
335
336   /* One more slot for the type of the string.  */
337   ++n_slots;
338
339   /* Now compute a phony string length.  */
340   len = EXP_ELEM_TO_BYTES (n_slots) - 1;
341
342   n_slots += 4;
343   increase_expout_size (ps, n_slots);
344
345   write_exp_elt_opcode (ps, OP_STRING);
346   write_exp_elt_longcst (ps, len);
347   write_exp_elt_longcst (ps, type);
348
349   for (i = 0; i < vec->len; ++i)
350     {
351       write_exp_elt_longcst (ps, vec->tokens[i].length);
352       memcpy (&ps->expout->elts[ps->expout_ptr], vec->tokens[i].ptr,
353               vec->tokens[i].length);
354       ps->expout_ptr += BYTES_TO_EXP_ELEM (vec->tokens[i].length);
355     }
356
357   write_exp_elt_longcst (ps, len);
358   write_exp_elt_opcode (ps, OP_STRING);
359 }
360
361 /* Add a bitstring constant to the end of the expression.
362
363    Bitstring constants are stored by first writing an expression element
364    that contains the length of the bitstring (in bits), then stuffing the
365    bitstring constant itself into however many expression elements are
366    needed to hold it, and then writing another expression element that
367    contains the length of the bitstring.  I.e. an expression element at
368    each end of the bitstring records the bitstring length, so you can skip
369    over the expression elements containing the actual bitstring bytes from
370    either end of the bitstring.  */
371
372 void
373 write_exp_bitstring (struct expr_builder *ps, struct stoken str)
374 {
375   int bits = str.length;        /* length in bits */
376   int len = (bits + HOST_CHAR_BIT - 1) / HOST_CHAR_BIT;
377   size_t lenelt;
378   char *strdata;
379
380   /* Compute the number of expression elements required to hold the bitstring,
381      along with one expression element at each end to record the actual
382      bitstring length in bits.  */
383
384   lenelt = 2 + BYTES_TO_EXP_ELEM (len);
385
386   increase_expout_size (ps, lenelt);
387
388   /* Write the leading length expression element (which advances the current
389      expression element index), then write the bitstring constant, and then
390      write the trailing length expression element.  */
391
392   write_exp_elt_longcst (ps, (LONGEST) bits);
393   strdata = (char *) &ps->expout->elts[ps->expout_ptr];
394   memcpy (strdata, str.ptr, len);
395   ps->expout_ptr += lenelt - 2;
396   write_exp_elt_longcst (ps, (LONGEST) bits);
397 }
398
399 /* Return the type of MSYMBOL, a minimal symbol of OBJFILE.  If
400    ADDRESS_P is not NULL, set it to the MSYMBOL's resolved
401    address.  */
402
403 type *
404 find_minsym_type_and_address (minimal_symbol *msymbol,
405                               struct objfile *objfile,
406                               CORE_ADDR *address_p)
407 {
408   bound_minimal_symbol bound_msym = {msymbol, objfile};
409   struct obj_section *section = MSYMBOL_OBJ_SECTION (objfile, msymbol);
410   enum minimal_symbol_type type = MSYMBOL_TYPE (msymbol);
411
412   bool is_tls = (section != NULL
413                  && section->the_bfd_section->flags & SEC_THREAD_LOCAL);
414
415   /* The minimal symbol might point to a function descriptor;
416      resolve it to the actual code address instead.  */
417   CORE_ADDR addr;
418   if (is_tls)
419     {
420       /* Addresses of TLS symbols are really offsets into a
421          per-objfile/per-thread storage block.  */
422       addr = MSYMBOL_VALUE_RAW_ADDRESS (bound_msym.minsym);
423     }
424   else if (msymbol_is_function (objfile, msymbol, &addr))
425     {
426       if (addr != BMSYMBOL_VALUE_ADDRESS (bound_msym))
427         {
428           /* This means we resolved a function descriptor, and we now
429              have an address for a code/text symbol instead of a data
430              symbol.  */
431           if (MSYMBOL_TYPE (msymbol) == mst_data_gnu_ifunc)
432             type = mst_text_gnu_ifunc;
433           else
434             type = mst_text;
435           section = NULL;
436         }
437     }
438   else
439     addr = BMSYMBOL_VALUE_ADDRESS (bound_msym);
440
441   if (overlay_debugging)
442     addr = symbol_overlayed_address (addr, section);
443
444   if (is_tls)
445     {
446       /* Skip translation if caller does not need the address.  */
447       if (address_p != NULL)
448         *address_p = target_translate_tls_address (objfile, addr);
449       return objfile_type (objfile)->nodebug_tls_symbol;
450     }
451
452   if (address_p != NULL)
453     *address_p = addr;
454
455   switch (type)
456     {
457     case mst_text:
458     case mst_file_text:
459     case mst_solib_trampoline:
460       return objfile_type (objfile)->nodebug_text_symbol;
461
462     case mst_text_gnu_ifunc:
463       return objfile_type (objfile)->nodebug_text_gnu_ifunc_symbol;
464
465     case mst_data:
466     case mst_file_data:
467     case mst_bss:
468     case mst_file_bss:
469       return objfile_type (objfile)->nodebug_data_symbol;
470
471     case mst_slot_got_plt:
472       return objfile_type (objfile)->nodebug_got_plt_symbol;
473
474     default:
475       return objfile_type (objfile)->nodebug_unknown_symbol;
476     }
477 }
478
479 /* Add the appropriate elements for a minimal symbol to the end of
480    the expression.  */
481
482 void
483 write_exp_msymbol (struct expr_builder *ps,
484                    struct bound_minimal_symbol bound_msym)
485 {
486   write_exp_elt_opcode (ps, OP_VAR_MSYM_VALUE);
487   write_exp_elt_objfile (ps, bound_msym.objfile);
488   write_exp_elt_msym (ps, bound_msym.minsym);
489   write_exp_elt_opcode (ps, OP_VAR_MSYM_VALUE);
490 }
491
492 /* See parser-defs.h.  */
493
494 void
495 parser_state::mark_struct_expression ()
496 {
497   gdb_assert (parse_completion
498               && (m_completion_state.expout_tag_completion_type
499                   == TYPE_CODE_UNDEF));
500   m_completion_state.expout_last_struct = expout_ptr;
501 }
502
503 /* Indicate that the current parser invocation is completing a tag.
504    TAG is the type code of the tag, and PTR and LENGTH represent the
505    start of the tag name.  */
506
507 void
508 parser_state::mark_completion_tag (enum type_code tag, const char *ptr,
509                                    int length)
510 {
511   gdb_assert (parse_completion
512               && (m_completion_state.expout_tag_completion_type
513                   == TYPE_CODE_UNDEF)
514               && m_completion_state.expout_completion_name == NULL
515               && m_completion_state.expout_last_struct == -1);
516   gdb_assert (tag == TYPE_CODE_UNION
517               || tag == TYPE_CODE_STRUCT
518               || tag == TYPE_CODE_ENUM);
519   m_completion_state.expout_tag_completion_type = tag;
520   m_completion_state.expout_completion_name.reset (xstrndup (ptr, length));
521 }
522
523 \f
524 /* Recognize tokens that start with '$'.  These include:
525
526    $regname     A native register name or a "standard
527    register name".
528
529    $variable    A convenience variable with a name chosen
530    by the user.
531
532    $digits              Value history with index <digits>, starting
533    from the first value which has index 1.
534
535    $$digits     Value history with index <digits> relative
536    to the last value.  I.e. $$0 is the last
537    value, $$1 is the one previous to that, $$2
538    is the one previous to $$1, etc.
539
540    $ | $0 | $$0 The last value in the value history.
541
542    $$           An abbreviation for the second to the last
543    value in the value history, I.e. $$1  */
544
545 void
546 write_dollar_variable (struct parser_state *ps, struct stoken str)
547 {
548   struct block_symbol sym;
549   struct bound_minimal_symbol msym;
550   struct internalvar *isym = NULL;
551   std::string copy;
552
553   /* Handle the tokens $digits; also $ (short for $0) and $$ (short for $$1)
554      and $$digits (equivalent to $<-digits> if you could type that).  */
555
556   int negate = 0;
557   int i = 1;
558   /* Double dollar means negate the number and add -1 as well.
559      Thus $$ alone means -1.  */
560   if (str.length >= 2 && str.ptr[1] == '$')
561     {
562       negate = 1;
563       i = 2;
564     }
565   if (i == str.length)
566     {
567       /* Just dollars (one or two).  */
568       i = -negate;
569       goto handle_last;
570     }
571   /* Is the rest of the token digits?  */
572   for (; i < str.length; i++)
573     if (!(str.ptr[i] >= '0' && str.ptr[i] <= '9'))
574       break;
575   if (i == str.length)
576     {
577       i = atoi (str.ptr + 1 + negate);
578       if (negate)
579         i = -i;
580       goto handle_last;
581     }
582
583   /* Handle tokens that refer to machine registers:
584      $ followed by a register name.  */
585   i = user_reg_map_name_to_regnum (ps->gdbarch (),
586                                    str.ptr + 1, str.length - 1);
587   if (i >= 0)
588     goto handle_register;
589
590   /* Any names starting with $ are probably debugger internal variables.  */
591
592   copy = copy_name (str);
593   isym = lookup_only_internalvar (copy.c_str () + 1);
594   if (isym)
595     {
596       write_exp_elt_opcode (ps, OP_INTERNALVAR);
597       write_exp_elt_intern (ps, isym);
598       write_exp_elt_opcode (ps, OP_INTERNALVAR);
599       return;
600     }
601
602   /* On some systems, such as HP-UX and hppa-linux, certain system routines 
603      have names beginning with $ or $$.  Check for those, first.  */
604
605   sym = lookup_symbol (copy.c_str (), NULL, VAR_DOMAIN, NULL);
606   if (sym.symbol)
607     {
608       write_exp_elt_opcode (ps, OP_VAR_VALUE);
609       write_exp_elt_block (ps, sym.block);
610       write_exp_elt_sym (ps, sym.symbol);
611       write_exp_elt_opcode (ps, OP_VAR_VALUE);
612       return;
613     }
614   msym = lookup_bound_minimal_symbol (copy.c_str ());
615   if (msym.minsym)
616     {
617       write_exp_msymbol (ps, msym);
618       return;
619     }
620
621   /* Any other names are assumed to be debugger internal variables.  */
622
623   write_exp_elt_opcode (ps, OP_INTERNALVAR);
624   write_exp_elt_intern (ps, create_internalvar (copy.c_str () + 1));
625   write_exp_elt_opcode (ps, OP_INTERNALVAR);
626   return;
627 handle_last:
628   write_exp_elt_opcode (ps, OP_LAST);
629   write_exp_elt_longcst (ps, (LONGEST) i);
630   write_exp_elt_opcode (ps, OP_LAST);
631   return;
632 handle_register:
633   write_exp_elt_opcode (ps, OP_REGISTER);
634   str.length--;
635   str.ptr++;
636   write_exp_string (ps, str);
637   write_exp_elt_opcode (ps, OP_REGISTER);
638   ps->block_tracker->update (ps->expression_context_block,
639                              INNERMOST_BLOCK_FOR_REGISTERS);
640   return;
641 }
642
643
644 const char *
645 find_template_name_end (const char *p)
646 {
647   int depth = 1;
648   int just_seen_right = 0;
649   int just_seen_colon = 0;
650   int just_seen_space = 0;
651
652   if (!p || (*p != '<'))
653     return 0;
654
655   while (*++p)
656     {
657       switch (*p)
658         {
659         case '\'':
660         case '\"':
661         case '{':
662         case '}':
663           /* In future, may want to allow these??  */
664           return 0;
665         case '<':
666           depth++;              /* start nested template */
667           if (just_seen_colon || just_seen_right || just_seen_space)
668             return 0;           /* but not after : or :: or > or space */
669           break;
670         case '>':
671           if (just_seen_colon || just_seen_right)
672             return 0;           /* end a (nested?) template */
673           just_seen_right = 1;  /* but not after : or :: */
674           if (--depth == 0)     /* also disallow >>, insist on > > */
675             return ++p;         /* if outermost ended, return */
676           break;
677         case ':':
678           if (just_seen_space || (just_seen_colon > 1))
679             return 0;           /* nested class spec coming up */
680           just_seen_colon++;    /* we allow :: but not :::: */
681           break;
682         case ' ':
683           break;
684         default:
685           if (!((*p >= 'a' && *p <= 'z') ||     /* allow token chars */
686                 (*p >= 'A' && *p <= 'Z') ||
687                 (*p >= '0' && *p <= '9') ||
688                 (*p == '_') || (*p == ',') ||   /* commas for template args */
689                 (*p == '&') || (*p == '*') ||   /* pointer and ref types */
690                 (*p == '(') || (*p == ')') ||   /* function types */
691                 (*p == '[') || (*p == ']')))    /* array types */
692             return 0;
693         }
694       if (*p != ' ')
695         just_seen_space = 0;
696       if (*p != ':')
697         just_seen_colon = 0;
698       if (*p != '>')
699         just_seen_right = 0;
700     }
701   return 0;
702 }
703 \f
704
705 /* Return a null-terminated temporary copy of the name of a string token.
706
707    Tokens that refer to names do so with explicit pointer and length,
708    so they can share the storage that lexptr is parsing.
709    When it is necessary to pass a name to a function that expects
710    a null-terminated string, the substring is copied out
711    into a separate block of storage.  */
712
713 std::string
714 copy_name (struct stoken token)
715 {
716   return std::string (token.ptr, token.length);
717 }
718 \f
719
720 /* See comments on parser-defs.h.  */
721
722 int
723 prefixify_expression (struct expression *expr, int last_struct)
724 {
725   gdb_assert (expr->nelts > 0);
726   int len = sizeof (struct expression) + EXP_ELEM_TO_BYTES (expr->nelts);
727   struct expression *temp;
728   int inpos = expr->nelts, outpos = 0;
729
730   temp = (struct expression *) alloca (len);
731
732   /* Copy the original expression into temp.  */
733   memcpy (temp, expr, len);
734
735   return prefixify_subexp (temp, expr, inpos, outpos, last_struct);
736 }
737
738 /* Return the number of exp_elements in the postfix subexpression 
739    of EXPR whose operator is at index ENDPOS - 1 in EXPR.  */
740
741 static int
742 length_of_subexp (struct expression *expr, int endpos)
743 {
744   int oplen, args;
745
746   operator_length (expr, endpos, &oplen, &args);
747
748   while (args > 0)
749     {
750       oplen += length_of_subexp (expr, endpos - oplen);
751       args--;
752     }
753
754   return oplen;
755 }
756
757 /* Sets *OPLENP to the length of the operator whose (last) index is 
758    ENDPOS - 1 in EXPR, and sets *ARGSP to the number of arguments that
759    operator takes.  */
760
761 void
762 operator_length (const struct expression *expr, int endpos, int *oplenp,
763                  int *argsp)
764 {
765   expr->language_defn->la_exp_desc->operator_length (expr, endpos,
766                                                      oplenp, argsp);
767 }
768
769 /* Default value for operator_length in exp_descriptor vectors.  */
770
771 void
772 operator_length_standard (const struct expression *expr, int endpos,
773                           int *oplenp, int *argsp)
774 {
775   int oplen = 1;
776   int args = 0;
777   enum range_type range_type;
778   int i;
779
780   if (endpos < 1)
781     error (_("?error in operator_length_standard"));
782
783   i = (int) expr->elts[endpos - 1].opcode;
784
785   switch (i)
786     {
787       /* C++  */
788     case OP_SCOPE:
789       oplen = longest_to_int (expr->elts[endpos - 2].longconst);
790       oplen = 5 + BYTES_TO_EXP_ELEM (oplen + 1);
791       break;
792
793     case OP_LONG:
794     case OP_FLOAT:
795     case OP_VAR_VALUE:
796     case OP_VAR_MSYM_VALUE:
797       oplen = 4;
798       break;
799
800     case OP_FUNC_STATIC_VAR:
801       oplen = longest_to_int (expr->elts[endpos - 2].longconst);
802       oplen = 4 + BYTES_TO_EXP_ELEM (oplen + 1);
803       args = 1;
804       break;
805
806     case OP_TYPE:
807     case OP_BOOL:
808     case OP_LAST:
809     case OP_INTERNALVAR:
810     case OP_VAR_ENTRY_VALUE:
811       oplen = 3;
812       break;
813
814     case OP_COMPLEX:
815       oplen = 3;
816       args = 2;
817       break;
818
819     case OP_FUNCALL:
820     case OP_F77_UNDETERMINED_ARGLIST:
821       oplen = 3;
822       args = 1 + longest_to_int (expr->elts[endpos - 2].longconst);
823       break;
824
825     case TYPE_INSTANCE:
826       oplen = 5 + longest_to_int (expr->elts[endpos - 2].longconst);
827       args = 1;
828       break;
829
830     case OP_OBJC_MSGCALL:       /* Objective C message (method) call.  */
831       oplen = 4;
832       args = 1 + longest_to_int (expr->elts[endpos - 2].longconst);
833       break;
834
835     case UNOP_MAX:
836     case UNOP_MIN:
837       oplen = 3;
838       break;
839
840     case UNOP_CAST_TYPE:
841     case UNOP_DYNAMIC_CAST:
842     case UNOP_REINTERPRET_CAST:
843     case UNOP_MEMVAL_TYPE:
844       oplen = 1;
845       args = 2;
846       break;
847
848     case BINOP_VAL:
849     case UNOP_CAST:
850     case UNOP_MEMVAL:
851       oplen = 3;
852       args = 1;
853       break;
854
855     case UNOP_ABS:
856     case UNOP_CAP:
857     case UNOP_CHR:
858     case UNOP_FLOAT:
859     case UNOP_HIGH:
860     case UNOP_KIND:
861     case UNOP_ODD:
862     case UNOP_ORD:
863     case UNOP_TRUNC:
864     case OP_TYPEOF:
865     case OP_DECLTYPE:
866     case OP_TYPEID:
867       oplen = 1;
868       args = 1;
869       break;
870
871     case OP_ADL_FUNC:
872       oplen = longest_to_int (expr->elts[endpos - 2].longconst);
873       oplen = 4 + BYTES_TO_EXP_ELEM (oplen + 1);
874       oplen++;
875       oplen++;
876       break;
877
878     case STRUCTOP_STRUCT:
879     case STRUCTOP_PTR:
880       args = 1;
881       /* fall through */
882     case OP_REGISTER:
883     case OP_M2_STRING:
884     case OP_STRING:
885     case OP_OBJC_NSSTRING:      /* Objective C Foundation Class
886                                    NSString constant.  */
887     case OP_OBJC_SELECTOR:      /* Objective C "@selector" pseudo-op.  */
888     case OP_NAME:
889       oplen = longest_to_int (expr->elts[endpos - 2].longconst);
890       oplen = 4 + BYTES_TO_EXP_ELEM (oplen + 1);
891       break;
892
893     case OP_ARRAY:
894       oplen = 4;
895       args = longest_to_int (expr->elts[endpos - 2].longconst);
896       args -= longest_to_int (expr->elts[endpos - 3].longconst);
897       args += 1;
898       break;
899
900     case TERNOP_COND:
901     case TERNOP_SLICE:
902       args = 3;
903       break;
904
905       /* Modula-2 */
906     case MULTI_SUBSCRIPT:
907       oplen = 3;
908       args = 1 + longest_to_int (expr->elts[endpos - 2].longconst);
909       break;
910
911     case BINOP_ASSIGN_MODIFY:
912       oplen = 3;
913       args = 2;
914       break;
915
916       /* C++ */
917     case OP_THIS:
918       oplen = 2;
919       break;
920
921     case OP_RANGE:
922       oplen = 3;
923       range_type = (enum range_type)
924         longest_to_int (expr->elts[endpos - 2].longconst);
925
926       switch (range_type)
927         {
928         case LOW_BOUND_DEFAULT:
929         case LOW_BOUND_DEFAULT_EXCLUSIVE:
930         case HIGH_BOUND_DEFAULT:
931           args = 1;
932           break;
933         case BOTH_BOUND_DEFAULT:
934           args = 0;
935           break;
936         case NONE_BOUND_DEFAULT:
937         case NONE_BOUND_DEFAULT_EXCLUSIVE:
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 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 LAST_STRUCT.  */
958
959 static int
960 prefixify_subexp (struct expression *inexpr,
961                   struct expression *outexpr, int inend, int outbeg,
962                   int last_struct)
963 {
964   int oplen;
965   int args;
966   int i;
967   int *arglens;
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 (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
1001       oplen = arglens[i];
1002       inend += oplen;
1003       r = prefixify_subexp (inexpr, outexpr, inend, outbeg, last_struct);
1004       if (r != -1)
1005         {
1006           /* Return immediately.  We probably have only parsed a
1007              partial expression, so we don't want to try to reverse
1008              the other operands.  */
1009           return r;
1010         }
1011       outbeg += oplen;
1012     }
1013
1014   return result;
1015 }
1016 \f
1017 /* Read an expression from the string *STRINGPTR points to,
1018    parse it, and return a pointer to a struct expression that we malloc.
1019    Use block BLOCK as the lexical context for variable names;
1020    if BLOCK is zero, use the block of the selected stack frame.
1021    Meanwhile, advance *STRINGPTR to point after the expression,
1022    at the first nonwhite character that is not part of the expression
1023    (possibly a null character).
1024
1025    If COMMA is nonzero, stop if a comma is reached.  */
1026
1027 expression_up
1028 parse_exp_1 (const char **stringptr, CORE_ADDR pc, const struct block *block,
1029              int comma, innermost_block_tracker *tracker)
1030 {
1031   return parse_exp_in_context (stringptr, pc, block, comma, 0, NULL,
1032                                tracker, nullptr);
1033 }
1034
1035 /* As for parse_exp_1, except that if VOID_CONTEXT_P, then
1036    no value is expected from the expression.
1037    OUT_SUBEXP is set when attempting to complete a field name; in this
1038    case it is set to the index of the subexpression on the
1039    left-hand-side of the struct op.  If not doing such completion, it
1040    is left untouched.  */
1041
1042 static expression_up
1043 parse_exp_in_context (const char **stringptr, CORE_ADDR pc,
1044                       const struct block *block,
1045                       int comma, int void_context_p, int *out_subexp,
1046                       innermost_block_tracker *tracker,
1047                       expr_completion_state *cstate)
1048 {
1049   const struct language_defn *lang = NULL;
1050   int subexp;
1051
1052   if (*stringptr == 0 || **stringptr == 0)
1053     error_no_arg (_("expression to compute"));
1054
1055   const struct block *expression_context_block = block;
1056   CORE_ADDR expression_context_pc = 0;
1057
1058   innermost_block_tracker local_tracker;
1059   if (tracker == nullptr)
1060     tracker = &local_tracker;
1061
1062   /* If no context specified, try using the current frame, if any.  */
1063   if (!expression_context_block)
1064     expression_context_block = get_selected_block (&expression_context_pc);
1065   else if (pc == 0)
1066     expression_context_pc = BLOCK_ENTRY_PC (expression_context_block);
1067   else
1068     expression_context_pc = pc;
1069
1070   /* Fall back to using the current source static context, if any.  */
1071
1072   if (!expression_context_block)
1073     {
1074       struct symtab_and_line cursal = get_current_source_symtab_and_line ();
1075       if (cursal.symtab)
1076         expression_context_block
1077           = BLOCKVECTOR_BLOCK (SYMTAB_BLOCKVECTOR (cursal.symtab),
1078                                STATIC_BLOCK);
1079       if (expression_context_block)
1080         expression_context_pc = BLOCK_ENTRY_PC (expression_context_block);
1081     }
1082
1083   if (language_mode == language_mode_auto && block != NULL)
1084     {
1085       /* Find the language associated to the given context block.
1086          Default to the current language if it can not be determined.
1087
1088          Note that using the language corresponding to the current frame
1089          can sometimes give unexpected results.  For instance, this
1090          routine is often called several times during the inferior
1091          startup phase to re-parse breakpoint expressions after
1092          a new shared library has been loaded.  The language associated
1093          to the current frame at this moment is not relevant for
1094          the breakpoint.  Using it would therefore be silly, so it seems
1095          better to rely on the current language rather than relying on
1096          the current frame language to parse the expression.  That's why
1097          we do the following language detection only if the context block
1098          has been specifically provided.  */
1099       struct symbol *func = block_linkage_function (block);
1100
1101       if (func != NULL)
1102         lang = language_def (SYMBOL_LANGUAGE (func));
1103       if (lang == NULL || lang->la_language == language_unknown)
1104         lang = current_language;
1105     }
1106   else
1107     lang = current_language;
1108
1109   /* get_current_arch may reset CURRENT_LANGUAGE via select_frame.
1110      While we need CURRENT_LANGUAGE to be set to LANG (for lookup_symbol
1111      and others called from *.y) ensure CURRENT_LANGUAGE gets restored
1112      to the value matching SELECTED_FRAME as set by get_current_arch.  */
1113
1114   parser_state ps (lang, get_current_arch (), expression_context_block,
1115                    expression_context_pc, comma, *stringptr,
1116                    cstate != nullptr, tracker);
1117
1118   scoped_restore_current_language lang_saver;
1119   set_language (lang->la_language);
1120
1121   try
1122     {
1123       lang->la_parser (&ps);
1124     }
1125   catch (const gdb_exception &except)
1126     {
1127       /* If parsing for completion, allow this to succeed; but if no
1128          expression elements have been written, then there's nothing
1129          to do, so fail.  */
1130       if (! ps.parse_completion || ps.expout_ptr == 0)
1131         throw;
1132     }
1133
1134   /* We have to operate on an "expression *", due to la_post_parser,
1135      which explains this funny-looking double release.  */
1136   expression_up result = ps.release ();
1137
1138   /* Convert expression from postfix form as generated by yacc
1139      parser, to a prefix form.  */
1140
1141   if (expressiondebug)
1142     dump_raw_expression (result.get (), gdb_stdlog,
1143                          "before conversion to prefix form");
1144
1145   subexp = prefixify_expression (result.get (),
1146                                  ps.m_completion_state.expout_last_struct);
1147   if (out_subexp)
1148     *out_subexp = subexp;
1149
1150   lang->la_post_parser (&result, void_context_p, ps.parse_completion,
1151                         tracker);
1152
1153   if (expressiondebug)
1154     dump_prefix_expression (result.get (), gdb_stdlog);
1155
1156   if (cstate != nullptr)
1157     *cstate = std::move (ps.m_completion_state);
1158   *stringptr = ps.lexptr;
1159   return result;
1160 }
1161
1162 /* Parse STRING as an expression, and complain if this fails
1163    to use up all of the contents of STRING.  */
1164
1165 expression_up
1166 parse_expression (const char *string, innermost_block_tracker *tracker)
1167 {
1168   expression_up exp = parse_exp_1 (&string, 0, 0, 0, tracker);
1169   if (*string)
1170     error (_("Junk after end of expression."));
1171   return exp;
1172 }
1173
1174 /* Same as parse_expression, but using the given language (LANG)
1175    to parse the expression.  */
1176
1177 expression_up
1178 parse_expression_with_language (const char *string, enum language lang)
1179 {
1180   gdb::optional<scoped_restore_current_language> lang_saver;
1181   if (current_language->la_language != lang)
1182     {
1183       lang_saver.emplace ();
1184       set_language (lang);
1185     }
1186
1187   return parse_expression (string);
1188 }
1189
1190 /* Parse STRING as an expression.  If parsing ends in the middle of a
1191    field reference, return the type of the left-hand-side of the
1192    reference; furthermore, if the parsing ends in the field name,
1193    return the field name in *NAME.  If the parsing ends in the middle
1194    of a field reference, but the reference is somehow invalid, throw
1195    an exception.  In all other cases, return NULL.  */
1196
1197 struct type *
1198 parse_expression_for_completion (const char *string,
1199                                  gdb::unique_xmalloc_ptr<char> *name,
1200                                  enum type_code *code)
1201 {
1202   expression_up exp;
1203   struct value *val;
1204   int subexp;
1205   expr_completion_state cstate;
1206
1207   try
1208     {
1209       exp = parse_exp_in_context (&string, 0, 0, 0, 0, &subexp,
1210                                   nullptr, &cstate);
1211     }
1212   catch (const gdb_exception_error &except)
1213     {
1214       /* Nothing, EXP remains NULL.  */
1215     }
1216
1217   if (exp == NULL)
1218     return NULL;
1219
1220   if (cstate.expout_tag_completion_type != TYPE_CODE_UNDEF)
1221     {
1222       *code = cstate.expout_tag_completion_type;
1223       *name = std::move (cstate.expout_completion_name);
1224       return NULL;
1225     }
1226
1227   if (cstate.expout_last_struct == -1)
1228     return NULL;
1229
1230   const char *fieldname = extract_field_op (exp.get (), &subexp);
1231   if (fieldname == NULL)
1232     {
1233       name->reset ();
1234       return NULL;
1235     }
1236
1237   name->reset (xstrdup (fieldname));
1238   /* This might throw an exception.  If so, we want to let it
1239      propagate.  */
1240   val = evaluate_subexpression_type (exp.get (), subexp);
1241
1242   return value_type (val);
1243 }
1244
1245 /* A post-parser that does nothing.  */
1246
1247 void
1248 null_post_parser (expression_up *exp, int void_context_p, int completin,
1249                   innermost_block_tracker *tracker)
1250 {
1251 }
1252
1253 /* Parse floating point value P of length LEN.
1254    Return false if invalid, true if valid.
1255    The successfully parsed number is stored in DATA in
1256    target format for floating-point type TYPE.
1257
1258    NOTE: This accepts the floating point syntax that sscanf accepts.  */
1259
1260 bool
1261 parse_float (const char *p, int len,
1262              const struct type *type, gdb_byte *data)
1263 {
1264   return target_float_from_string (data, type, std::string (p, len));
1265 }
1266 \f
1267 /* This function avoids direct calls to fprintf 
1268    in the parser generated debug code.  */
1269 void
1270 parser_fprintf (FILE *x, const char *y, ...)
1271
1272   va_list args;
1273
1274   va_start (args, y);
1275   if (x == stderr)
1276     vfprintf_unfiltered (gdb_stderr, y, args); 
1277   else
1278     {
1279       fprintf_unfiltered (gdb_stderr, " Unknown FILE used.\n");
1280       vfprintf_unfiltered (gdb_stderr, y, args);
1281     }
1282   va_end (args);
1283 }
1284
1285 /* Implementation of the exp_descriptor method operator_check.  */
1286
1287 int
1288 operator_check_standard (struct expression *exp, int pos,
1289                          int (*objfile_func) (struct objfile *objfile,
1290                                               void *data),
1291                          void *data)
1292 {
1293   const union exp_element *const elts = exp->elts;
1294   struct type *type = NULL;
1295   struct objfile *objfile = NULL;
1296
1297   /* Extended operators should have been already handled by exp_descriptor
1298      iterate method of its specific language.  */
1299   gdb_assert (elts[pos].opcode < OP_EXTENDED0);
1300
1301   /* Track the callers of write_exp_elt_type for this table.  */
1302
1303   switch (elts[pos].opcode)
1304     {
1305     case BINOP_VAL:
1306     case OP_COMPLEX:
1307     case OP_FLOAT:
1308     case OP_LONG:
1309     case OP_SCOPE:
1310     case OP_TYPE:
1311     case UNOP_CAST:
1312     case UNOP_MAX:
1313     case UNOP_MEMVAL:
1314     case UNOP_MIN:
1315       type = elts[pos + 1].type;
1316       break;
1317
1318     case TYPE_INSTANCE:
1319       {
1320         LONGEST arg, nargs = elts[pos + 2].longconst;
1321
1322         for (arg = 0; arg < nargs; arg++)
1323           {
1324             struct type *inst_type = elts[pos + 3 + arg].type;
1325             struct objfile *inst_objfile = TYPE_OBJFILE (inst_type);
1326
1327             if (inst_objfile && (*objfile_func) (inst_objfile, data))
1328               return 1;
1329           }
1330       }
1331       break;
1332
1333     case OP_VAR_VALUE:
1334       {
1335         const struct block *const block = elts[pos + 1].block;
1336         const struct symbol *const symbol = elts[pos + 2].symbol;
1337
1338         /* Check objfile where the variable itself is placed.
1339            SYMBOL_OBJ_SECTION (symbol) may be NULL.  */
1340         if ((*objfile_func) (symbol_objfile (symbol), data))
1341           return 1;
1342
1343         /* Check objfile where is placed the code touching the variable.  */
1344         objfile = lookup_objfile_from_block (block);
1345
1346         type = SYMBOL_TYPE (symbol);
1347       }
1348       break;
1349     case OP_VAR_MSYM_VALUE:
1350       objfile = elts[pos + 1].objfile;
1351       break;
1352     }
1353
1354   /* Invoke callbacks for TYPE and OBJFILE if they were set as non-NULL.  */
1355
1356   if (type && TYPE_OBJFILE (type)
1357       && (*objfile_func) (TYPE_OBJFILE (type), data))
1358     return 1;
1359   if (objfile && (*objfile_func) (objfile, data))
1360     return 1;
1361
1362   return 0;
1363 }
1364
1365 /* Call OBJFILE_FUNC for any objfile found being referenced by EXP.
1366    OBJFILE_FUNC is never called with NULL OBJFILE.  OBJFILE_FUNC get
1367    passed an arbitrary caller supplied DATA pointer.  If OBJFILE_FUNC
1368    returns non-zero value then (any other) non-zero value is immediately
1369    returned to the caller.  Otherwise zero is returned after iterating
1370    through whole EXP.  */
1371
1372 static int
1373 exp_iterate (struct expression *exp,
1374              int (*objfile_func) (struct objfile *objfile, void *data),
1375              void *data)
1376 {
1377   int endpos;
1378
1379   for (endpos = exp->nelts; endpos > 0; )
1380     {
1381       int pos, args, oplen = 0;
1382
1383       operator_length (exp, endpos, &oplen, &args);
1384       gdb_assert (oplen > 0);
1385
1386       pos = endpos - oplen;
1387       if (exp->language_defn->la_exp_desc->operator_check (exp, pos,
1388                                                            objfile_func, data))
1389         return 1;
1390
1391       endpos = pos;
1392     }
1393
1394   return 0;
1395 }
1396
1397 /* Helper for exp_uses_objfile.  */
1398
1399 static int
1400 exp_uses_objfile_iter (struct objfile *exp_objfile, void *objfile_voidp)
1401 {
1402   struct objfile *objfile = (struct objfile *) objfile_voidp;
1403
1404   if (exp_objfile->separate_debug_objfile_backlink)
1405     exp_objfile = exp_objfile->separate_debug_objfile_backlink;
1406
1407   return exp_objfile == objfile;
1408 }
1409
1410 /* Return 1 if EXP uses OBJFILE (and will become dangling when OBJFILE
1411    is unloaded), otherwise return 0.  OBJFILE must not be a separate debug info
1412    file.  */
1413
1414 int
1415 exp_uses_objfile (struct expression *exp, struct objfile *objfile)
1416 {
1417   gdb_assert (objfile->separate_debug_objfile_backlink == NULL);
1418
1419   return exp_iterate (exp, exp_uses_objfile_iter, objfile);
1420 }
1421
1422 /* Reallocate the `expout' pointer inside PS so that it can accommodate
1423    at least LENELT expression elements.  This function does nothing if
1424    there is enough room for the elements.  */
1425
1426 static void
1427 increase_expout_size (struct expr_builder *ps, size_t lenelt)
1428 {
1429   if ((ps->expout_ptr + lenelt) >= ps->expout_size)
1430     {
1431       ps->expout_size = std::max (ps->expout_size * 2,
1432                                   ps->expout_ptr + lenelt + 10);
1433       ps->expout.reset (XRESIZEVAR (expression,
1434                                     ps->expout.release (),
1435                                     (sizeof (struct expression)
1436                                      + EXP_ELEM_TO_BYTES (ps->expout_size))));
1437     }
1438 }
1439
1440 void
1441 _initialize_parse (void)
1442 {
1443   add_setshow_zuinteger_cmd ("expression", class_maintenance,
1444                              &expressiondebug,
1445                              _("Set expression debugging."),
1446                              _("Show expression debugging."),
1447                              _("When non-zero, the internal representation "
1448                                "of expressions will be printed."),
1449                              NULL,
1450                              show_expressiondebug,
1451                              &setdebuglist, &showdebuglist);
1452   add_setshow_boolean_cmd ("parser", class_maintenance,
1453                             &parser_debug,
1454                            _("Set parser debugging."),
1455                            _("Show parser debugging."),
1456                            _("When non-zero, expression parser "
1457                              "tracing will be enabled."),
1458                             NULL,
1459                             show_parserdebug,
1460                             &setdebuglist, &showdebuglist);
1461 }