resource_labels.h

Go to the documentation of this file.

#ifndef YAZE_ZELDA3_RESOURCE_LABELS_H
#define YAZE_ZELDA3_RESOURCE_LABELS_H
 
#include <cstdint>
#include <functional>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "absl/status/status.h"
#include "core/hack_manifest.h"
 
namespace yaze {
namespace zelda3 {
 
enum class ResourceType {
  kSprite,
  kRoom,
  kEntrance,
  kItem,
  kOverlord,
  kOverworldMap,
  kMusic,
  kGraphics,
  kRoomEffect,
  kRoomTag,
  kTileType,
};
 
std::string ResourceTypeToString(ResourceType type);
 
ResourceType StringToResourceType(const std::string& type_str);
 
// Project label section for explicit user room renames. Opening an Oracle
// project re-injects registry defaults into "room", so renames live here and
// take precedence over registry and "room" labels.
inline constexpr char kRoomOverrideLabelType[] = "room_override";
 
struct ResolvedLabel {
  // Project name when set, else default_name.
  std::string name;
  // Hyrule Magic name (sprites, when preferred), else vanilla.
  std::string default_name;
  bool from_project = false;
 
  // "Collectible (vanilla: ZoraKing)" when renamed, else just the name.
  std::string Display() const;
};
 
class ResourceLabelProvider {
 public:
  using LabelMap = std::unordered_map<std::string, std::string>;
  using ProjectLabels = std::unordered_map<std::string, LabelMap>;
 
  ResourceLabelProvider() = default;
 
  void SetProjectLabels(ProjectLabels* labels) { project_labels_ = labels; }
 
  void SetHackManifest(const core::HackManifest* manifest) {
    hack_manifest_ = manifest;
  }
  const core::HackManifest* hack_manifest() const { return hack_manifest_; }
 
  std::string GetLabel(ResourceType type, int id) const;
 
  std::string GetDefaultLabel(ResourceType type, int id) const;
 
  ResolvedLabel ResolveLabel(ResourceType type, int id) const;
 
  std::string GetLabel(const std::string& type_str, int id) const;
 
  void SetProjectLabel(ResourceType type, int id, const std::string& label);
 
  void ClearProjectLabel(ResourceType type, int id);
 
  bool HasProjectLabel(ResourceType type, int id) const;
 
  std::string GetVanillaLabel(ResourceType type, int id) const;
 
  std::string GetHMagicLabel(ResourceType type, int id) const;
 
  // =========================================================================
  // Hyrule Magic Naming Toggle
  // =========================================================================
 
  void SetPreferHMagicNames(bool prefer) { prefer_hmagic_ = prefer; }
 
  bool PreferHMagicNames() const { return prefer_hmagic_; }
 
  // =========================================================================
  // ZScream DefaultNames.txt Import/Export
  // =========================================================================
 
  absl::Status ImportFromZScreamFormat(const std::string& content);
 
  std::string ExportToZScreamFormat() const;
 
  absl::Status ImportOracleSpriteRegistry(const std::string& csv_content);
 
  // =========================================================================
  // Utility Methods
  // =========================================================================
 
  int GetResourceCount(ResourceType type) const;
 
  const LabelMap* GetProjectLabelsForType(ResourceType type) const;
 
  void ClearAllProjectLabels();
 
  const ProjectLabels* GetAllProjectLabels() const { return project_labels_; }
 
  struct State {
    ProjectLabels* project_labels = nullptr;
    const core::HackManifest* hack_manifest = nullptr;
    bool prefer_hmagic = true;
  };
  State SnapshotState() const {
    return {project_labels_, hack_manifest_, prefer_hmagic_};
  }
  void RestoreState(const State& state) {
    project_labels_ = state.project_labels;
    hack_manifest_ = state.hack_manifest;
    prefer_hmagic_ = state.prefer_hmagic;
  }
 
 private:
  // Project-specific label overrides (owned by YazeProject)
  ProjectLabels* project_labels_ = nullptr;
 
  // Hack manifest reference (owned by YazeProject)
  const core::HackManifest* hack_manifest_ = nullptr;
 
  // Whether to prefer Hyrule Magic sprite names
  bool prefer_hmagic_ = true;
 
  // Parse a single line in ZScream format
  bool ParseZScreamLine(const std::string& line, const std::string& section,
                        int& line_index);
};
 
// ============================================================================
// Global Provider Instance
// ============================================================================
 
ResourceLabelProvider& GetResourceLabels();
 
inline std::string GetSpriteLabel(int id) {
  return GetResourceLabels().GetLabel(ResourceType::kSprite, id);
}
 
inline ResolvedLabel ResolveSpriteLabel(int id) {
  return GetResourceLabels().ResolveLabel(ResourceType::kSprite, id);
}
 
inline std::string GetRoomLabel(int id) {
  return GetResourceLabels().GetLabel(ResourceType::kRoom, id);
}
 
inline std::string GetItemLabel(int id) {
  return GetResourceLabels().GetLabel(ResourceType::kItem, id);
}
 
// Chest/item-receipt IDs use the separate "item_receipt" project-label namespace.
// Generic "item" labels have a different ID domain and are never used here.
// A vanilla fallback does not establish the meaning of a patched receipt handler.
// Explicit context (including nullptr) never consults the global provider.
std::string GetItemReceiptLabel(
    uint8_t id, const ResourceLabelProvider::ProjectLabels* project_labels);
const char* GetItemReceiptLabelSource(
    uint8_t id, const ResourceLabelProvider::ProjectLabels* project_labels);
// Compatibility helpers for callers that use the active global project.
std::string GetItemReceiptLabel(uint8_t id);
const char* GetItemReceiptLabelSource(uint8_t id);
 
inline std::string GetEntranceLabel(int id) {
  return GetResourceLabels().GetLabel(ResourceType::kEntrance, id);
}
 
inline std::string GetOverlordLabel(int id) {
  return GetResourceLabels().GetLabel(ResourceType::kOverlord, id);
}
 
inline std::string GetOverworldMapLabel(int id) {
  return GetResourceLabels().GetLabel(ResourceType::kOverworldMap, id);
}
 
inline std::string GetMusicLabel(int id) {
  return GetResourceLabels().GetLabel(ResourceType::kMusic, id);
}
 
inline std::string GetRoomTagLabel(int id) {
  return GetResourceLabels().GetLabel(ResourceType::kRoomTag, id);
}
 
}  // namespace zelda3
}  // namespace yaze
 
#endif  // YAZE_ZELDA3_RESOURCE_LABELS_H