Register placeholder pattern for custom syntax

SkriptLang · Jan 14, 2025 · c2d9a2b · c2d9a2b
1 parent 9ec3526
commit c2d9a2b
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 4 deletions.
diff --git a/src/main/java/org/skriptlang/reflect/syntax/condition/elements/CustomCondition.java b/src/main/java/org/skriptlang/reflect/syntax/condition/elements/CustomCondition.java
@@ -74,6 +74,11 @@ public String toString(Event e, boolean debug) {
   @Override
   public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
                       SkriptParser.ParseResult parseResult) {
+    // prevent the user from using the placeholder pattern we register in order to satisfy the registration requirements
+    if (matchedPattern == 1) {
+      return false;
+    }
+
     which = StructCustomCondition.lookup(SkriptUtil.getCurrentScript(), matchedPattern);
 
     if (which == null) {

diff --git a/src/main/java/org/skriptlang/reflect/syntax/condition/elements/StructCustomCondition.java b/src/main/java/org/skriptlang/reflect/syntax/condition/elements/StructCustomCondition.java
@@ -57,7 +57,7 @@ public class StructCustomCondition extends CustomSyntaxStructure<ConditionSyntax
   static final Map<ConditionSyntaxInfo, Boolean> parseSectionLoaded = new HashMap<>();
 
   static {
-    Skript.registerCondition(CustomCondition.class);
+    Skript.registerCondition(CustomCondition.class, "this is here because at least one pattern is required");
     Optional<SyntaxInfo<? extends Condition>> info = SkriptMirror.getAddonInstance().syntaxRegistry().syntaxes(SyntaxRegistry.CONDITION).stream()
         .filter(i -> i.type() == CustomCondition.class)
         .findFirst();

diff --git a/src/main/java/org/skriptlang/reflect/syntax/effect/elements/CustomEffect.java b/src/main/java/org/skriptlang/reflect/syntax/effect/elements/CustomEffect.java
@@ -72,6 +72,11 @@ public String toString(Event e, boolean debug) {
   @Override
   public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
                       SkriptParser.ParseResult parseResult) {
+    // prevent the user from using the placeholder pattern we register in order to satisfy the registration requirements
+    if (matchedPattern == 1) {
+      return false;
+    }
+
     which = StructCustomEffect.lookup(SkriptUtil.getCurrentScript(), matchedPattern);
 
     if (which == null) {

diff --git a/src/main/java/org/skriptlang/reflect/syntax/effect/elements/StructCustomEffect.java b/src/main/java/org/skriptlang/reflect/syntax/effect/elements/StructCustomEffect.java
@@ -51,7 +51,7 @@ public class StructCustomEffect extends CustomSyntaxStructure<EffectSyntaxInfo>
   static final Map<EffectSyntaxInfo, Boolean> parseSectionLoaded = new HashMap<>();
 
   static {
-    Skript.registerEffect(CustomEffect.class);
+    Skript.registerEffect(CustomEffect.class, "this is here because at least one pattern is required");
     Optional<SyntaxInfo<? extends Effect>> info = SkriptMirror.getAddonInstance().syntaxRegistry().syntaxes(SyntaxRegistry.EFFECT).stream()
       .filter(i -> i.type() == CustomEffect.class)
       .findFirst();

diff --git a/src/main/java/org/skriptlang/reflect/syntax/event/elements/CustomEvent.java b/src/main/java/org/skriptlang/reflect/syntax/event/elements/CustomEvent.java
@@ -34,6 +34,11 @@ public class CustomEvent extends SkriptEvent {
 
   @Override
   public boolean init(Literal<?>[] args, int matchedPattern, SkriptParser.ParseResult parseResult) {
+    // prevent the user from using the placeholder pattern we register in order to satisfy the registration requirements
+    if (matchedPattern == 1) {
+      return false;
+    }
+
     which = StructCustomEvent.lookup(SkriptUtil.getCurrentScript(), matchedPattern);
 
     if (which == null) {

diff --git a/src/main/java/org/skriptlang/reflect/syntax/event/elements/StructCustomEvent.java b/src/main/java/org/skriptlang/reflect/syntax/event/elements/StructCustomEvent.java
@@ -62,7 +62,7 @@ public boolean canCreateWith(String node) {
   static final Map<EventSyntaxInfo, Boolean> parseSectionLoaded = new HashMap<>();
 
   static {
-    Skript.registerEvent("custom event", CustomEvent.class, BukkitCustomEvent.class);
+    Skript.registerEvent("custom event", CustomEvent.class, BukkitCustomEvent.class, "this is here because at least one pattern is required");
     Optional<BukkitSyntaxInfos.Event<?>> info = SkriptMirror.getAddonInstance().syntaxRegistry().syntaxes(BukkitRegistryKeys.EVENT).stream()
       .filter(i -> i.type() == CustomEvent.class)
       .findFirst();

diff --git a/src/main/java/org/skriptlang/reflect/syntax/expression/elements/CustomExpression.java b/src/main/java/org/skriptlang/reflect/syntax/expression/elements/CustomExpression.java
@@ -259,6 +259,11 @@ public void change(Event e, Object[] delta, Changer.ChangeMode mode) {
   @Override
   public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
                       SkriptParser.ParseResult parseResult) {
+    // prevent the user from using the placeholder pattern we register in order to satisfy the registration requirements
+    if (matchedPattern == 1) {
+      return false;
+    }
+
     which = StructCustomExpression.lookup(SkriptUtil.getCurrentScript(), matchedPattern);
 
     if (which == null) {

diff --git a/src/main/java/org/skriptlang/reflect/syntax/expression/elements/StructCustomExpression.java b/src/main/java/org/skriptlang/reflect/syntax/expression/elements/StructCustomExpression.java
@@ -88,7 +88,7 @@ protected Class<?> getValue(String value) {
 
   static {
     // noinspection unchecked
-    Skript.registerExpression(CustomExpression.class, Object.class, ExpressionType.PATTERN_MATCHES_EVERYTHING);
+    Skript.registerExpression(CustomExpression.class, Object.class, ExpressionType.PATTERN_MATCHES_EVERYTHING, "this is here because at least one pattern is required");
     Optional<SyntaxInfo<?>> info = SkriptMirror.getAddonInstance().syntaxRegistry().elements().stream()
         .filter(i -> Expression.class.isAssignableFrom(i.type()))
         .filter(i -> i.type() == CustomExpression.class)