Reworks Campaign CH slice CH2 per the REJECT-review findings doc (docs/research/2026-08-09-ch2-review-findings.md). BLOCKER 1 — SpewBoxController never rendered a line and leaked its pending queue. LinesProvider only ran through UiText.OnDraw, which gates on Visible — and the box started invisible, so the provider (the sole caller of SpewBoxState.Tick) never ran. Gave the controller an explicit per-frame Tick(now) driven by UiRoot's global-message-3 broadcast (a zero-size GlobalTimeSink child, the same pattern VendorUiController.DragOverGlobalTimeSink already uses), matching retail's gmSpewBoxUI::Update. LinesProvider now only returns the cache. Tests rewritten to drive root.Tick(...) instead of calling the provider directly, plus new coverage for visibility-without-a-draw, queue-drain-without-a-draw, and bounded-queue-across-many-ticks. BLOCKER 2 — re-derived the HandleFailureEvent routing table from the PDB-paired binary instead of the pseudo-C's ~33-char string previews. tools/pdb-extract/sweep_weenie_strings.py sweeps every push imm32 in VA 0x571990-0x575480, dereferences into .rdata/.data, and decodes the full UTF-16LE literal. Added the 5 ids dispatched via else-if (missed by case-label enumeration), resolved 0x4F8 (previously excluded), fixed 18 wrong strings (16 the review flagged + 2 more — 0x4E9 and 0x518 — an automated diff between every swept literal and the landed table found). Every changed row cross-checked against ACE's WeenieError/WeenieErrorWithString enum doc comments; both oracles agreed on every row, including a case where the review's own proposed text for the new 0x4E8 row was itself wrong (it was 0x4E9's text) — corrected via the else-if block's own instruction address plus the ACE cross-check. Pinned table count: 344 (338 + 5 + 0x4F8). SHOULD-FIX 1 — RuntimeCommunicationState.ResetSpewBox was dead code; folded into the ChatIdentity generation-reset stage (same lifetime boundary), with a reset assertion added to the existing populated-reset test. SHOULD-FIX 2 — AddText trimmed only the trailing end and invented an empty-string early return; retail's AddTextToScroll trims both ends (trim(&str, 1, 1, ws)) and has no empty guard. Both retired. SHOULD-FIX 3 — ShowWeenieError bypassed the AddText chokepoint via ChatLog.OnWeenieError (hardcoded LogTextType 0x00); routed through Communication.AddText(Resolve(code, param)) instead, and ChatLog.OnWeenieError is deleted — GameEventWiring's legacy no-router fallback now resolves + calls OnSystemMessage directly. SHOULD-FIX 4 — retail's HandleFailureEvent switch has no default case; an unmapped id now resolves to a null Text (silence toward the player) instead of the invented "WeenieError 0xNNNN" hex fallback, with a diagnostics-only console log line for the id. NITs — AP-TBD placeholders corrected to their real register rows (AP-178, not the unrelated AP-177 lifetime row); filed AP-180 for the windowId dual-destination gap and corrected three stale "lands with CH2" comments; extended SpewBoxLayoutDumpDiagnostic from dats.Portal to dats.Local and found the SpewBox element for real — LayoutDesc 0x21000011, element 0x10000048, size 450x72, MaxConcurrentItems (ListBox property 0x10000028) = 4, not retail's code default of 1. AP-178 narrowed accordingly; SpewBoxState.MaxConcurrentItems and SpewBoxController's extent/anchor/OneLine are now authored rather than placeholder (absolute screen position and colour remain open); fixed the "19 ids... lists 18" miscount by retiring the stale paragraph in the class doc rewrite; aligned the UseDone handler's silent-status check with the other two WeenieError handlers. Full Release suite: 11,914 passed / 4 skipped / 0 failed (build 0 errors). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
415 lines
15 KiB
C#
415 lines
15 KiB
C#
using AcDream.Runtime.Entities;
|
|
using AcDream.Runtime.Gameplay;
|
|
using AcDream.Runtime.World;
|
|
|
|
namespace AcDream.Runtime;
|
|
|
|
/// <summary>
|
|
/// The only host-specific edge in a character-generation reset. The host
|
|
/// retires presentation borrowed from an exact Runtime incarnation; Runtime
|
|
/// retains the retirement set, cursor, canonical cleanup, and generation.
|
|
/// </summary>
|
|
public interface IRuntimeGenerationResetHost
|
|
{
|
|
void RetireEntityProjection(RuntimeEntityRecord entity);
|
|
|
|
void DrainEntityProjectionBoundary();
|
|
|
|
void CompleteEntityProjectionRetirement();
|
|
}
|
|
|
|
public enum RuntimeGenerationResetStage
|
|
{
|
|
None = 0,
|
|
Transit = 1,
|
|
CommandTargets = 2,
|
|
ExternalContainer = 3,
|
|
Actions = 4,
|
|
Movement = 5,
|
|
ObjectTable = 6,
|
|
Character = 7,
|
|
ItemMana = 8,
|
|
Friends = 9,
|
|
Squelch = 10,
|
|
NegotiatedChannels = 11,
|
|
BeginEntityRetirement = 12,
|
|
RetireEntities = 13,
|
|
DrainHostProjection = 14,
|
|
CompleteCanonicalEntities = 15,
|
|
CompleteHostProjection = 16,
|
|
ChatIdentity = 17,
|
|
PlayerSnapshots = 18,
|
|
PlayerIdentity = 19,
|
|
Complete = 20,
|
|
}
|
|
|
|
public readonly record struct RuntimeGenerationResetSnapshot(
|
|
bool IsActive,
|
|
bool IsExecuting,
|
|
RuntimeGenerationToken RetiringGeneration,
|
|
RuntimeGenerationToken LastCompletedGeneration,
|
|
RuntimeGenerationResetStage Stage,
|
|
int RetirementCount,
|
|
int RetirementCursor,
|
|
bool CurrentProjectionAcknowledged,
|
|
long TransactionId)
|
|
{
|
|
public bool IsConverged =>
|
|
!IsActive
|
|
&& !IsExecuting;
|
|
}
|
|
|
|
public sealed class RuntimeGenerationResetStageException(
|
|
RuntimeGenerationToken retiringGeneration,
|
|
RuntimeGenerationResetStage stage,
|
|
Exception innerException) : Exception(
|
|
$"Runtime generation {retiringGeneration.Value} reset stage "
|
|
+ $"'{stage}' did not converge.",
|
|
innerException)
|
|
{
|
|
public RuntimeGenerationToken RetiringGeneration { get; } =
|
|
retiringGeneration;
|
|
|
|
public RuntimeGenerationResetStage Stage { get; } = stage;
|
|
}
|
|
|
|
/// <summary>
|
|
/// One persisted, retryable reset transaction for every canonical owner in a
|
|
/// reusable <see cref="GameRuntime"/>. A failed call retains the exact suffix:
|
|
/// completed stages and exact-incarnation retirements never replay.
|
|
/// </summary>
|
|
public sealed class RuntimeGenerationReset
|
|
{
|
|
private readonly RuntimeWorldTransitState _transit;
|
|
private readonly RuntimeCommunicationState _communication;
|
|
private readonly RuntimeInventoryState _inventory;
|
|
private readonly RuntimeActionState _actions;
|
|
private readonly RuntimeLocalPlayerMovementState _movement;
|
|
private readonly RuntimeEntityObjectLifetime _entityObjects;
|
|
private readonly RuntimeCharacterState _character;
|
|
private readonly RuntimeLocalPlayerIdentityState _identity;
|
|
private ResetState? _state;
|
|
private RuntimeGenerationToken _lastCompletedGeneration;
|
|
private bool _hasCompletedGeneration;
|
|
private bool _executing;
|
|
private long _nextTransactionId;
|
|
|
|
internal RuntimeGenerationReset(
|
|
RuntimeWorldTransitState transit,
|
|
RuntimeCommunicationState communication,
|
|
RuntimeInventoryState inventory,
|
|
RuntimeActionState actions,
|
|
RuntimeLocalPlayerMovementState movement,
|
|
RuntimeEntityObjectLifetime entityObjects,
|
|
RuntimeCharacterState character,
|
|
RuntimeLocalPlayerIdentityState identity)
|
|
{
|
|
_transit = transit ?? throw new ArgumentNullException(nameof(transit));
|
|
_communication = communication
|
|
?? throw new ArgumentNullException(nameof(communication));
|
|
_inventory = inventory
|
|
?? throw new ArgumentNullException(nameof(inventory));
|
|
_actions = actions ?? throw new ArgumentNullException(nameof(actions));
|
|
_movement = movement
|
|
?? throw new ArgumentNullException(nameof(movement));
|
|
_entityObjects = entityObjects
|
|
?? throw new ArgumentNullException(nameof(entityObjects));
|
|
_character = character
|
|
?? throw new ArgumentNullException(nameof(character));
|
|
_identity = identity
|
|
?? throw new ArgumentNullException(nameof(identity));
|
|
}
|
|
|
|
public RuntimeGenerationToken? ActiveRetiringGeneration =>
|
|
_state?.Generation;
|
|
|
|
public RuntimeGenerationResetSnapshot CaptureSnapshot()
|
|
{
|
|
ResetState? state = _state;
|
|
return state is null
|
|
? new RuntimeGenerationResetSnapshot(
|
|
false,
|
|
_executing,
|
|
default,
|
|
_lastCompletedGeneration,
|
|
_hasCompletedGeneration
|
|
? RuntimeGenerationResetStage.Complete
|
|
: RuntimeGenerationResetStage.None,
|
|
0,
|
|
0,
|
|
false,
|
|
0)
|
|
: new RuntimeGenerationResetSnapshot(
|
|
true,
|
|
_executing,
|
|
state.Generation,
|
|
_lastCompletedGeneration,
|
|
state.Stage,
|
|
state.Retirements?.Length ?? 0,
|
|
state.RetirementCursor,
|
|
state.CurrentProjectionAcknowledged,
|
|
state.TransactionId);
|
|
}
|
|
|
|
public void Reset(
|
|
RuntimeGenerationToken retiringGeneration,
|
|
IRuntimeGenerationResetHost host)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(host);
|
|
if (_executing)
|
|
{
|
|
throw new InvalidOperationException(
|
|
"Runtime generation reset cannot run concurrently or reentrantly.");
|
|
}
|
|
|
|
ResetState state = AcquireState(retiringGeneration, host);
|
|
if (state.Stage is RuntimeGenerationResetStage.Complete)
|
|
return;
|
|
|
|
_executing = true;
|
|
try
|
|
{
|
|
Drain(state);
|
|
}
|
|
catch (Exception error)
|
|
{
|
|
throw new RuntimeGenerationResetStageException(
|
|
state.Generation,
|
|
state.Stage,
|
|
error);
|
|
}
|
|
finally
|
|
{
|
|
_executing = false;
|
|
}
|
|
}
|
|
|
|
internal void DrainPending()
|
|
{
|
|
ResetState? state = _state;
|
|
if (state is null)
|
|
return;
|
|
Reset(state.Generation, state.Host);
|
|
}
|
|
|
|
private ResetState AcquireState(
|
|
RuntimeGenerationToken generation,
|
|
IRuntimeGenerationResetHost host)
|
|
{
|
|
if (_state is { } pending)
|
|
{
|
|
if (pending.Generation != generation)
|
|
{
|
|
throw new InvalidOperationException(
|
|
$"Runtime generation {pending.Generation.Value} reset "
|
|
+ $"must converge before generation {generation.Value} can reset.");
|
|
}
|
|
if (!ReferenceEquals(pending.Host, host))
|
|
{
|
|
throw new InvalidOperationException(
|
|
"An in-progress Runtime generation reset cannot replace "
|
|
+ "its borrowed projection host.");
|
|
}
|
|
return pending;
|
|
}
|
|
|
|
if (_hasCompletedGeneration)
|
|
{
|
|
if (generation == _lastCompletedGeneration)
|
|
return ResetState.Completed(generation, host);
|
|
if (generation.Value < _lastCompletedGeneration.Value)
|
|
{
|
|
throw new InvalidOperationException(
|
|
$"Runtime generation {generation.Value} reset is stale; "
|
|
+ $"generation {_lastCompletedGeneration.Value} already converged.");
|
|
}
|
|
}
|
|
|
|
var created = new ResetState(
|
|
generation,
|
|
host,
|
|
checked(++_nextTransactionId));
|
|
_state = created;
|
|
return created;
|
|
}
|
|
|
|
private void Drain(ResetState state)
|
|
{
|
|
while (state.Stage is not RuntimeGenerationResetStage.Complete)
|
|
{
|
|
switch (state.Stage)
|
|
{
|
|
case RuntimeGenerationResetStage.Transit:
|
|
Advance(state, _transit.ResetSession);
|
|
break;
|
|
case RuntimeGenerationResetStage.CommandTargets:
|
|
Advance(state, _communication.ResetCommandTargets);
|
|
break;
|
|
case RuntimeGenerationResetStage.ExternalContainer:
|
|
// Slice 5.3: the vendor browse session shares the
|
|
// external-container stage rather than claiming a new
|
|
// enum ordinal — both are client-local "open server
|
|
// object" sessions torn down uniformly at session
|
|
// reset/portal-out/logout (research doc §C.2's
|
|
// "generation/lifecycle contract every other J4/J5 child
|
|
// follows").
|
|
Advance(state, () =>
|
|
{
|
|
_inventory.ResetExternalContainer();
|
|
_inventory.ResetVendor();
|
|
});
|
|
break;
|
|
case RuntimeGenerationResetStage.Actions:
|
|
Advance(state, _actions.ResetSession);
|
|
break;
|
|
case RuntimeGenerationResetStage.Movement:
|
|
Advance(state, _movement.ResetSession);
|
|
break;
|
|
case RuntimeGenerationResetStage.ObjectTable:
|
|
Advance(state, _entityObjects.ClearObjects);
|
|
break;
|
|
case RuntimeGenerationResetStage.Character:
|
|
Advance(state, _character.ResetSession);
|
|
break;
|
|
case RuntimeGenerationResetStage.ItemMana:
|
|
Advance(state, _inventory.ResetItemMana);
|
|
break;
|
|
case RuntimeGenerationResetStage.Friends:
|
|
Advance(state, _communication.ResetFriends);
|
|
break;
|
|
case RuntimeGenerationResetStage.Squelch:
|
|
Advance(state, _communication.ResetSquelch);
|
|
break;
|
|
case RuntimeGenerationResetStage.NegotiatedChannels:
|
|
Advance(
|
|
state,
|
|
_communication.ResetNegotiatedChannels);
|
|
break;
|
|
case RuntimeGenerationResetStage.BeginEntityRetirement:
|
|
_ = _entityObjects.BeginSessionClear();
|
|
state.Retirements = _entityObjects
|
|
.CaptureSessionClearRetirements()
|
|
.ToArray();
|
|
state.Stage = RuntimeGenerationResetStage.RetireEntities;
|
|
break;
|
|
case RuntimeGenerationResetStage.RetireEntities:
|
|
RetireCurrentEntity(state);
|
|
break;
|
|
case RuntimeGenerationResetStage.DrainHostProjection:
|
|
state.Host.DrainEntityProjectionBoundary();
|
|
state.Stage =
|
|
RuntimeGenerationResetStage.CompleteCanonicalEntities;
|
|
break;
|
|
case RuntimeGenerationResetStage.CompleteCanonicalEntities:
|
|
if (!_entityObjects.CompleteSessionClearIfConverged())
|
|
{
|
|
throw new InvalidOperationException(
|
|
"Canonical entity/object lifetime still owns an "
|
|
+ "unacknowledged session retirement.");
|
|
}
|
|
state.Stage =
|
|
RuntimeGenerationResetStage.CompleteHostProjection;
|
|
break;
|
|
case RuntimeGenerationResetStage.CompleteHostProjection:
|
|
state.Host.CompleteEntityProjectionRetirement();
|
|
state.Stage = RuntimeGenerationResetStage.ChatIdentity;
|
|
break;
|
|
case RuntimeGenerationResetStage.ChatIdentity:
|
|
// CH2 REJECT-review rework (SHOULD-FIX 1,
|
|
// docs/research/2026-08-09-ch2-review-findings.md):
|
|
// RuntimeCommunicationState.ResetSpewBox was dead code —
|
|
// no caller reset the transient SpewBox queue at
|
|
// generation boundaries even though ResetChatIdentity
|
|
// (the chat transcript's identity/dedup reset) already
|
|
// ran here every generation. They share this stage
|
|
// because they're the same lifetime boundary — a fresh
|
|
// generation must not resurrect a stale refusal line —
|
|
// even though they differ in WHAT they reset:
|
|
// ResetChatIdentity preserves the visible transcript,
|
|
// ResetSpewBox clears it (see RuntimeCommunicationState's
|
|
// own doc comments on each).
|
|
Advance(state, () =>
|
|
{
|
|
_communication.ResetChatIdentity();
|
|
_communication.ResetSpewBox();
|
|
});
|
|
break;
|
|
case RuntimeGenerationResetStage.PlayerSnapshots:
|
|
Advance(state, _inventory.ResetPlayerSnapshots);
|
|
break;
|
|
case RuntimeGenerationResetStage.PlayerIdentity:
|
|
_identity.ResetSession();
|
|
Complete(state);
|
|
break;
|
|
default:
|
|
throw new InvalidOperationException(
|
|
$"Unsupported Runtime generation reset stage {state.Stage}.");
|
|
}
|
|
}
|
|
}
|
|
|
|
private void RetireCurrentEntity(ResetState state)
|
|
{
|
|
RuntimeEntityRecord[] retirements = state.Retirements ?? [];
|
|
if (state.RetirementCursor >= retirements.Length)
|
|
{
|
|
state.Stage = RuntimeGenerationResetStage.DrainHostProjection;
|
|
return;
|
|
}
|
|
|
|
RuntimeEntityRecord current = retirements[state.RetirementCursor];
|
|
if (!state.CurrentProjectionAcknowledged)
|
|
{
|
|
state.Host.RetireEntityProjection(current);
|
|
state.CurrentProjectionAcknowledged = true;
|
|
}
|
|
|
|
_entityObjects.CompleteSessionEntityRetirement(current);
|
|
state.CurrentProjectionAcknowledged = false;
|
|
state.RetirementCursor++;
|
|
}
|
|
|
|
private static void Advance(ResetState state, Action action)
|
|
{
|
|
action();
|
|
state.Stage++;
|
|
}
|
|
|
|
private void Complete(ResetState state)
|
|
{
|
|
state.Stage = RuntimeGenerationResetStage.Complete;
|
|
_lastCompletedGeneration = state.Generation;
|
|
_hasCompletedGeneration = true;
|
|
_state = null;
|
|
}
|
|
|
|
private sealed class ResetState
|
|
{
|
|
public ResetState(
|
|
RuntimeGenerationToken generation,
|
|
IRuntimeGenerationResetHost host,
|
|
long transactionId)
|
|
{
|
|
Generation = generation;
|
|
Host = host;
|
|
TransactionId = transactionId;
|
|
Stage = RuntimeGenerationResetStage.Transit;
|
|
}
|
|
|
|
public RuntimeGenerationToken Generation { get; }
|
|
public IRuntimeGenerationResetHost Host { get; }
|
|
public long TransactionId { get; }
|
|
public RuntimeGenerationResetStage Stage { get; set; }
|
|
public RuntimeEntityRecord[]? Retirements { get; set; }
|
|
public int RetirementCursor { get; set; }
|
|
public bool CurrentProjectionAcknowledged { get; set; }
|
|
|
|
public static ResetState Completed(
|
|
RuntimeGenerationToken generation,
|
|
IRuntimeGenerationResetHost host) =>
|
|
new(generation, host, 0)
|
|
{
|
|
Stage = RuntimeGenerationResetStage.Complete,
|
|
};
|
|
}
|
|
}
|