8 lines
31 KiB
HTML
8 lines
31 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Text.Regex.PCRE.Wrap</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
|
|
window.onload = function () {pageLoad();setSynopsis("mini_Text-Regex-PCRE-Wrap.html");};
|
|
//]]>
|
|
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">regex-pcre-0.94.4: Replaces/Enhances Text.Regex</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Text.Regex.PCRE.Wrap</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">High-level interface</a></li><li><a href="#g:2">Low-level interface</a></li><li><a href="#g:3">Miscellaneous</a></li><li><a href="#g:4">CompOption values</a></li><li><a href="#g:5">ExecOption values</a></li><li><a href="#g:6">ReturnCode values</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This will fail or error only if allocation fails or a nullPtr is passed in.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Regex">Regex</a></li><li class="src short"><span class="keyword">newtype</span> <a href="#t:CompOption">CompOption</a> = <a href="#v:CompOption">CompOption</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-Types.html#t:CInt">CInt</a></li><li class="src short"><span class="keyword">newtype</span> <a href="#t:ExecOption">ExecOption</a> = <a href="#v:ExecOption">ExecOption</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-Types.html#t:CInt">CInt</a></li><li class="src short"><a href="#v:-61--126-">(=~)</a> :: (RegexMaker <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a> source, RegexContext <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> source1 target) => source1 -> source -> target</li><li class="src short"><a href="#v:-61--126--126-">(=~~)</a> :: (RegexMaker <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a> source, RegexContext <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> source1 target, <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Control-Monad.html#t:Monad">Monad</a> m) => source1 -> source -> m target</li><li class="src short"><span class="keyword">type</span> <a href="#t:StartOffset">StartOffset</a> = <a href="Text-Regex-PCRE-String.html#t:MatchOffset">MatchOffset</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:EndOffset">EndOffset</a> = <a href="Text-Regex-PCRE-String.html#t:MatchOffset">MatchOffset</a></li><li class="src short"><span class="keyword">newtype</span> <a href="#t:ReturnCode">ReturnCode</a> = <a href="#v:ReturnCode">ReturnCode</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-Types.html#t:CInt">CInt</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:WrapError">WrapError</a> = (<a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a>, <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a>)</li><li class="src short"><a href="#v:wrapCompile">wrapCompile</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a> -> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-String.html#t:CString">CString</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Either.html#t:Either">Either</a> (<a href="Text-Regex-PCRE-String.html#t:MatchOffset">MatchOffset</a>, <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a>) <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a>)</li><li class="src short"><a href="#v:wrapTest">wrapTest</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:StartOffset">StartOffset</a> -> <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-String.html#t:CStringLen">CStringLen</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Either.html#t:Either">Either</a> <a href="Text-Regex-PCRE-Wrap.html#t:WrapError">WrapError</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a>)</li><li class="src short"><a href="#v:wrapMatch">wrapMatch</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:StartOffset">StartOffset</a> -> <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-String.html#t:CStringLen">CStringLen</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Either.html#t:Either">Either</a> <a href="Text-Regex-PCRE-Wrap.html#t:WrapError">WrapError</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Maybe.html#t:Maybe">Maybe</a> [(<a href="Text-Regex-PCRE-Wrap.html#t:StartOffset">StartOffset</a>, <a href="Text-Regex-PCRE-Wrap.html#t:EndOffset">EndOffset</a>)]))</li><li class="src short"><a href="#v:wrapMatchAll">wrapMatchAll</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-String.html#t:CStringLen">CStringLen</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Either.html#t:Either">Either</a> <a href="Text-Regex-PCRE-Wrap.html#t:WrapError">WrapError</a> [MatchArray])</li><li class="src short"><a href="#v:wrapCount">wrapCount</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-String.html#t:CStringLen">CStringLen</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Either.html#t:Either">Either</a> <a href="Text-Regex-PCRE-Wrap.html#t:WrapError">WrapError</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Int.html#t:Int">Int</a>)</li><li class="src short"><a href="#v:getVersion">getVersion</a> :: <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:configUTF8">configUTF8</a> :: <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:getNumSubs">getNumSubs</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:unusedOffset">unusedOffset</a> :: <a href="Text-Regex-PCRE-String.html#t:MatchOffset">MatchOffset</a></li><li class="src short"><a href="#v:compBlank">compBlank</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compAnchored">compAnchored</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compAutoCallout">compAutoCallout</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compCaseless">compCaseless</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compDollarEndOnly">compDollarEndOnly</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compDotAll">compDotAll</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compExtended">compExtended</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compExtra">compExtra</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compFirstLine">compFirstLine</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compMultiline">compMultiline</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compNoAutoCapture">compNoAutoCapture</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compUngreedy">compUngreedy</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compUTF8">compUTF8</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:compNoUTF8Check">compNoUTF8Check</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></li><li class="src short"><a href="#v:execBlank">execBlank</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></li><li class="src short"><a href="#v:execAnchored">execAnchored</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></li><li class="src short"><a href="#v:execNotBOL">execNotBOL</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></li><li class="src short"><a href="#v:execNotEOL">execNotEOL</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></li><li class="src short"><a href="#v:execNotEmpty">execNotEmpty</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></li><li class="src short"><a href="#v:execNoUTF8Check">execNoUTF8Check</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></li><li class="src short"><a href="#v:execPartial">execPartial</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></li><li class="src short"><a href="#v:retOk">retOk</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></li><li class="src short"><a href="#v:retNoMatch">retNoMatch</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></li><li class="src short"><a href="#v:retNull">retNull</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></li><li class="src short"><a href="#v:retBadOption">retBadOption</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></li><li class="src short"><a href="#v:retBadMagic">retBadMagic</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></li><li class="src short"><a href="#v:retUnknownNode">retUnknownNode</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></li><li class="src short"><a href="#v:retNoMemory">retNoMemory</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></li><li class="src short"><a href="#v:retNoSubstring">retNoSubstring</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></li></ul></div><div id="interface"><h2 id="g:1">High-level interface</h2><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Regex" class="def">Regex</a></p><div class="doc"><p>A compiled regular expression</p></div><div class="subs instances"><p id="control.i:Regex" class="caption collapser" onclick="toggleSection('i:Regex')">Instances</p><div id="section.i:Regex" class="show"><table><tr><td class="src">RegexOptions <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:CompOption" class="def">CompOption</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CompOption" class="def">CompOption</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-Types.html#t:CInt">CInt</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:CompOption" class="caption collapser" onclick="toggleSection('i:CompOption')">Instances</p><div id="section.i:CompOption" class="show"><table><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Prelude.html#t:Num">Num</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Text-Show.html#t:Show">Show</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bits.html#t:Bits">Bits</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></td><td class="doc empty"> </td></tr><tr><td class="src">RegexOptions <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:ExecOption" class="def">ExecOption</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ExecOption" class="def">ExecOption</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-Types.html#t:CInt">CInt</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:ExecOption" class="caption collapser" onclick="toggleSection('i:ExecOption')">Instances</p><div id="section.i:ExecOption" class="show"><table><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Prelude.html#t:Num">Num</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Text-Show.html#t:Show">Show</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bits.html#t:Bits">Bits</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></td><td class="doc empty"> </td></tr><tr><td class="src">RegexOptions <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:-61--126-" class="def">(=~)</a> :: (RegexMaker <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a> source, RegexContext <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> source1 target) => source1 -> source -> target</p></div><div class="top"><p class="src"><a name="v:-61--126--126-" class="def">(=~~)</a> :: (RegexMaker <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a> source, RegexContext <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> source1 target, <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Control-Monad.html#t:Monad">Monad</a> m) => source1 -> source -> m target</p></div><h2 id="g:2">Low-level interface</h2><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:StartOffset" class="def">StartOffset</a> = <a href="Text-Regex-PCRE-String.html#t:MatchOffset">MatchOffset</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:EndOffset" class="def">EndOffset</a> = <a href="Text-Regex-PCRE-String.html#t:MatchOffset">MatchOffset</a></p></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:ReturnCode" class="def">ReturnCode</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ReturnCode" class="def">ReturnCode</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-Types.html#t:CInt">CInt</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:ReturnCode" class="caption collapser" onclick="toggleSection('i:ReturnCode')">Instances</p><div id="section.i:ReturnCode" class="show"><table><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Text-Show.html#t:Show">Show</a> <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:WrapError" class="def">WrapError</a> = (<a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a>, <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a>)</p></div><div class="top"><p class="src"><a name="v:wrapCompile" class="def">wrapCompile</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></td><td class="doc"><p>Flags (summed together)</p></td></tr><tr><td class="src">-> <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></td><td class="doc"><p>Flags (summed together)</p></td></tr><tr><td class="src">-> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-String.html#t:CString">CString</a></td><td class="doc"><p>The regular expression to compile</p></td></tr><tr><td class="src">-> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Either.html#t:Either">Either</a> (<a href="Text-Regex-PCRE-String.html#t:MatchOffset">MatchOffset</a>, <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a>) <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a>)</td><td class="doc"><p>Returns: an error offset and string or the compiled regular expression</p></td></tr></table></div><div class="doc"><p>Compiles a regular expression</p></div></div><div class="top"><p class="src"><a name="v:wrapTest" class="def">wrapTest</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Text-Regex-PCRE-Wrap.html#t:StartOffset">StartOffset</a></td><td class="doc"><p>Starting index in CStringLen</p></td></tr><tr><td class="src">-> <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a></td><td class="doc"><p>Compiled regular expression</p></td></tr><tr><td class="src">-> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-String.html#t:CStringLen">CStringLen</a></td><td class="doc"><p>String to match against and length in bytes</p></td></tr><tr><td class="src">-> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Either.html#t:Either">Either</a> <a href="Text-Regex-PCRE-Wrap.html#t:WrapError">WrapError</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a>)</td><td class="doc empty"> </td></tr></table></div></div><div class="top"><p class="src"><a name="v:wrapMatch" class="def">wrapMatch</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Text-Regex-PCRE-Wrap.html#t:StartOffset">StartOffset</a></td><td class="doc"><p>Starting index in CStringLen</p></td></tr><tr><td class="src">-> <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a></td><td class="doc"><p>Compiled regular expression</p></td></tr><tr><td class="src">-> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-String.html#t:CStringLen">CStringLen</a></td><td class="doc"><p>String to match against and length in bytes</p></td></tr><tr><td class="src">-> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Either.html#t:Either">Either</a> <a href="Text-Regex-PCRE-Wrap.html#t:WrapError">WrapError</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Maybe.html#t:Maybe">Maybe</a> [(<a href="Text-Regex-PCRE-Wrap.html#t:StartOffset">StartOffset</a>, <a href="Text-Regex-PCRE-Wrap.html#t:EndOffset">EndOffset</a>)]))</td><td class="doc"><p>Returns: 'Right Nothing' if the regex did not match the
|
|
string, or:
|
|
'Right Just' an array of (offset,length) pairs where index 0 is whole match, and the rest are the captured subexpressions, or:
|
|
'Left ReturnCode' if there is some strange error</p></td></tr></table></div><div class="doc"><p>Matches a regular expression against a string</p><p>Should never return (Right (Just []))</p></div></div><div class="top"><p class="src"><a name="v:wrapMatchAll" class="def">wrapMatchAll</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-String.html#t:CStringLen">CStringLen</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Either.html#t:Either">Either</a> <a href="Text-Regex-PCRE-Wrap.html#t:WrapError">WrapError</a> [MatchArray])</p><div class="doc"><p>wrapMatchAll is an improvement over wrapMatch since it only
|
|
allocates memory with allocaBytes once at the start.</p></div></div><div class="top"><p class="src"><a name="v:wrapCount" class="def">wrapCount</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Foreign-C-String.html#t:CStringLen">CStringLen</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/System-IO.html#t:IO">IO</a> (<a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Either.html#t:Either">Either</a> <a href="Text-Regex-PCRE-Wrap.html#t:WrapError">WrapError</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Int.html#t:Int">Int</a>)</p></div><h2 id="g:3">Miscellaneous</h2><div class="top"><p class="src"><a name="v:getVersion" class="def">getVersion</a> :: <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-String.html#t:String">String</a></p><div class="doc"><p>return version of pcre used or Nothing if pcre is not available.</p></div></div><div class="top"><p class="src"><a name="v:configUTF8" class="def">configUTF8</a> :: <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Bool.html#t:Bool">Bool</a></p></div><div class="top"><p class="src"><a name="v:getNumSubs" class="def">getNumSubs</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:Regex">Regex</a> -> <a href="file:///usr/local/Cellar/ghc/7.10.1/share/doc/ghc/html/libraries/base-4.8.0.0/Data-Int.html#t:Int">Int</a></p></div><div class="top"><p class="src"><a name="v:unusedOffset" class="def">unusedOffset</a> :: <a href="Text-Regex-PCRE-String.html#t:MatchOffset">MatchOffset</a></p></div><h2 id="g:4">CompOption values</h2><div class="top"><p class="src"><a name="v:compBlank" class="def">compBlank</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compAnchored" class="def">compAnchored</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compAutoCallout" class="def">compAutoCallout</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compCaseless" class="def">compCaseless</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compDollarEndOnly" class="def">compDollarEndOnly</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compDotAll" class="def">compDotAll</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compExtended" class="def">compExtended</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compExtra" class="def">compExtra</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compFirstLine" class="def">compFirstLine</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compMultiline" class="def">compMultiline</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compNoAutoCapture" class="def">compNoAutoCapture</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compUngreedy" class="def">compUngreedy</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compUTF8" class="def">compUTF8</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><div class="top"><p class="src"><a name="v:compNoUTF8Check" class="def">compNoUTF8Check</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></p></div><h2 id="g:5">ExecOption values</h2><div class="top"><p class="src"><a name="v:execBlank" class="def">execBlank</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></p></div><div class="top"><p class="src"><a name="v:execAnchored" class="def">execAnchored</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></p></div><div class="top"><p class="src"><a name="v:execNotBOL" class="def">execNotBOL</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></p></div><div class="top"><p class="src"><a name="v:execNotEOL" class="def">execNotEOL</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></p></div><div class="top"><p class="src"><a name="v:execNotEmpty" class="def">execNotEmpty</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></p></div><div class="top"><p class="src"><a name="v:execNoUTF8Check" class="def">execNoUTF8Check</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></p></div><div class="top"><p class="src"><a name="v:execPartial" class="def">execPartial</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></p></div><h2 id="g:6">ReturnCode values</h2><div class="top"><p class="src"><a name="v:retOk" class="def">retOk</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></p></div><div class="top"><p class="src"><a name="v:retNoMatch" class="def">retNoMatch</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></p></div><div class="top"><p class="src"><a name="v:retNull" class="def">retNull</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></p></div><div class="top"><p class="src"><a name="v:retBadOption" class="def">retBadOption</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></p></div><div class="top"><p class="src"><a name="v:retBadMagic" class="def">retBadMagic</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></p></div><div class="top"><p class="src"><a name="v:retUnknownNode" class="def">retUnknownNode</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></p></div><div class="top"><p class="src"><a name="v:retNoMemory" class="def">retNoMemory</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></p></div><div class="top"><p class="src"><a name="v:retNoSubstring" class="def">retNoSubstring</a> :: <a href="Text-Regex-PCRE-Wrap.html#t:ReturnCode">ReturnCode</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.0</p></div></body></html> |