Irc.Modes

This module provides support for interpreting the modes changed by a MODE command.

Interpretation of modes

data ModeTypes

Settings that describe how to interpret channel modes

Constructors

ModeTypes

Fields

• _modesLists :: [Char]

  modes for channel lists (e.g. ban)

• _modesAlwaysArg :: [Char]

  modes that always have an argument

• _modesSetArg :: [Char]

  modes that have an argument when set

• _modesNeverArg :: [Char]

  modes that never have arguments

• _modesPrefixModes :: [(Char, Char)]

  modes requiring a nickname argument (mode,sigil)

Instances

Show ModeTypes

Defined in Irc.Modes

Methods

showsPrec :: Int -> ModeTypes -> ShowS

show :: ModeTypes -> String

showList :: [ModeTypes] -> ShowS

modesLists :: Functor f => ([Char] -> f [Char]) -> ModeTypes -> f ModeTypes

Lens for _modesList

modesAlwaysArg :: Functor f => ([Char] -> f [Char]) -> ModeTypes -> f ModeTypes

Lens for _modesAlwaysArg

modesSetArg :: Functor f => ([Char] -> f [Char]) -> ModeTypes -> f ModeTypes

Lens for _modesSetArg

modesNeverArg :: Functor f => ([Char] -> f [Char]) -> ModeTypes -> f ModeTypes

Lens for _modesNeverArg

modesPrefixModes :: Functor f => ([(Char, Char)] -> f [(Char, Char)]) -> ModeTypes -> f ModeTypes

Lens for _modesPrefixModes

defaultModeTypes :: ModeTypes

The channel modes used by Solanum

defaultUmodeTypes :: ModeTypes

The default UMODE used by Solanum

Operations for working with MODE command parameters

splitModes

Arguments

:: ModeTypes

mode interpretation

-> Text

modes

-> [Text]

arguments

-> Maybe [(Bool, Char, Text)]

(set, mode, parameter)

Split up a mode change command and arguments into individual changes given a configuration.

unsplitModes

Arguments

:: [(Bool, Char, Text)]

(set,mode,parameter)

-> [Text]

Construct the arguments to a MODE command corresponding to the given mode changes.