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

instance Lean.instReprImport : Repr Import

instance Lean.instInhabitedImport : Inhabited Import

instance Lean.instToJsonImport : ToJson Import

instance Lean.instFromJsonImport : FromJson Import

instance Lean.instCoeNameImport : Coe Name Import

instance Lean.instToStringImport : ToString Import

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

instance Lean.instInhabitedModuleHeader : Inhabited ModuleHeader

instance Lean.instToJsonModuleHeader : ToJson ModuleHeader

instance Lean.instFromJsonModuleHeader : FromJson ModuleHeader

structure Lean.ImportArtifacts : Type

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

• oleanParts : Array System.FilePath

instance Lean.instReprImportArtifacts : Repr ImportArtifacts

instance Lean.instInhabitedImportArtifacts : Inhabited ImportArtifacts

instance Lean.instToJsonImportArtifacts : ToJson ImportArtifacts

instance Lean.instFromJsonImportArtifacts : FromJson ImportArtifacts

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

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

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

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

instance Lean.instInhabitedModuleArtifacts : Inhabited ModuleArtifacts

instance Lean.instToJsonModuleArtifacts : ToJson ModuleArtifacts

instance Lean.instFromJsonModuleArtifacts : FromJson ModuleArtifacts

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

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.

instance Lean.instReprModuleSetup : Repr ModuleSetup

instance Lean.instInhabitedModuleSetup : Inhabited ModuleSetup

instance Lean.instToJsonModuleSetup : ToJson ModuleSetup

instance Lean.instFromJsonModuleSetup : FromJson ModuleSetup

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

Load a ModuleSetup from a JSON file.