X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fpbd%2Fpbd%2Ffile_utils.h;h=d44328815903619b0a373e0adee084046ff72f7e;hb=569167a603ef812a234d3c02f6a94976571a70ea;hp=ab42fd23570b44f09e0f9859cee3f92c72c3217d;hpb=24599c552d561a53375e5f76bb695cbfbb5eb934;p=ardour.git diff --git a/libs/pbd/pbd/file_utils.h b/libs/pbd/pbd/file_utils.h index ab42fd2357..d443288159 100644 --- a/libs/pbd/pbd/file_utils.h +++ b/libs/pbd/pbd/file_utils.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2007 Tim Mayberry + Copyright (C) 2007 Tim Mayberry This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -31,32 +31,32 @@ namespace PBD { /** - * Get a contents of directory. + * Get a list of path entries in a directory or within a directory tree + * if recursing. * @note paths in result will be absolute * - * @param path An absolute path to a directory in the filename encoding * @param result A vector of absolute paths to the directory entries in filename * encoding. + * @param paths A Searchpath * @param files_only Only include file entries in result * @param recurse Recurse into child directories */ LIBPBD_API void -get_directory_contents (const std::string& path, - std::vector& result, - bool files_only = true, - bool recurse = false); +get_paths (std::vector& result, + const Searchpath& paths, + bool files_only = true, + bool recurse = false); /** - * Get a list of files in a directory. - * @note You must join path with result to get the absolute path - * to the file. + * Get a list of files in a Searchpath. + * @note paths in result will be absolute. * - * @param path An Absolute path to a directory - * @param result A vector of filenames. + * @param path A Searchpath + * @param result A vector of paths to files. */ LIBPBD_API void -get_files_in_directory (const std::string& path, - std::vector& result); +get_files (std::vector& result, + const Searchpath& paths); /** * Takes a Searchpath and returns all the files contained in the @@ -93,6 +93,11 @@ find_files_matching_pattern (std::vector& result, * Takes a search path and a file name and places the full path * to that file in result if it is found within the search path. * + * @note the parameter order of this function doesn't match the + * others. At the time of writing it is the most widely used file + * utility function so I didn't change it but it may be worth + * doing at some point if it causes any confusion. + * * @return true If file is found within the search path. */ LIBPBD_API bool @@ -102,35 +107,58 @@ find_file (const Searchpath& search_path, /** - * @return files in dirpath that match a regular expression + * Find files in paths that match a regular expression + * @note This function does not recurse. + * + * @param result A vector in which to place the resulting matches. + * @param paths A Searchpath + * @param regexp A regular expression */ LIBPBD_API void find_files_matching_regex (std::vector& results, - const Searchpath& dirpath, - const std::string& regexp); + const Searchpath& paths, + const std::string& regexp, + bool recurse = false); /** - * @return paths in a Searchpath that match a supplied filter(functor) - * @note results include files and directories + * Find paths in a Searchpath that match a supplied filter(functor) + * @note results include files and directories. + * + * @param result A vector in which to place the resulting matches. + * @param paths A Searchpath + * @param filter A functor to use to filter paths + * @param arg additonal argument to filter if required + * @param pass_fullpath pass the full path to the filter or just the basename + * @param return_fullpath put the full path in results or just the basename + * @param recurse Recurse into child directories to find paths. */ LIBPBD_API void -find_paths_matching_filter (std::vector&, +find_paths_matching_filter (std::vector& results, const Searchpath& paths, bool (*filter)(const std::string &, void *), void *arg, - bool match_fullpath, + bool pass_fullpath, bool return_fullpath, bool recurse = false); /** - * @return files in a Searchpath that match a supplied filter(functor) + * Find paths in a Searchpath that match a supplied filter(functor) + * @note results include only files. + * + * @param result A vector in which to place the resulting matches. + * @param paths A Searchpath + * @param filter A functor to use to filter paths + * @param arg additonal argument to filter if required + * @param pass_fullpath pass the full path to the filter or just the basename + * @param return_fullpath put the full path in results or just the basename + * @param recurse Recurse into child directories to find files. */ LIBPBD_API void -find_files_matching_filter (std::vector&, +find_files_matching_filter (std::vector& results, const Searchpath& paths, bool (*filter)(const std::string &, void *), void *arg, - bool match_fullpath, + bool pass_fullpath, bool return_fullpath, bool recurse = false); @@ -148,12 +176,38 @@ LIBPBD_API bool copy_file(const std::string & from_path, const std::string & to_ */ LIBPBD_API void copy_files(const std::string & from_path, const std::string & to_dir); +/** + * Attempt to copy all regular files from from_path to a new directory. + */ +LIBPBD_API void copy_recurse(const std::string & from_path, const std::string & to_dir); + +/** + * Update the access and modification times of file at @path, creating file if it + * doesn't already exist. + * @path file path to touch + * @return true if file exists or was created and access time updated. + */ +LIBPBD_API bool touch_file (const std::string& path); + /** * Take a (possibly) relative path and make it absolute * @return An absolute path */ LIBPBD_API std::string get_absolute_path (const std::string &); +/** + * The equivalent of ::realpath on POSIX systems, on Windows hard + * links/junctions etc are not resolved. + */ +LIBPBD_API std::string canonical_path (const std::string& path); + +/** + * Take a path/filename and return the suffix (characters beyond the last '.' + * @return A string containing the suffix, which will be empty + * if there are no '.' characters in the path/filename. + */ +LIBPBD_API std::string get_suffix (const std::string &); + /** * Find out if `needle' is a file or directory within the * directory `haystack'. @@ -187,12 +241,35 @@ LIBPBD_API int clear_directory (const std::string& dir, size_t* size = 0, /** * Remove all the contents of a directory recursively. - * @note dir will not be removed + * including the dir itself (`rm -rf $dir`) * - * @param dir The directory to remove files from. + * @param dir The directory to remove recursively */ LIBPBD_API void remove_directory (const std::string& dir); +/** + * Create a temporary writable directory in which to create + * temporary files. The directory will be created under the + * top level "domain" directory. + * + * For instance tmp_writable_directory ("pbd", "foo") on POSIX + * systems may return a path to a new directory something like + * to /tmp/pbd/foo-1423 + * + * @param domain The top level directory + * @param prefix A prefix to use when creating subdirectory name + * + * @return new temporary directory + */ +LIBPBD_API std::string tmp_writable_directory (const char* domain, const std::string& prefix); + +/** If @param path exists, unlink it. If it doesn't exist, create it. + * + * @return zero if required action was successful, non-zero otherwise. + */ + +LIBPBD_API int toggle_file_existence (std::string const &); + } // namespace PBD #endif