antlr3 1.4.0 → 1.6.0

data/lib/antlr3/test/core-extensions.rb

@@ -176,7 +176,7 @@ end
 
 class File
   
-  # Given some target path string, and an optional reference path
+  # given some target path string, and an optional reference path
   # (Dir.pwd by default), this method returns a string containing
   # the relative path of the target path from the reference path
   # 

data/lib/antlr3/token.rb

@@ -281,21 +281,21 @@ module TokenSource
   
   def next
     token = next_token()
-    raise StopIteration if token.nil? or token.type == EOF
+    raise StopIteration if token.nil? || token.type == EOF
     return token
   end
   
   def to_stream(options = {})
     if block_given?
-      CommonTokenStream.new(self, options) { |t| yield(t) }
+      CommonTokenStream.new( self, options ) { | t, stream | yield( t, stream ) }
     else
-      CommonTokenStream.new(self, options)
+      CommonTokenStream.new( self, options )
     end
   end
   
   def each
     block_given? or return enum_for(:each)
-    loop { yield(self.next) }
+    loop { yield( self.next ) }
   rescue StopIteration
     return self
   end

data/lib/antlr3/tree.rb

@@ -287,28 +287,8 @@ module Tree
   #  self.ancestors.each { |anc| yield(anc) }
   #end
   
-  #def walk
-  #  block_given? or return( enum_for( :walk ) )
-  #  stack = []
-  #  cursor = self
-  #  loop do
-  #    begin
-  #      yield(cursor)
-  #      stack.push(cursor.children.clone) unless cursor.leaf?
-  #    rescue StopIteration
-  #      # skips adding children to prune the node
-  #    ensure
-  #      break if stack.empty?
-  #      cursor = stack.last.shift
-  #      stack.pop if stack.last.empty?
-  #    end
-  #  end
-  #  return self
-  #end
   
-  #def prune
-  #  raise StopIteration
-  #end
+
   
   #alias :each :walk
   #
@@ -319,7 +299,7 @@ module Tree
   #def leaf?
   #  children.empty?
   #end
-  #
+  
   #def ancestors
   #  a = []
   #  cursor = self
@@ -400,7 +380,7 @@ class BaseTree < ::Array
     killed = delete_at( index ) and freshen( index )
     return killed
   end
-  
+
   def replace_children( start, stop, new_tree )
     start >= length or stop >= length and
       raise IndexError, (<<-END).gsub!(/^\s+\| /,'')
@@ -446,6 +426,29 @@ class BaseTree < ::Array
     return( buffer )
   end
   
+  def walk
+    block_given? or return( enum_for( :walk ) )
+    stack = []
+    cursor = self
+    while true
+      begin
+        yield( cursor )
+        stack.push( Array[ *cursor ] ) unless cursor.empty?
+      rescue StopIteration
+        # skips adding children to prune the node
+      ensure
+        break if stack.empty?
+        cursor = stack.last.shift
+        stack.pop if stack.last.empty?
+      end
+    end
+    return self
+  end
+  
+  def prune
+    raise StopIteration
+  end
+  
   abstract :to_s
   #protected :sanity_check, :freshen
 end
@@ -498,7 +501,6 @@ class CommonTree < BaseTree
     @parent = nil
   end
   
-  
   def copy_node
     return self.class.new( @token )
   end
@@ -528,7 +530,6 @@ class CommonTree < BaseTree
     end
     return @token.column
   end
-
   
   def start_index
     @start_index == -1 and @token and return @token.index
@@ -843,7 +844,7 @@ class CommonTreeAdaptor
   end
   
   def create_flat_list!
-    return self.create_with_payload!( nil )
+    return create_with_payload!( nil )
   end
   
   def become_root( new_root, old_root )
@@ -884,6 +885,7 @@ class CommonTreeAdaptor
   def create_with_payload!( payload )
     return CommonTree.new( payload )
   end
+  
   def create!( *args )
     n = args.length
     if n == 1 and args.first.is_a?( Token ) then create_with_payload!( args[0] )
@@ -911,7 +913,7 @@ class CommonTreeAdaptor
   end
   
   def each_child( tree )
-    block_given? or return enum_for( __method__, tree )
+    block_given? or return enum_for( :each_child, tree )
     tree.each do | child |
       yield( child )
     end
@@ -979,14 +981,14 @@ class CommonTreeNodeStream
   attr_reader :adaptor, :position
   
   def initialize(*args)
+    options = args.last.is_a?( ::Hash ) ? args.pop : {}
     case n = args.length
     when 1
-      @adaptor = CommonTreeAdaptor.new
       @root = args.first
-      @nodes = @down = @up = @eof = nil
+      @token_stream = @adaptor = @nodes = @down = @up = @eof = nil
     when 2
       @adaptor, @root = args
-      @nodes = @down = @up = @eof = nil
+      @token_stream = @nodes = @down = @up = @eof = nil
     when 3
       parent, start, stop = *args
       @adaptor = parent.adaptor
@@ -995,17 +997,19 @@ class CommonTreeNodeStream
       @down = parent.down
       @up = parent.up
       @eof = parent.eof
+      @token_stream = parent.token_stream
     when 0
       raise ArgumentError, "wrong number of arguments (0 for 1)"
     else raise ArgumentError, "wrong number of arguments (#{ n } for 3)"
     end
-    @down  ||= @adaptor.create_from_type!( DOWN, 'DOWN' )
-    @up    ||= @adaptor.create_from_type!( UP, 'UP' )
-    @eof   ||= @adaptor.create_from_type!( EOF, 'EOF' )
+    @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' ) }
     @nodes ||= []
-    @token_stream = nil
     
-    @unique_navigation_nodes = false
+    @unique_navigation_nodes = options.fetch( :unique_navigation_nodes, false )
     @position = -1
     @last_marker = nil
     @calls = []

data/lib/antlr3/tree/debug.rb

@@ -9,10 +9,11 @@ Adds debugging event hooks to TreeAdaptor objects
 
 =end
 module TreeAdaptor
-  def self.wrap(adaptor, debug_listener = nil)
+  
+  def self.wrap( adaptor, debug_listener = nil )
     adaptor.extend(self)
     adaptor.debug_listener = debug_listener
-    return(adaptor)
+    return( adaptor )
   end
   
   attr_accessor :debug_listener

data/lib/antlr3/version.rb

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

data/templates/Ruby.stg

@@ -44,7 +44,7 @@ Current load path:
   END
 end
 
-defined?(ANTLR3) or begin
+defined?( ANTLR3 ) or begin
   
   # 1: try to load the ruby antlr3 runtime library from the system path
   require 'antlr3'
@@ -52,7 +52,7 @@ defined?(ANTLR3) or begin
 rescue LoadError
   
   # 2: try to load rubygems if it isn't already loaded
-  defined?(Gem) or begin
+  defined?( Gem ) or begin
     require 'rubygems'
   rescue LoadError
     antlr_load_failed.call
@@ -60,7 +60,7 @@ rescue LoadError
   
   # 3: try to activate the antlr3 gem
   begin
-    Gem.activate( 'antlr3', '= <runtimeLibraryVersion()>' )
+    Gem.activate( 'antlr3', '~> <runtimeLibraryVersion()>' )
   rescue Gem::LoadError
     antlr_load_failed.call
   end
@@ -97,7 +97,7 @@ module TokenData
 <if(tokens)>
 
   # define the token constants
-  define_tokens(<tokens:{:<it.name> => <it.type>}; anchor, wrap="\n", separator=", ">)
+  define_tokens( <tokens:{:<it.name> => <it.type>}; anchor, wrap="\n", separator=", "> )
 
 <endif>
 <if(tokenNames)>
@@ -108,7 +108,7 @@ module TokenData
   # this is necessary because anonymous tokens, which are
   # created from literal values in the grammar, do not
   # have descriptive names
-  register_names(<tokenNames:{<it>}; separator=", ", anchor, wrap="\n">)
+  register_names( <tokenNames:{<it>}; separator=", ", anchor, wrap="\n"> )
 
 <endif>
   
@@ -189,7 +189,7 @@ parserBody(grammar, name, scopes, tokens, tokenNames, rules, numRules, bitsets,
 <if(!grammar.grammarIsRoot)><autoloadDelegates()><\n><endif>
 <@mixins()>
 
-RULE_METHODS = [<rules:{r|:<r.ruleName>}; separator=", ", wrap="\n", anchor>].freeze
+RULE_METHODS = [ <rules:{r|:<r.ruleName>}; separator=", ", wrap="\n", anchor> ].freeze
 
 <scopes:{<if(it.isDynamicGlobalScope)><globalAttributeScopeClass(scope=it)><\n><endif>}>
 <rules:{<ruleAttributeScopeClass(scope=it.ruleDescriptor.ruleScope)>}>
@@ -234,8 +234,8 @@ end
 >>
 
 parserConstructor() ::= <<
-def initialize(<grammar.delegators:{g|<g:delegateName()>, }>input, options = {})
-  super(input, options)
+def initialize( <grammar.delegators:{g|<g:delegateName()>, }>input, options = {} )
+  super( input, options )
 <if(memoize)><if(grammar.grammarIsRoot)>
   @state.rule_memory = {}
 <endif><endif>
@@ -257,10 +257,15 @@ end
   * need to be in a rule by themselves.
   */
 synpredRule(ruleName, ruleDescriptor, block, description, nakedBlock) ::= <<
-# parser rule <ruleName; format="lexerRule"> (<ruleName>)
+# 
+# syntactic predicate <ruleName; format="lexerRule">
 # 
 # (in <fileName>)
 # <description>
+# 
+# This is an imaginary rule inserted by ANTLR to
+# implement a syntactic predicate decision
+# 
 def <ruleName; format="lexerRule"><if(ruleDescriptor.parameterScope)>(<ruleDescriptor.parameterScope:parameterScope(scope=it)>)<endif>
   <traceIn()><ruleLabelDefs()>
   <block>
@@ -276,10 +281,12 @@ end
 rule(ruleName, ruleDescriptor, block, emptyRule, description, exceptions, finally, memoize) ::= <<
 <returnScope(scope=ruleDescriptor.returnScope)>
 
+# 
 # parser rule <ruleName>
 # 
 # (in <fileName>)
 # <description>
+# 
 def <ruleName><if(ruleDescriptor.parameterScope)>(<ruleDescriptor.parameterScope:parameterScope(scope=it)>)<endif>
   <traceIn()><ruleScopeSetUp()><ruleDeclarations()><ruleLabelDefs()><action(name="init", code=ruleDescriptor.actions.init)>
   <@body><ruleBody()><@end>
@@ -292,7 +299,6 @@ end
 <endif>
 >>
 
-
 delegateRule(ruleDescriptor) ::= <<
 # delegated rule <ruleDescriptor.name>
 def <ruleDescriptor.name>(<ruleDescriptor.parameterScope:parameterScope(scope=it)>)
@@ -333,7 +339,7 @@ rescue <e.decl>
 >>
 
 closureBlockLoop() ::= <<
-loop do # decision <decisionNumber>
+while true # decision <decisionNumber>
   alt_<decisionNumber> = <maxAlt>
   <@decisionBody><decision><@end>
   case alt_<decisionNumber>
@@ -356,12 +362,12 @@ element() ::= <<
 execForcedAction(action) ::= "<action>"
 
 globalAttributeScopeClass(scope) ::= <<
-<if(scope.attributes)>Scope<scope.name> = Struct.new(<scope.attributes:{:<it.decl>}; separator=", ">)<endif>
+<if(scope.attributes)>@@<scope.name> = Struct.new( <scope.attributes:{:<it.decl>}; separator=", "> )<\n><endif>
 >>
 
 
 globalAttributeScopeStack(scope) ::= <<
-<if(scope.attributes)>@<scope.name>_stack = []<endif>
+<if(scope.attributes)>@<scope.name>_stack = []<\n><endif>
 >>
 
 
@@ -375,7 +381,7 @@ parameterScope(scope) ::= <<
 
 positiveClosureBlockLoop() ::= <<
 match_count_<decisionNumber> = 0
-loop do
+while true
   alt_<decisionNumber> = <maxAlt>
   <@decisionBody><decision><@end>
   case alt_<decisionNumber>
@@ -390,6 +396,7 @@ loop do
   match_count_<decisionNumber> += 1
 end<\n>
 >>
+
 returnScope(scope) ::= <<
 <if(ruleDescriptor.hasMultipleReturnValues)>
 <ruleDescriptor:returnStructName(r=it)> = define_return_scope <scope.attributes:{:<it.decl>}; separator=", ">
@@ -398,21 +405,8 @@ returnScope(scope) ::= <<
 
 
 returnStructName(r) ::= "<r.name; format=\"camelcase\">ReturnValue"
-
-
-ruleAttributeScopeClass(scope) ::= <<
-<if(scope.attributes)>
-Scope<scope.name> = Struct.new(<scope.attributes:{:<it.decl>}; separator=", ">)<\n>
-<endif>
->>
-
-
-ruleAttributeScopeStack(scope) ::= <<
-<if(scope.attributes)>
-@<scope.name>_stack = []<\n>
-<endif>
->>
-
+ruleAttributeScopeClass ::= globalAttributeScopeClass
+ruleAttributeScopeStack ::= globalAttributeScopeStack
 
 ruleBacktrackFailure() ::= <<
 <if(backtracking)>
@@ -420,7 +414,6 @@ ruleBacktrackFailure() ::= <<
 <endif>
 >>
 
-
 ruleBody() ::= <<
 <if(memoize)><if(backtracking)>
 success = false # flag used for memoization<\n>
@@ -527,7 +520,7 @@ return_value.stop = @input.look(-1)<\n>
 ruleMemoization(name) ::= <<
 <if(memoize)>
 # rule memoization
-if @state.backtracking > 0 and already_parsed_rule?(__method__)
+if @state.backtracking > 0 and already_parsed_rule?( __method__ )
   success = true
   return <ruleReturnValue()>
 end<\n>
@@ -536,7 +529,7 @@ end<\n>
 
 
 ruleScopeSetUp() ::= <<
-<ruleDescriptor.useScopes:{@<it>_stack.push(Scope<it>.new)<\n>}><ruleDescriptor.ruleScope:{@<it.name>_stack.push(Scope<it.name>.new)<\n>}>
+<ruleDescriptor.useScopes:{@<it>_stack.push(@@<it>.new)<\n>}><ruleDescriptor.ruleScope:{@<it.name>_stack.push(@@<it.name>.new)<\n>}>
 >>
 
 
@@ -751,6 +744,7 @@ match(UP, nil)
   */
 validateSemanticPredicate(pred,description) ::= <<
 unless (<evalPredicate(...)>)
+  <ruleBacktrackFailure()>
   raise FailedPredicate("<ruleName>", "<description>")
 end
 >>
@@ -1497,4 +1491,4 @@ placeAction(scope, name) ::= <<
 <endif>
 >>
 
-runtimeLibraryVersion() ::= "1.4.0"
+runtimeLibraryVersion() ::= "1.6.0"

data/templates/ST.stg

@@ -123,6 +123,3 @@ rulePropertyRef_text(scope, attr) ::= <<
 argumentMap(args) ::= <<
 <args:{a|:<a.name> => <a.value>}; separator=",\n">
 >>
-
-
-

data/test/functional/ast-output/construction.rb

@@ -5,7 +5,7 @@ require 'antlr3/test/functional'
 
 class TestASTConstructingParser < ANTLR3::Test::Functional
 
-  inline_grammar(<<-'END')
+  compile inline_grammar( <<-'END' )
     grammar ASTBuilder;
     options {
       language = Ruby;

data/test/unit/test-exceptions.rb

@@ -6,6 +6,18 @@ require 'test/unit'
 require 'spec'
 
 include ANTLR3::Error
+
+describe( ANTLR3::Error ) do
+  
+  example "raising an ANTLR bug exception" do
+    proc {
+      ANTLR3.bug!( 'whateva' )
+    }.should raise_error( ANTLR3::Bug )
+  end
+  
+  
+end
+
 #
 #class TestRecognitionError < Test::Unit::TestCase
 #  def test_init_none