ThemeLoader.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_THEME_LOADER_HPP
#define TGUI_THEME_LOADER_HPP
 
#include <TGUI/String.hpp>
#include <TGUI/Loading/DataIO.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
    #include <memory>
    #include <string>
    #include <vector>
    #include <map>
    #include <set>
#endif

 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API BaseThemeLoader
    {
    public:

        virtual ~BaseThemeLoader() = default;

        virtual void preload(const String& primary);

        TGUI_NODISCARD virtual std::map<String, String> getGlobalProperties(const String& primary);

        TGUI_NODISCARD virtual const std::map<String, String>& load(const String& primary, const String& secondary) = 0;

        TGUI_NODISCARD virtual bool canLoad(const String& primary, const String& secondary) = 0;

    protected:

        // Turns texture and font filenames into paths relative to the theme file
        void injectThemePath(const std::unique_ptr<DataIO::Node>& node, const String& path) const;

        // Resolves references to sections
        void resolveReferences(std::map<String, std::reference_wrapper<const std::unique_ptr<DataIO::Node>>>& sections,
                               const std::map<String, String>& globalProperties,
                               const std::unique_ptr<DataIO::Node>& node) const;

    };

    class TGUI_API DefaultThemeLoader : public BaseThemeLoader
    {
    public:

        void preload(const String& filename) override;

        TGUI_NODISCARD std::map<String, String> getGlobalProperties(const String& filename) override;

        TGUI_NODISCARD const std::map<String, String>& load(const String& filename, const String& section) override;

        TGUI_NODISCARD bool canLoad(const String& filename, const String& section) override;

        static void flushCache(const String& filename = "");

    protected:

        TGUI_NODISCARD virtual std::unique_ptr<DataIO::Node> readFile(const String& filename) const;

    protected:
        static std::map<String, std::map<String, std::map<String, String>>> m_propertiesCache;
        static std::map<String, std::map<String, String>> m_globalPropertiesCache;
    };

}

 
#endif // TGUI_THEME_LOADER_HPP