Provides support for regular expression pattern matching and text processing.

The Regex module provides ECMAScript-compatible regex functionality with Unicode support. It offers efficient pattern compilation, flexible matching modes, and text manipulation capabilities including search, replace, and split operations.

Key features include:

• ECMAScript (JavaScript) regex syntax.
• Full Unicode support including character classes and properties.
• Case-insensitive and multiline matching options.
• Reusable compiled patterns for optimal performance.
• Callback-based result processing for custom handling.

Note: Fluid scripts are expected to use the built-in regex functions for better integration as opposed to this module.

Functions

Compile | GetCaptureIndex | Replace | Search | Split

Structures

Regex

Constants

REGEX | RMATCH

Compile()

Compiles a regex pattern and returns a regex object.

Use Compile() to compile a regex pattern into a regex object that can be used for matching and searching. The compiled regex object can be reused for multiple match or search operations, improving performance. It must be removed with ~Core:FreeResource() when no longer needed to avoid memory leaks.

Error Codes

GetCaptureIndex()

Retrieves capture indices for a named group.

Use GetCaptureIndex() to resolve the numeric capture indices associated with a named capture group. ECMAScript allows multiple groups to share the same name; this function therefore returns every index that matches the provided name. If no capture groups match the provided name, ERR::Search is returned.

Error Codes

Replace()

Replaces occurrences of the regex pattern in the input text with a specified replacement string.

Call Replace() to perform regex-based replacements in a given text. The function takes a compiled regex object, the input text, a replacement string, and optional flags to modify the replacement behavior. The replacement string can include back-references like \1, \2, etc., to refer to captured groups from the regex match.

Error Codes

Search()

Performs regex matching.

Call Search() to search for a regex pattern in a given text. The function takes a compiled regex object, the input text, optional flags to modify the matching behavior, and a callback function to process the match results. For each match that is found, the callback function is invoked with details about the match.

The C++ prototype for the Callback function is:

ERR callback(int Index, std::vector<std::string_view> &Capture, size_t MatchStart, size_t MatchEnd, APTR Meta);

Note the inclusion of the Index parameter, which indicates the match number (starting from 0). The MatchStart and MatchEnd parameters provide explicit byte offsets into the input text for the matched region.

The Capture vector is always normalised so that its size matches the total number of capturing groups defined by the pattern (including the full match at index 0). Optional groups that did not match are provided as empty std::string_view instances, ensuring consistent indexing across matches.

Error Codes

Split()

Split a string into tokens, using a regex pattern to denote the delimiter.

Call Split() to divide a string into multiple tokens based on a regex pattern that defines the delimiters. The function takes a compiled regex object, the input text, and optional flags to modify the splitting behavior.

The resulting tokens are stored in the provided output array.

If no matches are found, the entire input text is returned as a single token.

Error Codes

REGEX Type

Optional flags for the Regex functions.

RMATCH Type

Regex Structure

Compiled regex structure.