paths

nimony/lib/std/paths.nim

This module implements path handling.

See also:

files module for file access

```
type Path = object
  data: string
```
func path(s: string): Path
Constructs a Path from the raw string s (normalization happens on demand).
func $(x: Path): string
String form of x (native path representation).
proc hash(x: Path): uint64
Stable hash honoring filesystem case sensitivity (hashIgnoreCase on case-insensitive FS).
func ==(x: Path; y: Path): bool
Compares two paths.
On a case-sensitive filesystem this is done case-sensitively otherwise case-insensitively.
func add(x: var Path; y: Path)
func /(head: Path; tail: Path): Path
Joins two directory names to one.
returns normalized path concatenation of head and tail, preserving whether or not tail has a trailing slash (or, if tail if empty, whether head has one).
See also:
- splitPath proc_
- uri.combine proc
- uri./ proc
func splitPath(path: Path): tuple[head: Path, tail: Path]
Splits a directory into (head, tail) tuple, so that head / tail == path (except for edge cases like "/usr").
See also:
- add proc_
- / proc_
- /../ proc_
- relativePath proc_
func splitFile(path: Path): tuple[dir: Path, name: Path, ext: string]
Splits a filename into (dir, name, extension) tuple.
dir does not end in DirSep unless it's /. extension includes the leading dot.
If path has no extension, ext is the empty string. If path has no directory component, dir is the empty string. If path has no filename component, name and ext are empty strings.
See also:
- extractFilename proc_
- lastPathPart proc_
- changeFileExt proc_
- addFileExt proc_
func isAbsolute(path: Path): bool
Checks whether a given path is absolute.
On Windows, network paths are considered absolute too.
proc relativePath(path: Path; base: Path; sep: char): Path
Converts path to a path relative to base.
The sep (default: DirSep) is used for the path normalizations, this can be useful to ensure the relative path only contains '/' so that it can be used for URL constructions.
On Windows, if a root of path and a root of base are different, returns path as is because it is impossible to make a relative path. That means an absolute path can be returned.
See also:
- splitPath proc_
- parentDir proc_
- tailDir proc_
proc isRelativeTo(path: Path; base: Path): bool
Returns true if path is relative to base.
func parentDir(path: Path): Path
Returns the parent directory of path.
This is similar to splitPath(path).head when path doesn't end in a dir separator, but also takes care of path normalizations. The remainder can be obtained with lastPathPart(path) proc_.
See also:
- relativePath proc_
- splitPath proc_
- tailDir proc_
- parentDirs iterator_
func tailDir(path: Path): Path
Returns the tail part of path.
See also:
- relativePath proc_
- splitPath proc_
- parentDir proc_
func isRootDir(path: Path): bool
Checks whether a given path is a root directory.
iterator parentDirs(path: Path; fromRoot: bool; inclusive: bool): Path
Walks over all parent directories of a given path.
If fromRoot is true (default: false), the traversal will start from the file system root directory. If inclusive is true (default), the original argument will be included in the traversal.
Relative paths won't be expanded by this iterator. Instead, it will traverse only the directories appearing in the relative path.
See also:
- parentDir proc_
func /../(head: Path; tail: Path): Path
The same as parentDir(head) / tail, unless there is no parent directory. Then head / tail is performed instead.
See also:
- / proc_
- parentDir proc_
func extractFilename(path: Path): Path
Extracts the filename of a given path.
This is the same as name & ext from splitFile(path) proc_.
See also:
- splitFile proc_
- lastPathPart proc_
- changeFileExt proc_
- addFileExt proc_
func lastPathPart(path: Path): Path
Like extractFilename proc_, but ignores trailing dir separator; aka: baseName:idx: in some other languages.
See also:
- splitFile proc_
- extractFilename proc_
- changeFileExt proc_
- addFileExt proc_
func changeFileExt(filename: Path; ext: string): Path
Changes the file extension to ext.
If the filename has no extension, ext will be added. If ext == "" then any extension is removed.
Ext should be given without the leading '.', because some filesystems may use a different character. (Although I know of none such beast.)
See also:
- splitFile proc_
- extractFilename proc_
- lastPathPart proc_
- addFileExt proc_
func addFileExt(filename: Path; ext: string): Path
Adds the file extension ext to filename, unless filename already has an extension.
Ext should be given without the leading '.', because some filesystems may use a different character. (Although I know of none such beast.)
See also:
- splitFile proc_
- extractFilename proc_
- lastPathPart proc_
- changeFileExt proc_
func unixToNativePath(path: Path; drive: Path): Path
Converts an UNIX-like path to a native one.
On an UNIX system this does nothing. Else it converts '/', '.', '..' to the appropriate things.
On systems with a concept of "drives", drive is used to determine which drive label to use during absolute path conversion. drive defaults to the drive of the current working directory, and is ignored on systems that do not have a concept of "drives".
proc getCurrentDir(): Path
Returns the current working directory:idx: i.e. where the built binary is run.
So the path returned by this proc is determined at run time.
See also:
proc normalizeExe(file: var Path)
Normalize executable name.
On Windows this proc will check if an .exe extension needs to be added. On other platforms it does nothing.
proc normalizePath(path: var Path)
Normalize a path.
Consecutive directory separators are collapsed, including directory separators at the end of the path.
proc normalizePathEnd(path: var Path; trailingSep: bool)
Normalize path so that it maintains a trailing separator or not depending on the value of the trailingSep parameter.
proc absolutePath(path: Path; root: Path): Path
Returns the absolute path of path, rooted at root (which must be absolute; default: current directory). If path is absolute, return it, ignoring root.
See also:
- normalizePath proc_
proc expandTilde(path: Path): Path
Expands ~ or a path starting with ~/ to a full path, replacing ~ with getHomeDir() (otherwise returns path unmodified).
Windows: this is still supported despite the Windows platform not having this convention; also, both ~/ and ~\ are handled.