Client.Configuration

This module defines the top-level configuration information for the client.

Configuration type

data Configuration

Top-level client configuration information. When connecting to a server configuration from _configServers is used where possible, otherwise _configDefaults is used.

Constructors

Configuration

Fields

• _configDefaults :: ServerSettings

  Default connection settings

• _configServers :: HashMap Text ServerSettings

  Host-specific settings

• _configPalette :: Palette
• _configWindowNames :: Text

  Names of windows, used when alt-jumping)

• _configExtraHighlights :: HashSet Identifier

  Extra highlight nicks/terms

• _configNickPadding :: Maybe Integer

  Padding of nicks

• _configConfigPath :: Maybe FilePath

  manually specified configuration path, used for reloading

• _configMacros :: HashMap Text [[ExpansionChunk]]

  command macros

• _configExtensions :: [FilePath]

  paths to shared library

• _configUrlOpener :: Maybe FilePath

  paths to url opening executable

• _configIgnores :: HashSet Identifier

  initial ignore list

Instances

Show Configuration

Methods

showsPrec :: Int -> Configuration -> ShowS

show :: Configuration -> String

showList :: [Configuration] -> ShowS

data ConfigurationFailure

Constructors

ConfigurationParseFailed String

ConfigurationMalformed String

ConfigurationReadFailed String

Instances

Show ConfigurationFailure

Methods

showsPrec :: Int -> ConfigurationFailure -> ShowS

show :: ConfigurationFailure -> String

showList :: [ConfigurationFailure] -> ShowS

Exception ConfigurationFailure

Methods

toException :: ConfigurationFailure -> SomeException

fromException :: SomeException -> Maybe ConfigurationFailure

displayException :: ConfigurationFailure -> String

configDefaults :: Lens' Configuration ServerSettings

configServers :: Lens' Configuration (HashMap Text ServerSettings)

configPalette :: Lens' Configuration Palette

configWindowNames :: Lens' Configuration Text

configNickPadding :: Lens' Configuration (Maybe Integer)

configConfigPath :: Lens' Configuration (Maybe FilePath)

configMacros :: Lens' Configuration (HashMap Text [[ExpansionChunk]])

configExtensions :: Lens' Configuration [FilePath]

configExtraHighlights :: Lens' Configuration (HashSet Identifier)

configUrlOpener :: Lens' Configuration (Maybe FilePath)

configIgnores :: Lens' Configuration (HashSet Identifier)

Loading configuration

loadConfiguration

Arguments

:: Maybe FilePath

path to configuration file

-> IO (Either ConfigurationFailure Configuration)

Load the configuration file defaulting to ~.glircconfig.

Resolving paths

resolveConfigurationPath :: FilePath -> IO FilePath

Resolve relative paths starting at the home directory rather than the current directory of the client.