Client.Commands.Interpolation

This module is able to parse commands with inline variables and then to evaluate those variables to produce a complete command that varies by the current context.

Documentation

data ExpansionChunk

Parsed chunk of an expandable command

Constructors

LiteralChunk Text

regular text

VariableChunk Text

inline variable $x or ${x y}

IntegerChunk Integer

inline variable $1 or ${1}

DefaultChunk ExpansionChunk Text

bracketed variable with default ${x|lit}

Instances

Show ExpansionChunk

Methods

showsPrec :: Int -> ExpansionChunk -> ShowS

show :: ExpansionChunk -> String

showList :: [ExpansionChunk] -> ShowS

parseExpansion :: Text -> Maybe [ExpansionChunk]

Parse a Text searching for the expansions as specified in ExpansionChunk. $$ is used to escape a single $.

resolveMacroExpansions

Arguments

:: (Text -> Maybe Text)

variable resolution

-> (Integer -> Maybe Text)

argument index resolution

-> [ExpansionChunk]

chunks

-> Maybe Text

concatenated, expanded chunks

Attempt to expand all of the elements in the given list using the two expansion functions. If the expansion of any chunk fails the whole expansion fails.

data Macro

Constructors

Macro

Fields

• macroSpec :: MacroSpec
• macroCommands :: [[ExpansionChunk]]

Instances

Show Macro

Methods

showsPrec :: Int -> Macro -> ShowS

show :: Macro -> String

showList :: [Macro] -> ShowS

data MacroSpec where

Constructors

MacroSpec :: ArgumentSpec s -> MacroSpec

Instances

Show MacroSpec

Methods

showsPrec :: Int -> MacroSpec -> ShowS

show :: MacroSpec -> String

showList :: [MacroSpec] -> ShowS

parseMacroSpecs :: Text -> Maybe MacroSpec

noMacroArguments :: MacroSpec

Specification used when unspecified, no arguments.