find all the matches in the argument text; e.g., to count the number of naturals in s:
countMatches $ s *=~ [re|[0-9]+|]Moduleregex-1.1.0.2Haskell2010
Text.RE.TDFA
- 6 types
- 1 class
- 60 values
- Packageregex-1.1.0.2
- Exports67
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceTDFA.hs
Tutorial
0 declarationsWe have a regex tutorial at http://tutorial.regex.uk.
About this Module
0 declarationsThis module provides access to the back end through polymorphic functions that operate over all of the String/Text/ByteString types supported by the back end. The module also provides all of the specialised back-end functionality that will not be needed by most regex clients. If you don't need this generality then you might want to consider using one of the simpler modules that have been specialised for each of these types:
find the first match in the argument text; e.g., to test if there is a natural number in the input text:
matched $ s ?=~ [re|[0-9]+|]The SearchReplace Operators
2 declarationssearch and replace all matches in the argument text; e.g., this section will convert every YYYY-MM-DD format date in its argument text into a DD/MM/YYYY date:
(*=~/ [ed|${y}([0-9]{4})-0*${m}([0-9]{2})-0*${d}([0-9]{2})///${d}/${m}/${y}|])search and replace the first occurrence only
The Matches Type
6 declarationsthe result of matching a RE against a text (with *=~), retaining
the text that was matched against
Instances4Functor, RegexContext, Eq, Show
Functor MatchesDefined in regex-1.1.0.2 · Text.RE.ZeInternals.Types.Matches(RegexContext regex source [MatchText source], RegexLike regex source, RegexFix regex source) => RegexContext regex source (Matches source)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.Types.Matchesthis instance hooks Matches into regex-base: regex consumers need not worry about any of this
Eq a => Eq (Matches a)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.Types.MatchesShow a => Show (Matches a)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.Types.Matches
the source text being matched
all Match instances found, left to right
tests whether the RE matched the source text at all
count the matches
list the texts that Matched
The Match Type
4 declarationsthe result of matching a RE to a text once (with ?=~), retaining
the text that was matched against
Instances4Functor, RegexContext, Eq, Show
Functor MatchDefined in regex-1.1.0.2 · Text.RE.ZeInternals.Types.Match(RegexContext regex source (AllTextSubmatches (Array Int) (source, (Int, Int))), RegexLike regex source, RegexFix regex source) => RegexContext regex source (Match source)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.Types.Matchthis instance hooks Match into regex-base: regex consumers need not worry about any of this
Eq a => Eq (Match a)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.Types.MatchShow a => Show (Match a)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.Types.Match
the whole source text
tests whether the RE matched the source text at all
yields the text matched by the RE, Nothing if no match
The Macros and Parsers
0 declarationsThere are a number of RE macros and corresponding Haskell parsers for parsing the matched text into appropriate Haskell types. See the Macros Tables for details.
module Text.RE.TestBench.Parsers
The RE Type
6 declarationsthe RE type for this back end representing a well-formed, compiled RE
Instances8IsRegex, IsOption, …
IsOption REOptionsDefined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFAIsRegex RE ByteStringDefined in regex-1.1.0.2 · Text.RE.TDFA.ByteString · orphanIsRegex RE ByteStringDefined in regex-1.1.0.2 · Text.RE.TDFA.ByteString.Lazy · orphanIsRegex RE StringDefined in regex-1.1.0.2 · Text.RE.TDFA.String · orphanIsRegex RE TextDefined in regex-1.1.0.2 · Text.RE.TDFA.Text · orphanIsRegex RE TextDefined in regex-1.1.0.2 · Text.RE.TDFA.Text.Lazy · orphanIsRegex RE (Seq Char)Defined in regex-1.1.0.2 · Text.RE.TDFA.Sequence · orphanIsOption (Macros RE)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFA
some functions in the Text.RE.TestBench need the back end to be passed dynamically as a RegexType parameters: use regexType for this
extract the REOptions from the RE
extract the RE source string from the RE
extract the CaptureNames from the RE
extract the back end compiled Regex type from the RE
Options
6 declarationsYou can specify different compilation options by appending a to the name of an [re| ... |] or [ed| ... /// ... |] quasi quoter to select the corresponding compilation option. For example, the section,
(?=~/ [edBlockInsensitive|foo$///bar|])will replace a foo suffix of the argument text, of any
capitalisation, with a (lower case) bar. If you need to specify the
options dynamically, use the [re_| ... |] and [ed_| ... /// ... |]
quasi quoters, which generate functions that take an IsOption option
(e.g., a SimpleReOptions value) and yields a RE or SearchReplace
as appropriate. For example if you have a SimpleReOptions value in
sro then
(?=~/ [ed_|foo$///bar|] sro)will compile the foo$ RE according to the value of sro. For more
on specifying RE options see Text.RE.REOptions.
the default API uses these simple, universal RE options, which get auto-converted into the appropriate back-end REOptions_
Constructors
MultilineSensitivecase-sensitive with ^ and $ matching the start and end of a line
MultilineInsensitivecase-insensitive with ^ and $ matsh the start and end of a line
BlockSensitivecase-sensitive with ^ and $ matching the start and end of the input text
BlockInsensitivecase-insensitive with ^ and $ matching the start and end of the input text
Instances7Bounded, Enum, Eq, Ord, Show, IsOption, …
Bounded SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptionsEnum SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptionsEq SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptionsOrd SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptionsShow SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptionsIsOption SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFALift SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptionswe need to use this in the quasi quoters to specify
SimpleREOptionsselected by the quasi quoter
a number of types can be used to encode REOptions_, each of which is made a member of this class
Methods
makeREOptions :: o -> REOptionsconvert the
otype into anREOptions
Instances6IsOption
IsOption SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFAIsOption REOptionsDefined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFAIsOption CompOptionDefined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFAIsOption ExecOptionDefined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFAIsOption ()Defined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFAIsOption (Macros RE)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFA
and the REOptions for this back end (see Text.RE.REOptions for details)
the default REOptions
the default REOptions but with no RE macros defined
convert a universal SimpleReOptions into the REOptions used
by this back end
Compiling and Escaping REs
11 declarationscontains a compiled RE and replacement template
Constructors
SearchReplacegetSearch :: !rethe RE to match a string to replace
getTemplate :: !sthe replacement template with ${cap} used to identify a capture (by number or name if one was given) and
$$being used to escape a single $
Instances2Functor, Show
Functor (SearchReplace re)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.Types.SearchReplace(Show re, Show s) => Show (SearchReplace re s)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.Types.SearchReplace
compile a SearchReplace template generating errors if the RE or the template are not well formed, all capture references being checked
compile a SearchReplace template, with simple options, generating errors if the RE or the template are not well formed, all capture references being checked
compile a SearchReplace template, with general options, generating errors if the RE or the template are not well formed, all capture references being checked
convert a string into a RE that matches that string, and apply it to an argument continuation function to make up the RE string to be compiled; e.g., to compile a RE that will only match the string:
maybe undefined id . escape (("^"++) . (++"$"))a variant of escape where the SimpleREOptions are specified
a variant of escapeWith that allows an IsOption RE option to be specified
Convert a string into a regular expression that will match that string
The Classic regex-base Match Operators
2 declarationsthe regex-base polymorphic match operator
the regex-base monadic, polymorphic match operator
The re Quasi Quoters
10 declarationsThe [re|.*|] quasi quoters, with variants for specifying different
options to the RE compiler (see Text.RE.REOptions), and the
specialised back-end types and functions.
[re| ... |], is equivalent to [reMultilineSensitive| ... |],
compiling a case-sensitive, multi-line RE
[reMultilineSensitive| ... |], compiles a case-sensitive, multi-line RE
[reMultilineInsensitive| ... |], compiles a case-insensitive, multi-line RE
[reMultilineInsensitive| ... |], compiles a case-sensitive, non-multi-line RE
[reMultilineInsensitive| ... |], compiles a case-insensitive, non-multi-line RE
[reMS| ... |] is a shorthand for [reMultilineSensitive| ... |]
[reMI| ... |] is a shorthand for [reMultilineInsensitive| ... |]
[reBS| ... |] is a shorthand for [reBlockSensitive| ... |]
[reBI| ... |] is a shorthand for [reBlockInsensitive| ... |]
[re_| ... |] compiles a RE to produce a function that takes
the RE options (e.g., a SimpleREOptions value) and yields the
RE compiled with those options. For example,
countMatches $ s *=~ [re_|[0-9a-f]+|] MultilineInsensitivecounts the number of hexadecimal digit strings in s, allowing
for upper- or lower-case hex digits (which is entirely equivalent
in this example to just using [reMultilineInsensitive|[0-9a-f]+|]).
The Ed Quasi Quoters
10 declarationsThe -- | the [ed| ... /// ... |] quasi quoters; for example,
[ed|${y}([0-9]{4})-0*${m}([0-9]{2})-0*${d}([0-9]{2})///${d}/${m}/${y}|])represents a SearchReplace that will convert a YYYY-MM-DD format date
into a DD/MM/YYYY format date.
The only difference between these quasi quoters is the RE options that are set,
using the same conventions as the [re| ... |] quasi quoters.
the [ed| ... /// ... |] quasi quoters
the [ed| ... /// ... |] quasi quoters
the [ed| ... /// ... |] quasi quoters
the [ed| ... /// ... |] quasi quoters
the [ed| ... /// ... |] quasi quoters
the [ed| ... /// ... |] quasi quoters
the [ed| ... /// ... |] quasi quoters
the [ed| ... /// ... |] quasi quoters
the [ed| ... /// ... |] quasi quoters
the [ed| ... /// ... |] quasi quoters
The cp Quasi Quoters
1 declarationquasi quoter for CaptureID: [cp|0|], [cp|0|], etc.,
indexing captures by classic positional numbers, and [cp|foo|],
etc., referencing a named capture [re| ... ${foo}( ... ) ... |].
RE Macros Standard Environment
7 declarationsthe standard table of Macros used to compile REs (which can be extended or replace: see Text.RE.TestBench)
the standard MacroEnv for this back end (see Text.RE.TestBench)
the macros in the standard environment that are failing their tests (checked by the test suite to be empty)
a table the standard macros in markdown format
a summary of the macros in the standard environment for this back end in plain text
a listing of the RE text for each macro in the standard environment with all macros expanded to normal form
the prelude source of a given macro in the standard environment
IsRegex
0 declarationsThe IsRegex class is used to abstract over the different regex back ends and the text types they work with -- see Text.RE.Tools.IsRegex for details.
module Text.RE.Tools.IsRegex
The IsRegex Instances
0 declarationsThese module exports merely provide the IsRegex instances.