<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>Text/Regex/TDFA.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-|
<a name="line-2"></a>
<a name="line-3"></a>The "Text.Regex.TDFA" module provides a backend for regular
<a name="line-4"></a>expressions. It provides instances for the classes defined and
<a name="line-5"></a>documented in "Text.Regex.Base" and re-exported by this module. If
<a name="line-6"></a>you import this along with other backends then you should do so with
<a name="line-7"></a>qualified imports (with renaming for convenience).
<a name="line-8"></a>
<a name="line-9"></a>This regex-tdfa package implements, correctly, POSIX extended regular
<a name="line-10"></a>expressions. It is highly unlikely that the regex-posix package on
<a name="line-11"></a>your operating system is correct, see
<a name="line-12"></a><a href="http://www.haskell.org/haskellwiki/Regex_Posix">http://www.haskell.org/haskellwiki/Regex_Posix</a> for examples of your
<a name="line-13"></a>OS's bugs.
<a name="line-14"></a>
<a name="line-15"></a>This package does provide captured parenthesized subexpressions.
<a name="line-16"></a>
<a name="line-17"></a>Depending on the text being searched this package supports Unicode.
<a name="line-18"></a>The [Char] and (Seq Char) text types support Unicode. The ByteString
<a name="line-19"></a>and ByteString.Lazy text types only support ASCII. It is possible to
<a name="line-20"></a>support utf8 encoded ByteString.Lazy by using regex-tdfa and
<a name="line-21"></a>regex-tdfa-utf8 packages together (required the utf8-string package).
<a name="line-22"></a>
<a name="line-23"></a>As of version 1.1.1 the following GNU extensions are recognized, all
<a name="line-24"></a>anchors:
<a name="line-25"></a>
<a name="line-26"></a>\\\` at beginning of entire text
<a name="line-27"></a>
<a name="line-28"></a>\\\' at end of entire text
<a name="line-29"></a>
<a name="line-30"></a>\\< at beginning of word
<a name="line-31"></a>
<a name="line-32"></a>\\> at end of word
<a name="line-33"></a>
<a name="line-34"></a>\\b at either beginning or end of word
<a name="line-35"></a>
<a name="line-36"></a>\\B at neither beginning nor end of word
<a name="line-37"></a>
<a name="line-38"></a>The above are controlled by the 'newSyntax' Bool in 'CompOption'.
<a name="line-39"></a>
<a name="line-40"></a>Where the "word" boundaries means between characters that are and are
<a name="line-41"></a>not in the [:word:] character class which contains [a-zA-Z0-9_]. Note
<a name="line-42"></a>that \< and \b may match before the entire text and \> and \b may
<a name="line-43"></a>match at the end of the entire text.
<a name="line-44"></a>
<a name="line-45"></a>There is no locale support, so collating elements like [.ch.] are
<a name="line-46"></a>simply ignored and equivalence classes like [=a=] are converted to
<a name="line-47"></a>just [a]. The character classes like [:alnum:] are supported over
<a name="line-48"></a>ASCII only, valid classes are alnum, digit, punct, alpha, graph,
<a name="line-49"></a>space, blank, lower, upper, cntrl, print, xdigit, word.
<a name="line-50"></a>
<a name="line-51"></a>This package does not provide "basic" regular expressions. This
<a name="line-52"></a>package does not provide back references inside regular expressions.
<a name="line-53"></a>
<a name="line-54"></a>The package does not provide Perl style regular expressions. Please
<a name="line-55"></a>look at the regex-pcre and pcre-light packages instead.
<a name="line-56"></a>
<a name="line-57"></a>-}</span>
<a name="line-58"></a>
<a name="line-59"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Regex</span><span class='hs-varop'>.</span><span class='hs-conid'>TDFA</span><span class='hs-layout'>(</span><span class='hs-varid'>getVersion_Text_Regex_TDFA</span>
<a name="line-60"></a> <span class='hs-layout'>,</span><span class='hs-layout'>(</span><span class='hs-varop'>=~</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span><span class='hs-layout'>(</span><span class='hs-varop'>=~~</span><span class='hs-layout'>)</span>
<a name="line-61"></a> <span class='hs-layout'>,</span><span class='hs-keyword'>module</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Regex</span><span class='hs-varop'>.</span><span class='hs-conid'>TDFA</span><span class='hs-varop'>.</span><span class='hs-conid'>Common</span>
<a name="line-62"></a> <span class='hs-layout'>,</span><span class='hs-keyword'>module</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Regex</span><span class='hs-varop'>.</span><span class='hs-conid'>Base</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-63"></a>
<a name="line-64"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Version</span><span class='hs-layout'>(</span><span class='hs-conid'>Version</span><span class='hs-layout'>)</span>
<a name="line-65"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Regex</span><span class='hs-varop'>.</span><span class='hs-conid'>Base</span>
<a name="line-66"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Regex</span><span class='hs-varop'>.</span><span class='hs-conid'>TDFA</span><span class='hs-varop'>.</span><span class='hs-conid'>String</span><span class='hs-conid'>()</span>
<a name="line-67"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Regex</span><span class='hs-varop'>.</span><span class='hs-conid'>TDFA</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-conid'>()</span>
<a name="line-68"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Regex</span><span class='hs-varop'>.</span><span class='hs-conid'>TDFA</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span><span class='hs-conid'>()</span>
<a name="line-69"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Regex</span><span class='hs-varop'>.</span><span class='hs-conid'>TDFA</span><span class='hs-varop'>.</span><span class='hs-conid'>Sequence</span><span class='hs-conid'>()</span>
<a name="line-70"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Regex</span><span class='hs-varop'>.</span><span class='hs-conid'>TDFA</span><span class='hs-varop'>.</span><span class='hs-conid'>Common</span><span class='hs-layout'>(</span><span class='hs-conid'>Regex</span><span class='hs-layout'>,</span><span class='hs-conid'>CompOption</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span><span class='hs-conid'>ExecOption</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-71"></a><span class='hs-comment'>--import Text.Regex.TDFA.Wrap(Regex,CompOption(..),ExecOption(..),(=~),(=~~))</span>
<a name="line-72"></a>
<a name="line-73"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Paths_regex_tdfa</span><span class='hs-layout'>(</span><span class='hs-varid'>version</span><span class='hs-layout'>)</span>
<a name="line-74"></a>
<a name="line-75"></a><a name="getVersion_Text_Regex_TDFA"></a><span class='hs-definition'>getVersion_Text_Regex_TDFA</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Version</span>
<a name="line-76"></a><span class='hs-definition'>getVersion_Text_Regex_TDFA</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>version</span>
<a name="line-77"></a>
<a name="line-78"></a>
<a name="line-79"></a><a name="=~"></a><span class='hs-comment'>-- | This is the pure functional matching operator. If the target</span>
<a name="line-80"></a><span class='hs-comment'>-- cannot be produced then some empty result will be returned. If</span>
<a name="line-81"></a><span class='hs-comment'>-- there is an error in processing, then 'error' will be called.</span>
<a name="line-82"></a><span class='hs-layout'>(</span><span class='hs-varop'>=~</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>RegexMaker</span> <span class='hs-conid'>Regex</span> <span class='hs-conid'>CompOption</span> <span class='hs-conid'>ExecOption</span> <span class='hs-varid'>source</span><span class='hs-layout'>,</span><span class='hs-conid'>RegexContext</span> <span class='hs-conid'>Regex</span> <span class='hs-varid'>source1</span> <span class='hs-varid'>target</span><span class='hs-layout'>)</span>
<a name="line-83"></a> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>source1</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>source</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>target</span>
<a name="line-84"></a><span class='hs-layout'>(</span><span class='hs-varop'>=~</span><span class='hs-layout'>)</span> <span class='hs-varid'>x</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>let</span> <span class='hs-varid'>make</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>RegexMaker</span> <span class='hs-conid'>Regex</span> <span class='hs-conid'>CompOption</span> <span class='hs-conid'>ExecOption</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Regex</span>
<a name="line-85"></a> <span class='hs-varid'>make</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>makeRegex</span>
<a name="line-86"></a> <span class='hs-keyword'>in</span> <span class='hs-varid'>match</span> <span class='hs-layout'>(</span><span class='hs-varid'>make</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span> <span class='hs-varid'>x</span>
<a name="line-87"></a>
<a name="line-88"></a><a name="=~~"></a><span class='hs-comment'>-- | This is the monadic matching operator. If a single match fails,</span>
<a name="line-89"></a><span class='hs-comment'>-- then 'fail' will be called.</span>
<a name="line-90"></a><span class='hs-layout'>(</span><span class='hs-varop'>=~~</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>RegexMaker</span> <span class='hs-conid'>Regex</span> <span class='hs-conid'>CompOption</span> <span class='hs-conid'>ExecOption</span> <span class='hs-varid'>source</span><span class='hs-layout'>,</span><span class='hs-conid'>RegexContext</span> <span class='hs-conid'>Regex</span> <span class='hs-varid'>source1</span> <span class='hs-varid'>target</span><span class='hs-layout'>,</span><span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span>
<a name="line-91"></a> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>source1</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>source</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>target</span>
<a name="line-92"></a><span class='hs-layout'>(</span><span class='hs-varop'>=~~</span><span class='hs-layout'>)</span> <span class='hs-varid'>x</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-keyword'>let</span> <span class='hs-varid'>make</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>RegexMaker</span> <span class='hs-conid'>Regex</span> <span class='hs-conid'>CompOption</span> <span class='hs-conid'>ExecOption</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>Regex</span>
<a name="line-93"></a> <span class='hs-varid'>make</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>makeRegexM</span>
<a name="line-94"></a> <span class='hs-varid'>q</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>make</span> <span class='hs-varid'>r</span>
<a name="line-95"></a> <span class='hs-varid'>matchM</span> <span class='hs-varid'>q</span> <span class='hs-varid'>x</span>
</pre></body>
</html>
