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.

Variables are built from 1 or more letters.

Optional arguments are suffixed with a ?

Remaining text arguments are suffixed with a *

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

Defined in Client.Commands.Interpolation

Methods

showsPrec :: Int -> ExpansionChunk -> ShowS

show :: ExpansionChunk -> String

showList :: [ExpansionChunk] -> ShowS

parseExpansion :: Text -> Either Text [ExpansionChunk]

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

resolveMacroExpansions

Arguments

:: Alternative f

=> (Text -> f Text)

variable resolution

-> (Integer -> f Text)

argument index resolution

-> [ExpansionChunk]

chunks

-> f 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

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

Instances

Show Macro

Defined in Client.Commands.Interpolation

Methods

showsPrec :: Int -> Macro -> ShowS

show :: Macro -> String

showList :: [Macro] -> ShowS

data MacroSpec where

Constructors

MacroSpec :: (forall r. Args r [String]) -> MacroSpec

Instances

Show MacroSpec

Defined in Client.Commands.Interpolation

Methods

showsPrec :: Int -> MacroSpec -> ShowS

show :: MacroSpec -> String

showList :: [MacroSpec] -> ShowS

parseMacroSpecs :: Text -> Either Text MacroSpec

noMacroArguments :: MacroSpec

Specification used when unspecified, no arguments.