New Registration API

src/main/java/ch/njol/skript/SkriptAddon.java

@@ -23,46 +23,55 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import org.bukkit.Bukkit;
+import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.eclipse.jdt.annotation.Nullable;
 
-import ch.njol.skript.localization.Language;
 import ch.njol.skript.util.Utils;
 import ch.njol.skript.util.Version;
+import org.jetbrains.annotations.ApiStatus;
+import org.skriptlang.skript.localization.Localizer;
+import org.skriptlang.skript.registration.SyntaxRegistry;
 
 /**
  * Utility class for Skript addons. Use {@link Skript#registerAddon(JavaPlugin)} to create a SkriptAddon instance for your plugin.
  */
-public final class SkriptAddon {
+public class SkriptAddon implements org.skriptlang.skript.addon.SkriptAddon {
 
 	public final JavaPlugin plugin;
 	public final Version version;
 	private final String name;
 
+	private final org.skriptlang.skript.addon.SkriptAddon addon;
+
 	/**
 	 * Package-private constructor. Use {@link Skript#registerAddon(JavaPlugin)} to get a SkriptAddon for your plugin.
-	 * 
-	 * @param p
 	 */
-	SkriptAddon(final JavaPlugin p) {
-		plugin = p;
-		name = "" + p.getName();
-		Version v;
+	SkriptAddon(JavaPlugin plugin) {
+		this(plugin, Skript.instance().registerAddon(plugin.getName()));
+	}
+
+	SkriptAddon(JavaPlugin plugin, org.skriptlang.skript.addon.SkriptAddon addon) {
+		this.addon = addon;
+		this.plugin = plugin;
+		this.name = plugin.getName();
+		Version version;
 		try {
-			v = new Version("" + p.getDescription().getVersion());
-		} catch (final IllegalArgumentException e) {
-			final Matcher m = Pattern.compile("(\\d+)(?:\\.(\\d+)(?:\\.(\\d+))?)?").matcher(p.getDescription().getVersion());
+			version = new Version(plugin.getDescription().getVersion());
+		} catch (IllegalArgumentException e) {
+			final Matcher m = Pattern.compile("(\\d+)(?:\\.(\\d+)(?:\\.(\\d+))?)?").matcher(plugin.getDescription().getVersion());
 			if (!m.find())
-				throw new IllegalArgumentException("The version of the plugin " + p.getName() + " does not contain any numbers: " + p.getDescription().getVersion());
-			v = new Version(Utils.parseInt("" + m.group(1)), m.group(2) == null ? 0 : Utils.parseInt("" + m.group(2)), m.group(3) == null ? 0 : Utils.parseInt("" + m.group(3)));
-			Skript.warning("The plugin " + p.getName() + " uses a non-standard version syntax: '" + p.getDescription().getVersion() + "'. Skript will use " + v + " instead.");
+				throw new IllegalArgumentException("The version of the plugin " + name + " does not contain any numbers: " + plugin.getDescription().getVersion());
+			version = new Version(Utils.parseInt(m.group(1)), m.group(2) == null ? 0 : Utils.parseInt(m.group(2)), m.group(3) == null ? 0 : Utils.parseInt(m.group(3)));
+			Skript.warning("The plugin " + name + " uses a non-standard version syntax: '" + plugin.getDescription().getVersion() + "'. Skript will use " + version + " instead.");
 		}
-		version = v;
+		this.version = version;
 	}
 
 	@Override
 	public final String toString() {
-		return name;
+		return getName();
 	}
 
 	public String getName() {
@@ -83,9 +92,6 @@ public SkriptAddon loadClasses(String basePackage, String... subPackages) throws
 		return this;
 	}
 
-	@Nullable
-	private String languageFileDirectory = null;
-
 	/**
 	 * Makes Skript load language files from the specified directory, e.g. "lang" or "skript lang" if you have a lang folder yourself. Localised files will be read from the
 	 * plugin's jar and the plugin's data folder, but the default English file is only taken from the jar and <b>must</b> exist!
@@ -94,19 +100,13 @@ public SkriptAddon loadClasses(String basePackage, String... subPackages) throws
 	 * @return This SkriptAddon
 	 */
 	public SkriptAddon setLanguageFileDirectory(String directory) {
-		if (languageFileDirectory != null)
-			throw new IllegalStateException();
-		directory = "" + directory.replace('\\', '/');
-		if (directory.endsWith("/"))
-			directory = "" + directory.substring(0, directory.length() - 1);
-		languageFileDirectory = directory;
-		Language.loadDefault(this);
+		localizer().setSourceDirectories(plugin.getClass(), directory, plugin.getDataFolder().getAbsolutePath() + directory);
 		return this;
 	}
 
 	@Nullable
 	public String getLanguageFileDirectory() {
-		return languageFileDirectory;
+		return localizer().languageFileDirectory();
 	}
 
 	@Nullable
@@ -126,4 +126,38 @@ public File getFile() {
 		return file;
 	}
 
+	//
+	// Modern SkriptAddon Compatibility
+	//
+
+	@Nullable
+	@ApiStatus.Experimental
+	static SkriptAddon fromModern(org.skriptlang.skript.addon.SkriptAddon addon) {
+		Class<?> source = addon.localizer().source();
+		if (source != null) // using source would be most accurate
+			return new SkriptAddon(JavaPlugin.getProvidingPlugin(source), addon);
+		Plugin plugin = Bukkit.getServer().getPluginManager().getPlugin(addon.name());
+		if (!(plugin instanceof JavaPlugin))
+			return null;
+		return new SkriptAddon((JavaPlugin) plugin, addon);
+	}
+
+	@Override
+	@ApiStatus.Experimental
+	public String name() {
+		return addon.name();
+	}
+
+	@Override
+	@ApiStatus.Experimental
+	public SyntaxRegistry syntaxRegistry() {
+		return addon.syntaxRegistry();
+	}
+
+	@Override
+	@ApiStatus.Experimental
+	public Localizer localizer() {
+		return addon.localizer();
+	}
+
 }

src/main/java/ch/njol/skript/conditions/base/PropertyCondition.java

@@ -28,6 +28,10 @@
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.util.Checker;
 import ch.njol.util.Kleenean;
+import org.jetbrains.annotations.ApiStatus;
+import org.skriptlang.skript.registration.SyntaxInfo;
+import org.skriptlang.skript.registration.SyntaxRegistry;
+import org.skriptlang.skript.util.Priority;
 
 /**
  * This class can be used for an easier writing of conditions that contain only one type in the pattern,
@@ -54,6 +58,14 @@
  */
 public abstract class PropertyCondition<T> extends Condition implements Checker<T> {
 
+	/**
+	 * A priority for {@link PropertyCondition}s.
+	 * They will be registered before {@link SyntaxInfo#PATTERN_MATCHES_EVERYTHING} expressions
+	 *  but after {@link SyntaxInfo#COMBINED} expressions.
+	 */
+	@ApiStatus.Experimental
+	public static final Priority DEFAULT_PRIORITY = Priority.before(SyntaxInfo.PATTERN_MATCHES_EVERYTHING);
+
 	/**
 	 * See {@link PropertyCondition} for more info
 	 */
@@ -83,14 +95,65 @@ public enum PropertyType {
 		WILL
 	}
 
-	private Expression<? extends T> expr;
+	/**
+	 * @param registry the SyntaxRegistry to register this PropertyCondition with.
+	 * @param condition the class to register
+	 * @param property the property name, for example <i>fly</i> in <i>players can fly</i>
+	 * @param type must be plural, for example <i>players</i> in <i>players can fly</i>
+	 */
+	@ApiStatus.Experimental
+	public static void register(SyntaxRegistry registry, Class<? extends Condition> condition, String property, String type) {
+		register(registry, condition, PropertyType.BE, property, type);
+	}
 
 	/**
+	 * @param registry the SyntaxRegistry to register this PropertyCondition with.
 	 * @param condition the class to register
+	 * @param propertyType the property type, see {@link PropertyType}
 	 * @param property the property name, for example <i>fly</i> in <i>players can fly</i>
 	 * @param type must be plural, for example <i>players</i> in <i>players can fly</i>
 	 */
+	@ApiStatus.Experimental
+	public static void register(SyntaxRegistry registry, Class<? extends Condition> condition, PropertyType propertyType, String property, String type) {
+		if (type.contains("%"))
+			throw new SkriptAPIException("The type argument must not contain any '%'s");
+		SyntaxInfo.Builder<?, ? extends Condition> builder = SyntaxInfo.builder(condition).priority(DEFAULT_PRIORITY);
+		switch (propertyType) {
+			case BE:
+				builder.addPatterns(
+					"%" + type + "% (is|are) " + property,
+					"%" + type + "% (isn't|is not|aren't|are not) " + property
+				);
+				break;
+			case CAN:
+				builder.addPatterns(
+					"%" + type + "% can " + property,
+					"%" + type + "% (can't|cannot|can not) " + property
+				);
+				break;
+			case HAVE:
+				builder.addPatterns(
+					"%" + type + "% (has|have) " + property,
+					"%" + type + "% (doesn't|does not|do not|don't) have " + property
+				);
+				break;
+			case WILL:
+				builder.addPatterns(
+					"%" + type + "% will " + property,
+					"%" + type + "% (will (not|neither)|won't) " + property
+				);
+				break;
+			default:
+				assert false;
+		}
+		registry.register(SyntaxRegistry.CONDITION, builder.build());
+	}
 
+	/**
+	 * @param condition the class to register
+	 * @param property the property name, for example <i>fly</i> in <i>players can fly</i>
+	 * @param type must be plural, for example <i>players</i> in <i>players can fly</i>
+	 */
 	public static void register(Class<? extends Condition> condition, String property, String type) {
 		register(condition, PropertyType.BE, property, type);
 	}
@@ -101,7 +164,6 @@ public static void register(Class<? extends Condition> condition, String propert
 	 * @param property the property name, for example <i>fly</i> in <i>players can fly</i>
 	 * @param type must be plural, for example <i>players</i> in <i>players can fly</i>
 	 */
-
 	public static void register(Class<? extends Condition> condition, PropertyType propertyType, String property, String type) {
 		if (type.contains("%"))
 			throw new SkriptAPIException("The type argument must not contain any '%'s");
@@ -132,6 +194,8 @@ public static void register(Class<? extends Condition> condition, PropertyType p
 		}
 	}
 
+	private Expression<? extends T> expr;
+
 	@Override
 	public boolean init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
 		expr = (Expression<? extends T>) expressions[0];

src/main/java/ch/njol/skript/expressions/base/EventValueExpression.java

@@ -44,6 +44,10 @@
 import ch.njol.util.Kleenean;
 import org.bukkit.event.Event;
 import org.eclipse.jdt.annotation.Nullable;
+import org.jetbrains.annotations.ApiStatus;
+import org.skriptlang.skript.registration.SyntaxInfo;
+import org.skriptlang.skript.registration.SyntaxRegistry;
+import org.skriptlang.skript.util.Priority;
 
 /**
  * A useful class for creating default expressions. It simply returns the event value of the given type.
@@ -65,6 +69,32 @@
  */
 public class EventValueExpression<T> extends SimpleExpression<T> implements DefaultExpression<T> {
 
+	/**
+	 * A priority for {@link EventValueExpression}s.
+	 * They will be registered before {@link SyntaxInfo#COMBINED} expressions
+	 *  but after {@link SyntaxInfo#SIMPLE} expressions.
+	 */
+	@ApiStatus.Experimental
+	public static final Priority DEFAULT_PRIORITY = Priority.before(SyntaxInfo.COMBINED);
+
+	/**
+	 * Registers an event value expression with the provided pattern.
+	 * This also adds '[the]' to the start of the pattern.
+	 *
+	 * @param registry the SyntaxRegistry to register this PropertyExpression with.
+	 * @param expressionClass The class that represents this EventValueExpression.
+	 * @param type The return type of the expression.
+	 * @param pattern The pattern for this syntax.
+	 */
+	@ApiStatus.Experimental
+	public static <T> void register(SyntaxRegistry registry, Class<? extends EventValueExpression<T>> expressionClass, Class<T> type, String pattern) {
+		registry.register(SyntaxRegistry.EXPRESSION, SyntaxInfo.Expression.builder(expressionClass)
+				.returnType(type)
+				.priority(DEFAULT_PRIORITY)
+				.addPattern("[the] " + pattern)
+				.build()
+		);
+	}
 
 	/**
 	 * Registers an expression as {@link ExpressionType#EVENT} with the provided pattern.

src/main/java/ch/njol/skript/expressions/base/PropertyExpression.java

@@ -22,6 +22,7 @@
 import org.eclipse.jdt.annotation.Nullable;
 
 import ch.njol.skript.Skript;
+import org.jetbrains.annotations.ApiStatus;
 import org.skriptlang.skript.lang.converter.Converter;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.ExpressionType;
@@ -30,6 +31,9 @@
 import ch.njol.skript.lang.util.SimpleExpression;
 import org.skriptlang.skript.lang.converter.Converters;
 import ch.njol.util.Kleenean;
+import org.skriptlang.skript.registration.SyntaxInfo;
+import org.skriptlang.skript.registration.SyntaxRegistry;
+import org.skriptlang.skript.util.Priority;
 
 import java.util.Arrays;
 
@@ -42,6 +46,36 @@
  */
 public abstract class PropertyExpression<F, T> extends SimpleExpression<T> {
 
+	/**
+	 * A priority for {@link PropertyExpression}s.
+	 * They will be registered before {@link SyntaxInfo#PATTERN_MATCHES_EVERYTHING} expressions
+	 *  but after {@link SyntaxInfo#COMBINED} expressions.
+	 */
+	@ApiStatus.Experimental
+	public static final Priority DEFAULT_PRIORITY = Priority.before(SyntaxInfo.PATTERN_MATCHES_EVERYTHING);
+
+	/**
+	 * Registers an expression with the two default property patterns "property of %types%" and "%types%'[s] property"
+	 *
+	 * @param registry the SyntaxRegistry to register this PropertyExpression with.
+	 * @param expressionClass the PropertyExpression class being registered.
+	 * @param type the main expression type the property is based off of.
+	 * @param property the name of the property.
+	 * @param fromType should be plural to support multiple objects but doesn't have to be.
+	 */
+	@ApiStatus.Experimental
+	public static <T> void register(SyntaxRegistry registry, Class<? extends Expression<T>> expressionClass, Class<T> type, String property, String fromType) {
+		registry.register(SyntaxRegistry.EXPRESSION, SyntaxInfo.Expression.builder(expressionClass)
+				.returnType(type)
+				.priority(DEFAULT_PRIORITY)
+				.addPatterns(
+						"[the] " + property + " of %" + fromType + "%",
+						"%" + fromType + "%'[s] " + property
+				)
+				.build()
+		);
+	}
+
 	/**
 	 * Registers an expression as {@link ExpressionType#PROPERTY} with the two default property patterns "property of %types%" and "%types%'[s] property"
 	 * 
@@ -54,6 +88,29 @@ public static <T> void register(Class<? extends Expression<T>> expressionClass,
 		Skript.registerExpression(expressionClass, type, ExpressionType.PROPERTY, "[the] " + property + " of %" + fromType + "%", "%" + fromType + "%'[s] " + property);
 	}
 
+	/**
+	 * Registers an expression with the two default property patterns "property [of %types%]" and "%types%'[s] property"
+	 * This method also makes the expression type optional to force a default expression on the property expression.
+	 *
+	 * @param registry the SyntaxRegistry to register this PropertyExpression with.
+	 * @param expressionClass the PropertyExpression class being registered.
+	 * @param type the main expression type the property is based off of.
+	 * @param property the name of the property.
+	 * @param fromType should be plural to support multiple objects but doesn't have to be.
+	 */
+	@ApiStatus.Experimental
+	public static <T> void registerDefault(SyntaxRegistry registry, Class<? extends Expression<T>> expressionClass, Class<T> type, String property, String fromType) {
+		registry.register(SyntaxRegistry.EXPRESSION, SyntaxInfo.Expression.builder(expressionClass)
+				.returnType(type)
+				.priority(DEFAULT_PRIORITY)
+				.addPatterns(
+						"[the] " + property + " [of %" + fromType + "%]",
+						"%" + fromType + "%'[s] " + property
+				)
+				.build()
+		);
+	}
+
 	/**
 	 * Registers an expression as {@link ExpressionType#PROPERTY} with the two default property patterns "property [of %types%]" and "%types%'[s] property"
 	 * This method also makes the expression type optional to force a default expression on the property expression.