Module Setup Information

Data types used by Lean module headers and the --setup CLI.

structure Lean.Import : Type

• module : Name
• importAll : Bool

  import all; whether to import and expose all data saved by the module.

• isExported : Bool

  Whether to activate this import when the current module itself is imported.

• isMeta : Bool

  Whether all definitions (transitively) reachable through the

def Lean.instReprImport.repr : Import → Nat → Format

Equations

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

instance Lean.instReprImport : Repr Import

Equations

• Lean.instReprImport = { reprPrec := Lean.instReprImport.repr }

instance Lean.instInhabitedImport : Inhabited Import

Equations

• Lean.instInhabitedImport = { default := Lean.instInhabitedImport.default }

def Lean.instInhabitedImport.default : Import

Equations

• Lean.instInhabitedImport.default = { module := default, importAll := default, isExported := default, isMeta := default }

instance Lean.instToJsonImport : ToJson Import

Equations

• Lean.instToJsonImport = { toJson := Lean.instToJsonImport.toJson }

def Lean.instToJsonImport.toJson : Import → Json

Equations

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

instance Lean.instFromJsonImport : FromJson Import

Equations

• Lean.instFromJsonImport = { fromJson? := Lean.instFromJsonImport.fromJson }

def Lean.instFromJsonImport.fromJson : Json → Except String Import

Equations

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

def Lean.instBEqImport.beq : Import → Import → Bool

Equations

• One or more equations did not get rendered due to their size.
• Lean.instBEqImport.beq x✝¹ x✝ = false

instance Lean.instBEqImport : BEq Import

Equations

• Lean.instBEqImport = { beq := Lean.instBEqImport.beq }

instance Lean.instHashableImport : Hashable Import

Equations

• Lean.instHashableImport = { hash := Lean.instHashableImport.hash }

def Lean.instHashableImport.hash : Import → UInt64

Equations

• Lean.instHashableImport.hash { module := a, importAll := a_1, isExported := a_2, isMeta := a_3 } = mixHash (mixHash (mixHash (mixHash 0 (hash a)) (hash a_1)) (hash a_2)) (hash a_3)

instance Lean.instCoeNameImport : Coe Name Import

Equations

• Lean.instCoeNameImport = { coe := fun (x : Lean.Name) => { module := x } }

instance Lean.instToStringImport : ToString Import

Equations

• Lean.instToStringImport = { toString := fun (imp : Lean.Import) => toString imp.module }

structure Lean.ModuleHeader : Type

Abstract structure of a module's header.

• imports : Array Import

  The module's direct imports (i.e., those listed in the header).

• isModule : Bool

  Whether the module is participating in the module system.

instance Lean.instReprModuleHeader : Repr ModuleHeader

Equations

• Lean.instReprModuleHeader = { reprPrec := Lean.instReprModuleHeader.repr }

def Lean.instReprModuleHeader.repr : ModuleHeader → Nat → Format

Equations

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

instance Lean.instInhabitedModuleHeader : Inhabited ModuleHeader

Equations

• Lean.instInhabitedModuleHeader = { default := Lean.instInhabitedModuleHeader.default }

def Lean.instInhabitedModuleHeader.default : ModuleHeader

Equations

• Lean.instInhabitedModuleHeader.default = { imports := default, isModule := default }

instance Lean.instToJsonModuleHeader : ToJson ModuleHeader

Equations

• Lean.instToJsonModuleHeader = { toJson := Lean.instToJsonModuleHeader.toJson }

def Lean.instToJsonModuleHeader.toJson : ModuleHeader → Json

Equations

• Lean.instToJsonModuleHeader.toJson x✝ = Lean.Json.mkObj [[("imports", Lean.toJson x✝.imports)], [("isModule", Lean.toJson x✝.isModule)]].flatten

def Lean.instFromJsonModuleHeader.fromJson : Json → Except String ModuleHeader

Equations

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

instance Lean.instFromJsonModuleHeader : FromJson ModuleHeader

Equations

• Lean.instFromJsonModuleHeader = { fromJson? := Lean.instFromJsonModuleHeader.fromJson }

structure Lean.ImportArtifacts : Type

Module data files used for an import statement. This structure is designed for efficient JSON serialization.

• ofArray :: (
• toArray : Array System.FilePath
• )

def Lean.instReprImportArtifacts.repr : ImportArtifacts → Nat → Format

Equations

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

instance Lean.instReprImportArtifacts : Repr ImportArtifacts

Equations

• Lean.instReprImportArtifacts = { reprPrec := Lean.instReprImportArtifacts.repr }

def Lean.instInhabitedImportArtifacts.default : ImportArtifacts

Equations

• Lean.instInhabitedImportArtifacts.default = { toArray := default }

instance Lean.instInhabitedImportArtifacts : Inhabited ImportArtifacts

Equations

• Lean.instInhabitedImportArtifacts = { default := Lean.instInhabitedImportArtifacts.default }

instance Lean.instToJsonImportArtifacts : ToJson ImportArtifacts

Equations

• Lean.instToJsonImportArtifacts = { toJson := fun (x : Lean.ImportArtifacts) => Lean.toJson x.toArray }

instance Lean.instFromJsonImportArtifacts : FromJson ImportArtifacts

Equations

• Lean.instFromJsonImportArtifacts = { fromJson? := fun (x : Lean.Json) => Lean.ImportArtifacts.ofArray <$> Lean.fromJson? x }

def Lean.ImportArtifacts.size (arts : ImportArtifacts) : Nat

Equations

• arts.size = arts.toArray.size

def Lean.ImportArtifacts.olean? (arts : ImportArtifacts) : Option System.FilePath

Equations

• arts.olean? = arts.toArray[0]?

def Lean.ImportArtifacts.ir? (arts : ImportArtifacts) : Option System.FilePath

Equations

• arts.ir? = arts.toArray[1]?

def Lean.ImportArtifacts.oleanServer? (arts : ImportArtifacts) : Option System.FilePath

Equations

• arts.oleanServer? = arts.toArray[2]?

def Lean.ImportArtifacts.oleanPrivate? (arts : ImportArtifacts) : Option System.FilePath

Equations

• arts.oleanPrivate? = arts.toArray[3]?

def Lean.ImportArtifacts.oleanParts (inServer : Bool) (arts : ImportArtifacts) : Array System.FilePath

Equations

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

structure Lean.ModuleArtifacts : Type

Files containing data for a single module.

• lean? : Option System.FilePath
• olean? : Option System.FilePath
• oleanServer? : Option System.FilePath
• oleanPrivate? : Option System.FilePath
• ilean? : Option System.FilePath
• ir? : Option System.FilePath
• c? : Option System.FilePath
• bc? : Option System.FilePath

instance Lean.instReprModuleArtifacts : Repr ModuleArtifacts

Equations

• Lean.instReprModuleArtifacts = { reprPrec := Lean.instReprModuleArtifacts.repr }

def Lean.instReprModuleArtifacts.repr : ModuleArtifacts → Nat → Format

Equations

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

instance Lean.instInhabitedModuleArtifacts : Inhabited ModuleArtifacts

Equations

• Lean.instInhabitedModuleArtifacts = { default := Lean.instInhabitedModuleArtifacts.default }

def Lean.instInhabitedModuleArtifacts.default : ModuleArtifacts

Equations

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

def Lean.instToJsonModuleArtifacts.toJson : ModuleArtifacts → Json

Equations

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

instance Lean.instToJsonModuleArtifacts : ToJson ModuleArtifacts

Equations

• Lean.instToJsonModuleArtifacts = { toJson := Lean.instToJsonModuleArtifacts.toJson }

def Lean.instFromJsonModuleArtifacts.fromJson : Json → Except String ModuleArtifacts

Equations

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

instance Lean.instFromJsonModuleArtifacts : FromJson ModuleArtifacts

Equations

• Lean.instFromJsonModuleArtifacts = { fromJson? := Lean.instFromJsonModuleArtifacts.fromJson }

def Lean.ModuleArtifacts.oleanParts (arts : ModuleArtifacts) : Array System.FilePath

Equations

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

structure Lean.ModuleSetup : Type

A module's setup information as described by a JSON file.

• name : Name

  Name of the module.

• isModule : Bool

  Whether the module, by default, participates in the module system. Even if false, a module can still choose to participate by using module in its header.

• imports? : Option (Array Import)

  The module's direct imports. If none, uses the imports from the module header.

• importArts : NameMap ImportArtifacts

  Pre-resolved artifacts of transitively imported modules.

• dynlibs : Array System.FilePath

  Dynamic libraries to load with the module.

• plugins : Array System.FilePath

  Plugins to initialize with the module.

• options : LeanOptions

  Additional options for the module.

def Lean.instReprModuleSetup.repr : ModuleSetup → Nat → Format

Equations

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

instance Lean.instReprModuleSetup : Repr ModuleSetup

Equations

• Lean.instReprModuleSetup = { reprPrec := Lean.instReprModuleSetup.repr }

instance Lean.instInhabitedModuleSetup : Inhabited ModuleSetup

Equations

• Lean.instInhabitedModuleSetup = { default := Lean.instInhabitedModuleSetup.default }

def Lean.instInhabitedModuleSetup.default : ModuleSetup

Equations

• Lean.instInhabitedModuleSetup.default = { name := default, isModule := default, imports? := default, importArts := default, dynlibs := default, plugins := default, options := default }

instance Lean.instToJsonModuleSetup : ToJson ModuleSetup

Equations

• Lean.instToJsonModuleSetup = { toJson := Lean.instToJsonModuleSetup.toJson }

def Lean.instToJsonModuleSetup.toJson : ModuleSetup → Json

Equations

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

def Lean.instFromJsonModuleSetup.fromJson : Json → Except String ModuleSetup

Equations

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

instance Lean.instFromJsonModuleSetup : FromJson ModuleSetup

Equations

• Lean.instFromJsonModuleSetup = { fromJson? := Lean.instFromJsonModuleSetup.fromJson }

def Lean.ModuleSetup.load (path : System.FilePath) : IO ModuleSetup

Load a ModuleSetup from a JSON file.

Equations

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