org.pkl.thirdparty.truffle.polyglot.PolyglotWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pkl-tools Show documentation
Fat Jar containing pkl-cli, pkl-codegen-java, pkl-codegen-kotlin, pkl-config-java, pkl-core, pkl-doc, and their shaded third-party dependencies.
There is a newer version: 0.27.1
Show newest version
/*
 * Copyright (c) 2018, 2022, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must 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.pkl.thirdparty.truffle.polyglot;

import static org.pkl.thirdparty.truffle.api.CompilerDirectives.shouldNotReachHere;

import java.lang.reflect.Proxy;

import org.pkl.thirdparty.truffle.api.CompilerDirectives.TruffleBoundary;
import org.pkl.thirdparty.truffle.api.interop.InteropLibrary;
import org.pkl.thirdparty.truffle.api.interop.UnsupportedMessageException;

interface PolyglotWrapper {

    Object getGuestObject();

    PolyglotContextImpl getContext();

    PolyglotLanguageContext getLanguageContext();

    static boolean isInstance(Object v) {
        if (v == null) {
            return false;
        } else if (v instanceof Proxy) {
            return isHostProxy(v);
        } else {
            return v instanceof PolyglotWrapper;
        }
    }

    @TruffleBoundary
    static boolean isHostProxy(Object v) {
        if (Proxy.isProxyClass(v.getClass())) {
            return Proxy.getInvocationHandler(v) instanceof PolyglotWrapper;
        } else {
            return false;
        }
    }

    static PolyglotWrapper asInstance(Object v) {
        if (v instanceof Proxy) {
            return getHostProxy(v);
        } else {
            return (PolyglotWrapper) v;
        }
    }

    @TruffleBoundary
    static PolyglotWrapper getHostProxy(Object v) {
        return (PolyglotWrapper) Proxy.getInvocationHandler(v);
    }

    @TruffleBoundary
    static boolean equalsProxy(PolyglotWrapper wrapper, Object other) {
        if (other == null) {
            return false;
        } else if (Proxy.isProxyClass(other.getClass())) {
            return equals(wrapper.getLanguageContext(), wrapper.getGuestObject(), getHostProxy(other).getGuestObject());
        } else {
            return false;
        }
    }

    @TruffleBoundary
    static boolean equals(Object context, Object receiver, Object obj) {
        if (obj == null) {
            return false;
        } else if (receiver == obj) {
            return true;
        }

        PolyglotLanguageContext languageContext = (PolyglotLanguageContext) context;

        if (languageContext != null) {
            PolyglotContextImpl.State localContextState = languageContext.context.state;
            if (localContextState.isInvalidOrClosed()) {
                /*
                 * Performance improvement for closed or invalid to avoid recurring exceptions.
                 */
                return false;
            }
        }
        Object prev = null;
        try {
            prev = PolyglotValueDispatch.hostEnter(languageContext);
        } catch (Throwable t) {
            // enter might fail if context was closed asynchonously.
            // Can no longer call interop.
            return false;
        }
        try {
            InteropLibrary receiverLib = InteropLibrary.getUncached(receiver);
            InteropLibrary objLib = InteropLibrary.getUncached(obj);
            return receiverLib.isIdentical(receiver, obj, objLib);
        } catch (Throwable t) {
            // propagate errors in languages they should be reported.
            throw PolyglotImpl.guestToHostException(languageContext, t, true);
        } finally {
            try {
                PolyglotValueDispatch.hostLeave(languageContext, prev);
            } catch (Throwable t) {
                // ignore errors leaving we cannot propagate them.
            }
        }
    }

    @TruffleBoundary
    static int hashCode(Object context, Object receiver) {
        PolyglotLanguageContext languageContext = (PolyglotLanguageContext) context;

        if (languageContext != null) {
            PolyglotContextImpl.State localContextState = languageContext.context.state;
            if (localContextState.isInvalidOrClosed()) {
                /*
                 * Performance improvement for closed or invalid to avoid recurring exceptions.
                 */
                return System.identityHashCode(receiver);
            }
        }
        Object prev = null;
        try {
            prev = PolyglotValueDispatch.hostEnter(languageContext);
        } catch (Throwable t) {
            // enter might fail if context was closed.
            // Can no longer call interop.
            return System.identityHashCode(receiver);
        }
        try {
            InteropLibrary receiverLib = InteropLibrary.getUncached(receiver);
            if (receiverLib.hasIdentity(receiver)) {
                return receiverLib.identityHashCode(receiver);
            } else {
                return System.identityHashCode(receiver);
            }
        } catch (Throwable t) {
            // propagate errors in languages they should be reported.
            throw PolyglotImpl.guestToHostException(languageContext, t, true);
        } finally {
            try {
                PolyglotValueDispatch.hostLeave(languageContext, prev);
            } catch (Throwable t) {
                // ignore errors leaving we cannot propagate them.
            }
        }
    }

    @TruffleBoundary
    static String toString(Object languageContext, Object receiver) {
        PolyglotLanguageContext context = (PolyglotLanguageContext) languageContext;
        Object prev = null;

        if (context != null) {
            PolyglotContextImpl.State localContextState = context.context.state;
            if (localContextState.isInvalidOrClosed()) {
                /*
                 * Performance improvement for closed or invalid to avoid recurring exceptions.
                 */
                return "Error in toString(): Context is invalid or closed.";
            }
        }

        try {
            prev = PolyglotValueDispatch.hostEnter(context);
        } catch (Throwable t) {
            // enter might fail if context was closed.
            // Can no longer call interop.
            return String.format("Error in toString(): Could not enter context: %s.", t.getMessage());
        }
        try {
            return toStringImpl(context, receiver);
        } catch (Throwable e) {
            throw PolyglotValueDispatch.guestToHostException(context, e, true);
        } finally {
            try {
                PolyglotValueDispatch.hostLeave(languageContext, prev);
            } catch (Throwable t) {
                // ignore errors leaving we cannot propagate them.
            }
        }
    }

    static String toString(PolyglotWrapper thisObj) {
        return toString(thisObj.getLanguageContext(), thisObj.getGuestObject());
    }

    static String toStringImpl(@SuppressWarnings("unused") Object languageContext, Object receiver) throws AssertionError {
        InteropLibrary lib = InteropLibrary.getFactory().getUncached(receiver);
        Object result = lib.toDisplayString(receiver);
        InteropLibrary resultLib = InteropLibrary.getFactory().getUncached(result);
        try {
            return resultLib.asString(result);
        } catch (UnsupportedMessageException e) {
            throw shouldNotReachHere("toDisplayString must be coercible to java.lang.String, but is not.", e);
        }
    }

}