Text.RE.ZeInternals.PreludeMacros

Documentation

data RegexType

what flavour of regex are we dealing with

Instances

Show RegexType

Methods

showsPrec :: Int -> RegexType -> ShowS

show :: RegexType -> String

showList :: [RegexType] -> ShowS

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

data PreludeMacro

an enumeration of all of the prelude macros

Constructors

PM_nat

PM_hex

PM_int

PM_frac

PM_string

PM_string_simple

PM_id

PM_id'

PM_id_

PM_date

PM_date_slashes

PM_time

PM_timezone

PM_datetime

PM_datetime_8601

PM_datetime_clf

PM_shortmonth

PM_address_ipv4

PM_email_simple

PM_url

PM_syslog_severity

Instances

Bounded PreludeMacro

Methods

minBound :: PreludeMacro

maxBound :: PreludeMacro

Enum PreludeMacro

Methods

succ :: PreludeMacro -> PreludeMacro

pred :: PreludeMacro -> PreludeMacro

toEnum :: Int -> PreludeMacro

fromEnum :: PreludeMacro -> Int

enumFrom :: PreludeMacro -> [PreludeMacro]

enumFromThen :: PreludeMacro -> PreludeMacro -> [PreludeMacro]

enumFromTo :: PreludeMacro -> PreludeMacro -> [PreludeMacro]

enumFromThenTo :: PreludeMacro -> PreludeMacro -> PreludeMacro -> [PreludeMacro]

Eq PreludeMacro

Methods

(==) :: PreludeMacro -> PreludeMacro -> Bool

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

Ord PreludeMacro

Methods

compare :: PreludeMacro -> PreludeMacro -> Ordering

(<) :: PreludeMacro -> PreludeMacro -> Bool

(<=) :: PreludeMacro -> PreludeMacro -> Bool

(>) :: PreludeMacro -> PreludeMacro -> Bool

(>=) :: PreludeMacro -> PreludeMacro -> Bool

max :: PreludeMacro -> PreludeMacro -> PreludeMacro

min :: PreludeMacro -> PreludeMacro -> PreludeMacro

Show PreludeMacro

Methods

showsPrec :: Int -> PreludeMacro -> ShowS

show :: PreludeMacro -> String

showList :: [PreludeMacro] -> ShowS

presentPreludeMacro :: PreludeMacro -> String

naming the macros

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

generate the standard prelude Macros used to parse REs

preludeMacroTable :: RegexType -> String

format the standard prelude macros in a markdown table

preludeMacroSummary :: RegexType -> PreludeMacro -> String

generate a textual summary of the prelude macros

preludeMacroSources :: RegexType -> String

generate a plain text table giving the RE for each macro with all macros expanded (to NF)

preludeMacroSource :: RegexType -> PreludeMacro -> String

generate plain text giving theexpanded RE for a single macro

preludeMacroEnv :: RegexType -> MacroEnv

generate the MacroEnv for the standard prelude macros

preludeMacroDescriptor :: RegexType -> MacroEnv -> PreludeMacro -> Maybe MacroDescriptor

generate the MacroDescriptor for a given PreludeMacro