org.openrewrite.java.template.internal.TreeMirrorMaker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rewrite-templating Show documentation
Auto-templating for rewrite-java.
The newest version!
/*
 * Copyright (C) 2010-2015 The Project Lombok Authors.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.openrewrite.java.template.internal;

import com.sun.source.tree.LabeledStatementTree;
import com.sun.source.tree.VariableTree;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.JCTree.JCFieldAccess;
import com.sun.tools.javac.tree.JCTree.JCVariableDecl;
import com.sun.tools.javac.tree.TreeCopier;
import com.sun.tools.javac.tree.TreeScanner;
import com.sun.tools.javac.util.List;
import org.openrewrite.java.template.internal.JavacTreeMaker.TypeTag;

import java.util.Collections;
import java.util.IdentityHashMap;
import java.util.Iterator;
import java.util.Map;

import static org.openrewrite.java.template.internal.Javac.*;

/**
 * Makes a copy of any AST node, with some exceptions.
 * Exceptions:
 * The symbol ('sym') of a copied variable isn't copied.
 * 
all labels are removed.
 * 
 * 
 * The purpose of this class is to make a copy, and then the copy is attributed (resolution info is added). These exceptions
 * are to work around apparent bugs (or at least inconsistencies) in javac sources.
 */
public class TreeMirrorMaker extends TreeCopier {
    private final IdentityHashMap originalToCopy = new IdentityHashMap<>();

    public TreeMirrorMaker(JavacTreeMaker maker) {
        super(maker.getUnderlyingTreeMaker());
    }

    @Override
    public  T copy(T original) {
        T copy = super.copy(original);
        putIfAbsent(originalToCopy, original, copy);
        return copy;
    }

    @Override
    public  T copy(T original, Void p) {
        T copy = super.copy(original, p);
        putIfAbsent(originalToCopy, original, copy);
        return copy;
    }

    @Override
    public  List copy(List originals) {
        List copies = super.copy(originals);
        if (originals != null) {
            Iterator it1 = originals.iterator();
            Iterator it2 = copies.iterator();
            while (it1.hasNext()) {
                putIfAbsent(originalToCopy, it1.next(), it2.next());
            }
        }
        return copies;
    }

    @Override
    public  List copy(List originals, Void p) {
        List copies = super.copy(originals, p);
        if (originals != null) {
            Iterator it1 = originals.iterator();
            Iterator it2 = copies.iterator();
            while (it1.hasNext()) {
                putIfAbsent(originalToCopy, it1.next(), it2.next());
            }
        }
        return copies;
    }

    public Map getOriginalToCopyMap() {
        return Collections.unmodifiableMap(originalToCopy);
    }

    // Monitor the following issues when making changes here.
    // - https://github.com/projectlombok/lombok/issues/278
    // - https://github.com/projectlombok/lombok/issues/729
    @Override
    public JCTree visitVariable(VariableTree node, Void p) {
        JCVariableDecl original = node instanceof JCVariableDecl ? (JCVariableDecl) node : null;
        JCVariableDecl copy = (JCVariableDecl) super.visitVariable(node, p);
        if (original == null) {
            return copy;
        }
        copy.sym = original.sym;
        if (copy.sym != null) {
            copy.type = original.type;
        }
        if (copy.type != null) {
            boolean wipeSymAndType = copy.type.isErroneous();
            if (!wipeSymAndType) {
                TypeTag typeTag = TypeTag.typeTag(copy.type);
                wipeSymAndType = CTC_NONE.equals(typeTag) || CTC_ERROR.equals(typeTag) || CTC_UNKNOWN.equals(typeTag) || CTC_UNDETVAR.equals(typeTag);
            }

            if (wipeSymAndType) {
                copy.sym = null;
                copy.type = null;
            } else {
                if (original.vartype != null) {
                    copy.vartype.type = original.vartype.type;
                    original.vartype.accept(new TreeScanner() {
                        @Override
                        public void scan(JCTree tree) {
                            super.scan(tree);
                            originalToCopy.get(tree).type = tree.type;
                        }

                        @Override
                        public void visitSelect(JCFieldAccess tree) {
                            super.visitSelect(tree);
                            ((JCFieldAccess) originalToCopy.get(tree)).sym = tree.sym;
                        }
                    });
                }
            }
        }

        return copy;
    }

    // Fix for NPE in HandleVal. See https://github.com/projectlombok/lombok/issues/372
    // This and visitVariable is rather hacky, but we're working around evident bugs or at least inconsistencies in javac.
    @Override
    public JCTree visitLabeledStatement(LabeledStatementTree node, Void p) {
        return node.getStatement().accept(this, p);
    }

    private  void putIfAbsent(Map map, K key, V value) {
        if (!map.containsKey(key)) {
            map.put(key, value);
        }
    }
}