Client.Commands

This module renders the lines used in the channel mask list. A mask list can show channel bans, quiets, invites, and exceptions.

Documentation

data CommandResult

Possible results of running a command

Constructors

CommandSuccess ClientState

Continue running the client, consume input if command was from input

CommandFailure ClientState

Continue running the client, report an error

CommandQuit ClientState

Client should close

execute

Arguments

:: String

chat or command

-> ClientState

client state

-> IO CommandResult

command result

Interpret the given chat message or command. Leading / indicates a command. Otherwise if a channel or user query is focused a chat message will be sent. Leading spaces before the / are ignored when checking for commands.

executeUserCommand

Arguments

:: Maybe Text

disconnection time

-> String

command

-> ClientState

client state

-> IO CommandResult

command result

Execute command provided by user, resolve aliases if necessary.

The last disconnection time is stored in text form and is available for substitutions in macros. It is only provided when running startup commands during a reconnect event.

commandExpansion

Arguments

:: Maybe Text

disconnect time

-> ClientState

client state

-> Text

expansion variable

-> Maybe Text

expansion value

Compute the replacement value for the given expansion variable.

tabCompletion

Arguments

:: Bool

reversed

-> ClientState

client state

-> IO CommandResult

command result

Respond to the TAB key being pressed. This can dispatch to a command specific completion mode when relevant. Otherwise this will complete input based on the users of the channel related to the current buffer.

Commands

data CommandSection

A command section is a logical grouping of commands. This allows for showing more structure in the help menu system.

Constructors

CommandSection

Fields

• cmdSectionName :: Text
• cmdSectionCmds :: [Command]

data Command

A command is a list of aliases, an argument specification, implementation, and documentation. The arguments and implementation must match so that the parsed arguments will match what the implementation expects.

Constructors

Command

Fields

• cmdNames :: NonEmpty Text

  Names of this command, first in the list is the "primary" name

• cmdArgumentSpec :: Args ClientState a

  Specification of the arguments of the command

• cmdDocumentation :: Text

  Multi-line IRC-formatted documentation text used for /help

• cmdImplementation :: CommandImpl a

  Implementation of the command for both execution and tab completion

data CommandImpl a

Pair of implementations for executing a command and tab completing one. The tab-completion logic is extended with a Bool indicating that tab completion should be reversed

Constructors

ClientCommand (ClientCommand a) (Bool -> ClientCommand String)

no requirements

NetworkCommand (NetworkCommand a) (Bool -> NetworkCommand String)

requires an active network

ChatCommand (ChannelCommand a) (Bool -> ChannelCommand String)

requires an active chat window

ChannelCommand (ChannelCommand a) (Bool -> ChannelCommand String)

requires an active channel window

commands :: Recognizer Command

Map of built-in client commands to their implementations, tab completion logic, and argument structures.

commandsList :: [CommandSection]

Raw list of commands in the order used for /help