13#include "absl/status/statusor.h"
14#include "absl/strings/str_format.h"
26 return "vanilla_safe";
28 return "hook_patched";
34 return "asm_expansion";
45absl::StatusOr<uint32_t> ParseHexAddress(absl::string_view str) {
52 return absl::InvalidArgumentError(
53 absl::StrFormat(
"Invalid hex address '%s'", str));
59 if (str ==
"vanilla_safe")
61 if (str ==
"hook_patched")
63 if (str ==
"asm_owned")
67 if (str ==
"asm_expansion")
73 return absl::InvalidArgumentError(
74 absl::StrFormat(
"Unknown ownership string '%s'", str));
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));
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));
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));
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));
104 return absl::OkStatus();
126 if (address >= 0x800000 && address <= 0xFFFFFF) {
147 const std::string& field,
150 return absl::InvalidArgumentError(
151 absl::StrFormat(
"%s must be a hexadecimal string", field));
154 const std::string input = value.
get<std::string>();
155 size_t digits_begin = 0;
156 if (!input.empty() && input.front() ==
'$') {
158 }
else if (input.size() >= 2 && input[0] ==
'0' &&
159 (input[1] ==
'x' || input[1] ==
'X')) {
162 if (digits_begin == input.size()) {
163 return absl::InvalidArgumentError(
164 absl::StrFormat(
"%s has no hexadecimal digits", field));
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));
175 return absl::InvalidArgumentError(absl::StrFormat(
176 "%s contains an invalid hexadecimal value '%s'", field, input));
178 if (parsed > maximum) {
179 return absl::InvalidArgumentError(
180 absl::StrFormat(
"%s value '%s' exceeds 0x%X", field, input, maximum));
182 return static_cast<uint32_t
>(parsed);
186 if (!root.
contains(
"manifest_version")) {
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");
200 version =
static_cast<uint64_t
>(signed_version);
202 return absl::InvalidArgumentError(
203 "manifest_version must be a non-negative integer");
206 if (version >
static_cast<uint64_t
>(std::numeric_limits<int>::max())) {
207 return absl::InvalidArgumentError(
"manifest_version is too large");
209 return static_cast<int>(version);
213 absl::string_view field,
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));
224 parsed =
static_cast<uint64_t
>(signed_value);
226 return absl::InvalidArgumentError(
227 absl::StrFormat(
"%s must be a non-negative integer", field));
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));
234 return static_cast<int>(parsed);
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));
245 uint32_t address = 0;
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));
254 if ((address & 0xFFFF) < 0x8000) {
255 return absl::InvalidArgumentError(absl::StrFormat(
256 "%s.%s must be a mapped LoROM address (low word >= 0x8000)", path,
260 return absl::InvalidArgumentError(absl::StrFormat(
261 "%s.%s is not convertible to a canonical LoROM address", path, key));
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));
275 const Json& value =
object[kField];
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));
285 count =
static_cast<uint64_t
>(signed_count);
287 return absl::InvalidArgumentError(
288 absl::StrFormat(
"%s.%s must be an integer", path, kField));
291 if (count == 0 || count > kMaxDungeonPointerCount) {
292 return absl::InvalidArgumentError(absl::StrFormat(
293 "%s.%s must be in [1, %u]", path, kField, kMaxDungeonPointerCount));
295 return static_cast<uint32_t
>(count);
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));
305 const std::string value =
object[kField].get<std::string>();
306 if (value ==
"long24") {
309 if (value ==
"bank16") {
312 return absl::InvalidArgumentError(
313 absl::StrFormat(
"%s.%s has unknown encoding '%s'", path, kField, value));
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));
323 const std::string value =
object[kField].get<std::string>();
324 if (value ==
"copy_on_write") {
327 if (value ==
"repack_all") {
330 return absl::InvalidArgumentError(
331 absl::StrFormat(
"%s.%s has unknown strategy '%s'", path, kField, value));
341 const std::string& description) {
342 std::sort(ranges.begin(), ranges.end(),
344 return lhs.start < rhs.start ||
345 (lhs.start == rhs.start && lhs.end < rhs.end);
347 if (ranges.empty()) {
348 return absl::OkStatus();
352 for (
size_t index = 1; index < ranges.size(); ++index) {
355 return absl::InvalidArgumentError(
356 absl::StrFormat(
"%s overlap: %s conflicts with %s", description,
359 if (current.
end > active.
end) {
363 return absl::OkStatus();
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));
374 std::vector<SnesAddressRange> ranges;
375 std::vector<NamedPcRange> pc_ranges;
376 ranges.reserve(
object[key].size());
377 pc_ranges.reserve(
object[key].size());
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));
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",
400 ranges.push_back(range);
401 pc_ranges.push_back({pc_start, pc_end, range_path});
406 std::sort(ranges.begin(), ranges.end(),
408 return lhs.start < rhs.start;
414 const Json& root,
int manifest_version) {
415 constexpr const char* kSection =
"editor_managed_regions";
417 return std::vector<SnesAddressRange>{};
419 if (manifest_version < 3) {
420 return absl::InvalidArgumentError(
421 "editor_managed_regions requires manifest_version 3 or newer");
424 const Json& section = root[kSection];
426 return absl::InvalidArgumentError(
427 "editor_managed_regions must be a non-empty object");
438 const std::string& key,
439 const std::string& path,
440 bool require_mapped_lorom) {
441 if (require_mapped_lorom) {
444 if (!
object.contains(key)) {
445 return absl::InvalidArgumentError(
446 absl::StrFormat(
"%s.%s is required", path, key));
449 uint32_t address = 0;
456 const Json& root,
int manifest_version) {
458 constexpr const char* kSection =
"protected_regions";
463 const Json& section = root[kSection];
465 return absl::InvalidArgumentError(
"protected_regions must be an object");
468 return absl::InvalidArgumentError(
469 "protected_regions.regions must be an array");
473 parsed.
regions.reserve(section[
"regions"].size());
478 const bool require_mapped_lorom = manifest_version >= 3;
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));
491 require_mapped_lorom));
493 require_mapped_lorom));
496 return absl::InvalidArgumentError(absl::StrFormat(
497 "%s must be a non-empty half-open range with end > start", path));
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));
510 return lhs.start < rhs.start;
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));
542 if (!
json.contains(
"pointer_bank")) {
543 return absl::InvalidArgumentError(
544 absl::StrFormat(
"%s.pointer_bank is required for bank16", path));
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));
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;
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 "
571 }
else if (
json.contains(
"pointer_bank")) {
572 return absl::InvalidArgumentError(
573 absl::StrFormat(
"%s.pointer_bank is not allowed for long24", path));
577 const bool contained =
580 return PcRangeContains(data, allocation);
583 return absl::InvalidArgumentError(absl::StrFormat(
584 "%s allocation range [0x%06X, 0x%06X) is not fully contained in "
586 path, allocation.start, allocation.end));
590 const uint64_t pointer_width =
593 const uint64_t table_size =
595 const uint64_t table_end_pc = table_start_pc + table_size;
598 return absl::InvalidArgumentError(absl::StrFormat(
599 "%s pointer table extends beyond canonical LoROM address space", path));
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));
613absl::StatusOr<std::unordered_map<DungeonStreamType, DungeonStreamLayout>>
615 std::unordered_map<DungeonStreamType, DungeonStreamLayout> layouts;
616 if (!root.
contains(
"dungeon_stream_regions")) {
620 const Json& section = root[
"dungeon_stream_regions"];
622 return absl::InvalidArgumentError(
623 "dungeon_stream_regions must be a non-empty object");
626 constexpr std::array<std::pair<const char*, DungeonStreamType>, 3> kStreams =
630 for (
const auto& item : section.
items()) {
631 const auto& key = item.key();
633 for (
const auto& entry : kStreams) {
634 if (key == entry.first) {
640 return absl::InvalidArgumentError(absl::StrFormat(
641 "dungeon_stream_regions contains unknown stream '%s'", key));
645 std::vector<NamedPcRange> occupied_ranges;
646 std::vector<NamedPcRange> allocation_ranges;
647 for (
const auto& [key, stream] : kStreams) {
655 const uint64_t pointer_width =
658 const uint64_t table_end_pc =
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)});
665 for (
size_t index = 0; index < layout.
data_regions.size(); ++index) {
667 occupied_ranges.push_back(
669 absl::StrFormat(
"%s.data_regions[%zu]", key, index)});
673 allocation_ranges.push_back(
675 absl::StrFormat(
"%s.allocation_regions[%zu]", key, index)});
677 layouts.emplace(stream, std::move(layout));
681 "dungeon stream pointer/data ranges"));
683 "dungeon stream allocation ranges"));
712 std::ifstream file(filepath);
713 if (!file.is_open()) {
714 return absl::NotFoundError(
"Could not open manifest: " + filepath);
716 std::stringstream buffer;
717 buffer << file.rdbuf();
727 }
catch (
const std::exception& exc) {
728 return absl::InvalidArgumentError(
729 std::string(
"Failed to parse manifest JSON: ") + exc.what());
733 return absl::InvalidArgumentError(
"Hack manifest root must be an object");
743 std::unordered_map<DungeonStreamType, DungeonStreamLayout>
744 dungeon_stream_layouts;
752 if (root.
contains(
"build_pipeline")) {
753 auto& pipeline = root[
"build_pipeline"];
762 if (root.
contains(
"owned_banks") && root[
"owned_banks"].
contains(
"banks")) {
763 for (
auto& bank_json : root[
"owned_banks"][
"banks"]) {
765 uint32_t bank_u32 = 0;
767 ParseHexAddress(bank_json.value(
"bank",
"0x00")));
768 bank.
bank =
static_cast<uint8_t
>(bank_u32 & 0xFF);
769 if (bank.
bank >= 0x80) {
773 "bank_start",
"0x000000")));
775 "bank_end",
"0x000000")));
779 "ownership",
"asm_owned")));
787 for (
auto& tag_json : root[
"room_tags"][
"tags"]) {
789 uint32_t tag_id_u32 = 0;
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")));
796 tag.
name = tag_json.value(
"name",
"");
797 tag.
purpose = tag_json.value(
"purpose",
"");
798 tag.
source = tag_json.value(
"source",
"");
800 tag.
enabled = tag_json.value(
"enabled",
true);
807 if (root.
contains(
"feature_flags") &&
808 root[
"feature_flags"].
contains(
"flags")) {
809 for (
auto& flag_json : root[
"feature_flags"][
"flags"]) {
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",
"");
822 for (
auto& var_json : root[
"sram"][
"variables"]) {
824 var.
name = var_json.value(
"name",
"");
826 ParseHexAddress(var_json.value(
"address",
"0x000000")));
827 var.
purpose = var_json.value(
"purpose",
"");
835 auto& msg = root[
"messages"];
836 if (!msg.is_object()) {
837 return absl::InvalidArgumentError(
"messages must be an object");
839 if (msg.contains(
"hook_address") && msg[
"hook_address"].is_string()) {
841 ParseHexAddress(msg[
"hook_address"].get<std::string>()));
845 if (msg.contains(
"data_start")) {
847 ParseHexAddress(msg.value(
"data_start",
"0x000000")));
851 if (msg.contains(
"data_end")) {
853 ParseHexAddress(msg.value(
"data_end",
"0x000000")));
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())));
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");
871 uint32_t first_id = 0;
872 uint32_t last_id = 0;
874 ParseHexAddress(expanded.value(
"first",
"0x000")));
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));
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");
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()) ==
903 return absl::InvalidArgumentError(absl::StrFormat(
904 "messages.source contains unknown field '%s'", item.key()));
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));
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'");
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");
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 "
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 "
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>(),
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");
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()));
964 if (!minecart_tracks.contains(
"source")) {
965 return absl::InvalidArgumentError(
966 "minecart_tracks.source is required when minecart_tracks is present");
969 const auto& source = minecart_tracks[
"source"];
970 if (!source.is_object()) {
971 return absl::InvalidArgumentError(
972 "minecart_tracks.source must be an object");
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()) ==
979 return absl::InvalidArgumentError(absl::StrFormat(
980 "minecart_tracks.source contains unknown field '%s'", item.key()));
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));
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'");
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");
1002 if (!source[
"path"].is_string()) {
1003 return absl::InvalidArgumentError(
1004 "minecart_tracks.source.path must be a string");
1006 const std::string source_path = source[
"path"].get<std::string>();
1008 source_path,
"minecart_tracks.source.path"));
1010 .
format = source[
"format"].get<std::string>(),
1011 .version = *source_version_or,
1012 .path = source_path,
1021 return absl::OkStatus();
1028 address = NormalizeSnesAddress(address);
1040 const uint8_t bank =
static_cast<uint8_t
>((address >> 16) & 0xFF);
1043 return bank_it->second.ownership;
1057 uint32_t address)
const {
1058 address = NormalizeSnesAddress(address);
1062 const auto upper = std::upper_bound(
1065 return addr < region.start;
1068 for (
auto iter = std::make_reverse_iterator(upper);
1070 if (address >= iter->start && address < iter->end) {
1082 address = NormalizeSnesAddress(address);
1083 const auto upper = std::upper_bound(
1086 return addr < region.start;
1092 return region.
start <= address && address < region.
end;
1096 uint8_t bank)
const {
1102 return std::nullopt;
1103 return iter->second.ownership;
1110 return iter->second.name;
1116 return std::nullopt;
1117 return iter->second;
1124 return iter->second.enabled;
1128 const std::vector<std::pair<uint32_t, uint32_t>>& ranges)
const {
1129 std::vector<WriteConflict> conflicts;
1134 for (
const auto& range : ranges) {
1135 const uint32_t start = NormalizeSnesAddress(range.first);
1136 const uint32_t end = NormalizeSnesAddress(range.second);
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));
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));
1162 std::sort(boundaries.begin(), boundaries.end());
1163 boundaries.erase(std::unique(boundaries.begin(), boundaries.end()),
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]) {
1176 if (!IsAsmOwned(ownership)) {
1177 previous_was_conflict =
false;
1185 protected_region !=
nullptr) {
1186 module = protected_region->module;
1189 const uint8_t bank =
static_cast<uint8_t
>((segment_start >> 16) & 0xFF);
1192 module = bank_it->second.ownership_note;
1196 if (!previous_was_conflict || ownership != previous_ownership ||
1197 module != previous_module) {
1198 conflicts.push_back({segment_start, ownership,
module});
1200 previous_was_conflict =
true;
1201 previous_ownership = ownership;
1202 previous_module = std::move(module);
1210 const std::vector<std::pair<uint32_t, uint32_t>>& pc_ranges)
const {
1215 std::vector<std::pair<uint32_t, uint32_t>> snes_ranges;
1216 snes_ranges.reserve(pc_ranges.size());
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) {
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);
1245 return iter->second.name;
1264 namespace fs = std::filesystem;
1267 fs::path base(code_folder);
1270 fs::path planning = base /
"Docs" /
"Dev" /
"Planning";
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();
1282 for (
const auto& dj : root[
"dungeons"]) {
1284 entry.
id = dj.value(
"id",
"");
1285 entry.
name = dj.value(
"name",
"");
1289 if (dj.contains(
"rooms") && dj[
"rooms"].is_array()) {
1290 for (
const auto& rj : dj[
"rooms"]) {
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",
"");
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));
1312 if (dj.contains(
"stairs") && dj[
"stairs"].is_array()) {
1313 for (
const auto& sj : dj[
"stairs"]) {
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);
1320 from_parsed.ok() ?
static_cast<int>(*from_parsed) : 0;
1322 to_parsed.ok() ?
static_cast<int>(*to_parsed) : 0;
1323 conn.
label = sj.value(
"label",
"");
1324 entry.
stairs.push_back(std::move(conn));
1329 if (dj.contains(
"holewarps") && dj[
"holewarps"].is_array()) {
1330 for (
const auto& hj : dj[
"holewarps"]) {
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);
1337 from_parsed.ok() ?
static_cast<int>(*from_parsed) : 0;
1339 to_parsed.ok() ?
static_cast<int>(*to_parsed) : 0;
1340 conn.
label = hj.value(
"label",
"");
1341 entry.
holewarps.push_back(std::move(conn));
1346 if (dj.contains(
"doors") && dj[
"doors"].is_array()) {
1347 for (
const auto& doorj : dj[
"doors"]) {
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);
1354 from_parsed.ok() ?
static_cast<int>(*from_parsed) : 0;
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));
1366 }
catch (
const std::exception& exc) {
1367 LOG_WARN(
"HackManifest",
"Failed to parse dungeons.json: %s",
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();
1383 for (
const auto& aj : root[
"areas"]) {
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);
1395 }
catch (
const std::exception& exc) {
1396 LOG_WARN(
"HackManifest",
"Failed to parse overworld.json: %s",
1405 fs::path unified_path = planning /
"oracle_resource_labels.json";
1406 fs::path legacy_path = planning /
"oracle_room_labels.json";
1408 auto normalize_label_id = [](
const std::string& raw) -> std::string {
1411 std::string s = raw;
1412 while (!s.empty() && std::isspace(
static_cast<unsigned char>(s.front()))) {
1415 while (!s.empty() && std::isspace(
static_cast<unsigned char>(s.back()))) {
1423 if (s.size() >= 2 && s[0] ==
'0' && (s[1] ==
'x' || s[1] ==
'X')) {
1433 const unsigned long value = std::stoul(s, &idx, base);
1434 if (idx != s.size()) {
1437 if (value >
static_cast<unsigned long>(std::numeric_limits<int>::max())) {
1440 return std::to_string(
static_cast<int>(value));
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();
1454 const std::vector<std::string> label_types = {
1455 "room",
"sprite",
"item",
"entrance",
"overworld_map",
"music"};
1456 for (
const auto& type_key : label_types) {
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);
1463 value.get<std::string>();
1468 }
catch (
const std::exception& exc) {
1470 "Failed to parse oracle_resource_labels.json: %s", exc.what());
1473 }
else if (fs::exists(legacy_path)) {
1475 std::ifstream file(legacy_path);
1476 if (file.is_open()) {
1477 std::stringstream buffer;
1478 buffer << file.rdbuf();
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);
1487 value.get<std::string>();
1490 }
catch (
const std::exception& exc) {
1491 LOG_WARN(
"HackManifest",
"Failed to parse oracle_room_labels.json: %s",
1502 size_t dungeon_room_labels = 0;
1504 for (
const auto& room : dungeon.rooms) {
1505 if (room.id >= 0 && !room.name.empty()) {
1508 ++dungeon_room_labels;
1512 if (dungeon_room_labels > 0) {
1514 "Mirrored %zu dungeon room names into project resource labels",
1515 dungeon_room_labels);
1519 fs::path story_events_path = planning /
"story_events.json";
1520 if (fs::exists(story_events_path)) {
1523 if (story_status.ok()) {
1533 LOG_DEBUG(
"HackManifest",
"Loaded story events: %zu nodes, %zu edges",
1537 LOG_WARN(
"HackManifest",
"Failed to load story_events.json: %s",
1538 std::string(story_status.message()).c_str());
1542 size_t total_labels = 0;
1544 total_labels += labels.size();
1550 "Loaded project registry: %zu dungeons, %zu overworld areas, "
1551 "%zu resource labels (%zu types)",
1557 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.
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,...)
#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::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)
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.
bool ParseHexString(absl::string_view str, uint64_t *out)
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
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
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