com.oracle.truffle.regex.tregex.parser.flavors

Interface RegexFlavorProcessor

All Known Implementing Classes:

PythonFlavorProcessor

public interface RegexFlavorProcessor

Allows the parsing and translating of a foreign regular expression into an ECMAScript regular expression.

After either RegexFlavorProcessor.validate() or RegexFlavorProcessor.toECMAScriptRegex() was called, RegexFlavorProcessor.getNamedCaptureGroups(), RegexFlavorProcessor.getFlags() and RegexFlavorProcessor.isUnicodePattern() can be called to extract extra information obtained during the parse.

Method Summary

Modifier and Type	Method and Description
com.oracle.truffle.api.interop.TruffleObject	getFlags() Returns a TruffleObject representing the compilation flags which were set for the regular expression.
Map<String,Integer>	getNamedCaptureGroups() Returns a map from the names of capture groups to their indices.
int	getNumberOfCaptureGroups() Returns the number of capture groups contained in the expression, including capture group 0.
boolean	isUnicodePattern() Returns true if the generated ECMAScript pattern is a Unicode pattern (matches Unicode code points instead of UTF-16 code units).
RegexSource	toECMAScriptRegex() Runs the parser and emits an equivalent ECMAScript regex.
void	validate() Runs the parser without trying to find an equivalent ECMAScript regex.

Method Detail

validate

void validate()
       throws RegexSyntaxException

Runs the parser without trying to find an equivalent ECMAScript regex. Useful for early error detection.

Throws:

RegexSyntaxException - when the pattern or the flags are not well-formed

toECMAScriptRegex

RegexSource toECMAScriptRegex()
                       throws RegexSyntaxException,
                              UnsupportedRegexException

Runs the parser and emits an equivalent ECMAScript regex.

Returns:

an ECMAScript RegexSource compatible to the input one

Throws:

RegexSyntaxException - when the pattern or the flags are not well-formed

UnsupportedRegexException - when the pattern cannot be translated to an equivalent ECMAScript pattern

getNumberOfCaptureGroups

int getNumberOfCaptureGroups()

Returns the number of capture groups contained in the expression, including capture group 0.

getNamedCaptureGroups

Map<String,Integer> getNamedCaptureGroups()

Returns a map from the names of capture groups to their indices. If the regular expression had no named capture groups, returns null.

getFlags

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

Returns a TruffleObject representing the compilation flags which were set for the regular expression. The returned object responds to 'READ' messages on names which correspond to the names of the flags as used in the language from which the flavor originates.

isUnicodePattern

boolean isUnicodePattern()

Returns true if the generated ECMAScript pattern is a Unicode pattern (matches Unicode code points instead of UTF-16 code units).