core: copy Animations from SettingsObjectWrapper to qPref as its own class

Update set/get functions to follow common name scheme:
- get function have same name as in struct preferences
- set function have set_<name in struct preferences>
- signal function have <name in struct preferences>_changed

one class one .h/.cpp is the C++ idiom. Having load/sync of each
variable in 1 functions (in contrast to the distributed way SettingsObjectWrapper
handles it) secures the same storage name is used. Having the set/get/load/sync
functions grouped together makes it easier to get an overview.

REMARK: this commit only defines the class, it is not active in production
Signed-off-by: Jan Iversen <jani@apache.org>

6 files changed, 66 insertions, 3 deletions

diff --git a/core/CMakeLists.txt b/core/CMakeLists.txt
index 67f0623a7..5b476c779 100644
--- a/core/CMakeLists.txt
+++ b/core/CMakeLists.txt
@@ -100,6 +100,7 @@ set(SUBSURFACE_CORE_LIB_SRCS
 
 	# classes to manage struct preferences for QWidget and QML
 	settings/qPref.cpp
+	settings/qPrefAnimations.cpp
 	settings/qPrefDisplay.cpp
 
 	#Subsurface Qt have the Subsurface structs QObjectified for easy access via QML.
diff --git a/core/settings/qPref.h b/core/settings/qPref.h
index 70eef3cb3..758b159d7 100644
--- a/core/settings/qPref.h
+++ b/core/settings/qPref.h
@@ -6,6 +6,7 @@
 #include <QSettings>
 #include "core/pref.h"
 
+#include "qPrefAnimations.h"
 #include "qPrefDisplay.h"
 
 class qPref : public QObject {
@@ -34,8 +35,6 @@ public:
 
 	const QString canonical_version() const;
 	const QString mobile_version() const;
-
-private:
 };
 
 #endif
diff --git a/core/settings/qPrefAnimations.cpp b/core/settings/qPrefAnimations.cpp
new file mode 100644
index 000000000..a6ecc1d5b
--- /dev/null
+++ b/core/settings/qPrefAnimations.cpp
@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: GPL-2.0
+#include "qPref.h"
+#include "qPref_private.h"
+#include "qPrefAnimations.h"
+
+qPrefAnimations::qPrefAnimations(QObject *parent) : QObject(parent)
+{
+}
+qPrefAnimations *qPrefAnimations::instance()
+{
+	static qPrefAnimations *self = new qPrefAnimations;
+	return self;
+}
+
+void qPrefAnimations::loadSync(bool doSync)
+{
+	disk_animation_speed(doSync);
+}
+
+HANDLE_PREFERENCE_INT(Animations, "/animation_speed", animation_speed);
diff --git a/core/settings/qPrefAnimations.h b/core/settings/qPrefAnimations.h
new file mode 100644
index 000000000..fb58b207e
--- /dev/null
+++ b/core/settings/qPrefAnimations.h
@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: GPL-2.0
+#ifndef QPREFANIMATIONS_H
+#define QPREFANIMATIONS_H
+
+#include <QObject>
+#include <QSettings>
+
+class qPrefAnimations : public QObject {
+	Q_OBJECT
+	Q_PROPERTY(int animation_speed READ animation_speed WRITE set_animation_speed NOTIFY animation_speed_changed);
+
+public:
+	qPrefAnimations(QObject *parent = NULL);
+	static qPrefAnimations *instance();
+
+	// Load/Sync local settings (disk) and struct preference
+	void loadSync(bool doSync);
+	void load() { loadSync(false); }
+	void sync() { loadSync(true); }
+
+public:
+	int animation_speed() const;
+
+public slots:
+	void set_animation_speed(int value);
+
+signals:
+	void animation_speed_changed(int value);
+
+private:
+	const QString group = QStringLiteral("Animations");
+	QSettings setting;
+
+	// functions to load/sync variable with disk
+	void disk_animation_speed(bool doSync);
+};
+
+#endif
diff --git a/packaging/ios/Subsurface-mobile.pro b/packaging/ios/Subsurface-mobile.pro
index cea7fdb28..1d0c473df 100644
--- a/packaging/ios/Subsurface-mobile.pro
+++ b/packaging/ios/Subsurface-mobile.pro
@@ -78,6 +78,7 @@ SOURCES += ../../subsurface-mobile-main.cpp \
 	../../core/connectionlistmodel.cpp \
 	../../core/qt-ble.cpp \
 	../../core/settings/qPref.cpp \
+	../../core/settings/qPrefAnimations.cpp \
 	../../core/settings/qPrefDisplay.cpp \
 	../../core/subsurface-qt/CylinderObjectHelper.cpp \
 	../../core/subsurface-qt/DiveObjectHelper.cpp \
@@ -186,6 +187,7 @@ HEADERS += \
 	../../core/connectionlistmodel.h \
 	../../core/qt-ble.h \
 	../../core/settings/qPref.h \
+	../../core/settings/qPrefAnimations.h \
 	../../core/settings/qPrefDisplay.h \
 	../../core/settings/qPref_private.h \
 	../../core/subsurface-qt/CylinderObjectHelper.h \
diff --git a/subsurface-helper.cpp b/subsurface-helper.cpp
index 50f975611..88b8a0587 100644
--- a/subsurface-helper.cpp
+++ b/subsurface-helper.cpp
@@ -144,7 +144,10 @@ void register_qml_types()
 	int rc;
 	rc = qmlRegisterType<qPref>("org.subsurfacedivelog.mobile", 1, 0, "SsrfPrefs");
 	if (rc < 0)
-		qDebug() << "ERROR: Cannot register Prefs (class qPref), QML will not work!!";
+		qDebug() << "ERROR: Cannot register SsrfPrefs (class qPref), QML will not work!!";
+	rc = qmlRegisterType<qPrefAnimations>("org.subsurfacedivelog.mobile", 1, 0, "SsrfAnimationsPrefs");
+	if (rc < 0)
+		qDebug() << "ERROR: Cannot register SsrfAnimationsPrefs (class qPrefAnimations), QML will not work!!";
 	rc = qmlRegisterType<qPrefDisplay>("org.subsurfacedivelog.mobile", 1, 0, "SsrfDisplayPrefs");
 	if (rc < 0)
 		qDebug() << "ERROR: Cannot register DisplayPrefs (class qPrefDisplay), QML will not work!!";