Moduleregex-pcre-builtin-0.95.2.3.8.44Haskell2010

Text.Regex.PCRE.Wrap

This will fail or error only if allocation fails or a nullPtr is passed in.

7 types
40 values

Packageregex-pcre-builtin-0.95.2.3.8.44
Exports47
LanguageHaskell2010
LicenceBSD-3-Clause
SourceWrap.hsc

High-level interface

5 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

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

value(=~)

:: (RegexMaker Regex CompOption ExecOption source, RegexContext Regex source1 target)
=> source1
-> source
-> target

value(=~~)

:: (RegexMaker Regex CompOption ExecOption source, RegexContext Regex source1 target, MonadFail m)
=> source1
-> source
-> m target

Low-level interface

9 declarations

typetype StartOffset = MatchOffset

typetype EndOffset = MatchOffset

newtypenewtype ReturnCode

Constructors

ReturnCode CInt

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)

valuewrapCompile

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

Compiles a regular expression

valuewrapTest

:: StartOffset
Starting index in CStringLen
-> Regex
Compiled regular expression
-> CStringLen
String to match against and length in bytes
-> IO (Either WrapError Bool)

valuewrapMatch

:: StartOffset
Starting index in CStringLen
-> Regex
Compiled regular expression
-> CStringLen
String to match against and length in bytes
-> IO (Either WrapError (Maybe [(StartOffset, EndOffset)]))
Returns: 'Right Nothing' if the regex did not match the string, or: 'Right Just' an array of (offset,length) pairs where index 0 is whole match, and the rest are the captured subexpressions, or: 'Left ReturnCode' if there is some strange error

Matches a regular expression against a string

Should never return (Right (Just []))

valuewrapMatchAll :: Regex -> CStringLen -> IO (Either WrapError [MatchArray])

wrapMatchAll is an improvement over wrapMatch since it only allocates memory with allocaBytes once at the start.

valuewrapCount :: Regex -> CStringLen -> IO (Either WrapError Int)

Miscellaneous

4 declarations

valuegetVersion :: Maybe String

Version string of PCRE library

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

valueconfigUTF8 :: Bool

valuegetNumSubs :: Regex -> Int

valueunusedOffset :: MatchOffset

CompOption values

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 values

7 declarations

valueexecBlank :: ExecOption

valueexecAnchored :: ExecOption

valueexecNotBOL :: ExecOption

valueexecNotEOL :: ExecOption

valueexecNotEmpty :: ExecOption

valueexecNoUTF8Check :: ExecOption

valueexecPartial :: ExecOption

ReturnCode values

8 declarations

valueretOk :: ReturnCode

valueretNoMatch :: ReturnCode

valueretNull :: ReturnCode

valueretBadOption :: ReturnCode

valueretBadMagic :: ReturnCode

valueretUnknownNode :: ReturnCode

valueretNoMemory :: ReturnCode

valueretNoSubstring :: ReturnCode