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 Antlr.Runtime.Misc; 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using Console = System.Console; 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public class TreeRewriter : TreeParser 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected bool showTransformations; 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected ITokenStream originalTokenStream; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected ITreeAdaptor originalAdaptor; 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Func<IAstRuleReturnScope> topdown_func; 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Func<IAstRuleReturnScope> bottomup_func; 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public TreeRewriter( ITreeNodeStream input ) 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver : this( input, new RecognizerSharedState() ) 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public TreeRewriter( ITreeNodeStream input, RecognizerSharedState state ) 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver : base( input, state ) 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver originalAdaptor = input.TreeAdaptor; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver originalTokenStream = input.TokenStream; 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver topdown_func = () => Topdown(); 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bottomup_func = () => Bottomup(); 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual object ApplyOnce( object t, Func<IAstRuleReturnScope> whichRule ) 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( t == null ) 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver try 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // share TreeParser object but not parsing-related state 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state = new RecognizerSharedState(); 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input = new CommonTreeNodeStream( originalAdaptor, t ); 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ( (CommonTreeNodeStream)input ).TokenStream = originalTokenStream; 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver BacktrackingLevel = 1; 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IAstRuleReturnScope r = whichRule(); 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver BacktrackingLevel = 0; 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( Failed ) 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return t; 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if (showTransformations && r != null && !t.Equals(r.Tree) && r.Tree != null) 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ReportTransformation(t, r.Tree); 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( r != null && r.Tree != null ) 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return r.Tree; 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver else 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return t; 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver catch ( RecognitionException ) 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return t; 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual object ApplyRepeatedly( object t, Func<IAstRuleReturnScope> whichRule ) 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bool treeChanged = true; 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver while ( treeChanged ) 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver object u = ApplyOnce( t, whichRule ); 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver treeChanged = !t.Equals( u ); 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver t = u; 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return t; 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual object Downup( object t ) 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return Downup( t, false ); 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual object Downup( object t, bool showTransformations ) 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.showTransformations = showTransformations; 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver TreeVisitor v = new TreeVisitor( new CommonTreeAdaptor() ); 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver t = v.Visit( t, ( o ) => ApplyOnce( o, topdown_func ), ( o ) => ApplyRepeatedly( o, bottomup_func ) ); 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return t; 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // methods the downup strategy uses to do the up and down rules. 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // to override, just define tree grammar rule topdown and turn on 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // filter=true. 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual IAstRuleReturnScope Topdown() 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual IAstRuleReturnScope Bottomup() 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return null; 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Override this if you need transformation tracing to go somewhere 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * other than stdout or if you're not using ITree-derived trees. 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected virtual void ReportTransformation(object oldTree, object newTree) 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ITree old = oldTree as ITree; 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ITree @new = newTree as ITree; 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string oldMessage = old != null ? old.ToStringTree() : "??"; 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string newMessage = @new != null ? @new.ToStringTree() : "??"; 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Console.WriteLine("{0} -> {1}", oldMessage, newMessage); 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 145