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);
 
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;
  }
 
  std::string GetLabel(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_; }
 
 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 std::string GetRoomLabel(int id) {
  return GetResourceLabels().GetLabel(ResourceType::kRoom, id);
}
 
inline std::string GetItemLabel(int id) {
  return GetResourceLabels().GetLabel(ResourceType::kItem, 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