Text.RE.Types.Replace

Documentation

class (Show a, Eq a, Ord a, Extract a, Monoid a) => Replace a where

Replace provides the missing methods needed to replace the matched text; lengthE is the minimum implementation

Minimal complete definition

lengthE, packE, unpackE, linesE, unlinesE, parseTemplateE

Methods

lengthE :: a -> Int

length function for a

packE :: String -> a

inject String into a

unpackE :: a -> String

project a onto a String

textifyE :: a -> Text

inject into Text

detextifyE :: Text -> a

project Text onto a

linesE :: a -> [a]

split into lines

unlinesE :: [a] -> a

concatenate a list of lines

appendNewlineE :: a -> a

append a newline

substE :: (a -> a) -> Capture a -> a

apply a substitution function to a Capture

parseTemplateE :: a -> Match a -> Location -> Capture a -> Maybe a

convert a template containing $0, $1, etc., in the first argument, into a phi replacement function for use with replaceAllCaptures and replaceCaptures

Instances

Replace ByteString

Methods

lengthE :: ByteString -> Int

packE :: String -> ByteString

unpackE :: ByteString -> String

textifyE :: ByteString -> Text

detextifyE :: Text -> ByteString

linesE :: ByteString -> [ByteString]

unlinesE :: [ByteString] -> ByteString

appendNewlineE :: ByteString -> ByteString

substE :: (ByteString -> ByteString) -> Capture ByteString -> ByteString

parseTemplateE :: ByteString -> Match ByteString -> Location -> Capture ByteString -> Maybe ByteString

Replace ByteString

Methods

lengthE :: ByteString -> Int

packE :: String -> ByteString

unpackE :: ByteString -> String

textifyE :: ByteString -> Text

detextifyE :: Text -> ByteString

linesE :: ByteString -> [ByteString]

unlinesE :: [ByteString] -> ByteString

appendNewlineE :: ByteString -> ByteString

substE :: (ByteString -> ByteString) -> Capture ByteString -> ByteString

parseTemplateE :: ByteString -> Match ByteString -> Location -> Capture ByteString -> Maybe ByteString

Replace Text

Methods

lengthE :: Text -> Int

packE :: String -> Text

unpackE :: Text -> String

textifyE :: Text -> Text

detextifyE :: Text -> Text

linesE :: Text -> [Text]

unlinesE :: [Text] -> Text

appendNewlineE :: Text -> Text

substE :: (Text -> Text) -> Capture Text -> Text

parseTemplateE :: Text -> Match Text -> Location -> Capture Text -> Maybe Text

Replace Text

Methods

lengthE :: Text -> Int

packE :: String -> Text

unpackE :: Text -> String

textifyE :: Text -> Text

detextifyE :: Text -> Text

linesE :: Text -> [Text]

unlinesE :: [Text] -> Text

appendNewlineE :: Text -> Text

substE :: (Text -> Text) -> Capture Text -> Text

parseTemplateE :: Text -> Match Text -> Location -> Capture Text -> Maybe Text

Replace [Char]

Methods

lengthE :: [Char] -> Int

packE :: String -> [Char]

unpackE :: [Char] -> String

textifyE :: [Char] -> Text

detextifyE :: Text -> [Char]

linesE :: [Char] -> [[Char]]

unlinesE :: [[Char]] -> [Char]

appendNewlineE :: [Char] -> [Char]

substE :: ([Char] -> [Char]) -> Capture [Char] -> [Char]

parseTemplateE :: [Char] -> Match [Char] -> Location -> Capture [Char] -> Maybe [Char]

Replace (Seq Char)

Methods

lengthE :: Seq Char -> Int

packE :: String -> Seq Char

unpackE :: Seq Char -> String

textifyE :: Seq Char -> Text

detextifyE :: Text -> Seq Char

linesE :: Seq Char -> [Seq Char]

unlinesE :: [Seq Char] -> Seq Char

appendNewlineE :: Seq Char -> Seq Char

substE :: (Seq Char -> Seq Char) -> Capture (Seq Char) -> Seq Char

parseTemplateE :: Seq Char -> Match (Seq Char) -> Location -> Capture (Seq Char) -> Maybe (Seq Char)

data ReplaceMethods a

a selction of the Replace methods can be encapsulated with ReplaceMethods for the higher-order replacement functions

Constructors

ReplaceMethods

Fields

• methodLength :: a -> Int
• methodSubst :: (a -> a) -> Capture a -> a

replaceMethods :: Replace a => ReplaceMethods a

replaceMethods encapsulates ReplaceMethods a from a Replace a context

data Context

Context specifies which contexts the substitutions should be applied

Constructors

TOP

substitutions should be applied to the top-level only, the text that matched the whole RE

SUB

substitutions should only be applied to the text captured by bracketed sub-REs

ALL

the substitution function should be applied to all captures, the top level and the sub-expression captures

Instances

Show Context

Methods

showsPrec :: Int -> Context -> ShowS

show :: Context -> String

showList :: [Context] -> ShowS

data Location

the Location information passed into the substitution function specifies which sub-expression is being substituted

Constructors

Location

Fields

• locationMatch :: Int

  the zero-based, i-th string to be matched, when matching all strings, zero when only the first string is being matched

• locationCapture :: CaptureOrdinal

  0, when matching the top-level string matched by the whole RE, 1 for the top-most, left-most redex captured by bracketed sub-REs, etc.

Instances

Show Location

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

isTopLocation :: Location -> Bool

True iff the location references a complete match (i.e., not a bracketed capture)

replace :: Replace a => Match a -> a -> a

replaceAll :: Replace a => a -> Matches a -> a

replace all with a template, $0 for whole text, $1 for first capture, etc.

replaceAllCaptures :: Replace a => Context -> (Match a -> Location -> Capture a -> Maybe a) -> Matches a -> a

substitutes using a function that takes the full Match context and returns the same replacement text as the _phi_phi context.

replaceAllCaptures_ :: Extract a => ReplaceMethods a -> Context -> (Match a -> Location -> Capture a -> Maybe a) -> Matches a -> a

replaceAllCaptures_ is like like replaceAllCaptures but takes the Replace methods through the ReplaceMethods argument

replaceAllCapturesM :: (Extract a, Monad m) => ReplaceMethods a -> Context -> (Match a -> Location -> Capture a -> m (Maybe a)) -> Matches a -> m a

replaceAllCapturesM is just a monadically generalised version of replaceAllCaptures_

replaceCaptures :: Replace a => Context -> (Match a -> Location -> Capture a -> Maybe a) -> Match a -> a

substitutes using a function that takes the full Match context and returns the same replacement text as the _phi_phi context.

replaceCaptures_ :: Extract a => ReplaceMethods a -> Context -> (Match a -> Location -> Capture a -> Maybe a) -> Match a -> a

replaceCaptures_ is like replaceCaptures but takes the Replace methods through the ReplaceMethods argument

replaceCapturesM :: (Monad m, Extract a) => ReplaceMethods a -> Context -> (Match a -> Location -> Capture a -> m (Maybe a)) -> Match a -> m a

replaceCapturesM is just a monadically generalised version of replaceCaptures_

expandMacros :: (r -> String) -> Macros r -> String -> String

expand all of the @{..} macros in the RE in the argument String according to the Macros argument, preprocessing the RE String according to the Mode argument (used internally)

expandMacros' :: (MacroID -> Maybe String) -> String -> String

expand the @{..} macos in the argument string using the given function