file_utils.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2016 Tim Mayberry <mojofunk@gmail.com>
 * Copyright (C) 2008-2015 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2014-2015 Robin Gareus <robin@gareus.org>
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef PBD_FILE_UTILS_INCLUDED
#define PBD_FILE_UTILS_INCLUDED
 
#include <string>
#include <vector>
 
#include <glibmm/pattern.h>
 
#include "pbd/libpbd_visibility.h"
#include "pbd/search_path.h"
 
#if defined(COMPILER_MSVC) && defined(WAF_BUILD)
#include <basetsd.h>
typedef SSIZE_T ssize_t; //Defining here for both file_utils.cc and file_archive.cc
#endif
           
namespace PBD {
 
LIBPBD_API void
get_paths (std::vector<std::string>& result,
           const Searchpath& paths,
           bool files_only = true,
           bool recurse = false);
 
LIBPBD_API void
get_files (std::vector<std::string>& result,
           const Searchpath& paths);
 
LIBPBD_API void
find_files_matching_pattern (std::vector<std::string>& result,
                             const Searchpath& paths,
                             const Glib::PatternSpec& pattern);
 
LIBPBD_API void
find_files_matching_pattern (std::vector<std::string>& result,
                             const Searchpath& paths,
                             const std::string& pattern);
 
LIBPBD_API bool
find_file (const Searchpath& search_path,
           const std::string& filename,
           std::string& result);
 
 
LIBPBD_API void
find_files_matching_regex (std::vector<std::string>& results,
                           const Searchpath& paths,
                           const std::string& regexp,
                           bool recurse = false);
 
LIBPBD_API void
find_paths_matching_filter (std::vector<std::string>& results,
                            const Searchpath& paths,
                            bool (*filter)(const std::string &, void *),
                            void *arg,
                            bool pass_fullpath,
                            bool return_fullpath,
                            bool recurse = false);
 
LIBPBD_API void
find_files_matching_filter (std::vector<std::string>& results,
                            const Searchpath& paths,
                            bool (*filter)(const std::string &, void *),
                            void *arg,
                            bool pass_fullpath,
                            bool return_fullpath,
                            bool recurse = false);
 
LIBPBD_API bool copy_file(const std::string & from_path, const std::string & to_path);
 
LIBPBD_API void copy_files(const std::string & from_path, const std::string & to_dir);
 
LIBPBD_API void copy_recurse(const std::string & from_path, const std::string & to_dir, bool preseve_timestamps = false);
 
LIBPBD_API bool touch_file (const std::string& path);
 
LIBPBD_API bool hard_link (const std::string& existing_file, const std::string& new_path);
 
LIBPBD_API std::string get_absolute_path (const std::string &);
 
LIBPBD_API std::string canonical_path (const std::string& path);
 
LIBPBD_API std::string get_suffix (const std::string &);
 
LIBPBD_API bool path_is_within (const std::string &, std::string);
 
LIBPBD_API bool equivalent_paths (const std::string &p1, const std::string &p2);
 
LIBPBD_API bool exists_and_writable(const std::string & p);
 
LIBPBD_API int clear_directory (const std::string& dir, size_t* size = 0,
                                std::vector<std::string>* removed_files = 0);
 
LIBPBD_API void remove_directory (const std::string& dir);
 
LIBPBD_API std::string tmp_writable_directory (const char* domain, const std::string& prefix);
 
LIBPBD_API int toggle_file_existence (std::string const & path);
 
} // namespace PBD
 
#endif