antlr3 1.6.3 → 1.7.2

data/lib/antlr3/template/group-file.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+
+=begin      ::about::
+author:     Kyle Yetter <kcy5b@yahoo.com>
+created on: March 19, 2010
+purpose:    Loads the ANTLR recognition code for ANTLR Template Group files
+=end
+
+require 'antlr3/template/group-file-lexer'
+require 'antlr3/template/group-file-parser'
+
+module ANTLR3
+module Template
+class Group
+  Lexer  = GroupFile::Lexer
+  Parser = GroupFile::Parser
+end
+end
+end

data/lib/antlr3/tree.rb

@@ -836,15 +836,15 @@ class CommonTreeAdaptor
   end
   
   def create_flat_list
-    return create_with_payload!( nil )
+    return create_with_payload( nil )
   end
   alias create_flat_list! create_flat_list
   
   def become_root( new_root, old_root )
-    new_root = create!( new_root ) if new_root.is_a?( Token )
+    new_root = create( new_root ) if new_root.is_a?( Token )
     old_root or return( new_root )
     
-    new_root = create_with_payload!( new_root ) unless CommonTree === new_root
+    new_root = create_with_payload( new_root ) unless CommonTree === new_root
     if new_root.flat_list?
       count = new_root.child_count
       if count == 1
@@ -862,13 +862,13 @@ class CommonTreeAdaptor
     from_token = from_token.dup
     from_token.type = token_type
     from_token.text = text.to_s if text
-    tree = create_with_payload!( from_token )
+    tree = create_with_payload( from_token )
     return tree
   end
   
   def create_from_type( token_type, text )
     from_token = create_token( token_type, DEFAULT_CHANNEL, text )
-    create_with_payload!( from_token )
+    create_with_payload( from_token )
   end
   
   def create_error_node( input, start, stop, exc )
@@ -881,11 +881,11 @@ class CommonTreeAdaptor
 
   def create( *args )
     n = args.length
-    if n == 1 and args.first.is_a?( Token ) then create_with_payload!( args[ 0 ] )
+    if n == 1 and args.first.is_a?( Token ) then create_with_payload( args[ 0 ] )
     elsif n == 2 and Integer === args.first and String === args[ 1 ]
-      create_from_type!( *args )
+      create_from_type( *args )
     elsif n >= 2 and Integer === args.first
-      create_from_token!( *args )
+      create_from_token( *args )
     else
       sig = args.map { |f| f.class }.join( ', ' )
       raise TypeError, "No create method with this signature found: (#{ sig })"
@@ -1008,9 +1008,9 @@ class CommonTreeNodeStream
     end
     @adaptor ||= options.fetch( :adaptor ) { CommonTreeAdaptor.new }
     @token_stream ||= options[ :token_stream ]
-    @down  ||= options.fetch( :down ) { @adaptor.create_from_type!( DOWN, 'DOWN' ) }
-    @up    ||= options.fetch( :up )   { @adaptor.create_from_type!( UP, 'UP' ) }
-    @eof   ||= options.fetch( :eof )  { @adaptor.create_from_type!( EOF, 'EOF' ) }
+    @down  ||= options.fetch( :down ) { @adaptor.create_from_type( DOWN, 'DOWN' ) }
+    @up    ||= options.fetch( :up )   { @adaptor.create_from_type( UP, 'UP' ) }
+    @eof   ||= options.fetch( :eof )  { @adaptor.create_from_type( EOF, 'EOF' ) }
     @nodes ||= []
     
     @unique_navigation_nodes = options.fetch( :unique_navigation_nodes, false )
@@ -1039,9 +1039,9 @@ class CommonTreeNodeStream
     navigation_node =
       case type
       when DOWN
-        has_unique_navigation_nodes? ? @adaptor.create_from_type!( DOWN, 'DOWN' ) : @down
+        has_unique_navigation_nodes? ? @adaptor.create_from_type( DOWN, 'DOWN' ) : @down
       else
-        has_unique_navigation_nodes? ? @adaptor.create_from_type!( UP, 'UP' ) : @up
+        has_unique_navigation_nodes? ? @adaptor.create_from_type( UP, 'UP' ) : @up
       end
     @nodes << navigation_node
   end
@@ -1089,7 +1089,9 @@ class CommonTreeNodeStream
   
   def consume
     @position == -1 and fill_buffer
+    node = @nodes.fetch( @position, @eof )
     @position += 1
+    return( node )
   end
   
   def peek( i = 1 )
@@ -1329,7 +1331,7 @@ rewriting parsers.
 =end
 class RewriteRuleTokenStream < RewriteRuleElementStream
   def next_node
-    return @adaptor.create_with_payload!( __next__ )
+    return @adaptor.create_with_payload( __next__ )
   end
   
   alias :next :__next__

data/lib/antlr3/tree/debug.rb

@@ -18,25 +18,25 @@ module TreeAdaptor
   
   attr_accessor :debug_listener
   
-  def create_with_payload!(payload)
+  def create_with_payload(payload)
     node = super
     @debug_listener.create_node(node, payload)
     return node
   end
   
-  def create_from_token!(token_type, from_token, text = nil)
+  def create_from_token(token_type, from_token, text = nil)
     node = super
     @debug_listener.create_node(node)
     return node
   end
   
-  def create_from_type!(token_type, text)
+  def create_from_type(token_type, text)
     node = super
     @debug_listener.create_node(node)
     return node
   end
   
-  def create_error_node!(input, start, stop, exc)
+  def create_error_node(input, start, stop, exc)
     node = super
     node.nil? or @debug_listener.error_node(node)
     return node
@@ -63,7 +63,7 @@ module TreeAdaptor
     return duplicate
   end
   
-  def create_flat_list!
+  def create_flat_list
     node = super
     @debug_listener.flat_node(node)
     return node
@@ -72,7 +72,7 @@ module TreeAdaptor
   def add_child(tree, child)
     case child
     when Token
-      node = create_with_payload!(child)
+      node = create_with_payload(child)
       add_child(tree, node)
     else
       tree.nil? || child.nil? and return
@@ -84,7 +84,7 @@ module TreeAdaptor
   def become_root(new_root, old_root)
     case new_root
     when Token
-      n = create_with_payload!(new_root)
+      n = create_with_payload(new_root)
       super(n, old_root)
     else
       n = super(new_root, old_root)

data/lib/antlr3/tree/wizard.rb

@@ -251,7 +251,7 @@ from a tokenized tree pattern
       @token_type == :identifier or return nil
       token_name = @tokenizer.text
       @token_type = @tokenizer.next_token
-      token_name == 'nil' and return @adaptor.create_flat_list!
+      token_name == 'nil' and return @adaptor.create_flat_list
       
       text = token_name
       arg = nil
@@ -262,7 +262,7 @@ from a tokenized tree pattern
       end
       
       node_type = @token_scheme[ token_name ] || INVALID_TOKEN_TYPE
-      node = @adaptor.create_from_type!( node_type, text )
+      node = @adaptor.create_from_type( node_type, text )
       
       if Pattern === node
         node.label, node.has_text_arg = label, arg
@@ -318,7 +318,7 @@ A customized TreeAdaptor used by AST::Wizards to build tree patterns.
 =end
 
   class PatternAdaptor < CommonTreeAdaptor
-    def create_with_payload!( payload )
+    def create_with_payload( payload )
       return Pattern.new( payload )
     end
   end

data/lib/antlr3/version.rb

@@ -19,8 +19,8 @@ module ANTLR3
   # The version data for the current state the library itself
   # 
   MAJOR_VERSION = 1
-  MINOR_VERSION = 6
-  PATCH_VERSION = 3
+  MINOR_VERSION = 7
+  PATCH_VERSION = 2
   VERSION = [ MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION ]
   VERSION_STRING = VERSION.join( '.' ).freeze
   

data/samples/ANTLRv3Grammar.g

@@ -78,15 +78,6 @@ tokens {
   LIST_LABEL_ASSIGN='+=';
 }
 
-/* action -> @parser::header
-{
-    package org.antlr.grammar.v3;
-} */
-/* action -> @lexer::header
-{
-    package org.antlr.grammar.v3;
-} */
-
 @members {
 	attr_reader :grammar_type
 }

data/templates/AST.stg

@@ -25,22 +25,22 @@ ruleLabelDefs() ::= <<
 <[ruleDescriptor.tokenLabels,ruleDescriptor.wildcardTreeLabels,ruleDescriptor.wildcardTreeListLabels,ruleDescriptor.tokenListLabels]
     :{tree_for_<it.label.text> = nil}; separator="\n">
 <ruleDescriptor.allTokenRefsInAltsWithRewrites
-    :{stream_<it> = ANTLR3::AST::RewriteRule<rewriteElementType>Stream.new(@adaptor, "token <it>")}; separator="\n">
+    :{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">
+    :{stream_<it> = ANTLR3::AST::RewriteRuleSubtreeStream.new( @adaptor, "rule <it>" )}; separator="\n">
 >>
 
 alt(elements,altNum,description,autoAST,outerAlt,treeLevel,rew) ::= <<
 <if(autoAST)><if(outerAlt)><if(!rewriteMode)>
-root_0 = @adaptor.create_flat_list!<\n><\n>
+root_0 = @adaptor.create_flat_list<\n><\n>
 <endif><endif><endif>
 # at line <description>
 <elements:element()><rew>
 >>
 
 tokenRefTrack(token,label,elementIndex,hetero) ::= <<
-<tokenRefBang(...)> <! Track implies no auto AST construction!>
-<gatedAction({stream_<token>.add(<label; format="label">)})>
+<tokenRefBang(...)>
+<gatedAction({stream_<token>.add( <label; format="label"> )})>
 >>
 
 tokenRefTrackAndListLabel(token,label,elementIndex,hetero) ::= <<
@@ -50,7 +50,7 @@ tokenRefTrackAndListLabel(token,label,elementIndex,hetero) ::= <<
 
 tokenRefRuleRootTrack(token,label,elementIndex,hetero) ::= <<
 <tokenRefBang(...)>
-<gatedAction({stream_<token>.add(<label; format="label">)})>
+<gatedAction({stream_<token>.add( <label; format="label"> )})>
 >>
 
 tokenRefRuleRootTrackAndListLabel(token,label,elementIndex,hetero) ::= <<
@@ -60,7 +60,7 @@ tokenRefRuleRootTrackAndListLabel(token,label,elementIndex,hetero) ::= <<
 
 ruleRefTrack(rule,label,elementIndex,args,scope) ::= <<
 <super.ruleRef(...)>
-<gatedAction({stream_<rule.name>.add(<label; format="label">.tree)})>
+<gatedAction({stream_<rule.name>.add( <label; format="label">.tree )})>
 >>
 
 ruleRefTrackAndListLabel(rule,label,elementIndex,args,scope) ::= <<
@@ -69,7 +69,7 @@ ruleRefTrackAndListLabel(rule,label,elementIndex,args,scope) ::= <<
 >>
 ruleRefRuleRootTrack(rule,label,elementIndex,args,scope) ::= <<
 <ruleRefRuleRoot(...)>
-<gatedAction({stream_<rule.name>.add(<label; format="label">.tree)})>
+<gatedAction({stream_<rule.name>.add( <label; format="label">.tree )})>
 >>
 
 ruleRefRuleRootTrackAndListLabel(rule,label,elementIndex,args,scope) ::= <<
@@ -98,7 +98,7 @@ rewriteCode(alts, description,
 <gatedAction({
 <prevRuleRootRef(); format="label">.tree = root_0
 <rewriteCodeLabels()>
-root_0 = @adaptor.create_flat_list!
+root_0 = @adaptor.create_flat_list
 <first(alts):rewriteAltFirst(); anchor>
 
 <rest(alts):{a| els<rewriteAltRest(a)>}; anchor, separator="\n\n">
@@ -106,11 +106,11 @@ root_0 = @adaptor.create_flat_list!
 <! if tree parser and rewrite=true !>
 <if(TREE_PARSER)>
 <if(rewriteMode)>
-<prevRuleRootRef(); format="label">.tree = @adaptor.rule_post_processing(root_0)
+<prevRuleRootRef(); format="label">.tree = @adaptor.rule_post_processing( root_0 )
 @input.replace_children(
-  @adaptor.parent(return_value.start),
-  @adaptor.child_index(return_value.start),
-  @adaptor.child_index(_last),
+  @adaptor.parent( return_value.start ),
+  @adaptor.child_index( return_value.start ),
+  @adaptor.child_index( _last ),
   return_value.tree
 )<\n>
 <endif>
@@ -129,22 +129,22 @@ root_0 = @adaptor.create_flat_list!
 
 rewriteCodeLabels() ::= <<
 <referencedTokenLabels:
-{stream_<it> = <rewriteElementType; format="snakecase">_stream("token <it>", <it; format="label">)};
+{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">)};
+{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">)};
+{stream_<it> = subtree_stream( "wildcard <it>", <it; format="label"> )};
 separator="\n">
 <referencedWildcardListLabels:
-{stream_<it> = subtree_stream("wildcard <it>", list_of_<it; format="label">)};
+{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>")};
+{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">)};
+{stream_<it> = subtree_stream( "token <it>", list_of_<it; format="label"> )};
 separator="\n">
 >>
 
@@ -155,11 +155,11 @@ rewriteOptionalBlock(
         description) ::=
 <<
 # at line <description>
-if <referencedElementsDeep:{el | stream_<el>.has_next?}; separator=" || ">
+if <referencedElementsDeep:{el|stream_<el>.has_next?}; separator=" || ">
   <alt>
 end
 
-<referencedElementsDeep:{el | stream_<el>.reset();<\n>}>
+<referencedElementsDeep:{el|stream_<el>.reset();<\n>}>
 >>
 
 rewriteClosureBlock(
@@ -169,11 +169,11 @@ rewriteClosureBlock(
         description) ::=
 <<
 # at line <description>
-while <referencedElements:{el | stream_<el>.has_next?}; separator=" || ">
+while <referencedElements:{el|stream_<el>.has_next?}; separator=" || ">
   <alt>
 end
 
-<referencedElements:{el | stream_<el>.reset();<\n>}>
+<referencedElements:{el|stream_<el>.reset();<\n>}>
 >>
 
 rewritePositiveClosureBlock(
@@ -183,15 +183,12 @@ rewritePositiveClosureBlock(
         description) ::=
 <<
 # at line <description>
-unless <referencedElements:{el | stream_<el>.has_next?}; separator=" || ">
-  raise ANTLR3::RewriteEarlyExit
-end
+<referencedElements:{el|stream_<el>.has_next?}; separator=" || "> or raise ANTLR3::RewriteEarlyExit
 
-while <referencedElements:{el | stream_<el>.has_next?}; separator=" || ">
+while <referencedElements:{el|stream_<el>.has_next?}; separator=" || ">
   <alt>
 end
-
-<referencedElements:{el | stream_<el>.reset<\n>}>
+<referencedElements:{el|stream_<el>.reset<\n>}>
 >>
 
 rewriteAltRest(a) ::= <<
@@ -200,7 +197,7 @@ if <a.pred>
   # <a.description>
   <a.alt>
 <else>
-e <! little hack to get if .. elsif .. else block right !>
+e
   # <a.description>
   <a.alt>
 end
@@ -222,10 +219,10 @@ rewriteEmptyAlt() ::= "root_0 = nil"
 
 rewriteTree(root,children,description,enclosingTreeLevel,treeLevel) ::= <<
 # at line <description>
-root_<treeLevel> = @adaptor.create_flat_list!
+root_<treeLevel> = @adaptor.create_flat_list
 <root:rewriteElement()>
 <children:rewriteElement()>
-@adaptor.add_child(root_<enclosingTreeLevel>, root_<treeLevel>)<\n>
+@adaptor.add_child( root_<enclosingTreeLevel>, root_<treeLevel> )<\n>
 >>
 
 rewriteElementList(elements) ::= "<elements:rewriteElement()>"
@@ -235,33 +232,33 @@ rewriteElement(e) ::= <<
 >>
 
 rewriteTokenRef(token,elementIndex,hetero,args) ::= <<
-@adaptor.add_child(root_<treeLevel>, <createRewriteNodeFromElement(...)>)<\n>
+@adaptor.add_child( root_<treeLevel>, <createRewriteNodeFromElement(...)> )<\n>
 >>
 
 rewriteTokenLabelRef(label,elementIndex) ::= <<
-@adaptor.add_child(root_<treeLevel>, stream_<label>.next_node)<\n>
+@adaptor.add_child( root_<treeLevel>, stream_<label>.next_node )<\n>
 >>
 
 rewriteTokenListLabelRef(label,elementIndex) ::= <<
-@adaptor.add_child(root_<treeLevel>, stream_<label>.next_node)<\n>
+@adaptor.add_child( root_<treeLevel>, stream_<label>.next_node )<\n>
 >>
 
 rewriteTokenLabelRefRoot(label,elementIndex) ::= <<
-root_<treeLevel> = @adaptor.become_root(stream_<label>.next_node, root_<treeLevel>)<\n>
+root_<treeLevel> = @adaptor.become_root( stream_<label>.next_node, root_<treeLevel> )<\n>
 >>
 
 rewriteTokenListLabelRefRoot ::= rewriteTokenLabelRefRoot
 
 rewriteTokenRefRoot(token,elementIndex,hetero,args) ::= <<
-root_<treeLevel> = @adaptor.become_root(<createRewriteNodeFromElement(...)>, root_<treeLevel>)<\n>
+root_<treeLevel> = @adaptor.become_root( <createRewriteNodeFromElement(...)>, root_<treeLevel> )<\n>
 >>
 
 rewriteImaginaryTokenRef(args,token,hetero,elementIndex) ::= <<
-@adaptor.add_child(root_<treeLevel>, <createImaginaryNode(tokenType=token, ...)>)<\n>
+@adaptor.add_child( root_<treeLevel>, <createImaginaryNode(tokenType=token, ...)> )<\n>
 >>
 
 rewriteImaginaryTokenRefRoot(args,token,hetero,elementIndex) ::= <<
-root_<treeLevel> = @adaptor.become_root(<createImaginaryNode(tokenType=token, ...)>, root_<treeLevel>)<\n>
+root_<treeLevel> = @adaptor.become_root( <createImaginaryNode(tokenType=token, ...)>, root_<treeLevel> )<\n>
 >>
 
 rewriteAction(action) ::= <<
@@ -271,61 +268,58 @@ root_0 = ( <action> )<\n>
 prevRuleRootRef() ::= "return_value"
 
 rewriteRuleRef(rule) ::= <<
-@adaptor.add_child(root_<treeLevel>, stream_<rule>.next_tree)<\n>
+@adaptor.add_child( root_<treeLevel>, stream_<rule>.next_tree )<\n>
 >>
 
 rewriteRuleRefRoot(rule) ::= <<
-root_<treeLevel> = @adaptor.become_root(stream_<rule>.next_node(), root_<treeLevel>)<\n>
+root_<treeLevel> = @adaptor.become_root( stream_<rule>.next_node, root_<treeLevel> )<\n>
 >>
 
 rewriteNodeAction(action) ::= <<
-@adaptor.add_child(root_<treeLevel>, <action>)<\n>
+@adaptor.add_child( root_<treeLevel>, ( <action> ) )<\n>
 >>
 
 rewriteNodeActionRoot(action) ::= <<
-root_<treeLevel> = @adaptor.become_root(<action>, root_<treeLevel>)<\n>
+root_<treeLevel> = @adaptor.become_root( ( <action> ), root_<treeLevel> )<\n>
 >>
 
 rewriteRuleLabelRef(label) ::= <<
-@adaptor.add_child(root_<treeLevel>, stream_<label>.next_tree)<\n>
+@adaptor.add_child( root_<treeLevel>, stream_<label>.next_tree )<\n>
 >>
 
 rewriteRuleListLabelRef(label) ::= <<
-@adaptor.add_child(root_<treeLevel>, stream_<label>.next_tree)<\n>
+@adaptor.add_child( root_<treeLevel>, stream_<label>.next_tree )<\n>
 >>
 
 rewriteRuleLabelRefRoot(label) ::= <<
-root_<treeLevel> = @adaptor.become_root(stream_<label>.next_node, root_<treeLevel>)<\n>
+root_<treeLevel> = @adaptor.become_root( stream_<label>.next_node, root_<treeLevel> )<\n>
 >>
 
 rewriteRuleListLabelRefRoot(label) ::= <<
-root_<treeLevel> = @adaptor.become_root(stream_<label>.next_node(), root_<treeLevel>)<\n>
+root_<treeLevel> = @adaptor.become_root( stream_<label>.next_node, root_<treeLevel> )<\n>
 >>
 
 rewriteWildcardLabelRef(label) ::= <<
-@adaptor.add_child(root_<treeLevel>, stream_<label>.next_tree)<\n>
+@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>)
+<hetero; 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=", ">)
+<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>)
+<hetero; format="constantPath">.new( stream_<token>.next<if(args)>, <args; separator=", "><endif> )
 <else>
-<if(args)><! must create new node from old !>
-<! need to call different adaptor.create!*() methods depending of argument count !>
-<if(!args)>@adaptor.create_from_type!(<token>, "<token>")
-<else><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>
+<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))> )
 <endif>
 <endif>
 <else>