/Users/parrt/antlr/code/antlr/main/runtime/Java/src/org/antlr/runtime/tree/TreeWizard.java

Go to the documentation of this file.

/*
 [The "BSD licence"]
 Copyright (c) 2005-2008 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 java.util.*;

public class TreeWizard {
        protected TreeAdaptor adaptor;
        protected Map tokenNameToTypeMap;

        public interface ContextVisitor {
                // TODO: should this be called visit or something else?
                public void visit(Object t, Object parent, int childIndex, Map labels);
        }

        public static abstract class Visitor implements ContextVisitor {
                public void visit(Object t, Object parent, int childIndex, Map labels) {
                        visit(t);
                }
                public abstract void visit(Object t);
        }

        public static class TreePattern extends CommonTree {
                public String label;
                public boolean hasTextArg;
                public TreePattern(Token payload) {
                        super(payload);
                }
                public String toString() {
                        if ( label!=null ) {
                                return "%"+label+":"+super.toString();
                        }
                        else {
                                return super.toString();                                
                        }
                }
        }

        public static class WildcardTreePattern extends TreePattern {
                public WildcardTreePattern(Token payload) {
                        super(payload);
                }
        }

        public static class TreePatternTreeAdaptor extends CommonTreeAdaptor {
                public Object create(Token payload) {
                        return new TreePattern(payload);
                }
        }

        // TODO: build indexes for the wizard

---