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.ByteString

Contents

- Types
- Miscellaneous
- Medium level API functions
- Compilation options
- Execution options
- Orphan instances

Description

This provides `ByteString` instances for RegexMaker and RegexLike based on Text.Regex.Posix.Wrap, and a (RegexContext Regex ByteString ByteString) instance.

To use these instance, you would normally import Text.Regex.Posix. You only need to import this module to use the medium level API of the compile, regexec, and execute functions. All of these report error by returning Left values instead of undefined or error or fail.

The ByteString will only be passed to the library efficiently (as a pointer) if it ends in a NUL byte. Otherwise a temporary copy must be made with the 0 byte appended.

Synopsis

- data Regex
- type MatchOffset = Int
- type MatchLength = Int
- data ReturnCode
- type WrapError = (ReturnCode, String)
- unusedOffset :: Int
- compile :: CompOption -> ExecOption -> ByteString -> IO (Either WrapError Regex)
- execute :: Regex -> ByteString -> IO (Either WrapError (Maybe (Array Int (MatchOffset, MatchLength))))
- regexec :: Regex -> ByteString -> IO (Either WrapError (Maybe (ByteString, ByteString, ByteString, [ByteString])))
- newtype CompOption = CompOption CInt
- compBlank :: CompOption
- compExtended :: CompOption
- compIgnoreCase :: CompOption
- compNoSub :: CompOption
- compNewline :: CompOption
- newtype ExecOption = ExecOption CInt
- execBlank :: ExecOption
- execNotBOL :: ExecOption
- execNotEOL :: ExecOption

## Types

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 #

type MatchOffset = Int Source #

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

type MatchLength = Int Source #

non-negative length of a match

data ReturnCode Source #

ReturnCode is an enumerated `CInt`, corresponding to the error codes from `man 3 regex`:

- `retBadbr` (`REG_BADBR`) invalid repetition count(s) in `{ }`
- `retBadpat` (`REG_BADPAT`) invalid regular expression
- `retBadrpt` (`REG_BADRPT`) `?`, `*`, or `+` operand invalid
- `retEcollate` (`REG_ECOLLATE`) invalid collating element
- `retEctype` (`REG_ECTYPE`) invalid character class
- `retEescape` (`REG_EESCAPE`) `\` applied to unescapable character
- `retEsubreg` (`REG_ESUBREG`) invalid backreference number
- `retEbrack` (`REG_EBRACK`) brackets `[ ]` not balanced
- `retEparen` (`REG_EPAREN`) parentheses `( )` not balanced
- `retEbrace` (`REG_EBRACE`) braces `{ }` not balanced
- `retErange` (`REG_ERANGE`) invalid character range in `[ ]`
- `retEspace` (`REG_ESPACE`) ran out of memory
- `retNoMatch` (`REG_NOMATCH`) The regexec() function failed to match

#### Instances

Instances details

Show ReturnCode Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods showsPrec :: Int -> ReturnCode -> ShowS Source # show :: ReturnCode -> String Source # showList :: [ReturnCode] -> ShowS Source #
Eq ReturnCode Source # |
Instance details Defined in Text.Regex.Posix.Wrap Methods (==) :: ReturnCode -> ReturnCode -> Bool Source # (/=) :: ReturnCode -> ReturnCode -> Bool Source #

type WrapError = (ReturnCode, String) Source #

The return code will be `retOk` when it is the Haskell wrapper and not the underlying library generating the error message.

## Miscellaneous

unusedOffset :: Int Source #

## Medium level API functions

compile Source #

Arguments

:: CompOption | Flags (summed together)
-> ExecOption | Flags (summed together)
-> ByteString | The regular expression to compile
-> IO (Either WrapError Regex) | Returns: the compiled regular expression

Compiles a regular expression

execute Source #

Arguments

:: Regex | Compiled regular expression
-> ByteString | String 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 buffer, returning the buffer indicies of the match, and any submatches

| Matches a regular expression against a string

regexec Source #

Arguments

:: Regex | Compiled regular expression
-> ByteString | String to match against
-> IO (Either WrapError (Maybe (ByteString, ByteString, ByteString, [ByteString]))) |

## Compilation options

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 #

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 #

## Execution options

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 #

execBlank :: ExecOption Source #

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

execNotBOL :: ExecOption Source #

execNotEOL :: ExecOption Source #

# Orphan instances

RegexLike Regex ByteString Source # |

Instance details

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 #

RegexContext Regex ByteString ByteString Source # |
Instance details Methods match :: Regex -> ByteString -> ByteString Source # matchM :: MonadFail m => Regex -> ByteString -> m ByteString Source #
RegexMaker Regex CompOption ExecOption ByteString Source # |
Instance details 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 #