XDGFilePaths.h

Go to the documentation of this file.

#pragma once

#include <array>
#include <filesystem>
#include <map>
#include <string>
#include <vector>

namespace rose {

    class XDGFilePaths {
    public:
        enum XDG_Name : std::size_t {
            XDG_DATA_HOME,
            XDG_CONFIG_HOME,
            XDG_DATA_DIRS,
            XDG_CONFIG_DIRS,
            XDG_CACHE_HOME,
            XDG_RUNTIME_DIR
        };

        struct XDG_Env_Spec {
            XDG_Name name;
            std::string_view varName;
            std::string_view defaultPath;
            bool homeRelative;
        };

        using XDG_Env_Var_List = std::array<XDG_Env_Spec, 6>;

        using XDG_Path_Set = std::vector<std::filesystem::path>;

        using XDG_Paths = std::map<XDG_Name, XDG_Path_Set>;

    protected:
        static constexpr XDG_Env_Var_List mEnvVars = {
                XDG_Env_Spec{XDG_DATA_HOME, "XDG_DATA_HOME", ".local/share", true},
                XDG_Env_Spec{XDG_CONFIG_HOME, "XDG_CONFIG_HOME", ".config", true},
                XDG_Env_Spec{XDG_DATA_DIRS, "XDG_DATA_DIRS", "/usr/local/share/:/usr/share/", false},
                XDG_Env_Spec{XDG_CONFIG_DIRS, "XDG_CONFIG_DIRS", "/etc/xdg", false},
                XDG_Env_Spec{XDG_CACHE_HOME, "XDG_CACHE_HOME", ".cache", true},
                XDG_Env_Spec{XDG_RUNTIME_DIR, "XDG_RUNTIME_DIR", "", false}
        };

        XDG_Paths mPaths{};     

        std::string mHome;      

    public:

        XDGFilePaths();

        template<typename S>
        std::tuple<bool,std::filesystem::path> findFilePath(XDG_Name name, const S &relativePath) {
            for (auto const &path : mPaths[name]) {
                auto tryPath{path};
                tryPath.append(relativePath);
                if (std::filesystem::exists(tryPath))
                    return std::make_tuple(true,tryPath);
            }

            auto preferredPath{mPaths[name].front()};
            preferredPath.append(relativePath);
            return std::make_tuple(false, preferredPath);
        }
    };
}