RegexOptions

java.lang.Object
- com.oracle.truffle.regex.RegexOptions

```
public final class RegexOptions
extends Object
```
These options define how TRegex should interpret a given parsing request.
Available options:
- Flavor: specifies the regex dialect to use. Possible values:
  - ECMAScript: ECMAScript/JavaScript syntax (default).
  - PythonStr: Python 3 syntax, as executed on str objects.
  - PythonBytes: Python 3 syntax, as executed on bytes-like objects.
  - Ruby: Ruby syntax.
- Encoding: specifies the string encoding to match against. Possible values:
  - UTF-8
  - UTF-16
  - UTF-32
  - LATIN-1
  - BYTES (equivalent to LATIN-1)
- PythonMethod: specifies which Python Pattern method was called (Python flavors only). Possible values:
  - search
  - match
  - fullmatch
- Validate: don't generate a regex matcher object, just check the regex for syntax errors.
- U180EWhitespace: treat 0x180E MONGOLIAN VOWEL SEPARATOR as part of \s. This is a legacy feature for languages using a Unicode standard older than 6.3, such as ECMAScript 6 and older.
- UTF16ExplodeAstralSymbols: generate one DFA states per (16 bit) char instead of per-codepoint. This may improve performance in certain scenarios, but increases the likelihood of DFA state explosion.
- AlwaysEager: do not generate any lazy regex matchers (lazy in the sense that they may lazily compute properties of a RegexResult).
- RegressionTestMode: exercise all supported regex matcher variants, and check if they produce the same results.
- DumpAutomata: dump all generated parser trees, NFA, and DFA to disk. This will generate debugging dumps of most relevant data structures in JSON, GraphViz and LaTex format.
- StepExecution: dump tracing information about all DFA matcher runs.
- IgnoreAtomicGroups: treat atomic groups as ordinary groups (experimental).
- MustAdvance: force the matcher to advance by at least one character, either by finding a non-zero-width match or by skipping at least one character before matching.
All options except Flavor, Encoding and PythonMethod are boolean and false by default.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RegexOptions.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`RegexOptions.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALWAYS_EAGER_NAME`
`static RegexOptions`	`DEFAULT`
`static String`	`DUMP_AUTOMATA_NAME`
`static String`	`ENCODING_NAME`
`static String`	`FLAVOR_ECMASCRIPT`
`static String`	`FLAVOR_NAME`
`static String`	`FLAVOR_PYTHON`
`static String`	`FLAVOR_PYTHON_BYTES`
`static String`	`FLAVOR_PYTHON_STR`
`static String`	`FLAVOR_RUBY`
`static String`	`IGNORE_ATOMIC_GROUPS_NAME`
`static String`	`MUST_ADVANCE_NAME`
`static String`	`PYTHON_METHOD_FULLMATCH`
`static String`	`PYTHON_METHOD_MATCH`
`static String`	`PYTHON_METHOD_NAME`
`static String`	`PYTHON_METHOD_SEARCH`
`static String`	`REGRESSION_TEST_MODE_NAME`
`static String`	`STEP_EXECUTION_NAME`
`static String`	`U180E_WHITESPACE_NAME`
`static String`	`UTF_16_EXPLODE_ASTRAL_SYMBOLS_NAME`
`static String`	`VALIDATE_NAME`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RegexOptions.Builder`	`builder(com.oracle.truffle.api.source.Source source, String sourceString)`
`boolean`	`equals(Object obj)`
`Encodings.Encoding`	`getEncoding()`
`RegexFlavor`	`getFlavor()`
`PythonMethod`	`getPythonMethod()`
`int`	`hashCode()`
`boolean`	`isAlwaysEager()` Always match capture groups eagerly.
`boolean`	`isBooleanMatch()` Don't track capture groups, just return a boolean match result instead.
`boolean`	`isDumpAutomata()` Produce ASTs and automata in JSON, DOT (GraphViz) and LaTeX formats.
`boolean`	`isDumpAutomataWithSourceSections()`
`boolean`	`isGenerateDFAImmediately()` Generate DFA matchers immediately after parsing the expression.
`boolean`	`isIgnoreAtomicGroups()` Ignore atomic groups (found e.g.
`boolean`	`isMustAdvance()` Do not return zero-width matches at the beginning of the search string.
`boolean`	`isRegressionTestMode()`
`boolean`	`isStepExecution()` Trace the execution of automata in JSON files.
`boolean`	`isU180EWhitespace()`
`boolean`	`isUTF16ExplodeAstralSymbols()` Explode astral symbols (`0x10000 - 0x10FFFF`) into sub-automata where every state matches one `char` as opposed to one code point.
`boolean`	`isValidate()` Do not generate an actual regular expression matcher, just check the given regular expression for syntax errors.
`String`	`toString()`
`RegexOptions`	`withBooleanMatch()`
`RegexOptions`	`withEncoding(Encodings.Encoding newEnc)`
`RegexOptions`	`withoutBooleanMatch()`
`RegexOptions`	`withoutPythonMethod()`

Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - U180E_WHITESPACE_NAME
```
public static final String U180E_WHITESPACE_NAME
```
    See Also:
    
    Constant Field Values
  - REGRESSION_TEST_MODE_NAME
```
public static final String REGRESSION_TEST_MODE_NAME
```
    See Also:
    
    Constant Field Values
  - DUMP_AUTOMATA_NAME
```
public static final String DUMP_AUTOMATA_NAME
```
    See Also:
    
    Constant Field Values
  - STEP_EXECUTION_NAME
```
public static final String STEP_EXECUTION_NAME
```
    See Also:
    
    Constant Field Values
  - ALWAYS_EAGER_NAME
```
public static final String ALWAYS_EAGER_NAME
```
    See Also:
    
    Constant Field Values
  - UTF_16_EXPLODE_ASTRAL_SYMBOLS_NAME
```
public static final String UTF_16_EXPLODE_ASTRAL_SYMBOLS_NAME
```
    See Also:
    
    Constant Field Values
  - VALIDATE_NAME
```
public static final String VALIDATE_NAME
```
    See Also:
    
    Constant Field Values
  - IGNORE_ATOMIC_GROUPS_NAME
```
public static final String IGNORE_ATOMIC_GROUPS_NAME
```
    See Also:
    
    Constant Field Values
  - MUST_ADVANCE_NAME
```
public static final String MUST_ADVANCE_NAME
```
    See Also:
    
    Constant Field Values
  - FLAVOR_NAME
```
public static final String FLAVOR_NAME
```
    See Also:
    
    Constant Field Values
  - FLAVOR_PYTHON
```
public static final String FLAVOR_PYTHON
```
    See Also:
    
    Constant Field Values
  - FLAVOR_PYTHON_STR
```
public static final String FLAVOR_PYTHON_STR
```
    See Also:
    
    Constant Field Values
  - FLAVOR_PYTHON_BYTES
```
public static final String FLAVOR_PYTHON_BYTES
```
    See Also:
    
    Constant Field Values
  - FLAVOR_RUBY
```
public static final String FLAVOR_RUBY
```
    See Also:
    
    Constant Field Values
  - FLAVOR_ECMASCRIPT
```
public static final String FLAVOR_ECMASCRIPT
```
    See Also:
    
    Constant Field Values
  - ENCODING_NAME
```
public static final String ENCODING_NAME
```
    See Also:
    
    Constant Field Values
  - PYTHON_METHOD_NAME
```
public static final String PYTHON_METHOD_NAME
```
    See Also:
    
    Constant Field Values
  - PYTHON_METHOD_SEARCH
```
public static final String PYTHON_METHOD_SEARCH
```
    See Also:
    
    Constant Field Values
  - PYTHON_METHOD_MATCH
```
public static final String PYTHON_METHOD_MATCH
```
    See Also:
    
    Constant Field Values
  - PYTHON_METHOD_FULLMATCH
```
public static final String PYTHON_METHOD_FULLMATCH
```
    See Also:
    
    Constant Field Values
  - DEFAULT
```
public static final RegexOptions DEFAULT
```
- Method Detail
  - builder
```
public static RegexOptions.Builder builder(com.oracle.truffle.api.source.Source source,
                                           String sourceString)
```
  - isU180EWhitespace
```
public boolean isU180EWhitespace()
```
  - isRegressionTestMode
```
public boolean isRegressionTestMode()
```
  - isDumpAutomata
```
public boolean isDumpAutomata()
```
    Produce ASTs and automata in JSON, DOT (GraphViz) and LaTeX formats.
  - isDumpAutomataWithSourceSections
```
public boolean isDumpAutomataWithSourceSections()
```
  - isStepExecution
```
public boolean isStepExecution()
```
    Trace the execution of automata in JSON files.
  - isGenerateDFAImmediately
```
public boolean isGenerateDFAImmediately()
```
    Generate DFA matchers immediately after parsing the expression.
  - isBooleanMatch
```
public boolean isBooleanMatch()
```
    Don't track capture groups, just return a boolean match result instead.
  - isAlwaysEager
```
public boolean isAlwaysEager()
```
    Always match capture groups eagerly.
  - isUTF16ExplodeAstralSymbols
```
public boolean isUTF16ExplodeAstralSymbols()
```
    Explode astral symbols (0x10000 - 0x10FFFF) into sub-automata where every state matches one char as opposed to one code point.
  - isValidate
```
public boolean isValidate()
```
    Do not generate an actual regular expression matcher, just check the given regular expression for syntax errors.
  - isIgnoreAtomicGroups
```
public boolean isIgnoreAtomicGroups()
```
    Ignore atomic groups (found e.g. in Ruby regular expressions), treat them as regular groups.
  - isMustAdvance
```
public boolean isMustAdvance()
```
    Do not return zero-width matches at the beginning of the search string. The matcher must advance by at least one character by either finding a match of non-zero width or finding a match after advancing skipping several characters.
  - getFlavor
```
public RegexFlavor getFlavor()
```
  - getEncoding
```
public Encodings.Encoding getEncoding()
```
  - getPythonMethod
```
public PythonMethod getPythonMethod()
```
  - withEncoding
```
public RegexOptions withEncoding(Encodings.Encoding newEnc)
```
  - withoutPythonMethod
```
public RegexOptions withoutPythonMethod()
```
  - withBooleanMatch
```
public RegexOptions withBooleanMatch()
```
  - withoutBooleanMatch
```
public RegexOptions withoutBooleanMatch()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RegexOptions

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

U180E_WHITESPACE_NAME

REGRESSION_TEST_MODE_NAME

DUMP_AUTOMATA_NAME

STEP_EXECUTION_NAME

ALWAYS_EAGER_NAME

UTF_16_EXPLODE_ASTRAL_SYMBOLS_NAME

VALIDATE_NAME

IGNORE_ATOMIC_GROUPS_NAME

MUST_ADVANCE_NAME

FLAVOR_NAME

FLAVOR_PYTHON

FLAVOR_PYTHON_STR

FLAVOR_PYTHON_BYTES

FLAVOR_RUBY

FLAVOR_ECMASCRIPT

ENCODING_NAME

PYTHON_METHOD_NAME

PYTHON_METHOD_SEARCH

PYTHON_METHOD_MATCH

PYTHON_METHOD_FULLMATCH

DEFAULT

Method Detail

builder

isU180EWhitespace

isRegressionTestMode

isDumpAutomata

isDumpAutomataWithSourceSections

isStepExecution

isGenerateDFAImmediately

isBooleanMatch

isAlwaysEager

isUTF16ExplodeAstralSymbols

isValidate

isIgnoreAtomicGroups

isMustAdvance

getFlavor

getEncoding

getPythonMethod

withEncoding

withoutPythonMethod

withBooleanMatch

withoutBooleanMatch

hashCode

equals

toString