Once-per-file cache for tactics

This file defines cache data structures for tactics that are initialized the first time they are accessed. Since Lean 4 starts one process per file, these caches are once-per-file and can for example be used to cache information about the imported modules.

The Cache α data structure is the most generic version we define. It is created using Cache.mk f where f : MetaM α performs the initialization of the cache:

initialize numberOfImports : Cache Nat ← Cache.mk do
  (← getEnv).imports.size

-- (does not work in the same module where the cache is defined)
#eval show MetaM Nat from numberOfImports.get

The DeclCache α data structure computes a fold over the environment's constants: DeclCache.mk empty f constructs such a cache where empty : α and f : Name → ConstantInfo → α → MetaM α. The result of the constants in the imports is cached between tactic invocations, while for constants defined in the same file f is evaluated again every time. This kind of cache can be used e.g. to populate discrimination trees.

def Mathlib.Tactic.Cache (α : Type) : Type

Once-per-file cache.

Equations

• Mathlib.Tactic.Cache α = IO.Ref (Lean.MetaM α ⊕ Task (Except Lean.Exception α))

instance Mathlib.Tactic.instNonemptyCache {α : Type} : Nonempty (Mathlib.Tactic.Cache α)

Equations

• @Mathlib.Tactic.instNonemptyCache = @Mathlib.Tactic.instNonemptyCache.proof_1

def Mathlib.Tactic.Cache.mk {α : Type} (init : Lean.MetaM α) : IO (Mathlib.Tactic.Cache α)

Creates a cache with an initialization function.

Equations

• Mathlib.Tactic.Cache.mk init = liftM (IO.mkRef (Sum.inl init))

def Mathlib.Tactic.Cache.get {m : Type → Type} {α : Type} [Monad m] [Lean.MonadEnv m] [Lean.MonadLog m] [Lean.MonadOptions m] [MonadLiftT BaseIO m] [MonadExcept Lean.Exception m] (cache : Mathlib.Tactic.Cache α) : m α

Access the cache. Calling this function for the first time will initialize the cache with the function provided in the constructor.

Equations

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

structure Mathlib.Tactic.DeclCache (α : Type) : Type

• mk' :: (
• cache : Mathlib.Tactic.Cache α

  The cached data.

• addDecl : Lean.Name → Lean.ConstantInfo → α → Lean.MetaM α

  Function for adding a declaration from the current file to the cache.

• addLibraryDecl : Lean.Name → Lean.ConstantInfo → α → Lean.MetaM α

  Function for adding a declaration from the library to the cache. Defaults to the same behaviour as adding a declaration from the current file.

• )

Cached fold over the environment's declarations, where a given function is applied to α for every constant.

instance Mathlib.Tactic.instNonemptyDeclCache : ∀ {α : Type} [inst : Nonempty α], Nonempty (Mathlib.Tactic.DeclCache α)

Equations

• @Mathlib.Tactic.instNonemptyDeclCache = @Mathlib.Tactic.instNonemptyDeclCache.proof_1

def Mathlib.Tactic.DeclCache.mk {α : Type} (profilingName : String) (empty : α) (addDecl : Lean.Name → Lean.ConstantInfo → α → Lean.MetaM α) (addLibraryDecl : optParam (Lean.Name → Lean.ConstantInfo → α → Lean.MetaM α) addDecl) (post : optParam (α → Lean.MetaM α) fun a => pure a) : IO (Mathlib.Tactic.DeclCache α)

Creates a DeclCache. The cached structure α is initialized with empty, and then addLibraryDecl is called for every imported constant, and the result is cached. After all imported constants have been added, we run post. When get is called, addDecl is also called for every constant in the current file.

Equations

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

def Mathlib.Tactic.DeclCache.get {α : Type} (cache : Mathlib.Tactic.DeclCache α) : Lean.MetaM α

Access the cache. Calling this function for the first time will initialize the cache with the function provided in the constructor.

Equations

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

@[reducible]

def Mathlib.Tactic.DiscrTreeCache (α : Type) : Type

A type synonym for a DeclCache containing a pair of discrimination trees. The first will store declarations in the current file, the second will store declarations from imports (and will hopefully be "read-only" after creation).

Equations

• Mathlib.Tactic.DiscrTreeCache α = Mathlib.Tactic.DeclCache (Lean.Meta.DiscrTree α true × Lean.Meta.DiscrTree α true)

def Mathlib.Tactic.DiscrTreeCache.mk {α : Type} [BEq α] (profilingName : String) (processDecl : Lean.Name → Lean.ConstantInfo → Lean.MetaM (Array (Array (Lean.Meta.DiscrTree.Key true) × α))) (post? : optParam (Option (Array α → Array α)) none) (init : optParam (Option (Lean.Meta.DiscrTree α true)) none) : IO (Mathlib.Tactic.DiscrTreeCache α)

Build a DiscrTreeCache, from a function that returns a collection of keys and values for each declaration.

Equations

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

def Mathlib.Tactic.DiscrTreeCache.getMatch {α : Type} (c : Mathlib.Tactic.DiscrTreeCache α) (e : Lean.Expr) : Lean.MetaM (Array α)

Get matches from both the discrimination tree for declarations in the current file, and for the imports.

Note that if you are calling this multiple times with the same environment, it will rebuild the discrimination tree for the current file multiple times, and it would be more efficient to call c.get once, and then call DiscrTree.getMatch multiple times.

Equations

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

structure Mathlib.Tactic.CachedData (α : Type) : Type

• pointer? : Option Lean.CompactedRegion
• cache : Mathlib.Tactic.DiscrTreeCache α

A structure that holds the cached discrimination tree, and possibly a pointer to a memory region, if we unpickled the tree from disk.

instance Mathlib.Tactic.instNonemptyCachedData : ∀ {α : Type}, Nonempty (Mathlib.Tactic.CachedData α)

Equations

• @Mathlib.Tactic.instNonemptyCachedData = @Mathlib.Tactic.instNonemptyCachedData.proof_1