DSL for Targets & Facets

Macros for declaring Lake targets and facets.

Facet Declarations

@[reducible, inline]

abbrev Lake.DSL.mkModuleFacetDecl (α : Type) (facet : Lean.Name) [OptDataKind α] [FormatQuery α] [FamilyDef ModuleData facet α] (f : Module → FetchM (Job α)) : ModuleFacetDecl

def Lake.DSL.expandModuleFacetDecl : Lean.Macro

@[reducible, inline]

abbrev Lake.DSL.mkPackageFacetDecl (α : Type) (facet : Lean.Name) [OptDataKind α] [FormatQuery α] [FamilyDef PackageData facet α] (f : Package → FetchM (Job α)) : PackageFacetDecl

def Lake.DSL.expandPackageFacetDecl : Lean.Macro

@[reducible, inline]

abbrev Lake.DSL.mkLibraryFacetDecl (α : Type) (facet : Lean.Name) [OptDataKind α] [FormatQuery α] [FamilyDef LibraryData facet α] (f : LeanLib → FetchM (Job α)) : LibraryFacetDecl

def Lake.DSL.expandLibraryFacetDecl : Lean.Macro

Custom Target Declaration

@[reducible, inline]

abbrev Lake.DSL.mkTargetDecl (α : Type) (pkgName target : Lean.Name) [OptDataKind α] [FormatQuery α] [FamilyDef (CustomData pkgName) target α] (f : NPackage pkgName → FetchM (Job α)) : TargetDecl

def Lake.DSL.expandTargetCommand : Lean.Macro

Lean Library & Executable Target Declarations

@[reducible, inline]

abbrev Lake.DSL.mkConfigDecl (pkg name kind : Lean.Name) (config : ConfigType kind pkg name) [FamilyDef (CustomData pkg) name (ConfigTarget kind)] [FamilyDef DataType kind (ConfigTarget kind)] : KConfigDecl kind

def Lake.DSL.mkConfigDeclDef (tyName attr kind : Lean.Name) [ConfigInfo tyName] [delTyName : TypeName (KConfigDecl kind)] (doc? : Option DocComment) (attrs? : Option Attributes) (nameStx? : Option IdentOrStr) (cfg : OptConfig) : Lean.Elab.Command.CommandElabM Lean.Command

def Lake.DSL.elabLeanLibCommand : Lean.Elab.Command.CommandElab

@[reducible, inline]

abbrev Lake.DSL.LeanLibCommand : Type

Define a new Lean library target for the package. Can optionally be provided with a configuration of type LeanLibConfig. Has many forms:

lean_lib «target-name»
lean_lib «target-name» { /- config opts -/ }
lean_lib «target-name» where /- config opts -/

instance Lake.DSL.instCoeLeanLibCommandCommand : Coe LeanLibCommand Lean.Command

def Lake.DSL.elabLeanExeCommand : Lean.Elab.Command.CommandElab

@[reducible, inline]

abbrev Lake.DSL.LeanExeCommand : Type

Define a new Lean binary executable target for the package. Can optionally be provided with a configuration of type LeanExeConfig. Has many forms:

lean_exe «target-name»
lean_exe «target-name» { /- config opts -/ }
lean_exe «target-name» where /- config opts -/

instance Lake.DSL.instCoeLeanExeCommandCommand : Coe LeanExeCommand Lean.Command

def Lake.DSL.elabInputfileCommand : Lean.Elab.Command.CommandElab

@[reducible, inline]

abbrev Lake.DSL.InputFileCommand : Type

Define a new input file target for the package. Can optionally be provided with a configuration of type InputFileConfig.

instance Lake.DSL.instCoeInputFileCommandCommand : Coe InputFileCommand Lean.Command

def Lake.DSL.elabInputDirCommand : Lean.Elab.Command.CommandElab

@[reducible, inline]

abbrev Lake.DSL.InputDirCommand : Type

Define a new input directory target for the package. Can optionally be provided with a configuration of type InputDirConfig.

instance Lake.DSL.instCoeInputDirCommandCommand : Coe InputDirCommand Lean.Command

External Library Target Declaration

@[reducible, inline]

abbrev Lake.DSL.mkExternLibDecl (pkgName name : Lean.Name) [FamilyDef (CustomData pkgName) (name.str "static") System.FilePath] [FamilyDef (CustomData pkgName) name (ConfigTarget ExternLib.configKind)] : ExternLibDecl

def Lake.DSL.expandExternLibCommand : Lean.Macro