Move settings lib into the main code, fixing error logging in it.

logic/BaseInstance.cpp

@@ -21,9 +21,9 @@
 #include <QDir>
 #include "MultiMC.h"
 
-#include "inisettingsobject.h"
-#include "setting.h"
-#include "overridesetting.h"
+#include "logic/settings/INISettingsObject.h"
+#include "logic/settings/Setting.h"
+#include "logic/settings/OverrideSetting.h"
 
 #include "pathutils.h"
 #include <cmdutils.h>

logic/BaseInstance.h

@@ -19,9 +19,9 @@
 #include <QDateTime>
 #include <QSet>
 
-#include <settingsobject.h>
+#include "logic/settings/SettingsObject.h"
 
-#include "inifile.h"
+#include "logic/settings/INIFile.h"
 #include "logic/BaseVersionList.h"
 #include "logic/auth/MojangAccount.h"
 

logic/BaseInstance_p.h

@@ -18,7 +18,7 @@
 #include <QString>
 #include <QSet>
 
-#include <settingsobject.h>
+#include "logic/settings/SettingsObject.h"
 
 #include "BaseInstance.h"
 

logic/InstanceFactory.cpp

@@ -15,9 +15,10 @@
 
 #include <QDir>
 #include <QFileInfo>
-#include <inifile.h>
-#include <inisettingsobject.h>
-#include <setting.h>
+
+#include "logic/settings/INIFile.h"
+#include "logic/settings/INISettingsObject.h"
+#include "logic/settings/Setting.h"
 
 #include <pathutils.h>
 #include "logger/QsLog.h"

logic/LegacyInstance.cpp

@@ -16,7 +16,7 @@
 #include <QFileInfo>
 #include <QDir>
 #include <QImage>
-#include <setting.h>
+#include <logic/settings/Setting.h>
 #include <pathutils.h>
 #include <cmdutils.h>
 

logic/LegacyInstance_p.h

@@ -15,7 +15,7 @@
 
 #pragma once
 #include <QString>
-#include <settingsobject.h>
+#include "logic/settings/SettingsObject.h"
 #include <memory>
 
 #include "BaseInstance_p.h"

logic/Mod.cpp

@@ -24,7 +24,7 @@
 
 #include "Mod.h"
 #include <pathutils.h>
-#include <inifile.h>
+#include "logic/settings/INIFile.h"
 #include "logger/QsLog.h"
 
 Mod::Mod(const QFileInfo &file)

logic/icons/IconList.cpp

@@ -15,14 +15,14 @@
 
 #include "IconList.h"
 #include <pathutils.h>
-#include <settingsobject.h>
+#include "logic/settings/SettingsObject.h"
 #include <QMap>
 #include <QEventLoop>
 #include <QMimeData>
 #include <QUrl>
 #include <QFileSystemWatcher>
 #include <MultiMC.h>
-#include <setting.h>
+#include <logic/settings/Setting.h>
 
 #define MAX_SIZE 1024
 
@@ -45,8 +45,8 @@ IconList::IconList(QObject *parent) : QAbstractListModel(parent)
 
 	auto setting = MMC->settings()->getSetting("IconsDir");
 	QString path = setting->get().toString();
-	connect(setting.get(), SIGNAL(settingChanged(const Setting &, QVariant)),
-			SLOT(settingChanged(const Setting &, QVariant)));
+	connect(setting.get(), SIGNAL(SettingChanged(const Setting &, QVariant)),
+			SLOT(SettingChanged(const Setting &, QVariant)));
 	directoryChanged(path);
 }
 
@@ -143,7 +143,7 @@ void IconList::fileChanged(const QString &path)
 	emit iconUpdated(key);
 }
 
-void IconList::settingChanged(const Setting &setting, QVariant value)
+void IconList::SettingChanged(const Setting &setting, QVariant value)
 {
 	if(setting.id() != "IconsDir")
 		return;

logic/icons/IconList.h

@@ -22,7 +22,7 @@
 #include <QtGui/QIcon>
 #include <memory>
 #include "MMCIcon.h"
-#include "setting.h"
+#include "logic/settings/Setting.h"
 
 class QFileSystemWatcher;
 
@@ -68,7 +68,7 @@ protected
 slots:
 	void directoryChanged(const QString &path);
 	void fileChanged(const QString &path);
-	void settingChanged(const Setting & setting, QVariant value);
+	void SettingChanged(const Setting & setting, QVariant value);
 private:
 	std::shared_ptr<QFileSystemWatcher> m_watcher;
 	bool is_watching;

logic/java/JavaUtils.cpp

@@ -18,7 +18,7 @@
 #include <QDir>
 #include <QStringList>
 
-#include <setting.h>
+#include <logic/settings/Setting.h>
 #include <pathutils.h>
 
 #include "MultiMC.h"

logic/settings/INIFile.cpp

@@ -0,0 +1,138 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "logic/settings/INIFile.h"
+
+#include <QFile>
+#include <QTextStream>
+#include <QStringList>
+
+INIFile::INIFile()
+{
+}
+
+QString INIFile::unescape(QString orig)
+{
+	QString out;
+	QChar prev = 0;
+	for(auto c: orig)
+	{
+		if(prev == '\\')
+		{
+			if(c == 'n')
+				out += '\n';
+			else if (c == 't')
+				out += '\t';
+			else
+				out += c;
+			prev = 0;
+		}
+		else
+		{
+			if(c == '\\')
+			{
+				prev = c;
+				continue;
+			}
+			out += c;
+			prev = 0;
+		}
+	}
+	return out;
+}
+
+QString INIFile::escape(QString orig)
+{
+	QString out;
+	for(auto c: orig)
+	{
+		if(c == '\n')
+			out += "\\n";
+		else if (c == '\t')
+			out += "\\t";
+		else if(c == '\\')
+			out += "\\\\";
+		else
+			out += c;
+	}
+	return out;
+}
+
+bool INIFile::saveFile(QString fileName)
+{
+	// TODO Handle errors.
+	QFile file(fileName);
+	file.open(QIODevice::WriteOnly);
+	QTextStream out(&file);
+	out.setCodec("UTF-8");
+
+	for (Iterator iter = begin(); iter != end(); iter++)
+	{
+		QString value = iter.value().toString();
+		value = escape(value);
+		out << iter.key() << "=" << value << "\n";
+	}
+
+	return true;
+}
+
+bool INIFile::loadFile(QString fileName)
+{
+	QFile file(fileName);
+	if (!file.open(QIODevice::ReadOnly))
+		return false;
+	bool success = loadFile(file.readAll());
+	file.close();
+	return success;
+}
+bool INIFile::loadFile(QByteArray file)
+{
+	QTextStream in(file);
+	in.setCodec("UTF-8");
+
+	QStringList lines = in.readAll().split('\n');
+	for (int i = 0; i < lines.count(); i++)
+	{
+		QString &lineRaw = lines[i];
+		// Ignore comments.
+		QString line = lineRaw.left(lineRaw.indexOf('#')).trimmed();
+
+		int eqPos = line.indexOf('=');
+		if (eqPos == -1)
+			continue;
+		QString key = line.left(eqPos).trimmed();
+		QString valueStr = line.right(line.length() - eqPos - 1).trimmed();
+
+		valueStr = unescape(valueStr);
+
+		QVariant value(valueStr);
+		this->operator[](key) = value;
+	}
+
+	return true;
+}
+
+QVariant INIFile::get(QString key, QVariant def) const
+{
+	if (!this->contains(key))
+		return def;
+	else
+		return this->operator[](key);
+}
+
+void INIFile::set(QString key, QVariant val)
+{
+	this->operator[](key) = val;
+}

logic/settings/INIFile.h

@@ -0,0 +1,36 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <QString>
+#include <QVariant>
+#include <QIODevice>
+
+// Sectionless INI parser (for instance config files)
+class INIFile : public QMap<QString, QVariant>
+{
+public:
+	explicit INIFile();
+
+	bool loadFile(QByteArray file);
+	bool loadFile(QString fileName);
+	bool saveFile(QString fileName);
+
+	QVariant get(QString key, QVariant def) const;
+	void set(QString key, QVariant val);
+	static QString unescape(QString orig);
+	static QString escape(QString orig);
+};

logic/settings/INISettingsObject.cpp

@@ -0,0 +1,81 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "INISettingsObject.h"
+#include "Setting.h"
+
+INISettingsObject::INISettingsObject(const QString &path, QObject *parent)
+	: SettingsObject(parent)
+{
+	m_filePath = path;
+	m_ini.loadFile(path);
+}
+
+void INISettingsObject::setFilePath(const QString &filePath)
+{
+	m_filePath = filePath;
+}
+
+bool INISettingsObject::reload()
+{
+	return m_ini.loadFile(m_filePath) && SettingsObject::reload();
+}
+
+void INISettingsObject::changeSetting(const Setting &setting, QVariant value)
+{
+	if (contains(setting.id()))
+	{
+		// valid value -> set the main config, remove all the sysnonyms
+		if (value.isValid())
+		{
+			auto list = setting.configKeys();
+			m_ini.set(list.takeFirst(), value);
+			for(auto iter: list)
+				m_ini.remove(iter);
+		}
+		// invalid -> remove all (just like resetSetting)
+		else
+		{
+			for(auto iter: setting.configKeys())
+				m_ini.remove(iter);
+		}
+		m_ini.saveFile(m_filePath);
+	}
+}
+
+void INISettingsObject::resetSetting(const Setting &setting)
+{
+	// if we have the setting, remove all the synonyms. ALL OF THEM
+	if (contains(setting.id()))
+	{
+		for(auto iter: setting.configKeys())
+			m_ini.remove(iter);
+		m_ini.saveFile(m_filePath);
+	}
+}
+
+QVariant INISettingsObject::retrieveValue(const Setting &setting)
+{
+	// if we have the setting, return value of the first matching synonym
+	if (contains(setting.id()))
+	{
+		for(auto iter: setting.configKeys())
+		{
+			if(m_ini.contains(iter))
+				return m_ini[iter];
+		}
+	}
+	return QVariant();
+}

logic/settings/INISettingsObject.h

@@ -0,0 +1,61 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <QObject>
+
+#include "logic/settings/INIFile.h"
+
+#include "logic/settings/SettingsObject.h"
+
+/*!
+ * \brief A settings object that stores its settings in an INIFile.
+ */
+class INISettingsObject : public SettingsObject
+{
+	Q_OBJECT
+public:
+	explicit INISettingsObject(const QString &path, QObject *parent = 0);
+
+	/*!
+	 * \brief Gets the path to the INI file.
+	 * \return The path to the INI file.
+	 */
+	virtual QString filePath() const
+	{
+		return m_filePath;
+	}
+
+	/*!
+	 * \brief Sets the path to the INI file and reloads it.
+	 * \param filePath The INI file's new path.
+	 */
+	virtual void setFilePath(const QString &filePath);
+
+	bool reload() override;
+
+protected
+slots:
+	virtual void changeSetting(const Setting &setting, QVariant value);
+	virtual void resetSetting(const Setting &setting);
+
+protected:
+	virtual QVariant retrieveValue(const Setting &setting);
+
+	INIFile m_ini;
+
+	QString m_filePath;
+};

logic/settings/OverrideSetting.cpp

@@ -0,0 +1,30 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "OverrideSetting.h"
+
+OverrideSetting::OverrideSetting(std::shared_ptr<Setting> other)
+	: Setting(other->configKeys(), QVariant())
+{
+	m_other = other;
+}
+
+QVariant OverrideSetting::defValue() const
+{
+	if (m_other)
+		return m_other->get();
+	else
+		return QVariant();
+}

logic/settings/OverrideSetting.h

@@ -0,0 +1,39 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <QObject>
+#include <memory>
+
+#include "Setting.h"
+
+/*!
+ * \brief A setting that 'overrides another.'
+ * This means that the setting's default value will be the value of another setting.
+ * The other setting can be (and usually is) a part of a different SettingsObject
+ * than this one.
+ */
+class OverrideSetting : public Setting
+{
+	Q_OBJECT
+public:
+	explicit OverrideSetting(std::shared_ptr<Setting> other);
+
+	virtual QVariant defValue() const;
+
+protected:
+	std::shared_ptr<Setting> m_other;
+};

logic/settings/Setting.cpp

@@ -0,0 +1,53 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "Setting.h"
+#include "logic/settings/SettingsObject.h"
+
+Setting::Setting(QStringList synonyms, QVariant defVal)
+	: QObject(), m_synonyms(synonyms), m_defVal(defVal)
+{
+}
+
+QVariant Setting::get() const
+{
+	SettingsObject *sbase = m_storage;
+	if (!sbase)
+	{
+		return defValue();
+	}
+	else
+	{
+		QVariant test = sbase->retrieveValue(*this);
+		if (!test.isValid())
+			return defValue();
+		return test;
+	}
+}
+
+QVariant Setting::defValue() const
+{
+	return m_defVal;
+}
+
+void Setting::set(QVariant value)
+{
+	emit SettingChanged(*this, value);
+}
+
+void Setting::reset()
+{
+	emit settingReset(*this);
+}

logic/settings/Setting.h

@@ -0,0 +1,117 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <QObject>
+#include <QVariant>
+#include <QStringList>
+#include <memory>
+
+class SettingsObject;
+
+/*!
+ *
+ */
+class Setting : public QObject
+{
+	Q_OBJECT
+public:
+	/**
+	 * Construct a Setting
+	 * 
+	 * Synonyms are all the possible names used in the settings object, in order of preference.
+	 * First synonym is the ID, which identifies the setting in MultiMC.
+	 * 
+	 * defVal is the default value that will be returned when the settings object
+	 * doesn't have any value for this setting.
+	 */
+	explicit Setting(QStringList synonyms, QVariant defVal = QVariant());
+
+	/*!
+	 * \brief Gets this setting's ID.
+	 * This is used to refer to the setting within the application.
+	 * \warning Changing the ID while the setting is registered with a SettingsObject results in
+	 * undefined behavior.
+	 * \return The ID of the setting.
+	 */
+	virtual QString id() const
+	{
+		return m_synonyms.first();
+	}
+
+	/*!
+	 * \brief Gets this setting's config file key.
+	 * This is used to store the setting's value in the config file. It is usually
+	 * the same as the setting's ID, but it can be different.
+	 * \return The setting's config file key.
+	 */
+	virtual QStringList configKeys() const
+	{
+		return m_synonyms;
+	}
+
+	/*!
+	 * \brief Gets this setting's value as a QVariant.
+	 * This is done by calling the SettingsObject's retrieveValue() function.
+	 * If this Setting doesn't have a SettingsObject, this returns an invalid QVariant.
+	 * \return QVariant containing this setting's value.
+	 * \sa value()
+	 */
+	virtual QVariant get() const;
+
+	/*!
+	 * \brief Gets this setting's default value.
+	 * \return The default value of this setting.
+	 */
+	virtual QVariant defValue() const;
+
+signals:
+	/*!
+	 * \brief Signal emitted when this Setting object's value changes.
+	 * \param setting A reference to the Setting that changed.
+	 * \param value This Setting object's new value.
+	 */
+	void SettingChanged(const Setting &setting, QVariant value);
+
+	/*!
+	 * \brief Signal emitted when this Setting object's value resets to default.
+	 * \param setting A reference to the Setting that changed.
+	 */
+	void settingReset(const Setting &setting);
+
+public
+slots:
+	/*!
+	 * \brief Changes the setting's value.
+	 * This is done by emitting the SettingChanged() signal which will then be
+	 * handled by the SettingsObject object and cause the setting to change.
+	 * \param value The new value.
+	 */
+	virtual void set(QVariant value);
+
+	/*!
+	 * \brief Reset the setting to default
+	 * This is done by emitting the settingReset() signal which will then be
+	 * handled by the SettingsObject object and cause the setting to change.
+	 */
+	virtual void reset();
+
+protected:
+	friend class SettingsObject;
+	SettingsObject * m_storage;
+	QStringList m_synonyms;
+	QVariant m_defVal;
+};

logic/settings/SettingsObject.cpp

@@ -0,0 +1,124 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "logic/settings/SettingsObject.h"
+#include "logic/settings/Setting.h"
+#include "logic/settings/OverrideSetting.h"
+#include "logger/QsLog.h"
+
+#include <QVariant>
+
+SettingsObject::SettingsObject(QObject *parent) : QObject(parent)
+{
+}
+
+SettingsObject::~SettingsObject()
+{
+	m_settings.clear();
+}
+
+std::shared_ptr<Setting> SettingsObject::registerOverride(std::shared_ptr<Setting> original)
+{
+	if (contains(original->id()))
+	{
+		QLOG_ERROR() << QString("Failed to register setting %1. ID already exists.")
+				   .arg(original->id());
+		return nullptr; // Fail
+	}
+	auto override = std::make_shared<OverrideSetting>(original);
+	override->m_storage = this;
+	connectSignals(*override);
+	m_settings.insert(override->id(), override);
+	return override;
+}
+
+std::shared_ptr<Setting> SettingsObject::registerSetting(QStringList synonyms, QVariant defVal)
+{
+	if (synonyms.empty())
+		return nullptr;
+	if (contains(synonyms.first()))
+	{
+		QLOG_ERROR() << QString("Failed to register setting %1. ID already exists.")
+				   .arg(synonyms.first());
+		return nullptr; // Fail
+	}
+	auto setting = std::make_shared<Setting>(synonyms, defVal);
+	setting->m_storage = this;
+	connectSignals(*setting);
+	m_settings.insert(setting->id(), setting);
+	return setting;
+}
+
+std::shared_ptr<Setting> SettingsObject::getSetting(const QString &id) const
+{
+	// Make sure there is a setting with the given ID.
+	if (!m_settings.contains(id))
+		return NULL;
+
+	return m_settings[id];
+}
+
+QVariant SettingsObject::get(const QString &id) const
+{
+	auto setting = getSetting(id);
+	return (setting ? setting->get() : QVariant());
+}
+
+bool SettingsObject::set(const QString &id, QVariant value)
+{
+	auto setting = getSetting(id);
+	if (!setting)
+	{
+		QLOG_ERROR() << QString("Error changing setting %1. Setting doesn't exist.").arg(id);
+		return false;
+	}
+	else
+	{
+		setting->set(value);
+		return true;
+	}
+}
+
+void SettingsObject::reset(const QString &id) const
+{
+	auto setting = getSetting(id);
+	if (setting)
+		setting->reset();
+}
+
+bool SettingsObject::contains(const QString &id)
+{
+	return m_settings.contains(id);
+}
+
+bool SettingsObject::reload()
+{
+	for (auto setting : m_settings.values())
+	{
+		setting->set(setting->get());
+	}
+	return true;
+}
+
+void SettingsObject::connectSignals(const Setting &setting)
+{
+	connect(&setting, SIGNAL(SettingChanged(const Setting &, QVariant)),
+			SLOT(changeSetting(const Setting &, QVariant)));
+	connect(&setting, SIGNAL(SettingChanged(const Setting &, QVariant)),
+			SIGNAL(SettingChanged(const Setting &, QVariant)));
+
+	connect(&setting, SIGNAL(settingReset(Setting)), SLOT(resetSetting(const Setting &)));
+	connect(&setting, SIGNAL(settingReset(Setting)), SIGNAL(settingReset(const Setting &)));
+}

logic/settings/SettingsObject.h

@@ -0,0 +1,177 @@
+/* Copyright 2013 MultiMC Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <QObject>
+#include <QMap>
+#include <QStringList>
+#include <QVariant>
+#include <memory>
+
+class Setting;
+
+/*!
+ * \brief The SettingsObject handles communicating settings between the application and a
+ *settings file.
+ * The class keeps a list of Setting objects. Each Setting object represents one
+ * of the application's settings. These Setting objects are registered with
+ * a SettingsObject and can be managed similarly to the way a list works.
+ *
+ * \author Andrew Okin
+ * \date 2/22/2013
+ *
+ * \sa Setting
+ */
+class SettingsObject : public QObject
+{
+	Q_OBJECT
+public:
+	explicit SettingsObject(QObject *parent = 0);
+	virtual ~SettingsObject();
+	/*!
+	 * Registers an override setting for the given original setting in this settings object
+	 *
+	 * This will fail if there is already a setting with the same ID as
+	 * the one that is being registered.
+	 * \return A valid Setting shared pointer if successful.
+	 */
+	std::shared_ptr<Setting> registerOverride(std::shared_ptr<Setting> original);
+
+	/*!
+	 * Registers the given setting with this SettingsObject and connects the necessary  signals.
+	 *
+	 * This will fail if there is already a setting with the same ID as
+	 * the one that is being registered.
+	 * \return A valid Setting shared pointer if successful.
+	 */
+	std::shared_ptr<Setting> registerSetting(QStringList synonyms,
+											 QVariant defVal = QVariant());
+
+	/*!
+	 * Registers the given setting with this SettingsObject and connects the necessary signals.
+	 *
+	 * This will fail if there is already a setting with the same ID as
+	 * the one that is being registered.
+	 * \return A valid Setting shared pointer if successful.
+	 */
+	std::shared_ptr<Setting> registerSetting(QString id, QVariant defVal = QVariant())
+	{
+		return registerSetting(QStringList(id), defVal);
+	}
+
+	/*!
+	 * \brief Gets the setting with the given ID.
+	 * \param id The ID of the setting to get.
+	 * \return A pointer to the setting with the given ID.
+	 * Returns null if there is no setting with the given ID.
+	 * \sa operator []()
+	 */
+	std::shared_ptr<Setting> getSetting(const QString &id) const;
+
+	/*!
+	 * \brief Gets the value of the setting with the given ID.
+	 * \param id The ID of the setting to get.
+	 * \return The setting's value as a QVariant.
+	 * If no setting with the given ID exists, returns an invalid QVariant.
+	 */
+	QVariant get(const QString &id) const;
+
+	/*!
+	 * \brief Sets the value of the setting with the given ID.
+	 * If no setting with the given ID exists, returns false and logs to qDebug
+	 * \param id The ID of the setting to change.
+	 * \param value The new value of the setting.
+	 * \return True if successful, false if it failed.
+	 */
+	bool set(const QString &id, QVariant value);
+
+	/*!
+	 * \brief Reverts the setting with the given ID to default.
+	 * \param id The ID of the setting to reset.
+	 */
+	void reset(const QString &id) const;
+
+	/*!
+	 * \brief Checks if this SettingsObject contains a setting with the given ID.
+	 * \param id The ID to check for.
+	 * \return True if the SettingsObject has a setting with the given ID.
+	 */
+	bool contains(const QString &id);
+
+	/*!
+	 * \brief Reloads the settings and emit signals for changed settings
+	 * \return True if reloading was successful
+	 */
+	virtual bool reload();
+
+signals:
+	/*!
+	 * \brief Signal emitted when one of this SettingsObject object's settings changes.
+	 * This is usually just connected directly to each Setting object's
+	 * SettingChanged() signals.
+	 * \param setting A reference to the Setting object that changed.
+	 * \param value The Setting object's new value.
+	 */
+	void SettingChanged(const Setting &setting, QVariant value);
+
+	/*!
+	 * \brief Signal emitted when one of this SettingsObject object's settings resets.
+	 * This is usually just connected directly to each Setting object's
+	 * settingReset() signals.
+	 * \param setting A reference to the Setting object that changed.
+	 */
+	void settingReset(const Setting &setting);
+
+protected
+slots:
+	/*!
+	 * \brief Changes a setting.
+	 * This slot is usually connected to each Setting object's
+	 * SettingChanged() signal. The signal is emitted, causing this slot
+	 * to update the setting's value in the config file.
+	 * \param setting A reference to the Setting object that changed.
+	 * \param value The setting's new value.
+	 */
+	virtual void changeSetting(const Setting &setting, QVariant value) = 0;
+
+	/*!
+	 * \brief Resets a setting.
+	 * This slot is usually connected to each Setting object's
+	 * settingReset() signal. The signal is emitted, causing this slot
+	 * to update the setting's value in the config file.
+	 * \param setting A reference to the Setting object that changed.
+	 */
+	virtual void resetSetting(const Setting &setting) = 0;
+
+protected:
+	/*!
+	 * \brief Connects the necessary signals to the given Setting.
+	 * \param setting The setting to connect.
+	 */
+	void connectSignals(const Setting &setting);
+
+	/*!
+	 * \brief Function used by Setting objects to get their values from the SettingsObject.
+	 * \param setting The
+	 * \return
+	 */
+	virtual QVariant retrieveValue(const Setting &setting) = 0;
+
+	friend class Setting;
+
+private:
+	QMap<QString, std::shared_ptr<Setting>> m_settings;
+};

logic/tools/JProfiler.cpp

@@ -3,7 +3,7 @@
 #include <QDir>
 #include <QMessageBox>
 
-#include "settingsobject.h"
+#include "logic/settings/SettingsObject.h"
 #include "logic/MinecraftProcess.h"
 #include "logic/BaseInstance.h"
 #include "MultiMC.h"

logic/tools/JVisualVM.cpp

@@ -3,7 +3,7 @@
 #include <QDir>
 #include <QStandardPaths>
 
-#include "settingsobject.h"
+#include "logic/settings/SettingsObject.h"
 #include "logic/MinecraftProcess.h"
 #include "logic/BaseInstance.h"
 #include "MultiMC.h"

logic/tools/MCEditTool.cpp

@@ -5,7 +5,7 @@
 #include <QDesktopServices>
 #include <QUrl>
 
-#include "settingsobject.h"
+#include "logic/settings/SettingsObject.h"
 #include "logic/BaseInstance.h"
 #include "MultiMC.h"
 

logic/updater/UpdateChecker.cpp

@@ -24,7 +24,7 @@
 #include <QJsonArray>
 #include <QJsonValue>
 
-#include <settingsobject.h>
+#include "logic/settings/SettingsObject.h"
 
 #define API_VERSION 0
 #define CHANLIST_FORMAT 0