Direct component access when iterating, benchmarks

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Mine In Abyss
+Copyright (c) 2020 Danielle Voznyy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -38,10 +38,10 @@ data class Velocity(var x: Double, var y: Double)
 
 class UpdatePositionSystem : TickingSystem(interval = 20.milliseconds) {
     // Specify all components we want (Geary also supports branched AND/OR/NOT statements for selection)
-    val TargetScope.position by get<Position>()
-    val TargetScope.velocity by get<Velocity>()
+    val Pointer.position by get<Position>()
+    val Pointer.velocity by get<Velocity>()
 
-    override fun TargetScope.tick() {
+    override fun Pointer.tick() {
         // We can access our components like regular variables!
         position.x += velocity.x
         position.y += velocity.y

addons/geary-common-features/src/main/kotlin/com/mineinabyss/geary/game/systems/ExpiringComponentSystem.kt

@@ -1,19 +1,24 @@
 package com.mineinabyss.geary.game.systems
 
+import com.mineinabyss.geary.annotations.optin.UnsafeAccessors
 import com.mineinabyss.geary.game.components.Expiry
 import com.mineinabyss.geary.systems.RepeatingSystem
-import com.mineinabyss.geary.systems.accessors.TargetScope
+import com.mineinabyss.geary.systems.accessors.Pointer
+
 
 /**
  * Handles removing components when an [Expiry] relation exists with another component.
  */
 class ExpiringComponentSystem : RepeatingSystem() {
-    private val TargetScope.expiry by getRelations<Expiry, Any?>()
+    private val Pointer.expiry by getRelationsWithData<Expiry, Any?>()
 
-    override fun TargetScope.tick() {
-        if (expiry.data.timeOver()) {
-            entity.remove(expiry.kind.id)
-            entity.remove(expiry.relation.id)
+    @OptIn(UnsafeAccessors::class)
+    override fun Pointer.tick() {
+        expiry.forEach {
+            if (it.data.timeOver()) {
+                entity.remove(it.kind.id)
+                entity.remove(it.relation.id)
+            }
         }
     }
 }

addons/geary-prefabs/src/commonMain/kotlin/com/mineinabyss/geary/prefabs/configuration/systems/ParseChildOnPrefab.kt

@@ -1,43 +1,44 @@
 package com.mineinabyss.geary.prefabs.configuration.systems
 
-import com.mineinabyss.geary.annotations.Handler
 import com.mineinabyss.geary.components.EntityName
 import com.mineinabyss.geary.components.relations.NoInherit
+import com.mineinabyss.geary.annotations.optin.UnsafeAccessors
 import com.mineinabyss.geary.helpers.addParent
 import com.mineinabyss.geary.helpers.entity
 import com.mineinabyss.geary.prefabs.configuration.components.ChildOnPrefab
 import com.mineinabyss.geary.prefabs.configuration.components.ChildrenOnPrefab
 import com.mineinabyss.geary.prefabs.configuration.components.Prefab
 import com.mineinabyss.geary.systems.Listener
-import com.mineinabyss.geary.systems.accessors.TargetScope
+import com.mineinabyss.geary.systems.accessors.Pointers
+
 
 class ParseChildOnPrefab : Listener() {
-    private val TargetScope.child by onSet<ChildOnPrefab>().onTarget()
+    private var Pointers.child by get<ChildOnPrefab>().removable().whenSetOnTarget()
 
-    @Handler
-    private fun TargetScope.convertToRelation() {
+    @OptIn(UnsafeAccessors::class)
+    override fun Pointers.handle() {
         entity {
-            addParent(entity)
-            setAll(child.components)
+            addParent(target.entity)
+            setAll(child!!.components)
         }
-        entity.remove<ChildOnPrefab>()
+        child = null
     }
 }
 
 class ParseChildrenOnPrefab : Listener() {
-    private val TargetScope.children by onSet<ChildrenOnPrefab>().onTarget()
+    private var Pointers.children by get<ChildrenOnPrefab>().removable().whenSetOnTarget()
 
-    @Handler
-    private fun TargetScope.convertToRelation() {
-        children.nameToComponents.forEach { (name, components) ->
+    @OptIn(UnsafeAccessors::class)
+    override fun Pointers.handle() {
+        children!!.nameToComponents.forEach { (name, components) ->
             entity {
                 set(EntityName(name))
                 set(Prefab())
-                addParent(entity)
+                addParent(target.entity)
                 addRelation<NoInherit, Prefab>()
                 setAll(components)
             }
         }
-        entity.remove<ChildrenOnPrefab>()
+        children = null
     }
 }

addons/geary-prefabs/src/commonMain/kotlin/com/mineinabyss/geary/prefabs/configuration/systems/ParseRelationOnPrefab.kt

@@ -1,20 +1,19 @@
 package com.mineinabyss.geary.prefabs.configuration.systems
 
-import com.mineinabyss.geary.annotations.Handler
 import com.mineinabyss.geary.prefabs.configuration.components.RelationOnPrefab
 import com.mineinabyss.geary.systems.Listener
-import com.mineinabyss.geary.systems.accessors.TargetScope
+import com.mineinabyss.geary.systems.accessors.Pointers
+
 
 class ParseRelationOnPrefab : Listener() {
-    private val TargetScope.relation by onSet<RelationOnPrefab>().onTarget()
+    private var Pointers.relation by get<RelationOnPrefab>().removable().whenSetOnTarget()
 
-    @Handler
-    private fun TargetScope.convertToRelation() {
+    override fun Pointers.handle() {
         try {
-            val rel: RelationOnPrefab = relation
+            val rel: RelationOnPrefab = relation!!
 //            entity.setRelation(relation.value, entity.parseEntity(relation.key).id)
         } finally {
-            entity.remove<RelationOnPrefab>()
+            relation = null
         }
     }
 }

addons/geary-prefabs/src/commonMain/kotlin/com/mineinabyss/geary/prefabs/configuration/systems/ParseRelationWithDataSystem.kt

@@ -1,15 +1,18 @@
 package com.mineinabyss.geary.prefabs.configuration.systems
 
-import com.mineinabyss.geary.annotations.Handler
+import com.mineinabyss.geary.datatypes.Records
+import com.mineinabyss.geary.annotations.optin.UnsafeAccessors
 import com.mineinabyss.geary.systems.Listener
+import com.mineinabyss.geary.systems.accessors.Pointers
 import com.mineinabyss.geary.systems.accessors.RelationWithData
-import com.mineinabyss.geary.systems.accessors.TargetScope
+
 
 class ParseRelationWithDataSystem : Listener() {
-    private val TargetScope.relationWithData by onSet<RelationWithData<*, *>>().onTarget()
+    private val Records.relationWithData by get<RelationWithData<*, *>>().whenSetOnTarget()
 
-    @Handler
-    private fun TargetScope.convertToRelation() {
+    @OptIn(UnsafeAccessors::class)
+    override fun Pointers.handle() {
+        val entity = target.entity
         val data = relationWithData.data
         val targetData = relationWithData.targetData
         if (data != null) entity.set(data, relationWithData.relation.id)

addons/geary-prefabs/src/commonMain/kotlin/com/mineinabyss/geary/prefabs/systems/InheritPrefabsOnLoad.kt

@@ -1,19 +1,19 @@
 package com.mineinabyss.geary.prefabs.systems
 
-import com.mineinabyss.geary.annotations.Handler
+import com.mineinabyss.geary.annotations.optin.UnsafeAccessors
 import com.mineinabyss.geary.datatypes.family.family
 import com.mineinabyss.geary.prefabs.events.PrefabLoaded
 import com.mineinabyss.geary.prefabs.helpers.inheritPrefabs
 import com.mineinabyss.geary.systems.Listener
-import com.mineinabyss.geary.systems.accessors.EventScope
-import com.mineinabyss.geary.systems.accessors.TargetScope
+import com.mineinabyss.geary.systems.accessors.Pointers
+
 
 class InheritPrefabsOnLoad : Listener() {
-    private val EventScope.loaded by family { has<PrefabLoaded>() }.onEvent()
+    private val Pointers.loaded by family { has<PrefabLoaded>() }.on(event)
 
-    @Handler
-    private fun TargetScope.inheritOnLoad() {
-        entity.inheritPrefabs()
+    @OptIn(UnsafeAccessors::class)
+    override fun Pointers.handle() {
+        target.entity.inheritPrefabs()
     }
 }
 

addons/geary-prefabs/src/commonMain/kotlin/com/mineinabyss/geary/prefabs/systems/TrackPrefabsByKeySystem.kt

@@ -1,18 +1,20 @@
 package com.mineinabyss.geary.prefabs.systems
 
-import com.mineinabyss.geary.annotations.Handler
 import com.mineinabyss.geary.components.relations.NoInherit
+import com.mineinabyss.geary.datatypes.Records
+import com.mineinabyss.geary.annotations.optin.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.TargetScope
+import com.mineinabyss.geary.systems.accessors.Pointers
+
 
 class TrackPrefabsByKeySystem : Listener() {
-    private val TargetScope.key by onSet<PrefabKey>().onTarget()
+    private val Records.key by get<PrefabKey>().whenSetOnTarget()
 
-    @Handler
-    private fun TargetScope.registerOnSet() {
-        prefabs.manager.registerPrefab(key, entity)
-        entity.addRelation<NoInherit, PrefabKey>()
+    @OptIn(UnsafeAccessors::class)
+    override fun Pointers.handle() {
+        prefabs.manager.registerPrefab(key, target.entity)
+        target.entity.addRelation<NoInherit, PrefabKey>()
     }
 }

addons/geary-uuid/src/commonMain/kotlin/com/mineinabyss/geary/uuid/systems/TrackUuidOnAdd.kt

@@ -2,25 +2,27 @@ package com.mineinabyss.geary.uuid.systems
 
 import com.benasher44.uuid.Uuid
 import com.benasher44.uuid.uuid4
-import com.mineinabyss.geary.annotations.Handler
+import com.mineinabyss.geary.annotations.optin.UnsafeAccessors
 import com.mineinabyss.geary.systems.GearyListener
-import com.mineinabyss.geary.systems.accessors.TargetScope
+import com.mineinabyss.geary.systems.accessors.Pointers
+
 import com.mineinabyss.geary.uuid.components.RegenerateUUIDOnClash
 import com.mineinabyss.geary.uuid.uuid2Geary
 
 class TrackUuidOnAdd : GearyListener() {
-    private val TargetScope.uuid by onSet<Uuid>().onTarget()
+    var Pointers.uuid by get<Uuid>().whenSetOnTarget()
+    val Pointers.regenerateUUIDOnClash by get<RegenerateUUIDOnClash>().orNull().on(target)
 
-    @Handler
-    private fun TargetScope.track() {
+    @OptIn(UnsafeAccessors::class)
+    override fun Pointers.handle() {
         if (uuid in uuid2Geary)
-            if (entity.has<RegenerateUUIDOnClash>()) {
+            if (regenerateUUIDOnClash != null) {
                 val newUuid = uuid4()
-                entity.set(newUuid)
-                uuid2Geary[newUuid] = entity
-            } else error("Tried tracking entity $entity with already existing uuid $uuid")
+                uuid = newUuid
+                uuid2Geary[newUuid] = target.entity
+            } else error("Tried tracking entity $target.entity with already existing uuid $uuid")
         else
-            uuid2Geary[uuid] = entity
+            uuid2Geary[uuid] = target.entity
     }
 }
 

addons/geary-uuid/src/commonMain/kotlin/com/mineinabyss/geary/uuid/systems/UnTrackUuidOnRemove.kt

@@ -1,20 +1,19 @@
 package com.mineinabyss.geary.uuid.systems
 
 import com.benasher44.uuid.Uuid
-import com.mineinabyss.geary.annotations.Handler
 import com.mineinabyss.geary.components.events.EntityRemoved
+import com.mineinabyss.geary.datatypes.Records
 import com.mineinabyss.geary.datatypes.family.family
 import com.mineinabyss.geary.systems.GearyListener
-import com.mineinabyss.geary.systems.accessors.EventScope
-import com.mineinabyss.geary.systems.accessors.TargetScope
+import com.mineinabyss.geary.systems.accessors.Pointers
+
 import com.mineinabyss.geary.uuid.uuid2Geary
 
 class UnTrackUuidOnRemove : GearyListener() {
-    private val TargetScope.uuid by get<Uuid>().onTarget()
-    private val EventScope.removed by family { has<EntityRemoved>() }.onEvent()
+    private val Pointers.uuid by get<Uuid>().on(target)
+    private val Pointers.removed by family { has<EntityRemoved>() }.on(event)
 
-    @Handler
-    private fun TargetScope.untrack() {
+    override fun Pointers.handle() {
         uuid2Geary.remove(uuid)
     }
 }

build.gradle.kts

@@ -17,6 +17,7 @@ allprojects {
 subprojects {
     tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>().configureEach {
         kotlinOptions.freeCompilerArgs += "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
+//        kotlinOptions.freeCompilerArgs += "-Xno-param-assertions"
     }
 }
 

geary-benchmarks/build.gradle.kts

@@ -0,0 +1,62 @@
+import kotlinx.benchmark.gradle.JvmBenchmarkTarget
+import org.jetbrains.kotlin.allopen.gradle.AllOpenExtension
+
+@Suppress("DSL_SCOPE_VIOLATION")
+plugins {
+    id(libs.plugins.mia.kotlin.jvm.get().pluginId)
+//    id(libs.plugins.mia.publication.get().pluginId)
+//    alias(libs.plugins.kotlinx.serialization)
+    id("org.jetbrains.kotlinx.benchmark") version "0.4.9"
+    kotlin("plugin.allopen") version "1.8.20"
+}
+
+configure<AllOpenExtension> {
+    annotation("org.openjdk.jmh.annotations.State")
+}
+
+dependencies {
+    implementation(project(":geary-core"))
+    implementation("org.jetbrains.kotlinx:kotlinx-benchmark-runtime:0.4.9")
+}
+
+benchmark {
+    configurations {
+        named("main") {
+            exclude("jvmTesting")
+            warmups = 3
+            iterations = 3
+            iterationTime = 5
+            iterationTimeUnit = "sec"
+        }
+
+        create("fast") {
+            exclude("jvmTesting")
+            warmups = 1
+            iterations = 1
+            iterationTime = 3
+            iterationTimeUnit = "sec"
+        }
+
+        create("fastest") {
+            exclude("jvmTesting")
+            warmups = 1
+            iterations = 1
+            iterationTime = 3
+            iterationTimeUnit = "sec"
+        }
+
+        create("specific") {
+            include("Unpack")
+            warmups = 1
+            iterations = 1
+            iterationTime = 3
+            iterationTimeUnit = "sec"
+        }
+    }
+    targets {
+        register("main") {
+            this as JvmBenchmarkTarget
+            jmhVersion = "1.21"
+        }
+    }
+}