#5927: Introduce auxiliary classes to deal with version-specific sett…

…ings files.
codereader · Mar 31, 2022 · 2b7db90 · 2b7db90
1 parent c5deae2
commit 2b7db90
Show file tree

Hide file tree

Showing 8 changed files with 106 additions and 0 deletions.
diff --git a/libs/settings/MajorMinorVersion.h b/libs/settings/MajorMinorVersion.h
@@ -0,0 +1,42 @@
+#pragma once
+
+#include <string>
+
+namespace settings
+{
+
+// Represents an application version tag with Major and Minor numbers
+class MajorMinorVersion
+{
+private:
+    int _majorVersion;
+    int _minorVersion;
+
+public:
+    MajorMinorVersion(const std::string& versionString)
+    {
+        // Extract the version from the given string
+        _majorVersion = 0;
+        _minorVersion = 0;
+    }
+
+    // Compare this version to the other one, returning true if this is instance is smaller
+    bool operator<(const MajorMinorVersion& other) const
+    {
+        if (_majorVersion < other._majorVersion)
+        {
+            return true;
+        }
+
+        // If major version matches, minor version decides
+        if (_majorVersion == other._majorVersion)
+        {
+            return _minorVersion < other._minorVersion;
+        }
+
+        // Major version is larger
+        return false;
+    }
+};
+
+}
diff --git a/libs/settings/SettingsManager.h b/libs/settings/SettingsManager.h
@@ -0,0 +1,37 @@
+#pragma once
+
+#include <string>
+#include "version.h"
+#include "imodule.h"
+
+#include "MajorMinorVersion.h"
+
+namespace settings
+{
+
+class SettingsManager
+{
+private:
+    const IApplicationContext& _context;
+    MajorMinorVersion _currentVersion;
+
+public:
+    SettingsManager(const IApplicationContext& context) :
+        SettingsManager(context, RADIANT_VERSION)
+    {}
+
+    SettingsManager(const SettingsManager& other) = delete;
+    SettingsManager& operator=(const SettingsManager& other) = delete;
+
+    // Construct a settings manager instance with a specific version
+    // string in the format "Major.Minor.Micro[BuildSuffix]", or "2.14.0pre1".
+    // Mainly used for unit test purposes, regular code should use the default constructor.
+    SettingsManager(const IApplicationContext& context, const std::string& currentVersion) :
+        _context(context),
+        _currentVersion(currentVersion)
+    {}
+
+    // TODO
+};
+
+}
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -38,6 +38,7 @@ add_executable(drtest
                SceneNode.cpp
                SelectionAlgorithm.cpp
                Selection.cpp
+               Settings.cpp
                TextureManipulation.cpp
                TextureTool.cpp
                Transformation.cpp

diff --git a/test/Settings.cpp b/test/Settings.cpp
@@ -0,0 +1,13 @@
+#include "gtest/gtest.h"
+
+#include "settings/MajorMinorVersion.h"
+
+namespace test
+{
+
+TEST(MajorMinorVersion, ParseFromString)
+{
+    // TODO
+}
+
+}
diff --git a/tools/msvc/Tests/Tests.vcxproj b/tools/msvc/Tests/Tests.vcxproj
@@ -114,6 +114,7 @@
     <ClCompile Include="..\..\..\test\SceneNode.cpp" />
     <ClCompile Include="..\..\..\test\Selection.cpp" />
     <ClCompile Include="..\..\..\test\SelectionAlgorithm.cpp" />
+    <ClCompile Include="..\..\..\test\Settings.cpp" />
     <ClCompile Include="..\..\..\test\TextureManipulation.cpp" />
     <ClCompile Include="..\..\..\test\TextureTool.cpp" />
     <ClCompile Include="..\..\..\test\Transformation.cpp" />

diff --git a/tools/msvc/Tests/Tests.vcxproj.filters b/tools/msvc/Tests/Tests.vcxproj.filters
@@ -57,6 +57,7 @@
     <ClCompile Include="..\..\..\test\ContinuousBuffer.cpp" />
     <ClCompile Include="..\..\..\test\Particles.cpp" />
     <ClCompile Include="..\..\..\test\GeometryStore.cpp" />
+    <ClCompile Include="..\..\..\test\Settings.cpp" />
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="..\..\..\test\HeadlessOpenGLContext.h" />

diff --git a/tools/msvc/libs.vcxproj b/tools/msvc/libs.vcxproj
@@ -256,6 +256,8 @@
     <ClInclude Include="..\..\libs\selection\SelectionVolume.h" />
     <ClInclude Include="..\..\libs\selection\SingleItemSelector.h" />
     <ClInclude Include="..\..\libs\SequentialTaskQueue.h" />
+    <ClInclude Include="..\..\libs\settings\MajorMinorVersion.h" />
+    <ClInclude Include="..\..\libs\settings\SettingsManager.h" />
     <ClInclude Include="..\..\libs\shaderlib.h" />
     <ClInclude Include="..\..\libs\stream\BinaryToTextInputStream.h" />
     <ClInclude Include="..\..\libs\stream\BufferInputStream.h" />

diff --git a/tools/msvc/libs.vcxproj.filters b/tools/msvc/libs.vcxproj.filters
@@ -380,6 +380,12 @@
     <ClInclude Include="..\..\libs\render\Rectangle.h">
       <Filter>render</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\libs\settings\SettingsManager.h">
+      <Filter>settings</Filter>
+    </ClInclude>
+    <ClInclude Include="..\..\libs\settings\MajorMinorVersion.h">
+      <Filter>settings</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <Filter Include="util">
@@ -427,5 +433,8 @@
     <Filter Include="materials">
       <UniqueIdentifier>{60865a71-2a02-47bd-b5e2-8e7ec339d27b}</UniqueIdentifier>
     </Filter>
+    <Filter Include="settings">
+      <UniqueIdentifier>{a23072d3-ab2e-4596-ba32-e785ba12be3a}</UniqueIdentifier>
+    </Filter>
   </ItemGroup>
 </Project>