Safe Haskell	None
Language	Haskell2010

System.Console.CmdArgs.Verbosity

Description

A module to deal with verbosity, how 'chatty' a program should be. This module defines the Verbosity data type, along with functions for manipulating a global verbosity value.

Synopsis

Documentation

data Verbosity Source

The verbosity data type

Constructors

Quiet	Only output essential messages (typically errors)
Normal	Output normal messages (typically errors and warnings)
Loud	Output lots of messages (typically errors, warnings and status updates)

Instances

Bounded Verbosity Source
Enum Verbosity Source
Eq Verbosity Source
Data Verbosity Source
Ord Verbosity Source
Read Verbosity Source
Show Verbosity Source

setVerbosity :: Verbosity -> IO () Source

Set the global verbosity.

getVerbosity :: IO Verbosity Source

Get the global verbosity. Initially Normal before any calls to setVerbosity.

isNormal :: IO Bool Source

Used to test if warnings should be output to the user. True if the verbosity is set to Normal or Loud (when --quiet is not specified).

isLoud :: IO Bool Source

Used to test if status updates should be output to the user. True if the verbosity is set to Loud (when --verbose is specified).

whenNormal :: IO () -> IO () Source

An action to perform if the verbosity is normal or higher, based on isNormal.

whenLoud :: IO () -> IO () Source

An action to perform if the verbosity is loud, based on isLoud.