Moduleregex-pcre-builtin-0.95.2.3.8.44Haskell2010

Text.Regex.PCRE.Sequence

This exports instances of the high level API and the medium level API of compile,execute, and regexec.

Contents

Types
Miscellaneous
Medium level API functions
Constants for CompOption
Constants for ExecOption

Synopsis

data Regex
type MatchOffset
type MatchLength
newtype CompOption
newtype ExecOption
newtype ReturnCode
type WrapError
value unusedOffset
value getVersion
value compile
value execute
value regexec
value compBlank
value compAnchored
value compAutoCallout
value compCaseless
value compDollarEndOnly
value compDotAll
value compExtended
value compExtra
value compFirstLine
value compMultiline
value compNoAutoCapture
value compUngreedy
value compUTF8
value compNoUTF8Check
value execBlank
value execAnchored
value execNotBOL
value execNotEOL
value execNotEmpty
value execNoUTF8Check
value execPartial

Packageregex-pcre-builtin-0.95.2.3.8.44
Exports33
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSequence.hs

Types

datadata Regex

Source#

A compiled regular expression

Instances19RegexOptions, RegexMaker, RegexLike, RegexContext, …

RegexLike Regex ByteStringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.ByteString · orphan
RegexLike Regex ByteStringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.ByteString.Lazy · orphan
RegexLike Regex StringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.String · orphan
RegexLike Regex TextDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Text · orphan
RegexLike Regex TextDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Text.Lazy · orphan
RegexContext Regex ByteString ByteStringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.ByteString · orphan
RegexContext Regex ByteString ByteStringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.ByteString.Lazy · orphan
RegexContext Regex String StringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.String · orphan
RegexContext Regex Text TextDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Text · orphan
RegexContext Regex Text TextDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Text.Lazy · orphan
RegexOptions Regex CompOption ExecOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.ByteString · orphan
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.ByteString.Lazy · orphan
RegexMaker Regex CompOption ExecOption StringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.String · orphan
RegexMaker Regex CompOption ExecOption TextDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Text · orphan
RegexMaker Regex CompOption ExecOption TextDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Text.Lazy · orphan
RegexMaker Regex CompOption ExecOption (Seq Char)Defined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Sequence · orphan
RegexLike Regex (Seq Char)Defined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Sequence · orphan
RegexContext Regex (Seq Char) (Seq Char)Defined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Sequence · orphan

typetype MatchOffset = Int

Source#

0 based index from start of source, or (-1) for unused

typetype MatchLength = Int

Source#

non-negative length of a match

newtypenewtype CompOption

Constructors

CompOption CInt

Instances11Eq, Num, Show, Bits, RegexOptions, RegexMaker, …

Eq CompOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
Num CompOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
Show CompOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
Bits CompOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
RegexOptions Regex CompOption ExecOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.ByteString · orphan
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.ByteString.Lazy · orphan
RegexMaker Regex CompOption ExecOption StringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.String · orphan
RegexMaker Regex CompOption ExecOption TextDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Text · orphan
RegexMaker Regex CompOption ExecOption TextDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Text.Lazy · orphan
RegexMaker Regex CompOption ExecOption (Seq Char)Defined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Sequence · orphan

newtypenewtype ExecOption

Constructors

ExecOption CInt

Instances11Eq, Num, Show, Bits, RegexOptions, RegexMaker, …

Eq ExecOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
Num ExecOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
Show ExecOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
Bits ExecOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
RegexOptions Regex CompOption ExecOptionDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.ByteString · orphan
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.ByteString.Lazy · orphan
RegexMaker Regex CompOption ExecOption StringDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.String · orphan
RegexMaker Regex CompOption ExecOption TextDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Text · orphan
RegexMaker Regex CompOption ExecOption TextDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Text.Lazy · orphan
RegexMaker Regex CompOption ExecOption (Seq Char)Defined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Sequence · orphan

newtypenewtype ReturnCode

Instances2Eq, Show

Eq ReturnCodeDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap
Show ReturnCodeDefined in regex-pcre-builtin-0.95.2.3.8.44 · Text.Regex.PCRE.Wrap

typetype WrapError = (ReturnCode, String)

Miscellaneous

valueunusedOffset :: MatchOffset

valuegetVersion :: Maybe String

Source#

Version string of PCRE library

NOTE: The Maybe type is used for historic reasons; practically, getVersion is never Nothing.

Medium level API functions

valuecompile

:: CompOption
Flags (summed together)
-> ExecOption
Flags (summed together)
-> Seq Char
The regular expression to compile
-> IO (Either (MatchOffset, String) Regex)
Returns: an error string and offset or the compiled regular expression

Source#

Compiles a regular expression

valueexecute

:: Regex
Compiled regular expression
-> Seq Char
(Seq Char) to match against
-> IO (Either WrapError (Maybe (Array Int (MatchOffset, MatchLength))))
Returns: Nothing if the regex did not match the string, or: Just an array of (offset,length) pairs where index 0 is whole match, and the rest are the captured subexpressions.

Source#

Matches a regular expression against a string

valueregexec

:: Regex
compiled regular expression
-> Seq Char
string to match
-> IO (Either WrapError (Maybe (Seq Char, Seq Char, Seq Char, [Seq Char])))
Returns: Nothing if no match, else (text before match, text after match, array of matches with 0 being the whole match)

Source#

execute match and extract substrings rather than just offsets

Constants for CompOption

valuecompBlank :: CompOption

valuecompAnchored :: CompOption

valuecompAutoCallout :: CompOption

valuecompCaseless :: CompOption

valuecompDollarEndOnly :: CompOption

valuecompDotAll :: CompOption

valuecompExtended :: CompOption

valuecompExtra :: CompOption

valuecompFirstLine :: CompOption

valuecompMultiline :: CompOption

valuecompNoAutoCapture :: CompOption

valuecompUngreedy :: CompOption

valuecompUTF8 :: CompOption

valuecompNoUTF8Check :: CompOption

Constants for ExecOption

valueexecBlank :: ExecOption

valueexecAnchored :: ExecOption

valueexecNotBOL :: ExecOption

valueexecNotEOL :: ExecOption

valueexecNotEmpty :: ExecOption

valueexecNoUTF8Check :: ExecOption

valueexecPartial :: ExecOption

Orphan instances

3 instances

RegexMaker Regex CompOption ExecOption (Seq Char)
RegexLike Regex (Seq Char)
RegexContext Regex (Seq Char) (Seq Char)