Ensure compatibility with Bison for `%locations

fix: ruby#429

lib/lrama/grammar.rb

@@ -26,13 +26,9 @@ class Grammar
     extend Forwardable
 
     attr_reader :percent_codes, :eof_symbol, :error_symbol, :undef_symbol, :accept_symbol, :aux
-    attr_accessor :union, :expect,
-                  :printers, :error_tokens,
-                  :lex_param, :parse_param, :initial_action,
+    attr_accessor :union, :expect, :printers, :error_tokens, :lex_param, :parse_param, :initial_action,
                   :after_shift, :before_reduce, :after_reduce, :after_shift_error_token, :after_pop_stack,
-                  :symbols_resolver, :types,
-                  :rules, :rule_builders,
-                  :sym_to_rules, :no_stdlib
+                  :symbols_resolver, :types, :rules, :rule_builders, :sym_to_rules, :no_stdlib, :locations
 
     def_delegators "@symbols_resolver", :symbols, :nterms, :terms, :add_nterm, :add_term,
                                         :find_symbol_by_number!, :find_symbol_by_id!, :token_to_symbol,
@@ -60,6 +56,7 @@ def initialize(rule_counter)
       @accept_symbol = nil
       @aux = Auxiliary.new
       @no_stdlib = false
+      @locations = false
 
       append_special_symbols
     end
@@ -155,6 +152,7 @@ def prepare
       fill_sym_to_rules
       compute_nullable
       compute_first_set
+      set_locations
     end
 
     # TODO: More validation methods
@@ -396,5 +394,9 @@ def validate_rule_lhs_is_nterm!
 
       raise errors.join("\n")
     end
+
+    def set_locations
+      @locations = @locations || @rules.any? {|rule| rule.contains_at_reference? }
+    end
   end
 end

lib/lrama/grammar/rule.rb

@@ -56,6 +56,12 @@ def translated_code
 
         Code::RuleAction.new(type: :rule_action, token_code: token_code, rule: self).translated_code
       end
+
+      def contains_at_reference?
+        return false unless token_code
+
+        token_code.references.any? {|r| r.type == :at }
+      end
     end
   end
 end

lib/lrama/lexer.rb

@@ -40,6 +40,7 @@ class Lexer
       %rule
       %no-stdlib
       %inline
+      %locations
     )
 
     def initialize(grammar_file)

lib/lrama/output.rb

@@ -335,7 +335,8 @@ def parse_param_use(val, loc)
 
     # b4_yylex_formals
     def yylex_formals
-      ary = ["&yylval", "&yylloc"]
+      ary = ["&yylval"]
+      ary << "&yylloc" if @grammar.locations
 
       if @grammar.lex_param
         ary << lex_param_name

parser.y

@@ -72,6 +72,7 @@ rule
                          @grammar.initial_action = Grammar::Code::InitialActionCode.new(type: :initial_action, token_code: val[3])
                        }
                    | "%no-stdlib" { @grammar.no_stdlib = true }
+                   | "%locations" { @grammar.locations = true }
 
   grammar_declaration: "%union" "{"
                          {

rbs_collection.lock.yaml

@@ -1,6 +1,14 @@
 ---
 path: ".gem_rbs_collection"
 gems:
+- name: diff-lcs
+  version: '1.5'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3c1c5abbff9e53169dbee3ceb2919b66b4ec06bf
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
 - name: erb
   version: '0'
   source:

sample/calc.y

@@ -31,6 +31,8 @@ static int yyerror(YYLTYPE *loc, const char *str);
 %left '+' '-'
 %left '*' '/'
 
+%locations
+
 %rule %inline op    : '+' { + }
                     | '-' { - }
                     | '*' { * }

sample/parse.y

@@ -8,7 +8,7 @@
 
 %code provides {
 
-static enum yytokentype yylex(YYSTYPE *lval, YYLTYPE *yylloc);
+static enum yytokentype yylex(YYSTYPE *lval);
 static void yyerror(YYLTYPE *yylloc, const char *msg);
 
 }
@@ -44,7 +44,7 @@ factor          : number
 // Epilogue
 
 static enum yytokentype
-yylex(YYSTYPE *lval, YYLTYPE *yylloc)
+yylex(YYSTYPE *lval)
 {
     return 0;
 }

sig/lrama/grammar.rbs

@@ -20,6 +20,7 @@ module Lrama
     @accept_symbol: Grammar::Symbol
     @aux: Auxiliary
     @no_stdlib: bool
+    @locations: bool
     @union: Union
 
     extend Forwardable
@@ -89,5 +90,6 @@ module Lrama
     def fill_symbols: () -> Array[Grammar::Symbol]
     def fill_sym_to_rules: () -> Array[Rule]
     def validate_rule_lhs_is_nterm!: () -> void
+    def set_locations: () -> void
   end
 end

sig/lrama/grammar/rule.rbs

@@ -29,6 +29,8 @@ module Lrama
       def initial_rule?: -> bool
 
       def with_actions: -> String
+
+      def contains_at_reference?: -> bool
     end
   end
 end

spec/fixtures/integration/after_shift.y

@@ -53,6 +53,8 @@ after_pop_stack(int len)
 %left '+' '-'
 %left '*' '/'
 
+%locations
+
 %%
 
 program : /* empty */

spec/fixtures/integration/calculator.y

@@ -17,6 +17,8 @@ static int yyerror(YYLTYPE *loc, const char *str);
 %left '+' '-'
 %left '*' '/'
 
+%locations
+
 %%
 
 program : /* empty */

spec/fixtures/integration/contains_at_reference.l

@@ -0,0 +1,40 @@
+%option noinput nounput noyywrap never-interactive yylineno bison-bridge bison-locations
+
+%{
+
+#include <stdio.h>
+#include <stdlib.h>
+#include "prologue_epilogue_optional.h"
+
+%}
+
+NUMBER [0-9]+
+
+%%
+
+{NUMBER} {
+    ((void) yylloc);
+    yylval->val = atoi(yytext);
+    return 1;
+}
+
+[+\-\*\/\(\)] {
+    return yytext[0];
+}
+
+[\n|\r\n] {
+    return(YYEOF);
+}
+
+[[:space:]] {}
+
+<<EOF>> {
+    return(YYEOF);
+}
+
+. {
+    fprintf(stderr, "Illegal character '%s'\n", yytext);
+    return(YYEOF);
+}
+
+%%

spec/fixtures/integration/contains_at_reference.y

@@ -0,0 +1,37 @@
+%{
+
+#include <stdio.h>
+#include "contains_at_reference.h"
+#include "contains_at_reference-lexer.h"
+
+static int yyerror(YYLTYPE *loc, const char *str);
+
+%}
+
+%union {
+    int val;
+}
+
+%%
+
+program : /* empty */ { (void)@1; }
+        ;
+
+%%
+
+static int yyerror(YYLTYPE *loc, const char *str) {
+    fprintf(stderr, "parse error: %s\n", str);
+    return 0;
+}
+
+int main(int argc, char *argv[]) {
+    if (argc == 2) {
+        yy_scan_string(argv[1]);
+    }
+
+    if (yyparse()) {
+        fprintf(stderr, "syntax error\n");
+        return 1;
+    }
+    return 0;
+}

spec/fixtures/integration/destructors.y

@@ -23,6 +23,8 @@ static int yyerror(YYLTYPE *loc, const char *str);
 %left '+' '-'
 %left '*' '/'
 
+%locations
+
 %destructor {
     printf("destructor for val1: %d\n", $$);
     printf("line for val1: %d\n", __LINE__);

spec/fixtures/integration/error_recovery.y

@@ -17,6 +17,8 @@ static int yyerror(YYLTYPE *loc, const char *str);
 %left '+' '-'
 %left '*' '/'
 
+%locations
+
 %error-token {
     $$ = 100;
 } NUM

spec/fixtures/integration/line_number.y

@@ -25,6 +25,8 @@ line_1(void)
 
 %token <i> NUM
 
+%locations
+
 %%
 
 program :   {

spec/fixtures/integration/named_references.y

@@ -41,6 +41,8 @@ static int yyerror(YYLTYPE *loc, const char *str);
 %token <val> NUM
 %type <val> expr
 
+%locations
+
 %%
 
 line: expr

spec/fixtures/integration/parameterizing_rules.y

@@ -23,6 +23,8 @@ static int yyerror(YYLTYPE *loc, const char *str);
 %type <num> stmt
 %type <str> opt_nl
 
+%locations
+
 %%
 
 program: stmts

spec/fixtures/integration/params.y

@@ -26,6 +26,8 @@ static int yyerror(YYLTYPE *loc, int parse_param, const char *str);
 %left '+' '-'
 %left '*' '/'
 
+%locations
+
 %%
 
 program : /* empty */

spec/fixtures/integration/printers.y

@@ -34,6 +34,8 @@ static int yyerror(YYLTYPE *loc, const char *str);
     printf("expr: %d\n", $$);
 } expr // printer for symbol
 
+%locations
+
 %%
 
 program : /* empty */

spec/fixtures/integration/prologue_epilogue_optional.y

@@ -12,6 +12,8 @@ static int yyerror(YYLTYPE *loc, const char *str);
     int val;
 }
 
+%locations
+
 %%
 
 program : /* empty */

spec/fixtures/integration/typed_midrule_actions.y

@@ -40,6 +40,8 @@ static int yyerror(YYLTYPE *loc, const char *str);
 %token <val> NUM
 %type <val> expr
 
+%locations
+
 %%
 
 line: expr

spec/fixtures/integration/user_defined_parameterizing_rules.y

@@ -30,6 +30,8 @@ static int yyerror(YYLTYPE *loc, const char *str);
                     }
                 ;
 
+%locations
+
 %%
 
 program: stmts

spec/lrama/integration_spec.rb

@@ -66,6 +66,10 @@ def generate_object(grammar_file_path, c_path, obj_path, command_args: [])
     test_parser("prologue_epilogue_optional", "", "")
   end
 
+  it "contains at reference in action" do
+    test_parser("contains_at_reference", "", "")
+  end
+
   describe "YYDEBUG, %lex-param, %parse-param option are enabled" do
     it "returns 9 for '(1+2)*3'" do
       test_parser("params", "(1+2)*3", "=> 9")
@@ -147,28 +151,28 @@ def generate_object(grammar_file_path, c_path, obj_path, command_args: [])
     it "prints messages when symbol is discarded" do
       expected = <<~STR
         destructor for expr: 1
-        line for expr: 43
+        line for expr: 45
       STR
       test_parser("destructors", "1 +", expected, expect_success: false)
 
       expected = <<~STR
         destructor for val2: 1
-        line for val2: 33
+        line for val2: 35
       STR
       test_parser("destructors", "+ 1 -", expected, expect_success: false)
 
       expected = <<~STR
         => 3
         destructor for val1: 3
-        line for val1: 28
+        line for val1: 30
       STR
       test_parser("destructors", "1 + 2 3", expected, expect_success: false)
 
       expected = <<~STR
         destructor for val4: 10
-        line for val4: 38
+        line for val4: 40
         destructor for expr: 1
-        line for expr: 43
+        line for expr: 45
       STR
       test_parser("destructors", "1 * ", expected, expect_success: false)
     end
@@ -177,10 +181,10 @@ def generate_object(grammar_file_path, c_path, obj_path, command_args: [])
   describe "__LINE__ of each place" do
     it "prints line number of each place" do
       expected = <<~STR
-        line_pre_program: 31
+        line_pre_program: 33
         line_1: 15
-        line_2: 55
-        line_post_program: 37
+        line_2: 57
+        line_post_program: 39
       STR
 
       test_parser("line_number", "1 + 2", expected)