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

Is this symbolic path allowed to be absolute, or must it be relative?

Abstract directory: current working directory.

See Note [Symbolic paths] in Distribution.Utils.Path.

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

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: dist directory (e.g. dist-newstyle).

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: source directory (a search directory for source files).

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: include directory (a search directory for CPP includes like header files, e.g. with ghc -I).

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: search directory for extra libraries.

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: MacOS framework directory.

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: build directory.

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: directory for build artifacts, such as documentation or .hie files.

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: package database directory.

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: data files directory.

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: directory for HPC .mix files.

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: directory for HPC .tix files.

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: a temporary directory.

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: directory for response files.

See Note [Symbolic paths] in Distribution.Utils.Path.

Abstract directory: directory for pkg-config files.

See Note [Symbolic paths] in Distribution.Utils.Path.

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).

A symbolic path which is allowed to be absolute.

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

A symbolic path, possibly 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).

Extract the FilePath underlying a SymbolicPathX or RelativePath, without interpreting it.

Use this function e.g. to validate the underlying filepath.

When interacting with the file system, you should instead use interpretSymbolicPath or interpretSymbolicPathCWD.

See Note [Symbolic paths] in Distribution.Utils.Path.

A symbolic path from a directory to itself.

Make a RelativePath, ensuring the path is not absolute, but performing no further checks.

Make a SymbolicPathX, which may be relative or absolute.

Make a SymbolicPathX which may be relative or absolute, without performing any checks.

Avoid using this function in new code.

Change what a symbolic path is pointing to.

Change both what a symbolic path is pointing from and pointing to.

Avoid using this in new code.

Weakening: convert a relative symbolic path to a symbolic path, "forgetting" that it is relative.

Is this symbolic path a relative symbolic path?

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.

NB: when invoking external programs (such as GHC), it is preferable to set the working directory of the process and use interpretSymbolicPathCWD rather than calling this function, as this function will turn relative paths into absolute paths if the working directory is an absolute path. This can degrade error messages, or worse, break the behaviour entirely (because the program might expect certain paths to be relative).

See Note [Symbolic paths] in Distribution.Utils.Path.

Like </>, but also supporting symbolic paths.

Like <.>, but also supporting symbolic paths.

Like takeDirectory, for symbolic paths.

Like dropExtensions, for symbolic paths.

Like replaceExtension, for symbolic paths.

Like normalise, for symbolic paths.

Interpret a symbolic path, **under the assumption that the working directory is the package directory**.

Use interpretSymbolicPath instead if you need to take into account a working directory argument before directly interacting with the file system.

Use this function instead of interpretSymbolicPath when invoking a child process: set the working directory of the sub-process, and use this function, e.g.:

callGhc :: Maybe (SymbolicPath CWD (Dir Pkg))
        -> SymbolicPath (Dir Pkg) File
        -> IO ()
callGhc mbWorkDir inputFile =
  runProgramInvocation $
    programInvocationCwd mbWorkDir ghcProg [interpretSymbolicPathCWD inputFile]

In this example, programInvocationCwd sets the working directory, so it is appropriate to use interpretSymbolicPathCWD to provide its arguments.

See Note [Symbolic paths] in Distribution.Utils.Path.

Absolute path to the current working directory.

Try to make a symbolic path relative.

This function does nothing if the path is already relative.

NB: this function may fail to make the path relative.

Retrieve the relative symbolic path to a Haskell module.