antlr3 1.8.13 → 1.9.0

data/lib/antlr3/constants.rb

@@ -59,10 +59,8 @@ module Constants
   MEMO_RULE_UNKNOWN = -1
   
   # built-in token types used internally by ANTLR3
-  
-  INVALID_TOKEN_TYPE = 0
-  
-  EOF = -1
+  INVALID = INVALID_TOKEN_TYPE = 0
+  EOF     = -1
   
   
   # Imaginary tree-navigation token type indicating the ascent after moving through the
@@ -86,12 +84,10 @@ module Constants
   end
   
   BUILT_IN_TOKEN_NAMES.update( 
-    0 => "<invalid>".freeze, 1 => "<EOR>".freeze, 
-    2 => "<DOWN>".freeze, 3 => "<UP>".freeze, 
+    0  => "<invalid>".freeze, 1 => "<EOR>".freeze,
+    2  => "<DOWN>".freeze,    3 => "<UP>".freeze,
     -1 => "<EOF>".freeze
   )
-  
-  
 end
 
 include Constants

data/lib/antlr3/task.rb

@@ -35,6 +35,7 @@ TODO: finish documentation
 =end
 
 class CompileTask < Rake::TaskLib
+  defined?( Rake::DSL ) and include( Rake::DSL )
   attr_reader :grammar_sets, :options
   attr_accessor :name
   
@@ -432,6 +433,7 @@ private
 end # class Grammar
 
 class GrammarFile::Imported < GrammarFile
+  defined?( Rake::DSL ) and include( Rake::DSL )
   def initialize( owner, path )
     @owner = owner
     @path = path.to_s

data/lib/antlr3/test/functional.rb

@@ -8,6 +8,7 @@ require 'antlr3/test/call-stack'
 
 require 'test/unit'
 require 'spec'
+require 'spec/interop/test'
 
 module ANTLR3
 module Test

data/lib/antlr3/token.rb

@@ -497,6 +497,15 @@ dynamically-created CommonToken subclass.
 =end
 
 class TokenScheme < ::Module
+  #
+  # introduced due to deprecation warning of Hash#index in Ruby 1.9.3
+  # 
+  if ::Hash.method_defined?( :key )
+    FETCH_KEY = proc { | h, v | h.key( v ) }
+  else
+    FETCH_KEY = proc { | h, v | h.index( v ) }
+  end
+  
   include TokenFactory
   
   def self.new( tk_class = nil, &body )
@@ -640,7 +649,7 @@ class TokenScheme < ::Module
   def []( name_or_value )
     case name_or_value
     when Integer then token_names.fetch( name_or_value, nil )
-    else const_get( name_or_value.to_s ) rescue token_names.index( name_or_value )
+    else const_get( name_or_value.to_s ) rescue FETCH_KEY.call( token_names, name_or_value )
     end
   end
   

data/lib/antlr3/version.rb

@@ -8,8 +8,8 @@ module ANTLR3
   # testing the current version of this library
   # 
   ANTLR_MAJOR_VERSION = 3
-  ANTLR_MINOR_VERSION = 2
-  ANTLR_PATCH_VERSION = 1
+  ANTLR_MINOR_VERSION = 5
+  ANTLR_PATCH_VERSION = 0
   ANTLR_VERSION = [ ANTLR_MAJOR_VERSION, ANTLR_MINOR_VERSION, ANTLR_PATCH_VERSION ].freeze
   ANTLR_VERSION_STRING = ANTLR_VERSION.join( '.' )
   ANTLR_VERSION_STRING.chomp!( '.0' )   # versioning drops minor version at 0
@@ -19,8 +19,8 @@ module ANTLR3
   # The version data for the current state the library itself
   # 
   MAJOR_VERSION = 1
-  MINOR_VERSION = 8
-  PATCH_VERSION = 13
+  MINOR_VERSION = 9
+  PATCH_VERSION = 0
   VERSION = [ MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION ]
   VERSION_STRING = VERSION.join( '.' ).freeze
   

data/rakefile

@@ -15,45 +15,45 @@ Hoe.spec "antlr3" do
   )
   
   self.test_globs = [
+    "test/unit/test-exceptions.rb",
+    "test/unit/test-trees.rb",
     "test/unit/test-scope.rb",
-    "test/unit/test-template.rb",
     "test/unit/test-tree-wizard.rb",
-    "test/unit/test-unicode-stream.rb",
-    "test/unit/test-scheme.rb",
-    "test/unit/test-trees.rb",
     "test/unit/test-streams.rb",
-    "test/unit/test-dfa.rb",
     "test/unit/test-recognizers.rb",
-    "test/unit/test-exceptions.rb",
-    "test/functional/ast-output/auto-ast.rb",
-    "test/functional/ast-output/hetero-nodes.rb",
-    "test/functional/ast-output/construction.rb",
-    "test/functional/ast-output/rewrites.rb",
-    "test/functional/ast-output/tree-rewrite.rb",
-    "test/functional/token-rewrite/via-parser.rb",
-    "test/functional/token-rewrite/basic.rb",
-    "test/functional/main/main-scripts.rb",
+    "test/unit/test-template.rb",
+    "test/unit/test-unicode-stream.rb",
+    "test/unit/test-dfa.rb",
+    "test/unit/test-scheme.rb",
     "test/functional/tree-parser/basic.rb",
-    "test/functional/parser/nuances.rb",
-    "test/functional/parser/backtracking.rb",
-    "test/functional/parser/properties.rb",
-    "test/functional/parser/scopes.rb",
-    "test/functional/parser/rule-methods.rb",
+    "test/functional/parser/actions.rb",
     "test/functional/parser/predicates.rb",
     "test/functional/parser/calc.rb",
     "test/functional/parser/basic.rb",
+    "test/functional/parser/rule-methods.rb",
+    "test/functional/parser/properties.rb",
+    "test/functional/parser/scopes.rb",
+    "test/functional/parser/nuances.rb",
+    "test/functional/parser/backtracking.rb",
     "test/functional/parser/ll-star.rb",
-    "test/functional/parser/actions.rb",
-    "test/functional/lexer/filter-mode.rb",
-    "test/functional/lexer/nuances.rb",
-    "test/functional/lexer/properties.rb",
-    "test/functional/lexer/basic.rb",
-    "test/functional/lexer/syn-pred.rb",
-    "test/functional/lexer/xml.rb",
     "test/functional/debugging/rule-tracing.rb",
     "test/functional/debugging/profile-mode.rb",
     "test/functional/debugging/debug-mode.rb",
+    "test/functional/main/main-scripts.rb",
+    "test/functional/lexer/filter-mode.rb",
+    "test/functional/lexer/basic.rb",
+    "test/functional/lexer/properties.rb",
+    "test/functional/lexer/xml.rb",
+    "test/functional/lexer/nuances.rb",
+    "test/functional/lexer/syn-pred.rb",
+    "test/functional/ast-output/construction.rb",
+    "test/functional/ast-output/hetero-nodes.rb",
+    "test/functional/ast-output/tree-rewrite.rb",
+    "test/functional/ast-output/auto-ast.rb",
+    "test/functional/ast-output/rewrites.rb",
     "test/functional/delegation/import.rb",
+    "test/functional/token-rewrite/basic.rb",
+    "test/functional/token-rewrite/via-parser.rb",
     "test/functional/template-output/template-output.rb"
   ]
   

data/templates/AST.stg

@@ -20,14 +20,14 @@ ruleDeclarations() ::= <<
 root_0 = nil<\n>
 >>
 
-ruleLabelDefs() ::= <<
-<super.ruleLabelDefs()>
+ruleLabelDefs(desc) ::= <<
+<super.ruleLabelDefs(desc)>
 <[ruleDescriptor.tokenLabels,ruleDescriptor.wildcardTreeLabels,ruleDescriptor.wildcardTreeListLabels,ruleDescriptor.tokenListLabels]
-    :{tree_for_<it.label.text> = nil}; separator="\n">
+    :{it|tree_for_<it.label.text> = nil}; separator="\n">
 <ruleDescriptor.allTokenRefsInAltsWithRewrites
-    :{stream_<it> = ANTLR3::AST::RewriteRule<rewriteElementType>Stream.new( @adaptor, "token <it>" )}; separator="\n">
+    :{it|stream_<it> = ANTLR3::AST::RewriteRule<rewriteElementType>Stream.new( @adaptor, "token <it>" )}; separator="\n">
 <ruleDescriptor.allRuleRefsInAltsWithRewrites
-    :{stream_<it> = ANTLR3::AST::RewriteRuleSubtreeStream.new( @adaptor, "rule <it>" )}; separator="\n">
+    :{it|stream_<it> = ANTLR3::AST::RewriteRuleSubtreeStream.new( @adaptor, "rule <it>" )}; separator="\n">
 >>
 
 alt(elements,altNum,description,autoAST,outerAlt,treeLevel,rew) ::= <<
@@ -38,22 +38,22 @@ root_0 = @adaptor.create_flat_list<\n><\n>
 <elements:element()><rew>
 >>
 
-tokenRefTrack(token,label,elementIndex,hetero) ::= <<
+tokenRefTrack(token,label,elementIndex,terminalOptions={}) ::= <<
 <tokenRefBang(...)>
 <gatedAction({stream_<token>.add( <label; format="label"> )})>
 >>
 
-tokenRefTrackAndListLabel(token,label,elementIndex,hetero) ::= <<
+tokenRefTrackAndListLabel(token,label,elementIndex,terminalOptions={}) ::= <<
 <tokenRefTrack(...)>
 <addToList(elem={<label; format="label">},...)>
 >>
 
-tokenRefRuleRootTrack(token,label,elementIndex,hetero) ::= <<
+tokenRefRuleRootTrack(token,label,elementIndex,terminalOptions={}) ::= <<
 <tokenRefBang(...)>
 <gatedAction({stream_<token>.add( <label; format="label"> )})>
 >>
 
-tokenRefRuleRootTrackAndListLabel(token,label,elementIndex,hetero) ::= <<
+tokenRefRuleRootTrackAndListLabel(token,label,elementIndex,terminalOptions={}) ::= <<
 <tokenRefRuleRootTrack(...)>
 <addToList(elem=label,...)>
 >>
@@ -129,22 +129,22 @@ root_0 = @adaptor.create_flat_list
 
 rewriteCodeLabels() ::= <<
 <referencedTokenLabels:
-{stream_<it> = <rewriteElementType; format="snakecase">_stream( "token <it>", <it; format="label"> )};
+{it | stream_<it> = <rewriteElementType; format="snakecase">_stream( "token <it>", <it; format="label"> )};
 separator="\n">
 <referencedTokenListLabels:
-{stream_<it> = <rewriteElementType; format="snakecase">_stream( "token <it>", list_of_<it; format="label"> )};
+{it | stream_<it> = <rewriteElementType; format="snakecase">_stream( "token <it>", list_of_<it; format="label"> )};
 separator="\n">
 <referencedWildcardLabels:
-{stream_<it> = subtree_stream( "wildcard <it>", <it; format="label"> )};
+{it | stream_<it> = subtree_stream( "wildcard <it>", <it; format="label"> )};
 separator="\n">
 <referencedWildcardListLabels:
-{stream_<it> = subtree_stream( "wildcard <it>", list_of_<it; format="label"> )};
+{it | stream_<it> = subtree_stream( "wildcard <it>", list_of_<it; format="label"> )};
 separator="\n">
 <referencedRuleLabels:
-{stream_<it> = <it; format="label"> ? subtree_stream( "rule <it>", <it; format="label">.tree ) : subtree_stream( "token <it>" )};
+{it | stream_<it> = <it; format="label"> ? subtree_stream( "rule <it>", <it; format="label">.tree ) : subtree_stream( "token <it>" )};
 separator="\n">
 <referencedRuleListLabels:
-{stream_<it> = subtree_stream( "token <it>", list_of_<it; format="label"> )};
+{it | stream_<it> = subtree_stream( "token <it>", list_of_<it; format="label"> )};
 separator="\n">
 >>
 
@@ -191,18 +191,18 @@ end
 <referencedElements:{el|stream_<el>.reset<\n>}>
 >>
 
-rewriteAltRest(a) ::= <<
+rewriteAltRest(a) ::= <%
 <if(a.pred)>
-if <a.pred>
-  # <a.description>
+if <a.pred><\n>
+  # <a.description><\n>
   <a.alt>
 <else>
-e
-  # <a.description>
-  <a.alt>
-end
+e<\n>
+  # <a.description><\n>
+  <a.alt><\n>
+end<\n>
 <endif>
->>
+%>
 
 rewriteAltFirst(a) ::= <<
 <if(a.pred)>
@@ -231,7 +231,7 @@ rewriteElement(e) ::= <<
 <e.el>
 >>
 
-rewriteTokenRef(token,elementIndex,hetero,args) ::= <<
+rewriteTokenRef(token,elementIndex,args,terminalOptions={}) ::= <<
 @adaptor.add_child( root_<treeLevel>, <createRewriteNodeFromElement(...)> )<\n>
 >>
 
@@ -249,15 +249,15 @@ root_<treeLevel> = @adaptor.become_root( stream_<label>.next_node, root_<treeLev
 
 rewriteTokenListLabelRefRoot ::= rewriteTokenLabelRefRoot
 
-rewriteTokenRefRoot(token,elementIndex,hetero,args) ::= <<
+rewriteTokenRefRoot(token,elementIndex,args,terminalOptions={}) ::= <<
 root_<treeLevel> = @adaptor.become_root( <createRewriteNodeFromElement(...)>, root_<treeLevel> )<\n>
 >>
 
-rewriteImaginaryTokenRef(args,token,hetero,elementIndex) ::= <<
+rewriteImaginaryTokenRef(args,token,elementIndex,terminalOptions={}) ::= <<
 @adaptor.add_child( root_<treeLevel>, <createImaginaryNode(tokenType=token, ...)> )<\n>
 >>
 
-rewriteImaginaryTokenRefRoot(args,token,hetero,elementIndex) ::= <<
+rewriteImaginaryTokenRefRoot(args,token,elementIndex,terminalOptions={}) ::= <<
 root_<treeLevel> = @adaptor.become_root( <createImaginaryNode(tokenType=token, ...)>, root_<treeLevel> )<\n>
 >>
 
@@ -303,27 +303,30 @@ rewriteWildcardLabelRef(label) ::= <<
 @adaptor.add_child( root_<treeLevel>, stream_<label>.next_tree )<\n>
 >>
 
-createImaginaryNode(tokenType,hetero,args) ::= <<
-<if(hetero)>
-<hetero; format="constantPath">.new( create_token( <tokenType> )<if(args)>, <args; separator=", "><endif> )
+createImaginaryNode(tokenType,args,terminalOptions={}) ::= <%
+<if(terminalOptions.node)>
+<terminalOptions.node; format="constantPath">.new( create_token( <tokenType> )<if(args)>, <args; separator=", "><endif> )
 <else>
 <if(!args)>@adaptor.create_from_type( <tokenType>, "<tokenType>" )
 <else>@adaptor.create( <tokenType>, <args; separator=", "> )
 <endif>
 <endif>
->>
+%>
 
-createRewriteNodeFromElement(token,hetero,args) ::= <<
-<if(hetero)>
-<hetero; format="constantPath">.new( stream_<token>.next<if(args)>, <args; separator=", "><endif> )
+createRewriteNodeFromElement(token,args,terminalOptions={}) ::= <%
+<if(terminalOptions.node)>
+<terminalOptions.node; format="constantPath">.new( stream_<token>.next<if(args)>, <args; separator=", "><endif> )
 <else>
 <if(args)>
-<if(!rest(args))>@adaptor.create_from_token( <token>, <first(args)> )
-<else><if(!rest(rest(args)))>@adaptor.create_from_token( <token>, <first(args)>, <first(rest(args))> )
+<if(!rest(args))>
+@adaptor.create_from_token( <token>, <first(args)> )
+<else>
+<if(!rest(rest(args)))>
+@adaptor.create_from_token( <token>, <first(args)>, <first(rest(args))> )
 <endif>
 <endif>
 <else>
 stream_<token>.next_node
 <endif>
 <endif>
->>
+%>

data/templates/ASTParser.stg

@@ -13,7 +13,7 @@ end
 return_value.tree = @adaptor.create_error_node( @input, return_value.start, @input.look(-1), re )<\n>
 >>
 
-tokenRef(token,label,elementIndex,hetero) ::= <<
+tokenRef(token,label,elementIndex,terminalOptions={}) ::= <<
 <super.tokenRef(...)>
 <gatedAction({
 tree_for_<label> = <createNodeFromToken(...)>
@@ -21,9 +21,9 @@ tree_for_<label> = <createNodeFromToken(...)>
 })>
 >>
 
-tokenRefBang(token,label,elementIndex) ::= "<super.tokenRef(...)>"
+tokenRefBang(token,label,elementIndex,terminalOptions={}) ::= "<super.tokenRef(...)>"
 
-tokenRefRuleRoot(token,label,elementIndex,hetero) ::= <<
+tokenRefRuleRoot(token,label,elementIndex,terminalOptions={}) ::= <<
 <super.tokenRef(...)>
 <gatedAction({
 tree_for_<label> = <createNodeFromToken(...)>
@@ -31,39 +31,39 @@ root_0 = @adaptor.become_root( tree_for_<label>, root_0 )
 })>
 >>
 
-tokenRefBangAndListLabel(token,label,elementIndex,hetero) ::= <<
+tokenRefBangAndListLabel(token,label,elementIndex,terminalOptions={}) ::= <<
 <tokenRefBang(...)>
 <addToList(elem={<label; format="label">},...)>
 >>
 
-tokenRefAndListLabel(token,label,elementIndex,hetero) ::= <<
+tokenRefAndListLabel(token,label,elementIndex,terminalOptions={}) ::= <<
 <tokenRef(...)>
 <addToList(elem={<label; format="label">},...)>
 >>
 
-tokenRefRuleRootAndListLabel(token,label,hetero,elementIndex) ::= <<
+tokenRefRuleRootAndListLabel(token,label,elementIndex,terminalOptions={}) ::= <<
 <tokenRefRuleRoot(...)>
 <addToList(elem={<label; format="label">},...)>
 >>
 
-matchSet(s,label,hetero,elementIndex,postmatchCode) ::= <<
-<super.matchSet(..., postmatchCode={<gatedAction({@adaptor.add_child( root_0, <createNodeFromToken(...)> )})>})>
+matchSet(s,label,elementIndex,postmatchCode,terminalOptions={}) ::= <<
+<super.matchSet(postmatchCode={<gatedAction({@adaptor.add_child( root_0, <createNodeFromToken(...)> )})>}, ...)>
 >>
 
-matchRuleBlockSet(s,label,hetero,elementIndex,postmatchCode,treeLevel="0") ::= <<
+matchRuleBlockSet(s,label,elementIndex,postmatchCode,treeLevel="0",terminalOptions={}) ::= <<
 <matchSet(...)>
 >>
 
 
 
 matchSetBang(s,label,elementIndex,postmatchCode) ::= "<super.matchSet(...)>"
-matchSetRuleRoot(s,label,hetero,elementIndex,debug) ::= <<
+matchSetRuleRoot(s,label,elementIndex,debug,terminalOptions={}) ::= <<
 <if(label)>
 <label; format="label"> = @input.look<\n>
 <endif>
-<super.matchSet(..., postmatchCode={<gatedAction({root_0 = @adaptor.become_root( <createNodeFromToken(...)>, root_0 )})>})>
+<super.matchSet(postmatchCode={<gatedAction({root_0 = @adaptor.become_root( <createNodeFromToken(...)>, root_0 )})>}, ...)>
 >>
-matchSetRuleRootAndListLabel(s,label,hetero,elementIndex,debug) ::= <<
+matchSetRuleRootAndListLabel(s,label,elementIndex,debug,terminalOptions={}) ::= <<
 <matchSetRuleRoot(...)>
 <addToList(elem={<label; format="label">},...)>
 >>
@@ -107,7 +107,7 @@ ruleRefRuleRootAndListLabel(rule,label,elementIndex,args,scope) ::= <<
 <addToList(elem={<label; format="label">.tree},...)>
 >>
 
-wildcard(label,elementIndex) ::= <<
+wildcard(token,label,elementIndex,terminalOptions={}) ::= <<
 <super.wildcard(...)>
 <gatedAction({
 tree_for_<label> = @adaptor.create_with_payload( <label; format="label"> )
@@ -115,9 +115,9 @@ tree_for_<label> = @adaptor.create_with_payload( <label; format="label"> )
 })>
 >>
 
-wildcardBang(label,elementIndex) ::= "<super.wildcard(...)>"
+wildcardBang(token,label,elementIndex,terminalOptions={}) ::= "<super.wildcard(...)>"
 
-wildcardRuleRoot(label,elementIndex) ::= <<
+wildcardRuleRoot(token,label,elementIndex,terminalOptions={}) ::= <<
 <super.wildcard(...)>
 <gatedAction({
 tree_for_<label> = @adaptor.create_with_payload( <label; format="label"> )
@@ -125,13 +125,14 @@ root_0 = @adaptor.become_root( tree_for_<label>, root_0 )
 })>
 >>
 
-createNodeFromToken(label,hetero) ::= <<
-<if(hetero)>
-<hetero; format="constantPath">.new( <label; format="label"> )
+
+createNodeFromToken(label,terminalOptions={}) ::= <%
+<if(terminalOptions.node)>
+<terminalOptions.node; format="constantPath">.new( <label; format="label"> )
 <else>
 @adaptor.create_with_payload( <label; format="label"> )
 <endif>
->>
+%>
 
 ruleCleanUp() ::= <<
 <super.ruleCleanUp()>