<!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.Base.RegexLike</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-Base-RegexLike.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-base-0.72.0.2: 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.Base.RegexLike</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>non-portable (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"
>Type aliases
</A
></DT
><DT
><A HREF="#2"
>Data types
</A
></DT
><DT
><A HREF="#3"
>Classes
</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
>Classes and instances for Regex matching.
</P
><P
>All the classes are declared here, and some common type aliases, and
the MatchResult data type.
</P
><P
>The only instances here are for Extract String and Extract ByteString.
There are no data values. The <TT
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
></TT
> instances are in
<A HREF="Text-Regex-Base-Context.html"
>Text.Regex.Base.Context</A
>, except for ones which run afoul of a
repeated variable (RegexContext regex a a), which are defined in each
modules' String and ByteString modules.
</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"
>type</SPAN
> <A HREF="#t%3AMatchOffset"
>MatchOffset</A
> = <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A HREF="#t%3AMatchLength"
>MatchLength</A
> = <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A HREF="#t%3AMatchArray"
>MatchArray</A
> = <A HREF="../base/GHC-Arr.html#t%3AArray"
>Array</A
> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> (<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchOffset"
>MatchOffset</A
>, <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchLength"
>MatchLength</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A HREF="#t%3AMatchText"
>MatchText</A
> source = <A HREF="../base/GHC-Arr.html#t%3AArray"
>Array</A
> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> (source, (<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchOffset"
>MatchOffset</A
>, <A HREF="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%3AMatchResult"
>MatchResult</A
> a = <A HREF="#v%3AMR"
>MR</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AmrBefore"
>mrBefore</A
> :: a</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AmrMatch"
>mrMatch</A
> :: a</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AmrAfter"
>mrAfter</A
> :: a</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AmrSubList"
>mrSubList</A
> :: [a]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AmrSubs"
>mrSubs</A
> :: <A HREF="../base/GHC-Arr.html#t%3AArray"
>Array</A
> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> a</TD
></TR
></TABLE
>}</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A HREF="#t%3ARegexOptions"
>RegexOptions</A
> regex compOpt execOpt | regex -> compOpt execOpt, compOpt -> regex execOpt, execOpt -> regex compOpt <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3AblankCompOpt"
>blankCompOpt</A
> :: compOpt</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AblankExecOpt"
>blankExecOpt</A
> :: execOpt</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdefaultCompOpt"
>defaultCompOpt</A
> :: compOpt</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdefaultExecOpt"
>defaultExecOpt</A
> :: execOpt</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsetExecOpts"
>setExecOpts</A
> :: execOpt -> regex -> regex</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetExecOpts"
>getExecOpts</A
> :: regex -> execOpt</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexOptions"
>RegexOptions</A
> regex compOpt execOpt => <A HREF="#t%3ARegexMaker"
>RegexMaker</A
> regex compOpt execOpt source | regex -> compOpt execOpt, compOpt -> regex execOpt, execOpt -> regex compOpt <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3AmakeRegex"
>makeRegex</A
> :: source -> regex</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AmakeRegexOpts"
>makeRegexOpts</A
> :: compOpt -> execOpt -> source -> regex</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A HREF="Text-Regex-Base-RegexLike.html#t%3AExtract"
>Extract</A
> source => <A HREF="#t%3ARegexLike"
>RegexLike</A
> regex source <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3AmatchAll"
>matchAll</A
> :: regex -> source -> [<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchArray"
>MatchArray</A
>]</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AmatchOnce"
>matchOnce</A
> :: regex -> source -> <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchArray"
>MatchArray</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AmatchCount"
>matchCount</A
> :: regex -> source -> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AmatchTest"
>matchTest</A
> :: regex -> source -> <A HREF="../ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AmatchAllText"
>matchAllText</A
> :: regex -> source -> [<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchText"
>MatchText</A
> source]</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AmatchOnceText"
>matchOnceText</A
> :: regex -> source -> <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> (source, <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchText"
>MatchText</A
> source, source)</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> regex source => <A HREF="#t%3ARegexContext"
>RegexContext</A
> regex source target <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3Amatch"
>match</A
> :: regex -> source -> target</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AmatchM"
>matchM</A
> :: <A HREF="../base/Control-Monad.html#t%3AMonad"
>Monad</A
> m => regex -> source -> m target</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A HREF="#t%3AExtract"
>Extract</A
> source <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3Abefore"
>before</A
> :: <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> -> source -> source</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aafter"
>after</A
> :: <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> -> source -> source</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aempty"
>empty</A
> :: source</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aextract"
>extract</A
> :: (<A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
>, <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
>) -> source -> source</TD
></TR
></TABLE
></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"
>Type aliases
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t:MatchOffset"
><A NAME="t%3AMatchOffset"
></A
></A
><B
>MatchOffset</B
> = <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="doc"
>0 based index from start of source, or (-1) for unused
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t:MatchLength"
><A NAME="t%3AMatchLength"
></A
></A
><B
>MatchLength</B
> = <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="doc"
>non-negative length of a match
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t:MatchArray"
><A NAME="t%3AMatchArray"
></A
></A
><B
>MatchArray</B
> = <A HREF="../base/GHC-Arr.html#t%3AArray"
>Array</A
> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> (<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchOffset"
>MatchOffset</A
>, <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchLength"
>MatchLength</A
>)</TD
></TR
><TR
><TD CLASS="doc"
>0 based array, with 0th index indicating the full match. If the
full match location is not available, represent as (0,0).
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t:MatchText"
><A NAME="t%3AMatchText"
></A
></A
><B
>MatchText</B
> source = <A HREF="../base/GHC-Arr.html#t%3AArray"
>Array</A
> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> (source, (<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchOffset"
>MatchOffset</A
>, <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchLength"
>MatchLength</A
>))</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="2"
><A NAME="2"
>Data types
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A NAME="t:MatchResult"
><A NAME="t%3AMatchResult"
></A
></A
><B
>MatchResult</B
> a </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>This is the same as the type from JRegex.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:MR"
><A NAME="v%3AMR"
></A
></A
><B
>MR</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:mrBefore"
><A NAME="v%3AmrBefore"
></A
></A
><B
>mrBefore</B
> :: a</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:mrMatch"
><A NAME="v%3AmrMatch"
></A
></A
><B
>mrMatch</B
> :: a</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:mrAfter"
><A NAME="v%3AmrAfter"
></A
></A
><B
>mrAfter</B
> :: a</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:mrSubList"
><A NAME="v%3AmrSubList"
></A
></A
><B
>mrSubList</B
> :: [a]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:mrSubs"
><A NAME="v%3AmrSubs"
></A
></A
><B
>mrSubs</B
> :: <A HREF="../base/GHC-Arr.html#t%3AArray"
>Array</A
> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> a</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:MatchResult')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:MatchResult" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b (<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchResult"
>MatchResult</A
> b)</TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="3"
><A NAME="3"
>Classes
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A NAME="t:RegexOptions"
><A NAME="t%3ARegexOptions"
></A
></A
><B
>RegexOptions</B
> regex compOpt execOpt | regex -> compOpt execOpt, compOpt -> regex execOpt, execOpt -> regex compOpt <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Rather than carry them around spearately, the options for how to
execute a regex are kept as part of the regex. There are two types
of options. Those that can only be specified at compilation time
and never changed are CompOpt. Those that can be changed later and
affect how matching is performed are ExecOpt. The actually types
for these depend on the backend.
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="section4"
>Methods</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A NAME="v:blankCompOpt"
><A NAME="v%3AblankCompOpt"
></A
></A
><B
>blankCompOpt</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: compOpt</TD
><TD CLASS="rdoc"
>no options set at all in the backend
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:blankExecOpt"
><A NAME="v%3AblankExecOpt"
></A
></A
><B
>blankExecOpt</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: execOpt</TD
><TD CLASS="rdoc"
>no options set at all in the backend
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:defaultCompOpt"
><A NAME="v%3AdefaultCompOpt"
></A
></A
><B
>defaultCompOpt</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: compOpt</TD
><TD CLASS="rdoc"
>reasonable options (extended,caseSensitive,multiline regex)
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:defaultExecOpt"
><A NAME="v%3AdefaultExecOpt"
></A
></A
><B
>defaultExecOpt</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: execOpt</TD
><TD CLASS="rdoc"
>reasonable options (extended,caseSensitive,multiline regex)
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:setExecOpts"
><A NAME="v%3AsetExecOpts"
></A
></A
><B
>setExecOpts</B
> :: execOpt -> regex -> regex</TD
></TR
><TR
><TD CLASS="doc"
>forget old flags and use new ones
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:getExecOpts"
><A NAME="v%3AgetExecOpts"
></A
></A
><B
>getExecOpts</B
> :: regex -> execOpt</TD
></TR
><TR
><TD CLASS="doc"
>retrieve the current flags
</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexOptions"
>RegexOptions</A
> regex compOpt execOpt => <A NAME="t:RegexMaker"
><A NAME="t%3ARegexMaker"
></A
></A
><B
>RegexMaker</B
> regex compOpt execOpt source | regex -> compOpt execOpt, compOpt -> regex execOpt, execOpt -> regex compOpt <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>RegexMaker captures the creation of the compiled regular
expression from a source type and an option type. The <TT
><A HREF="Text-Regex-Base-RegexLike.html#v%3AmakeRegex"
>makeRegex</A
></TT
>
function has a default implementation that depends on makeRegexOpts
and used <TT
><A HREF="Text-Regex-Base-RegexLike.html#v%3AdefaultCompOpt"
>defaultCompOpt</A
></TT
> and <TT
><A HREF="Text-Regex-Base-RegexLike.html#v%3AdefaultExecOpt"
>defaultExecOpt</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="section4"
>Methods</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A NAME="v:makeRegex"
><A NAME="v%3AmakeRegex"
></A
></A
><B
>makeRegex</B
> :: source -> regex</TD
></TR
><TR
><TD CLASS="doc"
>make using the defaultCompOpt and defaultExecOpt
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:makeRegexOpts"
><A NAME="v%3AmakeRegexOpts"
></A
></A
><B
>makeRegexOpts</B
> :: compOpt -> execOpt -> source -> regex</TD
></TR
><TR
><TD CLASS="doc"
>Specify your own options
</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A HREF="Text-Regex-Base-RegexLike.html#t%3AExtract"
>Extract</A
> source => <A NAME="t:RegexLike"
><A NAME="t%3ARegexLike"
></A
></A
><B
>RegexLike</B
> regex source <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><P
>RegexLike is parametrized on a regular expression type and a
source type to run the matching on.
</P
><P
>There are default implementations: matchTest and matchOnceText
using matchOnce; matchCount and matchAllText using
matchAll. matchOnce uses matchOnceText and matchAll uses
matchAllText. So a minimal complete instance need to provide
(matchOnce or matchOnceText) and (matchAll or matchAllText).
</P
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="section4"
>Methods</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A NAME="v:matchAll"
><A NAME="v%3AmatchAll"
></A
></A
><B
>matchAll</B
> :: regex -> source -> [<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchArray"
>MatchArray</A
>]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:matchOnce"
><A NAME="v%3AmatchOnce"
></A
></A
><B
>matchOnce</B
> :: regex -> source -> <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchArray"
>MatchArray</A
></TD
></TR
><TR
><TD CLASS="doc"
>This can return an array of (offset,length) index pairs for the
match and captured substrings.
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:matchCount"
><A NAME="v%3AmatchCount"
></A
></A
><B
>matchCount</B
> :: regex -> source -> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:matchTest"
><A NAME="v%3AmatchTest"
></A
></A
><B
>matchTest</B
> :: regex -> source -> <A HREF="../ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:matchAllText"
><A NAME="v%3AmatchAllText"
></A
></A
><B
>matchAllText</B
> :: regex -> source -> [<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchText"
>MatchText</A
> source]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:matchOnceText"
><A NAME="v%3AmatchOnceText"
></A
></A
><B
>matchOnceText</B
> :: regex -> source -> <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> (source, <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchText"
>MatchText</A
> source, source)</TD
></TR
><TR
><TD CLASS="doc"
>This can return a tuple of three items: the source before the
match, an array of the match and captured substrings (with their
indices), and the source after the match.
</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> regex source => <A NAME="t:RegexContext"
><A NAME="t%3ARegexContext"
></A
></A
><B
>RegexContext</B
> regex source target <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>RegexContext is the polymorphic interface to do matching
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="section4"
>Methods</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A NAME="v:match"
><A NAME="v%3Amatch"
></A
></A
><B
>match</B
> :: regex -> source -> target</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:matchM"
><A NAME="v%3AmatchM"
></A
></A
><B
>matchM</B
> :: <A HREF="../base/Control-Monad.html#t%3AMonad"
>Monad</A
> m => regex -> source -> m target</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:RegexContext')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:RegexContext" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchArray"
>MatchArray</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b <A HREF="../ghc-prim/GHC-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b ([] ([] b))</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b ([] (<A HREF="../base/GHC-Arr.html#t%3AArray"
>Array</A
> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> b))</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b ([] b)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b ([] (<A HREF="../ghc-prim/GHC-Tuple.html#t%3A%28%2C%29"
>(,)</A
> <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchOffset"
>MatchOffset</A
> <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchLength"
>MatchLength</A
>))</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b ([] (<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchText"
>MatchText</A
> b))</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b ([] <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchArray"
>MatchArray</A
>)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b (<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchResult"
>MatchResult</A
> b)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b (<A HREF="../base/GHC-Arr.html#t%3AArray"
>Array</A
> <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> b)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b (<A HREF="../ghc-prim/GHC-Tuple.html#t%3A%28%2C%29"
>(,)</A
> <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchOffset"
>MatchOffset</A
> <A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchLength"
>MatchLength</A
>)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b (<A HREF="../ghc-prim/GHC-Tuple.html#t%3A%28%2C%2C%29"
>(,,)</A
> b b b)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b (<A HREF="../ghc-prim/GHC-Tuple.html#t%3A%28%2C%2C%29"
>(,,)</A
> b (<A HREF="Text-Regex-Base-RegexLike.html#t%3AMatchText"
>MatchText</A
> b) b)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexLike"
>RegexLike</A
> a b => <A HREF="Text-Regex-Base-RegexLike.html#t%3ARegexContext"
>RegexContext</A
> a b (<A HREF="../ghc-prim/GHC-Tuple.html#t%3A%28%2C%2C%2C%29"
>(,,,)</A
> b b b ([] b))</TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
> <A NAME="t:Extract"
><A NAME="t%3AExtract"
></A
></A
><B
>Extract</B
> source <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Extract allows for indexing operations on String or ByteString.
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="section4"
>Methods</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A NAME="v:before"
><A NAME="v%3Abefore"
></A
></A
><B
>before</B
> :: <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> -> source -> source</TD
></TR
><TR
><TD CLASS="doc"
>before is a renamed <A HREF="take.html"
>take</A
>
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:after"
><A NAME="v%3Aafter"
></A
></A
><B
>after</B
> :: <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
> -> source -> source</TD
></TR
><TR
><TD CLASS="doc"
>after is a renamed <A HREF="drop.html"
>drop</A
>
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:empty"
><A NAME="v%3Aempty"
></A
></A
><B
>empty</B
> :: source</TD
></TR
><TR
><TD CLASS="doc"
>For when there is no match, this can construct an empty data value
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:extract"
><A NAME="v%3Aextract"
></A
></A
><B
>extract</B
> :: (<A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
>, <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
>) -> source -> source</TD
></TR
><TR
><TD CLASS="doc"
>extract takes an offset and length and has a default
implementation of <TT
>extract (off,len) source = before len (after
off source)</TT
>
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Extract')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Extract" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3AExtract"
>Extract</A
> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-Regex-Base-RegexLike.html#t%3AExtract"
>Extract</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="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.4.2</TD
></TR
></TABLE
></BODY
></HTML
>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
70ec89744a04da80369b4702b2c37256
>
files
>
1652
