Text.Regex.PCRE.Text

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

Since: 0.95.0

Types

data Regex

A compiled regular expression

Instances

RegexLike Regex String

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

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

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 Text

Defined in Text.Regex.PCRE.Text.Lazy

Methods

matchOnce :: Regex -> Text -> Maybe MatchArray

matchAll :: Regex -> Text -> [MatchArray]

matchCount :: Regex -> Text -> Int

matchTest :: Regex -> Text -> Bool

matchAllText :: Regex -> Text -> [MatchText Text]

matchOnceText :: Regex -> Text -> Maybe (Text, MatchText Text, Text)

RegexLike Regex Text

Defined in Text.Regex.PCRE.Text

Methods

matchOnce :: Regex -> Text -> Maybe MatchArray

matchAll :: Regex -> Text -> [MatchArray]

matchCount :: Regex -> Text -> Int

matchTest :: Regex -> Text -> Bool

matchAllText :: Regex -> Text -> [MatchText Text]

matchOnceText :: Regex -> Text -> Maybe (Text, MatchText Text, Text)

RegexOptions Regex CompOption ExecOption

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

Defined in Text.Regex.PCRE.String

Methods

match :: Regex -> String -> String

matchM :: MonadFail m => Regex -> String -> m String

RegexContext Regex ByteString ByteString

Defined in Text.Regex.PCRE.ByteString.Lazy

Methods

match :: Regex -> ByteString -> ByteString

matchM :: MonadFail m => Regex -> ByteString -> m ByteString

RegexContext Regex ByteString ByteString

Defined in Text.Regex.PCRE.ByteString

Methods

match :: Regex -> ByteString -> ByteString

matchM :: MonadFail m => Regex -> ByteString -> m ByteString

RegexContext Regex Text Text

Defined in Text.Regex.PCRE.Text.Lazy

Methods

match :: Regex -> Text -> Text

matchM :: MonadFail m => Regex -> Text -> m Text

RegexContext Regex Text Text

Defined in Text.Regex.PCRE.Text

Methods

match :: Regex -> Text -> Text

matchM :: MonadFail m => Regex -> Text -> m Text

RegexMaker Regex CompOption ExecOption String

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 ByteString

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 ByteString

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 Text

Defined in Text.Regex.PCRE.Text.Lazy

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption Text

Defined in Text.Regex.PCRE.Text

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption (Seq Char)

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)

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)

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

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

type MatchLength = Int

non-negative length of a match

newtype CompOption

Constructors

CompOption CInt

Instances

Eq CompOption

Defined in Text.Regex.PCRE.Wrap

Methods

(==) :: CompOption -> CompOption -> Bool

(/=) :: CompOption -> CompOption -> Bool

Num CompOption

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

Defined in Text.Regex.PCRE.Wrap

Methods

showsPrec :: Int -> CompOption -> ShowS

show :: CompOption -> String

showList :: [CompOption] -> ShowS

Bits CompOption

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

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

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 ByteString

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 ByteString

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 Text

Defined in Text.Regex.PCRE.Text.Lazy

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption Text

Defined in Text.Regex.PCRE.Text

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption (Seq Char)

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

Constructors

ExecOption CInt

Instances

Eq ExecOption

Defined in Text.Regex.PCRE.Wrap

Methods

(==) :: ExecOption -> ExecOption -> Bool

(/=) :: ExecOption -> ExecOption -> Bool

Num ExecOption

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

Defined in Text.Regex.PCRE.Wrap

Methods

showsPrec :: Int -> ExecOption -> ShowS

show :: ExecOption -> String

showList :: [ExecOption] -> ShowS

Bits ExecOption

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

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

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 ByteString

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 ByteString

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 Text

Defined in Text.Regex.PCRE.Text.Lazy

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption Text

Defined in Text.Regex.PCRE.Text

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption (Seq Char)

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

Instances

Eq ReturnCode

Defined in Text.Regex.PCRE.Wrap

Methods

(==) :: ReturnCode -> ReturnCode -> Bool

(/=) :: ReturnCode -> ReturnCode -> Bool

Show ReturnCode

Defined in Text.Regex.PCRE.Wrap

Methods

showsPrec :: Int -> ReturnCode -> ShowS

show :: ReturnCode -> String

showList :: [ReturnCode] -> ShowS

type WrapError = (ReturnCode, String)

Miscellaneous

unusedOffset :: MatchOffset

getVersion :: Maybe String

Version string of PCRE library

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

Medium level API functions

compile

Arguments

:: CompOption

(summed together)

-> ExecOption

(summed together)

-> Text

The regular expression to compile

-> IO (Either (MatchOffset, String) Regex)

Returns: the compiled regular expression

Compiles a regular expression

execute

Arguments

:: Regex

Compiled regular expression

-> Text

Text 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

Arguments

:: Regex

Compiled regular expression

-> Text

Text to match against

-> IO (Either WrapError (Maybe (Text, Text, Text, [Text])))

Returns: Nothing if the regex did not match the string, or Just text including before and after text

Matches a regular expression against a string

CompOption flags

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

ExecOption flags

execBlank :: ExecOption

execAnchored :: ExecOption

execNotBOL :: ExecOption

execNotEOL :: ExecOption

execNotEmpty :: ExecOption

execNoUTF8Check :: ExecOption

execPartial :: ExecOption

Orphan instances

RegexLike Regex Text

Methods

matchOnce :: Regex -> Text -> Maybe MatchArray

matchAll :: Regex -> Text -> [MatchArray]

matchCount :: Regex -> Text -> Int

matchTest :: Regex -> Text -> Bool

matchAllText :: Regex -> Text -> [MatchText Text]

matchOnceText :: Regex -> Text -> Maybe (Text, MatchText Text, Text)

RegexContext Regex Text Text

Methods

match :: Regex -> Text -> Text

matchM :: MonadFail m => Regex -> Text -> m Text

RegexMaker Regex CompOption ExecOption Text

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex