1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * [The "BSD licence"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Copyright (c) 2005-2008 Terence Parr 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * All rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Conversion to C#: 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Copyright (c) 2008-2009 Sam Harwell, Pixel Mine, Inc. 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * All rights reserved. 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Redistribution and use in source and binary forms, with or without 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * modification, are permitted provided that the following conditions 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * are met: 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 1. Redistributions of source code must retain the above copyright 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer. 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 2. Redistributions in binary form must reproduce the above copyright 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer in the 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * documentation and/or other materials provided with the distribution. 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 3. The name of the author may not be used to endorse or promote products 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * derived from this software without specific prior written permission. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvernamespace Antlr.Runtime.Debug 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using System.Collections.Generic; 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using ParseTree = Antlr.Runtime.Tree.ParseTree; 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This parser listener tracks rule entry/exit and token matches 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * to build a simple parse tree using ParseTree nodes. 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public class ParseTreeBuilder : BlankDebugEventListener 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const string EPSILON_PAYLOAD = "<epsilon>"; 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Stack<ParseTree> callStack = new Stack<ParseTree>(); 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver List<IToken> hiddenTokens = new List<IToken>(); 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int backtracking = 0; 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ParseTreeBuilder( string grammarName ) 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ParseTree root = Create( "<grammar " + grammarName + ">" ); 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver callStack.Push( root ); 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual ParseTree Tree 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return callStack.Peek(); 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * What kind of node to create. You might want to override 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * so I factored out creation here. 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual ParseTree Create( object payload ) 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return new ParseTree( payload ); 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual ParseTree EpsilonNode() 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return Create( EPSILON_PAYLOAD ); 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Backtracking or cyclic DFA, don't want to add nodes to tree</summary> */ 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void EnterDecision( int d, bool couldBacktrack ) 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver backtracking++; 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void ExitDecision( int i ) 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver backtracking--; 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void EnterRule( string filename, string ruleName ) 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( backtracking > 0 ) 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return; 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ParseTree parentRuleNode = callStack.Peek(); 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ParseTree ruleNode = Create( ruleName ); 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver parentRuleNode.AddChild( ruleNode ); 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver callStack.Push( ruleNode ); 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void ExitRule( string filename, string ruleName ) 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( backtracking > 0 ) 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return; 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ParseTree ruleNode = callStack.Peek(); 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( ruleNode.ChildCount == 0 ) 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ruleNode.AddChild( EpsilonNode() ); 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver callStack.Pop(); 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void ConsumeToken( IToken token ) 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( backtracking > 0 ) 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return; 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ParseTree ruleNode = callStack.Peek(); 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ParseTree elementNode = Create( token ); 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver elementNode.hiddenTokens = this.hiddenTokens; 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.hiddenTokens = new List<IToken>(); 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ruleNode.AddChild( elementNode ); 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void ConsumeHiddenToken( IToken token ) 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( backtracking > 0 ) 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return; 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver hiddenTokens.Add( token ); 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void RecognitionException( RecognitionException e ) 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( backtracking > 0 ) 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return; 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ParseTree ruleNode = callStack.Peek(); 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ParseTree errorNode = Create( e ); 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ruleNode.AddChild( errorNode ); 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 140