yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
hack_manifest.cc
Go to the documentation of this file.
2
3#include <algorithm>
4#include <array>
5#include <cctype>
6#include <filesystem>
7#include <fstream>
8#include <iterator>
9#include <limits>
10#include <sstream>
11#include <utility>
12
13#include "absl/status/statusor.h"
14#include "absl/strings/str_format.h"
15#include "rom/snes.h"
16#include "util/hex.h"
17#include "util/json.h"
18#include "util/log.h"
19#include "util/macro.h"
20
21namespace yaze::core {
22
24 switch (ownership) {
26 return "vanilla_safe";
28 return "hook_patched";
30 return "asm_owned";
32 return "shared";
34 return "asm_expansion";
36 return "ram";
38 return "mirror";
39 }
40 return "unknown";
41}
42
43namespace {
44
45absl::StatusOr<uint32_t> ParseHexAddress(absl::string_view str) {
46 // util::ParseHexString requires the whole string to be a hexadecimal number.
47 // The previous std::stoul call stopped at the first invalid character, so
48 // "0x1E80zz" loaded as 0x1E80, a value past 32 bits wrapped to a plausible
49 // address, and "-1" became 0xFFFFFFFF.
50 uint32_t value = 0;
51 if (!util::ParseHexString(str, &value)) {
52 return absl::InvalidArgumentError(
53 absl::StrFormat("Invalid hex address '%s'", str));
54 }
55 return value;
56}
57
58absl::StatusOr<AddressOwnership> ParseOwnership(const std::string& str) {
59 if (str == "vanilla_safe")
61 if (str == "hook_patched")
63 if (str == "asm_owned")
65 if (str == "shared")
67 if (str == "asm_expansion")
69 if (str == "ram")
71 if (str == "mirror")
73 return absl::InvalidArgumentError(
74 absl::StrFormat("Unknown ownership string '%s'", str));
75}
76
78 const std::string& configured_path, absl::string_view field_name) {
79 namespace fs = std::filesystem;
80 if (configured_path.empty() ||
81 configured_path.find('\\') != std::string::npos ||
82 configured_path.find(':') != std::string::npos ||
83 configured_path.find('\0') != std::string::npos) {
84 return absl::InvalidArgumentError(absl::StrFormat(
85 "%s must be a non-empty portable project-relative path", field_name));
86 }
87
88 const fs::path path(configured_path);
89 if (path.is_absolute() || path.has_root_name() || path.has_root_directory() ||
90 !path.has_filename()) {
91 return absl::InvalidArgumentError(
92 absl::StrFormat("%s must be a project-relative file path", field_name));
93 }
94 for (const fs::path& component : path) {
95 if (component == "." || component == "..") {
96 return absl::InvalidArgumentError(absl::StrFormat(
97 "%s may not contain '.' or '..' components", field_name));
98 }
99 }
100 if (path.lexically_normal().generic_string() != configured_path) {
101 return absl::InvalidArgumentError(absl::StrFormat(
102 "%s must be a normalized project-relative path", field_name));
103 }
104 return absl::OkStatus();
105}
106
108 switch (ownership) {
113 return true;
117 return false;
118 }
119 return false;
120}
121
122uint32_t NormalizeSnesAddress(uint32_t address) {
123 // Treat FastROM mirrors ($80-$FF) as equivalent to the canonical banks
124 // ($00-$7F). The hack manifest is emitted from ASM `org $XXXXXX` directives
125 // and typically uses canonical addresses.
126 if (address >= 0x800000 && address <= 0xFFFFFF) {
127 address &= 0x7FFFFF;
128 }
129 return address;
130}
131
132constexpr uint64_t kCanonicalLoRomSize = 0x400000;
133
135 switch (stream) {
137 return "objects";
139 return "sprites";
141 return "pot_items";
142 }
143 return "unknown";
144}
145
146absl::StatusOr<uint32_t> ParseStrictHexValue(const Json& value,
147 const std::string& field,
148 uint32_t maximum) {
149 if (!value.is_string()) {
150 return absl::InvalidArgumentError(
151 absl::StrFormat("%s must be a hexadecimal string", field));
152 }
153
154 const std::string input = value.get<std::string>();
155 size_t digits_begin = 0;
156 if (!input.empty() && input.front() == '$') {
157 digits_begin = 1;
158 } else if (input.size() >= 2 && input[0] == '0' &&
159 (input[1] == 'x' || input[1] == 'X')) {
160 digits_begin = 2;
161 }
162 if (digits_begin == input.size()) {
163 return absl::InvalidArgumentError(
164 absl::StrFormat("%s has no hexadecimal digits", field));
165 }
166 for (size_t index = digits_begin; index < input.size(); ++index) {
167 if (!std::isxdigit(static_cast<unsigned char>(input[index]))) {
168 return absl::InvalidArgumentError(absl::StrFormat(
169 "%s contains an invalid hexadecimal value '%s'", field, input));
170 }
171 }
172
173 uint64_t parsed = 0;
174 if (!util::ParseHexString(input.substr(digits_begin), &parsed)) {
175 return absl::InvalidArgumentError(absl::StrFormat(
176 "%s contains an invalid hexadecimal value '%s'", field, input));
177 }
178 if (parsed > maximum) {
179 return absl::InvalidArgumentError(
180 absl::StrFormat("%s value '%s' exceeds 0x%X", field, input, maximum));
181 }
182 return static_cast<uint32_t>(parsed);
183}
184
185absl::StatusOr<int> ParseManifestVersion(const Json& root) {
186 if (!root.contains("manifest_version")) {
187 return 0;
188 }
189
190 const Json& value = root["manifest_version"];
191 uint64_t version = 0;
192 if (value.is_number_unsigned()) {
193 version = value.get<uint64_t>();
194 } else if (value.is_number_integer()) {
195 const int64_t signed_version = value.get<int64_t>();
196 if (signed_version < 0) {
197 return absl::InvalidArgumentError(
198 "manifest_version must be a non-negative integer");
199 }
200 version = static_cast<uint64_t>(signed_version);
201 } else {
202 return absl::InvalidArgumentError(
203 "manifest_version must be a non-negative integer");
204 }
205
206 if (version > static_cast<uint64_t>(std::numeric_limits<int>::max())) {
207 return absl::InvalidArgumentError("manifest_version is too large");
208 }
209 return static_cast<int>(version);
210}
211
212absl::StatusOr<int> ParseBoundedNonnegativeInteger(const Json& value,
213 absl::string_view field,
214 uint64_t maximum) {
215 uint64_t parsed = 0;
216 if (value.is_number_unsigned()) {
217 parsed = value.get<uint64_t>();
218 } else if (value.is_number_integer()) {
219 const int64_t signed_value = value.get<int64_t>();
220 if (signed_value < 0) {
221 return absl::InvalidArgumentError(
222 absl::StrFormat("%s must be a non-negative integer", field));
223 }
224 parsed = static_cast<uint64_t>(signed_value);
225 } else {
226 return absl::InvalidArgumentError(
227 absl::StrFormat("%s must be a non-negative integer", field));
228 }
229 if (parsed > maximum ||
230 parsed > static_cast<uint64_t>(std::numeric_limits<int>::max())) {
231 return absl::InvalidArgumentError(
232 absl::StrFormat("%s is too large", field));
233 }
234 return static_cast<int>(parsed);
235}
236
237absl::StatusOr<uint32_t> ParseLoRomAddress(const Json& object,
238 const std::string& key,
239 const std::string& path) {
240 if (!object.contains(key)) {
241 return absl::InvalidArgumentError(
242 absl::StrFormat("%s.%s is required", path, key));
243 }
244
245 uint32_t address = 0;
246 ASSIGN_OR_RETURN(address, ParseStrictHexValue(object[key], path + "." + key,
247 /*maximum=*/0xFFFFFF));
248 address = NormalizeSnesAddress(address);
249 const uint8_t bank = static_cast<uint8_t>((address >> 16) & 0xFF);
250 if (bank == 0x7E || bank == 0x7F) {
251 return absl::InvalidArgumentError(absl::StrFormat(
252 "%s.%s must not use SNES WRAM bank 0x%02X", path, key, bank));
253 }
254 if ((address & 0xFFFF) < 0x8000) {
255 return absl::InvalidArgumentError(absl::StrFormat(
256 "%s.%s must be a mapped LoROM address (low word >= 0x8000)", path,
257 key));
258 }
259 if (NormalizeSnesAddress(PcToSnes(SnesToPc(address))) != address) {
260 return absl::InvalidArgumentError(absl::StrFormat(
261 "%s.%s is not convertible to a canonical LoROM address", path, key));
262 }
263 return address;
264}
265
266absl::StatusOr<uint32_t> ParsePointerCount(const Json& object,
267 const std::string& path) {
268 constexpr const char* kField = "pointer_count";
269 constexpr uint32_t kMaxDungeonPointerCount = 296;
270 if (!object.contains(kField)) {
271 return absl::InvalidArgumentError(
272 absl::StrFormat("%s.%s is required", path, kField));
273 }
274
275 const Json& value = object[kField];
276 uint64_t count = 0;
277 if (value.is_number_unsigned()) {
278 count = value.get<uint64_t>();
279 } else if (value.is_number_integer()) {
280 const int64_t signed_count = value.get<int64_t>();
281 if (signed_count <= 0) {
282 return absl::InvalidArgumentError(
283 absl::StrFormat("%s.%s must be greater than zero", path, kField));
284 }
285 count = static_cast<uint64_t>(signed_count);
286 } else {
287 return absl::InvalidArgumentError(
288 absl::StrFormat("%s.%s must be an integer", path, kField));
289 }
290
291 if (count == 0 || count > kMaxDungeonPointerCount) {
292 return absl::InvalidArgumentError(absl::StrFormat(
293 "%s.%s must be in [1, %u]", path, kField, kMaxDungeonPointerCount));
294 }
295 return static_cast<uint32_t>(count);
296}
297
298absl::StatusOr<DungeonPointerEncoding> ParsePointerEncoding(
299 const Json& object, const std::string& path) {
300 constexpr const char* kField = "pointer_encoding";
301 if (!object.contains(kField) || !object[kField].is_string()) {
302 return absl::InvalidArgumentError(
303 absl::StrFormat("%s.%s must be 'long24' or 'bank16'", path, kField));
304 }
305 const std::string value = object[kField].get<std::string>();
306 if (value == "long24") {
308 }
309 if (value == "bank16") {
311 }
312 return absl::InvalidArgumentError(
313 absl::StrFormat("%s.%s has unknown encoding '%s'", path, kField, value));
314}
315
316absl::StatusOr<DungeonWriteStrategy> ParseWriteStrategy(
317 const Json& object, const std::string& path) {
318 constexpr const char* kField = "strategy";
319 if (!object.contains(kField) || !object[kField].is_string()) {
320 return absl::InvalidArgumentError(absl::StrFormat(
321 "%s.%s must be 'copy_on_write' or 'repack_all'", path, kField));
322 }
323 const std::string value = object[kField].get<std::string>();
324 if (value == "copy_on_write") {
326 }
327 if (value == "repack_all") {
329 }
330 return absl::InvalidArgumentError(
331 absl::StrFormat("%s.%s has unknown strategy '%s'", path, kField, value));
332}
333
335 uint32_t start;
336 uint32_t end;
337 std::string name;
338};
339
340absl::Status ValidateDisjointRanges(std::vector<NamedPcRange> ranges,
341 const std::string& description) {
342 std::sort(ranges.begin(), ranges.end(),
343 [](const NamedPcRange& lhs, const NamedPcRange& rhs) {
344 return lhs.start < rhs.start ||
345 (lhs.start == rhs.start && lhs.end < rhs.end);
346 });
347 if (ranges.empty()) {
348 return absl::OkStatus();
349 }
350
351 NamedPcRange active = ranges.front();
352 for (size_t index = 1; index < ranges.size(); ++index) {
353 const NamedPcRange& current = ranges[index];
354 if (current.start < active.end) {
355 return absl::InvalidArgumentError(
356 absl::StrFormat("%s overlap: %s conflicts with %s", description,
357 current.name, active.name));
358 }
359 if (current.end > active.end) {
360 active = current;
361 }
362 }
363 return absl::OkStatus();
364}
365
366absl::StatusOr<std::vector<SnesAddressRange>> ParseAddressRanges(
367 const Json& object, const std::string& key, const std::string& path) {
368 const std::string field_path = path + "." + key;
369 if (!object.contains(key) || !object[key].is_array() || object[key].empty()) {
370 return absl::InvalidArgumentError(
371 absl::StrFormat("%s must be a non-empty array", field_path));
372 }
373
374 std::vector<SnesAddressRange> ranges;
375 std::vector<NamedPcRange> pc_ranges;
376 ranges.reserve(object[key].size());
377 pc_ranges.reserve(object[key].size());
378 size_t index = 0;
379 for (const Json& range_json : object[key]) {
380 const std::string range_path =
381 absl::StrFormat("%s[%zu]", field_path, index);
382 if (!range_json.is_object()) {
383 return absl::InvalidArgumentError(
384 absl::StrFormat("%s must be an object", range_path));
385 }
386
387 SnesAddressRange range;
389 ParseLoRomAddress(range_json, "start", range_path));
390 ASSIGN_OR_RETURN(range.end,
391 ParseLoRomAddress(range_json, "end", range_path));
392 const uint32_t pc_start = SnesToPc(range.start);
393 const uint32_t pc_end = SnesToPc(range.end);
394 if (range.end <= range.start || pc_end <= pc_start) {
395 return absl::InvalidArgumentError(absl::StrFormat(
396 "%s must be a non-empty half-open range with end > start",
397 range_path));
398 }
399
400 ranges.push_back(range);
401 pc_ranges.push_back({pc_start, pc_end, range_path});
402 ++index;
403 }
404
405 RETURN_IF_ERROR(ValidateDisjointRanges(std::move(pc_ranges), field_path));
406 std::sort(ranges.begin(), ranges.end(),
407 [](const SnesAddressRange& lhs, const SnesAddressRange& rhs) {
408 return lhs.start < rhs.start;
409 });
410 return ranges;
411}
412
413absl::StatusOr<std::vector<SnesAddressRange>> ParseEditorManagedRegions(
414 const Json& root, int manifest_version) {
415 constexpr const char* kSection = "editor_managed_regions";
416 if (!root.contains(kSection)) {
417 return std::vector<SnesAddressRange>{};
418 }
419 if (manifest_version < 3) {
420 return absl::InvalidArgumentError(
421 "editor_managed_regions requires manifest_version 3 or newer");
422 }
423
424 const Json& section = root[kSection];
425 if (!section.is_object() || section.empty()) {
426 return absl::InvalidArgumentError(
427 "editor_managed_regions must be a non-empty object");
428 }
429 return ParseAddressRanges(section, "regions", kSection);
430}
431
433 int total_hooks = 0;
434 std::vector<ProtectedRegion> regions;
435};
436
437absl::StatusOr<uint32_t> ParseProtectedAddress(const Json& object,
438 const std::string& key,
439 const std::string& path,
440 bool require_mapped_lorom) {
441 if (require_mapped_lorom) {
442 return ParseLoRomAddress(object, key, path);
443 }
444 if (!object.contains(key)) {
445 return absl::InvalidArgumentError(
446 absl::StrFormat("%s.%s is required", path, key));
447 }
448
449 uint32_t address = 0;
450 ASSIGN_OR_RETURN(address, ParseStrictHexValue(object[key], path + "." + key,
451 /*maximum=*/0xFFFFFF));
452 return NormalizeSnesAddress(address);
453}
454
455absl::StatusOr<ParsedProtectedRegions> ParseProtectedRegions(
456 const Json& root, int manifest_version) {
458 constexpr const char* kSection = "protected_regions";
459 if (!root.contains(kSection)) {
460 return parsed;
461 }
462
463 const Json& section = root[kSection];
464 if (!section.is_object()) {
465 return absl::InvalidArgumentError("protected_regions must be an object");
466 }
467 if (!section.contains("regions") || !section["regions"].is_array()) {
468 return absl::InvalidArgumentError(
469 "protected_regions.regions must be an array");
470 }
471
472 parsed.total_hooks = section.value("total_hooks", 0);
473 parsed.regions.reserve(section["regions"].size());
474 // Version 3 is the first schema that can exempt editor-managed ranges, so
475 // its protected endpoints must be canonical mapped LoROM addresses. Legacy
476 // manifests still require structurally valid ranges, but retain low-half
477 // addresses emitted by older Oracle sources (for example $1E7F21).
478 const bool require_mapped_lorom = manifest_version >= 3;
479 size_t index = 0;
480 for (const Json& region_json : section["regions"]) {
481 const std::string path =
482 absl::StrFormat("protected_regions.regions[%zu]", index);
483 if (!region_json.is_object()) {
484 return absl::InvalidArgumentError(
485 absl::StrFormat("%s must be an object", path));
486 }
487
488 ProtectedRegion region;
489 ASSIGN_OR_RETURN(region.start,
490 ParseProtectedAddress(region_json, "start", path,
491 require_mapped_lorom));
492 ASSIGN_OR_RETURN(region.end, ParseProtectedAddress(region_json, "end", path,
493 require_mapped_lorom));
494 if (region.end <= region.start ||
495 SnesToPc(region.end) <= SnesToPc(region.start)) {
496 return absl::InvalidArgumentError(absl::StrFormat(
497 "%s must be a non-empty half-open range with end > start", path));
498 }
499
500 region.hook_count = region_json.value("hook_count", 0);
501 region.module = region_json.value("module", "");
502 parsed.regions.push_back(std::move(region));
503 ++index;
504 }
505
506 // Unlike editor-managed and allocator ranges, protected hooks may overlap.
507 // FindProtectedRegion() deliberately walks backward across all candidates.
508 std::sort(parsed.regions.begin(), parsed.regions.end(),
509 [](const ProtectedRegion& lhs, const ProtectedRegion& rhs) {
510 return lhs.start < rhs.start;
511 });
512 return parsed;
513}
514
516 const SnesAddressRange& inner) {
517 return SnesToPc(outer.start) <= SnesToPc(inner.start) &&
518 SnesToPc(inner.end) <= SnesToPc(outer.end);
519}
520
521absl::StatusOr<DungeonStreamLayout> ParseDungeonStreamLayout(
522 DungeonStreamType stream, const Json& json) {
523 const std::string path = absl::StrFormat("dungeon_stream_regions.%s",
525 if (!json.is_object()) {
526 return absl::InvalidArgumentError(
527 absl::StrFormat("%s must be an object", path));
528 }
529
530 DungeonStreamLayout layout;
532 ParseLoRomAddress(json, "pointer_table", path));
537 ParseAddressRanges(json, "data_regions", path));
539 ParseAddressRanges(json, "allocation_regions", path));
540
542 if (!json.contains("pointer_bank")) {
543 return absl::InvalidArgumentError(
544 absl::StrFormat("%s.pointer_bank is required for bank16", path));
545 }
546 uint32_t bank = 0;
548 bank, ParseStrictHexValue(json["pointer_bank"], path + ".pointer_bank",
549 /*maximum=*/0xFF));
550 if (bank >= 0x80) {
551 bank &= 0x7F;
552 }
553 if (bank == 0x7E || bank == 0x7F) {
554 return absl::InvalidArgumentError(absl::StrFormat(
555 "%s.pointer_bank must not use SNES WRAM bank 0x%02X", path, bank));
556 }
557 layout.pointer_bank = static_cast<uint8_t>(bank);
558
559 const uint32_t bank_start_snes = (bank << 16) | 0x8000;
560 const uint32_t bank_start_pc = SnesToPc(bank_start_snes);
561 const uint64_t bank_end_pc = static_cast<uint64_t>(bank_start_pc) + 0x8000;
562 for (const SnesAddressRange& range : layout.data_regions) {
563 if (SnesToPc(range.start) < bank_start_pc ||
564 SnesToPc(range.end) > bank_end_pc) {
565 return absl::InvalidArgumentError(absl::StrFormat(
566 "%s.data_regions must stay within pointer_bank 0x%02X for "
567 "bank16 encoding",
568 path, bank));
569 }
570 }
571 } else if (json.contains("pointer_bank")) {
572 return absl::InvalidArgumentError(
573 absl::StrFormat("%s.pointer_bank is not allowed for long24", path));
574 }
575
576 for (const SnesAddressRange& allocation : layout.allocation_regions) {
577 const bool contained =
578 std::any_of(layout.data_regions.begin(), layout.data_regions.end(),
579 [&allocation](const SnesAddressRange& data) {
580 return PcRangeContains(data, allocation);
581 });
582 if (!contained) {
583 return absl::InvalidArgumentError(absl::StrFormat(
584 "%s allocation range [0x%06X, 0x%06X) is not fully contained in "
585 "a data_region",
586 path, allocation.start, allocation.end));
587 }
588 }
589
590 const uint64_t pointer_width =
592 const uint64_t table_start_pc = SnesToPc(layout.pointer_table);
593 const uint64_t table_size =
594 pointer_width * static_cast<uint64_t>(layout.pointer_count);
595 const uint64_t table_end_pc = table_start_pc + table_size;
596 if (table_start_pc > kCanonicalLoRomSize ||
597 table_end_pc > kCanonicalLoRomSize) {
598 return absl::InvalidArgumentError(absl::StrFormat(
599 "%s pointer table extends beyond canonical LoROM address space", path));
600 }
602 const uint64_t runtime_table_end =
603 static_cast<uint64_t>(layout.pointer_table & 0xFFFFu) + table_size;
604 if (runtime_table_end > 0x10000u) {
605 return absl::InvalidArgumentError(absl::StrFormat(
606 "%s bank16 pointer table crosses its runtime CPU bank", path));
607 }
608 }
609
610 return layout;
611}
612
613absl::StatusOr<std::unordered_map<DungeonStreamType, DungeonStreamLayout>>
615 std::unordered_map<DungeonStreamType, DungeonStreamLayout> layouts;
616 if (!root.contains("dungeon_stream_regions")) {
617 return layouts;
618 }
619
620 const Json& section = root["dungeon_stream_regions"];
621 if (!section.is_object() || section.empty()) {
622 return absl::InvalidArgumentError(
623 "dungeon_stream_regions must be a non-empty object");
624 }
625
626 constexpr std::array<std::pair<const char*, DungeonStreamType>, 3> kStreams =
627 {{{"objects", DungeonStreamType::kObjects},
628 {"sprites", DungeonStreamType::kSprites},
629 {"pot_items", DungeonStreamType::kPotItems}}};
630 for (const auto& item : section.items()) {
631 const auto& key = item.key();
632 bool known = false;
633 for (const auto& entry : kStreams) {
634 if (key == entry.first) {
635 known = true;
636 break;
637 }
638 }
639 if (!known) {
640 return absl::InvalidArgumentError(absl::StrFormat(
641 "dungeon_stream_regions contains unknown stream '%s'", key));
642 }
643 }
644
645 std::vector<NamedPcRange> occupied_ranges;
646 std::vector<NamedPcRange> allocation_ranges;
647 for (const auto& [key, stream] : kStreams) {
648 if (!section.contains(key)) {
649 continue;
650 }
651
652 DungeonStreamLayout layout;
653 ASSIGN_OR_RETURN(layout, ParseDungeonStreamLayout(stream, section[key]));
654
655 const uint64_t pointer_width =
657 const uint64_t table_start_pc = SnesToPc(layout.pointer_table);
658 const uint64_t table_end_pc =
659 table_start_pc +
660 pointer_width * static_cast<uint64_t>(layout.pointer_count);
661 occupied_ranges.push_back({static_cast<uint32_t>(table_start_pc),
662 static_cast<uint32_t>(table_end_pc),
663 absl::StrFormat("%s.pointer_table", key)});
664
665 for (size_t index = 0; index < layout.data_regions.size(); ++index) {
666 const auto& range = layout.data_regions[index];
667 occupied_ranges.push_back(
668 {SnesToPc(range.start), SnesToPc(range.end),
669 absl::StrFormat("%s.data_regions[%zu]", key, index)});
670 }
671 for (size_t index = 0; index < layout.allocation_regions.size(); ++index) {
672 const auto& range = layout.allocation_regions[index];
673 allocation_ranges.push_back(
674 {SnesToPc(range.start), SnesToPc(range.end),
675 absl::StrFormat("%s.allocation_regions[%zu]", key, index)});
676 }
677 layouts.emplace(stream, std::move(layout));
678 }
679
680 RETURN_IF_ERROR(ValidateDisjointRanges(std::move(occupied_ranges),
681 "dungeon stream pointer/data ranges"));
682 RETURN_IF_ERROR(ValidateDisjointRanges(std::move(allocation_ranges),
683 "dungeon stream allocation ranges"));
684 return layouts;
685}
686
687} // namespace
688
690 loaded_ = false;
692 hack_name_.clear();
693 total_hooks_ = 0;
694 protected_regions_.clear();
696 owned_banks_.clear();
697 room_tag_map_.clear();
698 room_tags_.clear();
699 feature_flag_map_.clear();
700 feature_flags_.clear();
701 sram_map_.clear();
702 sram_variables_.clear();
709}
710
711absl::Status HackManifest::LoadFromFile(const std::string& filepath) {
712 std::ifstream file(filepath);
713 if (!file.is_open()) {
714 return absl::NotFoundError("Could not open manifest: " + filepath);
715 }
716 std::stringstream buffer;
717 buffer << file.rdbuf();
718 return LoadFromString(buffer.str());
719}
720
721absl::Status HackManifest::LoadFromString(const std::string& json_content) {
722 Reset();
723
724 Json root;
725 try {
726 root = Json::parse(json_content);
727 } catch (const std::exception& exc) {
728 return absl::InvalidArgumentError(
729 std::string("Failed to parse manifest JSON: ") + exc.what());
730 }
731
732 if (!root.is_object()) {
733 return absl::InvalidArgumentError("Hack manifest root must be an object");
734 }
735
736 ASSIGN_OR_RETURN(manifest_version_, ParseManifestVersion(root));
737 hack_name_ = root.value("hack_name", "");
738
739 std::vector<SnesAddressRange> editor_managed_regions;
741 ParseEditorManagedRegions(root, manifest_version_));
742
743 std::unordered_map<DungeonStreamType, DungeonStreamLayout>
744 dungeon_stream_layouts;
745 ASSIGN_OR_RETURN(dungeon_stream_layouts, ParseDungeonStreamLayouts(root));
746
747 ParsedProtectedRegions protected_regions;
749 ParseProtectedRegions(root, manifest_version_));
750
751 // Build pipeline
752 if (root.contains("build_pipeline")) {
753 auto& pipeline = root["build_pipeline"];
754 build_pipeline_.dev_rom = pipeline.value("dev_rom", "");
755 build_pipeline_.patched_rom = pipeline.value("patched_rom", "");
756 build_pipeline_.assembler = pipeline.value("assembler", "");
757 build_pipeline_.entry_point = pipeline.value("entry_point", "");
758 build_pipeline_.build_script = pipeline.value("build_script", "");
759 }
760
761 // Owned banks
762 if (root.contains("owned_banks") && root["owned_banks"].contains("banks")) {
763 for (auto& bank_json : root["owned_banks"]["banks"]) {
764 OwnedBank bank;
765 uint32_t bank_u32 = 0;
766 ASSIGN_OR_RETURN(bank_u32,
767 ParseHexAddress(bank_json.value("bank", "0x00")));
768 bank.bank = static_cast<uint8_t>(bank_u32 & 0xFF);
769 if (bank.bank >= 0x80) {
770 bank.bank &= 0x7F;
771 }
772 ASSIGN_OR_RETURN(bank.bank_start, ParseHexAddress(bank_json.value(
773 "bank_start", "0x000000")));
774 ASSIGN_OR_RETURN(bank.bank_end, ParseHexAddress(bank_json.value(
775 "bank_end", "0x000000")));
776 bank.bank_start = NormalizeSnesAddress(bank.bank_start);
777 bank.bank_end = NormalizeSnesAddress(bank.bank_end);
778 ASSIGN_OR_RETURN(bank.ownership, ParseOwnership(bank_json.value(
779 "ownership", "asm_owned")));
780 bank.ownership_note = bank_json.value("ownership_note", "");
781 owned_banks_[bank.bank] = bank;
782 }
783 }
784
785 // Room tags
786 if (root.contains("room_tags") && root["room_tags"].contains("tags")) {
787 for (auto& tag_json : root["room_tags"]["tags"]) {
788 RoomTagEntry tag;
789 uint32_t tag_id_u32 = 0;
790 ASSIGN_OR_RETURN(tag_id_u32,
791 ParseHexAddress(tag_json.value("tag_id", "0x00")));
792 tag.tag_id = static_cast<uint8_t>(tag_id_u32 & 0xFF);
794 ParseHexAddress(tag_json.value("address", "0x000000")));
795 tag.address = NormalizeSnesAddress(tag.address);
796 tag.name = tag_json.value("name", "");
797 tag.purpose = tag_json.value("purpose", "");
798 tag.source = tag_json.value("source", "");
799 tag.feature_flag = tag_json.value("feature_flag", "");
800 tag.enabled = tag_json.value("enabled", true);
801 room_tag_map_[tag.tag_id] = tag;
802 room_tags_.push_back(tag);
803 }
804 }
805
806 // Feature flags
807 if (root.contains("feature_flags") &&
808 root["feature_flags"].contains("flags")) {
809 for (auto& flag_json : root["feature_flags"]["flags"]) {
810 FeatureFlag flag;
811 flag.name = flag_json.value("name", "");
812 flag.value = flag_json.value("value", 0);
813 flag.enabled = flag_json.value("enabled", false);
814 flag.source = flag_json.value("source", "");
815 feature_flag_map_[flag.name] = flag;
816 feature_flags_.push_back(flag);
817 }
818 }
819
820 // SRAM variables
821 if (root.contains("sram") && root["sram"].contains("variables")) {
822 for (auto& var_json : root["sram"]["variables"]) {
823 SramVariable var;
824 var.name = var_json.value("name", "");
826 ParseHexAddress(var_json.value("address", "0x000000")));
827 var.purpose = var_json.value("purpose", "");
828 sram_map_[var.address] = var;
829 sram_variables_.push_back(var);
830 }
831 }
832
833 // Message layout
834 if (root.contains("messages")) {
835 auto& msg = root["messages"];
836 if (!msg.is_object()) {
837 return absl::InvalidArgumentError("messages must be an object");
838 }
839 if (msg.contains("hook_address") && msg["hook_address"].is_string()) {
841 ParseHexAddress(msg["hook_address"].get<std::string>()));
843 NormalizeSnesAddress(message_layout_.hook_address);
844 }
845 if (msg.contains("data_start")) {
847 ParseHexAddress(msg.value("data_start", "0x000000")));
849 NormalizeSnesAddress(message_layout_.data_start);
850 }
851 if (msg.contains("data_end")) {
853 ParseHexAddress(msg.value("data_end", "0x000000")));
854 message_layout_.data_end = NormalizeSnesAddress(message_layout_.data_end);
855 }
856 if (msg.contains("vanilla_count")) {
859 ParseBoundedNonnegativeInteger(
860 msg["vanilla_count"], "messages.vanilla_count",
861 static_cast<uint64_t>(std::numeric_limits<int>::max())));
862 } else {
864 }
865 if (msg.contains("expanded_range")) {
866 auto& expanded = msg["expanded_range"];
867 if (!expanded.is_object()) {
868 return absl::InvalidArgumentError(
869 "messages.expanded_range must be an object");
870 }
871 uint32_t first_id = 0;
872 uint32_t last_id = 0;
873 ASSIGN_OR_RETURN(first_id,
874 ParseHexAddress(expanded.value("first", "0x000")));
875 ASSIGN_OR_RETURN(last_id,
876 ParseHexAddress(expanded.value("last", "0x000")));
878 static_cast<uint16_t>(first_id & 0xFFFF);
880 static_cast<uint16_t>(last_id & 0xFFFF);
881 if (expanded.contains("count")) {
882 constexpr uint64_t kMaximumExpandedMessageCount =
883 static_cast<uint64_t>(std::numeric_limits<uint16_t>::max()) + 1;
885 ParseBoundedNonnegativeInteger(
886 expanded["count"], "messages.expanded_range.count",
887 kMaximumExpandedMessageCount));
888 } else {
890 }
891 }
892 if (msg.contains("source")) {
893 const auto& source = msg["source"];
894 if (!source.is_object()) {
895 return absl::InvalidArgumentError("messages.source must be an object");
896 }
897 constexpr std::array<absl::string_view, 4> kSourceKeys = {
898 "format", "version", "canonical_bundle_path",
899 "generated_asm_include_path"};
900 for (const auto& item : source.items()) {
901 if (std::find(kSourceKeys.begin(), kSourceKeys.end(), item.key()) ==
902 kSourceKeys.end()) {
903 return absl::InvalidArgumentError(absl::StrFormat(
904 "messages.source contains unknown field '%s'", item.key()));
905 }
906 }
907 for (absl::string_view key : kSourceKeys) {
908 if (!source.contains(key)) {
909 return absl::InvalidArgumentError(
910 absl::StrFormat("messages.source.%s is required", key));
911 }
912 }
913 if (!source["format"].is_string() ||
914 source["format"].get<std::string>() != "yaze-message-bundle") {
915 return absl::InvalidArgumentError(
916 "messages.source.format must be 'yaze-message-bundle'");
917 }
918 int source_version = 0;
919 auto source_version_or = ParseBoundedNonnegativeInteger(
920 source["version"], "messages.source.version",
921 static_cast<uint64_t>(std::numeric_limits<int>::max()));
922 if (!source_version_or.ok() || *source_version_or != 1) {
923 return absl::InvalidArgumentError(
924 "messages.source.version must be integer 1");
925 }
926 source_version = *source_version_or;
927 if (!source["canonical_bundle_path"].is_string() ||
928 source["canonical_bundle_path"].get<std::string>().empty()) {
929 return absl::InvalidArgumentError(
930 "messages.source.canonical_bundle_path must be a non-empty "
931 "string");
932 }
933 if (!source["generated_asm_include_path"].is_string() ||
934 source["generated_asm_include_path"].get<std::string>().empty()) {
935 return absl::InvalidArgumentError(
936 "messages.source.generated_asm_include_path must be a non-empty "
937 "string");
938 }
940 .format = source["format"].get<std::string>(),
941 .version = source_version,
942 .canonical_bundle_path =
943 source["canonical_bundle_path"].get<std::string>(),
944 .generated_asm_include_path =
945 source["generated_asm_include_path"].get<std::string>(),
946 };
947 }
948 }
949
950 // Minecart track source contract
951 if (root.contains("minecart_tracks")) {
952 const auto& minecart_tracks = root["minecart_tracks"];
953 if (!minecart_tracks.is_object()) {
954 return absl::InvalidArgumentError("minecart_tracks must be an object");
955 }
956 constexpr std::array<absl::string_view, 1> kMinecartTrackKeys = {"source"};
957 for (const auto& item : minecart_tracks.items()) {
958 if (std::find(kMinecartTrackKeys.begin(), kMinecartTrackKeys.end(),
959 item.key()) == kMinecartTrackKeys.end()) {
960 return absl::InvalidArgumentError(absl::StrFormat(
961 "minecart_tracks contains unknown field '%s'", item.key()));
962 }
963 }
964 if (!minecart_tracks.contains("source")) {
965 return absl::InvalidArgumentError(
966 "minecart_tracks.source is required when minecart_tracks is present");
967 }
968
969 const auto& source = minecart_tracks["source"];
970 if (!source.is_object()) {
971 return absl::InvalidArgumentError(
972 "minecart_tracks.source must be an object");
973 }
974 constexpr std::array<absl::string_view, 3> kSourceKeys = {
975 "format", "version", "path"};
976 for (const auto& item : source.items()) {
977 if (std::find(kSourceKeys.begin(), kSourceKeys.end(), item.key()) ==
978 kSourceKeys.end()) {
979 return absl::InvalidArgumentError(absl::StrFormat(
980 "minecart_tracks.source contains unknown field '%s'", item.key()));
981 }
982 }
983 for (absl::string_view key : kSourceKeys) {
984 if (!source.contains(key)) {
985 return absl::InvalidArgumentError(
986 absl::StrFormat("minecart_tracks.source.%s is required", key));
987 }
988 }
989 if (!source["format"].is_string() ||
990 source["format"].get<std::string>() != "yaze-minecart-track-table") {
991 return absl::InvalidArgumentError(
992 "minecart_tracks.source.format must be "
993 "'yaze-minecart-track-table'");
994 }
995 const auto source_version_or = ParseBoundedNonnegativeInteger(
996 source["version"], "minecart_tracks.source.version",
997 static_cast<uint64_t>(std::numeric_limits<int>::max()));
998 if (!source_version_or.ok() || *source_version_or != 1) {
999 return absl::InvalidArgumentError(
1000 "minecart_tracks.source.version must be integer 1");
1001 }
1002 if (!source["path"].is_string()) {
1003 return absl::InvalidArgumentError(
1004 "minecart_tracks.source.path must be a string");
1005 }
1006 const std::string source_path = source["path"].get<std::string>();
1007 RETURN_IF_ERROR(ValidateProjectRelativeSourcePath(
1008 source_path, "minecart_tracks.source.path"));
1010 .format = source["format"].get<std::string>(),
1011 .version = *source_version_or,
1012 .path = source_path,
1013 };
1014 }
1015
1016 total_hooks_ = protected_regions.total_hooks;
1017 protected_regions_ = std::move(protected_regions.regions);
1019 dungeon_stream_layouts_ = std::move(dungeon_stream_layouts);
1020 loaded_ = true;
1021 return absl::OkStatus();
1022}
1023
1025 if (!loaded_)
1027
1028 address = NormalizeSnesAddress(address);
1029
1030 // Explicit hooks always win, including hooks that overlap an exact
1031 // editor-managed exemption inside an ASM-owned bank.
1032 if (IsProtected(address)) {
1034 }
1035
1036 if (IsEditorManaged(address)) {
1038 }
1039
1040 const uint8_t bank = static_cast<uint8_t>((address >> 16) & 0xFF);
1041 const auto bank_it = owned_banks_.find(bank);
1042 if (bank_it != owned_banks_.end()) {
1043 return bank_it->second.ownership;
1044 }
1045
1047}
1048
1049bool HackManifest::IsWriteOverwritten(uint32_t address) const {
1050 const AddressOwnership ownership = ClassifyAddress(address);
1051 return ownership == AddressOwnership::kHookPatched ||
1052 ownership == AddressOwnership::kAsmOwned ||
1054}
1055
1057 uint32_t address) const {
1058 address = NormalizeSnesAddress(address);
1059
1060 // Start with the last possible region, then walk backwards so nested or
1061 // overlapping protected regions cannot hide an earlier containing hook.
1062 const auto upper = std::upper_bound(
1063 protected_regions_.begin(), protected_regions_.end(), address,
1064 [](uint32_t addr, const ProtectedRegion& region) {
1065 return addr < region.start;
1066 });
1067
1068 for (auto iter = std::make_reverse_iterator(upper);
1069 iter != protected_regions_.rend(); ++iter) {
1070 if (address >= iter->start && address < iter->end) {
1071 return &*iter;
1072 }
1073 }
1074 return nullptr;
1075}
1076
1077bool HackManifest::IsProtected(uint32_t address) const {
1078 return FindProtectedRegion(address) != nullptr;
1079}
1080
1081bool HackManifest::IsEditorManaged(uint32_t address) const {
1082 address = NormalizeSnesAddress(address);
1083 const auto upper = std::upper_bound(
1084 editor_managed_regions_.begin(), editor_managed_regions_.end(), address,
1085 [](uint32_t addr, const SnesAddressRange& region) {
1086 return addr < region.start;
1087 });
1088 if (upper == editor_managed_regions_.begin()) {
1089 return false;
1090 }
1091 const SnesAddressRange& region = *std::prev(upper);
1092 return region.start <= address && address < region.end;
1093}
1094
1095std::optional<AddressOwnership> HackManifest::GetBankOwnership(
1096 uint8_t bank) const {
1097 if (bank >= 0x80) {
1098 bank &= 0x7F;
1099 }
1100 auto iter = owned_banks_.find(bank);
1101 if (iter == owned_banks_.end())
1102 return std::nullopt;
1103 return iter->second.ownership;
1104}
1105
1106std::string HackManifest::GetRoomTagLabel(uint8_t tag_id) const {
1107 auto iter = room_tag_map_.find(tag_id);
1108 if (iter == room_tag_map_.end())
1109 return "";
1110 return iter->second.name;
1111}
1112
1113std::optional<RoomTagEntry> HackManifest::GetRoomTag(uint8_t tag_id) const {
1114 auto iter = room_tag_map_.find(tag_id);
1115 if (iter == room_tag_map_.end())
1116 return std::nullopt;
1117 return iter->second;
1118}
1119
1120bool HackManifest::IsFeatureEnabled(const std::string& flag_name) const {
1121 auto iter = feature_flag_map_.find(flag_name);
1122 if (iter == feature_flag_map_.end())
1123 return false;
1124 return iter->second.enabled;
1125}
1126
1127std::vector<WriteConflict> HackManifest::AnalyzeWriteRanges(
1128 const std::vector<std::pair<uint32_t, uint32_t>>& ranges) const {
1129 std::vector<WriteConflict> conflicts;
1130 if (!loaded_) {
1131 return conflicts;
1132 }
1133
1134 for (const auto& range : ranges) {
1135 const uint32_t start = NormalizeSnesAddress(range.first);
1136 const uint32_t end = NormalizeSnesAddress(range.second);
1137 if (end <= start) {
1138 continue;
1139 }
1140
1141 // Classify one segment at a time. Every possible ownership transition is
1142 // a boundary: bank edges, exact editor-managed edges, and hook edges.
1143 // This prevents a partially exempt write from bypassing an owned neighbor.
1144 std::vector<uint32_t> boundaries = {start, end};
1145 const uint64_t first_bank_boundary =
1146 (static_cast<uint64_t>(start) & 0xFF0000u) + 0x010000u;
1147 for (uint64_t boundary = first_bank_boundary; boundary < end;
1148 boundary += 0x010000u) {
1149 boundaries.push_back(static_cast<uint32_t>(boundary));
1150 }
1151 auto add_range_boundaries = [start, end, &boundaries](const auto& regions) {
1152 for (const auto& region : regions) {
1153 if (region.start < end && start < region.end) {
1154 boundaries.push_back(std::max(start, region.start));
1155 boundaries.push_back(std::min(end, region.end));
1156 }
1157 }
1158 };
1159 add_range_boundaries(editor_managed_regions_);
1160 add_range_boundaries(protected_regions_);
1161
1162 std::sort(boundaries.begin(), boundaries.end());
1163 boundaries.erase(std::unique(boundaries.begin(), boundaries.end()),
1164 boundaries.end());
1165
1166 bool previous_was_conflict = false;
1168 std::string previous_module;
1169 for (size_t index = 0; index + 1 < boundaries.size(); ++index) {
1170 const uint32_t segment_start = boundaries[index];
1171 if (segment_start >= boundaries[index + 1]) {
1172 continue;
1173 }
1174
1175 const AddressOwnership ownership = ClassifyAddress(segment_start);
1176 if (!IsAsmOwned(ownership)) {
1177 previous_was_conflict = false;
1178 continue;
1179 }
1180
1181 std::string module;
1182 if (ownership == AddressOwnership::kHookPatched) {
1183 if (const ProtectedRegion* protected_region =
1184 FindProtectedRegion(segment_start);
1185 protected_region != nullptr) {
1186 module = protected_region->module;
1187 }
1188 } else {
1189 const uint8_t bank = static_cast<uint8_t>((segment_start >> 16) & 0xFF);
1190 if (const auto bank_it = owned_banks_.find(bank);
1191 bank_it != owned_banks_.end()) {
1192 module = bank_it->second.ownership_note;
1193 }
1194 }
1195
1196 if (!previous_was_conflict || ownership != previous_ownership ||
1197 module != previous_module) {
1198 conflicts.push_back({segment_start, ownership, module});
1199 }
1200 previous_was_conflict = true;
1201 previous_ownership = ownership;
1202 previous_module = std::move(module);
1203 }
1204 }
1205
1206 return conflicts;
1207}
1208
1209std::vector<WriteConflict> HackManifest::AnalyzePcWriteRanges(
1210 const std::vector<std::pair<uint32_t, uint32_t>>& pc_ranges) const {
1211 if (!loaded_) {
1212 return {};
1213 }
1214
1215 std::vector<std::pair<uint32_t, uint32_t>> snes_ranges;
1216 snes_ranges.reserve(pc_ranges.size());
1217
1218 for (const auto& range : pc_ranges) {
1219 uint32_t pc_start = range.first;
1220 const uint32_t pc_end = range.second;
1221 if (pc_end <= pc_start) {
1222 continue;
1223 }
1224
1225 // Split at LoROM bank boundaries (0x8000 bytes per bank segment in PC
1226 // space). PcToSnes() is linear within these segments.
1227 while (pc_start < pc_end) {
1228 const uint32_t next_boundary = (pc_start & ~0x7FFFu) + 0x8000u;
1229 const uint32_t seg_end = std::min(pc_end, next_boundary);
1230 const uint32_t seg_len = seg_end - pc_start;
1231 const uint32_t snes_start = PcToSnes(pc_start);
1232 const uint32_t snes_end = snes_start + seg_len;
1233 snes_ranges.emplace_back(snes_start, snes_end);
1234 pc_start = seg_end;
1235 }
1236 }
1237
1238 return AnalyzeWriteRanges(snes_ranges);
1239}
1240
1241std::string HackManifest::GetSramVariableName(uint32_t address) const {
1242 auto iter = sram_map_.find(address);
1243 if (iter == sram_map_.end())
1244 return "";
1245 return iter->second.name;
1246}
1247
1248bool HackManifest::IsExpandedMessage(uint16_t message_id) const {
1249 return message_id >= message_layout_.first_expanded_id &&
1250 message_id <= message_layout_.last_expanded_id;
1251}
1252
1254 DungeonStreamType stream) const {
1255 const auto iter = dungeon_stream_layouts_.find(stream);
1256 return iter == dungeon_stream_layouts_.end() ? nullptr : &iter->second;
1257}
1258
1259// ============================================================================
1260// Project Registry Loading
1261// ============================================================================
1262
1263absl::Status HackManifest::LoadProjectRegistry(const std::string& code_folder) {
1264 namespace fs = std::filesystem;
1265
1267 fs::path base(code_folder);
1268
1269 // Look for data files in Docs/Dev/Planning/ (generated output location)
1270 fs::path planning = base / "Docs" / "Dev" / "Planning";
1271
1272 // ── Load dungeons.json ──────────────────────────────────────────────────
1273 fs::path dungeons_path = planning / "dungeons.json";
1274 if (fs::exists(dungeons_path)) {
1275 std::ifstream file(dungeons_path);
1276 if (file.is_open()) {
1277 std::stringstream buffer;
1278 buffer << file.rdbuf();
1279 try {
1280 Json root = Json::parse(buffer.str());
1281 if (root.contains("dungeons") && root["dungeons"].is_array()) {
1282 for (const auto& dj : root["dungeons"]) {
1283 DungeonEntry entry;
1284 entry.id = dj.value("id", "");
1285 entry.name = dj.value("name", "");
1286 entry.vanilla_name = dj.value("vanilla_name", "");
1287
1288 // Rooms
1289 if (dj.contains("rooms") && dj["rooms"].is_array()) {
1290 for (const auto& rj : dj["rooms"]) {
1291 DungeonRoom room;
1292 std::string id_str = rj.value("id", "0x00");
1293 auto parsed = ParseHexAddress(id_str);
1294 room.id = parsed.ok() ? static_cast<int>(*parsed) : 0;
1295 room.name = rj.value("name", "");
1296 room.floor = rj.value("floor", "");
1297 room.has_grid_position =
1298 rj.contains("grid_row") && rj.contains("grid_col");
1299 room.grid_row = rj.value("grid_row", 0);
1300 room.grid_col = rj.value("grid_col", 0);
1301 room.type = rj.value("type", "normal");
1302 room.palette = rj.value("palette", 0);
1303 room.blockset = rj.value("blockset", 0);
1304 room.spriteset = rj.value("spriteset", 0);
1305 room.tag1 = static_cast<uint8_t>(rj.value("tag1", 0));
1306 room.tag2 = static_cast<uint8_t>(rj.value("tag2", 0));
1307 entry.rooms.push_back(std::move(room));
1308 }
1309 }
1310
1311 // Stairs
1312 if (dj.contains("stairs") && dj["stairs"].is_array()) {
1313 for (const auto& sj : dj["stairs"]) {
1314 DungeonConnection conn;
1315 std::string from_str = sj.value("from", "0x00");
1316 std::string to_str = sj.value("to", "0x00");
1317 auto from_parsed = ParseHexAddress(from_str);
1318 auto to_parsed = ParseHexAddress(to_str);
1319 conn.from_room =
1320 from_parsed.ok() ? static_cast<int>(*from_parsed) : 0;
1321 conn.to_room =
1322 to_parsed.ok() ? static_cast<int>(*to_parsed) : 0;
1323 conn.label = sj.value("label", "");
1324 entry.stairs.push_back(std::move(conn));
1325 }
1326 }
1327
1328 // Holewarps
1329 if (dj.contains("holewarps") && dj["holewarps"].is_array()) {
1330 for (const auto& hj : dj["holewarps"]) {
1331 DungeonConnection conn;
1332 std::string from_str = hj.value("from", "0x00");
1333 std::string to_str = hj.value("to", "0x00");
1334 auto from_parsed = ParseHexAddress(from_str);
1335 auto to_parsed = ParseHexAddress(to_str);
1336 conn.from_room =
1337 from_parsed.ok() ? static_cast<int>(*from_parsed) : 0;
1338 conn.to_room =
1339 to_parsed.ok() ? static_cast<int>(*to_parsed) : 0;
1340 conn.label = hj.value("label", "");
1341 entry.holewarps.push_back(std::move(conn));
1342 }
1343 }
1344
1345 // Doors
1346 if (dj.contains("doors") && dj["doors"].is_array()) {
1347 for (const auto& doorj : dj["doors"]) {
1348 DungeonConnection conn;
1349 std::string from_str = doorj.value("from", "0x00");
1350 std::string to_str = doorj.value("to", "0x00");
1351 auto from_parsed = ParseHexAddress(from_str);
1352 auto to_parsed = ParseHexAddress(to_str);
1353 conn.from_room =
1354 from_parsed.ok() ? static_cast<int>(*from_parsed) : 0;
1355 conn.to_room =
1356 to_parsed.ok() ? static_cast<int>(*to_parsed) : 0;
1357 conn.label = doorj.value("label", "");
1358 conn.direction = doorj.value("direction", "");
1359 entry.doors.push_back(std::move(conn));
1360 }
1361 }
1362
1363 project_registry_.dungeons.push_back(std::move(entry));
1364 }
1365 }
1366 } catch (const std::exception& exc) {
1367 LOG_WARN("HackManifest", "Failed to parse dungeons.json: %s",
1368 exc.what());
1369 }
1370 }
1371 }
1372
1373 // ── Load overworld.json ─────────────────────────────────────────────────
1374 fs::path overworld_path = planning / "overworld.json";
1375 if (fs::exists(overworld_path)) {
1376 std::ifstream file(overworld_path);
1377 if (file.is_open()) {
1378 std::stringstream buffer;
1379 buffer << file.rdbuf();
1380 try {
1381 Json root = Json::parse(buffer.str());
1382 if (root.contains("areas") && root["areas"].is_array()) {
1383 for (const auto& aj : root["areas"]) {
1384 OverworldArea area;
1385 std::string id_str = aj.value("area_id", "0x00");
1386 auto parsed = ParseHexAddress(id_str);
1387 area.area_id = parsed.ok() ? static_cast<int>(*parsed) : 0;
1388 area.name = aj.value("name", "");
1389 area.world = aj.value("world", "");
1390 area.grid_row = aj.value("grid_row", 0);
1391 area.grid_col = aj.value("grid_col", 0);
1392 project_registry_.overworld_areas.push_back(std::move(area));
1393 }
1394 }
1395 } catch (const std::exception& exc) {
1396 LOG_WARN("HackManifest", "Failed to parse overworld.json: %s",
1397 exc.what());
1398 }
1399 }
1400 }
1401
1402 // ── Load resource labels ────────────────────────────────────────────────
1403 // Priority 1: Unified oracle_resource_labels.json (all types)
1404 // Priority 2: Legacy oracle_room_labels.json (room type only)
1405 fs::path unified_path = planning / "oracle_resource_labels.json";
1406 fs::path legacy_path = planning / "oracle_room_labels.json";
1407
1408 auto normalize_label_id = [](const std::string& raw) -> std::string {
1409 // Project resource_labels keys are decimal strings (std::to_string(id)).
1410 // Support either decimal ("57") or explicit hex ("0x39") here.
1411 std::string s = raw;
1412 while (!s.empty() && std::isspace(static_cast<unsigned char>(s.front()))) {
1413 s.erase(s.begin());
1414 }
1415 while (!s.empty() && std::isspace(static_cast<unsigned char>(s.back()))) {
1416 s.pop_back();
1417 }
1418 if (s.empty()) {
1419 return raw;
1420 }
1421
1422 int base = 10;
1423 if (s.size() >= 2 && s[0] == '0' && (s[1] == 'x' || s[1] == 'X')) {
1424 base = 16;
1425 s = s.substr(2);
1426 if (s.empty()) {
1427 return raw;
1428 }
1429 }
1430
1431 try {
1432 size_t idx = 0;
1433 const unsigned long value = std::stoul(s, &idx, base);
1434 if (idx != s.size()) {
1435 return raw;
1436 }
1437 if (value > static_cast<unsigned long>(std::numeric_limits<int>::max())) {
1438 return raw;
1439 }
1440 return std::to_string(static_cast<int>(value));
1441 } catch (...) {
1442 return raw;
1443 }
1444 };
1445
1446 if (fs::exists(unified_path)) {
1447 std::ifstream file(unified_path);
1448 if (file.is_open()) {
1449 std::stringstream buffer;
1450 buffer << file.rdbuf();
1451 try {
1452 Json root = Json::parse(buffer.str());
1453 // Parse all type sections (room, sprite, item, entrance, etc.)
1454 const std::vector<std::string> label_types = {
1455 "room", "sprite", "item", "entrance", "overworld_map", "music"};
1456 for (const auto& type_key : label_types) {
1457 if (root.contains(type_key) && root[type_key].is_object()) {
1458 for (const auto& [key, value] : root[type_key].items()) {
1459 if (value.is_string()) {
1460 const std::string normalized_key = normalize_label_id(key);
1462 .all_resource_labels[type_key][normalized_key] =
1463 value.get<std::string>();
1464 }
1465 }
1466 }
1467 }
1468 } catch (const std::exception& exc) {
1469 LOG_WARN("HackManifest",
1470 "Failed to parse oracle_resource_labels.json: %s", exc.what());
1471 }
1472 }
1473 } else if (fs::exists(legacy_path)) {
1474 // Backward compat: load room-only labels from legacy file
1475 std::ifstream file(legacy_path);
1476 if (file.is_open()) {
1477 std::stringstream buffer;
1478 buffer << file.rdbuf();
1479 try {
1480 Json root = Json::parse(buffer.str());
1481 if (root.contains("resource_labels") &&
1482 root["resource_labels"].contains("room")) {
1483 for (const auto& [key, value] :
1484 root["resource_labels"]["room"].items()) {
1485 const std::string normalized_key = normalize_label_id(key);
1486 project_registry_.all_resource_labels["room"][normalized_key] =
1487 value.get<std::string>();
1488 }
1489 }
1490 } catch (const std::exception& exc) {
1491 LOG_WARN("HackManifest", "Failed to parse oracle_room_labels.json: %s",
1492 exc.what());
1493 }
1494 }
1495 }
1496
1497 // `dungeons.json` is the canonical Oracle room/dungeon structure. Mirror its
1498 // room names into the generic resource-label registry so opening an Oracle
1499 // project can populate YazeProject::resource_labels and serialize those names
1500 // into the project file. This intentionally runs after oracle_*_labels.json
1501 // so stale generated label bundles cannot mask the current dungeon registry.
1502 size_t dungeon_room_labels = 0;
1503 for (const auto& dungeon : project_registry_.dungeons) {
1504 for (const auto& room : dungeon.rooms) {
1505 if (room.id >= 0 && !room.name.empty()) {
1506 project_registry_.all_resource_labels["room"][std::to_string(room.id)] =
1507 room.name;
1508 ++dungeon_room_labels;
1509 }
1510 }
1511 }
1512 if (dungeon_room_labels > 0) {
1513 LOG_DEBUG("HackManifest",
1514 "Mirrored %zu dungeon room names into project resource labels",
1515 dungeon_room_labels);
1516 }
1517
1518 // ── Load story events ──────────────────────────────────────────────────
1519 fs::path story_events_path = planning / "story_events.json";
1520 if (fs::exists(story_events_path)) {
1521 auto story_status =
1522 project_registry_.story_events.LoadFromJson(story_events_path.string());
1523 if (story_status.ok()) {
1525 if (oracle_progression_state_.has_value()) {
1527 } else {
1528 // Default to an initial "no progress" state so the graph renders with
1529 // sensible locked/available coloring even before live SRAM is wired up.
1530 project_registry_.story_events.UpdateStatus(/*crystal_bitfield=*/0,
1531 /*game_state=*/0);
1532 }
1533 LOG_DEBUG("HackManifest", "Loaded story events: %zu nodes, %zu edges",
1536 } else {
1537 LOG_WARN("HackManifest", "Failed to load story_events.json: %s",
1538 std::string(story_status.message()).c_str());
1539 }
1540 }
1541
1542 size_t total_labels = 0;
1543 for (const auto& [type, labels] : project_registry_.all_resource_labels) {
1544 total_labels += labels.size();
1545 }
1546
1547 if (!project_registry_.dungeons.empty() ||
1548 !project_registry_.overworld_areas.empty() || total_labels > 0) {
1549 LOG_DEBUG("HackManifest",
1550 "Loaded project registry: %zu dungeons, %zu overworld areas, "
1551 "%zu resource labels (%zu types)",
1553 project_registry_.overworld_areas.size(), total_labels,
1555 }
1556
1557 return absl::OkStatus();
1558}
1559
1567
1571 project_registry_.story_events.UpdateStatus(/*crystal_bitfield=*/0,
1572 /*game_state=*/0);
1573 }
1574}
1575
1576} // namespace yaze::core
bool is_object() const
Definition json.h:57
static Json parse(const std::string &)
Definition json.h:36
bool is_array() const
Definition json.h:58
bool is_string() const
Definition json.h:59
items_view items()
Definition json.h:88
T get() const
Definition json.h:49
bool empty() const
Definition json.h:62
bool contains(const std::string &) const
Definition json.h:53
T value(const std::string &, const T &def) const
Definition json.h:50
std::vector< WriteConflict > AnalyzeWriteRanges(const std::vector< std::pair< uint32_t, uint32_t > > &ranges) const
Analyze a set of address ranges for write conflicts.
std::unordered_map< std::string, FeatureFlag > feature_flag_map_
std::optional< RoomTagEntry > GetRoomTag(uint8_t tag_id) const
Get the full room tag entry for a tag ID.
std::unordered_map< uint8_t, OwnedBank > owned_banks_
AddressOwnership ClassifyAddress(uint32_t address) const
Classify a ROM address by ownership.
bool IsFeatureEnabled(const std::string &flag_name) const
std::vector< SramVariable > sram_variables_
std::vector< ProtectedRegion > protected_regions_
bool IsWriteOverwritten(uint32_t address) const
Check if a ROM write at this address would be overwritten by asar.
ProjectRegistry project_registry_
bool IsExpandedMessage(uint16_t message_id) const
bool IsEditorManaged(uint32_t address) const
Check if an address is explicitly managed by yaze.
BuildPipeline build_pipeline_
std::optional< AddressOwnership > GetBankOwnership(uint8_t bank) const
Get the bank ownership for a given bank number.
std::optional< OracleProgressionState > oracle_progression_state_
std::unordered_map< uint32_t, SramVariable > sram_map_
std::string GetSramVariableName(uint32_t address) const
std::unordered_map< uint8_t, RoomTagEntry > room_tag_map_
std::vector< SnesAddressRange > editor_managed_regions_
std::unordered_map< DungeonStreamType, DungeonStreamLayout > dungeon_stream_layouts_
const std::vector< ProtectedRegion > & protected_regions() const
absl::Status LoadProjectRegistry(const std::string &code_folder)
Load project registry data from the code folder.
const DungeonStreamLayout * GetDungeonStreamLayout(DungeonStreamType stream) const
Get an explicitly declared dungeon stream layout.
bool IsProtected(uint32_t address) const
Check if an address is in a protected region.
MinecartTrackLayout minecart_track_layout_
absl::Status LoadFromFile(const std::string &filepath)
Load manifest from a JSON file path.
absl::Status LoadFromString(const std::string &json_content)
Load manifest from a JSON string.
MessageLayout message_layout_
std::string GetRoomTagLabel(uint8_t tag_id) const
Get the human-readable label for a room tag ID.
std::vector< WriteConflict > AnalyzePcWriteRanges(const std::vector< std::pair< uint32_t, uint32_t > > &pc_ranges) const
Analyze a set of PC-offset ranges for write conflicts.
void SetOracleProgressionState(const OracleProgressionState &state)
const ProtectedRegion * FindProtectedRegion(uint32_t address) const
const std::vector< SnesAddressRange > & editor_managed_regions() const
std::vector< RoomTagEntry > room_tags_
std::vector< FeatureFlag > feature_flags_
const std::vector< StoryEventNode > & nodes() const
void AutoLayout()
Compute layout positions using topological sort + layered positioning.
void UpdateStatus(uint8_t crystal_bitfield, uint8_t game_state)
Update node completion status based on SRAM state.
bool loaded() const
Check if the graph has been loaded.
const std::vector< StoryEdge > & edges() const
absl::Status LoadFromJson(const std::string &path)
Load the graph from a JSON file.
#define LOG_DEBUG(category, format,...)
Definition log.h:103
#define LOG_WARN(category, format,...)
Definition log.h:108
#define ASSIGN_OR_RETURN(type_variable_name, expression)
Definition macro.h:62
absl::StatusOr< AddressOwnership > ParseOwnership(const std::string &str)
absl::Status ValidateProjectRelativeSourcePath(const std::string &configured_path, absl::string_view field_name)
absl::StatusOr< ParsedProtectedRegions > ParseProtectedRegions(const Json &root, int manifest_version)
bool IsAsmOwned(AddressOwnership ownership)
absl::StatusOr< DungeonWriteStrategy > ParseWriteStrategy(const Json &object, const std::string &path)
absl::Status ValidateDisjointRanges(std::vector< NamedPcRange > ranges, const std::string &description)
absl::StatusOr< uint32_t > ParseProtectedAddress(const Json &object, const std::string &key, const std::string &path, bool require_mapped_lorom)
absl::StatusOr< uint32_t > ParseStrictHexValue(const Json &value, const std::string &field, uint32_t maximum)
absl::StatusOr< uint32_t > ParsePointerCount(const Json &object, const std::string &path)
absl::StatusOr< int > ParseBoundedNonnegativeInteger(const Json &value, absl::string_view field, uint64_t maximum)
const char * DungeonStreamTypeToString(DungeonStreamType stream)
absl::StatusOr< uint32_t > ParseLoRomAddress(const Json &object, const std::string &key, const std::string &path)
absl::StatusOr< int > ParseManifestVersion(const Json &root)
absl::StatusOr< std::unordered_map< DungeonStreamType, DungeonStreamLayout > > ParseDungeonStreamLayouts(const Json &root)
bool PcRangeContains(const SnesAddressRange &outer, const SnesAddressRange &inner)
absl::StatusOr< DungeonStreamLayout > ParseDungeonStreamLayout(DungeonStreamType stream, const Json &json)
absl::StatusOr< std::vector< SnesAddressRange > > ParseAddressRanges(const Json &object, const std::string &key, const std::string &path)
absl::StatusOr< std::vector< SnesAddressRange > > ParseEditorManagedRegions(const Json &root, int manifest_version)
absl::StatusOr< DungeonPointerEncoding > ParsePointerEncoding(const Json &object, const std::string &path)
std::string AddressOwnershipToString(AddressOwnership ownership)
DungeonStreamType
Dungeon stream kinds with allocator layouts in the hack manifest.
AddressOwnership
Ownership classification for ROM addresses and banks.
nlohmann::json json
bool ParseHexString(absl::string_view str, uint64_t *out)
Definition hex.cc:133
uint32_t PcToSnes(uint32_t addr)
Definition snes.h:17
uint32_t SnesToPc(uint32_t addr) noexcept
Definition snes.h:8
#define RETURN_IF_ERROR(expr)
Definition snes.cc:22
Build pipeline information.
A connection between two rooms (stair, holewarp, or door).
A complete dungeon entry with rooms and connections.
std::vector< DungeonConnection > doors
std::vector< DungeonConnection > holewarps
std::vector< DungeonRoom > rooms
std::vector< DungeonConnection > stairs
A room within a dungeon, with spatial and metadata info.
Explicit pointer and storage layout for one dungeon stream.
DungeonWriteStrategy strategy
std::vector< SnesAddressRange > allocation_regions
std::optional< uint8_t > pointer_bank
std::vector< SnesAddressRange > data_regions
DungeonPointerEncoding pointer_encoding
A compile-time feature flag.
Message range information for the expanded message system.
std::optional< Source > source
Canonical source metadata for the ASM-owned minecart track table.
std::optional< Source > source
Oracle of Secrets game progression state parsed from SRAM.
An overworld area from the overworld registry.
An expanded bank with ownership classification.
AddressOwnership ownership
std::string ownership_note
Project-level registry data loaded from the Oracle planning outputs.
std::vector< DungeonEntry > dungeons
std::vector< OverworldArea > overworld_areas
std::unordered_map< std::string, std::unordered_map< std::string, std::string > > all_resource_labels
A contiguous protected ROM region owned by the ASM hack.
A room tag entry from the dispatch table.
A half-open [start, end) range of canonical LoROM SNES addresses.
A custom SRAM variable definition.