fix(ui): OP2 rework — dormant UiDatElement subclasses, fixed Panel/CheckboxBitfield64 mechanism

OP2 (df9c7a35) was double-REJECTed: an unconditional Type-8/Type-5 factory
mapping silently re-classed 15 elements across 7 shipped panels (vendor
backdrop lost its fill, character/spellbook roots stopped passing clicks
through, combat gained a phantom import-time tab takeover, ten ListBoxes
gained a spurious hit-testable viewport) because the stale 27 pre-existing
fixtures never exercised the new fields — and the mechanism itself cited a
nonexistent "UIElement_TabControl" class, inverted UiCheckboxBitfield64's
checked-state predicate, and synthesized fake per-row geometry instead of
using the widget's own authored template.

Shape change: UiTabPanel (renamed from UiTabControl) and UiTemplateListBox
now derive from UiDatElement (unsealed) and stay DORMANT by default — an
imported Type-8/Type-5 element gets authored-media drawing, ClickThrough
generic-decoration default, and IUiDatStateful propagation identical to the
pre-OP2 UiDatElement fallback, with zero import-time side effects. The
factory's Type-8/Type-5 arms are unconditional again (no more guard whose
premise the blast-radius sweep proved false), because dormancy makes an
unactivated instance behaviorally indistinguishable from the old fallback.
UiTabPanel.ActivateTabBehavior() and UiTemplateListBox's lazy viewport
creation are the explicit, controller-driven opt-ins Campaign OP slice OP3+
will call; today nothing does, so the four pre-existing shipped Type-8
hosts (character/spellbook/vendor/combat) and ten pre-existing Type-5
ListBoxes keep their pre-OP2 behavior exactly. Filed AD-73 for this
dormant-vs-retail's-unconditional-activation adaptation.

Mechanism fixes (docs/research/2026-08-11-op2-review-mechanism.md):
- UiTabPanel cites UIElement_Panel (Type 8 is UIElement_Panel; no
  UIElement_TabControl exists in the PDB), resolves buttons/pages via a
  GetChildRecursive-equivalent descendant search (not direct-children-only),
  performs no switch when no entry authors 0x32 (deleted the _tabs[0]
  fallback), and surfaces unresolved tab-table entries via UnresolvedEntries
  + a diagnostic line instead of a silent no-op.
- ElementReader.ReadTabTable skips entries missing 0x30/0x31, matching
  retail's SetupTabPageHash @0x0046C2E0 entry filter.
- UiCheckboxBitfield64 now builds every row from its OWN authored template
  (property 0x64 -> {0x2100002B, 0x10000521}) via AddItemFromTemplateList,
  deleting the synthesized ElementInfo + invented RowHeight=14 — matching
  retail's CreateChildren @0x00485DF0, which is itself a UIElement_ListBox
  call. IsSet is now retail's ANY-bit-set predicate (Refresh @0x004859C0),
  not all-bits-set. TS-72 retired: the click-toggle bit math is now fully
  decomp-confirmed (SetBitsOnOrOff via ListenToElementMessage @0x00485AE0).

Regenerated all 32 UI fixtures against real DAT (ACDREAM_REGENERATE_UI_FIXTURES=1)
and committed them — 27 pre-existing fixtures now carry Outline/OutlineColor/
TabTable/TemplateList/ScrollbarElementId; the 5 Options fixtures were already
current. Updated EffectsUiControllerTests' now-correct UiTemplateListBox
class-identity assertion. Added: 6 built-widget behavior pins for all five
pre-existing Type-8 elements + a representative Type-5 element the dormancy
model protects (OP2ReworkBlastRadiusConformanceTests.cs); 5 reader-level
tests driving ReadTabTable/ReadTemplateList/the 0x72 reader from raw
property bags (ElementReaderTests.cs); a multi-bit-mask UiCheckboxBitfield64
test proving the any-bit predicate (the prior single-bit test couldn't
distinguish it from all-bits); an activation-idempotency test and a
before-activation click-is-inert test for UiTabPanel.

Full Release suite: 12,868 passed / 4 skipped / 0 failed (baseline 12,853/4/0
post-OP1-fixes; +15 net new tests, zero regressions).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Erik 2026-08-11 01:06:31 +02:00
parent 8a05fda445
commit b236a44279
40 changed files with 6249 additions and 1145 deletions

View file

@ -350,4 +350,132 @@ public class ElementReaderTests
var merged = ElementReader.Merge(base_, derived);
Assert.Null(merged.OutlineColor);
}
// ── OP2 rework: reader-level tests for 0x2E/0x64/0x72 ───────────────────────
// docs/research/2026-08-11-op2-review-mechanism.md §1.4 SHOULD-FIX: the OP2
// conformance tests only ever read the SERIALIZED ElementInfo.TabTable/
// TemplateList/ScrollbarElementId fields off a committed fixture, so a future
// regression in ReadTabTable/ReadTemplateList/the 0x72 reader would not fail a
// single test. These drive ApplyCanonicalLegacyProjection directly from a
// synthetic raw property bag — the readers themselves, not a fixture snapshot.
private static UiPropertyValue EnumProp(uint value) => new()
{
Kind = UiPropertyKind.Enum,
UnsignedValue = value,
};
private static UiPropertyValue BoolProp(bool value) => new()
{
Kind = UiPropertyKind.Bool,
BoolValue = value,
};
private static ElementInfo WithDirectProperty(uint propertyId, UiPropertyValue value)
{
var info = new ElementInfo();
var direct = new UiStateInfo { Id = UiStateInfo.DirectStateId, Name = "" };
direct.Properties.Values[propertyId] = value;
info.States[UiStateInfo.DirectStateId] = direct;
return info;
}
[Fact]
public void ReadTabTable_DecodesButtonPageDefaultInAuthoredOrder()
{
var entry0 = new UiPropertyValue { Kind = UiPropertyKind.Struct };
entry0.StructValue[0x30u] = EnumProp(0x1000AAAAu);
entry0.StructValue[0x31u] = EnumProp(0x1000BBBBu);
entry0.StructValue[0x32u] = BoolProp(true);
var entry1 = new UiPropertyValue { Kind = UiPropertyKind.Struct };
entry1.StructValue[0x30u] = EnumProp(0x1000CCCCu);
entry1.StructValue[0x31u] = EnumProp(0x1000DDDDu);
// no 0x32 -> IsDefault false
var array = new UiPropertyValue { Kind = UiPropertyKind.Array };
array.ArrayValue.Add(entry0);
array.ArrayValue.Add(entry1);
ElementInfo info = WithDirectProperty(0x2Eu, array);
ElementReader.ApplyCanonicalLegacyProjection(info);
Assert.Equal(2, info.TabTable.Count);
Assert.Equal(new UiTabTableEntry(0x1000AAAAu, 0x1000BBBBu, true), info.TabTable[0]);
Assert.Equal(new UiTabTableEntry(0x1000CCCCu, 0x1000DDDDu, false), info.TabTable[1]);
}
/// <summary>
/// Retail <c>UIElement_Panel::SetupTabPageHash @0x0046C2E0</c> skips a struct
/// entry whose <c>InqProperty(0x30)</c> or <c>InqProperty(0x31)</c> is missing —
/// a partial entry never enters <c>m_TabPageHash</c> (OP2 rework,
/// docs/research/2026-08-11-op2-review-mechanism.md §1.1).
/// </summary>
[Fact]
public void ReadTabTable_SkipsEntriesMissingButtonOrPage()
{
var missingPage = new UiPropertyValue { Kind = UiPropertyKind.Struct };
missingPage.StructValue[0x30u] = EnumProp(0x1000EEEEu);
// no 0x31
var missingButton = new UiPropertyValue { Kind = UiPropertyKind.Struct };
missingButton.StructValue[0x31u] = EnumProp(0x1000FFFFu);
// no 0x30
var wellFormed = new UiPropertyValue { Kind = UiPropertyKind.Struct };
wellFormed.StructValue[0x30u] = EnumProp(0x10001111u);
wellFormed.StructValue[0x31u] = EnumProp(0x10002222u);
var array = new UiPropertyValue { Kind = UiPropertyKind.Array };
array.ArrayValue.Add(missingPage);
array.ArrayValue.Add(missingButton);
array.ArrayValue.Add(wellFormed);
ElementInfo info = WithDirectProperty(0x2Eu, array);
ElementReader.ApplyCanonicalLegacyProjection(info);
UiTabTableEntry only = Assert.Single(info.TabTable);
Assert.Equal(new UiTabTableEntry(0x10001111u, 0x10002222u, false), only);
}
[Fact]
public void ReadTemplateList_DecodesLayoutDidAndElementIdInAuthoredOrder()
{
var entry0 = new UiPropertyValue { Kind = UiPropertyKind.Struct };
entry0.StructValue[0x63u] = EnumProp(0x21000099u);
entry0.StructValue[0x62u] = EnumProp(0x10003333u);
var entry1 = new UiPropertyValue { Kind = UiPropertyKind.Struct };
entry1.StructValue[0x63u] = EnumProp(0x21000099u);
entry1.StructValue[0x62u] = EnumProp(0x10004444u);
var array = new UiPropertyValue { Kind = UiPropertyKind.Array };
array.ArrayValue.Add(entry0);
array.ArrayValue.Add(entry1);
ElementInfo info = WithDirectProperty(0x64u, array);
ElementReader.ApplyCanonicalLegacyProjection(info);
Assert.Equal(2, info.TemplateList.Count);
Assert.Equal(new UiTemplateListEntry(0x21000099u, 0x10003333u), info.TemplateList[0]);
Assert.Equal(new UiTemplateListEntry(0x21000099u, 0x10004444u), info.TemplateList[1]);
}
[Fact]
public void ReadReferencedElementId_ScrollbarLinkage_DecodesEnumProperty()
{
ElementInfo info = WithDirectProperty(0x72u, EnumProp(0x10005555u));
ElementReader.ApplyCanonicalLegacyProjection(info);
Assert.Equal(0x10005555u, info.ScrollbarElementId);
}
[Fact]
public void ReadReferencedElementId_ScrollbarLinkage_AbsentPropertyStaysZero()
{
var info = new ElementInfo();
ElementReader.ApplyCanonicalLegacyProjection(info);
Assert.Equal(0u, info.ScrollbarElementId);
}
}