Add "support" for BYML v1, and check for MK8 path nodes (#27)

Author: fruityloops1

Diff for: .gitignore

@@ -8,6 +8,7 @@ dist/
 build/
 .mypy_cache/
 .idea/
+.cache/
 .vscode/
 .benchmarks/
 
@@ -22,6 +23,7 @@ build/
 perf.data
 perf.data.old
 .gdb_history
+compile_commands.json
 
 test/files/TwnObj_HyruleCastle_A.Tex.sbfres
 

Diff for: readme.rst

@@ -12,7 +12,7 @@ Features
 Currently, oead only handles very common formats that are extensively used in recent games such as *Breath of the Wild* and *Super Mario Odyssey*.
 
 * `AAMP <https://zeldamods.org/wiki/AAMP>`_ (binary parameter archive): Only version 2 is supported.
-* `BYML <https://zeldamods.org/wiki/BYML>`_ (binary YAML): Versions 2, 3, and 4 are supported.
+* `BYML <https://zeldamods.org/wiki/BYML>`_ (binary YAML): Versions 1, 2, 3, and 4 are supported.
 * `SARC <https://zeldamods.org/wiki/SARC>`_ (archive)
 * `Yaz0 <https://zeldamods.org/wiki/Yaz0>`_ (compression algorithm)
 

Diff for: src/byml.cpp

@@ -39,7 +39,7 @@ namespace byml {
 struct ResHeader {
   /// “BY” (big endian) or “YB” (little endian).
   std::array<char, 2> magic;
-  /// Format version (2 or 3).
+  /// Format version (1-4).
   u16 version;
   /// Offset to the hash key table, relative to start (usually 0x010)
   /// May be 0 if no hash nodes are used. Must be a string table node (0xc2).
@@ -59,6 +59,7 @@ enum class NodeType : u8 {
   Array = 0xc0,
   Hash = 0xc1,
   StringTable = 0xc2,
+  PathTable = 0xc3, // Unsupported
   Bool = 0xd0,
   Int = 0xd1,
   Float = 0xd2,
@@ -94,7 +95,7 @@ constexpr bool IsNonInlineType(T type) {
 }
 
 constexpr bool IsValidVersion(int version) {
-  return 2 <= version && version <= 4;
+  return 1 <= version && version <= 4;
 }
 
 class StringTableParser {
@@ -153,7 +154,19 @@ class Parser {
         m_reader, *m_reader.Read<u32>(offsetof(ResHeader, hash_key_table_offset)));
     m_string_table =
         StringTableParser(m_reader, *m_reader.Read<u32>(offsetof(ResHeader, string_table_offset)));
-    m_root_node_offset = *m_reader.Read<u32>(offsetof(ResHeader, root_node_offset));
+        
+    // In MK8 byamls, there is an extra offset to a path table here
+    u32 root_node_offset = *m_reader.Read<u32>(offsetof(ResHeader, root_node_offset));
+    size_t header_end = m_reader.Tell();
+    if (root_node_offset != 0)
+    {
+      const auto type = m_reader.Read<NodeType>(root_node_offset);
+      if (type == NodeType::PathTable)
+        throw UnsupportedError("Path nodes unsupported");
+    }
+
+    m_root_node_offset = root_node_offset;
+    m_reader.Seek(header_end);
   }
 
   Byml Parse() {

Diff for: src/include/oead/errors.h

@@ -33,4 +33,9 @@ struct InvalidDataError : std::runtime_error {
   using std::runtime_error::runtime_error;
 };
 
+/// Thrown when unsupported feature is detected.
+struct UnsupportedError : std::runtime_error {
+  using std::runtime_error::runtime_error;
+};
+
 }  // namespace oead