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 /** <summary> 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * A TreeAdaptor that works with any Tree implementation. It provides 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * really just factory methods; all the work is done by BaseTreeAdaptor. 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If you would like to have different tokens created than ClassicToken 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * objects, you need to override this and then set the parser tree adaptor to 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * use your subclass. 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * <remarks> 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * To get your parser to build nodes of a different type, override 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * create(Token), errorNode(), and to be safe, YourTreeClass.dupNode(). 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * dupNode is called to duplicate nodes during rewrite operations. 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </remarks> 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public class CommonTreeAdaptor : BaseTreeAdaptor { 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Duplicate a node. This is part of the factory; 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * override if you want another kind of node to be built. 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * <remarks> 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * I could use reflection to prevent having to override this 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * but reflection is slow. 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </remarks> 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override object DupNode(object t) { 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t == null) 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ((ITree)t).DupNode(); 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override object Create(IToken payload) { 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return new CommonTree(payload); 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Tell me how to create a token for use with imaginary token nodes. 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * For example, there is probably no input symbol associated with imaginary 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * token DECL, but you need to create it as a payload or whatever for 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the DECL node as in ^(DECL type ID). 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * <remarks> 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If you care what the token payload objects' type is, you should 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * override this method and any other createToken variant. 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </remarks> 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override IToken CreateToken(int tokenType, string text) { 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return new CommonToken(tokenType, text); 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Tell me how to create a token for use with imaginary token nodes. 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * For example, there is probably no input symbol associated with imaginary 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * token DECL, but you need to create it as a payload or whatever for 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the DECL node as in ^(DECL type ID). 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * <remarks> 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This is a variant of createToken where the new token is derived from 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * an actual real input token. Typically this is for converting '{' 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * tokens to BLOCK etc... You'll see 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * r : lc='{' ID+ '}' -> ^(BLOCK[$lc] ID+) ; 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If you care what the token payload objects' type is, you should 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * override this method and any other createToken variant. 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </remarks> 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override IToken CreateToken(IToken fromToken) { 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return new CommonToken(fromToken); 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Track start/stop token for subtree root created for a rule. 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Only works with Tree nodes. For rules that match nothing, 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * seems like this will yield start=i and stop=i-1 in a nil node. 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Might be useful info so I'll not force to be i..i. 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void SetTokenBoundaries(object t, IToken startToken, IToken stopToken) { 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t == null) 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return; 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int start = 0; 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int stop = 0; 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (startToken != null) 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver start = startToken.TokenIndex; 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (stopToken != null) 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver stop = stopToken.TokenIndex; 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ((ITree)t).TokenStartIndex = start; 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ((ITree)t).TokenStopIndex = stop; 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override int GetTokenStartIndex(object t) { 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t == null) 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return -1; 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ((ITree)t).TokenStartIndex; 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override int GetTokenStopIndex(object t) { 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t == null) 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return -1; 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ((ITree)t).TokenStopIndex; 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override string GetText(object t) { 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t == null) 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ((ITree)t).Text; 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override int GetType(object t) { 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t == null) 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return TokenTypes.Invalid; 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ((ITree)t).Type; 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * What is the Token associated with this node? If 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * you are not using CommonTree, then you must 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * override this in your own adaptor. 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override IToken GetToken(object t) { 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t is CommonTree) { 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ((CommonTree)t).Token; 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; // no idea what to do 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override object GetChild(object t, int i) { 175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t == null) 176324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 178324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ((ITree)t).GetChild(i); 179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 181324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override int GetChildCount(object t) { 182324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t == null) 183324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return 0; 184324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 185324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ((ITree)t).ChildCount; 186324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 187324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 188324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override object GetParent(object t) { 189324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t == null) 190324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 191324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 192324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ((ITree)t).Parent; 193324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 194324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 195324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void SetParent(object t, object parent) { 196324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t != null) 197324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ((ITree)t).Parent = (ITree)parent; 198324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 199324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 200324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override int GetChildIndex(object t) { 201324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t == null) 202324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return 0; 203324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 204324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ((ITree)t).ChildIndex; 205324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 206324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 207324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void SetChildIndex(object t, int index) { 208324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (t != null) 209324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ((ITree)t).ChildIndex = index; 210324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 211324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 212324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void ReplaceChildren(object parent, int startChildIndex, int stopChildIndex, object t) { 213324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (parent != null) { 214324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ((ITree)parent).ReplaceChildren(startChildIndex, stopChildIndex, t); 215324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 216324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 217324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 218324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 219