lazy_layered_config.hpp

Go to the documentation of this file.

#pragma once
 
#include <any>
#include <functional>
#include <map>
#include <memory>
#include <unordered_map>
#include <vector>
 
#include "gsl/pointers"
 
#include "porytiles2/app/config/app_config.hpp"
#include "porytiles2/domain/config/domain_config.hpp"
#include "porytiles2/domain/models/rgba32.hpp"
#include "porytiles2/infra/config/config_provider.hpp"
#include "porytiles2/infra/config/infra_config.hpp"
#include "porytiles2/infra/config/tiles_pal_mode.hpp"
#include "porytiles2/utilities/text/plain_text_formatter.hpp"
#include "porytiles2/utilities/text/text_formatter.hpp"
#include "porytiles2/xcut/config/config_value.hpp"
#include "porytiles2/xcut/result/chainable_result.hpp"
 
namespace porytiles2 {
 
/*
 * NOTE: DO NOT EDIT THIS FILE DIRECTLY. It is AUTO-GENERATED from config_schema.yaml.
 * To add new config values or make other changes, edit config_schema.yaml and regenerate using
 * Scripts/generate_config.py.
 */
 
/*
 * TODO: implement a better system for configuration validation. Right now, we rely on each ConfigProvider
 * implementation to provide validation internally before returning LayerValue::invalid. However, this means certain
 * config validations will have to be repeated multiple times in every single ConfigProvider impl. This is fine for some
 * validation. E.g. CommandLineProvider and YamlProvider might have different format validation needs when parsing from
 * source. Hence they may have different parse_x implementations. However, some values need generic validation, e.g.
 * num_pals_primary must be less than num_pals_total.
 */
 
class LazyLayeredConfig final : public DomainConfig, public AppConfig, public InfraConfig {
  public:
    explicit LazyLayeredConfig(
        gsl::not_null<TextFormatter *> format, std::vector<std::unique_ptr<ConfigProvider>> &&providers)
        : format_{format}, providers_{std::move(providers)}
    {
    }
 
    explicit LazyLayeredConfig(std::vector<std::unique_ptr<ConfigProvider>> &&providers)
        : owned_format_{std::make_unique<PlainTextFormatter>()}, format_{owned_format_.get()},
          providers_{std::move(providers)}
    {
    }
 
  protected:
    /*
     * Domain Config Raw Methods
     */
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_tiles_primary_raw(const std::string &tileset) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_tiles_total_raw(const std::string &tileset) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_metatiles_primary_raw(const std::string &tileset) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_metatiles_total_raw(const std::string &tileset) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_pals_primary_raw(const std::string &tileset) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_pals_total_raw(const std::string &tileset) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    max_map_data_size_raw(const std::string &tileset) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_tiles_per_metatile_raw(const std::string &tileset) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<Rgba32>>
    extrinsic_transparency_raw(const std::string &tileset) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<bool>>
    patch_build_enabled_raw(const std::string &tileset) const override;
 
    /*
     * App Config Raw Methods
     */
 
    /*
     * Infra Config Raw Methods
     */
    [[nodiscard]] ChainableResult<ConfigValue<TilesPalMode>> tiles_pal_mode_raw(const std::string &tileset) const override;
 
  public:
 
    /*
     * LazyLayeredConfig Specific Functionality
     */
 
    [[nodiscard]] std::string dump() const;
 
    void warmup_cache(const std::vector<std::string> &tileset_names) const;
 
  private:
    std::unique_ptr<TextFormatter> owned_format_; // Optional owned formatter (when using default ctor)
    TextFormatter *format_;                       // Non-owning pointer to formatter
    // Providers in priority order (highest first)
    std::vector<std::unique_ptr<ConfigProvider>> providers_;
 
    // Config value cache
    mutable std::map<std::string, std::any> cache_;
    // Config value as string for debug printing
    mutable std::unordered_map<std::string, std::string> cache_value_strings_;
 
    // Config source and source_details
    mutable std::unordered_map<std::string, std::string> source_;
    mutable std::unordered_map<std::string, std::vector<std::string>> source_details_;
 
    template <typename T>
    ChainableResult<ConfigValue<T>> resolve_config_value(
        const std::string &cache_key, std::function<LayerValue<T>(const ConfigProvider &)> provider_call) const;
};
 
} // namespace porytiles2