Lean.Elab.InfoTree.Main

Helper function for propagating the tactic metavariable context to its children nodes. We need this function because we preserve TacticInfo nodes during backtracking and their children. Moreover, we backtrack the metavariable context to undo metavariable assignments. TacticInfo nodes save the metavariable context before/after the tactic application, and can be pretty printed without any extra information. This is not the case for TermInfo nodes. Without this function, the formatting method would often fail when processing TermInfo nodes that are children of TacticInfo nodes that have been preserved during backtracking. Saving the metavariable context at TermInfo nodes is also not a good option because at TermInfo creation time, the metavariable context often miss information, e.g., a TC problem has not been resolved, a postponed subterm has not been elaborated, etc.

See Term.SavedState.restore.

Instances For

source

partial def Lean.Elab.InfoTree.format (tree : Lean.Elab.InfoTree) (ctx? : optParam (Option Lean.Elab.ContextInfo) none) :

IO Lean.Format

source

def Lean.Elab.getResetInfoTrees {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] :

m (Lean.PersistentArray Lean.Elab.InfoTree)

Returns the current array of InfoTrees and resets it to an empty array.

Instances For

source

def Lean.Elab.pushInfoTree {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] (t : Lean.Elab.InfoTree) :

m Unit

Instances For

source

def Lean.Elab.pushInfoLeaf {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] (t : Lean.Elab.Info) :

m Unit

Instances For

source

def Lean.Elab.addCompletionInfo {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] (info : Lean.Elab.CompletionInfo) :

m Unit

Instances For

source

def Lean.Elab.addConstInfo {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] [Lean.MonadEnv m] [Lean.MonadError m] (stx : Lean.Syntax) (n : Lake.Name) (expectedType? : optParam (Option Lean.Expr) none) :

m Unit

Instances For

source

def Lean.Elab.resolveGlobalConstNoOverloadWithInfo {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] [Lean.MonadResolveName m] [Lean.MonadEnv m] [Lean.MonadError m] (id : Lean.Syntax) (expectedType? : optParam (Option Lean.Expr) none) :

m Lake.Name

This does the same job as resolveGlobalConstNoOverload; resolving an identifier syntax to a unique fully resolved name or throwing if there are ambiguities. But also adds this resolved name to the infotree. This means that when you hover over a name in the sourcefile you will see the fully resolved name in the hover info.

Instances For

source

def Lean.Elab.resolveGlobalConstWithInfos {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] [Lean.MonadResolveName m] [Lean.MonadEnv m] [Lean.MonadError m] (id : Lean.Syntax) (expectedType? : optParam (Option Lean.Expr) none) :

m (List Lake.Name)

Similar to resolveGlobalConstNoOverloadWithInfo, except if there are multiple name resolutions then it returns them as a list.

Instances For

source

def Lean.Elab.resolveGlobalNameWithInfos {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] [Lean.MonadResolveName m] [Lean.MonadEnv m] [Lean.MonadError m] (ref : Lean.Syntax) (id : Lake.Name) :

m (List (Lake.Name × List String))

Similar to resolveGlobalName, but it also adds the resolved name to the info tree.

Instances For

source

def Lean.Elab.withInfoContext' {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] {α : Type} [MonadFinally m] (x : m α) (mkInfo : α → m (Lean.Elab.Info ⊕ Lean.MVarId)) :

m α

Use this to descend a node on the infotree that is being built.

It saves the current list of trees t₀ and resets it and then runs x >>= mkInfo, producing either an i : Info or a hole id. Running x >>= mkInfo will modify the trees state and produce a new list of trees t₁. In the i : Info case, t₁ become the children of a node node i t₁ that is appended to t₀.

Instances For

source

def Lean.Elab.withInfoTreeContext {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] {α : Type} [MonadFinally m] (x : m α) (mkInfoTree : Lean.PersistentArray Lean.Elab.InfoTree → m Lean.Elab.InfoTree) :

m α

Saves the current list of trees t₀, runs x to produce a new tree list t₁ and runs mkInfoTree t₁ to get n : InfoTree and then restores the trees to be t₀ ++ [n].

Instances For

source

@[inline]

def Lean.Elab.withInfoContext {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] {α : Type} [MonadFinally m] (x : m α) (mkInfo : m Lean.Elab.Info) :

m α

Run x as a new child infotree node with header given by mkInfo.

Instances For

source

def Lean.Elab.withSaveInfoContext {m : Type → Type} [Monad m] [Lean.Elab.MonadInfoTree m] {α : Type} [Lean.MonadNameGenerator m] [MonadFinally m] [Lean.MonadEnv m] [Lean.MonadOptions m] [Lean.MonadMCtx m] [Lean.MonadResolveName m] [Lean.MonadFileMap m] (x : m α) :

m α

Resets the trees state t₀, runs x to produce a new trees state t₁ and sets the state to be t₀ ++ (InfoTree.context Γ <$> t₁) where Γ is the context derived from the monad state.

Instances For

source