/Users/parrt/antlr/code/antlr/main/runtime/Java/src/main/java/org/antlr/runtime/debug/DebugEventListener.java

Go to the documentation of this file.

/*
 [The "BSD license"]
 Copyright (c) 2005-2009 Terence Parr
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.
 3. The name of the author may not be used to endorse or promote products
     derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.antlr.runtime.debug;

import org.antlr.runtime.RecognitionException;
import org.antlr.runtime.Token;

public interface DebugEventListener {
        public static final String PROTOCOL_VERSION = "2";
        
        public static final int TRUE = 1;
        public static final int FALSE = 0;

        public void enterRule(String grammarFileName, String ruleName);

        public void enterAlt(int alt);

        public void exitRule(String grammarFileName, String ruleName);

        public void enterSubRule(int decisionNumber);

        public void exitSubRule(int decisionNumber);

        public void enterDecision(int decisionNumber, boolean couldBacktrack);

        public void exitDecision(int decisionNumber);

        public void consumeToken(Token t);

        public void consumeHiddenToken(Token t);

        public void LT(int i, Token t);

        public void mark(int marker);

        public void rewind(int marker);

        public void rewind();

        public void beginBacktrack(int level);

        public void endBacktrack(int level, boolean successful);

        public void location(int line, int pos);

        public void recognitionException(RecognitionException e);

        public void beginResync();

        public void endResync();

        public void semanticPredicate(boolean result, String predicate);

        public void commence();

        public void terminate();


        // T r e e  P a r s i n g

        public void consumeNode(Object t);

        public void LT(int i, Object t);


        // A S T  E v e n t s

        public void nilNode(Object t);

        public void errorNode(Object t);

        public void createNode(Object t);

        public void createNode(Object node, Token token);

        public void becomeRoot(Object newRoot, Object oldRoot);

        public void addChild(Object root, Object child);

        public void setTokenBoundaries(Object t, int tokenStartIndex, int tokenStopIndex);
}

---