Safe Haskell	None
Language	Haskell2010

Matterhorn.Types

Synopsis

data ConnectionStatus
- = Connected
- | Disconnected
data HelpTopic = HelpTopic {
- helpTopicName :: Text
- helpTopicDescription :: Text
- helpTopicScreen :: HelpScreen
}
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 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 CPUUsagePolicy
- = SingleCPU
- | MultipleCPUs
class (Show a, Eq a, Ord a) => SemEq a where
- semeq :: a -> a -> Bool
handleEventWith :: [Event -> MH Bool] -> Event -> MH Bool
getServerBaseUrl :: TeamId -> MH TeamBaseURL
serverBaseUrl :: ChatState -> TeamId -> TeamBaseURL
data ConnectionInfo = ConnectionInfo {
- _ciHostname :: Text
- _ciPort :: Int
- _ciUrlPath :: Text
- _ciUsername :: Text
- _ciOTPToken :: Maybe 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 ChannelListSorting
- = ChannelListSortDefault
- | ChannelListSortUnreadFirst
data ThreadOrientation
- = ThreadBelow
- | ThreadAbove
- | ThreadLeft
- | ThreadRight
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
ciOTPToken :: Lens' ConnectionInfo (Maybe Text)
ciPassword :: Lens' ConnectionInfo Text
ciType :: Lens' ConnectionInfo ConnectionType
ciAccessToken :: Lens' ConnectionInfo Text
data ChannelTopicDialogState = ChannelTopicDialogState {
- _channelTopicDialogEditor :: Editor Text Name
- _channelTopicDialogFocus :: FocusRing Name
}
channelTopicDialogEditor :: Lens' ChannelTopicDialogState (Editor Text Name)
channelTopicDialogFocus :: Lens' ChannelTopicDialogState (FocusRing Name)
resultToWidget :: Result n -> Widget n
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
- configTruncateVerbatimBlocks :: Maybe Int
- 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
- configChannelListSorting :: ChannelListSorting
- configShowTypingIndicator :: Bool
- configSendTypingNotifications :: Bool
- configAbsPath :: Maybe FilePath
- configUserKeys :: KeyConfig
- configHyperlinkingMode :: Bool
- configSyntaxDirs :: [FilePath]
- configDirectChannelExpirationDays :: Int
- configCpuUsagePolicy :: CPUUsagePolicy
- configDefaultAttachmentPath :: Maybe FilePath
- configChannelListOrientation :: ChannelListOrientation
- configThreadOrientation :: ThreadOrientation
- configMouseMode :: Bool
- configShowLastOpenThread :: 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
configTruncateVerbatimBlocksL :: Lens' Config (Maybe Int)
configChannelListSortingL :: Lens' Config ChannelListSorting
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
configSendTypingNotificationsL :: 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
configThreadOrientationL :: Lens' Config ThreadOrientation
configMouseModeL :: Lens' Config Bool
configShowLastOpenThreadL :: Lens' Config Bool
data NotificationVersion
- = NotifyV1
- | NotifyV2
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
- | ChannelSelect
- | LeaveChannelConfirm
- | DeleteChannelConfirm
- | MessageSelectDeleteConfirm MessageInterfaceTarget
- | PostListWindow PostListContents
- | UserListWindow
- | ReactionEmojiListWindow
- | ChannelListWindow
- | ThemeListWindow
- | ViewMessage
- | EditNotifyPrefs
- | ChannelTopicWindow
data ChannelSelectPattern
- = CSP MatchType Text
- | CSPAny
data PostListContents
- = PostListFlagged
- | PostListPinned ChannelId
- | PostListSearch Text Bool
data AuthenticationException
- = ConnectError HostCannotConnect
- | ResolveError HostNotResolved
- | AuthIOError IOError
- | LoginError LoginFailureException
- | MattermostServerError MattermostError
- | 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]
matchesTeam :: Text -> Team -> Bool
mkTeamZipper :: HashMap TeamId TeamState -> Zipper () TeamId
mkTeamZipperFromIds :: [TeamId] -> Zipper () TeamId
teamZipperIds :: Zipper () TeamId -> [TeamId]
mkChannelZipperList :: ChannelListSorting -> UTCTime -> Config -> TeamId -> Maybe ClientConfig -> UserPreferences -> HashMap TeamId (Set ChannelListGroupLabel) -> ClientChannels -> Users -> [(ChannelListGroup, [ChannelListEntry])]
data ChannelListGroup = ChannelListGroup {
- channelListGroupLabel :: ChannelListGroupLabel
- channelListGroupUnread :: Int
- channelListGroupCollapsed :: Bool
- channelListGroupEntries :: Int
}
nonDMChannelListGroupUnread :: ChannelListGroup -> Int
type ThreadInterface = MessageInterface Name PostId
type ChannelMessageInterface = MessageInterface Name ()
threadInterface :: HasCallStack => TeamId -> Traversal' ChatState ThreadInterface
unsafeThreadInterface :: HasCallStack => TeamId -> Lens' ChatState ThreadInterface
maybeThreadInterface :: TeamId -> Lens' ChatState (Maybe ThreadInterface)
threadInterfaceEmpty :: TeamId -> MH Bool
threadInterfaceDeleteWhere :: TeamId -> ChannelId -> (Message -> Bool) -> MH ()
modifyThreadMessages :: TeamId -> ChannelId -> (Messages -> Messages) -> MH ()
modifyEachThreadMessage :: TeamId -> ChannelId -> (Message -> Message) -> MH ()
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
- _tsTeam :: Team
- _tsRecentChannel :: Maybe ChannelId
- _tsReturnChannel :: Maybe ChannelId
- _tsModeStack :: NonemptyStack Mode
- _tsChannelSelectState :: ChannelSelectState
- _tsPendingChannelChange :: Maybe PendingChannelChange
- _tsViewedMessage :: Maybe (Message, TabbedWindow ChatState MH Name ViewMessageWindowTab)
- _tsPostListWindow :: PostListWindowState
- _tsUserListWindow :: ListWindowState UserInfo UserSearchScope
- _tsChannelListWindow :: ListWindowState Channel ChannelSearchScope
- _tsNotifyPrefs :: Maybe (Form ChannelNotifyProps MHEvent Name)
- _tsChannelTopicDialog :: ChannelTopicDialogState
- _tsReactionEmojiListWindow :: ListWindowState (Bool, Text) ()
- _tsThemeListWindow :: ListWindowState InternalTheme ()
- _tsChannelListSorting :: ChannelListSorting
- _tsThreadInterface :: Maybe ThreadInterface
- _tsMessageInterfaceFocus :: MessageInterfaceFocus
}
tsFocus :: Lens' TeamState (Zipper ChannelListGroup ChannelListEntry)
tsPendingChannelChange :: Lens' TeamState (Maybe PendingChannelChange)
tsRecentChannel :: Lens' TeamState (Maybe ChannelId)
tsReturnChannel :: Lens' TeamState (Maybe ChannelId)
tsTeam :: Lens' TeamState Team
tsChannelSelectState :: Lens' TeamState ChannelSelectState
tsViewedMessage :: Lens' TeamState (Maybe (Message, TabbedWindow ChatState MH Name ViewMessageWindowTab))
tsPostListWindow :: Lens' TeamState PostListWindowState
tsUserListWindow :: Lens' TeamState (ListWindowState UserInfo UserSearchScope)
tsChannelListWindow :: Lens' TeamState (ListWindowState Channel ChannelSearchScope)
tsNotifyPrefs :: Lens' TeamState (Maybe (Form ChannelNotifyProps MHEvent Name))
tsChannelTopicDialog :: Lens' TeamState ChannelTopicDialogState
tsReactionEmojiListWindow :: Lens' TeamState (ListWindowState (Bool, Text) ())
tsThemeListWindow :: Lens' TeamState (ListWindowState InternalTheme ())
tsChannelListSorting :: Lens' TeamState ChannelListSorting
tsThreadInterface :: Lens' TeamState (Maybe ThreadInterface)
tsMessageInterfaceFocus :: Lens' TeamState MessageInterfaceFocus
teamMode :: TeamState -> Mode
teamModes :: TeamState -> [Mode]
getTeamMode :: TeamId -> MH Mode
data MessageInterfaceFocus
- = FocusThread
- | FocusCurrentChannel
messageInterfaceFocusNext :: TeamState -> TeamState
messageInterfaceFocusPrev :: TeamState -> TeamState
channelEditor :: ChannelId -> Lens' ChatState (EditState Name)
channelMessageSelect :: ChannelId -> Lens' ChatState MessageSelectState
data ChatState
newState :: StartupStateInfo -> ChatState
withCurrentChannel :: TeamId -> (ChannelId -> ClientChannel -> MH ()) -> MH ()
withCurrentChannel' :: TeamId -> (ChannelId -> ClientChannel -> MH (Maybe a)) -> MH (Maybe a)
withCurrentTeam :: (TeamId -> MH ()) -> MH ()
csTeamZipper :: Lens' ChatState (Zipper () TeamId)
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))
csGlobalEditState :: Lens' ChatState GlobalEditState
csVerbatimTruncateSetting :: Lens' ChatState (Maybe Int)
csCurrentChannelId :: TeamId -> SimpleGetter ChatState (Maybe ChannelId)
csCurrentTeamId :: SimpleGetter ChatState (Maybe TeamId)
csPostMap :: Lens' ChatState (HashMap PostId Message)
csUsers :: Lens' ChatState Users
csHiddenChannelGroups :: Lens' ChatState (HashMap TeamId (Set ChannelListGroupLabel))
csConnectionStatus :: Lens' ChatState ConnectionStatus
csWorkerIsBusy :: Lens' ChatState (Maybe (Maybe Int))
csChannel :: ChannelId -> Traversal' ChatState ClientChannel
csChannelMessages :: ChannelId -> Traversal' ChatState Messages
csChannelMessageInterface :: ChannelId -> Lens' ChatState ChannelMessageInterface
maybeChannelMessageInterface :: ChannelId -> Traversal' ChatState ChannelMessageInterface
csChannels :: Lens' ChatState ClientChannels
csClientConfig :: Lens' ChatState (Maybe ClientConfig)
csInputHistory :: Lens' ChatState InputHistory
csMe :: Lens' ChatState User
timeZone :: Lens' ChatState TimeZoneSeries
whenMode :: TeamId -> Mode -> MH () -> MH ()
pushMode :: TeamId -> Mode -> MH ()
pushMode' :: TeamId -> Mode -> ChatState -> ChatState
popMode :: TeamId -> MH ()
replaceMode :: TeamId -> Mode -> MH ()
data GlobalEditState = GlobalEditState {
- _gedYankBuffer :: Text
}
emptyGlobalEditState :: GlobalEditState
gedYankBuffer :: Lens' GlobalEditState Text
data PostListWindowState = PostListWindowState {
- _postListPosts :: Messages
- _postListSelected :: Maybe PostId
}
postListSelected :: Lens' PostListWindowState (Maybe PostId)
postListPosts :: Lens' PostListWindowState Messages
data UserSearchScope
- = ChannelMembers ChannelId TeamId
- | ChannelNonMembers ChannelId TeamId
- | AllUsers (Maybe TeamId)
data ChannelSearchScope = AllChannels
data ListWindowState a b = ListWindowState {
- _listWindowSearchResults :: List Name a
- _listWindowSearchInput :: Editor Text Name
- _listWindowSearchScope :: b
- _listWindowSearching :: Bool
- _listWindowEnterHandler :: a -> MH Bool
- _listWindowNewList :: Vector a -> List Name a
- _listWindowFetchResults :: b -> Session -> Text -> IO (Vector a)
- _listWindowRecordCount :: Maybe Int
}
listWindowSearchResults :: forall a b. Lens' (ListWindowState a b) (List Name a)
listWindowSearchInput :: forall a b. Lens' (ListWindowState a b) (Editor Text Name)
listWindowSearchScope :: forall a b. Lens' (ListWindowState a b) b
listWindowSearching :: forall a b. Lens' (ListWindowState a b) Bool
listWindowEnterHandler :: forall a b. Lens' (ListWindowState a b) (a -> MH Bool)
listWindowNewList :: forall a b. Lens' (ListWindowState a b) (Vector a -> List Name a)
listWindowFetchResults :: forall a b. Lens' (ListWindowState a b) (b -> Session -> Text -> IO (Vector a))
listWindowRecordCount :: forall a b. Lens' (ListWindowState a b) (Maybe Int)
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
- _crSpellChecker :: Maybe Aspell
}
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
crSpellChecker :: Lens' ChatResources (Maybe Aspell)
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 ()
mhContinueWithoutRedraw :: 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
withChannel :: ChannelId -> (ClientChannel -> MH ()) -> MH ()
withChannelOrDefault :: ChannelId -> a -> (ClientChannel -> MH a) -> MH a
userList :: ChatState -> [UserInfo]
resetAutocomplete :: Traversal' ChatState (EditState n) -> 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 :: TeamId -> 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 -> TeamId -> HighlightSet
emptyHSet :: HighlightSet
moveLeft :: Eq a => a -> [a] -> [a]
moveRight :: Eq a => a -> [a] -> [a]
module Matterhorn.Types.Core
module Matterhorn.Types.Channels
module Matterhorn.Types.EditState
module Matterhorn.Types.Messages
module Matterhorn.Types.MessageInterface
module Matterhorn.Types.TabbedWindow
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

Instances

Instances details

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

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 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 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 #

handleEventWith :: [Event -> MH Bool] -> Event -> MH Bool Source #

Given a list of event handlers and an event, try to handle the event with the handlers in the specified order. If a handler returns False (indicating it did not handle the event), try the next handler until either a handler returns True or all handlers are tried. Returns True if any handler handled the event or False otherwise.

getServerBaseUrl :: TeamId -> MH TeamBaseURL Source #

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

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 _ciOTPToken :: Maybe 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 ChannelListSorting Source #

Constructors

ChannelListSortDefault
ChannelListSortUnreadFirst

Instances

Instances details

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

data ThreadOrientation Source #

Constructors

ThreadBelow	Show the thread below the channel message area.
ThreadAbove	Show the thread above the channel message area.
ThreadLeft	Show the thread to the left of the channel message area.
ThreadRight	Show the thread to the right of the channel message area.

Instances

Instances details

Eq ThreadOrientation Source #
Instance details Defined in Matterhorn.Types Methods (==) :: ThreadOrientation -> ThreadOrientation -> Bool # (/=) :: ThreadOrientation -> ThreadOrientation -> Bool #
Show ThreadOrientation Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> ThreadOrientation -> ShowS # show :: ThreadOrientation -> String # showList :: [ThreadOrientation] -> 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 #

ciOTPToken :: Lens' ConnectionInfo (Maybe Text) Source #

ciPassword :: Lens' ConnectionInfo Text Source #

ciType :: Lens' ConnectionInfo ConnectionType Source #

ciAccessToken :: Lens' ConnectionInfo Text Source #

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 #

resultToWidget :: Result n -> Widget n 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.
configTruncateVerbatimBlocks :: Maybe Int
Whether to truncate verbatim (and code) blocks past a reasonable number of lines.
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.
configChannelListSorting :: ChannelListSorting
How to sort channels in each channel list group
configShowTypingIndicator :: Bool
Whether to show the typing indicator when other users are typing
configSendTypingNotifications :: Bool
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.
configThreadOrientation :: ThreadOrientation
The orientation of the thread window relative to the main channel message window.
configMouseMode :: Bool
Whether to enable mouse support in matterhorn
configShowLastOpenThread :: Bool
Whether to re-open a thread that was open the last time Matterhorn quit

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 #

configTruncateVerbatimBlocksL :: Lens' Config (Maybe Int) Source #

configChannelListSortingL :: Lens' Config ChannelListSorting 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 #

configSendTypingNotificationsL :: 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 #

configThreadOrientationL :: Lens' Config ThreadOrientation Source #

configMouseModeL :: Lens' Config Bool Source #

configShowLastOpenThreadL :: 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 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

Constructors

Main
ShowHelp HelpTopic
ChannelSelect
LeaveChannelConfirm
DeleteChannelConfirm
MessageSelectDeleteConfirm MessageInterfaceTarget
PostListWindow PostListContents
UserListWindow
ReactionEmojiListWindow
ChannelListWindow
ThemeListWindow
ViewMessage
EditNotifyPrefs
ChannelTopicWindow

Instances

Instances details

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

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 window

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 #
Show PostListContents Source #
Instance details Defined in Matterhorn.Types Methods showsPrec :: Int -> PostListContents -> ShowS # show :: PostListContents -> String # showList :: [PostListContents] -> ShowS #

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
MattermostServerError MattermostError
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 #

matchesTeam :: Text -> Team -> Bool Source #

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

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

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

mkChannelZipperList :: ChannelListSorting -> UTCTime -> Config -> TeamId -> Maybe ClientConfig -> UserPreferences -> HashMap TeamId (Set ChannelListGroupLabel) -> 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

ChannelListGroup
Fields channelListGroupLabel :: ChannelListGroupLabel channelListGroupUnread :: Int channelListGroupCollapsed :: Bool channelListGroupEntries :: Int

Instances

Instances details

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

nonDMChannelListGroupUnread :: ChannelListGroup -> Int Source #

type ThreadInterface = MessageInterface Name PostId Source #

type ChannelMessageInterface = MessageInterface Name () Source #

threadInterface :: HasCallStack => TeamId -> Traversal' ChatState ThreadInterface Source #

unsafeThreadInterface :: HasCallStack => TeamId -> Lens' ChatState ThreadInterface Source #

maybeThreadInterface :: TeamId -> Lens' ChatState (Maybe ThreadInterface) Source #

threadInterfaceEmpty :: TeamId -> MH Bool Source #

threadInterfaceDeleteWhere :: TeamId -> ChannelId -> (Message -> Bool) -> MH () Source #

modifyThreadMessages :: TeamId -> ChannelId -> (Messages -> Messages) -> MH () Source #

modifyEachThreadMessage :: TeamId -> ChannelId -> (Message -> Message) -> MH () 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.
_tsTeam :: Team
The team data.
_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.
_tsModeStack :: NonemptyStack Mode
The current application mode stack when viewing this team. This is used to dispatch to different rendering and event handling routines. The current mode is always in at the top of the stack.
_tsChannelSelectState :: ChannelSelectState
The state of the user's input and selection for channel selection mode.
_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.
_tsViewedMessage :: Maybe (Message, TabbedWindow ChatState MH Name 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.).
_tsPostListWindow :: PostListWindowState
The state of the post list window.
_tsUserListWindow :: ListWindowState UserInfo UserSearchScope
The state of the user list window.
_tsChannelListWindow :: ListWindowState Channel ChannelSearchScope
The state of the user list window.
_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.
_tsReactionEmojiListWindow :: ListWindowState (Bool, Text) ()
The state of the reaction emoji list window.
_tsThemeListWindow :: ListWindowState InternalTheme ()
The state of the theme list window.
_tsChannelListSorting :: ChannelListSorting
How to sort channels in this team's channel list groups
_tsThreadInterface :: Maybe ThreadInterface
The thread interface for this team for participating in a single thread
_tsMessageInterfaceFocus :: MessageInterfaceFocus
Which message interface is focused for editing input

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

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

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

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

tsTeam :: Lens' TeamState Team Source #

tsChannelSelectState :: Lens' TeamState ChannelSelectState Source #

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

tsPostListWindow :: Lens' TeamState PostListWindowState Source #

tsUserListWindow :: Lens' TeamState (ListWindowState UserInfo UserSearchScope) Source #

tsChannelListWindow :: Lens' TeamState (ListWindowState Channel ChannelSearchScope) Source #

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

tsChannelTopicDialog :: Lens' TeamState ChannelTopicDialogState Source #

tsReactionEmojiListWindow :: Lens' TeamState (ListWindowState (Bool, Text) ()) Source #

tsThemeListWindow :: Lens' TeamState (ListWindowState InternalTheme ()) Source #

tsChannelListSorting :: Lens' TeamState ChannelListSorting Source #

tsThreadInterface :: Lens' TeamState (Maybe ThreadInterface) Source #

tsMessageInterfaceFocus :: Lens' TeamState MessageInterfaceFocus Source #

teamMode :: TeamState -> Mode Source #

teamModes :: TeamState -> [Mode] Source #

getTeamMode :: TeamId -> MH Mode Source #

data MessageInterfaceFocus Source #

Constructors

FocusThread
FocusCurrentChannel

Instances

Instances details

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

messageInterfaceFocusNext :: TeamState -> TeamState Source #

messageInterfaceFocusPrev :: TeamState -> TeamState Source #

channelEditor :: ChannelId -> Lens' ChatState (EditState Name) Source #

channelMessageSelect :: ChannelId -> Lens' ChatState MessageSelectState 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 #

withCurrentChannel :: TeamId -> (ChannelId -> ClientChannel -> MH ()) -> MH () Source #

withCurrentChannel' :: TeamId -> (ChannelId -> ClientChannel -> MH (Maybe a)) -> MH (Maybe a) Source #

withCurrentTeam :: (TeamId -> MH ()) -> MH () Source #

csTeamZipper :: Lens' ChatState (Zipper () TeamId) 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 #

csGlobalEditState :: Lens' ChatState GlobalEditState Source #

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

csCurrentChannelId :: TeamId -> SimpleGetter ChatState (Maybe ChannelId) Source #

csCurrentTeamId :: SimpleGetter ChatState (Maybe TeamId) Source #

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

csUsers :: Lens' ChatState Users Source #

csHiddenChannelGroups :: Lens' ChatState (HashMap TeamId (Set ChannelListGroupLabel)) Source #

csConnectionStatus :: Lens' ChatState ConnectionStatus Source #

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

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

csChannelMessages :: ChannelId -> Traversal' ChatState Messages Source #

csChannelMessageInterface :: ChannelId -> Lens' ChatState ChannelMessageInterface Source #

maybeChannelMessageInterface :: ChannelId -> Traversal' ChatState ChannelMessageInterface 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 :: TeamId -> Mode -> MH () -> MH () Source #

pushMode :: TeamId -> Mode -> MH () Source #

pushMode' :: TeamId -> Mode -> ChatState -> ChatState Source #

popMode :: TeamId -> MH () Source #

replaceMode :: TeamId -> Mode -> MH () Source #

data GlobalEditState Source #

The GlobalEditState value contains state not specific to any single editor.

Constructors

GlobalEditState
Fields _gedYankBuffer :: Text

emptyGlobalEditState :: GlobalEditState Source #

gedYankBuffer :: Lens' GlobalEditState Text Source #

data PostListWindowState Source #

The state of the post list window.

Constructors

PostListWindowState
Fields _postListPosts :: Messages _postListSelected :: Maybe PostId

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

postListPosts :: Lens' PostListWindowState Messages Source #

data UserSearchScope Source #

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

Constructors

ChannelMembers ChannelId TeamId
ChannelNonMembers ChannelId TeamId
AllUsers (Maybe TeamId)

data ChannelSearchScope Source #

The scope for searching for channels to join.

Constructors

AllChannels

data ListWindowState a b Source #

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

Constructors

ListWindowState

Fields

_listWindowSearchResults :: List Name a
The list of search results currently shown in the window.
_listWindowSearchInput :: Editor Text Name
The editor for the window's search input.
_listWindowSearchScope :: b
The window's current search scope.
_listWindowSearching :: Bool
Whether a search is in progress (i.e. whether we are currently awaiting a response from a search query to the server).
_listWindowEnterHandler :: a -> MH Bool
The handler to invoke on the selected element when the user presses Enter.
_listWindowNewList :: Vector a -> List Name a
The function to build a new brick List from a vector of search results.
_listWindowFetchResults :: b -> Session -> Text -> IO (Vector a)
The function to call to issue a search query to the server.
_listWindowRecordCount :: Maybe Int
The total number of available records, if known.

listWindowSearchResults :: forall a b. Lens' (ListWindowState a b) (List Name a) Source #

listWindowSearchInput :: forall a b. Lens' (ListWindowState a b) (Editor Text Name) Source #

listWindowSearchScope :: forall a b. Lens' (ListWindowState a b) b Source #

listWindowSearching :: forall a b. Lens' (ListWindowState a b) Bool Source #

listWindowEnterHandler :: forall a b. Lens' (ListWindowState a b) (a -> MH Bool) Source #

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

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

listWindowRecordCount :: forall a b. Lens' (ListWindowState a b) (Maybe Int) 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
_crSpellChecker :: Maybe Aspell

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 #

crSpellChecker :: Lens' ChatResources (Maybe Aspell) 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 #

mhContinueWithoutRedraw :: 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 #