opaque Lean.diagnostics : Lean.Option Bool

opaque Lean.diagnostics.threshold : Lean.Option Nat

opaque Lean.maxHeartbeats : Lean.Option Nat

opaque Lean.Elab.async : Lean.Option Bool

def Lean.useDiagnosticMsg : MessageData

If the diagnostics option is not already set, gives a message explaining this option. Begins with a \n, so an error message can look like m!"some error occurred{useDiagnosticMsg}".

Equations

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

def Lean.Core.getMaxHeartbeats (opts : Options) : Nat

Equations

• Lean.Core.getMaxHeartbeats opts = Lean.Option.get opts Lean.maxHeartbeats * 1000

@[reducible, inline]

abbrev Lean.Core.InstantiateLevelCache : Type

Equations

• Lean.Core.InstantiateLevelCache = Lean.PersistentHashMap Lean.Name (List Lean.Level × Lean.Expr)

structure Lean.Core.Cache : Type

Cache for the CoreM monad

• instLevelType : InstantiateLevelCache
• instLevelValue : InstantiateLevelCache

Instances For

• Lean.Core.instInhabitedCache

instance Lean.Core.instInhabitedCache : Inhabited Cache

Equations

• Lean.Core.instInhabitedCache = { default := { instLevelType := default, instLevelValue := default } }

structure Lean.Core.State : Type

State for the CoreM monad.

• env : Environment

  Current environment.

• nextMacroScope : MacroScope

  Next macro scope. We use macro scopes to avoid accidental name capture.

• ngen : NameGenerator

  Name generator for producing unique FVarIds, MVarIds, and LMVarIds

• traceState : TraceState

  Trace messages

• cache : Cache

  Cache for instantiating universe polymorphic declarations.

• messages : MessageLog

  Message log.

• infoState : Elab.InfoState

  Info tree. We have the info tree here because we want to update it while adding attributes.

• snapshotTasks : Array (Language.SnapshotTask Language.SnapshotTree)

  Snapshot trees of asynchronous subtasks. As these are untyped and reported only at the end of the command's main elaboration thread, they are only useful for basic message log reporting; for incremental reporting and reuse within a long-running elaboration thread, types rooted in CommandParsedSnapshot need to be adjusted.

Instances For

• Lean.Core.instNonemptyState

instance Lean.Core.instNonemptyState : Nonempty State

structure Lean.Core.Context : Type

Context for the CoreM monad.

• fileName : String

  Name of the file being compiled.

• fileMap : FileMap

  Auxiliary datastructure for converting String.Pos into Line/Column number.

• options : Options
• currRecDepth : Nat
• maxRecDepth : Nat
• ref : Syntax
• currNamespace : Name
• openDecls : List OpenDecl
• initHeartbeats : Nat
• maxHeartbeats : Nat
• currMacroScope : MacroScope
• diag : Bool

  If diag := true, different parts of the system collect diagnostics. Use the set_option diag true to set it to true.

• cancelTk? : Option IO.CancelToken

  If set, used to cancel elaboration from outside when results are not needed anymore.

• suppressElabErrors : Bool

  If set (when showPartialSyntaxErrors is not set and parsing failed), suppresses most elaboration errors; see also logMessage below.

Instances For

• Lean.Core.instNonemptyContext

instance Lean.Core.instNonemptyContext : Nonempty Context

@[reducible, inline]

abbrev Lean.Core.CoreM (α : Type) : Type

CoreM is a monad for manipulating the Lean environment. It is the base monad for MetaM. The main features it provides are:

• name generator state
• environment state
• Lean options context
• the current open namespace

Equations

• Lean.CoreM = ReaderT Lean.Core.Context (StateRefT' IO.RealWorld Lean.Core.State (EIO Lean.Exception))

Instances For

• Lean.Core.instAddMessageContextCoreM
• Lean.Core.instInhabitedCoreM
• Lean.Core.instMonadCoreM
• Lean.Core.instMonadEnvCoreM
• Lean.Core.instMonadInfoTreeCoreM
• Lean.Core.instMonadLiftIOCoreM
• Lean.Core.instMonadLogCoreM
• Lean.Core.instMonadNameGeneratorCoreM
• Lean.Core.instMonadOptionsCoreM
• Lean.Core.instMonadQuotationCoreM
• Lean.Core.instMonadRecDepthCoreM
• Lean.Core.instMonadRefCoreM
• Lean.Core.instMonadResolveNameCoreM
• Lean.Core.instMonadTraceCoreM
• Lean.Core.instMonadWithOptionsCoreM
• Lean.instMonadExceptOfExceptionCoreM
• Lean.instMonadRuntimeExceptionCoreM
• ProofWidgets.instHtmlEvalCoreMHtml
• instLawfulMonadCoreM_batteries
• instMonadSatisfyingCoreM

@[always_inline]

instance Lean.Core.instMonadCoreM : Monad CoreM

Equations

• Lean.Core.instMonadCoreM = Monad.mk

instance Lean.Core.instInhabitedCoreM {α : Type} : Inhabited (CoreM α)

Equations

• Lean.Core.instInhabitedCoreM = { default := fun (x : Lean.Core.Context) (x : ST.Ref IO.RealWorld Lean.Core.State) => throw default }

instance Lean.Core.instMonadRefCoreM : MonadRef CoreM

Equations

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

instance Lean.Core.instMonadEnvCoreM : MonadEnv CoreM

Equations

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

instance Lean.Core.instMonadOptionsCoreM : MonadOptions CoreM

Equations

• Lean.Core.instMonadOptionsCoreM = { getOptions := do let __do_lift ← read pure __do_lift.options }

instance Lean.Core.instMonadWithOptionsCoreM : MonadWithOptions CoreM

Equations

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

instance Lean.Core.instAddMessageContextCoreM : AddMessageContext CoreM

Equations

• Lean.Core.instAddMessageContextCoreM = { addMessageContext := Lean.addMessageContextPartial }

instance Lean.Core.instMonadNameGeneratorCoreM : MonadNameGenerator CoreM

Equations

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

instance Lean.Core.instMonadRecDepthCoreM : MonadRecDepth CoreM

Equations

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

instance Lean.Core.instMonadResolveNameCoreM : MonadResolveName CoreM

Equations

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

def Lean.Core.withFreshMacroScope {α : Type} (x : CoreM α) : CoreM α

Equations

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

instance Lean.Core.instMonadQuotationCoreM : MonadQuotation CoreM

Equations

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

instance Lean.Core.instMonadInfoTreeCoreM : Elab.MonadInfoTree CoreM

Equations

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

@[inline]

def Lean.Core.modifyCache (f : Cache → Cache) : CoreM Unit

Equations

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

@[inline]

def Lean.Core.modifyInstLevelTypeCache (f : InstantiateLevelCache → InstantiateLevelCache) : CoreM Unit

Equations

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

@[inline]

def Lean.Core.modifyInstLevelValueCache (f : InstantiateLevelCache → InstantiateLevelCache) : CoreM Unit

Equations

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

def Lean.Core.instantiateTypeLevelParams (c : ConstantInfo) (us : List Level) : CoreM Expr

Equations

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

def Lean.Core.instantiateValueLevelParams (c : ConstantInfo) (us : List Level) : CoreM Expr

Equations

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

@[inline]

def Lean.Core.liftIOCore {α : Type} (x : IO α) : CoreM α

Equations

• Lean.Core.liftIOCore x = do let ref ← Lean.getRef liftM (IO.toEIO (fun (err : IO.Error) => Lean.Exception.error ref ((Lean.MessageData.ofFormat ∘ Std.format) (toString err))) x)

instance Lean.Core.instMonadLiftIOCoreM : MonadLift IO CoreM

Equations

• Lean.Core.instMonadLiftIOCoreM = { monadLift := fun {α : Type} => Lean.Core.liftIOCore }

instance Lean.Core.instMonadTraceCoreM : MonadTrace CoreM

Equations

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

structure Lean.Core.SavedStateextends Lean.Core.State : Type

• env : Environment
• nextMacroScope : MacroScope
• ngen : NameGenerator
• traceState : TraceState
• cache : Cache
• messages : MessageLog
• infoState : Elab.InfoState
• snapshotTasks : Array (Language.SnapshotTask Language.SnapshotTree)
• passedHeartbeats : Nat

  Number of heartbeats passed inside withRestoreOrSaveFull, not used otherwise.

Instances For

• Lean.Core.instNonemptySavedState

instance Lean.Core.instNonemptySavedState : Nonempty SavedState

def Lean.Core.saveState : CoreM SavedState

Equations

• Lean.Core.saveState = do let s ← get pure { toState := s, passedHeartbeats := 0 }

@[specialize #[]]

def Lean.Core.withRestoreOrSaveFull {α : Type} (reusableResult? : Option (α × SavedState)) (act : CoreM α) : CoreM (α × SavedState)

Incremental reuse primitive: if reusableResult? is none, runs act and returns its result together with the saved monadic state after act including the heartbeats used by it. If reusableResult? on the other hand is some (a, state), restores full state including heartbeats used and returns (a, state).

The intention is for steps that support incremental reuse to initially pass none as reusableResult? and store the result and state in a snapshot. In a further run, if reuse is possible, reusableResult? should be set to the previous result and state, ensuring that the state after running withRestoreOrSaveFull is identical in both runs. Note however that necessarily this is only an approximation in the case of heartbeats as heartbeats used by withRestoreOrSaveFull itself after calling act as well as by reuse-handling code such as the one supplying reusableResult? are not accounted for.

Equations

• One or more equations did not get rendered due to their size.
• Lean.Core.withRestoreOrSaveFull (some (val, state)) act = do set state.toState liftM (IO.addHeartbeats state.passedHeartbeats.toUInt64) pure (val, state)

def Lean.Core.SavedState.restore (b : SavedState) : CoreM Unit

Restore backtrackable parts of the state.

Equations

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

def Lean.Core.mkFreshUserName (n : Name) : CoreM Name

Equations

• Lean.mkFreshUserName n = Lean.Core.mkFreshNameImp✝ n

@[inline]

def Lean.Core.CoreM.run {α : Type} (x : CoreM α) (ctx : Context) (s : State) : EIO Exception (α × State)

Equations

• x.run ctx s = (Lean.Core.withConsistentCtx✝ x ctx).run s

@[inline]

def Lean.Core.CoreM.run' {α : Type} (x : CoreM α) (ctx : Context) (s : State) : EIO Exception α

Equations

• x.run' ctx s = Prod.fst <$> x.run ctx s

@[inline]

def Lean.Core.CoreM.toIO {α : Type} (x : CoreM α) (ctx : Context) (s : State) : IO (α × State)

Equations

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

def Lean.Core.withIncRecDepth {m : Type → Type u_1} {α : Type} [Monad m] [MonadControlT CoreM m] (x : m α) : m α

Equations

• Lean.Core.withIncRecDepth x = controlAt Lean.CoreM fun (runInBase : {β : Type} → m β → Lean.CoreM (stM Lean.CoreM m β)) => Lean.withIncRecDepth (runInBase x)

opaque Lean.Core.interruptExceptionId : InternalExceptionId

@[inline]

def Lean.Core.checkInterrupted : CoreM Unit

Throws an internal interrupt exception if cancellation has been requested. The exception is not caught by try catch but is intended to be caught by Command.withLoggingExceptions at the top level of elaboration. In particular, we want to skip producing further incremental snapshots after the exception has been thrown.

Equations

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

opaque Lean.Core.debug.moduleNameAtTimeout : Lean.Option Bool

def Lean.Core.throwMaxHeartbeat (moduleName optionName : Name) (max : Nat) : CoreM Unit

Equations

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

def Lean.Core.checkMaxHeartbeatsCore (moduleName : String) (optionName : Name) (max : Nat) : CoreM Unit

Equations

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

def Lean.Core.checkMaxHeartbeats (moduleName : String) : CoreM Unit

Equations

• Lean.Core.checkMaxHeartbeats moduleName = do let __do_lift ← read Lean.Core.checkMaxHeartbeatsCore moduleName `maxHeartbeats __do_lift.maxHeartbeats

def Lean.Core.checkSystem (moduleName : String) : CoreM Unit

Equations

• Lean.checkSystem moduleName = do Lean.Core.checkInterrupted Lean.Core.checkMaxHeartbeats moduleName

def Lean.Core.withCurrHeartbeats {m : Type → Type u_1} {α : Type} [Monad m] [MonadControlT CoreM m] (x : m α) : m α

Equations

• Lean.withCurrHeartbeats x = controlAt Lean.CoreM fun (runInBase : {β : Type} → m β → Lean.CoreM (stM Lean.CoreM m β)) => Lean.Core.withCurrHeartbeatsImp✝ (runInBase x)

def Lean.Core.setMessageLog (messages : MessageLog) : CoreM Unit

Equations

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

def Lean.Core.resetMessageLog : CoreM Unit

Equations

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

def Lean.Core.getMessageLog : CoreM MessageLog

Equations

• Lean.Core.getMessageLog = do let __do_lift ← get pure __do_lift.messages

def Lean.Core.getAndEmptyMessageLog : CoreM MessageLog

Returns the current log and then resets its messages while adjusting MessageLog.hadErrors. Used for incremental reporting during elaboration of a single command.

Equations

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

instance Lean.Core.instMonadLogCoreM : MonadLog CoreM

Equations

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

def Lean.Core.logSnapshotTask (task : Language.SnapshotTask Language.SnapshotTree) : CoreM Unit

Includes a given task (such as from wrapAsyncAsSnapshot) in the overall snapshot tree for this command's elaboration, making its result available to reporting and the language server. The reporter will not know about this snapshot tree node until the main elaboration thread for this command has finished so this function is not useful for incremental reporting within a longer elaboration thread but only for tasks that outlive it such as background kernel checking or proof elaboration.

Equations

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

def Lean.Core.wrapAsync {α : Type} (act : Unit → CoreM α) : CoreM (EIO Exception α)

Wraps the given action for use in EIO.asTask etc., discarding its final monadic state.

Equations

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

opaque Lean.Core.stderrAsMessages : Lean.Option Bool

Option for capturing output to stderr during elaboration.

def Lean.Core.wrapAsyncAsSnapshot (act : Unit → CoreM Unit) (desc : String := by exact decl_name%.toString) : CoreM (BaseIO Language.SnapshotTree)

Wraps the given action for use in BaseIO.asTask etc., discarding its final state except for logSnapshotTask tasks, which are reported as part of the returned tree.

Equations

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

@[inline]

def Lean.withAtLeastMaxRecDepth {m : Type → Type u_1} {α : Type} [MonadFunctorT CoreM m] (max : Nat) : m α → m α

Equations

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

@[inline]

def Lean.catchInternalId {m : Type u_1 → Type u_2} {α : Type u_1} [Monad m] [MonadExcept Exception m] (id : InternalExceptionId) (x : m α) (h : Exception → m α) : m α

Equations

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

@[inline]

def Lean.catchInternalIds {m : Type u_1 → Type u_2} {α : Type u_1} [Monad m] [MonadExcept Exception m] (ids : List InternalExceptionId) (x : m α) (h : Exception → m α) : m α

Equations

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

def Lean.Exception.isMaxHeartbeat (ex : Exception) : Bool

Return true if ex was generated by throwMaxHeartbeat. This function is a bit hackish. The heartbeat exception should probably be an internal exception. We used a similar hack at Exception.isMaxRecDepth

Equations

• (Lean.Exception.error ref (Lean.MessageData.tagged `runtime.maxHeartbeats a)).isMaxHeartbeat = true
• ex.isMaxHeartbeat = false

def Lean.mkArrow (d b : Expr) : CoreM Expr

Creates the expression d → b

Equations

• Lean.mkArrow d b = do let __do_lift ← Lean.mkFreshUserName `x pure (Lean.mkForall __do_lift Lean.BinderInfo.default d b)

def Lean.mkArrowN (ds : Array Expr) (e : Expr) : CoreM Expr

Iterated mkArrow, creates the expression a₁ → a₂ → … → aₙ → b. Also see arrowDomainsN.

Equations

• Lean.mkArrowN ds e = Array.foldrM Lean.mkArrow e ds

opaque Lean.compiler.enableNew : Lean.Option Bool

@[extern lean_lcnf_compile_decls]

opaque Lean.compileDeclsNew (declNames : List Name) : CoreM Unit

@[extern lean_compile_decls]

opaque Lean.compileDeclsOld (env : Environment) (opt : Options) (decls : List Name) : Except Kernel.Exception Environment

def Lean.compileDecl (decl : Declaration) : CoreM Unit

Equations

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

def Lean.compileDecls (decls : List Name) : CoreM Unit

Equations

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

def Lean.getDiag (opts : Options) : Bool

Equations

• Lean.getDiag opts = Lean.Option.get opts Lean.diagnostics

def Lean.isDiagnosticsEnabled : CoreM Bool

Return true if diagnostic information collection is enabled.

Equations

• Lean.isDiagnosticsEnabled = do let __do_lift ← read pure __do_lift.diag

def Lean.ImportM.runCoreM {α : Type} (x : CoreM α) : ImportM α

Equations

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

def Lean.Exception.isRuntime (ex : Exception) : Bool

Return true if the exception was generated by one of our resource limits.

Equations

• ex.isRuntime = (ex.isMaxHeartbeat || ex.isMaxRecDepth)

def Lean.Exception.isInterrupt : Exception → Bool

Returns true if the exception is an interrupt generated by checkInterrupted.

Equations

• (Lean.Exception.internal id extra).isInterrupt = (id == Lean.Core.interruptExceptionId)
• x✝.isInterrupt = false

@[inline]

def Lean.Core.tryCatch {α : Type} (x : CoreM α) (h : Exception → CoreM α) : CoreM α

Custom try-catch for all monads based on CoreM. We usually don't want to catch "runtime exceptions" these monads, but on CommandElabM or, in specific cases, using tryCatchRuntimeEx. See issues #2775 and #2744 as well as MonadAlwaysExcept. Also, we never want to catch interrupt exceptions inside the elaborator.

Equations

• Lean.Core.tryCatch x h = tryCatch x fun (ex : Lean.Exception) => if (ex.isInterrupt || ex.isRuntime) = true then throw ex else h ex

@[inline]

def Lean.Core.tryCatchRuntimeEx {α : Type} (x : CoreM α) (h : Exception → CoreM α) : CoreM α

A variant of tryCatch that also catches runtime exception (see also tryCatch documentation). Like tryCatch, this function does not catch interrupt exceptions, which are not considered runtime exceptions.

Equations

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

instance Lean.instMonadExceptOfExceptionCoreM : MonadExceptOf Exception CoreM

Equations

• Lean.instMonadExceptOfExceptionCoreM = { throw := fun {α : Type} => throw, tryCatch := fun {α : Type} => Lean.Core.tryCatch }

class Lean.MonadRuntimeException (m : Type → Type) : Type 1

• tryCatchRuntimeEx {α : Type} (body : m α) (handler : Exception → m α) : m α

Instances

• Lean.instMonadRuntimeExceptionCoreM
• Lean.instMonadRuntimeExceptionReaderT
• Lean.instMonadRuntimeExceptionStateRefT'

instance Lean.instMonadRuntimeExceptionCoreM : MonadRuntimeException CoreM

Equations

• Lean.instMonadRuntimeExceptionCoreM = { tryCatchRuntimeEx := fun {α : Type} => Lean.Core.tryCatchRuntimeEx }

@[inline]

instance Lean.instMonadRuntimeExceptionReaderT {m : Type → Type} {ρ : Type} [MonadRuntimeException m] : MonadRuntimeException (ReaderT ρ m)

Equations

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

@[inline]

instance Lean.instMonadRuntimeExceptionStateRefT' {m : Type → Type} {ω σ : Type} [MonadRuntimeException m] : MonadRuntimeException (StateRefT' ω σ m)

Equations

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

@[inline]

def Lean.mapCoreM {m : Type → Type u_1} [MonadControlT CoreM m] [Monad m] (f : {α : Type} → CoreM α → CoreM α) {α : Type} (x : m α) : m α

Equations

• Lean.mapCoreM f x = controlAt Lean.CoreM fun (runInBase : {β : Type} → m β → Lean.CoreM (stM Lean.CoreM m β)) => f (runInBase x)

def Lean.logMessageKind (kind : Name) : CoreM Bool

Returns true if the given message kind has not been reported in the message log, and then mark it as logged. Otherwise, returns false. We use this API to ensure we don't log the same kind of warning multiple times.

Equations

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