Copyright	Ian Lynagh 2007
License	BSD3
Maintainer	cabal-devel@haskell.org
Portability	portable
Safe Haskell	None
Language	Haskell2010

Distribution.Verbosity

Contents

Verbosity
Call stacks
Output markets
line-wrapping
timestamps

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

data Verbosity
silent :: Verbosity
normal :: Verbosity
verbose :: Verbosity
deafening :: Verbosity
moreVerbose :: Verbosity -> Verbosity
lessVerbose :: Verbosity -> Verbosity
isVerboseQuiet :: Verbosity -> Bool
intToVerbosity :: Int -> Maybe Verbosity
flagToVerbosity :: ReadE Verbosity
showForCabal :: Verbosity -> String
showForGHC :: Verbosity -> String
verboseNoFlags :: Verbosity -> Verbosity
verboseHasFlags :: Verbosity -> Bool
modifyVerbosity :: (Verbosity -> Verbosity) -> Verbosity -> Verbosity
verboseCallSite :: Verbosity -> Verbosity
verboseCallStack :: Verbosity -> Verbosity
isVerboseCallSite :: Verbosity -> Bool
isVerboseCallStack :: Verbosity -> Bool
verboseMarkOutput :: Verbosity -> Verbosity
isVerboseMarkOutput :: Verbosity -> Bool
verboseUnmarkOutput :: Verbosity -> Verbosity
verboseNoWrap :: Verbosity -> Verbosity
isVerboseNoWrap :: Verbosity -> Bool
verboseTimestamp :: Verbosity -> Verbosity
isVerboseTimestamp :: Verbosity -> Bool
verboseNoTimestamp :: Verbosity -> Verbosity

Verbosity

data Verbosity #

Instances

Bounded Verbosity #
Instance details Defined in Distribution.Verbosity Methods minBound :: Verbosity # maxBound :: Verbosity #
Enum Verbosity #
Instance details Defined in Distribution.Verbosity Methods succ :: Verbosity -> Verbosity # pred :: Verbosity -> Verbosity # toEnum :: Int -> Verbosity # fromEnum :: Verbosity -> Int # enumFrom :: Verbosity -> [Verbosity] # enumFromThen :: Verbosity -> Verbosity -> [Verbosity] # enumFromTo :: Verbosity -> Verbosity -> [Verbosity] # enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity] #
Eq Verbosity #
Instance details Defined in Distribution.Verbosity Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Ord Verbosity #
Instance details Defined in Distribution.Verbosity Methods compare :: Verbosity -> Verbosity -> Ordering # (<) :: Verbosity -> Verbosity -> Bool # (<=) :: Verbosity -> Verbosity -> Bool # (>) :: Verbosity -> Verbosity -> Bool # (>=) :: Verbosity -> Verbosity -> Bool # max :: Verbosity -> Verbosity -> Verbosity # min :: Verbosity -> Verbosity -> Verbosity #
Read Verbosity #
Instance details Defined in Distribution.Verbosity Methods readsPrec :: Int -> ReadS Verbosity # readList :: ReadS [Verbosity] # readPrec :: ReadPrec Verbosity # readListPrec :: ReadPrec [Verbosity] #
Show Verbosity #
Instance details Defined in Distribution.Verbosity Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #
Generic Verbosity #
Instance details Defined in Distribution.Verbosity Associated Types type Rep Verbosity :: * -> * # Methods from :: Verbosity -> Rep Verbosity x # to :: Rep Verbosity x -> Verbosity #
Binary Verbosity #
Instance details Defined in Distribution.Verbosity Methods put :: Verbosity -> Put # get :: Get Verbosity # putList :: [Verbosity] -> Put #
type Rep Verbosity #
Instance details Defined in Distribution.Verbosity type Rep Verbosity

silent :: Verbosity #

normal :: Verbosity #

verbose :: Verbosity #

deafening :: Verbosity #

moreVerbose :: Verbosity -> Verbosity #

lessVerbose :: Verbosity -> Verbosity #

isVerboseQuiet :: Verbosity -> Bool #

Test if we had called lessVerbose on the verbosity

intToVerbosity :: Int -> Maybe Verbosity #

flagToVerbosity :: ReadE Verbosity #

showForCabal :: Verbosity -> String #

showForGHC :: Verbosity -> String #

verboseNoFlags :: Verbosity -> Verbosity #

Turn off all flags

verboseHasFlags :: Verbosity -> Bool #

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: 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 if we should output timestamps when we log.

verboseNoTimestamp :: Verbosity -> Verbosity #

Turn off timestamps for log messages.