regex-pcre-0.94.4: Replaces/Enhances Text.Regex

Safe HaskellNone

Text.Regex.PCRE.Sequence

Contents

Description

This exports instances of the high level API and the medium level API of compile,execute, and regexec.

Synopsis

Types

data Regex Source

A compiled regular expression

Instances

RegexLike Regex String 
RegexLike Regex ByteString 
RegexLike Regex ByteString 
RegexOptions Regex CompOption ExecOption 
RegexContext Regex String String 
RegexContext Regex ByteString ByteString 
RegexContext Regex ByteString ByteString 
RegexMaker Regex CompOption ExecOption String 
RegexMaker Regex CompOption ExecOption ByteString 
RegexMaker Regex CompOption ExecOption ByteString 
RegexMaker Regex CompOption ExecOption (Seq Char) 
RegexLike Regex (Seq Char) 
RegexContext Regex (Seq Char) (Seq Char) 

type MatchOffset = Int

type MatchLength = Int

newtype CompOption Source

Constructors

CompOption CInt 

Instances

Eq CompOption 
Num CompOption 
Show CompOption 
Bits CompOption 
RegexOptions Regex CompOption ExecOption 
RegexMaker Regex CompOption ExecOption String 
RegexMaker Regex CompOption ExecOption ByteString 
RegexMaker Regex CompOption ExecOption ByteString 
RegexMaker Regex CompOption ExecOption (Seq Char) 

newtype ExecOption Source

Constructors

ExecOption CInt 

Instances

Eq ExecOption 
Num ExecOption 
Show ExecOption 
Bits ExecOption 
RegexOptions Regex CompOption ExecOption 
RegexMaker Regex CompOption ExecOption String 
RegexMaker Regex CompOption ExecOption ByteString 
RegexMaker Regex CompOption ExecOption ByteString 
RegexMaker Regex CompOption ExecOption (Seq Char) 

data ReturnCode Source

Instances

type WrapError = (ReturnCode, String)Source

Miscellaneous

getVersion :: Maybe StringSource

return version of pcre used or Nothing if pcre is not available.

Medium level API functions

compileSource

Arguments

:: CompOption

Flags (summed together)

-> ExecOption

Flags (summed together)

-> Seq Char

The regular expression to compile

-> IO (Either (MatchOffset, String) Regex)

Returns: an error string and offset or the compiled regular expression

Compiles a regular expression

executeSource

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

regexecSource

Arguments

:: Regex

compiled regular expression

-> Seq Char

string to match

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

Returns: Nothing if no match, else (text before match, text after match, array of matches with 0 being the whole match)

execute match and extract substrings rather than just offsets

Constants for CompOption

Constants for ExecOption