Text.Regex.PCRE

The Text.Regex.PCRE module provides a backend for regular expressions. If you import this along with other backends, then you should do so with qualified imports, perhaps renamed for convenience.

You will need to have libpcre, from www.pcre.org, to use this module. The haskell must be compiled with -DHAVE_PCRE_H and linked with pcre. This is the default in the cabal file.

If you do not compile with HAVE_PCRE_H then the functions will still exist, but using them will create a run time error. You can test for the existance of PCRE by checking getVersion which is Nothing if not compiled with PCRE or Just String if PCRE is present.

Using the provided CompOption and ExecOption values and if configUTF8 is True, then you might be able to send UTF8 encoded ByteStrings to PCRE and get sensible results. This is currently untested.

The regular expression can be provided as a ByteString, but it will be copied and a NUL byte appended to make a CString unless such a byte is already present. Thus the regular expression cannot contain an explicit NUL byte. The search string is passed as a CStringLen and may contain NUL bytes and does not need to end in a NUL byte. ByteStrings are searched in place (via unsafeUseAsCStringLen).

A String will be converted into a CString or CStringLen for processing. Doing this repeatedly will be very inefficient.

The Text.Regex.PCRE.String, Text.Regex.PCRE.ByteString, and Text.Regex.PCRE.Wrap modules provides both the high level interface exported by this module and medium- and low-level interfaces that returns error using Either structures.

Documentation

getVersion_Text_Regex_PCRE :: Version

module Text.Regex.Base

Wrap, for =~ and =~~, types and constants

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)

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

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

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

(=~) :: (RegexMaker Regex CompOption ExecOption source, RegexContext Regex source1 target) => source1 -> source -> target

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

compBlank :: CompOption

execBlank :: ExecOption

unusedOffset :: MatchOffset

getNumSubs :: Regex -> Int

getVersion :: Maybe String

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

configUTF8 :: Bool

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

execAnchored :: ExecOption

execNotBOL :: ExecOption

execNotEOL :: ExecOption

execNotEmpty :: ExecOption

execNoUTF8Check :: ExecOption

execPartial :: ExecOption