SettingSection.h

/*
 *  Copyright (C) 2013-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 "ISetting.h"
#include "Setting.h"
#include "SettingCategoryAccess.h"
#include "utils/logtypes.h"

#include <string>
#include <utility>
#include <vector>

class CSettingsManager;

class CSettingGroup : public ISetting
{
public:
  CSettingGroup(const std::string &id, CSettingsManager *settingsManager = nullptr);
  ~CSettingGroup() override = default;

  // implementation of ISetting
  bool Deserialize(const TiXmlNode *node, bool update = false) override;

  const SettingList& GetSettings() const { return m_settings; }
  SettingList GetSettings(SettingLevel level) const;

  void AddSetting(const std::shared_ptr<CSetting>& setting);
  void AddSettings(const SettingList &settings);

  bool ReplaceSetting(const std::shared_ptr<const CSetting>& currentSetting,
                      const std::shared_ptr<CSetting>& newSetting);

  std::shared_ptr<const ISettingControl> GetControl() const { return m_control; }
  std::shared_ptr<ISettingControl> GetControl() { return m_control; }
  void SetControl(std::shared_ptr<ISettingControl> control) { m_control = std::move(control); }

private:
  SettingList m_settings;
  std::shared_ptr<ISettingControl> m_control;

  static Logger s_logger;
};

using SettingGroupPtr = std::shared_ptr<CSettingGroup>;
using SettingGroupList = std::vector<SettingGroupPtr>;

class CSettingCategory : public ISetting
{
public:
  CSettingCategory(const std::string &id, CSettingsManager *settingsManager = nullptr);
  ~CSettingCategory() override = default;

  // implementation of ISetting
  bool Deserialize(const TiXmlNode *node, bool update = false) override;

  const SettingGroupList& GetGroups() const { return m_groups; }
  SettingGroupList GetGroups(SettingLevel level) const;

  bool CanAccess() const;

  void AddGroup(const SettingGroupPtr& group);
  void AddGroupToFront(const SettingGroupPtr& group);
  void AddGroups(const SettingGroupList &groups);

private:
  SettingGroupList m_groups;
  CSettingCategoryAccess m_accessCondition;

  static Logger s_logger;
};

using SettingCategoryPtr = std::shared_ptr<CSettingCategory>;
using SettingCategoryList = std::vector<SettingCategoryPtr>;

class CSettingSection : public ISetting
{
public:
  CSettingSection(const std::string &id, CSettingsManager *settingsManager = nullptr);
  ~CSettingSection() override = default;

  // implementation of ISetting
  bool Deserialize(const TiXmlNode *node, bool update = false) override;

  const SettingCategoryList& GetCategories() const { return m_categories; }
  SettingCategoryList GetCategories(SettingLevel level) const;

  void AddCategory(const SettingCategoryPtr& category);
  void AddCategories(const SettingCategoryList &categories);

private:
  SettingCategoryList m_categories;

  static Logger s_logger;
};

using SettingSectionPtr = std::shared_ptr<CSettingSection>;
using SettingSectionList = std::vector<SettingSectionPtr>;