/Users/parrt/antlr/code/antlr/main/runtime/Java/src/main/java/org/antlr/runtime/tree/TreeAdaptor.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.tree;

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

public interface TreeAdaptor {
        // C o n s t r u c t i o n

        public Object create(Token payload);

        public Object dupNode(Object treeNode);

        public Object dupTree(Object tree);

        public Object nil();

        public Object errorNode(TokenStream input, Token start, Token stop, RecognitionException e);

        public boolean isNil(Object tree);

        public void addChild(Object t, Object child);

        public Object becomeRoot(Object newRoot, Object oldRoot);

        public Object rulePostProcessing(Object root);

        public int getUniqueID(Object node);


        // R e w r i t e  R u l e s

        public Object becomeRoot(Token newRoot, Object oldRoot);

        public Object create(int tokenType, Token fromToken);

        public Object create(int tokenType, Token fromToken, String text);

        public Object create(int tokenType, String text);


        // C o n t e n t

        public int getType(Object t);

        public void setType(Object t, int type);

        public String getText(Object t);

        public void setText(Object t, String text);

        public Token getToken(Object t);

        public void setTokenBoundaries(Object t, Token startToken, Token stopToken);

        public int getTokenStartIndex(Object t);

        public int getTokenStopIndex(Object t);


        // N a v i g a t i o n  /  T r e e  P a r s i n g

        public Object getChild(Object t, int i);

        public void setChild(Object t, int i, Object child);

        public Object deleteChild(Object t, int i);

        public int getChildCount(Object t);

        public Object getParent(Object t);
        public void setParent(Object t, Object parent);

        public int getChildIndex(Object t);
        public void setChildIndex(Object t, int index);

        public void replaceChildren(Object parent, int startChildIndex, int stopChildIndex, Object t);
}

---