Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.Regex.PCRE2.Sequence

Contents

Types
Miscellaneous
Medium level API functions
CompOption flags
MatchOption flags, new to v1.0.0.0 (pcre2), replacing the obsolete ExecOptions
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 Word32
newtype MatchOption = MatchOption Word32
data ReturnCode
type WrapError = (ReturnCode, String)
unusedOffset :: MatchOffset
getVersion :: Maybe String
compile :: CompOption -> MatchOption -> 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
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

Types

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

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

data ReturnCode Source #

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 #

Miscellaneous

unusedOffset :: MatchOffset Source #

getVersion :: Maybe String Source #

Version string of PCRE2 library

Medium level API functions

compile Source #

Arguments

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

CompOption flags

compBlank :: CompOption Source #

compAnchored :: CompOption Source #

compEndAnchored :: CompOption Source #

compAllowEmptyClass :: CompOption Source #

compAltBSUX :: CompOption Source #

compAltExtendedClass :: CompOption Source #

compAltVerbnames :: CompOption Source #

compAutoCallout :: CompOption Source #

compCaseless :: CompOption Source #

compDollarEndOnly :: CompOption Source #

compDotAll :: CompOption Source #

compDupNames :: CompOption Source #

compExtended :: CompOption Source #

compExtendedMore :: CompOption Source #

compFirstLine :: CompOption Source #

compLiteral :: CompOption Source #

compMatchUnsetBackref :: CompOption Source #

compMultiline :: CompOption Source #

compNeverBackslashC :: CompOption Source #

compNoAutoCapture :: CompOption Source #

compNoAutoPossess :: CompOption Source #

compNoDotstarAnchor :: CompOption Source #

compNoUTFCheck :: CompOption Source #

compUngreedy :: CompOption Source #

compUTF :: CompOption Source #

MatchOption flags, new to v1.0.0.0 (pcre2), replacing the obsolete ExecOptions

matchBlank :: MatchOption Source #

matchAnchored :: MatchOption Source #

matchCopyMatchedSubject :: MatchOption Source #

matchDisableRecurseLoopCheck :: MatchOption Source #

matchEndAnchored :: MatchOption Source #

matchNotBOL :: MatchOption Source #

matchNotEOL :: MatchOption Source #

matchNotEmpty :: MatchOption Source #

matchNotEmptyAtStart :: MatchOption Source #

matchNoUTFCheck :: MatchOption Source #

matchPartialHard :: MatchOption Source #

matchPartialSoft :: MatchOption Source #

Orphan instances

RegexMaker Regex CompOption MatchOption (Seq Char) Source #
Instance details 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 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 :: MonadFail m => Regex -> Seq Char -> m (Seq Char) #