Safe Haskell	None
Language	Haskell2010

Text.RE.PCRE.RE

Contents

RE Type
REOptions Type
Compiling Regular Expressions
Compiling Search-Replace Templates
Escaping String
Macros Standard Environment
The Quasi Quoters
Orphan instances

Synopsis

RE Type

data RE Source #

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

Instances

IsOption REOptions RE CompOption ExecOption Source #
Methods makeREOptions :: REOptions -> REOptions_ RE CompOption ExecOption #
IsOption (Macros RE) RE CompOption ExecOption Source #
Methods makeREOptions :: Macros RE -> REOptions_ RE CompOption ExecOption #

regexType :: RegexType Source #

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

extract the REOptions from the RE

reSource :: RE -> String Source #

extract the RE source string from the RE

reCaptureNames :: RE -> CaptureNames Source #

extract the CaptureNames from the RE

reRegex :: RE -> Regex Source #

extract the back end compiled Regex type from the RE

REOptions Type

type REOptions = REOptions_ RE CompOption ExecOption Source #

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

defaultREOptions :: REOptions Source #

the default REOptions

noPreludeREOptions :: REOptions Source #

the default REOptions but with no RE macros defined

Compiling Regular Expressions

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

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

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

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) Source #

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) Source #

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) Source #

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

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

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

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

preludeEnv :: MacroEnv Source #

preludeTestsFailing :: [MacroID] Source #

preludeTable :: String Source #

preludeSummary :: PreludeMacro -> String Source #

preludeSources :: String Source #

preludeSource :: PreludeMacro -> String Source #

unpackSimpleREOptions :: SimpleREOptions -> REOptions Source #

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

The Quasi Quoters

re :: QuasiQuoter Source #