subsurface/core/settings
Jocke 148bc8fbf1 Mobile: always update the preferences when set_unit_system is called
Unit_system is read from git storage but units are set from locale when the
app starts. To prevent a miss-match between unit and unit_system we have to
always update the preferences variable when set_unit_system is called so that
the user doesn't end up with imperial units when the preferences say metric.

Signed-off-by: Joakim Bygdell <j.bygdell@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2018-09-19 14:41:34 -07:00
..
qPref.cpp core/settings ... : remove qPref* includes in qPref.h 2018-09-11 17:25:00 -07:00
qPref.h core/settings ... : remove qPref* includes in qPref.h 2018-09-11 17:25:00 -07:00
qPrefCloudStorage.cpp core/settings: optimize base_url functions. 2018-09-11 17:25:00 -07:00
qPrefCloudStorage.h core: declare cloud_status in qPrefCloudStorage 2018-09-11 17:25:00 -07:00
qPrefDisplay.cpp core/settings: correct UserSurvey -> userSurvey in qPrefDisplay 2018-09-11 17:25:00 -07:00
qPrefDisplay.h core/settings: correct UserSurvey -> userSurvey in qPrefDisplay 2018-09-11 17:25:00 -07:00
qPrefDiveComputer.cpp core/settings: add missing empty line. 2018-09-11 17:22:58 -07:00
qPrefDiveComputer.h core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
qPrefDivePlanner.cpp core/settings: change bestmixend to int, to allow qml to work 2018-09-11 17:25:00 -07:00
qPrefDivePlanner.h core/settings: change bestmixend to int, to allow qml to work 2018-09-11 17:25:00 -07:00
qPrefFacebook.cpp core/settings: correct wrong emit in qPrefFacebook 2018-09-11 17:25:00 -07:00
qPrefFacebook.h core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
qPrefGeneral.cpp core/settings: change bestmixend to int, to allow qml to work 2018-09-11 17:25:00 -07:00
qPrefGeneral.h core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
qPrefGeocoding.cpp core/settings: add missing empty line. 2018-09-11 17:22:58 -07:00
qPrefGeocoding.h core/settings: add missing empty line. 2018-09-11 17:22:58 -07:00
qPrefLanguage.cpp qPref: use helper function to ensure key/name grouping 2018-09-07 14:37:18 -07:00
qPrefLanguage.h core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
qPrefLocationService.cpp core/settings: add missing empty line. 2018-09-11 17:22:58 -07:00
qPrefLocationService.h core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
qPrefPartialPressureGas.cpp core/settings: add missing empty line. 2018-09-11 17:22:58 -07:00
qPrefPartialPressureGas.h core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
qPrefPrivate.cpp qPref: use helper function to ensure key/name grouping 2018-09-07 14:37:18 -07:00
qPrefPrivate.h core/settings: use instance() in qPref macros 2018-09-11 17:25:00 -07:00
qPrefProxy.cpp core/settings: add missing empty line. 2018-09-11 17:22:58 -07:00
qPrefProxy.h core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
qPrefTechnicalDetails.cpp qPref: use helper function to ensure key/name grouping 2018-09-07 14:37:18 -07:00
qPrefTechnicalDetails.h core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
qPrefUnit.cpp Mobile: always update the preferences when set_unit_system is called 2018-09-19 14:41:34 -07:00
qPrefUnit.h core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
qPrefUpdateManager.cpp core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
qPrefUpdateManager.h core/setting: change *_changed to *Changed for the sake of QML. 2018-09-11 17:22:58 -07:00
README.md core/settings: add README 2018-08-30 05:36:36 -07:00

Short explanation of how qPref works

System startup:

core/qt-init.cpp init_qt_late()

does

qPref::load();

to load all properties from all qPref* classes

System shutdown:

subsurface-mobile-main.cpp and subsurface-desktop-main.cpp main()

calls

call qPref::sync()

to save all changes to disk, this is needed because part of the program modifies struct preferences instead of calling the set method.

EXCEPTION:

Variables not present in struct preferences (local static variables in the class are not written, see later.

System startup/shutdown common handling:

qPref::load() calls qPref::doSync(false)
qPref::sync() calls qPref::doSync(true)

qPrefDoSync()

qPref::doSync() calls qPref::doSync() for all qPref* classes Meaning qPref knows which classes exist, but not which variables

qPref*::doSync() calls

disk_<variable name>() for each variable

EXCEPTION:

some variables are not in struct preferences, but local static variables which can only be accessed through the set/get functions, therefore there are no need to sync them

	if (!doSync) // meaining load
		load_<variable_name>()

qPref*::disk_*()

qPref*::disk_*() calls qPrefPrivate::propSetValue to save a property, and qPrefPrivate::propValue() to read a property. The function also keeps struct preferences in sync.

qPrefPrivate::propSetValue()

qPrefPrivate::propSetValue() is static and calls QSettings to write property

qPrefPrivate::propValue()

qPrefPrivate::propValue() is static and calls QSettings to read property

macros

the macros are defined in qPrefPrivate.h

the macros are used in qPref*cpp

Reading properties

Reading a property is done through an inline function, and thus no more expensive than accessing the variable directly.

qPref*::<variable_name>()

Setting properties

Setting a property is done through a dedicated set function which are static to simplify the call:

qPref<class>::set_<variable_name>(value)

like:

qPrefDisplay::animation_speed(500);

the set function updates struct preferences (if not a local variable), and saves the property to disk, however save is only done if the variable is changed.

Updating struct preferences

When a program part updates struct preferences directly, changes are NOT saved to disk if the programm crashes, otherwise all variables are saved to disk with the program exists.