Safe Haskell	None
Language	Haskell2010

Matterhorn.Types

Synopsis

data ConnectionStatus
- = Connected
- | Disconnected
data HelpTopic = HelpTopic {
- helpTopicName :: Text
- helpTopicDescription :: Text
- helpTopicScreen :: HelpScreen
- helpTopicViewportName :: Name
}
data MessageSelectState = MessageSelectState {
- selectMessageId :: Maybe MessageId
}
data ProgramOutput = ProgramOutput {
- program :: FilePath
- programArgs :: [String]
- programStdout :: String
- programStderr :: String
- programExitCode :: ExitCode
}
data MHEvent
- = WSEvent WebsocketEvent
- | WSActionResponse WebsocketActionResponse
- | RespEvent (MH ())
- | RefreshWebsocketEvent
- | WebsocketParseError String
- | WebsocketDisconnect
- | WebsocketConnect
- | BGIdle
- | BGBusy (Maybe Int)
- | RateLimitExceeded Int
- | RateLimitSettingsMissing
- | RequestDropped
- | IEvent InternalEvent
data InternalEvent
- = DisplayError MHError
- | LoggingStarted FilePath
- | LoggingStopped FilePath
- | LogStartFailed FilePath String
- | LogDestination (Maybe FilePath)
- | LogSnapshotSucceeded FilePath
- | LogSnapshotFailed FilePath String
data Name
- = ChannelMessages ChannelId
- | MessageInput TeamId
- | ChannelList TeamId
- | HelpViewport
- | HelpText
- | ScriptHelpText
- | ThemeHelpText
- | SyntaxHighlightHelpText
- | KeybindingHelpText
- | ChannelSelectString TeamId
- | ChannelSelectEntry ChannelSelectMatch
- | CompletionAlternatives TeamId
- | CompletionList TeamId
- | JoinChannelList TeamId
- | UrlList TeamId
- | MessagePreviewViewport TeamId
- | ThemeListSearchInput TeamId
- | UserListSearchInput TeamId
- | JoinChannelListSearchInput TeamId
- | UserListSearchResults TeamId
- | ThemeListSearchResults TeamId
- | ViewMessageArea TeamId
- | ViewMessageReactionsArea TeamId
- | ChannelSidebar TeamId
- | ChannelSelectInput TeamId
- | AttachmentList TeamId
- | AttachmentFileBrowser TeamId
- | MessageReactionsArea TeamId
- | ReactionEmojiList TeamId
- | ReactionEmojiListInput TeamId
- | TabbedWindowTabBar TeamId
- | MuteToggleField TeamId
- | ChannelMentionsField TeamId
- | DesktopNotificationsField TeamId (WithDefault NotifyOption)
- | PushNotificationsField TeamId (WithDefault NotifyOption)
- | ChannelTopicEditor TeamId
- | ChannelTopicSaveButton TeamId
- | ChannelTopicCancelButton TeamId
- | ChannelTopicEditorPreview TeamId
- | ChannelTopic
- | TeamList
- | ClickableChannelListEntry ChannelId
- | ClickableTeamListEntry TeamId
- | ClickableURL Name Int LinkTarget
- | ClickableURLInMessage MessageId Int LinkTarget
- | ClickableUsernameInMessage MessageId Int Text
- | ClickableUsername Name Int Text
- | ClickableURLListEntry Int LinkTarget
- | ClickableReactionInMessage PostId Text (Set UserId)
- | ClickableReaction PostId Text (Set UserId)
- | AttachmentPathEditor TeamId
- | AttachmentPathSaveButton TeamId
- | AttachmentPathCancelButton TeamId
- | RenderedMessage MessageId
- | ReactionEmojiListOverlayEntry (Bool, Text)
data ChannelSelectMatch = ChannelSelectMatch {
- nameBefore :: Text
- nameMatched :: Text
- nameAfter :: Text
- matchFull :: Text
- matchEntry :: ChannelListEntry
}
data StartupStateInfo = StartupStateInfo {
- startupStateResources :: ChatResources
- startupStateConnectedUser :: User
- startupStateTeams :: HashMap TeamId TeamState
- startupStateTimeZone :: TimeZoneSeries
- startupStateInitialHistory :: InputHistory
- startupStateInitialTeam :: TeamId
}
data MHError
- = GenericError Text
- | NoSuchChannel Text
- | NoSuchUser Text
- | AmbiguousName Text
- | ServerError MattermostError
- | ClipboardError Text
- | ConfigOptionMissing Text
- | ProgramExecutionFailed Text Text
- | NoSuchScript Text
- | NoSuchHelpTopic Text
- | AttachmentException SomeException
- | BadAttachmentPath Text
- | AsyncErrEvent SomeException
data AttachmentData = AttachmentData {
- attachmentDataFileInfo :: FileInfo
- attachmentDataBytes :: ByteString
}
data CPUUsagePolicy
- = SingleCPU
- | MultipleCPUs
class (Show a, Eq a, Ord a) => SemEq a where
- semeq :: a -> a -> Bool
tabbedWindow :: (Show a, Eq a) => a -> TabbedWindowTemplate a -> Mode -> (Int, Int) -> TabbedWindow a
getCurrentTabbedWindowEntry :: (Show a, Eq a) => TabbedWindow a -> TabbedWindowEntry a
tabbedWindowNextTab :: (Show a, Eq a) => TabbedWindow a -> MH (TabbedWindow a)
tabbedWindowPreviousTab :: (Show a, Eq a) => TabbedWindow a -> MH (TabbedWindow a)
runTabShowHandlerFor :: (Eq a, Show a) => a -> TabbedWindow a -> MH ()
getServerBaseUrl :: TeamId -> MH TeamBaseURL
serverBaseUrl :: ChatState -> TeamId -> TeamBaseURL
data TabbedWindow a = TabbedWindow {
- twValue :: a
- twReturnMode :: Mode
- twTemplate :: TabbedWindowTemplate a
- twWindowWidth :: Int
- twWindowHeight :: Int
}
data TabbedWindowEntry a = TabbedWindowEntry {
- tweValue :: a
- tweRender :: a -> ChatState -> Widget Name
- tweHandleEvent :: a -> Event -> MH ()
- tweTitle :: a -> Bool -> Text
- tweShowHandler :: a -> MH ()
}
data TabbedWindowTemplate a = TabbedWindowTemplate {
- twtEntries :: [TabbedWindowEntry a]
- twtTitle :: a -> Widget Name
}
data ConnectionInfo = ConnectionInfo {
- _ciHostname :: Text
- _ciPort :: Int
- _ciUrlPath :: Text
- _ciUsername :: Text
- _ciPassword :: Text
- _ciAccessToken :: Text
- _ciType :: ConnectionType
}
data SidebarUpdate
- = SidebarUpdateImmediate
- | SidebarUpdateDeferred
data PendingChannelChange
- = ChangeByChannelId TeamId ChannelId (Maybe (MH ()))
- | ChangeByUserId UserId
data ViewMessageWindowTab
- = VMTabMessage
- | VMTabReactions
clearChannelUnreadStatus :: ChannelId -> MH ()
data ChannelListEntry = ChannelListEntry {
- channelListEntryChannelId :: ChannelId
- channelListEntryType :: ChannelListEntryType
- channelListEntryUnread :: Bool
- channelListEntrySortValue :: Text
- channelListEntryFavorite :: Bool
}
data ChannelListEntryType
- = CLChannel
- | CLUserDM UserId
- | CLGroupDM
data ChannelListOrientation
- = ChannelListLeft
- | ChannelListRight
channelListEntryUserId :: ChannelListEntry -> Maybe UserId
userIdsFromZipper :: Zipper ChannelListGroup ChannelListEntry -> [UserId]
entryIsDMEntry :: ChannelListEntry -> Bool
ciHostname :: Lens' ConnectionInfo Text
ciPort :: Lens' ConnectionInfo Int
ciUrlPath :: Lens' ConnectionInfo Text
ciUsername :: Lens' ConnectionInfo Text
ciPassword :: Lens' ConnectionInfo Text
ciType :: Lens' ConnectionInfo ConnectionType
ciAccessToken :: Lens' ConnectionInfo Text
newChannelTopicDialog :: TeamId -> Text -> ChannelTopicDialogState
data ChannelTopicDialogState = ChannelTopicDialogState {
- _channelTopicDialogEditor :: Editor Text Name
- _channelTopicDialogFocus :: FocusRing Name
}
channelTopicDialogEditor :: Lens' ChannelTopicDialogState (Editor Text Name)
channelTopicDialogFocus :: Lens' ChannelTopicDialogState (FocusRing Name)
newSaveAttachmentDialog :: TeamId -> Text -> SaveAttachmentDialogState
data SaveAttachmentDialogState = SaveAttachmentDialogState {
- _attachmentPathEditor :: Editor Text Name
- _attachmentPathDialogFocus :: FocusRing Name
}
attachmentPathEditor :: Lens' SaveAttachmentDialogState (Editor Text Name)
attachmentPathDialogFocus :: Lens' SaveAttachmentDialogState (FocusRing Name)
data Config = Config {
- configUser :: Maybe Text
- configHost :: Maybe Text
- configTeam :: Maybe Text
- configPort :: Int
- configUrlPath :: Maybe Text
- configPass :: Maybe PasswordSource
- configToken :: Maybe TokenSource
- configTimeFormat :: Maybe Text
- configDateFormat :: Maybe Text
- configTheme :: Maybe Text
- configThemeCustomizationFile :: Maybe Text
- configSmartBacktick :: Bool
- configSmartEditing :: Bool
- configURLOpenCommand :: Maybe Text
- configURLOpenCommandInteractive :: Bool
- configActivityNotifyCommand :: Maybe Text
- configActivityNotifyVersion :: NotificationVersion
- configActivityBell :: Bool
- configShowMessageTimestamps :: Bool
- configShowBackground :: BackgroundInfo
- configShowMessagePreview :: Bool
- configShowChannelList :: Bool
- configShowExpandedChannelTopics :: Bool
- configEnableAspell :: Bool
- configAspellDictionary :: Maybe Text
- configUnsafeUseHTTP :: Bool
- configValidateServerCertificate :: Bool
- configChannelListWidth :: Int
- configLogMaxBufferSize :: Int
- configShowOlderEdits :: Bool
- configShowTypingIndicator :: Bool
- configAbsPath :: Maybe FilePath
- configUserKeys :: KeyConfig
- configHyperlinkingMode :: Bool
- configSyntaxDirs :: [FilePath]
- configDirectChannelExpirationDays :: Int
- configCpuUsagePolicy :: CPUUsagePolicy
- configDefaultAttachmentPath :: Maybe FilePath
- configChannelListOrientation :: ChannelListOrientation
- configMouseMode :: Bool
}
configUserL :: Lens' Config (Maybe Text)
configHostL :: Lens' Config (Maybe Text)
configTeamL :: Lens' Config (Maybe Text)
configPortL :: Lens' Config Int
configUrlPathL :: Lens' Config (Maybe Text)
configPassL :: Lens' Config (Maybe PasswordSource)
configTokenL :: Lens' Config (Maybe TokenSource)
configTimeFormatL :: Lens' Config (Maybe Text)
configDateFormatL :: Lens' Config (Maybe Text)
configThemeL :: Lens' Config (Maybe Text)
configThemeCustomizationFileL :: Lens' Config (Maybe Text)
configSmartBacktickL :: Lens' Config Bool
configSmartEditingL :: Lens' Config Bool
configURLOpenCommandL :: Lens' Config (Maybe Text)
configURLOpenCommandInteractiveL :: Lens' Config Bool
configActivityNotifyCommandL :: Lens' Config (Maybe Text)
configActivityNotifyVersionL :: Lens' Config NotificationVersion
configActivityBellL :: Lens' Config Bool
configShowMessageTimestampsL :: Lens' Config Bool
configShowBackgroundL :: Lens' Config BackgroundInfo
configShowMessagePreviewL :: Lens' Config Bool
configShowChannelListL :: Lens' Config Bool
configShowExpandedChannelTopicsL :: Lens' Config Bool
configEnableAspellL :: Lens' Config Bool
configAspellDictionaryL :: Lens' Config (Maybe Text)
configUnsafeUseHTTPL :: Lens' Config Bool
configValidateServerCertificateL :: Lens' Config Bool
configChannelListWidthL :: Lens' Config Int
configLogMaxBufferSizeL :: Lens' Config Int
configShowOlderEditsL :: Lens' Config Bool
configShowTypingIndicatorL :: Lens' Config Bool
configAbsPathL :: Lens' Config (Maybe FilePath)
configUserKeysL :: Lens' Config KeyConfig
configHyperlinkingModeL :: Lens' Config Bool
configSyntaxDirsL :: Lens' Config [FilePath]
configDirectChannelExpirationDaysL :: Lens' Config Int
configCpuUsagePolicyL :: Lens' Config CPUUsagePolicy
configDefaultAttachmentPathL :: Lens' Config (Maybe FilePath)
configChannelListOrientationL :: Lens' Config ChannelListOrientation
configMouseModeL :: Lens' Config Bool
data NotificationVersion
- = NotifyV1
- | NotifyV2
data HelpScreen
- = MainHelp
- | ScriptHelp
- | ThemeHelp
- | SyntaxHighlightHelp
- | KeybindingHelp
data PasswordSource
- = PasswordString Text
- | PasswordCommand Text
data TokenSource
- = TokenString Text
- | TokenCommand Text
data MatchType
- = Prefix
- | Suffix
- | Infix
- | Equal
- | PrefixDMOnly
- | PrefixNonDMOnly
data Mode
- = Main
- | ShowHelp HelpTopic Mode
- | ChannelSelect
- | UrlSelect
- | LeaveChannelConfirm
- | DeleteChannelConfirm
- | MessageSelect
- | MessageSelectDeleteConfirm
- | PostListOverlay PostListContents
- | UserListOverlay
- | ReactionEmojiListOverlay
- | ChannelListOverlay
- | ThemeListOverlay
- | ViewMessage
- | ManageAttachments
- | ManageAttachmentsBrowseFiles
- | EditNotifyPrefs
- | ChannelTopicWindow
- | SaveAttachmentWindow LinkChoice
data ChannelSelectPattern
- = CSP MatchType Text
- | CSPAny
data PostListContents
- = PostListFlagged
- | PostListPinned ChannelId
- | PostListSearch Text Bool
data AuthenticationException
- = ConnectError HostCannotConnect
- | ResolveError HostNotResolved
- | AuthIOError IOError
- | LoginError LoginFailureException
- | OtherAuthError SomeException
data BackgroundInfo
- = Disabled
- | Active
- | ActiveCount
type RequestChan = TChan (IO (Maybe (MH ())))
data UserFetch
- = UserFetchById UserId
- | UserFetchByUsername Text
- | UserFetchByNickname Text
writeBChan :: MonadIO m => BChan MHEvent -> MHEvent -> m ()
data InternalTheme = InternalTheme {
- internalThemeName :: Text
- internalTheme :: Theme
- internalThemeDesc :: Text
}
attrNameToConfig :: AttrName -> Text
sortTeams :: [Team] -> [Team]
mkTeamZipper :: HashMap TeamId TeamState -> Zipper () TeamId
mkTeamZipperFromIds :: [TeamId] -> Zipper () TeamId
teamZipperIds :: Zipper () TeamId -> [TeamId]
mkChannelZipperList :: UTCTime -> Config -> TeamId -> Maybe ClientConfig -> UserPreferences -> ClientChannels -> Users -> [(ChannelListGroup, [ChannelListEntry])]
data ChannelListGroup
- = ChannelGroupPublicChannels Int
- | ChannelGroupPrivateChannels Int
- | ChannelGroupFavoriteChannels Int
- | ChannelGroupDirectMessages Int
channelListGroupUnread :: ChannelListGroup -> Int
nonDMChannelListGroupUnread :: ChannelListGroup -> Int
trimChannelSigil :: Text -> Text
data ChannelSelectState = ChannelSelectState {
- _channelSelectInput :: Editor Text Name
- _channelSelectMatches :: Zipper ChannelListGroup ChannelSelectMatch
}
channelSelectMatches :: Lens' ChannelSelectState (Zipper ChannelListGroup ChannelSelectMatch)
channelSelectInput :: Lens' ChannelSelectState (Editor Text Name)
emptyChannelSelectState :: TeamId -> ChannelSelectState
data TeamState = TeamState {
- _tsFocus :: Zipper ChannelListGroup ChannelListEntry
- _tsPendingChannelChange :: Maybe PendingChannelChange
- _tsRecentChannel :: Maybe ChannelId
- _tsReturnChannel :: Maybe ChannelId
- _tsEditState :: ChatEditState
- _tsMessageSelect :: MessageSelectState
- _tsTeam :: Team
- _tsChannelSelectState :: ChannelSelectState
- _tsUrlList :: List Name (Int, LinkChoice)
- _tsViewedMessage :: Maybe (Message, TabbedWindow ViewMessageWindowTab)
- _tsPostListOverlay :: PostListOverlayState
- _tsUserListOverlay :: ListOverlayState UserInfo UserSearchScope
- _tsChannelListOverlay :: ListOverlayState Channel ChannelSearchScope
- _tsNotifyPrefs :: Maybe (Form ChannelNotifyProps MHEvent Name)
- _tsChannelTopicDialog :: ChannelTopicDialogState
- _tsMode :: Mode
- _tsReactionEmojiListOverlay :: ListOverlayState (Bool, Text) ()
- _tsThemeListOverlay :: ListOverlayState InternalTheme ()
- _tsSaveAttachmentDialog :: SaveAttachmentDialogState
}
tsFocus :: Lens' TeamState (Zipper ChannelListGroup ChannelListEntry)
tsMode :: Lens' TeamState Mode
tsPendingChannelChange :: Lens' TeamState (Maybe PendingChannelChange)
tsRecentChannel :: Lens' TeamState (Maybe ChannelId)
tsReturnChannel :: Lens' TeamState (Maybe ChannelId)
tsEditState :: Lens' TeamState ChatEditState
tsMessageSelect :: Lens' TeamState MessageSelectState
tsTeam :: Lens' TeamState Team
tsChannelSelectState :: Lens' TeamState ChannelSelectState
tsUrlList :: Lens' TeamState (List Name (Int, LinkChoice))
tsViewedMessage :: Lens' TeamState (Maybe (Message, TabbedWindow ViewMessageWindowTab))
tsPostListOverlay :: Lens' TeamState PostListOverlayState
tsUserListOverlay :: Lens' TeamState (ListOverlayState UserInfo UserSearchScope)
tsChannelListOverlay :: Lens' TeamState (ListOverlayState Channel ChannelSearchScope)
tsNotifyPrefs :: Lens' TeamState (Maybe (Form ChannelNotifyProps MHEvent Name))
tsChannelTopicDialog :: Lens' TeamState ChannelTopicDialogState
tsReactionEmojiListOverlay :: Lens' TeamState (ListOverlayState (Bool, Text) ())
tsThemeListOverlay :: Lens' TeamState (ListOverlayState InternalTheme ())
tsSaveAttachmentDialog :: Lens' TeamState SaveAttachmentDialogState
data ChatState
newState :: StartupStateInfo -> ChatState
newTeamState :: Team -> Zipper ChannelListGroup ChannelListEntry -> Maybe (Aspell, IO ()) -> TeamState
csTeamZipper :: Lens' ChatState (Zipper () TeamId)
csCurrentTeam :: Lens' ChatState TeamState
csTeams :: Lens' ChatState (HashMap TeamId TeamState)
csTeam :: TeamId -> Lens' ChatState TeamState
csChannelListOrientation :: Lens' ChatState ChannelListOrientation
csResources :: Lens' ChatState ChatResources
csLastMouseDownEvent :: Lens' ChatState (Maybe (BrickEvent Name MHEvent))
csCurrentChannel :: Lens' ChatState ClientChannel
csCurrentChannelId :: TeamId -> SimpleGetter ChatState ChannelId
csCurrentTeamId :: SimpleGetter ChatState TeamId
csPostMap :: Lens' ChatState (HashMap PostId Message)
csUsers :: Lens' ChatState Users
csConnectionStatus :: Lens' ChatState ConnectionStatus
csWorkerIsBusy :: Lens' ChatState (Maybe (Maybe Int))
csChannel :: ChannelId -> Traversal' ChatState ClientChannel
csChannels :: Lens' ChatState ClientChannels
csClientConfig :: Lens' ChatState (Maybe ClientConfig)
csInputHistory :: Lens' ChatState InputHistory
csMe :: Lens' ChatState User
timeZone :: Lens' ChatState TimeZoneSeries
whenMode :: Mode -> MH () -> MH ()
setMode :: Mode -> MH ()
setMode' :: Mode -> ChatState -> ChatState
data ChatEditState
emptyEditState :: TeamId -> ChatEditState
cedAttachmentList :: Lens' ChatEditState (List Name AttachmentData)
cedFileBrowser :: Lens' ChatEditState (Maybe (FileBrowser Name))
unsafeCedFileBrowser :: Lens' ChatEditState (FileBrowser Name)
cedYankBuffer :: Lens' ChatEditState Text
cedSpellChecker :: Lens' ChatEditState (Maybe (Aspell, IO ()))
cedMisspellings :: Lens' ChatEditState (Set Text)
cedEditMode :: Lens' ChatEditState EditMode
cedEphemeral :: Lens' ChatEditState EphemeralEditState
cedEditor :: Lens' ChatEditState (Editor Text Name)
cedAutocomplete :: Lens' ChatEditState (Maybe AutocompleteState)
cedAutocompletePending :: Lens' ChatEditState (Maybe Text)
cedJustCompleted :: Lens' ChatEditState Bool
data AutocompleteState = AutocompleteState {
- _acPreviousSearchString :: Text
- _acCompletionList :: List Name AutocompleteAlternative
- _acType :: AutocompletionType
- _acCachedResponses :: HashMap Text [AutocompleteAlternative]
}
acPreviousSearchString :: Lens' AutocompleteState Text
acCompletionList :: Lens' AutocompleteState (List Name AutocompleteAlternative)
acCachedResponses :: Lens' AutocompleteState (HashMap Text [AutocompleteAlternative])
acType :: Lens' AutocompleteState AutocompletionType
data AutocompletionType
- = ACUsers
- | ACChannels
- | ACCodeBlockLanguage
- | ACEmoji
- | ACCommands
data CompletionSource
- = Server
- | Client
data AutocompleteAlternative
- = UserCompletion User Bool
- | SpecialMention SpecialMention
- | ChannelCompletion Bool Channel
- | SyntaxCompletion Text
- | CommandCompletion CompletionSource Text Text Text
- | EmojiCompletion Text
autocompleteAlternativeReplacement :: AutocompleteAlternative -> Text
data SpecialMention
- = MentionAll
- | MentionChannel
specialMentionName :: SpecialMention -> Text
isSpecialMention :: Text -> Bool
data PostListOverlayState
postListSelected :: Lens' PostListOverlayState (Maybe PostId)
postListPosts :: Lens' PostListOverlayState Messages
data UserSearchScope
- = ChannelMembers ChannelId TeamId
- | ChannelNonMembers ChannelId TeamId
- | AllUsers (Maybe TeamId)
data ChannelSearchScope = AllChannels
data ListOverlayState a b
listOverlaySearchResults :: forall a b. Lens' (ListOverlayState a b) (List Name a)
listOverlaySearchInput :: forall a b. Lens' (ListOverlayState a b) (Editor Text Name)
listOverlaySearchScope :: forall a b. Lens' (ListOverlayState a b) b
listOverlaySearching :: forall a b. Lens' (ListOverlayState a b) Bool
listOverlayEnterHandler :: forall a b. Lens' (ListOverlayState a b) (a -> MH Bool)
listOverlayNewList :: forall a b. Lens' (ListOverlayState a b) (Vector a -> List Name a)
listOverlayFetchResults :: forall a b. Lens' (ListOverlayState a b) (b -> Session -> Text -> IO (Vector a))
listOverlayRecordCount :: forall a b. Lens' (ListOverlayState a b) (Maybe Int)
listOverlayReturnMode :: forall a b. Lens' (ListOverlayState a b) Mode
getUsers :: MH Users
data ChatResources = ChatResources {
- _crSession :: Session
- _crWebsocketThreadId :: Maybe ThreadId
- _crConn :: ConnectionData
- _crRequestQueue :: RequestChan
- _crEventQueue :: BChan MHEvent
- _crSubprocessLog :: TChan ProgramOutput
- _crWebsocketActionChan :: TChan WebsocketAction
- _crTheme :: AttrMap
- _crStatusUpdateChan :: TChan [UserId]
- _crConfiguration :: Config
- _crFlaggedPosts :: Set PostId
- _crUserPreferences :: UserPreferences
- _crSyntaxMap :: SyntaxMap
- _crLogManager :: LogManager
- _crEmoji :: EmojiCollection
}
crUserPreferences :: Lens' ChatResources UserPreferences
crEventQueue :: Lens' ChatResources (BChan MHEvent)
crTheme :: Lens' ChatResources AttrMap
crStatusUpdateChan :: Lens' ChatResources (TChan [UserId])
crSubprocessLog :: Lens' ChatResources (TChan ProgramOutput)
crWebsocketActionChan :: Lens' ChatResources (TChan WebsocketAction)
crWebsocketThreadId :: Lens' ChatResources (Maybe ThreadId)
crRequestQueue :: Lens' ChatResources RequestChan
crFlaggedPosts :: Lens' ChatResources (Set PostId)
crConn :: Lens' ChatResources ConnectionData
crConfiguration :: Lens' ChatResources Config
crSyntaxMap :: Lens' ChatResources SyntaxMap
crLogManager :: Lens' ChatResources LogManager
crEmoji :: Lens' ChatResources EmojiCollection
getSession :: MH Session
getResourceSession :: ChatResources -> Session
specialUserMentions :: [Text]
applyTeamOrder :: [TeamId] -> MH ()
refreshTeamZipper :: MH ()
data UserPreferences = UserPreferences Bool (Seq FlaggedPost) (HashMap ChannelId Bool) (HashMap UserId Bool) (HashMap ChannelId Bool) (Maybe TeammateNameDisplayMode) (Maybe [TeamId])
userPrefShowJoinLeave :: Lens' UserPreferences Bool
userPrefFlaggedPostList :: Lens' UserPreferences (Seq FlaggedPost)
userPrefGroupChannelPrefs :: Lens' UserPreferences (HashMap ChannelId Bool)
userPrefDirectChannelPrefs :: Lens' UserPreferences (HashMap UserId Bool)
userPrefTeammateNameDisplayMode :: Lens' UserPreferences (Maybe TeammateNameDisplayMode)
userPrefTeamOrder :: Lens' UserPreferences (Maybe [TeamId])
userPrefFavoriteChannelPrefs :: Lens' UserPreferences (HashMap ChannelId Bool)
dmChannelShowPreference :: UserPreferences -> UserId -> Maybe Bool
groupChannelShowPreference :: UserPreferences -> ChannelId -> Maybe Bool
favoriteChannelPreference :: UserPreferences -> ChannelId -> Maybe Bool
defaultUserPreferences :: UserPreferences
setUserPreferences :: Seq Preference -> UserPreferences -> UserPreferences
data WebsocketAction = UserTyping UTCTime ChannelId (Maybe PostId)
data Cmd = forall a. Cmd {
- cmdName :: Text
- cmdDescr :: Text
- cmdArgSpec :: CmdArgs a
- cmdAction :: CmdExec a
}
commandName :: Cmd -> Text
data CmdArgs :: Type -> Type where
- NoArg :: CmdArgs ()
- LineArg :: Text -> CmdArgs Text
- UserArg :: CmdArgs rest -> CmdArgs (Text, rest)
- ChannelArg :: CmdArgs rest -> CmdArgs (Text, rest)
- TokenArg :: Text -> CmdArgs rest -> CmdArgs (Text, rest)
data MH a
runMHEvent :: ChatState -> MH () -> EventM Name (Next ChatState)
scheduleUserFetches :: [UserFetch] -> MH ()
scheduleUserStatusFetches :: [UserId] -> MH ()
getScheduledUserFetches :: MH [UserFetch]
getScheduledUserStatusFetches :: MH (Maybe [UserId])
mh :: EventM Name a -> MH a
generateUUID :: MH UUID
generateUUID_IO :: IO UUID
mhSuspendAndResume :: (ChatState -> IO ChatState) -> MH ()
mhHandleEventLensed :: Lens' ChatState b -> (e -> b -> EventM Name b) -> e -> MH ()
mhHandleEventLensed' :: Lens' ChatState b -> (b -> EventM Name b) -> MH ()
gets :: MonadState s m => (s -> a) -> m a
mhError :: MHError -> MH ()
mhLog :: LogCategory -> Text -> MH ()
mhGetIOLogger :: MH (LogCategory -> Text -> IO ())
ioLogWithManager :: LogManager -> Maybe LogContext -> LogCategory -> Text -> IO ()
data LogContext = LogContext {
- logContextChannelId :: Maybe ChannelId
}
withLogContext :: (Maybe LogContext -> Maybe LogContext) -> MH a -> MH a
withLogContextChannelId :: ChannelId -> MH a -> MH a
getLogContext :: MH (Maybe LogContext)
data LogMessage = LogMessage {
- logMessageText :: !Text
- logMessageContext :: !(Maybe LogContext)
- logMessageCategory :: !LogCategory
- logMessageTimestamp :: !UTCTime
}
data LogCommand
- = LogToFile FilePath
- | LogAMessage !LogMessage
- | StopLogging
- | ShutdownLogging
- | GetLogDestination
- | LogSnapshot FilePath
data LogCategory
- = LogGeneral
- | LogAPI
- | LogWebsocket
- | LogError
- | LogUserMark
data LogManager = LogManager {
- logManagerCommandChannel :: TChan LogCommand
- logManagerHandle :: Async ()
}
startLoggingToFile :: LogManager -> FilePath -> IO ()
stopLoggingToFile :: LogManager -> IO ()
requestLogSnapshot :: LogManager -> FilePath -> IO ()
requestLogDestination :: LogManager -> IO ()
sendLogMessage :: LogManager -> LogMessage -> IO ()
requestQuit :: MH ()
getMessageForPostId :: ChatState -> PostId -> Maybe Message
getParentMessage :: ChatState -> Message -> Maybe Message
getReplyRootMessage :: Message -> MH Message
resetSpellCheckTimer :: ChatEditState -> IO ()
withChannel :: ChannelId -> (ClientChannel -> MH ()) -> MH ()
withChannelOrDefault :: ChannelId -> a -> (ClientChannel -> MH a) -> MH a
userList :: ChatState -> [UserInfo]
resetAutocomplete :: MH ()
isMine :: ChatState -> Message -> Bool
setUserStatus :: UserId -> Text -> MH ()
myUser :: ChatState -> User
myUsername :: ChatState -> Text
myUserId :: ChatState -> UserId
usernameForUserId :: UserId -> ChatState -> Maybe Text
userByUsername :: Text -> ChatState -> Maybe UserInfo
userByNickname :: Text -> ChatState -> Maybe UserInfo
channelIdByChannelName :: Text -> ChatState -> Maybe ChannelId
channelIdByUsername :: Text -> ChatState -> Maybe ChannelId
userById :: UserId -> ChatState -> Maybe UserInfo
allUserIds :: ChatState -> [UserId]
addNewUser :: UserInfo -> MH ()
useNickname :: ChatState -> Bool
useNickname' :: Maybe ClientConfig -> UserPreferences -> Bool
displayNameForUserId :: UserId -> ChatState -> Maybe Text
displayNameForUser :: UserInfo -> Maybe ClientConfig -> UserPreferences -> Text
raiseInternalEvent :: InternalEvent -> MH ()
getNewMessageCutoff :: ChannelId -> ChatState -> Maybe NewMessageIndicator
getEditedMessageCutoff :: ChannelId -> ChatState -> Maybe ServerTime
data HighlightSet = HighlightSet {
- hUserSet :: Set Text
- hChannelSet :: Set Text
- hSyntaxMap :: SyntaxMap
}
type UserSet = Set Text
type ChannelSet = Set Text
getHighlightSet :: ChatState -> HighlightSet
emptyHSet :: HighlightSet
moveLeft :: Eq a => a -> [a] -> [a]
moveRight :: Eq a => a -> [a] -> [a]
module Matterhorn.Types.Channels
module Matterhorn.Types.Messages
module Matterhorn.Types.Posts
module Matterhorn.Types.Users

Documentation

data ConnectionStatus Source #

We're either connected or we're not.

Constructors

Connected
Disconnected

Instances

Instances details

Eq ConnectionStatus Source #
Instance details Defined in Matterhorn.Types Methods (==) :: ConnectionStatus -> ConnectionStatus -> Bool # (/=) :: ConnectionStatus -> ConnectionStatus -> Bool #

data HelpTopic Source #

Help topics

Constructors

HelpTopic
Fields helpTopicName :: Text helpTopicDescription :: Text helpTopicScreen :: HelpScreen helpTopicViewportName :: Name

Instances

Instances details

Eq HelpTopic Source #
Instance details Defined in Matterhorn.Types Methods (==) :: HelpTopic -> HelpTopic -> Bool # (/=) :: HelpTopic -> HelpTopic -> Bool #

data MessageSelectState Source #

The state of message selection mode.

Constructors

MessageSelectState
Fields selectMessageId :: Maybe MessageId

data ProgramOutput Source #

Constructors

ProgramOutput
Fields program :: FilePath programArgs :: [String] programStdout :: String programStderr :: String programExitCode :: ExitCode

data MHEvent Source #

This represents events that we handle in the main application loop.

Constructors

WSEvent WebsocketEvent	For events that arise from the websocket
WSActionResponse WebsocketActionResponse	For responses to websocket actions
RespEvent (MH ())	For the result values of async IO operations
RefreshWebsocketEvent	Tell our main loop to refresh the websocket connection
WebsocketParseError String	We failed to parse an incoming websocket event
WebsocketDisconnect	The websocket connection went down.
WebsocketConnect	The websocket connection came up.
BGIdle	background worker is idle
BGBusy (Maybe Int)	background worker is busy (with n requests)
RateLimitExceeded Int	A request initially failed due to a rate limit but will be retried if possible. The argument is the number of seconds in which the retry will be attempted.
RateLimitSettingsMissing	A request denied by a rate limit could not be retried because the response contained no rate limit metadata
RequestDropped	A request was reattempted due to a rate limit and was rate limited again
IEvent InternalEvent	MH-internal events

data InternalEvent Source #

Internal application events.

Constructors

DisplayError MHError	Some kind of application error occurred
LoggingStarted FilePath
LoggingStopped FilePath
LogStartFailed FilePath String
LogDestination (Maybe FilePath)
LogSnapshotSucceeded FilePath
LogSnapshotFailed FilePath String	Logging events from the logging thread

data Name Source #

This Name type is the type used in brick to identify various parts of the interface.

Constructors

ChannelMessages ChannelId
MessageInput TeamId
ChannelList TeamId
HelpViewport
HelpText
ScriptHelpText
ThemeHelpText
SyntaxHighlightHelpText
KeybindingHelpText
ChannelSelectString TeamId
ChannelSelectEntry ChannelSelectMatch
CompletionAlternatives TeamId
CompletionList TeamId
JoinChannelList TeamId
UrlList TeamId
MessagePreviewViewport TeamId
ThemeListSearchInput TeamId
UserListSearchInput TeamId
JoinChannelListSearchInput TeamId
UserListSearchResults TeamId
ThemeListSearchResults TeamId
ViewMessageArea TeamId
ViewMessageReactionsArea TeamId
ChannelSidebar TeamId
ChannelSelectInput TeamId
AttachmentList TeamId
AttachmentFileBrowser TeamId
MessageReactionsArea TeamId
ReactionEmojiList TeamId
ReactionEmojiListInput TeamId
TabbedWindowTabBar TeamId
MuteToggleField TeamId
ChannelMentionsField TeamId
DesktopNotificationsField TeamId (WithDefault NotifyOption)
PushNotificationsField TeamId (WithDefault NotifyOption)
ChannelTopicEditor TeamId
ChannelTopicSaveButton TeamId
ChannelTopicCancelButton TeamId
ChannelTopicEditorPreview TeamId
ChannelTopic
TeamList
ClickableChannelListEntry ChannelId
ClickableTeamListEntry TeamId
ClickableURL Name Int LinkTarget
ClickableURLInMessage MessageId Int LinkTarget
ClickableUsernameInMessage MessageId Int Text
ClickableUsername Name Int Text
ClickableURLListEntry Int LinkTarget
ClickableReactionInMessage PostId Text (Set UserId)
ClickableReaction PostId Text (Set UserId)
AttachmentPathEditor TeamId
AttachmentPathSaveButton TeamId
AttachmentPathCancelButton TeamId
RenderedMessage MessageId
ReactionEmojiListOverlayEntry (Bool, Text)

Instances

Instances details

Eq Name Source #
Instance details Defined in Matterhorn.Types Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name Source #
Instance details Defined in Matterhorn.Types Methods compare :: Name -> Name -> Ordering # (<) :: Name -> Name -> Bool # (<=) :: Name -> Name -> Bool # (>) :: Name -> Name -> Bool # (>=) :: Name -> Name -> Bool # max :: Name -> Name -> Name # min :: Name -> Name -> Name #
Show Name Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
SemEq Name Source #
Instance details Defined in Matterhorn.Types Methods semeq :: Name -> Name -> Bool Source #

data ChannelSelectMatch Source #

A match in channel selection mode.

Constructors

ChannelSelectMatch

Fields

nameBefore :: Text
The content of the match before the user's matching input.
nameMatched :: Text
The potion of the name that matched the user's input.
nameAfter :: Text
The portion of the name that came after the user's matching input.
matchFull :: Text
The full string for this entry so it doesn't have to be reassembled from the parts above.
matchEntry :: ChannelListEntry
The original entry data corresponding to the text match.

Instances

Instances details

Eq ChannelSelectMatch Source #
Instance details Defined in Matterhorn.Types Methods (==) :: ChannelSelectMatch -> ChannelSelectMatch -> Bool # (/=) :: ChannelSelectMatch -> ChannelSelectMatch -> Bool #
Ord ChannelSelectMatch Source #
Instance details Defined in Matterhorn.Types Methods compare :: ChannelSelectMatch -> ChannelSelectMatch -> Ordering # (<) :: ChannelSelectMatch -> ChannelSelectMatch -> Bool # (<=) :: ChannelSelectMatch -> ChannelSelectMatch -> Bool # (>) :: ChannelSelectMatch -> ChannelSelectMatch -> Bool # (>=) :: ChannelSelectMatch -> ChannelSelectMatch -> Bool # max :: ChannelSelectMatch -> ChannelSelectMatch -> ChannelSelectMatch # min :: ChannelSelectMatch -> ChannelSelectMatch -> ChannelSelectMatch #
Show ChannelSelectMatch Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> ChannelSelectMatch -> ShowS # show :: ChannelSelectMatch -> String # showList :: [ChannelSelectMatch] -> ShowS #

data StartupStateInfo Source #

Startup state information that is constructed prior to building a ChatState.

Constructors

StartupStateInfo
Fields startupStateResources :: ChatResources startupStateConnectedUser :: User startupStateTeams :: HashMap TeamId TeamState startupStateTimeZone :: TimeZoneSeries startupStateInitialHistory :: InputHistory startupStateInitialTeam :: TeamId

data MHError Source #

Application errors.

Constructors

GenericError Text	A generic error message constructor
NoSuchChannel Text	The specified channel does not exist
NoSuchUser Text	The specified user does not exist
AmbiguousName Text	The specified name matches both a user and a channel
ServerError MattermostError	A Mattermost server error occurred
ClipboardError Text	A problem occurred trying to deal with yanking or the system clipboard
ConfigOptionMissing Text	A missing config option is required to perform an operation
ProgramExecutionFailed Text Text	Args: program name, path to log file. A problem occurred when running the program.
NoSuchScript Text	The specified script was not found
NoSuchHelpTopic Text	The specified help topic was not found
AttachmentException SomeException	IO operations for attaching a file threw an exception
BadAttachmentPath Text	The specified file is either a directory or doesn't exist
AsyncErrEvent SomeException	For errors that arise in the course of async IO operations

Instances

Instances details

Show MHError Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> MHError -> ShowS # show :: MHError -> String # showList :: [MHError] -> ShowS #

data AttachmentData Source #

An attachment.

Constructors

AttachmentData
Fields attachmentDataFileInfo :: FileInfo attachmentDataBytes :: ByteString

Instances

Instances details

Eq AttachmentData Source #
Instance details Defined in Matterhorn.Types Methods (==) :: AttachmentData -> AttachmentData -> Bool # (/=) :: AttachmentData -> AttachmentData -> Bool #
Show AttachmentData Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> AttachmentData -> ShowS # show :: AttachmentData -> String # showList :: [AttachmentData] -> ShowS #

data CPUUsagePolicy Source #

The policy for CPU usage.

The idea is that Matterhorn can benefit from using multiple CPUs, but the exact number is application-determined. We expose this policy setting to the user in the configuration.

Constructors

SingleCPU	Constrain the application to use one CPU.
MultipleCPUs	Permit the usage of multiple CPUs (the exact number is determined by the application).

Instances

Instances details

Eq CPUUsagePolicy Source #
Instance details Defined in Matterhorn.Types Methods (==) :: CPUUsagePolicy -> CPUUsagePolicy -> Bool # (/=) :: CPUUsagePolicy -> CPUUsagePolicy -> Bool #
Show CPUUsagePolicy Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> CPUUsagePolicy -> ShowS # show :: CPUUsagePolicy -> String # showList :: [CPUUsagePolicy] -> ShowS #

class (Show a, Eq a, Ord a) => SemEq a where Source #

Types that provide a "semantically equal" operation. Two values may be semantically equal even if they are not equal according to Eq if, for example, they are equal on the basis of some fields that are more pertinent than others.

Methods

semeq :: a -> a -> Bool Source #

Instances

Instances details

SemEq Name Source #
Instance details Defined in Matterhorn.Types Methods semeq :: Name -> Name -> Bool Source #
SemEq a => SemEq (Maybe a) Source #
Instance details Defined in Matterhorn.Types Methods semeq :: Maybe a -> Maybe a -> Bool Source #

tabbedWindow Source #

Arguments

:: (Show a, Eq a)
=> a	The handle corresponding to the tab that should be selected initially.
-> TabbedWindowTemplate a	The template for the window to construct.
-> Mode	When the window is closed, return to this application mode.
-> (Int, Int)	The window dimensions (width, height).
-> TabbedWindow a

Construct a new tabbed window from a template. This will raise an exception if the initially-selected tab does not exist in the window template, or if the window template has any duplicated tab handles.

Note that the caller is responsible for determining whether to call the initially-selected tab's on-show handler.

getCurrentTabbedWindowEntry :: (Show a, Eq a) => TabbedWindow a -> TabbedWindowEntry a Source #

Get the currently-selected tab entry for a tabbed window. Raise an exception if the window's selected tab handle is not found in its template (which is a bug in the tabbed window infrastructure).

tabbedWindowNextTab :: (Show a, Eq a) => TabbedWindow a -> MH (TabbedWindow a) Source #

Switch a tabbed window's selected tab to its next tab, cycling back to the first tab if the last tab is the selected tab. This also invokes the on-show handler for the newly-selected tab.

Note that this does nothing if the window has only one tab.

tabbedWindowPreviousTab :: (Show a, Eq a) => TabbedWindow a -> MH (TabbedWindow a) Source #

Switch a tabbed window's selected tab to its previous tab, cycling to the last tab if the first tab is the selected tab. This also invokes the on-show handler for the newly-selected tab.

Note that this does nothing if the window has only one tab.

runTabShowHandlerFor :: (Eq a, Show a) => a -> TabbedWindow a -> MH () Source #

Run the on-show handler for the window tab entry with the specified handle.

getServerBaseUrl :: TeamId -> MH TeamBaseURL Source #

serverBaseUrl :: ChatState -> TeamId -> TeamBaseURL Source #

data TabbedWindow a Source #

An instantiated tab window. This is based on a template and tracks the state of the tabbed window (current tab).

Parameterized over an abstract handle type (a) for the tabs so we can give each a unique handle.

Constructors

TabbedWindow
Fields twValue :: a The handle of the currently-selected tab. twReturnMode :: Mode The mode to return to when the tab is closed. twTemplate :: TabbedWindowTemplate a The template to use as a basis for rendering the window and handling user input. twWindowWidth :: Int twWindowHeight :: Int Window dimensions

data TabbedWindowEntry a Source #

An entry in a tabbed window corresponding to a tab and its content. Parameterized over an abstract handle type (a) for the tabs so we can give each a unique handle.

Constructors

TabbedWindowEntry

Fields

tweValue :: a
The handle for this tab.
tweRender :: a -> ChatState -> Widget Name
The rendering function to use when this tab is selected.
tweHandleEvent :: a -> Event -> MH ()
The event-handling function to use when this tab is selected.
tweTitle :: a -> Bool -> Text
Title function for this tab, with a boolean indicating whether this is the current tab.
tweShowHandler :: a -> MH ()
A handler to be invoked when this tab is shown.

data TabbedWindowTemplate a Source #

The definition of a tabbed window. Note that this does not track the *state* of the window; it merely provides a collection of tab window entries (see above). To track the state of a tabbed window, use a TabbedWindow.

Parameterized over an abstract handle type (a) for the tabs so we can give each a unique handle.

Constructors

TabbedWindowTemplate
Fields twtEntries :: [TabbedWindowEntry a] The entries in tabbed windows with this structure. twtTitle :: a -> Widget Name The title-rendering function for this kind of tabbed window.

data ConnectionInfo Source #

Our ConnectionInfo contains exactly as much information as is necessary to start a connection with a Mattermost server. This is built up during interactive authentication and then is used to log in.

If the access token field is non-empty, that value is used and the username and password values are ignored.

Constructors

ConnectionInfo
Fields _ciHostname :: Text _ciPort :: Int _ciUrlPath :: Text _ciUsername :: Text _ciPassword :: Text _ciAccessToken :: Text _ciType :: ConnectionType

data SidebarUpdate Source #

Constructors

SidebarUpdateImmediate
SidebarUpdateDeferred

Instances

Instances details

Eq SidebarUpdate Source #
Instance details Defined in Matterhorn.Types Methods (==) :: SidebarUpdate -> SidebarUpdate -> Bool # (/=) :: SidebarUpdate -> SidebarUpdate -> Bool #
Show SidebarUpdate Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> SidebarUpdate -> ShowS # show :: SidebarUpdate -> String # showList :: [SidebarUpdate] -> ShowS #

data PendingChannelChange Source #

Constructors

ChangeByChannelId TeamId ChannelId (Maybe (MH ()))
ChangeByUserId UserId

data ViewMessageWindowTab Source #

Handles for the View Message window's tabs.

Constructors

VMTabMessage	The message tab.
VMTabReactions	The reactions tab.

Instances

Instances details

Eq ViewMessageWindowTab Source #
Instance details Defined in Matterhorn.Types Methods (==) :: ViewMessageWindowTab -> ViewMessageWindowTab -> Bool # (/=) :: ViewMessageWindowTab -> ViewMessageWindowTab -> Bool #
Show ViewMessageWindowTab Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> ViewMessageWindowTab -> ShowS # show :: ViewMessageWindowTab -> String # showList :: [ViewMessageWindowTab] -> ShowS #

clearChannelUnreadStatus :: ChannelId -> MH () Source #

data ChannelListEntry Source #

The type of channel list entries.

Constructors

ChannelListEntry
Fields channelListEntryChannelId :: ChannelId channelListEntryType :: ChannelListEntryType channelListEntryUnread :: Bool channelListEntrySortValue :: Text channelListEntryFavorite :: Bool

Instances

Instances details

Eq ChannelListEntry Source #
Instance details Defined in Matterhorn.Types Methods (==) :: ChannelListEntry -> ChannelListEntry -> Bool # (/=) :: ChannelListEntry -> ChannelListEntry -> Bool #
Ord ChannelListEntry Source #
Instance details Defined in Matterhorn.Types Methods compare :: ChannelListEntry -> ChannelListEntry -> Ordering # (<) :: ChannelListEntry -> ChannelListEntry -> Bool # (<=) :: ChannelListEntry -> ChannelListEntry -> Bool # (>) :: ChannelListEntry -> ChannelListEntry -> Bool # (>=) :: ChannelListEntry -> ChannelListEntry -> Bool # max :: ChannelListEntry -> ChannelListEntry -> ChannelListEntry # min :: ChannelListEntry -> ChannelListEntry -> ChannelListEntry #
Show ChannelListEntry Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> ChannelListEntry -> ShowS # show :: ChannelListEntry -> String # showList :: [ChannelListEntry] -> ShowS #

data ChannelListEntryType Source #

Constructors

CLChannel	A non-DM entry
CLUserDM UserId	A single-user DM entry
CLGroupDM	A multi-user DM entry

Instances

Instances details

Eq ChannelListEntryType Source #
Instance details Defined in Matterhorn.Types Methods (==) :: ChannelListEntryType -> ChannelListEntryType -> Bool # (/=) :: ChannelListEntryType -> ChannelListEntryType -> Bool #
Ord ChannelListEntryType Source #
Instance details Defined in Matterhorn.Types Methods compare :: ChannelListEntryType -> ChannelListEntryType -> Ordering # (<) :: ChannelListEntryType -> ChannelListEntryType -> Bool # (<=) :: ChannelListEntryType -> ChannelListEntryType -> Bool # (>) :: ChannelListEntryType -> ChannelListEntryType -> Bool # (>=) :: ChannelListEntryType -> ChannelListEntryType -> Bool # max :: ChannelListEntryType -> ChannelListEntryType -> ChannelListEntryType # min :: ChannelListEntryType -> ChannelListEntryType -> ChannelListEntryType #
Show ChannelListEntryType Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> ChannelListEntryType -> ShowS # show :: ChannelListEntryType -> String # showList :: [ChannelListEntryType] -> ShowS #

data ChannelListOrientation Source #

Constructors

ChannelListLeft	Show the channel list to the left of the message area.
ChannelListRight	Show the channel list to the right of the message area.

Instances

Instances details

Eq ChannelListOrientation Source #
Instance details Defined in Matterhorn.Types Methods (==) :: ChannelListOrientation -> ChannelListOrientation -> Bool # (/=) :: ChannelListOrientation -> ChannelListOrientation -> Bool #
Show ChannelListOrientation Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> ChannelListOrientation -> ShowS # show :: ChannelListOrientation -> String # showList :: [ChannelListOrientation] -> ShowS #

channelListEntryUserId :: ChannelListEntry -> Maybe UserId Source #

userIdsFromZipper :: Zipper ChannelListGroup ChannelListEntry -> [UserId] Source #

entryIsDMEntry :: ChannelListEntry -> Bool Source #

ciHostname :: Lens' ConnectionInfo Text Source #

ciPort :: Lens' ConnectionInfo Int Source #

ciUrlPath :: Lens' ConnectionInfo Text Source #

ciUsername :: Lens' ConnectionInfo Text Source #

ciPassword :: Lens' ConnectionInfo Text Source #

ciType :: Lens' ConnectionInfo ConnectionType Source #

ciAccessToken :: Lens' ConnectionInfo Text Source #

newChannelTopicDialog :: TeamId -> Text -> ChannelTopicDialogState Source #

Make a new channel topic editor window state.

data ChannelTopicDialogState Source #

The state of the channel topic editor window.

Constructors

ChannelTopicDialogState
Fields _channelTopicDialogEditor :: Editor Text Name The topic string editor state. _channelTopicDialogFocus :: FocusRing Name The window focus state (editor/buttons)

channelTopicDialogEditor :: Lens' ChannelTopicDialogState (Editor Text Name) Source #

channelTopicDialogFocus :: Lens' ChannelTopicDialogState (FocusRing Name) Source #

newSaveAttachmentDialog :: TeamId -> Text -> SaveAttachmentDialogState Source #

Make a new attachment-saving editor window state.

data SaveAttachmentDialogState Source #

The state of the attachment path window.

Constructors

SaveAttachmentDialogState
Fields _attachmentPathEditor :: Editor Text Name The attachment path editor state. _attachmentPathDialogFocus :: FocusRing Name The window focus state (editor/buttons)

attachmentPathEditor :: Lens' SaveAttachmentDialogState (Editor Text Name) Source #

attachmentPathDialogFocus :: Lens' SaveAttachmentDialogState (FocusRing Name) Source #

data Config Source #

This is how we represent the user's configuration. Most fields correspond to configuration file settings (see Config.hs) but some are for internal book-keeping purposes only.

Constructors

Config

Fields

configUser :: Maybe Text
The username to use when connecting.
configHost :: Maybe Text
The hostname to use when connecting.
configTeam :: Maybe Text
The team name to use when connecting.
configPort :: Int
The port to use when connecting.
configUrlPath :: Maybe Text
The server path to use when connecting.
configPass :: Maybe PasswordSource
The password source to use when connecting.
configToken :: Maybe TokenSource
The token source to use when connecting.
configTimeFormat :: Maybe Text
The format string for timestamps.
configDateFormat :: Maybe Text
The format string for dates.
configTheme :: Maybe Text
The name of the theme to use.
configThemeCustomizationFile :: Maybe Text
The path to the theme customization file, if any.
configSmartBacktick :: Bool
Whether to enable smart quoting characters.
configSmartEditing :: Bool
Whether to enable smart editing behaviors.
configURLOpenCommand :: Maybe Text
The command to use to open URLs.
configURLOpenCommandInteractive :: Bool
Whether the URL-opening command is interactive (i.e. whether it should be given control of the terminal).
configActivityNotifyCommand :: Maybe Text
The command to run for activity notifications.
configActivityNotifyVersion :: NotificationVersion
The activity notifier version.
configActivityBell :: Bool
Whether to ring the terminal bell on activity.
configShowMessageTimestamps :: Bool
Whether to show timestamps on messages.
configShowBackground :: BackgroundInfo
Whether to show async background worker thread info.
configShowMessagePreview :: Bool
Whether to show the message preview area.
configShowChannelList :: Bool
Whether to show the channel list.
configShowExpandedChannelTopics :: Bool
Whether to show expanded channel topics.
configEnableAspell :: Bool
Whether to enable Aspell spell checking.
configAspellDictionary :: Maybe Text
A specific Aspell dictionary name to use.
configUnsafeUseHTTP :: Bool
Whether to permit an insecure HTTP connection.
configValidateServerCertificate :: Bool
Whether to validate TLS certificates.
configChannelListWidth :: Int
The width, in columns, of the channel list sidebar.
configLogMaxBufferSize :: Int
The maximum size, in log entries, of the internal log message buffer.
configShowOlderEdits :: Bool
Whether to highlight the edit indicator on edits made prior to the beginning of the current session.
configShowTypingIndicator :: Bool
Whether to show the typing indicator for other users, and whether to send typing notifications to other users.
configAbsPath :: Maybe FilePath
A book-keeping field for the absolute path to the configuration. (Not a user setting.)
configUserKeys :: KeyConfig
The user's keybinding configuration.
configHyperlinkingMode :: Bool
Whether to enable terminal hyperlinking mode.
configSyntaxDirs :: [FilePath]
The search path for syntax description XML files.
configDirectChannelExpirationDays :: Int
The number of days to show a user in the channel menu after a direct message with them.
configCpuUsagePolicy :: CPUUsagePolicy
The CPU usage policy for the application.
configDefaultAttachmentPath :: Maybe FilePath
The default path for browsing attachments
configChannelListOrientation :: ChannelListOrientation
The orientation of the channel list.
configMouseMode :: Bool
Whether to enable mouse support in matterhorn

Instances

Instances details

Eq Config Source #
Instance details Defined in Matterhorn.Types Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Show Config Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #

configUserL :: Lens' Config (Maybe Text) Source #

configHostL :: Lens' Config (Maybe Text) Source #

configTeamL :: Lens' Config (Maybe Text) Source #

configPortL :: Lens' Config Int Source #

configUrlPathL :: Lens' Config (Maybe Text) Source #

configPassL :: Lens' Config (Maybe PasswordSource) Source #

configTokenL :: Lens' Config (Maybe TokenSource) Source #

configTimeFormatL :: Lens' Config (Maybe Text) Source #

configDateFormatL :: Lens' Config (Maybe Text) Source #

configThemeL :: Lens' Config (Maybe Text) Source #

configThemeCustomizationFileL :: Lens' Config (Maybe Text) Source #

configSmartBacktickL :: Lens' Config Bool Source #

configSmartEditingL :: Lens' Config Bool Source #

configURLOpenCommandL :: Lens' Config (Maybe Text) Source #

configURLOpenCommandInteractiveL :: Lens' Config Bool Source #

configActivityNotifyCommandL :: Lens' Config (Maybe Text) Source #

configActivityNotifyVersionL :: Lens' Config NotificationVersion Source #

configActivityBellL :: Lens' Config Bool Source #

configShowMessageTimestampsL :: Lens' Config Bool Source #

configShowBackgroundL :: Lens' Config BackgroundInfo Source #

configShowMessagePreviewL :: Lens' Config Bool Source #

configShowChannelListL :: Lens' Config Bool Source #

configShowExpandedChannelTopicsL :: Lens' Config Bool Source #

configEnableAspellL :: Lens' Config Bool Source #

configAspellDictionaryL :: Lens' Config (Maybe Text) Source #

configUnsafeUseHTTPL :: Lens' Config Bool Source #

configValidateServerCertificateL :: Lens' Config Bool Source #

configChannelListWidthL :: Lens' Config Int Source #

configLogMaxBufferSizeL :: Lens' Config Int Source #

configShowOlderEditsL :: Lens' Config Bool Source #

configShowTypingIndicatorL :: Lens' Config Bool Source #

configAbsPathL :: Lens' Config (Maybe FilePath) Source #

configUserKeysL :: Lens' Config KeyConfig Source #

configHyperlinkingModeL :: Lens' Config Bool Source #

configSyntaxDirsL :: Lens' Config [FilePath] Source #

configDirectChannelExpirationDaysL :: Lens' Config Int Source #

configCpuUsagePolicyL :: Lens' Config CPUUsagePolicy Source #

configDefaultAttachmentPathL :: Lens' Config (Maybe FilePath) Source #

configChannelListOrientationL :: Lens' Config ChannelListOrientation Source #

configMouseModeL :: Lens' Config Bool Source #

data NotificationVersion Source #

A notification version for the external notifier

Constructors

NotifyV1
NotifyV2

Instances

Instances details

Eq NotificationVersion Source #
Instance details Defined in Matterhorn.Types Methods (==) :: NotificationVersion -> NotificationVersion -> Bool # (/=) :: NotificationVersion -> NotificationVersion -> Bool #
Read NotificationVersion Source #
Instance details Defined in Matterhorn.Types Methods readsPrec :: Int -> ReadS NotificationVersion # readList :: ReadS [NotificationVersion] # readPrec :: ReadPrec NotificationVersion # readListPrec :: ReadPrec [NotificationVersion] #
Show NotificationVersion Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> NotificationVersion -> ShowS # show :: NotificationVersion -> String # showList :: [NotificationVersion] -> ShowS #

data HelpScreen Source #

The HelpScreen type represents the set of possible Help dialogues we have to choose from.

Constructors

MainHelp
ScriptHelp
ThemeHelp
SyntaxHighlightHelp
KeybindingHelp

Instances

Instances details

Eq HelpScreen Source #
Instance details Defined in Matterhorn.Types Methods (==) :: HelpScreen -> HelpScreen -> Bool # (/=) :: HelpScreen -> HelpScreen -> Bool #

data PasswordSource Source #

A user password is either given to us directly, or a command which we execute to find the password.

Constructors

PasswordString Text
PasswordCommand Text

Instances

Instances details

Eq PasswordSource Source #
Instance details Defined in Matterhorn.Types Methods (==) :: PasswordSource -> PasswordSource -> Bool # (/=) :: PasswordSource -> PasswordSource -> Bool #
Read PasswordSource Source #
Instance details Defined in Matterhorn.Types Methods readsPrec :: Int -> ReadS PasswordSource # readList :: ReadS [PasswordSource] # readPrec :: ReadPrec PasswordSource # readListPrec :: ReadPrec [PasswordSource] #
Show PasswordSource Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> PasswordSource -> ShowS # show :: PasswordSource -> String # showList :: [PasswordSource] -> ShowS #

data TokenSource Source #

An access token source.

Constructors

TokenString Text
TokenCommand Text

Instances

Instances details

Eq TokenSource Source #
Instance details Defined in Matterhorn.Types Methods (==) :: TokenSource -> TokenSource -> Bool # (/=) :: TokenSource -> TokenSource -> Bool #
Read TokenSource Source #
Instance details Defined in Matterhorn.Types Methods readsPrec :: Int -> ReadS TokenSource # readList :: ReadS [TokenSource] # readPrec :: ReadPrec TokenSource # readListPrec :: ReadPrec [TokenSource] #
Show TokenSource Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> TokenSource -> ShowS # show :: TokenSource -> String # showList :: [TokenSource] -> ShowS #

data MatchType Source #

Constructors

Prefix
Suffix
Infix
Equal
PrefixDMOnly
PrefixNonDMOnly

Instances

Instances details

Eq MatchType Source #
Instance details Defined in Matterhorn.Types Methods (==) :: MatchType -> MatchType -> Bool # (/=) :: MatchType -> MatchType -> Bool #
Show MatchType Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> MatchType -> ShowS # show :: MatchType -> String # showList :: [MatchType] -> ShowS #

data Mode Source #

The Mode represents the current dominant UI activity

Instances

Instances details

Eq Mode Source #
Instance details Defined in Matterhorn.Types Methods (==) :: Mode -> Mode -> Bool # (/=) :: Mode -> Mode -> Bool #

data ChannelSelectPattern Source #

Constructors

CSP MatchType Text
CSPAny

Instances

Instances details

Eq ChannelSelectPattern Source #
Instance details Defined in Matterhorn.Types Methods (==) :: ChannelSelectPattern -> ChannelSelectPattern -> Bool # (/=) :: ChannelSelectPattern -> ChannelSelectPattern -> Bool #
Show ChannelSelectPattern Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> ChannelSelectPattern -> ShowS # show :: ChannelSelectPattern -> String # showList :: [ChannelSelectPattern] -> ShowS #

data PostListContents Source #

Mode type for the current contents of the post list overlay

Constructors

PostListFlagged
PostListPinned ChannelId
PostListSearch Text Bool

Instances

Instances details

Eq PostListContents Source #
Instance details Defined in Matterhorn.Types Methods (==) :: PostListContents -> PostListContents -> Bool # (/=) :: PostListContents -> PostListContents -> Bool #

data AuthenticationException Source #

The sum type of exceptions we expect to encounter on authentication failure. We encode them explicitly here so that we can print them in a more user-friendly manner than just show.

Constructors

ConnectError HostCannotConnect
ResolveError HostNotResolved
AuthIOError IOError
LoginError LoginFailureException
OtherAuthError SomeException

Instances

Instances details

Show AuthenticationException Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> AuthenticationException -> ShowS # show :: AuthenticationException -> String # showList :: [AuthenticationException] -> ShowS #

data BackgroundInfo Source #

The state of the UI diagnostic indicator for the async worker thread.

Constructors

Disabled	Disable (do not show) the indicator.
Active	Show the indicator when the thread is working.
ActiveCount	Show the indicator when the thread is working, but include the thread's work queue length.

Instances

Instances details

Eq BackgroundInfo Source #
Instance details Defined in Matterhorn.Types Methods (==) :: BackgroundInfo -> BackgroundInfo -> Bool # (/=) :: BackgroundInfo -> BackgroundInfo -> Bool #
Show BackgroundInfo Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> BackgroundInfo -> ShowS # show :: BackgroundInfo -> String # showList :: [BackgroundInfo] -> ShowS #

type RequestChan = TChan (IO (Maybe (MH ()))) Source #

A RequestChan is a queue of operations we have to perform in the background to avoid blocking on the main loop

data UserFetch Source #

A user fetching strategy.

Constructors

UserFetchById UserId	Fetch the user with the specified ID.
UserFetchByUsername Text	Fetch the user with the specified username.
UserFetchByNickname Text	Fetch the user with the specified nickname.

Instances

Instances details

Eq UserFetch Source #
Instance details Defined in Matterhorn.Types Methods (==) :: UserFetch -> UserFetch -> Bool # (/=) :: UserFetch -> UserFetch -> Bool #
Show UserFetch Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> UserFetch -> ShowS # show :: UserFetch -> String # showList :: [UserFetch] -> ShowS #

writeBChan :: MonadIO m => BChan MHEvent -> MHEvent -> m () Source #

data InternalTheme Source #

Constructors

InternalTheme
Fields internalThemeName :: Text internalTheme :: Theme internalThemeDesc :: Text

attrNameToConfig :: AttrName -> Text Source #

sortTeams :: [Team] -> [Team] Source #

mkTeamZipper :: HashMap TeamId TeamState -> Zipper () TeamId Source #

mkTeamZipperFromIds :: [TeamId] -> Zipper () TeamId Source #

teamZipperIds :: Zipper () TeamId -> [TeamId] Source #

mkChannelZipperList :: UTCTime -> Config -> TeamId -> Maybe ClientConfig -> UserPreferences -> ClientChannels -> Users -> [(ChannelListGroup, [ChannelListEntry])] Source #

data ChannelListGroup Source #

The type of channel list group headings. Integer arguments indicate total number of channels in the group that have unread activity.

Constructors

ChannelGroupPublicChannels Int
ChannelGroupPrivateChannels Int
ChannelGroupFavoriteChannels Int
ChannelGroupDirectMessages Int

Instances

Instances details

Eq ChannelListGroup Source #
Instance details Defined in Matterhorn.Types Methods (==) :: ChannelListGroup -> ChannelListGroup -> Bool # (/=) :: ChannelListGroup -> ChannelListGroup -> Bool #

channelListGroupUnread :: ChannelListGroup -> Int Source #

nonDMChannelListGroupUnread :: ChannelListGroup -> Int Source #

trimChannelSigil :: Text -> Text Source #

data ChannelSelectState Source #

The state of channel selection mode.

Constructors

ChannelSelectState
Fields _channelSelectInput :: Editor Text Name _channelSelectMatches :: Zipper ChannelListGroup ChannelSelectMatch

channelSelectMatches :: Lens' ChannelSelectState (Zipper ChannelListGroup ChannelSelectMatch) Source #

channelSelectInput :: Lens' ChannelSelectState (Editor Text Name) Source #

emptyChannelSelectState :: TeamId -> ChannelSelectState Source #

data TeamState Source #

All application state specific to a team, along with state specific to our user interface's presentation of that team. We include the UI state relevant to the team so that we can easily switch which team the UI is presenting without having to reinitialize the UI from the new team. This allows the user to be engaged in just about any application activity while viewing a team, switch to another team, and return to the original team and resume what they were doing, all without us doing any work.

Constructors

TeamState

Fields

_tsFocus :: Zipper ChannelListGroup ChannelListEntry
The channel sidebar zipper that tracks which channel is selected.
_tsPendingChannelChange :: Maybe PendingChannelChange
A pending channel change that we need to apply once the channel in question is available. We set this up when we need to change to a channel in the sidebar, but it isn't even there yet because we haven't loaded its metadata.
_tsRecentChannel :: Maybe ChannelId
The most recently-selected channel, if any.
_tsReturnChannel :: Maybe ChannelId
The channel to return to after visiting one or more unread channels.
_tsEditState :: ChatEditState
The state of the input box used for composing and editing messages and commands.
_tsMessageSelect :: MessageSelectState
The state of message selection mode.
_tsTeam :: Team
The team data.
_tsChannelSelectState :: ChannelSelectState
The state of the user's input and selection for channel selection mode.
_tsUrlList :: List Name (Int, LinkChoice)
The URL list used to show URLs drawn from messages in a channel.
_tsViewedMessage :: Maybe (Message, TabbedWindow ViewMessageWindowTab)
Set when the ViewMessage mode is active. The message being viewed. Note that this stores a message, not a message ID. That's because not all messages have message IDs (e.g. client messages) and we still want to support viewing of those messages. It's the responsibility of code that uses this message to always consult the chat state for the latest *version* of any message with an ID here, to be sure that the latest version is used (e.g. if it gets edited, etc.).
_tsPostListOverlay :: PostListOverlayState
The state of the post list overlay.
_tsUserListOverlay :: ListOverlayState UserInfo UserSearchScope
The state of the user list overlay.
_tsChannelListOverlay :: ListOverlayState Channel ChannelSearchScope
The state of the user list overlay.
_tsNotifyPrefs :: Maybe (Form ChannelNotifyProps MHEvent Name)
A form for editing the notification preferences for the current channel. This is set when entering EditNotifyPrefs mode and updated when the user changes the form state.
_tsChannelTopicDialog :: ChannelTopicDialogState
The state for the interactive channel topic editor window.
_tsMode :: Mode
The current application mode when viewing this team. This is used to dispatch to different rendering and event handling routines.
_tsReactionEmojiListOverlay :: ListOverlayState (Bool, Text) ()
The state of the reaction emoji list overlay.
_tsThemeListOverlay :: ListOverlayState InternalTheme ()
The state of the theme list overlay.
_tsSaveAttachmentDialog :: SaveAttachmentDialogState
The state for the interactive attachment-saving editor window.

tsFocus :: Lens' TeamState (Zipper ChannelListGroup ChannelListEntry) Source #

tsMode :: Lens' TeamState Mode Source #

tsPendingChannelChange :: Lens' TeamState (Maybe PendingChannelChange) Source #

tsRecentChannel :: Lens' TeamState (Maybe ChannelId) Source #

tsReturnChannel :: Lens' TeamState (Maybe ChannelId) Source #

tsEditState :: Lens' TeamState ChatEditState Source #

tsMessageSelect :: Lens' TeamState MessageSelectState Source #

tsTeam :: Lens' TeamState Team Source #

tsChannelSelectState :: Lens' TeamState ChannelSelectState Source #

tsUrlList :: Lens' TeamState (List Name (Int, LinkChoice)) Source #

tsViewedMessage :: Lens' TeamState (Maybe (Message, TabbedWindow ViewMessageWindowTab)) Source #

tsPostListOverlay :: Lens' TeamState PostListOverlayState Source #

tsUserListOverlay :: Lens' TeamState (ListOverlayState UserInfo UserSearchScope) Source #

tsChannelListOverlay :: Lens' TeamState (ListOverlayState Channel ChannelSearchScope) Source #

tsNotifyPrefs :: Lens' TeamState (Maybe (Form ChannelNotifyProps MHEvent Name)) Source #

tsChannelTopicDialog :: Lens' TeamState ChannelTopicDialogState Source #

tsReactionEmojiListOverlay :: Lens' TeamState (ListOverlayState (Bool, Text) ()) Source #

tsThemeListOverlay :: Lens' TeamState (ListOverlayState InternalTheme ()) Source #

tsSaveAttachmentDialog :: Lens' TeamState SaveAttachmentDialogState Source #

data ChatState Source #

This type represents the current state of our application at any given time.

Instances

Instances details

MonadState ChatState MH Source #
Instance details Defined in Matterhorn.Types Methods get :: MH ChatState # put :: ChatState -> MH () # state :: (ChatState -> (a, ChatState)) -> MH a #

newState :: StartupStateInfo -> ChatState Source #

newTeamState :: Team -> Zipper ChannelListGroup ChannelListEntry -> Maybe (Aspell, IO ()) -> TeamState Source #

csTeamZipper :: Lens' ChatState (Zipper () TeamId) Source #

csCurrentTeam :: Lens' ChatState TeamState Source #

csTeams :: Lens' ChatState (HashMap TeamId TeamState) Source #

csTeam :: TeamId -> Lens' ChatState TeamState Source #

csChannelListOrientation :: Lens' ChatState ChannelListOrientation Source #

csResources :: Lens' ChatState ChatResources Source #

csLastMouseDownEvent :: Lens' ChatState (Maybe (BrickEvent Name MHEvent)) Source #

csCurrentChannel :: Lens' ChatState ClientChannel Source #

csCurrentChannelId :: TeamId -> SimpleGetter ChatState ChannelId Source #

csCurrentTeamId :: SimpleGetter ChatState TeamId Source #

csPostMap :: Lens' ChatState (HashMap PostId Message) Source #

csUsers :: Lens' ChatState Users Source #

csConnectionStatus :: Lens' ChatState ConnectionStatus Source #

csWorkerIsBusy :: Lens' ChatState (Maybe (Maybe Int)) Source #

csChannel :: ChannelId -> Traversal' ChatState ClientChannel Source #

csChannels :: Lens' ChatState ClientChannels Source #

csClientConfig :: Lens' ChatState (Maybe ClientConfig) Source #

csInputHistory :: Lens' ChatState InputHistory Source #

csMe :: Lens' ChatState User Source #

timeZone :: Lens' ChatState TimeZoneSeries Source #

whenMode :: Mode -> MH () -> MH () Source #

setMode :: Mode -> MH () Source #

setMode' :: Mode -> ChatState -> ChatState Source #

data ChatEditState Source #

The ChatEditState value contains the editor widget itself as well as history and metadata we need for editing-related operations.

emptyEditState :: TeamId -> ChatEditState Source #

We can initialize a new ChatEditState value with just an edit history, which we save locally.

cedAttachmentList :: Lens' ChatEditState (List Name AttachmentData) Source #

cedFileBrowser :: Lens' ChatEditState (Maybe (FileBrowser Name)) Source #

unsafeCedFileBrowser :: Lens' ChatEditState (FileBrowser Name) Source #

cedYankBuffer :: Lens' ChatEditState Text Source #

cedSpellChecker :: Lens' ChatEditState (Maybe (Aspell, IO ())) Source #

cedMisspellings :: Lens' ChatEditState (Set Text) Source #

cedEditMode :: Lens' ChatEditState EditMode Source #

cedEphemeral :: Lens' ChatEditState EphemeralEditState Source #

cedEditor :: Lens' ChatEditState (Editor Text Name) Source #

cedAutocomplete :: Lens' ChatEditState (Maybe AutocompleteState) Source #

cedAutocompletePending :: Lens' ChatEditState (Maybe Text) Source #

cedJustCompleted :: Lens' ChatEditState Bool Source #

data AutocompleteState Source #

Constructors

AutocompleteState

Fields

_acPreviousSearchString :: Text
The search string used for the currently-displayed autocomplete results, for use in deciding whether to issue another server query
_acCompletionList :: List Name AutocompleteAlternative
The list of alternatives that the user selects from
_acType :: AutocompletionType
The type of data that we're completing
_acCachedResponses :: HashMap Text [AutocompleteAlternative]
A cache of alternative lists, keyed on search string, for use in avoiding server requests. The idea here is that users type quickly enough (and edit their input) that would normally lead to rapid consecutive requests, some for the same strings during editing, that we can avoid that by caching them here. Note that this cache gets destroyed whenever autocompletion is not on, so this cache does not live very long.

acPreviousSearchString :: Lens' AutocompleteState Text Source #

acCompletionList :: Lens' AutocompleteState (List Name AutocompleteAlternative) Source #

acCachedResponses :: Lens' AutocompleteState (HashMap Text [AutocompleteAlternative]) Source #

acType :: Lens' AutocompleteState AutocompletionType Source #

data AutocompletionType Source #

The type of data that the autocompletion logic supports. We use this to track the kind of completion underway in case the type of completion needs to change.

Constructors

ACUsers
ACChannels
ACCodeBlockLanguage
ACEmoji
ACCommands

Instances

Instances details

Eq AutocompletionType Source #
Instance details Defined in Matterhorn.Types Methods (==) :: AutocompletionType -> AutocompletionType -> Bool # (/=) :: AutocompletionType -> AutocompletionType -> Bool #
Show AutocompletionType Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> AutocompletionType -> ShowS # show :: AutocompletionType -> String # showList :: [AutocompletionType] -> ShowS #

data CompletionSource Source #

The source of an autocompletion alternative.

Constructors

Server
Client

Instances

Instances details

Eq CompletionSource Source #
Instance details Defined in Matterhorn.Types Methods (==) :: CompletionSource -> CompletionSource -> Bool # (/=) :: CompletionSource -> CompletionSource -> Bool #
Show CompletionSource Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> CompletionSource -> ShowS # show :: CompletionSource -> String # showList :: [CompletionSource] -> ShowS #

data AutocompleteAlternative Source #

Constructors

UserCompletion User Bool	User, plus whether the user is in the channel that triggered the autocomplete
SpecialMention SpecialMention	A special mention.
ChannelCompletion Bool Channel	Channel, plus whether the user is a member of the channel
SyntaxCompletion Text	Name of a skylighting syntax definition
CommandCompletion CompletionSource Text Text Text	Source, name of a slash command, argspec, and description
EmojiCompletion Text	The text of an emoji completion

autocompleteAlternativeReplacement :: AutocompleteAlternative -> Text Source #

data SpecialMention Source #

A "special" mention that does not map to a specific user, but is an alias that the server uses to notify users.

Constructors

MentionAll	@all: notify everyone in the channel.
MentionChannel	@channel: notify everyone in the channel.

specialMentionName :: SpecialMention -> Text Source #

isSpecialMention :: Text -> Bool Source #

data PostListOverlayState Source #

The state of the post list overlay.

postListSelected :: Lens' PostListOverlayState (Maybe PostId) Source #

postListPosts :: Lens' PostListOverlayState Messages Source #

data UserSearchScope Source #

The scope for searching for users in a user list overlay.

Constructors

ChannelMembers ChannelId TeamId
ChannelNonMembers ChannelId TeamId
AllUsers (Maybe TeamId)

data ChannelSearchScope Source #

The scope for searching for channels to join.

Constructors

AllChannels

data ListOverlayState a b Source #

The state of the search result list overlay. Type a is the type of data in the list. Type b is the search scope type.

listOverlaySearchResults :: forall a b. Lens' (ListOverlayState a b) (List Name a) Source #

listOverlaySearchInput :: forall a b. Lens' (ListOverlayState a b) (Editor Text Name) Source #

listOverlaySearchScope :: forall a b. Lens' (ListOverlayState a b) b Source #

listOverlaySearching :: forall a b. Lens' (ListOverlayState a b) Bool Source #

listOverlayEnterHandler :: forall a b. Lens' (ListOverlayState a b) (a -> MH Bool) Source #

listOverlayNewList :: forall a b. Lens' (ListOverlayState a b) (Vector a -> List Name a) Source #

listOverlayFetchResults :: forall a b. Lens' (ListOverlayState a b) (b -> Session -> Text -> IO (Vector a)) Source #

listOverlayRecordCount :: forall a b. Lens' (ListOverlayState a b) (Maybe Int) Source #

listOverlayReturnMode :: forall a b. Lens' (ListOverlayState a b) Mode Source #

getUsers :: MH Users Source #

data ChatResources Source #

ChatResources represents configuration and connection-related information, as opposed to current model or view information. Information that goes in the ChatResources value should be limited to information that we read or set up prior to setting up the bulk of the application state.

Constructors

ChatResources

Fields

_crSession :: Session
_crWebsocketThreadId :: Maybe ThreadId
_crConn :: ConnectionData
_crRequestQueue :: RequestChan
_crEventQueue :: BChan MHEvent
_crSubprocessLog :: TChan ProgramOutput
_crWebsocketActionChan :: TChan WebsocketAction
_crTheme :: AttrMap
_crStatusUpdateChan :: TChan [UserId]
_crConfiguration :: Config
_crFlaggedPosts :: Set PostId
_crUserPreferences :: UserPreferences
_crSyntaxMap :: SyntaxMap
_crLogManager :: LogManager
_crEmoji :: EmojiCollection

crUserPreferences :: Lens' ChatResources UserPreferences Source #

crEventQueue :: Lens' ChatResources (BChan MHEvent) Source #

crTheme :: Lens' ChatResources AttrMap Source #

crStatusUpdateChan :: Lens' ChatResources (TChan [UserId]) Source #

crSubprocessLog :: Lens' ChatResources (TChan ProgramOutput) Source #

crWebsocketActionChan :: Lens' ChatResources (TChan WebsocketAction) Source #

crWebsocketThreadId :: Lens' ChatResources (Maybe ThreadId) Source #

crRequestQueue :: Lens' ChatResources RequestChan Source #

crFlaggedPosts :: Lens' ChatResources (Set PostId) Source #

crConn :: Lens' ChatResources ConnectionData Source #

crConfiguration :: Lens' ChatResources Config Source #

crSyntaxMap :: Lens' ChatResources SyntaxMap Source #

crLogManager :: Lens' ChatResources LogManager Source #

crEmoji :: Lens' ChatResources EmojiCollection Source #

getSession :: MH Session Source #

getResourceSession :: ChatResources -> Session Source #

specialUserMentions :: [Text] Source #

applyTeamOrder :: [TeamId] -> MH () Source #

refreshTeamZipper :: MH () Source #

data UserPreferences Source #

Constructors

UserPreferences Bool (Seq FlaggedPost) (HashMap ChannelId Bool) (HashMap UserId Bool) (HashMap ChannelId Bool) (Maybe TeammateNameDisplayMode) (Maybe [TeamId])

userPrefShowJoinLeave :: Lens' UserPreferences Bool Source #

userPrefFlaggedPostList :: Lens' UserPreferences (Seq FlaggedPost) Source #

userPrefGroupChannelPrefs :: Lens' UserPreferences (HashMap ChannelId Bool) Source #

userPrefDirectChannelPrefs :: Lens' UserPreferences (HashMap UserId Bool) Source #

userPrefTeammateNameDisplayMode :: Lens' UserPreferences (Maybe TeammateNameDisplayMode) Source #

userPrefTeamOrder :: Lens' UserPreferences (Maybe [TeamId]) Source #

userPrefFavoriteChannelPrefs :: Lens' UserPreferences (HashMap ChannelId Bool) Source #

dmChannelShowPreference :: UserPreferences -> UserId -> Maybe Bool Source #

groupChannelShowPreference :: UserPreferences -> ChannelId -> Maybe Bool Source #

favoriteChannelPreference :: UserPreferences -> ChannelId -> Maybe Bool Source #

defaultUserPreferences :: UserPreferences Source #

setUserPreferences :: Seq Preference -> UserPreferences -> UserPreferences Source #

data WebsocketAction Source #

Actions that can be sent on the websocket to the server.

Constructors

UserTyping UTCTime ChannelId (Maybe PostId)

user typing in the input box

Instances

Instances details

Eq WebsocketAction Source #
Instance details Defined in Matterhorn.Types Methods (==) :: WebsocketAction -> WebsocketAction -> Bool # (/=) :: WebsocketAction -> WebsocketAction -> Bool #
Ord WebsocketAction Source #
Instance details Defined in Matterhorn.Types Methods compare :: WebsocketAction -> WebsocketAction -> Ordering # (<) :: WebsocketAction -> WebsocketAction -> Bool # (<=) :: WebsocketAction -> WebsocketAction -> Bool # (>) :: WebsocketAction -> WebsocketAction -> Bool # (>=) :: WebsocketAction -> WebsocketAction -> Bool # max :: WebsocketAction -> WebsocketAction -> WebsocketAction # min :: WebsocketAction -> WebsocketAction -> WebsocketAction #
Read WebsocketAction Source #
Instance details Defined in Matterhorn.Types Methods readsPrec :: Int -> ReadS WebsocketAction # readList :: ReadS [WebsocketAction] # readPrec :: ReadPrec WebsocketAction # readListPrec :: ReadPrec [WebsocketAction] #
Show WebsocketAction Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> WebsocketAction -> ShowS # show :: WebsocketAction -> String # showList :: [WebsocketAction] -> ShowS #

data Cmd Source #

A Cmd packages up a CmdArgs specifier and the CmdExec implementation with a name and a description.

Constructors

forall a. Cmd
Fields cmdName :: Text cmdDescr :: Text cmdArgSpec :: CmdArgs a cmdAction :: CmdExec a

commandName :: Cmd -> Text Source #

Helper function to extract the name out of a Cmd value

data CmdArgs :: Type -> Type where Source #

The CmdArgs type represents the arguments to a slash-command; the type parameter represents the argument structure.

Constructors

NoArg :: CmdArgs ()
LineArg :: Text -> CmdArgs Text
UserArg :: CmdArgs rest -> CmdArgs (Text, rest)
ChannelArg :: CmdArgs rest -> CmdArgs (Text, rest)
TokenArg :: Text -> CmdArgs rest -> CmdArgs (Text, rest)

data MH a Source #

A value of type MH a represents a computation that can manipulate the application state and also request that the application quit

Instances

Instances details

Monad MH Source #
Instance details Defined in Matterhorn.Types Methods (>>=) :: MH a -> (a -> MH b) -> MH b # (>>) :: MH a -> MH b -> MH b # return :: a -> MH a #
Functor MH Source #
Instance details Defined in Matterhorn.Types Methods fmap :: (a -> b) -> MH a -> MH b # (<$) :: a -> MH b -> MH a #
MonadFail MH Source #
Instance details Defined in Matterhorn.Types Methods fail :: String -> MH a #
Applicative MH Source #
Instance details Defined in Matterhorn.Types Methods pure :: a -> MH a # (<>) :: MH (a -> b) -> MH a -> MH b # liftA2 :: (a -> b -> c) -> MH a -> MH b -> MH c # (>) :: MH a -> MH b -> MH b # (<*) :: MH a -> MH b -> MH a #
MonadIO MH Source #
Instance details Defined in Matterhorn.Types Methods liftIO :: IO a -> MH a #
MonadState ChatState MH Source #
Instance details Defined in Matterhorn.Types Methods get :: MH ChatState # put :: ChatState -> MH () # state :: (ChatState -> (a, ChatState)) -> MH a #

runMHEvent :: ChatState -> MH () -> EventM Name (Next ChatState) Source #

Run an MM computation, choosing whether to continue or halt based on the resulting

scheduleUserFetches :: [UserFetch] -> MH () Source #

scheduleUserStatusFetches :: [UserId] -> MH () Source #

getScheduledUserFetches :: MH [UserFetch] Source #

getScheduledUserStatusFetches :: MH (Maybe [UserId]) Source #

mh :: EventM Name a -> MH a Source #

lift a computation in EventM into MH

generateUUID :: MH UUID Source #

generateUUID_IO :: IO UUID Source #

mhSuspendAndResume :: (ChatState -> IO ChatState) -> MH () Source #

mhHandleEventLensed :: Lens' ChatState b -> (e -> b -> EventM Name b) -> e -> MH () Source #

mhHandleEventLensed' :: Lens' ChatState b -> (b -> EventM Name b) -> MH () Source #

gets :: MonadState s m => (s -> a) -> m a #

Gets specific component of the state, using a projection function supplied.

mhError :: MHError -> MH () Source #

Log and raise an error.

mhLog :: LogCategory -> Text -> MH () Source #

Log a message.

mhGetIOLogger :: MH (LogCategory -> Text -> IO ()) Source #

Get a logger suitable for use in IO. The logger always logs using the MH monad log context at the time of the call to mhGetIOLogger.

ioLogWithManager :: LogManager -> Maybe LogContext -> LogCategory -> Text -> IO () Source #

data LogContext Source #

Logging context information, in the event that metadata should accompany a log message.

Constructors

LogContext
Fields logContextChannelId :: Maybe ChannelId

Instances

Instances details

Eq LogContext Source #
Instance details Defined in Matterhorn.Types Methods (==) :: LogContext -> LogContext -> Bool # (/=) :: LogContext -> LogContext -> Bool #
Show LogContext Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> LogContext -> ShowS # show :: LogContext -> String # showList :: [LogContext] -> ShowS #

withLogContext :: (Maybe LogContext -> Maybe LogContext) -> MH a -> MH a Source #

Use a modified logging context for the duration of the specified MH action.

withLogContextChannelId :: ChannelId -> MH a -> MH a Source #

getLogContext :: MH (Maybe LogContext) Source #

Get the current logging context.

data LogMessage Source #

A log message.

Constructors

LogMessage
Fields logMessageText :: !Text The text of the log message. logMessageContext :: !(Maybe LogContext) The optional context information relevant to the log message. logMessageCategory :: !LogCategory The category of the log message. logMessageTimestamp :: !UTCTime The timestamp of the log message.

Instances

Instances details

Eq LogMessage Source #
Instance details Defined in Matterhorn.Types Methods (==) :: LogMessage -> LogMessage -> Bool # (/=) :: LogMessage -> LogMessage -> Bool #
Show LogMessage Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> LogMessage -> ShowS # show :: LogMessage -> String # showList :: [LogMessage] -> ShowS #

data LogCommand Source #

A logging thread command.

Constructors

LogToFile FilePath	Start logging to the specified path.
LogAMessage !LogMessage	Log the specified message.
StopLogging	Stop any active logging.
ShutdownLogging	Shut down.
GetLogDestination	Ask the logging thread about its active logging destination.
LogSnapshot FilePath	Ask the logging thread to dump the current buffer to the specified destination.

Instances

Instances details

Show LogCommand Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> LogCommand -> ShowS # show :: LogCommand -> String # showList :: [LogCommand] -> ShowS #

data LogCategory Source #

Log message tags.

Constructors

LogGeneral
LogAPI
LogWebsocket
LogError
LogUserMark

Instances

Instances details

Eq LogCategory Source #
Instance details Defined in Matterhorn.Types Methods (==) :: LogCategory -> LogCategory -> Bool # (/=) :: LogCategory -> LogCategory -> Bool #
Show LogCategory Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> LogCategory -> ShowS # show :: LogCategory -> String # showList :: [LogCategory] -> ShowS #

data LogManager Source #

A handle to the log manager thread.

Constructors

LogManager
Fields logManagerCommandChannel :: TChan LogCommand logManagerHandle :: Async ()

startLoggingToFile :: LogManager -> FilePath -> IO () Source #

stopLoggingToFile :: LogManager -> IO () Source #

requestLogSnapshot :: LogManager -> FilePath -> IO () Source #

requestLogDestination :: LogManager -> IO () Source #

sendLogMessage :: LogManager -> LogMessage -> IO () Source #

requestQuit :: MH () Source #

This will request that after this computation finishes the application should exit

getMessageForPostId :: ChatState -> PostId -> Maybe Message Source #

getParentMessage :: ChatState -> Message -> Maybe Message Source #

getReplyRootMessage :: Message -> MH Message Source #

resetSpellCheckTimer :: ChatEditState -> IO () Source #

withChannel :: ChannelId -> (ClientChannel -> MH ()) -> MH () Source #

withChannelOrDefault :: ChannelId -> a -> (ClientChannel -> MH a) -> MH a Source #

userList :: ChatState -> [UserInfo] Source #

resetAutocomplete :: MH () Source #

isMine :: ChatState -> Message -> Bool Source #

setUserStatus :: UserId -> Text -> MH () Source #

myUser :: ChatState -> User Source #

myUsername :: ChatState -> Text Source #

myUserId :: ChatState -> UserId Source #

usernameForUserId :: UserId -> ChatState -> Maybe Text Source #

userByUsername :: Text -> ChatState -> Maybe UserInfo Source #

userByNickname :: Text -> ChatState -> Maybe UserInfo Source #

channelIdByChannelName :: Text -> ChatState -> Maybe ChannelId Source #

channelIdByUsername :: Text -> ChatState -> Maybe ChannelId Source #

userById :: UserId -> ChatState -> Maybe UserInfo Source #

allUserIds :: ChatState -> [UserId] Source #

addNewUser :: UserInfo -> MH () Source #

useNickname :: ChatState -> Bool Source #

useNickname' :: Maybe ClientConfig -> UserPreferences -> Bool Source #

displayNameForUserId :: UserId -> ChatState -> Maybe Text Source #

displayNameForUser :: UserInfo -> Maybe ClientConfig -> UserPreferences -> Text Source #

raiseInternalEvent :: InternalEvent -> MH () Source #

getNewMessageCutoff :: ChannelId -> ChatState -> Maybe NewMessageIndicator Source #

getEditedMessageCutoff :: ChannelId -> ChatState -> Maybe ServerTime Source #

data HighlightSet Source #

The set of usernames, channel names, and language names used for highlighting when rendering messages.

Constructors

HighlightSet
Fields hUserSet :: Set Text hChannelSet :: Set Text hSyntaxMap :: SyntaxMap

type UserSet = Set Text Source #

type ChannelSet = Set Text Source #

getHighlightSet :: ChatState -> HighlightSet Source #

emptyHSet :: HighlightSet Source #

moveLeft :: Eq a => a -> [a] -> [a] Source #

moveRight :: Eq a => a -> [a] -> [a] Source #

module Matterhorn.Types.Channels

module Matterhorn.Types.Messages

module Matterhorn.Types.Posts

module Matterhorn.Types.Users

Main
ShowHelp HelpTopic Mode
ChannelSelect
UrlSelect
LeaveChannelConfirm
DeleteChannelConfirm
MessageSelect
MessageSelectDeleteConfirm
PostListOverlay PostListContents
UserListOverlay
ReactionEmojiListOverlay
ChannelListOverlay
ThemeListOverlay
ViewMessage
ManageAttachments
ManageAttachmentsBrowseFiles
EditNotifyPrefs
ChannelTopicWindow
SaveAttachmentWindow LinkChoice