Safe Haskell	None
Language	Haskell98

Text.Regex.PCRE.Sequence

Contents

Types
Miscellaneous
Medium level API functions
Constants for CompOption
Constants for ExecOption
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 -> Seq Char -> IO (Either (MatchOffset, String) Regex)
execute :: Regex -> Seq Char -> IO (Either WrapError (Maybe (Array Int (MatchOffset, MatchLength))))
regexec :: Regex -> Seq Char -> IO (Either WrapError (Maybe (Seq Char, Seq Char, Seq Char, [Seq Char])))
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

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

type MatchOffset = Int #

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

type MatchLength = Int #

non-negative length of a match

newtype CompOption Source #

Constructors

CompOption CInt

Instances

Eq CompOption Source #
Instance details Defined in Text.Regex.PCRE.Wrap Methods (==) :: CompOption -> CompOption -> Bool # (/=) :: CompOption -> CompOption -> Bool #
Num CompOption Source #
Instance details Defined in Text.Regex.PCRE.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.PCRE.Wrap Methods showsPrec :: Int -> CompOption -> ShowS # show :: CompOption -> String # showList :: [CompOption] -> ShowS #
Bits CompOption Source #
Instance details Defined in Text.Regex.PCRE.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 #
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 String Source #
Instance details Defined in Text.Regex.PCRE.String Methods makeRegex :: String -> Regex # makeRegexOpts :: CompOption -> ExecOption -> String -> Regex # makeRegexM :: Monad m => String -> m Regex # makeRegexOptsM :: Monad m => CompOption -> ExecOption -> String -> m Regex #
RegexMaker Regex CompOption ExecOption ByteString Source #
Instance details Defined in Text.Regex.PCRE.ByteString.Lazy Methods makeRegex :: ByteString -> Regex # makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex # makeRegexM :: Monad m => ByteString -> m Regex # makeRegexOptsM :: Monad m => CompOption -> ExecOption -> ByteString -> m Regex #
RegexMaker Regex CompOption ExecOption ByteString Source #
Instance details Defined in Text.Regex.PCRE.ByteString Methods makeRegex :: ByteString -> Regex # makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex # makeRegexM :: Monad m => ByteString -> m Regex # makeRegexOptsM :: Monad m => CompOption -> ExecOption -> ByteString -> m Regex #
RegexMaker Regex CompOption ExecOption (Seq Char) Source #
Instance details Defined in Text.Regex.PCRE.Sequence Methods makeRegex :: Seq Char -> Regex # makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex # makeRegexM :: Monad m => Seq Char -> m Regex # makeRegexOptsM :: Monad m => CompOption -> ExecOption -> Seq Char -> m Regex #

newtype ExecOption Source #

Constructors

ExecOption CInt

Instances

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

data ReturnCode Source #

Instances

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

type WrapError = (ReturnCode, String) Source #

Miscellaneous

unusedOffset :: MatchOffset Source #

getVersion :: Maybe String Source #

return version of pcre used or Nothing if pcre is not available.

Medium level API functions

compile Source #

Arguments

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

Compiles a regular expression

execute Source #

Arguments

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

Matches a regular expression against a string

regexec Source #

Arguments

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

execute match and extract substrings rather than just offsets

Constants for CompOption

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 #

Constants for ExecOption

execBlank :: ExecOption Source #

execAnchored :: ExecOption Source #

execNotBOL :: ExecOption Source #

execNotEOL :: ExecOption Source #

execNotEmpty :: ExecOption Source #

execNoUTF8Check :: ExecOption Source #

execPartial :: ExecOption Source #

Orphan instances

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