Moduleregex-pcre-builtin-0.95.2.3.8.44Haskell2010

Text.Regex.PCRE.Text

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

7 types
26 values

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

Types

7 declarations

datadata Regex

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

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

typetype MatchLength = Int

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

2 declarations

valueunusedOffset :: MatchOffset

valuegetVersion :: Maybe String

Version string of PCRE library

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

Medium level API functions

3 declarations

valuecompile

:: CompOption
(summed together)
-> ExecOption
(summed together)
-> Text
The regular expression to compile
-> IO (Either (MatchOffset, String) Regex)
Returns: the compiled regular expression

Compiles a regular expression

valueexecute

:: Regex
Compiled regular expression
-> Text
Text 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.

Matches a regular expression against a string

valueregexec

:: Regex
Compiled regular expression
-> Text
Text to match against
-> IO (Either WrapError (Maybe (Text, Text, Text, [Text])))
Returns: Nothing if the regex did not match the string, or Just text including before and after text

Matches a regular expression against a string

CompOption flags

14 declarations

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

ExecOption flags

7 declarations

valueexecBlank :: ExecOption

valueexecAnchored :: ExecOption

valueexecNotBOL :: ExecOption

valueexecNotEOL :: ExecOption

valueexecNotEmpty :: ExecOption

valueexecNoUTF8Check :: ExecOption

valueexecPartial :: ExecOption

Orphan instances

3 instances

RegexLike Regex Text
RegexContext Regex Text Text
RegexMaker Regex CompOption ExecOption Text