DragonECS/src/entlong.cs

using System;
using System.ComponentModel;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

namespace DCFApixels.DragonECS
{
    using static entlong.ThrowHalper;
    // uniqueID - 32 bits
    // gen - 16 bits
    // world - 16 bits
    /// <summary>Strong identifier/Permanent entity identifier</summary>
    [StructLayout(LayoutKind.Explicit, Pack = 2, Size = 8)]
    public readonly struct entlong : IEquatable<long>, IEquatable<entlong>
    {
        public static readonly entlong NULL = default;
        [FieldOffset(0)]
        internal readonly long full; //Union
        [FieldOffset(0)]
        internal readonly int id;
        [FieldOffset(4)]
        internal readonly short gen;
        [FieldOffset(6)]
        internal readonly short world;

        #region Properties
        public bool IsAlive
        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => EcsWorld.Worlds[world].IsAlive(id, gen);
        }
        public bool IsNull
        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => this == NULL;
        }
        [EditorBrowsable(EditorBrowsableState.Never)]
        public bool IsNotNull
        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => this != NULL;
        }

        [EditorBrowsable(EditorBrowsableState.Never)]
        public int ID
        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get
            {
#if (DEBUG && !DISABLE_DEBUG) || !DRAGONECS_NO_SANITIZE_CHECKS
                if (!IsAlive) ThrowIsNotAlive(this);
#endif
                return id;
            }
        }
        [EditorBrowsable(EditorBrowsableState.Never)]
        public short Gen
        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get
            {
#if (DEBUG && !DISABLE_DEBUG) || !DRAGONECS_NO_SANITIZE_CHECKS
                if (!IsAlive) ThrowIsNotAlive(this);
#endif
                return gen;
            }
        }
        public EcsWorld World
        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get
            {
#if (DEBUG && !DISABLE_DEBUG) || !DRAGONECS_NO_SANITIZE_CHECKS
                if (!IsAlive) ThrowIsNotAlive(this);
#endif
                return EcsWorld.Worlds[world];
            }
        }
        [EditorBrowsable(EditorBrowsableState.Never)]
        public short WorldID
        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get
            {
#if (DEBUG && !DISABLE_DEBUG) || !DRAGONECS_NO_SANITIZE_CHECKS
                if (!IsAlive) ThrowIsNotAlive(this);
#endif
                return world;
            }
        }
        #endregion

        #region Constructors
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public entlong(int id, short gen, short world) : this()
        {
            this.id = id;
            this.gen = gen;
            this.world = world;
        }
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        internal entlong(long full) : this()
        {
            this.full = full;
        }
        #endregion

        #region TryGetters
        public bool TryGetID(out int id)
        {
            id = this.id;
            return IsAlive;
        }
        public bool TryGetWorld(out EcsWorld world)
        {
            world = EcsWorld.Worlds[this.world];
            return IsAlive;
        }
        public bool TryUnpack(out EcsWorld world, out int id)
        {
            world = EcsWorld.Worlds[this.world];
            id = this.id;
            return IsAlive;
        }
        #endregion

        #region Equals
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public bool Equals(entlong other) => full == other.full;
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public bool Equals(long other) => full == other;
        #endregion

        #region Object
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public override int GetHashCode() => unchecked((int)full) ^ (int)(full >> 32);
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public override string ToString() => $"entity(id:{id} g:{gen} w:{world} {(IsAlive ? "alive" : "not alive")})";
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public override bool Equals(object obj) => obj is entlong other && full == other.full;
        #endregion

        #region operators
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static bool operator ==(in entlong a, in entlong b) => a.full == b.full;
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static bool operator !=(in entlong a, in entlong b) => a.full != b.full;

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static explicit operator long(in entlong a) => a.full;
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static explicit operator entlong(in long a) => new entlong(a);
        #endregion

        #region ThrowHalper
        internal static class ThrowHalper
        {
            [MethodImpl(MethodImplOptions.NoInlining)]
            public static void ThrowIsNotAlive(entlong entity)
            {
                if (entity.IsNull)
                    throw new EcsFrameworkException("The entity identifier is null.");
                else
                    throw new EcsFrameworkException("The entity is not alive.");
            }
        }
        #endregion
    }
}