RobustToolbox/Robust.Shared/GameObjects/EntityEventBus.Common.cs

using System;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
using JetBrains.Annotations;
using Robust.Shared.Collections;
using Robust.Shared.Reflection;
using Robust.Shared.Utility;

namespace Robust.Shared.GameObjects;

internal sealed partial class EntityEventBus : IEventBus
{
    private EntityManager _entMan;
    private IComponentFactory _comFac;
    private IReflectionManager _reflection;

    // Data on individual events. Used to check ordering info and fire broadcast events.
    private FrozenDictionary<Type, EventData> _eventData = FrozenDictionary<Type, EventData>.Empty;
    private readonly Dictionary<Type, EventData> _eventDataUnfrozen = new();

    // Inverse subscriptions to be able to unsubscribe an IEntityEventSubscriber.
    private readonly Dictionary<IEntityEventSubscriber, Dictionary<Type, BroadcastRegistration>> _inverseEventSubscriptions
        = new();

    // For queued message broadcast.
    private readonly Queue<(EventSource source, object args)> _eventQueue = new();

    // eUid -> EventType -> { CompType1, ... CompTypeN }
    // See EventTable declaration for layout details
    internal Dictionary<EntityUid, EventTable> _entEventTables = new();

    /// <summary>
    /// Array of component events and their handlers. The array is indexed by a component's
    /// <see cref="CompIdx.Value"/>, while the dictionary is indexed by the event type. This does not include events
    /// with the <see cref="ComponentEventAttribute"/>, unless <see cref="ComponentEventAttribute.Exclusive"/> is false.
    /// </summary>
    private FrozenDictionary<Type, DirectedRegistration>[] _eventSubs = default!;

    /// <summary>
    /// Variant of <see cref="_eventSubs"/> that only includes events with the <see cref="ComponentEventAttribute"/>
    /// </summary>
    private FrozenDictionary<Type, DirectedEventHandler>[] _compEventSubs = default!;

    // pre-freeze event subscription data
    private Dictionary<Type, DirectedRegistration>?[] _eventSubsUnfrozen = [];
    private Dictionary<Type, DirectedEventHandler>?[] _compEventSubsUnfrozen = [];

    /// <summary>
    /// Inverse of <see cref="_eventSubs"/>, mapping event types to sets of components.
    /// </summary>
    private Dictionary<Type, HashSet<CompIdx>> _eventSubsInv = new();
    // Only required to sort ordered subscriptions, which only happens during initialization
    // so doesn't need to be a frozen dictionary.

    // prevents shitcode, get your subscriptions figured out before you start spawning entities
    private bool _subscriptionLock;

    public bool IgnoreUnregisteredComponents;

    private readonly List<Type> _childrenTypesTemp = [];

    [MethodImpl(MethodImplOptions.AggressiveInlining)]
    private static ref Unit ExtractUnitRef(ref object obj, Type objType)
    {
        // If it's a boxed value type we have to do some trickery to return the INTERIOR reference,
        // not the reference to the boxed object.
        // Otherwise the unit points to the reference to the reference type.
        return ref objType.IsValueType
            ? ref Unsafe.As<object, UnitBox>(ref obj).Value
            : ref Unsafe.As<object, Unit>(ref obj);
    }

    private void RegisterCommon(Type eventType, OrderingData? data, out EventData subs)
    {
        if (_subscriptionLock)
            throw new InvalidOperationException("Subscription locked.");

        subs = _eventDataUnfrozen.GetOrNew(eventType);

        if (data == null)
            return;

        if (data.Before.Length > 0 || data.After.Length > 0)
        {
            subs.IsOrdered = true;
            subs.OrderingUpToDate = false;
        }
    }

    /// <summary>
    /// Information for a single event type handled by EventBus. Not specific to broadcast registrations.
    /// </summary>
    private sealed class EventData
    {
        public bool IsOrdered;
        public bool OrderingUpToDate;
        public ValueList<BroadcastRegistration> BroadcastRegistrations;
    }

    // This is not a real type. Whenever you see a "ref Unit" it means it's a ref to *some* kind of other type.

    // It should always be cast to/from with Unsafe.As<,>

    internal readonly struct Unit
    {
    }

    [StructLayout(LayoutKind.Sequential)]
    private sealed class UnitBox
    {
        [UsedImplicitly] public Unit Value;
    }
}