Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > c97e5283ec2813fd0eb55be8bea536e2 > files > 37

ghc-pcre-light-devel-0.4-4.fc14.x86_64.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>dist/build/Text/Regex/PCRE/Light/Base.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LINE 1 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE CPP, ForeignFunctionInterface, GeneralizedNewtypeDeriving #-}</span>
<a name="line-3"></a><span class='hs-comment'>{-# LINE 2 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-4"></a><span class='hs-comment'>--------------------------------------------------------------------</span>
<a name="line-5"></a><span class='hs-comment'>-- |</span>
<a name="line-6"></a><span class='hs-comment'>-- Module   : Text.Regex.PCRE.Light.Base</span>
<a name="line-7"></a><span class='hs-comment'>-- Copyright: Copyright (c) 2007-2008, Don Stewart</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- Documentation based on /man pcreapi/, written by Philip Hazel, 2007.</span>
<a name="line-10"></a><span class='hs-comment'>--</span>
<a name="line-11"></a><span class='hs-comment'>-- License   : BSD3</span>
<a name="line-12"></a><span class='hs-comment'>-- Maintainer:  Don Stewart &lt;dons@galois.com&gt;</span>
<a name="line-13"></a><span class='hs-comment'>-- Stability :  experimental</span>
<a name="line-14"></a><span class='hs-comment'>-- Portability: CPP, FFI</span>
<a name="line-15"></a><span class='hs-comment'>-- Tested with: GHC 6.8.2</span>
<a name="line-16"></a><span class='hs-comment'>--</span>
<a name="line-17"></a><span class='hs-comment'>-- Raw FFI bindings to PCRE functions and constants. </span>
<a name="line-18"></a><span class='hs-comment'>--</span>
<a name="line-19"></a>
<a name="line-20"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Regex</span><span class='hs-varop'>.</span><span class='hs-conid'>PCRE</span><span class='hs-varop'>.</span><span class='hs-conid'>Light</span><span class='hs-varop'>.</span><span class='hs-conid'>Base</span> <span class='hs-layout'>(</span>
<a name="line-21"></a>
<a name="line-22"></a>        <span class='hs-comment'>-- * A PCRE structure</span>
<a name="line-23"></a>          <span class='hs-conid'>PCRE</span>
<a name="line-24"></a>        <span class='hs-layout'>,</span> <span class='hs-conid'>Regex</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-25"></a>
<a name="line-26"></a>        <span class='hs-comment'>-- * C exports</span>
<a name="line-27"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>c_pcre_compile</span>
<a name="line-28"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>c_pcre_exec</span>
<a name="line-29"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>c_pcre_fullinfo</span>
<a name="line-30"></a>
<a name="line-31"></a>        <span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-32"></a>
<a name="line-33"></a>        <span class='hs-comment'>-- * PCRE Options, an abstract newtyped Num wrapper over a CInt</span>
<a name="line-34"></a>        <span class='hs-layout'>,</span> <span class='hs-conid'>PCREOption</span>
<a name="line-35"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>combineOptions</span>
<a name="line-36"></a>
<a name="line-37"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>anchored</span> <span class='hs-layout'>,</span> <span class='hs-varid'>auto_callout</span> <span class='hs-comment'>{-, bsr_anycrlf-}</span>
<a name="line-38"></a>        <span class='hs-comment'>{-, bsr_unicode-}</span> <span class='hs-layout'>,</span> <span class='hs-varid'>caseless</span> <span class='hs-layout'>,</span> <span class='hs-varid'>dollar_endonly</span>
<a name="line-39"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>dotall</span> <span class='hs-layout'>,</span> <span class='hs-varid'>dupnames</span> <span class='hs-layout'>,</span> <span class='hs-varid'>extended</span>
<a name="line-40"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>extra</span> <span class='hs-layout'>,</span> <span class='hs-varid'>firstline</span> <span class='hs-layout'>,</span> <span class='hs-varid'>multiline</span>
<a name="line-41"></a>        <span class='hs-comment'>{-, newline_any-}</span> <span class='hs-comment'>{-, newline_anycrlf-}</span> <span class='hs-layout'>,</span> <span class='hs-varid'>newline_cr</span>
<a name="line-42"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>newline_crlf</span> <span class='hs-layout'>,</span> <span class='hs-varid'>newline_lf</span> <span class='hs-layout'>,</span> <span class='hs-varid'>no_auto_capture</span>
<a name="line-43"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>ungreedy</span> <span class='hs-layout'>,</span> <span class='hs-varid'>utf8</span> <span class='hs-layout'>,</span> <span class='hs-varid'>no_utf8_check</span>
<a name="line-44"></a>
<a name="line-45"></a>        <span class='hs-comment'>-- * PCRE exec-time options, an abstract, newtyped Num wrapper over CInt</span>
<a name="line-46"></a>        <span class='hs-layout'>,</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-47"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>combineExecOptions</span>
<a name="line-48"></a>
<a name="line-49"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>exec_anchored</span> <span class='hs-comment'>{-, exec_newline_any , exec_newline_anycrlf-}</span>
<a name="line-50"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>exec_newline_cr</span> <span class='hs-layout'>,</span> <span class='hs-varid'>exec_newline_crlf</span> <span class='hs-layout'>,</span> <span class='hs-varid'>exec_newline_lf</span>
<a name="line-51"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>exec_notbol</span> <span class='hs-layout'>,</span> <span class='hs-varid'>exec_noteol</span> <span class='hs-layout'>,</span> <span class='hs-varid'>exec_notempty</span>
<a name="line-52"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>exec_no_utf8_check</span> <span class='hs-layout'>,</span> <span class='hs-varid'>exec_partial</span>
<a name="line-53"></a>
<a name="line-54"></a>        <span class='hs-comment'>------------------------------------------------------------------------ </span>
<a name="line-55"></a>        <span class='hs-comment'>-- * PCRE Errors</span>
<a name="line-56"></a>        <span class='hs-layout'>,</span> <span class='hs-conid'>PCREError</span>
<a name="line-57"></a>
<a name="line-58"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>error_nomatch</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_null</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_badoption</span>
<a name="line-59"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>error_badmagic</span> <span class='hs-comment'>{-, error_unknown_opcode-}</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_unknown_node</span>
<a name="line-60"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>error_nomemory</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_nosubstring</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_matchlimit</span>
<a name="line-61"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>error_callout</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_badutf8</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_badutf8_offset</span>
<a name="line-62"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>error_partial</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_badpartial</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_internal</span>
<a name="line-63"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>error_badcount</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_dfa_uitem</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_dfa_ucond</span>
<a name="line-64"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>error_dfa_umlimit</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_dfa_wssize</span> <span class='hs-layout'>,</span> <span class='hs-varid'>error_dfa_recurse</span>
<a name="line-65"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>error_recursionlimit</span> <span class='hs-comment'>{-, error_nullwslimit-}</span> <span class='hs-comment'>{-, error_badnewline-}</span>
<a name="line-66"></a>
<a name="line-67"></a>        <span class='hs-comment'>-- * PCRE Info</span>
<a name="line-68"></a>        <span class='hs-layout'>,</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-69"></a>
<a name="line-70"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>info_options</span> <span class='hs-layout'>,</span> <span class='hs-varid'>info_size</span> <span class='hs-layout'>,</span> <span class='hs-varid'>info_capturecount</span>
<a name="line-71"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>info_backrefmax</span> <span class='hs-layout'>,</span> <span class='hs-varid'>info_firstbyte</span> <span class='hs-layout'>,</span> <span class='hs-varid'>info_firstchar</span>
<a name="line-72"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>info_firsttable</span> <span class='hs-layout'>,</span> <span class='hs-varid'>info_lastliteral</span> <span class='hs-layout'>,</span> <span class='hs-varid'>info_nameentrysize</span>
<a name="line-73"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>info_namecount</span> <span class='hs-layout'>,</span> <span class='hs-varid'>info_nametable</span> <span class='hs-layout'>,</span> <span class='hs-varid'>info_studysize</span>
<a name="line-74"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>info_default_tables</span> <span class='hs-comment'>{-, info_okpartial-}</span> <span class='hs-comment'>{-, info_jchanged-}</span>
<a name="line-75"></a>        <span class='hs-comment'>{-, info_hascrorlf-}</span>
<a name="line-76"></a>
<a name="line-77"></a>        <span class='hs-comment'>-- * PCRE Configuration</span>
<a name="line-78"></a>        <span class='hs-layout'>,</span> <span class='hs-conid'>PCREConfig</span>
<a name="line-79"></a>
<a name="line-80"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>config_utf8</span> <span class='hs-layout'>,</span> <span class='hs-varid'>config_newline</span> <span class='hs-layout'>,</span> <span class='hs-varid'>config_link_size</span>
<a name="line-81"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>config_posix_malloc_threshold</span> <span class='hs-layout'>,</span> <span class='hs-varid'>config_match_limit</span>
<a name="line-82"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>config_stackrecurse</span> <span class='hs-layout'>,</span> <span class='hs-varid'>config_unicode_properties</span>
<a name="line-83"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>config_match_limit_recursion</span> <span class='hs-comment'>{-, config_bsr-}</span>
<a name="line-84"></a>
<a name="line-85"></a>        <span class='hs-comment'>-- * PCRE Extra</span>
<a name="line-86"></a>        <span class='hs-layout'>,</span> <span class='hs-conid'>PCREExtraFlags</span>
<a name="line-87"></a>
<a name="line-88"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>extra_study_data</span> <span class='hs-layout'>,</span> <span class='hs-varid'>extra_match_limit</span> <span class='hs-layout'>,</span> <span class='hs-varid'>extra_callout_data</span>
<a name="line-89"></a>        <span class='hs-layout'>,</span> <span class='hs-varid'>extra_tables</span> <span class='hs-layout'>,</span> <span class='hs-varid'>extra_match_limit_recursion</span><span class='hs-layout'>,</span>
<a name="line-90"></a>
<a name="line-91"></a>        <span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-92"></a>
<a name="line-93"></a>        <span class='hs-varid'>size_of_cint</span>
<a name="line-94"></a>
<a name="line-95"></a>    <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-96"></a>
<a name="line-97"></a><span class='hs-comment'>-- Foreigns</span>
<a name="line-98"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span>
<a name="line-99"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>Ptr</span>
<a name="line-100"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-101"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-conid'>String</span>
<a name="line-102"></a>
<a name="line-103"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Char8</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>S</span>
<a name="line-104"></a>
<a name="line-105"></a>
<a name="line-106"></a><span class='hs-comment'>{-# LINE 104 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-107"></a>
<a name="line-108"></a><a name="size_of_cint"></a><span class='hs-comment'>-- | Get sizeof CInt from hsc2hs</span>
<a name="line-109"></a><span class='hs-definition'>size_of_cint</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span>
<a name="line-110"></a><span class='hs-definition'>size_of_cint</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>4</span>
<a name="line-111"></a><span class='hs-comment'>{-# LINE 108 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-112"></a>
<a name="line-113"></a><span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-114"></a><span class='hs-comment'>-- Types</span>
<a name="line-115"></a>
<a name="line-116"></a><a name="Regex"></a><span class='hs-comment'>-- | An abstract pointer to a compiled PCRE Regex structure</span>
<a name="line-117"></a><a name="Regex"></a><span class='hs-comment'>-- The structure allocated by the PCRE library will be deallocated</span>
<a name="line-118"></a><a name="Regex"></a><span class='hs-comment'>-- automatically by the Haskell storage manager.</span>
<a name="line-119"></a><a name="Regex"></a><span class='hs-comment'>--</span>
<a name="line-120"></a><a name="Regex"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Regex</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Regex</span> <span class='hs-comment'>{-# UNPACK #-}</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>PCRE</span><span class='hs-layout'>)</span>
<a name="line-121"></a>                   <span class='hs-comment'>{-# UNPACK #-}</span> <span class='hs-varop'>!</span><span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-122"></a>        <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Ord</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-123"></a>
<a name="line-124"></a><a name="PCRE"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>PCRE</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>()</span>
<a name="line-125"></a>
<a name="line-126"></a><span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-127"></a>
<a name="line-128"></a><a name="PCREOption"></a><span class='hs-comment'>-- | A type for PCRE compile-time options. These are newtyped CInts,</span>
<a name="line-129"></a><a name="PCREOption"></a><span class='hs-comment'>-- which can be bitwise-or'd together, using '(Data.Bits..|.)'</span>
<a name="line-130"></a><a name="PCREOption"></a><span class='hs-comment'>--</span>
<a name="line-131"></a><a name="PCREOption"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>PCREOption</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-layout'>{</span> <span class='hs-varid'>unPCREOption</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span> <span class='hs-layout'>}</span>
<a name="line-132"></a>
<a name="line-133"></a><span class='hs-comment'>{-# LINE 129 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-134"></a>    <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span><span class='hs-conid'>Ord</span><span class='hs-layout'>,</span><span class='hs-conid'>Show</span><span class='hs-layout'>,</span><span class='hs-conid'>Read</span><span class='hs-layout'>)</span>
<a name="line-135"></a>
<a name="line-136"></a><span class='hs-comment'>{-# LINE 131 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-137"></a>
<a name="line-138"></a><a name="combineOptions"></a><span class='hs-comment'>-- | Combine a list of options into a single option, using bitwise (.|.)</span>
<a name="line-139"></a><span class='hs-definition'>combineOptions</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>PCREOption</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>PCREOption</span>
<a name="line-140"></a><span class='hs-definition'>combineOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varop'>.</span> <span class='hs-varid'>foldr</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varop'>.|.</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>unPCREOption</span><span class='hs-layout'>)</span> <span class='hs-num'>0</span>
<a name="line-141"></a>
<a name="line-142"></a><span class='hs-comment'>-- Now follows the user-visible options to _exec and _compile.</span>
<a name="line-143"></a><span class='hs-comment'>-- To avoid type errors, we newtype the underlying CInts, and </span>
<a name="line-144"></a><span class='hs-comment'>-- statically differentiate PCREOptions from non-PCREOptions</span>
<a name="line-145"></a><span class='hs-comment'>--</span>
<a name="line-146"></a><span class='hs-comment'>-- The safety can still be defeated using numeric literals though,</span>
<a name="line-147"></a><span class='hs-comment'>-- and other Num operations. We could do more to protect against this.</span>
<a name="line-148"></a><span class='hs-comment'>-- (a smart constructor for .|.)</span>
<a name="line-149"></a>
<a name="line-150"></a><a name="anchored"></a><span class='hs-comment'>-- | 'anchored'</span>
<a name="line-151"></a><span class='hs-comment'>--</span>
<a name="line-152"></a><span class='hs-comment'>-- If this bit is set, the pattern is forced to be /anchored/, that is,</span>
<a name="line-153"></a><span class='hs-comment'>-- it is constrained to match only at the first matching point in the</span>
<a name="line-154"></a><span class='hs-comment'>-- string that is being searched (the /subject string/). This effect can</span>
<a name="line-155"></a><span class='hs-comment'>-- also be achieved by appropriate constructs in the pattern itself, which</span>
<a name="line-156"></a><span class='hs-comment'>-- is the only way to do it in Perl.  </span>
<a name="line-157"></a><span class='hs-comment'>--</span>
<a name="line-158"></a><span class='hs-definition'>anchored</span>           <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-159"></a><span class='hs-definition'>anchored</span>           <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>anchored_cint</span>
<a name="line-160"></a>
<a name="line-161"></a><a name="auto_callout"></a><span class='hs-comment'>-- | 'auto_callout'</span>
<a name="line-162"></a><span class='hs-comment'>--</span>
<a name="line-163"></a><span class='hs-comment'>-- If this bit is set, "compile" automatically inserts callout</span>
<a name="line-164"></a><span class='hs-comment'>-- items, all with number 255, before each pattern item. For discussion</span>
<a name="line-165"></a><span class='hs-comment'>-- of the callout facility, see the man pcrecallout documentation</span>
<a name="line-166"></a><span class='hs-comment'>--</span>
<a name="line-167"></a><span class='hs-definition'>auto_callout</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-168"></a><span class='hs-definition'>auto_callout</span>       <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>auto_callout_cint</span>
<a name="line-169"></a>
<a name="line-170"></a><span class='hs-comment'>-- | 'bsr_anycrlf' and 'bsr_unicode'</span>
<a name="line-171"></a><span class='hs-comment'>--</span>
<a name="line-172"></a><span class='hs-comment'>-- These options (which are mutually exclusive) control what the \\R escape</span>
<a name="line-173"></a><span class='hs-comment'>-- sequence matches. The choice is either to match only CR, LF, or CRLF, or to</span>
<a name="line-174"></a><span class='hs-comment'>-- match any Unicode new- line sequence. The default is specified when PCRE is</span>
<a name="line-175"></a><span class='hs-comment'>-- built. It can be overridden from within the pattern, or by setting an option</span>
<a name="line-176"></a><span class='hs-comment'>-- when a compiled pattern is matched.</span>
<a name="line-177"></a><span class='hs-comment'>--</span>
<a name="line-178"></a><span class='hs-comment'>-- bsr_anycrlf        :: PCREOption</span>
<a name="line-179"></a><span class='hs-comment'>-- bsr_anycrlf        = PCREOption bsr_anycrlf_cint</span>
<a name="line-180"></a>
<a name="line-181"></a><span class='hs-comment'>-- | 'bsr_unicode'. See 'bse_anycrlf'</span>
<a name="line-182"></a><span class='hs-comment'>--</span>
<a name="line-183"></a><span class='hs-comment'>-- bsr_unicode        :: PCREOption</span>
<a name="line-184"></a><span class='hs-comment'>-- bsr_unicode        = PCREOption bsr_unicode_cint</span>
<a name="line-185"></a>
<a name="line-186"></a><a name="caseless"></a><span class='hs-comment'>-- | 'caseless'</span>
<a name="line-187"></a><span class='hs-comment'>--</span>
<a name="line-188"></a><span class='hs-comment'>-- If this bit is set, letters in the pattern match both upper and lower case</span>
<a name="line-189"></a><span class='hs-comment'>-- letters. It is equivalent to Perl's \/i option, and it can be changed within a</span>
<a name="line-190"></a><span class='hs-comment'>-- pattern by a (?i) option setting. In UTF-8 mode, PCRE always understands the</span>
<a name="line-191"></a><span class='hs-comment'>-- concept of case for characters whose values are less than 128, so caseless</span>
<a name="line-192"></a><span class='hs-comment'>-- matching is always possible. For characters with higher values, the concept of</span>
<a name="line-193"></a><span class='hs-comment'>-- case is supported if PCRE is compiled with Unicode property sup- port, but not</span>
<a name="line-194"></a><span class='hs-comment'>-- otherwise. If you want to use caseless matching for characters 128 and above,</span>
<a name="line-195"></a><span class='hs-comment'>-- you must ensure that PCRE is compiled with Unicode property support as well as</span>
<a name="line-196"></a><span class='hs-comment'>-- with UTF-8 support.</span>
<a name="line-197"></a><span class='hs-comment'>-- </span>
<a name="line-198"></a><span class='hs-definition'>caseless</span>           <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-199"></a><span class='hs-definition'>caseless</span>           <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>caseless_cint</span>
<a name="line-200"></a>
<a name="line-201"></a><a name="dollar_endonly"></a><span class='hs-comment'>-- | 'dollar_endonly'</span>
<a name="line-202"></a><span class='hs-comment'>--</span>
<a name="line-203"></a><span class='hs-comment'>-- If this bit is set, a dollar metacharacter in the pattern matches only at</span>
<a name="line-204"></a><span class='hs-comment'>-- the end of the subject string. Without this option, a dollar also matches</span>
<a name="line-205"></a><span class='hs-comment'>-- immediately before a newline at the end of the string (but not before any other</span>
<a name="line-206"></a><span class='hs-comment'>-- newlines). The 'dollar_endonly' option is ignored if 'multiline'</span>
<a name="line-207"></a><span class='hs-comment'>-- is set.  There is no equivalent to this option in Perl, and no way to set it</span>
<a name="line-208"></a><span class='hs-comment'>-- within a pattern.</span>
<a name="line-209"></a><span class='hs-comment'>--</span>
<a name="line-210"></a><span class='hs-definition'>dollar_endonly</span>     <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-211"></a><span class='hs-definition'>dollar_endonly</span>     <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>dollar_endonly_cint</span>
<a name="line-212"></a>
<a name="line-213"></a><a name="dotall"></a><span class='hs-comment'>-- | 'dotall'</span>
<a name="line-214"></a><span class='hs-comment'>--</span>
<a name="line-215"></a><span class='hs-comment'>-- If this bit is set, a dot metacharater in the pattern matches all</span>
<a name="line-216"></a><span class='hs-comment'>-- characters, including those that indicate newline. Without it, a dot does</span>
<a name="line-217"></a><span class='hs-comment'>-- not match when the current position is at a newline. This option is</span>
<a name="line-218"></a><span class='hs-comment'>-- equivalent to Perl's \/s option, and it can be changed within a pattern by a</span>
<a name="line-219"></a><span class='hs-comment'>-- (?s) option setting. A negative class such as [^a] always matches newline</span>
<a name="line-220"></a><span class='hs-comment'>-- characters, independent of the setting of this option.</span>
<a name="line-221"></a><span class='hs-comment'>--</span>
<a name="line-222"></a><span class='hs-definition'>dotall</span>             <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-223"></a><span class='hs-definition'>dotall</span>             <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>dotall_cint</span>
<a name="line-224"></a>
<a name="line-225"></a><a name="dupnames"></a><span class='hs-comment'>-- | 'dupnames'</span>
<a name="line-226"></a><span class='hs-comment'>--</span>
<a name="line-227"></a><span class='hs-comment'>-- If this bit is set, names used to identify capturing subpatterns need not be</span>
<a name="line-228"></a><span class='hs-comment'>-- unique. This can be helpful for certain types of pattern when it is known</span>
<a name="line-229"></a><span class='hs-comment'>-- that only one instance of the named subpattern can ever be matched. There are</span>
<a name="line-230"></a><span class='hs-comment'>-- more details of named subpatterns in the /man pcreapi/ documentation.</span>
<a name="line-231"></a><span class='hs-comment'>--</span>
<a name="line-232"></a><span class='hs-definition'>dupnames</span>           <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-233"></a><span class='hs-definition'>dupnames</span>           <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>dupnames_cint</span>
<a name="line-234"></a>
<a name="line-235"></a><a name="extended"></a><span class='hs-comment'>-- | 'extended'</span>
<a name="line-236"></a><span class='hs-comment'>--</span>
<a name="line-237"></a><span class='hs-comment'>-- If this bit is set, whitespace data characters in the pattern are totally</span>
<a name="line-238"></a><span class='hs-comment'>-- ignored except when escaped or inside a character class. Whitespace does not</span>
<a name="line-239"></a><span class='hs-comment'>-- include the VT character (code 11). In addition, characters between an</span>
<a name="line-240"></a><span class='hs-comment'>-- unescaped \# outside a character class and the next newline, inclusive, are</span>
<a name="line-241"></a><span class='hs-comment'>-- also ignored. This is equivalent to Perl's \/x option, and it can be changed</span>
<a name="line-242"></a><span class='hs-comment'>--within a pattern by a (?x) option setting.</span>
<a name="line-243"></a><span class='hs-comment'>--</span>
<a name="line-244"></a><span class='hs-comment'>-- This option makes it possible to include comments inside complicated</span>
<a name="line-245"></a><span class='hs-comment'>-- patterns. Note, however, that this applies only to data characters. Whitespace</span>
<a name="line-246"></a><span class='hs-comment'>-- characters may never appear within special character sequences in a pattern,</span>
<a name="line-247"></a><span class='hs-comment'>-- for example within the sequence (?( which introduces a conditional subpattern.</span>
<a name="line-248"></a><span class='hs-comment'>--</span>
<a name="line-249"></a><span class='hs-definition'>extended</span>           <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-250"></a><span class='hs-definition'>extended</span>           <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>extended_cint</span>
<a name="line-251"></a>
<a name="line-252"></a><a name="extra"></a><span class='hs-comment'>-- | 'extra'</span>
<a name="line-253"></a><span class='hs-comment'>--</span>
<a name="line-254"></a><span class='hs-comment'>-- This option was invented in order to turn on additional functionality of</span>
<a name="line-255"></a><span class='hs-comment'>-- PCRE that is incompatible with Perl, but it is currently of very little use.</span>
<a name="line-256"></a><span class='hs-comment'>-- When set, any backslash in a pattern that is followed by a letter that has no</span>
<a name="line-257"></a><span class='hs-comment'>-- special meaning causes an error, thus reserving these combinations for future</span>
<a name="line-258"></a><span class='hs-comment'>-- expansion. By default, as in Perl, a backslash followed by a letter with no</span>
<a name="line-259"></a><span class='hs-comment'>-- special meaning is treated as a literal. (Perl can, however, be persuaded to</span>
<a name="line-260"></a><span class='hs-comment'>-- give a warning for this.) There are at present no other features controlled by</span>
<a name="line-261"></a><span class='hs-comment'>-- this option. It can also be set by a (?X) option setting within a pattern. </span>
<a name="line-262"></a><span class='hs-comment'>--</span>
<a name="line-263"></a><span class='hs-definition'>extra</span>              <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-264"></a><span class='hs-definition'>extra</span>              <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>extra_cint</span>
<a name="line-265"></a>
<a name="line-266"></a><a name="firstline"></a><span class='hs-comment'>-- | 'firstline'</span>
<a name="line-267"></a><span class='hs-comment'>--</span>
<a name="line-268"></a><span class='hs-comment'>-- If this option is set, an unanchored pattern is required to match before or</span>
<a name="line-269"></a><span class='hs-comment'>-- at the first newline in the subject string, though the matched text may</span>
<a name="line-270"></a><span class='hs-comment'>--continue over the newline.</span>
<a name="line-271"></a><span class='hs-comment'>--</span>
<a name="line-272"></a><span class='hs-definition'>firstline</span>          <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-273"></a><span class='hs-definition'>firstline</span>          <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>firstline_cint</span>
<a name="line-274"></a>
<a name="line-275"></a><a name="multiline"></a><span class='hs-comment'>-- | 'multiline'</span>
<a name="line-276"></a><span class='hs-comment'>--</span>
<a name="line-277"></a><span class='hs-comment'>--  By default, PCRE treats the subject string as consisting of a single line</span>
<a name="line-278"></a><span class='hs-comment'>-- of characters (even if it actually contains newlines). The /start of line/</span>
<a name="line-279"></a><span class='hs-comment'>-- metacharacter (^) matches only at the start of the string, while the /end of line/</span>
<a name="line-280"></a><span class='hs-comment'>--  metacharacter ($) matches only at the end of the string, or before a</span>
<a name="line-281"></a><span class='hs-comment'>-- terminating newline (unless 'dollar_endonly' is set). This is the same</span>
<a name="line-282"></a><span class='hs-comment'>-- as Perl.</span>
<a name="line-283"></a><span class='hs-comment'>--</span>
<a name="line-284"></a><span class='hs-comment'>-- When 'multiline' it is set, the /start of line/ and /end of line/</span>
<a name="line-285"></a><span class='hs-comment'>-- constructs match immediately following or immediately before internal newlines</span>
<a name="line-286"></a><span class='hs-comment'>-- in the subject string, respectively, as well as at the very start and end. This</span>
<a name="line-287"></a><span class='hs-comment'>-- is equivalent to Perl's \/m option, and it can be changed within a pattern by a</span>
<a name="line-288"></a><span class='hs-comment'>-- (?m) option setting. If there are no newlines in a subject string, or no occur-</span>
<a name="line-289"></a><span class='hs-comment'>-- rences of ^ or $ in a pattern, setting PCRE_MULTILINE has no effect.</span>
<a name="line-290"></a><span class='hs-comment'>-- </span>
<a name="line-291"></a><span class='hs-definition'>multiline</span>          <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-292"></a><span class='hs-definition'>multiline</span>          <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>multiline_cint</span>
<a name="line-293"></a>
<a name="line-294"></a><span class='hs-comment'>-- | newline_cr', 'newline_lf', 'newline_crlf',</span>
<a name="line-295"></a><span class='hs-comment'>-- 'newline_anycrlf', 'newline_any'</span>
<a name="line-296"></a><span class='hs-comment'>--</span>
<a name="line-297"></a><span class='hs-comment'>-- These options override the default newline definition that</span>
<a name="line-298"></a><span class='hs-comment'>-- was chosen when PCRE was built. Setting the first or the</span>
<a name="line-299"></a><span class='hs-comment'>-- second specifies that a newline is indicated by a single</span>
<a name="line-300"></a><span class='hs-comment'>-- character (CR or LF, respectively). Setting 'newline_crlf' specifies</span>
<a name="line-301"></a><span class='hs-comment'>-- that a newline is indicated by the two-character CRLF sequence.</span>
<a name="line-302"></a><span class='hs-comment'>-- Setting 'newline_anycrlf'</span>
<a name="line-303"></a><span class='hs-comment'>-- specifies that any of the three preceding sequences should</span>
<a name="line-304"></a><span class='hs-comment'>-- be recognized. Setting 'newline_any' specifies that any</span>
<a name="line-305"></a><span class='hs-comment'>-- Unicode newline sequence should be recognized. The Unicode</span>
<a name="line-306"></a><span class='hs-comment'>-- newline sequences are the three just mentioned, plus the</span>
<a name="line-307"></a><span class='hs-comment'>-- single characters VT (vertical tab, U+000B), FF (formfeed,</span>
<a name="line-308"></a><span class='hs-comment'>-- U+000C), NEL (next line, U+0085), LS (line separator,</span>
<a name="line-309"></a><span class='hs-comment'>-- U+2028), and PS (paragraph separator, U+2029). The last</span>
<a name="line-310"></a><span class='hs-comment'>-- two are recognized only in UTF-8 mode.</span>
<a name="line-311"></a><span class='hs-comment'>-- </span>
<a name="line-312"></a><span class='hs-comment'>-- The newline setting in the options word uses three bits</span>
<a name="line-313"></a><span class='hs-comment'>-- that are treated as a number, giving eight possibilities.</span>
<a name="line-314"></a><span class='hs-comment'>-- Currently only six are used (default plus the five values</span>
<a name="line-315"></a><span class='hs-comment'>-- above). This means that if you set more than one newline</span>
<a name="line-316"></a><span class='hs-comment'>-- option, the combination may or may not be sensible. For</span>
<a name="line-317"></a><span class='hs-comment'>-- example, 'newline_cr' with 'newline_lf' is equivalent to</span>
<a name="line-318"></a><span class='hs-comment'>-- 'newline_crlf', but other combinations may yield unused numbers and</span>
<a name="line-319"></a><span class='hs-comment'>-- cause an error.</span>
<a name="line-320"></a><span class='hs-comment'>-- </span>
<a name="line-321"></a><span class='hs-comment'>-- The only time that a line break is specially recognized</span>
<a name="line-322"></a><span class='hs-comment'>-- when compiling a pattern is if 'extended' is set, and</span>
<a name="line-323"></a><span class='hs-comment'>-- an unescaped \# outside a character class is encountered.</span>
<a name="line-324"></a><span class='hs-comment'>-- This indicates a comment that lasts until after the next</span>
<a name="line-325"></a><span class='hs-comment'>-- line break sequence. In other circumstances, line break</span>
<a name="line-326"></a><span class='hs-comment'>-- sequences are treated as literal data, except that in</span>
<a name="line-327"></a><span class='hs-comment'>-- 'extended' mode, both CR and LF are treated as whitespace characters</span>
<a name="line-328"></a><span class='hs-comment'>-- and are therefore ignored.  -- </span>
<a name="line-329"></a><span class='hs-comment'>--</span>
<a name="line-330"></a><span class='hs-comment'>-- The newline option that is set at compile time becomes the</span>
<a name="line-331"></a><span class='hs-comment'>-- default that is used for 'exec' but it can be overridden.</span>
<a name="line-332"></a><span class='hs-comment'>-- </span>
<a name="line-333"></a><span class='hs-comment'>-- newline_any        :: PCREOption</span>
<a name="line-334"></a><span class='hs-comment'>-- newline_any        = PCREOption newline_any_cint</span>
<a name="line-335"></a>
<a name="line-336"></a><span class='hs-comment'>-- | 'newline_anycrlf', see 'newline_any'</span>
<a name="line-337"></a><span class='hs-comment'>-- newline_anycrlf    :: PCREOption</span>
<a name="line-338"></a><span class='hs-comment'>-- newline_anycrlf    = PCREOption newline_anycrlf_cint</span>
<a name="line-339"></a>
<a name="line-340"></a><a name="newline_cr"></a><span class='hs-comment'>-- | 'newline_cr', see 'newline_any'</span>
<a name="line-341"></a><span class='hs-definition'>newline_cr</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-342"></a><span class='hs-definition'>newline_cr</span>         <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>newline_cr_cint</span>
<a name="line-343"></a>
<a name="line-344"></a><a name="newline_crlf"></a><span class='hs-comment'>-- | 'newline_crlf', see 'newline_any'</span>
<a name="line-345"></a><span class='hs-definition'>newline_crlf</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-346"></a><span class='hs-definition'>newline_crlf</span>       <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>newline_crlf_cint</span>
<a name="line-347"></a>
<a name="line-348"></a><a name="newline_lf"></a><span class='hs-comment'>-- | 'newline_lf', see 'newline_any'</span>
<a name="line-349"></a><span class='hs-definition'>newline_lf</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-350"></a><span class='hs-definition'>newline_lf</span>         <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>newline_lf_cint</span>
<a name="line-351"></a>
<a name="line-352"></a><a name="no_auto_capture"></a><span class='hs-comment'>-- | 'no_auto_capture'</span>
<a name="line-353"></a><span class='hs-comment'>--</span>
<a name="line-354"></a><span class='hs-comment'>-- If this option is set, it disables the use of numbered</span>
<a name="line-355"></a><span class='hs-comment'>-- capturing parentheses in the pattern. Any opening paren-</span>
<a name="line-356"></a><span class='hs-comment'>-- thesis that is not followed by ? behaves as if it were</span>
<a name="line-357"></a><span class='hs-comment'>-- followed by ?: but named parentheses can still be used for</span>
<a name="line-358"></a><span class='hs-comment'>-- capturing (and they acquire numbers in the usual way).</span>
<a name="line-359"></a><span class='hs-comment'>-- There is no equivalent of this option in Perl.</span>
<a name="line-360"></a><span class='hs-comment'>--</span>
<a name="line-361"></a><span class='hs-definition'>no_auto_capture</span>    <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-362"></a><span class='hs-definition'>no_auto_capture</span>    <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>no_auto_capture_cint</span>
<a name="line-363"></a>
<a name="line-364"></a><a name="ungreedy"></a><span class='hs-comment'>-- | 'ungreedy'</span>
<a name="line-365"></a><span class='hs-comment'>--</span>
<a name="line-366"></a><span class='hs-comment'>-- This option inverts the /greediness/ of the quantifiers so</span>
<a name="line-367"></a><span class='hs-comment'>-- that they are not greedy by default, but become greedy if</span>
<a name="line-368"></a><span class='hs-comment'>-- followed by /?/. It is not compatible with Perl. It can</span>
<a name="line-369"></a><span class='hs-comment'>-- also be set by a (?U) option setting within the pattern.</span>
<a name="line-370"></a><span class='hs-comment'>--</span>
<a name="line-371"></a><span class='hs-definition'>ungreedy</span>           <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-372"></a><span class='hs-definition'>ungreedy</span>           <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>ungreedy_cint</span>
<a name="line-373"></a>
<a name="line-374"></a><a name="utf8"></a><span class='hs-comment'>-- | 'utf8'</span>
<a name="line-375"></a><span class='hs-comment'>--</span>
<a name="line-376"></a><span class='hs-comment'>-- This option causes PCRE to regard both the pattern and the</span>
<a name="line-377"></a><span class='hs-comment'>-- subject as strings of UTF-8 characters instead of single-byte character</span>
<a name="line-378"></a><span class='hs-comment'>-- strings. However, it is available only when </span>
<a name="line-379"></a><span class='hs-comment'>-- PCRE is built to include UTF-8 support. If not, the use of</span>
<a name="line-380"></a><span class='hs-comment'>-- this option provokes an error. Details of how this option</span>
<a name="line-381"></a><span class='hs-comment'>-- changes the behaviour of PCRE are given in the section on</span>
<a name="line-382"></a><span class='hs-comment'>-- UTF-8 support in the main pcre page.</span>
<a name="line-383"></a><span class='hs-comment'>--</span>
<a name="line-384"></a><span class='hs-definition'>utf8</span>               <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-385"></a><span class='hs-definition'>utf8</span>               <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>utf8_cint</span>
<a name="line-386"></a>
<a name="line-387"></a><a name="no_utf8_check"></a><span class='hs-comment'>-- | 'no_utf8_check'</span>
<a name="line-388"></a><span class='hs-comment'>--</span>
<a name="line-389"></a><span class='hs-comment'>-- When PCRE_UTF8 is set, the validity of the pattern as a</span>
<a name="line-390"></a><span class='hs-comment'>-- UTF-8 string is automatically checked. There is a discussion </span>
<a name="line-391"></a><span class='hs-comment'>-- about the validity of UTF-8 strings in the main pcre</span>
<a name="line-392"></a><span class='hs-comment'>-- page. If an invalid UTF-8 sequence of bytes is found,</span>
<a name="line-393"></a><span class='hs-comment'>-- compile() returns an error. If you already know that</span>
<a name="line-394"></a><span class='hs-comment'>-- your pattern is valid, and you want to skip this check for</span>
<a name="line-395"></a><span class='hs-comment'>-- performance reasons, you can set the 'no_utf8_check'</span>
<a name="line-396"></a><span class='hs-comment'>-- option. When it is set, the effect of passing an invalid</span>
<a name="line-397"></a><span class='hs-comment'>-- UTF-8 string as a pattern is undefined. It may cause your</span>
<a name="line-398"></a><span class='hs-comment'>-- program to crash. Note that this option can also be passed</span>
<a name="line-399"></a><span class='hs-comment'>-- to 'exec', to suppress the UTF-8 validity checking of subject strings.</span>
<a name="line-400"></a><span class='hs-comment'>--</span>
<a name="line-401"></a><span class='hs-definition'>no_utf8_check</span>      <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption</span>
<a name="line-402"></a><span class='hs-definition'>no_utf8_check</span>      <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREOption</span> <span class='hs-varid'>no_utf8_check_cint</span>
<a name="line-403"></a>
<a name="line-404"></a><a name="PCREOption_"></a><span class='hs-comment'>-- Internal name for hsc2hs to bind to.</span>
<a name="line-405"></a><a name="PCREOption_"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>PCREOption_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>CInt</span>
<a name="line-406"></a>
<a name="line-407"></a><a name="anchored_cint"></a><span class='hs-comment'>-- PCRE compile options, as CInts</span>
<a name="line-408"></a><span class='hs-definition'>anchored_cint</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-409"></a><span class='hs-definition'>anchored_cint</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-num'>16</span>
<a name="line-410"></a><a name="auto_callout_cint"></a><span class='hs-definition'>auto_callout_cint</span>     <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-411"></a><span class='hs-definition'>auto_callout_cint</span>     <span class='hs-keyglyph'>=</span>  <span class='hs-num'>16384</span>
<a name="line-412"></a><a name="caseless_cint"></a><span class='hs-definition'>caseless_cint</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-413"></a><span class='hs-definition'>caseless_cint</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-num'>1</span>
<a name="line-414"></a><a name="dollar_endonly_cint"></a><span class='hs-definition'>dollar_endonly_cint</span>   <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-415"></a><span class='hs-definition'>dollar_endonly_cint</span>   <span class='hs-keyglyph'>=</span>  <span class='hs-num'>32</span>
<a name="line-416"></a><a name="dotall_cint"></a><span class='hs-definition'>dotall_cint</span>           <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-417"></a><span class='hs-definition'>dotall_cint</span>           <span class='hs-keyglyph'>=</span>  <span class='hs-num'>4</span>
<a name="line-418"></a><a name="dupnames_cint"></a><span class='hs-definition'>dupnames_cint</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-419"></a><span class='hs-definition'>dupnames_cint</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-num'>524288</span>
<a name="line-420"></a><a name="extended_cint"></a><span class='hs-definition'>extended_cint</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-421"></a><span class='hs-definition'>extended_cint</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-num'>8</span>
<a name="line-422"></a><a name="extra_cint"></a><span class='hs-definition'>extra_cint</span>            <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-423"></a><span class='hs-definition'>extra_cint</span>            <span class='hs-keyglyph'>=</span>  <span class='hs-num'>64</span>
<a name="line-424"></a><a name="firstline_cint"></a><span class='hs-definition'>firstline_cint</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-425"></a><span class='hs-definition'>firstline_cint</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-num'>262144</span>
<a name="line-426"></a><a name="multiline_cint"></a><span class='hs-definition'>multiline_cint</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-427"></a><span class='hs-definition'>multiline_cint</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-num'>2</span>
<a name="line-428"></a><a name="newline_cr_cint"></a><span class='hs-definition'>newline_cr_cint</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-429"></a><span class='hs-definition'>newline_cr_cint</span>       <span class='hs-keyglyph'>=</span>  <span class='hs-num'>1048576</span>
<a name="line-430"></a><a name="newline_crlf_cint"></a><span class='hs-definition'>newline_crlf_cint</span>     <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-431"></a><span class='hs-definition'>newline_crlf_cint</span>     <span class='hs-keyglyph'>=</span>  <span class='hs-num'>3145728</span>
<a name="line-432"></a><a name="newline_lf_cint"></a><span class='hs-definition'>newline_lf_cint</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-433"></a><span class='hs-definition'>newline_lf_cint</span>       <span class='hs-keyglyph'>=</span>  <span class='hs-num'>2097152</span>
<a name="line-434"></a><a name="no_auto_capture_cint"></a><span class='hs-definition'>no_auto_capture_cint</span>  <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-435"></a><span class='hs-definition'>no_auto_capture_cint</span>  <span class='hs-keyglyph'>=</span>  <span class='hs-num'>4096</span>
<a name="line-436"></a><a name="ungreedy_cint"></a><span class='hs-definition'>ungreedy_cint</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-437"></a><span class='hs-definition'>ungreedy_cint</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-num'>512</span>
<a name="line-438"></a><a name="utf8_cint"></a><span class='hs-definition'>utf8_cint</span>             <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-439"></a><span class='hs-definition'>utf8_cint</span>             <span class='hs-keyglyph'>=</span>  <span class='hs-num'>2048</span>
<a name="line-440"></a><a name="no_utf8_check_cint"></a><span class='hs-definition'>no_utf8_check_cint</span>    <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREOption_</span>
<a name="line-441"></a><span class='hs-definition'>no_utf8_check_cint</span>    <span class='hs-keyglyph'>=</span>  <span class='hs-num'>8192</span>
<a name="line-442"></a>
<a name="line-443"></a><span class='hs-comment'>{-# LINE 421 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-444"></a>
<a name="line-445"></a><span class='hs-comment'>--  , bsr_anycrlf_cint     = PCRE_BSR_ANYCRLF</span>
<a name="line-446"></a><span class='hs-comment'>--  , bsr_unicode_cint     = PCRE_BSR_UNICODE</span>
<a name="line-447"></a><span class='hs-comment'>--  , newline_any_cint     = PCRE_NEWLINE_ANY</span>
<a name="line-448"></a><span class='hs-comment'>--  , newline_anycrlf_cint = PCRE_NEWLINE_ANYCRLF</span>
<a name="line-449"></a>
<a name="line-450"></a><span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-451"></a>
<a name="line-452"></a><a name="PCREExecOption"></a><span class='hs-comment'>-- | PCRE exec options, to be passed to exec</span>
<a name="line-453"></a><a name="PCREExecOption"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-layout'>{</span> <span class='hs-varid'>unPCREExecOption</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption_</span> <span class='hs-layout'>}</span>
<a name="line-454"></a>
<a name="line-455"></a><span class='hs-comment'>{-# LINE 432 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-456"></a>    <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span><span class='hs-conid'>Ord</span><span class='hs-layout'>,</span><span class='hs-conid'>Show</span><span class='hs-layout'>,</span><span class='hs-conid'>Read</span><span class='hs-layout'>)</span>
<a name="line-457"></a>
<a name="line-458"></a><span class='hs-comment'>{-# LINE 434 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-459"></a>
<a name="line-460"></a><a name="combineExecOptions"></a><span class='hs-comment'>-- | Combine a list of exec options into a single option, using bitwise (.|.)</span>
<a name="line-461"></a><span class='hs-definition'>combineExecOptions</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>PCREExecOption</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-462"></a><span class='hs-definition'>combineExecOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-varop'>.</span> <span class='hs-varid'>foldr</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varop'>.|.</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>unPCREExecOption</span><span class='hs-layout'>)</span> <span class='hs-num'>0</span>
<a name="line-463"></a>
<a name="line-464"></a><a name="exec_anchored"></a><span class='hs-comment'>-- | 'anchored'.</span>
<a name="line-465"></a><span class='hs-comment'>--</span>
<a name="line-466"></a><span class='hs-comment'>-- The 'anchored' option limits 'exec' to matching at</span>
<a name="line-467"></a><span class='hs-comment'>-- the first matching position. If a pattern was compiled</span>
<a name="line-468"></a><span class='hs-comment'>-- with 'anchored', or turned out to be anchored by virtue</span>
<a name="line-469"></a><span class='hs-comment'>-- of its contents, it cannot be made unachored at matching</span>
<a name="line-470"></a><span class='hs-comment'>-- time.</span>
<a name="line-471"></a><span class='hs-definition'>exec_anchored</span>              <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-472"></a><span class='hs-definition'>exec_anchored</span>              <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-varid'>exec_anchored_cint</span>
<a name="line-473"></a>
<a name="line-474"></a><span class='hs-comment'>-- | 'newline_cr', 'newline_lf',</span>
<a name="line-475"></a><span class='hs-comment'>-- 'newline_crlf', 'newline_anycrlf', 'newline_any'</span>
<a name="line-476"></a><span class='hs-comment'>--</span>
<a name="line-477"></a><span class='hs-comment'>-- These options override the newline definition that was</span>
<a name="line-478"></a><span class='hs-comment'>-- chosen or defaulted when the pattern was compiled. For</span>
<a name="line-479"></a><span class='hs-comment'>-- details, see the description of 'compile' above. Dur-</span>
<a name="line-480"></a><span class='hs-comment'>-- ing matching, the newline choice affects the behaviour of</span>
<a name="line-481"></a><span class='hs-comment'>-- the dot, circumflex, and dollar metacharacters. It may</span>
<a name="line-482"></a><span class='hs-comment'>-- also alter the way the match position is advanced after a</span>
<a name="line-483"></a><span class='hs-comment'>-- match failure for an unanchored pattern.</span>
<a name="line-484"></a><span class='hs-comment'>--</span>
<a name="line-485"></a><span class='hs-comment'>-- When 'newline_crlf', 'newline_anycrlf', or 'newline_any'</span>
<a name="line-486"></a><span class='hs-comment'>-- is set, and a match attempt for an unanchored</span>
<a name="line-487"></a><span class='hs-comment'>-- pattern fails when the current position is at a CRLF</span>
<a name="line-488"></a><span class='hs-comment'>-- sequence, and the pattern contains no explicit matches for</span>
<a name="line-489"></a><span class='hs-comment'>-- CR or LF characters, the match position is advanced by two</span>
<a name="line-490"></a><span class='hs-comment'>-- characters instead of one, in other words, to after the</span>
<a name="line-491"></a><span class='hs-comment'>-- CRLF.</span>
<a name="line-492"></a><span class='hs-comment'>--</span>
<a name="line-493"></a><span class='hs-comment'>-- The above rule is a compromise that makes the most common</span>
<a name="line-494"></a><span class='hs-comment'>-- cases work as expected. For example, if the pattern is .+A</span>
<a name="line-495"></a><span class='hs-comment'>-- (and the 'dotall' option is not set), it does not match</span>
<a name="line-496"></a><span class='hs-comment'>-- the string /\\r\\nA/ because, after failing at the start, it</span>
<a name="line-497"></a><span class='hs-comment'>-- skips both the CR and the LF before retrying. However, the</span>
<a name="line-498"></a><span class='hs-comment'>-- pattern /[\\r\\n]A/ does match that string, because it contains</span>
<a name="line-499"></a><span class='hs-comment'>-- an explicit CR or LF reference, and so advances only</span>
<a name="line-500"></a><span class='hs-comment'>-- by one character after the first failure.</span>
<a name="line-501"></a><span class='hs-comment'>--</span>
<a name="line-502"></a><span class='hs-comment'>-- An explicit match for CR of LF is either a literal appear-</span>
<a name="line-503"></a><span class='hs-comment'>-- ance of one of those characters, or one of the \\r or \\n</span>
<a name="line-504"></a><span class='hs-comment'>-- escape sequences. Implicit matches such as [^X] do not</span>
<a name="line-505"></a><span class='hs-comment'>-- count, nor does \\s (which includes CR and LF in the char-</span>
<a name="line-506"></a><span class='hs-comment'>-- acters that it matches).</span>
<a name="line-507"></a><span class='hs-comment'>--</span>
<a name="line-508"></a><span class='hs-comment'>-- Notwithstanding the above, anomalous effects may still</span>
<a name="line-509"></a><span class='hs-comment'>-- occur when CRLF is a valid newline sequence and explicit</span>
<a name="line-510"></a><span class='hs-comment'>-- \\r or \\n escapes appear in the pattern.</span>
<a name="line-511"></a><span class='hs-comment'>--</span>
<a name="line-512"></a><span class='hs-comment'>-- exec_newline_any           :: PCREExecOption</span>
<a name="line-513"></a><span class='hs-comment'>-- exec_newline_any           = PCREExecOption exec_newline_any_cint</span>
<a name="line-514"></a>
<a name="line-515"></a><span class='hs-comment'>-- | 'exec_newline_anycrlf', see 'exec_newline_any'</span>
<a name="line-516"></a><span class='hs-comment'>-- exec_newline_anycrlf       :: PCREExecOption</span>
<a name="line-517"></a><span class='hs-comment'>-- exec_newline_anycrlf       = PCREExecOption exec_newline_anycrlf_cint</span>
<a name="line-518"></a>
<a name="line-519"></a><a name="exec_newline_cr"></a><span class='hs-comment'>-- | 'exec_newline_cr', see 'exec_newline_any'</span>
<a name="line-520"></a><span class='hs-definition'>exec_newline_cr</span>            <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-521"></a><span class='hs-definition'>exec_newline_cr</span>            <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-varid'>exec_newline_cr_cint</span>
<a name="line-522"></a>
<a name="line-523"></a><a name="exec_newline_crlf"></a><span class='hs-comment'>-- | 'exec_newline_crlf', see 'exec_newline_any'</span>
<a name="line-524"></a><span class='hs-definition'>exec_newline_crlf</span>          <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-525"></a><span class='hs-definition'>exec_newline_crlf</span>          <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-varid'>exec_newline_crlf_cint</span>
<a name="line-526"></a>
<a name="line-527"></a><a name="exec_newline_lf"></a><span class='hs-comment'>-- | 'exec_newline_lf', see 'exec_newline_any'</span>
<a name="line-528"></a><span class='hs-definition'>exec_newline_lf</span>            <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-529"></a><span class='hs-definition'>exec_newline_lf</span>            <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-varid'>exec_newline_lf_cint</span>
<a name="line-530"></a>
<a name="line-531"></a><a name="exec_notbol"></a><span class='hs-comment'>-- | 'PCRE_NOTBOL'</span>
<a name="line-532"></a><span class='hs-comment'>--</span>
<a name="line-533"></a><span class='hs-comment'>-- This option specifies that first character of the subject</span>
<a name="line-534"></a><span class='hs-comment'>-- string is not the beginning of a line, so the circumflex</span>
<a name="line-535"></a><span class='hs-comment'>-- metacharacter should not match before it. Setting this</span>
<a name="line-536"></a><span class='hs-comment'>-- without 'multiline' (at compile time) causes circumflex</span>
<a name="line-537"></a><span class='hs-comment'>-- never to match. This option affects only the behaviour of</span>
<a name="line-538"></a><span class='hs-comment'>-- the circumflex metacharacter. It does not affect \\A.</span>
<a name="line-539"></a><span class='hs-comment'>--</span>
<a name="line-540"></a><span class='hs-definition'>exec_notbol</span>                <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-541"></a><span class='hs-definition'>exec_notbol</span>                <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-varid'>exec_notbol_cint</span>
<a name="line-542"></a>
<a name="line-543"></a><a name="exec_noteol"></a><span class='hs-comment'>-- | 'noteol'</span>
<a name="line-544"></a><span class='hs-comment'>--</span>
<a name="line-545"></a><span class='hs-comment'>-- This option specifies that the end of the subject string</span>
<a name="line-546"></a><span class='hs-comment'>-- is not the end of a line, so the dollar metacharacter</span>
<a name="line-547"></a><span class='hs-comment'>-- should not match it nor (except in multiline mode) a newline</span>
<a name="line-548"></a><span class='hs-comment'>-- immediately before it. Setting this without 'multiline' </span>
<a name="line-549"></a><span class='hs-comment'>-- (at compile time) causes dollar never to match.</span>
<a name="line-550"></a><span class='hs-comment'>-- This option affects only the behaviour of the dollar</span>
<a name="line-551"></a><span class='hs-comment'>-- metacharacter. It does not affect \\Z or \\z.</span>
<a name="line-552"></a><span class='hs-comment'>--</span>
<a name="line-553"></a><span class='hs-definition'>exec_noteol</span>                <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-554"></a><span class='hs-definition'>exec_noteol</span>                <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-varid'>exec_noteol_cint</span>
<a name="line-555"></a>
<a name="line-556"></a><a name="exec_notempty"></a><span class='hs-comment'>-- | PCRE_NOTEMPTY</span>
<a name="line-557"></a><span class='hs-comment'>--</span>
<a name="line-558"></a><span class='hs-comment'>-- An empty string is not considered to be a valid match if</span>
<a name="line-559"></a><span class='hs-comment'>-- this option is set. If there are alternatives in the pattern,</span>
<a name="line-560"></a><span class='hs-comment'>-- they are tried. If all the alternatives match the</span>
<a name="line-561"></a><span class='hs-comment'>-- empty string, the entire match fails. For example, if the</span>
<a name="line-562"></a><span class='hs-comment'>-- pattern</span>
<a name="line-563"></a><span class='hs-comment'>--</span>
<a name="line-564"></a><span class='hs-comment'>-- &gt; a?b?</span>
<a name="line-565"></a><span class='hs-comment'>--</span>
<a name="line-566"></a><span class='hs-comment'>-- is applied to a string not beginning with /a/ or /b/, it</span>
<a name="line-567"></a><span class='hs-comment'>-- matches the empty string at the start of the subject. With</span>
<a name="line-568"></a><span class='hs-comment'>-- 'notempty' set, this match is not valid, so 'PCRE</span>
<a name="line-569"></a><span class='hs-comment'>-- searches further into the string for occurrences of /a/ or</span>
<a name="line-570"></a><span class='hs-comment'>-- /b/.</span>
<a name="line-571"></a><span class='hs-comment'>--</span>
<a name="line-572"></a><span class='hs-comment'>-- Perl has no direct equivalent of 'notempty', but it</span>
<a name="line-573"></a><span class='hs-comment'>-- does make a special case of a pattern match of the empty</span>
<a name="line-574"></a><span class='hs-comment'>-- string within its split() function, and when using the \/g</span>
<a name="line-575"></a><span class='hs-comment'>-- modifier. It is possible to emulate Perl's behaviour after</span>
<a name="line-576"></a><span class='hs-comment'>-- matching a null string by first trying the match again at</span>
<a name="line-577"></a><span class='hs-comment'>-- the same offset with PCRE_NOTEMPTY and PCRE_ANCHORED, and</span>
<a name="line-578"></a><span class='hs-comment'>-- then if that fails by advancing the starting offset (see</span>
<a name="line-579"></a><span class='hs-comment'>-- below) and trying an ordinary match again. There is some</span>
<a name="line-580"></a><span class='hs-comment'>-- code that demonstrates how to do this in the pcredemo.c</span>
<a name="line-581"></a><span class='hs-comment'>-- sample program.</span>
<a name="line-582"></a><span class='hs-comment'>--</span>
<a name="line-583"></a><span class='hs-definition'>exec_notempty</span>              <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-584"></a><span class='hs-definition'>exec_notempty</span>              <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-varid'>exec_notempty_cint</span>
<a name="line-585"></a>
<a name="line-586"></a><a name="exec_no_utf8_check"></a><span class='hs-comment'>-- | 'no_utf8_check'</span>
<a name="line-587"></a><span class='hs-comment'>--</span>
<a name="line-588"></a><span class='hs-comment'>-- When 'utf8' is set at compile time, the validity of the</span>
<a name="line-589"></a><span class='hs-comment'>-- subject as a UTF-8 string is automatically checked when</span>
<a name="line-590"></a><span class='hs-comment'>-- exec() is subsequently called. The value of</span>
<a name="line-591"></a><span class='hs-comment'>-- startoffset is also checked to ensure that it points to</span>
<a name="line-592"></a><span class='hs-comment'>-- the start of a UTF-8 character. There is a discussion</span>
<a name="line-593"></a><span class='hs-comment'>-- about the validity of UTF-8 strings in the section on</span>
<a name="line-594"></a><span class='hs-comment'>-- UTF-8 support in the main pcre page. If an invalid UTF-8</span>
<a name="line-595"></a><span class='hs-comment'>-- sequence of bytes is found, exec() returns the error</span>
<a name="line-596"></a><span class='hs-comment'>-- 'error_badutf8'. If startoffset contains an invalid</span>
<a name="line-597"></a><span class='hs-comment'>-- value, 'error_badutf8_offset' is returned.</span>
<a name="line-598"></a><span class='hs-comment'>--</span>
<a name="line-599"></a><span class='hs-comment'>-- If you already know that your subject is valid, and you</span>
<a name="line-600"></a><span class='hs-comment'>-- want to skip these checks for performance reasons, you can</span>
<a name="line-601"></a><span class='hs-comment'>-- set the 'no_utf8_check' option when calling</span>
<a name="line-602"></a><span class='hs-comment'>-- 'exec'. You might want to do this for the second and</span>
<a name="line-603"></a><span class='hs-comment'>-- subsequent calls to exec() if you are making repeated</span>
<a name="line-604"></a><span class='hs-comment'>-- calls to find all the matches in a single subject string.</span>
<a name="line-605"></a><span class='hs-comment'>-- However, you should be sure that the value of startoffset</span>
<a name="line-606"></a><span class='hs-comment'>-- points to the start of a UTF-8 character. When</span>
<a name="line-607"></a><span class='hs-comment'>-- 'no_utf8_check' is set, the effect of passing an</span>
<a name="line-608"></a><span class='hs-comment'>-- invalid UTF-8 string as a subject, or a value of startoff-</span>
<a name="line-609"></a><span class='hs-comment'>-- set that does not point to the start of a UTF-8 character,</span>
<a name="line-610"></a><span class='hs-comment'>-- is undefined. Your program may crash.</span>
<a name="line-611"></a><span class='hs-comment'>--</span>
<a name="line-612"></a><span class='hs-definition'>exec_no_utf8_check</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-613"></a><span class='hs-definition'>exec_no_utf8_check</span>         <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-varid'>exec_no_utf8_check_cint</span>
<a name="line-614"></a>
<a name="line-615"></a><a name="exec_partial"></a><span class='hs-comment'>-- | 'partial'</span>
<a name="line-616"></a><span class='hs-comment'>--</span>
<a name="line-617"></a><span class='hs-comment'>-- This option turns on the partial matching feature. If the</span>
<a name="line-618"></a><span class='hs-comment'>-- subject string fails to match the pattern, but at some</span>
<a name="line-619"></a><span class='hs-comment'>-- point during the matching process the end of the subject</span>
<a name="line-620"></a><span class='hs-comment'>-- was reached (that is, the subject partially matches the</span>
<a name="line-621"></a><span class='hs-comment'>-- pattern and the failure to match occurred only because</span>
<a name="line-622"></a><span class='hs-comment'>-- there were not enough subject characters), 'exec'</span>
<a name="line-623"></a><span class='hs-comment'>-- returns 'error_partial' instead of 'error_nomatch'.</span>
<a name="line-624"></a><span class='hs-comment'>-- When 'partial' is used, there are restrictions on what</span>
<a name="line-625"></a><span class='hs-comment'>-- may appear in the pattern. These are discussed in the</span>
<a name="line-626"></a><span class='hs-comment'>-- pcrepartial documentation.</span>
<a name="line-627"></a><span class='hs-comment'>--</span>
<a name="line-628"></a><span class='hs-definition'>exec_partial</span>               <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-629"></a><span class='hs-definition'>exec_partial</span>               <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PCREExecOption</span> <span class='hs-varid'>exec_partial_cint</span>
<a name="line-630"></a>
<a name="line-631"></a><a name="PCREExecOption_"></a><span class='hs-comment'>-- Internal name for hsc2hs to bind to.</span>
<a name="line-632"></a><a name="PCREExecOption_"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>PCREExecOption_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>CInt</span>
<a name="line-633"></a>
<a name="line-634"></a><a name="exec_anchored_cint"></a><span class='hs-comment'>-- PCRE exec options</span>
<a name="line-635"></a><span class='hs-definition'>exec_anchored_cint</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption_</span>
<a name="line-636"></a><span class='hs-definition'>exec_anchored_cint</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-num'>16</span>
<a name="line-637"></a><a name="exec_newline_cr_cint"></a><span class='hs-definition'>exec_newline_cr_cint</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption_</span>
<a name="line-638"></a><span class='hs-definition'>exec_newline_cr_cint</span>       <span class='hs-keyglyph'>=</span>  <span class='hs-num'>1048576</span>
<a name="line-639"></a><a name="exec_newline_crlf_cint"></a><span class='hs-definition'>exec_newline_crlf_cint</span>     <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption_</span>
<a name="line-640"></a><span class='hs-definition'>exec_newline_crlf_cint</span>     <span class='hs-keyglyph'>=</span>  <span class='hs-num'>3145728</span>
<a name="line-641"></a><a name="exec_newline_lf_cint"></a><span class='hs-definition'>exec_newline_lf_cint</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption_</span>
<a name="line-642"></a><span class='hs-definition'>exec_newline_lf_cint</span>       <span class='hs-keyglyph'>=</span>  <span class='hs-num'>2097152</span>
<a name="line-643"></a><a name="exec_notbol_cint"></a><span class='hs-definition'>exec_notbol_cint</span>           <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption_</span>
<a name="line-644"></a><span class='hs-definition'>exec_notbol_cint</span>           <span class='hs-keyglyph'>=</span>  <span class='hs-num'>128</span>
<a name="line-645"></a><a name="exec_noteol_cint"></a><span class='hs-definition'>exec_noteol_cint</span>           <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption_</span>
<a name="line-646"></a><span class='hs-definition'>exec_noteol_cint</span>           <span class='hs-keyglyph'>=</span>  <span class='hs-num'>256</span>
<a name="line-647"></a><a name="exec_notempty_cint"></a><span class='hs-definition'>exec_notempty_cint</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption_</span>
<a name="line-648"></a><span class='hs-definition'>exec_notempty_cint</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-num'>1024</span>
<a name="line-649"></a><a name="exec_no_utf8_check_cint"></a><span class='hs-definition'>exec_no_utf8_check_cint</span>    <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption_</span>
<a name="line-650"></a><span class='hs-definition'>exec_no_utf8_check_cint</span>    <span class='hs-keyglyph'>=</span>  <span class='hs-num'>8192</span>
<a name="line-651"></a><a name="exec_partial_cint"></a><span class='hs-definition'>exec_partial_cint</span>          <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExecOption_</span>
<a name="line-652"></a><span class='hs-definition'>exec_partial_cint</span>          <span class='hs-keyglyph'>=</span>  <span class='hs-num'>32768</span>
<a name="line-653"></a>
<a name="line-654"></a><span class='hs-comment'>{-# LINE 621 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-655"></a>
<a name="line-656"></a><span class='hs-comment'>--  , exec_newline_any_cint     = PCRE_NEWLINE_ANY</span>
<a name="line-657"></a><span class='hs-comment'>--  , exec_newline_anycrlf_cint = PCRE_NEWLINE_ANYCRLF</span>
<a name="line-658"></a><span class='hs-comment'>--  , dfa_shortest   = PCRE_DFA_SHORTEST</span>
<a name="line-659"></a><span class='hs-comment'>--  , dfa_restart    = PCRE_DFA_RESTART</span>
<a name="line-660"></a>
<a name="line-661"></a><span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-662"></a>
<a name="line-663"></a><a name="PCREError"></a><span class='hs-comment'>-- | A type for PCRE Errors: exec-time error codes.</span>
<a name="line-664"></a><a name="PCREError"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>PCREError</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>CInt</span>
<a name="line-665"></a>
<a name="line-666"></a><a name="error_nomatch"></a><span class='hs-definition'>error_nomatch</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-667"></a><span class='hs-definition'>error_nomatch</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>1</span><span class='hs-layout'>)</span>
<a name="line-668"></a><a name="error_null"></a><span class='hs-definition'>error_null</span>            <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-669"></a><span class='hs-definition'>error_null</span>            <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>2</span><span class='hs-layout'>)</span>
<a name="line-670"></a><a name="error_badoption"></a><span class='hs-definition'>error_badoption</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-671"></a><span class='hs-definition'>error_badoption</span>       <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>3</span><span class='hs-layout'>)</span>
<a name="line-672"></a><a name="error_badmagic"></a><span class='hs-definition'>error_badmagic</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-673"></a><span class='hs-definition'>error_badmagic</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>4</span><span class='hs-layout'>)</span>
<a name="line-674"></a><a name="error_unknown_node"></a><span class='hs-definition'>error_unknown_node</span>    <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-675"></a><span class='hs-definition'>error_unknown_node</span>    <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>5</span><span class='hs-layout'>)</span>
<a name="line-676"></a><a name="error_nomemory"></a><span class='hs-definition'>error_nomemory</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-677"></a><span class='hs-definition'>error_nomemory</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>6</span><span class='hs-layout'>)</span>
<a name="line-678"></a><a name="error_nosubstring"></a><span class='hs-definition'>error_nosubstring</span>     <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-679"></a><span class='hs-definition'>error_nosubstring</span>     <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>7</span><span class='hs-layout'>)</span>
<a name="line-680"></a><a name="error_matchlimit"></a><span class='hs-definition'>error_matchlimit</span>      <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-681"></a><span class='hs-definition'>error_matchlimit</span>      <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>8</span><span class='hs-layout'>)</span>
<a name="line-682"></a><a name="error_callout"></a><span class='hs-definition'>error_callout</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-683"></a><span class='hs-definition'>error_callout</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>9</span><span class='hs-layout'>)</span>
<a name="line-684"></a><a name="error_badutf8"></a><span class='hs-definition'>error_badutf8</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-685"></a><span class='hs-definition'>error_badutf8</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>10</span><span class='hs-layout'>)</span>
<a name="line-686"></a><a name="error_badutf8_offset"></a><span class='hs-definition'>error_badutf8_offset</span>  <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-687"></a><span class='hs-definition'>error_badutf8_offset</span>  <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>11</span><span class='hs-layout'>)</span>
<a name="line-688"></a><a name="error_partial"></a><span class='hs-definition'>error_partial</span>         <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-689"></a><span class='hs-definition'>error_partial</span>         <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>12</span><span class='hs-layout'>)</span>
<a name="line-690"></a><a name="error_badpartial"></a><span class='hs-definition'>error_badpartial</span>      <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-691"></a><span class='hs-definition'>error_badpartial</span>      <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>13</span><span class='hs-layout'>)</span>
<a name="line-692"></a><a name="error_internal"></a><span class='hs-definition'>error_internal</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-693"></a><span class='hs-definition'>error_internal</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>14</span><span class='hs-layout'>)</span>
<a name="line-694"></a><a name="error_badcount"></a><span class='hs-definition'>error_badcount</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-695"></a><span class='hs-definition'>error_badcount</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>15</span><span class='hs-layout'>)</span>
<a name="line-696"></a><a name="error_dfa_uitem"></a><span class='hs-definition'>error_dfa_uitem</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-697"></a><span class='hs-definition'>error_dfa_uitem</span>       <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>16</span><span class='hs-layout'>)</span>
<a name="line-698"></a><a name="error_dfa_ucond"></a><span class='hs-definition'>error_dfa_ucond</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-699"></a><span class='hs-definition'>error_dfa_ucond</span>       <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>17</span><span class='hs-layout'>)</span>
<a name="line-700"></a><a name="error_dfa_umlimit"></a><span class='hs-definition'>error_dfa_umlimit</span>     <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-701"></a><span class='hs-definition'>error_dfa_umlimit</span>     <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>18</span><span class='hs-layout'>)</span>
<a name="line-702"></a><a name="error_dfa_wssize"></a><span class='hs-definition'>error_dfa_wssize</span>      <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-703"></a><span class='hs-definition'>error_dfa_wssize</span>      <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>19</span><span class='hs-layout'>)</span>
<a name="line-704"></a><a name="error_dfa_recurse"></a><span class='hs-definition'>error_dfa_recurse</span>     <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-705"></a><span class='hs-definition'>error_dfa_recurse</span>     <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>20</span><span class='hs-layout'>)</span>
<a name="line-706"></a><a name="error_recursionlimit"></a><span class='hs-definition'>error_recursionlimit</span>  <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREError</span>
<a name="line-707"></a><span class='hs-definition'>error_recursionlimit</span>  <span class='hs-keyglyph'>=</span>  <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>21</span><span class='hs-layout'>)</span>
<a name="line-708"></a>
<a name="line-709"></a><span class='hs-comment'>{-# LINE 655 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-710"></a>
<a name="line-711"></a><span class='hs-comment'>--  , error_unknown_opcode = PCRE_ERROR_UNKNOWN_OPCODE</span>
<a name="line-712"></a><span class='hs-comment'>--  , error_nullwslimit    = PCRE_ERROR_NULLWSLIMIT</span>
<a name="line-713"></a><span class='hs-comment'>--  , error_badnewline     = PCRE_ERROR_BADNEWLINE</span>
<a name="line-714"></a>
<a name="line-715"></a><span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-716"></a><span class='hs-comment'>-- Request types for fullinfo() */</span>
<a name="line-717"></a>
<a name="line-718"></a><a name="PCREInfo"></a><span class='hs-comment'>-- | PCRE Info requests -- provides information about the compiled pattern.</span>
<a name="line-719"></a><a name="PCREInfo"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>PCREInfo</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>CInt</span>
<a name="line-720"></a>
<a name="line-721"></a><a name="info_options"></a><span class='hs-definition'>info_options</span>          <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-722"></a><span class='hs-definition'>info_options</span>          <span class='hs-keyglyph'>=</span>  <span class='hs-num'>0</span>
<a name="line-723"></a><a name="info_size"></a><span class='hs-definition'>info_size</span>             <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-724"></a><span class='hs-definition'>info_size</span>             <span class='hs-keyglyph'>=</span>  <span class='hs-num'>1</span>
<a name="line-725"></a><a name="info_capturecount"></a><span class='hs-definition'>info_capturecount</span>     <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-726"></a><span class='hs-definition'>info_capturecount</span>     <span class='hs-keyglyph'>=</span>  <span class='hs-num'>2</span>
<a name="line-727"></a><a name="info_backrefmax"></a><span class='hs-definition'>info_backrefmax</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-728"></a><span class='hs-definition'>info_backrefmax</span>       <span class='hs-keyglyph'>=</span>  <span class='hs-num'>3</span>
<a name="line-729"></a><a name="info_firstbyte"></a><span class='hs-definition'>info_firstbyte</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-730"></a><span class='hs-definition'>info_firstbyte</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-num'>4</span>
<a name="line-731"></a><a name="info_firstchar"></a><span class='hs-definition'>info_firstchar</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-732"></a><span class='hs-definition'>info_firstchar</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-num'>4</span>
<a name="line-733"></a><a name="info_firsttable"></a><span class='hs-definition'>info_firsttable</span>       <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-734"></a><span class='hs-definition'>info_firsttable</span>       <span class='hs-keyglyph'>=</span>  <span class='hs-num'>5</span>
<a name="line-735"></a><a name="info_lastliteral"></a><span class='hs-definition'>info_lastliteral</span>      <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-736"></a><span class='hs-definition'>info_lastliteral</span>      <span class='hs-keyglyph'>=</span>  <span class='hs-num'>6</span>
<a name="line-737"></a><a name="info_nameentrysize"></a><span class='hs-definition'>info_nameentrysize</span>    <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-738"></a><span class='hs-definition'>info_nameentrysize</span>    <span class='hs-keyglyph'>=</span>  <span class='hs-num'>7</span>
<a name="line-739"></a><a name="info_namecount"></a><span class='hs-definition'>info_namecount</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-740"></a><span class='hs-definition'>info_namecount</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-num'>8</span>
<a name="line-741"></a><a name="info_nametable"></a><span class='hs-definition'>info_nametable</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-742"></a><span class='hs-definition'>info_nametable</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-num'>9</span>
<a name="line-743"></a><a name="info_studysize"></a><span class='hs-definition'>info_studysize</span>        <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-744"></a><span class='hs-definition'>info_studysize</span>        <span class='hs-keyglyph'>=</span>  <span class='hs-num'>10</span>
<a name="line-745"></a><a name="info_default_tables"></a><span class='hs-definition'>info_default_tables</span>   <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-746"></a><span class='hs-definition'>info_default_tables</span>   <span class='hs-keyglyph'>=</span>  <span class='hs-num'>11</span>
<a name="line-747"></a>
<a name="line-748"></a><span class='hs-comment'>{-# LINE 681 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-749"></a>
<a name="line-750"></a><span class='hs-comment'>--  , info_okpartial       = PCRE_INFO_OKPARTIAL</span>
<a name="line-751"></a><span class='hs-comment'>--  , info_jchanged        = PCRE_INFO_JCHANGED</span>
<a name="line-752"></a><span class='hs-comment'>--  , info_hascrorlf       = PCRE_INFO_HASCRORLF</span>
<a name="line-753"></a>
<a name="line-754"></a><span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-755"></a>
<a name="line-756"></a><a name="PCREConfig"></a><span class='hs-comment'>-- | Request types for config()</span>
<a name="line-757"></a><a name="PCREConfig"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>PCREConfig</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>CInt</span>
<a name="line-758"></a>
<a name="line-759"></a><a name="config_utf8"></a><span class='hs-definition'>config_utf8</span>                    <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREConfig</span>
<a name="line-760"></a><span class='hs-definition'>config_utf8</span>                    <span class='hs-keyglyph'>=</span>  <span class='hs-num'>0</span>
<a name="line-761"></a><a name="config_newline"></a><span class='hs-definition'>config_newline</span>                 <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREConfig</span>
<a name="line-762"></a><span class='hs-definition'>config_newline</span>                 <span class='hs-keyglyph'>=</span>  <span class='hs-num'>1</span>
<a name="line-763"></a><a name="config_link_size"></a><span class='hs-definition'>config_link_size</span>               <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREConfig</span>
<a name="line-764"></a><span class='hs-definition'>config_link_size</span>               <span class='hs-keyglyph'>=</span>  <span class='hs-num'>2</span>
<a name="line-765"></a><a name="config_posix_malloc_threshold"></a><span class='hs-definition'>config_posix_malloc_threshold</span>  <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREConfig</span>
<a name="line-766"></a><span class='hs-definition'>config_posix_malloc_threshold</span>  <span class='hs-keyglyph'>=</span>  <span class='hs-num'>3</span>
<a name="line-767"></a><a name="config_match_limit"></a><span class='hs-definition'>config_match_limit</span>             <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREConfig</span>
<a name="line-768"></a><span class='hs-definition'>config_match_limit</span>             <span class='hs-keyglyph'>=</span>  <span class='hs-num'>4</span>
<a name="line-769"></a><a name="config_stackrecurse"></a><span class='hs-definition'>config_stackrecurse</span>            <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREConfig</span>
<a name="line-770"></a><span class='hs-definition'>config_stackrecurse</span>            <span class='hs-keyglyph'>=</span>  <span class='hs-num'>5</span>
<a name="line-771"></a><a name="config_unicode_properties"></a><span class='hs-definition'>config_unicode_properties</span>      <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREConfig</span>
<a name="line-772"></a><span class='hs-definition'>config_unicode_properties</span>      <span class='hs-keyglyph'>=</span>  <span class='hs-num'>6</span>
<a name="line-773"></a><a name="config_match_limit_recursion"></a><span class='hs-definition'>config_match_limit_recursion</span>   <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREConfig</span>
<a name="line-774"></a><span class='hs-definition'>config_match_limit_recursion</span>   <span class='hs-keyglyph'>=</span>  <span class='hs-num'>7</span>
<a name="line-775"></a>
<a name="line-776"></a><span class='hs-comment'>{-# LINE 701 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-777"></a>
<a name="line-778"></a><span class='hs-comment'>-- Not portable</span>
<a name="line-779"></a><span class='hs-comment'>--  , config_bsr                    = PCRE_CONFIG_BSR</span>
<a name="line-780"></a>
<a name="line-781"></a>
<a name="line-782"></a><span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-783"></a>
<a name="line-784"></a><a name="PCREExtra"></a><span class='hs-comment'>-- | PCREExtra.</span>
<a name="line-785"></a><a name="PCREExtra"></a><span class='hs-comment'>-- A extra structure contains the following fields:</span>
<a name="line-786"></a><a name="PCREExtra"></a><span class='hs-comment'>--</span>
<a name="line-787"></a><a name="PCREExtra"></a><span class='hs-comment'>-- * flags        Bits indicating which fields are set</span>
<a name="line-788"></a><a name="PCREExtra"></a><span class='hs-comment'>-- * study_data   Opaque data from study()</span>
<a name="line-789"></a><a name="PCREExtra"></a><span class='hs-comment'>-- * match_limit  Limit on internal resource use</span>
<a name="line-790"></a><a name="PCREExtra"></a><span class='hs-comment'>-- * match_limit_recursion  Limit on internal recursion depth</span>
<a name="line-791"></a><a name="PCREExtra"></a><span class='hs-comment'>-- * callout_data Opaque data passed back to callouts</span>
<a name="line-792"></a><a name="PCREExtra"></a><span class='hs-comment'>-- * tables       Points to character tables or is NULL</span>
<a name="line-793"></a><a name="PCREExtra"></a><span class='hs-comment'>--</span>
<a name="line-794"></a><a name="PCREExtra"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>PCREExtra</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>()</span>
<a name="line-795"></a>
<a name="line-796"></a><a name="PCREExtraFlags"></a><span class='hs-comment'>-- | PCREExtraFlags. bit flags for extra structure.</span>
<a name="line-797"></a><a name="PCREExtraFlags"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>PCREExtraFlags</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>CInt</span>
<a name="line-798"></a>
<a name="line-799"></a><a name="extra_study_data"></a><span class='hs-comment'>-- Bit flags for the extra structure. Do not re-arrange or redefine</span>
<a name="line-800"></a><span class='hs-comment'>-- these bits, just add new ones on the end, in order to remain compatible. */</span>
<a name="line-801"></a><span class='hs-definition'>extra_study_data</span>             <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExtraFlags</span>
<a name="line-802"></a><span class='hs-definition'>extra_study_data</span>             <span class='hs-keyglyph'>=</span>  <span class='hs-num'>1</span>
<a name="line-803"></a><a name="extra_match_limit"></a><span class='hs-definition'>extra_match_limit</span>            <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExtraFlags</span>
<a name="line-804"></a><span class='hs-definition'>extra_match_limit</span>            <span class='hs-keyglyph'>=</span>  <span class='hs-num'>2</span>
<a name="line-805"></a><a name="extra_callout_data"></a><span class='hs-definition'>extra_callout_data</span>           <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExtraFlags</span>
<a name="line-806"></a><span class='hs-definition'>extra_callout_data</span>           <span class='hs-keyglyph'>=</span>  <span class='hs-num'>4</span>
<a name="line-807"></a><a name="extra_tables"></a><span class='hs-definition'>extra_tables</span>                 <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExtraFlags</span>
<a name="line-808"></a><span class='hs-definition'>extra_tables</span>                 <span class='hs-keyglyph'>=</span>  <span class='hs-num'>8</span>
<a name="line-809"></a><a name="extra_match_limit_recursion"></a><span class='hs-definition'>extra_match_limit_recursion</span>  <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PCREExtraFlags</span>
<a name="line-810"></a><span class='hs-definition'>extra_match_limit_recursion</span>  <span class='hs-keyglyph'>=</span>  <span class='hs-num'>16</span>
<a name="line-811"></a>
<a name="line-812"></a><span class='hs-comment'>{-# LINE 732 "Text/Regex/PCRE/Light/Base.hsc" #-}</span>
<a name="line-813"></a>
<a name="line-814"></a><span class='hs-comment'>-- PCRE_EXP_DECL pcre *compile(const char *, int, const char **, int *, const unsigned char *);</span>
<a name="line-815"></a><span class='hs-comment'>-- PCRE_EXP_DECL int  config(int, void *);</span>
<a name="line-816"></a><span class='hs-comment'>-- PCRE_EXP_DECL int  exec(const pcre *, const extra *, PCRE_SPTR, int, int, int, int *, int);</span>
<a name="line-817"></a>
<a name="line-818"></a><span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-819"></a><span class='hs-comment'>-- C api</span>
<a name="line-820"></a>
<a name="line-821"></a><span class='hs-comment'>{-
<a name="line-822"></a>   pcre *pcre_compile(const char *pattern, int options,
<a name="line-823"></a>               const char **errptr, int *erroffset,
<a name="line-824"></a>               const unsigned char *tableptr);
<a name="line-825"></a>-}</span>
<a name="line-826"></a>
<a name="line-827"></a><span class='hs-comment'>-- | Compile a pattern to an internal form. The pattern is a C string</span>
<a name="line-828"></a><span class='hs-comment'>-- terminated by a binary zero. A pointer to a single block of memory that is</span>
<a name="line-829"></a><span class='hs-comment'>-- obtained via pcre_malloc is returned. It is up to the caller to free</span>
<a name="line-830"></a><span class='hs-comment'>-- the memory (via pcre_free) when it is no longer required</span>
<a name="line-831"></a><span class='hs-comment'>--</span>
<a name="line-832"></a><span class='hs-comment'>-- The options argument contains various bit settings that affect the</span>
<a name="line-833"></a><span class='hs-comment'>-- compilation. It should be zero if no options are required.</span>
<a name="line-834"></a><span class='hs-comment'>--</span>
<a name="line-835"></a><span class='hs-comment'>-- If errptr is NULL, pcre_compile() returns NULL immediately.</span>
<a name="line-836"></a><span class='hs-comment'>-- Otherwise, if compilation of a pattern fails, pcre_compile() returns NULL,</span>
<a name="line-837"></a><span class='hs-comment'>-- and sets the variable pointed to by errptr to point to a textual error</span>
<a name="line-838"></a><span class='hs-comment'>-- message.</span>
<a name="line-839"></a><span class='hs-comment'>--</span>
<a name="line-840"></a><span class='hs-comment'>-- The offset from the start of the pattern to the character where the error</span>
<a name="line-841"></a><span class='hs-comment'>-- was discovered is placed in the variable pointed to by erroffset, which must</span>
<a name="line-842"></a><span class='hs-comment'>-- not be NULL.</span>
<a name="line-843"></a><span class='hs-comment'>--</span>
<a name="line-844"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"pcre.h pcre_compile"</span>
<a name="line-845"></a>    <span class='hs-varid'>c_pcre_compile</span>  <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CString</span>
<a name="line-846"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>PCREOption</span>
<a name="line-847"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>CString</span>
<a name="line-848"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>CInt</span>
<a name="line-849"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>Word8</span>
<a name="line-850"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>PCRE</span><span class='hs-layout'>)</span>
<a name="line-851"></a>
<a name="line-852"></a><span class='hs-comment'>-- Additional fields to c_pcre_compile:</span>
<a name="line-853"></a><span class='hs-comment'>--</span>
<a name="line-854"></a><span class='hs-comment'>--    errptr        Where to put an error message</span>
<a name="line-855"></a><span class='hs-comment'>--    erroffset     Offset in pattern where error was found</span>
<a name="line-856"></a><span class='hs-comment'>--    tableptr      Pointer to character tables, or NULL to to use built in</span>
<a name="line-857"></a>
<a name="line-858"></a><span class='hs-comment'>{-
<a name="line-859"></a>       int pcre_exec(const pcre *code, const pcre_extra *extra,
<a name="line-860"></a>            const char *subject, int length, int startoffset,
<a name="line-861"></a>            int options, int *ovector, int ovecsize);
<a name="line-862"></a>-}</span>
<a name="line-863"></a>
<a name="line-864"></a><span class='hs-comment'>-- | This function matches a compiled regular expression</span>
<a name="line-865"></a><span class='hs-comment'>-- against a given subject string, using a matching algorithm</span>
<a name="line-866"></a><span class='hs-comment'>-- that is similar to Perl's. It returns offsets to captured</span>
<a name="line-867"></a><span class='hs-comment'>-- substrings.</span>
<a name="line-868"></a><span class='hs-comment'>--</span>
<a name="line-869"></a><span class='hs-comment'>-- Its arguments are, in order:</span>
<a name="line-870"></a><span class='hs-comment'>--</span>
<a name="line-871"></a><span class='hs-comment'>-- * 'code'        Points to the compiled pattern (result of pcre_compile)</span>
<a name="line-872"></a><span class='hs-comment'>--</span>
<a name="line-873"></a><span class='hs-comment'>-- * 'extra'       Points to an associated pcre_extra structure (result of pcre_study), or is NULL</span>
<a name="line-874"></a><span class='hs-comment'>--</span>
<a name="line-875"></a><span class='hs-comment'>-- * 'subject'      Points to the subject string</span>
<a name="line-876"></a><span class='hs-comment'>--</span>
<a name="line-877"></a><span class='hs-comment'>-- * 'length'       Length of the subject string, in bytes</span>
<a name="line-878"></a><span class='hs-comment'>--</span>
<a name="line-879"></a><span class='hs-comment'>-- * 'startoffset'  Offset in bytes in the subject at which to start matching</span>
<a name="line-880"></a><span class='hs-comment'>--</span>
<a name="line-881"></a><span class='hs-comment'>-- * 'options'      Option bits</span>
<a name="line-882"></a><span class='hs-comment'>--</span>
<a name="line-883"></a><span class='hs-comment'>-- * 'ovector'      Points to a vector of ints for result substrings</span>
<a name="line-884"></a><span class='hs-comment'>--</span>
<a name="line-885"></a><span class='hs-comment'>-- * 'ovecsize'     Number of elements in the vector (a  multiple of 3)</span>
<a name="line-886"></a><span class='hs-comment'>--</span>
<a name="line-887"></a><span class='hs-comment'>-- Note, subject not required to be null terminated.</span>
<a name="line-888"></a><span class='hs-comment'>--</span>
<a name="line-889"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"pcre.h pcre_exec"</span>
<a name="line-890"></a>    <span class='hs-varid'>c_pcre_exec</span>     <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>PCRE</span>
<a name="line-891"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>PCREExtra</span>
<a name="line-892"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>Word8</span>
<a name="line-893"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>CInt</span>
<a name="line-894"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>CInt</span>
<a name="line-895"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>PCREExecOption</span>
<a name="line-896"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>CInt</span>
<a name="line-897"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>CInt</span>
<a name="line-898"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>CInt</span>
<a name="line-899"></a>
<a name="line-900"></a><span class='hs-comment'>-- | Return information about a compiled pattern</span>
<a name="line-901"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"pcre.h pcre_fullinfo"</span>
<a name="line-902"></a>    <span class='hs-varid'>c_pcre_fullinfo</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>PCRE</span>
<a name="line-903"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>PCREExtra</span>
<a name="line-904"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>PCREInfo</span>
<a name="line-905"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Ptr</span> <span class='hs-varid'>a</span>
<a name="line-906"></a>                    <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>CInt</span>
<a name="line-907"></a>
</pre></body>
</html>

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