ShaderCacheManager.h

#pragma once
 
// Standard.
#include <memory>
#include <string>
#include <optional>
 
// Custom.
#include "misc/Error.h"
#include "io/ConfigManager.h"
 
namespace ne {
    class Renderer;
 
    class ShaderCacheManager {
        // Only shader manager is expected to create this manager.
        friend class ShaderManager;
 
    public:
        virtual ~ShaderCacheManager() = default;
 
        ShaderCacheManager() = delete;
        ShaderCacheManager(const ShaderCacheManager&) = delete;
        ShaderCacheManager& operator=(const ShaderCacheManager&) = delete;
 
        [[nodiscard]] std::optional<Error> refreshShaderCache();
 
    protected:
        ShaderCacheManager(Renderer* pRenderer);
 
        [[nodiscard]] virtual std::optional<std::string>
        isLanguageSpecificGlobalCacheOutdated(const ConfigManager& cacheConfig) = 0;
 
        [[nodiscard]] virtual std::optional<Error>
        writeLanguageSpecificParameters(ConfigManager& cacheConfig) = 0;
 
    private:
        struct GlobalShaderCacheParameterNames {
            static constexpr std::string_view sIsReleaseBuild = "is_release_build";
 
            static constexpr std::string_view sRenderer = "renderer";
 
            static constexpr std::string_view sShaderParserVersion = "shader_parser_version";
        };
 
        static std::unique_ptr<ShaderCacheManager> create(Renderer* pRenderer);
 
        [[nodiscard]] std::optional<Error> createNewShaderCache();
 
        [[nodiscard]] std::optional<std::string>
        isGlobalShaderCacheOutdated(const ConfigManager& cacheConfig);
 
        Renderer* const pRenderer = nullptr;
 
        static constexpr std::string_view sGlobalShaderCacheInfoFileName = ".shader_cache.toml";
    };
}