lrama 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d7cf0f612d3e1ac4aea0b45db6c0533beadd6412f10a85dd17aceefcfb104a9
+  data.tar.gz: 9e60878988696b8d300700a442cb93bb7d7919be94be80a4bd96cbfe689dad1a
+SHA512:
+  metadata.gz: 0fa702fd65a2b84c3d426c45ea6d09a5129391409408604d50767c71f8f2d059db45bbde0b8fd96f093caf3741479add35e8cb1434bdd763c38761f70a994d93
+  data.tar.gz: d2d5ed81585710107200595b38316120ccc5e01718247c08b6c7de7708ae619de1ec7e37d4ce987b6c21c31d81d5f5c812ecb385d7a6d2838be26e4cf52621f1

data/.github/workflows/test.yaml

@@ -0,0 +1,72 @@
+name: test
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['head', '3.2', '3.1', '3.0']
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle install
+      - run: bundle exec rspec
+  test-ruby:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        baseruby: ['3.0']
+        ruby_branch: ['master']
+    defaults:
+      run:
+        working-directory: ../ruby/build
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.baseruby }}
+          bundler-cache: true
+      - run: git clone --depth=1 https://github.com/ruby/ruby.git -b ${{ matrix.ruby_branch }} ../ruby
+        working-directory:
+      - run: mkdir tool/lrama
+        working-directory: ../ruby
+      - name: Copy Lrama to ruby/tool
+        run: cp -r exe lib template ../ruby/tool/lrama
+        working-directory:
+      - run: tree tool/lrama
+        working-directory: ../ruby
+      # See also https://github.com/ruby/ruby/blob/master/.github/workflows/ubuntu.yml
+      - run: mkdir build
+        working-directory: ../ruby
+      - name: Set ENV
+        run: |
+          echo "GNUMAKEFLAGS=-j$((1 + $(nproc --all)))" >> $GITHUB_ENV
+      - name: Install libraries
+        run: |
+          set -x
+          arch=${arch:+:${arch/i[3-6]86/i386}}
+          ${arch:+sudo dpkg --add-architecture ${arch#:}}
+          sudo apt-get update -q || :
+          sudo apt-get install --no-install-recommends -q -y \
+          ${arch:+cross}build-essential${arch/:/-} \
+          libssl-dev${arch} libyaml-dev${arch} libreadline6-dev${arch} \
+          zlib1g-dev${arch} libncurses5-dev${arch} libffi-dev${arch} \
+          autoconf
+          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: make YACC=$(readlink -f $(pwd)/../tool/lrama/exe/lrama)
+      - run: make test-all

data/.gitignore

@@ -0,0 +1,4 @@
+/tmp
+.irbrc
+/Gemfile.lock
+/pkg/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "rspec"
+gem "pry"
+gem "stackprof"
+gem "rake"

data/LEGAL.md

@@ -0,0 +1,26 @@
+# LEGAL NOTICE INFORMATION
+
+All the files in this distribution are covered under the MIT License except some files
+mentioned below.
+
+## GNU General Public License version 3
+
+These files are licensed under the GNU General Public License version 3. See these files for more information.
+
+* template/bison/yacc.c
+* template/bison/yacc.h
+
+## Same with Ruby
+
+These files are licensed same with Ruby. See https://github.com/ruby/ruby/blob/master/COPYING for more information.
+
+* spec/fixtures/integration/ruby_3_0_5/parse.tmp.y
+* spec/fixtures/integration/ruby_3_0_5/y.tab.c
+* spec/fixtures/integration/ruby_3_0_5/y.tab.h
+* spec/fixtures/integration/ruby_3_1_0/parse.tmp.y
+* spec/fixtures/integration/ruby_3_1_0/y.tab.c
+* spec/fixtures/integration/ruby_3_1_0/y.tab.h
+* spec/fixtures/integration/ruby_3_2_0/parse.tmp.y
+* spec/fixtures/integration/ruby_3_2_0/y.tab.c
+* spec/fixtures/integration/ruby_3_2_0/y.tab.h
+

data/MIT

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Yuichiro Kaneko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# Lrama
+
+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
+
+* Bison style grammar file is supported with some assumptions
+  * b4_locations_if is always true
+  * b4_pure_if is always true
+  * b4_pull_if is always false
+  * b4_lac_if is always false
+* Error Tolerance parser
+  * Subset of [Repairing Syntax Errors in LR Parsers (Corchuelo et al.)](https://idus.us.es/bitstream/handle/11441/65631/Repairing%20syntax%20errors.pdf) algorithm is supported
+
+## Installation
+
+```shell
+$ bundle exec rake install
+$ lrama --version
+0.1.0
+```
+
+## Usage
+
+```shell
+# "y.tab.c" is generated
+$ lrama parse.y
+```
+
+## License
+
+See LEGAL.md file.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/doc/TODO.md

@@ -0,0 +1,50 @@
+# TODO
+
+* command
+  * [ ] Add "--bison" option
+* lexer
+  * [x] Basic functionalities
+* parser
+  * [x] Basic functionalities
+  * [x] Precedence in grammar
+* LALR
+  * [x] compute_nullable
+  * [x] compute_lr0_states
+  * [x] Direct Read Sets
+  * [x] Reads Relation
+  * [x] Read Sets
+  * [x] Includes Relation
+  * [x] Lookback Relation
+  * [x] Follow Sets
+  * [x] Look-Ahead Sets
+  * [x] Precedence support
+  * [x] Conflict check
+  * [x] Algorithm Digraph
+* Rendering
+  * [x] Table compaction
+  * [x] -d option
+  * yacc.c
+    * [ ] %lex-param
+    * [x] %parse-param
+    * [x] %printer
+    * [x] Replace $, @ in user codes
+    * [x] `[@oline@]`
+    * [ ] b4_symbol (for eof, error and so on)
+    * Assumption
+      * b4_locations_if is true
+      * b4_pure_if is true
+      * b4_pull_if is false
+      * b4_lac_if is false
+* Performance improvement
+  * [ ]
+* Licenses
+  * [x] Write down something about licenses
+* Reporting
+  * [ ] Bison style
+* Error Tolerance
+  * [x] Subset of Corchuelo et al.
+* Lex state
+* CI
+  * [x] Setup CI
+  * [x] Add ruby 3.1 or under
+  * [x] Add integration tests which installs Lrama, build ruby and run `make test`

data/exe/lrama

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+
+$LOAD_PATH << File.join(__dir__, "../lib")
+require "lrama"
+
+Lrama::Command.new.run(ARGV.dup)

data/lib/lrama/command.rb

@@ -0,0 +1,129 @@
+require 'optparse'
+
+module Lrama
+  class Command
+    def run(argv)
+      opt = OptionParser.new
+
+      # opt.on('-h') {|v| p v }
+      opt.on('-V', '--version') {|v| puts Lrama::VERSION ; exit 0 }
+
+      # Tuning the Parser
+      skeleton = "bison/yacc.c"
+
+      opt.on('-S', '--skeleton=FILE') {|v| skeleton = v }
+      opt.on('-t') {  } # Do nothing
+
+      # Output Files:
+      header = false
+      header_file = nil
+      report = []
+      report_file = nil
+      outfile = "y.tab.c"
+
+      opt.on('-h', '--header=[FILE]') {|v| header = true; header_file = v }
+      opt.on('-d') { header = true }
+      opt.on('-r', '--report=THINGS') {|v| report = v.split(',') }
+      opt.on('--report-file=FILE')    {|v| report_file = v }
+      opt.on('-v') {  } # Do nothing
+      opt.on('-o', '--output=FILE')   {|v| outfile = v }
+
+      # Hidden
+      trace = []
+      opt.on('--trace=THINGS') {|v| trace = v.split(',') }
+
+      # Error Recovery
+      error_recovery = false
+      opt.on('-e') {|v| error_recovery = true }
+
+      opt.parse!(argv)
+
+      trace_opts = validate_trace(trace)
+      report_opts = validate_report(report)
+
+      grammar_file = argv.shift
+
+      if !report.empty? && report_file.nil? && grammar_file
+        report_file = File.dirname(grammar_file) + "/" + File.basename(grammar_file, ".*") + ".output"
+      end
+
+      if !header_file && header
+        case
+        when outfile
+          header_file = File.dirname(outfile) + "/" + File.basename(outfile, ".*") + ".h"
+        when grammar_file
+          header_file = File.dirname(grammar_file) + "/" + File.basename(grammar_file, ".*") + ".h"
+        end
+      end
+
+      if !grammar_file
+        puts "File should be specified\n"
+        exit 1
+      end
+
+      Report::Duration.enable if trace_opts[:time]
+
+      y = File.read(grammar_file)
+      grammar = Lrama::Parser.new(y).parse
+      states = Lrama::States.new(grammar, trace_state: (trace_opts[:automaton] || trace_opts[:closure]))
+      states.compute
+      context = Lrama::Context.new(states)
+
+      if report_file
+        reporter = Lrama::StatesReporter.new(states)
+        File.open(report_file, "w+") do |f|
+          reporter.report(f, **report_opts)
+        end
+      end
+
+      File.open(outfile, "w+") do |f|
+        Lrama::Output.new(
+          out: f,
+          output_file_path: outfile,
+          template_name: skeleton,
+          grammar_file_path: grammar_file,
+          header_file_path: header_file,
+          context: context,
+          grammar: grammar,
+        ).render
+      end
+    end
+
+    private
+
+    def validate_report(report)
+      list = %w[states itemsets lookaheads solved counterexamples cex all none]
+      not_supported = %w[counterexamples cex all none]
+      h = {}
+
+      report.each do |r|
+        if list.include?(r) && !not_supported.include?(r)
+          h[r.to_sym] = true
+        else
+          raise "Invalid report option \"#{r}\"."
+        end
+      end
+
+      return h
+    end
+
+    def validate_trace(trace)
+      list = %w[
+        none locations scan parse automaton bitsets
+        closure grammar resource sets muscles tools
+        m4-early m4 skeleton time ielr cex all
+      ]
+      h = {}
+
+      trace.each do |t|
+        if list.include?(t)
+          h[t.to_sym] = true
+        else
+          raise "Invalid trace option \"#{t}\"."
+        end
+      end
+
+      return h
+    end
+  end
+end