CurryInfo: cass-analysis-5.0.0 / Analysis.Logging

 
-----------------------------------------------------------------------
This module provides operation for log messages and setting
the log level for the analyses.

@author Michael Hanus
@version January 2025
-----------------------------------------------------------------------

 Analysis.Logging

 debugMessage debugString

 

module Analysis.Logging ( DLevel(..), debugMessage, debugString ) where

import Control.Monad
import System.IO      ( hPutStr, stderr )

--------------------------------------------------------------------------
--- Debug levels intended as first parameter in debug operations below:
--- 0 : show nothing
--- 1 : show worker activity, e.g., timings
--- 2 : show server communication
--- 3 : ...and show read/store information
--- 4 : ...show also stored/computed analysis data
data DLevel = Quiet | Timing | Communicate | Storage | AllData
 deriving Enum

--- Prints a message line (to stderr) if debugging level is at least n.
debugMessage :: DLevel -> Int -> String -> IO ()
debugMessage dl n message = debugString dl n (message ++ "\n")

--- Prints a string (to stderr) if debugging level is at least n.
debugString :: DLevel -> Int -> String -> IO ()
debugString dl n message = when (fromEnum dl >= n) $ hPutStr stderr message

--------------------------------------------------------------------------

 DLevel

 safe