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

Safe HaskellNone

Text.Regex.PCRE.ByteString

Contents

Description

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

Synopsis

Types

type MatchOffset = Int

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

type MatchLength = Int

non-negative length of a match

Miscellaneous

getVersion :: Maybe StringSource

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

Medium level API functions

compileSource

Arguments

:: CompOption

(summed together)

-> ExecOption

(summed together)

-> ByteString

The regular expression to compile

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

Returns: the compiled regular expression

Compiles a regular expression

executeSource

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

regexecSource

Arguments

:: Regex

Compiled regular expression

-> ByteString

String to match against

-> IO (Either WrapError (Maybe (ByteString, ByteString, ByteString, [ByteString]))) 

CompOption flags

ExecOption flags