yaml_file_provider.hpp

Go to the documentation of this file.

#pragma once
 
#include <filesystem>
#include <memory>
#include <string>
 
#include "gsl/pointers"
 
#include "porytiles/infra/config/config_provider.hpp"
#include "porytiles/utilities/text/text_formatter.hpp"
#include "porytiles/xcut/diagnostics/user_diagnostics.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 YamlFileProvider final : public ConfigProvider {
  public:
    explicit YamlFileProvider(
        gsl::not_null<const TextFormatter *> format,
        const UserDiagnostics *diagnostics,
        const std::filesystem::path &project_root);
 
    explicit YamlFileProvider(
        const UserDiagnostics *diagnostics,
        const std::filesystem::path &project_root);
 
    [[nodiscard]] std::string name() const override;
 
    [[nodiscard]] bool preload_and_validate(ConfigScopeType type, const std::string &scope) const;
 
    [[nodiscard]] LayerValue<std::size_t> num_tiles_in_primary(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::size_t> num_tiles_total(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::size_t> num_metatiles_in_primary(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::size_t> num_metatiles_total(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::size_t> num_pals_in_primary(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::size_t> num_pals_total(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::size_t> max_map_data_size(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::size_t> num_tiles_per_metatile(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<Rgba32> extrinsic_transparency(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<ArtifactEditMode> tiles_edit_mode(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<ArtifactEditMode> pals_edit_mode(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<bool> pal_hints_enabled(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::vector<PaletteHint>> pal_hints(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<PackingStrategyType> packing_strategy(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<PackingStrategyParams> packing_strategy_params(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<TileSharingPacking> tile_sharing_packing(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<TileSharingAlignment> tile_sharing_alignment(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<TilesPalMode> tiles_pal_mode(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<AnimPalResolutionStrategy> global_anim_pal_resolution_strategy(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<AnimKeyFrameResolutionStrategy> global_anim_key_frame_resolution_strategy(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<AnimMultiPalSubtileResolutionStrategy> global_anim_multi_pal_subtile_resolution_strategy(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<FrameLinking> global_frame_linking(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<PerAnimOverrides> per_anim_overrides(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<bool> cross_tileset_anim_linking(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<bool> verify_checksums(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<PrimaryPairingMode> primary_pairing_mode(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::vector<std::string>> primary_pairing_partners(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::vector<std::string>> diagnostic_warnings_exclude(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::vector<std::string>> diagnostic_warnings_include(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::vector<std::string>> diagnostic_remarks_exclude(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::vector<std::string>> diagnostic_remarks_include(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::string> tileset_paths_primary_src(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::string> tileset_paths_primary_bin(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::string> tileset_paths_secondary_src(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::string> tileset_paths_secondary_bin(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<std::size_t> metatile_attr_size(ConfigScopeType type, const std::string &scope) const override;
 
    [[nodiscard]] LayerValue<bool> tileset_animations_wire_anim_code(ConfigScopeType type, const std::string &scope) const override;
 
  private:
    std::unique_ptr<TextFormatter> owned_format_; // Optional owned formatter (when using default ctor)
    const TextFormatter *format_;                 // Non-owning pointer to formatter
    const UserDiagnostics *diagnostics_;          // Non-owning pointer to diagnostics
    std::filesystem::path project_root_;
};
 
} // namespace porytiles