| Copyright | (c) Eric Mertens 2016 |
|---|---|
| License | ISC |
| Maintainer | emertens@gmail.com |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Client.State
Description
This module provides the core logic of the IRC client. The client state tracks everything about the client.
Synopsis
- data ClientState = ClientState {
- _clientWindows :: !(Map Focus Window)
- _clientPrevFocus :: !Focus
- _clientActivityReturn :: !(Maybe Focus)
- _clientFocus :: !Focus
- _clientSubfocus :: !Subfocus
- _clientExtraFocus :: ![(Focus, Subfocus)]
- _clientConnections :: !(HashMap Text NetworkState)
- _clientEvents :: !(TQueue NetworkEvent)
- _clientThreadJoins :: TQueue (Int, ThreadEntry)
- _clientConfig :: !Configuration
- _clientConfigPath :: !FilePath
- _clientTextBox :: !EditBox
- _clientTextBoxOffset :: !Int
- _clientWidth :: !Int
- _clientHeight :: !Int
- _clientScroll :: !Int
- _clientDetailView :: !Bool
- _clientActivityBar :: !Bool
- _clientShowPing :: !Bool
- _clientRegex :: Maybe Matcher
- _clientLayout :: LayoutMode
- _clientEditMode :: EditMode
- _clientEditLock :: Bool
- _clientNotifications :: [(Text, Text)]
- _clientBell :: !Bool
- _clientUiFocused :: !Bool
- _clientIgnores :: !(HashSet Identifier)
- _clientIgnoreMask :: Mask
- _clientExtensions :: !ExtensionState
- _clientLogQueue :: ![LogLine]
- _clientErrorMsg :: Maybe Text
- _clientRtsStats :: Maybe Stats
- _clientStsPolicy :: !(HashMap Text StsPolicy)
- _clientHighlights :: !(HashMap Identifier Highlight)
- clientWindows :: Lens' ClientState (Map Focus Window)
- clientTextBox :: Lens' ClientState EditBox
- clientTextBoxOffset :: Lens' ClientState Int
- clientConnections :: Lens' ClientState (HashMap Text NetworkState)
- clientThreadJoins :: Lens' ClientState (TQueue (Int, ThreadEntry))
- 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, Subfocus)]
- clientConfig :: Lens' ClientState Configuration
- clientScroll :: Lens' ClientState Int
- clientDetailView :: Lens' ClientState Bool
- clientActivityBar :: Lens' ClientState Bool
- clientShowPing :: Lens' ClientState Bool
- clientSubfocus :: Lens' ClientState Subfocus
- clientIgnores :: Lens' ClientState (HashSet Identifier)
- clientIgnoreMask :: Lens' ClientState Mask
- clientConnection :: Applicative f => Text -> LensLike' f ClientState NetworkState
- clientNotifications :: Lens' ClientState [(Text, Text)]
- clientBell :: Lens' ClientState Bool
- clientUiFocused :: Lens' ClientState Bool
- clientExtensions :: Lens' ClientState ExtensionState
- clientRegex :: Lens' ClientState (Maybe Matcher)
- clientLogQueue :: Lens' ClientState [LogLine]
- clientActivityReturn :: Lens' ClientState (Maybe Focus)
- clientErrorMsg :: Lens' ClientState (Maybe Text)
- clientLayout :: Lens' ClientState LayoutMode
- clientEditMode :: Lens' ClientState EditMode
- clientEditLock :: Lens' ClientState Bool
- clientRtsStats :: Lens' ClientState (Maybe Stats)
- clientConfigPath :: Lens' ClientState FilePath
- clientStsPolicy :: Lens' ClientState (HashMap Text StsPolicy)
- clientHighlights :: Lens' ClientState (HashMap Identifier Highlight)
- withClientState :: FilePath -> Configuration -> (ClientState -> IO a) -> IO a
- clientIsFiltered :: ClientState -> Bool
- clientFilter :: ClientState -> (a -> Text) -> [a] -> [a]
- clientFilterChannels :: ClientState -> Maybe Int -> Maybe Int -> [(Identifier, Int, Text)] -> [(Identifier, Int, Text)]
- clientNetworkPalette :: ClientState -> NetworkPalette
- buildMatcher :: String -> Maybe Matcher
- clientToggleHideMeta :: ClientState -> ClientState
- channelUserList :: Text -> Identifier -> ClientState -> [Identifier]
- consumeInput :: ClientState -> ClientState
- currentCompletionList :: ClientState -> [Identifier]
- identIgnored :: UserInfo -> ClientState -> Bool
- clientFirstLine :: ClientState -> String
- clientLine :: ClientState -> (Int, String)
- abortNetwork :: Text -> ClientState -> IO ClientState
- addConnection :: Int -> Maybe UTCTime -> Maybe Int -> Text -> ClientState -> IO ClientState
- removeNetwork :: Text -> ClientState -> (NetworkState, ClientState)
- clientTick :: ClientState -> ClientState
- applyMessageToClientState :: ZonedTime -> IrcMsg -> Text -> NetworkState -> ClientState -> ([RawIrcMsg], ClientState)
- clientHighlightsFocus :: Focus -> ClientState -> HashMap Identifier Highlight
- clientWindowNames :: ClientState -> [Char]
- clientPalette :: ClientState -> Palette
- clientAutoconnects :: ClientState -> [Text]
- clientActiveCommand :: ClientState -> Maybe (String, String)
- clientNextWindowName :: Maybe WindowHint -> ClientState -> Char
- clientWindowHint :: Focus -> ClientState -> Maybe WindowHint
- clientExtraFocuses :: ClientState -> [(Focus, Subfocus)]
- currentNickCompletionMode :: ClientState -> WordCompletionMode
- recordChannelMessage :: Text -> Identifier -> ClientMessage -> ClientState -> ClientState
- recordNetworkMessage :: ClientMessage -> ClientState -> ClientState
- recordError :: ZonedTime -> Text -> Text -> ClientState -> ClientState
- recordIrcMessage :: Text -> MessageTarget -> ClientMessage -> ClientState -> ClientState
- recordSuccess :: ZonedTime -> ClientState -> Text -> ClientState
- changeFocus :: Focus -> ClientState -> ClientState
- changeSubfocus :: Subfocus -> ClientState -> ClientState
- returnFocus :: ClientState -> ClientState
- advanceFocus :: ClientState -> ClientState
- advanceNetworkFocus :: ClientState -> ClientState
- retreatFocus :: ClientState -> ClientState
- jumpToActivity :: ClientState -> ClientState
- jumpFocus :: Char -> ClientState -> ClientState
- setExtraFocus :: [(Focus, Subfocus)] -> ClientState -> ClientState
- scrollClient :: Int -> ClientState -> ClientState
- data ExtensionState
- esActive :: Lens' ExtensionState (IntMap ActiveExtension)
- esMVar :: Lens' ExtensionState (MVar ParkState)
- esStablePtr :: Lens' ExtensionState (StablePtr (MVar ParkState))
Client state type
data ClientState Source #
All state information for the IRC client
Constructors
| ClientState | |
Fields
| |
Lenses
clientThreadJoins :: Lens' ClientState (TQueue (Int, ThreadEntry)) Source #
clientExtraFocus :: Lens' ClientState [(Focus, Subfocus)] Source #
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.
clientNotifications :: Lens' ClientState [(Text, Text)] Source #
clientRegex :: Lens' ClientState (Maybe Matcher) Source #
clientRtsStats :: Lens' ClientState (Maybe Stats) Source #
Client operations
withClientState :: FilePath -> Configuration -> (ClientState -> IO a) -> IO a Source #
Construct an initial ClientState using default values.
clientIsFiltered :: ClientState -> Bool Source #
clientFilter :: ClientState -> (a -> Text) -> [a] -> [a] Source #
clientFilterChannels :: ClientState -> Maybe Int -> Maybe Int -> [(Identifier, Int, Text)] -> [(Identifier, Int, Text)] Source #
clientNetworkPalette :: ClientState -> NetworkPalette Source #
Generates the NetworkPalette for the current focus.
buildMatcher :: String -> Maybe Matcher Source #
clientToggleHideMeta :: ClientState -> ClientState Source #
Toggle the hide metadata setting for the focused window.
Arguments
| :: Text | network |
| -> Identifier | channel |
| -> ClientState | |
| -> [Identifier] | nicks |
consumeInput :: ClientState -> ClientState Source #
Add the textbox input to the edit history and clear the textbox.
currentCompletionList :: ClientState -> [Identifier] Source #
Returns the current network's channels and current channel's users.
Arguments
| :: UserInfo | target user |
| -> ClientState | client state |
| -> Bool | is ignored |
Predicate for nicknames to determine if messages should be ignored.
clientFirstLine :: ClientState -> String Source #
The full top-most line that would be executed
Arguments
| :: ClientState | |
| -> (Int, String) | line number, line content |
The line under the cursor in the edit box.
Arguments
| :: Text | network |
| -> ClientState | |
| -> IO ClientState |
Forcefully terminate the connection currently associated with a given network name.
Arguments
| :: Int | attempts |
| -> Maybe UTCTime | optional disconnect time |
| -> Maybe Int | STS upgrade port |
| -> Text | network name |
| -> ClientState | |
| -> IO ClientState |
Start a new connection. The delay is used for reconnections.
removeNetwork :: Text -> ClientState -> (NetworkState, ClientState) Source #
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 Source #
Function applied to the client state every redraw.
applyMessageToClientState Source #
Arguments
| :: ZonedTime | timestamp |
| -> IrcMsg | message received |
| -> Text | network name |
| -> NetworkState | network connection state |
| -> ClientState | client state |
| -> ([RawIrcMsg], ClientState) | response , updated state |
clientWindowNames :: ClientState -> [Char] Source #
Produce the list of window names configured for the client.
clientPalette :: ClientState -> Palette Source #
Produce the list of window names configured for the client.
clientAutoconnects :: ClientState -> [Text] Source #
Returns the list of network names that requested autoconnection.
Arguments
| :: ClientState | client state |
| -> Maybe (String, String) | command name and argument string |
Compute the command and arguments currently in the textbox.
clientNextWindowName :: Maybe WindowHint -> ClientState -> Char Source #
clientWindowHint :: Focus -> ClientState -> Maybe WindowHint Source #
clientExtraFocuses :: ClientState -> [(Focus, Subfocus)] Source #
List of extra focuses to display as split windows
currentNickCompletionMode :: ClientState -> WordCompletionMode Source #
Returns the WordCompletionMode associated with the current network.
Add messages to buffers
Arguments
| :: Text | network |
| -> Identifier | channel |
| -> ClientMessage | |
| -> ClientState | |
| -> ClientState |
Add a message to the window associated with a given channel
recordNetworkMessage :: ClientMessage -> ClientState -> ClientState Source #
Record a message on a network window
Arguments
| :: ZonedTime | now |
| -> Text | network |
| -> Text | error message |
| -> ClientState | client state |
| -> ClientState |
Arguments
| :: Text | network |
| -> MessageTarget | |
| -> ClientMessage | |
| -> ClientState | |
| -> ClientState |
Record a message in the windows corresponding to the given target
recordSuccess :: ZonedTime -> ClientState -> Text -> ClientState Source #
Focus manipulation
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.
Arguments
| :: Subfocus | new subfocus |
| -> ClientState | client state |
| -> ClientState |
Change the subfocus to the given value, preserve the focus, reset the scroll.
returnFocus :: ClientState -> ClientState Source #
Return to previously focused window.
advanceFocus :: ClientState -> ClientState Source #
Step focus to the next window when on message view. Otherwise switch to message view.
advanceNetworkFocus :: ClientState -> ClientState Source #
Step focus to the next window when on message view. Otherwise switch to message view.
retreatFocus :: ClientState -> ClientState Source #
Step focus to the previous window when on message view. Otherwise switch to message view.
jumpToActivity :: ClientState -> ClientState Source #
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.
Arguments
| :: Char | window name |
| -> ClientState | |
| -> ClientState |
Jump the focus directly to a window based on its zero-based index while ignoring hidden windows.
setExtraFocus :: [(Focus, Subfocus)] -> ClientState -> ClientState Source #
Unified logic for assigning to the extra focuses field that activates and deactivates windows as needed.
Scrolling
scrollClient :: Int -> ClientState -> ClientState Source #
Scroll the current buffer to show newer messages
Extensions
data ExtensionState Source #
State of the extension API including loaded extensions and the mechanism used to support reentry into the Haskell runtime from the C API.
When executing inside an extension the mvar will contain the client state and the ID of the running extension.
esStablePtr :: Lens' ExtensionState (StablePtr (MVar ParkState)) Source #