Lean.Util.Path

If the package of mod can be found in sp, return the path with extension ext (lean or olean) corresponding to mod. Otherwise, return none. Does not check whether the returned path exists.

Equations

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

source

def Lean.SearchPath.findModuleWithExt (sp : Lean.SearchPath) (ext : String) (mod : Lean.Name) :

IO (Option System.FilePath)

Like findWithExt, but ensures the returned path exists.

Equations

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

source

def Lean.SearchPath.findAllWithExt (sp : Lean.SearchPath) (ext : String) :

IO (Array System.FilePath)

Equations

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

source

opaque Lean.searchPathRef:

IO.Ref Lean.SearchPath

source

@[export lean_get_prefix]

def Lean.getBuildDir:

IO System.FilePath

Equations

Lean.getBuildDir = do let a ← IO.appDir pure (Option.get! (System.FilePath.parent a))

source

@[export lean_get_libdir]

def Lean.getLibDir (leanSysroot : System.FilePath) :

IO System.FilePath

Equations

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

source

def Lean.getBuiltinSearchPath (leanSysroot : System.FilePath) :

IO Lean.SearchPath

Equations

Lean.getBuiltinSearchPath leanSysroot = do let a ← Lean.getLibDir leanSysroot pure [a]

source

def Lean.addSearchPathFromEnv (sp : Lean.SearchPath) :

IO Lean.SearchPath

Equations

Lean.addSearchPathFromEnv sp = do let val ← liftM (IO.getEnv "LEAN_PATH") match val with | none => pure sp | some val => pure (System.SearchPath.parse val ++ sp)

source

def Lean.initSearchPath (leanSysroot : System.FilePath) (sp : optParam Lean.SearchPath ∅) :

IO Unit

Initialize Lean's search path given Lean's system root and an initial search path. The system root can be obtained via getBuildDir (for internal use) or findSysroot (for external users).

Equations

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

source

def Lean.findOLean (mod : Lean.Name) :

IO System.FilePath

Equations

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

source

partial def Lean.findOLean.maybeThisOne (pkg : System.FilePath) (dir : System.FilePath) :

IO (Option String)

source

@[export lean_module_name_of_file]

def Lean.moduleNameOfFileName (fname : System.FilePath) (rootDir : Option System.FilePath) :

IO Lean.Name

Infer module name of source file name.

Equations

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

source

def Lean.searchModuleNameOfFileName (fname : System.FilePath) (rootDirs : Lean.SearchPath) :

IO (Option Lean.Name)

Equations

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

source

def Lean.findSysroot (lean : optParam String "lean") :

IO System.FilePath

Find the system root of the given lean command by calling lean --print-prefix and returning the path it prints. Defaults to trying the lean in PATH. If set, the LEAN_SYSROOT environment variable takes precedence. Note that the called lean binary might not be part of the system root, e.g. in the case of elan's proxy binary. Users internal to Lean should use Lean.getBuildDir instead.

Equations

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