lrama 0.6.10 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fce10e3be7a24cd5dcae139d72e41bb586cb2a34bb6a6cd06412a420e65513b
-  data.tar.gz: 663d42179f28318ecb2a120d726dfcdfc8f599f2732771d39ed2d6a9e88fe07d
+  metadata.gz: 9c967547ee9de2d87e1e275bf5d9b1f525b7040f110ee41b9144b163923a3dd6
+  data.tar.gz: f9ada41c05e186245e11dfca1dc31da2f2bf8987090b91ed5312369ad1306e64
 SHA512:
-  metadata.gz: 469a0e7bf84b68092e90187df12d7c9a71273e26caded2b27742cb7a83930a76626f73f2f872c931f496816348005a986d7edce639c326f7a83ed697708b4013
-  data.tar.gz: f053199c82ca39d614c56c55fd09daeb441e7e3b7504165042ee3c6a1275c400d640822365d939145a3a7a6c791da63119e614c4e5a36ad4f0cfa57a7561baa4
+  metadata.gz: efa3c528e1f8070c26b42e71329c058b874b530d3e13a64047898928099994a94de131a05c491464cdd566c806a2424e427113987f5240ec13e281c7bcb9bdd2
+  data.tar.gz: da9ea52d9fa0534e168baf3f62fab8df091caca127201c085c641552fd3f7aaf09ad7f60ad49725a8874b444eb655e881064481907bd1f5ba82481d9db118398

data/.github/workflows/gh-pages.yml

@@ -0,0 +1,46 @@
+name: Deploy Lrama documentation to GitHub Pages
+
+on:
+  push:
+    branches: ["master"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: ${{ github.repository == 'ruby/lrama' && !startsWith(github.event_name, 'pull') }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@f26937343756480a8cb3ae1f623b9c8d89ed6984 # v1.196.0
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with Lrama
+        run: bundle exec rake rdoc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

data/.github/workflows/test.yaml

@@ -16,7 +16,7 @@ jobs:
 
   test:
     needs: ruby-versions
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
@@ -54,9 +54,28 @@ jobs:
       - run: flex --help
       - run: bundle install
       - run: bundle exec rspec
+  test-c:
+    needs: ruby-versions
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['head']
+        compiler: ['cc', 'gcc', 'clang']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: flex --help
+      - run: bundle install
+      - run: bundle exec rspec
+        env:
+          COMPILER: ${{ matrix.compiler }}
   test-cpp:
     needs: ruby-versions
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
@@ -74,7 +93,7 @@ jobs:
         env:
           COMPILER: ${{ matrix.compiler }}
   test-memory:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
@@ -94,7 +113,7 @@ jobs:
         env:
           ENABEL_VALGRIND: 'true'
   check-misc:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         ruby: ['head']
@@ -122,7 +141,7 @@ jobs:
           bundle exec rake build:parser
           git diff --color --no-ext-diff --ignore-submodules --exit-code lib/lrama/parser.rb
   steep-check:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
@@ -136,10 +155,19 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - run: bundle install
+      - run: bundle exec rbs-inline --output lib/
+      - name: Check for uncommitted changes
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "Uncommitted changes detected after running rbs-inline."
+            echo "Please run 'bundle rake rbs_inline' and commit the changes generated by rbs-inline." >&2
+            exit 1
+          fi
+        shell: bash
       - run: bundle exec rbs collection install
       - run: bundle exec steep check
   test-ruby:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
@@ -184,6 +212,10 @@ jobs:
           sudo apt-get install -q -y pkg-config${arch} || :
       - run: sudo apt-get --purge remove bison
       - run: ../autogen.sh
-      - run: ../configure -C --disable-install-doc
+      - run: ../configure -C --disable-install-doc --with-parser=parse.y
       - run: make
-      - run: make test-all
+      - run: make test-all RUN_OPTS="$RUN_OPTS" SPECOPTS="$SPECOPTS"
+        env:
+          EXCLUDES: '../test/.excludes-parsey'
+          RUN_OPTS: ${{ matrix.run_opts || '--parser=parse.y' }}
+          SPECOPTS: ${{ matrix.specopts || '-T --parser=parse.y' }}

data/.gitignore

@@ -10,3 +10,4 @@
 /tmp/
 /vendor/bundle
 /.idea/
+_site/

data/.rdoc_options

@@ -0,0 +1,2 @@
+page_dir: doc
+warn_missing_rdoc_ref: true

data/Gemfile

@@ -7,6 +7,7 @@ gemspec
 gem "pry"
 gem "racc", "1.8.1"
 gem "rake"
+gem "rdoc"
 gem "rspec"
 gem "simplecov", require: false
 gem "stackprof", platforms: [:ruby] # stackprof doesn't support Windows
@@ -15,6 +16,7 @@ gem "memory_profiler"
 # Recent steep requires Ruby >= 3.0.0.
 # Then skip install on some CI jobs.
 if !ENV['GITHUB_ACTION'] || ENV['INSTALL_STEEP'] == 'true'
-  gem "rbs", "3.5.3", require: false
-  gem "steep", "1.7.1", require: false
+  gem "rbs", "3.8.1", require: false
+  gem "rbs-inline", require: false
+  gem "steep", "1.9.3", require: false
 end

data/NEWS.md

@@ -1,12 +1,107 @@
 # NEWS for Lrama
 
+## Lrama 0.7.0 (2025-01-21)
+
+## [EXPERIMENTAL] Support the generation of the IELR(1) parser described in this paper
+
+Support the generation of the IELR(1) parser described in this paper.
+https://www.sciencedirect.com/science/article/pii/S0167642309001191
+
+If you use IELR(1) parser, you can write the following directive in your grammar file.
+
+```yacc
+%define lr.type ielr
+```
+
+But, currently IELR(1) parser is experimental feature. If you find any bugs, please report it to us. Thank you.
+
+## Support `-t` option as same as `--debug` option
+
+Support to `-t` option as same as `--debug` option.
+These options align with Bison behavior. So same as `--debug` option.
+
+## Trace only explicit rules
+
+Support to trace only explicit rules.
+If you use `--trace=rules` option, it shows include mid-rule actions. If you want to show only explicit rules, you can use `--trace=only-explicit-rules` option.
+
+Example:
+
+```yacc
+%{
+%}
+%union {
+    int i;
+}
+%token <i> number
+%type <i> program
+%%
+program         : number { printf("%d", $1); } number { $$ = $1 + $3; }
+                ;
+%%
+```
+
+Result of `--trace=rules`:
+
+```console
+$ exe/lrama --trace=rules sample.y
+Grammar rules:
+$accept -> program YYEOF
+$@1 -> ε
+program -> number $@1 number
+```
+
+Result of `--trace=only-explicit-rules`:
+
+```console
+$ exe/lrama --trace=explicit-rules sample.y
+Grammar rules:
+$accept -> program YYEOF
+program -> number number
+```
+
+## Lrama 0.6.11 (2024-12-23)
+
+### Add support for %type declarations using %nterm in Nonterminal Symbols
+
+Allow to use `%nterm` in Nonterminal Symbols for `%type` declarations.
+
+```yacc
+%nterm <type> nonterminal…
+```
+
+This directive is also supported for compatibility with Bison, and only non-terminal symbols are allowed. In other words, definitions like the following will result in an error:
+
+```yacc
+%{
+// Prologue
+%}
+
+%token EOI 0 "EOI"
+%nterm EOI
+
+%%
+
+program: /* empty */
+        ;
+```
+
+It show an error message like the following:
+
+```command
+❯ exe/lrama nterm.y
+nterm.y:6:7: symbol EOI redeclared as a nonterminal
+%nterm EOI
+       ^^^
+```
+
 ## Lrama 0.6.10 (2024-09-11)
 
 ### Aliased Named References for actions of RHS in parameterizing rules
 
 Allow to use aliased named references for actions of RHS in parameterizing rules.
 
-```
+```yacc
 %rule sum(X, Y): X[summand] '+' Y[addend] { $$ = $summand + $addend }
                ;
 ```
@@ -18,7 +113,7 @@ https://github.com/ruby/lrama/pull/410
 
 Allow to use named references for actions of RHS in parameterizing rules caller side.
 
-```
+```yacc
 opt_nl: '\n'?[nl] <str> { $$ = $nl; }
       ;
 ```
@@ -29,7 +124,7 @@ https://github.com/ruby/lrama/pull/414
 
 Allow to define parameterizing rules in the middle of the grammar.
 
-```
+```yacc
 %rule defined_option(X): /* empty */
                        | X
                        ;
@@ -52,8 +147,8 @@ https://github.com/ruby/lrama/pull/420
 Support to report unused terminal symbols.
 Run `exe/lrama --report=terms` to show unused terminal symbols.
 
-```
-❯ exe/lrama --report=terms sample/calc.y
+```console
+$ exe/lrama --report=terms sample/calc.y
  11 Unused Terms
      0 YYerror
      1 YYUNDEF
@@ -74,8 +169,8 @@ https://github.com/ruby/lrama/pull/439
 Support to report unused rules.
 Run `exe/lrama --report=rules` to show unused rules.
 
-```
-❯ exe/lrama --report=rules sample/calc.y
+```console
+$ exe/lrama --report=rules sample/calc.y
   3 Unused Rules
      0 unused_option
      1 unused_list
@@ -96,8 +191,8 @@ https://github.com/ruby/lrama/pull/446
 Support to warning redefined parameterizing rules.
 Run `exe/lrama -W` or  `exe/lrama --warnings` to show redefined parameterizing rules.
 
-```
-❯ exe/lrama -W sample/calc.y
+```console
+$ exe/lrama -W sample/calc.y
 parameterizing rule redefined: redefined_method(X)
 parameterizing rule redefined: redefined_method(X)
 ```
@@ -117,7 +212,7 @@ https://github.com/ruby/lrama/pull/457
 
 Allow to specify tag on callee side of parameterizing rules.
 
-```
+```yacc
 %union {
     int i;
 }
@@ -130,7 +225,7 @@ Allow to specify tag on callee side of parameterizing rules.
 
 Allow to use named references for actions of RHS in parameterizing rules.
 
-```
+```yacc
 %rule option(number): /* empty */
                     | number { $$ = $number; }
                     ;
@@ -142,7 +237,7 @@ Allow to use named references for actions of RHS in parameterizing rules.
 
 Allow to nested parameterizing rules with tag.
 
-```
+```yacc
 %union {
     int i;
 }
@@ -179,8 +274,8 @@ User can use `'symbol'?`, `'symbol'+` and `'symbol'*` in RHS of user defined par
 Support trace actions for debugging.
 Run `exe/lrama --trace=actions` to show grammar rules with actions.
 
-```
-❯ exe/lrama --trace=actions sample/calc.y
+```console
+$ exe/lrama --trace=actions sample/calc.y
 Grammar rules with actions:
 $accept -> list, YYEOF {}
 list -> ε {}
@@ -199,7 +294,7 @@ expr -> '(', expr, ')' { $$ = $2; }
 Support inlining for rules.
 The `%inline` directive causes all references to symbols to be replaced with its definition.
 
-```
+```yacc
 %rule %inline op: PLUS { + }
                 | TIMES { * }
                 ;
@@ -213,7 +308,7 @@ expr : number { $$ = $1; }
 
 as same as
 
-```
+```yacc
 expr : number { $$ = $1; }
      | expr '+' expr { $$ = $1 + $3; }
      | expr '*' expr { $$ = $1 * $3; }
@@ -226,7 +321,7 @@ expr : number { $$ = $1; }
 
 User can specify the type of mid rule action by tag (`<bar>`) instead of specifying it with in an action.
 
-```
+```yacc
 primary: k_case expr_value terms?
            {
                $<val>$ = p->case_labels;
@@ -241,7 +336,7 @@ primary: k_case expr_value terms?
 
 can be written as
 
-```
+```yacc
 primary: k_case expr_value terms?
            {
                $$ = p->case_labels;
@@ -266,7 +361,7 @@ Bison supports this feature from 3.1.
 
 Support `preceded`, `terminated` and `delimited` rules.
 
-```
+```text
 program: preceded(opening, X)
 
 // Expanded to
@@ -302,7 +397,7 @@ In general, these resources are freed by actions or after parsing.
 However if syntax error happens in parsing, these codes may not be executed.
 Codes associated to `%destructor` are executed when semantic value is popped from the stack by an error.
 
-```
+```yacc
 %token <val1> NUM
 %type <val2> expr2
 %type <val3> expr
@@ -350,7 +445,7 @@ Lrama provides these five callbacks. Registered functions are called when each e
 User also needs to access semantic value of their stack in grammar action. `$:n` provides the way to access to it. `$:n` is translated to the minus index from the top of the stack.
 For example
 
-```
+```yacc
 primary: k_if expr_value then compstmt if_tail k_end
           {
           /*% ripper: if!($:2, $:4, $:5) %*/
@@ -375,7 +470,7 @@ https://github.com/ruby/lrama/pull/344
 
 Allow to pass an instantiated rule to other parameterizing rules.
 
-```
+```yacc
 %rule constant(X) : X
                   ;
 
@@ -392,7 +487,7 @@ program         : option(constant(number)) // Nested rule
 
 Allow to use nested parameterizing rules when define parameterizing rules.
 
-```
+```yacc
 %rule option(x) : /* empty */
                 | X
                 ;
@@ -419,7 +514,7 @@ https://github.com/ruby/lrama/pull/337
 
 Allow to define parameterizing rule by `%rule` directive.
 
-```
+```yacc
 %rule pair(X, Y): X Y { $$ = $1 + $2; }
                 ;
 
@@ -442,7 +537,7 @@ https://github.com/ruby/lrama/pull/285
 Allow to specify type of rules by specifying tag, `<i>` in below example.
 Tag is post-modification style.
 
-```
+```yacc
 %union {
     int i;
 }
@@ -469,7 +564,7 @@ https://github.com/ruby/lrama/pull/197
 
 Support `separated_list` and `separated_nonempty_list` parameterizing rules.
 
-```
+```text
 program: separated_list(',', number)
 
 // Expanded to
@@ -500,7 +595,7 @@ https://github.com/ruby/lrama/pull/204
 Parameterizing rules are template of rules.
 It's very common pattern to write "list" grammar rule like:
 
-```
+```yacc
 opt_args: /* none */
         | args
         ;
@@ -532,7 +627,7 @@ https://github.com/ruby/lrama/pull/62
 
 ### Runtime configuration for error recovery
 
-Meke error recovery function configurable on runtime by two new macros.
+Make error recovery function configurable on runtime by two new macros.
 
 * `YYMAXREPAIR`: Expected to return max length of repair operations. `%parse-param` is passed to this function.
 * `YYERROR_RECOVERY_ENABLED`: Expected to return bool value to determine error recovery is enabled or not. `%parse-param` is passed to this function.
@@ -555,7 +650,7 @@ https://github.com/ruby/lrama/pull/44
 Instead of positional references like `$1` or `$$`,
 named references allow to access to symbol by name.
 
-```
+```yacc
 primary: k_class cpath superclass bodystmt k_end
            {
              $primary = new_class($cpath, $bodystmt, $superclass);
@@ -564,7 +659,7 @@ primary: k_class cpath superclass bodystmt k_end
 
 Alias name can be declared.
 
-```
+```yacc
 expr[result]: expr[ex-left] '+' expr[ex.right]
                 {
                   $result = $[ex-left] + $[ex.right];

data/README.md

@@ -6,19 +6,32 @@
 
 Lrama is LALR (1) parser generator written by Ruby. The first goal of this project is providing error tolerant parser for CRuby with minimal changes on CRuby parse.y file.
 
-* [Features](#features)
-* [Installation](#installation)
-* [Usage](#usage)
-* [Versions and Branches](#versions-and-branches)
-* [Supported Ruby version](#supported-ruby-version)
-* [Development](#development)
-  * [How to generate parser.rb](#how-to-generate-parserrb)
-  * [Test](#test)
-  * [Call-stack Profiling Lrama](#call-stack-profiling-lrama)
-  * [Memory Profiling Lrama](#memory-profiling-lrama)
-  * [Build Ruby](#build-ruby)
-* [Release flow](#release-flow)
-* [License](#license)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Documentation](#documentation)
+- [Versions and Branches](#versions-and-branches)
+  - [v0\_7 (`master` branch)](#v0_7-master-branch)
+  - [v0\_6 (`lrama_0_6` branch)](#v0_6-lrama_0_6-branch)
+  - [v0\_5 (`lrama_0_5` branch)](#v0_5-lrama_0_5-branch)
+  - [v0\_4 (`lrama_0_4` branch)](#v0_4-lrama_0_4-branch)
+- [Supported Ruby version](#supported-ruby-version)
+- [Development](#development)
+  - [How to generate parser.rb](#how-to-generate-parserrb)
+  - [How to Write a Type Signature](#how-to-write-a-type-signature)
+  - [Test](#test)
+  - [Call-stack Profiling Lrama](#call-stack-profiling-lrama)
+    - [1. Create parse.tmp.y in ruby/ruby](#1-create-parsetmpy-in-rubyruby)
+    - [2. Enable Profiler](#2-enable-profiler)
+    - [3. Run Lrama](#3-run-lrama)
+    - [4. Generate Flamegraph](#4-generate-flamegraph)
+  - [Memory Profiling Lrama](#memory-profiling-lrama)
+    - [1. Create parse.tmp.y in ruby/ruby](#1-create-parsetmpy-in-rubyruby-1)
+    - [2. Enable Profiler](#2-enable-profiler-1)
+    - [3. Run Lrama](#3-run-lrama-1)
+  - [Build Ruby](#build-ruby)
+- [Release flow](#release-flow)
+- [License](#license)
 
 ## Features
 
@@ -71,11 +84,19 @@ Enter the formula:
 => 9
 ```
 
+## Documentation
+
+https://ruby.github.io/lrama/ provides a comprehensive guide to Lrama's features and usage.
+
 ## Versions and Branches
 
-### v0_6 (`master` branch)
+### v0_7 (`master` branch)
+
+This branch is for Ruby 3.5. `lrama_0_7` branch is created from this branch, once Ruby 3.5 is released.
+
+### v0_6 (`lrama_0_6` branch)
 
-This branch is for Ruby 3.4. `lrama_0_6` branch is created from this branch, once Ruby 3.4 is released.
+This branch is for Ruby 3.4.
 
 ### v0_5 (`lrama_0_5` branch)
 
@@ -102,6 +123,14 @@ $ bundle exec rake build:parser
 `parser.rb` is generated from `parser.y` by Racc.
 Run the rake command when you update `parser.y` then commit changes of both files.
 
+### How to Write a Type Signature
+
+We use [Steep](https://github.com/soutaro/steep) for type checking and [rbs-inline](https://github.com/soutaro/rbs-inline) for type declarations.
+
+Currently, type signatures are declared in the [sig/lrama](https://github.com/ruby/lrama/blob/master/sig/lrama) directory. However, these files will be replaced with `rbs-inline`. This means type signatures should be written directly in the source code.
+
+For guidance on writing type signatures, refer to the [Syntax Guide](https://github.com/soutaro/rbs-inline/wiki/Syntax-guide) in the rbs-inline documentation.
+
 ### Test
 
 Running tests:

data/Rakefile

@@ -15,9 +15,21 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
 end
 task :spec => "build:parser"
 
+require "rdoc/task"
+RDoc::Task.new do |rdoc|
+  rdoc.title = "Lrama Documentation"
+  rdoc.main = "Index.md"
+  rdoc.rdoc_dir = "_site"
+end
+
 desc "steep check"
 task :steep do
   sh "bundle exec steep check"
 end
 
-task default: %i[spec steep]
+desc "Run rbs-inline"
+task :rbs_inline do
+  sh "bundle exec rbs-inline --output lib/"
+end
+
+task default: %i[spec rbs_inline steep]

data/Steepfile

@@ -7,13 +7,18 @@ target :lib do
   signature "sig"
 
   check "lib/lrama/grammar"
+
+  check "lib/lrama/counterexamples"
   check "lib/lrama/lexer"
   check "lib/lrama/report"
   check "lib/lrama/state"
   check "lib/lrama/states"
   check "lib/lrama/bitmap.rb"
+  check "lib/lrama/counterexamples.rb"
   check "lib/lrama/digraph.rb"
   check "lib/lrama/grammar.rb"
+  check "lib/lrama/logger.rb"
   check "lib/lrama/options.rb"
+  check "lib/lrama/trace_reporter.rb"
   check "lib/lrama/warning.rb"
 end