settings_registry.h

Go to the documentation of this file.

 
#pragma once
 
#include <filesystem>
#include <memory>
#include <string>
#include <string_view>
#include <vector>
 
#include <rex/module.h>
#include <rex/platform.h>
#include <rex/result.h>
#include <rex/types.h>
#include <rex/setting.h>
#include <rex/utility.h>
 
namespace rex {
 
class ProcessSettingsControl;

struct UnknownSetting {
  std::string name;   
  SettingLayer layer; 
};

REX_DECLARE_INTERFACE(ISettingsRegistry, 1)
  [[nodiscard]] virtual Result<void> Register(SettingOwner& owner) = 0;

  virtual void Unregister(SettingOwner& owner) = 0;

  [[nodiscard]] virtual Result<SettingBase*> Find(std::string_view name) const = 0;

  virtual std::vector<SettingBase*> Enumerate(std::string_view scope = {}) const = 0;

  virtual std::vector<ConsoleCommand*> EnumerateCommands(std::string_view scope = {}) const = 0;

  [[nodiscard]] virtual Result<void> SetText(std::string_view name, std::string_view text) = 0;

  [[nodiscard]] virtual Result<void> SetText(SettingLayer layer, std::string_view name,
                                             std::string_view text) = 0;

  virtual void AddAlias(std::string_view old_name, std::string_view new_name) = 0;

  [[nodiscard]] virtual bool IsAlias(std::string_view name) const = 0;

  [[nodiscard]] virtual Result<void> Reset(std::string_view name) = 0;

  [[nodiscard]] virtual Result<void> Run(std::string_view name, std::string_view args) = 0;

  virtual std::vector<std::string> GetRestartPending() const = 0;

  [[nodiscard]] virtual Result<void> Save(const std::filesystem::path& file) const = 0;

  [[nodiscard]] virtual Result<void> Load(const std::filesystem::path& file,
                                          SettingLayer layer = SettingLayer::kRuntime) = 0;
};

class REX_API SettingsRegistry final : public ISettingsRegistry {
 public:
  [[nodiscard]] Result<void> Register(SettingOwner& owner) override;
 
  void Unregister(SettingOwner& owner) override;
 
  [[nodiscard]] Result<SettingBase*> Find(std::string_view name) const override;
 
  std::vector<SettingBase*> Enumerate(std::string_view scope = {}) const override;
 
  std::vector<ConsoleCommand*> EnumerateCommands(std::string_view scope = {}) const override;
 
  [[nodiscard]] Result<void> SetText(std::string_view name, std::string_view text) override;
 
  [[nodiscard]] Result<void> SetText(SettingLayer layer, std::string_view name,
                                     std::string_view text) override;
 
  void AddAlias(std::string_view old_name, std::string_view new_name) override;
 
  [[nodiscard]] bool IsAlias(std::string_view name) const override;
 
  [[nodiscard]] Result<void> Reset(std::string_view name) override;
 
  [[nodiscard]] Result<void> Run(std::string_view name, std::string_view args) override;
 
  std::vector<std::string> GetRestartPending() const override;
 
  [[nodiscard]] Result<void> Save(const std::filesystem::path& file) const override;
 
  [[nodiscard]] Result<void> Load(const std::filesystem::path& file,
                                  SettingLayer layer = SettingLayer::kRuntime) override;
 
 private:
  friend REX_API SettingsRegistry& GetSettingsRegistry();
  friend class ProcessSettingsControl;

  void EndSession();

  void ApplyEnvironment();

  std::vector<std::string> TakeNotices();

  std::vector<UnknownSetting> TakeUnknown();
 
  SettingsRegistry();
  ~SettingsRegistry();
  friend class SettingBase;
  friend class ConsoleCommand;
  void Detach(SettingBase& setting);
  void Detach(ConsoleCommand& command);
  bool ApplyOldLogFile(SettingLayer layer, std::string_view name, std::string_view text,
                       Result<void>& result);
 
  struct State;
  std::unique_ptr<State> state_;
};
 
REX_API SettingsRegistry& GetSettingsRegistry();
 
#define REX_SETTINGS() ::rex::GetSettingsRegistry()
 
}  // namespace rex