openmw/components/settings/settings.cpp

#include "settings.hpp"
#include "parser.hpp"

#include <filesystem>
#include <sstream>

#include <components/files/configurationmanager.hpp>
#include <components/misc/strings/algorithm.hpp>

namespace Settings
{

CategorySettingValueMap Manager::mDefaultSettings = CategorySettingValueMap();
CategorySettingValueMap Manager::mUserSettings = CategorySettingValueMap();
CategorySettingVector Manager::mChangedSettings = CategorySettingVector();

void Manager::clear()
{
    mDefaultSettings.clear();
    mUserSettings.clear();
    mChangedSettings.clear();
}

std::filesystem::path Manager::load(const Files::ConfigurationManager& cfgMgr, bool loadEditorSettings)
{
    SettingsFileParser parser;
    const std::vector<std::filesystem::path>& paths = cfgMgr.getActiveConfigPaths();
    if (paths.empty())
        throw std::runtime_error("No config dirs! ConfigurationManager::readConfiguration must be called first.");

    // Create file name strings for either the engine or the editor.
    std::string defaultSettingsFile;
    std::string userSettingsFile;

    if (!loadEditorSettings)
    {
        defaultSettingsFile = "defaults.bin";
        userSettingsFile = "settings.cfg";
    }
    else
    {
        defaultSettingsFile = "defaults-cs.bin";
        userSettingsFile = "openmw-cs.cfg";
    }

    // Create the settings manager and load default settings file.
    const auto defaultsBin = paths.front() / defaultSettingsFile;
    if (!std::filesystem::exists(defaultsBin))
        throw std::runtime_error ("No default settings file found! Make sure the file \"" + defaultSettingsFile + "\" was properly installed.");
    parser.loadSettingsFile(defaultsBin, mDefaultSettings, true, false);

    // Load "settings.cfg" or "openmw-cs.cfg" from every config dir except the last one as additional default settings.
    for (int i = 0; i < static_cast<int>(paths.size()) - 1; ++i)
    {
        const auto additionalDefaults = paths[i] / userSettingsFile;
        if (std::filesystem::exists(additionalDefaults))
            parser.loadSettingsFile(additionalDefaults, mDefaultSettings, false, true);
    }

    // Load "settings.cfg" or "openmw-cs.cfg" from the last config dir as user settings. This path will be used to save modified settings.
    auto settingspath = paths.back() / userSettingsFile;
    if (std::filesystem::exists(settingspath))
        parser.loadSettingsFile(settingspath, mUserSettings, false, false);

    return settingspath;
}

void Manager::saveUser(const std::filesystem::path &file)
{
    SettingsFileParser parser;
    parser.saveSettingsFile(file, mUserSettings);
}

const std::string& Manager::getString(std::string_view setting, std::string_view category)
{
    const auto key = std::make_pair(category, setting);
    CategorySettingValueMap::iterator it = mUserSettings.find(key);
    if (it != mUserSettings.end())
        return it->second;

    it = mDefaultSettings.find(key);
    if (it != mDefaultSettings.end())
        return it->second;

    std::string error("Trying to retrieve a non-existing setting: ");
    error += setting;
    error += ".\nMake sure the defaults.bin file was properly installed.";
    throw std::runtime_error(error);
}

std::vector<std::string> Manager::getStringArray(std::string_view setting, std::string_view category)
{
    // TODO: it is unclear how to handle empty value -
    // there is no difference between empty serialized array
    // and a serialized array which has one empty value
    std::vector<std::string> values;
    const std::string& value = getString(setting, category);
    if (value.empty())
        return values;

    Misc::StringUtils::split(value, values, ",");
    for (auto& item : values)
        Misc::StringUtils::trim(item);
    return values;
}

float Manager::getFloat(std::string_view setting, std::string_view category)
{
    const std::string& value = getString(setting, category);
    std::stringstream stream(value);
    float number = 0.f;
    stream >> number;
    return number;
}

double Manager::getDouble(std::string_view setting, std::string_view category)
{
    const std::string& value = getString(setting, category);
    std::stringstream stream(value);
    double number = 0.0;
    stream >> number;
    return number;
}

int Manager::getInt(std::string_view setting, std::string_view category)
{
    const std::string& value = getString(setting, category);
    std::stringstream stream(value);
    int number = 0;
    stream >> number;
    return number;
}

std::int64_t Manager::getInt64(std::string_view setting, std::string_view category)
{
    const std::string& value = getString(setting, category);
    std::stringstream stream(value);
    std::int64_t number = 0;
    stream >> number;
    return number;
}

bool Manager::getBool(std::string_view setting, std::string_view category)
{
    const std::string& string = getString(setting, category);
    return Misc::StringUtils::ciEqual(string, "true");
}

osg::Vec2f Manager::getVector2(std::string_view setting, std::string_view category)
{
    const std::string& value = getString(setting, category);
    std::stringstream stream(value);
    float x, y;
    stream >> x >> y;
    if (stream.fail())
        throw std::runtime_error(std::string("Can't parse 2d vector: " + value));
    return {x, y};
}

osg::Vec3f Manager::getVector3(std::string_view setting, std::string_view category)
{
    const std::string& value = getString(setting, category);
    std::stringstream stream(value);
    float x, y, z;
    stream >> x >> y >> z;
    if (stream.fail())
        throw std::runtime_error(std::string("Can't parse 3d vector: " + value));
    return {x, y, z};
}

void Manager::setString(std::string_view setting, std::string_view category, const std::string &value)
{
    auto found = mUserSettings.find(std::make_pair(category, setting));
    if (found != mUserSettings.end())
    {
        if (found->second == value)
            return;
    }

    CategorySettingValueMap::key_type key(category, setting);

    mUserSettings[key] = value;

    mChangedSettings.insert(std::move(key));
}

void Manager::setStringArray(std::string_view setting, std::string_view category, const std::vector<std::string> &value)
{
    std::stringstream stream;

    // TODO: escape delimeters, new line characters, etc.
    for (size_t i = 0; i < value.size(); ++i)
    {
        std::string item = value[i];
        Misc::StringUtils::trim(item);
        stream << item;

        if (i < value.size() - 1)
            stream << ",";
    }

    setString(setting, category, stream.str());
}

void Manager::setInt(std::string_view setting, std::string_view category, const int value)
{
    std::ostringstream stream;
    stream << value;
    setString(setting, category, stream.str());
}

void Manager::setInt64(std::string_view setting, std::string_view category, const std::int64_t value)
{
    std::ostringstream stream;
    stream << value;
    setString(setting, category, stream.str());
}

void Manager::setFloat (std::string_view setting, std::string_view category, const float value)
{
    std::ostringstream stream;
    stream << value;
    setString(setting, category, stream.str());
}

void Manager::setDouble (std::string_view setting, std::string_view category, const double value)
{
    std::ostringstream stream;
    stream << value;
    setString(setting, category, stream.str());
}

void Manager::setBool(std::string_view setting, std::string_view category, const bool value)
{
    setString(setting, category, value ? "true" : "false");
}

void Manager::setVector2 (std::string_view setting, std::string_view category, const osg::Vec2f value)
{
    std::ostringstream stream;
    stream << value.x() << " " << value.y();
    setString(setting, category, stream.str());
}

void Manager::setVector3 (std::string_view setting, std::string_view category, const osg::Vec3f value)
{
    std::ostringstream stream;
    stream << value.x() << ' ' << value.y() << ' ' << value.z();
    setString(setting, category, stream.str());
}

CategorySettingVector Manager::getPendingChanges()
{
    return mChangedSettings;
}

CategorySettingVector Manager::getPendingChanges(const CategorySettingVector& filter)
{
    CategorySettingVector intersection;
    std::set_intersection(mChangedSettings.begin(), mChangedSettings.end(),
                          filter.begin(), filter.end(),
                          std::inserter(intersection, intersection.begin()));
    return intersection;
}

void Manager::resetPendingChanges()
{
    mChangedSettings.clear();
}

void Manager::resetPendingChanges(const CategorySettingVector& filter)
{
    for (const auto& key : filter)
    {
        mChangedSettings.erase(key);
    }
}

}