Text.RE.IsRegex

Documentation

class Replace s => IsRegex re s where

the IsRegex class allows polymorhic tools to be written that will work with a variety of regex back ends and text types

Minimal complete definition

matchOnce, matchMany, makeRegexWith, makeSearchReplaceWith, regexSource

Methods

matchOnce :: re -> s -> Match s

finding the first match

matchMany :: re -> s -> Matches s

finding all matches

makeRegex :: (Functor m, Monad m) => s -> m re

compiling an RE, failing if the RE is not well formed

makeRegexWith :: (Functor m, Monad m) => SimpleREOptions -> s -> m re

comiling an RE, specifying the SimpleREOptions

makeSearchReplace :: (Functor m, Monad m, IsRegex re s) => s -> s -> m (SearchReplace re s)

compiling a SearchReplace template from the RE text and the template Text, failing if they are not well formed

makeSearchReplaceWith :: (Functor m, Monad m, IsRegex re s) => SimpleREOptions -> s -> s -> m (SearchReplace re s)

compiling a SearchReplace template specifing the SimpleREOptions for the RE

makeEscaped :: (Functor m, Monad m) => (s -> s) -> s -> m re

incorporate an escaped string into a compiled RE with the default options

makeEscapedWith :: (Functor m, Monad m) => SimpleREOptions -> (s -> s) -> s -> m re

incorporate an escaped string into a compiled RE with the specified SimpleREOptions

regexSource :: re -> s

extract the text of the RE from the RE

data SearchReplace re s

contains a compiled RE and replacement template

Constructors

SearchReplace

Fields

• getSearch :: !re

  the RE

• getTemplate :: !s

  the replacement template

Instances

Functor (SearchReplace re)

Methods

fmap :: (a -> b) -> SearchReplace re a -> SearchReplace re b

(<$) :: a -> SearchReplace re b -> SearchReplace re a

(Show s, Show re) => Show (SearchReplace re s)

Methods

showsPrec :: Int -> SearchReplace re s -> ShowS

show :: SearchReplace re s -> String

showList :: [SearchReplace re s] -> ShowS

searchReplaceAll :: IsRegex re s => SearchReplace re s -> s -> s

searching and replacing the first occurrence

searchReplaceFirst :: IsRegex re s => SearchReplace re s -> s -> s

searching and replaceing all occurrences