Concrete types (#21)

* get custom types working

* shadow + tests

* polish

* return empty array when creating a struct whose template doesn't exist

* comment out local test

* keep classes/classinfos around and re-use to avoid stale references, add converters from Struct to subclasses.

* handle chained converters

* struct copy docs

Author: sovdeeth

build.gradle

@@ -2,6 +2,8 @@ import org.apache.tools.ant.filters.ReplaceTokens
 
 plugins {
     id 'java'
+//    id 'skript-test' version('1.0.1')
+    id 'com.gradleup.shadow' version('9.2.2')
 }
 
 group = 'com.sovdee'
@@ -12,6 +14,7 @@ test {
 
 repositories {
     mavenCentral()
+    mavenLocal()
     maven {
         url 'https://repo.papermc.io/repository/maven-public/'
     }
@@ -21,14 +24,31 @@ repositories {
 }
 
 dependencies {
-    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
-    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
-
     compileOnly 'org.spigotmc:spigot-api:1.21.4-R0.1-SNAPSHOT'
-    compileOnly "com.github.SkriptLang:Skript:2.11.0"
+    compileOnly "com.github.SkriptLang:Skript:2.12.2"
     compileOnly 'org.jetbrains:annotations:26.0.1'
+    implementation 'net.bytebuddy:byte-buddy:1.14.18' // for runtime code generation
 }
 
 processResources {
     filter ReplaceTokens, tokens: ["version": project.property("version")]
 }
+
+shadowJar {
+    relocate 'net.bytebuddy', 'com.sovdee.oopsk.bytebuddy'
+    minimize()
+    archiveClassifier.set('')
+}
+
+build {
+    dependsOn shadowJar
+}
+
+
+//skriptTest {
+//    dependsOn build
+//    testScriptDirectory = file("src/test/scripts")
+//    extraPluginsDirectory = new File("./build/libs")
+//    skriptRepoRef = "dev/patch"
+//    runVanillaTests = false
+//}

settings.gradle

@@ -1 +1,10 @@
+pluginManagement {
+    repositories {
+        mavenLocal()
+        gradlePluginPortal()
+    }
+}
+
 rootProject.name = 'oopsk'
+
+

src/main/java/com/sovdee/oopsk/Oopsk.java

@@ -5,6 +5,7 @@
 import ch.njol.skript.bstats.bukkit.Metrics;
 import com.sovdee.oopsk.core.StructManager;
 import com.sovdee.oopsk.core.TemplateManager;
+import com.sovdee.oopsk.core.generation.TemporaryClassManager;
 import org.bukkit.plugin.java.JavaPlugin;
 
 import java.io.IOException;
@@ -16,6 +17,7 @@ public final class Oopsk extends JavaPlugin {
     private static SkriptAddon addon;
     private static StructManager structManager;
     private static TemplateManager templateManager;
+    private static TemporaryClassManager classManager = new TemporaryClassManager();
     private static Logger logger;
 
     public static Oopsk getInstance() {
@@ -34,6 +36,10 @@ public static TemplateManager getTemplateManager() {
         return templateManager;
     }
 
+    public static TemporaryClassManager getClassManager() {
+        return classManager;
+    }
+
     public static void info(String message) {
         logger.info(message);
     }

src/main/java/com/sovdee/oopsk/core/Struct.java

@@ -22,14 +22,41 @@ public class Struct {
     private StructTemplate template;
     private final Map<Field<?>, Object[]> fieldValues;
 
+    public static Struct newInstance(@NotNull StructTemplate template, @Nullable Event event) {
+        Class<? extends Struct> structClass = template.getCustomClass();
+        try {
+            return structClass.getDeclaredConstructor(StructTemplate.class, Event.class).newInstance(template, event);
+        } catch (Exception e) {
+            throw new RuntimeException("Failed to create new instance of struct class " + structClass.getName(), e);
+        }
+    }
+
+    public static Struct newInstance(Struct source) {
+        Class<? extends Struct> structClass = source.getTemplate().getCustomClass();
+        try {
+            return structClass.getDeclaredConstructor(Struct.class).newInstance(source);
+        } catch (Exception e) {
+            throw new RuntimeException("Failed to create new instance of struct class " + structClass.getName(), e);
+        }
+    }
+
+    public static Struct newInstance(@NotNull StructTemplate template, @Nullable Event event, @Nullable Map<String, Expression<?>> initialValues) {
+        Class<? extends Struct> structClass = template.getCustomClass();
+        try {
+            return structClass.getDeclaredConstructor(StructTemplate.class, Event.class, Map.class).newInstance(template, event, initialValues);
+        } catch (Exception e) {
+            throw new RuntimeException("Failed to create new instance of struct class " + structClass.getName(), e);
+        }
+    }
+
     /**
      * Creates a new struct with the given template and event.
      *
      * @param template The template to create the struct from.
      * @param event    The event to evaluate the default values in.
      * @see StructManager#createStruct(StructTemplate, Event)
      */
-    public Struct(@NotNull StructTemplate template, @Nullable Event event) {
+    protected Struct(@NotNull StructTemplate template, @Nullable Event event) {
         this.template = template;
         fieldValues = new HashMap<>();
         for (Field<?> field : template.getFields()) {
@@ -44,7 +71,7 @@ public Struct(@NotNull StructTemplate template, @Nullable Event event) {
      * @param source The struct to copy from.
      * @see StructManager#createStruct(StructTemplate, Event)
      */
-    public Struct(Struct source) {
+    protected Struct(Struct source) {
         this.template = source.template;
         fieldValues = new HashMap<>();
         for (Map.Entry<Field<?>, Object[]> entry : source.fieldValues.entrySet()) {
@@ -64,7 +91,7 @@ public Struct(Struct source) {
      * @param initialValues The initial values to set in the struct. This is a map of field names to expressions.
      * @see StructManager#createStruct(StructTemplate, Event)
      */
-    Struct(@NotNull StructTemplate template, @Nullable Event event, @Nullable Map<String, Expression<?>> initialValues) {
+    protected Struct(@NotNull StructTemplate template, @Nullable Event event, @Nullable Map<String, Expression<?>> initialValues) {
         this.template = template;
         fieldValues = new HashMap<>();
         for (Field<?> field : template.getFields()) {

src/main/java/com/sovdee/oopsk/core/StructManager.java

@@ -41,7 +41,7 @@ public Struct createStruct(StructTemplate template, @Nullable Event event) {
      * @return The created struct.
      */
     public Struct createStruct(StructTemplate template, @Nullable Event event, @Nullable Map<String, Expression<?>> initialValues) {
-        Struct struct = new Struct(template, event, initialValues);
+        Struct struct = Struct.newInstance(template, event, initialValues);
         activeStructs.computeIfAbsent(template, k -> Collections.newSetFromMap(new WeakHashMap<>())).add(struct);
         return struct;
     }

src/main/java/com/sovdee/oopsk/core/StructTemplate.java

@@ -14,15 +14,17 @@
 public class StructTemplate {
     private final String name;
     private final Map<String, Field<?>> fields;
+    private final Class<? extends Struct> customClass;
 
     /**
      * Creates a new struct template with the given name and fields.
      *
      * @param name   The name of the template.
      * @param fields The fields of the template.
      */
-    public StructTemplate(String name, @NotNull List<Field<?>> fields) {
+    public StructTemplate(String name, @NotNull List<Field<?>> fields, Class<? extends Struct> customClass) {
         this.name = name;
+        this.customClass = customClass;
         this.fields = new HashMap<>();
         for (Field<?> field : fields) {
             this.fields.put(field.name(), field);
@@ -36,6 +38,13 @@ public String getName() {
         return name;
     }
 
+    /**
+     * @return The custom class for this struct, or null if none was specified.
+     */
+    public Class<? extends Struct> getCustomClass() {
+        return customClass;
+    }
+
     /**
      * Parses all the default value expressions for this struct. Prints errors.
      * @return true if no errors were encountered. False otherwise.

src/main/java/com/sovdee/oopsk/core/TemplateManager.java

@@ -18,6 +18,7 @@
 public class TemplateManager {
 
     private final Map<String, StructTemplate> templates = new HashMap<>();
+    private final Map<Class<? extends Struct>, StructTemplate> templatesByClass = new HashMap<>();
 
     /**
      * Adds a new template to the manager. Attempts to reparent all orphaned structs that match this template's name.
@@ -29,6 +30,7 @@ public boolean addTemplate(@NotNull StructTemplate template) {
         if (templates.containsKey(template.getName()))
             return false; // Template with the same name already exists
         templates.put(template.getName(), template);
+        templatesByClass.put(template.getCustomClass(), template);
         // reparent all orphaned structs of this template
         Oopsk.getStructManager().reparentStructs(template);
         return true; // Template added successfully
@@ -44,6 +46,16 @@ public StructTemplate getTemplate(String name) {
         return templates.get(name);
     }
 
+    /**
+     * Retrieves a template by class.
+     *
+     * @param structClass The name of the template to retrieve.
+     * @return The template, or null if it does not exist.
+     */
+    public StructTemplate getTemplate(Class<?extends Struct> structClass) {
+        return templatesByClass.get(structClass);
+    }
+
     /**
      * Removes a template from the manager. This will orphan all structs of this template.
      *
@@ -54,6 +66,7 @@ public void removeTemplate(@NotNull StructTemplate template) {
         if (!templates.containsKey(name))
             return; // Template with the given name does not exist
         templates.remove(name);
+        templatesByClass.remove(template.getCustomClass());
         // mark all structs of this template as orphaned
         Oopsk.getStructManager().orphanStructs(template);
     }