lrama 0.5.11 → 0.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 634093bc73fd1504910364bffa6827a66fa7479f1f5b5238fdf577f0bb6d3d9d
-  data.tar.gz: 96db570d049f47f20bf619535ee91e7f0f846a492404a54f7fe41a6addcce484
+  metadata.gz: '008f1a5df39b115123be84cb5e1edd379d88458bc95256b0e4fe4659481ceb51'
+  data.tar.gz: 02af30da8cf4cb2cad841f43b603433edafab09b0cf0e8993201c2e9aea12029
 SHA512:
-  metadata.gz: 6b09e84cd16cd162f263e68abf7ada808418212ca449fab0f4a380c42c0193f479cad3d0d1afcc1d5f17d81b890e3754642d1a9433f7be5f6fc71fdcb2df3f97
-  data.tar.gz: 1994a670f1033e737f2193e2e71ccaa0818e4144ac7f4424ebf24046ece23efc3f67eeb0927c5336663a244f270b321247b39dbbdbe76cfacc13b94da6289a8b
+  metadata.gz: 12cf8b98035052e89f9060dd73ec2b32ad9c5bec2fe4076e6ee0416832039962cf973c7ca895b482f2f434500648638c01a717d67357aa055eccce851995adaf
+  data.tar.gz: a4cffc85bb5945a3d4d037c0eadee0df22e30236085e01f06bffe1646d0acafd09fdb606860752cdea9dbfdf45baa1fc8d244504b7a0ca29c37ab60f9a727367

data/.github/workflows/test.yaml

@@ -122,7 +122,7 @@ jobs:
       - run: mkdir -p tool/lrama
         working-directory: ../ruby
       - name: Copy Lrama to ruby/tool
-        run: cp -r LEGAL.md MIT exe lib template ../ruby/tool/lrama
+        run: cp -r LEGAL.md NEWS.md MIT exe lib template ../ruby/tool/lrama
         working-directory:
       - run: tree tool/lrama
         working-directory: ../ruby

data/LEGAL.md

@@ -7,5 +7,6 @@ mentioned below.
 
 These files are licensed under the GNU General Public License version 3 or later. See these files for more information.
 
+* template/bison/_yacc.h
 * template/bison/yacc.c
 * template/bison/yacc.h

data/NEWS.md

@@ -0,0 +1,167 @@
+# NEWS for Lrama
+
+## Lrama 0.5.11 (2023-12-02)
+
+### Type specification of parameterizing rules
+
+Allow to specify type of rules by specifying tag, `<i>` in below example.
+Tag is post-modification style.
+
+```
+%union {
+    int i;
+}
+
+%%
+
+program         : option(number) <i>
+                | number_alias? <i>
+                ;
+```
+
+https://github.com/ruby/lrama/pull/272
+
+
+## Lrama 0.5.10 (2023-11-18)
+
+### Parameterizing rules (option, nonempty_list, list)
+
+Support function call style parameterizing rules for `option`, `nonempty_list` and `list`.
+
+https://github.com/ruby/lrama/pull/197
+
+### Parameterizing rules (separated_list)
+
+Support `separated_list` and `separated_nonempty_list` parameterizing rules.
+
+```
+program: separated_list(',', number)
+
+// Expanded to
+
+program: separated_list_number
+separated_list_number: ε
+separated_list_number: separated_nonempty_list_number
+separated_nonempty_list_number: number
+separated_nonempty_list_number: separated_nonempty_list_number ',' number
+```
+
+```
+program: separated_nonempty_list(',', number)
+
+// Expanded to
+
+program: separated_nonempty_list_number
+separated_nonempty_list_number: number
+separated_nonempty_list_number: separated_nonempty_list_number ',' number
+```
+
+https://github.com/ruby/lrama/pull/204
+
+## Lrama 0.5.9 (2023-11-05)
+
+### Parameterizing rules (suffix)
+
+Parameterizing rules are template of rules.
+It's very common pattern to write "list" grammar rule like:
+
+```
+opt_args: /* none */
+        | args
+        ;
+
+args: arg
+    | args arg
+```
+
+Lrama supports these suffixes:
+
+* `?`: option
+* `+`: nonempty list
+* `*`: list
+
+Idea of Parameterizing rules comes from Menhir LR(1) parser generator (https://gallium.inria.fr/~fpottier/menhir/manual.html#sec32).
+
+https://github.com/ruby/lrama/pull/181
+
+## Lrama 0.5.7 (2023-10-23)
+
+### Racc parser
+
+Replace Lrama's parser from hand written parser to LR parser generated by Racc.
+Lrama uses `--embedded` option to generate LR parser because Racc is changed from default gem to bundled gem by Ruby 3.3 (https://github.com/ruby/lrama/pull/132).
+
+https://github.com/ruby/lrama/pull/62
+
+## Lrama 0.5.4 (2023-08-17)
+
+### Runtime configuration for error recovery
+
+Meke 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.
+
+https://github.com/ruby/lrama/pull/74
+
+## Lrama 0.5.3 (2023-08-05)
+
+### Error Recovery
+
+Support token insert base Error Recovery.
+`-e` option is needed to generate parser with error recovery functions.
+
+https://github.com/ruby/lrama/pull/44
+
+## Lrama 0.5.2 (2023-06-14)
+
+### Named References
+
+Instead of positional references like `$1` or `$$`,
+named references allow to access to symbol by name.
+
+```
+primary: k_class cpath superclass bodystmt k_end
+           {
+             $primary = new_class($cpath, $bodystmt, $superclass);
+           }
+```
+
+Alias name can be declared.
+
+```
+expr[result]: expr[ex-left] '+' expr[ex.right]
+                {
+                  $result = $[ex-left] + $[ex.right];
+                }
+```
+
+Bison supports this feature from 2.5.
+
+### Add parse params to some macros and functions
+
+`%parse-param` are added to these macros and functions to remove ytab.sed hack from Ruby.
+
+* `YY_LOCATION_PRINT`
+* `YY_SYMBOL_PRINT`
+* `yy_stack_print`
+* `YY_STACK_PRINT`
+* `YY_REDUCE_PRINT`
+* `yysyntax_error`
+
+https://github.com/ruby/lrama/pull/40
+
+See also: https://github.com/ruby/ruby/pull/7807
+
+## Lrama 0.5.0 (2023-05-17)
+
+### stdin mode
+
+When `-` is given as grammar file name, reads the grammar source from STDIN, and takes the next argument as the input file name. This mode helps pre-process a grammar source.
+
+https://github.com/ruby/lrama/pull/8
+
+## Lrama 0.4.0 (2023-05-13)
+
+This is the first version migrated to Ruby.
+This version generates "parse.c" compatible with Bison 3.8.2.

data/README.md

@@ -138,7 +138,7 @@ $ stackprof --d3-flamegraph tmp/stackprof-cpu-myapp.dump > tmp/flamegraph.html
 
 1. Update `Lrama::VERSION`
 2. Release as a gem by `rake release`
-3. Update Lrama in ruby/ruby by `cp -r LEGAL.md MIT exe lib template ruby/tool/lrama`
+3. Update Lrama in ruby/ruby by `cp -r LEGAL.md NEWS.md MIT exe lib template ruby/tool/lrama`
 4. Create new release on [GitHub](https://github.com/ruby/lrama/releases)
 
 ## License

data/lib/lrama/grammar/code/rule_action.rb

@@ -14,9 +14,23 @@ module Lrama
         # * ($1) yyvsp[i]
         # * (@1) yylsp[i]
         #
+        #
+        # Consider a rule like
+        #
+        #   class: keyword_class { $1 } tSTRING { $2 + $3 } keyword_end { $class = $1 + $keyword_end }
+        #
+        # For the semantic action of original rule:
+        #
+        # "Rule"                class: keyword_class { $1 } tSTRING { $2 + $3 } keyword_end { $class = $1 + $keyword_end }
+        # "Position in grammar"                   $1     $2      $3          $4          $5                             $6
+        # "Index for yyvsp"                       -4     -3      -2          -1           0
+        #
+        #
+        # For the first midrule action:
+        #
         # "Rule"                class: keyword_class { $1 } tSTRING { $2 + $3 } keyword_end { $class = $1 + $keyword_end }
-        # "Position in grammar"                   $1    $2      $3          $4          $5                             $6
-        # "Index for yyvsp"                       -4    -3      -2          -1           0
+        # "Position in grammar"                   $1
+        # "Index for yyvsp"                        0
         def reference_to_c(ref)
           case
           when ref.type == :dollar && ref.name == "$" # $$
@@ -45,10 +59,12 @@ module Lrama
           @rule.position_in_original_rule_rhs || @rule.rhs.count
         end
 
+        # If this is midrule action, RHS is a RHS of the original rule.
         def rhs
           (@rule.original_rule || @rule).rhs
         end
 
+        # Unlike `rhs`, LHS is always a LHS of the rule.
         def lhs
           @rule.lhs
         end

data/lib/lrama/version.rb

@@ -1,3 +1,3 @@
 module Lrama
-  VERSION = "0.5.11".freeze
+  VERSION = "0.5.12".freeze
 end

data/sig/lrama/grammar/parameterizing_rules/builder/base.rbs

@@ -3,6 +3,8 @@ module Lrama
     class ParameterizingRules
       class Builder
         class Base
+          attr_reader build_token: Lexer::Token::Ident
+
           def initialize: (Lexer::Token::Parameterizing token, Counter rule_counter, untyped lhs_tag, Lexer::Token::UserCode? user_code, Lexer::Token? precedence_sym, Integer? line) -> void
           def build: () -> Array[Rule]
 
@@ -10,7 +12,7 @@ module Lrama
           @token: Lexer::Token::Parameterizing
           @key: Symbol
           @rule_counter: Counter
-          @lhs: Lexer::Token
+          @lhs_tag: untyped
           @user_code: Lexer::Token::UserCode?
           @precedence_sym: Lexer::Token?
           @line: Integer?

data/sig/lrama/grammar/parameterizing_rules/builder/separated_list.rbs

@@ -3,6 +3,8 @@ module Lrama
     class ParameterizingRules
       class Builder
         class SeparatedList < Base
+          @separator: Lexer::Token
+
           def initialize: (Lexer::Token token, Counter rule_counter, untyped lhs_tag, Lexer::Token::UserCode? user_code, Lexer::Token? precedence_sym, Integer? line) -> void
         end
       end

data/sig/lrama/grammar/parameterizing_rules/builder/separated_nonempty_list.rbs

@@ -3,6 +3,8 @@ module Lrama
     class ParameterizingRules
       class Builder
         class SeparatedNonemptyList < Base
+          @separator: Lexer::Token
+
           def initialize: (Lexer::Token token, Counter rule_counter, untyped lhs_tag, Lexer::Token::UserCode? user_code, Lexer::Token? precedence_sym, Integer? line) -> void
         end
       end

data/sig/lrama/grammar/parameterizing_rules/builder.rbs

@@ -7,14 +7,15 @@ module Lrama
         @token: Lexer::Token::Parameterizing
         @key: Symbol
         @rule_counter: Counter
-        @lhs: Lexer::Token
+        @lhs_tag: untyped
         @user_code: Lexer::Token::UserCode?
         @precedence_sym: Lexer::Token?
         @line: Integer?
+        @builder: Grammar::ParameterizingRules::Builder::Base
 
         def initialize: (Lexer::Token token, Counter rule_counter, untyped lhs_tag, Lexer::Token::UserCode? user_code, Lexer::Token? precedence_sym, Integer? line) -> void
         def build: () -> Array[Rule]
-        def build_token: () -> Lrama::Lexer::Token
+        def build_token: () -> Lexer::Token
         def create_builder: () -> void
         def validate_key!: () -> void
       end

data/sig/lrama/lexer/token/parameterizing.rbs

@@ -2,9 +2,9 @@ module Lrama
   class Lexer
     class Token
       class Parameterizing < Token
-        attr_accessor args: Array[Lrama::Lexer::Token]
+        attr_accessor args: Array[Lexer::Token]
 
-        def initialize: (s_value: String, ?alias_name: String, ?location: Location, ?args: Array[Lrama::Lexer::Token]) -> void
+        def initialize: (s_value: String, ?alias_name: String, ?location: Location, ?args: Array[Lexer::Token]) -> void
 
         def option?: () -> bool
         def nonempty_list?: () -> bool

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lrama
 version: !ruby/object:Gem::Version
-  version: 0.5.11
+  version: 0.5.12
 platform: ruby
 authors:
 - Yuichiro Kaneko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies: []
 description: LALR (1) parser generator written by Ruby
 email:
@@ -27,10 +27,10 @@ files:
 - Gemfile
 - LEGAL.md
 - MIT
+- NEWS.md
 - README.md
 - Rakefile
 - Steepfile
-- doc/TODO.md
 - exe/lrama
 - lib/lrama.rb
 - lib/lrama/bitmap.rb

data/doc/TODO.md

@@ -1,59 +0,0 @@
-# TODO
-
-* command
-* 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
-  * [ ] Conflict resolution
-    * [x] Do not generate default action if states have conflicts
-    * [ ] Fix number of s/r conflicts of basic.y. See basic.output file generated by Bison.
-* Rendering
-  * [x] Table compaction
-  * [x] -d option
-  * yacc.c
-    * [x] %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
-    * [ ] Wrap not selected reduce with "[]". See basic.output file generated by Bison.
-* Counterexamples
-  * [x] Nonunifying Counterexamples
-  * [ ] Unifying Counterexamples
-  * [ ] Performance improvement using reverse_transitions and reverse_productions
-* Error Tolerance
-  * [x] Corchuelo et al. algorithm with N = 1 (this means the next token when error is raised)
-  * [x] Add new decl for error token semantic value initialization (%error-token)
-  * [x] Use YYMALLOC & YYFREE
-* 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`