Improvements to syntax inlining.

Author: Moderocky

src/main/java/org/byteskript/skript/api/SyntaxElement.java

@@ -13,7 +13,6 @@
 import org.byteskript.skript.api.note.ForceExtract;
 import org.byteskript.skript.api.note.ForceInline;
 import org.byteskript.skript.compiler.*;
-import org.byteskript.skript.compiler.structure.PreVariable;
 import org.byteskript.skript.error.ScriptReassemblyError;
 import org.byteskript.skript.lang.handler.StandardHandlers;
 
@@ -143,13 +142,7 @@ default void writeCall(final MethodBuilder builder, final Method method, final C
             else sub.writeCode(returnObject());
             builder.writeCode(invokeStatic(context.getType(), target));
         } else if (inline != null) {
-            final InlineController controller = new InlineController(context);
-            for (int i = method.getParameterTypes().length - 1; i >= 0; i--) {
-                final PreVariable var = new PreVariable("$unspec_" + i);
-                context.forceUnspecVariable(var);
-                final int slot = context.slotOf(var);
-                builder.writeCode(WriteInstruction.storeObject(slot));
-            }
+            final InlineController controller = new InlineController(context, method);
             builder.writeCode(SourceReader.getSource(method, controller).toArray(new WriteInstruction[0]));
         } else if (extract != null) {
             final ClassBuilder parent = builder.finish();

src/main/java/org/byteskript/skript/compiler/InlineController.java

@@ -6,13 +6,17 @@
 
 package org.byteskript.skript.compiler;
 
+import mx.kenzie.foundation.MethodBuilder;
 import mx.kenzie.foundation.RewriteController;
 import mx.kenzie.foundation.Type;
 import mx.kenzie.foundation.WriteInstruction;
+import org.byteskript.skript.api.SyntaxElement;
 import org.byteskript.skript.compiler.structure.MultiLabel;
 import org.byteskript.skript.compiler.structure.PreVariable;
+import org.byteskript.skript.lang.syntax.variable.VariableExpression;
 import org.objectweb.asm.Label;
 
+import java.lang.reflect.Method;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -23,8 +27,30 @@ public class InlineController extends RewriteController {
     final MultiLabel label = new MultiLabel();
     protected final Map<Integer, PreVariable> special = new HashMap<>();
 
-    public InlineController(Context context) {
+    public InlineController(Context context, Method method) {
         this.context = context;
+        this.prepareVariables(method);
+    }
+    
+    private void prepareVariables(Method method) {
+        final ElementTree[] inputs = context.getCompileCurrent().nested();
+        for (int i = 0; i < inputs.length; i++) {
+            final SyntaxElement element = inputs[i].current();
+            if (element.getClass() != VariableExpression.class) continue;
+            final VariableExpression expression = (VariableExpression) inputs[i].current();
+            special.put(i, expression.getVariable(context, inputs[i].match()));
+        }
+        final MethodBuilder builder = context.getMethod();
+        for (int i = method.getParameterTypes().length - 1; i >= 0; i--) {
+            if (special.containsKey(i)) {
+                builder.writeCode(WriteInstruction.pop()); // have to pop, aload is already queued
+                continue;
+            }
+            final PreVariable var = new PreVariable("$unspec_" + i);
+            context.forceUnspecVariable(var);
+            final int slot = context.slotOf(var);
+            builder.writeCode(WriteInstruction.storeObject(slot));
+        }
     }
 
     public Map<Integer, PreVariable> getSpecial() {
@@ -63,6 +89,20 @@ public int adjustVariable(int i) {
         return context.slotOf(variable);
     }
 
+    @Override
+    public WriteInstruction return0(int opcode) {
+        return this.jumpToEnd();
+//        if (opcode < 177) {
+//            int slot = this.returnSlot();
+//            return (writer, visitor) -> {
+//                visitor.visitVarInsn(opcode - 118, slot);
+//                this.jumpToEnd().accept(writer, visitor);
+//            };
+//        } else {
+//            return this.jumpToEnd();
+//        }
+    }
+    
     @Override
     public int returnSlot() {
         final PreVariable variable = new PreVariable("$unspec_ret");

src/main/java/org/byteskript/skript/compiler/SkriptLangSpec.java

@@ -78,20 +78,20 @@
 import static org.byteskript.skript.lang.handler.StandardHandlers.GET;
 
 public final class SkriptLangSpec extends ModifiableLibrary implements LanguageDefinition, Library {
-    public static final Pattern LINE_COMMENT = Pattern.compile("//.*(?=(\\R|$|\\n))");
-    public static final Pattern BLOCK_COMMENT = Pattern.compile("/\\*[\\s\\S]*?\\*/");
-    public static final Pattern DEAD_SPACE = Pattern.compile("(?<=\\S)[\\t\\f\\v ]+(?=(\\R|$))");
     public static final Pattern IDENTIFIER = Pattern.compile("\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}*");
     public static final JavaVersion JAVA_VERSION = JavaVersion.JAVA_17;
 
     static final SkriptLangSpec INSTANCE = new SkriptLangSpec();
-    public static final LanguageDefinition LANG = INSTANCE;
     public static final Library LIBRARY = INSTANCE;
 
     final LanguageElement[] grammar = StandardElements.values();
 
     final Map<State, List<SyntaxElement>> syntax = new HashMap<>();
 
+    public LanguageElement[] getGrammar() {
+        return grammar;
+    }
+    
     private SkriptLangSpec() {
         super("Skript");
         registerTypes(

src/main/java/org/byteskript/skript/lang/syntax/generic/PropertyExpression.java

@@ -63,7 +63,6 @@ public Pattern.Match match(String thing, Context context) {
         final Matcher matcher = pattern.matcher(thing);
         if (!matcher.find()) return null;
         final String name = matcher.group("name");
-//        if (!context.hasHandle(name, context.getHandlerMode())) return null;
         final Matcher dummy = createDummy(thing, i, matcher);
         dummy.find();
         return new Pattern.Match(dummy, name, CommonTypes.OBJECT);

src/main/java/org/byteskript/skript/lang/syntax/list/ClearList.java

@@ -7,7 +7,7 @@
 package org.byteskript.skript.lang.syntax.list;
 
 import org.byteskript.skript.api.note.Documentation;
-import org.byteskript.skript.api.note.ForceExtract;
+import org.byteskript.skript.api.note.ForceInline;
 import org.byteskript.skript.api.syntax.Effect;
 import org.byteskript.skript.compiler.Context;
 import org.byteskript.skript.compiler.Pattern;
@@ -39,7 +39,7 @@ public ClearList() {
         handlers.put(StandardHandlers.RUN, findMethod(this.getClass(), "run", Object.class));
     }
 
-    @ForceExtract
+    @ForceInline
     public static void run(Object object) {
         if (object instanceof Collection list) list.clear();
         if (object instanceof Map map) map.clear(); // in case this is loaded in preference.

src/main/java/org/byteskript/skript/lang/syntax/list/ListCreator.java

@@ -8,7 +8,7 @@
 
 import mx.kenzie.foundation.Type;
 import org.byteskript.skript.api.note.Documentation;
-import org.byteskript.skript.api.note.ForceExtract;
+import org.byteskript.skript.api.note.ForceInline;
 import org.byteskript.skript.api.syntax.SimpleExpression;
 import org.byteskript.skript.compiler.CommonTypes;
 import org.byteskript.skript.compiler.SkriptLangSpec;
@@ -47,7 +47,7 @@ public Type getReturnType() {
         return CommonTypes.LIST;
     }
 
-    @ForceExtract
+    @ForceInline
     public static DataList create() {
         return new DataList();
     }

src/main/java/org/byteskript/skript/lang/syntax/map/MapCreator.java

@@ -8,7 +8,7 @@
 
 import mx.kenzie.foundation.Type;
 import org.byteskript.skript.api.note.Documentation;
-import org.byteskript.skript.api.note.ForceExtract;
+import org.byteskript.skript.api.note.ForceInline;
 import org.byteskript.skript.api.syntax.SimpleExpression;
 import org.byteskript.skript.compiler.CommonTypes;
 import org.byteskript.skript.compiler.SkriptLangSpec;
@@ -40,7 +40,7 @@ public Type getReturnType() {
         return CommonTypes.MAP;
     }
 
-    @ForceExtract
+    @ForceInline
     public static DataMap create() {
         return new DataMap();
     }

src/main/java/org/byteskript/skript/lang/syntax/variable/VariableExpression.java

@@ -76,7 +76,6 @@ public Type getHolderType() {
     @Override
     public void compile(Context context, Pattern.Match match) {
         final MethodBuilder method = context.getMethod();
-        assert method != null;
         final String name = match.matcher().group("name");
         final PreVariable variable = context.getVariable(name);
         final int slot = context.slotOf(variable);
@@ -90,6 +89,11 @@ public void compile(Context context, Pattern.Match match) {
         }
     }
 
+    public PreVariable getVariable(Context context, Pattern.Match match) {
+        final String name = match.matcher().group("name");
+        return context.getVariable(name);
+    }
+    
     @Override
     public Type getReturnType() {
         return CommonTypes.OBJECT;

src/test/java/org/byteskript/skript/test/InlineTest.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2021 ByteSkript org (Moderocky)
+ * View the full licence information and permissions:
+ * https://github.com/Moderocky/ByteSkript/blob/master/LICENSE
+ */
+
+package org.byteskript.skript.test;
+
+import mx.kenzie.foundation.language.PostCompileClass;
+import org.byteskript.skript.runtime.Script;
+import org.byteskript.skript.runtime.Skript;
+import org.byteskript.skript.runtime.internal.Member;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+public class InlineTest extends SkriptTest {
+    
+    private static final Skript skript = new Skript();
+    private static Script script;
+    
+    @BeforeClass
+    public static void start() throws Throwable {
+        final PostCompileClass cls = skript.compileScript(InlineTest.class.getClassLoader()
+            .getResourceAsStream("inline.bsk"), "skript.inline");
+        script = skript.loadScript(cls);
+    }
+    
+    @Test
+    public void simple() throws Throwable {
+        final Member function = script.getFunction("simple");
+        assert function != null;
+        function.invoke();
+    }
+    
+}

src/test/resources/inline.bsk

@@ -0,0 +1,7 @@
+
+function simple:
+    trigger:
+        set {var} to a new list
+        add "hello" to {var}
+        assert {var} contains "hello": "List contains check failed."
+        clear {var}