Common Build Tools

This file defines general utilities that abstract common build functionality and provides some common concrete build functions.

General Utilities

@[specialize #[]]

def Lake.BuildTrace.checkUpToDate {ι : Type u_1} [Lake.CheckExists ι] [Lake.GetMTime ι] (info : ι) (depTrace : Lake.BuildTrace) (traceFile : Lake.FilePath) : Lake.JobM Bool

Check if the info is up-to-date by comparing depTrace with traceFile.

@[inline]

def Lake.buildUnlessUpToDate {ι : Type u_1} [Lake.CheckExists ι] [Lake.GetMTime ι] (info : ι) (depTrace : Lake.BuildTrace) (traceFile : Lake.FilePath) (build : Lake.JobM PUnit) : Lake.JobM PUnit

Build info unless it already exists and depTrace matches that of the traceFile. If rebuilt, save the new depTrace to the tracefile.

def Lake.fetchFileTrace (file : Lake.FilePath) : Lake.BuildM Lake.BuildTrace

Fetch the trace of a file that may have its hash already cached in a .hash file.

def Lake.cacheFileHash (file : Lake.FilePath) : IO Lake.Hash

Compute the hash of a file and save it to a .hash file.

def Lake.buildFileUnlessUpToDate (file : Lake.FilePath) (depTrace : Lake.BuildTrace) (build : Lake.BuildM PUnit) : Lake.BuildM Lake.BuildTrace

Build file using build unless it already exists and depTrace matches the trace stored in the .trace file. If built, save the new depTrace and cache file's hash in a .hash file. Otherwise, try to fetch the hash from the .hash file using fetchFileTrace.

By example, for file := "foo.c", compare depTrace with that in foo.c.trace and cache the hash using foo.c.hash.

@[inline]

def Lake.buildFileAfterDep {α : Type} (file : Lake.FilePath) (dep : Lake.BuildJob α) (build : α → Lake.BuildM PUnit) (extraDepTrace : optParam (Lake.BuildM Lake.BuildTrace) (pure Lake.BuildTrace.nil)) : Lake.SchedulerM (Lake.BuildJob Lake.FilePath)

Build file using build after dep completes if the dependency's trace (and/or extraDepTrace) has changed.

@[inline]

def Lake.buildFileAfterDepList {α : Type} (file : Lake.FilePath) (deps : List (Lake.BuildJob α)) (build : List α → Lake.BuildM PUnit) (extraDepTrace : optParam (Lake.BuildM Lake.BuildTrace) (pure Lake.BuildTrace.nil)) : Lake.SchedulerM (Lake.BuildJob Lake.FilePath)

Build file using build after deps have built if any of their traces change.

@[inline]

def Lake.buildFileAfterDepArray {α : Type} (file : Lake.FilePath) (deps : Array (Lake.BuildJob α)) (build : Array α → Lake.BuildM PUnit) (extraDepTrace : optParam (Lake.BuildM Lake.BuildTrace) (pure Lake.BuildTrace.nil)) : Lake.SchedulerM (Lake.BuildJob Lake.FilePath)

Build file using build after deps have built if any of their traces change.

Common Builds

def Lake.inputFile (path : Lake.FilePath) : Lake.SchedulerM (Lake.BuildJob Lake.FilePath)

A build job for file that is expected to already exist (e.g., a source file).

@[inline]

def Lake.buildO (name : String) (oFile : Lake.FilePath) (srcJob : Lake.BuildJob Lake.FilePath) (weakArgs : optParam (Array String) #[]) (traceArgs : optParam (Array String) #[]) (compiler : optParam Lake.FilePath { toString := "cc" }) (extraDepTrace : optParam (Lake.BuildM Lake.BuildTrace) (pure Lake.BuildTrace.nil)) : Lake.SchedulerM (Lake.BuildJob Lake.FilePath)

Build an object file from a source file job using compiler. The invocation is:

compiler -c -o oFile srcFile weakArgs... traceArgs...

The traceArgs are included as part of the dependency trace hash, whereas the weakArgs are not. Thus, system-dependent options like -I or -L should be weakArgs to avoid build artifact incompatibility between systems (i.e., a change in the file path should not cause a rebuild).

You can add more components to the trace via extraDepTrace, which will be computed in the resulting BuildJob before building.

@[inline]

def Lake.buildLeanO (name : String) (oFile : Lake.FilePath) (srcJob : Lake.BuildJob Lake.FilePath) (weakArgs : optParam (Array String) #[]) (traceArgs : optParam (Array String) #[]) : Lake.SchedulerM (Lake.BuildJob Lake.FilePath)

Build an object file from a source fie job (i.e, a lean -c output) using leanc.

def Lake.buildStaticLib (libFile : Lake.FilePath) (oFileJobs : Array (Lake.BuildJob Lake.FilePath)) : Lake.SchedulerM (Lake.BuildJob Lake.FilePath)

Build a static library from object file jobs using the ar packaged with Lean.

def Lake.buildLeanSharedLib (libFile : Lake.FilePath) (linkJobs : Array (Lake.BuildJob Lake.FilePath)) (weakArgs : optParam (Array String) #[]) (traceArgs : optParam (Array String) #[]) : Lake.SchedulerM (Lake.BuildJob Lake.FilePath)

Build a shared library by linking the results of linkJobs using leanc.

def Lake.buildLeanExe (exeFile : Lake.FilePath) (linkJobs : Array (Lake.BuildJob Lake.FilePath)) (weakArgs : optParam (Array String) #[]) (traceArgs : optParam (Array String) #[]) : Lake.SchedulerM (Lake.BuildJob Lake.FilePath)

Build an executable by linking the results of linkJobs using leanc.

def Lake.buildLeanSharedLibOfStatic (staticLibJob : Lake.BuildJob Lake.FilePath) (weakArgs : optParam (Array String) #[]) (traceArgs : optParam (Array String) #[]) : Lake.SchedulerM (Lake.BuildJob Lake.FilePath)

Build a shared library from a static library using leanc.

def Lake.computeDynlibOfShared (sharedLibTarget : Lake.BuildJob Lake.FilePath) : Lake.SchedulerM (Lake.BuildJob Lake.Dynlib)

Construct a Dynlib object for a shared library target.