racc 1.5.2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edf5dcefea26cb0246401ee59480890de48d5d84885423b882f39ae4394e56fc
-  data.tar.gz: 0b0c54b36dbc6be20469e57cd7538c94ff6b6f060383d6946f578e3baab3a03b
+  metadata.gz: d3140410adc1a0eea76ac4c19b3b03b9de9a4dd4c271971fef8675c3bec43260
+  data.tar.gz: 3bbbb46621a165b7f68dfbdb3cfebb508078db7984eb443b0acaebf5b98642b5
 SHA512:
-  metadata.gz: fecf83ab9be1bd80075e10cd966f85eb11a5a5f3b9786481e13b74401e528cf807a35b55a82408b0c638f8d320e298ec199b0599b80b3ca780a2684df04335b0
-  data.tar.gz: 2a6029118b2edcf9164957b1d9a7ac14292c5694bf49bb0e7c156bead403a6302920fced609b79772a6d0a4979cce5aacffd11b3125fcfc621f5b2dd6cfd54c8
+  metadata.gz: 62602fcf78f448a79c997e09084a7577257eb895b8ecae5880086b54fb05105b4140618f72c237e31d89d09347b420105a9e964068308404a30e01385a12ba15
+  data.tar.gz: 6f206c5cc183b836b50cfd84e71fe0b1b28dc2666e6d41c11055280a68a5497f3567f21931666e2c59495682bd310ec52e1704c4cb3fe5a434fa5e09da985d85

data/README.ja.rdoc

@@ -1,7 +1,6 @@
 = Racc
 
 * http://i.loveruby.net/en/projects/racc/
-* http://racc.rubyforge.org/
 
 == DESCRIPTION:
 

data/README.rdoc

@@ -1,21 +1,15 @@
 = Racc
 
-* http://i.loveruby.net/en/projects/racc/
-* http://racc.rubyforge.org/
+* https://github.com/ruby/racc
 
 == DESCRIPTION:
 
   Racc is a LALR(1) parser generator.
   It is written in Ruby itself, and generates Ruby program.
 
-  NOTE: Ruby 1.8.x comes with Racc runtime module.  You
-  can run your parsers generated by racc 1.4.x out of the
-  box.
-
-
 == Requirement
 
-  *  Ruby 1.8.x or later.
+  *  Ruby 2.5 or later.
 
 == Installation
 
@@ -59,9 +53,9 @@
 
       $ ruby calc
 
-  ... Does it works?
-  For details of Racc, see HTML documents placed under 'doc.en/'
-  and sample grammer files under 'sample/'.
+  ... Does it work?
+  For details of Racc, see HTML documents placed under 'doc/en/'
+  and sample grammar files under 'sample/'.
 
 
 == License
@@ -74,9 +68,10 @@
 
 == Bug Reports
 
-  Any kind of bug reports are welcome.
-  If you find a bug of Racc, please email me. Your grammer file,
-  debug output genereted by "racc -g", are helpful.
+  Any kind of bug report is welcome.
+  If you find a bug of Racc, please report an issue at 
+  https://github.com/ruby/racc/issues. Your grammar file,
+  debug output generated by "racc -g", are helpful.
 
 
                                                       Minero Aoki

data/{rdoc → doc}/en/grammar.en.rdoc

@@ -4,25 +4,24 @@
 
 == Class Block and User Code Block
 
-There's two block on toplevel.
-one is 'class' block, another is 'user code' block. 'user code' block MUST
-places after 'class' block.
+There are two top-level blocks: the 'class' block, and the 'user code'
+block. The 'user code' block MUST be after the 'class' block.
 
 == Comment
 
-You can insert comment about all places. Two style comment can be used,
-Ruby style (#.....) and C style (/*......*/) .
+Comments can be added about everywhere.  Two comment styles are
+supported: Ruby style (`# ...`) and C style (`/* ... */`).
 
 == Class Block
 
 The class block is formed like this:
 --
 class CLASS_NAME
-  [precedance table]
-  [token declearations]
+  [precedence table]
+  [token declarations]
   [expected number of S/R conflict]
   [options]
-  [semantic value convertion]
+  [semantic value conversion]
   [start rule]
 rule
   GRAMMARS
@@ -43,7 +42,7 @@ end
 
 == Grammar Block
 
-The grammar block discripts grammar which is able
+The grammar block describes the grammar
 to be understood by parser.  Syntax is:
 --
 (token): (token) (token) (token).... (action)
@@ -69,7 +68,7 @@ It is value of result, or returned value by "return" statement.
 Here is an example of whole grammar block.
 --
 rule
-  goal: definition ruls source { result = val }
+  goal: definition rules source { result = val }
 
   definition: /* none */   { result = [] }
     | definition startdesig  { result[0] = val[1] }
@@ -96,7 +95,7 @@ An array of value of right-hand side (rhs).
 A stack of values.
 DO NOT MODIFY this stack unless you know what you are doing.
 
-== Operator Precedance
+== Operator Precedence
 
 This function is equal to '%prec' in yacc.
 To designate this block:
@@ -128,25 +127,24 @@ rule
 
 == expect
 
-Racc has bison's "expect" directive.
+Racc supports Bison's "expect" directive to declare the expected
+number of shift/reduce conflicts.
 --
-# Example
-
 class MyParser
 rule
   expect 3
     :
     :
 --
-This directive declears "expected" number of shift/reduce conflict.
-If "expected" number is equal to real number of conflicts,
-racc does not print confliction warning message.
+Then warnings are issued only when the effective number of conflicts differs.
+
 
 == Declaring Tokens
 
-By declaring tokens, you can avoid many meanless bugs.
-If decleared token does not exist/existing token does not decleared,
-Racc output warnings.  Declearation syntax is:
+Declaring tokens avoids many bugs.
+
+Racc outputs warnings for declared tokens that do not exist, or existing tokens not declared.
+The syntax is:
 --
 token TOKEN_NAME AND_IS_THIS
       ALSO_THIS_IS AGAIN_AND_AGAIN THIS_IS_LAST
@@ -174,12 +172,12 @@ You can use 'no_' prefix to invert its meanings.
 
 Token symbols are, as default,
 
-  * naked token string in racc file (TOK, XFILE, this_is_token, ...)
+  * naked token strings in racc file (TOK, XFILE, this_is_token, ...)
     --> symbol (:TOK, :XFILE, :this_is_token, ...)
-  * quoted string (':', '.', '(', ...)
+  * quoted strings (':', '.', '(', ...)
     --> same string (':', '.', '(', ...)
 
-You can change this default by "convert" block.
+You can change this default using a "convert" block.
 Here is an example:
 --
 convert
@@ -202,18 +200,19 @@ end
 
 == Start Rule
 
-'%start' in yacc. This changes start rule.
+'%start' in yacc. This changes the start symbol.
 --
 start real_target
 --
-This statement will not be used forever, I think.
+
 
 == User Code Block
 
-"User Code Block" is a Ruby source code which is copied to output.
-There are three user code block, "header" "inner" and "footer".
+A "User Code Block" is a piece of Ruby source code copied in the output.
+There are three user code blocks, "header" "inner" and "footer".
 
-Format of user code is like this:
+User code blocks are introduced by four '-' at the beginning of a line,
+followed by a single-word name:
 --
 ---- header
   ruby statement
@@ -225,6 +224,3 @@ Format of user code is like this:
      :
      :
 --
-If four '-' exist on line head,
-racc treat it as beginning of user code block.
-A name of user code must be one word.

data/doc/en/grammar2.en.rdoc

@@ -0,0 +1,219 @@
+= Racc Grammar File Reference
+
+== Global Structure
+
+== Class Block and User Code Block
+
+There are two blocks on the toplevel. One is the 'class' block, the other is the 'user code'
+block. The 'user code' block MUST be placed after the 'class' block.
+
+== Comments
+
+You can insert comments about all places. Two styles of comments can be used, Ruby style '#.....' and C style '/\*......*\/'.
+
+== Class Block
+
+The class block is formed like this:
+
+  class CLASS_NAME
+    [precedence table]
+    [token declarations]
+    [expected number of S/R conflicts]
+    [options]
+    [semantic value conversion]
+    [start rule]
+  rule
+    GRAMMARS
+
+CLASS_NAME is a name of the parser class. This is the name of the generating parser
+class.
+
+If CLASS_NAME includes '::', Racc outputs the module clause. For example, writing
+"class M::C" causes the code below to be created:
+
+  module M
+    class C
+      :
+      :
+    end
+  end
+
+== Grammar Block
+
+The grammar block describes grammar which is able to be understood by the parser.
+Syntax is:
+
+  (token): (token) (token) (token).... (action)
+
+  (token): (token) (token) (token).... (action)
+         | (token) (token) (token).... (action)
+         | (token) (token) (token).... (action)
+
+(action) is an action which is executed when its (token)s are found.
+(action) is a ruby code block, which is surrounded by braces:
+
+  { print val[0]
+    puts val[1] }
+
+Note that you cannot use '%' string, here document, '%r' regexp in action.
+
+Actions can be omitted. When it is omitted, '' (empty string) is used.
+
+A return value of action is a value of the left side value ($$). It is the value of the
+result, or the returned value by `return` statement.
+
+Here is an example of the whole grammar block.
+
+  rule
+    goal: definition rules source { result = val }
+
+    definition: /* none */   { result = [] }
+      | definition startdesig  { result[0] = val[1] }
+      | definition
+               precrule   # this line continues from upper line
+        {
+          result[1] = val[1]
+        }
+
+    startdesig: START TOKEN
+
+You can use the following special local variables in action:
+
+* result ($$)
+
+The value of the left-hand side (lhs). A default value is val[0].
+
+* val ($1,$2,$3...)
+
+An array of value of the right-hand side (rhs).
+
+* _values (...$-2,$-1,$0)
+
+A stack of values. DO NOT MODIFY this stack unless you know what you are doing.
+
+== Operator Precedence
+
+This function is equal to '%prec' in yacc.
+To designate this block:
+
+  prechigh
+    nonassoc '++'
+    left     '*' '/'
+    left     '+' '-'
+    right    '='
+  preclow
+
+`right` is yacc's %right, `left` is yacc's %left.
+
+`=` + (symbol) means yacc's %prec:
+
+  prechigh
+    nonassoc UMINUS
+    left '*' '/'
+    left '+' '-'
+  preclow
+
+  rule
+    exp: exp '*' exp
+       | exp '-' exp
+       | '-' exp       =UMINUS   # equals to "%prec UMINUS"
+           :
+           :
+
+== expect
+
+Racc has bison's "expect" directive.
+
+  # Example
+
+  class MyParser
+  rule
+    expect 3
+      :
+      :
+
+This directive declares "expected" number of shift/reduce conflicts. If
+"expected" number is equal to real number of conflicts, Racc does not print
+conflict warning message.
+
+== Declaring Tokens
+
+By declaring tokens, you can avoid many meaningless bugs. If declared token
+does not exist or existing token does not decleared, Racc output warnings.
+Declaration syntax is:
+
+  token TOKEN_NAME AND_IS_THIS
+        ALSO_THIS_IS AGAIN_AND_AGAIN THIS_IS_LAST
+
+== Options
+
+You can write options for Racc command in your Racc file.
+
+  options OPTION OPTION ...
+
+Options are:
+
+* omit_action_call
+
+omits empty action call or not.
+
+* result_var
+
+uses local variable "result" or not.
+
+You can use 'no_' prefix to invert their meanings.
+
+== Converting Token Symbol
+
+Token symbols are, as default,
+
+  * naked token string in Racc file (TOK, XFILE, this_is_token, ...)
+    --> symbol (:TOK, :XFILE, :this_is_token, ...)
+  * quoted string (':', '.', '(', ...)
+    --> same string (':', '.', '(', ...)
+
+You can change this default by "convert" block.
+Here is an example:
+
+  convert
+    PLUS 'PlusClass'      # We use PlusClass for symbol of `PLUS'
+    MIN  'MinusClass'     # We use MinusClass for symbol of `MIN'
+  end
+
+We can use almost all ruby value can be used by token symbol,
+except 'false' and 'nil'.  These cause unexpected parse error.
+
+If you want to use String as token symbol, special care is required.
+For example:
+
+  convert
+    class '"cls"'            # in code, "cls"
+    PLUS '"plus\n"'          # in code, "plus\n"
+    MIN  "\"minus#{val}\""   # in code, \"minus#{val}\"
+  end
+
+== Start Rule
+
+'%start' in yacc. This changes start rule.
+
+  start real_target
+
+== User Code Block
+
+"User Code Block" is a Ruby source code which is copied to output. There are
+three user code blocks, "header" "inner" and "footer".
+
+Format of user code is like this:
+
+  ---- header
+    ruby statement
+    ruby statement
+    ruby statement
+
+  ---- inner
+    ruby statement
+       :
+       :
+
+If four '-' exist on the line head, Racc treats it as the beginning of the
+user code block.  The name of the user code block must be one word.

data/ext/racc/cparse/cparse.c

@@ -819,7 +819,7 @@ reduce0(RB_BLOCK_CALL_FUNC_ARGLIST(_, data))
 void
 Init_cparse(void)
 {
-#if HAVE_RB_EXT_RACTOR_SAFE
+#ifdef HAVE_RB_EXT_RACTOR_SAFE
     rb_ext_ractor_safe(true);
 #endif
 

data/ext/racc/cparse/extconf.rb

@@ -3,6 +3,7 @@
 
 require 'mkmf'
 
+have_func('rb_block_call')
 have_func('rb_ary_subseq')
 
 create_makefile 'racc/cparse'

data/lib/racc/grammar.rb

@@ -335,14 +335,14 @@ module Racc
         if action
           idbase = "#{type}@#{id}-#{@seqs[type] += 1}"
           target = _wrap(idbase, "#{idbase}-core", action)
-          _regist("#{idbase}-core", &block)
+          _register("#{idbase}-core", &block)
         else
-          target = _regist("#{type}@#{id}", &block)
+          target = _register("#{type}@#{id}", &block)
         end
         @grammar.intern(target)
       end
 
-      def _regist(target_name)
+      def _register(target_name)
         target = target_name.intern
         unless _added?(@grammar.intern(target))
           yield(target).each_rule do |rule|

data/lib/racc/grammarfileparser.rb

@@ -260,9 +260,9 @@ module Racc
       _, *blocks = *@scanner.epilogue.split(/^----/)
       blocks.each do |block|
         header, *body = block.lines.to_a
-        label0, pathes = *header.sub(/\A-+/, '').split('=', 2)
+        label0, paths = *header.sub(/\A-+/, '').split('=', 2)
         label = canonical_label(label0)
-        (pathes ? pathes.strip.split(' ') : []).each do |path|
+        (paths ? paths.strip.split(' ') : []).each do |path|
           add_user_code label, SourceText.new(File.read(path), path, 1)
         end
         add_user_code label, SourceText.new(body.join(''), @filename, line + 1)

data/lib/racc/info.rb

@@ -11,7 +11,7 @@
 #++
 
 module Racc
-  VERSION   = '1.5.2'
+  VERSION   = '1.6.1'
   Version = VERSION
   Copyright = 'Copyright (c) 1999-2006 Minero Aoki'
 end

data/lib/racc/parser-text.rb

@@ -22,7 +22,7 @@ module Racc
   class ParseError < StandardError; end
 end
 unless defined?(::ParseError)
-  ParseError = Racc::ParseError
+  ParseError = Racc::ParseError # :nodoc:
 end
 
 # Racc is a LALR(1) parser generator.
@@ -548,7 +548,7 @@ module Racc
     end
 
     # Exit parser.
-    # Return value is Symbol_Value_Stack[0].
+    # Return value is +Symbol_Value_Stack[0]+.
     def yyaccept
       throw :racc_jump, 2
     end

data/lib/racc/parser.rb

@@ -20,7 +20,7 @@ module Racc
   class ParseError < StandardError; end
 end
 unless defined?(::ParseError)
-  ParseError = Racc::ParseError
+  ParseError = Racc::ParseError # :nodoc:
 end
 
 # Racc is a LALR(1) parser generator.
@@ -546,7 +546,7 @@ module Racc
     end
 
     # Exit parser.
-    # Return value is Symbol_Value_Stack[0].
+    # Return value is +Symbol_Value_Stack[0]+.
     def yyaccept
       throw :racc_jump, 2
     end

data/lib/racc/parserfilegenerator.rb

@@ -320,50 +320,6 @@ module Racc
     end
 
     def integer_list(name, table)
-      if table.size > 2000
-        serialize_integer_list_compressed name, table
-      else
-        serialize_integer_list_std name, table
-      end
-    end
-
-    def serialize_integer_list_compressed(name, table)
-      # TODO: this can be made a LOT more clean with a simple split/map
-      sep  = "\n"
-      nsep = ",\n"
-      buf  = String.new
-      com  = ''
-      ncom = ','
-      co   = com
-      @f.print 'clist = ['
-      table.each do |i|
-        buf << co << i.to_s; co = ncom
-        if buf.size > 66
-          @f.print sep; sep = nsep
-          @f.print "'", buf, "'"
-          buf = String.new
-          co = com
-        end
-      end
-      unless buf.empty?
-        @f.print sep
-        @f.print "'", buf, "'"
-      end
-      line ' ]'
-
-      @f.print(<<-End)
-        #{name} = arr = ::Array.new(#{table.size}, nil)
-        idx = 0
-        clist.each do |str|
-          str.split(',', -1).each do |i|
-            arr[idx] = i.to_i unless i.empty?
-            idx += 1
-          end
-        end
-      End
-    end
-
-    def serialize_integer_list_std(name, table)
       sep = ''
       line "#{name} = ["
       table.each_slice(10) do |ns|

data/lib/racc/statetransitiontable.rb

@@ -12,12 +12,6 @@
 
 require 'racc/parser'
 
-unless Object.method_defined?(:funcall)
-  class Object
-    alias funcall __send__
-  end
-end
-
 module Racc
 
   StateTransitionTable = Struct.new(:action_table,
@@ -222,7 +216,7 @@ module Racc
         end
         i = ii
       end
-      Regexp.compile(map, 'n')
+      Regexp.compile(map, nil, 'n')
     end
 
     def set_table(entries, dummy, tbl, chk, ptr)
@@ -300,9 +294,9 @@ module Racc
       c.module_eval "def _reduce_none(vals, vstack) vals[0] end"
       @grammar.each do |rule|
         if rule.action.empty?
-          c.funcall(:alias_method, "_reduce_#{rule.ident}", :_reduce_none)
+          c.alias_method("_reduce_#{rule.ident}", :_reduce_none)
         else
-          c.funcall(:define_method, "_racc_action_#{rule.ident}", &rule.action.proc)
+          c.define_method("_racc_action_#{rule.ident}", &rule.action.proc)
           c.module_eval(<<-End, __FILE__, __LINE__ + 1)
             def _reduce_#{rule.ident}(vals, vstack)
               _racc_action_#{rule.ident}(*vals)