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 Source #

Instances

Bounded Verbosity #
Instance details Methods minBound :: Verbosity Source # maxBound :: Verbosity Source #
Enum Verbosity #
Instance details Methods succ :: Verbosity -> Verbosity Source # pred :: Verbosity -> Verbosity Source # toEnum :: Int -> Verbosity Source # fromEnum :: Verbosity -> Int Source # enumFrom :: Verbosity -> [Verbosity] Source # enumFromThen :: Verbosity -> Verbosity -> [Verbosity] Source # enumFromTo :: Verbosity -> Verbosity -> [Verbosity] Source # enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity] Source #
Eq Verbosity #
Instance details Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Ord Verbosity #
Instance details 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 Methods readsPrec :: Int -> ReadS Verbosity Source # readList :: ReadS [Verbosity] Source # readPrec :: ReadPrec Verbosity Source # readListPrec :: ReadPrec [Verbosity] Source #
Show Verbosity #
Instance details Methods showsPrec :: Int -> Verbosity -> ShowS Source # show :: Verbosity -> String Source # showList :: [Verbosity] -> ShowS Source #
Generic Verbosity #
Instance details Associated Types type Rep Verbosity :: * -> * Source # Methods from :: Verbosity -> Rep Verbosity x Source # to :: Rep Verbosity x -> Verbosity Source #
Binary Verbosity #
Instance details Methods put :: Verbosity -> Put Source # get :: Get Verbosity Source # putList :: [Verbosity] -> Put Source #
type Rep Verbosity #
Instance details type Rep Verbosity

silent :: Verbosity Source #

normal :: Verbosity Source #

verbose :: Verbosity Source #

deafening :: Verbosity Source #

moreVerbose :: Verbosity -> Verbosity Source #

lessVerbose :: Verbosity -> Verbosity Source #

isVerboseQuiet :: Verbosity -> Bool Source #

Test if we had called lessVerbose on the verbosity

intToVerbosity :: Int -> Maybe Verbosity Source #

flagToVerbosity :: ReadE Verbosity Source #

showForCabal :: Verbosity -> String Source #

showForGHC :: Verbosity -> String Source #

verboseNoFlags :: Verbosity -> Verbosity Source #

Turn off all flags

verboseHasFlags :: Verbosity -> Bool Source #

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

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

Call stacks

verboseCallSite :: Verbosity -> Verbosity Source #

Turn on verbose call-site printing when we log.

verboseCallStack :: Verbosity -> Verbosity Source #

Turn on verbose call-stack printing when we log.

isVerboseCallSite :: Verbosity -> Bool Source #

Test if we should output call sites when we log.

isVerboseCallStack :: Verbosity -> Bool Source #

Test if we should output call stacks when we log.

Output markets

verboseMarkOutput :: Verbosity -> Verbosity Source #

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

isVerboseMarkOutput :: Verbosity -> Bool Source #

Test if we should output markets.

verboseUnmarkOutput :: Verbosity -> Verbosity Source #

Turn off marking; useful for suppressing nondeterministic output.

line-wrapping

verboseNoWrap :: Verbosity -> Verbosity Source #

Disable line-wrapping for log messages.

isVerboseNoWrap :: Verbosity -> Bool Source #

Test if line-wrapping is disabled for log messages.

timestamps

verboseTimestamp :: Verbosity -> Verbosity Source #

Turn on timestamps for log messages.

isVerboseTimestamp :: Verbosity -> Bool Source #

Test if if we should output timestamps when we log.

verboseNoTimestamp :: Verbosity -> Verbosity Source #

Turn off timestamps for log messages.