Representing collected and deduplicated definitions and usages

structure Lean.Server.Reference : Type

Global reference. Used by the language server to figure out which identifiers refer to which other identifiers across the whole project.

• ident : Lsp.RefIdent

  Identifier of this reference.

• aliases : Array Lsp.RefIdent

  Identifiers that are logically identical to this reference.

• range : Lsp.Range

  Range where this reference occurs.

• stx : Syntax

  Syntax of this reference.

• ci : Elab.ContextInfo

  ContextInfo at the point of elaboration of this reference.

• info : Elab.Info

  Additional InfoTree information for this reference.

• isBinder : Bool

  Whether this reference declares ident.

structure Lean.Server.RefInfo : Type

Definition and usages of an identifier within a single module.

• definition : Option Reference

  Definition Reference of the identifier. Is equal to none if e.g. the definition is outside of the module where this RefInfo is used.

• usages : Array Reference

  All usage References of the identifier in a single module.

def Lean.Server.RefInfo.empty : RefInfo

No definition, no usages.

def Lean.Server.RefInfo.addRef (i : RefInfo) (ref : Reference) : RefInfo

Adds ref to i. If i has no definition and ref is a declaration, it becomes the definition. If i already has a definition and ref is also a declaration, it is not added to i. Otherwise, ref is added to i.usages.

def Lean.Server.RefInfo.toLspRefInfo (i : RefInfo) : BaseIO Lsp.RefInfo

Converts i to a JSON-serializable Lsp.RefInfo.

@[reducible, inline]

abbrev Lean.Server.ModuleRefs : Type

All references from within a module for all identifiers used in a single module.

def Lean.Server.ModuleRefs.addRef (self : ModuleRefs) (ref : Reference) : ModuleRefs

Adds ref to the RefInfo corresponding to ref.ident in self. See RefInfo.addRef.

def Lean.Server.ModuleRefs.toLspModuleRefs (refs : ModuleRefs) : BaseIO Lsp.ModuleRefs

Converts refs to a JSON-serializable Lsp.ModuleRefs.

def Lean.Lsp.RefInfo.empty : RefInfo

No definition, no usages

def Lean.Lsp.RefInfo.merge (a b : RefInfo) : RefInfo

Combines the usages of a and b and prefers the definition? of b over that of a.

def Lean.Lsp.RefInfo.findReferenceLocation? (self : RefInfo) (pos : Position) (includeStop : Bool := false) : Option Location

Finds the first definition or usage in self where the RefInfo.Location.range contains the given pos. The includeStop parameter can be used to toggle between closed-interval and half-open-interval behavior for the range. Closed-interval behavior matches the expectation of VSCode when selecting an identifier at a cursor position (see #767).

def Lean.Lsp.RefInfo.findReferenceLocation?.contains (includeStop : Bool := false) (range : Range) (pos : Position) : Bool

def Lean.Lsp.RefInfo.contains (self : RefInfo) (pos : Position) (includeStop : Bool := false) : Bool

Checks whether any of the ranges in self.definition? or self.usages contains pos.

def Lean.Lsp.ModuleRefs.findAt (self : ModuleRefs) (pos : Position) (includeStop : Bool := false) : Array RefIdent

Find all identifiers in self with a reference in this module that contains pos in its range.

def Lean.Lsp.ModuleRefs.findRange? (self : ModuleRefs) (pos : Position) (includeStop : Bool := false) : Option Range

Finds the first range in self that contains pos.

structure Lean.Server.Ilean : Type

Content of individual .ilean files

• version : Nat

  Version number of the ilean format.

• module : Name

  Name of the module that this ilean data has been collected for.

• references : Lsp.ModuleRefs

  All references of this module.

instance Lean.Server.instFromJsonIlean : FromJson Ilean

instance Lean.Server.instToJsonIlean : ToJson Ilean

def Lean.Server.Ilean.load (path : System.FilePath) : IO Ilean

Reads and parses the .ilean file at path.

Collecting and deduplicating definitions and usages

def Lean.Server.getModuleContainingDecl? (env : Environment) (declName : Name) : Option Name

Gets the name of the module that contains declName.

def Lean.Server.identOf (ci : Elab.ContextInfo) (i : Elab.Info) : Option (Lsp.RefIdent × Bool)

Determines the RefIdent for the Info i of an identifier in module and whether it is a declaration.

def Lean.Server.findReferences (text : FileMap) (trees : Array Elab.InfoTree) : Array Reference

Finds all references in trees.

def Lean.Server.combineIdents (trees : Array Elab.InfoTree) (refs : Array Reference) : Array Reference

There are several different identifiers that should be considered equal for the purpose of finding all references of an identifier:

• FVarIds of a function parameter in the function's signature and body
• Chains of helper definitions like those created for do-reassignment x := e
• Overlapping definitions like those defined by where declarations that define both an FVar (for local usage) and a constant (for non-local usage)
• Identifiers connected by FVarAliasInfo such as variables before and after match generalization

In the first three cases that are not explicitly denoted as aliases with an FVarAliasInfo, the corresponding References have the exact same range. This function finds all definitions that have the exact same range as another definition or usage and collapses them into a single identifier. It also collapses identifiers connected by an FVarAliasInfo. When collapsing identifiers, it prefers using a RefIdent.const name over a RefIdent.fvar id for all identifiers that are being collapsed into one.

def Lean.Server.combineIdents.useConstRepresentatives (idMap : Std.HashMap Lsp.RefIdent Lsp.RefIdent) : Std.HashMap Lsp.RefIdent Lsp.RefIdent

def Lean.Server.combineIdents.findCanonicalRepresentative (idMap : Std.HashMap Lsp.RefIdent Lsp.RefIdent) (id : Lsp.RefIdent) : Lsp.RefIdent

def Lean.Server.combineIdents.buildIdMap (trees : Array Elab.InfoTree) (refs : Array Reference) (posMap : Std.HashMap Lsp.Range Lsp.RefIdent) : Std.HashMap Lsp.RefIdent Lsp.RefIdent

def Lean.Server.combineIdents.insertIdMap (id baseId : Lsp.RefIdent) : StateT (Std.HashMap Lsp.RefIdent Lsp.RefIdent) Id Unit

def Lean.Server.dedupReferences (refs : Array Reference) (allowSimultaneousBinderUse : Bool := false) : Array Reference

Groups refs by identifier and range s.t. references with the same identifier and range are added to the aliases of the representative of the group. Yields to separate groups for declaration and usages if allowSimultaneousBinderUse is set.

def Lean.Server.findModuleRefs (text : FileMap) (trees : Array Elab.InfoTree) (localVars : Bool := true) (allowSimultaneousBinderUse : Bool := false) : ModuleRefs

Finds all references in trees and deduplicates the result. See dedupReferences and combineIdents.

Collecting and maintaining reference info from different sources

structure Lean.Server.LoadedILean : Type

Reference information from a loaded ILean file.

• moduleUri : Lsp.DocumentUri

  URI of the module of this ILean.

• ileanPath : System.FilePath

  Path to the ILean file.

• refs : Lsp.ModuleRefs

  Reference information from this ILean.

@[reducible, inline]

abbrev Lean.Server.ILeanMap : Type

Paths and module references for every module name. Loaded from .ilean files.

structure Lean.Server.TransientWorkerILean : Type

Transient reference information from a file worker. We track this information so that we have up-to-date reference information before a file has been built.

• moduleUri : Lsp.DocumentUri

  URI of the module that the file worker is associated with.

• version : Nat

  Document version for which these references have been collected.

• refs : Lsp.ModuleRefs

  References provided by the worker.

@[reducible, inline]

abbrev Lean.Server.WorkerRefMap : Type

Document versions and module references for every module name. Loaded from the current state in a file worker.

structure Lean.Server.References : Type

References from ilean files and current ilean information from file workers.

• ileans : ILeanMap

  References loaded from ilean files

• workers : WorkerRefMap

  References from workers, overriding the corresponding ilean files

def Lean.Server.References.empty : References

No ilean files, no information from workers.

def Lean.Server.References.addIlean (self : References) (moduleUri : Lsp.DocumentUri) (path : System.FilePath) (ilean : Ilean) : References

Adds the contents of an ilean file ilean at path to self.

def Lean.Server.References.removeIlean (self : References) (path : System.FilePath) : References

Removes the ilean file data at path from self.

def Lean.Server.References.updateWorkerRefs (self : References) (name : Name) (moduleUri : Lsp.DocumentUri) (version : Nat) (refs : Lsp.ModuleRefs) : References

Updates the worker references in self with the refs of the worker managing the module name. Replaces the current references with refs if version is newer than the current version managed in refs and otherwise merges the reference data if version is equal to the current version.

def Lean.Server.References.finalizeWorkerRefs (self : References) (name : Name) (moduleUri : Lsp.DocumentUri) (version : Nat) (refs : Lsp.ModuleRefs) : References

Replaces the worker references in self with the refs of the worker managing the module name if version is newer than the current version managed in refs.

def Lean.Server.References.removeWorkerRefs (self : References) (name : Name) : References

Erases all worker references in self for the worker managing name.

@[reducible, inline]

abbrev Lean.Server.References.AllRefsMap : Type

All references for a module. The current references in a file worker take precedence over those in .ilean files.

def Lean.Server.References.allRefs (self : References) : AllRefsMap

Yields a map from all modules to all of their references.

def Lean.Server.References.getModuleRefs? (self : References) (mod : Name) : Option (Lsp.DocumentUri × Lsp.ModuleRefs)

Gets the references for mod. The current references in a file worker take precedence over those in .ilean files.

def Lean.Server.References.allRefsFor (self : References) (ident : Lsp.RefIdent) : IO (Array (Lsp.DocumentUri × Name × Lsp.RefInfo))

Yields all references in self for ident, as well as the DocumentUri that each reference occurs in.

def Lean.Server.References.findAt (self : References) (module : Name) (pos : Lsp.Position) (includeStop : Bool := false) : Array Lsp.RefIdent

Yields all references in module at pos.

def Lean.Server.References.findRange? (self : References) (module : Name) (pos : Lsp.Position) (includeStop : Bool := false) : Option Lsp.Range

Yields the first reference in module at pos.

structure Lean.Server.References.DocumentRefInfo : Type

Location and parent declaration of a reference.

• location : Lsp.Location

  Location of the reference.

• module : Name

  Module name of the reference.

• parentInfo? : Option Lsp.RefInfo.ParentDecl

  Parent declaration of the reference.

def Lean.Server.References.referringTo (self : References) (ident : Lsp.RefIdent) (includeDefinition : Bool := true) : IO (Array DocumentRefInfo)

Yields locations and parent declaration for all references referring to ident.

def Lean.Server.References.definitionOf? (self : References) (ident : Lsp.RefIdent) : IO (Option DocumentRefInfo)

Yields the definition location of ident.

structure Lean.Server.References.MatchedDefinition (α : Type) : Type

A match in References.definitionsMatching.

• mod : Name

  Result of filterMapMod.

• modUri : Lsp.DocumentUri

  URI for mod.

• ident : α

  Result of filterMapIdent.

• range : Lsp.Range

  Definition range of matched identifier.

def Lean.Server.References.definitionsMatching {α : Type} (self : References) (filterMapIdent : Name → IO (Option α)) (cancelTk? : Option IO.CancelToken := none) : IO (Array (MatchedDefinition α))

Yields all definitions matching the given filter.