|
| 1 | +/* |
| 2 | + * Copyright (c) 2023, 2023, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | + * |
| 5 | + * The Universal Permissive License (UPL), Version 1.0 |
| 6 | + * |
| 7 | + * Subject to the condition set forth below, permission is hereby granted to any |
| 8 | + * person obtaining a copy of this software, associated documentation and/or |
| 9 | + * data (collectively the "Software"), free of charge and under any and all |
| 10 | + * copyright rights in the Software, and any and all patent rights owned or |
| 11 | + * freely licensable by each licensor hereunder covering either (i) the |
| 12 | + * unmodified Software as contributed to or provided by such licensor, or (ii) |
| 13 | + * the Larger Works (as defined below), to deal in both |
| 14 | + * |
| 15 | + * (a) the Software, and |
| 16 | + * |
| 17 | + * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if |
| 18 | + * one is included with the Software each a "Larger Work" to which the Software |
| 19 | + * is contributed by such licensors), |
| 20 | + * |
| 21 | + * without restriction, including without limitation the rights to copy, create |
| 22 | + * derivative works of, display, perform, and distribute the Software and make, |
| 23 | + * use, sell, offer for sale, import, export, have made, and have sold the |
| 24 | + * Software and the Larger Work(s), and to sublicense the foregoing rights on |
| 25 | + * either these or other terms. |
| 26 | + * |
| 27 | + * This license is subject to the following condition: |
| 28 | + * |
| 29 | + * The above copyright notice and either this complete permission notice or at a |
| 30 | + * minimum a reference to the UPL must be included in all copies or substantial |
| 31 | + * portions of the Software. |
| 32 | + * |
| 33 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 34 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 35 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 36 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 37 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 38 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 39 | + * SOFTWARE. |
| 40 | + */ |
| 41 | +package com.oracle.graal.python.lib; |
| 42 | + |
| 43 | +import static com.oracle.graal.python.builtins.objects.PNone.NO_VALUE; |
| 44 | +import static com.oracle.graal.python.nodes.SpecialMethodNames.T___FORMAT__; |
| 45 | +import static com.oracle.graal.python.nodes.StringLiterals.T_EMPTY_STRING; |
| 46 | +import static com.oracle.graal.python.runtime.exception.PythonErrorType.TypeError; |
| 47 | + |
| 48 | +import com.oracle.graal.python.builtins.PythonBuiltinClassType; |
| 49 | +import com.oracle.graal.python.builtins.objects.PNone; |
| 50 | +import com.oracle.graal.python.builtins.objects.type.SpecialMethodSlot; |
| 51 | +import com.oracle.graal.python.nodes.ErrorMessages; |
| 52 | +import com.oracle.graal.python.nodes.PGuards; |
| 53 | +import com.oracle.graal.python.nodes.PNodeWithContext; |
| 54 | +import com.oracle.graal.python.nodes.PRaiseNode; |
| 55 | +import com.oracle.graal.python.nodes.attributes.LookupCallableSlotInMRONode; |
| 56 | +import com.oracle.graal.python.nodes.call.special.CallBinaryMethodNode; |
| 57 | +import com.oracle.graal.python.nodes.call.special.LookupAndCallBinaryNode; |
| 58 | +import com.oracle.graal.python.nodes.object.GetClassNode; |
| 59 | +import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary; |
| 60 | +import com.oracle.truffle.api.dsl.Cached; |
| 61 | +import com.oracle.truffle.api.dsl.Cached.Exclusive; |
| 62 | +import com.oracle.truffle.api.dsl.Cached.Shared; |
| 63 | +import com.oracle.truffle.api.dsl.Fallback; |
| 64 | +import com.oracle.truffle.api.dsl.GenerateCached; |
| 65 | +import com.oracle.truffle.api.dsl.GenerateInline; |
| 66 | +import com.oracle.truffle.api.dsl.GenerateUncached; |
| 67 | +import com.oracle.truffle.api.dsl.Specialization; |
| 68 | +import com.oracle.truffle.api.frame.Frame; |
| 69 | +import com.oracle.truffle.api.frame.VirtualFrame; |
| 70 | +import com.oracle.truffle.api.nodes.Node; |
| 71 | +import com.oracle.truffle.api.strings.TruffleString; |
| 72 | + |
| 73 | +/** |
| 74 | + * Equivalent of CPython's {@code PyObject_Format}. The {@code formatSpec} argument must be a Python |
| 75 | + * string, otherwise this raises a SystemError. Unlike CPython's {@code PyObject_Format}, this does |
| 76 | + * not accept native {@code NULL} as {@code formatSpec}. Convert it to an empty string to get |
| 77 | + * equivalent behavior. |
| 78 | + */ |
| 79 | +@GenerateInline |
| 80 | +@GenerateUncached |
| 81 | +public abstract class PyObjectFormat extends PNodeWithContext { |
| 82 | + public final Object executeNonInlined(VirtualFrame frame, Object obj, Object formatSpec) { |
| 83 | + return execute(frame, null, obj, formatSpec); |
| 84 | + } |
| 85 | + |
| 86 | + public abstract Object execute(VirtualFrame frame, Node node, Object obj, Object formatSpec); |
| 87 | + |
| 88 | + @Specialization |
| 89 | + static Object doNone(VirtualFrame frame, Node inliningTarget, Object obj, PNone formatSpec, |
| 90 | + @Shared("impl") @Cached PyObjectFormatStr formatStr) { |
| 91 | + return formatStr.execute(frame, inliningTarget, obj, T_EMPTY_STRING); |
| 92 | + } |
| 93 | + |
| 94 | + @Fallback |
| 95 | + static Object doOthers(VirtualFrame frame, Node inliningTarget, Object obj, Object formatSpec, |
| 96 | + @Shared("impl") @Cached PyObjectFormatStr formatStr) { |
| 97 | + return formatStr.execute(frame, inliningTarget, obj, formatSpec); |
| 98 | + } |
| 99 | + |
| 100 | + @GenerateInline |
| 101 | + @GenerateUncached |
| 102 | + @GenerateCached(false) |
| 103 | + public abstract static class PyObjectFormatStr extends PNodeWithContext { |
| 104 | + public abstract Object execute(Frame frame, Node inliningTarget, Object obj, Object formatSpec); |
| 105 | + |
| 106 | + static boolean isEmptyString(Object formatSpec) { |
| 107 | + // to keep the fast-path optimization guard simple, we ignore empty PStrings |
| 108 | + return (formatSpec instanceof TruffleString && ((TruffleString) formatSpec).isEmpty()); |
| 109 | + } |
| 110 | + |
| 111 | + @Specialization(guards = {"isString(obj)", "isEmptyString(formatSpec)"}) |
| 112 | + static Object doString(Object obj, Object formatSpec) { |
| 113 | + return obj; |
| 114 | + } |
| 115 | + |
| 116 | + @Specialization(guards = {"isEmptyString(formatSpec)"}) |
| 117 | + static Object doLong(long obj, Object formatSpec) { |
| 118 | + return obj; |
| 119 | + } |
| 120 | + |
| 121 | + // Note: PRaiseNode is @Exclusive to workaround a bug in DSL |
| 122 | + @Specialization(guards = "isString(formatSpec)") |
| 123 | + static Object doGeneric(VirtualFrame frame, Object obj, Object formatSpec, |
| 124 | + @Cached(parameters = "Format", inline = false) LookupAndCallBinaryNode callFormat, |
| 125 | + @Exclusive @Cached(inline = false) PRaiseNode raiseNode) { |
| 126 | + Object res = callFormat.executeObject(frame, obj, formatSpec); |
| 127 | + if (res == NO_VALUE) { |
| 128 | + throw raiseNode.raise(TypeError, ErrorMessages.TYPE_DOESNT_DEFINE_FORMAT, obj); |
| 129 | + } |
| 130 | + if (!PGuards.isString(res)) { |
| 131 | + throw raiseNode.raise(TypeError, ErrorMessages.S_MUST_RETURN_S_NOT_P, T___FORMAT__, "str", res); |
| 132 | + } |
| 133 | + return res; |
| 134 | + } |
| 135 | + |
| 136 | + @Specialization(guards = "isString(formatSpec)", replaces = "doGeneric") |
| 137 | + @TruffleBoundary |
| 138 | + static Object doGenericUncached(Object obj, Object formatSpec) { |
| 139 | + Object klass = GetClassNode.getUncached().execute(obj); |
| 140 | + Object slot = LookupCallableSlotInMRONode.getUncached(SpecialMethodSlot.Format).execute(klass); |
| 141 | + return CallBinaryMethodNode.getUncached().executeObject(null, slot, obj, formatSpec); |
| 142 | + } |
| 143 | + |
| 144 | + // Note: PRaiseNode is @Exclusive to workaround a bug in DSL |
| 145 | + @Fallback |
| 146 | + static Object doNonStringFormat(Object obj, Object formatSpec, |
| 147 | + @Exclusive @Cached(inline = false) PRaiseNode raiseNode) { |
| 148 | + throw raiseNode.raise(PythonBuiltinClassType.SystemError, ErrorMessages.S_MUST_BE_S_NOT_P, "Format specifier", "string", formatSpec); |
| 149 | + } |
| 150 | + } |
| 151 | +} |
0 commit comments