Cabal-3.4.1.0: A framework for packaging Haskell software
CopyrightIan Lynagh 2007
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellSafe-Inferred
LanguageHaskell2010

Distribution.Verbosity

Description

A Verbosity type with associated utilities.

There are 4 standard verbosity levels from silent, normal, verbose up to deafening. This is used for deciding what logging messages to print.

Verbosity also is equipped with some internal settings which can be used to control at a fine granularity the verbosity of specific settings (e.g., so that you can trace only particular things you are interested in.) It's important to note that the instances for Verbosity assume that this does not exist.

Synopsis

Verbosity

data Verbosity #

Instances

Instances details
Parsec Verbosity #

Parser verbosity

>>> explicitEitherParsec parsecVerbosity "normal"
Right (Verbosity {vLevel = Normal, vFlags = fromList [], vQuiet = False})
>>> explicitEitherParsec parsecVerbosity "normal+nowrap  "
Right (Verbosity {vLevel = Normal, vFlags = fromList [VNoWrap], vQuiet = False})
>>> explicitEitherParsec parsecVerbosity "normal+nowrap +markoutput"
Right (Verbosity {vLevel = Normal, vFlags = fromList [VNoWrap,VMarkOutput], vQuiet = False})
>>> explicitEitherParsec parsecVerbosity "normal +nowrap +markoutput"
Right (Verbosity {vLevel = Normal, vFlags = fromList [VNoWrap,VMarkOutput], vQuiet = False})
>>> explicitEitherParsec parsecVerbosity "normal+nowrap+markoutput"
Right (Verbosity {vLevel = Normal, vFlags = fromList [VNoWrap,VMarkOutput], vQuiet = False})
>>> explicitEitherParsec parsecVerbosity "deafening+nowrap+stdout+stderr+callsite+callstack"
Right (Verbosity {vLevel = Deafening, vFlags = fromList [VCallStack,VCallSite,VNoWrap,VStderr], vQuiet = False})

Note: this parser will eat trailing spaces.

Instance details

Defined in Distribution.Verbosity

Methods

parsec :: CabalParsing m => m Verbosity #

Pretty Verbosity # 
Instance details

Defined in Distribution.Verbosity

Structured Verbosity # 
Instance details

Defined in Distribution.Verbosity

Bounded Verbosity # 
Instance details

Defined in Distribution.Verbosity

Enum Verbosity # 
Instance details

Defined in Distribution.Verbosity

Generic Verbosity # 
Instance details

Defined in Distribution.Verbosity

Associated Types

type Rep Verbosity :: Type -> Type Source #

Read Verbosity # 
Instance details

Defined in Distribution.Verbosity

Show Verbosity # 
Instance details

Defined in Distribution.Verbosity

Binary Verbosity # 
Instance details

Defined in Distribution.Verbosity

Eq Verbosity # 
Instance details

Defined in Distribution.Verbosity

Ord Verbosity # 
Instance details

Defined in Distribution.Verbosity

type Rep Verbosity # 
Instance details

Defined in Distribution.Verbosity

isVerboseQuiet :: Verbosity -> Bool #

Test if we had called lessVerbose on the verbosity

verboseNoFlags :: Verbosity -> Verbosity #

Turn off all flags

modifyVerbosity :: (Verbosity -> Verbosity) -> Verbosity -> Verbosity #

Combinator for transforming verbosity level while retaining the original hidden state.

For instance, the following property holds

isVerboseNoWrap (modifyVerbosity (max verbose) v) == isVerboseNoWrap v

Note: you can use modifyVerbosity (const v1) v0 to overwrite v1's flags with v0's flags.

Since: Cabal-2.0.1.0

Call stacks

verboseCallSite :: Verbosity -> Verbosity #

Turn on verbose call-site printing when we log.

verboseCallStack :: Verbosity -> Verbosity #

Turn on verbose call-stack printing when we log.

isVerboseCallSite :: Verbosity -> Bool #

Test if we should output call sites when we log.

isVerboseCallStack :: Verbosity -> Bool #

Test if we should output call stacks when we log.

Output markets

verboseMarkOutput :: Verbosity -> Verbosity #

Turn on -----BEGIN CABAL OUTPUT----- markers for output from Cabal (as opposed to GHC, or system dependent).

isVerboseMarkOutput :: Verbosity -> Bool #

Test if we should output markets.

verboseUnmarkOutput :: Verbosity -> Verbosity #

Turn off marking; useful for suppressing nondeterministic output.

line-wrapping

verboseNoWrap :: Verbosity -> Verbosity #

Disable line-wrapping for log messages.

isVerboseNoWrap :: Verbosity -> Bool #

Test if line-wrapping is disabled for log messages.

timestamps

verboseTimestamp :: Verbosity -> Verbosity #

Turn on timestamps for log messages.

isVerboseTimestamp :: Verbosity -> Bool #

Test if we should output timestamps when we log.

verboseNoTimestamp :: Verbosity -> Verbosity #

Turn off timestamps for log messages.

Stderr

verboseStderr :: Verbosity -> Verbosity #

Turn on timestamps for log messages.

Since: Cabal-3.4.0.0

isVerboseStderr :: Verbosity -> Bool #

Test if we should output to stderr when we log.

Since: Cabal-3.4.0.0

verboseNoStderr :: Verbosity -> Verbosity #

Turn off timestamps for log messages.

Since: Cabal-3.4.0.0