Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.Regex.PCRE2.Wrap

Contents

High-level interface
Low-level interface
Miscellaneous
CompOption values
ReturnCode values

Description

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

Synopsis

data Regex
newtype CompOption = CompOption Word32
newtype MatchOption = MatchOption Word32
(=~) :: (RegexMaker Regex CompOption MatchOption source, RegexContext Regex source1 target) => source1 -> source -> target
(=~~) :: (RegexMaker Regex CompOption MatchOption source, RegexContext Regex source1 target, MonadFail m) => source1 -> source -> m target
type StartOffset = MatchOffset
type EndOffset = MatchOffset
newtype ReturnCode = ReturnCode CInt
type WrapError = (ReturnCode, String)
wrapCompile :: CompOption -> MatchOption -> CStringLen -> IO (Either (MatchOffset, String) Regex)
wrapTest :: StartOffset -> Regex -> CStringLen -> IO (Either WrapError Bool)
wrapMatch :: StartOffset -> Regex -> CStringLen -> IO (Either WrapError (Maybe [(StartOffset, EndOffset)]))
wrapMatchAll :: Regex -> CStringLen -> IO (Either WrapError [MatchArray])
wrapCount :: Regex -> CStringLen -> IO (Either WrapError Int)
getVersion :: Maybe String
getNumSubs :: Regex -> Int
unusedOffset :: MatchOffset
compBlank :: CompOption
compAnchored :: CompOption
compEndAnchored :: CompOption
compAllowEmptyClass :: CompOption
compAltBSUX :: CompOption
compAltExtendedClass :: CompOption
compAltVerbnames :: CompOption
compAutoCallout :: CompOption
compCaseless :: CompOption
compDollarEndOnly :: CompOption
compDotAll :: CompOption
compDupNames :: CompOption
compExtended :: CompOption
compExtendedMore :: CompOption
compFirstLine :: CompOption
compLiteral :: CompOption
compMatchUnsetBackref :: CompOption
compMultiline :: CompOption
compNeverBackslashC :: CompOption
compNoAutoCapture :: CompOption
compNoAutoPossess :: CompOption
compNoDotstarAnchor :: CompOption
compNoUTFCheck :: CompOption
compUngreedy :: CompOption
compUTF :: CompOption
matchBlank :: MatchOption
matchAnchored :: MatchOption
matchCopyMatchedSubject :: MatchOption
matchDisableRecurseLoopCheck :: MatchOption
matchEndAnchored :: MatchOption
matchNotBOL :: MatchOption
matchNotEOL :: MatchOption
matchNotEmpty :: MatchOption
matchNotEmptyAtStart :: MatchOption
matchNoUTFCheck :: MatchOption
matchPartialHard :: MatchOption
matchPartialSoft :: MatchOption
retOk :: ReturnCode
retNoMatch :: ReturnCode
retPartial :: ReturnCode
retNull :: ReturnCode
retBadOption :: ReturnCode
retBadMagic :: ReturnCode
retNoMemory :: ReturnCode
retNoSubstring :: ReturnCode

High-level interface

data Regex Source #

A compiled regular expression

Instances

Instances details

RegexLike Regex ByteString Source #
Instance details Defined in Text.Regex.PCRE2.ByteString Methods matchOnce :: Regex -> ByteString -> Maybe MatchArray # matchAll :: Regex -> ByteString -> [MatchArray] # matchCount :: Regex -> ByteString -> Int # matchTest :: Regex -> ByteString -> Bool # matchAllText :: Regex -> ByteString -> [MatchText ByteString] # matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString) #
RegexLike Regex ByteString Source #
Instance details Defined in Text.Regex.PCRE2.ByteString.Lazy Methods matchOnce :: Regex -> ByteString -> Maybe MatchArray # matchAll :: Regex -> ByteString -> [MatchArray] # matchCount :: Regex -> ByteString -> Int # matchTest :: Regex -> ByteString -> Bool # matchAllText :: Regex -> ByteString -> [MatchText ByteString] # matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString) #
RegexLike Regex String Source #
Instance details Defined in Text.Regex.PCRE2.String Methods matchOnce :: Regex -> String -> Maybe MatchArray # matchAll :: Regex -> String -> [MatchArray] # matchCount :: Regex -> String -> Int # matchTest :: Regex -> String -> Bool # matchAllText :: Regex -> String -> [MatchText String] # matchOnceText :: Regex -> String -> Maybe (String, MatchText String, String) #
RegexContext Regex ByteString ByteString Source #
Instance details Defined in Text.Regex.PCRE2.ByteString Methods match :: Regex -> ByteString -> ByteString # matchM :: MonadFail m => Regex -> ByteString -> m ByteString #
RegexContext Regex ByteString ByteString Source #
Instance details Defined in Text.Regex.PCRE2.ByteString.Lazy Methods match :: Regex -> ByteString -> ByteString # matchM :: MonadFail m => Regex -> ByteString -> m ByteString #
RegexContext Regex String String Source #
Instance details Defined in Text.Regex.PCRE2.String Methods match :: Regex -> String -> String # matchM :: MonadFail m => Regex -> String -> m String #
RegexOptions Regex CompOption MatchOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods blankCompOpt :: CompOption # blankExecOpt :: MatchOption # defaultCompOpt :: CompOption # defaultExecOpt :: MatchOption # setExecOpts :: MatchOption -> Regex -> Regex # getExecOpts :: Regex -> MatchOption #
RegexMaker Regex CompOption MatchOption ByteString Source #
Instance details Defined in Text.Regex.PCRE2.ByteString Methods makeRegex :: ByteString -> Regex # makeRegexOpts :: CompOption -> MatchOption -> ByteString -> Regex # makeRegexM :: MonadFail m => ByteString -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> ByteString -> m Regex #
RegexMaker Regex CompOption MatchOption ByteString Source #
Instance details Defined in Text.Regex.PCRE2.ByteString.Lazy Methods makeRegex :: ByteString -> Regex # makeRegexOpts :: CompOption -> MatchOption -> ByteString -> Regex # makeRegexM :: MonadFail m => ByteString -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> ByteString -> m Regex #
RegexMaker Regex CompOption MatchOption String Source #
Instance details Defined in Text.Regex.PCRE2.String Methods makeRegex :: String -> Regex # makeRegexOpts :: CompOption -> MatchOption -> String -> Regex # makeRegexM :: MonadFail m => String -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> String -> m Regex #
RegexMaker Regex CompOption MatchOption (Seq Char) Source #
Instance details Defined in Text.Regex.PCRE2.Sequence Methods makeRegex :: Seq Char -> Regex # makeRegexOpts :: CompOption -> MatchOption -> Seq Char -> Regex # makeRegexM :: MonadFail m => Seq Char -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> Seq Char -> m Regex #
RegexLike Regex (Seq Char) Source #
Instance details Defined in Text.Regex.PCRE2.Sequence Methods matchOnce :: Regex -> Seq Char -> Maybe MatchArray # matchAll :: Regex -> Seq Char -> [MatchArray] # matchCount :: Regex -> Seq Char -> Int # matchTest :: Regex -> Seq Char -> Bool # matchAllText :: Regex -> Seq Char -> [MatchText (Seq Char)] # matchOnceText :: Regex -> Seq Char -> Maybe (Seq Char, MatchText (Seq Char), Seq Char) #
RegexContext Regex (Seq Char) (Seq Char) Source #
Instance details Defined in Text.Regex.PCRE2.Sequence Methods match :: Regex -> Seq Char -> Seq Char # matchM :: MonadFail m => Regex -> Seq Char -> m (Seq Char) #

newtype CompOption Source #

Constructors

CompOption Word32

Instances

Instances details

Bits CompOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods (.&.) :: CompOption -> CompOption -> CompOption # (.\|.) :: CompOption -> CompOption -> CompOption # xor :: CompOption -> CompOption -> CompOption # complement :: CompOption -> CompOption # shift :: CompOption -> Int -> CompOption # rotate :: CompOption -> Int -> CompOption # zeroBits :: CompOption # bit :: Int -> CompOption # setBit :: CompOption -> Int -> CompOption # clearBit :: CompOption -> Int -> CompOption # complementBit :: CompOption -> Int -> CompOption # testBit :: CompOption -> Int -> Bool # bitSizeMaybe :: CompOption -> Maybe Int # bitSize :: CompOption -> Int # isSigned :: CompOption -> Bool # shiftL :: CompOption -> Int -> CompOption # unsafeShiftL :: CompOption -> Int -> CompOption # shiftR :: CompOption -> Int -> CompOption # unsafeShiftR :: CompOption -> Int -> CompOption # rotateL :: CompOption -> Int -> CompOption # rotateR :: CompOption -> Int -> CompOption # popCount :: CompOption -> Int #
Num CompOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods (+) :: CompOption -> CompOption -> CompOption # (-) :: CompOption -> CompOption -> CompOption # (*) :: CompOption -> CompOption -> CompOption # negate :: CompOption -> CompOption # abs :: CompOption -> CompOption # signum :: CompOption -> CompOption # fromInteger :: Integer -> CompOption #
Show CompOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods showsPrec :: Int -> CompOption -> ShowS # show :: CompOption -> String # showList :: [CompOption] -> ShowS #
Eq CompOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods (==) :: CompOption -> CompOption -> Bool # (/=) :: CompOption -> CompOption -> Bool #
RegexOptions Regex CompOption MatchOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods blankCompOpt :: CompOption # blankExecOpt :: MatchOption # defaultCompOpt :: CompOption # defaultExecOpt :: MatchOption # setExecOpts :: MatchOption -> Regex -> Regex # getExecOpts :: Regex -> MatchOption #
RegexMaker Regex CompOption MatchOption ByteString Source #
Instance details Defined in Text.Regex.PCRE2.ByteString Methods makeRegex :: ByteString -> Regex # makeRegexOpts :: CompOption -> MatchOption -> ByteString -> Regex # makeRegexM :: MonadFail m => ByteString -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> ByteString -> m Regex #
RegexMaker Regex CompOption MatchOption ByteString Source #
Instance details Defined in Text.Regex.PCRE2.ByteString.Lazy Methods makeRegex :: ByteString -> Regex # makeRegexOpts :: CompOption -> MatchOption -> ByteString -> Regex # makeRegexM :: MonadFail m => ByteString -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> ByteString -> m Regex #
RegexMaker Regex CompOption MatchOption String Source #
Instance details Defined in Text.Regex.PCRE2.String Methods makeRegex :: String -> Regex # makeRegexOpts :: CompOption -> MatchOption -> String -> Regex # makeRegexM :: MonadFail m => String -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> String -> m Regex #
RegexMaker Regex CompOption MatchOption (Seq Char) Source #
Instance details Defined in Text.Regex.PCRE2.Sequence Methods makeRegex :: Seq Char -> Regex # makeRegexOpts :: CompOption -> MatchOption -> Seq Char -> Regex # makeRegexM :: MonadFail m => Seq Char -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> Seq Char -> m Regex #

newtype MatchOption Source #

Constructors

MatchOption Word32

Instances

Instances details

Bits MatchOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods (.&.) :: MatchOption -> MatchOption -> MatchOption # (.\|.) :: MatchOption -> MatchOption -> MatchOption # xor :: MatchOption -> MatchOption -> MatchOption # complement :: MatchOption -> MatchOption # shift :: MatchOption -> Int -> MatchOption # rotate :: MatchOption -> Int -> MatchOption # zeroBits :: MatchOption # bit :: Int -> MatchOption # setBit :: MatchOption -> Int -> MatchOption # clearBit :: MatchOption -> Int -> MatchOption # complementBit :: MatchOption -> Int -> MatchOption # testBit :: MatchOption -> Int -> Bool # bitSizeMaybe :: MatchOption -> Maybe Int # bitSize :: MatchOption -> Int # isSigned :: MatchOption -> Bool # shiftL :: MatchOption -> Int -> MatchOption # unsafeShiftL :: MatchOption -> Int -> MatchOption # shiftR :: MatchOption -> Int -> MatchOption # unsafeShiftR :: MatchOption -> Int -> MatchOption # rotateL :: MatchOption -> Int -> MatchOption # rotateR :: MatchOption -> Int -> MatchOption # popCount :: MatchOption -> Int #
Num MatchOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods (+) :: MatchOption -> MatchOption -> MatchOption # (-) :: MatchOption -> MatchOption -> MatchOption # (*) :: MatchOption -> MatchOption -> MatchOption # negate :: MatchOption -> MatchOption # abs :: MatchOption -> MatchOption # signum :: MatchOption -> MatchOption # fromInteger :: Integer -> MatchOption #
Show MatchOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods showsPrec :: Int -> MatchOption -> ShowS # show :: MatchOption -> String # showList :: [MatchOption] -> ShowS #
Eq MatchOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods (==) :: MatchOption -> MatchOption -> Bool # (/=) :: MatchOption -> MatchOption -> Bool #
RegexOptions Regex CompOption MatchOption Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods blankCompOpt :: CompOption # blankExecOpt :: MatchOption # defaultCompOpt :: CompOption # defaultExecOpt :: MatchOption # setExecOpts :: MatchOption -> Regex -> Regex # getExecOpts :: Regex -> MatchOption #
RegexMaker Regex CompOption MatchOption ByteString Source #
Instance details Defined in Text.Regex.PCRE2.ByteString Methods makeRegex :: ByteString -> Regex # makeRegexOpts :: CompOption -> MatchOption -> ByteString -> Regex # makeRegexM :: MonadFail m => ByteString -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> ByteString -> m Regex #
RegexMaker Regex CompOption MatchOption ByteString Source #
Instance details Defined in Text.Regex.PCRE2.ByteString.Lazy Methods makeRegex :: ByteString -> Regex # makeRegexOpts :: CompOption -> MatchOption -> ByteString -> Regex # makeRegexM :: MonadFail m => ByteString -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> ByteString -> m Regex #
RegexMaker Regex CompOption MatchOption String Source #
Instance details Defined in Text.Regex.PCRE2.String Methods makeRegex :: String -> Regex # makeRegexOpts :: CompOption -> MatchOption -> String -> Regex # makeRegexM :: MonadFail m => String -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> String -> m Regex #
RegexMaker Regex CompOption MatchOption (Seq Char) Source #
Instance details Defined in Text.Regex.PCRE2.Sequence Methods makeRegex :: Seq Char -> Regex # makeRegexOpts :: CompOption -> MatchOption -> Seq Char -> Regex # makeRegexM :: MonadFail m => Seq Char -> m Regex # makeRegexOptsM :: MonadFail m => CompOption -> MatchOption -> Seq Char -> m Regex #

(=~) :: (RegexMaker Regex CompOption MatchOption source, RegexContext Regex source1 target) => source1 -> source -> target Source #

(=~~) :: (RegexMaker Regex CompOption MatchOption source, RegexContext Regex source1 target, MonadFail m) => source1 -> source -> m target Source #

Low-level interface

type StartOffset = MatchOffset Source #

type EndOffset = MatchOffset Source #

newtype ReturnCode Source #

Constructors

ReturnCode CInt

Instances

Instances details

Show ReturnCode Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods showsPrec :: Int -> ReturnCode -> ShowS # show :: ReturnCode -> String # showList :: [ReturnCode] -> ShowS #
Eq ReturnCode Source #
Instance details Defined in Text.Regex.PCRE2.Wrap Methods (==) :: ReturnCode -> ReturnCode -> Bool # (/=) :: ReturnCode -> ReturnCode -> Bool #

type WrapError = (ReturnCode, String) Source #

wrapCompile Source #

Arguments

:: CompOption	Flags (summed together)
-> MatchOption	Flags (summed together)
-> CStringLen	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

wrapTest Source #

Arguments

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

wrapMatch Source #

Arguments

:: 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