file.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2024 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * 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, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_UTILITY_FILESYSTEM_FILE_HPP
#define ORES_UTILITY_FILESYSTEM_FILE_HPP
 
#include <set>
#include <list>
#include <string>
#include <fstream>
#include <sstream>
#include <filesystem>
#include "ores.utility/log/make_logger.hpp"
#include "ores.utility/filesystem/io_error.hpp"
 
namespace ores::utility::filesystem {
 
class file final {
private:
    inline static std::string_view logger_name =
        "ores.utility.filesystem.file";
 
    static auto& lg() {
        using namespace ores::utility::log;
        static auto instance = make_logger(logger_name);
        return instance;
    }
 
public:
    static std::string read_content(std::istream& s);
 
    static std::string read_content(const std::filesystem::path& p);
 
    static void write_content(const std::filesystem::path& path,
        const std::string& content);
 
    template<typename Ioable>
    static void write(const std::filesystem::path& path, const Ioable& target) {
        try {
            std::ofstream os(path);
            os.exceptions(std::ifstream::failbit | std::ifstream::badbit);
            os << target;
        } catch (const std::exception& e) {
            std::ostringstream s;
            s << "An error occurred whilst trying to write a file. Path: '"
              << path.generic_string() << "'. Error: " << e.what();
            throw io_error(s.str());
        }
    }
 
    static std::set<std::filesystem::path>
    find_files(const std::filesystem::path& dir);
    static std::set<std::filesystem::path>
    find_files(const std::vector<std::filesystem::path>& dirs);
    static std::set<std::filesystem::path>
    find_files(const std::list<std::filesystem::path>& dirs);
    static std::filesystem::path find_file_recursively_upwards(
        std::filesystem::path starting_directory,
        const std::filesystem::path& relative_file_path);
 
    static void remove(const std::list<std::filesystem::path>& files);
 
    static void remove_empty_directories(const std::filesystem::path& dir);
    static void remove_empty_directories(const std::list<std::filesystem::path>& dirs);
    static void recreate_directory(const std::filesystem::path& dir);
};
 
}
 
#endif