1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver [The "BSD licence"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Copyright (c) 2005-2007 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.*; 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** A parser for a stream of tree nodes. "tree grammars" result in a subclass 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * of this. All the error reporting and recovery is shared with Parser via 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the BaseRecognizer superclass. 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public class TreeParser extends BaseRecognizer { 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static const DOWN:int = TokenConstants.DOWN; 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static const UP:int = TokenConstants.UP; 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected var input:TreeNodeStream; 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function TreeParser(input:TreeNodeStream, state:RecognizerSharedState = null) { 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super(state); 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver treeNodeStream = input; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function reset():void { 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super.reset(); // reset all recognizer state variables 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( input!=null ) { 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.seek(0); // rewind the input 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Set the input stream */ 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function set treeNodeStream(input:TreeNodeStream):void { 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.input = input; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function get treeNodeStream():TreeNodeStream { 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input; 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function get sourceName():String { 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.sourceName; 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected override function getCurrentInputSymbol(input:IntStream):Object { 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return TreeNodeStream(input).LT(1); 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected override function getMissingSymbol(input:IntStream, 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver e:RecognitionException, 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver expectedTokenType:int, 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver follow:BitSet):Object { 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver var tokenText:String = 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "<missing "+tokenNames[expectedTokenType]+">"; 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return CommonTree.createFromToken(new CommonToken(expectedTokenType, tokenText)); 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Match '.' in tree parser has special meaning. Skip node or 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * entire tree if node has children. If children, scan until 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * corresponding UP node. 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function matchAny(ignore:IntStream):void { // ignore stream, copy of this.input 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.errorRecovery = false; 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.failed = false; 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver var look:Object = input.LT(1); 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( input.treeAdaptor.getChildCount(look)==0 ) { 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.consume(); // not subtree, consume 1 node and return 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return; 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // current node is a subtree, skip to corresponding UP. 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // must count nesting level to get right UP 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver var level:int=0; 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver var tokenType:int = input.treeAdaptor.getType(look); 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver while ( tokenType!=TokenConstants.EOF && !(tokenType==UP && level==0) ) { 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.consume(); 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver look = input.LT(1); 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver tokenType = input.treeAdaptor.getType(look); 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( tokenType == DOWN ) { 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver level++; 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver else if ( tokenType == UP ) { 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver level--; 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.consume(); // consume UP 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** We have DOWN/UP nodes in the stream that have no line info; override. 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * plus we want to alter the exception type. Don't try to recover 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * from tree parser errors inline... 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected override function mismatch(input:IntStream, ttype:int, follow:BitSet):void { 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throw new MismatchedTreeNodeException(ttype, TreeNodeStream(input)); 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Prefix error message with the grammar name because message is 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * always intended for the programmer because the parser built 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the input tree not the user. 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function getErrorHeader(e:RecognitionException):String { 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return grammarFileName+": node from "+ 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver (e.approximateLineInfo?"after ":"")+"line "+e.line+":"+e.charPositionInLine; 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Tree parsers parse nodes they usually have a token object as 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * payload. Set the exception token and do the default behavior. 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override function getErrorMessage(e:RecognitionException, tokenNames:Array):String { 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( this is TreeParser ) { 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver var adaptor:TreeAdaptor = TreeNodeStream(e.input).treeAdaptor; 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver e.token = adaptor.getToken(e.node); 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( e.token==null ) { // could be an UP/DOWN node 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver e.token = new CommonToken(adaptor.getType(e.node), 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver adaptor.getText(e.node)); 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return super.getErrorMessage(e, tokenNames); 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function set treeAdaptor(adaptor:TreeAdaptor):void { 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // do nothing, implemented in generated code 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function get treeAdaptor():TreeAdaptor { 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // implementation provided in generated code 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function traceIn(ruleName:String, ruleIndex:int):void { 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super.traceInSymbol(ruleName, ruleIndex, input.LT(1)); 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public function traceOut(ruleName:String, ruleIndex:int):void { 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super.traceOutSymbol(ruleName, ruleIndex, input.LT(1)); 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}