Client.State

This module provides the core logic of the IRC client. The client state tracks everything about the client.

Client state type

data ClientState

All state information for the IRC client

Constructors

ClientState

Fields

• _clientWindows :: !(Map Focus Window)

  client message buffers

• _clientPrevFocus :: !Focus

  previously focused buffer

• _clientActivityReturn :: !Focus

  focus prior to jumping to activity

• _clientFocus :: !Focus

  currently focused buffer

• _clientSubfocus :: !Subfocus

  current view mode

• _clientExtraFocus :: ![Focus]

  extra messages windows to view

• _clientConnections :: !(IntMap NetworkState)

  state of active connections

• _clientNextConnectionId :: !NetworkId

  next available NetworkId

• _clientEvents :: !(TQueue NetworkEvent)

  incoming network event queue

• _clientNetworkMap :: !(HashMap Text NetworkId)

  network name to connection ID

• _clientConfig :: !Configuration

  client configuration

• _clientTextBox :: !EditBox

  primary text box

• _clientTextBoxOffset :: !Int

  size to crop from left of text box

• _clientWidth :: !Int

  current terminal width

• _clientHeight :: !Int

  current terminal height

• _clientScroll :: !Int

  buffer scroll lines

• _clientDetailView :: !Bool

  use detailed rendering mode

• _clientActivityBar :: !Bool

  visible activity bar

• _clientShowMetadata :: !Bool

  visible activity bar

• _clientRegex :: Maybe Regex

  optional persistent filter

• _clientBell :: !Bool

  sound a bell next draw

• _clientIgnores :: !(HashSet Identifier)

  ignored nicknames

• _clientExtensions :: !ExtensionState

  state of loaded extensions

• _clientLogQueue :: ![LogLine]

  log lines ready to write

Lenses

clientWindows :: Lens' ClientState (Map Focus Window)

clientTextBox :: Lens' ClientState EditBox

clientTextBoxOffset :: Lens' ClientState Int

clientConnections :: Lens' ClientState (IntMap NetworkState)

clientWidth :: Lens' ClientState Int

clientHeight :: Lens' ClientState Int

clientEvents :: Lens' ClientState (TQueue NetworkEvent)

clientFocus :: Lens' ClientState Focus

clientPrevFocus :: Lens' ClientState Focus

clientExtraFocus :: Lens' ClientState [Focus]

clientConfig :: Lens' ClientState Configuration

clientScroll :: Lens' ClientState Int

clientDetailView :: Lens' ClientState Bool

clientActivityBar :: Lens' ClientState Bool

clientShowMetadata :: Lens' ClientState Bool

clientSubfocus :: Lens' ClientState Subfocus

clientNextConnectionId :: Lens' ClientState NetworkId

clientNetworkMap :: Lens' ClientState (HashMap Text NetworkId)

clientIgnores :: Lens' ClientState (HashSet Identifier)

clientConnection

Arguments

:: Applicative f

=> Text

network

-> LensLike' f ClientState NetworkState

Traversal for finding the NetworkState associated with a given network if that connection is currently active.

clientBell :: Lens' ClientState Bool

clientExtensions :: Lens' ClientState ExtensionState

clientRegex :: Lens' ClientState (Maybe Regex)

clientLogQueue :: Lens' ClientState [LogLine]

clientActivityReturn :: Lens' ClientState Focus

Client operations

withClientState :: Configuration -> (ClientState -> IO a) -> IO a

Construct an initial ClientState using default values.

clientStartExtensions :: ClientState -> IO ClientState

Start extensions after ensuring existing ones are stopped

clientShutdown :: ClientState -> IO ()

Actions to be run when exiting the client.

clientPark

Arguments

:: ClientState

client state

-> (Ptr () -> IO a)

continuation using the stable pointer to the client

-> IO (ClientState, a)

Prepare the client to support reentry from the extension API.

clientMatcher

Arguments

:: ClientState

client state

-> Maybe (Text -> Bool)

optional predicate

Returns the current filtering predicate if one is active.

clientActiveRegex :: ClientState -> Maybe Regex

Construct a text matching predicate used to filter the message window.

consumeInput :: ClientState -> ClientState

Add the textbox input to the edit history and clear the textbox.

currentCompletionList :: ClientState -> [Identifier]

Returns the current network's channels and current channel's users.

identIgnored

Arguments

:: Identifier

nickname

-> ClientState

client state

-> Bool

is ignored

Predicate for nicknames to determine if messages should be ignored.

clientFirstLine :: ClientState -> String

The full top-most line that would be executed

clientLine

Arguments

:: ClientState

-> (Int, String)

line number, line content

The line under the cursor in the edit box.

abortNetwork

Arguments

:: Text

network

-> ClientState

-> IO ClientState

Forcefully terminate the connection currently associated with a given network name.

addConnection

Arguments

:: Int

attempts

-> Maybe UTCTime

optional disconnect time

-> Text

network name

-> ClientState

-> IO ClientState

Start a new connection. The delay is used for reconnections.

removeNetwork :: NetworkId -> ClientState -> (NetworkState, ClientState)

Remove a network connection and unlink it from the network map. This operation assumes that the network connection exists and should only be applied once per connection.

clientTick :: ClientState -> ClientState

Function applied to the client state every redraw.

applyMessageToClientState

Arguments

:: ZonedTime

timestamp

-> IrcMsg

message received

-> NetworkId

message network

-> NetworkState

network connection state

-> ClientState

client state

-> ([RawIrcMsg], ClientState)

response , updated state

clientHighlights

Arguments

:: NetworkState

network state

-> ClientState

client state

-> HashSet Identifier

extra highlight identifiers

Compute the set of extra identifiers that should be highlighted given a particular network state.

clientWindowNames :: ClientState -> [Char]

Produce the list of window names configured for the client.

clientPalette :: ClientState -> Palette

Produce the list of window names configured for the client.

clientAutoconnects :: ClientState -> [Text]

Returns the list of network names that requested autoconnection.

clientActiveCommand

Arguments

:: ClientState

client state

-> Maybe (String, String)

command name and argument string

Compute the command and arguments currently in the textbox.

clientExtraFocuses :: ClientState -> [Focus]

List of extra focuses to display as split windows

currentNickCompletionMode :: ClientState -> WordCompletionMode

Returns the WordCompletionMode associated with the current network.

Add messages to buffers

recordChannelMessage

Arguments

:: Text

network

-> Identifier

channel

-> ClientMessage

-> ClientState

-> ClientState

Add a message to the window associated with a given channel

recordNetworkMessage :: ClientMessage -> ClientState -> ClientState

Record a message on a network window

recordIrcMessage

Arguments

:: Text

network

-> MessageTarget

-> ClientMessage

-> ClientState

-> ClientState

Record a message in the windows corresponding to the given target

Focus manipulation

changeFocus

Arguments

:: Focus

new focus

-> ClientState

client state

-> ClientState

Change the window focus to the given value, reset the subfocus to message view, reset the scroll, remember the previous focus if it changed.

changeSubfocus

Arguments

:: Subfocus

new subfocus

-> ClientState

client state

-> ClientState

Change the subfocus to the given value, preserve the focus, reset the scroll.

returnFocus :: ClientState -> ClientState

Return to previously focused window.

advanceFocus :: ClientState -> ClientState

Step focus to the next window when on message view. Otherwise switch to message view.

advanceNetworkFocus :: ClientState -> ClientState

Step focus to the next window when on message view. Otherwise switch to message view.

retreatFocus :: ClientState -> ClientState

Step focus to the previous window when on message view. Otherwise switch to message view.

jumpToActivity :: ClientState -> ClientState

Jump the focus of the client to a buffer that has unread activity. Some events like errors or chat messages mentioning keywords are considered important and will be jumped to first.

jumpFocus

Arguments

:: Int

zero-based window index

-> ClientState

-> ClientState

Jump the focus directly to a window based on its zero-based index.

setExtraFocus :: [Focus] -> ClientState -> ClientState

Unified logic for assigning to the extra focuses field that activates and deactivates windows as needed.

Scrolling

scrollClient :: Int -> ClientState -> ClientState

Scroll the current buffer to show newer messages

Extensions

data ExtensionState

State of the extension API including loaded extensions and the mechanism used to support reentry into the Haskell runtime from the C API.

esActive :: Lens' ExtensionState [ActiveExtension]

URL view

urlPattern :: Regex

Regular expression for matching HTTP/HTTPS URLs in chat text.

urlMatches :: Text -> [Text]

Find all the URL matches using urlPattern in a given Text suitable for being opened. Surrounding < and > are removed.