openmw/components/settings/settings.hpp

#ifndef COMPONENTS_SETTINGS_H
#define COMPONENTS_SETTINGS_H

#include "categories.hpp"
#include "gyroscopeaxis.hpp"
#include "hrtfmode.hpp"
#include "navmeshrendermode.hpp"
#include "screenshotsettings.hpp"
#include "windowmode.hpp"

#include <components/detournavigator/collisionshapetype.hpp>
#include <components/sceneutil/lightingmethod.hpp>
#include <components/sdlutil/vsyncmode.hpp>

#include <filesystem>
#include <set>
#include <string>
#include <string_view>
#include <vector>

#include <osg/Vec2f>
#include <osg/Vec3f>

#include <MyGUI_Colour.h>

namespace Files
{
    struct ConfigurationManager;
}

namespace Settings
{
    ///
    /// \brief Settings management (can change during runtime)
    ///
    class Manager
    {
    public:
        static CategorySettingValueMap mDefaultSettings;
        static CategorySettingValueMap mUserSettings;

        static CategorySettingVector mChangedSettings;
        ///< tracks all the settings that were changed since the last apply() call

        static void clear();
        ///< clears all settings and default settings

        static std::filesystem::path load(const Files::ConfigurationManager& cfgMgr, bool loadEditorSettings = false);
        ///< load settings from all active config dirs. Returns the path of the last loaded file.

        static void saveUser(const std::filesystem::path& file);
        ///< save user settings to file

        static void resetPendingChanges();
        ///< resets the list of all pending changes

        static void resetPendingChanges(const CategorySettingVector& filter);
        ///< resets only the pending changes listed in the filter

        static CategorySettingVector getPendingChanges();
        ///< returns the list of changed settings

        static CategorySettingVector getPendingChanges(const CategorySettingVector& filter);
        ///< returns the list of changed settings intersecting with the filter

        static int getInt(std::string_view setting, std::string_view category);
        static std::uint64_t getUInt64(std::string_view setting, std::string_view category);
        static std::size_t getSize(std::string_view setting, std::string_view category);
        static unsigned getUnsigned(std::string_view setting, std::string_view category);
        static unsigned long getUnsignedLong(std::string_view setting, std::string_view category);
        static unsigned long long getUnsignedLongLong(std::string_view setting, std::string_view category);
        static float getFloat(std::string_view setting, std::string_view category);
        static double getDouble(std::string_view setting, std::string_view category);
        static const std::string& getString(std::string_view setting, std::string_view category);
        static std::vector<std::string> getStringArray(std::string_view setting, std::string_view category);
        static bool getBool(std::string_view setting, std::string_view category);
        static osg::Vec2f getVector2(std::string_view setting, std::string_view category);
        static osg::Vec3f getVector3(std::string_view setting, std::string_view category);

        template <class T>
        static T getOrDefault(std::string_view setting, std::string_view category, const T& defaultValue)
        {
            const auto key = std::make_pair(category, setting);
            if (!mUserSettings.contains(key) && !mDefaultSettings.contains(key))
                return defaultValue;
            return get<T>(setting, category);
        }

        template <class T>
        static T get(std::string_view setting, std::string_view category)
        {
            recordInit(setting, category);
            return getImpl<T>(setting, category);
        }

        static void setInt(std::string_view setting, std::string_view category, int value);
        static void setUInt64(std::string_view setting, std::string_view category, std::uint64_t value);
        static void setFloat(std::string_view setting, std::string_view category, float value);
        static void setDouble(std::string_view setting, std::string_view category, double value);
        static void setString(std::string_view setting, std::string_view category, const std::string& value);
        static void setStringArray(
            std::string_view setting, std::string_view category, const std::vector<std::string>& value);
        static void setBool(std::string_view setting, std::string_view category, bool value);
        static void setVector2(std::string_view setting, std::string_view category, osg::Vec2f value);
        static void setVector3(std::string_view setting, std::string_view category, osg::Vec3f value);

        static void set(std::string_view setting, std::string_view category, int value);
        static void set(std::string_view setting, std::string_view category, unsigned value);
        static void set(std::string_view setting, std::string_view category, unsigned long value);
        static void set(std::string_view setting, std::string_view category, unsigned long long value);
        static void set(std::string_view setting, std::string_view category, float value);
        static void set(std::string_view setting, std::string_view category, double value);
        static void set(std::string_view setting, std::string_view category, const std::string& value);
        static void set(std::string_view setting, std::string_view category, bool value);
        static void set(std::string_view setting, std::string_view category, const osg::Vec2f& value);
        static void set(std::string_view setting, std::string_view category, const osg::Vec3f& value);
        static void set(std::string_view setting, std::string_view category, DetourNavigator::CollisionShapeType value);
        static void set(std::string_view setting, std::string_view category, const std::vector<std::string>& value);
        static void set(std::string_view setting, std::string_view category, const MyGUI::Colour& value);
        static void set(std::string_view setting, std::string_view category, SceneUtil::LightingMethod value);
        static void set(std::string_view setting, std::string_view category, HrtfMode value);
        static void set(std::string_view setting, std::string_view category, WindowMode value);
        static void set(std::string_view setting, std::string_view category, SDLUtil::VSyncMode value);

    private:
        static std::set<std::pair<std::string_view, std::string_view>> sInitialized;

        template <class T>
        static T getImpl(std::string_view setting, std::string_view category) = delete;

        static void recordInit(std::string_view setting, std::string_view category);
    };

    template <>
    inline int Manager::getImpl<int>(std::string_view setting, std::string_view category)
    {
        return getInt(setting, category);
    }

    template <>
    inline unsigned Manager::getImpl<unsigned>(std::string_view setting, std::string_view category)
    {
        return getUnsigned(setting, category);
    }

    template <>
    inline unsigned long Manager::getImpl<unsigned long>(std::string_view setting, std::string_view category)
    {
        return getUnsignedLong(setting, category);
    }

    template <>
    inline unsigned long long Manager::getImpl<unsigned long long>(std::string_view setting, std::string_view category)
    {
        return getUnsignedLongLong(setting, category);
    }

    template <>
    inline float Manager::getImpl<float>(std::string_view setting, std::string_view category)
    {
        return getFloat(setting, category);
    }

    template <>
    inline double Manager::getImpl<double>(std::string_view setting, std::string_view category)
    {
        return getDouble(setting, category);
    }

    template <>
    inline std::string Manager::getImpl<std::string>(std::string_view setting, std::string_view category)
    {
        return getString(setting, category);
    }

    template <>
    inline bool Manager::getImpl<bool>(std::string_view setting, std::string_view category)
    {
        return getBool(setting, category);
    }

    template <>
    inline osg::Vec2f Manager::getImpl<osg::Vec2f>(std::string_view setting, std::string_view category)
    {
        return getVector2(setting, category);
    }

    template <>
    inline osg::Vec3f Manager::getImpl<osg::Vec3f>(std::string_view setting, std::string_view category)
    {
        return getVector3(setting, category);
    }

    template <>
    inline DetourNavigator::CollisionShapeType Manager::getImpl<DetourNavigator::CollisionShapeType>(
        std::string_view setting, std::string_view category)
    {
        return DetourNavigator::toCollisionShapeType(getInt(setting, category));
    }

    template <>
    inline std::vector<std::string> Manager::getImpl<std::vector<std::string>>(
        std::string_view setting, std::string_view category)
    {
        return getStringArray(setting, category);
    }

    template <>
    inline MyGUI::Colour Manager::getImpl<MyGUI::Colour>(std::string_view setting, std::string_view category)
    {
        return MyGUI::Colour::parse(getString(setting, category));
    }

    GyroscopeAxis parseGyroscopeAxis(std::string_view value);

    template <>
    inline GyroscopeAxis Manager::getImpl<GyroscopeAxis>(std::string_view setting, std::string_view category)
    {
        return parseGyroscopeAxis(getString(setting, category));
    }

    NavMeshRenderMode parseNavMeshRenderMode(std::string_view value);

    template <>
    inline NavMeshRenderMode Manager::getImpl<NavMeshRenderMode>(std::string_view setting, std::string_view category)
    {
        return parseNavMeshRenderMode(getString(setting, category));
    }

    SceneUtil::LightingMethod parseLightingMethod(std::string_view value);

    template <>
    inline SceneUtil::LightingMethod Manager::getImpl<SceneUtil::LightingMethod>(
        std::string_view setting, std::string_view category)
    {
        return parseLightingMethod(getString(setting, category));
    }

    template <>
    inline HrtfMode Manager::getImpl<HrtfMode>(std::string_view setting, std::string_view category)
    {
        const int value = getInt(setting, category);
        if (value < 0)
            return HrtfMode::Auto;
        if (value > 0)
            return HrtfMode::Enable;
        return HrtfMode::Disable;
    }

    template <>
    inline WindowMode Manager::getImpl<WindowMode>(std::string_view setting, std::string_view category)
    {
        const int value = getInt(setting, category);
        if (value < 0 || 2 < value)
            return WindowMode::Fullscreen;
        return static_cast<WindowMode>(value);
    }

    template <>
    inline SDLUtil::VSyncMode Manager::getImpl<SDLUtil::VSyncMode>(std::string_view setting, std::string_view category)
    {
        const int value = getInt(setting, category);
        if (value < 0 || 2 < value)
            return SDLUtil::VSyncMode::Disabled;
        return static_cast<SDLUtil::VSyncMode>(value);
    }

    ScreenshotSettings parseScreenshotSettings(std::string_view value);

    template <>
    inline ScreenshotSettings Manager::getImpl<ScreenshotSettings>(std::string_view setting, std::string_view category)
    {
        return parseScreenshotSettings(getString(setting, category));
    }
}

#endif // COMPONENTS_SETTINGS_H