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 executing a RegexEngine. 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
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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegexObject.RegexObjectExecMethod

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

AbstractConstantKeysObject.IsReadableCacheNode, AbstractConstantKeysObject.ReadCacheNode

Constructor Summary

Constructors

Constructor and Description
RegexObject(RegexCompiler compiler, RegexSource source, com.oracle.truffle.api.interop.TruffleObject flags, int numberOfCaptureGroups, Map<String,Integer> namedCaptureGroups)

Method Summary

Modifier and Type	Method and Description
Object	getCompiledRegexObject()
RegexObject.RegexObjectExecMethod	getExecMethod()
com.oracle.truffle.api.interop.TruffleObject	getFlags()
TruffleReadOnlyKeysArray	getKeys()
com.oracle.truffle.api.interop.TruffleObject	getNamedCaptureGroups()
int	getNumberOfCaptureGroups()
RegexSource	getSource()
Object	readMemberImpl(String symbol)
void	setCompiledRegexObject(com.oracle.truffle.api.interop.TruffleObject compiledRegexObject)

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

getMembers, hasMembers, isMemberReadable, readMember

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

getLanguage, hasLanguage, toDisplayString

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexObject

public RegexObject(RegexCompiler compiler,
                   RegexSource source,
                   com.oracle.truffle.api.interop.TruffleObject flags,
                   int numberOfCaptureGroups,
                   Map<String,Integer> 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()

getCompiledRegexObject

public Object getCompiledRegexObject()

setCompiledRegexObject

public void setCompiledRegexObject(com.oracle.truffle.api.interop.TruffleObject compiledRegexObject)

getExecMethod

public RegexObject.RegexObjectExecMethod getExecMethod()

getKeys

public TruffleReadOnlyKeysArray getKeys()

Specified by:

getKeys 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