com.oracle.truffle.regex

Class RegexLanguage

java.lang.Object

com.oracle.truffle.api.TruffleLanguage<RegexLanguage.RegexContext>

com.oracle.truffle.regex.RegexLanguage

public final class RegexLanguage
extends com.oracle.truffle.api.TruffleLanguage<RegexLanguage.RegexContext>

Truffle Regular Expression Language

This language represents classic regular expressions. By evaluating any source, you get access to the RegexEngineBuilder. By calling this builder, you can build your custom RegexEngine which implements your flavor of regular expressions and uses your fallback compiler for expressions not covered. The RegexEngine accepts regular expression patterns and flags and compiles them to RegexObjects, which you can use to match the regular expressions against strings.

 Usage example in pseudocode:
 
 engineBuilder = <eval any source in the "regex" language>
 engine = engineBuilder("Flavor=ECMAScript", optionalFallbackCompiler)

 regex = engine("(a|(b))c", "i")
 assert(regex.pattern == "(a|(b))c")
 assert(regex.flags.ignoreCase == true)
 assert(regex.groupCount == 3)

 result = regex.exec("xacy", 0)
 assert(result.isMatch == true)
 assertEquals([result.getStart(0), result.getEnd(0)], [ 1,  3])
 assertEquals([result.getStart(1), result.getEnd(1)], [ 1,  2])
 assertEquals([result.getStart(2), result.getEnd(2)], [-1, -1])

 result2 = regex.exec("xxx", 0)
 assert(result2.isMatch == false)
 // result2.getStart(...) and result2.getEnd(...) are undefined
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegexLanguage.RegexContext

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

com.oracle.truffle.api.TruffleLanguage.ContextPolicy, com.oracle.truffle.api.TruffleLanguage.ContextReference<C>, com.oracle.truffle.api.TruffleLanguage.Env, com.oracle.truffle.api.TruffleLanguage.InlineParsingRequest, com.oracle.truffle.api.TruffleLanguage.LanguageReference<L extends com.oracle.truffle.api.TruffleLanguage>, com.oracle.truffle.api.TruffleLanguage.ParsingRequest, com.oracle.truffle.api.TruffleLanguage.Provider, com.oracle.truffle.api.TruffleLanguage.Registration

Field Summary

Fields

Modifier and Type	Field and Description
RegexEngineBuilder	engineBuilder
static String	ID
static String	MIME_TYPE
static String	NAME

Constructor Summary

Constructors

Constructor and Description
RegexLanguage()

Method Summary

Modifier and Type	Method and Description
protected RegexLanguage.RegexContext	createContext(com.oracle.truffle.api.TruffleLanguage.Env env)
protected Iterable<com.oracle.truffle.api.Scope>	findTopScopes(RegexLanguage.RegexContext context)
static RegexLanguage.RegexContext	getCurrentContext()
protected boolean	isObjectOfLanguage(Object object)
protected boolean	isThreadAccessAllowed(Thread thread, boolean singleThreaded) RegexLanguage is thread-safe - it supports parallel parsing requests as well as parallel access to all RegexLanguageObjects.
protected com.oracle.truffle.api.CallTarget	parse(com.oracle.truffle.api.TruffleLanguage.ParsingRequest parsingRequest)
protected boolean	patchContext(RegexLanguage.RegexContext context, com.oracle.truffle.api.TruffleLanguage.Env newEnv)
static void	validateRegex(RegexSource source)
static void	validateRegex(String pattern, String flags)

Methods inherited from class com.oracle.truffle.api.TruffleLanguage

areOptionsCompatible, disposeContext, disposeThread, finalizeContext, findLocalScopes, findMetaObject, findSourceLocation, getCurrentContext, getCurrentLanguage, getLanguageHome, getOptionDescriptors, initializeContext, initializeMultipleContexts, initializeMultiThreading, initializeThread, isVisible, parse, toString

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

MIME_TYPE

public static final String MIME_TYPE

See Also:

Constant Field Values

engineBuilder

public final RegexEngineBuilder engineBuilder

Constructor Detail

RegexLanguage

public RegexLanguage()

Method Detail

validateRegex

public static void validateRegex(String pattern,
                                 String flags)
                          throws RegexSyntaxException

Throws:

RegexSyntaxException

validateRegex

public static void validateRegex(RegexSource source)
                          throws RegexSyntaxException

Throws:

RegexSyntaxException

parse

protected com.oracle.truffle.api.CallTarget parse(com.oracle.truffle.api.TruffleLanguage.ParsingRequest parsingRequest)

Overrides:

parse in class com.oracle.truffle.api.TruffleLanguage<RegexLanguage.RegexContext>

createContext

protected RegexLanguage.RegexContext createContext(com.oracle.truffle.api.TruffleLanguage.Env env)

Specified by:

createContext in class com.oracle.truffle.api.TruffleLanguage<RegexLanguage.RegexContext>

patchContext

protected boolean patchContext(RegexLanguage.RegexContext context,
                               com.oracle.truffle.api.TruffleLanguage.Env newEnv)

Overrides:

patchContext in class com.oracle.truffle.api.TruffleLanguage<RegexLanguage.RegexContext>

findTopScopes

protected Iterable<com.oracle.truffle.api.Scope> findTopScopes(RegexLanguage.RegexContext context)

Overrides:

findTopScopes in class com.oracle.truffle.api.TruffleLanguage<RegexLanguage.RegexContext>

isObjectOfLanguage

protected boolean isObjectOfLanguage(Object object)

Specified by:

isObjectOfLanguage in class com.oracle.truffle.api.TruffleLanguage<RegexLanguage.RegexContext>

isThreadAccessAllowed

protected boolean isThreadAccessAllowed(Thread thread,
                                        boolean singleThreaded)

RegexLanguage is thread-safe - it supports parallel parsing requests as well as parallel access to all RegexLanguageObjects. Parallel access to LazyCaptureGroupsResult objects may lead to duplicate execution of code, but no wrong results.

Overrides:

isThreadAccessAllowed in class com.oracle.truffle.api.TruffleLanguage<RegexLanguage.RegexContext>

Parameters:

thread - the thread that accesses the context for the first time.

singleThreaded - true if the access is considered single-threaded, false if more than one thread is active at the same time.

Returns:

always true

getCurrentContext

public static RegexLanguage.RegexContext getCurrentContext()