Safe Haskell	Safe-Inferred
Language	Haskell2010

Crux.Config.Load

Description

This module deals with loading configurations.

Synopsis

data Options opts
- = ShowHelp
- | ShowVersion
- | Options opts [FilePath]
data ColorOptions = ColorOptions {
- noColorsErr :: Bool
- noColorsOut :: Bool
}
defaultColorOptions :: ColorOptions
allColors :: ColorOptions
noColors :: ColorOptions
data EarlyConfig opts = EarlyConfig {
- showHelp :: Bool
- showVersion :: Bool
- configFile :: Maybe FilePath
- colorOptions :: ColorOptions
- options :: OptSetter opts
- files :: [FilePath]
}
commandLineOptions :: Config opts -> OptSpec (EarlyConfig opts)
delayOpt :: OptSetter opts -> OptSetter (EarlyConfig opts)
data ConfigFileLoc
- = NoConfgFile
- | AtPosition Position
data ConfigError
ppConfigError :: ConfigError -> String
loadConfig :: Text -> Config opts -> IO (ColorOptions, Options opts)
fromFile :: Text -> Config opts -> Maybe FilePath -> IO opts
fromEnv :: opts -> EnvDescr opts -> IO opts

Documentation

data Options opts Source #

The result of loading a configuration.

Constructors

ShowHelp	Show help and exit
ShowVersion	Show version and exit
Options opts [FilePath]	We loaded some options

data ColorOptions Source #

Constructors

ColorOptions
Fields noColorsErr :: Bool noColorsOut :: Bool

Instances

Instances details

Generic ColorOptions Source #
Instance details Defined in Crux.Config.Load Associated Types type Rep ColorOptions :: Type -> Type # Methods from :: ColorOptions -> Rep ColorOptions x # to :: Rep ColorOptions x -> ColorOptions #
type Rep ColorOptions Source #
Instance details Defined in Crux.Config.Load type Rep ColorOptions = D1 ('MetaData "ColorOptions" "Crux.Config.Load" "crux-0.7-DD4jascIe8aJ5p2f7vnjLq" 'False) (C1 ('MetaCons "ColorOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "noColorsErr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "noColorsOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

defaultColorOptions :: ColorOptions Source #

allColors :: ColorOptions Source #

noColors :: ColorOptions Source #

data EarlyConfig opts Source #

Command line options processed before loading the configuration file.

Constructors

EarlyConfig
Fields showHelp :: Bool Describe options & quit showVersion :: Bool Show tool version & quit configFile :: Maybe FilePath Load configuratoin from here. Other command line options override the settings in the file. colorOptions :: ColorOptions options :: OptSetter opts files :: [FilePath]

Instances

Instances details

Generic (EarlyConfig opts) Source #
Instance details Defined in Crux.Config.Load Associated Types type Rep (EarlyConfig opts) :: Type -> Type # Methods from :: EarlyConfig opts -> Rep (EarlyConfig opts) x # to :: Rep (EarlyConfig opts) x -> EarlyConfig opts #
type Rep (EarlyConfig opts) Source #
Instance details Defined in Crux.Config.Load type Rep (EarlyConfig opts) = D1 ('MetaData "EarlyConfig" "Crux.Config.Load" "crux-0.7-DD4jascIe8aJ5p2f7vnjLq" 'False) (C1 ('MetaCons "EarlyConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "showHelp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: (S1 ('MetaSel ('Just "showVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: S1 ('MetaSel ('Just "configFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)))) :: (S1 ('MetaSel ('Just "colorOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ColorOptions) :: (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OptSetter opts)) :*: S1 ('MetaSel ('Just "files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath])))))

commandLineOptions :: Config opts -> OptSpec (EarlyConfig opts) Source #

delayOpt :: OptSetter opts -> OptSetter (EarlyConfig opts) Source #

data ConfigFileLoc Source #

Constructors

NoConfgFile
AtPosition Position

Instances

Instances details

Show ConfigFileLoc Source #
Instance details Defined in Crux.Config.Load Methods showsPrec :: Int -> ConfigFileLoc -> ShowS # show :: ConfigFileLoc -> String # showList :: [ConfigFileLoc] -> ShowS #
ErrorAnnotation ConfigFileLoc Source #
Instance details Defined in Crux.Config.Load Methods displayAnnotation :: ConfigFileLoc -> Doc #

data ConfigError Source #

Constructors

FailedToReadFile IOError
FailedToParseFile ParseError
FailedToProcessFile (ValueSpecMismatch ConfigFileLoc)
InvalidEnvVar String String String	variable, value, error message
InvalidCommandLine [String]

Instances

Instances details

Exception ConfigError Source #
Instance details Defined in Crux.Config.Load Methods toException :: ConfigError -> SomeException # fromException :: SomeException -> Maybe ConfigError # displayException :: ConfigError -> String #
Show ConfigError Source #
Instance details Defined in Crux.Config.Load Methods showsPrec :: Int -> ConfigError -> ShowS # show :: ConfigError -> String # showList :: [ConfigError] -> ShowS #

ppConfigError :: ConfigError -> String Source #

loadConfig :: Text -> Config opts -> IO (ColorOptions, Options opts) Source #

Merges command-line options, environment variable options, and configuration file options (in that order) to get the overall Options configuration for running Crux. Throws ConfigError on failure.

fromFile :: Text -> Config opts -> Maybe FilePath -> IO opts Source #

Load settings from a file, or from an empty configuration value.

fromEnv :: opts -> EnvDescr opts -> IO opts Source #

Modify the options using an environment variable.