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

Contents

Types
Miscellaneous
Medium level API functions
Compilation options
Orphan instances

Description

This provides String instances for RegexMaker and RegexLike based on Text.Regex.Posix.Wrap, and a (RegexContext Regex String String) 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.

Synopsis

Types

data Regex #

A compiled regular expression.

Instances

RegexOptions Regex CompOption ExecOption #
Methods blankCompOpt :: CompOption # blankExecOpt :: ExecOption # defaultCompOpt :: CompOption # defaultExecOpt :: ExecOption # setExecOpts :: ExecOption -> Regex -> Regex # getExecOpts :: Regex -> ExecOption #

type MatchOffset = Int #

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

type MatchLength = Int #

non-negative length of a match

data ReturnCode #

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

Eq ReturnCode #
Methods (==) :: ReturnCode -> ReturnCode -> Bool # (/=) :: ReturnCode -> ReturnCode -> Bool #
Show ReturnCode #
Methods showsPrec :: Int -> ReturnCode -> ShowS # show :: ReturnCode -> String # showList :: [ReturnCode] -> ShowS #

type WrapError = (ReturnCode, String) #

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

Miscellaneous

unusedOffset :: Int #

Medium level API functions

compile #

Arguments

:: CompOption	Flags (summed together)
-> ExecOption	Flags (summed together)
-> Seq Char	The regular expression to compile (ASCII only, no null bytes)
-> IO (Either WrapError Regex)	Returns: the compiled regular expression

regexec #

Arguments

:: Regex

Compiled regular expression

-> Seq Char

(Seq Char) to match against

-> IO (Either WrapError (Maybe (Seq Char, Seq Char, Seq Char, [Seq Char])))

Returns: Nothing if the regex did not match the string, or:

  Just (everything before match,
        matched portion,
        everything after match,
        subexpression matches)

Matches a regular expression against a string

execute #

Arguments

:: Regex

Compiled regular expression

-> Seq Char

(Seq Char) to match against

-> IO (Either WrapError (Maybe (Array Int (MatchOffset, MatchLength))))

Returns: Nothing if the regex did not match the string, or:

  Just (array of offset length pairs)

Matches a regular expression against a string

Compilation options

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 #
Methods (==) :: CompOption -> CompOption -> Bool # (/=) :: CompOption -> CompOption -> Bool #
Num CompOption #
Methods (+) :: CompOption -> CompOption -> CompOption # (-) :: CompOption -> CompOption -> CompOption # (*) :: CompOption -> CompOption -> CompOption # negate :: CompOption -> CompOption # abs :: CompOption -> CompOption # signum :: CompOption -> CompOption # fromInteger :: Integer -> CompOption #
Show CompOption #
Methods showsPrec :: Int -> CompOption -> ShowS # show :: CompOption -> String # showList :: [CompOption] -> ShowS #
Bits CompOption #
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 #
Methods blankCompOpt :: CompOption # blankExecOpt :: ExecOption # defaultCompOpt :: CompOption # defaultExecOpt :: ExecOption # setExecOpts :: ExecOption -> Regex -> Regex # getExecOpts :: Regex -> ExecOption #

compBlank :: CompOption #

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

compExtended :: CompOption #

compIgnoreCase :: CompOption #

compNoSub :: CompOption #

compNewline :: CompOption #

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 #
Methods (==) :: ExecOption -> ExecOption -> Bool # (/=) :: ExecOption -> ExecOption -> Bool #
Num ExecOption #
Methods (+) :: ExecOption -> ExecOption -> ExecOption # (-) :: ExecOption -> ExecOption -> ExecOption # (*) :: ExecOption -> ExecOption -> ExecOption # negate :: ExecOption -> ExecOption # abs :: ExecOption -> ExecOption # signum :: ExecOption -> ExecOption # fromInteger :: Integer -> ExecOption #
Show ExecOption #
Methods showsPrec :: Int -> ExecOption -> ShowS # show :: ExecOption -> String # showList :: [ExecOption] -> ShowS #
Bits ExecOption #
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 #
Methods blankCompOpt :: CompOption # blankExecOpt :: ExecOption # defaultCompOpt :: CompOption # defaultExecOpt :: ExecOption # setExecOpts :: ExecOption -> Regex -> Regex # getExecOpts :: Regex -> ExecOption #

execBlank :: ExecOption #

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

execNotBOL :: ExecOption #

execNotEOL :: ExecOption #

Orphan instances

RegexMaker Regex CompOption ExecOption (Seq Char) #
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) #
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) #
Methods match :: Regex -> Seq Char -> Seq Char # matchM :: Monad m => Regex -> Seq Char -> m (Seq Char) #