Class TruffleString.ByteIndexOfCodePointSetNode

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.strings.TruffleString.ByteIndexOfCodePointSetNode

All Implemented Interfaces:

NodeInterface, Cloneable

Enclosing class:

TruffleString

public abstract static class TruffleString.ByteIndexOfCodePointSetNode
extends Node

Node to find the byte index of the first occurrence of a codepoint present in a given codepoint set. See execute(AbstractTruffleString, int, int, TruffleString.CodePointSet) for details.

Since:

23.0

Nested Class Summary

Nested classes/interfaces inherited from class Node

Node.Child, Node.Children

Modifier and Type	Class	Description
static @interface	Node.Child	Marks fields that represent child nodes of this node.
static @interface	Node.Children	Marks array fields that are children of this node.

Method Summary

Modifier and Type	Method	Description
static TruffleString.ByteIndexOfCodePointSetNode	create()	Create a new TruffleString.ByteIndexOfCodePointSetNode.
final int	execute(AbstractTruffleString a, int fromByteIndex, int toByteIndex, TruffleString.CodePointSet codePointSet)	Returns the byte index of the first codepoint present in the given TruffleString.CodePointSet, bounded by fromByteIndex (inclusive) and toByteIndex (exclusive).
abstract int	execute(AbstractTruffleString a, int fromByteIndex, int toByteIndex, TruffleString.CodePointSet codePointSet, boolean usePreciseCodeRange)	Returns the byte index of the first codepoint present in the given TruffleString.CodePointSet, bounded by fromByteIndex (inclusive) and toByteIndex (exclusive).
static TruffleString.ByteIndexOfCodePointSetNode	getUncached()	Get the uncached version of TruffleString.ByteIndexOfCodePointSetNode.

Methods inherited from class 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, reportReplace, toString

Modifier and Type	Method	Description
final void	accept(NodeVisitor nodeVisitor)	Invokes the NodeVisitor.visit(Node) method for this node and recursively also for all child nodes.
final void	adoptChildren()
final void	atomic(Runnable closure)
final <T> T	atomic(Callable<T> closure)
Node	copy()	Creates a shallow copy of this node.
Node	deepCopy()	Creates a deep copy of this node.
final Iterable<Node>	getChildren()	Iterator over the children of this node.
NodeCost	getCost()	Deprecated. in 24.1 without replacement
Map<String,Object>	getDebugProperties()	Returns properties of this node interesting for debugging and can be overwritten by subclasses to add their own custom properties.
String	getDescription()	Returns a user-readable description of the purpose of the Node, or "" if no description is available.
SourceSection	getEncapsulatingSourceSection()	Retrieves the segment of guest language source code that is represented by this Node, if present; otherwise retrieves the segment represented by the nearest AST ancestor that has this information.
protected final Lock	getLock()	Returns a lock object that can be used to synchronize modifications to the AST.
final Node	getParent()	The current parent node of this node.
final RootNode	getRootNode()	Get the root node of the tree a node belongs to.
SourceSection	getSourceSection()	Retrieves the segment of guest language source code that is represented by this Node.
final <T extends Node> T	insert(T newChild)	Inserts an new node into an AST that was already adopted by a parent.
final <T extends Node> T[]	insert(T[] newChildren)	Inserts new node children into an AST that was already adopted by a parent.
boolean	isAdoptable()	Returns true if this node can be adopted by a parent.
final boolean	isSafelyReplaceableBy(Node newNode)	Checks if this node can be replaced by another node: tree structure & type.
protected final void	notifyInserted(Node node)	Notifies the framework about the insertion of one or more nodes during execution.
protected void	onReplace(Node newNode, CharSequence reason)	Intended to be implemented by subclasses of Node to receive a notification when the node is rewritten.
final <T extends Node> T	replace(T newNode)	Replaces this node with another node.
final <T extends Node> T	replace(T newNode, CharSequence reason)	Replaces this node with another node.
final void	reportPolymorphicSpecialize()	Notifies the runtime that this node specialized to a polymorphic state.
protected final void	reportReplace(Node oldNode, Node newNode, CharSequence reason)	Reports that oldNode was replaced with newNode, notifying any replace observers and invalidating any compiled call targets.
String	toString()	Converts this node to a textual representation useful for debugging.

Methods inherited from class Object

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

Method Details

execute

public final int execute(AbstractTruffleString a,
 int fromByteIndex,
 int toByteIndex,
 TruffleString.CodePointSet codePointSet)

Returns the byte index of the first codepoint present in the given TruffleString.CodePointSet, bounded by fromByteIndex (inclusive) and toByteIndex (exclusive).

TruffleString.ByteIndexOfCodePointSetNode will specialize on the given TruffleString.CodePointSet's content, which is therefore required to be partial evaluation constant.

Usage example: A node that scans a string for a known set of code points and escapes them with '\'.

abstract static class StringEscapeNode extends Node {

    public static final TruffleString.Encoding ENCODING = TruffleString.Encoding.UTF_32;
    public static final TruffleString.ByteIndexOfCodePointSetNode.CodePointSet ESCAPE_CHARS = TruffleString.ByteIndexOfCodePointSetNode.CodePointSet.fromRanges(new int[]{
                    '\n', '\n',
                    '\r', '\r',
                    // ....
    }, ENCODING);

    abstract TruffleString execute(TruffleString input);

    @Specialization
    static TruffleString run(TruffleString input,
                    @Cached TruffleString.ByteIndexOfCodePointSetNode byteIndexOfCodePointSetNode,
                    @Cached TruffleStringBuilder.AppendSubstringByteIndexNode appendSubstringByteIndexNode,
                    @Cached TruffleString.CodePointAtByteIndexNode codePointAtByteIndexNode,
                    @Cached TruffleStringBuilder.AppendCodePointNode appendCodePointNode,
                    @Cached TruffleString.ByteLengthOfCodePointNode byteLengthOfCodePointNode,
                    @Cached TruffleStringBuilder.ToStringNode toStringNode) {
        int byteLength = input.byteLength(ENCODING);
        TruffleStringBuilder sb = TruffleStringBuilder.create(ENCODING, byteLength);
        int lastPos = 0;
        int pos = 0;
        while (pos >= 0) {
            pos = byteIndexOfCodePointSetNode.execute(input, lastPos, byteLength, ESCAPE_CHARS);
            int substringLength = (pos < 0 ? byteLength : pos) - lastPos;
            appendSubstringByteIndexNode.execute(sb, input, lastPos, substringLength);
            if (pos >= 0) {
                int codePoint = codePointAtByteIndexNode.execute(input, pos, ENCODING);
                appendCodePointNode.execute(sb, '\\');
                appendCodePointNode.execute(sb, codePoint);
                int codePointLength = byteLengthOfCodePointNode.execute(input, pos, ENCODING);
                lastPos = pos + codePointLength;
            }
        }
        return toStringNode.execute(sb);
    }
}

Parameters:

codePointSet - The set of codepoints to look for. This parameter is expected to be partial evaluation constant.

Since:

23.0

execute

public abstract int execute(AbstractTruffleString a,
 int fromByteIndex,
 int toByteIndex,
 TruffleString.CodePointSet codePointSet,
 boolean usePreciseCodeRange)

Returns the byte index of the first codepoint present in the given TruffleString.CodePointSet, bounded by fromByteIndex (inclusive) and toByteIndex (exclusive).

Parameters:

usePreciseCodeRange - If this parameter is set to true, the node may evaluate the input string's precise code range for better search performance. For more details, see TruffleString.GetCodeRangeNode and TruffleString.GetCodeRangeImpreciseNode. This parameter is expected to be partial evaluation constant.

Since:

24.1

create

public static TruffleString.ByteIndexOfCodePointSetNode create()

Create a new TruffleString.ByteIndexOfCodePointSetNode.

Since:

23.0

getUncached

public static TruffleString.ByteIndexOfCodePointSetNode getUncached()

Get the uncached version of TruffleString.ByteIndexOfCodePointSetNode.

Since:

23.0