binary.hpp

Go to the documentation of this file.

#pragma once

 
#include <cstdint>
#include <type_traits>
 
#include <wowlib/formats/common/fourcc.hpp>
 
namespace wowlib::db::wdc {
  inline constexpr std::uint32_t Wdc1Magic = formats::fourcc("WDC1", formats::FourCCEndian::Forward);

  inline constexpr std::uint32_t Wdc3Magic = formats::fourcc("WDC3", formats::FourCCEndian::Forward);

  inline constexpr std::uint32_t Wdc4Magic = formats::fourcc("WDC4", formats::FourCCEndian::Forward);

  inline constexpr std::uint32_t Wdc5Magic = formats::fourcc("WDC5", formats::FourCCEndian::Forward);

  constexpr bool isWdcMagic(std::uint32_t magic) {
    return magic == Wdc1Magic || magic == Wdc3Magic || magic == Wdc4Magic || magic == Wdc5Magic;
  }

  enum WdcFlags : std::uint16_t {
    WdcFlagSparse = 0x01, 
    WdcFlagSecondary = 0x02, 
    WdcFlagNoninlineId = 0x04 
  };

  struct Wdc1Header {
    std::uint32_t magic = Wdc1Magic;
    std::uint32_t recordCount = 0;
    std::uint32_t fieldCount = 0; 
    std::uint32_t recordSize = 0; 
    std::uint32_t stringTableSize = 0;
    std::uint32_t tableHash = 0; 
    std::uint32_t layoutHash = 0; 
    std::uint32_t minId = 0;
    std::uint32_t maxId = 0;
    std::uint32_t locale = 0;
    std::uint32_t copyTableSize = 0; 
    std::uint16_t flags = 0; 
    std::uint16_t idIndex = 0; 
    std::uint32_t totalFieldCount = 0; 
    std::uint32_t bitpackedDataOffset = 0; 
    std::uint32_t lookupColumnCount = 0;
    std::uint32_t offsetMapOffset = 0; 
    std::uint32_t idListSize = 0; 
    std::uint32_t fieldStorageInfoSize = 0; 
    std::uint32_t commonDataSize = 0;
    std::uint32_t palletDataSize = 0;
    std::uint32_t relationshipDataSize = 0;
  };
 
  static_assert(sizeof(Wdc1Header) == 84 && std::is_trivially_copyable_v<Wdc1Header>);

  struct Wdc3Header {
    std::uint32_t magic = Wdc3Magic;
    std::uint32_t recordCount = 0; 
    std::uint32_t fieldCount = 0; 
    std::uint32_t recordSize = 0; 
    std::uint32_t stringTableSize = 0; 
    std::uint32_t tableHash = 0; 
    std::uint32_t layoutHash = 0; 
    std::uint32_t minId = 0;
    std::uint32_t maxId = 0;
    std::uint32_t locale = 0;
    std::uint16_t flags = 0; 
    std::uint16_t idIndex = 0; 
    std::uint32_t totalFieldCount = 0; 
    std::uint32_t bitpackedDataOffset = 0; 
    std::uint32_t lookupColumnCount = 0;
    std::uint32_t fieldStorageInfoSize = 0; 
    std::uint32_t commonDataSize = 0;
    std::uint32_t palletDataSize = 0;
    std::uint32_t sectionCount = 0;
  };
 
  static_assert(sizeof(Wdc3Header) == 72 && std::is_trivially_copyable_v<Wdc3Header>);

  struct Wdc5HeaderPrefix {
    std::uint32_t versionNum = 5;
    char schemaString[128] = {};
  };
 
  static_assert(sizeof(Wdc5HeaderPrefix) == 132 && std::is_trivially_copyable_v<Wdc5HeaderPrefix>);

  struct Wdc3SectionHeader {
    std::uint64_t tactKeyHash = 0; 
    std::uint32_t fileOffset = 0; 
    std::uint32_t recordCount = 0; 
    std::uint32_t stringTableSize = 0; 
    std::uint32_t offsetRecordsEnd = 0; 
    std::uint32_t idListSize = 0; 
    std::uint32_t relationshipDataSize = 0; 
    std::uint32_t offsetMapIdCount = 0; 
    std::uint32_t copyTableCount = 0; 
  };
 
  static_assert(sizeof(Wdc3SectionHeader) == 40 && std::is_trivially_copyable_v<Wdc3SectionHeader>);

  struct WdcFieldStructure {
    std::int16_t size = 0;
    std::uint16_t position = 0;
  };
 
  static_assert(sizeof(WdcFieldStructure) == 4);

  enum class WdcCompression : std::uint32_t {
    None = 0, 
    Bitpacked = 1, 
    CommonData = 2, 
    Pallet = 3, 
    PalletArray = 4, 
    BitpackedSigned = 5 
  };

  struct WdcFieldStorage {
    std::uint16_t fieldOffsetBits = 0; 
    std::uint16_t fieldSizeBits = 0; 
    std::uint32_t additionalDataSize = 0; 
    WdcCompression storageType = WdcCompression::None;
    std::uint32_t val1 = 0; 
    std::uint32_t val2 = 0; 
    std::uint32_t val3 = 0; 
  };
 
  static_assert(sizeof(WdcFieldStorage) == 24 && std::is_trivially_copyable_v<WdcFieldStorage>);
}