lazy_layered_config.hpp

Go to the documentation of this file.

#pragma once
 
#include <any>
#include <functional>
#include <map>
#include <memory>
#include <ostream>
#include <unordered_map>
#include <vector>
 
#include "gsl/pointers"
 
#include "porytiles/app/config/app_config.hpp"
#include "porytiles/domain/config/domain_config.hpp"
#include "porytiles/domain/config/tiles_pal_mode.hpp"
#include "porytiles/domain/models/rgba32.hpp"
#include "porytiles/domain/packing/models/palette_hint.hpp"
#include "porytiles/infra/config/config_provider.hpp"
#include "porytiles/infra/config/infra_config.hpp"
#include "porytiles/utilities/text/plain_text_formatter.hpp"
#include "porytiles/utilities/text/text_formatter.hpp"
#include "porytiles/xcut/config/config_value.hpp"
#include "porytiles/utilities/result/chainable_result.hpp"
 
namespace porytiles {
 
/*
 * 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 via:
 *
 *   uv run scripts/generate_config.py
 */
 
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)}
    {
    }
 
    void add_provider(std::unique_ptr<ConfigProvider> provider) override;
 
  protected:
    /*
     * Domain Config Raw Methods (Tier 1)
     * Note: _validated methods (Tier 2) are inherited from DomainConfig and not overridden
     */
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_tiles_in_primary_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_tiles_total_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_metatiles_in_primary_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_metatiles_total_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_pals_in_primary_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_pals_total_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    max_map_data_size_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>>
    num_tiles_per_metatile_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<Rgba32>>
    extrinsic_transparency_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<ArtifactEditMode>>
    tiles_edit_mode_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<ArtifactEditMode>>
    pals_edit_mode_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<bool>>
    pal_hints_enabled_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::vector<PaletteHint>>>
    pal_hints_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<PackingStrategyType>>
    packing_strategy_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<PackingStrategyParams>>
    packing_strategy_params_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<TileSharingPacking>>
    tile_sharing_packing_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<TileSharingAlignment>>
    tile_sharing_alignment_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<TilesPalMode>>
    tiles_pal_mode_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<AnimPalResolutionStrategy>>
    global_anim_pal_resolution_strategy_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<AnimKeyFrameResolutionStrategy>>
    global_anim_key_frame_resolution_strategy_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<AnimMultiPalSubtileResolutionStrategy>>
    global_anim_multi_pal_subtile_resolution_strategy_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<FrameLinking>>
    global_frame_linking_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<PerAnimOverrides>>
    per_anim_overrides_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<bool>>
    cross_tileset_anim_linking_raw(ConfigScopeType type, const std::string &scope) const override;
 
    /*
     * App Config Raw Methods (Tier 1)
     * Note: _validated methods (Tier 2) are inherited from AppConfig and not overridden
     */
 
    [[nodiscard]] ChainableResult<ConfigValue<bool>>
    verify_checksums_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<PrimaryPairingMode>>
    primary_pairing_mode_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::vector<std::string>>>
    primary_pairing_partners_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::vector<std::string>>>
    diagnostic_warnings_exclude_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::vector<std::string>>>
    diagnostic_warnings_include_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::vector<std::string>>>
    diagnostic_remarks_exclude_raw(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] ChainableResult<ConfigValue<std::vector<std::string>>>
    diagnostic_remarks_include_raw(ConfigScopeType type, const std::string &scope) const override;
 
    /*
     * Infra Config Raw Methods (Tier 1)
     * Note: _validated methods (Tier 2) are inherited from InfraConfig and not overridden
     */
    [[nodiscard]] ChainableResult<ConfigValue<std::string>> tileset_paths_primary_src_raw(ConfigScopeType type, const std::string &scope) const override;
    [[nodiscard]] ChainableResult<ConfigValue<std::string>> tileset_paths_primary_bin_raw(ConfigScopeType type, const std::string &scope) const override;
    [[nodiscard]] ChainableResult<ConfigValue<std::string>> tileset_paths_secondary_src_raw(ConfigScopeType type, const std::string &scope) const override;
    [[nodiscard]] ChainableResult<ConfigValue<std::string>> tileset_paths_secondary_bin_raw(ConfigScopeType type, const std::string &scope) const override;
    [[nodiscard]] ChainableResult<ConfigValue<std::size_t>> metatile_attr_size_raw(ConfigScopeType type, const std::string &scope) const override;
    [[nodiscard]] ChainableResult<ConfigValue<bool>> tileset_animations_wire_anim_code_raw(ConfigScopeType type, const std::string &scope) const override;
 
  public:
    /*
     * Provenance Chain Methods
     * These methods return the full provenance chain for each config value,
     * showing what each provider in the chain would return.
     */
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::size_t>>
    num_tiles_in_primary_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::size_t>>
    num_tiles_total_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::size_t>>
    num_metatiles_in_primary_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::size_t>>
    num_metatiles_total_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::size_t>>
    num_pals_in_primary_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::size_t>>
    num_pals_total_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::size_t>>
    max_map_data_size_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::size_t>>
    num_tiles_per_metatile_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<Rgba32>>
    extrinsic_transparency_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<ArtifactEditMode>>
    tiles_edit_mode_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<ArtifactEditMode>>
    pals_edit_mode_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<bool>>
    pal_hints_enabled_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::vector<PaletteHint>>>
    pal_hints_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<PackingStrategyType>>
    packing_strategy_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<PackingStrategyParams>>
    packing_strategy_params_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<TileSharingPacking>>
    tile_sharing_packing_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<TileSharingAlignment>>
    tile_sharing_alignment_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<TilesPalMode>>
    tiles_pal_mode_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<AnimPalResolutionStrategy>>
    global_anim_pal_resolution_strategy_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<AnimKeyFrameResolutionStrategy>>
    global_anim_key_frame_resolution_strategy_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<AnimMultiPalSubtileResolutionStrategy>>
    global_anim_multi_pal_subtile_resolution_strategy_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<FrameLinking>>
    global_frame_linking_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<PerAnimOverrides>>
    per_anim_overrides_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<bool>>
    cross_tileset_anim_linking_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<bool>>
    verify_checksums_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<PrimaryPairingMode>>
    primary_pairing_mode_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::vector<std::string>>>
    primary_pairing_partners_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::vector<std::string>>>
    diagnostic_warnings_exclude_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::vector<std::string>>>
    diagnostic_warnings_include_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::vector<std::string>>>
    diagnostic_remarks_exclude_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::vector<std::string>>>
    diagnostic_remarks_include_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::string>>
    tileset_paths_primary_src_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::string>>
    tileset_paths_primary_bin_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::string>>
    tileset_paths_secondary_src_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::string>>
    tileset_paths_secondary_bin_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<std::size_t>>
    metatile_attr_size_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] std::vector<ProvenanceChainLink<bool>>
    tileset_animations_wire_anim_code_provenance_chain(ConfigScopeType type, const std::string &scope) const;
 
    void dump_config(std::ostream &out, ConfigScopeType type, const std::string &scope) 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_;
 
    // Source key cache (stores the provider-specific identifier for each config value)
    mutable std::unordered_map<std::string, std::string> source_key_;
 
    // 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,
        const std::string &canonical_name,
        std::function<LayerValue<T>(const ConfigProvider &)> provider_call) const;
 
    template <typename T>
    std::vector<ProvenanceChainLink<T>>
    collect_provenance_chain(std::function<LayerValue<T>(const ConfigProvider &)> provider_call) const;
};
 
} // namespace porytiles