Use records typealias, remove ops/s comments

MineInAbyss · Sep 5, 2023 · 1cd4a99 · 1cd4a99
1 parent 28738fa
commit 1cd4a99
Show file tree

Hide file tree

Showing 18 changed files with 27 additions and 36 deletions.
diff --git a/...mmonMain/kotlin/com/mineinabyss/geary/prefabs/configuration/systems/ParseChildOnPrefab.kt b/...mmonMain/kotlin/com/mineinabyss/geary/prefabs/configuration/systems/ParseChildOnPrefab.kt
@@ -2,7 +2,6 @@ package com.mineinabyss.geary.prefabs.configuration.systems
 
 import com.mineinabyss.geary.components.EntityName
 import com.mineinabyss.geary.components.relations.NoInherit
-import com.mineinabyss.geary.datatypes.Records
 import com.mineinabyss.geary.datatypes.UnsafeAccessors
 import com.mineinabyss.geary.helpers.addParent
 import com.mineinabyss.geary.helpers.entity
@@ -17,7 +16,7 @@ class ParseChildOnPrefab : Listener() {
     private var Pointers.child by get<ChildOnPrefab>().removable().whenSetOnTarget()
 
     @OptIn(UnsafeAccessors::class)
-    override fun Records.handle() {
+    override fun Pointers.handle() {
         entity {
             addParent(target.entity)
             setAll(child!!.components)
@@ -30,7 +29,7 @@ class ParseChildrenOnPrefab : Listener() {
     private var Pointers.children by get<ChildrenOnPrefab>().removable().whenSetOnTarget()
 
     @OptIn(UnsafeAccessors::class)
-    override fun Records.handle() {
+    override fun Pointers.handle() {
         children!!.nameToComponents.forEach { (name, components) ->
             entity {
                 set(EntityName(name))

diff --git a/...nMain/kotlin/com/mineinabyss/geary/prefabs/configuration/systems/ParseRelationOnPrefab.kt b/...nMain/kotlin/com/mineinabyss/geary/prefabs/configuration/systems/ParseRelationOnPrefab.kt
@@ -1,14 +1,14 @@
 package com.mineinabyss.geary.prefabs.configuration.systems
 
-import com.mineinabyss.geary.datatypes.Records
 import com.mineinabyss.geary.prefabs.configuration.components.RelationOnPrefab
 import com.mineinabyss.geary.systems.Listener
+import com.mineinabyss.geary.systems.accessors.Pointers
 
 
 class ParseRelationOnPrefab : Listener() {
-    private var Records.relation by get<RelationOnPrefab>().removable().whenSetOnTarget()
+    private var Pointers.relation by get<RelationOnPrefab>().removable().whenSetOnTarget()
 
-    override fun Records.handle() {
+    override fun Pointers.handle() {
         try {
             val rel: RelationOnPrefab = relation!!
 //            entity.setRelation(relation.value, entity.parseEntity(relation.key).id)

diff --git a/...kotlin/com/mineinabyss/geary/prefabs/configuration/systems/ParseRelationWithDataSystem.kt b/...kotlin/com/mineinabyss/geary/prefabs/configuration/systems/ParseRelationWithDataSystem.kt
@@ -3,14 +3,15 @@ package com.mineinabyss.geary.prefabs.configuration.systems
 import com.mineinabyss.geary.datatypes.Records
 import com.mineinabyss.geary.datatypes.UnsafeAccessors
 import com.mineinabyss.geary.systems.Listener
+import com.mineinabyss.geary.systems.accessors.Pointers
 import com.mineinabyss.geary.systems.accessors.RelationWithData
 
 
 class ParseRelationWithDataSystem : Listener() {
     private val Records.relationWithData by get<RelationWithData<*, *>>().whenSetOnTarget()
 
     @OptIn(UnsafeAccessors::class)
-    override fun Records.handle() {
+    override fun Pointers.handle() {
         val entity = target.entity
         val data = relationWithData.data
         val targetData = relationWithData.targetData

diff --git a/...efabs/src/commonMain/kotlin/com/mineinabyss/geary/prefabs/systems/InheritPrefabsOnLoad.kt b/...efabs/src/commonMain/kotlin/com/mineinabyss/geary/prefabs/systems/InheritPrefabsOnLoad.kt
@@ -13,7 +13,7 @@ class InheritPrefabsOnLoad : Listener() {
     private val Pointers.loaded by family { has<PrefabLoaded>() }.on(event)
 
     @OptIn(UnsafeAccessors::class)
-    override fun Records.handle() {
+    override fun Pointers.handle() {
         target.entity.inheritPrefabs()
     }
 }

diff --git a/...bs/src/commonMain/kotlin/com/mineinabyss/geary/prefabs/systems/TrackPrefabsByKeySystem.kt b/...bs/src/commonMain/kotlin/com/mineinabyss/geary/prefabs/systems/TrackPrefabsByKeySystem.kt
@@ -6,13 +6,14 @@ import com.mineinabyss.geary.datatypes.UnsafeAccessors
 import com.mineinabyss.geary.prefabs.PrefabKey
 import com.mineinabyss.geary.prefabs.prefabs
 import com.mineinabyss.geary.systems.Listener
+import com.mineinabyss.geary.systems.accessors.Pointers
 
 
 class TrackPrefabsByKeySystem : Listener() {
     private val Records.key by get<PrefabKey>().whenSetOnTarget()
 
     @OptIn(UnsafeAccessors::class)
-    override fun Records.handle() {
+    override fun Pointers.handle() {
         prefabs.manager.registerPrefab(key, target.entity)
         target.entity.addRelation<NoInherit, PrefabKey>()
     }

diff --git a/addons/geary-uuid/src/commonMain/kotlin/com/mineinabyss/geary/uuid/systems/TrackUuidOnAdd.kt b/addons/geary-uuid/src/commonMain/kotlin/com/mineinabyss/geary/uuid/systems/TrackUuidOnAdd.kt
@@ -15,7 +15,7 @@ class TrackUuidOnAdd : GearyListener() {
     val Pointers.regenerateUUIDOnClash by get<RegenerateUUIDOnClash>().orNull().on(target)
 
     @OptIn(UnsafeAccessors::class)
-    override fun Records.handle() {
+    override fun Pointers.handle() {
         if (uuid in uuid2Geary)
             if (regenerateUUIDOnClash != null) {
                 val newUuid = uuid4()

diff --git a/...eary-uuid/src/commonMain/kotlin/com/mineinabyss/geary/uuid/systems/UnTrackUuidOnRemove.kt b/...eary-uuid/src/commonMain/kotlin/com/mineinabyss/geary/uuid/systems/UnTrackUuidOnRemove.kt
@@ -13,7 +13,7 @@ class UnTrackUuidOnRemove : GearyListener() {
     private val Pointers.uuid by get<Uuid>().on(target)
     private val Pointers.removed by family { has<EntityRemoved>() }.on(event)
 
-    override fun Records.handle() {
+    override fun Pointers.handle() {
         uuid2Geary.remove(uuid)
     }
 }
diff --git a/geary-benchmarks/src/main/kotlin/com/mineinabyss/geary/benchmarks/VelocitySystemBenchmark.kt b/geary-benchmarks/src/main/kotlin/com/mineinabyss/geary/benchmarks/VelocitySystemBenchmark.kt
@@ -39,7 +39,6 @@ class VelocitySystemBenchmark {
         }
     }
 
-    // 0.606 ops/s
     @Benchmark
     fun velocitySystem() {
         VelocitySystem.tickAll()

diff --git a/...rks/src/main/kotlin/com/mineinabyss/geary/benchmarks/jvmTesting/MemoryAccessBenchmarks.kt b/...rks/src/main/kotlin/com/mineinabyss/geary/benchmarks/jvmTesting/MemoryAccessBenchmarks.kt
@@ -30,22 +30,19 @@ class MemoryAccessBenchmarks {
         accessorWithScope = AccessorWithScope(intArr)
     }
 
-    // >2bil ops/s
-//    @Benchmark
+    @Benchmark
     fun emptyLoop() {
         for (i in 0 until oneMil) {
         }
     }
 
-    // 1.8bil ops/s
     @Benchmark
     fun readIntArrDirectly() {
         for (i in 0 until oneMil) {
             intArr[i] + 1
         }
     }
 
-    // 1.7bil ops/s
     @Benchmark
     fun readObjArrDirectly() {
         for (i in 0 until oneMil) {
@@ -60,7 +57,6 @@ class MemoryAccessBenchmarks {
         }
     }
 
-    // 1.3bil ops/s
     @Benchmark
     fun read2ArrDirectly() {
         for (i in 0 until oneMil) {
@@ -83,8 +79,6 @@ class MemoryAccessBenchmarks {
         }
     }
 
-
-    // 23470 ops/s
     @Benchmark
     fun readWriteSingleIntArrDirectly() {
         for (i in 0 until oneMil) {
@@ -93,7 +87,6 @@ class MemoryAccessBenchmarks {
     }
 
 
-    // 15503 ops/s
     @Benchmark
     fun readWriteTwoArrDirectly() {
         for (i in 0 until oneMil) {
@@ -116,7 +109,6 @@ class MemoryAccessBenchmarks {
         }
     }
 
-    // 1907 ops/s
     @Benchmark
     fun readPackToSeparateArr() {
         val arr = IntArray(oneMil)
@@ -125,8 +117,6 @@ class MemoryAccessBenchmarks {
         }
     }
 
-    // 1.5bil ops/s
-    // Even with a full object instantiation, we don't lose much!
     @Benchmark
     fun readIntArrWithIndirection() {
         for (i in 0 until oneMil) {

diff --git a/...benchmarks/src/main/kotlin/com/mineinabyss/geary/benchmarks/unpacking/Unpack1Benchmark.kt b/...benchmarks/src/main/kotlin/com/mineinabyss/geary/benchmarks/unpacking/Unpack1Benchmark.kt
@@ -2,7 +2,6 @@ package com.mineinabyss.geary.benchmarks.unpacking
 
 import com.mineinabyss.geary.benchmarks.helpers.Comp1
 import com.mineinabyss.geary.benchmarks.helpers.tenMil
-import com.mineinabyss.geary.datatypes.family.family
 import com.mineinabyss.geary.helpers.entity
 import com.mineinabyss.geary.modules.TestEngineModule
 import com.mineinabyss.geary.modules.geary
@@ -30,7 +29,6 @@ class Unpack1Benchmark {
         }
     }
 
-    // 5.149 ops/s
     @Benchmark
     fun unpack1of1Comp() {
         SystemOf1.run {

diff --git a/...benchmarks/src/main/kotlin/com/mineinabyss/geary/benchmarks/unpacking/Unpack2Benchmark.kt b/...benchmarks/src/main/kotlin/com/mineinabyss/geary/benchmarks/unpacking/Unpack2Benchmark.kt
@@ -37,7 +37,6 @@ class Unpack2Benchmark {
         }
     }
 
-    // 4.993 ops/s
     @Benchmark
     fun unpack1of2Comp() {
         SystemOf1.run {
@@ -47,7 +46,6 @@ class Unpack2Benchmark {
         }
     }
 
-    // 3.576 ops/s
     @Benchmark
     fun unpack2of2Comp() {
         SystemOf2.run {

diff --git a/geary-core/src/commonMain/kotlin/com/mineinabyss/geary/datatypes/RecordPointer.kt b/geary-core/src/commonMain/kotlin/com/mineinabyss/geary/datatypes/RecordPointer.kt
@@ -10,6 +10,7 @@ import com.mineinabyss.geary.modules.archetypes
 )
 annotation class UnsafeAccessors
 
+/** A record created in place that delegates to the real entity pointer the first time [entity] gets accessed. */
 class RecordPointer @PublishedApi internal constructor(
     archetype: Archetype,
     row: Int
@@ -40,8 +41,8 @@ class RecordPointer @PublishedApi internal constructor(
             return entity
         }
 
-    operator fun component1(): Archetype =
-        @OptIn(UnsafeAccessors::class) archetype
+    @UnsafeAccessors
+    operator fun component1(): Archetype = archetype
 
     operator fun component2(): Int = row
 }
diff --git a/geary-core/src/commonMain/kotlin/com/mineinabyss/geary/systems/Listener.kt b/geary-core/src/commonMain/kotlin/com/mineinabyss/geary/systems/Listener.kt
@@ -1,6 +1,5 @@
 package com.mineinabyss.geary.systems
 
-import com.mineinabyss.geary.datatypes.Records
 import com.mineinabyss.geary.helpers.componentId
 import com.mineinabyss.geary.systems.accessors.*
 import com.mineinabyss.geary.systems.accessors.type.ComponentAccessor
@@ -59,6 +58,6 @@ abstract class Listener : AccessorOperations(), System {
         return this.on(event)
     }
 
-    abstract fun Records.handle()
+    abstract fun Pointers.handle()
 }
 
diff --git a/geary-core/src/jvmTest/kotlin/com/mineinabyss/geary/events/ComponentAddEventTest.kt b/geary-core/src/jvmTest/kotlin/com/mineinabyss/geary/events/ComponentAddEventTest.kt
@@ -6,6 +6,7 @@ import com.mineinabyss.geary.helpers.getArchetype
 import com.mineinabyss.geary.helpers.tests.GearyTest
 import com.mineinabyss.geary.modules.geary
 import com.mineinabyss.geary.systems.Listener
+import com.mineinabyss.geary.systems.accessors.Pointers
 import io.kotest.matchers.shouldBe
 import org.junit.jupiter.api.Test
 
@@ -19,7 +20,7 @@ internal class ComponentAddEventTest : GearyTest() {
         val Records.int by get<Int>().whenSetOnTarget()
         val Records.double by get<Double>().whenSetOnTarget()
 
-        override fun Records.handle() {
+        override fun Pointers.handle() {
             inc++
         }
     }

diff --git a/geary-core/src/jvmTest/kotlin/com/mineinabyss/geary/events/SimpleComponentAddListenerTest.kt b/geary-core/src/jvmTest/kotlin/com/mineinabyss/geary/events/SimpleComponentAddListenerTest.kt
@@ -5,6 +5,7 @@ import com.mineinabyss.geary.helpers.entity
 import com.mineinabyss.geary.helpers.tests.GearyTest
 import com.mineinabyss.geary.modules.geary
 import com.mineinabyss.geary.systems.Listener
+import com.mineinabyss.geary.systems.accessors.Pointers
 import io.kotest.matchers.shouldBe
 import kotlin.test.Test
 
@@ -14,7 +15,7 @@ class SimpleComponentAddListenerTest : GearyTest() {
 
         val Records.data by get<Int>().whenSetOnTarget()
 
-        override fun Records.handle() {
+        override fun Pointers.handle() {
             called += 1
         }
     }

diff --git a/geary-core/src/jvmTest/kotlin/com/mineinabyss/geary/events/SimpleEventTest.kt b/geary-core/src/jvmTest/kotlin/com/mineinabyss/geary/events/SimpleEventTest.kt
@@ -5,6 +5,7 @@ import com.mineinabyss.geary.helpers.entity
 import com.mineinabyss.geary.helpers.tests.GearyTest
 import com.mineinabyss.geary.modules.geary
 import com.mineinabyss.geary.systems.Listener
+import com.mineinabyss.geary.systems.accessors.Pointers
 import io.kotest.matchers.shouldBe
 import kotlin.test.Test
 
@@ -17,7 +18,7 @@ class SimpleEventTest : GearyTest() {
         val Records.data by get<Int>().on(target)
         val Records.event by get<MyEvent>().on(event)
 
-        override fun Records.handle() {
+        override fun Pointers.handle() {
             called += 1
         }
     }

diff --git a/geary-core/src/jvmTest/kotlin/com/mineinabyss/geary/events/SourceTargetEventTest.kt b/geary-core/src/jvmTest/kotlin/com/mineinabyss/geary/events/SourceTargetEventTest.kt
@@ -6,6 +6,7 @@ import com.mineinabyss.geary.helpers.entity
 import com.mineinabyss.geary.helpers.tests.GearyTest
 import com.mineinabyss.geary.modules.geary
 import com.mineinabyss.geary.systems.Listener
+import com.mineinabyss.geary.systems.accessors.Pointers
 import io.kotest.matchers.shouldBe
 import org.junit.jupiter.api.Test
 
@@ -22,7 +23,7 @@ class SourceTargetEventTest : GearyTest() {
             event.mutableFamily.add(family { has<Attack>() })
         }
 
-        override fun Records.handle() {
+        override fun Pointers.handle() {
             health = Health(health.amount - strength.amount)
         }
     }

diff --git a/geary-core/src/jvmTest/kotlin/com/mineinabyss/geary/systems/QueryManagerTest.kt b/geary-core/src/jvmTest/kotlin/com/mineinabyss/geary/systems/QueryManagerTest.kt
@@ -6,6 +6,7 @@ import com.mineinabyss.geary.helpers.entity
 import com.mineinabyss.geary.helpers.tests.GearyTest
 import com.mineinabyss.geary.modules.archetypes
 import com.mineinabyss.geary.modules.geary
+import com.mineinabyss.geary.systems.accessors.Pointers
 import io.kotest.matchers.collections.shouldContain
 import io.kotest.matchers.shouldBe
 import org.junit.jupiter.api.Test
@@ -17,7 +18,7 @@ internal class QueryManagerTest : GearyTest() {
         var ran = 0
         private val Records.testComponent by get<TestComponent>().on(target)
 
-        override fun Records.handle() {
+        override fun Pointers.handle() {
             ran++
         }
     }