ECS - add Entity.Revision

friflo · Jul 30, 2024 · b5f9014 · b5f9014
1 parent 218531f
commit b5f9014
Show file tree

Hide file tree

Showing 18 changed files with 471 additions and 198 deletions.
diff --git a/src/ECS/Archetype/EntityStore.cs b/src/ECS/Archetype/EntityStore.cs
@@ -152,9 +152,9 @@ protected EntityStoreBase()
     internal static NullReferenceException EntityNullException(Entity entity) {
         return new NullReferenceException($"entity is null. id: {entity.Id}");
     }
-
-    internal static Exception   EntityDetachedException(string parameterName) {
-        return ExceptionUtils.ArgumentException("entity is detached", parameterName);
+    
+    internal static ArgumentNullException EntityArgumentNullException(Entity entity, string param) {
+        return new ArgumentNullException(param, $"entity is null. id: {entity.Id}");
     }
 
     internal static Exception   InvalidStoreException(string parameterName) {

diff --git a/src/ECS/Base/Types/ComponentType.cs b/src/ECS/Base/Types/ComponentType.cs
@@ -95,18 +95,30 @@ internal ComponentType(string componentKey, int structIndex, Type indexType, Typ
 
     internal override bool RemoveEntityComponent(Entity entity) {
         int archIndex = 0;
-        return EntityStoreBase.RemoveComponent<T>(entity.Id, ref entity.refArchetype, ref entity.refCompIndex, ref archIndex, StructIndex);
+        ref var node    = ref entity.store.nodes[entity.Id];
+        if (node.archetype != null && node.revision == entity.Revision) {
+            return EntityStoreBase.RemoveComponent<T>(entity.Id, ref node.archetype, ref node.compIndex, ref archIndex, StructIndex);
+        }
+        throw EntityStoreBase.EntityArgumentNullException(entity, nameof(entity));
     }
 
     internal override bool AddEntityComponent(Entity entity) {
         int archIndex = 0;
-        return EntityStoreBase.AddComponent<T>(entity.Id, StructIndex, ref entity.refArchetype, ref entity.refCompIndex, ref archIndex, default);
+        ref var node    = ref entity.store.nodes[entity.Id];
+        if (node.archetype != null && node.revision == entity.Revision) {
+            return EntityStoreBase.AddComponent<T>(entity.Id, StructIndex, ref node.archetype, ref node.compIndex, ref archIndex, default);
+        }
+        throw EntityStoreBase.EntityArgumentNullException(entity, nameof(entity));
     }
 
     internal override bool AddEntityComponentValue(Entity entity, object value) {
         int archIndex = 0;
         var componentValue = (T)value;
-        return EntityStoreBase.AddComponent(entity.Id, StructIndex, ref entity.refArchetype, ref entity.refCompIndex, ref archIndex, componentValue);
+        ref var node    = ref entity.store.nodes[entity.Id];
+        if (node.archetype != null && node.revision == entity.Revision) {
+            return EntityStoreBase.AddComponent(entity.Id, StructIndex, ref node.archetype, ref node.compIndex, ref archIndex, componentValue);
+        }
+        throw EntityStoreBase.EntityArgumentNullException(entity, nameof(entity));
     }
 
     internal override StructHeap CreateHeap() {

diff --git a/src/ECS/Entity.cs b/src/ECS/Entity.cs
diff --git a/src/ECS/Entity/EntityInfo.cs b/src/ECS/Entity/EntityInfo.cs
@@ -23,7 +23,7 @@ internal readonly struct EntityInfo
     #region properties
     internal            long                Pid             => entity.Pid;
     internal            bool                Enabled         => entity.Enabled;
-    internal            Archetype           Archetype       => entity.archetype;
+    internal            Archetype           Archetype       => entity.GetArchetype();
     internal            Scripts             Scripts         => entity.Scripts;
     internal            Entity              Parent          => entity.Parent;
     internal            JSON                JSON            => new JSON(EntityUtils.EntityToJSON(entity));

diff --git a/src/ECS/Entity/EntityNode.cs b/src/ECS/Entity/EntityNode.cs
@@ -59,8 +59,10 @@ public struct EntityNode
 
     [Browse(Never)] internal    int             compIndex;          //  4   index within Archetype.entityIds & StructHeap<>.components
 
+    [Browse(Never)] internal    short           revision;           //  2
+
     // /// <summary> Use <see cref="Is"/> or <see cref="IsNot"/> for read access. </summary>
-    // [Browse(Never)] internal    NodeFlags       flags;              //  1
+    // [Browse(Never)] internal NodeFlags       flags;              //  1
 
     /// <summary>
     /// Bit mask for all <see cref="EntityRelations"/> and all <see cref="ComponentIndex"/> instances.<br/> 

diff --git a/src/ECS/Entity/EntityUtils.cs b/src/ECS/Entity/EntityUtils.cs
@@ -34,7 +34,8 @@ public static class EntityUtils
     /// So avoid using this method whenever possible. Use <see cref="Entity.GetComponent{T}"/> instead.
     /// </summary>
     public static  IComponent   GetEntityComponent    (Entity entity, ComponentType componentType) {
-        return entity.archetype.heapMap[componentType.StructIndex].GetComponentDebug(entity.compIndex);
+        var type = entity.GetArchetype() ?? throw EntityStoreBase.EntityArgumentNullException(entity, nameof(entity));
+        return type.heapMap[componentType.StructIndex].GetComponentDebug(entity.compIndex);
     }
 
     public static  bool RemoveEntityComponent (Entity entity, ComponentType componentType)
@@ -65,7 +66,8 @@ public static  bool AddEntityComponentValue(Entity entity, ComponentType compone
     // ------------------------------------------- internal methods -------------------------------------------
 #region internal - methods
     internal static int ComponentCount (this Entity entity) {
-        return entity.archetype.componentCount + entity.Scripts.Length;
+        var type = entity.GetArchetype() ?? throw EntityStoreBase.EntityArgumentNullException(entity, nameof(entity));
+        return type.componentCount + entity.Scripts.Length;
     }
 
     internal static Exception NotImplemented(int id, string use) {
@@ -77,7 +79,7 @@ internal static string EntityToString(Entity entity) {
         if (entity.store == null) {
             return "null";
         }
-        return EntityToString(entity.Id, entity.archetype, new StringBuilder());
+        return EntityToString(entity.Id, entity.GetArchetype(), new StringBuilder());
     }
 
     internal static string EntityToString(int id, Archetype archetype, StringBuilder sb)
@@ -196,31 +198,35 @@ private static Script AddNewScript(Entity entity, ScriptType scriptType)
     }
 
     internal static Script AddScript (Entity entity, Script script) {
-        var scriptType = ScriptTypeByType[script.GetType()];
-        return entity.archetype.entityStore.extension.AddScript(entity, script, scriptType);
+        var store       = entity.GetStore() ?? throw EntityStoreBase.EntityArgumentNullException(entity, nameof(entity));
+        var scriptType  = ScriptTypeByType[script.GetType()];
+        return store.extension.AddScript(entity, script, scriptType);
     }
 
     private static  Script AddScriptInternal(Entity entity, Script script, ScriptType scriptType)
     {
         if (!script.entity.IsNull) {
             throw new InvalidOperationException($"script already added to an entity. current entity id: {script.entity.Id}");
         }
-        return entity.archetype.entityStore.extension.AddScript(entity, script, scriptType);
+        var store = entity.GetStore() ?? throw EntityStoreBase.EntityArgumentNullException(entity, nameof(entity));
+        return store.extension.AddScript(entity, script, scriptType);
     }
 
     internal static Script RemoveScript(Entity entity, int scriptTypeIndex) {
+        var store = entity.GetStore() ?? throw EntityStoreBase.EntityArgumentNullException(entity, nameof(entity));
         if (!entity.store.extension.scriptMap.TryGetValue(entity.Id, out int scriptIndex)) {
             return null;
         }
         var scriptType  = ScriptTypes[scriptTypeIndex];
-        return entity.archetype.entityStore.extension.RemoveScript(entity, scriptType, scriptIndex);
+        return store.extension.RemoveScript(entity, scriptType, scriptIndex);
     }
 
     private static Script RemoveScriptType(Entity entity, ScriptType scriptType) {
+        var store = entity.GetStore() ?? throw EntityStoreBase.EntityArgumentNullException(entity, nameof(entity));
         if (!entity.store.extension.scriptMap.TryGetValue(entity.Id, out int scriptIndex)) {
             return null;
         }
-        return entity.archetype.entityStore.extension.RemoveScript(entity, scriptType, scriptIndex);
+        return store.extension.RemoveScript(entity, scriptType, scriptIndex);
     }
 
     internal static void AddTreeTags(Entity entity, in Tags tags)

diff --git a/src/ECS/Entity/Extensions/EntityLinks.cs b/src/ECS/Entity/Extensions/EntityLinks.cs
@@ -74,11 +74,11 @@ public static int CountAllIncomingLinks(this Entity target)
 #region outgoing links
     public static int CountAllOutgoingLinks(this Entity entity)
     {
-        var schema      = EntityStoreBase.Static.EntitySchema;
-
+        var schema  = EntityStoreBase.Static.EntitySchema;
+        var type    = entity.GetArchetype() ?? throw EntityStoreBase.EntityNullException(entity);
         // --- count link components
         var linkTypes   = new ComponentTypes {
-            bitSet = BitSet.Intersect(entity.archetype.componentTypes.bitSet, schema.linkComponentTypes.bitSet)
+            bitSet = BitSet.Intersect(type.componentTypes.bitSet, schema.linkComponentTypes.bitSet)
         };
         // --- count relations components
         int count           = linkTypes.Count;

diff --git a/src/ECS/Entity/Store/Entities.cs b/src/ECS/Entity/Store/Entities.cs
@@ -87,7 +87,7 @@ internal int CreateEntityInternal(Archetype archetype, int id)
     /// </remarks>
     public Entity CloneEntity(Entity entity)
     {
-        var archetype   = entity.archetype ?? throw EntityNullException(entity);
+        var archetype   = entity.GetArchetype() ?? throw EntityArgumentNullException(entity, nameof(entity));
         var id          = NewId();
         CreateEntityInternal(archetype, id);
         var clone       = new Entity(this, id);
@@ -174,6 +174,7 @@ private int CreateEntityNode(Archetype archetype, int id)
         entityCount++;
         node.compIndex  = Archetype.AddEntity(archetype, id);
         node.archetype  = archetype;
+        node.revision++;
         // node.flags      = Created;
         return node.compIndex;
     }
@@ -193,6 +194,7 @@ internal void CreateEntityNodes(Archetype archetype, int count)
             ref var node    = ref localNodes[id];
             node.compIndex  = index;
             node.archetype  = archetype;
+            node.revision++;
             // node.flags      = Created;
         }
         if (intern.pidType == PidType.RandomPids) {
@@ -208,10 +210,8 @@ internal void CreateEntityNodes(Archetype archetype, int count)
     /// Set the passed <paramref name="entity"/> as the <see cref="StoreRoot"/> entity.
     /// </summary>
     public void SetStoreRoot(Entity entity) {
-        if (entity.IsNull) {
-            throw new ArgumentNullException(nameof(entity));
-        }
-        if (this != entity.archetype.store) {
+        var store = entity.GetStore() ?? throw EntityArgumentNullException(entity, nameof(entity));
+        if (this != store) {
             throw InvalidStoreException(nameof(entity));
         }
         SetStoreRootEntity(entity);

diff --git a/src/ECS/Entity/Store/NodeTree.cs b/src/ECS/Entity/Store/NodeTree.cs
@@ -525,7 +525,9 @@ internal void DeleteNode(Entity entity)
         RemoveAllEntityEventHandlers(this, node, id);
         int parentId = GetTreeParentId(id);
         // --- clear node entry.
+        var revision    = node.revision;
         node = default;
+        node.revision   = revision;        
         extension.RemoveEntity(id);
 
         // --- remove child from parent 

diff --git a/src/ECS/Entity/Store/Scripts.cs b/src/ECS/Entity/Store/Scripts.cs
@@ -58,8 +58,8 @@ internal void AppendScript(Entity entity, Script script)
     /// <br/> 
     /// The entity state refers to:
     /// <list type="bullet">
-    ///   <item><see cref="Entity.refArchetype"/></item>
-    ///   <item><see cref="Entity.refCompIndex"/></item>
+    ///   <item><see cref="EntityNode.archetype"/></item>
+    ///   <item><see cref="EntityNode.compIndex"/></item>
     ///   <item><see cref="RawEntity.archIndex"/></item>
     /// </list>
     /// </remarks>

diff --git a/src/ECS/Index/IndexExtensions.cs b/src/ECS/Index/IndexExtensions.cs
@@ -23,7 +23,7 @@ public static class IndexExtensions
     public static EntityLinks<TComponent> GetIncomingLinks<TComponent>(this Entity target)
         where TComponent: struct, ILinkComponent
     {
-        if (target.archetype == null) throw EntityStoreBase.EntityNullException(target);
+        if (target.IsNull) throw EntityStoreBase.EntityNullException(target);
         var index = (ComponentIndex<Entity>)StoreIndex.GetIndex(target.store, StructInfo<TComponent>.Index);
         return new EntityLinks<TComponent>(target, index.GetHasValueEntities(target), null);
     }

diff --git a/src/ECS/Relations/RelationExtensions.cs b/src/ECS/Relations/RelationExtensions.cs
@@ -21,7 +21,7 @@ public static class RelationExtensions
     public static ref TComponent GetRelation<TComponent, TKey>(this Entity entity, TKey key)
         where TComponent : struct, IRelationComponent<TKey>
     {
-        if (entity.archetype == null) throw EntityStoreBase.EntityNullException(entity);
+        if (entity.IsNull) throw EntityStoreBase.EntityNullException(entity);
         return ref EntityRelations.GetRelation<TComponent, TKey>(entity.store, entity.Id, key);
     }
 
@@ -33,7 +33,7 @@ public static ref TComponent GetRelation<TComponent, TKey>(this Entity entity, T
     public static bool TryGetRelation<TComponent, TKey>(this Entity entity, TKey key, out TComponent value)
         where TComponent : struct, IRelationComponent<TKey>
     {
-        if (entity.archetype == null) throw EntityStoreBase.EntityNullException(entity);
+        if (entity.IsNull) throw EntityStoreBase.EntityNullException(entity);
         return EntityRelations.TryGetRelation(entity.store, entity.Id, key, out value);
     }
 
@@ -45,7 +45,7 @@ public static bool TryGetRelation<TComponent, TKey>(this Entity entity, TKey key
     public static RelationComponents<TComponent> GetRelations<TComponent>(this Entity entity)
         where TComponent : struct, IRelationComponent
     {
-        if (entity.archetype == null) throw EntityStoreBase.EntityNullException(entity);
+        if (entity.IsNull) throw EntityStoreBase.EntityNullException(entity);
         return EntityRelations.GetRelations<TComponent>(entity.store, entity.Id);
     }
 
@@ -58,7 +58,7 @@ public static RelationComponents<TComponent> GetRelations<TComponent>(this Entit
     public static bool AddRelation<TComponent>(this Entity entity, in TComponent component)
         where TComponent : struct, IRelationComponent
     {
-        if (entity.archetype == null) throw EntityStoreBase.EntityNullException(entity);
+        if (entity.IsNull) throw EntityStoreBase.EntityNullException(entity);
         return EntityRelations.AddRelation(entity.store, entity.Id, component);
     }
 
@@ -71,7 +71,7 @@ public static bool AddRelation<TComponent>(this Entity entity, in TComponent com
     public static bool RemoveRelation<TComponent, TKey>(this Entity entity, TKey key)
         where TComponent : struct, IRelationComponent<TKey>
     {
-        if (entity.archetype == null) throw EntityStoreBase.EntityNullException(entity); 
+        if (entity.IsNull) throw EntityStoreBase.EntityNullException(entity); 
         return EntityRelations.RemoveRelation<TComponent, TKey>(entity.store, entity.Id, key);
     }
 
@@ -84,7 +84,7 @@ public static bool RemoveRelation<TComponent, TKey>(this Entity entity, TKey key
     public static bool RemoveRelation<TComponent>(this Entity entity, Entity target)
         where TComponent : struct, ILinkRelation
     {
-        if (entity.archetype == null) throw EntityStoreBase.EntityNullException(entity);
+        if (entity.IsNull) throw EntityStoreBase.EntityNullException(entity);
         return EntityRelations.RemoveRelation<TComponent, Entity>(entity.store, entity.Id, target);
     }
 
@@ -96,7 +96,7 @@ public static bool RemoveRelation<TComponent>(this Entity entity, Entity target)
     public static EntityLinks<TComponent> GetIncomingLinks<TComponent>(this Entity target)
         where TComponent: struct, IRelationComponent
     {
-        if (target.archetype == null) throw EntityStoreBase.EntityNullException(target);
+        if (target.IsNull) throw EntityStoreBase.EntityNullException(target);
         var entities = EntityRelations.GetIncomingLinkRelations(target.store, target.Id, StructInfo<TComponent>.Index, out var relations);
         return new EntityLinks<TComponent>(target, entities, relations);
     }

diff --git a/src/ECS/Serialize/EntityConverter.cs b/src/ECS/Serialize/EntityConverter.cs
@@ -31,10 +31,7 @@ public EntityConverter() {
     /// </summary>
     public DataEntity EntityToDataEntity(Entity entity, DataEntity dataEntity, bool pretty)
     {
-        if (entity.IsNull) {
-            throw new ArgumentNullException(nameof(entity));
-        }
-        var store       = entity.archetype.entityStore;
+        var store       = entity.GetStore() ?? throw EntityStoreBase.EntityArgumentNullException(entity, nameof(entity));
         var pid         = store.IdToPid(entity.Id);
         dataEntity    ??= new DataEntity();
         dataEntity.pid  = pid;

diff --git a/src/Tests/ECS/Entity/Test_Entity.cs b/src/Tests/ECS/Entity/Test_Entity.cs
@@ -307,57 +307,6 @@ public static void Test_Entity_EnableTree()
         IsFalse (root.Enabled);
     }
 
-    [Test]
-    public static void Test_Entity_NullReferenceException()
-    {
-        var store = new EntityStore();
-        var entity = store.CreateEntity();
-        entity.DeleteEntity();
-        var expect = "entity is null. id: 1";
-
-        // --- components
-        var nre = Throws<NullReferenceException>(() => {
-            entity.AddComponent(new Position());    
-        });
-        AreEqual(expect, nre!.Message);
-
-        nre = Throws<NullReferenceException>(() => {
-            entity.AddComponent<Position>();    
-        });
-        AreEqual(expect, nre!.Message);
-
-        nre = Throws<NullReferenceException>(() => {
-            entity.RemoveComponent<Position>();    
-        });
-        AreEqual(expect, nre!.Message);
-
-        // --- tags
-        nre = Throws<NullReferenceException>(() => {
-            entity.AddTag<TestTag>();    
-        });
-        AreEqual(expect, nre!.Message);
-
-        nre = Throws<NullReferenceException>(() => {
-            entity.AddTags(default);    
-        });
-        AreEqual(expect, nre!.Message);
-
-        nre = Throws<NullReferenceException>(() => {
-            entity.RemoveTag<TestTag>();    
-        });
-        AreEqual(expect, nre!.Message);
-
-        nre = Throws<NullReferenceException>(() => {
-            entity.RemoveTags(default);    
-        });
-        AreEqual(expect, nre!.Message);
-
-        nre = Throws<NullReferenceException>(() => {
-            store.CloneEntity(entity);    
-        });
-        AreEqual(expect, nre!.Message);
-    }
-
     [Test]
     public static void Test_Entity_create_delete_Entity_events()
     {