com.oracle.truffle.api.strings.provider.JCodingsProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-api Show documentation
Truffle is a multi-language framework for executing dynamic languages that achieves high performance when combined with Graal.
The newest version!
/*
 * Copyright (c) 2024, 2024, 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.truffle.api.strings.provider;

import java.util.function.Function;

import com.oracle.truffle.api.strings.AbstractTruffleString;
import com.oracle.truffle.api.strings.TranscodingErrorHandler;
import com.oracle.truffle.api.strings.TruffleString;

/**
 * NOT PUBLIC API.
 * 
 * Used to register optional {@link TruffleString} encoding support using a service provider.
 * 
 * This interface is not intended to be implemented directly; rather, it is an internal SPI,
 * implementation of which is provided by the shadowed jcodings module.
 *
 * @since 24.1
 */
public interface JCodingsProvider {

    int MAX_JCODINGS_INDEX_VALUE = 0x7f;

    interface Encoding {
        int length(byte[] array, int index, int arrayLength);

        int codeToMbcLength(int codepoint);

        int codeToMbc(int codepoint, byte[] array, int index);

        int mbcToCode(byte[] array, int index, int arrayEnd);

        int prevCharHead(byte[] array, int arrayBegin, int index, int arrayEnd);

        boolean isUnicode();

        boolean isSingleByte();

        boolean isFixedWidth();

        int minLength();

        int maxLength();

        String getCharsetName();

        byte[] getName();
    }

    Encoding get(String encodingName);

    record TranscodeResult(byte[] buffer, int length, boolean undefinedConversion) {
    }

    TranscodeResult transcode(AbstractTruffleString a,
                    int codePointLengthA,
                    int byteArrayOffset,
                    int byteLength,
                    TruffleString.Encoding targetEncoding,
                    Encoding jCodingSrc,
                    Encoding jCodingDst,
                    byte[] builtinReplacement,
                    TranscodingErrorHandler errorHandler,
                    Function asBytesMaterializeNative,
                    Function getBytesEncoding);
}