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

Copyright | (c) Chris Kuklewicz 200620072008 derived from (c) The University of Glasgow 2002
Maintainer | Andreas Abel
Stability | stable
Portability | non-portable (regex-base needs MPTC+FD)
Safe Haskell | None
Language | Haskell2010

Text.Regex.Posix.Wrap

Contents

- High-level API
- Low-level API
- Miscellaneous
- Compilation options
- Execution options
- Return codes

Description

WrapPosix.hsc exports a wrapped version of the ffi imports. To increase type safety, the flags are newtype'd. The other important export is a `Regex` type that is specific to the Posix library backend. The flags are documented in Text.Regex.Posix. The `defaultCompOpt` is `(compExtended .|. compNewline)`.

The `Regex`, `CompOption`, and `ExecOption` types and their `RegexOptions` instance is declared. The `=~` and `=~~` convenience functions are defined.

This module will fail or error only if allocation fails or a nullPtr is passed in.

2009-January : `wrapMatchAll` and `wrapCount` now adjust the execution option `execNotBOL` after the first result to take into account 'n' in the text immediately before the next matches. (version 0.93.3)

2009-January : `wrapMatchAll` and `wrapCount` have been changed to return all non-overlapping matches, including empty matches even if they coincide with the end of the previous non-empty match. The change is that the first non-empty match no longer terminates the search. One can filter the results to obtain the old behavior or to obtain the behavior of "sed", where "sed" eliminates the empty matches which coincide with the end of non-empty matches. (version 0.94.0)

Synopsis

- data Regex
- type RegOffset = Int64
- type RegOffsetT = Int32
- (=~) :: (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
- type WrapError = (ReturnCode, String)
- wrapCompile :: CompOption -> ExecOption -> CString -> IO (Either WrapError Regex)
- wrapTest :: Regex -> CString -> IO (Either WrapError Bool)
- wrapMatch :: Regex -> CString -> IO (Either WrapError (Maybe [(RegOffset, RegOffset)]))
- wrapMatchAll :: Regex -> CString -> IO (Either WrapError [MatchArray])
- wrapCount :: Regex -> CString -> IO (Either WrapError Int)
- unusedRegOffset :: RegOffset
- newtype CompOption = CompOption CInt
- compBlank :: CompOption
- compExtended :: CompOption
- compIgnoreCase :: CompOption
- compNoSub :: CompOption
- compNewline :: CompOption
- newtype ExecOption = ExecOption CInt
- execBlank :: ExecOption
- execNotBOL :: ExecOption
- execNotEOL :: ExecOption
- newtype ReturnCode = ReturnCode CInt
- retBadbr :: ReturnCode
- retBadpat :: ReturnCode
- retBadrpt :: ReturnCode
- retEcollate :: ReturnCode
- retEctype :: ReturnCode
- retEescape :: ReturnCode
- retEsubreg :: ReturnCode
- retEbrack :: ReturnCode
- retEparen :: ReturnCode
- retEbrace :: ReturnCode
- retErange :: ReturnCode
- retEspace :: ReturnCode

## High-level API

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 RegOffset = Int64 Source #

`RegOffset` is `typedef int regoff_t` on Linux and ultimately `typedef long long __int64_t` on Max OS X. So rather than saying 2,147,483,647 is all the length you need, I'll take the larger: 9,223,372,036,854,775,807 should be enough bytes for anyone, no need for Integer. The alternative is to compile to different sizes in a platform dependent manner with `type RegOffset = (#type regoff_t)`, which I do not want to do.

There is also a special value ``unusedRegOffset` :: `RegOffset`` which is (-1) and as a starting index means that the subgroup capture was unused. Otherwise the `RegOffset` indicates a character boundary that is before the character at that index offset, with the first character at index offset 0. So starting at 1 and ending at 2 means to take only the second character.

type RegOffsetT = Int32 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 #

## Low-level API

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.

wrapCompile Source #

Arguments

:: CompOption | Flags (bitmapped)
-> ExecOption | Flags (bitmapped)
-> CString | The regular expression to compile (ASCII only, no null bytes)
-> IO (Either WrapError Regex) | Returns: the compiled regular expression

wrapTest :: Regex -> CString -> IO (Either WrapError Bool) Source #

wrapMatch :: Regex -> CString -> IO (Either WrapError (Maybe [(RegOffset, RegOffset)])) Source #

`wrapMatch` returns offsets for the begin and end of each capture. Unused captures have offsets of `unusedRegOffset` which is (-1).

wrapMatchAll :: Regex -> CString -> IO (Either WrapError [MatchArray]) Source #

`wrapMatchAll` returns the offset and length of each capture. Unused captures have an offset of `unusedRegOffset` which is (-1) and length of 0.

wrapCount :: Regex -> CString -> IO (Either WrapError Int) Source #

## Miscellaneous

unusedRegOffset :: RegOffset Source #

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

## Return codes

newtype 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

Constructors

ReturnCode CInt |

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

retBadbr :: ReturnCode Source #

retBadpat :: ReturnCode Source #

retBadrpt :: ReturnCode Source #

retEcollate :: ReturnCode Source #

retEctype :: ReturnCode Source #

retEescape :: ReturnCode Source #

retEsubreg :: ReturnCode Source #

retEbrack :: ReturnCode Source #

retEparen :: ReturnCode Source #

retEbrace :: ReturnCode Source #

retErange :: ReturnCode Source #

retEspace :: ReturnCode Source #