1 /* Bison Action Scanner                             -*- C -*-
 
   3    Copyright (C) 2006, 2007, 2008-2009 Free Software Foundation, Inc.
 
   5    This file is part of Bison, the GNU Compiler Compiler.
 
   7    This program is free software: you can redistribute it and/or modify
 
   8    it under the terms of the GNU General Public License as published by
 
   9    the Free Software Foundation, either version 3 of the License, or
 
  10    (at your option) any later version.
 
  12    This program is distributed in the hope that it will be useful,
 
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
  15    GNU General Public License for more details.
 
  17    You should have received a copy of the GNU General Public License
 
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
  20 %option debug nodefault noinput nounput noyywrap never-interactive
 
  21 %option prefix="code_" outfile="lex.yy.c"
 
  24 /* Work around a bug in flex 2.5.31.  See Debian bug 333231
 
  25    <http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=333231>.  */
 
  29 #define FLEX_PREFIX(Id) code_ ## Id
 
  30 #include "flex-scanner.h"
 
  35 #include "scan-code.h"
 
  39 #include <get-errno.h>
 
  42 /* The current calling start condition: SC_RULE_ACTION or
 
  44 # define YY_DECL static char *code_lex (code_props *self, int sc_context)
 
  47 #define YY_USER_ACTION  location_compute (loc, &loc->end, yytext, yyleng);
 
  49 static void handle_action_dollar (symbol_list *rule, char *cp,
 
  51 static void handle_action_at (symbol_list *rule, char *cp, location at_loc);
 
  53 /* A string to be pushed to obstack after dollar/at has been handled. */
 
  54 static char *ref_tail_fields;
 
  56 static location the_location;
 
  57 static location *loc = &the_location;
 
  59 /* A string representing the most recent translation.  */
 
  60 static char *last_string;
 
  62 /* True if an untyped $$ or $n was seen.  */
 
  63 static bool untyped_var_seen;
 
  66  /* C and C++ comments in code. */
 
  67 %x SC_COMMENT SC_LINE_COMMENT
 
  68  /* Strings and characters in code. */
 
  69 %x SC_STRING SC_CHARACTER
 
  70  /* Whether in a rule or symbol action.  Specifies the translation
 
  72 %x SC_RULE_ACTION SC_SYMBOL_ACTION
 
  75 /* POSIX says that a tag must be both an id and a C union member, but
 
  76    historically almost any character is allowed in a tag.  We disallow
 
  77    NUL and newline, as this simplifies our implementation.  */
 
  80 /* Zero or more instances of backslash-newline.  Following GCC, allow
 
  81    white space between the backslash and the newline.  */
 
  82 splice   (\\[ \f\t\v]*\n)*
 
  84 /* C style identifier. Must start with letter. Will be used for
 
  85    named symbol references. Shall be kept synchronized with
 
  86    scan-gram.l "letter" and "id". */
 
  87 letter    [-.abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_]
 
  88 id        {letter}({letter}|[0-9])*
 
  89 ref      -?[0-9]+|{id}|"["{id}"]"|"$"
 
  94   /* Nesting level of the current code in braces.  */
 
  97   /* Whether a semicolon is probably needed.
 
  98      The heuristic is that a semicolon is not needed after `{', `}', `;',
 
  99      or a C preprocessor directive, and that whitespaces and comments
 
 100      do not affect this flag.
 
 101      Note that `{' does not need a semicolon because of `{}'.
 
 102      A semicolon may be needed before a cpp direcive, but don't bother.  */
 
 103   bool need_semicolon = false;
 
 105   /* Whether in a C preprocessor directive.  Don't use a start condition
 
 106      for this because, at the end of strings and comments, we still need
 
 107      to know whether we're in a directive.  */
 
 110   /* This scanner is special: it is invoked only once, henceforth
 
 111      is expected to return only once.  This initialization is
 
 112      therefore done once per action to translate. */
 
 113   aver (sc_context == SC_SYMBOL_ACTION
 
 114         || sc_context == SC_RULE_ACTION
 
 115         || sc_context == INITIAL);
 
 119   /*------------------------------------------------------------.
 
 120   | Scanning a C comment.  The initial `/ *' is already eaten.  |
 
 121   `------------------------------------------------------------*/
 
 125   "*"{splice}"/"  STRING_GROW; BEGIN sc_context;
 
 129   /*--------------------------------------------------------------.
 
 130   | Scanning a line comment.  The initial `//' is already eaten.  |
 
 131   `--------------------------------------------------------------*/
 
 135   "\n"           STRING_GROW; BEGIN sc_context;
 
 136   {splice}       STRING_GROW;
 
 140   /*--------------------------------------------.
 
 141   | Scanning user-code characters and strings.  |
 
 142   `--------------------------------------------*/
 
 144 <SC_CHARACTER,SC_STRING>
 
 146   {splice}|\\{splice}.  STRING_GROW;
 
 151   "'"           STRING_GROW; BEGIN sc_context;
 
 156   "\""          STRING_GROW; BEGIN sc_context;
 
 160 <SC_RULE_ACTION,SC_SYMBOL_ACTION>{
 
 164     need_semicolon = true;
 
 169     need_semicolon = true;
 
 177     BEGIN SC_LINE_COMMENT;
 
 183   "$"("<"{tag}">")?{ref}  {
 
 185     handle_action_dollar (self->rule, yytext, *loc);
 
 186     if (ref_tail_fields) {
 
 187       obstack_sgrow (&obstack_for_string, ref_tail_fields);
 
 189     need_semicolon = true;
 
 193     handle_action_at (self->rule, yytext, *loc);
 
 194     if (ref_tail_fields) {
 
 195       obstack_sgrow (&obstack_for_string, ref_tail_fields);
 
 197     need_semicolon = true;
 
 200     warn_at (*loc, _("stray `$'"));
 
 201     obstack_sgrow (&obstack_for_string, "$][");
 
 202     need_semicolon = true;
 
 205     warn_at (*loc, _("stray `@'"));
 
 206     obstack_sgrow (&obstack_for_string, "@@");
 
 207     need_semicolon = true;
 
 210     obstack_sgrow (&obstack_for_string, "@{");
 
 211     need_semicolon = true;
 
 214     obstack_sgrow (&obstack_for_string, "@}");
 
 215     need_semicolon = true;
 
 218   ";"  STRING_GROW;                 need_semicolon = false;
 
 219   "{"  STRING_GROW; ++braces_level; need_semicolon = false;
 
 221     bool outer_brace = --braces_level == 0;
 
 223     /* As an undocumented Bison extension, append `;' before the last
 
 224        brace in braced code, so that the user code can omit trailing
 
 225        `;'.  But do not append `;' if emulating Yacc, since Yacc does
 
 227     if (outer_brace && !yacc_flag && language_prio == default_prio
 
 228         && skeleton_prio == default_prio && need_semicolon && ! in_cpp)
 
 230         warn_at (*loc, _("a `;' might be needed at the end of action code"));
 
 231         warn_at (*loc, _("future versions of Bison will not add the `;'"));
 
 232         obstack_1grow (&obstack_for_string, ';');
 
 236     need_semicolon = false;
 
 239   /* Preprocessing directives should only be recognized at the beginning
 
 240      of lines, allowing whitespace including comments, but in C/C++,
 
 241      `#' can only be the start of preprocessor directives or within
 
 242      `#define' directives anyway, so don't bother with begin of line.  */
 
 243   "#"       STRING_GROW; in_cpp = true;
 
 245   {splice}  STRING_GROW;
 
 246   [\n\r]    STRING_GROW; if (in_cpp) in_cpp = need_semicolon = false; 
 
 248   .         STRING_GROW; need_semicolon = true;
 
 254     obstack_sgrow (&obstack_for_string, "]b4_dollar_dollar[");
 
 255     self->is_value_used = true;
 
 258     obstack_sgrow (&obstack_for_string, "]b4_at_dollar[");
 
 259     locations_flag = true;
 
 264   /*-----------------------------------------.
 
 265   | Escape M4 quoting characters in C code.  |
 
 266   `-----------------------------------------*/
 
 270   \$    obstack_sgrow (&obstack_for_string, "$][");
 
 271   \@    obstack_sgrow (&obstack_for_string, "@@");
 
 272   \[    obstack_sgrow (&obstack_for_string, "@{");
 
 273   \]    obstack_sgrow (&obstack_for_string, "@}");
 
 276   /*-----------------------------------------------------.
 
 277   | By default, grow the string obstack with the input.  |
 
 278   `-----------------------------------------------------*/
 
 282  /* End of processing. */
 
 291 is_dot_or_dash (char ch)
 
 293   return ch == '.' || ch == '-';
 
 297 contains_dot_or_dash (const char* p)
 
 300     if (is_dot_or_dash (*p))
 
 305 /* Defines a variant of a symbolic name resolution. */
 
 308   /* Index in symbol list. */
 
 309   unsigned symbol_index;
 
 311   /* Matched symbol id and loc. */
 
 315   /* Hiding named reference. */
 
 316   named_ref* hidden_by;
 
 318   /* Error flags. May contain zero (no errors) or
 
 319      a combination of VARIANT_* values. */
 
 323 /* Set when the variant refers to a symbol hidden
 
 324    by an explicit symbol reference. */
 
 325 #define VARIANT_HIDDEN (1 << 0)
 
 327 /* Set when the variant refers to a symbol containing
 
 328    dots or dashes. Will require explicit bracketing. */
 
 329 #define VARIANT_BAD_BRACKETING (1 << 1)
 
 331 /* Set when the variant refers to a symbol which is
 
 332    not visible from current midrule. */
 
 333 #define VARIANT_NOT_VISIBLE_FROM_MIDRULE (1 << 2)
 
 335 static variant *variant_table = 0;
 
 336 static unsigned variant_table_size = 0;
 
 337 static unsigned variant_count = 0;
 
 340 variant_table_grow (void)
 
 343   if (variant_count > variant_table_size)
 
 345       while (variant_count > variant_table_size)
 
 346         variant_table_size = 2 * variant_table_size + 3;
 
 347       variant_table = xnrealloc (variant_table, variant_table_size,
 
 348                                  sizeof *variant_table);
 
 350   return &variant_table[variant_count - 1];
 
 354 variant_table_free (void)
 
 356   free (variant_table);
 
 358   variant_table_size = variant_count = 0;
 
 362 find_prefix_end (const char *prefix, char *begin, char *end)
 
 366   for (; *prefix && ptr != end; ++prefix, ++ptr)
 
 377 variant_add (uniqstr id, location id_loc, unsigned symbol_index,
 
 378              char *cp, char *cp_end, bool exact_mode)
 
 382   prefix_end = find_prefix_end (id, cp, cp_end);
 
 384       (prefix_end == cp_end ||
 
 385        (!exact_mode && is_dot_or_dash (*prefix_end))))
 
 387       variant *r = variant_table_grow ();
 
 388       r->symbol_index = symbol_index;
 
 400 get_at_spec(unsigned symbol_index)
 
 402   static char at_buf[20];
 
 403   if (symbol_index == 0)
 
 404     strcpy (at_buf, "$$");
 
 406     snprintf (at_buf, sizeof at_buf, "$%u", symbol_index);
 
 411 show_sub_messages (const char* cp, bool exact_mode, int midrule_rhs_index,
 
 412                    char dollar_or_at, bool is_warning)
 
 416   for (i = 0; i < variant_count; ++i)
 
 418       const variant *var = &variant_table[i];
 
 419       const char *at_spec = get_at_spec (var->symbol_index);
 
 424             warn_at (var->loc, _("  refers to: %c%s at %s"),
 
 425                      dollar_or_at, var->id, at_spec);
 
 427             complain_at (var->loc, _("  refers to: %c%s at %s"),
 
 428                          dollar_or_at, var->id, at_spec);
 
 432           static struct obstack msg_buf;
 
 433           const char *tail = exact_mode ? "" :
 
 434             cp + strlen (var->id);
 
 435           const char *id = var->hidden_by ? var->hidden_by->id :
 
 437           location id_loc = var->hidden_by ? var->hidden_by->loc :
 
 440           /* Create the explanation message. */
 
 441           obstack_init (&msg_buf);
 
 443           obstack_fgrow1 (&msg_buf, "  possibly meant: %c", dollar_or_at);
 
 444           if (contains_dot_or_dash (id))
 
 445             obstack_fgrow1 (&msg_buf, "[%s]", id);
 
 447             obstack_sgrow (&msg_buf, id);
 
 448           obstack_sgrow (&msg_buf, tail);
 
 450           if (var->err & VARIANT_HIDDEN)
 
 452               obstack_fgrow1 (&msg_buf, ", hiding %c", dollar_or_at);
 
 453               if (contains_dot_or_dash (var->id))
 
 454                 obstack_fgrow1 (&msg_buf, "[%s]", var->id);
 
 456                 obstack_sgrow (&msg_buf, var->id);
 
 457               obstack_sgrow (&msg_buf, tail);
 
 460           obstack_fgrow1 (&msg_buf, " at %s", at_spec);
 
 462           if (var->err & VARIANT_NOT_VISIBLE_FROM_MIDRULE)
 
 463             obstack_fgrow1 (&msg_buf, ", cannot be accessed from "
 
 464                             "mid-rule action at $%d", midrule_rhs_index);
 
 466           obstack_1grow (&msg_buf, '\0');
 
 468             warn_at (id_loc, _("%s"), (char *) obstack_finish (&msg_buf));
 
 470             complain_at (id_loc, _("%s"), (char *) obstack_finish (&msg_buf));
 
 471           obstack_free (&msg_buf, 0);
 
 476 /* Returned from "parse_ref" when the reference
 
 478 #define INVALID_REF (INT_MIN)
 
 480 /* Returned from "parse_ref" when the reference
 
 481    points to LHS ($$) of the current rule or midrule. */
 
 482 #define LHS_REF (INT_MIN + 1)
 
 484 /* Parse named or positional reference. In case of positional
 
 485    references, can return negative values for $-n "deep" stack
 
 488 parse_ref (char *cp, symbol_list *rule, int rule_length,
 
 489            int midrule_rhs_index, char *text, location text_loc,
 
 496   unsigned valid_variants = 0;
 
 497   unsigned valid_variant_index = 0;
 
 502   if (c_isdigit (*cp) || (*cp == '-' && c_isdigit (* (cp + 1))))
 
 504       long int num = strtol (cp, &cp, 10);
 
 505       if (1 - INT_MAX + rule_length <= num && num <= rule_length)
 
 509           complain_at (text_loc, _("integer out of range: %s"),
 
 517       /* Ignore the brackets. */
 
 519       for (p = ++cp; *p != ']'; ++p)
 
 527       /* Take all characters of the name. */
 
 529       for (p = cp; *p; ++p)
 
 530         if (is_dot_or_dash (*p))
 
 535       for (p = cp; *p; ++p)
 
 542   /* Add all relevant variants. */
 
 544     unsigned symbol_index;
 
 546     for (symbol_index = 0, l = rule; !symbol_list_null (l);
 
 547          ++symbol_index, l = l->next)
 
 550         if (l->content_type != SYMLIST_SYMBOL)
 
 553         var = variant_add (l->content.sym->tag, l->sym_loc,
 
 554                            symbol_index, cp, cp_end, exact_mode);
 
 555         if (var && l->named_ref)
 
 556           var->hidden_by = l->named_ref;
 
 559           variant_add (l->named_ref->id, l->named_ref->loc,
 
 560                        symbol_index, cp, cp_end, exact_mode);
 
 565   for (i = 0; i < variant_count; ++i)
 
 567       variant *var = &variant_table[i];
 
 568       unsigned symbol_index = var->symbol_index;
 
 570       /* Check visibility from mid-rule actions. */
 
 571       if (midrule_rhs_index != 0
 
 572           && (symbol_index == 0 || midrule_rhs_index < symbol_index))
 
 573         var->err |= VARIANT_NOT_VISIBLE_FROM_MIDRULE;
 
 575       /* Check correct bracketing. */
 
 576       if (!exact_mode && contains_dot_or_dash (var->id))
 
 577         var->err |= VARIANT_BAD_BRACKETING;
 
 579       /* Check using of hidden symbols. */
 
 581         var->err |= VARIANT_HIDDEN;
 
 585           valid_variant_index = i;
 
 590   switch (valid_variants)
 
 593       if (variant_count == 0)
 
 594         complain_at (text_loc, _("invalid reference: %s, symbol not found"),
 
 598           complain_at (text_loc, _("invalid reference: %s"),
 
 600           show_sub_messages (cp, exact_mode, midrule_rhs_index,
 
 601                              dollar_or_at, false);
 
 606         if (variant_count > 1)
 
 608             warn_at (text_loc, _("misleading reference: %s"),
 
 610             show_sub_messages (cp, exact_mode, midrule_rhs_index,
 
 614           unsigned symbol_index =
 
 615             variant_table[valid_variant_index].symbol_index;
 
 616           return (symbol_index == midrule_rhs_index) ? LHS_REF : symbol_index;
 
 621       complain_at (text_loc, _("ambiguous reference: %s"),
 
 623       show_sub_messages (cp, exact_mode, midrule_rhs_index,
 
 624                          dollar_or_at, false);
 
 632 /* Keeps track of the maximum number of semantic values to the left of
 
 633    a handle (those referenced by $0, $-1, etc.) are required by the
 
 634    semantic actions of this grammar. */
 
 635 int max_left_semantic_context = 0;
 
 638 /*------------------------------------------------------------------.
 
 639 | TEXT is pointing to a wannabee semantic value (i.e., a `$').      |
 
 641 | Possible inputs: $[<TYPENAME>]($|integer)                         |
 
 643 | Output to OBSTACK_FOR_STRING a reference to this semantic value.  |
 
 644 `------------------------------------------------------------------*/
 
 647 handle_action_dollar (symbol_list *rule, char *text, location dollar_loc)
 
 649   char const *type_name = NULL;
 
 652   symbol_list *effective_rule;
 
 653   int effective_rule_length;
 
 656   if (rule->midrule_parent_rule)
 
 658       effective_rule = rule->midrule_parent_rule;
 
 659       effective_rule_length = rule->midrule_parent_rhs_index - 1;
 
 663       effective_rule = rule;
 
 664       effective_rule_length = symbol_list_length (rule->next);
 
 667   /* Get the type name if explicit. */
 
 674       /* The '>' symbol will be later replaced by '\0'. Original
 
 675          'text' is needed for error messages. */
 
 678       if (untyped_var_seen)
 
 679         complain_at (dollar_loc, _("explicit type given in untyped grammar"));
 
 683   n = parse_ref (cp, effective_rule, effective_rule_length,
 
 684                  rule->midrule_parent_rhs_index, text, dollar_loc, '$');
 
 696         type_name = symbol_list_n_type_name_get (rule, dollar_loc, 0);
 
 700           if (union_seen | tag_seen)
 
 702               if (rule->midrule_parent_rule)
 
 703                 complain_at (dollar_loc,
 
 704                              _("$$ for the midrule at $%d of `%s'"
 
 705                                " has no declared type"),
 
 706                              rule->midrule_parent_rhs_index,
 
 707                              effective_rule->content.sym->tag);
 
 709                 complain_at (dollar_loc, _("$$ of `%s' has no declared type"),
 
 710                              rule->content.sym->tag);
 
 713             untyped_var_seen = true;
 
 717       obstack_fgrow1 (&obstack_for_string,
 
 718                       "]b4_lhs_value([%s])[", type_name);
 
 719       rule->action_props.is_value_used = true;
 
 723       if (max_left_semantic_context < 1 - n)
 
 724         max_left_semantic_context = 1 - n;
 
 725       if (!type_name && 0 < n)
 
 727           symbol_list_n_type_name_get (effective_rule, dollar_loc, n);
 
 730           if (union_seen | tag_seen)
 
 731             complain_at (dollar_loc, _("$%s of `%s' has no declared type"),
 
 732                          cp, effective_rule->content.sym->tag);
 
 734             untyped_var_seen = true;
 
 738       obstack_fgrow3 (&obstack_for_string,
 
 739                       "]b4_rhs_value(%d, %d, [%s])[",
 
 740                       effective_rule_length, n, type_name);
 
 742         symbol_list_n_get (effective_rule, n)->action_props.is_value_used =
 
 749 /*------------------------------------------------------.
 
 750 | TEXT is a location token (i.e., a `@...').  Output to |
 
 751 | OBSTACK_FOR_STRING a reference to this location.      |
 
 752 `------------------------------------------------------*/
 
 755 handle_action_at (symbol_list *rule, char *text, location at_loc)
 
 758   symbol_list *effective_rule;
 
 759   int effective_rule_length;
 
 762   if (rule->midrule_parent_rule)
 
 764       effective_rule = rule->midrule_parent_rule;
 
 765       effective_rule_length = rule->midrule_parent_rhs_index - 1;
 
 769       effective_rule = rule;
 
 770       effective_rule_length = symbol_list_length (rule->next);
 
 773   locations_flag = true;
 
 775   n = parse_ref (cp, effective_rule, effective_rule_length,
 
 776                        rule->midrule_parent_rhs_index, text, at_loc, '@');
 
 783       obstack_sgrow (&obstack_for_string, "]b4_lhs_location[");
 
 787       obstack_fgrow2 (&obstack_for_string, "]b4_rhs_location(%d, %d)[",
 
 788                       effective_rule_length, n);
 
 794 /*-------------------------.
 
 795 | Initialize the scanner.  |
 
 796 `-------------------------*/
 
 798 /* Translate the dollars and ats in \a self, in the context \a sc_context
 
 799    (SC_RULE_ACTION, SC_SYMBOL_ACTION, INITIAL).  */
 
 802 translate_action (code_props *self, int sc_context)
 
 805   static bool initialized = false;
 
 808       obstack_init (&obstack_for_string);
 
 813   loc->start = loc->end = self->location.start;
 
 814   yy_switch_to_buffer (yy_scan_string (self->code));
 
 815   res = code_lex (self, sc_context);
 
 816   yy_delete_buffer (YY_CURRENT_BUFFER);
 
 821 /*------------------------------------------------------------------------.
 
 822 | Implementation of the public interface as documented in "scan-code.h".  |
 
 823 `------------------------------------------------------------------------*/
 
 826 code_props_none_init (code_props *self)
 
 828   *self = code_props_none;
 
 831 code_props const code_props_none = CODE_PROPS_NONE_INIT;
 
 834 code_props_plain_init (code_props *self, char const *code,
 
 837   self->kind = CODE_PROPS_PLAIN;
 
 839   self->location = code_loc;
 
 840   self->is_value_used = false;
 
 842   self->named_ref = NULL;
 
 846 code_props_symbol_action_init (code_props *self, char const *code,
 
 849   self->kind = CODE_PROPS_SYMBOL_ACTION;
 
 851   self->location = code_loc;
 
 852   self->is_value_used = false;
 
 854   self->named_ref = NULL;
 
 858 code_props_rule_action_init (code_props *self, char const *code,
 
 859                              location code_loc, symbol_list *rule,
 
 862   self->kind = CODE_PROPS_RULE_ACTION;
 
 864   self->location = code_loc;
 
 865   self->is_value_used = false;
 
 867   self->named_ref = name;
 
 871 code_props_translate_code (code_props *self)
 
 875       case CODE_PROPS_NONE:
 
 877       case CODE_PROPS_PLAIN:
 
 878         self->code = translate_action (self, INITIAL);
 
 880       case CODE_PROPS_SYMBOL_ACTION:
 
 881         self->code = translate_action (self, SC_SYMBOL_ACTION);
 
 883       case CODE_PROPS_RULE_ACTION:
 
 884         self->code = translate_action (self, SC_RULE_ACTION);
 
 890 code_scanner_last_string_free (void)
 
 896 code_scanner_free (void)
 
 898   obstack_free (&obstack_for_string, 0);
 
 899   variant_table_free ();
 
 901   /* Reclaim Flex's buffers.  */