Safe Haskell	None
Language	Haskell2010

Matterhorn.Config

Synopsis

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
- 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
}
data PasswordSource
- = PasswordString Text
- | PasswordCommand Text
findConfig :: Maybe FilePath -> IO (Either String ([String], Config))
defaultConfig :: Config
configConnectionType :: Config -> ConnectionType

Documentation

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

Instances

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 #

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

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 #

findConfig :: Maybe FilePath -> IO (Either String ([String], Config)) Source #

defaultConfig :: Config Source #

configConnectionType :: Config -> ConnectionType Source #