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.Tree 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using System.Collections.Generic; 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using StringBuilder = System.Text.StringBuilder; 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * A record of the rules used to match a token sequence. The tokens 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * end up as the leaves of this tree and rule nodes are the interior nodes. 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This really adds no functionality, it is just an alias for CommonTree 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * that is more meaningful (specific) and holds a String to display for a node. 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver [System.Serializable] 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public class ParseTree : BaseTree 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public object payload; 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public List<IToken> hiddenTokens; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ParseTree( object label ) 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.payload = label; 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #region Properties 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override string Text 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ToString(); 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override int TokenStartIndex 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return 0; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override int TokenStopIndex 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return 0; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override int Type 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return 0; 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #endregion 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override ITree DupNode() 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override string ToString() 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( payload is IToken ) 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IToken t = (IToken)payload; 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( t.Type == TokenTypes.EndOfFile ) 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return "<EOF>"; 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return t.Text; 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return payload.ToString(); 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Emit a token and all hidden nodes before. EOF node holds all 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * hidden tokens after last real token. 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual string ToStringWithHiddenTokens() 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver StringBuilder buf = new StringBuilder(); 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( hiddenTokens != null ) 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver for ( int i = 0; i < hiddenTokens.Count; i++ ) 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IToken hidden = (IToken)hiddenTokens[i]; 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver buf.Append( hidden.Text ); 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string nodeText = this.ToString(); 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( !nodeText.Equals( "<EOF>" ) ) 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver buf.Append( nodeText ); 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return buf.ToString(); 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Print out the leaves of this tree, which means printing original 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * input back out. 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual string ToInputString() 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver StringBuilder buf = new StringBuilder(); 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ToStringLeaves( buf ); 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return buf.ToString(); 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected virtual void ToStringLeaves( StringBuilder buf ) 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( payload is IToken ) 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { // leaf node token? 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver buf.Append( this.ToStringWithHiddenTokens() ); 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return; 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver for ( int i = 0; Children != null && i < Children.Count; i++ ) 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ParseTree t = (ParseTree)Children[i]; 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver t.ToStringLeaves( buf ); 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 168