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

• _configIndentWrapped :: Maybe Int

  How far to indent wrapped lines

• _configConfigPath :: Maybe FilePath

  manually specified configuration path, used for reloading

• _configMacros :: Recognizer Macro

  command macros

• _configExtensions :: [FilePath]

  paths to shared library

• _configUrlOpener :: Maybe FilePath

  paths to url opening executable

• _configIgnores :: HashSet Identifier

  initial ignore list

• _configActivityBar :: Bool

  initially visibility of the activity bar

• _configBellOnMention :: Bool

  notify terminal on mention

• _configHideMeta :: Bool

  default setting for hidemeta on new windows

• _configKeyMap :: KeyMap

  keyboard bindings

• _configLayout :: LayoutMode

  Default layout on startup

• _configJumpModifier :: [Modifier]

  Modifier used for jumping windows

Instances

Show Configuration

Methods

showsPrec :: Int -> Configuration -> ShowS

show :: Configuration -> String

showList :: [Configuration] -> ShowS

data ConfigurationFailure

Failure cases when loading a configuration file.

Constructors

ConfigurationReadFailed String

Error message from reading configuration file

ConfigurationParseFailed FilePath String

Error message from parser or lexer

ConfigurationMalformed FilePath String

Error message from loading parsed configuration

Instances

Show ConfigurationFailure

Methods

showsPrec :: Int -> ConfigurationFailure -> ShowS

show :: ConfigurationFailure -> String

showList :: [ConfigurationFailure] -> ShowS

Exception ConfigurationFailure

default instance

Methods

toException :: ConfigurationFailure -> SomeException

fromException :: SomeException -> Maybe ConfigurationFailure

displayException :: ConfigurationFailure -> String

data LayoutMode

Constructors

OneColumn

Vertically stack all windows in a single column

TwoColumn

Vertically stack extra windows in a second column

Instances

Show LayoutMode

Methods

showsPrec :: Int -> LayoutMode -> ShowS

show :: LayoutMode -> String

showList :: [LayoutMode] -> ShowS

Lenses

configDefaults :: Lens' Configuration ServerSettings

configServers :: Lens' Configuration (HashMap Text ServerSettings)

configPalette :: Lens' Configuration Palette

configWindowNames :: Lens' Configuration Text

configNickPadding :: Lens' Configuration (Maybe Integer)

configIndentWrapped :: Lens' Configuration (Maybe Int)

configConfigPath :: Lens' Configuration (Maybe FilePath)

configMacros :: Lens' Configuration (Recognizer Macro)

configExtensions :: Lens' Configuration [FilePath]

configExtraHighlights :: Lens' Configuration (HashSet Identifier)

configUrlOpener :: Lens' Configuration (Maybe FilePath)

configIgnores :: Lens' Configuration (HashSet Identifier)

configActivityBar :: Lens' Configuration Bool

configBellOnMention :: Lens' Configuration Bool

configHideMeta :: Lens' Configuration Bool

configKeyMap :: Lens' Configuration KeyMap

configLayout :: Lens' Configuration LayoutMode

configJumpModifier :: Lens' Configuration [Modifier]

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.

getNewConfigPath :: IO FilePath

Uses getXdgDirectory XdgConfig to find .configglircconfig

Specification

configurationSpec :: ValueSpecs (Maybe FilePath -> ServerSettings -> Configuration)