SettingsBase.h

/*
 *  Copyright (C) 2016-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "settings/lib/ISettingCallback.h"
#include "threads/CriticalSection.h"

#include <set>
#include <string>
#include <vector>

class CSetting;
class CSettingSection;
class CSettingsManager;
class CVariant;
class CXBMCTinyXML;
class TiXmlElement;

class CSettingsBase
{
public:
  virtual ~CSettingsBase();

  CSettingsManager* GetSettingsManager() const { return m_settingsManager; }

  virtual bool Initialize();
  virtual bool IsInitialized() const;
  virtual bool Load() = 0;
  virtual void SetLoaded();
  virtual bool IsLoaded() const;
  virtual bool Save() = 0;
  virtual void Unload();
  virtual void Uninitialize();

  void RegisterCallback(ISettingCallback* callback, const std::set<std::string>& settingList);
  void UnregisterCallback(ISettingCallback* callback);

  std::shared_ptr<CSetting> GetSetting(const std::string& id) const;
  std::vector<std::shared_ptr<CSettingSection>> GetSections() const;
  std::shared_ptr<CSettingSection> GetSection(const std::string& section) const;

  bool GetBool(const std::string& id) const;
  int GetInt(const std::string& id) const;
  double GetNumber(const std::string& id) const;
  std::string GetString(const std::string& id) const;
  std::vector<CVariant> GetList(const std::string& id) const;

  bool SetBool(const std::string& id, bool value);
  bool ToggleBool(const std::string& id);
  bool SetInt(const std::string& id, int value);
  bool SetNumber(const std::string& id, double value);
  bool SetString(const std::string& id, const std::string& value);
  bool SetList(const std::string& id, const std::vector<CVariant>& value);

  bool SetDefault(const std::string &id);
  void SetDefaults();

protected:
  CSettingsBase();

  virtual void InitializeSettingTypes() { }
  virtual void InitializeControls() { }
  virtual void InitializeOptionFillers() { }
  virtual void UninitializeOptionFillers() { }
  virtual void InitializeConditions() { }
  virtual void UninitializeConditions() { }
  virtual bool InitializeDefinitions() = 0;
  virtual void InitializeVisibility() { }
  virtual void InitializeDefaults() { }
  virtual void InitializeISettingsHandlers() { }
  virtual void UninitializeISettingsHandlers() { }
  virtual void InitializeISubSettings() { }
  virtual void UninitializeISubSettings() { }
  virtual void InitializeISettingCallbacks() { }
  virtual void UninitializeISettingCallbacks() { }

  bool InitializeDefinitionsFromXml(const CXBMCTinyXML& xml);

  bool LoadValuesFromXml(const CXBMCTinyXML& xml, bool& updated);
  bool SaveValuesToXml(CXBMCTinyXML& xml) const;

  bool LoadValuesFromXml(const TiXmlElement* root, bool& updated);

  bool LoadHiddenValuesFromXml(const TiXmlElement* root);

  bool m_initialized = false;
  CSettingsManager* m_settingsManager;
  mutable CCriticalSection m_critical;
private:
  CSettingsBase(const CSettingsBase&) = delete;
  CSettingsBase& operator=(const CSettingsBase&) = delete;
};