feat: swap event generation to source-based generation

Still being validated, we have event generation that can run as an
Annotation Processor, which has the benefits of producing closer to usage
events with generics that survive their usages. This enables
CompositeEvent to be near-fully implemented.

Author: gabizou

.gitignore

@@ -4,6 +4,9 @@ MANIFEST.MF
 dependency-reduced-pom.xml
 .checkstyle
 !.checkstyle/
+# We exclude the generated events from git to avoid
+# temptation to edit said generated files.
+src/main/generated/
 
 # Compiled #
 ############

build.gradle.kts

@@ -3,11 +3,6 @@ import org.jetbrains.gradle.ext.delegateActions
 import org.jetbrains.gradle.ext.settings
 import org.jetbrains.gradle.ext.taskTriggers
 
-buildscript {
-    dependencies {
-        classpath(libs.spoon) // bump for EIG
-    }
-}
 
 plugins {
     eclipse
@@ -21,6 +16,9 @@ plugins {
     alias(libs.plugins.nexusPublish)
 }
 
+// Enable event generation to be considered part of
+// the main source set
+val generatedEventSourcesDir = project.file("src/main/generated")
 val javaTarget: String by project
 val ap by sourceSets.registering {
     compileClasspath += sourceSets.main.get().compileClasspath + sourceSets.main.get().output
@@ -46,7 +44,7 @@ tasks {
 
 sourceSets {
     main {
-        java.srcDirs(layout.buildDirectory.dir("generated/sources/annotationProcessor/java/main"))
+        java.srcDirs(generatedEventSourcesDir)
     }
 }
 
@@ -150,33 +148,14 @@ dependencies {
 tasks {
 
     compileJava {
+        options.generatedSourceOutputDirectory = generatedEventSourcesDir
         options.compilerArgs.addAll(listOf(
+            "-AeventGenInclusiveFolders=org/spongepowered/api/event",
+            "-AeventGenExclusiveFolders=org/spongepowered/api/event/cause,org/spongepowered/api/event/filter,org/spongepowered/api/event/impl,org/spongepowered/api/event/lifecycle",
             "-AeventGenFactory=org.spongepowered.api.event.SpongeEventFactory",
             "-AeventGenDebug=true",
         ))
     }
-//    genEventImpl {
-//        sourceCompatibility = javaTarget
-//        destinationDirectory = project.layout.buildDirectory.dir("generated/event-factory")
-//
-//        outputFactory = "org.spongepowered.api.event.SpongeEventFactory"
-//        include("org/spongepowered/api/event/*/**/*")
-//        include("org/spongepowered/api/event/CompositeEvent.java")
-//        exclude("org/spongepowered/api/event/action/InteractEvent.java")
-//        exclude("org/spongepowered/api/event/cause/")
-//        exclude("org/spongepowered/api/event/entity/AffectEntityEvent.java")
-//        exclude("org/spongepowered/api/event/filter/")
-//        exclude("org/spongepowered/api/event/impl/")
-//        exclude("org/spongepowered/api/event/lifecycle/ProvideServiceEvent.java")
-//        exclude("org/spongepowered/api/event/lifecycle/RegisterBuilderEvent.java")
-//        exclude("org/spongepowered/api/event/lifecycle/RegisterRegistryEvent.java")
-//        exclude("org/spongepowered/api/event/lifecycle/RegisterRegistryValueEvent.java")
-//        exclude("org/spongepowered/api/event/lifecycle/RegisterCommandEvent.java")
-//        exclude("org/spongepowered/api/event/lifecycle/RegisterFactoryEvent.java")
-//        exclude("org/spongepowered/api/event/lifecycle/RegisterWorldEvent.java")
-//        inclusiveAnnotations = setOf("org.spongepowered.api.util.annotation.eventgen.GenerateFactoryMethod")
-//        exclusiveAnnotations = setOf("org.spongepowered.api.util.annotation.eventgen.NoFactoryMethod")
-//    }
 
     jar {
         from(ap.get().output)

gradle/libs.versions.toml

@@ -45,7 +45,6 @@ eventImplGen-annotations = { module = "org.spongepowered:event-impl-gen-annotati
 checkerQual = { module = "org.checkerframework:checker-qual", version.ref = "checker" }
 errorprone = { module = "com.google.errorprone:error_prone_core", version.ref = "errorprone" }
 errorprone-annotations = { module = "com.google.errorprone:error_prone_annotations", version.ref = "errorprone" }
-spoon = { module = "fr.inria.gforge.spoon:spoon-core", version = "10.4.2" } # bump for EIG
 
 # testing
 

gradle/verification-metadata.xml

@@ -264,6 +264,14 @@
             <sha256 value="ca6529bd6d79090f0ab6f5da452eb4fbb29377b48e6a806e7612396dcb2998e0" origin="Generated by Gradle"/>
          </artifact>
       </component>
+      <component group="com.google.dagger" name="dagger" version="2.52">
+         <artifact name="dagger-2.52.jar">
+            <sha256 value="dfb8e83020786daefbd64335ce0e0ebf01646a1b407fb77a27e052baf42df458" origin="Generated by Gradle"/>
+         </artifact>
+         <artifact name="dagger-2.52.pom">
+            <sha256 value="5cb60843f46bbccf97bd832d5490d26ab192af2e663fad7e5971969bf20fb94e" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
       <component group="com.google.errorprone" name="error_prone_annotation" version="2.24.1">
          <artifact name="error_prone_annotation-2.24.1.jar">
             <sha256 value="dc202da451680aa8cdda7c68d959f27c112dca8f8fdeaf7c597de73cb2b1a0a6" origin="Generated by Gradle"/>
@@ -748,6 +756,22 @@
             <sha256 value="5a65e06a159d20d3b4800624a570c646dbee710b2b539b3449a268558c289e9c" origin="Generated by Gradle"/>
          </artifact>
       </component>
+      <component group="io.soabase.java-composer" name="java-composer" version="1.0">
+         <artifact name="java-composer-1.0.jar">
+            <sha256 value="d914e52079c41509cde32d8fa03b5a865d8a227867ed6fd5d8121639518d28a1" origin="Generated by Gradle"/>
+         </artifact>
+         <artifact name="java-composer-1.0.pom">
+            <sha256 value="741a35966a3055c80c10631736c6cfec82d7b5e4212b3f72ded29f98935bbb5e" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
+      <component group="jakarta.inject" name="jakarta.inject-api" version="2.0.1">
+         <artifact name="jakarta.inject-api-2.0.1.jar">
+            <sha256 value="f7dc98062fccf14126abb751b64fab12c312566e8cbdc8483598bffcea93af7c" origin="Generated by Gradle"/>
+         </artifact>
+         <artifact name="jakarta.inject-api-2.0.1.pom">
+            <sha256 value="e7fd7232e96307a575b2494c9367d68cf43ec98244aace3ccc23e1773ffa6fda" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
       <component group="jakarta.platform" name="jakarta.jakartaee-bom" version="9.1.0">
          <artifact name="jakarta.jakartaee-bom-9.1.0.pom">
             <sha256 value="df98e0266219fdbb82562826d79a3a20776a8ba02aa787f0f0765a538654c8a4" origin="Generated by Gradle"/>
@@ -1512,6 +1536,9 @@
          <artifact name="apiguardian-api-1.1.2.module">
             <sha256 value="e08028131375b357d1d28734e9a4fb4216da84b240641cb3ef7e7c7d628223fc" origin="Generated by Gradle"/>
          </artifact>
+         <artifact name="apiguardian-api-1.1.2.pom">
+            <sha256 value="32355081d109095c3d5d374d5a43b4f4c1b75d549e983ef50723e2772e5302a0" origin="Generated by Gradle"/>
+         </artifact>
       </component>
       <component group="org.checkerframework" name="checker-qual" version="2.10.0">
          <artifact name="checker-qual-2.10.0.jar">
@@ -1621,6 +1648,11 @@
             <sha256 value="5e583878df905b5f33a230ef690a52b8f19dab9cc892bedee069f3d8af4e960a" origin="Generated by Gradle"/>
          </artifact>
       </component>
+      <component group="org.eclipse.ee4j" name="project" version="1.0.6">
+         <artifact name="project-1.0.6.pom">
+            <sha256 value="4e7d8329d8da7dcf30779d824241be145f27108932f5a5a24eb907677bc8d72d" origin="Generated by Gradle"/>
+         </artifact>
+      </component>
       <component group="org.eclipse.ee4j" name="project" version="1.0.7">
          <artifact name="project-1.0.7.pom">
             <sha256 value="205c039a42cbae3556efbeb04a483eb3a3cf9550bd75bf84260dc8f28218f105" origin="Generated by Gradle"/>

settings.gradle.kts

@@ -13,6 +13,9 @@ plugins {
 }
 
 dependencyResolutionManagement {
+    repositories {
+        mavenLocal()
+    }
     repositoriesMode = RepositoriesMode.FAIL_ON_PROJECT_REPOS
     pluginManagement.repositories.forEach(repositories::add)
 }

src/main/java/org/spongepowered/api/data/DataManipulator.java

@@ -30,7 +30,7 @@
 import org.spongepowered.api.data.value.Value;
 import org.spongepowered.api.data.value.ValueContainer;
 import org.spongepowered.api.entity.Entity;
-import org.spongepowered.api.util.annotation.eventgen.TransformWith;
+import org.spongepowered.eventgen.annotations.TransformWith;
 import org.spongepowered.api.world.World;
 
 import java.util.Arrays;

src/main/java/org/spongepowered/api/event/Cancellable.java

@@ -24,7 +24,7 @@
  */
 package org.spongepowered.api.event;
 
-import org.spongepowered.api.util.annotation.eventgen.PropertySettings;
+import org.spongepowered.eventgen.annotations.PropertySettings;
 
 /**
  * Represents an event that can be cancelled.

src/main/java/org/spongepowered/api/event/Cause.java

@@ -27,6 +27,7 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.util.CopyableBuilder;
 import org.spongepowered.api.util.annotation.DoNotStore;
+import org.spongepowered.eventgen.annotations.NoFactoryMethod;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -54,6 +55,7 @@
  */
 @DoNotStore
 @SuppressWarnings("unchecked")
+@NoFactoryMethod
 public final class Cause implements Iterable<Object> {
 
     /**

src/main/java/org/spongepowered/api/event/EventContext.java

@@ -27,6 +27,7 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.util.CopyableBuilder;
 import org.spongepowered.api.util.annotation.DoNotStore;
+import org.spongepowered.eventgen.annotations.NoFactoryMethod;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -42,6 +43,7 @@
  * in the event's {@link Cause}.
  */
 @DoNotStore
+@NoFactoryMethod
 public final class EventContext {
 
     private static final EventContext EMPTY_CONTEXT = new EventContext(Map.of());

src/main/java/org/spongepowered/api/event/EventContextKeys.java

@@ -53,6 +53,7 @@
 import org.spongepowered.api.world.portal.PortalLogic;
 import org.spongepowered.api.world.server.ServerLocation;
 import org.spongepowered.api.world.server.ServerWorld;
+import org.spongepowered.eventgen.annotations.NoFactoryMethod;
 import org.spongepowered.math.vector.Vector3d;
 import org.spongepowered.plugin.PluginContainer;
 
@@ -62,6 +63,7 @@
  * Standard keys for use within {@link EventContext}s.
  */
 @SuppressWarnings("unused")
+@NoFactoryMethod
 public final class EventContextKeys {
 
     // @formatter:off