1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver#!/usr/bin/ruby 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver# encoding: utf-8 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver=begin LICENSE 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver[The "BSD licence"] 7324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverCopyright (c) 2009-2010 Kyle Yetter 8324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverAll rights reserved. 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 10324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverRedistribution and use in source and binary forms, with or without 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermodification, are permitted provided that the following conditions 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverare met: 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1. Redistributions of source code must retain the above copyright 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer. 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 2. Redistributions in binary form must reproduce the above copyright 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer in the 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver documentation and/or other materials provided with the distribution. 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 3. The name of the author may not be used to endorse or promote products 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver derived from this software without specific prior written permission. 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 22324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverTHIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverIMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverOF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverIN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverINCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverTHIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver=end 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver=begin rdoc ANTLR3 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 37324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverThe main namespace for the ANTLR runtime libraries, which are used by 38324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverRuby-targeted recognizers generated by ANTLR. The entire library is segmented 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverinto several main components, as well as a few additional utility components, 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvereach contained within a separate script. 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver== Library Components 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 44324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverNot all components of the ANTLR3 library are necessary within ANTLR generated 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvercode. Some components are only used within specific types of recognizers and 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruversome are simply extra utilities for use by anyone working with ANTLR code. Thus, 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverwhen requiring 'antlr3', only the essential core components are loaded 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimmediately. The rest are configured to autoload when any of the constant names 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverthey define are referenced. 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 51324c4644fee44b9898524c09511bd33c3f12e2dfBen GruverThe following list gives a brief introduction to each component of the ANTLR3 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverruntime library. The items are loosely ordered by importance. 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/recognizers.rb:: 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver contains the base classes for ANTLR-generated recognizers, and thus, is one of 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver the most important components of the runtime library. loaded by default 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/dfa.rb:: 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver defines a single DFA class that is used to simulate state machines for certain 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver decisions recognizers must make in code generated by ANTLR 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/streams.rb:: 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver defines the stream classes used by ANTLR recognizers to walk sequentially 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver through strings, tokens, and tree nodes loaded by default 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/token.rb:: 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver contains all modules and classes concerned with making tokens, the chunks of 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver text and symbol information produced by lexers and used by parsers and ASTs 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver loaded by default 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/error.rb:: 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver defines the Error module, which contains definitions for most of the many 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver error classes used through the runtime library and ANTLR generated 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver recognizers. loaded by default 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/constants.rb:: 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver just a module used as a namespace for the named constant values used 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throughout the library. loaded by default 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/tree.rb:: 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver contains everything pertaining to Abstract Syntax Trees (ASTs). This script is 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver not loaded by default when 'antlr3' is required, but it is autloaded on demand 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver when any constant defined in the script is referenced. contents are autoloaded 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver on demand 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/debug.rb:: 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver when code is generated by ANTLR using the '-debug' option, all of the 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver additional classes and mixins required by the debug code are contained within 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver the Debug module defined by this library. the Debug module is autoloaded on 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver demand 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/main.rb:: 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver defines the Main module. When ANTLR-generated recognizer code is run directly 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver as a script (not loaded as a module), the code will behave as a full 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver command-line script by using functionality implemented in the Main module. the 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Main module is autloaded on demand 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/tree-wizard.rb:: 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver contains extra tools to easily construct ASTs by parsing descriptions written 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver in a special DSL 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverantlr3/dot.rb:: 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver extra utilities to generate DOT map specifications for graphical. 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver representations of ASTs 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver@author Kyle Yetter 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver=end 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvermodule ANTLR3 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # :stopdoc: 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # BEGIN PATHS -- do not modify 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver LIBRARY_PATH = ::File.expand_path( ::File.dirname( __FILE__ ) ).freeze 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver PROJECT_PATH = ::File.dirname( LIBRARY_PATH ).freeze 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver DATA_PATH = ::File.join( PROJECT_PATH, 'java' ).freeze 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # END PATHS 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # :startdoc: 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # Returns the library path for the module. If any arguments are given, 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # they will be joined to the end of the libray path using 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # <tt>File.join</tt>. 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def self.library_path( *args ) 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ::File.expand_path( ::File.join( LIBRARY_PATH, *args ) ) 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # Returns the lpath for the module. If any arguments are given, 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # they will be joined to the end of the path using 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # <tt>File.join</tt>. 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def self.data_path( *args ) 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ::File.expand_path( ::File.join( DATA_PATH, *args ) ) 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # This is used internally in a handful of locations in the runtime library 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # where assumptions have been made that a condition will never happen 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # under normal usage conditions and thus an ANTLR3::Bug error will be 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # raised if the condition does occur. 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def self.bug!( message = nil ) 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bug = Bug.new( message ) 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bug.set_backtrace( caller ) 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver raise( bug ) 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @antlr_jar = nil 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def self.antlr_jar=( path ) 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @antlr_jar = path ? File.expand_path( path.to_s ) : path 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver def self.antlr_jar 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver @antlr_jar and return( @antlr_jar ) 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver path = data_path "antlr-full-#{ ANTLR_VERSION_STRING }.jar" 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if env_path = ENV[ 'RUBY_ANTLR_JAR' ] 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if File.file?( env_path ) then return File.expand_path( env_path ) end 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver warn( 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "#{ __FILE__ }:#{ __LINE__ }: " << 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "ignoring environmental variable RUBY_ANTLR_JAR (=%p) " % env_path << 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "as it is not the path to an existing file\n" << 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver " -> trying default jar path %p instead" % path 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ) 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver File.exists?( path ) ? path : nil 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ############################################################################################## 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ############################### Namespace and Load Path Setup ################################ 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ############################################################################################## 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # Tree classes are only used by tree parsers or AST-building parsers 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # Thus, they're not essential for everything ANTLR generates and 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # are autoloaded on-demand 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload :AST, 'antlr3/tree' 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver tree_classes = [ 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :Tree, :TreeAdaptor, :BaseTree, :BaseTreeAdaptor, 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :CommonTree, :CommonErrorNode, :CommonTreeAdaptor, 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :TreeNodeStream, :CommonTreeNodeStream, :TreeParser, 175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :TreeVisitor, :RewriteRuleElementStream, 176324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :RewriteRuleTokenStream, :RewriteRuleSubtreeStream, 177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver :RewriteRuleNodeStream 178324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ] 179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver for klass in tree_classes 181324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload klass, 'antlr3/tree' 182324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver end 183324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 184324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver # Set up non-essential components to be loaded on-demand 185324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload :TokenRewriteStream, 'antlr3/streams/rewrite' 186324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload :FilterMode, 'antlr3/modes/filter' 187324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload :ASTBuilder, 'antlr3/modes/ast-builder' 188324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload :Main, 'antlr3/main' 189324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload :Debug, 'antlr3/debug' 190324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload :Profile, 'antlr3/profile' 191324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload :DOT, 'antlr3/dot' 192324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload :InteractiveStringStream, 'antlr3/streams/interactive' 193324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 194324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver autoload :Template, 'antlr3/template' 195324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 196324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver $LOAD_PATH.include?( library_path ) or $LOAD_PATH.unshift( library_path ) 197324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 198324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverend # module ANTLR3 199324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 200324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 201324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverrequire 'set' 202324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverrequire 'antlr3/util' 203324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverrequire 'antlr3/version' 204324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 205324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverunless $0 == 'antlr4ruby' 206324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver require 'antlr3/constants' 207324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver require 'antlr3/error' 208324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver require 'antlr3/token' 209324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver require 'antlr3/recognizers' 210324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver require 'antlr3/dfa' 211324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver require 'antlr3/streams' 212324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverend 213