BuildEnv.Path

Documentation

type SymbolicPath = SymbolicPathX 'AllowAbsolute

A path which is either absolute or relative to the given abstract* location specified by the from type parameter.

They are *symbolic*, which means we cannot perform any IO until we interpret them (using e.g. interpretSymbolicPath).

type RelativePath = SymbolicPathX 'OnlyRelative

A symbolic relative path, relative to an abstract location specified by the from type parameter.

They are *symbolic*, which means we cannot perform any IO until we interpret them (using e.g. interpretSymbolicPath).

data AbsolutePath to

An absolute path, or a reference to a path from the PATH environment variable.

Instances

Show (AbsolutePath to)

Defined in BuildEnv.Path

Methods

showsPrec :: Int -> AbsolutePath to -> ShowS

show :: AbsolutePath to -> String

showList :: [AbsolutePath to] -> ShowS

data FileOrDir

A type-level symbolic name, to an abstract file or directory (e.g. the Cabal package directory).

Constructors

File

A file (with no further information).

Dir Type

The abstract name of a directory or category of directories, e.g. the package directory or a source directory.

data CWD

Abstract directory: current working directory.

data Pkg

Abstract directory: package directory (e.g. a directory containing the .cabal file).

data PkgDb

Abstract directory: package database directory (e.g. a directory containing a package.conf file).

data Project

Abstract directory: project root for 'build-env' commands.

data Tmp

Abstract temporary directory.

data Logs

Abstract directory for logs.

data Fetch

Abstract directory: fetched sources directory.

data Prefix

Abstract directory: prefix.

data Install

Abstract directory: installation directory.

sameDirectory :: SymbolicPathX allowAbsolute from to

mkSymbolicPath :: FilePath -> SymbolicPath from to

mkRelativePath :: FilePath -> RelativePath from to

mkAbsolutePath :: FilePath -> AbsolutePath to

interpretSymbolicPath :: SymbolicPath CWD (Dir dir) -> SymbolicPathX allowAbsolute dir to -> FilePath

Interpret a symbolic path with respect to the given directory.

Use this function before directly interacting with the file system in order to take into account a working directory argument.

getSymbolicPath :: SymbolicPathX allowAbsolute from to -> FilePath

getAbsolutePath :: AbsolutePath to -> FilePath

absoluteSymbolicPath :: AbsolutePath to -> SymbolicPath from to

makeAbsolute :: SymbolicPath CWD (Dir dir) -> SymbolicPath dir to -> IO (AbsolutePath to)

Make the given SymbolicPathX absolute.

(<.>) :: FileLike p => p -> String -> p infixr 7

Like <.>, but also supporting symbolic paths.

(</>) :: PathLike p q r => p -> q -> r infixr 5

Like </>, but also supporting symbolic paths.