Add class for budnling project settings

Closes #168

Author: svetter

src/db/tables/settings_table.cpp

@@ -137,6 +137,24 @@ void SettingsTable::removeSetting(QWidget* parent, const GenericProjectSetting*
 }
 
 
+/**
+ * Removes the value from the setting in the project settings table.
+ * 
+ * @param parent	The parent window. Cannot be nullptr.
+ * @param setting	The setting to remove.
+ */
+void SettingsTable::clearAllSettings(QWidget* parent, const QString& baseKey)
+{
+	for (BufferRowIndex rowIndex = BufferRowIndex(buffer.numRows()); rowIndex.isValid(); rowIndex--) {
+		QString key = settingKeyColumn->getValueAt(rowIndex).toString();
+		if (key.startsWith(baseKey)) {
+			ValidItemID settingID = VALID_ITEM_ID(primaryKeyColumn->getValueAt(rowIndex));
+			removeMatchingRows(parent, primaryKeyColumn, settingID);
+		}
+	}
+}
+
+
 
 /**
  * Finds the projectSettingID (primary key) of the given setting in the database.

src/db/tables/settings_table.h

@@ -53,6 +53,7 @@ class SettingsTable : public Table {
 	void setSetting(QWidget* parent, const GenericProjectSetting* setting, QVariant value);
 	void clearSetting(QWidget* parent, const GenericProjectSetting* setting);
 	void removeSetting(QWidget* parent, const GenericProjectSetting* setting);
+	void clearAllSettings(QWidget* parent, const QString& baseKey);
 
 private:
 	ItemID findSettingID(const GenericProjectSetting* setting, QWidget* parent = nullptr);

src/settings/project_settings.cpp

@@ -18,7 +18,7 @@
 /**
  * @file project_settings.cpp
  * 
- * This file defines the ProjectSetting class.
+ * This file defines the GenericProjectSetting, ProjectSetting and ProjectMultiSetting classes.
  */
 
 #include "project_settings.h"
@@ -46,7 +46,7 @@ GenericProjectSetting::GenericProjectSetting(SettingsTable* table, const QString
  * @param parent	The parent window. Can be nullptr, in which case no cleanup is performed for duplicate settings.
  * @return			True if the setting is present in the project settings storage, false otherwise.
  */
-bool GenericProjectSetting::isPresent(QWidget* parent)
+bool GenericProjectSetting::isPresent(QWidget* parent) const
 {
 	return table->settingIsPresent(this, parent);
 }
@@ -60,7 +60,7 @@ bool GenericProjectSetting::isPresent(QWidget* parent)
  * @param parent	The parent window. Can be nullptr, in which case no cleanup is performed for duplicate settings.
  * @return			The current value of the setting as a QVariant.
  */
-QVariant GenericProjectSetting::getAsQVariant(QWidget* parent)
+QVariant GenericProjectSetting::getAsQVariant(QWidget* parent) const
 {
 	return table->getSetting(this, parent);
 }
@@ -154,3 +154,134 @@ T ProjectSetting<T>::getDefault() const
 {
 	return defaultValue.value<T>();
 }
+
+
+
+
+
+/**
+ * Creates a new ProjectMultiSetting with the given base key and default value.
+ * 
+ * @param baseKey		The common part of the keys under which the settings will be stored.
+ * @param defaultValue	The default value for all the settings.
+ */
+template<typename T>
+ProjectMultiSetting<T>::ProjectMultiSetting(SettingsTable* table, const QString baseKey, QVariant defaultValue) :
+		settings(QMap<QString, ProjectSetting<T>*>()),
+		table(table),
+		baseKey(baseKey),
+		defaultValue(defaultValue)
+{}
+
+
+/**
+ * Checks whether any of the settings are present in the project settings storage.
+ * 
+ * @return	True if any settings are stored in the settings file under the baseKey, false otherwise.
+ */
+template<typename T>
+bool ProjectMultiSetting<T>::anyPresent() const
+{
+	for (const ProjectSetting<T>* const setting : settings) {
+		if (setting->isPresent()) return true;
+	}
+	return false;
+}
+
+/**
+ * Checks whether none of the settings are present in the project settings storage.
+ * 
+ * @return	True if no settings are stored in the settings file under the baseKey, false otherwise.
+ */
+template<typename T>
+bool ProjectMultiSetting<T>::nonePresent() const
+{
+	return !anyPresent();
+}
+
+/**
+ * Checks whether al of the the setting are present in the project settings storage.
+ * 
+ * @param subKeys	The sub-keys of all settings to check.
+ * @return			True if all settings given by their sub-keys are stored in the settings file under the baseKey, false otherwise.
+ */
+template<typename T>
+bool ProjectMultiSetting<T>::allPresent(QSet<QString> subKeys)
+{
+	for (const QString& subKey : subKeys) {
+		createSettingIfMissing(subKey);
+		if (!settings[subKey]->isPresent()) return false;
+	}
+	return true;
+}
+
+/**
+ * Returns the values of the settings after validating them, paired with their sub-keys.
+ * 
+ * If the setting is not present in the settings file or invalid, it is discarded and the
+ * default value is returned and written back to the settings file.
+ * 
+ * @return	The value of the settings as they are stored in the settings file after validation.
+ */
+template<typename T>
+QMap<QString, T> ProjectMultiSetting<T>::get(const QSet<QString>& subKeys)
+{
+	QMap<QString, T> values = QMap<QString, T>();
+	for (const QString& subKey : subKeys) {
+		createSettingIfMissing(subKey);
+		values[subKey] = settings.value(subKey)->get();
+	}
+	return values;
+}
+
+/**
+ * Returns the default value of the settings.
+ * 
+ * @return	The default value of the settings.
+ */
+template<typename T>
+T ProjectMultiSetting<T>::getDefault() const
+{
+	return defaultValue.value<T>();
+}
+
+
+/**
+ * Sets the value of the setting.
+ * 
+ * @param values	The new values for the settings.
+ */
+template<typename T>
+void ProjectMultiSetting<T>::set(QWidget* parent, const QMap<QString, T>& subKeyValueMap)
+{
+	for (auto iter = subKeyValueMap.cbegin(); iter != subKeyValueMap.cend(); iter++) {
+		const QString& subKey	= iter.key();
+		const T& value			= iter.value();
+		
+		createSettingIfMissing(subKey);
+		settings[subKey]->set(parent, value);
+	}
+}
+
+/**
+ * Removes all of the settings from the project settings storage.
+ */
+template<typename T>
+void ProjectMultiSetting<T>::clear(QWidget* parent, SettingsTable* settingsTable) const
+{
+	settingsTable->clearAllSettings(parent, baseKey);
+}
+
+
+/**
+ * Creates a new Setting for the given sub-key and adds it to the setttings map.
+ * 
+ * @param subKey	The sub-key for the missing setting
+ */
+template<typename T>
+void ProjectMultiSetting<T>::createSettingIfMissing(const QString& subKey)
+{
+	if (!settings.contains(subKey)) {
+		settings.insert(subKey, new ProjectSetting<T>(table, baseKey + "/" + subKey, defaultValue));
+	}
+}

src/settings/project_settings.h

@@ -18,8 +18,8 @@
 /**
  * @file project_settings.h
  * 
- * This file declares the GenericProjectSetting and ProjectSetting classes and defines the
- * ProjectSettings class.
+ * This file declares the GenericProjectSetting, ProjectSetting and ProjectMultiSetting classes
+ * and defines the ProjectSettings class.
  */
 
 #ifndef PROJECT_SETTINGS_H
@@ -31,8 +31,6 @@
 #include <QVariant>
 #include <QDate>
 
-class ProjectSettings;
-
 
 
 /**
@@ -51,8 +49,8 @@ class GenericProjectSetting {
 
 	GenericProjectSetting(SettingsTable* table, const QString& key, QVariant defaultValue);
 
-	bool isPresent(QWidget* parent = nullptr);
-	QVariant getAsQVariant(QWidget* parent = nullptr);
+	bool isPresent(QWidget* parent = nullptr) const;
+	QVariant getAsQVariant(QWidget* parent = nullptr) const;
 	QVariant getDefaultAsQVariant() const;
 
 	void set(QWidget* parent, QVariant value);
@@ -82,6 +80,38 @@ template class ProjectSetting<QDate>;
 
 
 
+template<typename T>
+class ProjectMultiSetting
+{
+	/** Dynamically grown list of all settings in this group, mapped to their sub-keys. */
+	QMap<QString, ProjectSetting<T>*> settings;
+	
+	/** The project settings table. */
+	SettingsTable* const table;
+	/** The part of the key which all settings share. */
+	const QString baseKey;
+	/** The default value of all the settings. */
+	const QVariant defaultValue;
+	
+public:
+	ProjectMultiSetting(SettingsTable* table, const QString baseKey, QVariant defaultValue = T());
+	
+	bool anyPresent() const;
+	bool nonePresent() const;
+	bool allPresent(QSet<QString> subKeys);
+	
+	QMap<QString, T> get(const QSet<QString>& subKeys);
+	T getDefault() const;
+	
+	void set(QWidget* parent, const QMap<QString, T>& subKeyValueMap);
+	void clear(QWidget* parent, SettingsTable* settingsTable) const;
+	
+private:
+	void createSettingIfMissing(const QString& subKey);
+};
+
+
+
 /**
  * A class for managing all project settings.
  */

src/settings/settings.h

@@ -151,7 +151,7 @@ class MultiSetting
 
 public:
 	/**
-	 * Creates a new setting with the given key and default value.
+	 * Creates a new MultiSetting with the given base key and default value.
 	 *
 	 * @param baseKey		The common part of the keys under which the settings will be stored.
 	 * @param defaultValue	The default value for all the settings.
@@ -260,6 +260,11 @@ class MultiSetting
 
 
 private:
+	/**
+	 * Creates a new Setting for the given sub-key and adds it to the setttings map.
+	 * 
+	 * @param subKey	The sub-key for the missing setting
+	 */
 	inline void createSettingIfMissing(const QString& subKey)
 	{
 		if (!settings.contains(subKey)) {