Feature/registry classes

src/main/java/ch/njol/skript/classes/data/BukkitClasses.java

@@ -38,6 +38,7 @@
 import org.bukkit.Location;
 import org.bukkit.Material;
 import org.bukkit.OfflinePlayer;
+import org.bukkit.Registry;
 import org.bukkit.SoundCategory;
 import org.bukkit.World;
 import org.bukkit.World.Environment;
@@ -77,7 +78,6 @@
 import org.bukkit.potion.PotionEffectType;
 import org.bukkit.util.CachedServerIcon;
 import org.bukkit.util.Vector;
-import org.eclipse.jdt.annotation.Nullable;
 
 import ch.njol.skript.Skript;
 import ch.njol.skript.SkriptConfig;
@@ -90,6 +90,7 @@
 import ch.njol.skript.classes.EnumClassInfo;
 import ch.njol.skript.classes.Parser;
 import ch.njol.skript.classes.Serializer;
+import ch.njol.skript.classes.registry.RegistryClassInfo;
 import ch.njol.skript.entity.EntityData;
 import ch.njol.skript.expressions.ExprDamageCause;
 import ch.njol.skript.expressions.base.EventValueExpression;
@@ -104,6 +105,7 @@
 import ch.njol.util.StringUtils;
 import ch.njol.yggdrasil.Fields;
 import io.papermc.paper.world.MoonPhase;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * @author Peter Güttinger
@@ -976,8 +978,14 @@ public String toVariableNameString(final ItemStack i) {
 				.name(ClassInfo.NO_DOC)
 				.since("2.0")
 				.changer(DefaultChangers.itemChanger));
-
-		Classes.registerClass(new EnumClassInfo<>(Biome.class, "biome", "biomes")
+
+		ClassInfo<?> biomeClassInfo;
+		if (Skript.classExists("org.bukkit.Registry") && Skript.fieldExists(Registry.class, "BIOME")) {
+			biomeClassInfo = new RegistryClassInfo<>(Biome.class, Registry.BIOME, "biome", "biomes");
+		} else {
+			biomeClassInfo = new EnumClassInfo<>(Biome.class, "biome", "biomes");
+		}
+		Classes.registerClass(biomeClassInfo
 				.user("biomes?")
 				.name("Biome")
 				.description("All possible biomes Minecraft uses to generate a world.")

src/main/java/ch/njol/skript/classes/registry/RegistryClassInfo.java

@@ -0,0 +1,73 @@
+/**
+ *   This file is part of Skript.
+ *
+ *  Skript is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Skript is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright Peter Güttinger, SkriptLang team and contributors
+ */
+package ch.njol.skript.classes.registry;
+
+import ch.njol.skript.classes.ClassInfo;
+import ch.njol.skript.classes.Parser;
+import ch.njol.skript.expressions.base.EventValueExpression;
+import ch.njol.skript.lang.DefaultExpression;
+import ch.njol.skript.lang.ParseContext;
+import org.bukkit.Keyed;
+import org.bukkit.Registry;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * This class can be used for an easier writing of ClassInfos that are registries,
+ * it registers a language node with usage, a serializer, default expression and a parser.
+ * Making it easier to register registry ClassInfos.
+ *
+ * @param <R> The Registry class.
+ */
+public class RegistryClassInfo<R extends Keyed> extends ClassInfo<R> {
+
+	public RegistryClassInfo(Class<R> registryClass, Registry<R> registry, String codeName, String languageNode) {
+		this(registryClass, registry, codeName, languageNode, new EventValueExpression<>(registryClass));
+	}
+
+	/**
+	 * @param registry The registry
+	 * @param codeName The name used in patterns
+	 */
+	public RegistryClassInfo(Class<R> registryClass, Registry<R> registry, String codeName, String languageNode, DefaultExpression<R> defaultExpression) {
+		super(registryClass, codeName);
+		RegistryUtils<R> registryUtils = new RegistryUtils<>(registry, languageNode);
+		usage(registryUtils.getAllNames())
+			.serializer(new RegistrySerializer<R>(registry))
+			.defaultExpression(defaultExpression)
+			.parser(new Parser<R>() {
+
+				@Override
+				public @Nullable R parse(String string, ParseContext context) {
+					return registryUtils.parse(string);
+				}
+
+				@Override
+				public @NotNull String toString(R object, int flags) {
+					return registryUtils.toString(object, flags);
+				}
+
+				@Override
+				public @NotNull String toVariableNameString(R object) {
+					return toString(object, 0);
+				}
+			});
+	}
+
+}

src/main/java/ch/njol/skript/classes/registry/RegistrySerializer.java

@@ -0,0 +1,84 @@
+/**
+ *   This file is part of Skript.
+ *
+ *  Skript is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Skript is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright Peter Güttinger, SkriptLang team and contributors
+ */
+package ch.njol.skript.classes.registry;
+
+import ch.njol.skript.classes.Serializer;
+import ch.njol.yggdrasil.Fields;
+import org.bukkit.Keyed;
+import org.bukkit.NamespacedKey;
+import org.bukkit.Registry;
+
+import java.io.StreamCorruptedException;
+
+/**
+ * Serializer for {@link RegistryClassInfo}
+ *
+ * @param <R> Registry class
+ */
+public class RegistrySerializer<R extends Keyed> extends Serializer<R> {
+
+	private final Registry<R> registry;
+
+	public RegistrySerializer(Registry<R> registry) {
+		this.registry = registry;
+	}
+
+	@Override
+	public Fields serialize(R o) {
+		Fields fields = new Fields();
+		fields.putPrimitive("name", o.getKey().toString());
+		return null;
+	}
+
+	@Override
+	protected R deserialize(Fields fields) {
+		try {
+			String name = fields.getAndRemovePrimitive("name", String.class);
+			NamespacedKey namespacedKey;
+			if (!name.contains(":")) {
+				// Old variables
+				namespacedKey = NamespacedKey.minecraft(name);
+			} else {
+				namespacedKey = NamespacedKey.fromString(name);
+			}
+			if (namespacedKey == null)
+				return null;
+
+			return registry.get(namespacedKey);
+		} catch (StreamCorruptedException e) {
+			return null;
+		}
+	}
+
+	@Override
+	public boolean mustSyncDeserialization() {
+		return false;
+	}
+
+	@Override
+	protected boolean canBeInstantiated() {
+		return false;
+	}
+
+	@Override
+	public void deserialize(R o, Fields f) {
+		throw new UnsupportedOperationException();
+	}
+
+}

src/main/java/ch/njol/skript/classes/registry/RegistryUtils.java

@@ -0,0 +1,134 @@
+/**
+ *   This file is part of Skript.
+ *
+ *  Skript is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Skript is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright Peter Güttinger, SkriptLang team and contributors
+ */
+package ch.njol.skript.classes.registry;
+
+import ch.njol.skript.localization.Language;
+import ch.njol.skript.localization.Noun;
+import ch.njol.util.NonNullPair;
+import ch.njol.util.StringUtils;
+import org.bukkit.Keyed;
+import org.bukkit.NamespacedKey;
+import org.bukkit.Registry;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.HashMap;
+import java.util.Locale;
+import java.util.Map;
+
+/**
+ * Utility class for {@link Registry}
+ *
+ * @param <R> Registry class
+ */
+public class RegistryUtils<R extends Keyed> {
+
+	private final Registry<R> registry;
+	private final String languageNode;
+
+	private final Map<R, String> names = new HashMap<>();
+	private final Map<String, R> parseMap = new HashMap<>();
+
+	public RegistryUtils(Registry<R> registry, String languageNode) {
+		assert !languageNode.isEmpty() && !languageNode.endsWith(".") : languageNode;
+		this.registry = registry;
+		this.languageNode = languageNode;
+		refresh();
+		Language.addListener(this::refresh);
+	}
+
+	private void refresh() {
+		names.clear();
+		parseMap.clear();
+		for (R registryObject : registry) {
+			NamespacedKey namespacedKey = registryObject.getKey();
+			String namespace = namespacedKey.getNamespace();
+			String key = namespacedKey.getKey();
+			String keyWithSpaces = key.replace("_", " ");
+			String languageKey = languageNode + "." + key;
+
+			// Put the full namespaced key as a pattern
+			parseMap.put(namespacedKey.toString(), registryObject);
+
+			// If the object is a vanilla Minecraft object, we'll add the key with spaces as a pattern
+			if (namespace.equalsIgnoreCase(NamespacedKey.MINECRAFT)) {
+				parseMap.put(keyWithSpaces, registryObject);
+			}
+
+			String[] options = Language.getList(languageKey);
+			// Missing/Custom registry objects
+			if (options.length == 1 && options[0].equals(languageKey.toLowerCase(Locale.ENGLISH))) {
+				if (namespace.equalsIgnoreCase(NamespacedKey.MINECRAFT)) {
+					// If the object is a vanilla Minecraft object, we'll use the key with spaces as a name
+					names.put(registryObject, keyWithSpaces);
+				} else {
+					// If the object is a custom object, we'll use the full namespaced key as a name
+					names.put(registryObject, namespacedKey.toString());
+				}
+			} else {
+				for (String option : options) {
+					option = option.toLowerCase(Locale.ENGLISH);
+
+					// Isolate the gender if one is present
+					NonNullPair<String, Integer> strippedOption = Noun.stripGender(option, languageKey);
+					String first = strippedOption.getFirst();
+					Integer second = strippedOption.getSecond();
+
+					// Add to name map if needed
+					names.putIfAbsent(registryObject, first);
+
+					parseMap.put(first, registryObject);
+					if (second != -1) { // There is a gender present
+						parseMap.put(Noun.getArticleWithSpace(second, Language.F_INDEFINITE_ARTICLE) + first, registryObject);
+					}
+				}
+			}
+		}
+	}
+
+	/**
+	 * This method attempts to match the string input against one of the string representations of the registry.
+	 *
+	 * @param input a string to attempt to match against one in the registry.
+	 * @return The registry object matching the input, or null if no match could be made.
+	 */
+	@Nullable
+	public R parse(String input) {
+		return parseMap.get(input.toLowerCase(Locale.ENGLISH));
+	}
+
+	/**
+	 * This method returns the string representation of a registry.
+	 *
+	 * @param object The object to represent as a string.
+	 * @param flags  not currently used
+	 * @return A string representation of the registry object.
+	 */
+	public String toString(R object, int flags) {
+		return names.get(object);
+	}
+
+	/**
+	 * @return A comma-separated string containing a list of all names representing the registry.
+	 * Note that some entries may represent the same registry object.
+	 */
+	public String getAllNames() {
+		return StringUtils.join(parseMap.keySet(), ", ");
+	}
+
+}