13#include "absl/status/statusor.h"
14#include "absl/strings/str_format.h"
25 return "vanilla_safe";
27 return "hook_patched";
33 return "asm_expansion";
44absl::StatusOr<uint32_t> ParseHexAddress(
const std::string& str) {
46 if (str.size() >= 2 && str[0] ==
'0' && (str[1] ==
'x' || str[1] ==
'X')) {
47 return static_cast<uint32_t
>(std::stoul(str.substr(2),
nullptr, 16));
49 return static_cast<uint32_t
>(std::stoul(str,
nullptr, 16));
50 }
catch (
const std::exception& exc) {
51 return absl::InvalidArgumentError(
52 absl::StrFormat(
"Invalid hex address '%s': %s", str, exc.what()));
57 if (str ==
"vanilla_safe")
59 if (str ==
"hook_patched")
61 if (str ==
"asm_owned")
65 if (str ==
"asm_expansion")
71 return absl::InvalidArgumentError(
72 absl::StrFormat(
"Unknown ownership string '%s'", str));
94 if (address >= 0x800000 && address <= 0xFFFFFF) {
115 const std::string& field,
118 return absl::InvalidArgumentError(
119 absl::StrFormat(
"%s must be a hexadecimal string", field));
122 const std::string input = value.
get<std::string>();
123 size_t digits_begin = 0;
124 if (!input.empty() && input.front() ==
'$') {
126 }
else if (input.size() >= 2 && input[0] ==
'0' &&
127 (input[1] ==
'x' || input[1] ==
'X')) {
130 if (digits_begin == input.size()) {
131 return absl::InvalidArgumentError(
132 absl::StrFormat(
"%s has no hexadecimal digits", field));
134 for (
size_t index = digits_begin; index < input.size(); ++index) {
135 if (!std::isxdigit(
static_cast<unsigned char>(input[index]))) {
136 return absl::InvalidArgumentError(absl::StrFormat(
137 "%s contains an invalid hexadecimal value '%s'", field, input));
142 const uint64_t parsed =
143 std::stoull(input.substr(digits_begin),
nullptr, 16);
144 if (parsed > maximum) {
145 return absl::InvalidArgumentError(
146 absl::StrFormat(
"%s value '%s' exceeds 0x%X", field, input, maximum));
148 return static_cast<uint32_t
>(parsed);
149 }
catch (
const std::exception& exc) {
150 return absl::InvalidArgumentError(
151 absl::StrFormat(
"Invalid hexadecimal value for %s ('%s'): %s", field,
157 if (!root.
contains(
"manifest_version")) {
161 const Json& value = root[
"manifest_version"];
162 uint64_t version = 0;
163 if (value.is_number_unsigned()) {
164 version = value.
get<uint64_t>();
165 }
else if (value.is_number_integer()) {
166 const int64_t signed_version = value.
get<int64_t>();
167 if (signed_version < 0) {
168 return absl::InvalidArgumentError(
169 "manifest_version must be a non-negative integer");
171 version =
static_cast<uint64_t
>(signed_version);
173 return absl::InvalidArgumentError(
174 "manifest_version must be a non-negative integer");
177 if (version >
static_cast<uint64_t
>(std::numeric_limits<int>::max())) {
178 return absl::InvalidArgumentError(
"manifest_version is too large");
180 return static_cast<int>(version);
184 absl::string_view field,
187 if (value.is_number_unsigned()) {
188 parsed = value.
get<uint64_t>();
189 }
else if (value.is_number_integer()) {
190 const int64_t signed_value = value.
get<int64_t>();
191 if (signed_value < 0) {
192 return absl::InvalidArgumentError(
193 absl::StrFormat(
"%s must be a non-negative integer", field));
195 parsed =
static_cast<uint64_t
>(signed_value);
197 return absl::InvalidArgumentError(
198 absl::StrFormat(
"%s must be a non-negative integer", field));
200 if (parsed > maximum ||
201 parsed >
static_cast<uint64_t
>(std::numeric_limits<int>::max())) {
202 return absl::InvalidArgumentError(
203 absl::StrFormat(
"%s is too large", field));
205 return static_cast<int>(parsed);
209 const std::string& key,
210 const std::string& path) {
211 if (!
object.contains(key)) {
212 return absl::InvalidArgumentError(
213 absl::StrFormat(
"%s.%s is required", path, key));
216 uint32_t address = 0;
220 const uint8_t bank =
static_cast<uint8_t
>((address >> 16) & 0xFF);
221 if (bank == 0x7E || bank == 0x7F) {
222 return absl::InvalidArgumentError(absl::StrFormat(
223 "%s.%s must not use SNES WRAM bank 0x%02X", path, key, bank));
225 if ((address & 0xFFFF) < 0x8000) {
226 return absl::InvalidArgumentError(absl::StrFormat(
227 "%s.%s must be a mapped LoROM address (low word >= 0x8000)", path,
231 return absl::InvalidArgumentError(absl::StrFormat(
232 "%s.%s is not convertible to a canonical LoROM address", path, key));
238 const std::string& path) {
239 constexpr const char* kField =
"pointer_count";
240 constexpr uint32_t kMaxDungeonPointerCount = 296;
241 if (!
object.contains(kField)) {
242 return absl::InvalidArgumentError(
243 absl::StrFormat(
"%s.%s is required", path, kField));
246 const Json& value =
object[kField];
248 if (value.is_number_unsigned()) {
249 count = value.
get<uint64_t>();
250 }
else if (value.is_number_integer()) {
251 const int64_t signed_count = value.
get<int64_t>();
252 if (signed_count <= 0) {
253 return absl::InvalidArgumentError(
254 absl::StrFormat(
"%s.%s must be greater than zero", path, kField));
256 count =
static_cast<uint64_t
>(signed_count);
258 return absl::InvalidArgumentError(
259 absl::StrFormat(
"%s.%s must be an integer", path, kField));
262 if (count == 0 || count > kMaxDungeonPointerCount) {
263 return absl::InvalidArgumentError(absl::StrFormat(
264 "%s.%s must be in [1, %u]", path, kField, kMaxDungeonPointerCount));
266 return static_cast<uint32_t
>(count);
270 const Json&
object,
const std::string& path) {
271 constexpr const char* kField =
"pointer_encoding";
272 if (!
object.contains(kField) || !
object[kField].is_string()) {
273 return absl::InvalidArgumentError(
274 absl::StrFormat(
"%s.%s must be 'long24' or 'bank16'", path, kField));
276 const std::string value =
object[kField].get<std::string>();
277 if (value ==
"long24") {
280 if (value ==
"bank16") {
283 return absl::InvalidArgumentError(
284 absl::StrFormat(
"%s.%s has unknown encoding '%s'", path, kField, value));
288 const Json&
object,
const std::string& path) {
289 constexpr const char* kField =
"strategy";
290 if (!
object.contains(kField) || !
object[kField].is_string()) {
291 return absl::InvalidArgumentError(absl::StrFormat(
292 "%s.%s must be 'copy_on_write' or 'repack_all'", path, kField));
294 const std::string value =
object[kField].get<std::string>();
295 if (value ==
"copy_on_write") {
298 if (value ==
"repack_all") {
301 return absl::InvalidArgumentError(
302 absl::StrFormat(
"%s.%s has unknown strategy '%s'", path, kField, value));
312 const std::string& description) {
313 std::sort(ranges.begin(), ranges.end(),
315 return lhs.start < rhs.start ||
316 (lhs.start == rhs.start && lhs.end < rhs.end);
318 if (ranges.empty()) {
319 return absl::OkStatus();
323 for (
size_t index = 1; index < ranges.size(); ++index) {
326 return absl::InvalidArgumentError(
327 absl::StrFormat(
"%s overlap: %s conflicts with %s", description,
330 if (current.
end > active.
end) {
334 return absl::OkStatus();
338 const Json&
object,
const std::string& key,
const std::string& path) {
339 const std::string field_path = path +
"." + key;
340 if (!
object.contains(key) || !
object[key].is_array() ||
object[key].empty()) {
341 return absl::InvalidArgumentError(
342 absl::StrFormat(
"%s must be a non-empty array", field_path));
345 std::vector<SnesAddressRange> ranges;
346 std::vector<NamedPcRange> pc_ranges;
347 ranges.reserve(
object[key].size());
348 pc_ranges.reserve(
object[key].size());
350 for (
const Json& range_json :
object[key]) {
351 const std::string range_path =
352 absl::StrFormat(
"%s[%zu]", field_path, index);
353 if (!range_json.is_object()) {
354 return absl::InvalidArgumentError(
355 absl::StrFormat(
"%s must be an object", range_path));
365 if (range.
end <= range.
start || pc_end <= pc_start) {
366 return absl::InvalidArgumentError(absl::StrFormat(
367 "%s must be a non-empty half-open range with end > start",
371 ranges.push_back(range);
372 pc_ranges.push_back({pc_start, pc_end, range_path});
377 std::sort(ranges.begin(), ranges.end(),
379 return lhs.start < rhs.start;
385 const Json& root,
int manifest_version) {
386 constexpr const char* kSection =
"editor_managed_regions";
388 return std::vector<SnesAddressRange>{};
390 if (manifest_version < 3) {
391 return absl::InvalidArgumentError(
392 "editor_managed_regions requires manifest_version 3 or newer");
395 const Json& section = root[kSection];
397 return absl::InvalidArgumentError(
398 "editor_managed_regions must be a non-empty object");
409 const std::string& key,
410 const std::string& path,
411 bool require_mapped_lorom) {
412 if (require_mapped_lorom) {
415 if (!
object.contains(key)) {
416 return absl::InvalidArgumentError(
417 absl::StrFormat(
"%s.%s is required", path, key));
420 uint32_t address = 0;
427 const Json& root,
int manifest_version) {
429 constexpr const char* kSection =
"protected_regions";
434 const Json& section = root[kSection];
436 return absl::InvalidArgumentError(
"protected_regions must be an object");
439 return absl::InvalidArgumentError(
440 "protected_regions.regions must be an array");
444 parsed.
regions.reserve(section[
"regions"].size());
449 const bool require_mapped_lorom = manifest_version >= 3;
451 for (
const Json& region_json : section[
"regions"]) {
452 const std::string path =
453 absl::StrFormat(
"protected_regions.regions[%zu]", index);
454 if (!region_json.is_object()) {
455 return absl::InvalidArgumentError(
456 absl::StrFormat(
"%s must be an object", path));
462 require_mapped_lorom));
464 require_mapped_lorom));
467 return absl::InvalidArgumentError(absl::StrFormat(
468 "%s must be a non-empty half-open range with end > start", path));
471 region.
hook_count = region_json.value(
"hook_count", 0);
472 region.module = region_json.value(
"module",
"");
473 parsed.
regions.push_back(std::move(region));
481 return lhs.start < rhs.start;
494 const std::string path = absl::StrFormat(
"dungeon_stream_regions.%s",
496 if (!
json.is_object()) {
497 return absl::InvalidArgumentError(
498 absl::StrFormat(
"%s must be an object", path));
513 if (!
json.contains(
"pointer_bank")) {
514 return absl::InvalidArgumentError(
515 absl::StrFormat(
"%s.pointer_bank is required for bank16", path));
524 if (bank == 0x7E || bank == 0x7F) {
525 return absl::InvalidArgumentError(absl::StrFormat(
526 "%s.pointer_bank must not use SNES WRAM bank 0x%02X", path, bank));
530 const uint32_t bank_start_snes = (bank << 16) | 0x8000;
531 const uint32_t bank_start_pc =
SnesToPc(bank_start_snes);
532 const uint64_t bank_end_pc =
static_cast<uint64_t
>(bank_start_pc) + 0x8000;
534 if (
SnesToPc(range.start) < bank_start_pc ||
535 SnesToPc(range.end) > bank_end_pc) {
536 return absl::InvalidArgumentError(absl::StrFormat(
537 "%s.data_regions must stay within pointer_bank 0x%02X for "
542 }
else if (
json.contains(
"pointer_bank")) {
543 return absl::InvalidArgumentError(
544 absl::StrFormat(
"%s.pointer_bank is not allowed for long24", path));
548 const bool contained =
551 return PcRangeContains(data, allocation);
554 return absl::InvalidArgumentError(absl::StrFormat(
555 "%s allocation range [0x%06X, 0x%06X) is not fully contained in "
557 path, allocation.start, allocation.end));
561 const uint64_t pointer_width =
564 const uint64_t table_size =
566 const uint64_t table_end_pc = table_start_pc + table_size;
569 return absl::InvalidArgumentError(absl::StrFormat(
570 "%s pointer table extends beyond canonical LoROM address space", path));
573 const uint64_t runtime_table_end =
574 static_cast<uint64_t
>(layout.
pointer_table & 0xFFFFu) + table_size;
575 if (runtime_table_end > 0x10000u) {
576 return absl::InvalidArgumentError(absl::StrFormat(
577 "%s bank16 pointer table crosses its runtime CPU bank", path));
584absl::StatusOr<std::unordered_map<DungeonStreamType, DungeonStreamLayout>>
586 std::unordered_map<DungeonStreamType, DungeonStreamLayout> layouts;
587 if (!root.
contains(
"dungeon_stream_regions")) {
591 const Json& section = root[
"dungeon_stream_regions"];
593 return absl::InvalidArgumentError(
594 "dungeon_stream_regions must be a non-empty object");
597 constexpr std::array<std::pair<const char*, DungeonStreamType>, 3> kStreams =
601 for (
const auto& item : section.
items()) {
602 const auto& key = item.key();
604 for (
const auto& entry : kStreams) {
605 if (key == entry.first) {
611 return absl::InvalidArgumentError(absl::StrFormat(
612 "dungeon_stream_regions contains unknown stream '%s'", key));
616 std::vector<NamedPcRange> occupied_ranges;
617 std::vector<NamedPcRange> allocation_ranges;
618 for (
const auto& [key, stream] : kStreams) {
626 const uint64_t pointer_width =
629 const uint64_t table_end_pc =
632 occupied_ranges.push_back({
static_cast<uint32_t
>(table_start_pc),
633 static_cast<uint32_t
>(table_end_pc),
634 absl::StrFormat(
"%s.pointer_table", key)});
636 for (
size_t index = 0; index < layout.
data_regions.size(); ++index) {
638 occupied_ranges.push_back(
640 absl::StrFormat(
"%s.data_regions[%zu]", key, index)});
644 allocation_ranges.push_back(
646 absl::StrFormat(
"%s.allocation_regions[%zu]", key, index)});
648 layouts.emplace(stream, std::move(layout));
652 "dungeon stream pointer/data ranges"));
654 "dungeon stream allocation ranges"));
682 std::ifstream file(filepath);
683 if (!file.is_open()) {
684 return absl::NotFoundError(
"Could not open manifest: " + filepath);
686 std::stringstream buffer;
687 buffer << file.rdbuf();
697 }
catch (
const std::exception& exc) {
698 return absl::InvalidArgumentError(
699 std::string(
"Failed to parse manifest JSON: ") + exc.what());
703 return absl::InvalidArgumentError(
"Hack manifest root must be an object");
713 std::unordered_map<DungeonStreamType, DungeonStreamLayout>
714 dungeon_stream_layouts;
722 if (root.
contains(
"build_pipeline")) {
723 auto& pipeline = root[
"build_pipeline"];
732 if (root.
contains(
"owned_banks") && root[
"owned_banks"].
contains(
"banks")) {
733 for (
auto& bank_json : root[
"owned_banks"][
"banks"]) {
735 uint32_t bank_u32 = 0;
737 ParseHexAddress(bank_json.value(
"bank",
"0x00")));
738 bank.
bank =
static_cast<uint8_t
>(bank_u32 & 0xFF);
739 if (bank.
bank >= 0x80) {
743 "bank_start",
"0x000000")));
745 "bank_end",
"0x000000")));
749 "ownership",
"asm_owned")));
757 for (
auto& tag_json : root[
"room_tags"][
"tags"]) {
759 uint32_t tag_id_u32 = 0;
761 ParseHexAddress(tag_json.value(
"tag_id",
"0x00")));
762 tag.
tag_id =
static_cast<uint8_t
>(tag_id_u32 & 0xFF);
764 ParseHexAddress(tag_json.value(
"address",
"0x000000")));
766 tag.
name = tag_json.value(
"name",
"");
767 tag.
purpose = tag_json.value(
"purpose",
"");
768 tag.
source = tag_json.value(
"source",
"");
770 tag.
enabled = tag_json.value(
"enabled",
true);
777 if (root.
contains(
"feature_flags") &&
778 root[
"feature_flags"].
contains(
"flags")) {
779 for (
auto& flag_json : root[
"feature_flags"][
"flags"]) {
781 flag.
name = flag_json.value(
"name",
"");
782 flag.
value = flag_json.value(
"value", 0);
783 flag.
enabled = flag_json.value(
"enabled",
false);
784 flag.
source = flag_json.value(
"source",
"");
792 for (
auto& var_json : root[
"sram"][
"variables"]) {
794 var.
name = var_json.value(
"name",
"");
796 ParseHexAddress(var_json.value(
"address",
"0x000000")));
797 var.
purpose = var_json.value(
"purpose",
"");
805 auto& msg = root[
"messages"];
806 if (!msg.is_object()) {
807 return absl::InvalidArgumentError(
"messages must be an object");
809 if (msg.contains(
"hook_address") && msg[
"hook_address"].is_string()) {
811 ParseHexAddress(msg[
"hook_address"].get<std::string>()));
815 if (msg.contains(
"data_start")) {
817 ParseHexAddress(msg.value(
"data_start",
"0x000000")));
821 if (msg.contains(
"data_end")) {
823 ParseHexAddress(msg.value(
"data_end",
"0x000000")));
826 if (msg.contains(
"vanilla_count")) {
829 ParseBoundedNonnegativeInteger(
830 msg[
"vanilla_count"],
"messages.vanilla_count",
831 static_cast<uint64_t
>(std::numeric_limits<int>::max())));
835 if (msg.contains(
"expanded_range")) {
836 auto& expanded = msg[
"expanded_range"];
837 if (!expanded.is_object()) {
838 return absl::InvalidArgumentError(
839 "messages.expanded_range must be an object");
841 uint32_t first_id = 0;
842 uint32_t last_id = 0;
844 ParseHexAddress(expanded.value(
"first",
"0x000")));
846 ParseHexAddress(expanded.value(
"last",
"0x000")));
848 static_cast<uint16_t
>(first_id & 0xFFFF);
850 static_cast<uint16_t
>(last_id & 0xFFFF);
851 if (expanded.contains(
"count")) {
852 constexpr uint64_t kMaximumExpandedMessageCount =
853 static_cast<uint64_t
>(std::numeric_limits<uint16_t>::max()) + 1;
855 ParseBoundedNonnegativeInteger(
856 expanded[
"count"],
"messages.expanded_range.count",
857 kMaximumExpandedMessageCount));
862 if (msg.contains(
"source")) {
863 const auto& source = msg[
"source"];
864 if (!source.is_object()) {
865 return absl::InvalidArgumentError(
"messages.source must be an object");
867 constexpr std::array<absl::string_view, 4> kSourceKeys = {
868 "format",
"version",
"canonical_bundle_path",
869 "generated_asm_include_path"};
870 for (
const auto& item : source.items()) {
871 if (std::find(kSourceKeys.begin(), kSourceKeys.end(), item.key()) ==
873 return absl::InvalidArgumentError(absl::StrFormat(
874 "messages.source contains unknown field '%s'", item.key()));
877 for (absl::string_view key : kSourceKeys) {
878 if (!source.contains(key)) {
879 return absl::InvalidArgumentError(
880 absl::StrFormat(
"messages.source.%s is required", key));
883 if (!source[
"format"].is_string() ||
884 source[
"format"].get<std::string>() !=
"yaze-message-bundle") {
885 return absl::InvalidArgumentError(
886 "messages.source.format must be 'yaze-message-bundle'");
888 int source_version = 0;
889 auto source_version_or = ParseBoundedNonnegativeInteger(
890 source[
"version"],
"messages.source.version",
891 static_cast<uint64_t
>(std::numeric_limits<int>::max()));
892 if (!source_version_or.ok() || *source_version_or != 1) {
893 return absl::InvalidArgumentError(
894 "messages.source.version must be integer 1");
896 source_version = *source_version_or;
897 if (!source[
"canonical_bundle_path"].is_string() ||
898 source[
"canonical_bundle_path"].get<std::string>().empty()) {
899 return absl::InvalidArgumentError(
900 "messages.source.canonical_bundle_path must be a non-empty "
903 if (!source[
"generated_asm_include_path"].is_string() ||
904 source[
"generated_asm_include_path"].get<std::string>().empty()) {
905 return absl::InvalidArgumentError(
906 "messages.source.generated_asm_include_path must be a non-empty "
910 .
format = source[
"format"].get<std::string>(),
911 .version = source_version,
912 .canonical_bundle_path =
913 source[
"canonical_bundle_path"].get<std::string>(),
914 .generated_asm_include_path =
915 source[
"generated_asm_include_path"].get<std::string>(),
925 return absl::OkStatus();
932 address = NormalizeSnesAddress(address);
944 const uint8_t bank =
static_cast<uint8_t
>((address >> 16) & 0xFF);
947 return bank_it->second.ownership;
961 uint32_t address)
const {
962 address = NormalizeSnesAddress(address);
966 const auto upper = std::upper_bound(
969 return addr < region.start;
972 for (
auto iter = std::make_reverse_iterator(upper);
974 if (address >= iter->start && address < iter->end) {
986 address = NormalizeSnesAddress(address);
987 const auto upper = std::upper_bound(
990 return addr < region.start;
996 return region.
start <= address && address < region.
end;
1000 uint8_t bank)
const {
1006 return std::nullopt;
1007 return iter->second.ownership;
1014 return iter->second.name;
1020 return std::nullopt;
1021 return iter->second;
1028 return iter->second.enabled;
1032 const std::vector<std::pair<uint32_t, uint32_t>>& ranges)
const {
1033 std::vector<WriteConflict> conflicts;
1038 for (
const auto& range : ranges) {
1039 const uint32_t start = NormalizeSnesAddress(range.first);
1040 const uint32_t end = NormalizeSnesAddress(range.second);
1048 std::vector<uint32_t> boundaries = {start, end};
1049 const uint64_t first_bank_boundary =
1050 (
static_cast<uint64_t
>(start) & 0xFF0000u) + 0x010000u;
1051 for (uint64_t boundary = first_bank_boundary; boundary < end;
1052 boundary += 0x010000u) {
1053 boundaries.push_back(
static_cast<uint32_t
>(boundary));
1055 auto add_range_boundaries = [start, end, &boundaries](
const auto& regions) {
1056 for (
const auto& region : regions) {
1057 if (region.start < end && start < region.end) {
1058 boundaries.push_back(std::max(start, region.start));
1059 boundaries.push_back(std::min(end, region.end));
1066 std::sort(boundaries.begin(), boundaries.end());
1067 boundaries.erase(std::unique(boundaries.begin(), boundaries.end()),
1070 bool previous_was_conflict =
false;
1072 std::string previous_module;
1073 for (
size_t index = 0; index + 1 < boundaries.size(); ++index) {
1074 const uint32_t segment_start = boundaries[index];
1075 if (segment_start >= boundaries[index + 1]) {
1080 if (!IsAsmOwned(ownership)) {
1081 previous_was_conflict =
false;
1089 protected_region !=
nullptr) {
1090 module = protected_region->module;
1093 const uint8_t bank =
static_cast<uint8_t
>((segment_start >> 16) & 0xFF);
1096 module = bank_it->second.ownership_note;
1100 if (!previous_was_conflict || ownership != previous_ownership ||
1101 module != previous_module) {
1102 conflicts.push_back({segment_start, ownership,
module});
1104 previous_was_conflict =
true;
1105 previous_ownership = ownership;
1106 previous_module = std::move(module);
1114 const std::vector<std::pair<uint32_t, uint32_t>>& pc_ranges)
const {
1119 std::vector<std::pair<uint32_t, uint32_t>> snes_ranges;
1120 snes_ranges.reserve(pc_ranges.size());
1122 for (
const auto& range : pc_ranges) {
1123 uint32_t pc_start = range.first;
1124 const uint32_t pc_end = range.second;
1125 if (pc_end <= pc_start) {
1131 while (pc_start < pc_end) {
1132 const uint32_t next_boundary = (pc_start & ~0x7FFFu) + 0x8000u;
1133 const uint32_t seg_end = std::min(pc_end, next_boundary);
1134 const uint32_t seg_len = seg_end - pc_start;
1135 const uint32_t snes_start =
PcToSnes(pc_start);
1136 const uint32_t snes_end = snes_start + seg_len;
1137 snes_ranges.emplace_back(snes_start, snes_end);
1149 return iter->second.name;
1168 namespace fs = std::filesystem;
1171 fs::path base(code_folder);
1174 fs::path planning = base /
"Docs" /
"Dev" /
"Planning";
1177 fs::path dungeons_path = planning /
"dungeons.json";
1178 if (fs::exists(dungeons_path)) {
1179 std::ifstream file(dungeons_path);
1180 if (file.is_open()) {
1181 std::stringstream buffer;
1182 buffer << file.rdbuf();
1186 for (
const auto& dj : root[
"dungeons"]) {
1188 entry.
id = dj.value(
"id",
"");
1189 entry.
name = dj.value(
"name",
"");
1193 if (dj.contains(
"rooms") && dj[
"rooms"].is_array()) {
1194 for (
const auto& rj : dj[
"rooms"]) {
1196 std::string id_str = rj.value(
"id",
"0x00");
1197 auto parsed = ParseHexAddress(id_str);
1198 room.
id = parsed.ok() ?
static_cast<int>(*parsed) : 0;
1199 room.
name = rj.value(
"name",
"");
1200 room.
floor = rj.value(
"floor",
"");
1202 rj.contains(
"grid_row") && rj.contains(
"grid_col");
1203 room.
grid_row = rj.value(
"grid_row", 0);
1204 room.
grid_col = rj.value(
"grid_col", 0);
1205 room.
type = rj.value(
"type",
"normal");
1206 room.
palette = rj.value(
"palette", 0);
1207 room.
blockset = rj.value(
"blockset", 0);
1208 room.
spriteset = rj.value(
"spriteset", 0);
1209 room.
tag1 =
static_cast<uint8_t
>(rj.value(
"tag1", 0));
1210 room.
tag2 =
static_cast<uint8_t
>(rj.value(
"tag2", 0));
1211 entry.
rooms.push_back(std::move(room));
1216 if (dj.contains(
"stairs") && dj[
"stairs"].is_array()) {
1217 for (
const auto& sj : dj[
"stairs"]) {
1219 std::string from_str = sj.value(
"from",
"0x00");
1220 std::string to_str = sj.value(
"to",
"0x00");
1221 auto from_parsed = ParseHexAddress(from_str);
1222 auto to_parsed = ParseHexAddress(to_str);
1224 from_parsed.ok() ?
static_cast<int>(*from_parsed) : 0;
1226 to_parsed.ok() ?
static_cast<int>(*to_parsed) : 0;
1227 conn.
label = sj.value(
"label",
"");
1228 entry.
stairs.push_back(std::move(conn));
1233 if (dj.contains(
"holewarps") && dj[
"holewarps"].is_array()) {
1234 for (
const auto& hj : dj[
"holewarps"]) {
1236 std::string from_str = hj.value(
"from",
"0x00");
1237 std::string to_str = hj.value(
"to",
"0x00");
1238 auto from_parsed = ParseHexAddress(from_str);
1239 auto to_parsed = ParseHexAddress(to_str);
1241 from_parsed.ok() ?
static_cast<int>(*from_parsed) : 0;
1243 to_parsed.ok() ?
static_cast<int>(*to_parsed) : 0;
1244 conn.
label = hj.value(
"label",
"");
1245 entry.
holewarps.push_back(std::move(conn));
1250 if (dj.contains(
"doors") && dj[
"doors"].is_array()) {
1251 for (
const auto& doorj : dj[
"doors"]) {
1253 std::string from_str = doorj.value(
"from",
"0x00");
1254 std::string to_str = doorj.value(
"to",
"0x00");
1255 auto from_parsed = ParseHexAddress(from_str);
1256 auto to_parsed = ParseHexAddress(to_str);
1258 from_parsed.ok() ?
static_cast<int>(*from_parsed) : 0;
1260 to_parsed.ok() ?
static_cast<int>(*to_parsed) : 0;
1261 conn.
label = doorj.value(
"label",
"");
1262 conn.
direction = doorj.value(
"direction",
"");
1263 entry.
doors.push_back(std::move(conn));
1270 }
catch (
const std::exception& exc) {
1271 LOG_WARN(
"HackManifest",
"Failed to parse dungeons.json: %s",
1278 fs::path overworld_path = planning /
"overworld.json";
1279 if (fs::exists(overworld_path)) {
1280 std::ifstream file(overworld_path);
1281 if (file.is_open()) {
1282 std::stringstream buffer;
1283 buffer << file.rdbuf();
1287 for (
const auto& aj : root[
"areas"]) {
1289 std::string id_str = aj.value(
"area_id",
"0x00");
1290 auto parsed = ParseHexAddress(id_str);
1291 area.
area_id = parsed.ok() ?
static_cast<int>(*parsed) : 0;
1292 area.
name = aj.value(
"name",
"");
1293 area.
world = aj.value(
"world",
"");
1294 area.
grid_row = aj.value(
"grid_row", 0);
1295 area.
grid_col = aj.value(
"grid_col", 0);
1299 }
catch (
const std::exception& exc) {
1300 LOG_WARN(
"HackManifest",
"Failed to parse overworld.json: %s",
1309 fs::path unified_path = planning /
"oracle_resource_labels.json";
1310 fs::path legacy_path = planning /
"oracle_room_labels.json";
1312 auto normalize_label_id = [](
const std::string& raw) -> std::string {
1315 std::string s = raw;
1316 while (!s.empty() && std::isspace(
static_cast<unsigned char>(s.front()))) {
1319 while (!s.empty() && std::isspace(
static_cast<unsigned char>(s.back()))) {
1327 if (s.size() >= 2 && s[0] ==
'0' && (s[1] ==
'x' || s[1] ==
'X')) {
1337 const unsigned long value = std::stoul(s, &idx, base);
1338 if (idx != s.size()) {
1341 if (value >
static_cast<unsigned long>(std::numeric_limits<int>::max())) {
1344 return std::to_string(
static_cast<int>(value));
1350 if (fs::exists(unified_path)) {
1351 std::ifstream file(unified_path);
1352 if (file.is_open()) {
1353 std::stringstream buffer;
1354 buffer << file.rdbuf();
1358 const std::vector<std::string> label_types = {
1359 "room",
"sprite",
"item",
"entrance",
"overworld_map",
"music"};
1360 for (
const auto& type_key : label_types) {
1362 for (
const auto& [key, value] : root[type_key].
items()) {
1363 if (value.is_string()) {
1364 const std::string normalized_key = normalize_label_id(key);
1367 value.get<std::string>();
1372 }
catch (
const std::exception& exc) {
1374 "Failed to parse oracle_resource_labels.json: %s", exc.what());
1377 }
else if (fs::exists(legacy_path)) {
1379 std::ifstream file(legacy_path);
1380 if (file.is_open()) {
1381 std::stringstream buffer;
1382 buffer << file.rdbuf();
1385 if (root.
contains(
"resource_labels") &&
1386 root[
"resource_labels"].
contains(
"room")) {
1387 for (
const auto& [key, value] :
1388 root[
"resource_labels"][
"room"].
items()) {
1389 const std::string normalized_key = normalize_label_id(key);
1391 value.get<std::string>();
1394 }
catch (
const std::exception& exc) {
1395 LOG_WARN(
"HackManifest",
"Failed to parse oracle_room_labels.json: %s",
1406 size_t dungeon_room_labels = 0;
1408 for (
const auto& room : dungeon.rooms) {
1409 if (room.id >= 0 && !room.name.empty()) {
1412 ++dungeon_room_labels;
1416 if (dungeon_room_labels > 0) {
1418 "Mirrored %zu dungeon room names into project resource labels",
1419 dungeon_room_labels);
1423 fs::path story_events_path = planning /
"story_events.json";
1424 if (fs::exists(story_events_path)) {
1427 if (story_status.ok()) {
1437 LOG_DEBUG(
"HackManifest",
"Loaded story events: %zu nodes, %zu edges",
1441 LOG_WARN(
"HackManifest",
"Failed to load story_events.json: %s",
1442 std::string(story_status.message()).c_str());
1446 size_t total_labels = 0;
1448 total_labels += labels.size();
1454 "Loaded project registry: %zu dungeons, %zu overworld areas, "
1455 "%zu resource labels (%zu types)",
1461 return absl::OkStatus();
static Json parse(const std::string &)
bool contains(const std::string &) const
T value(const std::string &, const T &def) const
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_
void ClearOracleProgressionState()
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.
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,...)
#define LOG_WARN(category, format,...)
#define ASSIGN_OR_RETURN(type_variable_name, expression)
absl::StatusOr< AddressOwnership > ParseOwnership(const std::string &str)
constexpr uint64_t kCanonicalLoRomSize
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)
uint32_t NormalizeSnesAddress(uint32_t address)
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.
uint32_t PcToSnes(uint32_t addr)
uint32_t SnesToPc(uint32_t addr) noexcept
#define RETURN_IF_ERROR(expr)
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
uint16_t last_expanded_id
uint16_t first_expanded_id
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
StoryEventGraph story_events
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.
std::vector< ProtectedRegion > regions