1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver [The "BSD licence"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Copyright (c) 2005-2006 Terence Parr 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver All rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Redistribution and use in source and binary forms, with or without 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver modification, are permitted provided that the following conditions 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver are met: 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1. Redistributions of source code must retain the above copyright 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer. 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 2. Redistributions in binary form must reproduce the above copyright 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer in the 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver documentation and/or other materials provided with the distribution. 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 3. The name of the author may not be used to endorse or promote products 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver derived from this software without specific prior written permission. 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver*/ 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpackage org.antlr.runtime.tree { 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver import org.antlr.runtime.Token; 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver import org.antlr.runtime.TokenConstants; 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** A tree node that is wrapper for a Token object. After 3.0 release 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * while building tree rewrite stuff, it became clear that computing 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * parent and child index is very difficult and cumbersome. Better to 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * spend the space in every tree node. If you don't want these extra 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * fields, it's easy to cut them out in your own BaseTree subclass. 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public class CommonTree extends BaseTree { 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** A single token is the payload */ 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected var _token:Token; 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** What token indexes bracket all tokens associated with this node 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and below? 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public var startIndex:int=-1, stopIndex:int=-1; 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Who is the parent node of this node; if null, implies node is root */ 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected var _parent:CommonTree; 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** What index is this node in the child list? Range: 0..n-1 */ 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected var _childIndex:int = -1; 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function CommonTree(node:CommonTree = null) { 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (node != null) { 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super(node); 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this._token = node._token; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.startIndex = node.startIndex; 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.stopIndex = node.stopIndex; 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static function createFromToken(t:Token):CommonTree { 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver var ct:CommonTree = new CommonTree(); 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ct._token = t; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ct; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function get token():Token { 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _token; 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function dupNode():Tree { 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return new CommonTree(this); 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function get isNil():Boolean { 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _token==null; 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function get type():int { 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( _token==null ) { 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return TokenConstants.INVALID_TOKEN_TYPE; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _token.type; 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function get text():String { 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( _token==null ) { 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _token.text; 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function get line():int { 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( _token==null || _token.line==0 ) { 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( childCount >0 ) { 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return getChild(0).line; 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return 0; 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _token.line; 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function get charPositionInLine():int { 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( _token==null || _token.charPositionInLine==-1 ) { 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( childCount>0 ) { 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return getChild(0).charPositionInLine; 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return 0; 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _token.charPositionInLine; 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function get tokenStartIndex():int { 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( startIndex==-1 && _token!=null ) { 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _token.tokenIndex; 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return startIndex; 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function set tokenStartIndex(index:int):void { 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver startIndex = index; 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function get tokenStopIndex():int { 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( stopIndex==-1 && _token!=null ) { 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _token.tokenIndex; 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return stopIndex; 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function set tokenStopIndex(index:int):void { 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver stopIndex = index; 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function get childIndex():int { 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _childIndex; 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function get parent():Tree { 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _parent; 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function set parent(t:Tree):void { 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this._parent = CommonTree(t); 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function set childIndex(index:int):void { 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this._childIndex = index; 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function toString():String { 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( isNil ) { 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return "nil"; 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( type==TokenConstants.INVALID_TOKEN_TYPE ) { 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return "<errornode>"; 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( token==null ) { 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return _token.text; 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 167