13447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein/*
23447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein [The "BSD license"]
33447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein Copyright (c) 2005-2009 Terence Parr
43447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein All rights reserved.
53447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
63447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein Redistribution and use in source and binary forms, with or without
73447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein modification, are permitted provided that the following conditions
83447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein are met:
93447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 1. Redistributions of source code must retain the above copyright
103447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein     notice, this list of conditions and the following disclaimer.
113447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 2. Redistributions in binary form must reproduce the above copyright
123447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein     notice, this list of conditions and the following disclaimer in the
133447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein     documentation and/or other materials provided with the distribution.
143447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 3. The name of the author may not be used to endorse or promote products
153447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein     derived from this software without specific prior written permission.
163447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
173447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
183447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
193447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
203447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
213447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
223447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
233447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
243447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
253447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
263447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
273447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein */
283447a5916aa62f44de24cc441fc9987116ddff52Andrew Sappersteinpackage org.antlr.runtime.debug;
293447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
303447a5916aa62f44de24cc441fc9987116ddff52Andrew Sappersteinimport org.antlr.runtime.*;
313447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
323447a5916aa62f44de24cc441fc9987116ddff52Andrew Sappersteinimport java.io.IOException;
333447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
343447a5916aa62f44de24cc441fc9987116ddff52Andrew Sappersteinpublic class DebugParser extends Parser {
353447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	/** Who to notify when events in the parser occur. */
363447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	protected DebugEventListener dbg = null;
373447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
383447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	/** Used to differentiate between fixed lookahead and cyclic DFA decisions
393447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	 *  while profiling.
403447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein 	 */
413447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public boolean isCyclicDecision = false;
423447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
433447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	/** Create a normal parser except wrap the token stream in a debug
443447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	 *  proxy that fires consume events.
453447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	 */
463447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public DebugParser(TokenStream input, DebugEventListener dbg, RecognizerSharedState state) {
473447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		super(input instanceof DebugTokenStream?input:new DebugTokenStream(input,dbg), state);
483447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		setDebugListener(dbg);
493447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
503447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
513447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public DebugParser(TokenStream input, RecognizerSharedState state) {
523447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		super(input instanceof DebugTokenStream?input:new DebugTokenStream(input,null), state);
533447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
543447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
553447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public DebugParser(TokenStream input, DebugEventListener dbg) {
563447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		this(input instanceof DebugTokenStream?input:new DebugTokenStream(input,dbg), dbg, null);
573447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
583447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
593447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	/** Provide a new debug event listener for this parser.  Notify the
603447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	 *  input stream too that it should send events to this listener.
613447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	 */
623447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public void setDebugListener(DebugEventListener dbg) {
633447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		if ( input instanceof DebugTokenStream ) {
643447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein			((DebugTokenStream)input).setDebugListener(dbg);
653447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		}
663447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		this.dbg = dbg;
673447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
683447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
693447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public DebugEventListener getDebugListener() {
703447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		return dbg;
713447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
723447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
733447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public void reportError(IOException e) {
743447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		System.err.println(e);
753447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		e.printStackTrace(System.err);
763447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
773447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
783447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public void beginResync() {
793447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		dbg.beginResync();
803447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
813447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
823447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public void endResync() {
833447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		dbg.endResync();
843447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
853447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
863447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public void beginBacktrack(int level) {
873447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		dbg.beginBacktrack(level);
883447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
893447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
903447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public void endBacktrack(int level, boolean successful) {
913447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		dbg.endBacktrack(level,successful);
923447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
933447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein
943447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	public void reportError(RecognitionException e) {
953447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		super.reportError(e);
963447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein		dbg.recognitionException(e);
973447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein	}
983447a5916aa62f44de24cc441fc9987116ddff52Andrew Sapperstein}
99