Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 1f2b142b9d2ef4849a6f5316fa1c5b12 > files > 2823

ghc-6.10.4-1mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Text.Regex.Posix.ByteString</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Text-Regex-Posix-ByteString.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>regex-posix-0.72.0.3: Replaces/Enhances Text.Regex</TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Text.Regex.Posix.ByteString</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>non-portable (regex-base needs MPTC+FD)</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>experimental</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>libraries@haskell.org, textregexlazy@personal.mightyreason.com</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>Types
</A
></DT
><DT
><A HREF="#2"
>Miscellaneous
</A
></DT
><DT
><A HREF="#3"
>Medium level API functions
</A
></DT
><DT
><A HREF="#4"
>Compilation options
</A
></DT
><DT
><A HREF="#5"
>Execution options
</A
></DT
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>This provides <TT
><A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
></TT
> instances for RegexMaker and RegexLike
 based on <A HREF="Text-Regex-Posix-Wrap.html"
>Text.Regex.Posix.Wrap</A
>, and a (RegexContext Regex
 ByteString ByteString) instance.
</P
><P
>To use these instance, you would normally import
 <A HREF="Text-Regex-Posix.html"
>Text.Regex.Posix</A
>.  You only need to import this module to use
 the medium level API of the compile, regexec, and execute
 functions.  All of these report error by returning Left values
 instead of undefined or error or fail.
</P
><P
>The ByteString will only be passed to the library efficiently (as a
 pointer) if it ends in a NUL byte.  Otherwise a temporary copy must
 be made with the 0 byte appended.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3ARegex"
>Regex</A
> </TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3AMatchOffset"
>MatchOffset</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3AMatchLength"
>MatchLength</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AReturnCode"
>ReturnCode</A
> </TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A HREF="#t%3AWrapError"
>WrapError</A
> = (<A HREF="Text-Regex-Posix-ByteString.html#t%3AReturnCode"
>ReturnCode</A
>, <A HREF="../base/Data-Char.html#t%3AString"
>String</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AunusedOffset"
>unusedOffset</A
> :: <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Acompile"
>compile</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
> -&gt; <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
> -&gt; <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="../base/Data-Either.html#t%3AEither"
>Either</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AWrapError"
>WrapError</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aexecute"
>execute</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> -&gt; <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="../base/Data-Either.html#t%3AEither"
>Either</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AWrapError"
>WrapError</A
> (<A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> (<A HREF="../base/GHC-Arr.html#t%3AArray"
>Array</A
> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> (<A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3AMatchOffset"
>MatchOffset</A
>, <A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3AMatchLength"
>MatchLength</A
>))))</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aregexec"
>regexec</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> -&gt; <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="../base/Data-Either.html#t%3AEither"
>Either</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AWrapError"
>WrapError</A
> (<A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> (<A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
>, <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
>, <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
>, [<A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
>])))</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>newtype</SPAN
>  <A HREF="#t%3ACompOption"
>CompOption</A
>  = <A HREF="#v%3ACompOption"
>CompOption</A
> <A HREF="../base/Foreign-C-Types.html#t%3ACInt"
>CInt</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcompBlank"
>compBlank</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcompExtended"
>compExtended</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcompIgnoreCase"
>compIgnoreCase</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcompNoSub"
>compNoSub</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcompNewline"
>compNewline</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>newtype</SPAN
>  <A HREF="#t%3AExecOption"
>ExecOption</A
>  = <A HREF="#v%3AExecOption"
>ExecOption</A
> <A HREF="../base/Foreign-C-Types.html#t%3ACInt"
>CInt</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AexecBlank"
>execBlank</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AexecNotBOL"
>execNotBOL</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AexecNotEOL"
>execNotEOL</A
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="1"
><A NAME="1"
>Types
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:Regex"
><A NAME="t%3ARegex"
></A
></A
><B
>Regex</B
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>A compiled regular expression.
</TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Regex')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Regex" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexOptions"
>RegexOptions</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
> <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexMaker"
>RegexMaker</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexMaker"
>RegexMaker</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
> <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3AMatchOffset"
>MatchOffset</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3AMatchLength"
>MatchLength</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:ReturnCode"
><A NAME="t%3AReturnCode"
></A
></A
><B
>ReturnCode</B
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><P
>ReturnCode is an enumerated <TT
><A HREF="../base/Foreign-C-Types.html#t%3ACInt"
>CInt</A
></TT
>, corresponding to the error codes
 from <TT
>man 3 regex</TT
>:
</P
><UL
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretBadbr"
>retBadbr</A
></TT
> (<TT
>REG_BADBR</TT
>) invalid repetition count(s) in <TT
>{ }</TT
>
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretBadpat"
>retBadpat</A
></TT
> (<TT
>REG_BADPAT</TT
>) invalid regular expression
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretBadrpt"
>retBadrpt</A
></TT
> (<TT
>REG_BADRPT</TT
>) <TT
>?</TT
>, <TT
>*</TT
>, or <TT
>+</TT
> operand invalid
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretEcollate"
>retEcollate</A
></TT
> (<TT
>REG_ECOLLATE</TT
>) invalid collating element
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretEctype"
>retEctype</A
></TT
> (<TT
>REG_ECTYPE</TT
>) invalid character class
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretEescape"
>retEescape</A
></TT
> (<TT
>REG_EESCAPE</TT
>) <TT
>\</TT
> applied to unescapable character
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretEsubreg"
>retEsubreg</A
></TT
> (<TT
>REG_ESUBREG</TT
>) invalid backreference number
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretEbrack"
>retEbrack</A
></TT
> (<TT
>REG_EBRACK</TT
>) brackets <TT
>[ ]</TT
> not balanced
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretEparen"
>retEparen</A
></TT
> (<TT
>REG_EPAREN</TT
>) parentheses <TT
>( )</TT
> not balanced
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretEbrace"
>retEbrace</A
></TT
> (<TT
>REG_EBRACE</TT
>) braces <TT
>{ }</TT
> not balanced
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretErange"
>retErange</A
></TT
> (<TT
>REG_ERANGE</TT
>) invalid character range in <TT
>[ ]</TT
>
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-Wrap.html#v%3AretEspace"
>retEspace</A
></TT
> (<TT
>REG_ESPACE</TT
>) ran out of memory
</LI
><LI
> <TT
>retNoMatch</TT
> (<TT
>REG_NOMATCH</TT
>) The regexec() function failed to match
</LI
></UL
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:ReturnCode')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:ReturnCode" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="../base/Data-Eq.html#t%3AEq"
>Eq</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AReturnCode"
>ReturnCode</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AReturnCode"
>ReturnCode</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t:WrapError"
><A NAME="t%3AWrapError"
></A
></A
><B
>WrapError</B
> = (<A HREF="Text-Regex-Posix-ByteString.html#t%3AReturnCode"
>ReturnCode</A
>, <A HREF="../base/Data-Char.html#t%3AString"
>String</A
>)</TD
></TR
><TR
><TD CLASS="doc"
>The return code will be retOk when it is the Haskell wrapper and
 not the underlying library generating the error message.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="2"
><A NAME="2"
>Miscellaneous
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:unusedOffset"
><A NAME="v%3AunusedOffset"
></A
></A
><B
>unusedOffset</B
> :: <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="3"
><A NAME="3"
>Medium level API functions
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:compile"
><A NAME="v%3Acompile"
></A
></A
><B
>compile</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
><TD CLASS="rdoc"
>Flags (summed together)
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
><TD CLASS="rdoc"
>Flags (summed together)
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
></TD
><TD CLASS="rdoc"
>The regular expression to compile
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="../base/Data-Either.html#t%3AEither"
>Either</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AWrapError"
>WrapError</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
>)</TD
><TD CLASS="rdoc"
>Returns: the compiled regular expression
</TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>Compiles a regular expression
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:execute"
><A NAME="v%3Aexecute"
></A
></A
><B
>execute</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
></TD
><TD CLASS="rdoc"
>Compiled regular expression
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
></TD
><TD CLASS="rdoc"
>String to match against
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="../base/Data-Either.html#t%3AEither"
>Either</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AWrapError"
>WrapError</A
> (<A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> (<A HREF="../base/GHC-Arr.html#t%3AArray"
>Array</A
> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> (<A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3AMatchOffset"
>MatchOffset</A
>, <A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3AMatchLength"
>MatchLength</A
>))))</TD
><TD CLASS="rdoc"
>Returns: <TT
><A HREF="../base/Data-Maybe.html#v%3ANothing"
>Nothing</A
></TT
> if the regex did not match the
 string, or:
   <TT
><A HREF="../base/Data-Maybe.html#v%3AJust"
>Just</A
></TT
> an array of (offset,length) pairs where index 0 is whole match, and the rest are the captured subexpressions.
</TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
><P
>Matches a regular expression against a buffer, returning the buffer
 indicies of the match, and any submatches
</P
><P
>| Matches a regular expression against a string
</P
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:regexec"
><A NAME="v%3Aregexec"
></A
></A
><B
>regexec</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
></TD
><TD CLASS="rdoc"
>Compiled regular expression
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
></TD
><TD CLASS="rdoc"
>String to match against
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="../base/Data-Either.html#t%3AEither"
>Either</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AWrapError"
>WrapError</A
> (<A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> (<A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
>, <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
>, <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
>, [<A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
>])))</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="4"
><A NAME="4"
>Compilation options
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>newtype</SPAN
>  <A NAME="t:CompOption"
><A NAME="t%3ACompOption"
></A
></A
><B
>CompOption</B
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><P
>A bitmapped <TT
><A HREF="../base/Foreign-C-Types.html#t%3ACInt"
>CInt</A
></TT
> containing options for compilation of regular
 expressions.  Option values (and their man 3 regcomp names) are
</P
><UL
><LI
> <TT
><A HREF="Text-Regex-Posix-ByteString.html#v%3AcompBlank"
>compBlank</A
></TT
> which is a completely zero value for all the flags.
    This is also the <TT
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#v%3AblankCompOpt"
>blankCompOpt</A
></TT
> value.
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-ByteString.html#v%3AcompExtended"
>compExtended</A
></TT
> (REG_EXTENDED) which can be set to use extended instead
    of basic regular expressions.
    This is set in the <TT
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#v%3AdefaultCompOpt"
>defaultCompOpt</A
></TT
> value.
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-ByteString.html#v%3AcompNewline"
>compNewline</A
></TT
> (REG_NEWLINE) turns on newline sensitivity: The dot (.)
    and inverted set <TT
>[^ ]</TT
> never match newline, and ^ and $ anchors do
    match after and before newlines.
    This is set in the <TT
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#v%3AdefaultCompOpt"
>defaultCompOpt</A
></TT
> value.
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-ByteString.html#v%3AcompIgnoreCase"
>compIgnoreCase</A
></TT
> (REG_ICASE) which can be set to match ignoring upper
    and lower distinctions.
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-ByteString.html#v%3AcompNoSub"
>compNoSub</A
></TT
> (REG_NOSUB) which turns off all information from matching
    except whether a match exists.
</LI
></UL
></TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:CompOption"
><A NAME="v%3ACompOption"
></A
></A
><B
>CompOption</B
> <A HREF="../base/Foreign-C-Types.html#t%3ACInt"
>CInt</A
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:CompOption')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:CompOption" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="../base/Data-Eq.html#t%3AEq"
>Eq</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base/Prelude.html#t%3ANum"
>Num</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base/Data-Bits.html#t%3ABits"
>Bits</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexOptions"
>RegexOptions</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexMaker"
>RegexMaker</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexMaker"
>RegexMaker</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
> <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:compBlank"
><A NAME="v%3AcompBlank"
></A
></A
><B
>compBlank</B
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="doc"
>A completely zero value for all the flags.
 This is also the <TT
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#v%3AblankCompOpt"
>blankCompOpt</A
></TT
> value.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:compExtended"
><A NAME="v%3AcompExtended"
></A
></A
><B
>compExtended</B
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:compIgnoreCase"
><A NAME="v%3AcompIgnoreCase"
></A
></A
><B
>compIgnoreCase</B
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:compNoSub"
><A NAME="v%3AcompNoSub"
></A
></A
><B
>compNoSub</B
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:compNewline"
><A NAME="v%3AcompNewline"
></A
></A
><B
>compNewline</B
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="5"
><A NAME="5"
>Execution options
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>newtype</SPAN
>  <A NAME="t:ExecOption"
><A NAME="t%3AExecOption"
></A
></A
><B
>ExecOption</B
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><P
>A bitmapped <TT
><A HREF="../base/Foreign-C-Types.html#t%3ACInt"
>CInt</A
></TT
> containing options for execution of compiled
 regular expressions.  Option values (and their man 3 regexec names) are
</P
><UL
><LI
> <TT
><A HREF="Text-Regex-Posix-ByteString.html#v%3AexecBlank"
>execBlank</A
></TT
> which is a complete zero value for all the flags.  This is
    the blankExecOpt value.
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-ByteString.html#v%3AexecNotBOL"
>execNotBOL</A
></TT
> (REG_NOTBOL) can be set to prevent ^ from matching at the
    start of the input.
</LI
><LI
> <TT
><A HREF="Text-Regex-Posix-ByteString.html#v%3AexecNotEOL"
>execNotEOL</A
></TT
> (REG_NOTEOL) can be set to prevent $ from matching at the
    end of the input (before the terminating NUL).
</LI
></UL
></TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:ExecOption"
><A NAME="v%3AExecOption"
></A
></A
><B
>ExecOption</B
> <A HREF="../base/Foreign-C-Types.html#t%3ACInt"
>CInt</A
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:ExecOption')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:ExecOption" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="../base/Data-Eq.html#t%3AEq"
>Eq</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base/Prelude.html#t%3ANum"
>Num</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base/Data-Bits.html#t%3ABits"
>Bits</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexOptions"
>RegexOptions</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexMaker"
>RegexMaker</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#t%3ARegexMaker"
>RegexMaker</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ARegex"
>Regex</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3ACompOption"
>CompOption</A
> <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
> <A HREF="../bytestring/Data-ByteString-Internal.html#t%3AByteString"
>ByteString</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:execBlank"
><A NAME="v%3AexecBlank"
></A
></A
><B
>execBlank</B
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="doc"
>A completely zero value for all the flags.
 This is also the <TT
><A HREF="../regex-base/Text-Regex-Base-RegexLike.html#v%3AblankExecOpt"
>blankExecOpt</A
></TT
> value.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:execNotBOL"
><A NAME="v%3AexecNotBOL"
></A
></A
><B
>execNotBOL</B
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:execNotEOL"
><A NAME="v%3AexecNotEOL"
></A
></A
><B
>execNotEOL</B
> :: <A HREF="Text-Regex-Posix-ByteString.html#t%3AExecOption"
>ExecOption</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.4.2</TD
></TR
></TABLE
></BODY
></HTML
>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional