Add Origin-applying SyntaxRegistry (SkriptLang#8376)

Author: APickledWalrus

src/main/java/org/skriptlang/skript/SkriptImpl.java

@@ -8,7 +8,6 @@
 import org.skriptlang.skript.addon.SkriptAddon;
 import org.skriptlang.skript.docs.Origin;
 import org.skriptlang.skript.localization.Localizer;
-import org.skriptlang.skript.registration.SyntaxInfo;
 import org.skriptlang.skript.registration.SyntaxRegistry;
 import org.skriptlang.skript.util.Registry;
 
@@ -27,7 +26,7 @@ final class SkriptImpl implements Skript {
 
 	SkriptImpl(Class<?> source, String name) {
 		addon = new SkriptAddonImpl(this, source, name, Localizer.of(this));
-		storeRegistry(SyntaxRegistry.class, new AddonAwareSyntaxRegistry(SyntaxRegistry.empty(), this));
+		storeRegistry(SyntaxRegistry.class, SyntaxRegistry.withOrigin(SyntaxRegistry.empty(), Origin.of(this)));
 	}
 
 	/*
@@ -132,13 +131,14 @@ private static final class SkriptAddonImpl implements SkriptAddon {
 		private final Class<?> source;
 		private final String name;
 		private final Localizer localizer;
-		private AddonAwareSyntaxRegistry syntaxRegistry;
+		private final Origin origin;
 
 		SkriptAddonImpl(Skript skript, Class<?> source, String name, @Nullable Localizer localizer) {
 			this.skript = skript;
 			this.source = source;
 			this.name = name;
 			this.localizer = localizer == null ? Localizer.of(this) : localizer;
+			this.origin = Origin.of(this);
 		}
 
 		@Override
@@ -170,11 +170,8 @@ public boolean hasRegistry(Class<? extends Registry<?>> registryClass) {
 		public <R extends Registry<?>> R registry(Class<R> registryClass) {
 			R registry = skript.registry(registryClass);
 			if (registryClass == SyntaxRegistry.class) {
-				if (syntaxRegistry == null || syntaxRegistry.syntaxRegistry != registry) { // stored syntax registry has changed...
-					this.syntaxRegistry = new AddonAwareSyntaxRegistry((SyntaxRegistry) registry, this);
-				}
 				//noinspection unchecked
-				return (R) syntaxRegistry;
+				return (R) SyntaxRegistry.withOrigin((SyntaxRegistry) registry, origin);
 			}
 			return registry;
 		}
@@ -281,49 +278,4 @@ public Skript unmodifiableView() {
 
 	}
 
-	/*
-	 * SyntaxRegistry Implementations
-	 */
-
-	private static final class AddonAwareSyntaxRegistry implements SyntaxRegistry {
-
-		final SyntaxRegistry syntaxRegistry;
-		private final SkriptAddon addon;
-
-		public AddonAwareSyntaxRegistry(SyntaxRegistry syntaxRegistry, SkriptAddon addon) {
-			this.syntaxRegistry = syntaxRegistry;
-			this.addon = addon;
-		}
-
-		@Override
-		public @Unmodifiable <I extends SyntaxInfo<?>> Collection<I> syntaxes(Key<I> key) {
-			return syntaxRegistry.syntaxes(key);
-		}
-
-		@Override
-		public <I extends SyntaxInfo<?>> void register(Key<I> key, I info) {
-			if (info.origin() == Origin.UNKNOWN) { // when origin is unspecified, add one
-				//noinspection unchecked
-				info = (I) info.toBuilder().origin(Origin.of(addon)).build();
-			}
-			syntaxRegistry.register(key, info);
-		}
-
-		@Override
-		public void unregister(SyntaxInfo<?> info) {
-			syntaxRegistry.unregister(info);
-		}
-
-		@Override
-		public <I extends SyntaxInfo<?>> void unregister(Key<I> key, I info) {
-			syntaxRegistry.unregister(key, info);
-		}
-
-		@Override
-		public @Unmodifiable Collection<SyntaxInfo<?>> elements() {
-			return syntaxRegistry.elements();
-		}
-
-	}
-
 }

src/main/java/org/skriptlang/skript/registration/SyntaxRegistry.java

@@ -7,6 +7,7 @@
 import ch.njol.skript.lang.Statement;
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.Unmodifiable;
+import org.skriptlang.skript.docs.Origin;
 import org.skriptlang.skript.lang.structure.Structure;
 import org.skriptlang.skript.util.Registry;
 import org.skriptlang.skript.util.ViewProvider;
@@ -59,6 +60,17 @@ static SyntaxRegistry empty() {
 		return new SyntaxRegistryImpl();
 	}
 
+	/**
+	 * Constructs a syntax registry that applies an origin to all syntax infos registered through it
+	 *  with the {@link Origin#UNKNOWN} origin.
+	 * @param syntaxRegistry The syntax registry providing the implementation.
+	 * @param origin The origin to apply.
+	 * @return A syntax registry that applies an origin.
+	 */
+	static SyntaxRegistry withOrigin(SyntaxRegistry syntaxRegistry, Origin origin) {
+		return new SyntaxRegistryImpl.OriginApplyingRegistry(syntaxRegistry, origin);
+	}
+
 	/**
 	 * A method to obtain all syntaxes registered under a certain key.
 	 * @param key The key to obtain syntaxes from.

src/main/java/org/skriptlang/skript/registration/SyntaxRegistryImpl.java

@@ -3,8 +3,10 @@
 import com.google.common.base.MoreObjects;
 import com.google.common.collect.ImmutableSet;
 import org.jetbrains.annotations.Unmodifiable;
+import org.skriptlang.skript.docs.Origin;
 
 import java.util.Collection;
+import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.concurrent.ConcurrentHashMap;
@@ -59,6 +61,47 @@ public Collection<SyntaxInfo<?>> elements() {
 		return builder.build();
 	}
 
+	static final class OriginApplyingRegistry implements SyntaxRegistry {
+
+		private final SyntaxRegistry syntaxRegistry;
+		private final Origin origin;
+
+		OriginApplyingRegistry(SyntaxRegistry syntaxRegistry, Origin origin) {
+			this.syntaxRegistry = syntaxRegistry;
+			this.origin = origin;
+		}
+
+		@Override
+		public @Unmodifiable <I extends SyntaxInfo<?>> Collection<I> syntaxes(Key<I> key) {
+			return syntaxRegistry.syntaxes(key);
+		}
+
+		@Override
+		public <I extends SyntaxInfo<?>> void register(Key<I> key, I info) {
+			if (info.origin() == Origin.UNKNOWN) { // when origin is unspecified, add one
+				//noinspection unchecked
+				info = (I) info.toBuilder().origin(origin).build();
+			}
+			syntaxRegistry.register(key, info);
+		}
+
+		@Override
+		public void unregister(SyntaxInfo<?> info) {
+			syntaxRegistry.unregister(info);
+		}
+
+		@Override
+		public <I extends SyntaxInfo<?>> void unregister(Key<I> key, I info) {
+			syntaxRegistry.unregister(key, info);
+		}
+
+		@Override
+		public @Unmodifiable Collection<SyntaxInfo<?>> elements() {
+			return syntaxRegistry.elements();
+		}
+
+	}
+
 	static final class UnmodifiableRegistry implements SyntaxRegistry {
 
 		private final SyntaxRegistry registry;

src/test/java/org/skriptlang/skript/addon/BaseSkriptAddonTests.java

@@ -1,6 +1,9 @@
 package org.skriptlang.skript.addon;
 
+import ch.njol.skript.lang.SyntaxElement;
 import org.junit.Test;
+import org.skriptlang.skript.docs.Origin.AddonOrigin;
+import org.skriptlang.skript.registration.SyntaxInfo;
 import org.skriptlang.skript.registration.SyntaxRegistry;
 import org.skriptlang.skript.util.Registry;
 
@@ -88,7 +91,6 @@ public void testSyntaxRegistry() {
 		assertNotNull(unmodifiable.syntaxRegistry());
 		// unmodifiable's syntax registry should be unmodifiable (different)
 		assertNotEquals(addon.syntaxRegistry(), unmodifiable.syntaxRegistry());
-		assertEquals(addon.registry(SyntaxRegistry.class), addon.syntaxRegistry());
 	}
 
 	@Test
@@ -99,4 +101,21 @@ public void testLocalizer() {
 		assertNotNull(addon.unmodifiableView().localizer());
 	}
 
+	@Test
+	public void testAutomaticOrigin() {
+		final SkriptAddon addon = addon();
+
+		addon.syntaxRegistry().register(SyntaxRegistry.Key.of("OriginTest"), SyntaxInfo.builder(SyntaxElement.class)
+			.supplier(() -> {
+				throw new UnsupportedOperationException();
+			})
+			.addPattern("OriginTest")
+			.build()
+		);
+
+		var info = addon.syntaxRegistry().elements().iterator().next();
+		assertNotNull(info);
+		assertTrue(info.origin() instanceof AddonOrigin addonOrigin && addonOrigin.addon().name().equals(addon.name()));
+	}
+
 }