Safe Haskell	None
Language	Haskell2010

Text.RE.TestBench

Synopsis

Documentation

newtype MacroID Source

Constructors

MacroID
Fields _MacroID :: String

Instances

Eq MacroID
Ord MacroID
Show MacroID
IsString MacroID
Hashable MacroID
IsOption (Macros RE) RE CompOption ExecOption
IsOption (Macros RE) RE CompOption ExecOption

data RegexType Source

what kind of back end will be compiling the RE

Constructors

TDFA
PCRE

Instances

Bounded RegexType
Enum RegexType
Eq RegexType
Ord RegexType
Show RegexType

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 WithCaptures Source

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

Constructors

InclCaptures
ExclCaptures

Instances

Eq WithCaptures
Ord WithCaptures
Show WithCaptures

data MacroDescriptor Source

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

Constructors

MacroDescriptor
Fields _md_source :: !RegexSource the RE _md_samples :: ![String] some sample matches _md_counter_samples :: ![String] some sample non-matches _md_test_results :: ![TestResult] validation test results _md_parser :: !(Maybe FunctionID) WA, the parser function _md_description :: !String summary comment

Instances

Show MacroDescriptor

newtype TestResult Source

list of failures on a validation run

Constructors

TestResult
Fields _TestResult :: String

Instances

Show TestResult
IsString TestResult

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
IsString RegexSource

newtype FunctionID Source

name of the Haskell parser function for parsing the text matched by a macro

Constructors

FunctionID
Fields _FunctionID :: String

Instances

Show FunctionID
IsString FunctionID

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

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

badMacros :: MacroEnv -> [MacroID] Source

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

formatMacroTable :: RegexType -> MacroEnv -> String Source

dumpMacroTable :: String -> RegexType -> MacroEnv -> IO () Source

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

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

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

testMacroDescriptors :: [MacroDescriptor] -> [TestResult] Source