regex-tdfa-1.2.2: Replaces/Enhances Text.Regex

Safe HaskellNone
LanguageHaskell98

Text.Regex.TDFA.String

Contents

Description

This modules provides RegexMaker and RegexLike instances for using String with the TDFA backend.

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

Synopsis

Types

data Regex Source

The TDFA backend specific Regex type, used by this module's RegexOptions and RegexMaker

type MatchOffset = Int

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

type MatchLength = Int

non-negative length of a match

data CompOption Source

Control whether the pattern is multiline or case-sensitive like Text.Regex and whether to capture the subgroups (\1, \2, etc). Controls enabling extra anchor syntax.

Medium level API functions

compile Source

Arguments

:: CompOption

Flags (summed together)

-> ExecOption

Flags (summed together)

-> String

The regular expression to compile (ASCII only, no null bytes)

-> Either String Regex

Returns: the compiled regular expression

execute Source

Arguments

:: Regex

Compiled regular expression

-> String

String to match against

-> Either String (Maybe MatchArray) 

regexec Source

Arguments

:: Regex

Compiled regular expression

-> String

String to match against

-> Either String (Maybe (String, String, String, [String]))