structure Lean.Elab.Term.SavedContext : Type

• declName? : Option Lake.Name
• options : Lean.Options
• openDecls : List Lean.OpenDecl
• macroStack : Lean.Elab.MacroStack
• errToSorry : Bool
• levelNames : List Lake.Name

Saved context for postponed terms and tactics to be executed.

inductive Lean.Elab.Term.SyntheticMVarKind : Type

• typeClass: Lean.Elab.Term.SyntheticMVarKind

  Use typeclass resolution to synthesize value for metavariable.

• coe: Option String → Lean.Expr → Lean.Expr → Option Lean.Expr → Lean.Elab.Term.SyntheticMVarKind

  Use coercion to synthesize value for the metavariable. if f? is some f, we produce an application type mismatch error message. Otherwise, if header? is some header, we generate the error (header ++ "has type" ++ eType ++ "but it is expected to have type" ++ expectedType) Otherwise, we generate the error ("type mismatch" ++ e ++ "has type" ++ eType ++ "but it is expected to have type" ++ expectedType)

• tactic: Lean.Syntax → Lean.Elab.Term.SavedContext → Lean.Elab.Term.SyntheticMVarKind

  Use tactic to synthesize value for metavariable.

• postponed: Lean.Elab.Term.SavedContext → Lean.Elab.Term.SyntheticMVarKind

  Metavariable represents a hole whose elaboration has been postponed.

We use synthetic metavariables as placeholders for pending elaboration steps.

instance Lean.Elab.Term.instInhabitedSyntheticMVarKind : Inhabited Lean.Elab.Term.SyntheticMVarKind

instance Lean.Elab.Term.instToStringSyntheticMVarKind : ToString Lean.Elab.Term.SyntheticMVarKind

structure Lean.Elab.Term.SyntheticMVarDecl : Type

• stx : Lean.Syntax
• kind : Lean.Elab.Term.SyntheticMVarKind

instance Lean.Elab.Term.instInhabitedSyntheticMVarDecl : Inhabited Lean.Elab.Term.SyntheticMVarDecl

inductive Lean.Elab.Term.MVarErrorKind : Type

• implicitArg: Lean.Expr → Lean.Elab.Term.MVarErrorKind

  Metavariable for implicit arguments. ctx is the parent application.

• hole: Lean.Elab.Term.MVarErrorKind

  Metavariable for explicit holes provided by the user (e.g., _ and ?m)

• custom: Lean.MessageData → Lean.Elab.Term.MVarErrorKind

  "Custom", msgData stores the additional error messages.

We can optionally associate an error context with a metavariable (see MVarErrorInfo). We have three different kinds of error context.

instance Lean.Elab.Term.instInhabitedMVarErrorKind : Inhabited Lean.Elab.Term.MVarErrorKind

instance Lean.Elab.Term.instToStringMVarErrorKind : ToString Lean.Elab.Term.MVarErrorKind

structure Lean.Elab.Term.MVarErrorInfo : Type

• mvarId : Lean.MVarId
• ref : Lean.Syntax
• kind : Lean.Elab.Term.MVarErrorKind
• argName? : Option Lake.Name

We can optionally associate an error context with metavariables.

instance Lean.Elab.Term.instInhabitedMVarErrorInfo : Inhabited Lean.Elab.Term.MVarErrorInfo

structure Lean.Elab.Term.LetRecToLift : Type

• ref : Lean.Syntax
• fvarId : Lean.FVarId
• attrs : Array Lean.Elab.Attribute
• shortDeclName : Lake.Name
• declName : Lake.Name
• lctx : Lean.LocalContext
• localInstances : Lean.LocalInstances
• type : Lean.Expr
• val : Lean.Expr
• mvarId : Lean.MVarId

Nested let rec expressions are eagerly lifted by the elaborator. We store the information necessary for performing the lifting here.

instance Lean.Elab.Term.instInhabitedLetRecToLift : Inhabited Lean.Elab.Term.LetRecToLift

structure Lean.Elab.Term.State : Type

• levelNames : List Lake.Name
• syntheticMVars : Lean.MVarIdMap Lean.Elab.Term.SyntheticMVarDecl
• pendingMVars : List Lean.MVarId
• mvarErrorInfos : Lean.MVarIdMap Lean.Elab.Term.MVarErrorInfo
• letRecsToLift : List Lean.Elab.Term.LetRecToLift

State of the TermElabM monad.

instance Lean.Elab.Term.instInhabitedState : Inhabited Lean.Elab.Term.State

structure Lean.Elab.Tactic.State : Type

• goals : List Lean.MVarId

State of the TacticM monad.

instance Lean.Elab.Tactic.instInhabitedState : Inhabited Lean.Elab.Tactic.State

structure Lean.Elab.Tactic.Snapshot : Type

• core : Lean.Core.State
• meta : Lean.Meta.State
• term : Lean.Elab.Term.State
• tactic : Lean.Elab.Tactic.State
• stx : Lean.Syntax

Snapshots are used to implement the save tactic. This tactic caches the state of the system, and allows us to "replay" expensive proofs efficiently. This is only relevant implementing the LSP server.

structure Lean.Elab.Tactic.CacheKey : Type

• mvarId : Lean.MVarId
• pos : String.Pos

Key for the cache used to implement the save tactic.

instance Lean.Elab.Tactic.instBEqCacheKey : BEq Lean.Elab.Tactic.CacheKey

instance Lean.Elab.Tactic.instHashableCacheKey : Hashable Lean.Elab.Tactic.CacheKey

instance Lean.Elab.Tactic.instInhabitedCacheKey : Inhabited Lean.Elab.Tactic.CacheKey

structure Lean.Elab.Tactic.Cache : Type

• pre : Lean.PHashMap Lean.Elab.Tactic.CacheKey Lean.Elab.Tactic.Snapshot
• post : Lean.PHashMap Lean.Elab.Tactic.CacheKey Lean.Elab.Tactic.Snapshot

Cache for the save tactic.

instance Lean.Elab.Tactic.instInhabitedCache : Inhabited Lean.Elab.Tactic.Cache

structure Lean.Elab.Term.Context : Type

• declName? : Option Lake.Name
• auxDeclToFullName : Lean.FVarIdMap Lake.Name

  Map .auxDecl local declarations used to encode recursive declarations to their full-names.

• macroStack : Lean.Elab.MacroStack
• mayPostpone : Bool

  When mayPostpone == true, an elaboration function may interrupt its execution by throwing Exception.postpone. The function elabTerm catches this exception and creates fresh synthetic metavariable ?m, stores ?m in the list of pending synthetic metavariables, and returns ?m.

• errToSorry : Bool

  When errToSorry is set to true, the method elabTerm catches exceptions and converts them into synthetic sorrys. The implementation of choice nodes and overloaded symbols rely on the fact that when errToSorry is set to false for an elaboration function F, then errToSorry remains false for all elaboration functions invoked by F. That is, it is safe to transition errToSorry from true to false, but we must not set errToSorry to true when it is currently set to false.

• autoBoundImplicit : Bool

  When autoBoundImplicit is set to true, instead of producing an "unknown identifier" error for unbound variables, we generate an internal exception. This exception is caught at elabBinders and elabTypeWithUnboldImplicit. Both methods add implicit declarations for the unbound variable and try again.

• autoBoundImplicits : Lean.PArray Lean.Expr
• autoBoundImplicitForbidden : Lake.Name → Bool

  A name n is only eligible to be an auto implicit name if autoBoundImplicitForbidden n = false. We use this predicate to disallow f to be considered an auto implicit name in a definition such as

  def f : f → Bool := fun _ => true
  

• sectionVars : Lake.NameMap Lake.Name

  Map from user name to internal unique name

• sectionFVars : Lake.NameMap Lean.Expr

  Map from internal name to fvar

• implicitLambda : Bool

  Enable/disable implicit lambdas feature.

• isNoncomputableSection : Bool

  Noncomputable sections automatically add the noncomputable modifier to any declaration we cannot generate code for.

• ignoreTCFailures : Bool

  When true we skip TC failures. We use this option when processing patterns.

• inPattern : Bool

  true when elaborating patterns. It affects how we elaborate named holes.

• tacticCache? : Option (IO.Ref Lean.Elab.Tactic.Cache)

  Cache for the save tactic. It is only some in the LSP server.

• saveRecAppSyntax : Bool

  If true, we store in the Expr the Syntax for recursive applications (i.e., applications of free variables tagged with isAuxDecl). We store the Syntax using mkRecAppWithSyntax. We use the Syntax object to produce better error messages at Structural.lean and WF.lean.

• holesAsSyntheticOpaque : Bool

  If holesAsSyntheticOpaque is true, then we mark metavariables associated with _s as synthethicOpaque if they do not occur in patterns. This option is useful when elaborating terms in tactics such as refine' where we want holes there to become new goals. See issue #1681, we have `refine' (fun x => _)

@[inline, reducible]

abbrev Lean.Elab.Term.TermElabM (α : Type) : Type

@[inline, reducible]

abbrev Lean.Elab.Term.TermElab : Type

@[always_inline]

instance Lean.Elab.Term.instMonadTermElabM : Monad Lean.Elab.TermElabM

instance Lean.Elab.Term.instInhabitedTermElabM {α : Type} : Inhabited (Lean.Elab.TermElabM α)

structure Lean.Elab.Term.SavedState : Type

• meta : Lean.Meta.SavedState
• elab : Lean.Elab.Term.State

Backtrackable state for the TermElabM monad.

instance Lean.Elab.Term.instNonemptySavedState : Nonempty Lean.Elab.Term.SavedState

def Lean.Elab.Term.saveState : Lean.Elab.TermElabM Lean.Elab.Term.SavedState

def Lean.Elab.Term.SavedState.restore (s : Lean.Elab.Term.SavedState) (restoreInfo : optParam Bool false) : Lean.Elab.TermElabM Unit

instance Lean.Elab.Term.instMonadBacktrackSavedStateTermElabM : Lean.MonadBacktrack Lean.Elab.Term.SavedState Lean.Elab.TermElabM

@[inline, reducible]

abbrev Lean.Elab.Term.TermElabResult (α : Type) : Type

def Lean.Elab.Term.observing {α : Type} (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM (Lean.Elab.Term.TermElabResult α)

Execute x, save resulting expression and new state. We remove any Info created by x. The info nodes are committed when we execute applyResult. We use observing to implement overloaded notation and decls. We want to save Info nodes for the chosen alternative.

def Lean.Elab.Term.applyResult {α : Type} (result : Lean.Elab.Term.TermElabResult α) : Lean.Elab.TermElabM α

Apply the result/exception and state captured with observing. We use this method to implement overloaded notation and symbols.

def Lean.Elab.Term.commitIfDidNotPostpone {α : Type} (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Execute x, but keep state modifications only if x did not postpone. This method is useful to implement elaboration functions that cannot decide whether they need to postpone or not without updating the state.

def Lean.Elab.Term.getLevelNames : Lean.Elab.TermElabM (List Lake.Name)

Return the universe level names explicitly provided by the user.

def Lean.Elab.Term.getFVarLocalDecl! (fvar : Lean.Expr) : Lean.Elab.TermElabM Lean.LocalDecl

Given a free variable fvar, return its declaration. This function panics if fvar is not a free variable.

instance Lean.Elab.Term.instAddErrorMessageContextTermElabM : Lean.AddErrorMessageContext Lean.Elab.TermElabM

def Lean.Elab.Term.withoutModifyingElabMetaStateWithInfo {α : Type} (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Execute x but discard changes performed at Term.State and Meta.State. Recall that the Environment and InfoState are at Core.State. Thus, any updates to it will be preserved. This method is useful for performing computations where all metavariable must be resolved or discarded. The InfoTrees are not discarded, however, and wrapped in InfoTree.Context to store their metavariable context.

def Lean.Elab.Term.withoutSavingRecAppSyntax {α : Type} (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Execute x without storing Syntax for recursive applications. See saveRecAppSyntax field at Context.

unsafe def Lean.Elab.Term.mkTermElabAttributeUnsafe (ref : Lake.Name) : IO (Lean.KeyedDeclsAttribute Lean.Elab.Term.TermElab)

@[implemented_by Lean.Elab.Term.mkTermElabAttributeUnsafe]

opaque Lean.Elab.Term.mkTermElabAttribute (ref : Lake.Name) : IO (Lean.KeyedDeclsAttribute Lean.Elab.Term.TermElab)

opaque Lean.Elab.Term.termElabAttribute : Lean.KeyedDeclsAttribute Lean.Elab.Term.TermElab

inductive Lean.Elab.Term.LVal : Type

• fieldIdx: Lean.Syntax → Nat → Lean.Elab.Term.LVal
• fieldName: Lean.Syntax → String → Option Lake.Name → Lean.Syntax → Lean.Elab.Term.LVal

  Field suffix? is for producing better error messages because x.y may be a field access or a hierarchical/composite name. ref is the syntax object representing the field. targetStx is the target object being accessed.

Auxiliary datatype for presenting a Lean lvalue modifier. We represent an unelaborated lvalue as a Syntax (or Expr) and List LVal. Example: a.foo.1 is represented as the Syntax a and the list [LVal.fieldName "foo", LVal.fieldIdx 1].

def Lean.Elab.Term.LVal.getRef : Lean.Elab.Term.LVal → Lean.Syntax

def Lean.Elab.Term.LVal.isFieldName : Lean.Elab.Term.LVal → Bool

instance Lean.Elab.Term.instToStringLVal : ToString Lean.Elab.Term.LVal

def Lean.Elab.Term.getDeclName? : Lean.Elab.TermElabM (Option Lake.Name)

Return the name of the declaration being elaborated if available.

def Lean.Elab.Term.getLetRecsToLift : Lean.Elab.TermElabM (List Lean.Elab.Term.LetRecToLift)

Return the list of nested let rec declarations that need to be lifted.

def Lean.Elab.Term.getMVarDecl (mvarId : Lean.MVarId) : Lean.Elab.TermElabM Lean.MetavarDecl

Return the declaration of the given metavariable

def Lean.Elab.Term.withDeclName {α : Type} (name : Lake.Name) (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Execute x with declName? := name. See getDeclName?.

def Lean.Elab.Term.setLevelNames (levelNames : List Lake.Name) : Lean.Elab.TermElabM Unit

Update the universe level parameter names.

def Lean.Elab.Term.withLevelNames {α : Type} (levelNames : List Lake.Name) (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Execute x using levelNames as the universe level parameter names. See getLevelNames.

def Lean.Elab.Term.withAuxDecl {α : Type} (shortDeclName : Lake.Name) (type : Lean.Expr) (declName : Lake.Name) (k : Lean.Expr → Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Declare an auxiliary local declaration shortDeclName : type for elaborating recursive declaration declName, update the mapping auxDeclToFullName, and then execute k.

def Lean.Elab.Term.withoutErrToSorryImp {α : Type} (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

def Lean.Elab.Term.withoutErrToSorry {m : Type → Type u_1} {α : Type} [MonadFunctorT Lean.Elab.TermElabM m] : m α → m α

Execute x without converting errors (i.e., exceptions) to sorry applications. Recall that when errToSorry = true, the method elabTerm catches exceptions and converts them into sorry applications.

def Lean.Elab.Term.throwErrorIfErrors : Lean.Elab.TermElabM Unit

For testing TermElabM methods. The #eval command will sign the error.

def Lean.Elab.Term.traceAtCmdPos (cls : Lake.Name) (msg : Unit → Lean.MessageData) : Lean.Elab.TermElabM Unit

def Lean.Elab.Term.ppGoal (mvarId : Lean.MVarId) : Lean.Elab.TermElabM Lean.Format

def Lean.Elab.Term.liftLevelM {α : Type} (x : Lean.Elab.Level.LevelElabM α) : Lean.Elab.TermElabM α

def Lean.Elab.Term.elabLevel (stx : Lean.Syntax) : Lean.Elab.TermElabM Lean.Level

def Lean.Elab.Term.withPushMacroExpansionStack {α : Type} (beforeStx : Lean.Syntax) (afterStx : Lean.Syntax) (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Elaborate x with stx on the macro stack

def Lean.Elab.Term.withMacroExpansion {α : Type} (beforeStx : Lean.Syntax) (afterStx : Lean.Syntax) (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Elaborate x with stx on the macro stack and produce macro expansion info

def Lean.Elab.Term.registerSyntheticMVar (stx : Lean.Syntax) (mvarId : Lean.MVarId) (kind : Lean.Elab.Term.SyntheticMVarKind) : Lean.Elab.TermElabM Unit

Add the given metavariable to the list of pending synthetic metavariables. The method synthesizeSyntheticMVars is used to process the metavariables on this list.

def Lean.Elab.Term.registerSyntheticMVarWithCurrRef (mvarId : Lean.MVarId) (kind : Lean.Elab.Term.SyntheticMVarKind) : Lean.Elab.TermElabM Unit

def Lean.Elab.Term.registerMVarErrorInfo (mvarErrorInfo : Lean.Elab.Term.MVarErrorInfo) : Lean.Elab.TermElabM Unit

def Lean.Elab.Term.registerMVarErrorHoleInfo (mvarId : Lean.MVarId) (ref : Lean.Syntax) : Lean.Elab.TermElabM Unit

def Lean.Elab.Term.registerMVarErrorImplicitArgInfo (mvarId : Lean.MVarId) (ref : Lean.Syntax) (app : Lean.Expr) : Lean.Elab.TermElabM Unit

def Lean.Elab.Term.registerMVarErrorCustomInfo (mvarId : Lean.MVarId) (ref : Lean.Syntax) (msgData : Lean.MessageData) : Lean.Elab.TermElabM Unit

def Lean.Elab.Term.getMVarErrorInfo? (mvarId : Lean.MVarId) : Lean.Elab.TermElabM (Option Lean.Elab.Term.MVarErrorInfo)

def Lean.Elab.Term.registerCustomErrorIfMVar (e : Lean.Expr) (ref : Lean.Syntax) (msgData : Lean.MessageData) : Lean.Elab.TermElabM Unit

def Lean.Elab.Term.throwMVarError {α : Type} (m : Lean.MessageData) : Lean.Elab.TermElabM α

Auxiliary method for reporting errors of the form "... contains metavariables ...". This kind of error is thrown, for example, at Match.lean where elaboration cannot continue if there are metavariables in patterns. We only want to log it if we haven't logged any errors so far.

def Lean.Elab.Term.MVarErrorInfo.logError (mvarErrorInfo : Lean.Elab.Term.MVarErrorInfo) (extraMsg? : Option Lean.MessageData) : Lean.Elab.TermElabM Unit

def Lean.Elab.Term.MVarErrorInfo.logError.addArgName (mvarErrorInfo : Lean.Elab.Term.MVarErrorInfo) (msg : Lean.MessageData) (extra : optParam String "") : Lean.MessageData

Append mvarErrorInfo argument name (if available) to the message. Remark: if the argument name contains macro scopes we do not append it.

def Lean.Elab.Term.MVarErrorInfo.logError.appendExtra (extraMsg? : Option Lean.MessageData) (msg : Lean.MessageData) : Lean.MessageData

def Lean.Elab.Term.logUnassignedUsingErrorInfos (pendingMVarIds : Array Lean.MVarId) (extraMsg? : optParam (Option Lean.MessageData) none) : Lean.Elab.TermElabM Bool

Try to log errors for the unassigned metavariables pendingMVarIds.

Return true if there were "unfilled holes", and we should "abort" declaration. TODO: try to fill "all" holes using synthetic "sorry's"

Remark: We only log the "unfilled holes" as new errors if no error has been logged so far.

def Lean.Elab.Term.ensureNoUnassignedMVars (decl : Lean.Declaration) : Lean.Elab.TermElabM Unit

Ensure metavariables registered using registerMVarErrorInfos (and used in the given declaration) have been assigned.

def Lean.Elab.Term.withoutPostponing {α : Type} (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Execute x without allowing it to postpone elaboration tasks. That is, tryPostpone is a noop.

def Lean.Elab.Term.mkExplicitBinder (ident : Lean.Syntax) (type : Lean.Syntax) : Lean.Syntax

Creates syntax for ( : )

def Lean.Elab.Term.levelMVarToParam (e : Lean.Expr) (except : optParam (Lean.LMVarId → Bool) fun x => false) : Lean.Elab.TermElabM Lean.Expr

Convert unassigned universe level metavariables into parameters. The new parameter names are fresh names of the form u_i with regard to ctx.levelNames, which is updated with the new names.

def Lean.Elab.Term.mkFreshBinderName {m : Type → Type} [Monad m] [Lean.MonadQuotation m] : m Lake.Name

Auxiliary method for creating fresh binder names. Do not confuse with the method for creating fresh free/meta variable ids.

def Lean.Elab.Term.mkFreshIdent {m : Type → Type} [Monad m] [Lean.MonadQuotation m] (ref : Lean.Syntax) (canonical : optParam Bool false) : m Lean.Ident

Auxiliary method for creating a Syntax.ident containing a fresh name. This method is intended for creating fresh binder names. It is just a thin layer on top of mkFreshUserName.

def Lean.Elab.Term.applyAttributesAt (declName : Lake.Name) (attrs : Array Lean.Elab.Attribute) (applicationTime : Lean.AttributeApplicationTime) : Lean.Elab.TermElabM Unit

Apply given attributes at a given application time

def Lean.Elab.Term.applyAttributes (declName : Lake.Name) (attrs : Array Lean.Elab.Attribute) : Lean.Elab.TermElabM Unit

def Lean.Elab.Term.mkTypeMismatchError (header? : Option String) (e : Lean.Expr) (eType : Lean.Expr) (expectedType : Lean.Expr) : Lean.Elab.TermElabM Lean.MessageData

def Lean.Elab.Term.throwTypeMismatchError {α : Type} (header? : Option String) (expectedType : Lean.Expr) (eType : Lean.Expr) (e : Lean.Expr) (f? : optParam (Option Lean.Expr) none) (extraMsg? : optParam (Option Lean.MessageData) none) : Lean.Elab.TermElabM α

def Lean.Elab.Term.withoutMacroStackAtErr {α : Type} (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

@[inline, reducible]

abbrev Lean.Elab.Term.ContainsPendingMVar.M (α : Type) : Type

partial def Lean.Elab.Term.ContainsPendingMVar.visit (e : Lean.Expr) : Lean.Elab.Term.ContainsPendingMVar.M Unit

See containsPostponedTerm

def Lean.Elab.Term.containsPendingMVar (e : Lean.Expr) : Lean.MetaM Bool

Return true if e contains a pending metavariable. Remark: it also visits let-declarations.

def Lean.Elab.Term.synthesizeInstMVarCore (instMVar : Lean.MVarId) (maxResultSize? : optParam (Option Nat) none) : Lean.Elab.TermElabM Bool

Try to synthesize metavariable using type class resolution. This method assumes the local context and local instances of instMVar coincide with the current local context and local instances. Return true if the instance was synthesized successfully, and false if the instance contains unassigned metavariables that are blocking the type class resolution procedure. Throw an exception if resolution or assignment irrevocably fails.

def Lean.Elab.Term.mkCoe (expectedType : Lean.Expr) (e : Lean.Expr) (f? : optParam (Option Lean.Expr) none) (errorMsgHeader? : optParam (Option String) none) : Lean.Elab.TermElabM Lean.Expr

def Lean.Elab.Term.ensureHasType (expectedType? : Option Lean.Expr) (e : Lean.Expr) (errorMsgHeader? : optParam (Option String) none) (f? : optParam (Option Lean.Expr) none) : Lean.Elab.TermElabM Lean.Expr

If expectedType? is some t, then ensure t and eType are definitionally equal. If they are not, then try coercions.

Argument f? is used only for generating error messages.

def Lean.Elab.Term.exceptionToSorry (ex : Lean.Exception) (expectedType? : Option Lean.Expr) : Lean.Elab.TermElabM Lean.Expr

Log the given exception, and create a synthetic sorry for representing the failed elaboration step with exception ex.

def Lean.Elab.Term.tryPostpone : Lean.Elab.TermElabM Unit

If mayPostpone == true, throw Expection.postpone.

def Lean.Elab.Term.isMVarApp (e : Lean.Expr) : Lean.Elab.TermElabM Bool

Return true if e reduces (by unfolding only [reducible] declarations) to ?m ...

def Lean.Elab.Term.tryPostponeIfMVar (e : Lean.Expr) : Lean.Elab.TermElabM Unit

If mayPostpone == true and e's head is a metavariable, throw Exception.postpone.

def Lean.Elab.Term.tryPostponeIfNoneOrMVar (e? : Option Lean.Expr) : Lean.Elab.TermElabM Unit

If e? = some e, then tryPostponeIfMVar e, otherwise it is just tryPostpone.

def Lean.Elab.Term.tryPostponeIfHasMVars? (expectedType? : Option Lean.Expr) : Lean.Elab.TermElabM (Option Lean.Expr)

Throws Exception.postpone, if expectedType? contains unassigned metavariables. It is a noop if mayPostpone == false.

def Lean.Elab.Term.tryPostponeIfHasMVars (expectedType? : Option Lean.Expr) (msg : String) : Lean.Elab.TermElabM Lean.Expr

Throws Exception.postpone, if expectedType? contains unassigned metavariables. If mayPostpone == false, it throws error msg.

def Lean.Elab.Term.saveContext : Lean.Elab.TermElabM Lean.Elab.Term.SavedContext

Save relevant context for term elaboration postponement.

def Lean.Elab.Term.withSavedContext {α : Type} (savedCtx : Lean.Elab.Term.SavedContext) (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Execute x with the context saved using saveContext.

def Lean.Elab.Term.getSyntheticMVarDecl? (mvarId : Lean.MVarId) : Lean.Elab.TermElabM (Option Lean.Elab.Term.SyntheticMVarDecl)

def Lean.Elab.Term.mkSaveInfoAnnotation (e : Lean.Expr) : Lean.Expr

Create an auxiliary annotation to make sure we create an Info even if e is a metavariable. See mkTermInfo.

We use this function because some elaboration functions elaborate subterms that may not be immediately part of the resulting term. Example:

let_mvar% ?m := b; wait_if_type_mvar% ?m; body

If the type of b is not known, then wait_if_type_mvar% ?m; body is postponed and just returns a fresh metavariable ?n. The elaborator for

let_mvar% ?m := b; wait_if_type_mvar% ?m; body

returns mkSaveInfoAnnotation ?n to make sure the info nodes created when elaborating b are "saved". This is a bit hackish, but elaborators like let_mvar% are rare.

def Lean.Elab.Term.isSaveInfoAnnotation? (e : Lean.Expr) : Option Lean.Expr

partial def Lean.Elab.Term.removeSaveInfoAnnotation (e : Lean.Expr) : Lean.Expr

def Lean.Elab.Term.isTacticOrPostponedHole? (e : Lean.Expr) : Lean.Elab.TermElabM (Option Lean.MVarId)

Return some mvarId if e corresponds to a hole that is going to be filled "later" by executing a tactic or resuming elaboration.

We do not save ofTermInfo for this kind of node in the InfoTree.

def Lean.Elab.Term.mkTermInfo (elaborator : Lake.Name) (stx : Lean.Syntax) (e : Lean.Expr) (expectedType? : optParam (Option Lean.Expr) none) (lctx? : optParam (Option Lean.LocalContext) none) (isBinder : optParam Bool false) : Lean.Elab.TermElabM (Lean.Elab.Info ⊕ Lean.MVarId)

def Lean.Elab.Term.addTermInfo (stx : Lean.Syntax) (e : Lean.Expr) (expectedType? : optParam (Option Lean.Expr) none) (lctx? : optParam (Option Lean.LocalContext) none) (elaborator : optParam Lake.Name Lean.Name.anonymous) (isBinder : optParam Bool false) (force : optParam Bool false) : Lean.Elab.TermElabM Lean.Expr

Pushes a new leaf node to the info tree associating the expression e to the syntax stx. As a result, when the user hovers over stx they will see the type of e, and if e is a constant they will see the constant's doc string.

• expectedType?: the expected type of e at the point of elaboration, if available
• lctx?: the local context in which to interpret e (otherwise it will use ← getLCtx)
• elaborator: a declaration name used as an alternative target for go-to-definition
• isBinder: if true, this will be treated as defining e (which should be a local constant) for the purpose of go-to-definition on local variables
• force: In patterns, the effect of addTermInfo is usually suppressed and replaced by a patternWithRef? annotation which will be turned into a term info on the post-match-elaboration expression. This flag overrides that behavior and adds the term info immediately. (See https://github.com/leanprover/lean4/pull/1664.)

def Lean.Elab.Term.addTermInfo' (stx : Lean.Syntax) (e : Lean.Expr) (expectedType? : optParam (Option Lean.Expr) none) (lctx? : optParam (Option Lean.LocalContext) none) (elaborator : optParam Lake.Name Lean.Name.anonymous) (isBinder : optParam Bool false) : Lean.Elab.TermElabM Unit

def Lean.Elab.Term.withInfoContext' (stx : Lean.Syntax) (x : Lean.Elab.TermElabM Lean.Expr) (mkInfo : Lean.Expr → Lean.Elab.TermElabM (Lean.Elab.Info ⊕ Lean.MVarId)) : Lean.Elab.TermElabM Lean.Expr

def Lean.Elab.Term.postponeElabTerm (stx : Lean.Syntax) (expectedType? : Option Lean.Expr) : Lean.Elab.TermElabM Lean.Expr

Postpone the elaboration of stx, return a metavariable that acts as a placeholder, and ensures the info tree is updated and a hole id is introduced. When stx is elaborated, new info nodes are created and attached to the new hole id in the info tree.

instance Lean.Elab.Term.instMonadMacroAdapterTermElabM : Lean.Elab.MonadMacroAdapter Lean.Elab.TermElabM

def Lean.Elab.Term.hasNoImplicitLambdaAnnotation (type : Lean.Expr) : Bool

def Lean.Elab.Term.mkNoImplicitLambdaAnnotation (type : Lean.Expr) : Lean.Expr

def Lean.Elab.Term.blockImplicitLambda (stx : Lean.Syntax) : Bool

Block usage of implicit lambdas if stx is @f or @f arg1 ... or fun with an implicit binder annotation.

def Lean.Elab.Term.resolveLocalName (n : Lake.Name) : Lean.Elab.TermElabM (Option (Lean.Expr × List String))

def Lean.Elab.Term.resolveLocalName.go (localDecl : Lean.LocalDecl) (givenNameView : Lean.MacroScopesView) (fullDeclName : Lake.Name) (ns : Lake.Name) : Option Lean.LocalDecl

Equations

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

def Lean.Elab.Term.resolveLocalName.loop (view : Lean.MacroScopesView) (findLocalDecl? : Lean.MacroScopesView → Bool → Option Lean.LocalDecl) (n : Lake.Name) (projs : List String) (globalDeclFound : Bool) : Lean.Elab.TermElabM (Option (Lean.Expr × List String))

Equations

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

def Lean.Elab.Term.isLocalIdent? (stx : Lean.Syntax) : Lean.Elab.TermElabM (Option Lean.Expr)

Return true iff stx is a Syntax.ident, and it is a local variable.

inductive Lean.Elab.Term.UseImplicitLambdaResult : Type

• no: Lean.Elab.Term.UseImplicitLambdaResult
• yes: Lean.Expr → Lean.Elab.Term.UseImplicitLambdaResult
• postpone: Lean.Elab.Term.UseImplicitLambdaResult

def Lean.Elab.Term.addDotCompletionInfo (stx : Lean.Syntax) (e : Lean.Expr) (expectedType? : Option Lean.Expr) (field? : optParam (Option Lean.Syntax) none) : Lean.Elab.TermElabM Unit

Store in the InfoTree that e is a "dot"-completion target.

def Lean.Elab.Term.elabTerm (stx : Lean.Syntax) (expectedType? : Option Lean.Expr) (catchExPostpone : optParam Bool true) (implicitLambda : optParam Bool true) : Lean.Elab.TermElabM Lean.Expr

Main function for elaborating terms. It extracts the elaboration methods from the environment using the node kind. Recall that the environment has a mapping from SyntaxNodeKind to TermElab methods. It creates a fresh macro scope for executing the elaboration method. All unlogged trace messages produced by the elaboration method are logged using the position information at stx. If the elaboration method throws an Exception.error and errToSorry == true, the error is logged and a synthetic sorry expression is returned. If the elaboration throws Exception.postpone and catchExPostpone == true, a new synthetic metavariable of kind SyntheticMVarKind.postponed is created, registered, and returned. The option catchExPostpone == false is used to implement resumeElabTerm to prevent the creation of another synthetic metavariable when resuming the elaboration.

If implicitLambda == false, then disable implicit lambdas feature for the given syntax, but not for its subterms. We use this flag to implement, for example, the @ modifier. If Context.implicitLambda == false, then this parameter has no effect.

def Lean.Elab.Term.elabTermEnsuringType (stx : Lean.Syntax) (expectedType? : Option Lean.Expr) (catchExPostpone : optParam Bool true) (implicitLambda : optParam Bool true) (errorMsgHeader? : optParam (Option String) none) : Lean.Elab.TermElabM Lean.Expr

def Lean.Elab.Term.commitIfNoErrors? {α : Type} (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM (Option α)

Execute x and return some if no new errors were recorded or exceptions were thrown. Otherwise, return none.

def Lean.Elab.Term.adaptExpander (exp : Lean.Syntax → Lean.Elab.TermElabM Lean.Syntax) : Lean.Elab.Term.TermElab

Adapt a syntax transformation to a regular, term-producing elaborator.

def Lean.Elab.Term.mkInstMVar (type : Lean.Expr) : Lean.Elab.TermElabM Lean.Expr

Create a new metavariable with the given type, and try to synthesize it. If type class resolution cannot be executed (e.g., it is stuck because of metavariables in type), register metavariable as a pending one.

def Lean.Elab.Term.ensureType (e : Lean.Expr) : Lean.Elab.TermElabM Lean.Expr

Make sure e is a type by inferring its type and making sure it is an Expr.sort or is unifiable with Expr.sort, or can be coerced into one.

def Lean.Elab.Term.elabType (stx : Lean.Syntax) : Lean.Elab.TermElabM Lean.Expr

Elaborate stx and ensure result is a type.

def Lean.Elab.Term.withAutoBoundImplicit {α : Type} (k : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Enable auto-bound implicits, and execute k while catching auto bound implicit exceptions. When an exception is caught, a new local declaration is created, registered, and k is tried to be executed again.

partial def Lean.Elab.Term.withAutoBoundImplicit.loop {α : Type} (k : Lean.Elab.TermElabM α) (s : Lean.Elab.Term.SavedState) : Lean.Elab.TermElabM α

def Lean.Elab.Term.withoutAutoBoundImplicit {α : Type} (k : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

def Lean.Elab.Term.withAutoBoundImplicitForbiddenPred {α : Type} (p : Lake.Name → Bool) (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

def Lean.Elab.Term.collectUnassignedMVars (type : Lean.Expr) (init : optParam (Array Lean.Expr) #[]) (except : optParam (Lean.MVarId → Bool) fun x => false) : Lean.Elab.TermElabM (Array Lean.Expr)

Collect unassigned metavariables in type that are not already in init and not satisfying except.

partial def Lean.Elab.Term.collectUnassignedMVars.go (except : optParam (Lean.MVarId → Bool) fun x => false) (mvarIds : List Lean.MVarId) (result : Array Lean.Expr) (visited : Array Lean.Expr) : Lean.Elab.TermElabM (Array Lean.Expr)

def Lean.Elab.Term.addAutoBoundImplicits (xs : Array Lean.Expr) : Lean.Elab.TermElabM (Array Lean.Expr)

Return autoBoundImplicits ++ xs This method throws an error if a variable in autoBoundImplicits depends on some x in xs. The autoBoundImplicits may contain free variables created by the auto-implicit feature, and unassigned free variables. It avoids the hack used at autoBoundImplicitsOld.

Remark: we cannot simply replace every occurrence of addAutoBoundImplicitsOld with this one because a particular use-case may not be able to handle the metavariables in the array being given to k.

def Lean.Elab.Term.addAutoBoundImplicits.go (xs : Array Lean.Expr) (todo : List Lean.Expr) (autos : Array Lean.Expr) : Lean.Elab.TermElabM (Array Lean.Expr)

Equations

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

def Lean.Elab.Term.addAutoBoundImplicits' {α : Type} (xs : Array Lean.Expr) (type : Lean.Expr) (k : Array Lean.Expr → Lean.Expr → Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Similar to autoBoundImplicits, but immediately if the resulting array of expressions contains metavariables, it immediately uses mkForallFVars + forallBoundedTelescope to convert them into free variables. The type type is modified during the process if type depends on xs. We use this method to simplify the conversion of code using autoBoundImplicitsOld to autoBoundImplicits.

def Lean.Elab.Term.mkAuxName (suffix : Lake.Name) : Lean.Elab.TermElabM Lake.Name

def Lean.Elab.Term.isLetRecAuxMVar (mvarId : Lean.MVarId) : Lean.Elab.TermElabM Bool

Return true if mvarId is an auxiliary metavariable created for compiling let rec or it is delayed assigned to one.

def Lean.Elab.Term.mkConst (constName : Lake.Name) (explicitLevels : optParam (List Lean.Level) []) : Lean.Elab.TermElabM Lean.Expr

Create an Expr.const using the given name and explicit levels. Remark: fresh universe metavariables are created if the constant has more universe parameters than explicitLevels.

def Lean.Elab.Term.resolveName (stx : Lean.Syntax) (n : Lake.Name) (preresolved : List Lean.Syntax.Preresolved) (explicitLevels : List Lean.Level) (expectedType? : optParam (Option Lean.Expr) none) : Lean.Elab.TermElabM (List (Lean.Expr × List String))

def Lean.Elab.Term.resolveName.process (n : Lake.Name) (explicitLevels : List Lean.Level) (candidates : List (Lake.Name × List String)) : Lean.Elab.TermElabM (List (Lean.Expr × List String))

def Lean.Elab.Term.resolveName' (ident : Lean.Syntax) (explicitLevels : List Lean.Level) (expectedType? : optParam (Option Lean.Expr) none) : Lean.Elab.TermElabM (List (Lean.Expr × Lean.Syntax × List Lean.Syntax))

Similar to resolveName, but creates identifiers for the main part and each projection with position information derived from ident. Example: Assume resolveName v.head.bla.boo produces (v.head, ["bla", "boo"]), then this method produces (v.head, id, [f₁, f₂]) where id is an identifier for v.head, and f₁ and f₂ are identifiers for fields "bla" and "boo".

def Lean.Elab.Term.resolveId? (stx : Lean.Syntax) (kind : optParam String "term") (withInfo : optParam Bool false) : Lean.Elab.TermElabM (Option Lean.Expr)

def Lean.Elab.Term.TermElabM.run {α : Type} (x : Lean.Elab.TermElabM α) (ctx : optParam Lean.Elab.Term.Context { declName? := none, auxDeclToFullName := ∅, macroStack := [], mayPostpone := true, errToSorry := true, autoBoundImplicit := false, autoBoundImplicits := { root := Lean.PersistentArrayNode.node (Array.mkEmpty (USize.toNat Lean.PersistentArray.branching)), tail := Array.mkEmpty (USize.toNat Lean.PersistentArray.branching), size := 0, shift := Lean.PersistentArray.initShift, tailOff := 0 }, autoBoundImplicitForbidden := fun x => false, sectionVars := ∅, sectionFVars := ∅, implicitLambda := true, isNoncomputableSection := false, ignoreTCFailures := false, inPattern := false, tacticCache? := none, saveRecAppSyntax := true, holesAsSyntheticOpaque := false }) (s : optParam Lean.Elab.Term.State { levelNames := [], syntheticMVars := ∅, pendingMVars := ∅, mvarErrorInfos := ∅, letRecsToLift := [] }) : Lean.MetaM (α × Lean.Elab.Term.State)

@[inline]

def Lean.Elab.Term.TermElabM.run' {α : Type} (x : Lean.Elab.TermElabM α) (ctx : optParam Lean.Elab.Term.Context { declName? := none, auxDeclToFullName := ∅, macroStack := [], mayPostpone := true, errToSorry := true, autoBoundImplicit := false, autoBoundImplicits := { root := Lean.PersistentArrayNode.node (Array.mkEmpty (USize.toNat Lean.PersistentArray.branching)), tail := Array.mkEmpty (USize.toNat Lean.PersistentArray.branching), size := 0, shift := Lean.PersistentArray.initShift, tailOff := 0 }, autoBoundImplicitForbidden := fun x => false, sectionVars := ∅, sectionFVars := ∅, implicitLambda := true, isNoncomputableSection := false, ignoreTCFailures := false, inPattern := false, tacticCache? := none, saveRecAppSyntax := true, holesAsSyntheticOpaque := false }) (s : optParam Lean.Elab.Term.State { levelNames := [], syntheticMVars := ∅, pendingMVars := ∅, mvarErrorInfos := ∅, letRecsToLift := [] }) : Lean.MetaM α

def Lean.Elab.Term.TermElabM.toIO {α : Type} (x : Lean.Elab.TermElabM α) (ctxCore : Lean.Core.Context) (sCore : Lean.Core.State) (ctxMeta : Lean.Meta.Context) (sMeta : Lean.Meta.State) (ctx : Lean.Elab.Term.Context) (s : Lean.Elab.Term.State) : IO (α × Lean.Core.State × Lean.Meta.State × Lean.Elab.Term.State)

instance Lean.Elab.Term.instMetaEvalTermElabM {α : Type} [Lean.MetaEval α] : Lean.MetaEval (Lean.Elab.TermElabM α)

def Lean.Elab.Term.universeConstraintsCheckpoint {α : Type} (x : Lean.Elab.TermElabM α) : Lean.Elab.TermElabM α

Execute x and then tries to solve pending universe constraints. Note that, stuck constraints will not be discarded.

def Lean.Elab.Term.expandDeclId (currNamespace : Lake.Name) (currLevelNames : List Lake.Name) (declId : Lean.Syntax) (modifiers : Lean.Elab.Modifiers) : Lean.Elab.TermElabM Lean.Elab.ExpandDeclIdResult

def Lean.Elab.Term.exprToSyntax (e : Lean.Expr) : Lean.Elab.TermElabM Lean.Term

Helper function for "embedding" an Expr in Syntax. It creates a named hole ?m and immediately assigns e to it. Examples:

let e := mkConst ``Nat.zero
`(Nat.succ $(← exprToSyntax e))

def Lean.Elab.withoutModifyingStateWithInfoAndMessages {m : Type → Type u_1} {α : Type} [MonadControlT Lean.Elab.TermElabM m] [Monad m] (x : m α) : m α