Text.RE.ZeInternals.TestBench

Documentation

newtype MacroID

MacroID is just a wrapped String type with an IsString instance

Constructors

MacroID

Fields

• getMacroID :: String

Instances

Eq MacroID

Methods

(==) :: MacroID -> MacroID -> Bool

(/=) :: MacroID -> MacroID -> Bool

Ord MacroID

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

Methods

showsPrec :: Int -> MacroID -> ShowS

show :: MacroID -> String

showList :: [MacroID] -> ShowS

IsString MacroID

Methods

fromString :: String -> MacroID

Hashable MacroID

MacroID is used with HM.HashMap to build macro lookup tables

Methods

hashWithSalt :: Int -> MacroID -> Int

hash :: MacroID -> Int

IsOption (Macros RE) RE CompOption ExecOption

Methods

makeREOptions :: Macros RE -> REOptions_ RE CompOption ExecOption

data RegexType

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

Instances

Show RegexType

Methods

showsPrec :: Int -> RegexType -> ShowS

show :: RegexType -> String

showList :: [RegexType] -> ShowS

mkTDFA :: TestBenchMatcher -> RegexType

mkPCRE :: TestBenchMatcher -> RegexType

isTDFA :: RegexType -> Bool

test RegexType for TDFA/PCREness

isPCRE :: RegexType -> Bool

test RegexType for TDFA/PCREness

presentRegexType :: RegexType -> String

type MacroEnv = HashMap MacroID MacroDescriptor

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

data WithCaptures

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

Methods

(==) :: WithCaptures -> WithCaptures -> Bool

(/=) :: WithCaptures -> WithCaptures -> Bool

Ord WithCaptures

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

Methods

showsPrec :: Int -> WithCaptures -> ShowS

show :: WithCaptures -> String

showList :: [WithCaptures] -> ShowS

data MacroDescriptor

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

Methods

showsPrec :: Int -> MacroDescriptor -> ShowS

show :: MacroDescriptor -> String

showList :: [MacroDescriptor] -> ShowS

newtype TestResult

list of failures on a validation run

Constructors

TestResult

Fields

• _TestResult :: String

Instances

Show TestResult

Methods

showsPrec :: Int -> TestResult -> ShowS

show :: TestResult -> String

showList :: [TestResult] -> ShowS

IsString TestResult

Methods

fromString :: String -> TestResult

newtype RegexSource

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

Methods

showsPrec :: Int -> RegexSource -> ShowS

show :: RegexSource -> String

showList :: [RegexSource] -> ShowS

IsString RegexSource

Methods

fromString :: String -> RegexSource

newtype FunctionID

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

Constructors

FunctionID

Fields

• _FunctionID :: String

Instances

Show FunctionID

Methods

showsPrec :: Int -> FunctionID -> ShowS

show :: FunctionID -> String

showList :: [FunctionID] -> ShowS

IsString FunctionID

Methods

fromString :: String -> FunctionID

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

construct a macro table suitable for use with the RE compilers

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

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

badMacros :: MacroEnv -> [MacroID]

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

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

formatMacroTable :: RegexType -> MacroEnv -> String

format a macros table as a markdown table

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

dump a MacroEnv into the docs directory

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

generate a plain text summary of a macro

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

list the source REs for each macro in plain text

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

list the source of a single macro in plain text

testMacroDescriptors :: [MacroDescriptor] -> [TestResult]

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