ModuleCabal-3.12.1.0Haskell2010

Distribution.Verbosity

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.

1 type
31 values

PackageCabal-3.12.1.0
Exports32
LanguageHaskell2010
LicenceBSD-3-Clause
SourceVerbosity.hs

Verbosity

15 declarations

datadata Verbosity

Instances12Bounded, Enum, Eq, Ord, Read, Show, …

Bounded VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity
Enum VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity
Eq VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity
Ord VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity
Read VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity
Show VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity
Generic VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity
Binary VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity

Parsec VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity

Parser verbosity

Example1 expression

>>> explicitEitherParsec parsecVerbosity "normal"Right (Verbosity {vLevel = Normal, vFlags = fromList [], vQuiet = False})

Example1 expression

>>> explicitEitherParsec parsecVerbosity "normal+nowrap  "Right (Verbosity {vLevel = Normal, vFlags = fromList [VNoWrap], vQuiet = False})

Example1 expression

>>> explicitEitherParsec parsecVerbosity "normal+nowrap +markoutput"Right (Verbosity {vLevel = Normal, vFlags = fromList [VNoWrap,VMarkOutput], vQuiet = False})

Example1 expression

>>> explicitEitherParsec parsecVerbosity "normal +nowrap +markoutput"Right (Verbosity {vLevel = Normal, vFlags = fromList [VNoWrap,VMarkOutput], vQuiet = False})

Example1 expression

>>> explicitEitherParsec parsecVerbosity "normal+nowrap+markoutput"Right (Verbosity {vLevel = Normal, vFlags = fromList [VNoWrap,VMarkOutput], vQuiet = False})

Example1 expression

>>> 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.

Pretty VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity
Structured VerbosityDefined in Cabal-3.12.1.0 · Distribution.Verbosity
type Rep Verbosity = D1 ('MetaData "Verbosity" "Distribution.Verbosity" "Cabal-3.12.1.0-fc60" 'False) (C1 ('MetaCons "Verbosity" 'PrefixI 'True) (S1 ('MetaSel ('Just "vLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VerbosityLevel) :*: (S1 ('MetaSel ('Just "vFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set VerbosityFlag)) :*: S1 ('MetaSel ('Just "vQuiet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))Defined in Cabal-3.12.1.0 · Distribution.Verbosity

valuesilent :: Verbosity

In silent mode, we should not print anything unless an error occurs.

valuenormal :: Verbosity

Print stuff we want to see by default.

valueverbose :: Verbosity

Be more verbose about what's going on.

valuedeafening :: Verbosity

Not only are we verbose ourselves (perhaps even noisier than when being verbose), but we tell everything we run to be verbose too.

valuemoreVerbose :: Verbosity -> Verbosity

Increase verbosity level, but stay silent if we are.

valuelessVerbose :: Verbosity -> Verbosity

Decrease verbosity level, but stay deafening if we are.

valueisVerboseQuiet :: Verbosity -> Bool

Test if we had called lessVerbose on the verbosity.

valueintToVerbosity :: Int -> Maybe Verbosity

Numeric verbosity level 0..3: 0 is silent, 3 is deafening.

valueflagToVerbosity :: ReadE Verbosity

valueshowForCabal :: Verbosity -> String

valueshowForGHC :: Verbosity -> String

valueverboseNoFlags :: Verbosity -> Verbosity

Turn off all flags.

valueverboseHasFlags :: Verbosity -> Bool

valuemodifyVerbosity :: (Verbosity -> Verbosity) -> Verbosity -> Verbosity

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

For instance, the following property holds

Property

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

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

Call stacks

4 declarations

valueverboseCallSite :: Verbosity -> Verbosity

Turn on verbose call-site printing when we log.

valueverboseCallStack :: Verbosity -> Verbosity

Turn on verbose call-stack printing when we log.

valueisVerboseCallSite :: Verbosity -> Bool

Test if we should output call sites when we log.

valueisVerboseCallStack :: Verbosity -> Bool

Test if we should output call stacks when we log.

Output markets

3 declarations

valueverboseMarkOutput :: Verbosity -> Verbosity

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

valueisVerboseMarkOutput :: Verbosity -> Bool

Test if we should output markets.

valueverboseUnmarkOutput :: Verbosity -> Verbosity

Turn off marking; useful for suppressing nondeterministic output.

Line wrapping

2 declarations

valueverboseNoWrap :: Verbosity -> Verbosity

Disable line-wrapping for log messages.

valueisVerboseNoWrap :: Verbosity -> Bool

Test if line-wrapping is disabled for log messages.

Time stamps

3 declarations

valueverboseTimestamp :: Verbosity -> Verbosity

Turn on timestamps for log messages.

valueisVerboseTimestamp :: Verbosity -> Bool

Test if we should output timestamps when we log.

valueverboseNoTimestamp :: Verbosity -> Verbosity

Turn off timestamps for log messages.

Stderr

3 declarations

valueverboseStderr :: Verbosity -> Verbosity

Switch logging to stderr.

valueisVerboseStderr :: Verbosity -> Bool

Test if we should output to stderr when we log.

valueverboseNoStderr :: Verbosity -> Verbosity

Switch logging to stdout.

No warnings

2 declarations

valueverboseNoWarn :: Verbosity -> Verbosity

Turn off warnings for log messages.

valueisVerboseNoWarn :: Verbosity -> Bool

Test if we should output warnings when we log.