lean4-htt/Lake/Config/Workspace.lean
2022-01-14 20:41:47 -08:00

96 lines
3.2 KiB
Text

/-
Copyright (c) 2021 Mac Malone. All rights reserved.
Released under Apache 2.0 license as described in the file LICENSE.
Authors: Mac Malone
-/
import Lean.Util.Paths
import Lake.Config.Opaque
import Lake.Config.WorkspaceConfig
import Lake.Config.Package
open System
open Lean (Name NameMap LeanPaths)
namespace Lake
/-- A Lake workspace -- the top-level package directory. -/
structure Workspace where
/-- The path to the workspace's directory. -/
dir : FilePath
/-- The workspace's configuration. -/
config : WorkspaceConfig
/-- Name-package map of packages within the workspace. -/
packageMap : NameMap Package := {}
deriving Inhabited
namespace OpaqueWorkspace
unsafe def unsafeMk (ws : Workspace) : OpaqueWorkspace :=
unsafeCast ws
@[implementedBy unsafeMk] constant mk (ws : Workspace) : OpaqueWorkspace
instance : Coe Workspace OpaqueWorkspace := ⟨mk⟩
instance : Inhabited OpaqueWorkspace := ⟨mk Inhabited.default⟩
unsafe def unsafeGet (self : OpaqueWorkspace) : Workspace :=
unsafeCast self
@[implementedBy unsafeGet] constant get (self : OpaqueWorkspace) : Workspace
instance : Coe OpaqueWorkspace Workspace := ⟨get⟩
@[simp] axiom get_mk {ws : Workspace} : get (mk ws) = ws
end OpaqueWorkspace
namespace Workspace
/-- Create a `Workspace` from a package using its directory and `WorkspaceConfig`. -/
def ofPackage (pkg : Package) : Workspace :=
{dir := pkg.dir, config := pkg.config.toWorkspaceConfig}
/-- The workspace's `dir` joined with its `packagesDir` configuration. -/
def packagesDir (self : Workspace) : FilePath :=
self.dir / self.config.packagesDir
/-- The `List` of packages to the workspace. -/
def packageList (self : Workspace) : List Package :=
self.packageMap.revFold (fun pkgs _ pkg => pkg :: pkgs) []
/-- The `Array` of packages to the workspace. -/
def packageArray (self : Workspace) : Array Package :=
self.packageMap.fold (fun pkgs _ pkg => pkgs.push pkg) #[]
/-- Add a package to the workspace. -/
def addPackage (pkg : Package) (self : Workspace) : Workspace :=
{self with packageMap := self.packageMap.insert pkg.name pkg}
/-- Get a package within the workspace by name. -/
def packageByName? (pkg : Name) (self : Workspace) : Option Package :=
self.packageMap.find? pkg
/-- Find a package in the workspace satisfying the given predicate (if one exists). -/
def findPackage? (f : Package → Bool) (self : Workspace) : Option Package :=
self.packageArray.find? f
/-- Check if the module is local to any package in the workspace. -/
def isLocalModule (mod : Name) (self : Workspace) : Bool :=
self.packageMap.any fun _ pkg => pkg.isLocalModule mod
/-- Get the package for the module in the workspace (if it is local to one). -/
def packageForModule? (mod : Name) (self : Workspace) : Option Package :=
self.findPackage? (·.isLocalModule mod)
/-- The `LEAN_PATH` of the workspace. -/
def oleanPath (self : Workspace) : SearchPath :=
self.packageList.map (·.oleanDir)
/-- The `LEAN_SRC_PATH` of the workspace. -/
def leanSrcPath (self : Workspace) : SearchPath :=
self.packageList.map (·.srcDir)
/-- The `LeanPaths` of the workspace. -/
def leanPaths (self : Workspace) : LeanPaths :=
let pkgs := self.packageList
LeanPaths.mk (pkgs.map (·.oleanDir)) (pkgs.map (·.srcDir))