From 602360cdeb7b27f54bf298d8d2aff15950120ad6 Mon Sep 17 00:00:00 2001
From: James Turner <zakalawe@mac.com>
Date: Sat, 14 Nov 2020 14:31:18 +0000
Subject: [PATCH] Add graphics-presets logic (as a subsystem)

Gives the ability to define graphics settings via an XML file at
startup or later during runtime. Tracks if changes to graphics settings
required additional actions (eg, scenery reload or restart of the sim)

When a preset is active, and properties are modified, the system will
detect this and mark the preset as edited.
---
 src/Main/fg_init.cxx           |  21 +-
 src/Main/main.cxx              |  15 +-
 src/Main/options.cxx           |   1 +
 src/Scenery/scenery.cxx        |   1 +
 src/Viewer/CMakeLists.txt      |   4 +-
 src/Viewer/GraphicsPresets.cxx | 496 +++++++++++++++++++++++++++++++++
 src/Viewer/GraphicsPresets.hxx |  89 ++++++
 7 files changed, 611 insertions(+), 16 deletions(-)
 create mode 100644 src/Viewer/GraphicsPresets.cxx
 create mode 100644 src/Viewer/GraphicsPresets.hxx

diff --git a/src/Main/fg_init.cxx b/src/Main/fg_init.cxx
index 58fd61142..89dcc6cc8 100644
--- a/src/Main/fg_init.cxx
+++ b/src/Main/fg_init.cxx
@@ -124,21 +124,22 @@
 #if defined(ENABLE_SWIFT)
 #include <Network/Swift/swift_connection.hxx>
 #endif
-#include <FDM/fdm_shell.hxx>
-#include <Environment/ephemeris.hxx>
-#include <Environment/environment_mgr.hxx>
-#include <Viewer/renderer.hxx>
-#include <Viewer/viewmgr.hxx>
-#include <Viewer/FGEventHandler.hxx>
-#include <Navaids/NavDataCache.hxx>
-#include <Instrumentation/HUD/HUD.hxx>
 #include <Cockpit/cockpitDisplayManager.hxx>
-#include <Network/HTTPClient.hxx>
+#include <Environment/environment_mgr.hxx>
+#include <Environment/ephemeris.hxx>
+#include <FDM/fdm_shell.hxx>
+#include <Instrumentation/HUD/HUD.hxx>
+#include <Navaids/NavDataCache.hxx>
 #include <Network/DNSClient.hxx>
+#include <Network/HTTPClient.hxx>
 #include <Network/fgcom.hxx>
 #include <Network/http/httpd.hxx>
-#include <Viewer/splash.hxx>
 #include <Viewer/CameraGroup.hxx>
+#include <Viewer/FGEventHandler.hxx>
+#include <Viewer/GraphicsPresets.hxx>
+#include <Viewer/renderer.hxx>
+#include <Viewer/splash.hxx>
+#include <Viewer/viewmgr.hxx>
 
 #include "fg_init.hxx"
 #include "fg_io.hxx"
diff --git a/src/Main/main.cxx b/src/Main/main.cxx
index f1e85ba64..b30568dda 100755
--- a/src/Main/main.cxx
+++ b/src/Main/main.cxx
@@ -50,17 +50,18 @@
 #include <simgear/emesary/notifications.hxx>
 
 #include <Add-ons/AddonManager.hxx>
+#include <GUI/MessageBox.hxx>
+#include <GUI/gui.h>
 #include <Main/locale.hxx>
 #include <Model/panelnode.hxx>
+#include <Navaids/NavDataCache.hxx>
 #include <Scenery/scenery.hxx>
 #include <Sound/soundmanager.hxx>
 #include <Time/TimeManager.hxx>
-#include <GUI/gui.h>
-#include <GUI/MessageBox.hxx>
-#include <Viewer/splash.hxx>
-#include <Viewer/renderer.hxx>
+#include <Viewer/GraphicsPresets.hxx>
 #include <Viewer/WindowSystemAdapter.hxx>
-#include <Navaids/NavDataCache.hxx>
+#include <Viewer/renderer.hxx>
+#include <Viewer/splash.hxx>
 #include <flightgearBuildId.h>
 
 #include "fg_commands.hxx"
@@ -727,7 +728,11 @@ int fgMainInit( int argc, char **argv )
     // Copy the property nodes for the menus added by registered add-ons
     addons::AddonManager::instance()->addAddonMenusToFGMenubar();
 
+    auto presets = globals->add_new_subsystem<flightgear::GraphicsPresets>(SGSubsystemMgr::DISPLAY);
+    presets->applyInitialPreset();
+
     // Initialize the Window/Graphics environment.
+
     fgOSInit(&argc, argv);
     _bootstrap_OSInit++;
 
diff --git a/src/Main/options.cxx b/src/Main/options.cxx
index bff9bc434..1ebcde51e 100644
--- a/src/Main/options.cxx
+++ b/src/Main/options.cxx
@@ -1871,6 +1871,7 @@ struct OptionDesc {
     {"developer",                    true,  OPTION_IGNORE | OPTION_BOOL, "", false, "", nullptr },
     {"jsbsim-output-directive-file", true,  OPTION_STRING, "/sim/jsbsim/output-directive-file", false, "", nullptr },
     {"disable-gui",                  false, OPTION_FUNC, "", false, "", fgOptDisableGUI },
+    {"graphics-preset", true, OPTION_STRING, "/sim/rendering/preset", false, "", nullptr},
     {"composite-viewer",             true,  OPTION_INT,    "/sim/rendering/composite-viewer-enabled", "", "", nullptr},
     {nullptr,                        false, 0,             nullptr, false, nullptr, nullptr}
 };
diff --git a/src/Scenery/scenery.cxx b/src/Scenery/scenery.cxx
index 83aff9c80..615e6756d 100644
--- a/src/Scenery/scenery.cxx
+++ b/src/Scenery/scenery.cxx
@@ -427,6 +427,7 @@ void FGScenery::init() {
 void FGScenery::reinit()
 {
     flightgear::addSentryBreadcrumb("reloading scenery", "info");
+    fgSetBool("/sim/rendering/scenery-reload-required", false);
     _terrain->reinit();
 }
 
diff --git a/src/Viewer/CMakeLists.txt b/src/Viewer/CMakeLists.txt
index eca4f7ef6..e870e6f1d 100644
--- a/src/Viewer/CMakeLists.txt
+++ b/src/Viewer/CMakeLists.txt
@@ -7,12 +7,13 @@ set(SOURCES
 	WindowSystemAdapter.cxx
 	fg_os_osgviewer.cxx
 	fgviewer.cxx
-        ViewPropertyEvaluator.cxx
+    ViewPropertyEvaluator.cxx
 	renderer.cxx
 	splash.cxx
 	view.cxx
 	viewmgr.cxx
 	sview.cxx
+	GraphicsPresets.cxx
 	)
 
 set(HEADERS
@@ -26,6 +27,7 @@ set(HEADERS
 	view.hxx
 	viewmgr.hxx
 	sview.hxx
+	GraphicsPresets.hxx
 	)
 
 if (Qt5Core_FOUND)
diff --git a/src/Viewer/GraphicsPresets.cxx b/src/Viewer/GraphicsPresets.cxx
new file mode 100644
index 000000000..3942b8a1b
--- /dev/null
+++ b/src/Viewer/GraphicsPresets.cxx
@@ -0,0 +1,496 @@
+#include "config.h"
+
+#include <Viewer/GraphicsPresets.hxx>
+
+// std
+#include <unordered_set>
+
+// SG
+#include <simgear/misc/sg_dir.hxx>
+#include <simgear/props/props_io.hxx>
+#include <simgear/structure/commands.hxx>
+#include <simgear/structure/exception.hxx>
+
+// FG
+#include <Main/fg_props.hxx>
+#include <Main/globals.hxx>
+#include <Main/locale.hxx>
+#include <Main/sentryIntegration.hxx>
+#include <Scenery/scenery.hxx>
+
+using namespace std;
+
+namespace {
+
+const char* kPresetPropPath = "/sim/rendering/preset";
+const char* kPresetNameProp = "/sim/rendering/preset-name";
+const char* kPresetDescriptionProp = "/sim/rendering/preset-description";
+const char* kPresetActiveProp = "/sim/rendering/preset-active";
+
+
+const char* kRestartRequiredProp = "/sim/rendering/restart-required";
+const char* kSceneryReloadRequiredProp = "/sim/rendering/scenery-reload-required";
+
+// define the property prefixes which graphics presets are allowed to
+// modify. Changes to properties outside these prefixes will be
+// blocked
+
+const string_list kWitelistedPrefixes = {
+    "/sim/rendering"};
+
+
+} // namespace
+
+namespace flightgear {
+
+class GraphicsPresets::GraphicsConfigChangeListener : public SGPropertyChangeListener
+{
+public:
+    GraphicsConfigChangeListener()
+    {
+        _presetProp = fgGetNode(kPresetPropPath, true);
+    }
+
+    void registerWithProperty(SGPropertyNode_ptr n)
+    {
+        auto it = std::find(_watchedProps.begin(), _watchedProps.end(), n);
+        if (it != _watchedProps.end()) {
+            // this would happen if a preset somehow set the same property more than once
+            SG_LOG(SG_GUI, SG_ALERT, "GraphicsPresets: Duplicate registration for:" << n->getPath());
+            return;
+        }
+
+        _watchedProps.push_back(n);
+        n->addChangeListener(this);
+    }
+
+    void unregisterFromProperties()
+    {
+        for (const auto& w : _watchedProps) {
+            w->removeChangeListener(this);
+        }
+        _watchedProps.clear();
+    }
+
+    void valueChanged(SGPropertyNode* prop) override
+    {
+        SG_LOG(SG_GUI, SG_INFO, "GraphicsPreset clearing; setting:" << prop->getPath() << " was modified");
+        if (_presetProp->hasValue()) {
+            flightgear::addSentryBreadcrumb("clearing graphics preset, config was customised at:" + prop->getPath(), "info");
+            _presetProp->clearValue();
+
+            auto gp = globals->get_subsystem<GraphicsPresets>();
+            gp->clearPreset();
+        }
+    }
+
+private:
+    SGPropertyNode_ptr _presetProp;
+
+    using PropertyNodeList = std::vector<SGPropertyNode_ptr>;
+    PropertyNodeList _watchedProps;
+};
+
+/**
+    @brief monitor a collection of properties, and set a flag property to true when any of them are
+    modified. Used to track the list of 'reload-required' and 'restart-requried' properties defined in
+    FG_DATA/Video/graphics-properties.xml
+ */
+class GraphicsPresets::RequiredPropertyListener : public SGPropertyChangeListener
+{
+public:
+    RequiredPropertyListener(const std::string& requiredProp, SGPropertyNode_ptr props)
+    {
+        _requiredProp = fgGetNode(requiredProp, true);
+        _requiredProp->setBoolValue(false);
+
+        // would happen if graphics-properties.xml was malformed
+        if (!props)
+            return;
+
+        for (const auto& c : props->getChildren("property")) {
+            // tolerate exterior whitespace in the XML
+            string path = simgear::strutils::strip(c->getStringValue());
+            if (path.empty())
+                continue;
+
+            SGPropertyNode_ptr n = fgGetNode(path, true);
+            if (n) {
+                n->addChangeListener(this);
+            }
+        } // of properties iteration
+    }
+
+    void clearRequiredFlag()
+    {
+        if (_requiredProp->getBoolValue()) {
+            _requiredProp->setBoolValue(false);
+        }
+    }
+
+    void valueChanged(SGPropertyNode* prop) override
+    {
+        if (!_requiredProp->getBoolValue()) {
+            SG_LOG(SG_GUI, SG_INFO, "GraphicsPreset: saw modification of:" << prop->getPath() << ", setting:" << _requiredProp->getPath() << " to true");
+            _requiredProp->setBoolValue(true);
+        }
+    }
+
+private:
+    SGPropertyNode_ptr _requiredProp;
+};
+
+static bool do_apply_preset(const SGPropertyNode* arg, SGPropertyNode* root)
+{
+    auto gp = globals->get_subsystem<GraphicsPresets>();
+
+    bool result = false;
+    if (arg->hasChild("path")) {
+        SGPath p = SGPath::fromUtf8(arg->getStringValue("path"));
+        if (!p.exists()) {
+            SG_LOG(SG_IO, SG_ALERT, "apply-graphics-preset: no file at:" << p);
+            return false;
+        }
+
+        result = gp->applyCustomPreset(p);
+    } else if (arg->hasChild("preset-name")) {
+        // helper for PUI UI: PUI ComboBox gives us the name, not the ID.
+        // so allow specify a preset by (localized) name.
+        gp->applyPresetByName(arg->getStringValue("preset-name"));
+    } else if (arg->hasChild("preset")) {
+        fgSetString(kPresetPropPath, arg->getStringValue("preset"));
+        result = gp->applyCurrentPreset();
+    } else {
+        // just apply the current selected one
+        result = gp->applyCurrentPreset();
+    }
+
+    if (arg->getBoolValue("reload-scenery")) {
+        if (fgGetBool(kSceneryReloadRequiredProp)) {
+            SG_LOG(SG_GUI, SG_MANDATORY_INFO, "apply-graphics-preset: triggering scenery reload");
+            globals->get_scenery()->reinit(); // this will set
+        }
+    }
+
+    return result;
+}
+
+static bool do_save_preset(const SGPropertyNode* arg, SGPropertyNode* root)
+{
+    // TODO implement me
+    if (!arg->hasChild("path")) {
+        SG_LOG(SG_GUI, SG_ALERT, "do_save_preset: no out path argument provided");
+        return false;
+    }
+
+    const SGPath path = SGPath::fromUtf8(arg->getStringValue("path"));
+    const string name = arg->getStringValue("name");
+    auto gp = globals->get_subsystem<GraphicsPresets>();
+
+    return gp->saveToXML(path, name);
+}
+
+static bool do_list_standard_presets(const SGPropertyNode* arg, SGPropertyNode* root)
+{
+    auto gp = globals->get_subsystem<GraphicsPresets>();
+    if (!arg->hasValue("destination-path")) {
+        SG_LOG(SG_GUI, SG_ALERT, "list-graphics-preset: no destination path supplied");
+        return false;
+    }
+
+    SGPropertyNode_ptr destRoot = fgGetNode(arg->getStringValue("destination-path"), true /* create */);
+
+    if (arg->hasValue("clear-destination")) {
+        destRoot->removeAllChildren();
+    }
+
+    // format the way PUI combo-box (actualy, fgValueList) like it
+    if (arg->getBoolValue("as-combobox-values")) {
+        for (const auto& preset : gp->listPresets()) {
+            SGPropertyNode_ptr v = destRoot->addChild("value");
+            v->setStringValue(preset.name);
+        }
+    } else {
+        for (const auto& preset : gp->listPresets()) {
+            SGPropertyNode_ptr pn = destRoot->addChild("preset");
+            pn->setStringValue("name", preset.name);
+            pn->setStringValue("id", preset.id);
+            pn->setStringValue("description", preset.description);
+        }
+    }
+
+    return true;
+}
+
+
+GraphicsPresets::GraphicsPresets()
+{
+    // needs to be done early so that applyInitialPreset
+    // can setup the registration
+    _listener.reset(new GraphicsConfigChangeListener);
+}
+
+GraphicsPresets::~GraphicsPresets()
+{
+}
+
+void GraphicsPresets::applyInitialPreset()
+{
+    const string currentPreset = fgGetString(kPresetPropPath);
+    fgSetBool(kPresetActiveProp, false);
+    if (!currentPreset.empty()) {
+        SG_LOG(SG_GUI, SG_INFO, "Applying graphics preset:" << currentPreset);
+        addSentryBreadcrumb("Startup selection of preset:" + currentPreset, "info");
+        applyCurrentPreset();
+    }
+}
+
+void GraphicsPresets::init()
+{
+    // create the change listeners. Because we do the initial application before this, we won't
+    // see any changes caused by any initial preset load (or autosave.xml load), only
+    // future changes made by the user via settings UI.
+    SGPropertyNode_ptr graphicsPropsXML(new SGPropertyNode);
+    try {
+        readProperties(globals->findDataPath("Video/graphics-properties.xml"), graphicsPropsXML.get());
+
+        _restartListener.reset(new RequiredPropertyListener{kRestartRequiredProp, graphicsPropsXML->getChild("restart-required")});
+        _sceneryReloadListener.reset(new RequiredPropertyListener{kSceneryReloadRequiredProp, graphicsPropsXML->getChild("scenery-reload-required")});
+
+        SGPropertyNode_ptr toSave = graphicsPropsXML->getChild("save-to-file");
+        if (toSave) {
+            for (const auto& p : toSave->getChildren("property")) {
+                string t = simgear::strutils::strip(p->getStringValue());
+                _propertiesToSave.push_back(t);
+            }
+        }
+    } catch (sg_exception& e) {
+        SG_LOG(SG_GUI, SG_ALERT, "Failed to read graphics-properties.xml");
+    }
+
+    globals->get_commands()->addCommand("apply-graphics-preset", do_apply_preset);
+    globals->get_commands()->addCommand("save-graphics-preset", do_save_preset);
+    globals->get_commands()->addCommand("list-graphics-presets", do_list_standard_presets);
+}
+
+void GraphicsPresets::update(double delta_time_sec)
+{
+    SG_UNUSED(delta_time_sec);
+}
+
+void GraphicsPresets::shutdown()
+{
+    globals->get_commands()->removeCommand("apply-graphics-preset");
+    globals->get_commands()->removeCommand("save-graphics-preset");
+    globals->get_commands()->removeCommand("list-graphics-presets");
+
+    _listener->unregisterFromProperties();
+    _listener.reset();
+}
+
+bool GraphicsPresets::applyCurrentPreset()
+{
+    _listener->unregisterFromProperties();
+
+    const string presetId = fgGetString(kPresetPropPath);
+    GraphicsPresetInfo info;
+    const auto ok = loadStandardPreset(presetId, info);
+    if (!ok) {
+        return false;
+    }
+
+    addSentryBreadcrumb("loading graphics preset:" + presetId, "info");
+
+    return innerApplyPreset(info, true);
+}
+
+bool GraphicsPresets::loadStandardPreset(const std::string& id, GraphicsPresetInfo& info)
+{
+    const auto path = globals->findDataPath("Video/" + id + "-preset.xml");
+    if (!path.exists()) {
+        SG_LOG(SG_GUI, SG_ALERT, "No such graphics preset '" << id << "' found");
+        return false;
+    }
+
+    return loadPresetXML(path, info);
+}
+
+
+auto GraphicsPresets::listPresets() -> GraphicsPresetVec
+{
+    GraphicsPresetVec result;
+
+    auto videoPaths = globals->get_data_paths("Video");
+    for (const auto& vp : videoPaths) {
+        simgear::Dir videoDir(vp);
+        for (const auto& presetFile : videoDir.children(simgear::Dir::TYPE_FILE, "-preset.xml")) {
+            GraphicsPresetInfo info;
+            loadPresetXML(presetFile, info);
+            result.push_back(info);
+        }
+    } // of Video/ data dirs iteration
+
+    return result;
+}
+
+bool GraphicsPresets::applyCustomPreset(const SGPath& path)
+{
+    GraphicsPresetInfo info;
+    const auto ok = loadPresetXML(path, info);
+    if (!ok) {
+        return false;
+    }
+
+    addSentryBreadcrumb("loading graphics preset from:" + path.utf8Str(), "info");
+    return innerApplyPreset(info, true);
+}
+
+bool GraphicsPresets::applyPresetByName(const std::string& name)
+{
+    const auto presets = listPresets();
+    auto it = std::find_if(presets.begin(), presets.end(), [name](const GraphicsPresetInfo& pi) { return simgear::strutils::iequals(name, pi.name); });
+    if (it == presets.end()) {
+        SG_LOG(SG_GUI, SG_ALERT, "Couldn't find graphics preset with name:" << name);
+        return false;
+    }
+
+    fgSetString(kPresetPropPath, it->id);
+    return applyCurrentPreset();
+}
+
+bool GraphicsPresets::innerApplyPreset(const GraphicsPresetInfo& info, bool overwriteAutosaved)
+{
+    fgSetString(kPresetNameProp, info.name);
+    fgSetString(kPresetDescriptionProp, info.description);
+
+    if (info.id == "custom") {
+        fgSetBool(kPresetActiveProp, false);
+    }
+
+    std::unordered_set<string> leafProps;
+
+    copyPropertiesIf(info.properties, globals->get_props(), [overwriteAutosaved, &leafProps](const SGPropertyNode* src) {
+        if (src->getParent() == nullptr)
+            return true; // root node passes
+
+        // due to the slightly odd way SGPropertyNode::getPath works, we
+        // don't need to omit settings here; it will be dropped
+        // automatically.
+        const auto path = src->getPath(true);
+
+        auto it = std::find_if(kWitelistedPrefixes.begin(), kWitelistedPrefixes.end(), [&path](const string& p) {
+            // if we're high up in the tree, eg looking at /sim, then we
+            // want to check if at least one prefix includes that path
+            if (path.length() < p.length()) {
+                return simgear::strutils::starts_with(p, path);
+            }
+
+            // if the prefix is longer (more specific) than our path, we
+            // want to consider the full prefix
+            return simgear::strutils::starts_with(path, p);
+        });
+
+        if (it == kWitelistedPrefixes.end()) {
+            return false; // skip entirely
+        }
+
+        // find the corresponding destination node
+        auto dstNode = globals->get_props()->getNode(path);
+
+        // if destination exists, and we're not over-writing, check its
+        // ARCHIVE flag.
+        if (!overwriteAutosaved && dstNode && (dstNode->getAttribute(SGPropertyNode::ARCHIVE) == false)) {
+            return false;
+        }
+
+        // only watch the leaf properties
+        const bool isLeaf = src->nChildren() == 0;
+        if (isLeaf) {
+            leafProps.insert(path);
+        }
+        return true; // easy, just copy it
+    });
+
+    _listener->unregisterFromProperties();
+    for (const auto& p : leafProps) {
+        _listener->registerWithProperty(fgGetNode(p));
+    }
+
+    fgSetBool(kPresetActiveProp, true);
+    return true;
+}
+
+void GraphicsPresets::clearPreset()
+{
+    fgSetString(kPresetNameProp, "");
+    fgSetString(kPresetDescriptionProp, "");
+    fgSetBool(kPresetActiveProp, false);
+    _listener->unregisterFromProperties();
+}
+
+bool GraphicsPresets::loadPresetXML(const SGPath& p, GraphicsPresetInfo& info)
+{
+    SGPropertyNode_ptr props(new SGPropertyNode);
+
+    try {
+        readProperties(p, props.get());
+    } catch (sg_exception& e) {
+        SG_LOG(SG_IO, SG_ALERT, "XML errors loading " << p.str() << "\n\t" << e.getFormattedMessage());
+        return false;
+    }
+
+    const string id = props->getStringValue("id");
+    const string rawName = props->getStringValue("name");
+    const string rawDesc = props->getStringValue("description");
+
+    if (id.empty() || rawName.empty() || rawDesc.empty()) {
+        SG_LOG(SG_IO, SG_ALERT, "Missing preset info loading: " << p.str());
+        return false;
+    }
+
+    info.id = id;
+    info.name = globals->get_locale()->getLocalizedString(rawName, "graphics-presets");
+    info.description = globals->get_locale()->getLocalizedString(rawDesc, "graphics-presets");
+
+    if (info.name.empty())
+        info.name = rawName; // no translation defined
+    if (info.description.empty())
+        info.description = rawDesc;
+
+    info.properties = props->getChild("settings");
+    if (!info.properties) {
+        SG_LOG(SG_IO, SG_ALERT, "Missing settings loading: " << p.str());
+        return false;
+    }
+
+    // read devices list
+    info.devices.clear();
+    SGPropertyNode_ptr devices = props->getChild("devices");
+    if (devices) {
+        for (auto d : devices->getChildren("device")) {
+            const auto t = simgear::strutils::strip(d->getStringValue());
+            info.devices.push_back(t);
+        }
+    }
+
+    return true;
+}
+
+bool GraphicsPresets::saveToXML(const SGPath& path, const std::string& name)
+{
+    SGPropertyNode_ptr presetXML(new SGPropertyNode);
+    presetXML->setStringValue("id", path.file_base()); // without .xml
+    presetXML->setStringValue("name", name);
+    // no description
+
+    auto settingsNode = presetXML->getChild("settings", true);
+
+    copyPropertiesIf(globals->get_props(), settingsNode, [this](const SGPropertyNode* nd) {
+        // TODO
+        return true;
+    });
+
+    return true;
+}
+
+} // namespace flightgear
diff --git a/src/Viewer/GraphicsPresets.hxx b/src/Viewer/GraphicsPresets.hxx
new file mode 100644
index 000000000..bc2d3037a
--- /dev/null
+++ b/src/Viewer/GraphicsPresets.hxx
@@ -0,0 +1,89 @@
+#pragma once
+
+#include <string>
+#include <vector>
+
+#include <simgear/misc/strutils.hxx>
+#include <simgear/props/propsfwd.hxx>
+#include <simgear/structure/subsystem_mgr.hxx>
+
+// forward decls
+class SGPath;
+
+namespace flightgear {
+
+class GraphicsPresets : public SGSubsystem
+{
+public:
+    GraphicsPresets();
+    ~GraphicsPresets();
+
+    static const char* staticSubsystemClassId() { return "graphics-presets"; }
+
+    struct GraphicsPresetInfo {
+        std::string id;
+        std::string name;        // localized
+        std::string description; // localized
+        string_list devices;
+
+        SGPropertyNode_ptr properties;
+    };
+
+    using GraphicsPresetVec = std::vector<GraphicsPresetInfo>;
+
+    // implement SGSubsystem intergace
+    void init() override;
+    void shutdown() override;
+
+    void update(double delta_time_sec) override;
+
+    /**
+        @brief init() is called too late (after fgOSInit), so we call this method early,
+                to load the initial preset if set, at that time.
+     */
+    void applyInitialPreset();
+
+    /**
+     * @brief Apple the settings defined in the current graphics preset,
+     * to the property tree
+     *
+     */
+    bool applyCurrentPreset();
+
+    bool applyCustomPreset(const SGPath& path);
+
+    /**
+        @brief apply a preset identified by its (localized) name. This is helpful
+        for the rnedering dialog since PUI combo-boxes only record the name of
+        items and no other data.
+     */
+    bool applyPresetByName(const std::string& name);
+
+    /**
+        @brief retrieve all standard presets which are defined
+     */
+    GraphicsPresetVec listPresets();
+
+    bool saveToXML(const SGPath& path, const std::string& name);
+
+private:
+    void clearPreset();
+
+    bool loadStandardPreset(const std::string& id, GraphicsPresetInfo& info);
+
+    bool innerApplyPreset(const GraphicsPresetInfo& info, bool overwriteAutosaved);
+
+    bool loadPresetXML(const SGPath& p, GraphicsPresetInfo& info);
+
+
+    class RequiredPropertyListener;
+    class GraphicsConfigChangeListener;
+
+    std::unique_ptr<GraphicsConfigChangeListener> _listener;
+    std::unique_ptr<RequiredPropertyListener> _restartListener;
+    std::unique_ptr<RequiredPropertyListener> _sceneryReloadListener;
+
+    string_list _propertiesToSave;
+};
+
+} // namespace flightgear