Safe Haskell	None
Language	GHC2021

GHC.Utils.Logger

Contents

Logger setup
- Hooks
- Flags
Logging
Dumping
Tracing

Description

Logger

The Logger is an configurable entity that is used by the compiler to output messages on the console (stdout, stderr) and in dump files.

The behaviour of default Logger returned by initLogger can be modified with hooks. The compiler itself uses hooks in multithreaded code (--make) and it is also probably used by ghc-api users (IDEs, etc.).

In addition to hooks, the Logger supports LogFlags: basically a subset of the command-line flags that control the logger behaviour at a higher level than hooks.

Hooks are used to define how to generate a infowarningerror/dump messages
LogFlags are used to decide when and how to generate messages

Synopsis

data Logger
class HasLogger (m :: Type -> Type) where
- getLogger :: m Logger
class ContainsLogger t where
- extractLogger :: t -> Logger
initLogger :: IO Logger
type LogAction = LogFlags -> MessageClass -> SrcSpan -> SDoc -> IO ()
type LogJsonAction = LogFlags -> MessageClass -> JsonDoc -> IO ()
type DumpAction = LogFlags -> PprStyle -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
type TraceAction a = LogFlags -> String -> SDoc -> a -> a
data DumpFormat
- = FormatHaskell
- | FormatCore
- | FormatSTG
- | FormatByteCode
- | FormatCMM
- | FormatASM
- | FormatC
- | FormatLLVM
- | FormatJS
- | FormatText
popLogHook :: Logger -> Logger
pushLogHook :: (LogAction -> LogAction) -> Logger -> Logger
popJsonLogHook :: Logger -> Logger
pushJsonLogHook :: (LogJsonAction -> LogJsonAction) -> Logger -> Logger
popDumpHook :: Logger -> Logger
pushDumpHook :: (DumpAction -> DumpAction) -> Logger -> Logger
popTraceHook :: Logger -> Logger
pushTraceHook :: (forall a. TraceAction a -> TraceAction a) -> Logger -> Logger
makeThreadSafe :: Logger -> IO Logger
data LogFlags = LogFlags {
- log_default_user_context :: SDocContext
- log_default_dump_context :: SDocContext
- log_dump_flags :: !(EnumSet DumpFlag)
- log_show_caret :: !Bool
- log_diagnostics_as_json :: !Bool
- log_show_warn_groups :: !Bool
- log_enable_timestamps :: !Bool
- log_dump_to_file :: !Bool
- log_dump_dir :: !(Maybe FilePath)
- log_dump_prefix :: !FilePath
- log_dump_prefix_override :: !(Maybe FilePath)
- log_with_ways :: !Bool
- log_enable_debug :: !Bool
- log_verbosity :: !Int
- log_ways :: !(Maybe Ways)
}
defaultLogFlags :: LogFlags
log_dopt :: DumpFlag -> LogFlags -> Bool
log_set_dopt :: DumpFlag -> LogFlags -> LogFlags
setLogFlags :: Logger -> LogFlags -> Logger
updateLogFlags :: Logger -> (LogFlags -> LogFlags) -> Logger
logFlags :: Logger -> LogFlags
logHasDumpFlag :: Logger -> DumpFlag -> Bool
logVerbAtLeast :: Logger -> Int -> Bool
putLogMsg :: Logger -> LogAction
defaultLogAction :: LogAction
defaultLogJsonAction :: LogJsonAction
defaultLogActionHPrintDoc :: LogFlags -> Bool -> Handle -> SDoc -> IO ()
defaultLogActionHPutStrDoc :: LogFlags -> Bool -> Handle -> SDoc -> IO ()
logMsg :: Logger -> MessageClass -> SrcSpan -> SDoc -> IO ()
logJsonMsg :: ToJson a => Logger -> MessageClass -> a -> IO ()
logDumpMsg :: Logger -> String -> SDoc -> IO ()
defaultDumpAction :: DumpCache -> LogAction -> DumpAction
putDumpFile :: Logger -> DumpAction
putDumpFileMaybe :: Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
putDumpFileMaybe' :: Logger -> NamePprCtx -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
withDumpFileHandle :: DumpCache -> LogFlags -> DumpFlag -> (Maybe Handle -> IO ()) -> IO ()
touchDumpFile :: Logger -> DumpFlag -> IO ()
logDumpFile :: Logger -> PprStyle -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
defaultTraceAction :: TraceAction a
putTraceMsg :: Logger -> TraceAction a
loggerTraceFlushUpdate :: Logger -> (IO () -> IO ()) -> Logger
loggerTraceFlush :: Logger -> IO ()
logTraceMsg :: Logger -> String -> SDoc -> a -> a

Documentation

data Logger Source #

class HasLogger (m :: Type -> Type) where Source #

Methods

getLogger :: m Logger Source #

Instances

Instances details

HasLogger LlvmM Source #
Instance details Defined in GHC.CmmToLlvm.Base Methods getLogger :: LlvmM Logger Source #
HasLogger CoreM Source #
Instance details Defined in GHC.Core.Opt.Monad Methods getLogger :: CoreM Logger Source #
HasLogger SimplM Source #
Instance details Defined in GHC.Core.Opt.Simplify.Monad Methods getLogger :: SimplM Logger Source #
HasLogger Hsc Source #
Instance details Defined in GHC.Driver.Env.Types Methods getLogger :: Hsc Logger Source #
HasLogger Ghc Source #
Instance details Defined in GHC.Driver.Monad Methods getLogger :: Ghc Logger Source #
ContainsLogger env => HasLogger (IOEnv env) Source #
Instance details Defined in GHC.Data.IOEnv Methods getLogger :: IOEnv env Logger Source #
MonadIO m => HasLogger (GhcT m) Source #
Instance details Defined in GHC.Driver.Monad Methods getLogger :: GhcT m Logger Source #

class ContainsLogger t where Source #

Methods

extractLogger :: t -> Logger Source #

Instances

Instances details

ContainsLogger (Env gbl lcl) Source #
Instance details Defined in GHC.Tc.Types Methods extractLogger :: Env gbl lcl -> Logger Source #

Logger setup

initLogger :: IO Logger Source #

type LogAction = LogFlags -> MessageClass -> SrcSpan -> SDoc -> IO () Source #

type LogJsonAction = LogFlags -> MessageClass -> JsonDoc -> IO () Source #

type DumpAction = LogFlags -> PprStyle -> DumpFlag -> String -> DumpFormat -> SDoc -> IO () Source #

type TraceAction a = LogFlags -> String -> SDoc -> a -> a Source #

data DumpFormat Source #

Format of a dump

Dump formats are loosely defined: dumps may contain various additional headers and annotations and they may be partial. DumpFormat is mainly a hint (e.g. for syntax highlighters).

Constructors

FormatHaskell	Haskell
FormatCore	Core
FormatSTG	STG
FormatByteCode	ByteCode
FormatCMM	Cmm
FormatASM	Assembly code
FormatC	C code/header
FormatLLVM	LLVM bytecode
FormatJS	JavaScript code
FormatText	Unstructured dump

Instances

Instances details

Show DumpFormat Source #
Instance details Defined in GHC.Utils.Logger Methods showsPrec :: Int -> DumpFormat -> ShowS # show :: DumpFormat -> String # showList :: [DumpFormat] -> ShowS #
Eq DumpFormat Source #
Instance details Defined in GHC.Utils.Logger Methods (==) :: DumpFormat -> DumpFormat -> Bool # (/=) :: DumpFormat -> DumpFormat -> Bool #