FileSys.h

Go to the documentation of this file.

/*
 *  This 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
 *  any later version.
 *  The software 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 the software. If not, see <http://www.gnu.org/licenses/>.
 *
 *  Copyright 2017, Kuylen E, Willem L, Broeckhove J
 */

#pragma once

#include <boost/property_tree/ptree_fwd.hpp>
#include <functional>
#include <string>

#ifdef BOOST_FOUND
#include <boost/filesystem.hpp>
#include <boost/filesystem/path.hpp>
namespace filesys = boost::filesystem;
#else
#include <filesystem>
namespace filesys = std::filesystem;
#endif

namespace stride {
namespace util {

class FileSys
{
public:
        static bool IsDirectoryString(const std::string& s);

        static bool CreateDirectory(std::string s);

        static filesys::path BuildPath(const std::string& output_prefix, const std::string& filename);

        static boost::property_tree::ptree ReadPtreeFile(const filesys::path& f_p);

        static boost::property_tree::ptree ReadPtreeFile(const std::string& f_n);

        static void WritePtreeFile(const filesys::path& f_p, const boost::property_tree::ptree& pt);

        static void WritePtreeFile(const std::string& f_n, const boost::property_tree::ptree& pt);

public:
        static filesys::path GetCurrentDir() { return Get().m_current_dir; }

        static filesys::path GetExecPath() { return Get().m_exec_path; }

public:
        static bool CheckInstallEnv(
            std::function<void(const std::string&)> logger = std::function<void(const std::string&)>());

        static filesys::path GetBinDir() { return Get().m_bin_dir; }

        static filesys::path GetConfigDir() { return Get().m_config_dir; }

        static filesys::path GetDataDir() { return Get().m_data_dir; }

        static filesys::path GetRootDir() { return Get().m_root_dir; }

        static filesys::path GetTestsDir() { return Get().m_tests_dir; }

private:
        struct Dirs
        {
                Dirs()
                    : m_current_dir(), m_exec_path(), m_bin_dir(), m_config_dir(), m_data_dir(), m_root_dir(),
                      m_tests_dir(){};

                filesys::path m_current_dir;
                filesys::path m_exec_path;

                // only relevant when use_install_dirs mode is active
                filesys::path m_bin_dir;
                filesys::path m_config_dir;
                filesys::path m_data_dir;
                filesys::path m_root_dir;
                filesys::path m_tests_dir;
        };

private:
        static Dirs Initialize();

        static Dirs& Get();
};

} // namespace util
} // namespace stride