com.oracle.graal.python.lib.PyObjectReprAsTruffleStringNode Maven / Gradle / Ivy
/*
* Copyright (c) 2022, 2023, 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 com.oracle.graal.python.lib;
import com.oracle.graal.python.nodes.PNodeWithContext;
import com.oracle.graal.python.nodes.util.CastToTruffleStringNode;
import com.oracle.truffle.api.dsl.Cached;
import com.oracle.truffle.api.dsl.GenerateCached;
import com.oracle.truffle.api.dsl.GenerateInline;
import com.oracle.truffle.api.dsl.GenerateUncached;
import com.oracle.truffle.api.dsl.NeverDefault;
import com.oracle.truffle.api.dsl.Specialization;
import com.oracle.truffle.api.frame.Frame;
import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.strings.TruffleString;
/**
* Equivalent of CPython's {@code PyObject_Repr}. Converts the object to a string using its
* {@code __repr__} special method. Falls back to default object {@code __repr__} implementation.
*
* The output is always coerced to a {@link TruffleString}
*
* @see PyObjectReprAsObjectNode
*/
@GenerateUncached
@GenerateInline(inlineByDefault = true)
@GenerateCached
public abstract class PyObjectReprAsTruffleStringNode extends PNodeWithContext {
public static TruffleString executeUncached(Object object) {
return PyObjectReprAsTruffleStringNodeGen.getUncached().execute(null, null, object);
}
// TODO: calling this with VirtualFrame that may not be null is likely a bug, review the usages
public static TruffleString executeUncached(Frame frame, Object object) {
return PyObjectReprAsTruffleStringNodeGen.getUncached().execute(frame, null, object);
}
public final TruffleString executeCached(Frame frame, Object object) {
return execute(frame, this, object);
}
public abstract TruffleString execute(Frame frame, Node inliningTarget, Object object);
@Specialization
static TruffleString repr(VirtualFrame frame, Node inliningTarget, Object obj,
@Cached PyObjectReprAsObjectNode reprNode,
@Cached CastToTruffleStringNode cast) {
return cast.execute(inliningTarget, reprNode.execute(frame, inliningTarget, obj));
}
@NeverDefault
public static PyObjectReprAsTruffleStringNode create() {
return PyObjectReprAsTruffleStringNodeGen.create();
}
}