-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat!: initial Folia support - fixes #213 * feat: add Folia plugin management * chore: amend to review * chore: suppress unused in deprecated bootstrap
- Loading branch information
1 parent
ab7d62d
commit f3a6a0c
Showing
19 changed files
with
789 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
...ain/java/dev/hypera/chameleon/annotations/processing/generation/folia/FoliaGenerator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| /* | ||
| * This file is a part of the Chameleon Framework, licensed under the MIT License. | ||
| * | ||
| * Copyright (c) 2021-2023 The Chameleon Framework Authors. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
| package dev.hypera.chameleon.annotations.processing.generation.folia; | ||
|
|
||
| import com.squareup.javapoet.FieldSpec; | ||
| import com.squareup.javapoet.JavaFile; | ||
| import com.squareup.javapoet.MethodSpec; | ||
| import com.squareup.javapoet.TypeSpec; | ||
| import dev.hypera.chameleon.annotations.Plugin; | ||
| import dev.hypera.chameleon.annotations.exception.ChameleonAnnotationException; | ||
| import dev.hypera.chameleon.annotations.processing.generation.Generator; | ||
| import dev.hypera.chameleon.annotations.utils.MapBuilder; | ||
| import dev.hypera.chameleon.exception.instantiation.ChameleonInstantiationException; | ||
| import dev.hypera.chameleon.platform.Platform; | ||
| import java.io.BufferedWriter; | ||
| import java.io.IOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Paths; | ||
| import java.util.Arrays; | ||
| import java.util.Objects; | ||
| import java.util.logging.Level; | ||
| import java.util.stream.Collectors; | ||
| import javax.annotation.processing.ProcessingEnvironment; | ||
| import javax.lang.model.element.Modifier; | ||
| import javax.lang.model.element.PackageElement; | ||
| import javax.lang.model.element.TypeElement; | ||
| import javax.tools.StandardLocation; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.yaml.snakeyaml.Yaml; | ||
|
|
||
| /** | ||
| * Bukkit plugin main class and 'paper-plugin.yml' description file generator. | ||
| */ | ||
| public final class FoliaGenerator extends Generator { | ||
|
|
||
| private static final @NotNull String DESCRIPTION_FILE = "paper-plugin.yml"; | ||
|
|
||
| /** | ||
| * Generate Bukkit plugin main class and 'plugin.yml' description file. | ||
| * | ||
| * @param data {@link Plugin} data | ||
| * @param plugin Chameleon plugin main class | ||
| * @param env Processing environment | ||
| * | ||
| * @throws ChameleonAnnotationException if something goes wrong while creating the files. | ||
| */ | ||
| @Override | ||
| public void generate(@NotNull Plugin data, @NotNull TypeElement plugin, @NotNull ProcessingEnvironment env) throws ChameleonAnnotationException { | ||
| MethodSpec constructorSpec = MethodSpec.constructorBuilder() | ||
| .addModifiers(Modifier.PUBLIC) | ||
| .beginControlFlow("try") | ||
| .addStatement(createPluginData(data)) | ||
| .addStatement("this.$N = $T.createFoliaBootstrap($T.class, this, $N).load()", CHAMELEON_VAR, clazz("dev.hypera.chameleon.platform.folia", "FoliaChameleon"), plugin, "pluginData") | ||
| .nextControlFlow("catch ($T ex)", ChameleonInstantiationException.class) | ||
| .addStatement("getLogger().log($T.SEVERE, \"An error occurred while loading Chameleon\", $N)", Level.class, "ex") | ||
| .addStatement("throw new $T($N)", clazz("dev.hypera.chameleon.exception", "ChameleonRuntimeException"), "ex") | ||
| .endControlFlow() | ||
| .build(); | ||
|
|
||
| MethodSpec enableSpec = MethodSpec.methodBuilder("onEnable") | ||
| .addAnnotation(Override.class).addModifiers(Modifier.PUBLIC) | ||
| .addStatement("this.$N.onEnable()", CHAMELEON_VAR).build(); | ||
|
|
||
| MethodSpec disableSpec = MethodSpec.methodBuilder("onDisable") | ||
| .addAnnotation(Override.class).addModifiers(Modifier.PUBLIC) | ||
| .addStatement("this.$N.onDisable()", CHAMELEON_VAR).build(); | ||
|
|
||
| TypeSpec foliaMainClassSpec = TypeSpec.classBuilder(plugin.getSimpleName() + "Folia") | ||
| .addModifiers(Modifier.PUBLIC, Modifier.FINAL) | ||
| .superclass(clazz("org.bukkit.plugin.java", "JavaPlugin")) | ||
| .addField(FieldSpec.builder(clazz("dev.hypera.chameleon.platform.folia", "FoliaChameleon"), CHAMELEON_VAR, Modifier.PRIVATE).build()) | ||
| .addMethod(constructorSpec) | ||
| .addMethod(enableSpec) | ||
| .addMethod(disableSpec) | ||
| .build(); | ||
|
|
||
| String packageName = Objects.requireNonNull((PackageElement) plugin.getEnclosingElement()).getQualifiedName().toString(); | ||
| if (packageName.endsWith("core") || packageName.endsWith("common")) { | ||
| packageName = packageName.substring(0, packageName.lastIndexOf(".")); | ||
| } | ||
| packageName = packageName + ".platform.folia"; | ||
|
|
||
| try { | ||
| JavaFile.builder(packageName, foliaMainClassSpec).indent(INDENT).build().writeTo(env.getFiler()); | ||
| generateDescriptionFile(data, plugin, env, packageName); | ||
| } catch (IOException ex) { | ||
| throw new ChameleonAnnotationException("Failed to write main class or description file", ex); | ||
| } | ||
| } | ||
|
|
||
| private void generateDescriptionFile(@NotNull Plugin data, @NotNull TypeElement plugin, @NotNull ProcessingEnvironment env, @NotNull String packageName) throws IOException { | ||
| try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(env.getFiler().createResource(StandardLocation.CLASS_OUTPUT, "", DESCRIPTION_FILE).toUri()))) { | ||
| new Yaml().dump(new MapBuilder<String, Object>().add("name", data.name().isEmpty() ? data.id() : data.name()) | ||
| .add("main", packageName + "." + plugin.getSimpleName() + "Folia") | ||
| .add("version", data.version()) | ||
| .add("api-version", "1.19") | ||
| .add("author", data.authors().length > 0 ? String.join(", ", data.authors()) : "Unknown") | ||
| .add("authors", data.authors()) | ||
| .add("website", data.url()) | ||
| .add("dependencies", Arrays.stream(data.dependencies()) | ||
| .filter(d -> (d.platforms().length == 0 || Arrays.asList(d.platforms()).contains(Platform.FOLIA))) | ||
| .map(d -> new MapBuilder<String, Object>() | ||
| .add("name", d.name()) | ||
| .add("required", !d.soft()) | ||
| ).collect(Collectors.toList())) | ||
| .add("description", data.description()) | ||
| .add("folia-supported", "true"), writer); | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| /* | ||
| * This file is a part of the Chameleon Framework, licensed under the MIT License. | ||
| * | ||
| * Copyright (c) 2021-2023 The Chameleon Framework Authors. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
| plugins { | ||
| id("chameleon.common") | ||
| id("java-library") | ||
| } | ||
|
|
||
| repositories { | ||
| maven("https://hub.spigotmc.org/nexus/content/repositories/snapshots/") | ||
| maven("https://repo.papermc.io/repository/maven-public/") | ||
| } | ||
|
|
||
| dependencies { | ||
| api(project(":chameleon-platform-bukkit")) | ||
| compileOnlyApi(libs.platform.folia) | ||
| } |
Oops, something went wrong.