src/scan-code.l

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