squad_objective_state.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. #pragma once
  2. #include "mission_auth_patch.h"
  3. #include "squad_objective_auth.h"
  4. namespace sunrise::middleware::bap::activity_message::squad_objective {
  5. /** The transported objective target, evaluation revision and reserved placement mode. */
  6. struct State final {
  7. std::uint32_t registryKey{};
  8. std::uint32_t revision{};
  9. std::uint16_t objectiveIndex{};
  10. std::int32_t taskGroup{kNoTaskGroup};
  11. bool reserved{};
  12. std::uint32_t spawnGeneration{};
  13. };
  14. /** Root field ordinals are fixed by the squad Auth schema. */
  15. inline constexpr std::size_t kObjectiveField = 0;
  16. inline constexpr std::size_t kSpawnGenerationField = 6;
  17. inline constexpr std::size_t kRevisionField = 13;
  18. inline constexpr std::size_t kTaskGroupField = 16;
  19. inline constexpr std::size_t kModeField = 19;
  20. /** Reads objective state from the complete transported squad body. */
  21. [[nodiscard]] inline bool
  22. read_state(std::span<const std::byte> body, std::size_t bits, State& output) noexcept {
  23. output = {};
  24. if (body.empty()) {
  25. return bits == 0;
  26. }
  27. mission_auth_patch::Layout layout{};
  28. if (!mission_auth_patch::parse(kSchema, body, bits, layout)) {
  29. return false;
  30. }
  31. std::uint64_t value = 0;
  32. encoding::bits::Reader mode(body);
  33. if (!mode.skip(layout.fields[kModeField].offset) || !mode.read(kModeWidth, value)) {
  34. return false;
  35. }
  36. output.reserved = value == static_cast<std::uint32_t>(squad_auth::Mode::reserve) + kModeBias;
  37. if (layout.fields[kTaskGroupField].present) {
  38. encoding::bits::Reader group(body);
  39. if (!group.skip(layout.fields[kTaskGroupField].offset + fields::kPresenceWidth)
  40. || !group.read(kTaskGroupWidth, value) || value > kTaskGroupCount) {
  41. return false;
  42. }
  43. output.taskGroup = static_cast<std::int32_t>(value) - kTaskGroupBias;
  44. }
  45. if (layout.fields[kSpawnGenerationField].present) {
  46. encoding::bits::Reader generation(body);
  47. if (!generation.skip(layout.fields[kSpawnGenerationField].offset + fields::kPresenceWidth)
  48. || !generation.read(fields::kCounterWidth, value)) {
  49. return false;
  50. }
  51. output.spawnGeneration = static_cast<std::uint32_t>(value);
  52. }
  53. if (layout.fields[kRevisionField].present) {
  54. encoding::bits::Reader revision(body);
  55. if (!revision.skip(layout.fields[kRevisionField].offset + fields::kPresenceWidth)
  56. || !revision.read(fields::kCounterWidth, value)) {
  57. return false;
  58. }
  59. output.revision = static_cast<std::uint32_t>(value);
  60. }
  61. if (!layout.fields[kObjectiveField].present) {
  62. return true;
  63. }
  64. encoding::bits::Reader reference(body);
  65. std::uint64_t type = 0;
  66. std::uint64_t index = 0;
  67. if (!reference.skip(layout.fields[kObjectiveField].offset + fields::kPresenceWidth)
  68. || !reference.read(fields::kClientRefKeyWidth, value)
  69. || !reference.read(fields::kClientRefTypeWidth, type)
  70. || !reference.read(fields::kClientRefIndexWidth, index)) {
  71. return false;
  72. }
  73. if (value != fields::kClientRefAbsentKey
  74. && type == scriptable_auth::kType3SlotType + fields::kClientRefTypeBias
  75. && index >= fields::kClientRefIndexBias) {
  76. output.registryKey = static_cast<std::uint32_t>(value);
  77. output.objectiveIndex = static_cast<std::uint16_t>(index - fields::kClientRefIndexBias);
  78. }
  79. return true;
  80. }
  81. /** Chooses an evaluation revision without allowing stale cost reports to change the assignment. */
  82. [[nodiscard]] inline bool next_request(const State& previous,
  83. std::uint32_t expectedRevision,
  84. bool reconsider,
  85. bool preserveReservation,
  86. Request& request) noexcept {
  87. const bool same = previous.registryKey == request.registryKey
  88. && previous.objectiveIndex == request.objectiveIndex;
  89. if (!reconsider && expectedRevision != 0 && (!same || previous.revision != expectedRevision)) {
  90. return false;
  91. }
  92. const bool advance = !same || reconsider || previous.revision == 0;
  93. if (advance && previous.revision == fields::kMaximumCounter) {
  94. return false;
  95. }
  96. request.revision = previous.revision + static_cast<std::uint32_t>(advance);
  97. if (preserveReservation) {
  98. request.reserved = previous.reserved;
  99. }
  100. return request.revision != 0;
  101. }
  102. } // namespace sunrise::middleware::bap::activity_message::squad_objective