/usr/share/doc/libghc-regex-pcre-doc/html/Text-Regex-PCRE.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</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Text-Regex-PCRE.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Text-Regex-PCRE.html">Source</a></li><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</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Wrap, for <code>=~</code> and <code>=~~</code>, types and constants</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The <a href="Text-Regex-PCRE.html">Text.Regex.PCRE</a> module provides a backend for regular
expressions.  If you import this along with other backends, then
you should do so with qualified imports, perhaps renamed for
convenience.</p><p>You will need to have libpcre, from www.pcre.org, to use
this module.  The haskell must be compiled with -DHAVE_PCRE_H and
linked with pcre.  This is the default in the cabal file.</p><p>If you do not compile with HAVE_PCRE_H then the functions will still
exist, but using them will create a run time error.  You can test for
the existance of PCRE by checking <code><a href="Text-Regex-PCRE-Wrap.html#v:getVersion">getVersion</a></code> which is <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if
not compiled with PCRE or <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Maybe.html#v:Just">Just</a></code> <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a></code> if PCRE is present.</p><p>Using the provided <code><a href="Text-Regex-PCRE-Wrap.html#t:CompOption">CompOption</a></code> and <code><a href="Text-Regex-PCRE-Wrap.html#t:ExecOption">ExecOption</a></code> values and if
<code><a href="Text-Regex-PCRE-Wrap.html#v:configUTF8">configUTF8</a></code> is True, then you might be able to send UTF8 encoded
ByteStrings to PCRE and get sensible results.  This is currently
untested.</p><p>The regular expression can be provided as a <code>ByteString</code>, but it will
be copied and a NUL byte appended to make a <code>CString</code> unless such a
byte is already present.  Thus the regular expression cannot contain
an explicit NUL byte. The search string is passed as a <code>CStringLen</code>
and may contain NUL bytes and does not need to end in a NUL
byte. <code>ByteString</code>s are searched in place (via unsafeUseAsCStringLen).</p><p>A <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a></code> will be converted into a <code>CString</code> or <code>CStringLen</code> for
processing.  Doing this repeatedly will be very inefficient.</p><p>The <a href="Text-Regex-PCRE-String.html">Text.Regex.PCRE.String</a>, <a href="Text-Regex-PCRE-ByteString.html">Text.Regex.PCRE.ByteString</a>, and
<a href="Text-Regex-PCRE-Wrap.html">Text.Regex.PCRE.Wrap</a> modules provides both the high level interface
exported by this module and medium- and low-level interfaces that
returns error using Either structures.</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"><a href="#v:getVersion_Text_Regex_PCRE">getVersion_Text_Regex_PCRE</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Version.html#t:Version">Version</a></li><li class="src short">module <a href="file:///usr/share/doc/libghc-regex-base-doc/html/Text-Regex-Base.html">Text.Regex.Base</a></li><li class="src short">module <a href="Text-Regex-PCRE-Wrap.html">Text.Regex.PCRE.Wrap</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:getVersion_Text_Regex_PCRE" class="def">getVersion_Text_Regex_PCRE</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Version.html#t:Version">Version</a> <a href="src/Text-Regex-PCRE.html#getVersion_Text_Regex_PCRE" class="link">Source</a> <a href="#v:getVersion_Text_Regex_PCRE" class="selflink">#</a></p></div><div class="top"><p class="src">module <a href="file:///usr/share/doc/libghc-regex-base-doc/html/Text-Regex-Base.html">Text.Regex.Base</a></p></div><h2 id="g:1">Wrap, for <code><a href="Text-Regex-PCRE-Wrap.html#v:-61--126-">=~</a></code> and <code><a href="Text-Regex-PCRE-Wrap.html#v:-61--126--126-">=~~</a></code>, types and constants</h2><div class="top"><p class="src">module <a href="Text-Regex-PCRE-Wrap.html">Text.Regex.PCRE.Wrap</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html>
libghc-regex-pcre-doc 0.94.4-9 / usr / share / doc / libghc-regex-pcre-doc / html / Text-Regex-PCRE.html
