Documentation

Lean.Log

class Lean.MonadLog (m : TypeType) extends Lean.MonadFileMap :

The MonadLog interface for logging error messages.

  • getFileMap : m Lean.FileMap
  • getRef : m Lean.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 : Lean.Messagem Unit

    Log a new message.

Instances
    instance Lean.instMonadLog (m : TypeType) (n : TypeType) [MonadLift m n] [Lean.MonadLog m] :
    Equations

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

    Equations
    Instances For

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

      Equations
      Instances For

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

        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.

        Equations
        • One or more equations did not get rendered due to their size.
        Instances For

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

          Equations
          Instances For

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

            Equations
            Instances For

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

              Equations
              Instances For

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

                Equations
                • Lean.log msgData severity = do let ref ← Lean.MonadLog.getRef Lean.logAt ref msgData severity
                Instances For

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

                  Equations
                  Instances For

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

                    Equations
                    • One or more equations did not get rendered due to their size.
                    Instances For

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

                      Equations
                      Instances For

                        Log the error message "unknown declaration"

                        Equations
                        Instances For