Safe Haskell	None
Language	Haskell2010

Text.RE.TestBench

Contents

Parsers
Text.RE

Synopsis

Documentation

newtype MacroID Source #

Constructors

MacroID
Fields getMacroID :: String

Instances

Eq MacroID Source #
Methods (==) :: MacroID -> MacroID -> Bool # (/=) :: MacroID -> MacroID -> Bool #
Ord MacroID Source #
Methods compare :: MacroID -> MacroID -> Ordering # (<) :: MacroID -> MacroID -> Bool # (<=) :: MacroID -> MacroID -> Bool # (>) :: MacroID -> MacroID -> Bool # (>=) :: MacroID -> MacroID -> Bool # max :: MacroID -> MacroID -> MacroID # min :: MacroID -> MacroID -> MacroID #
Show MacroID Source #
Methods showsPrec :: Int -> MacroID -> ShowS # show :: MacroID -> String # showList :: [MacroID] -> ShowS #
IsString MacroID Source #
Methods fromString :: String -> MacroID #
Hashable MacroID Source #
Methods hashWithSalt :: Int -> MacroID -> Int # hash :: MacroID -> Int #
IsOption (Macros RE) RE CompOption ExecOption Source #
Methods makeOptions :: Macros RE -> Options_ RE CompOption ExecOption Source #

data RegexType Source #

what kind of back end will be compiling the RE, and its match function

Instances

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

mkTDFA :: TestBenchMatcher -> RegexType Source #

mkPCRE :: TestBenchMatcher -> RegexType Source #

isTDFA :: RegexType -> Bool Source #

test RegexType for TDFA/PCREness

isPCRE :: RegexType -> Bool Source #

test RegexType for TDFA/PCREness

presentRegexType :: RegexType -> String Source #

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 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 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 Source #
Methods showsPrec :: Int -> MacroDescriptor -> ShowS # show :: MacroDescriptor -> String # showList :: [MacroDescriptor] -> ShowS #

newtype TestResult Source #

list of failures on a validation run

Constructors

TestResult
Fields _TestResult :: String

Instances

Show TestResult Source #
Methods showsPrec :: Int -> TestResult -> ShowS # show :: TestResult -> String # showList :: [TestResult] -> ShowS #
IsString TestResult Source #
Methods fromString :: String -> 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 Source #
Methods showsPrec :: Int -> RegexSource -> ShowS # show :: RegexSource -> String # showList :: [RegexSource] -> ShowS #
IsString RegexSource Source #
Methods fromString :: String -> 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 Source #
Methods showsPrec :: Int -> FunctionID -> ShowS # show :: FunctionID -> String # showList :: [FunctionID] -> ShowS #
IsString FunctionID Source #
Methods fromString :: String -> 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 #

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

Parsers

module Text.RE.TestBench.Parsers

Text.RE

module Text.RE