loot_settings.h

/*  LOOT

    A load order optimisation tool for
    Morrowind, Oblivion, Skyrim, Skyrim Special Edition, Skyrim VR,
    Fallout 3, Fallout: New Vegas, Fallout 4 and Fallout 4 VR.

    Copyright (C) 2014 WrinklyNinja

    This file is part of LOOT.

    LOOT is free software: you can redistribute
    it and/or modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation, either version 3 of
    the License, or (at your option) any later version.

    LOOT 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 LOOT.  If not, see
    <https://www.gnu.org/licenses/>.
    */

#ifndef LOOT_GUI_STATE_LOOT_SETTINGS
#define LOOT_GUI_STATE_LOOT_SETTINGS

#include <filesystem>
#include <map>
#include <mutex>
#include <optional>
#include <string>
#include <vector>

#include "gui/state/game/game_settings.h"

namespace loot {
std::vector<std::string> checkSettingsFile(
    const std::filesystem::path& filePath);

std::string getDefaultPreludeSource();

class LootSettings {
public:
  struct WindowPosition {
    int top{0};
    int bottom{0};
    int left{0};
    int right{0};
    bool maximised{false};
  };

  struct Language {
    std::string locale;
    std::string name;
  };

  struct Filters {
    bool hideVersionNumbers{false};
    bool hideCRCs{false};
    bool hideBashTags{true};
    bool hideLocations{true};
    bool hideNotes{false};
    bool hideOfficialPluginsCleaningMessages{false};
    bool hideAllPluginMessages{false};
    bool hideInactivePlugins{false};
    bool hideMessagelessPlugins{false};
    bool hideCreationClubPlugins{false};
    bool showOnlyEmptyPlugins{false};
  };

  void load(const std::filesystem::path& file);
  void save(const std::filesystem::path& file);

  bool isAutoSortEnabled() const;
  bool isDebugLoggingEnabled() const;
  bool isMasterlistUpdateBeforeSortEnabled() const;
  bool isLootUpdateCheckEnabled() const;
  bool isNoSortingChangesDialogEnabled() const;
  bool isWarnOnCaseSensitiveGamePathsEnabled() const;
  std::string getGame() const;
  std::string getLastGame() const;
  std::string getLastVersion() const;
  std::string getLanguage() const;
  std::string getTheme() const;
  std::string getPreludeSource() const;
  std::optional<WindowPosition> getMainWindowPosition() const;
  std::optional<WindowPosition> getGroupsEditorWindowPosition() const;
  const std::vector<GameSettings>& getGameSettings() const;
  const Filters& getFilters() const;
  const std::vector<Language>& getLanguages() const;

  void setDefaultGame(const std::string& game);
  void setLanguage(const std::string& language);
  void setTheme(const std::string& theme);
  void setPreludeSource(const std::string& source);
  void enableAutoSort(bool enable);
  void enableDebugLogging(bool enable);
  void enableMasterlistUpdateBeforeSort(bool enable);
  void enableLootUpdateCheck(bool enable);
  void enableNoSortingChangesDialog(bool enable);
  void enableWarnOnCaseSensitiveGamePaths(bool enable);

  void storeLastGame(const std::string& lastGame);
  void storeMainWindowPosition(const WindowPosition& position);
  void storeGroupsEditorWindowPosition(const WindowPosition& position);
  void storeGameSettings(const std::vector<GameSettings>& gameSettings);
  void storeFilters(const Filters& filters);
  void updateLastVersion();

private:
  bool autoSort_{false};
  bool enableDebugLogging_{false};
  bool updateMasterlistBeforeSort_{true};
  bool enableLootUpdateCheck_{true};
  bool useNoSortingChangesDialog_{true};
  bool warnOnCaseSensitiveGamePaths_{true};
  std::string game_{"auto"};
  std::string lastGame_{"auto"};
  std::string lastVersion_;
  std::string language_{"en"};
  std::string preludeSource_{getDefaultPreludeSource()};
  std::string theme_{"default"};
  std::optional<WindowPosition> mainWindowPosition_;
  std::optional<WindowPosition> groupsEditorWindowPosition_;
  std::vector<GameSettings> gameSettings_;
  Filters filters_;
  std::vector<Language> languages_{
      Language({"en", "English"}),
      Language({"bg", "Български"}),
      Language({"cs", "Čeština"}),
      Language({"da", "Dansk"}),
      Language({"de", "Deutsch"}),
      Language({"es", "Español"}),
      Language({"fi", "Suomi"}),
      Language({"fr", "Français"}),
      Language({"it", "Italiano"}),
      Language({"ja", "日本語"}),
      Language({"ko", "한국어"}),
      Language({"pl", "Polski"}),
      Language({"pt_BR", "Português do Brasil"}),
      Language({"pt_PT", "Português de Portugal"}),
      Language({"ru", "Русский"}),
      Language({"sv", "Svenska"}),
      Language({"ta", "தமிழ்"}),
      Language({"tr_TR", "Türkçe"}),
      Language({"uk_UA", "Українська"}),
      Language({"zh_CN", "简体中文"}),
  };

  mutable std::recursive_mutex mutex_;
};
}

#endif