expansion.hpp

Go to the documentation of this file.

#pragma once

 
#include <array>
#include <meta>
#include <optional>
 
#include <welder/vocabulary.hpp>
 
#include <wowlib/core/client_version.hpp>
 
namespace wowlib {
  enum class [[
      =welder::weld,
      =welder::doc(R"(
        The expansion a client belongs to, in release order. The enumerable
        counterpart of a full ClientVersion: versioned format classes and
        factories are keyed on it (each enumerator maps to the
        last-minor-of-major release in the versions namespace).)")
    ]] Expansion {
    Vanilla,
    Tbc,
    Wotlk,
    Cata,
    Mop,
    Wod,
    Legion,
    Bfa,
    Shadowlands,
    Dragonflight,
    TheWarWithin
  };
 
  namespace detail {
    inline constexpr std::array ExpansionVersions{
      versions::Vanilla,
      versions::Tbc,
      versions::Wotlk,
      versions::Cata,
      versions::Mop,
      versions::Wod,
      versions::Legion,
      versions::Bfa,
      versions::Shadowlands,
      versions::Dragonflight,
      versions::Tww
    };
 
    static_assert(ExpansionVersions.size() == std::meta::enumerators_of(^^Expansion).size(),
                  "expansion_versions must cover every Expansion enumerator");
  }
 
  [[=welder::weld,
    =welder::doc(
      "The last-minor-of-major client version wowlib targets for this "
      "expansion (the versions constant)."),
    =welder::returns("the matching versions constant")]]
  constexpr ClientVersion toClientVersion(Expansion expansion [[=welder::doc("the expansion")]]) {
    return detail::ExpansionVersions[static_cast<std::size_t>(expansion)];
  }
 
  [[=welder::weld,
    =welder::doc(
      "The expansion whose targeted release is exactly this version. "
      "Never matches a Classic constant — Classic clients are not "
      "expansion releases; pass version.format_lineage to ask which "
      "expansion's FORMATS one uses."),
    =welder::returns("the expansion, or None if the version is not one of the "
      "versions constants")]]
  constexpr std::optional<Expansion> toExpansion(ClientVersion version [[=welder::doc("a full client version")]]) {
    for (std::size_t i = 0; i < detail::ExpansionVersions.size(); ++i)
      if (detail::ExpansionVersions[i] == version) return static_cast<Expansion>(i);
    return std::nullopt;
  }
 
  [[=welder::weld,
    =welder::doc(R"(
        The expansion a client version belongs to, by major version — works for
        any build, not just the targeted releases.
 
        This is the CONTENT axis: Cataclysm Classic 4.4.2 reports Cata, because
        that is the game it is. It is NOT the format axis — that same client
        writes War Within-era files. For formats, ask
        to_expansion(version.format_lineage) instead.)"),
    =welder::returns("the expansion, or None for unknown majors")]]
  constexpr std::optional<Expansion> expansionOf(ClientVersion version [[=welder::doc("a full client version")]]) {
    for (std::size_t i = 0; i < detail::ExpansionVersions.size(); ++i)
      if (detail::ExpansionVersions[i].major == version.major) return static_cast<Expansion>(i);
    return std::nullopt;
  }
}