com.oracle.truffle.regex

Class RegexObject

java.lang.Object

com.oracle.truffle.regex.AbstractRegexObject

com.oracle.truffle.regex.AbstractConstantKeysObject

com.oracle.truffle.regex.RegexObject

All Implemented Interfaces:

com.oracle.truffle.api.interop.TruffleObject

public final class RegexObject
extends AbstractConstantKeysObject

RegexObject represents a compiled regular expression that can be used to match against input strings. It is the result of a call to RegexLanguage.parse(TruffleLanguage.ParsingRequest). It exposes the following three properties:

1. String pattern: the source of the compiled regular expression
2. TruffleObject flags: the set of flags passed to the regular expression compiler. The type differs based on the flavor of regular expressions used:
   • RegexFlags if the flavor was ECMAScript
   • PythonFlags if the flavor was PythonStr or PythonBytes
   • RubyFlags if the flavor was Ruby
3. int groupCount: number of capture groups present in the regular expression, including group 0.
4. RegexObject.RegexObjectExecMethod exec: an executable method that matches the compiled regular expression against a string. The method accepts two parameters:
   1. Object input: the character sequence to search in. This may either be a String or a TruffleObject that responds to InteropLibrary.hasArrayElements(Object) and returns Characters on indexed InteropLibrary.readArrayElement(Object, long) requests.
   2. Number fromIndex: the position to start searching from. This argument will be cast to int, since a String can not be longer than Integer.MAX_VALUE. If fromIndex is greater than Integer.MAX_VALUE, this method will immediately return NO_MATCH.
   The return value is a RegexResult. The contents of the exec can be compiled lazily and so its first invocation might involve a longer delay as the regular expression is compiled on the fly.
5. TruffleObject groups: a Truffle object that has a member for every named capture group. The value of the member depends on the flavor of regular expressions. In flavors where all capture groups must have a unique name, the value of the member is a single integer, the index of the group that bears the member's name. In flavors where it is possible to have multiple groups of the same name (as in Ruby), the value of the member has array elements that give the indices of the groups with the member's name.
6. boolean isBacktracking: whether or not matching with this regular expression will use backtracking when matching, which could result in an exponential runtime in the worst case scenario

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegexObject.RegexObjectExecBooleanMethod
static class	RegexObject.RegexObjectExecMethod
static class	RegexObject.RegexObjectExecUTF8Method DEPRECATED.

Nested classes/interfaces inherited from class com.oracle.truffle.regex.AbstractConstantKeysObject

AbstractConstantKeysObject.IsMemberReadable, AbstractConstantKeysObject.ReadMember

Constructor Summary

Constructors

Constructor and Description
RegexObject(RegexExecNode execNode, RegexSource source, AbstractRegexObject flags, int numberOfCaptureGroups, AbstractRegexObject namedCaptureGroups)

Method Summary

Modifier and Type	Method and Description
com.oracle.truffle.api.CallTarget	getExecBooleanCallTarget()
RegexObject.RegexObjectExecBooleanMethod	getExecBooleanMethod()
com.oracle.truffle.api.CallTarget	getExecCallTarget()
RegexObject.RegexObjectExecMethod	getExecMethod()
RegexObject.RegexObjectExecUTF8Method	getExecUTF8Method()
com.oracle.truffle.api.interop.TruffleObject	getFlags()
TruffleReadOnlyKeysArray	getKeys()
com.oracle.truffle.api.interop.TruffleObject	getNamedCaptureGroups()
int	getNumberOfCaptureGroups()
RegexSource	getSource()
boolean	isBacktracking()
boolean	isMemberReadableImpl(String symbol)
Object	readMemberImpl(String symbol)
String	toString()

Methods inherited from class com.oracle.truffle.regex.AbstractConstantKeysObject

getMembers, hasMembers

Methods inherited from class com.oracle.truffle.regex.AbstractRegexObject

createNamedCaptureGroupMapInt, createNamedCaptureGroupMapListInt, getLanguage, hasLanguage, toDisplayString

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexObject

public RegexObject(RegexExecNode execNode,
                   RegexSource source,
                   AbstractRegexObject flags,
                   int numberOfCaptureGroups,
                   AbstractRegexObject namedCaptureGroups)

Method Detail

getSource

public RegexSource getSource()

getFlags

public com.oracle.truffle.api.interop.TruffleObject getFlags()

getNumberOfCaptureGroups

public int getNumberOfCaptureGroups()

getNamedCaptureGroups

public com.oracle.truffle.api.interop.TruffleObject getNamedCaptureGroups()

getExecCallTarget

public com.oracle.truffle.api.CallTarget getExecCallTarget()

getExecBooleanCallTarget

public com.oracle.truffle.api.CallTarget getExecBooleanCallTarget()

isBacktracking

public boolean isBacktracking()

getExecMethod

public RegexObject.RegexObjectExecMethod getExecMethod()

getExecBooleanMethod

public RegexObject.RegexObjectExecBooleanMethod getExecBooleanMethod()

getExecUTF8Method

public RegexObject.RegexObjectExecUTF8Method getExecUTF8Method()

getKeys

public TruffleReadOnlyKeysArray getKeys()

Specified by:

getKeys in class AbstractConstantKeysObject

isMemberReadableImpl

public boolean isMemberReadableImpl(String symbol)

Specified by:

isMemberReadableImpl in class AbstractConstantKeysObject

readMemberImpl

public Object readMemberImpl(String symbol)
                      throws com.oracle.truffle.api.interop.UnknownIdentifierException

Specified by:

readMemberImpl in class AbstractConstantKeysObject

Throws:

com.oracle.truffle.api.interop.UnknownIdentifierException

toString

public String toString()

Overrides:

toString in class Object