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 ConditionalAttribute = System.Diagnostics.ConditionalAttribute; 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using Regex = System.Text.RegularExpressions.Regex; 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using RegexOptions = System.Text.RegularExpressions.RegexOptions; 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * A parser for a stream of tree nodes. "tree grammars" result in a subclass 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * of this. All the error reporting and recovery is shared with Parser via 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the BaseRecognizer superclass. 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public class TreeParser : BaseRecognizer 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const int DOWN = TokenTypes.Down; 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const int UP = TokenTypes.Up; 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // precompiled regex used by inContext 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver static string dotdot = ".*[^.]\\.\\.[^.].*"; 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver static string doubleEtc = ".*\\.\\.\\.\\s+\\.\\.\\..*"; 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver static Regex dotdotPattern = new Regex( dotdot, RegexOptions.Compiled ); 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver static Regex doubleEtcPattern = new Regex( doubleEtc, RegexOptions.Compiled ); 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected ITreeNodeStream input; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public TreeParser( ITreeNodeStream input ) 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver : base() // highlight that we go to super to set state object 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver SetTreeNodeStream( input ); 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public TreeParser( ITreeNodeStream input, RecognizerSharedState state ) 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver : base( state ) // share the state object with another parser 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver SetTreeNodeStream( input ); 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void Reset() 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver base.Reset(); // reset all recognizer state variables 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( input != null ) 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.Seek( 0 ); // rewind the input 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Set the input stream</summary> */ 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual void SetTreeNodeStream( ITreeNodeStream input ) 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.input = input; 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual ITreeNodeStream GetTreeNodeStream() 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input; 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override string SourceName 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.SourceName; 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected override object GetCurrentInputSymbol( IIntStream input ) 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return ( (ITreeNodeStream)input ).LT( 1 ); 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected override object GetMissingSymbol( IIntStream input, 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver RecognitionException e, 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int expectedTokenType, 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver BitSet follow ) 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string tokenText = 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver "<missing " + TokenNames[expectedTokenType] + ">"; 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ITreeAdaptor adaptor = ((ITreeNodeStream)e.Input).TreeAdaptor; 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return adaptor.Create(new CommonToken(expectedTokenType, tokenText)); 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Match '.' in tree parser has special meaning. Skip node or 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * entire tree if node has children. If children, scan until 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * corresponding UP node. 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override void MatchAny( IIntStream ignore ) 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.errorRecovery = false; 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver state.failed = false; 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // always consume the current node 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.Consume(); 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // if the next node is DOWN, then the current node is a subtree: 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // skip to corresponding UP. must count nesting level to get right UP 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int look = input.LA( 1 ); 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( look == DOWN ) 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.Consume(); 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int level = 1; 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver while ( level > 0 ) 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver switch ( input.LA( 1 ) ) 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver case DOWN: 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver level++; 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver break; 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver case UP: 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver level--; 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver break; 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver case TokenTypes.EndOfFile: 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return; 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver default: 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver break; 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.Consume(); 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * We have DOWN/UP nodes in the stream that have no line info; override. 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * plus we want to alter the exception type. Don't try to recover 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * from tree parser errors inline... 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected override object RecoverFromMismatchedToken( IIntStream input, int ttype, BitSet follow ) 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throw new MismatchedTreeNodeException( ttype, (ITreeNodeStream)input ); 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Prefix error message with the grammar name because message is 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * always intended for the programmer because the parser built 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the input tree not the user. 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override string GetErrorHeader( RecognitionException e ) 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return GrammarFileName + ": node from " + 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ( e.ApproximateLineInfo ? "after " : "" ) + "line " + e.Line + ":" + e.CharPositionInLine; 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 176324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Tree parsers parse nodes they usually have a token object as 178324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * payload. Set the exception token and do the default behavior. 179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 181324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override string GetErrorMessage( RecognitionException e, string[] tokenNames ) 182324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 183324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( this is TreeParser ) 184324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 185324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ITreeAdaptor adaptor = ( (ITreeNodeStream)e.Input ).TreeAdaptor; 186324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver e.Token = adaptor.GetToken( e.Node ); 187324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( e.Token == null ) 188324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { // could be an UP/DOWN node 189324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver e.Token = new CommonToken( adaptor.GetType( e.Node ), 190324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver adaptor.GetText( e.Node ) ); 191324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 192324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 193324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return base.GetErrorMessage( e, tokenNames ); 194324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 195324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 196324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver [Conditional("ANTLR_TRACE")] 197324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual void TraceIn( string ruleName, int ruleIndex ) 198324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 199324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver base.TraceIn( ruleName, ruleIndex, input.LT( 1 ) ); 200324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 201324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 202324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver [Conditional("ANTLR_TRACE")] 203324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual void TraceOut( string ruleName, int ruleIndex ) 204324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 205324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver base.TraceOut( ruleName, ruleIndex, input.LT( 1 ) ); 206324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 207324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 208324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 209324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 210