file_system.h

/********************************************************************
 * Copyright (C) 2015 Liangliang Nan <liangliang.nan@gmail.com>
 * https://3d.bk.tudelft.nl/liangliang/
 *
 * This file is part of Easy3D. If it is useful in your research/work,
 * I would be grateful if you show your appreciation by citing it:
 * ------------------------------------------------------------------
 *      Liangliang Nan.
 *      Easy3D: a lightweight, easy-to-use, and efficient C++ library
 *      for processing and rendering 3D data.
 *      Journal of Open Source Software, 6(64), 3255, 2021.
 * ------------------------------------------------------------------
 *
 * Easy3D is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License Version 3
 * as published by the Free Software Foundation.
 *
 * Easy3D 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/>.
 ********************************************************************/
 
#ifndef EASY3D_UTIL_FILE_SYSTEM_H
#define EASY3D_UTIL_FILE_SYSTEM_H
 
#include <string>
#include <vector>
#include <fstream>
 
 
namespace easy3d {
 
    namespace file_system {
 
        bool    is_file(const std::string& path);
 
        bool    is_directory(const std::string& path);
 
        bool    create_directory(const std::string& path);
 
        bool    delete_file(const std::string& path);
 
        bool    delete_directory(const std::string& path);
 
        bool    delete_contents(const std::string& path);
 
        void    get_directory_entries(const std::string& path, std::vector<std::string>& entries, bool recursive);
 
        void    get_files(const std::string& path, std::vector<std::string>& files, bool recursive);
 
        void    get_sub_directories(const std::string& path, std::vector<std::string>& subs, bool recursive);
 
        std::string current_working_directory() ;
 
        bool    set_current_working_directory(const std::string& path);
 
        std::string home_directory();
 
        std::string executable();
 
        std::string executable_directory();
 
        bool    rename_file(const std::string& old_name, const std::string& new_name);
 
        time_t  time_stamp(const std::string& path);
 
        std::string time_string(const std::string& path);
 
        std::ifstream::pos_type file_size(const std::string& path);
 
        std::string parent_directory(const std::string& path) ;
 
        std::string extension(const std::string& path, bool lower = true) ;
 
        std::string simple_name(const std::string& path) ;
 
        std::string base_name(const std::string& path) ;
 
        std::string name_less_extension(const std::string& path);
 
        std::string name_less_all_extensions(const std::string& path);
 
        std::string replace_extension(std::string const& path, const std::string& ext);
 
        std::string path_root(const std::string& path);
 
        bool    is_absolute_path(const std::string& path);
 
        std::string relative_path(const std::string& from, const std::string& to);
 
        std::string absolute_path(const std::string& path);
 
        std::string convert_to_windows_style(const std::string& path);
 
        std::string convert_to_unix_style(const std::string& path);
 
        std::string convert_to_native_style(const std::string& path);
 
        char native_path_separator();
 
        bool is_native_style(const std::string& path);
 
        bool copy_file(const std::string& original, const std::string& copy);
 
        bool file_contains_string(const std::string& filename, const std::string& str);
 
        void read_file_to_string(const std::string& filename, std::string& str);
 
        void write_string_to_file(const std::string& str, const std::string& filename);
 
    }
 
 
} // namespace easy3d
 
 
#endif  // EASY3D_UTIL_FILE_SYSTEM_H