com.oracle.truffle.api.strings

Class TruffleString.CodePointAtIndexNode

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.strings.TruffleString.CodePointAtIndexNode

All Implemented Interfaces:

NodeInterface, Cloneable

Enclosing class:

TruffleString

public abstract static class TruffleString.CodePointAtIndexNode
extends Node

Node to read a codepoint at a given codepoint index. See TruffleString.CodePointAtIndexNode.execute(AbstractTruffleString, int, TruffleString.Encoding) for details.

Since:

22.1

Nested Class Summary

Nested classes/interfaces inherited from class com.oracle.truffle.api.nodes.Node

Node.Child, Node.Children

Method Summary

Modifier and Type	Method and Description
static TruffleString.CodePointAtIndexNode	create() Create a new TruffleString.CodePointAtIndexNode.
int	execute(AbstractTruffleString a, int i, TruffleString.Encoding expectedEncoding) Decode and return the codepoint at codepoint index i, with best-effort error handling.
abstract int	execute(AbstractTruffleString a, int i, TruffleString.Encoding expectedEncoding, TruffleString.ErrorHandling errorHandling) Decode and return the codepoint at codepoint index i.
static TruffleString.CodePointAtIndexNode	getUncached() Get the uncached version of TruffleString.CodePointAtIndexNode.

Methods inherited from class com.oracle.truffle.api.nodes.Node

accept, adoptChildren, atomic, atomic, copy, deepCopy, getChildren, getCost, getDebugProperties, getDescription, getEncapsulatingSourceSection, getLock, getParent, getRootNode, getSourceSection, insert, insert, isAdoptable, isSafelyReplaceableBy, notifyInserted, onReplace, replace, replace, reportPolymorphicSpecialize, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

execute

public final int execute(AbstractTruffleString a,
                         int i,
                         TruffleString.Encoding expectedEncoding)

Decode and return the codepoint at codepoint index i, with best-effort error handling.

Since:

22.1

execute

public abstract int execute(AbstractTruffleString a,
                            int i,
                            TruffleString.Encoding expectedEncoding,
                            TruffleString.ErrorHandling errorHandling)

Decode and return the codepoint at codepoint index i.

Parameters:

errorHandling - if set to TruffleString.ErrorHandling.BEST_EFFORT, the return value on invalid codepoints depends on expectedEncoding:

• TruffleString.Encoding.UTF_8: Unicode Replacement character 0xFFFD
• TruffleString.Encoding.UTF_16: the (16-bit) char value read at index i
• TruffleString.Encoding.UTF_32: the (32-bit) int value read at index i
• TruffleString.Encoding.US_ASCII, TruffleString.Encoding.ISO_8859_1, TruffleString.Encoding.BYTES: the (8-bit) unsigned byte value read at index i
• All other Encodings: Unicode Replacement character 0xFFFD

If set to TruffleString.ErrorHandling.RETURN_NEGATIVE, -1 will be returned instead. This parameter is expected to be partial evaluation constant.

Since:

22.3

create

public static TruffleString.CodePointAtIndexNode create()

Create a new TruffleString.CodePointAtIndexNode.

Since:

22.1

getUncached

public static TruffleString.CodePointAtIndexNode getUncached()

Get the uncached version of TruffleString.CodePointAtIndexNode.

Since:

22.1