Classes and instances for Regex matching.
All the classes are declared here, and some common type aliases, and
the MatchResult data type.
The only instances here are for Extract String and Extract ByteString.
There are no data values. The RegexContext instances are in
Text.Regex.Base.Context, except for ones which run afoul of a
repeated variable (RegexContext regex a a), which are defined in each
modules' String and ByteString modules.
|0 based index from start of source, or (-1) for unused
|non-negative length of a match
|0 based array, with 0th index indicating the full match. If the
full match location is not available, represent as (0,0).
|This is the same as the type from JRegex.
|mrBefore :: a|
|mrMatch :: a|
|mrAfter :: a|
|mrSubList :: [a]|
|mrSubs :: Array Int a|
|class RegexOptions regex compOpt execOpt | regex -> compOpt execOpt, compOpt -> regex execOpt, execOpt -> regex compOpt where||Source|
|Rather than carry them around spearately, the options for how to
execute a regex are kept as part of the regex. There are two types
of options. Those that can only be specified at compilation time
and never changed are CompOpt. Those that can be changed later and
affect how matching is performed are ExecOpt. The actually types
for these depend on the backend.
|:: compOpt||no options set at all in the backend
|:: execOpt||no options set at all in the backend
|:: compOpt||reasonable options (extended,caseSensitive,multiline regex)
|:: execOpt||reasonable options (extended,caseSensitive,multiline regex)
|setExecOpts :: execOpt -> regex -> regex||Source|
|forget old flags and use new ones
|getExecOpts :: regex -> execOpt||Source|
|retrieve the current flags
|class RegexOptions regex compOpt execOpt => RegexMaker regex compOpt execOpt source | regex -> compOpt execOpt, compOpt -> regex execOpt, execOpt -> regex compOpt where||Source|
|RegexMaker captures the creation of the compiled regular
expression from a source type and an option type. The makeRegex
function has a default implementation that depends on makeRegexOpts
and used defaultCompOpt and defaultExecOpt.
|makeRegex :: source -> regex||Source|
|make using the defaultCompOpt and defaultExecOpt
|makeRegexOpts :: compOpt -> execOpt -> source -> regex||Source|
|Specify your own options
RegexLike is parametrized on a regular expression type and a
source type to run the matching on.
There are default implementations: matchTest and matchOnceText
using matchOnce; matchCount and matchAllText using
matchAll. matchOnce uses matchOnceText and matchAll uses
matchAllText. So a minimal complete instance need to provide
(matchOnce or matchOnceText) and (matchAll or matchAllText).
|This can return an array of (offset,length) index pairs for the
match and captured substrings.
|This can return a tuple of three items: the source before the
match, an array of the match and captured substrings (with their
indices), and the source after the match.
|class RegexLike regex source => RegexContext regex source target where||Source|
|RegexContext is the polymorphic interface to do matching
|match :: regex -> source -> target||Source|
|class Extract source where||Source|
|Extract allows for indexing operations on String or ByteString.
|before is a renamed take
|after is a renamed drop
|For when there is no match, this can construct an empty data value
|extract takes an offset and length and has a default
implementation of extract (off,len) source = before len (after
|Produced by Haddock version 2.4.2|