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

  User-customized color palette

• _configWindowNames :: Text

  Names of windows, used when alt-jumping)

• _configExtraHighlights :: [Identifier]

  Extra highlight nicks/terms

• _configNeverHighlights :: [Identifier]

  Never highlight nicks/terms

• _configNickPadding :: PaddingMode

  Padding of nicks in messages

• _configMacros :: Recognizer Macro

  command macros

• _configExtensions :: [ExtensionConfiguration]

  extensions to load

• _configUrlOpener :: Maybe UrlOpener

  paths to url opening executable

• _configIgnores :: [Text]

  initial ignore mask 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

• _configShowPing :: Bool

  visibility of ping time

• _configJumpModifier :: [Modifier]

  Modifier used for jumping windows

• _configDigraphs :: Map Digraph Text

  Extra digraphs

• _configNotifications :: NotifyWith

Instances

Show Configuration

Defined in Client.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

Exception ConfigurationFailure

default instance

Defined in Client.Configuration

Methods

toException :: ConfigurationFailure -> SomeException

fromException :: SomeException -> Maybe ConfigurationFailure

displayException :: ConfigurationFailure -> String

Show ConfigurationFailure

Defined in Client.Configuration

Methods

showsPrec :: Int -> ConfigurationFailure -> ShowS

show :: ConfigurationFailure -> String

showList :: [ConfigurationFailure] -> ShowS

data LayoutMode

Constructors

OneColumn

Vertically stack all windows in a single column

TwoColumn

Vertically stack extra windows in a second column

Instances

Show LayoutMode

Defined in Client.Configuration

Methods

showsPrec :: Int -> LayoutMode -> ShowS

show :: LayoutMode -> String

showList :: [LayoutMode] -> ShowS

data EditMode

Constructors

SingleLineEditor

MultiLineEditor

Instances

Show EditMode

Defined in Client.Configuration

Methods

showsPrec :: Int -> EditMode -> ShowS

show :: EditMode -> String

showList :: [EditMode] -> ShowS

data PaddingMode

Setting for how to pad the message prefix.

Constructors

LeftPadding !Int

Whitespace add to the left side of chat prefix

RightPadding !Int

Whitespace add to the right side of chat prefix

NoPadding

No whitespace added

Instances

Show PaddingMode

Defined in Client.Configuration

Methods

showsPrec :: Int -> PaddingMode -> ShowS

show :: PaddingMode -> String

showList :: [PaddingMode] -> ShowS

data ExtensionConfiguration

Configuration information for run-time loaded dynamic library extensions.

Constructors

ExtensionConfiguration

Fields

• _extensionPath :: FilePath

  path to shared object

• _extensionRtldFlags :: [RTLDFlags]

  dynamic linker flags

• _extensionArgs :: [Text]

  arguments to the extension on startup

Instances

Show ExtensionConfiguration

Defined in Client.Configuration

Methods

showsPrec :: Int -> ExtensionConfiguration -> ShowS

show :: ExtensionConfiguration -> String

showList :: [ExtensionConfiguration] -> ShowS

Lenses

configDefaults :: Lens' Configuration ServerSettings

configServers :: Lens' Configuration (HashMap Text ServerSettings)

configPalette :: Lens' Configuration Palette

configWindowNames :: Lens' Configuration Text

configNickPadding :: Lens' Configuration PaddingMode

configMacros :: Lens' Configuration (Recognizer Macro)

configExtensions :: Lens' Configuration [ExtensionConfiguration]

configExtraHighlights :: Lens' Configuration [Identifier]

configNeverHighlights :: Lens' Configuration [Identifier]

configUrlOpener :: Lens' Configuration (Maybe UrlOpener)

configIgnores :: Lens' Configuration [Text]

configActivityBar :: Lens' Configuration Bool

configBellOnMention :: Lens' Configuration Bool

configHideMeta :: Lens' Configuration Bool

configKeyMap :: Lens' Configuration KeyMap

configLayout :: Lens' Configuration LayoutMode

configShowPing :: Lens' Configuration Bool

configJumpModifier :: Lens' Configuration [Modifier]

configDigraphs :: Lens' Configuration (Map Digraph Text)

configNotifications :: Lens' Configuration NotifyWith

configNetworkPalette :: Text -> Configuration -> NetworkPalette

Returns a NetworkPalette for the given network name.

extensionPath :: Lens' ExtensionConfiguration FilePath

extensionRtldFlags :: Lens' ExtensionConfiguration [RTLDFlags]

extensionArgs :: Lens' ExtensionConfiguration [Text]

Loading configuration

loadConfiguration

Arguments

:: Maybe FilePath

path to configuration file

-> IO (Either ConfigurationFailure (FilePath, Configuration))

Load the configuration file defaulting to ~.glircconfig.

Given configuration path is optional and actual path used will be returns on success

Resolving paths

getConfigPath :: IO FilePath

Uses getXdgDirectory XdgConfig to find ~.configglirc/config

Specification

configurationSpec :: ValueSpec (ServerSettings -> Configuration)

FilePath resolution

data FilePathContext

newFilePathContext

Arguments

:: FilePath

configuration file path

-> IO FilePathContext

resolveFilePath :: FilePathContext -> FilePath -> FilePath

Url opener configuration

data UrlOpener

Constructors

UrlOpener FilePath [UrlArgument]

Instances

Show UrlOpener

Defined in Client.Configuration

Methods

showsPrec :: Int -> UrlOpener -> ShowS

show :: UrlOpener -> String

showList :: [UrlOpener] -> ShowS

data UrlArgument

Constructors

UrlArgLiteral String

UrlArgUrl

Instances

Show UrlArgument

Defined in Client.Configuration

Methods

showsPrec :: Int -> UrlArgument -> ShowS

show :: UrlArgument -> String

showList :: [UrlArgument] -> ShowS