/* 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 the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ #ifndef PBD_FILE_UTILS_INCLUDED #define PBD_FILE_UTILS_INCLUDED #include #include #include #include "pbd/libpbd_visibility.h" #include "pbd/search_path.h" namespace PBD { /** * Get a contents of directory. * @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 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 a list of files in a directory. * @note You must join path with result to get the absolute path * to the file. * * @param path An Absolute path to a directory * @param result A vector of filenames. */ LIBPBD_API void get_files_in_directory (const std::string& path, std::vector& result); /** * Takes a Searchpath and returns all the files contained in the * directory paths that match a particular pattern. * * @param result A vector in which to place the resulting matches. * @param paths A Searchpath * @param pattern A Glib::PatternSpec used to match the files. */ LIBPBD_API void find_files_matching_pattern (std::vector& result, const Searchpath& paths, const Glib::PatternSpec& pattern); /** * Takes a Searchpath and returns all the files contained in the * directory paths that match a particular pattern. * * This is a convenience method to avoid explicitly declaring * temporary variables such as: * find_files_matching_pattern (result, paths, string("*.ext")) * * @param result A vector in which to place the resulting matches. * @param paths A Searchpath * @param pattern A string representing the Glib::PatternSpec used * to match the files. */ LIBPBD_API void find_files_matching_pattern (std::vector& result, const Searchpath& paths, const std::string& pattern); /** * Takes a directory path and returns all the files in the directory * matching a particular pattern. * * @param directory A directory path * @param pattern A Glib::PatternSpec used to match the files. * @param result A vector in which to place the resulting matches. */ LIBPBD_API void find_matching_files_in_directory (const std::string& directory, const Glib::PatternSpec& pattern, std::vector& result); /** * Takes a number of directory paths and returns all the files matching * a particular pattern. * * @param paths A vector containing the Absolute paths * @param pattern A Glib::PatternSpec used to match the files * @param result A vector in which to place the resulting matches. */ LIBPBD_API void find_matching_files_in_directories (const std::vector& directory_paths, const Glib::PatternSpec& pattern, std::vector& result); /** * Takes a Searchpath and puts a list of all the files in the search path * that match pattern into the result vector. * * @param search_path A Searchpath * @param pattern A Glib::PatternSpec used to match the files * @param result A vector in which to place the resulting matches. */ LIBPBD_API void find_matching_files_in_search_path (const Searchpath& search_path, const Glib::PatternSpec& pattern, std::vector& result); /** * Takes a search path and a file name and place the full path * to that file in result if it is found within the search path. * * @return true If file is found within the search path. */ LIBPBD_API bool find_file_in_search_path (const Searchpath& search_path, const std::string& filename, std::string& result); /** * @return files in dirpath that match a regular expression */ LIBPBD_API void find_files_matching_regex (std::vector& results, const Searchpath& dirpath, const std::string& regexp); /** * @return files in a Searchpath that match a supplied filter(functor) */ LIBPBD_API void find_files_matching_filter (std::vector&, const Searchpath& paths, bool (*filter)(const std::string &, void *), void *arg, bool match_fullpath, bool return_fullpath, bool recurse = false); /** * Attempt to copy the contents of the file from_path to a new file * at path to_path. If to_path exists it is overwritten. * * @return true if file was successfully copied */ LIBPBD_API bool copy_file(const std::string & from_path, const std::string & to_path); /** * Attempt to copy all regular files from from_path to a new directory. * This method does not recurse. */ LIBPBD_API void copy_files(const std::string & from_path, const std::string & to_dir); /** * Take a (possibly) relative path and make it absolute * @return An absolute path */ LIBPBD_API std::string get_absolute_path (const std::string &); /** * Find out if `needle' is a file or directory within the * directory `haystack'. * @return true if it is. */ LIBPBD_API bool path_is_within (const std::string &, std::string); /** * @return true if p1 and p2 both resolve to the same file * @param p1 a file path. * @param p2 a file path. * * Uses g_stat to check for identical st_dev and st_ino values. */ LIBPBD_API bool equivalent_paths (const std::string &p1, const std::string &p2); /// @return true if path at p exists and is writable, false otherwise LIBPBD_API bool exists_and_writable(const std::string & p); } // namespace PBD #endif