kratos_filesystem.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics
//
//  License:         BSD License
//                   Kratos default license: kratos/license.txt
//
//  Main authors:    Philipp Bucher (https://github.com/philbucher)
//
 
#pragma once
 
// System includes
#include <filesystem>
#include <string>
#include <vector>
 
// External includes
 
// Project includes
#include "includes/define.h"
 
namespace Kratos {
 
// deprecated namespaces wrongly issue a warning with GCC < 10, hence disabling until removed
#if defined(__GNUG__) && __GNUC__ < 10 && !defined(__clang__) && !defined(__INTEL_COMPILER)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wattributes"
#endif
 
namespace KRATOS_DEPRECATED_MESSAGE("Please use std::filesystem directly") filesystem {
 
#if defined(__GNUG__) && __GNUC__ < 10 && !defined(__clang__) && !defined(__INTEL_COMPILER)
#pragma GCC diagnostic pop
#endif
 
bool KRATOS_API(KRATOS_CORE) exists(const std::string& rPath);
 
bool KRATOS_API(KRATOS_CORE) is_regular_file(const std::string& rPath);
 
bool KRATOS_API(KRATOS_CORE) is_directory(const std::string& rPath);
 
bool KRATOS_API(KRATOS_CORE) create_directory(const std::string& rPath);
 
bool KRATOS_API(KRATOS_CORE) create_directories(const std::string& rPath);
 
bool KRATOS_API(KRATOS_CORE) remove(const std::string& rPath);
 
std::uintmax_t KRATOS_API(KRATOS_CORE) remove_all(const std::string& rPath);
 
void KRATOS_API(KRATOS_CORE) rename(const std::string& rPathFrom, const std::string& rPathTo);
 
std::string KRATOS_API(KRATOS_CORE) parent_path(const std::string& rPath);
 
std::string KRATOS_API(KRATOS_CORE) filename(const std::string& rPath);
 
} // namespace filesystem
 
 
class KRATOS_API(KRATOS_CORE) FilesystemExtensions
{
 
public:
    FilesystemExtensions() = delete;
 
    FilesystemExtensions(FilesystemExtensions const& rOther) = delete;
 
    FilesystemExtensions& operator=(FilesystemExtensions const& rOther) = delete;
 
    // helper functions related to filesystem
 
    KRATOS_DEPRECATED_MESSAGE("Please use std::filesystem directly")
    static std::string CurrentWorkingDirectory();
 
    KRATOS_DEPRECATED_MESSAGE("Please use the /-operator directly")
    static std::string JoinPaths(const std::vector<std::string>& rPaths);
 
    [[nodiscard]] static std::vector<std::filesystem::path> ListDirectory(const std::filesystem::path& rPath);
 
    static void MPISafeCreateDirectories(const std::filesystem::path& rPath);
 
    [[nodiscard]] static std::filesystem::path ResolveSymlinks(const std::filesystem::path& rPath);
 
}; // class FilesystemExtensions
 
} // namespace Kratos