relativePath

fnstring relativePath(CaseSensitive cs = CaseSensitive.osDefault)(string path, lazy string base = getcwd())

Translates path into a relative path.

The returned path is relative to base, which is by default taken to be the current working directory. If specified, base must be an absolute path, and it is always assumed to refer to a directory. If path and base refer to the same directory, the function returns `.`.

The following algorithm is used:

  1. If path is a relative directory, return it unaltered.
  2. Find a common root between path and base.

    If there is no common root, return path unaltered.

  3. Prepare a string with as many `../` or `..\` as

    necessary to reach the common root from base path.

  4. Append the remaining segments of path to the string

    and return.

In the second step, path components are compared using filenameCmp!cs, where cs is an optional template parameter determining whether the comparison is case sensitive or not. See the

filenameCmp documentation for details.

This function allocates memory.

Parameters

csWhether matching path name components against the base path should be case-sensitive or not.
pathA path name.
baseThe base path to construct the relative path from.

Returns

The relative path.

See Also

asRelativePath which does not allocate memory

Throws

Exception if the specified _base directory is not absolute.