Client.Commands.Types

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

type ClientCommand a

Arguments

 = ClientState

-> a

arguments

-> IO CommandResult

Type of commands that always work

type WindowCommand a = Focus -> ClientCommand a

Type of commands that operate on a window

type NetworkCommand a

Arguments

 = NetworkState

current network

-> ClientCommand a

Type of commands that require an active network to be focused

type MaybeChatCommand a

Arguments

 = Maybe Identifier

focused channel

-> NetworkCommand a

Type of commands that require an active network to be focused and maybe a chat window.

type ChannelCommand a

Arguments

 = Identifier

focused channel

-> NetworkCommand a

Type of commands that require an active channel to be focused

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

WindowCommand (WindowCommand a) (Bool -> WindowCommand String)

operates on a window

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

requires an active network

MaybeChatCommand (MaybeChatCommand a) (Bool -> MaybeChatCommand String)

requires an active network and maybe a chat window

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

requires an active chat window

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

requires an active channel window

data ArgsContext

Data available to the arguments parser at the time of parsing.

Constructors

ArgsContext

Fields

• argsContextSt :: ClientState
• argsContextFocus :: Focus

makeArgsContext :: ClientState -> ArgsContext

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

forall a. Command

Fields

• cmdNames :: NonEmpty Text

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

• cmdArgumentSpec :: Args ArgsContext 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 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]

commandSuccess :: Monad m => ClientState -> m CommandResult

Consider the text entry successful and resume the client

commandSuccessUpdateCS :: NetworkState -> ClientState -> IO CommandResult

Consider the text entry successful, and resume the client with a particular network updated.

commandFailure :: Monad m => ClientState -> m CommandResult

Consider the text entry a failure and resume the client

commandFailureMsg :: Text -> ClientState -> IO CommandResult

Command failure with an error message printed to client window