From 338c8a9bd51a23cd128223e7a8f6ed1621aceeb3 Mon Sep 17 00:00:00 2001
From: Alexander Bock <mail@alexanderbock.eu>
Date: Sun, 21 Jun 2020 14:26:15 +0200
Subject: [PATCH] Adding the ability to add additional scripts to a profile
 when necessary

---
 include/openspace/scene/profile.h             |  1 +
 src/scene/profile.cpp                         | 27 ++++++++++++++++++-
 .../profile/basic_additional_scripts.profile  |  7 +++++
 tests/profile/integration_full_test.profile   |  5 ++++
 ...ntegration_full_test_permutation_1.profile |  5 ++++
 ...gration_full_test_permutation_base.profile |  5 ++++
 tests/test_profile.cpp                        | 11 ++++++++
 7 files changed, 60 insertions(+), 1 deletion(-)
 create mode 100644 tests/profile/basic_additional_scripts.profile

diff --git a/include/openspace/scene/profile.h b/include/openspace/scene/profile.h
index 299ef2c9cf..dbd6a0d802 100644
--- a/include/openspace/scene/profile.h
+++ b/include/openspace/scene/profile.h
@@ -149,6 +149,7 @@ private:
     std::optional<Time> time;
     std::optional<CameraType> camera;
     std::vector<std::string> markNodes;
+    std::vector<std::string> additionalScripts;
 
     bool _ignoreUpdates = false;
 };
diff --git a/src/scene/profile.cpp b/src/scene/profile.cpp
index 5de4d7bccd..0d9638c293 100644
--- a/src/scene/profile.cpp
+++ b/src/scene/profile.cpp
@@ -46,6 +46,7 @@ namespace {
     constexpr const char* headerTime = "#Time";
     constexpr const char* headerCamera = "#Camera";
     constexpr const char* headerMarkNodes = "#MarkNodes";
+    constexpr const char* headerAdditionalScripts = "#AdditionalScripts";
 
     // Helper structs for the visitor pattern of the std::variant
     template <class... Ts> struct overloaded : Ts... { using Ts::operator()...; };
@@ -89,7 +90,8 @@ namespace {
         Keybinding,
         Time,
         Camera,
-        MarkNodes
+        MarkNodes,
+        AdditionalScripts
     };
 
     //struct ParsingContext {
@@ -106,6 +108,7 @@ namespace {
         if (line == headerTime) { return Section::Time; }
         if (line == headerCamera) { return Section::Camera; }
         if (line == headerMarkNodes) { return Section::MarkNodes; }
+        if (line == headerAdditionalScripts) { return Section::AdditionalScripts; }
 
         throw ProfileParsingError(
             lineNumber,
@@ -399,6 +402,10 @@ namespace {
     [[ nodiscard ]] std::string parseMarkNodes(const std::string& line, int) {
         return line;
     }
+
+    [[ nodiscard ]] std::string parseAdditionalScript(const std::string& line, int) {
+        return line;
+    }
 } // namespace
 
 void Profile::saveCurrentSettingsToProfile(const properties::PropertyOwner& rootOwner,
@@ -638,6 +645,13 @@ std::string Profile::serialize() const {
         }
     }
 
+    if (!additionalScripts.empty()) {
+        output += fmt::format("\n{}\n", headerAdditionalScripts);
+        for (const std::string& s : additionalScripts) {
+            output += fmt::format("{}\n", s);
+        }
+    }
+
     return output;
 }
 
@@ -737,6 +751,12 @@ Profile::Profile(const std::vector<std::string>& content) {
                 markNodes.push_back(std::move(m));
                 break;
             }
+            case Section::AdditionalScripts:
+            {
+                std::string a = parseAdditionalScript(line, lineNum);
+                additionalScripts.push_back(std::move(a));
+                break;
+            }
             default:
                 throw ghoul::MissingCaseException();
         }
@@ -886,6 +906,11 @@ std::string Profile::convertToScene() const {
             *camera
         );
     }
+
+    for (const std::string& a : additionalScripts) {
+        output += fmt::format("{}\n", a);
+    }
+
     output += "end)\n";
 
     return output;
diff --git a/tests/profile/basic_additional_scripts.profile b/tests/profile/basic_additional_scripts.profile
new file mode 100644
index 0000000000..ba6b944989
--- /dev/null
+++ b/tests/profile/basic_additional_scripts.profile
@@ -0,0 +1,7 @@
+#Version
+12.13
+
+#AdditionalScripts
+script-1
+script-2
+script-3
diff --git a/tests/profile/integration_full_test.profile b/tests/profile/integration_full_test.profile
index bd5f95b5e9..3c4112f665 100644
--- a/tests/profile/integration_full_test.profile
+++ b/tests/profile/integration_full_test.profile
@@ -38,3 +38,8 @@ Earth
 Mars
 Moon
 Sun
+
+#AdditionalScripts
+script-1
+script-2
+script-3
diff --git a/tests/profile/integration_full_test_permutation_1.profile b/tests/profile/integration_full_test_permutation_1.profile
index 94facf52d8..adf8380cf9 100644
--- a/tests/profile/integration_full_test_permutation_1.profile
+++ b/tests/profile/integration_full_test_permutation_1.profile
@@ -22,6 +22,11 @@ setPropertyValueSingle	property_name_4	property_value_5
 setPropertyValueSingle	property_name_4	property_value_5
 setPropertyValueSingle	property_name_4	property_value_5
 
+#AdditionalScripts
+script-1
+script-2
+script-3
+
 #Asset
 scene/solarsystem/planets/earth/earth	require	
 scene/solarsystem/planets/earth/satellites/satellites	require	
diff --git a/tests/profile/integration_full_test_permutation_base.profile b/tests/profile/integration_full_test_permutation_base.profile
index bd5f95b5e9..3c4112f665 100644
--- a/tests/profile/integration_full_test_permutation_base.profile
+++ b/tests/profile/integration_full_test_permutation_base.profile
@@ -38,3 +38,8 @@ Earth
 Mars
 Moon
 Sun
+
+#AdditionalScripts
+script-1
+script-2
+script-3
diff --git a/tests/test_profile.cpp b/tests/test_profile.cpp
index 4319bc2257..a210fddc15 100644
--- a/tests/test_profile.cpp
+++ b/tests/test_profile.cpp
@@ -199,6 +199,17 @@ TEST_CASE("Basic Mark Nodes", "[profile]") {
     REQUIRE(serialized == contents);
 }
 
+TEST_CASE("Basic Additional Scripts", "[profile]") {
+    constexpr const char* TestFile =
+        "${TESTDIR}/profile/basic_additional_scripts.profile";
+    Profile p = loadProfile(TestFile);
+
+    std::string serialized = p.serialize();
+    std::string contents = loadFile(TestFile);
+
+    REQUIRE(serialized == contents);
+}
+
 //
 // Integration
 //