Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.Regex.PCRE.ByteString.Lazy

Contents

Types
Miscellaneous
Medium level API functions
CompOption flags
ExecOption flags
Orphan instances

Description

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

Synopsis

data Regex
type MatchOffset = Int
type MatchLength = Int
newtype CompOption = CompOption CInt
newtype ExecOption = ExecOption CInt
data ReturnCode
type WrapError = (ReturnCode, String)
unusedOffset :: MatchOffset
getVersion :: Maybe String
compile :: CompOption -> ExecOption -> ByteString -> IO (Either (MatchOffset, String) Regex)
execute :: Regex -> ByteString -> IO (Either WrapError (Maybe (Array Int (MatchOffset, MatchLength))))
regexec :: Regex -> ByteString -> IO (Either WrapError (Maybe (ByteString, ByteString, ByteString, [ByteString])))
compBlank :: CompOption
compAnchored :: CompOption
compAutoCallout :: CompOption
compCaseless :: CompOption
compDollarEndOnly :: CompOption
compDotAll :: CompOption
compExtended :: CompOption
compExtra :: CompOption
compFirstLine :: CompOption
compMultiline :: CompOption
compNoAutoCapture :: CompOption
compUngreedy :: CompOption
compUTF8 :: CompOption
compNoUTF8Check :: CompOption
execBlank :: ExecOption
execAnchored :: ExecOption
execNotBOL :: ExecOption
execNotEOL :: ExecOption
execNotEmpty :: ExecOption
execNoUTF8Check :: ExecOption
execPartial :: ExecOption

Types

data Regex Source #

A compiled regular expression

Instances

Instances details

RegexLike Regex ByteString
Instance details Defined in Text.Regex.PCRE.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
Instance details Defined in Text.Regex.PCRE.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
Instance details Defined in Text.Regex.PCRE.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
Instance details Defined in Text.Regex.PCRE.ByteString Methods match :: Regex -> ByteString -> ByteString matchM :: MonadFail m => Regex -> ByteString -> m ByteString
RegexContext Regex ByteString ByteString
Instance details Defined in Text.Regex.PCRE.ByteString.Lazy Methods match :: Regex -> ByteString -> ByteString matchM :: MonadFail m => Regex -> ByteString -> m ByteString
RegexContext Regex String String
Instance details Defined in Text.Regex.PCRE.String Methods match :: Regex -> String -> String matchM :: MonadFail m => Regex -> String -> m String
RegexOptions Regex CompOption ExecOption Source #
Instance details Defined in Text.Regex.PCRE.Wrap Methods blankCompOpt :: CompOption blankExecOpt :: ExecOption defaultCompOpt :: CompOption defaultExecOpt :: ExecOption setExecOpts :: ExecOption -> Regex -> Regex getExecOpts :: Regex -> ExecOption
RegexMaker Regex CompOption ExecOption ByteString
Instance details Defined in Text.Regex.PCRE.ByteString Methods makeRegex :: ByteString -> Regex makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex makeRegexM :: MonadFail m => ByteString -> m Regex makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex
RegexMaker Regex CompOption ExecOption ByteString
Instance details Defined in Text.Regex.PCRE.ByteString.Lazy Methods makeRegex :: ByteString -> Regex makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex makeRegexM :: MonadFail m => ByteString -> m Regex makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex
RegexMaker Regex CompOption ExecOption String
Instance details Defined in Text.Regex.PCRE.String Methods makeRegex :: String -> Regex makeRegexOpts :: CompOption -> ExecOption -> String -> Regex makeRegexM :: MonadFail m => String -> m Regex makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex
RegexMaker Regex CompOption ExecOption (Seq Char)
Instance details Defined in Text.Regex.PCRE.Sequence Methods makeRegex :: Seq Char -> Regex makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex makeRegexM :: MonadFail m => Seq Char -> m Regex makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex
RegexLike Regex (Seq Char)
Instance details Defined in Text.Regex.PCRE.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)
Instance details Defined in Text.Regex.PCRE.Sequence Methods match :: Regex -> Seq Char -> Seq Char matchM :: MonadFail m => Regex -> Seq Char -> m (Seq Char)

type MatchOffset = Int #

type MatchLength = Int #

newtype CompOption Source #

Constructors

CompOption CInt

Instances

Instances details

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

newtype ExecOption Source #

Constructors

ExecOption CInt

Instances

Instances details

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

data ReturnCode Source #

Instances

Instances details

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

type WrapError = (ReturnCode, String) Source #

Miscellaneous

unusedOffset :: MatchOffset Source #

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

compile Source #

Arguments

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

Compiles a regular expression

execute Source #

Arguments

:: Regex	Compiled regular expression
-> ByteString	String 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 buffer, returning the buffer indicies of the match, and any submatches

| Matches a regular expression against a string

regexec Source #

Arguments

:: Regex	Compiled regular expression
-> ByteString	String to match against
-> IO (Either WrapError (Maybe (ByteString, ByteString, ByteString, [ByteString])))

CompOption flags

compBlank :: CompOption Source #

compAnchored :: CompOption Source #

compAutoCallout :: CompOption Source #

compCaseless :: CompOption Source #

compDollarEndOnly :: CompOption Source #

compDotAll :: CompOption Source #

compExtended :: CompOption Source #

compExtra :: CompOption Source #

compFirstLine :: CompOption Source #

compMultiline :: CompOption Source #

compNoAutoCapture :: CompOption Source #

compUngreedy :: CompOption Source #

compUTF8 :: CompOption Source #

compNoUTF8Check :: CompOption Source #

ExecOption flags

execBlank :: ExecOption Source #

execAnchored :: ExecOption Source #

execNotBOL :: ExecOption Source #

execNotEOL :: ExecOption Source #

execNotEmpty :: ExecOption Source #

execNoUTF8Check :: ExecOption Source #

execPartial :: ExecOption Source #

Orphan instances

RegexLike Regex ByteString Source #
Instance details 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)
RegexContext Regex ByteString ByteString Source #
Instance details Methods match :: Regex -> ByteString -> ByteString matchM :: MonadFail m => Regex -> ByteString -> m ByteString
RegexMaker Regex CompOption ExecOption ByteString Source #
Instance details Methods makeRegex :: ByteString -> Regex makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex makeRegexM :: MonadFail m => ByteString -> m Regex makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex