ImplicitCastNodeFactory.java

/*
 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.truffle.dsl.processor.generator;

import static com.oracle.truffle.dsl.processor.generator.GeneratorUtils.isTypeBoxingOptimized;
import static com.oracle.truffle.dsl.processor.java.ElementUtils.getTypeId;
import static com.oracle.truffle.dsl.processor.java.ElementUtils.modifiers;
import static javax.lang.model.element.Modifier.FINAL;
import static javax.lang.model.element.Modifier.PRIVATE;
import static javax.lang.model.element.Modifier.PUBLIC;
import static javax.lang.model.element.Modifier.STATIC;

import java.util.List;

import javax.lang.model.element.Element;
import javax.lang.model.type.TypeMirror;

import com.oracle.truffle.api.CompilerDirectives;
import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
import com.oracle.truffle.api.nodes.UnexpectedResultException;
import com.oracle.truffle.dsl.processor.ProcessorContext;
import com.oracle.truffle.dsl.processor.java.ElementUtils;
import com.oracle.truffle.dsl.processor.java.model.CodeAnnotationMirror;
import com.oracle.truffle.dsl.processor.java.model.CodeExecutableElement;
import com.oracle.truffle.dsl.processor.java.model.CodeTree;
import com.oracle.truffle.dsl.processor.java.model.CodeTreeBuilder;
import com.oracle.truffle.dsl.processor.java.model.CodeTypeElement;
import com.oracle.truffle.dsl.processor.java.model.CodeVariableElement;
import com.oracle.truffle.dsl.processor.java.model.GeneratedTypeMirror;
import com.oracle.truffle.dsl.processor.model.ImplicitCastData;
import com.oracle.truffle.dsl.processor.model.TypeSystemData;

@SuppressWarnings("deprecation")
public class ImplicitCastNodeFactory {

    private final ProcessorContext context;
    private final TypeMirror forType;
    private final TypeSystemData typeSystem;
    private final com.oracle.truffle.api.dsl.internal.DSLOptions options;
    private final List<TypeMirror> sourceTypes;

    public ImplicitCastNodeFactory(ProcessorContext context, TypeSystemData typeSystem, TypeMirror forType) {
        this.context = context;
        this.forType = forType;
        this.typeSystem = typeSystem;
        this.options = typeSystem.getOptions();
        this.sourceTypes = typeSystem.lookupSourceTypes(forType);
    }

    public static String typeName(TypeMirror type) {
        return "Implicit" + getTypeId(type) + "Cast";
    }

    public static TypeMirror type(TypeSystemData typeSystem, TypeMirror type) {
        String typeSystemName = TypeSystemCodeGenerator.typeName(typeSystem);
        return new GeneratedTypeMirror(ElementUtils.getPackageName(typeSystem.getTemplateType()) + "." + typeSystemName, typeName(type));
    }

    public static CodeTree create(TypeSystemData typeSystem, TypeMirror type, CodeTree value) {
        return CodeTreeBuilder.createBuilder().startStaticCall(type(typeSystem, type), "create").tree(value).end().build();
    }

    public static CodeTree cast(String nodeName, CodeTree value) {
        return CodeTreeBuilder.createBuilder().startCall(nodeName, "cast").tree(value).end().build();
    }

    public static CodeTree check(String nodeName, CodeTree value) {
        return CodeTreeBuilder.createBuilder().startCall(nodeName, "check").tree(value).end().build();
    }

    private static String seenFieldName(TypeMirror type) {
        return "seen" + getTypeId(type);
    }

    public CodeTypeElement create() {
        String typeName = typeName(forType);
        TypeMirror baseType = context.getType(Object.class);
        CodeTypeElement clazz = GeneratorUtils.createClass(typeSystem, null, modifiers(PUBLIC, FINAL, STATIC), typeName, baseType);

        for (TypeMirror sourceType : sourceTypes) {
            CodeVariableElement hasSeen = new CodeVariableElement(modifiers(PUBLIC), context.getType(boolean.class), seenFieldName(sourceType));
            hasSeen.getAnnotationMirrors().add(new CodeAnnotationMirror(context.getDeclaredType(CompilationFinal.class)));
            clazz.add(hasSeen);
        }

        clazz.add(createConstructor(clazz));
        if (isTypeBoxingOptimized(options.monomorphicTypeBoxingOptimization(), forType)) {
            clazz.add(createIsMonomorphic());
        }
        clazz.add(createCast(false));
        clazz.add(createCast(true));
        clazz.add(createCheck());
        clazz.add(createMerge(clazz));
        clazz.add(createCreate(clazz));

        return clazz;
    }

    private Element createIsMonomorphic() {
        String methodName = "isMonomorphic";
        CodeExecutableElement method = new CodeExecutableElement(modifiers(PUBLIC), context.getType(boolean.class), methodName);
        CodeTreeBuilder builder = method.createBuilder();
        builder.startReturn();
        String operator = "";
        for (TypeMirror sourceType : sourceTypes) {
            builder.string(operator);
            builder.string(seenFieldName(sourceType));
            operator = " ^ ";
        }
        builder.end();
        return method;
    }

    private static Element createConstructor(CodeTypeElement clazz) {
        return new CodeExecutableElement(modifiers(PRIVATE), null, clazz.getSimpleName().toString());
    }

    private Element createCreate(CodeTypeElement clazz) {
        String methodName = "create";
        CodeExecutableElement method = new CodeExecutableElement(modifiers(PUBLIC, STATIC), clazz.asType(), methodName);
        method.addParameter(new CodeVariableElement(context.getType(Object.class), "value"));
        CodeTreeBuilder builder = method.createBuilder();

        builder.declaration(clazz.asType(), "newCast", builder.create().startNew(clazz.asType()).end());

        for (TypeMirror sourceType : sourceTypes) {
            String seenField = seenFieldName(sourceType);
            builder.startStatement();
            builder.string("newCast.").string(seenField).string(" = ").tree(TypeSystemCodeGenerator.check(typeSystem, sourceType, "value"));
            builder.end();
        }
        builder.startReturn().string("newCast").end();
        return method;
    }

    private Element createMerge(CodeTypeElement clazz) {
        String methodName = "merge";
        CodeExecutableElement method = new CodeExecutableElement(modifiers(PUBLIC), context.getType(void.class), methodName);
        method.addParameter(new CodeVariableElement(clazz.asType(), "otherCast"));
        CodeTreeBuilder builder = method.createBuilder();

        for (TypeMirror sourceType : sourceTypes) {
            String seenField = seenFieldName(sourceType);
            builder.startStatement();
            builder.string("this.").string(seenField).string(" |= ").string("otherCast.").string(seenField);
            builder.end();
        }
        return method;
    }

    private Element createCheck() {
        String methodName = "check";
        CodeExecutableElement method = new CodeExecutableElement(modifiers(PUBLIC), context.getType(boolean.class), methodName);
        method.addParameter(new CodeVariableElement(context.getType(Object.class), "value"));
        CodeTreeBuilder builder = method.createBuilder();

        boolean elseIf = false;
        for (TypeMirror sourceType : sourceTypes) {
            elseIf = builder.startIf(elseIf);
            builder.string(seenFieldName(sourceType)).string(" && ").tree(TypeSystemCodeGenerator.check(typeSystem, sourceType, "value"));
            builder.end();
            builder.startBlock().returnTrue().end();
        }
        builder.returnFalse();
        return method;
    }

    private Element createCast(boolean expect) {
        String methodName = expect ? "expect" : "cast";
        CodeExecutableElement method = new CodeExecutableElement(modifiers(PUBLIC), forType, methodName);
        method.addParameter(new CodeVariableElement(context.getType(Object.class), "value"));
        if (expect) {
            method.getThrownTypes().add(context.getType(UnexpectedResultException.class));
        }

        CodeTreeBuilder builder = method.createBuilder();

        boolean elseIf = false;
        for (TypeMirror sourceType : sourceTypes) {
            elseIf = builder.startIf(elseIf);
            builder.string(seenFieldName(sourceType)).string(" && ").tree(TypeSystemCodeGenerator.check(typeSystem, sourceType, "value"));
            builder.end();
            builder.startBlock();
            builder.startReturn();
            CodeTree castTree = TypeSystemCodeGenerator.cast(typeSystem, sourceType, "value");
            ImplicitCastData cast = typeSystem.lookupCast(sourceType, forType);
            if (cast != null) {
                builder.tree(TypeSystemCodeGenerator.invokeImplicitCast(typeSystem, cast, castTree));
            } else {
                builder.tree(castTree);
            }
            builder.end();
            builder.end();
        }
        if (expect) {
            builder.startThrow().startNew(context.getType(UnexpectedResultException.class)).string("value").end().end();
        } else {
            builder.startStatement().startStaticCall(context.getType(CompilerDirectives.class), "transferToInterpreter").end().end();
            builder.startThrow().startNew(context.getType(AssertionError.class)).end().end();
        }
        return method;
    }

}