src/scan-code.l

   1 /* Bison Action Scanner                             -*- C -*-
   2
   3    Copyright (C) 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
   4
   5    This file is part of Bison, the GNU Compiler Compiler.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 %option debug nodefault noinput nounput noyywrap never-interactive
  21 %option prefix="code_" outfile="lex.yy.c"
  22
  23 %{
  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>.  */
  26 #undef code_wrap
  27 #define code_wrap() 1
  28
  29 #define FLEX_PREFIX(Id) code_ ## Id
  30 #include <src/flex-scanner.h>
  31
  32 #include <src/complain.h>
  33 #include <src/reader.h>
  34 #include <src/getargs.h>
  35 #include <src/muscle-tab.h>
  36 #include <src/scan-code.h>
  37 #include <src/symlist.h>
  38
  39 #include <c-ctype.h>
  40 #include <get-errno.h>
  41 #include <quote.h>
  42
  43 /* The current calling start condition: SC_RULE_ACTION or
  44    SC_SYMBOL_ACTION. */
  45 # define YY_DECL static char *code_lex (code_props *self, int sc_context)
  46 YY_DECL;
  47
  48 #define YY_USER_ACTION  location_compute (loc, &loc->end, yytext, yyleng);
  49
  50 static void handle_action_dollar (symbol_list *rule, char *cp,
  51                                   location dollar_loc);
  52 static void handle_action_at (symbol_list *rule, char *cp, location at_loc);
  53
  54 /* A string to be pushed to obstack after dollar/at has been handled. */
  55 static char *ref_tail_fields;
  56
  57 static location the_location;
  58 static location *loc = &the_location;
  59
  60 /* A string representing the most recent translation.  */
  61 static char *last_string;
  62
  63 /* True if an untyped $$ or $n was seen.  */
  64 static bool untyped_var_seen;
  65
  66 %}
  67  /* C and C++ comments in code. */
  68 %x SC_COMMENT SC_LINE_COMMENT
  69  /* Strings and characters in code. */
  70 %x SC_STRING SC_CHARACTER
  71  /* Whether in a rule or symbol action.  Specifies the translation
  72     of $ and @.  */
  73 %x SC_RULE_ACTION SC_SYMBOL_ACTION
  74
  75
  76 /* POSIX says that a tag must be both an id and a C union member, but
  77    historically almost any character is allowed in a tag.  We disallow
  78    NUL and newline, as this simplifies our implementation.  */
  79 tag      [^\0\n>]+
  80
  81 /* Zero or more instances of backslash-newline.  Following GCC, allow
  82    white space between the backslash and the newline.  */
  83 splice   (\\[ \f\t\v]*\n)*
  84
  85 /* C style identifier. Must start with letter. Will be used for
  86    named symbol references. Shall be kept synchronized with
  87    scan-gram.l "letter" and "id". */
  88 letter    [-.abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_]
  89 id        {letter}({letter}|[0-9])*
  90 ref      -?[0-9]+|{id}|"["{id}"]"|"$"
  91
  92 %%
  93
  94 %{
  95   /* Nesting level of the current code in braces.  */
  96   int braces_level = 0;
  97
  98   /* Whether a semicolon is probably needed.
  99      The heuristic is that a semicolon is not needed after `{', `}', `;',
 100      or a C preprocessor directive, and that whitespaces and comments
 101      do not affect this flag.
 102      Note that `{' does not need a semicolon because of `{}'.
 103      A semicolon may be needed before a cpp direcive, but don't bother.  */
 104   bool need_semicolon = false;
 105
 106   /* Whether in a C preprocessor directive.  Don't use a start condition
 107      for this because, at the end of strings and comments, we still need
 108      to know whether we're in a directive.  */
 109   bool in_cpp = false;
 110
 111   /* This scanner is special: it is invoked only once, henceforth
 112      is expected to return only once.  This initialization is
 113      therefore done once per action to translate. */
 114   aver (sc_context == SC_SYMBOL_ACTION
 115         || sc_context == SC_RULE_ACTION
 116         || sc_context == INITIAL);
 117   BEGIN sc_context;
 118 %}
 119
 120   /*------------------------------------------------------------.
 121   | Scanning a C comment.  The initial `/ *' is already eaten.  |
 122   `------------------------------------------------------------*/
 123
 124 <SC_COMMENT>
 125 {
 126   "*"{splice}"/"  STRING_GROW; BEGIN sc_context;
 127 }
 128
 129
 130   /*--------------------------------------------------------------.
 131   | Scanning a line comment.  The initial `//' is already eaten.  |
 132   `--------------------------------------------------------------*/
 133
 134 <SC_LINE_COMMENT>
 135 {
 136   "\n"           STRING_GROW; BEGIN sc_context;
 137   {splice}       STRING_GROW;
 138 }
 139
 140
 141   /*--------------------------------------------.
 142   | Scanning user-code characters and strings.  |
 143   `--------------------------------------------*/
 144
 145 <SC_CHARACTER,SC_STRING>
 146 {
 147   {splice}|\\{splice}.  STRING_GROW;
 148 }
 149
 150 <SC_CHARACTER>
 151 {
 152   "'"           STRING_GROW; BEGIN sc_context;
 153 }
 154
 155 <SC_STRING>
 156 {
 157   "\""          STRING_GROW; BEGIN sc_context;
 158 }
 159
 160
 161 <SC_RULE_ACTION,SC_SYMBOL_ACTION>{
 162   "'" {
 163     STRING_GROW;
 164     BEGIN SC_CHARACTER;
 165     need_semicolon = true;
 166   }
 167   "\"" {
 168     STRING_GROW;
 169     BEGIN SC_STRING;
 170     need_semicolon = true;
 171   }
 172   "/"{splice}"*" {
 173     STRING_GROW;
 174     BEGIN SC_COMMENT;
 175   }
 176   "/"{splice}"/" {
 177     STRING_GROW;
 178     BEGIN SC_LINE_COMMENT;
 179   }
 180 }
 181
 182 <SC_RULE_ACTION>
 183 {
 184   "$"("<"{tag}">")?{ref}  {
 185     ref_tail_fields = 0;
 186     handle_action_dollar (self->rule, yytext, *loc);
 187     if (ref_tail_fields) {
 188       obstack_sgrow (&obstack_for_string, ref_tail_fields);
 189     }
 190     need_semicolon = true;
 191   }
 192   "@"{ref} {
 193     ref_tail_fields = 0;
 194     handle_action_at (self->rule, yytext, *loc);
 195     if (ref_tail_fields) {
 196       obstack_sgrow (&obstack_for_string, ref_tail_fields);
 197     }
 198     need_semicolon = true;
 199   }
 200   "$"  {
 201     warn_at (*loc, _("stray `$'"));
 202     obstack_sgrow (&obstack_for_string, "$][");
 203     need_semicolon = true;
 204   }
 205   "@"  {
 206     warn_at (*loc, _("stray `@'"));
 207     obstack_sgrow (&obstack_for_string, "@@");
 208     need_semicolon = true;
 209   }
 210   "["  {
 211     obstack_sgrow (&obstack_for_string, "@{");
 212     need_semicolon = true;
 213   }
 214   "]"  {
 215     obstack_sgrow (&obstack_for_string, "@}");
 216     need_semicolon = true;
 217   }
 218
 219   ";"  STRING_GROW;                 need_semicolon = false;
 220   "{"  STRING_GROW; ++braces_level; need_semicolon = false;
 221   "}"  {
 222     bool outer_brace = --braces_level == 0;
 223
 224     /* As an undocumented Bison extension, append `;' before the last
 225        brace in braced code, so that the user code can omit trailing
 226        `;'.  But do not append `;' if emulating Yacc, since Yacc does
 227        not append one.  */
 228     if (outer_brace && !yacc_flag && language_prio == default_prio
 229         && skeleton_prio == default_prio && need_semicolon && ! in_cpp)
 230       {
 231         warn_at (*loc, _("a `;' might be needed at the end of action code"));
 232         warn_at (*loc, _("future versions of Bison will not add the `;'"));
 233         obstack_1grow (&obstack_for_string, ';');
 234       }
 235
 236     STRING_GROW;
 237     need_semicolon = false;
 238   }
 239
 240   /* Preprocessing directives should only be recognized at the beginning
 241      of lines, allowing whitespace including comments, but in C/C++,
 242      `#' can only be the start of preprocessor directives or within
 243      `#define' directives anyway, so don't bother with begin of line.  */
 244   "#"       STRING_GROW; in_cpp = true;
 245
 246   {splice}  STRING_GROW;
 247   [\n\r]    STRING_GROW; if (in_cpp) in_cpp = need_semicolon = false;
 248   [ \t\f]   STRING_GROW;
 249   .         STRING_GROW; need_semicolon = true;
 250 }
 251
 252 <SC_SYMBOL_ACTION>
 253 {
 254   "$$" {
 255     obstack_sgrow (&obstack_for_string, "]b4_dollar_dollar[");
 256     self->is_value_used = true;
 257   }
 258   "@$" {
 259     obstack_sgrow (&obstack_for_string, "]b4_at_dollar[");
 260     muscle_percent_define_ensure("locations", the_location, true);
 261   }
 262 }
 263
 264
 265   /*-----------------------------------------.
 266   | Escape M4 quoting characters in C code.  |
 267   `-----------------------------------------*/
 268
 269 <*>
 270 {
 271   \$    obstack_sgrow (&obstack_for_string, "$][");
 272   \@    obstack_sgrow (&obstack_for_string, "@@");
 273   \[    obstack_sgrow (&obstack_for_string, "@{");
 274   \]    obstack_sgrow (&obstack_for_string, "@}");
 275 }
 276
 277   /*-----------------------------------------------------.
 278   | By default, grow the string obstack with the input.  |
 279   `-----------------------------------------------------*/
 280
 281 <*>.|\n STRING_GROW;
 282
 283  /* End of processing. */
 284 <*><<EOF>>       {
 285                    STRING_FINISH;
 286                    return last_string;
 287                  }
 288
 289 %%
 290
 291 static inline bool
 292 is_dot_or_dash (char ch)
 293 {
 294   return ch == '.' || ch == '-';
 295 }
 296
 297 static inline bool
 298 contains_dot_or_dash (const char* p)
 299 {
 300   for (; *p; ++p)
 301     if (is_dot_or_dash (*p))
 302       return true;
 303   return false;
 304 }
 305
 306 /* Defines a variant of a symbolic name resolution. */
 307 typedef struct
 308 {
 309   /* Index in symbol list. */
 310   unsigned index;
 311
 312   /* Matched symbol id and loc. */
 313   uniqstr id;
 314   location loc;
 315
 316   /* Hiding named reference. */
 317   named_ref* hidden_by;
 318
 319   /* Error flags. May contain zero (no errors) or
 320      a combination of VARIANT_* values. */
 321   unsigned err;
 322 } variant;
 323
 324 /* Set when the variant refers to a symbol hidden
 325    by an explicit symbol reference. */
 326 #define VARIANT_HIDDEN (1 << 0)
 327
 328 /* Set when the variant refers to a symbol containing
 329    dots or dashes. Will require explicit bracketing. */
 330 #define VARIANT_BAD_BRACKETING (1 << 1)
 331
 332 /* Set when the variant refers to a symbol which is
 333    not visible from current midrule. */
 334 #define VARIANT_NOT_VISIBLE_FROM_MIDRULE (1 << 2)
 335
 336 static variant *variant_table = 0;
 337 static unsigned variant_table_size = 0;
 338 static unsigned variant_count = 0;
 339
 340 static variant *
 341 variant_table_grow (void)
 342 {
 343   ++variant_count;
 344   if (variant_count > variant_table_size)
 345     {
 346       while (variant_count > variant_table_size)
 347         variant_table_size = 2 * variant_table_size + 3;
 348       variant_table = xnrealloc (variant_table, variant_table_size,
 349                                  sizeof *variant_table);
 350     }
 351   return &variant_table[variant_count - 1];
 352 }
 353
 354 static void
 355 variant_table_free (void)
 356 {
 357   free (variant_table);
 358   variant_table = 0;
 359   variant_table_size = variant_count = 0;
 360 }
 361
 362 static char *
 363 find_prefix_end (const char *prefix, char *begin, char *end)
 364 {
 365   char *ptr = begin;
 366
 367   for (; *prefix && ptr != end; ++prefix, ++ptr)
 368     if (*prefix != *ptr)
 369       return 0;
 370
 371   if (*prefix)
 372     return 0;
 373
 374   return ptr;
 375 }
 376
 377 static variant *
 378 variant_add (uniqstr id, location id_loc, unsigned symbol_index,
 379              char *cp, char *cp_end, bool exact_mode)
 380 {
 381   char *prefix_end;
 382
 383   prefix_end = find_prefix_end (id, cp, cp_end);
 384   if (prefix_end &&
 385       (prefix_end == cp_end ||
 386        (!exact_mode && is_dot_or_dash (*prefix_end))))
 387     {
 388       variant *r = variant_table_grow ();
 389       r->index = symbol_index;
 390       r->id = id;
 391       r->loc = id_loc;
 392       r->hidden_by = NULL;
 393       r->err = 0;
 394       return r;
 395     }
 396   else
 397     return NULL;
 398 }
 399
 400 static const char *
 401 get_at_spec(unsigned symbol_index)
 402 {
 403   static char at_buf[20];
 404   if (symbol_index == 0)
 405     strcpy (at_buf, "$$");
 406   else
 407     snprintf (at_buf, sizeof at_buf, "$%u", symbol_index);
 408   return at_buf;
 409 }
 410
 411 /* Returned from "parse_ref" when the reference
 412    is inappropriate. */
 413 #define INVALID_REF (INT_MIN)
 414
 415 /* Returned from "parse_ref" when the reference
 416    points to LHS ($$) of the current rule. */
 417 #define LHS_REF (INT_MIN + 1)
 418
 419 /* Parse named or positional reference. In case of positional
 420    references, can return negative values for $-n "deep" stack
 421    accesses. */
 422 static long int
 423 parse_ref (char *cp, symbol_list *rule, int rule_length,
 424            int midrule_rhs_index, char *text, location text_loc,
 425            char dollar_or_at)
 426 {
 427   symbol_list *l;
 428   char *cp_end;
 429   bool exact_mode;
 430   bool has_error;
 431   bool has_valid;
 432   unsigned i;
 433
 434   if ('$' == *cp)
 435     return LHS_REF;
 436
 437   if (c_isdigit (*cp) || (*cp == '-' && c_isdigit (* (cp + 1))))
 438     {
 439       long int num = strtol (cp, &cp, 10);
 440       if (1 - INT_MAX + rule_length <= num && num <= rule_length)
 441         return num;
 442       else
 443         {
 444           complain_at (text_loc, _("integer out of range: %s"),
 445                        quote (text));
 446           return INVALID_REF;
 447         }
 448     }
 449
 450   if ('[' == *cp)
 451     {
 452       /* Ignore the brackets. */
 453       char *p;
 454       for (p = ++cp; *p != ']'; ++p)
 455         continue;
 456       cp_end = p;
 457
 458       exact_mode = true;
 459     }
 460   else
 461     {
 462       /* Take all characters of the name. */
 463       char* p;
 464       for (p = cp; *p; ++p)
 465         if (is_dot_or_dash (*p))
 466           {
 467             ref_tail_fields = p;
 468             break;
 469           }
 470       for (p = cp; *p; ++p)
 471         continue;
 472       cp_end = p;
 473
 474       exact_mode = false;
 475     }
 476
 477   /* Add all relevant variants. */
 478   {
 479     unsigned symbol_index;
 480     variant_count = 0;
 481     for (symbol_index = 0, l = rule; !symbol_list_null (l);
 482          ++symbol_index, l = l->next)
 483       {
 484         variant *var;
 485         if (l->content_type != SYMLIST_SYMBOL)
 486           continue;
 487
 488         var = variant_add (l->content.sym->tag, l->sym_loc,
 489                            symbol_index, cp, cp_end, exact_mode);
 490         if (var && l->named_ref)
 491           var->hidden_by = l->named_ref;
 492
 493         if (l->named_ref)
 494           variant_add (l->named_ref->id, l->named_ref->loc,
 495                        symbol_index, cp, cp_end, exact_mode);
 496       }
 497   }
 498
 499   /* Check errors. */
 500   has_error = false;
 501   has_valid = false;
 502   for (i = 0; i < variant_count; ++i)
 503     {
 504       variant *var = &variant_table[i];
 505       unsigned symbol_index = var->index;
 506
 507       /* Check visibility from mid-rule actions. */
 508       if (midrule_rhs_index != 0
 509           && (symbol_index == 0 || midrule_rhs_index < symbol_index))
 510         {
 511           var->err |= VARIANT_NOT_VISIBLE_FROM_MIDRULE;
 512           has_error = true;
 513         }
 514
 515       /* Check correct bracketing. */
 516       if (!exact_mode && contains_dot_or_dash (var->id))
 517         {
 518           var->err |= VARIANT_BAD_BRACKETING;
 519           has_error = true;
 520         }
 521
 522       /* Check using of hidden symbols. */
 523       if (var->hidden_by)
 524         {
 525           var->err |= VARIANT_HIDDEN;
 526           has_error = true;
 527         }
 528
 529       if (!var->err)
 530         has_valid = true;
 531     }
 532
 533   if (variant_count == 1 && has_valid)
 534     {
 535       /* The only "good" case is here. */
 536       unsigned symbol_index = variant_table[0].index;
 537       if (symbol_index == midrule_rhs_index)
 538         return LHS_REF;
 539       else
 540         return symbol_index;
 541     }
 542
 543   /* Start complaining. */
 544
 545   if (variant_count == 0)
 546     complain_at (text_loc, _("invalid reference: %s, symbol not found"),
 547                  quote (text));
 548   else if (variant_count > 1 && !has_error)
 549     complain_at (text_loc, _("ambiguous reference: %s"),
 550                  quote (text));
 551   else if (variant_count > 1 && has_valid && has_error)
 552     complain_at (text_loc, _("misleading reference: %s"),
 553                  quote (text));
 554   else
 555     complain_at (text_loc, _("invalid reference: %s"),
 556                  quote (text));
 557
 558   for (i = 0; i < variant_count; ++i)
 559     {
 560       const variant *var = &variant_table[i];
 561       const char *at_spec = get_at_spec (var->index);
 562
 563       if (var->err == 0)
 564         complain_at (var->loc, _("  refers to: %c%s at %s"),
 565                      dollar_or_at, var->id, at_spec);
 566       else
 567         {
 568           static struct obstack msg_buf;
 569           const char *tail = exact_mode ? "" :
 570             cp + strlen (var->id);
 571           const char *id = var->hidden_by ? var->hidden_by->id :
 572             var->id;
 573           location id_loc = var->hidden_by ? var->hidden_by->loc :
 574             var->loc;
 575
 576           /* Create the explanation message. */
 577           obstack_init (&msg_buf);
 578
 579           obstack_fgrow1 (&msg_buf, "  possibly meant: %c", dollar_or_at);
 580           if (contains_dot_or_dash (id))
 581             obstack_fgrow1 (&msg_buf, "[%s]", id);
 582           else
 583             obstack_sgrow (&msg_buf, id);
 584           obstack_sgrow (&msg_buf, tail);
 585
 586           if (var->err & VARIANT_HIDDEN)
 587             {
 588               obstack_fgrow1 (&msg_buf, ", hiding %c", dollar_or_at);
 589               if (contains_dot_or_dash (var->id))
 590                 obstack_fgrow1 (&msg_buf, "[%s]", var->id);
 591               else
 592                 obstack_sgrow (&msg_buf, var->id);
 593               obstack_sgrow (&msg_buf, tail);
 594             }
 595
 596           obstack_fgrow1 (&msg_buf, " at %s", at_spec);
 597
 598           if (var->err & VARIANT_NOT_VISIBLE_FROM_MIDRULE)
 599             obstack_fgrow1 (&msg_buf, ", cannot be accessed from "
 600                             "mid-rule action at $%d", midrule_rhs_index);
 601
 602           obstack_1grow (&msg_buf, '\0');
 603           complain_at (id_loc, _("%s"), (char *) obstack_finish (&msg_buf));
 604           obstack_free (&msg_buf, 0);
 605         }
 606     }
 607
 608   return INVALID_REF;
 609 }
 610
 611 /* Keeps track of the maximum number of semantic values to the left of
 612    a handle (those referenced by $0, $-1, etc.) are required by the
 613    semantic actions of this grammar. */
 614 int max_left_semantic_context = 0;
 615
 616
 617 /*------------------------------------------------------------------.
 618 | TEXT is pointing to a wannabee semantic value (i.e., a `$').      |
 619 |                                                                   |
 620 | Possible inputs: $[<TYPENAME>]($|integer)                         |
 621 |                                                                   |
 622 | Output to OBSTACK_FOR_STRING a reference to this semantic value.  |
 623 `------------------------------------------------------------------*/
 624
 625 static void
 626 handle_action_dollar (symbol_list *rule, char *text, location dollar_loc)
 627 {
 628   char const *type_name = NULL;
 629   char *cp = text + 1;
 630   char *gt_ptr = 0;
 631   symbol_list *effective_rule;
 632   int effective_rule_length;
 633   int n;
 634
 635   if (rule->midrule_parent_rule)
 636     {
 637       effective_rule = rule->midrule_parent_rule;
 638       effective_rule_length = rule->midrule_parent_rhs_index - 1;
 639     }
 640   else
 641     {
 642       effective_rule = rule;
 643       effective_rule_length = symbol_list_length (rule->next);
 644     }
 645
 646   /* Get the type name if explicit. */
 647   if (*cp == '<')
 648     {
 649       type_name = ++cp;
 650       while (*cp != '>')
 651         ++cp;
 652
 653       /* The '>' symbol will be later replaced by '\0'. Original
 654          'text' is needed for error messages. */
 655       gt_ptr = cp;
 656       ++cp;
 657       if (untyped_var_seen)
 658         complain_at (dollar_loc, _("explicit type given in untyped grammar"));
 659       tag_seen = true;
 660     }
 661
 662   n = parse_ref (cp, effective_rule, effective_rule_length,
 663                  rule->midrule_parent_rhs_index, text, dollar_loc, '$');
 664
 665   if (gt_ptr)
 666     *gt_ptr = '\0';
 667
 668   switch (n)
 669     {
 670     case INVALID_REF:
 671       break;
 672
 673     case LHS_REF:
 674       if (!type_name)
 675         type_name = symbol_list_n_type_name_get (rule, dollar_loc, 0);
 676
 677       if (!type_name)
 678         {
 679           if (union_seen | tag_seen)
 680             {
 681               if (rule->midrule_parent_rule)
 682                 complain_at (dollar_loc,
 683                              _("$$ for the midrule at $%d of `%s'"
 684                                " has no declared type"),
 685                              rule->midrule_parent_rhs_index,
 686                              effective_rule->content.sym->tag);
 687               else
 688                 complain_at (dollar_loc, _("$$ of `%s' has no declared type"),
 689                              rule->content.sym->tag);
 690             }
 691           else
 692             untyped_var_seen = true;
 693           type_name = "";
 694         }
 695
 696       obstack_fgrow1 (&obstack_for_string,
 697                       "]b4_lhs_value([%s])[", type_name);
 698       rule->action_props.is_value_used = true;
 699       break;
 700
 701     default:
 702       if (max_left_semantic_context < 1 - n)
 703         max_left_semantic_context = 1 - n;
 704       if (!type_name && 0 < n)
 705         type_name =
 706           symbol_list_n_type_name_get (effective_rule, dollar_loc, n);
 707       if (!type_name)
 708         {
 709           if (union_seen | tag_seen)
 710             complain_at (dollar_loc, _("$%s of `%s' has no declared type"),
 711                          cp, effective_rule->content.sym->tag);
 712           else
 713             untyped_var_seen = true;
 714           type_name = "";
 715         }
 716
 717       obstack_fgrow3 (&obstack_for_string,
 718                       "]b4_rhs_value(%d, %d, [%s])[",
 719                       effective_rule_length, n, type_name);
 720       if (n > 0)
 721         symbol_list_n_get (effective_rule, n)->action_props.is_value_used =
 722           true;
 723       break;
 724     }
 725 }
 726
 727
 728 /*------------------------------------------------------.
 729 | TEXT is a location token (i.e., a `@...').  Output to |
 730 | OBSTACK_FOR_STRING a reference to this location.      |
 731 `------------------------------------------------------*/
 732
 733 static void
 734 handle_action_at (symbol_list *rule, char *text, location at_loc)
 735 {
 736   char *cp = text + 1;
 737   symbol_list *effective_rule;
 738   int effective_rule_length;
 739   int n;
 740
 741   if (rule->midrule_parent_rule)
 742     {
 743       effective_rule = rule->midrule_parent_rule;
 744       effective_rule_length = rule->midrule_parent_rhs_index - 1;
 745     }
 746   else
 747     {
 748       effective_rule = rule;
 749       effective_rule_length = symbol_list_length (rule->next);
 750     }
 751
 752   muscle_percent_define_ensure("locations", at_loc, true);
 753
 754   n = parse_ref (cp, effective_rule, effective_rule_length,
 755                        rule->midrule_parent_rhs_index, text, at_loc, '@');
 756   switch (n)
 757     {
 758     case INVALID_REF:
 759       break;
 760
 761     case LHS_REF:
 762       obstack_sgrow (&obstack_for_string, "]b4_lhs_location[");
 763       break;
 764
 765     default:
 766       obstack_fgrow2 (&obstack_for_string, "]b4_rhs_location(%d, %d)[",
 767                       effective_rule_length, n);
 768       break;
 769     }
 770 }
 771
 772
 773 /*-------------------------.
 774 | Initialize the scanner.  |
 775 `-------------------------*/
 776
 777 /* Translate the dollars and ats in \a self, in the context \a sc_context
 778    (SC_RULE_ACTION, SC_SYMBOL_ACTION, INITIAL).  */
 779
 780 static char const *
 781 translate_action (code_props *self, int sc_context)
 782 {
 783   char *res;
 784   static bool initialized = false;
 785   if (!initialized)
 786     {
 787       obstack_init (&obstack_for_string);
 788       yy_flex_debug = 0;
 789       initialized = true;
 790     }
 791
 792   loc->start = loc->end = self->location.start;
 793   yy_switch_to_buffer (yy_scan_string (self->code));
 794   res = code_lex (self, sc_context);
 795   yy_delete_buffer (YY_CURRENT_BUFFER);
 796
 797   return res;
 798 }
 799
 800 /*------------------------------------------------------------------------.
 801 | Implementation of the public interface as documented in "scan-code.h".  |
 802 `------------------------------------------------------------------------*/
 803
 804 void
 805 code_props_none_init (code_props *self)
 806 {
 807   *self = code_props_none;
 808 }
 809
 810 code_props const code_props_none = CODE_PROPS_NONE_INIT;
 811
 812 void
 813 code_props_plain_init (code_props *self, char const *code,
 814                        location code_loc)
 815 {
 816   self->kind = CODE_PROPS_PLAIN;
 817   self->code = code;
 818   self->location = code_loc;
 819   self->is_value_used = false;
 820   self->rule = NULL;
 821   self->named_ref = NULL;
 822 }
 823
 824 void
 825 code_props_symbol_action_init (code_props *self, char const *code,
 826                                location code_loc)
 827 {
 828   self->kind = CODE_PROPS_SYMBOL_ACTION;
 829   self->code = code;
 830   self->location = code_loc;
 831   self->is_value_used = false;
 832   self->rule = NULL;
 833   self->named_ref = NULL;
 834 }
 835
 836 void
 837 code_props_rule_action_init (code_props *self, char const *code,
 838                              location code_loc, symbol_list *rule,
 839                              named_ref *name)
 840 {
 841   self->kind = CODE_PROPS_RULE_ACTION;
 842   self->code = code;
 843   self->location = code_loc;
 844   self->is_value_used = false;
 845   self->rule = rule;
 846   self->named_ref = name;
 847 }
 848
 849 void
 850 code_props_translate_code (code_props *self)
 851 {
 852   switch (self->kind)
 853     {
 854       case CODE_PROPS_NONE:
 855         break;
 856       case CODE_PROPS_PLAIN:
 857         self->code = translate_action (self, INITIAL);
 858         break;
 859       case CODE_PROPS_SYMBOL_ACTION:
 860         self->code = translate_action (self, SC_SYMBOL_ACTION);
 861         break;
 862       case CODE_PROPS_RULE_ACTION:
 863         self->code = translate_action (self, SC_RULE_ACTION);
 864         break;
 865     }
 866 }
 867
 868 void
 869 code_scanner_last_string_free (void)
 870 {
 871   STRING_FREE;
 872 }
 873
 874 void
 875 code_scanner_free (void)
 876 {
 877   obstack_free (&obstack_for_string, 0);
 878   variant_table_free ();
 879
 880   /* Reclaim Flex's buffers.  */
 881   yylex_destroy ();
 882 }