Common: Add SettingsInterface and SettingsWrapper

2026-01-31 01:15:24 +01:00 · 2021-09-22 17:39:01 +10:00
parent 817524bd1c
commit 6fa82da1f1
6 changed files with 393 additions and 0 deletions
--- a/common/SettingsWrapper.cpp
+++ b/common/SettingsWrapper.cpp
@@ -0,0 +1,180 @@
+/*  PCSX2 - PS2 Emulator for PCs
+ *  Copyright (C) 2002-2021  PCSX2 Dev Team
+ *
+ *  PCSX2 is free software: you can redistribute it and/or modify it under the terms
+ *  of the GNU Lesser General Public License as published by the Free Software Found-
+ *  ation, either version 3 of the License, or (at your option) any later version.
+ *
+ *  PCSX2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ *  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ *  PURPOSE.  See the GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along with PCSX2.
+ *  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "PrecompiledHeader.h"
+
+#include <algorithm>
+
+#include "SettingsWrapper.h"
+#include "Console.h"
+
+static int _calcEnumLength(const char* const* enumArray)
+{
+	int cnt = 0;
+	while (*enumArray != nullptr)
+	{
+		enumArray++;
+		cnt++;
+	}
+
+	return cnt;
+}
+
+SettingsWrapper::SettingsWrapper(SettingsInterface& si)
+	: m_si(si)
+{
+}
+
+SettingsLoadWrapper::SettingsLoadWrapper(SettingsInterface& si)
+	: SettingsWrapper(si)
+{
+}
+
+bool SettingsLoadWrapper::IsLoading() const
+{
+	return true;
+}
+
+bool SettingsLoadWrapper::IsSaving() const
+{
+	return false;
+}
+
+void SettingsLoadWrapper::Entry(const char* section, const char* var, int& value, const int defvalue /*= 0*/)
+{
+	value = m_si.GetIntValue(section, var, defvalue);
+}
+
+void SettingsLoadWrapper::Entry(const char* section, const char* var, uint& value, const uint defvalue /*= 0*/)
+{
+	value = m_si.GetUIntValue(section, var, defvalue);
+}
+
+void SettingsLoadWrapper::Entry(const char* section, const char* var, bool& value, const bool defvalue /*= false*/)
+{
+	value = m_si.GetBoolValue(section, var, defvalue);
+}
+
+void SettingsLoadWrapper::Entry(const char* section, const char* var, double& value, const double defvalue /*= 0.0*/)
+{
+	value = m_si.GetDoubleValue(section, var, defvalue);
+}
+
+void SettingsLoadWrapper::Entry(const char* section, const char* var, std::string& value, const std::string& default_value /*= std::string()*/)
+{
+	if (!m_si.GetStringValue(section, var, &value) && &value != &default_value)
+		value = default_value;
+}
+
+void SettingsLoadWrapper::_EnumEntry(const char* section, const char* var, int& value, const char* const* enumArray, int defvalue)
+{
+	const int cnt = _calcEnumLength(enumArray);
+	defvalue = std::clamp(defvalue, 0, cnt);
+
+	const std::string retval(m_si.GetStringValue(section, var, enumArray[defvalue]));
+
+	int i = 0;
+	while (enumArray[i] != nullptr && (retval != enumArray[i]))
+		i++;
+
+	if (enumArray[i] == nullptr)
+	{
+		Console.Warning("(LoadSettings) Warning: Unrecognized value '%s' on key '%s'\n\tUsing the default setting of '%s'.",
+			retval.c_str(), var, enumArray[defvalue]);
+		value = defvalue;
+	}
+	else
+	{
+		value = i;
+	}
+}
+
+bool SettingsLoadWrapper::EntryBitBool(const char* section, const char* var, bool value, const bool defvalue /*= false*/)
+{
+	return m_si.GetBoolValue(section, var, defvalue);
+}
+
+int SettingsLoadWrapper::EntryBitfield(const char* section, const char* var, int value, const int defvalue /*= 0*/)
+{
+	return m_si.GetIntValue(section, var, defvalue);
+}
+
+SettingsSaveWrapper::SettingsSaveWrapper(SettingsInterface& si)
+	: SettingsWrapper(si)
+{
+}
+
+bool SettingsSaveWrapper::IsLoading() const
+{
+	return false;
+}
+
+bool SettingsSaveWrapper::IsSaving() const
+{
+	return true;
+}
+
+void SettingsSaveWrapper::Entry(const char* section, const char* var, int& value, const int defvalue /*= 0*/)
+{
+	m_si.SetIntValue(section, var, value);
+}
+
+void SettingsSaveWrapper::Entry(const char* section, const char* var, uint& value, const uint defvalue /*= 0*/)
+{
+	m_si.SetUIntValue(section, var, value);
+}
+
+void SettingsSaveWrapper::Entry(const char* section, const char* var, bool& value, const bool defvalue /*= false*/)
+{
+	m_si.SetBoolValue(section, var, value);
+}
+
+void SettingsSaveWrapper::Entry(const char* section, const char* var, double& value, const double defvalue /*= 0.0*/)
+{
+	m_si.SetDoubleValue(section, var, value);
+}
+
+void SettingsSaveWrapper::Entry(const char* section, const char* var, std::string& value, const std::string& default_value /*= std::string()*/)
+{
+	m_si.SetStringValue(section, var, value.c_str());
+}
+
+bool SettingsSaveWrapper::EntryBitBool(const char* section, const char* var, bool value, const bool defvalue /*= false*/)
+{
+	m_si.SetBoolValue(section, var, value);
+	return value;
+}
+
+int SettingsSaveWrapper::EntryBitfield(const char* section, const char* var, int value, const int defvalue /*= 0*/)
+{
+	m_si.SetIntValue(section, var, value);
+	return value;
+}
+
+void SettingsSaveWrapper::_EnumEntry(const char* section, const char* var, int& value, const char* const* enumArray, int defvalue)
+{
+	const int cnt = _calcEnumLength(enumArray);
+	if (value >= cnt)
+	{
+		Console.Warning("(SaveSettings) An illegal enumerated index was detected when saving '%s'", var);
+		Console.Indent().Warning(
+			"Illegal Value: %d\n"
+			"Using Default: %d (%s)\n",
+			value, defvalue, enumArray[defvalue]);
+		value = defvalue;
+	}
+
+	m_si.SetIntValue(section, var, value);
+}