FileSystemUtils.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Base/Util/FileSystemUtils.cpp
//! @brief     Implements namespace BaseUtils::Filesystem
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#include "Base/Util/FileSystemUtils.h"
#include "Base/Util/Assert.h"
#include "Base/Util/StringUtils.h"
#include <codecvt>
#include <filesystem>
#include <locale>
#include <regex>
#include <stdexcept>
 
namespace fs = std::filesystem; // make the code more readable
 
std::string BaseUtils::Filesystem::extension(const std::string& path)
{
    return fs::path(path).extension().string();
}
 
bool BaseUtils::Filesystem::hasExtension(const std::string& path, const std::string& ref_extension)
{
    return BaseUtils::String::to_lower(extension(path)) == ref_extension;
}
 
std::string BaseUtils::Filesystem::extensions(const std::string& path)
{
    const auto name = BaseUtils::Filesystem::filename(path);
    if (name == "..")
        return {};
 
    const auto pos = name.find_first_of('.', 1); // 1: ignore any file-is-hidden dot
    return pos != std::string::npos ? name.substr(pos, name.size() - pos) : "";
}
 
bool BaseUtils::Filesystem::createDirectory(const std::string& dir_name)
{
#ifdef _WIN32
    return fs::create_directory(convert_utf8_to_utf16(dir_name));
#else
    return fs::create_directory(dir_name);
#endif
}
 
bool BaseUtils::Filesystem::createDirectories(const std::string& dir_name)
{
#ifdef _WIN32
    return fs::create_directories(convert_utf8_to_utf16(dir_name));
#else
    return fs::create_directories(dir_name);
#endif
}
 
std::vector<std::string> BaseUtils::Filesystem::filesInDirectory(const std::string& dir_name)
{
    std::vector<std::string> result;
    if (!fs::exists(dir_name))
        throw std::runtime_error("BaseUtils::Filesystem::filesInDirectory '" + dir_name
                                 + "' does not exist");
 
    for (const auto& entry : fs::directory_iterator(dir_name))
        if (entry.is_regular_file())
            result.push_back(entry.path().filename().string());
 
    return result;
}
 
std::string BaseUtils::Filesystem::jointPath(const std::string& path1, const std::string& path2)
{
    ASSERT(!path2.empty());
 
    if (path1.empty())
        return fs::path(path2).string();
 
    return (fs::path(path1) / fs::path(path2)).string();
}
 
std::string BaseUtils::Filesystem::filename(const std::string& path)
{
    return fs::path(path).filename().string();
}
 
std::vector<std::string> BaseUtils::Filesystem::glob(const std::string& dir,
                                                     const std::string& pattern)
{
    std::vector<std::string> result;
    for (const std::string& fname : filesInDirectory(dir))
        if (std::regex_match(fname, std::regex(pattern)))
            result.push_back(fname);
    return result;
}
 
std::string BaseUtils::Filesystem::stem(const std::string& path)
{
    return fs::path(path).stem().string();
}
 
std::string BaseUtils::Filesystem::stem_ext(const std::string& path)
{
    const auto name = BaseUtils::Filesystem::filename(path);
    if (name == "..")
        return "..";
 
    const auto pos = name.find_first_of('.', 1); // 1: ignore any file-is-hidden dot
    return pos != std::string::npos ? name.substr(0, pos) : name;
}
 
std::wstring BaseUtils::Filesystem::convert_utf8_to_utf16(const std::string& str)
{
    std::wstring_convert<std::codecvt_utf8_utf16<wchar_t>> converter;
    return converter.from_bytes(str);
}
 
bool BaseUtils::Filesystem::IsFileExists(const std::string& path)
{
#ifdef _WIN32
    return fs::exists(convert_utf8_to_utf16(path));
#else
    return fs::exists(path);
#endif
}