pcsx2/common/SettingsInterface.h

// SPDX-FileCopyrightText: 2002-2024 PCSX2 Dev Team
// SPDX-License-Identifier: GPL-3.0+

#pragma once

#include "Pcsx2Defs.h"
#include "SmallString.h"

#include <string>
#include <optional>
#include <vector>

class Error;

class SettingsInterface
{
public:
	virtual ~SettingsInterface() = default;

	virtual bool Save(Error* error = nullptr) = 0;
	virtual void Clear() = 0;
	virtual bool IsEmpty() = 0;

	virtual bool GetIntValue(const char* section, const char* key, int* value) const = 0;
	virtual bool GetUIntValue(const char* section, const char* key, uint* value) const = 0;
	virtual bool GetFloatValue(const char* section, const char* key, float* value) const = 0;
	virtual bool GetDoubleValue(const char* section, const char* key, double* value) const = 0;
	virtual bool GetBoolValue(const char* section, const char* key, bool* value) const = 0;
	virtual bool GetStringValue(const char* section, const char* key, std::string* value) const = 0;
	virtual bool GetStringValue(const char* section, const char* key, SmallStringBase* value) const = 0;

	virtual void SetIntValue(const char* section, const char* key, int value) = 0;
	virtual void SetUIntValue(const char* section, const char* key, uint value) = 0;
	virtual void SetFloatValue(const char* section, const char* key, float value) = 0;
	virtual void SetDoubleValue(const char* section, const char* key, double value) = 0;
	virtual void SetBoolValue(const char* section, const char* key, bool value) = 0;
	virtual void SetStringValue(const char* section, const char* key, const char* value) = 0;

	virtual std::vector<std::string> GetStringList(const char* section, const char* key) const = 0;
	virtual void SetStringList(const char* section, const char* key, const std::vector<std::string>& items) = 0;
	virtual bool RemoveFromStringList(const char* section, const char* key, const char* item) = 0;
	virtual bool AddToStringList(const char* section, const char* key, const char* item) = 0;

	virtual std::vector<std::pair<std::string, std::string>> GetKeyValueList(const char* section) const = 0;
	virtual void SetKeyValueList(const char* section, const std::vector<std::pair<std::string, std::string>>& items) = 0;

	virtual bool ContainsValue(const char* section, const char* key) const = 0;
	virtual void DeleteValue(const char* section, const char* key) = 0;
	virtual void ClearSection(const char* section) = 0;
	virtual void RemoveSection(const char* section) = 0;
	virtual void RemoveEmptySections() = 0;

	__fi int GetIntValue(const char* section, const char* key, int default_value = 0) const
	{
		int value;
		return GetIntValue(section, key, &value) ? value : default_value;
	}

	__fi uint GetUIntValue(const char* section, const char* key, uint default_value = 0) const
	{
		uint value;
		return GetUIntValue(section, key, &value) ? value : default_value;
	}

	__fi float GetFloatValue(const char* section, const char* key, float default_value = 0.0f) const
	{
		float value;
		return GetFloatValue(section, key, &value) ? value : default_value;
	}

	__fi float GetDoubleValue(const char* section, const char* key, double default_value = 0.0) const
	{
		double value;
		return GetDoubleValue(section, key, &value) ? value : default_value;
	}

	__fi bool GetBoolValue(const char* section, const char* key, bool default_value = false) const
	{
		bool value;
		return GetBoolValue(section, key, &value) ? value : default_value;
	}

	__fi std::string GetStringValue(const char* section, const char* key, const char* default_value = "") const
	{
		std::string value;
		if (!GetStringValue(section, key, &value))
			value.assign(default_value);
		return value;
	}

	__fi SmallString GetSmallStringValue(const char* section, const char* key, const char* default_value = "") const
	{
		SmallString value;
		if (!GetStringValue(section, key, &value))
			value.assign(default_value);
		return value;
	}

	__fi TinyString GetTinyStringValue(const char* section, const char* key, const char* default_value = "") const
	{
		TinyString value;
		if (!GetStringValue(section, key, &value))
			value.assign(default_value);
		return value;
	}

	__fi std::optional<int> GetOptionalIntValue(const char* section, const char* key, std::optional<int> default_value = std::nullopt) const
	{
		int ret;
		return GetIntValue(section, key, &ret) ? std::optional<int>(ret) : default_value;
	}

	__fi std::optional<uint> GetOptionalUIntValue(const char* section, const char* key, std::optional<uint> default_value = std::nullopt) const
	{
		uint ret;
		return GetUIntValue(section, key, &ret) ? std::optional<uint>(ret) : default_value;
	}

	__fi std::optional<float> GetOptionalFloatValue(const char* section, const char* key, std::optional<float> default_value = std::nullopt) const
	{
		float ret;
		return GetFloatValue(section, key, &ret) ? std::optional<float>(ret) : default_value;
	}

	__fi std::optional<double> GetOptionalDoubleValue(const char* section, const char* key, std::optional<double> default_value = std::nullopt) const
	{
		double ret;
		return GetDoubleValue(section, key, &ret) ? std::optional<double>(ret) : default_value;
	}

	__fi std::optional<bool> GetOptionalBoolValue(const char* section, const char* key, std::optional<bool> default_value = std::nullopt) const
	{
		bool ret;
		return GetBoolValue(section, key, &ret) ? std::optional<bool>(ret) : default_value;
	}

	__fi std::optional<std::string> GetOptionalStringValue(const char* section, const char* key, std::optional<const char*> default_value = std::nullopt) const
	{
		std::string ret;
		return GetStringValue(section, key, &ret) ? std::optional<std::string>(ret) :
													(default_value.has_value() ? std::optional<std::string>(default_value.value()) :
																				 std::optional<std::string>());
	}

	__fi std::optional<SmallString> GetOptionalSmallStringValue(const char* section, const char* key,
		std::optional<const char*> default_value = std::nullopt) const
	{
		SmallString ret;
		return GetStringValue(section, key, &ret) ?
				   std::optional<SmallString>(ret) :
				   (default_value.has_value() ? std::optional<SmallString>(default_value.value()) :
												std::optional<SmallString>());
	}

	__fi std::optional<TinyString> GetOptionalTinyStringValue(const char* section, const char* key,
		std::optional<const char*> default_value = std::nullopt) const
	{
		TinyString ret;
		return GetStringValue(section, key, &ret) ?
				   std::optional<TinyString>(ret) :
				   (default_value.has_value() ? std::optional<TinyString>(default_value.value()) :
												std::optional<TinyString>());
	}

	__fi void SetOptionalIntValue(const char* section, const char* key, const std::optional<int>& value)
	{
		value.has_value() ? SetIntValue(section, key, value.value()) : DeleteValue(section, key);
	}

	__fi void SetOptionalUIntValue(const char* section, const char* key, const std::optional<uint>& value)
	{
		value.has_value() ? SetUIntValue(section, key, value.value()) : DeleteValue(section, key);
	}

	__fi void SetOptionalFloatValue(const char* section, const char* key, const std::optional<float>& value)
	{
		value.has_value() ? SetFloatValue(section, key, value.value()) : DeleteValue(section, key);
	}

	__fi void SetOptionalDoubleValue(const char* section, const char* key, const std::optional<double>& value)
	{
		value.has_value() ? SetDoubleValue(section, key, value.value()) : DeleteValue(section, key);
	}

	__fi void SetOptionalBoolValue(const char* section, const char* key, const std::optional<bool>& value)
	{
		value.has_value() ? SetBoolValue(section, key, value.value()) : DeleteValue(section, key);
	}

	__fi void SetOptionalStringValue(const char* section, const char* key, const std::optional<const char*>& value)
	{
		value.has_value() ? SetStringValue(section, key, value.value()) : DeleteValue(section, key);
	}

	__fi void CopyBoolValue(const SettingsInterface& si, const char* section, const char* key)
	{
		bool value;
		if (si.GetBoolValue(section, key, &value))
			SetBoolValue(section, key, value);
		else
			DeleteValue(section, key);
	}

	__fi void CopyIntValue(const SettingsInterface& si, const char* section, const char* key)
	{
		int value;
		if (si.GetIntValue(section, key, &value))
			SetIntValue(section, key, value);
		else
			DeleteValue(section, key);
	}

	__fi void CopyUIntValue(const SettingsInterface& si, const char* section, const char* key)
	{
		uint value;
		if (si.GetUIntValue(section, key, &value))
			SetUIntValue(section, key, value);
		else
			DeleteValue(section, key);
	}

	__fi void CopyFloatValue(const SettingsInterface& si, const char* section, const char* key)
	{
		float value;
		if (si.GetFloatValue(section, key, &value))
			SetFloatValue(section, key, value);
		else
			DeleteValue(section, key);
	}

	__fi void CopyDoubleValue(const SettingsInterface& si, const char* section, const char* key)
	{
		double value;
		if (si.GetDoubleValue(section, key, &value))
			SetDoubleValue(section, key, value);
		else
			DeleteValue(section, key);
	}

	__fi void CopyStringValue(const SettingsInterface& si, const char* section, const char* key)
	{
		std::string value;
		if (si.GetStringValue(section, key, &value))
			SetStringValue(section, key, value.c_str());
		else
			DeleteValue(section, key);
	}

	__fi void CopyStringListValue(const SettingsInterface& si, const char* section, const char* key)
	{
		std::vector<std::string> value(si.GetStringList(section, key));
		if (!value.empty())
			SetStringList(section, key, value);
		else
			DeleteValue(section, key);
	}

	__fi void CopyKeysAndValues(const SettingsInterface& si, const char* section)
	{
		SetKeyValueList(section, si.GetKeyValueList(section));
	}
};