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 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public class DebugTokenStream : ITokenStream 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected IDebugEventListener dbg; 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public ITokenStream input; 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected bool initialStreamState = true; 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Track the last mark() call result value for use in rewind().</summary> */ 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected int lastMarker; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public DebugTokenStream( ITokenStream input, IDebugEventListener dbg ) 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver this.input = input; 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver DebugListener = dbg; 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // force TokenStream to get at least first valid token 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // so we know if there are any hidden tokens first in the stream 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.LT( 1 ); 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #region Properties 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual int Index 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.Index; 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual int Range 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.Range; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual IDebugEventListener DebugListener 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return dbg; 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver dbg = value; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver #endregion 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual void Consume() 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( initialStreamState ) 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ConsumeInitialHiddenTokens(); 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int a = input.Index; 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IToken t = input.LT( 1 ); 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.Consume(); 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int b = input.Index; 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver dbg.ConsumeToken( t ); 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( b > a + 1 ) 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // then we consumed more than one token; must be off channel tokens 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver for ( int i = a + 1; i < b; i++ ) 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver dbg.ConsumeHiddenToken( input.Get( i ) ); 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Consume all initial off-channel tokens</summary> */ 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected virtual void ConsumeInitialHiddenTokens() 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int firstOnChannelTokenIndex = input.Index; 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver for ( int i = 0; i < firstOnChannelTokenIndex; i++ ) 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver dbg.ConsumeHiddenToken( input.Get( i ) ); 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver initialStreamState = false; 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual IToken LT( int i ) 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( initialStreamState ) 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ConsumeInitialHiddenTokens(); 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver dbg.LT( i, input.LT( i ) ); 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.LT( i ); 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual int LA( int i ) 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( initialStreamState ) 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ConsumeInitialHiddenTokens(); 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver dbg.LT( i, input.LT( i ) ); 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.LA( i ); 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual IToken Get( int i ) 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.Get( i ); 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual int Mark() 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver lastMarker = input.Mark(); 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver dbg.Mark( lastMarker ); 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return lastMarker; 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual void Rewind( int marker ) 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver dbg.Rewind( marker ); 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.Rewind( marker ); 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual void Rewind() 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver dbg.Rewind(); 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.Rewind( lastMarker ); 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual void Release( int marker ) 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual void Seek( int index ) 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // TODO: implement seek in dbg interface 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // db.seek(index); 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver input.Seek( index ); 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual int Count 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 176324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.Count; 178324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 181324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual ITokenSource TokenSource 182324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 183324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 184324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 185324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.TokenSource; 186324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 187324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 188324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 189324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual string SourceName 190324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 191324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get 192324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 193324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return TokenSource.SourceName; 194324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 195324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 196324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 197324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public override string ToString() 198324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 199324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.ToString(); 200324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 201324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 202324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual string ToString( int start, int stop ) 203324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 204324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.ToString( start, stop ); 205324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 206324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 207324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public virtual string ToString( IToken start, IToken stop ) 208324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 209324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return input.ToString( start, stop ); 210324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 211324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 212324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 213