class Lean.MonadLog (m : Type → Type) extends Lean.MonadFileMap m : Type

The MonadLog interface for logging error messages.

• getFileMap : m FileMap
• getRef : m Syntax

  Return the current reference syntax being used to provide position information.

• getFileName : m String

  The name of the file being processed.

• hasErrors : m Bool

  Return true if errors have been logged.

• logMessage : Message → m Unit

  Log a new message.

instance Lean.instMonadLogOfMonadLift (m n : Type → Type) [MonadLift m n] [MonadLog m] : MonadLog n

def Lean.getRefPos {m : Type → Type} [Monad m] [MonadLog m] : m String.Pos

Return the position (as String.pos) associated with the current reference syntax (i.e., the syntax object returned by getRef.)

def Lean.getRefPosition {m : Type → Type} [Monad m] [MonadLog m] : m Position

Return the line and column numbers associated with the current reference syntax (i.e., the syntax object returned by getRef.)

opaque Lean.warningAsError : Lean.Option Bool

If warningAsError is set to true, then warning messages are treated as errors.

def Lean.errorDescriptionWidget : Widget.Module

A widget for displaying error names and explanation links.

def Lean.logAt {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (ref : Syntax) (msgData : MessageData) (severity : MessageSeverity := MessageSeverity.error) (isSilent : Bool := false) : m Unit

Log the message msgData at the position provided by ref with the given severity. If getRef has position information but ref does not, we use getRef. We use the fileMap to find the line and column numbers for the error message.

def Lean.logErrorAt {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (ref : Syntax) (msgData : MessageData) : m Unit

Log a new error message using the given message data. The position is provided by ref.

def Lean.logNamedErrorAt {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (ref : Syntax) (name : Name) (msgData : MessageData) : m Unit

Log a named error message using the given message data. The position is provided by ref.

Note: Use the macro logNamedErrorAt, which validates error names, instead of calling this function directly.

def Lean.logWarningAt {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (ref : Syntax) (msgData : MessageData) : m Unit

Log a new warning message using the given message data. The position is provided by ref.

def Lean.logNamedWarningAt {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (ref : Syntax) (name : Name) (msgData : MessageData) : m Unit

Log a named error warning using the given message data. The position is provided by ref.

Note: Use the macro logNamedWarningAt, which validates error names, instead of calling this function directly.

def Lean.logInfoAt {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (ref : Syntax) (msgData : MessageData) : m Unit

Log a new information message using the given message data. The position is provided by ref.

def Lean.log {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (msgData : MessageData) (severity : MessageSeverity := MessageSeverity.error) (isSilent : Bool := false) : m Unit

Log a new error/warning/information message using the given message data and severity. The position is provided by getRef.

def Lean.logError {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (msgData : MessageData) : m Unit

Log a new error message using the given message data. The position is provided by getRef.

def Lean.logNamedError {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (name : Name) (msgData : MessageData) : m Unit

Log a named error message using the given message data. The position is provided by getRef.

Note: Use the macro logNamedError, which validates error names, instead of calling this function directly.

def Lean.logWarning {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (msgData : MessageData) : m Unit

Log a new warning message using the given message data. The position is provided by getRef.

def Lean.logNamedWarning {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (name : Name) (msgData : MessageData) : m Unit

Log a named warning using the given message data. The position is provided by getRef.

Note: Use the macro logNamedWarning, which validates error names, instead of calling this function directly.

def Lean.logInfo {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (msgData : MessageData) : m Unit

Log a new information message using the given message data. The position is provided by getRef.

def Lean.logUnknownDecl {m : Type → Type} [Monad m] [MonadLog m] [AddMessageContext m] [MonadOptions m] (declName : Name) : m Unit

Log the error message "unknown declaration"