Merge branch 'master' into 2025-04-07-copy-opt

Author: genaray

src/Arch.Benchmarks/Benchmark.cs

@@ -9,6 +9,7 @@ public class Benchmark
 {
     private static void Main(string[] args)
     {
+
         // NOTE: Can this be replaced with ManualConfig.CreateEmpty()?
 #pragma warning disable HAA0101 // Array allocation for params parameter
         var config = new ManualConfig()

src/Arch.Tests/WorldTest.cs

@@ -55,6 +55,25 @@ public void WorldRecycle()
         That(secondWorld.Id, Is.EqualTo(firstWorld.Id));
     }
 
+    /// <summary>
+    ///     Check the dispose pattern.
+    /// </summary>
+    [Test]
+    public void WorldDestroyTwice()
+    {
+        using var worldA = World.Create(); // World A has ID 0 and size 0
+        worldA.Create(); // worldA is now size 1
+        World.Destroy(worldA); // world A is size 0
+
+        using var worldB = World.Create(); // World B has ID 0 and size 0
+        var e0 = worldB.Create(0); // world B now has size 1
+        World.Destroy(worldA); // World B still appears to have size 1
+        var e1 = worldB.Create(0); // World B has size 2
+
+        e0.Get<int>(); // This causes a null reference exception
+        e1.Get<int>(); // This also causes a null reference exception
+    }
+
     /// <summary>
     ///     Checks if the <see cref="World"/> creates <see cref="Entity"/> correctly.
     /// </summary>

src/Arch/Core/World.cs

@@ -91,6 +91,8 @@ public partial class World
     /// </summary>
     public static JobScheduler? SharedJobScheduler { get; set; }
 
+    private bool _isDisposed;
+
     /// <summary>
     ///     Creates a <see cref="World"/> instance.
     /// </summary>
@@ -133,31 +135,7 @@ public static World Create(int chunkSizeInBytes = 16_384, int minimumAmountOfEnt
     /// <param name="world">The <see cref="World"/> to destroy.</param>
     public static void Destroy(World world)
     {
-#if !PURE_ECS
-        lock (Worlds)
-        {
-            Worlds[world.Id] = null!;
-            RecycledWorldIds.Enqueue(world.Id);
-            Interlocked.Decrement(ref worldSizeUnsafe);
-        }
-#endif
-
-        world.Capacity = 0;
-        world.Size = 0;
-
-        // Dispose
-        world.JobHandles.Dispose();
-        world.GroupToArchetype.Dispose();
-        world.RecycledIds.Dispose();
-        world.QueryCache.Dispose();
-
-        // Set archetypes to null to free them manually since Archetypes are set to ClearMode.Never to fix #65
-        for (var index = 0; index < world.Archetypes.Count; index++)
-        {
-            world.Archetypes[index] = null!;
-        }
-
-        world.Archetypes.Dispose();
+        world.Dispose();
     }
 }
 
@@ -578,12 +556,60 @@ public Enumerator<Archetype> GetEnumerator()
     [StructuralChange]
     public void Dispose()
     {
-        Destroy(this);
-        // In case the user (or us) decides to override and provide a finalizer, prevents them from having
-        // to re-implement Dispose() to avoid calling it twice.
+        Dispose(true);
         GC.SuppressFinalize(this);
     }
 
+    // Protected implementation of Dispose pattern.
+    protected virtual void Dispose(bool disposing)
+    {
+        if (!_isDisposed)
+        {
+            _isDisposed = true;
+
+            if (disposing)
+            {
+                // Dispose managed state.
+            }
+
+            // Dispose unmanaged resource.
+
+            var world = this;
+#if !PURE_ECS
+            lock (Worlds)
+            {
+                Worlds[world.Id] = null!;
+                RecycledWorldIds.Enqueue(world.Id);
+                Interlocked.Decrement(ref worldSizeUnsafe);
+            }
+#endif
+
+            world.Capacity = 0;
+            world.Size = 0;
+
+            // Dispose
+            world.JobHandles.Dispose();
+            world.GroupToArchetype.Dispose();
+            world.RecycledIds.Dispose();
+            world.QueryCache.Dispose();
+
+            // Set archetypes to null to free them manually since Archetypes are set to ClearMode.Never to fix #65
+            for (var index = 0; index < world.Archetypes.Count; index++)
+            {
+                world.Archetypes[index] = null!;
+            }
+
+            world.Archetypes.Dispose();
+
+        }
+    }
+
+    // It fails the WorldRecycle test.
+    //~World()
+    //{
+    //    Dispose(false);
+    //}
+
     /// <summary>
     ///     Converts this <see cref="World"/> to a human-readable <c>string</c>.
     /// </summary>