Search
View source code
Display the source code in std/path.d from which this page was generated on github.
Report a bug
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

# Function std.path.relativePath

Translates path into a relative path.

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

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

NameDescription
cs Whether matching path name components against the base path should be case-sensitive or not.
path A path name.
base The base path to construct the relative path from.

## Returns

The relative path.

asRelativePath which does not allocate memory

## Throws

Exception if the specified base directory is not absolute.

## Example

writeln(relativePath("foo")); // "foo"

version (Posix)
{
writeln(relativePath("foo", "/bar")); // "foo"
writeln(relativePath("/foo/bar", "/foo/bar")); // "."
writeln(relativePath("/foo/bar", "/foo/baz")); // "../bar"
writeln(relativePath("/foo/bar/baz", "/foo/woo/wee")); // "../../bar/baz"
writeln(relativePath("/foo/bar/baz", "/foo/bar")); // "baz"
}
version (Windows)
{
writeln(relativePath("foo", c:\bar)); // "foo"
writeln(relativePath(c:\foo\bar, c:\foo\bar)); // "."
writeln(relativePath(c:\foo\bar, c:\foo\baz)); // ..\bar
writeln(relativePath(c:\foo\bar\baz, c:\foo\woo\wee)); // ..\..\bar\baz
writeln(relativePath(c:\foo\bar\baz, c:\foo\bar)); // "baz"
writeln(relativePath(c:\foo\bar, d:\foo)); // c:\foo\bar
}


## Authors

Lars Tandle Kyllingstad, Walter Bright, Grzegorz Adam Hankiewicz, Thomas Kühne, Andrei Alexandrescu