Copyright	(c) Chris Kuklewicz 2006
License	BSD-style (see the file LICENSE)
Maintainer	libraries@haskell.org, textregexlazy@personal.mightyreason.com
Stability	experimental
Portability	non-portable (regex-base needs MPTC+FD)
Safe Haskell	None
Language	Haskell98

Text.Regex.Posix

Contents

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

Description

Module that provides the Regex backend that wraps the c posix regex api. This is the backend being used by the regex-compat package to replace Text.Regex

The Text.Regex.Posix 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.

If the =~ and =~~ functions are too high level, you can use the compile, regexec, and execute functions from importing either Text.Regex.Posix.String or Text.Regex.Posix.ByteString. If you want to use a low-level CString interface to the library, then import Text.Regex.Posix.Wrap and use the wrap* functions.

This module is only efficient with ByteString only if it is null terminated, i.e. (Bytestring.last bs)==0. Otherwise the library must make a temporary copy of the ByteString and append the NUL byte.

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

Note that the posix library works with single byte characters, and does not understand Unicode. If you need Unicode support you will have to use a different backend.

When offsets are reported for subexpression captures, a subexpression that did not match anything (as opposed to matching an empty string) will have its offset set to the unusedRegOffset value, which is (-1).

Benchmarking shows the default regex library on many platforms is very inefficient. You might increase performace by an order of magnitude by obtaining libpcre and regex-pcre or libtre and regex-tre. If you do not need the captured substrings then you can also get great performance from regex-dfa. If you do need the capture substrings then you may be able to use regex-parsec to improve performance.

Synopsis

getVersion_Text_Regex_Posix :: Version
module Text.Regex.Base
data Regex
newtype ExecOption = ExecOption CInt
newtype CompOption = CompOption CInt
compBlank :: CompOption
execBlank :: ExecOption
unusedRegOffset :: RegOffset
(=~) :: (RegexMaker Regex CompOption ExecOption source, RegexContext Regex source1 target) => source1 -> source -> target
(=~~) :: (RegexMaker Regex CompOption ExecOption source, RegexContext Regex source1 target, Monad m) => source1 -> source -> m target
execNotBOL :: ExecOption
execNotEOL :: ExecOption
compExtended :: CompOption
compIgnoreCase :: CompOption
compNoSub :: CompOption
compNewline :: CompOption

Documentation

getVersion_Text_Regex_Posix :: Version #

module Text.Regex.Base

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

data Regex #

A compiled regular expression.

Instances

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

newtype ExecOption #

A bitmapped CInt containing options for execution of compiled regular expressions. Option values (and their man 3 regexec names) are

execBlank which is a complete zero value for all the flags. This is the blankExecOpt value.
execNotBOL (REG_NOTBOL) can be set to prevent ^ from matching at the start of the input.
execNotEOL (REG_NOTEOL) can be set to prevent $ from matching at the end of the input (before the terminating NUL).

Constructors

ExecOption CInt

Instances

Eq ExecOption #
Instance details Defined in Text.Regex.Posix.Wrap Methods (==) :: ExecOption -> ExecOption -> Bool # (/=) :: ExecOption -> ExecOption -> Bool #
Num ExecOption #
Instance details Defined in Text.Regex.Posix.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 #
Instance details Defined in Text.Regex.Posix.Wrap Methods showsPrec :: Int -> ExecOption -> ShowS # show :: ExecOption -> String # showList :: [ExecOption] -> ShowS #
Bits ExecOption #
Instance details Defined in Text.Regex.Posix.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 #
Instance details Defined in Text.Regex.Posix.Wrap Methods blankCompOpt :: CompOption # blankExecOpt :: ExecOption # defaultCompOpt :: CompOption # defaultExecOpt :: ExecOption # setExecOpts :: ExecOption -> Regex -> Regex # getExecOpts :: Regex -> ExecOption #
RegexMaker Regex CompOption ExecOption String #
Instance details Defined in Text.Regex.Posix.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 #
Instance details Defined in Text.Regex.Posix.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 #
Instance details Defined in Text.Regex.Posix.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) #
Instance details Defined in Text.Regex.Posix.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 CompOption #

A bitmapped CInt containing options for compilation of regular expressions. Option values (and their man 3 regcomp names) are

compBlank which is a completely zero value for all the flags. This is also the blankCompOpt value.
compExtended (REG_EXTENDED) which can be set to use extended instead of basic regular expressions. This is set in the defaultCompOpt value.
compNewline (REG_NEWLINE) turns on newline sensitivity: The dot (.) and inverted set [^ ] never match newline, and ^ and $ anchors do match after and before newlines. This is set in the defaultCompOpt value.
compIgnoreCase (REG_ICASE) which can be set to match ignoring upper and lower distinctions.
compNoSub (REG_NOSUB) which turns off all information from matching except whether a match exists.

Constructors

CompOption CInt

Instances

Eq CompOption #
Instance details Defined in Text.Regex.Posix.Wrap Methods (==) :: CompOption -> CompOption -> Bool # (/=) :: CompOption -> CompOption -> Bool #
Num CompOption #
Instance details Defined in Text.Regex.Posix.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 #
Instance details Defined in Text.Regex.Posix.Wrap Methods showsPrec :: Int -> CompOption -> ShowS # show :: CompOption -> String # showList :: [CompOption] -> ShowS #
Bits CompOption #
Instance details Defined in Text.Regex.Posix.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 #
Instance details Defined in Text.Regex.Posix.Wrap Methods blankCompOpt :: CompOption # blankExecOpt :: ExecOption # defaultCompOpt :: CompOption # defaultExecOpt :: ExecOption # setExecOpts :: ExecOption -> Regex -> Regex # getExecOpts :: Regex -> ExecOption #
RegexMaker Regex CompOption ExecOption String #
Instance details Defined in Text.Regex.Posix.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 #
Instance details Defined in Text.Regex.Posix.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 #
Instance details Defined in Text.Regex.Posix.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) #
Instance details Defined in Text.Regex.Posix.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 #

compBlank :: CompOption #

A completely zero value for all the flags. This is also the blankCompOpt value.

execBlank :: ExecOption #

A completely zero value for all the flags. This is also the blankExecOpt value.

unusedRegOffset :: RegOffset #

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

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

execNotBOL :: ExecOption #

execNotEOL :: ExecOption #

compExtended :: CompOption #

compIgnoreCase :: CompOption #

compNoSub :: CompOption #

compNewline :: CompOption #

Documentation

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

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