fs.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_CORE_FS_H_
#define GENESIS_UTILS_CORE_FS_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2022 Lucas Czech
 
    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 3 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, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lczech@carnegiescience.edu>
    Department of Plant Biology, Carnegie Institution For Science
    260 Panama Street, Stanford, CA 94305, USA
*/
 
#include <string>
#include <unordered_map>
#include <vector>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     File Access
// =================================================================================================
 
bool path_exists( std::string const& path );
 
bool is_file( std::string const& path );
 
bool file_exists( std::string const& filename );
 
bool file_is_readable( std::string const& filename );
 
bool file_is_readable( std::string const& filename, std::string& err_str );
 
std::string file_read(
    std::string const& filename,
    bool detect_compression = true
);
 
std::vector<std::string> file_read_lines(
    std::string const& filename,
    bool detect_compression = true
);
 
void file_write(
    std::string const& content,
    std::string const& filename,
    bool create_dirs = true
);
 
void file_append(
    std::string const& content,
    std::string const& filename,
    bool create_dirs = true
);
 
// =================================================================================================
//     Directory Access
// =================================================================================================
 
bool is_dir( std::string const& path );
 
bool dir_exists( std::string const& dir );
 
void dir_create( std::string const& path, bool with_parents = true );
 
std::string dir_normalize_path( std::string const& path );
 
std::vector<std::string> dir_list_contents(
    std::string const& dir,
    bool full_path = false,
    std::string const& regex = ""
);
 
std::vector<std::string> dir_list_files(
    std::string const& dir,
    bool full_path = false,
    std::string const& regex = ""
);
 
std::vector<std::string> dir_list_directories(
    std::string const& dir,
    bool full_path = false,
    std::string const& regex = ""
);
 
// =================================================================================================
//     Path Information
// =================================================================================================
 
std::string current_path();
 
std::string real_path( std::string const& path, bool resolve_link = true );
 
// =================================================================================================
//     File Information
// =================================================================================================
 
std::unordered_map<std::string, std::string> file_info ( std::string const& filename );
 
size_t file_size( std::string const& filename );
 
std::string file_path( std::string const& filename );
 
std::string file_basename( std::string const& filename );
 
std::string file_basename(
    std::string const& filename,
    std::vector<std::string> const& remove_extensions
);
 
std::string file_filename( std::string const& filename );
 
std::string file_extension( std::string const& filename );
 
// =================================================================================================
//     File Names
// =================================================================================================
 
bool        is_valid_filename( std::string const& filename );
 
std::string sanitize_filename( std::string const& filename );
 
} // namespace utils
} // namespace genesis
 
#endif // include guard