Safe Haskell	None
Language	Haskell2010

Text.RE.TestBench

Contents

The Test Bench Tutorial
The Test Bench
The Parsers
The Match Type

Synopsis

The Test Bench Tutorial

This API module provides a test bench for developing, documenting and testing regex RE macros.

See the tutorials at http://re-tutorial-testbench.regex.uk

The Test Bench

type MacroEnv = HashMap MacroID MacroDescriptor Source #

each macro can reference others, the whole environment being required for each macro, so we use a Lazy HashMap

data MacroDescriptor Source #

describes a macro, giving the text of the RE and a si=ummary description

Constructors

MacroDescriptor
Fields macroSource :: !RegexSource the RE macroSamples :: ![String] some sample matches macroCounterSamples :: ![String] some sample non-matches macroTestResults :: ![TestResult] validation test results macroParser :: !(Maybe FunctionID) WA, the parser function macroDescription :: !String summary comment

Instances

Show MacroDescriptor Source #
Methods showsPrec :: Int -> MacroDescriptor -> ShowS # show :: MacroDescriptor -> String # showList :: [MacroDescriptor] -> ShowS #

newtype RegexSource Source #

a RE that should work for POSIX and PCRE with open brackets ('(') represented as follows: ( mere symbol (?: used for grouping only, not for captures (}: used for captures only, not for grouping (]: used for captures and grouping ( do not modify

Constructors

RegexSource
Fields _RegexSource :: String

Instances

Show RegexSource Source #
Methods showsPrec :: Int -> RegexSource -> ShowS # show :: RegexSource -> String # showList :: [RegexSource] -> ShowS #
IsString RegexSource Source #
Methods fromString :: String -> RegexSource #

data WithCaptures Source #

do we need the captures in the RE or whould they be stripped out where possible

Constructors

InclCaptures	include all captures
ExclCaptures	remove captures where possible

Instances

Eq WithCaptures Source #
Methods (==) :: WithCaptures -> WithCaptures -> Bool # (/=) :: WithCaptures -> WithCaptures -> Bool #
Ord WithCaptures Source #
Methods compare :: WithCaptures -> WithCaptures -> Ordering # (<) :: WithCaptures -> WithCaptures -> Bool # (<=) :: WithCaptures -> WithCaptures -> Bool # (>) :: WithCaptures -> WithCaptures -> Bool # (>=) :: WithCaptures -> WithCaptures -> Bool # max :: WithCaptures -> WithCaptures -> WithCaptures # min :: WithCaptures -> WithCaptures -> WithCaptures #
Show WithCaptures Source #
Methods showsPrec :: Int -> WithCaptures -> ShowS # show :: WithCaptures -> String # showList :: [WithCaptures] -> ShowS #

data RegexType Source #

what flavour of regex are we dealing with

Instances

Show RegexType Source #
Methods showsPrec :: Int -> RegexType -> ShowS # show :: RegexType -> String # showList :: [RegexType] -> ShowS #

isTDFA :: RegexType -> Bool Source #

test RegexType for TDFA/PCREness

isPCRE :: RegexType -> Bool Source #

test RegexType for TDFA/PCREness

presentRegexType :: RegexType -> String Source #

Constructing a MacrosEnv

mkMacros :: (Monad m, Functor m) => (String -> m r) -> RegexType -> WithCaptures -> MacroEnv -> m (Macros r) Source #

construct a macro table suitable for use with the RE compilers

Formatting Macros

formatMacroTable :: RegexType -> MacroEnv -> String Source #

format a macros table as a markdown table

formatMacroSummary :: RegexType -> MacroEnv -> MacroID -> String Source #

generate a plain text summary of a macro

formatMacroSources :: RegexType -> WithCaptures -> MacroEnv -> String Source #

list the source REs for each macro in plain text

formatMacroSource :: RegexType -> WithCaptures -> MacroEnv -> MacroID -> String Source #

list the source of a single macro in plain text

mdRegexSource :: RegexType -> WithCaptures -> MacroEnv -> MacroDescriptor -> String Source #

Formatting Macros

testMacroEnv :: String -> RegexType -> MacroEnv -> IO Bool Source #

test that a MacroEnv is passing all of its built-in tests

runTests :: (Eq a, Show a) => RegexType -> (String -> Maybe a) -> [(String, a)] -> MacroEnv -> MacroID -> MacroDescriptor -> MacroDescriptor Source #

runTests' :: (Eq a, Show a) => RegexType -> (Match String -> Maybe a) -> [(String, a)] -> MacroEnv -> MacroID -> MacroDescriptor -> MacroDescriptor Source #

The Parsers

module Text.RE.TestBench.Parsers

The Match Type

data Match a Source #

the result of matching a RE to a text once (with ?=~), retaining the text that was matched against

Instances

Functor Match Source #
Methods fmap :: (a -> b) -> Match a -> Match b # (<$) :: a -> Match b -> Match a #
(RegexContext regex source (AllTextSubmatches (Array Int) (source, (Int, Int))), RegexLike regex source) => RegexContext regex source (Match source) Source #	this instance hooks `Match` into regex-base: regex consumers need not worry about any of this
Methods match :: regex -> source -> Match source # matchM :: Monad m => regex -> source -> m (Match source) #
Eq a => Eq (Match a) Source #
Methods (==) :: Match a -> Match a -> Bool # (/=) :: Match a -> Match a -> Bool #
Show a => Show (Match a) Source #
Methods showsPrec :: Int -> Match a -> ShowS # show :: Match a -> String # showList :: [Match a] -> ShowS #