project_tileset_metadata_provider.hpp

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <filesystem>
#include <map>
#include <set>
#include <string>
#include <utility>
#include <vector>
 
#include "gsl/pointers"
 
#include "porytiles/domain/services/tileset_metadata_provider.hpp"
#include "porytiles/infra/models/project_tileset_metadata.hpp"
#include "porytiles/infra/repos/project_tileset_artifact_paths.hpp"
#include "porytiles/utilities/result/chainable_result.hpp"
#include "porytiles/utilities/text/text_formatter.hpp"
#include "porytiles/xcut/diagnostics/user_diagnostics.hpp"
 
namespace porytiles {
 
namespace detail {
 
enum class IncbinResolutionFailure : std::uint8_t {
    not_found,  // The variable name was not declared in any scanned source file.
    empty_paths // The variable was found but its INCBIN declaration captured no paths.
};
 
struct UnresolvedIncbinVar {
    std::string field_label;   // The struct field, e.g. ".tiles" or ".metatileAttributes".
    std::string variable_name; // The INCBIN variable the field referenced.
    IncbinResolutionFailure reason;
};
 
} // namespace detail
 
class ProjectTilesetMetadataProvider : public TilesetMetadataProvider {
  public:
    ProjectTilesetMetadataProvider(
        std::filesystem::path project_root,
        gsl::not_null<const TextFormatter *> format,
        gsl::not_null<const UserDiagnostics *> diag)
        : project_root_{std::move(project_root)}, format_{format}, diag_{diag}
    {
    }
 
    [[nodiscard]] bool exists(const std::string &tileset_name) const override;
 
    [[nodiscard]] ChainableResult<bool> is_secondary(const std::string &tileset_name) const override;
 
    [[nodiscard]] ChainableResult<bool> has_animations(const std::string &tileset_name) const override;
 
    [[nodiscard]] ChainableResult<std::set<std::string>> tilesets() const override;
 
    [[nodiscard]] ChainableResult<ProjectTilesetMetadata> metadata_for(const std::string &tileset_name) const;
 
    [[nodiscard]] ChainableResult<ProjectTilesetArtifactPaths>
    artifact_paths_for(const std::string &tileset_name) const;
 
    void invalidate_metadata_cache() const;
 
  private:
    std::filesystem::path project_root_;
    const TextFormatter *format_;
    const UserDiagnostics *diag_;
 
    // Lazy-loaded cache for parsed tileset metadata (mutable for const methods)
    mutable bool metadata_parsed_{false};
    mutable std::map<std::string, ProjectTilesetMetadata> tileset_metadata_;
 
    // Lazy-loaded cache for resolved tileset artifact paths (mutable for const methods)
    mutable bool artifact_paths_parsed_{false};
    mutable std::map<std::string, ProjectTilesetArtifactPaths> tileset_artifact_paths_;
 
    // Per-tileset record of artifact fields that failed INCBIN resolution, for diagnostics
    mutable std::map<std::string, std::vector<detail::UnresolvedIncbinVar>> tileset_unresolved_vars_;
};
 
} // namespace porytiles