SDL: Move SDLSettingsInterface (ini) to frontend-common

2025-06-17 14:15:47 -04:00 · 2020-02-28 17:00:14 +10:00
parent 9ab5212833
commit bbdee22ea8
9 changed files with 49 additions and 40 deletions
--- a/src/frontend-common/CMakeLists.txt
+++ b/src/frontend-common/CMakeLists.txt
@ -5,6 +5,8 @@ add_library(frontend-common
  icon.h
  imgui_styles.cpp
  imgui_styles.h
+  ini_settings_interface.cpp
+  ini_settings_interface.h
 )

 if(SDL2_FOUND)
@ -21,5 +23,5 @@ if(SDL2_FOUND)
  target_link_libraries(frontend-common PRIVATE ${SDL2_LIBRARIES})
 endif()

-target_link_libraries(frontend-common PRIVATE core common imgui)
+target_link_libraries(frontend-common PRIVATE core common imgui simpleini)

--- a/src/frontend-common/frontend-common.vcxproj
+++ b/src/frontend-common/frontend-common.vcxproj
@ -44,11 +44,21 @@
    <ProjectReference Include="..\..\dep\libcue\libcue.vcxproj">
      <Project>{6a4208ed-e3dc-41e1-81cd-f61025fc285a}</Project>
    </ProjectReference>
+    <ProjectReference Include="..\..\dep\simpleini\simpleini.vcxproj">
+      <Project>{3773f4cc-614e-4028-8595-22e08ca649e3}</Project>
+    </ProjectReference>
+    <ProjectReference Include="..\common\common.vcxproj">
+      <Project>{ee054e08-3799-4a59-a422-18259c105ffd}</Project>
+    </ProjectReference>
+    <ProjectReference Include="..\core\core.vcxproj">
+      <Project>{868b98c8-65a1-494b-8346-250a73a48c0a}</Project>
+    </ProjectReference>
  </ItemGroup>
  <ItemGroup>
    <ClCompile Include="common_host_interface.cpp" />
    <ClCompile Include="icon.cpp" />
    <ClCompile Include="imgui_styles.cpp" />
+    <ClCompile Include="ini_settings_interface.cpp" />
    <ClCompile Include="sdl_audio_stream.cpp" />
    <ClCompile Include="sdl_controller_interface.cpp" />
    <ClCompile Include="sdl_initializer.cpp" />
@ -57,6 +67,7 @@
    <ClInclude Include="common_host_interface.h" />
    <ClInclude Include="icon.h" />
    <ClInclude Include="imgui_styles.h" />
+    <ClInclude Include="ini_settings_interface.h" />
    <ClInclude Include="sdl_audio_stream.h" />
    <ClInclude Include="sdl_controller_interface.h" />
    <ClInclude Include="sdl_initializer.h" />
@ -205,7 +216,7 @@
      <PreprocessorDefinitions>WITH_SDL2=1;WIN32;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
      <SDLCheck>true</SDLCheck>
      <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
-      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\glad\include;$(SolutionDir)dep\imgui\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\imgui\include;$(SolutionDir)dep\simpleini\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
      <MultiProcessorCompilation>true</MultiProcessorCompilation>
      <LanguageStandard>stdcpp17</LanguageStandard>
      <ConformanceMode>true</ConformanceMode>
@ -232,7 +243,7 @@
      <PreprocessorDefinitions>WITH_SDL2=1;_ITERATOR_DEBUG_LEVEL=1;WIN32;_DEBUGFAST;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
      <SDLCheck>true</SDLCheck>
      <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
-      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\glad\include;$(SolutionDir)dep\imgui\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\imgui\include;$(SolutionDir)dep\simpleini\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
      <BasicRuntimeChecks>Default</BasicRuntimeChecks>
      <SupportJustMyCode>false</SupportJustMyCode>
      <MultiProcessorCompilation>true</MultiProcessorCompilation>
@ -262,7 +273,7 @@
      <PreprocessorDefinitions>WITH_SDL2=1;WIN32;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
      <SDLCheck>true</SDLCheck>
      <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
-      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\glad\include;$(SolutionDir)dep\imgui\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\imgui\include;$(SolutionDir)dep\simpleini\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
      <MultiProcessorCompilation>true</MultiProcessorCompilation>
      <LanguageStandard>stdcpp17</LanguageStandard>
      <ConformanceMode>true</ConformanceMode>
@ -289,7 +300,7 @@
      <PreprocessorDefinitions>WITH_SDL2=1;_ITERATOR_DEBUG_LEVEL=1;WIN32;_DEBUGFAST;_DEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
      <SDLCheck>true</SDLCheck>
      <DebugInformationFormat>ProgramDatabase</DebugInformationFormat>
-      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\glad\include;$(SolutionDir)dep\imgui\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\imgui\include;$(SolutionDir)dep\simpleini\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
      <BasicRuntimeChecks>Default</BasicRuntimeChecks>
      <SupportJustMyCode>false</SupportJustMyCode>
      <MultiProcessorCompilation>true</MultiProcessorCompilation>
@ -320,7 +331,7 @@
      <IntrinsicFunctions>true</IntrinsicFunctions>
      <PreprocessorDefinitions>WITH_SDL2=1;WIN32;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
      <SDLCheck>true</SDLCheck>
-      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\glad\include;$(SolutionDir)dep\imgui\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\imgui\include;$(SolutionDir)dep\simpleini\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
      <MultiProcessorCompilation>true</MultiProcessorCompilation>
      <LanguageStandard>stdcpp17</LanguageStandard>
      <WholeProgramOptimization>false</WholeProgramOptimization>
@ -349,7 +360,7 @@
      <IntrinsicFunctions>true</IntrinsicFunctions>
      <PreprocessorDefinitions>WITH_SDL2=1;WIN32;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
      <SDLCheck>true</SDLCheck>
-      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\glad\include;$(SolutionDir)dep\imgui\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\imgui\include;$(SolutionDir)dep\simpleini\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
      <OmitFramePointers>true</OmitFramePointers>
      <MultiProcessorCompilation>true</MultiProcessorCompilation>
      <LanguageStandard>stdcpp17</LanguageStandard>
@ -380,7 +391,7 @@
      <IntrinsicFunctions>true</IntrinsicFunctions>
      <PreprocessorDefinitions>WITH_SDL2=1;WIN32;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
      <SDLCheck>true</SDLCheck>
-      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\glad\include;$(SolutionDir)dep\imgui\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\imgui\include;$(SolutionDir)dep\simpleini\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
      <MultiProcessorCompilation>true</MultiProcessorCompilation>
      <LanguageStandard>stdcpp17</LanguageStandard>
      <WholeProgramOptimization>false</WholeProgramOptimization>
@ -409,7 +420,7 @@
      <IntrinsicFunctions>true</IntrinsicFunctions>
      <PreprocessorDefinitions>WITH_SDL2=1;WIN32;NDEBUG;_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
      <SDLCheck>true</SDLCheck>
-      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\glad\include;$(SolutionDir)dep\imgui\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(SolutionDir)dep\msvc\include\SDL;$(SolutionDir)dep\imgui\include;$(SolutionDir)dep\simpleini\include;$(SolutionDir)src;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
      <OmitFramePointers>true</OmitFramePointers>
      <MultiProcessorCompilation>true</MultiProcessorCompilation>
      <LanguageStandard>stdcpp17</LanguageStandard>
--- a/src/frontend-common/frontend-common.vcxproj.filters
+++ b/src/frontend-common/frontend-common.vcxproj.filters
@ -7,6 +7,7 @@
    <ClCompile Include="sdl_controller_interface.cpp" />
    <ClCompile Include="sdl_initializer.cpp" />
    <ClCompile Include="common_host_interface.cpp" />
+    <ClCompile Include="ini_settings_interface.cpp" />
  </ItemGroup>
  <ItemGroup>
    <ClInclude Include="icon.h" />
@ -15,6 +16,7 @@
    <ClInclude Include="sdl_controller_interface.h" />
    <ClInclude Include="sdl_initializer.h" />
    <ClInclude Include="common_host_interface.h" />
+    <ClInclude Include="ini_settings_interface.h" />
  </ItemGroup>
  <ItemGroup>
    <None Include="font_roboto_regular.inl" />
--- a/src/frontend-common/ini_settings_interface.cpp
+++ b/src/frontend-common/ini_settings_interface.cpp
@ -0,0 +1,121 @@
+#include "ini_settings_interface.h"
+#include "common/log.h"
+#include <algorithm>
+Log_SetChannel(INISettingsInterface);
+
+INISettingsInterface::INISettingsInterface(const char* filename) : m_filename(filename), m_ini(true, true)
+{
+  SI_Error err = m_ini.LoadFile(filename);
+  if (err != SI_OK)
+    Log_WarningPrintf("Settings could not be loaded from '%s', defaults will be used.", filename);
+}
+
+INISettingsInterface::~INISettingsInterface()
+{
+  if (m_dirty)
+  {
+    SI_Error err = m_ini.SaveFile(m_filename.c_str(), false);
+    if (err != SI_OK)
+      Log_WarningPrintf("Failed to save settings to '%s'.", m_filename.c_str());
+  }
+}
+
+void INISettingsInterface::Clear()
+{
+  m_ini.Reset();
+}
+
+int INISettingsInterface::GetIntValue(const char* section, const char* key, int default_value /*= 0*/)
+{
+  return static_cast<int>(m_ini.GetLongValue(section, key, default_value));
+}
+
+float INISettingsInterface::GetFloatValue(const char* section, const char* key, float default_value /*= 0.0f*/)
+{
+  return static_cast<float>(m_ini.GetDoubleValue(section, key, default_value));
+}
+
+bool INISettingsInterface::GetBoolValue(const char* section, const char* key, bool default_value /*= false*/)
+{
+  return m_ini.GetBoolValue(section, key, default_value);
+}
+
+std::string INISettingsInterface::GetStringValue(const char* section, const char* key,
+                                                 const char* default_value /*= ""*/)
+{
+  return m_ini.GetValue(section, key, default_value);
+}
+
+void INISettingsInterface::SetIntValue(const char* section, const char* key, int value)
+{
+  m_dirty = true;
+  m_ini.SetLongValue(section, key, static_cast<long>(value), nullptr, false, true);
+}
+
+void INISettingsInterface::SetFloatValue(const char* section, const char* key, float value)
+{
+  m_dirty = true;
+  m_ini.SetDoubleValue(section, key, static_cast<double>(value), nullptr, true);
+}
+
+void INISettingsInterface::SetBoolValue(const char* section, const char* key, bool value)
+{
+  m_dirty = true;
+  m_ini.SetBoolValue(section, key, value, nullptr, true);
+}
+
+void INISettingsInterface::SetStringValue(const char* section, const char* key, const char* value)
+{
+  m_dirty = true;
+  m_ini.SetValue(section, key, value, nullptr, true);
+}
+
+void INISettingsInterface::DeleteValue(const char* section, const char* key)
+{
+  m_dirty = true;
+  m_ini.Delete(section, key);
+}
+
+std::vector<std::string> INISettingsInterface::GetStringList(const char* section, const char* key)
+{
+  std::list<CSimpleIniA::Entry> entries;
+  if (!m_ini.GetAllValues(section, key, entries))
+    return {};
+
+  std::vector<std::string> ret;
+  ret.reserve(entries.size());
+  std::transform(entries.begin(), entries.end(), std::back_inserter(ret),
+                 [](const CSimpleIniA::Entry& it) { return std::string(it.pItem); });
+  return ret;
+}
+
+void INISettingsInterface::SetStringList(const char* section, const char* key,
+                                         const std::vector<std::string_view>& items)
+{
+  m_dirty = true;
+  m_ini.Delete(section, key);
+
+  for (const std::string_view& sv : items)
+    m_ini.SetValue(section, key, std::string(sv).c_str(), nullptr, false);
+}
+
+bool INISettingsInterface::RemoveFromStringList(const char* section, const char* key, const char* item)
+{
+  m_dirty = true;
+  return m_ini.DeleteValue(section, key, item, true);
+}
+
+bool INISettingsInterface::AddToStringList(const char* section, const char* key, const char* item)
+{
+  std::list<CSimpleIniA::Entry> entries;
+  if (m_ini.GetAllValues(section, key, entries) &&
+      std::find_if(entries.begin(), entries.end(),
+                   [item](const CSimpleIniA::Entry& e) { return (std::strcmp(e.pItem, item) == 0); }) != entries.end())
+  {
+    return false;
+  }
+
+  m_dirty = true;
+  m_ini.SetValue(section, key, item, nullptr, false);
+  return true;
+}
--- a/src/frontend-common/ini_settings_interface.h
+++ b/src/frontend-common/ini_settings_interface.h
@ -0,0 +1,34 @@
+#pragma once
+#include "core/settings.h"
+
+#include "SimpleIni.h"
+
+class INISettingsInterface : public SettingsInterface
+{
+public:
+  INISettingsInterface(const char* filename);
+  ~INISettingsInterface();
+
+  void Clear() override;
+
+  int GetIntValue(const char* section, const char* key, int default_value = 0) override;
+  float GetFloatValue(const char* section, const char* key, float default_value = 0.0f) override;
+  bool GetBoolValue(const char* section, const char* key, bool default_value = false) override;
+  std::string GetStringValue(const char* section, const char* key, const char* default_value = "") override;
+
+  void SetIntValue(const char* section, const char* key, int value) override;
+  void SetFloatValue(const char* section, const char* key, float value) override;
+  void SetBoolValue(const char* section, const char* key, bool value) override;
+  void SetStringValue(const char* section, const char* key, const char* value) override;
+  void DeleteValue(const char* section, const char* key) override;
+
+  std::vector<std::string> GetStringList(const char* section, const char* key) override;
+  void SetStringList(const char* section, const char* key, const std::vector<std::string_view>& items) override;
+  bool RemoveFromStringList(const char* section, const char* key, const char* item) override;
+  bool AddToStringList(const char* section, const char* key, const char* item) override;
+
+private:
+  std::string m_filename;
+  CSimpleIniA m_ini;
+  bool m_dirty = false;
+};