UI: Massive revamp, new features and improvements

src/util/CMakeLists.txt

@@ -21,6 +21,8 @@ add_library(util
   cd_xa.h
   cue_parser.cpp
   cue_parser.h
+  ini_settings_interface.cpp
+  ini_settings_interface.h
   iso_reader.cpp
   iso_reader.h
   jit_code_buffer.cpp
@@ -41,5 +43,5 @@ add_library(util
 
 target_include_directories(util PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}/..")
 target_include_directories(util PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/..")
-target_link_libraries(util PUBLIC common)
+target_link_libraries(util PUBLIC common simpleini)
 target_link_libraries(util PRIVATE libchdr samplerate zlib)

src/util/ini_settings_interface.cpp

@@ -0,0 +1,249 @@
+/*  PCSX2 - PS2 Emulator for PCs
+ *  Copyright (C) 2002-2021  PCSX2 Dev Team
+ *
+ *  PCSX2 is free software: you can redistribute it and/or modify it under the terms
+ *  of the GNU Lesser General Public License as published by the Free Software Found-
+ *  ation, either version 3 of the License, or (at your option) any later version.
+ *
+ *  PCSX2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ *  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ *  PURPOSE.  See the GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along with PCSX2.
+ *  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "ini_settings_interface.h"
+#include "common/file_system.h"
+#include "common/log.h"
+#include "common/string_util.h"
+#include <algorithm>
+#include <iterator>
+
+Log_SetChannel(INISettingsInterface);
+
+INISettingsInterface::INISettingsInterface(std::string filename) : m_filename(std::move(filename)), m_ini(true, true) {}
+
+INISettingsInterface::~INISettingsInterface()
+{
+  if (m_dirty)
+    Save();
+}
+
+bool INISettingsInterface::Load()
+{
+  if (m_filename.empty())
+    return false;
+
+  SI_Error err = SI_FAIL;
+  auto fp = FileSystem::OpenManagedCFile(m_filename.c_str(), "rb");
+  if (fp)
+    err = m_ini.LoadFile(fp.get());
+
+  return (err == SI_OK);
+}
+
+bool INISettingsInterface::Save()
+{
+  if (m_filename.empty())
+    return false;
+
+  SI_Error err = SI_FAIL;
+  std::FILE* fp = FileSystem::OpenCFile(m_filename.c_str(), "wb");
+  if (fp)
+  {
+    err = m_ini.SaveFile(fp, false);
+    std::fclose(fp);
+  }
+
+  if (err != SI_OK)
+  {
+    Log_WarningPrintf("Failed to save settings to '%s'.", m_filename.c_str());
+    return false;
+  }
+
+  m_dirty = false;
+  return true;
+}
+
+void INISettingsInterface::Clear()
+{
+  m_ini.Reset();
+}
+
+bool INISettingsInterface::GetIntValue(const char* section, const char* key, s32* value) const
+{
+  const char* str_value = m_ini.GetValue(section, key);
+  if (!str_value)
+    return false;
+
+  std::optional<s32> parsed_value = StringUtil::FromChars<s32>(str_value, 10);
+  if (!parsed_value.has_value())
+    return false;
+
+  *value = parsed_value.value();
+  return true;
+}
+
+bool INISettingsInterface::GetUIntValue(const char* section, const char* key, u32* value) const
+{
+  const char* str_value = m_ini.GetValue(section, key);
+  if (!str_value)
+    return false;
+
+  std::optional<u32> parsed_value = StringUtil::FromChars<u32>(str_value, 10);
+  if (!parsed_value.has_value())
+    return false;
+
+  *value = parsed_value.value();
+  return true;
+}
+
+bool INISettingsInterface::GetFloatValue(const char* section, const char* key, float* value) const
+{
+  const char* str_value = m_ini.GetValue(section, key);
+  if (!str_value)
+    return false;
+
+  std::optional<float> parsed_value = StringUtil::FromChars<float>(str_value);
+  if (!parsed_value.has_value())
+    return false;
+
+  *value = parsed_value.value();
+  return true;
+}
+
+bool INISettingsInterface::GetDoubleValue(const char* section, const char* key, double* value) const
+{
+  const char* str_value = m_ini.GetValue(section, key);
+  if (!str_value)
+    return false;
+
+  std::optional<double> parsed_value = StringUtil::FromChars<double>(str_value);
+  if (!parsed_value.has_value())
+    return false;
+
+  *value = parsed_value.value();
+  return true;
+}
+
+bool INISettingsInterface::GetBoolValue(const char* section, const char* key, bool* value) const
+{
+  const char* str_value = m_ini.GetValue(section, key);
+  if (!str_value)
+    return false;
+
+  std::optional<bool> parsed_value = StringUtil::FromChars<bool>(str_value);
+  if (!parsed_value.has_value())
+    return false;
+
+  *value = parsed_value.value();
+  return true;
+}
+
+bool INISettingsInterface::GetStringValue(const char* section, const char* key, std::string* value) const
+{
+  const char* str_value = m_ini.GetValue(section, key);
+  if (!str_value)
+    return false;
+
+  value->assign(str_value);
+  return true;
+}
+
+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::SetUIntValue(const char* section, const char* key, u32 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::SetDoubleValue(const char* section, const char* key, double value)
+{
+  m_dirty = true;
+  m_ini.SetDoubleValue(section, key, 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);
+}
+
+bool INISettingsInterface::ContainsValue(const char* section, const char* key) const
+{
+  return (m_ini.GetValue(section, key, nullptr) != nullptr);
+}
+
+void INISettingsInterface::DeleteValue(const char* section, const char* key)
+{
+  m_dirty = true;
+  m_ini.Delete(section, key);
+}
+
+void INISettingsInterface::ClearSection(const char* section)
+{
+  m_dirty = true;
+  m_ini.Delete(section, nullptr);
+  m_ini.SetValue(section, nullptr, nullptr);
+}
+
+std::vector<std::string> INISettingsInterface::GetStringList(const char* section, const char* key) const
+{
+  std::list<CSimpleIniA::Entry> entries;
+  if (!m_ini.GetAllValues(section, key, entries))
+    return {};
+
+  std::vector<std::string> ret;
+  ret.reserve(entries.size());
+  for (const CSimpleIniA::Entry& entry : entries)
+    ret.emplace_back(entry.pItem);
+  return ret;
+}
+
+void INISettingsInterface::SetStringList(const char* section, const char* key, const std::vector<std::string>& items)
+{
+  m_dirty = true;
+  m_ini.Delete(section, key);
+
+  for (const std::string& sv : items)
+    m_ini.SetValue(section, key, 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;
+}

src/util/ini_settings_interface.h

@@ -0,0 +1,72 @@
+/*  PCSX2 - PS2 Emulator for PCs
+ *  Copyright (C) 2002-2021  PCSX2 Dev Team
+ *
+ *  PCSX2 is free software: you can redistribute it and/or modify it under the terms
+ *  of the GNU Lesser General Public License as published by the Free Software Found-
+ *  ation, either version 3 of the License, or (at your option) any later version.
+ *
+ *  PCSX2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ *  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ *  PURPOSE.  See the GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along with PCSX2.
+ *  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+#include "common/settings_interface.h"
+
+// being a pain here...
+#ifdef _WIN32
+#include "common/windows_headers.h"
+#endif
+#include "SimpleIni.h"
+
+class INISettingsInterface final : public SettingsInterface
+{
+public:
+  INISettingsInterface(std::string filename);
+  ~INISettingsInterface() override;
+
+  const std::string& GetFileName() const { return m_filename; }
+
+  bool Load();
+  bool Save() override;
+
+  void Clear() override;
+
+  bool GetIntValue(const char* section, const char* key, s32* value) const override;
+  bool GetUIntValue(const char* section, const char* key, u32* value) const override;
+  bool GetFloatValue(const char* section, const char* key, float* value) const override;
+  bool GetDoubleValue(const char* section, const char* key, double* value) const override;
+  bool GetBoolValue(const char* section, const char* key, bool* value) const override;
+  bool GetStringValue(const char* section, const char* key, std::string* value) const override;
+
+  void SetIntValue(const char* section, const char* key, s32 value) override;
+  void SetUIntValue(const char* section, const char* key, u32 value) override;
+  void SetFloatValue(const char* section, const char* key, float value) override;
+  void SetDoubleValue(const char* section, const char* key, double 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;
+  bool ContainsValue(const char* section, const char* key) const override;
+  void DeleteValue(const char* section, const char* key) override;
+  void ClearSection(const char* section) override;
+
+  std::vector<std::string> GetStringList(const char* section, const char* key) const override;
+  void SetStringList(const char* section, const char* key, const std::vector<std::string>& 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;
+
+  // default parameter overloads
+  using SettingsInterface::GetBoolValue;
+  using SettingsInterface::GetDoubleValue;
+  using SettingsInterface::GetFloatValue;
+  using SettingsInterface::GetIntValue;
+  using SettingsInterface::GetStringValue;
+  using SettingsInterface::GetUIntValue;
+
+private:
+  std::string m_filename;
+  CSimpleIniA m_ini;
+  bool m_dirty = false;
+};

src/util/util.props

@@ -4,13 +4,13 @@
 
   <ItemDefinitionGroup>
     <ClCompile>
-      <AdditionalIncludeDirectories>$(SolutionDir)dep\libsamplerate\include;$(SolutionDir)dep\libchdr\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(SolutionDir)dep\simpleini\include;$(SolutionDir)dep\libsamplerate\include;$(SolutionDir)dep\libchdr\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
     </ClCompile>
   </ItemDefinitionGroup>
 
   <ItemDefinitionGroup>
     <Link>
-      <AdditionalDependencies>$(RootBuildDir)libchdr\libchdr.lib;$(RootBuildDir)libsamplerate\libsamplerate.lib;%(AdditionalDependencies)</AdditionalDependencies>
+      <AdditionalDependencies>$(RootBuildDir)simpleini\simpleini.lib;$(RootBuildDir)libchdr\libchdr.lib;$(RootBuildDir)libsamplerate\libsamplerate.lib;%(AdditionalDependencies)</AdditionalDependencies>
     </Link>
   </ItemDefinitionGroup>
 </Project>

src/util/util.vcxproj

@@ -6,6 +6,7 @@
     <ClInclude Include="cd_image.h" />
     <ClInclude Include="cd_image_hasher.h" />
     <ClInclude Include="cue_parser.h" />
+    <ClInclude Include="ini_settings_interface.h" />
     <ClInclude Include="iso_reader.h" />
     <ClInclude Include="jit_code_buffer.h" />
     <ClInclude Include="null_audio_stream.h" />
@@ -33,6 +34,7 @@
     <ClCompile Include="cd_image_pbp.cpp" />
     <ClCompile Include="cue_parser.cpp" />
     <ClCompile Include="cd_image_ppf.cpp" />
+    <ClCompile Include="ini_settings_interface.cpp" />
     <ClCompile Include="iso_reader.cpp" />
     <ClCompile Include="jit_code_buffer.cpp" />
     <ClCompile Include="cd_subchannel_replacement.cpp" />

src/util/util.vcxproj.filters

@@ -16,6 +16,7 @@
     <ClInclude Include="page_fault_handler.h" />
     <ClInclude Include="pbp_types.h" />
     <ClInclude Include="cue_parser.h" />
+    <ClInclude Include="ini_settings_interface.h" />
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="jit_code_buffer.cpp" />
@@ -42,5 +43,6 @@
     <ClCompile Include="cue_parser.cpp" />
     <ClCompile Include="cd_image_ppf.cpp" />
     <ClCompile Include="cd_image_device.cpp" />
+    <ClCompile Include="ini_settings_interface.cpp" />
   </ItemGroup>
 </Project>