Text.RE.TDFA.RE

RE Type

data RE

the RE type for this back end representing a well-formed, compiled RE

Instances

IsOption REOptions RE CompOption ExecOption

Methods

makeREOptions :: REOptions -> REOptions_ RE CompOption ExecOption

IsOption (Macros RE) RE CompOption ExecOption

Methods

makeREOptions :: Macros RE -> REOptions_ RE CompOption ExecOption

regexType :: RegexType

some functions in the Text.RE.TestBench need the back end to be passed dynamically as a RegexType parameters: use regexType fpr this backend

reOptions :: RE -> REOptions

extract the REOptions from the RE

reSource :: RE -> String

extract the RE source string from the RE

reCaptureNames :: RE -> CaptureNames

extract the CaptureNames from the RE

reRegex :: RE -> Regex

extract the back end compiled Regex type from the RE

REOptions Type

type REOptions = REOptions_ RE CompOption ExecOption

and the REOptions for this back end (see Text.RE.Types.REOptions for details)

defaultREOptions :: REOptions

the default REOptions

noPreludeREOptions :: REOptions

the default REOptions but with no RE macros defined

Compiling Regular Expressions

compileRegex :: (Functor m, Monad m) => String -> m RE

compile a String into a RE with the default options, generating an error if the RE is not well formed

compileRegexWith :: (Functor m, Monad m) => SimpleREOptions -> String -> m RE

compile a String into a RE using the given SimpleREOptions, generating an error if the RE is not well formed

compileRegexWithOptions :: (IsOption o RE CompOption ExecOption, Functor m, Monad m) => o -> String -> m RE

compile a String into a RE using the given SimpleREOptions, generating an error if the RE is not well formed

Compiling Search-Replace Templates

compileSearchReplace :: (Monad m, Functor m, IsRegex RE s) => String -> String -> m (SearchReplace RE s)

compile a SearchReplace template generating errors if the RE or the template are not well formed -- all capture references being checked

compileSearchReplaceWith :: (Monad m, Functor m, IsRegex RE s) => SimpleREOptions -> String -> String -> m (SearchReplace RE s)

compile a SearchReplace template, with simple options, generating errors if the RE or the template are not well formed -- all capture references being checked

compileSearchReplaceWithREOptions :: (Monad m, Functor m, IsRegex RE s) => REOptions -> String -> String -> m (SearchReplace RE s)

compile a SearchReplace template, with general options, generating errors if the RE or the template are not well formed -- all capture references being checked

Escaping String

escape :: (Functor m, Monad m) => (String -> String) -> String -> m RE

convert a string into a RE that matches that string, and apply it to an argument continuation function to make up the RE string to be compiled

escapeWith :: (Functor m, Monad m) => SimpleREOptions -> (String -> String) -> String -> m RE

convert a string into a RE that matches that string, and apply it to an argument continuation function to make up the RE string to be compiled with the default options

escapeWithOptions :: (IsOption o RE CompOption ExecOption, Functor m, Monad m) => o -> (String -> String) -> String -> m RE

convert a string into a RE that matches that string, and apply it to an argument continuation function to make up the RE string to be compiled the given options

escapeREString :: String -> String

Convert a string into a regular expression that will amtch that string

Macros Standard Environment

prelude :: Macros RE

the standard table of Macros used to compile REs (which can be extended or replace: see Text.RE.TestBench)

preludeEnv :: MacroEnv

the standard MacroEnv for this back end (see Text.RE.TestBench)

preludeTestsFailing :: [MacroID]

the macros in the standard environment that are failing their tests (checked by the test suite to be empty)

preludeTable :: String

a table the standard macros in markdown format

preludeSummary :: PreludeMacro -> String

a summary of the macros in the standard environment for this back end in plain text

preludeSources :: String

a listing of the RE text for each macro in the standard environment with all macros expanded to normal form

preludeSource :: PreludeMacro -> String

the prolude source of a given macro in the standard environment

unpackSimpleREOptions :: SimpleREOptions -> REOptions

convert a universal SimpleReOptions into the REOptions used by this back end

The Quasi Quoters

re :: QuasiQuoter

the [re| ... |] and [ed| ... /// ... |] quasi quoters

reMS :: QuasiQuoter

the [re| ... |] and [ed| ... /// ... |] quasi quoters

reMI :: QuasiQuoter

the [re| ... |] and [ed| ... /// ... |] quasi quoters

reBS :: QuasiQuoter

the [re| ... |] and [ed| ... /// ... |] quasi quoters

reBI :: QuasiQuoter

the [re| ... |] and [ed| ... /// ... |] quasi quoters

reMultilineSensitive :: QuasiQuoter

the [re| ... |] and [ed| ... /// ... |] quasi quoters

reMultilineInsensitive :: QuasiQuoter

the [re| ... |] and [ed| ... /// ... |] quasi quoters

reBlockSensitive :: QuasiQuoter

the [re| ... |] and [ed| ... /// ... |] quasi quoters

reBlockInsensitive :: QuasiQuoter

the [re| ... |] and [ed| ... /// ... |] quasi quoters

re_ :: QuasiQuoter

the [re| ... |] and [ed| ... /// ... |] quasi quoters

cp :: QuasiQuoter

quasi quoter for CaptureID ([cp|0|],[cp|y|], etc.)

Orphan instances

IsOption () RE CompOption ExecOption

Methods

makeREOptions :: () -> REOptions_ RE CompOption ExecOption

IsOption CompOption RE CompOption ExecOption

Methods

makeREOptions :: CompOption -> REOptions_ RE CompOption ExecOption

IsOption ExecOption RE CompOption ExecOption

Methods

makeREOptions :: ExecOption -> REOptions_ RE CompOption ExecOption

IsOption SimpleREOptions RE CompOption ExecOption

Methods

makeREOptions :: SimpleREOptions -> REOptions_ RE CompOption ExecOption