Development.IDE.Types.Logger

This is a compatibility module that abstracts over the concrete choice of logging framework so users can plug in whatever framework they want to.

Documentation

data Priority

Constructors

Debug

Verbose debug logging.

Info

Useful information in case an error has to be understood.

Warning

These error messages should not occur in a expected usage, and should be investigated.

Error

Such log messages must never occur in expected usage.

Instances

Bounded Priority

Defined in Development.IDE.Types.Logger

Methods

minBound :: Priority

maxBound :: Priority

Enum Priority

Defined in Development.IDE.Types.Logger

Methods

succ :: Priority -> Priority

pred :: Priority -> Priority

toEnum :: Int -> Priority

fromEnum :: Priority -> Int

enumFrom :: Priority -> [Priority]

enumFromThen :: Priority -> Priority -> [Priority]

enumFromTo :: Priority -> Priority -> [Priority]

enumFromThenTo :: Priority -> Priority -> Priority -> [Priority]

Eq Priority

Defined in Development.IDE.Types.Logger

Methods

(==) :: Priority -> Priority -> Bool

(/=) :: Priority -> Priority -> Bool

Ord Priority

Defined in Development.IDE.Types.Logger

Methods

compare :: Priority -> Priority -> Ordering

(<) :: Priority -> Priority -> Bool

(<=) :: Priority -> Priority -> Bool

(>) :: Priority -> Priority -> Bool

(>=) :: Priority -> Priority -> Bool

max :: Priority -> Priority -> Priority

min :: Priority -> Priority -> Priority

Show Priority

Defined in Development.IDE.Types.Logger

Methods

showsPrec :: Int -> Priority -> ShowS

show :: Priority -> String

showList :: [Priority] -> ShowS

newtype Logger

Note that this is logging actions _of the program_, not of the user. You shouldn't call warning/error if the user has caused an error, only if our code has gone wrong and is itself erroneous (e.g. we threw an exception).

Constructors

Logger

Fields

• logPriority :: Priority -> Text -> IO ()

Instances

Semigroup Logger

Defined in Development.IDE.Types.Logger

Methods

(<>) :: Logger -> Logger -> Logger

sconcat :: NonEmpty Logger -> Logger

stimes :: Integral b => b -> Logger -> Logger

Monoid Logger

Defined in Development.IDE.Types.Logger

Methods

mempty :: Logger

mappend :: Logger -> Logger -> Logger

mconcat :: [Logger] -> Logger

newtype Recorder msg

Note that this is logging actions _of the program_, not of the user. You shouldn't call warning/error if the user has caused an error, only if our code has gone wrong and is itself erroneous (e.g. we threw an exception).

Constructors

Recorder

Fields

• logger_ :: forall m. MonadIO m => msg -> m ()

Instances

Contravariant Recorder

Defined in Development.IDE.Types.Logger

Methods

contramap :: (a -> b) -> Recorder b -> Recorder a

(>$) :: b -> Recorder b -> Recorder a

Semigroup (Recorder msg)

Defined in Development.IDE.Types.Logger

Methods

(<>) :: Recorder msg -> Recorder msg -> Recorder msg

sconcat :: NonEmpty (Recorder msg) -> Recorder msg

stimes :: Integral b => b -> Recorder msg -> Recorder msg

Monoid (Recorder msg)

Defined in Development.IDE.Types.Logger

Methods

mempty :: Recorder msg

mappend :: Recorder msg -> Recorder msg -> Recorder msg

mconcat :: [Recorder msg] -> Recorder msg

logError :: Logger -> Text -> IO ()

logWarning :: Logger -> Text -> IO ()

logInfo :: Logger -> Text -> IO ()

logDebug :: Logger -> Text -> IO ()

noLogging :: Logger

data WithPriority a

Constructors

WithPriority

Fields

• priority :: Priority
• callStack_ :: CallStack
• payload :: a

Instances

Functor WithPriority

Defined in Development.IDE.Types.Logger

Methods

fmap :: (a -> b) -> WithPriority a -> WithPriority b

(<$) :: a -> WithPriority b -> WithPriority a

logWith :: (HasCallStack, MonadIO m) => Recorder (WithPriority msg) -> Priority -> msg -> m ()

cmap :: (a -> b) -> Recorder b -> Recorder a

cmapIO :: (a -> IO b) -> Recorder b -> Recorder a

cfilter :: (a -> Bool) -> Recorder a -> Recorder a

withDefaultRecorder

Arguments

:: MonadUnliftIO m

=> Maybe FilePath

Log file path. Nothing uses stderr

-> Maybe [LoggingColumn]

logging columns to display. Nothing uses defaultLoggingColumns

-> Priority

min priority for hslogger compatibility

-> (Recorder (WithPriority (Doc d)) -> m a)

action given a recorder

-> m a

If no path given then use stderr, otherwise use file. Kinda complicated because we also need to setup hslogger for `hie-bios` log compatibility reasons. If `hie-bios` can be set to use our logger instead or if `hie-bios` doesn't use hslogger then hslogger can be removed completely. See setupHsLogger comment.

makeDefaultStderrRecorder :: MonadIO m => Maybe [LoggingColumn] -> Priority -> m (Recorder (WithPriority (Doc a)))

Priority is actually for hslogger compatibility

priorityToHsLoggerPriority :: Priority -> Priority

data LoggingColumn

Constructors

TimeColumn

ThreadIdColumn

PriorityColumn

DataColumn

SourceLocColumn

cmapWithPrio :: (a -> b) -> Recorder (WithPriority b) -> Recorder (WithPriority a)

withBacklog :: (v -> Recorder a) -> IO (Recorder a, v -> IO ())

Given a Recorder that requires an argument, produces a Recorder that queues up messages until the argument is provided using the callback, at which point it sends the backlog and begins functioning normally.

lspClientMessageRecorder :: LanguageContextEnv config -> Recorder (WithPriority Text)

Creates a recorder that sends logs to the LSP client via window/showMessage notifications.

lspClientLogRecorder :: LanguageContextEnv config -> Recorder (WithPriority Text)

Creates a recorder that sends logs to the LSP client via window/logMessage notifications.

module Prettyprinter

renderStrict :: SimpleDocStream ann -> Text

(renderStrict sdoc) takes the output sdoc from a rendering function and transforms it to strict text.