| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
GHC.Utils.Trace
Description
Tracing utilities
Synopsis
- pprTrace :: String -> SDoc -> a -> a
- pprTraceM :: Applicative f => String -> SDoc -> f ()
- pprTraceDebug :: String -> SDoc -> a -> a
- pprTraceIt :: Outputable a => String -> a -> a
- pprTraceWith :: String -> (a -> SDoc) -> a -> a
- pprSTrace :: HasCallStack => SDoc -> a -> a
- pprTraceException :: ExceptionMonad m => String -> SDoc -> m a -> m a
- warnPprTrace :: HasCallStack => Bool -> String -> SDoc -> a -> a
- warnPprTraceM :: (Applicative f, HasCallStack) => Bool -> String -> SDoc -> f ()
- pprTraceUserWarning :: HasCallStack => SDoc -> a -> a
- trace :: String -> a -> a
Documentation
pprTraceDebug :: String -> SDoc -> a -> a Source #
pprTraceIt :: Outputable a => String -> a -> a Source #
pprTraceIt desc x is equivalent to pprTrace desc (ppr x) x
pprTraceWith :: String -> (a -> SDoc) -> a -> a Source #
pprTraceWith desc f x is equivalent to pprTrace desc (f x) x.
This allows you to print details from the returned value as well as from
ambient variables.
pprSTrace :: HasCallStack => SDoc -> a -> a Source #
If debug output is on, show some SDoc on the screen along
with a call stack when available.
pprTraceException :: ExceptionMonad m => String -> SDoc -> m a -> m a Source #
pprTraceException desc x action runs action, printing a message
if it throws an exception.
warnPprTrace :: HasCallStack => Bool -> String -> SDoc -> a -> a Source #
Just warn about an assertion failure, recording the given file and line number.
warnPprTraceM :: (Applicative f, HasCallStack) => Bool -> String -> SDoc -> f () Source #
pprTraceUserWarning :: HasCallStack => SDoc -> a -> a Source #
For when we want to show the user a non-fatal WARNING so that they can report a GHC bug, but don't want to panic.