Build Info

This module defines the Lake build info type and related utilities. Build info is what is the data passed to a Lake build function to facilitate the build.

inductive Lake.BuildInfo : Type

The type of Lake's build info.

• moduleFacet (module : Module) (facet : Lean.Name) : BuildInfo
• packageFacet (package : Package) (facet : Lean.Name) : BuildInfo
• libraryFacet (lib : LeanLib) (facet : Lean.Name) : BuildInfo
• leanExe (exe : LeanExe) : BuildInfo
• staticExternLib (lib : ExternLib) : BuildInfo
• sharedExternLib (lib : ExternLib) : BuildInfo
• dynlibExternLib (lib : ExternLib) : BuildInfo
• target (package : Package) (target : Lean.Name) : BuildInfo

Build Info & Keys

Build Key Helper Constructors

@[reducible, inline]

abbrev Lake.Module.facetBuildKey (facet : Lean.Name) (self : Module) : BuildKey

Equations

• Lake.Module.facetBuildKey facet self = Lake.BuildKey.moduleFacet self.keyName facet

@[reducible, inline]

abbrev Lake.Package.facetBuildKey (facet : Lean.Name) (self : Package) : BuildKey

Equations

• Lake.Package.facetBuildKey facet self = Lake.BuildKey.packageFacet self.name facet

@[reducible, inline]

abbrev Lake.Package.targetBuildKey (target : Lean.Name) (self : Package) : BuildKey

Equations

• Lake.Package.targetBuildKey target self = Lake.BuildKey.customTarget self.name target

@[reducible, inline]

abbrev Lake.LeanLib.facetBuildKey (self : LeanLib) (facet : Lean.Name) : BuildKey

Equations

• self.facetBuildKey facet = Lake.BuildKey.targetFacet self.pkg.name self.name (`leanLib ++ facet)

@[reducible, inline]

abbrev Lake.LeanExe.buildKey (self : LeanExe) : BuildKey

Equations

• self.buildKey = Lake.BuildKey.targetFacet self.pkg.name self.name Lake.LeanExe.exeFacet

@[reducible, inline]

abbrev Lake.ExternLib.staticBuildKey (self : ExternLib) : BuildKey

Equations

• self.staticBuildKey = Lake.BuildKey.targetFacet self.pkg.name self.name Lake.ExternLib.staticFacet

@[reducible, inline]

abbrev Lake.ExternLib.sharedBuildKey (self : ExternLib) : BuildKey

Equations

• self.sharedBuildKey = Lake.BuildKey.targetFacet self.pkg.name self.name Lake.ExternLib.sharedFacet

@[reducible, inline]

abbrev Lake.ExternLib.dynlibBuildKey (self : ExternLib) : BuildKey

Equations

• self.dynlibBuildKey = Lake.BuildKey.targetFacet self.pkg.name self.name Lake.ExternLib.dynlibFacet

Build Info to Key

@[reducible]

def Lake.BuildInfo.key (self : BuildInfo) : BuildKey

The key that identifies the build in the Lake build store.

Equations

• (Lake.BuildInfo.moduleFacet m f).key = Lake.Module.facetBuildKey f m
• (Lake.BuildInfo.packageFacet p f).key = Lake.Package.facetBuildKey f p
• (Lake.BuildInfo.libraryFacet l f).key = l.facetBuildKey f
• (Lake.BuildInfo.leanExe x_1).key = x_1.buildKey
• (Lake.BuildInfo.staticExternLib l).key = l.staticBuildKey
• (Lake.BuildInfo.sharedExternLib l).key = l.sharedBuildKey
• (Lake.BuildInfo.dynlibExternLib l).key = l.dynlibBuildKey
• (Lake.BuildInfo.target p t).key = Lake.Package.targetBuildKey t p

Instances For

• Lake.instFamilyDefBuildKeyBuildDataKeyDynlibExternLibOfFamilyOutNameTargetDataDynlibFacet
• Lake.instFamilyDefBuildKeyBuildDataKeyLeanExeOfFamilyOutNameTargetDataExeFacet
• Lake.instFamilyDefBuildKeyBuildDataKeyLibraryFacetOfFamilyOutNameTargetDataHAppendMkStr1
• Lake.instFamilyDefBuildKeyBuildDataKeyModuleFacetOfFamilyOutNameModuleData
• Lake.instFamilyDefBuildKeyBuildDataKeyPackageFacetOfFamilyOutNamePackageData
• Lake.instFamilyDefBuildKeyBuildDataKeySharedExternLibOfFamilyOutNameTargetDataSharedFacet
• Lake.instFamilyDefBuildKeyBuildDataKeyStaticExternLibOfFamilyOutNameTargetDataStaticFacet
• Lake.instFamilyDefBuildKeyBuildDataKeyTargetOfFamilyOutProdNameCustomDataMk

Instances for deducing data types of BuildInfo keys

instance Lake.instFamilyDefBuildKeyBuildDataKeyModuleFacetOfFamilyOutNameModuleData {f : Lean.Name} {α : Type} {m : Module} [FamilyOut ModuleData f α] : FamilyDef BuildData (BuildInfo.moduleFacet m f).key α

instance Lake.instFamilyDefBuildKeyBuildDataKeyPackageFacetOfFamilyOutNamePackageData {f : Lean.Name} {α : Type} {p : Package} [FamilyOut PackageData f α] : FamilyDef BuildData (BuildInfo.packageFacet p f).key α

@[instance 100]

instance Lake.instFamilyDefBuildKeyBuildDataCustomTargetNameCustomDataMkName {n t : Lean.Name} {p : NPackage n} : FamilyDef BuildData (BuildKey.customTarget p.name t) (CustomData (n, t))

instance Lake.instFamilyDefBuildKeyBuildDataKeyTargetOfFamilyOutProdNameCustomDataMk {n t : Lean.Name} {α : Type} {p : NPackage n} [FamilyOut CustomData (n, t) α] : FamilyDef BuildData (BuildInfo.target p.toPackage t).key α

instance Lake.instFamilyDefBuildKeyBuildDataKeyLibraryFacetOfFamilyOutNameTargetDataHAppendMkStr1 {f : Lean.Name} {α : Type} {l : LeanLib} [FamilyOut TargetData (`leanLib ++ f) α] : FamilyDef BuildData (BuildInfo.libraryFacet l f).key α

instance Lake.instFamilyDefBuildKeyBuildDataKeyLeanExeOfFamilyOutNameTargetDataExeFacet {α : Type} {x : LeanExe} [FamilyOut TargetData LeanExe.exeFacet α] : FamilyDef BuildData (BuildInfo.leanExe x).key α

instance Lake.instFamilyDefBuildKeyBuildDataKeyStaticExternLibOfFamilyOutNameTargetDataStaticFacet {α : Type} {l : ExternLib} [FamilyOut TargetData ExternLib.staticFacet α] : FamilyDef BuildData (BuildInfo.staticExternLib l).key α

instance Lake.instFamilyDefBuildKeyBuildDataKeySharedExternLibOfFamilyOutNameTargetDataSharedFacet {α : Type} {l : ExternLib} [FamilyOut TargetData ExternLib.sharedFacet α] : FamilyDef BuildData (BuildInfo.sharedExternLib l).key α

instance Lake.instFamilyDefBuildKeyBuildDataKeyDynlibExternLibOfFamilyOutNameTargetDataDynlibFacet {α : Type} {l : ExternLib} [FamilyOut TargetData ExternLib.dynlibFacet α] : FamilyDef BuildData (BuildInfo.dynlibExternLib l).key α

Build Info & Facets

Complex Builtin Facet Declarations

Additional builtin facets missing from Build.Facets. These are defined here because they need configuration definitions (e.g., Module), whereas the facets there are needed by the configuration definitions.

@[reducible, inline]

abbrev Lake.Module.importsFacet : Lean.Name

The direct local imports of the Lean module.

Equations

• Lake.Module.importsFacet = `imports

instance Lake.instFamilyDefNameModuleDataMkStr1ArrayModule : FamilyDef ModuleData `imports (Array Module)

@[simp]

axiom Lake.ModuleData.imports : ModuleData `imports = Array Module

@[reducible, inline]

abbrev Lake.Module.transImportsFacet : Lean.Name

The transitive local imports of the Lean module.

Equations

• Lake.Module.transImportsFacet = `transImports

@[simp]

axiom Lake.ModuleData.transImports : ModuleData `transImports = Array Module

instance Lake.instFamilyDefNameModuleDataMkStr1ArrayModule_1 : FamilyDef ModuleData `transImports (Array Module)

@[reducible, inline]

abbrev Lake.Module.precompileImportsFacet : Lean.Name

The transitive local imports of the Lean module.

Equations

• Lake.Module.precompileImportsFacet = `precompileImports

@[simp]

axiom Lake.ModuleData.precompileImports : ModuleData `precompileImports = Array Module

instance Lake.instFamilyDefNameModuleDataMkStr1ArrayModule_2 : FamilyDef ModuleData `precompileImports (Array Module)

@[reducible, inline]

abbrev Lake.Module.dynlibFacet : Lean.Name

Shared library for --load-dynlib.

Equations

• Lake.Module.dynlibFacet = `dynlib

@[simp]

axiom Lake.ModuleData.dynlib : ModuleData `dynlib = Dynlib

instance Lake.instFamilyDefNameModuleDataMkStr1Dynlib : FamilyDef ModuleData `dynlib Dynlib

@[reducible, inline]

abbrev Lake.LeanLib.modulesFacet : Lean.Name

A Lean library's Lean modules.

Equations

• Lake.LeanLib.modulesFacet = `modules

instance Lake.instFamilyDefNameTargetDataHAppendMkStr1ArrayModule : FamilyDef TargetData (`leanLib ++ `modules) (Array Module)

@[simp]

axiom Lake.TargetData.leanLib.modules : TargetData (`leanLib ++ `modules) = Array Module

@[reducible, inline]

abbrev Lake.Package.depsFacet : Lean.Name

The package's array of dependencies.

Equations

• Lake.Package.depsFacet = `deps

@[simp]

axiom Lake.PackageData.deps : PackageData `deps = Array Package

instance Lake.instFamilyDefNamePackageDataMkStr1ArrayPackage : FamilyDef PackageData `deps (Array Package)

@[reducible, inline]

abbrev Lake.Package.transDepsFacet : Lean.Name

The package's complete array of transitive dependencies.

Equations

• Lake.Package.transDepsFacet = `transDeps

instance Lake.instFamilyDefNamePackageDataMkStr1ArrayPackage_1 : FamilyDef PackageData `transDeps (Array Package)

@[simp]

axiom Lake.PackageData.transDeps : PackageData `transDeps = Array Package

Facet Build Info Helper Constructors

Definitions to easily construct BuildInfo values for module, package, and target facets.

@[reducible, inline]

abbrev Lake.Module.facet (facet : Lean.Name) (self : Module) : BuildInfo

Build info for the module's specified facet.

Equations

• Lake.Module.facet facet self = Lake.BuildInfo.moduleFacet self facet

@[reducible, inline]

abbrev Lake.Module.imports (self : Module) : BuildInfo

The direct local imports of the Lean module.

Equations

• self.imports = Lake.Module.facet Lake.Module.importsFacet self

@[reducible, inline]

abbrev Lake.Module.transImports (self : Module) : BuildInfo

The transitive local imports of the Lean module.

Equations

• self.transImports = Lake.Module.facet Lake.Module.transImportsFacet self

@[reducible, inline]

abbrev Lake.Module.precompileImports (self : Module) : BuildInfo

The transitive local imports of the Lean module.

Equations

• self.precompileImports = Lake.Module.facet Lake.Module.precompileImportsFacet self

@[reducible, inline]

abbrev Lake.Module.deps (self : Module) : BuildInfo

The facet which builds all of a module's dependencies (i.e., transitive local imports and --load-dynlib shared libraries). Returns the list of shared libraries to load along with their search path.

Equations

• self.deps = Lake.Module.facet Lake.Module.depsFacet self

@[reducible, inline]

abbrev Lake.Module.leanArts (self : Module) : BuildInfo

The core build facet of a Lean file. Elaborates the Lean file via lean and produces all the Lean artifacts of the module (i.e., olean, ilean, c). Its trace just includes its dependencies.

Equations

• self.leanArts = Lake.Module.facet Lake.Module.leanArtsFacet self

@[reducible, inline]

abbrev Lake.Module.olean (self : Module) : BuildInfo

The olean file produced by lean.

Equations

• self.olean = Lake.Module.facet Lake.Module.oleanFacet self

@[reducible, inline]

abbrev Lake.Module.ilean (self : Module) : BuildInfo

The ilean file produced by lean.

Equations

• self.ilean = Lake.Module.facet Lake.Module.ileanFacet self

@[reducible, inline]

abbrev Lake.Module.c (self : Module) : BuildInfo

The C file built from the Lean file via lean.

Equations

• self.c = Lake.Module.facet Lake.Module.cFacet self

@[reducible, inline]

abbrev Lake.Module.bc (self : Module) : BuildInfo

The C file built from the Lean file via lean.

Equations

• self.bc = Lake.Module.facet Lake.Module.bcFacet self

@[reducible, inline]

abbrev Lake.Module.o (self : Module) : BuildInfo

The object file built from c/bc. On Windows with the C backend, no Lean symbols are exported. On every other configuration, symbols are exported.

Equations

• self.o = Lake.Module.facet Lake.Module.oFacet self

@[reducible, inline]

abbrev Lake.Module.oExport (self : Module) : BuildInfo

The object file built from c/bc (with Lean symbols exported).

Equations

• self.oExport = Lake.Module.facet Lake.Module.oExportFacet self

@[reducible, inline]

abbrev Lake.Module.oNoExport (self : Module) : BuildInfo

The object file built from c/bc (without Lean symbols exported).

Equations

• self.oNoExport = Lake.Module.facet Lake.Module.oNoExportFacet self

@[reducible, inline]

abbrev Lake.Module.co (self : Module) : BuildInfo

The object file .c.o built from c. On Windows, this is c.o.noexport, on other systems it is c.o.export).

Equations

• self.co = Lake.Module.facet Lake.Module.coFacet self

@[reducible, inline]

abbrev Lake.Module.coExport (self : Module) : BuildInfo

The object file .c.o.export built from c (with -DLEAN_EXPORTING).

Equations

• self.coExport = Lake.Module.facet Lake.Module.coExportFacet self

@[reducible, inline]

abbrev Lake.Module.coNoExport (self : Module) : BuildInfo

The object file .c.o.noexport built from c (without -DLEAN_EXPORTING).

Equations

• self.coNoExport = Lake.Module.facet Lake.Module.coNoExportFacet self

@[reducible, inline]

abbrev Lake.Module.bco (self : Module) : BuildInfo

The object file .bc.o built from bc.

Equations

• self.bco = Lake.Module.facet Lake.Module.bcoFacet self

@[reducible, inline]

abbrev Lake.Module.dynlib (self : Module) : BuildInfo

Shared library for --load-dynlib.

Equations

• self.dynlib = Lake.Module.facet Lake.Module.dynlibFacet self

@[reducible, inline]

abbrev Lake.Package.facet (facet : Lean.Name) (self : Package) : BuildInfo

Build info for the package's specified facet.

Equations

• Lake.Package.facet facet self = Lake.BuildInfo.packageFacet self facet

@[reducible, inline]

abbrev Lake.Package.buildCache (self : Package) : BuildInfo

A package's cached build archive (e.g., from Reservoir or GitHub). Will cause the whole build to fail if the archive cannot be fetched.

Equations

• self.buildCache = Lake.Package.facet Lake.Package.buildCacheFacet self

@[reducible, inline]

abbrev Lake.Package.optBuildCache (self : Package) : BuildInfo

A package's optional cached build archive (e.g., from Reservoir or GitHub). Will NOT cause the whole build to fail if the archive cannot be fetched.

Equations

• self.optBuildCache = Lake.Package.facet Lake.Package.optBuildCacheFacet self

@[reducible, inline]

abbrev Lake.Package.reservoirBarrel (self : Package) : BuildInfo

A package's Reservoir build archive from Reservoir. Will cause the whole build to fail if the barrel cannot be fetched.

Equations

• self.reservoirBarrel = Lake.Package.facet Lake.Package.reservoirBarrelFacet self

@[reducible, inline]

abbrev Lake.Package.optReservoirBarrel (self : Package) : BuildInfo

A package's optional build archive from Reservoir. Will NOT cause the whole build to fail if the barrel cannot be fetched.

Equations

• self.optReservoirBarrel = Lake.Package.facet Lake.Package.optReservoirBarrelFacet self

@[reducible, inline]

abbrev Lake.Package.gitHubRelease (self : Package) : BuildInfo

A package's build archive from a GitHub release. Will cause the whole build to fail if the release cannot be fetched.

Equations

• self.gitHubRelease = Lake.Package.facet Lake.Package.gitHubReleaseFacet self

@[reducible, inline]

abbrev Lake.Package.optGitHubRelease (self : Package) : BuildInfo

A package's optional build archive from a GitHub release. Will NOT cause the whole build to fail if the release cannot be fetched.

Equations

• self.optGitHubRelease = Lake.Package.facet Lake.Package.optGitHubReleaseFacet self

@[reducible, inline, deprecated Lake.Package.gitHubRelease (since := "2024-09-27")]

abbrev Lake.Package.release (self : Package) : BuildInfo

Equations

• Lake.Package.release = Lake.Package.gitHubRelease

@[reducible, inline, deprecated Lake.Package.optGitHubRelease (since := "2024-09-27")]

abbrev Lake.Package.optRelease (self : Package) : BuildInfo

Equations

• Lake.Package.optRelease = Lake.Package.optGitHubRelease

@[reducible, inline]

abbrev Lake.Package.extraDep (self : Package) : BuildInfo

A package's extraDepTargets mixed with its transitive dependencies'.

Equations

• self.extraDep = Lake.Package.facet Lake.Package.extraDepFacet self

@[reducible, inline]

abbrev Lake.Package.deps (self : Package) : BuildInfo

The package's array of dependencies.

Equations

• self.deps = Lake.Package.facet Lake.Package.depsFacet self

@[reducible, inline]

abbrev Lake.Package.transDeps (self : Package) : BuildInfo

The package's complete array of transitive dependencies.

Equations

• self.transDeps = Lake.Package.facet Lake.Package.transDepsFacet self

@[reducible, inline]

abbrev Lake.Package.target (target : Lean.Name) (self : Package) : BuildInfo

Build info for a custom package target.

Equations

• Lake.Package.target target self = Lake.BuildInfo.target self target

@[reducible, inline]

abbrev Lake.LeanLib.facet (self : LeanLib) (facet : Lean.Name) : BuildInfo

Build info of the Lean library's Lean binaries.

Equations

• self.facet facet = Lake.BuildInfo.libraryFacet self facet

@[reducible, inline]

abbrev Lake.LeanLib.modules (self : LeanLib) : BuildInfo

A Lean library's Lean modules.

Equations

• self.modules = self.facet Lake.LeanLib.modulesFacet

@[reducible, inline]

abbrev Lake.LeanLib.leanArts (self : LeanLib) : BuildInfo

A Lean library's Lean artifacts (i.e., olean, ilean, c).

Equations

• self.leanArts = self.facet Lake.LeanLib.leanArtsFacet

@[reducible, inline]

abbrev Lake.LeanLib.static (self : LeanLib) : BuildInfo

A Lean library's static artifact.

Equations

• self.static = self.facet Lake.LeanLib.staticFacet

@[reducible, inline]

abbrev Lake.LeanLib.staticExport (self : LeanLib) : BuildInfo

A Lean library's static artifact (with exported symbols).

Equations

• self.staticExport = self.facet Lake.LeanLib.staticExportFacet

@[reducible, inline]

abbrev Lake.LeanLib.shared (self : LeanLib) : BuildInfo

A Lean library's shared artifact.

Equations

• self.shared = self.facet Lake.LeanLib.sharedFacet

@[reducible, inline]

abbrev Lake.LeanLib.extraDep (self : LeanLib) : BuildInfo

A Lean library's extraDepTargets mixed with its package's.

Equations

• self.extraDep = self.facet Lake.LeanLib.extraDepFacet

@[reducible, inline]

abbrev Lake.LeanExe.exe (self : LeanExe) : BuildInfo

Build info of the Lean executable.

Equations

• self.exe = Lake.BuildInfo.leanExe self

@[reducible, inline]

abbrev Lake.ExternLib.static (self : ExternLib) : BuildInfo

Build info of the external library's static binary.

Equations

• self.static = Lake.BuildInfo.staticExternLib self

@[reducible, inline]

abbrev Lake.ExternLib.shared (self : ExternLib) : BuildInfo

Build info of the external library's shared binary.

Equations

• self.shared = Lake.BuildInfo.sharedExternLib self

@[reducible, inline]

abbrev Lake.ExternLib.dynlib (self : ExternLib) : BuildInfo

Build info of the external library's dynlib.

Equations

• self.dynlib = Lake.BuildInfo.dynlibExternLib self