regex-posix-0.96.0.2: POSIX Backend for "Text.Regex" (regex-base)

Copyright | (c) Chris Kuklewicz 2006
License | BSD-3-Clause
Maintainer | Andreas Abel
Stability | stable
Portability | non-portable (regex-base needs MPTC+FD)
Safe Haskell | None
Language | Haskell2010

Text.Regex.Posix

Contents

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

Description

Module that provides the Regex backend that wraps the C POSIX.2 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 CompOption = CompOption CInt
- newtype ExecOption = ExecOption CInt
- (=~) :: (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
- unusedRegOffset :: RegOffset
- compBlank :: CompOption
- compExtended :: CompOption
- compIgnoreCase :: CompOption
- compNoSub :: CompOption
- compNewline :: CompOption
- execBlank :: ExecOption
- execNotBOL :: ExecOption
- execNotEOL :: ExecOption

# Documentation

getVersion_Text_Regex_Posix :: Version Source #

module Text.Regex.Base

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

data Regex Source #

A compiled regular expression.

#### Instances

Instances details

RegexLike Regex ByteString Source # |

Instance details

Defined in Text.Regex.Posix.ByteString

Methods

matchOnce :: Regex -> ByteString -> Maybe MatchArray Source #

matchAll :: Regex -> ByteString -> [MatchArray] Source #

matchCount :: Regex -> ByteString -> Int Source #

matchTest :: Regex -> ByteString -> Bool Source #

matchAllText :: Regex -> ByteString -> [MatchText ByteString] Source #

matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString) Source #

RegexLike Regex ByteString Source # |

Instance details

Defined in Text.Regex.Posix.ByteString.Lazy

Methods

matchOnce :: Regex -> ByteString -> Maybe MatchArray Source #

matchAll :: Regex -> ByteString -> [MatchArray] Source #

matchCount :: Regex -> ByteString -> Int Source #

matchTest :: Regex -> ByteString -> Bool Source #

matchAllText :: Regex -> ByteString -> [MatchText ByteString] Source #

matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString) Source #

RegexLike Regex String Source # |

Instance details

Defined in Text.Regex.Posix.String

Methods

matchOnce :: Regex -> String -> Maybe MatchArray Source #

matchAll :: Regex -> String -> [MatchArray] Source #

matchCount :: Regex -> String -> Int Source #

matchTest :: Regex -> String -> Bool Source #

matchAllText :: Regex -> String -> [MatchText String] Source #

matchOnceText :: Regex -> String -> Maybe (String, MatchText String, String) Source #

RegexContext Regex ByteString ByteString Source # |
Instance details Defined in Text.Regex.Posix.ByteString Methods match :: Regex -> ByteString -> ByteString Source # matchM :: MonadFail m => Regex -> ByteString -> m ByteString Source #
RegexContext Regex ByteString ByteString Source # |
Instance details Defined in Text.Regex.Posix.ByteString.Lazy Methods match :: Regex -> ByteString -> ByteString Source # matchM :: MonadFail m => Regex -> ByteString -> m ByteString Source #
RegexContext Regex String String Source # |
Instance details Defined in Text.Regex.Posix.String Methods match :: Regex -> String -> String Source # matchM :: MonadFail m => Regex -> String -> m String Source #
RegexOptions Regex CompOption ExecOption Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods blankCompOpt :: CompOption Source # blankExecOpt :: ExecOption Source # defaultCompOpt :: CompOption Source # defaultExecOpt :: ExecOption Source # setExecOpts :: ExecOption -> Regex -> Regex Source # getExecOpts :: Regex -> ExecOption Source #
RegexMaker Regex CompOption ExecOption ByteString Source # |
Instance details Defined in Text.Regex.Posix.ByteString Methods makeRegex :: ByteString -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex Source # makeRegexM :: MonadFail m => ByteString -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex Source #
RegexMaker Regex CompOption ExecOption ByteString Source # |
Instance details Defined in Text.Regex.Posix.ByteString.Lazy Methods makeRegex :: ByteString -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex Source # makeRegexM :: MonadFail m => ByteString -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex Source #
RegexMaker Regex CompOption ExecOption String Source # |
Instance details Defined in Text.Regex.Posix.String Methods makeRegex :: String -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> String -> Regex Source # makeRegexM :: MonadFail m => String -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex Source #
RegexMaker Regex CompOption ExecOption (Seq Char) Source # |
Instance details Defined in Text.Regex.Posix.Sequence Methods makeRegex :: Seq Char -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex Source # makeRegexM :: MonadFail m => Seq Char -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex Source #
RegexLike Regex (Seq Char) Source # |

Instance details

Defined in Text.Regex.Posix.Sequence

Methods

matchOnce :: Regex -> Seq Char -> Maybe MatchArray Source #

matchAll :: Regex -> Seq Char -> [MatchArray] Source #

matchCount :: Regex -> Seq Char -> Int Source #

matchTest :: Regex -> Seq Char -> Bool Source #

matchAllText :: Regex -> Seq Char -> [MatchText (Seq Char)] Source #

matchOnceText :: Regex -> Seq Char -> Maybe (Seq Char, MatchText (Seq Char), Seq Char) Source #

RegexContext Regex (Seq Char) (Seq Char) Source # |
Instance details Defined in Text.Regex.Posix.Sequence Methods match :: Regex -> Seq Char -> Seq Char Source # matchM :: MonadFail m => Regex -> Seq Char -> m (Seq Char) Source #

newtype CompOption Source #

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

Instances details

Bits CompOption Source # |

Instance details

Defined in Text.Regex.Posix.Wrap

Methods

(.&.) :: CompOption -> CompOption -> CompOption Source #

(.|.) :: CompOption -> CompOption -> CompOption Source #

xor :: CompOption -> CompOption -> CompOption Source #

complement :: CompOption -> CompOption Source #

shift :: CompOption -> Int -> CompOption Source #

rotate :: CompOption -> Int -> CompOption Source #

zeroBits :: CompOption Source #

bit :: Int -> CompOption Source #

setBit :: CompOption -> Int -> CompOption Source #

clearBit :: CompOption -> Int -> CompOption Source #

complementBit :: CompOption -> Int -> CompOption Source #

testBit :: CompOption -> Int -> Bool Source #

bitSizeMaybe :: CompOption -> Maybe Int Source #

bitSize :: CompOption -> Int Source #

isSigned :: CompOption -> Bool Source #

shiftL :: CompOption -> Int -> CompOption Source #

unsafeShiftL :: CompOption -> Int -> CompOption Source #

shiftR :: CompOption -> Int -> CompOption Source #

unsafeShiftR :: CompOption -> Int -> CompOption Source #

rotateL :: CompOption -> Int -> CompOption Source #

rotateR :: CompOption -> Int -> CompOption Source #

popCount :: CompOption -> Int Source #

Num CompOption Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods (+) :: CompOption -> CompOption -> CompOption Source # (-) :: CompOption -> CompOption -> CompOption Source # (*) :: CompOption -> CompOption -> CompOption Source # negate :: CompOption -> CompOption Source # abs :: CompOption -> CompOption Source # signum :: CompOption -> CompOption Source # fromInteger :: Integer -> CompOption Source #
Show CompOption Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods showsPrec :: Int -> CompOption -> ShowS Source # show :: CompOption -> String Source # showList :: [CompOption] -> ShowS Source #
Eq CompOption Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods (==) :: CompOption -> CompOption -> Bool Source # (/=) :: CompOption -> CompOption -> Bool Source #
RegexOptions Regex CompOption ExecOption Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods blankCompOpt :: CompOption Source # blankExecOpt :: ExecOption Source # defaultCompOpt :: CompOption Source # defaultExecOpt :: ExecOption Source # setExecOpts :: ExecOption -> Regex -> Regex Source # getExecOpts :: Regex -> ExecOption Source #
RegexMaker Regex CompOption ExecOption ByteString Source # |
Instance details Defined in Text.Regex.Posix.ByteString Methods makeRegex :: ByteString -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex Source # makeRegexM :: MonadFail m => ByteString -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex Source #
RegexMaker Regex CompOption ExecOption ByteString Source # |
Instance details Defined in Text.Regex.Posix.ByteString.Lazy Methods makeRegex :: ByteString -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex Source # makeRegexM :: MonadFail m => ByteString -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex Source #
RegexMaker Regex CompOption ExecOption String Source # |
Instance details Defined in Text.Regex.Posix.String Methods makeRegex :: String -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> String -> Regex Source # makeRegexM :: MonadFail m => String -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex Source #
RegexMaker Regex CompOption ExecOption (Seq Char) Source # |
Instance details Defined in Text.Regex.Posix.Sequence Methods makeRegex :: Seq Char -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex Source # makeRegexM :: MonadFail m => Seq Char -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex Source #

newtype ExecOption Source #

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

Instances details

Bits ExecOption Source # |

Instance details

Defined in Text.Regex.Posix.Wrap

Methods

(.&.) :: ExecOption -> ExecOption -> ExecOption Source #

(.|.) :: ExecOption -> ExecOption -> ExecOption Source #

xor :: ExecOption -> ExecOption -> ExecOption Source #

complement :: ExecOption -> ExecOption Source #

shift :: ExecOption -> Int -> ExecOption Source #

rotate :: ExecOption -> Int -> ExecOption Source #

zeroBits :: ExecOption Source #

bit :: Int -> ExecOption Source #

setBit :: ExecOption -> Int -> ExecOption Source #

clearBit :: ExecOption -> Int -> ExecOption Source #

complementBit :: ExecOption -> Int -> ExecOption Source #

testBit :: ExecOption -> Int -> Bool Source #

bitSizeMaybe :: ExecOption -> Maybe Int Source #

bitSize :: ExecOption -> Int Source #

isSigned :: ExecOption -> Bool Source #

shiftL :: ExecOption -> Int -> ExecOption Source #

unsafeShiftL :: ExecOption -> Int -> ExecOption Source #

shiftR :: ExecOption -> Int -> ExecOption Source #

unsafeShiftR :: ExecOption -> Int -> ExecOption Source #

rotateL :: ExecOption -> Int -> ExecOption Source #

rotateR :: ExecOption -> Int -> ExecOption Source #

popCount :: ExecOption -> Int Source #

Num ExecOption Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods (+) :: ExecOption -> ExecOption -> ExecOption Source # (-) :: ExecOption -> ExecOption -> ExecOption Source # (*) :: ExecOption -> ExecOption -> ExecOption Source # negate :: ExecOption -> ExecOption Source # abs :: ExecOption -> ExecOption Source # signum :: ExecOption -> ExecOption Source # fromInteger :: Integer -> ExecOption Source #
Show ExecOption Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods showsPrec :: Int -> ExecOption -> ShowS Source # show :: ExecOption -> String Source # showList :: [ExecOption] -> ShowS Source #
Eq ExecOption Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods (==) :: ExecOption -> ExecOption -> Bool Source # (/=) :: ExecOption -> ExecOption -> Bool Source #
RegexOptions Regex CompOption ExecOption Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods blankCompOpt :: CompOption Source # blankExecOpt :: ExecOption Source # defaultCompOpt :: CompOption Source # defaultExecOpt :: ExecOption Source # setExecOpts :: ExecOption -> Regex -> Regex Source # getExecOpts :: Regex -> ExecOption Source #
RegexMaker Regex CompOption ExecOption ByteString Source # |
Instance details Defined in Text.Regex.Posix.ByteString Methods makeRegex :: ByteString -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex Source # makeRegexM :: MonadFail m => ByteString -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex Source #
RegexMaker Regex CompOption ExecOption ByteString Source # |
Instance details Defined in Text.Regex.Posix.ByteString.Lazy Methods makeRegex :: ByteString -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex Source # makeRegexM :: MonadFail m => ByteString -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex Source #
RegexMaker Regex CompOption ExecOption String Source # |
Instance details Defined in Text.Regex.Posix.String Methods makeRegex :: String -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> String -> Regex Source # makeRegexM :: MonadFail m => String -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex Source #
RegexMaker Regex CompOption ExecOption (Seq Char) Source # |
Instance details Defined in Text.Regex.Posix.Sequence Methods makeRegex :: Seq Char -> Regex Source # makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex Source # makeRegexM :: MonadFail m => Seq Char -> m Regex Source # makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex Source #

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

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

unusedRegOffset :: RegOffset Source #

compBlank :: CompOption Source #

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

compExtended :: CompOption Source #

compIgnoreCase :: CompOption Source #

compNoSub :: CompOption Source #

compNewline :: CompOption Source #

execBlank :: ExecOption Source #

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

execNotBOL :: ExecOption Source #

execNotEOL :: ExecOption Source #