nix-files/modules/lib/path.nix

74 lines
2.4 KiB
Nix

{ lib, ... }:
let path = rec {
# split the string path into a list of string components.
# root directory "/" becomes the empty list [].
# implicitly performs normalization so that:
# split "a//b/" => ["a" "b"]
# split "/a/b" => ["a" "b"]
split = str: builtins.filter (seg: seg != "") (lib.splitString "/" str);
# given an array of components, returns the equivalent string path
join = comps: "/" + (builtins.concatStringsSep "/" comps);
# given an a sequence of string paths, concatenates them into one long string path
concat = paths: path.join (builtins.concatLists (builtins.map path.split paths));
# normalize the given path
# canonical form is an *absolute* path;
# always starting with '/', never trailing with '/' unless it's the empty (root) path
norm = str: path.join (path.split str);
# removes ".." and "." components from a path component list, by evaluating them logically.
# Type realpathArray: [ str ] -> [ str ]
realpathArray = arr: lib.foldl'
(acc: next:
if next == ".." then lib.init acc
else if next == "." then acc
else acc ++ [ next ]
)
[]
arr
;
# removes ".." and "." from a path, by evaluating them logically.
# has the effect of also normalizing the path, in the process.
# Type realpath: str -> str
realpath = str: path.join (path.realpathArray (path.split str));
# return the parent directory. doesn't care about leading/trailing slashes.
# the parent of "/" is "/".
parent = str: path.norm (builtins.dirOf (path.norm str));
hasParent = str: (path.parent str) != (path.norm str);
# return the last path component; error on the empty path
leaf = str: lib.last (split str);
# return the path from `from` to `to`, but keeping absolute form
# e.g. `pathFrom "/home/colin" "/home/colin/foo/bar"` -> "/foo/bar"
from = start: end: let
s = path.norm start;
e = path.norm end;
in (
assert isChild start end;
"/" + lib.removePrefix s e
);
isChild = parent: child:
lib.any
(p: p == norm parent)
(walk "/" child)
;
# yield every node between start and end, including each of the endpoints
# e.g. walk "/foo" "/foo/bar/baz" => [ "/foo" "/foo/bar" "/foo/bar/baz" ]
# XXX: assumes input paths are normalized
walk = start: end: if start == end then
[ start ]
else
assert end != "/"; # else there's no path from `start` to `end`!
(walk start (parent end)) ++ [ end ]
;
};
in path