X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Ffs%2Futils.h;h=e518d35cf225da8e38692e5b09dffe2d21793af5;hb=c73d8eee1982ba4982518d3f28651f848f130730;hp=f345ba7e7f3266a2bba26c298821129ae49a8635;hpb=7563bb650aa11207a7c128ba44468cf5ad2897c7;p=libs%2Fcore.git diff --git a/source/fs/utils.h b/source/fs/utils.h index f345ba7..e518d35 100644 --- a/source/fs/utils.h +++ b/source/fs/utils.h @@ -12,22 +12,15 @@ std::string basename(const Path &); /// Removes the last component from the path. Path dirname(const Path &); -/** -Returns the base part of a filename. This includes everything up to the last -dot, but not the dot itself. -*/ +/** Returns the base part of a filename. This includes everything up to the +last dot, but not the dot itself. */ std::string basepart(const std::string &); -/** -Returns the extension part of a filename. This includes the last dot and -everything after it. -*/ +/** Returns the extension part of a filename. This includes the last dot and +everything after it. */ std::string extpart(const std::string &); -/** -Fixes the case of the given path to match files / directories on the -filesystem. -*/ +/// Fixes the case of a path to match files / directories on the filesystem. Path fix_case(const Path &path); /// Reads the contents of a symbolic link @@ -42,11 +35,15 @@ void unlink(const Path &path); /// Renames a file. Existing file, if any, is overwritten. void rename(const Path &from, const Path &to); -/// Makes a path relative to some base path. That is, base/result==path. +/** Makes a path relative to some base path. That is, base/result==path. Both +paths must be either absolute or relative. */ Path relative(const Path &path, const Path &base); +/// Returns the longest prefix shared by both paths. +Path common_ancestor(const Path &, const Path &); + /** Determines how many levels a path is below another. Returns -1 if path is -not a descendant of parent. */ +not a descendant of parent. Both paths must be either absolute or relative. */ int descendant_depth(const Path &path, const Path &parent); } // namespace FS