the result type to use when every match is needed, not just the first match of the RE against the source

the result of matching a RE to a text once, listing the text that was matched and the named captures in the RE and all of the substrings matched, with the text captured by the whole RE; a complete failure to match will be represented with an empty array (with bounds (0,-1))

the matching of a single sub-expression against part of the source text

Construct a Match that does not match anything.

tests whether the RE matched the source text at all

count the matches

extract the main capture from each match

tests whether the RE matched the source text at all

tests whether the RE matched the source text at all

the top-level capture if the source text matched the RE, Nothing otherwise

the top-level capture and the sub captures if the text matched the RE, Nothing otherwise

an alternative for captureText

look up the text of the nth capture, 0 being the match of the whole RE against the source text, 1, the first bracketed sub-expression to be matched and so on

an alternative for captureTextMaybe

look up the text of the nth capture (0 being the match of the whole), returning Nothing if the Match doesn't contain the capture

an alternative for capture

look up the nth capture, 0 being the match of the whole RE against the source text, 1, the first bracketed sub-expression to be matched and so on

an alternative for capture captureMaybe

look up the nth capture, 0 being the match of the whole RE against the source text, 1, the first bracketed sub-expression to be matched and so on, returning Nothing if there is no such capture, or if the capture failed to capture anything (being in a failed alternate)

test if the capture has matched any text

returns the text preceding the match

returns the text after the match

CaptureID identifies captures, either by number (e.g., [cp|1|]) or name (e.g., [cp|foo|]).

the dictionary for named captures stored in compiled regular expressions associates

an empty CaptureNames dictionary

a CaptureName is just the text of the name

a CaptureOrdinal is just the number of the capture, starting with 0 for the whole of the text matched, then in leftmost, outermost

look up a CaptureID in the CaptureNames dictionary

Replace provides the missing methods needed to replace the matched text; lengthE is the minimum implementation

a selction of the Replace methods can be encapsulated with ReplaceMethods for the higher-order replacement functions

replaceMethods encapsulates ReplaceMethods a from a Replace a context

Context specifies which contexts the substitutions should be applied

the Location information passed into the substitution function specifies which sub-expression is being substituted

True iff the location references a complete match (i.e., not a bracketed capture)

replace all with a template, $0 for whole text, $1 for first capture, etc.

substitutes using a function that takes the full Match context and returns the same replacement text as the _phi_phi context.

replaceAllCaptures_ is like like replaceAllCaptures but takes the Replace methods through the ReplaceMethods argument

replaceAllCapturesM is just a monadically generalised version of replaceAllCaptures_

substitutes using a function that takes the full Match context and returns the same replacement text as the _phi_phi context.

replaceCaptures_ is like replaceCaptures but takes the Replace methods through the ReplaceMethods argument

replaceCapturesM is just a monadically generalised version of replaceCaptures_

expand all of the @{..} macros in the RE in the argument String according to the Macros argument, preprocessing the RE String according to the Mode argument (used internally)

expand the @{..} macos in the argument string using the given function