Preprocessors (#86)

brachy84 · web-flow · commit bd75153dd963 · 2023-09-01T11:42:22.000+02:00
* preprocessors

* add debug only preprocessor

* use preprocessors in example files
diff --git a/examples/postInit/actuallyadditions.groovy b/examples/postInit/actuallyadditions.groovy
@@ -1,5 +1,6 @@
 
-if (!isLoaded('actuallyadditions')) return
+// MODS_LOADED: actuallyadditions
+
 println 'mod \'actuallyadditions\' detected, running script'
 
 
diff --git a/examples/postInit/advancedmortars.groovy b/examples/postInit/advancedmortars.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('advancedmortars')) return
+// MODS_LOADED: advancedmortars
 println 'mod \'advancedmortars\' detected, running script'
 
 // Mortar
diff --git a/examples/postInit/appliedenergistics2.groovy b/examples/postInit/appliedenergistics2.groovy
@@ -1,5 +1,11 @@
-
-if (!isLoaded('appliedenergistics2')) return
+/*
+NO_RUN
+NO_RELOAD
+MODS_LOADED: appliedenergistics2
+SIDE: client
+*/
+
+// MODS_LOADED: appliedenergistics2
 println 'mod \'appliedenergistics2\' detected, running script'
 
 // Can be access via either `appliedenergistics2` or `ae2`
diff --git a/examples/postInit/astral.groovy b/examples/postInit/astral.groovy
@@ -1,8 +1,8 @@
-import net.minecraft.util.math.MathHelper
 
-if (!isLoaded('astralsorcery')) return
+// MODS_LOADED: astralsorcery
 println 'mod \'astralsorcery\' detected, running script'
 
+import net.minecraft.util.math.MathHelper
 
 // Constellation bracket handler:
 // Major (Bright) Constellations:
diff --git a/examples/postInit/avaritia.groovy b/examples/postInit/avaritia.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('avaritia')) return
+// MODS_LOADED: avaritia
 println 'mod \'avaritia\' detected, running script'
 
 // extreme crafting
diff --git a/examples/postInit/bloodmagic.groovy b/examples/postInit/bloodmagic.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('bloodmagic')) return
+// MODS_LOADED: bloodmagic
 println 'mod \'bloodmagic\' detected, running script'
 
 
diff --git a/examples/postInit/botania.groovy b/examples/postInit/botania.groovy
@@ -1,9 +1,9 @@
-import net.minecraft.potion.PotionEffect
-import net.minecraft.util.text.TextFormatting
 
-if (!isLoaded('botania')) return
+// MODS_LOADED: botania
 println 'mod \'botania\' detected, running script'
 
+import net.minecraft.potion.PotionEffect
+import net.minecraft.util.text.TextFormatting
 
 // Bracket Handlers
 // Brew:
diff --git a/examples/postInit/chisel.groovy b/examples/postInit/chisel.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('chisel')) return
+// MODS_LOADED: chisel
 println 'mod \'chisel\' detected, running script'
 
 // Carving
diff --git a/examples/postInit/compactmachines.groovy b/examples/postInit/compactmachines.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('compactmachines3')) return
+// MODS_LOADED: compactmachines3
 println 'mod \'compactmachines3\' detected, running script'
 
 // Miniaturization:
diff --git a/examples/postInit/draconicevolution.groovy b/examples/postInit/draconicevolution.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('draconicevolution')) return
+// MODS_LOADED: draconicevolution
 println 'mod \'draconicevolution\' detected, running script'
 
 // Fusion:
diff --git a/examples/postInit/enderio.groovy b/examples/postInit/enderio.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('enderio')) return
+// MODS_LOADED: enderio
 println 'mod \'enderio\' detected, running script'
 
 // Alloy Smelter (Alloying):
diff --git a/examples/postInit/evilcraft.groovy b/examples/postInit/evilcraft.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('evilcraft')) return
+// MODS_LOADED: evilcraft
 println 'mod \'evilcraft\' detected, running script'
 
 // Weather Bracket Handler
diff --git a/examples/postInit/extendedcrafting.groovy b/examples/postInit/extendedcrafting.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('extendedcrafting')) return
+// MODS_LOADED: extendedcrafting
 println 'mod \'extendedcrafting\' detected, running script'
 
 // Combination Crafting (Combination):
diff --git a/examples/postInit/forestry.groovy b/examples/postInit/forestry.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('forestry')) return
+// MODS_LOADED: forestry
 println 'mod \'forestry\' detected, running script'
 
 // Species Bracket Handler
diff --git a/examples/postInit/immersiveengineering.groovy b/examples/postInit/immersiveengineering.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('immersiveengineering')) return
+// MODS_LOADED: immersiveengineering
 println 'mod \'immersiveengineering\' detected, running script'
 
 // Alloy Kiln:
diff --git a/examples/postInit/inspirations.groovy b/examples/postInit/inspirations.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('inspirations')) return
+// MODS_LOADED: inspirations
 println 'mod \'inspirations\' detected, running script'
 
 // Cauldron:
diff --git a/examples/postInit/integrateddynamics.groovy b/examples/postInit/integrateddynamics.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('integrateddynamics')) return
+// MODS_LOADED: integrateddynamics
 println 'mod \'integrateddynamics\' detected, running script'
 
 // Drying Basin and Mechanical Drying Basin:
diff --git a/examples/postInit/loottables.groovy b/examples/postInit/loottables.groovy
@@ -1,8 +1,5 @@
 
-if (isReloading()) {
-    println 'Cancelled running script loot'
-    return
-}
+// NO_RELOAD
 
 def pyramidLootTable = loot.getTable(resource('minecraft:chests/stronghold_library'))
 
diff --git a/examples/postInit/mekanism.groovy b/examples/postInit/mekanism.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('mekanism')) return
+// MODS_LOADED: mekanism
 println 'mod \'mekanism\' detected, running script'
 
 // Bracket Handlers
diff --git a/examples/postInit/roots.groovy b/examples/postInit/roots.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('roots')) return
+// MODS_LOADED: roots
 println 'mod \'roots\' detected, running script'
 
 // Bracket Handlers
diff --git a/examples/postInit/thaumcraft.groovy b/examples/postInit/thaumcraft.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('thaumcraft')) return
+// MODS_LOADED: thaumcraft
 println 'mod \'thaumcraft\' detected, running script'
 
 mods.thaumcraft.Crucible.removeByOutput(item('minecraft:gunpowder'))
diff --git a/examples/postInit/thermal.groovy b/examples/postInit/thermal.groovy
@@ -1,5 +1,5 @@
 
-if (!isLoaded('thermalexpansion')) return
+// MODS_LOADED: thermalexpansion
 println 'mod \'thermalexpansion\' detected, running script'
 
 mods.te.Pulverizer.recipeBuilder()
diff --git a/examples/postInit/woot.groovy b/examples/postInit/woot.groovy
@@ -1,10 +1,9 @@
 
-if (!isLoaded('woot')) return
+// MODS_LOADED: woot
 println 'mod \'woot\' detected, running script'
 
-//import ipsis.woot.configuration.EnumConfigKey
-
-//import ipsis.woot.util.WootMobName
+import ipsis.woot.configuration.EnumConfigKey
+import ipsis.woot.util.WootMobName
 
 // Note:
 // Drops, Spawning, Policy, and Mob Config can also be controlled via .json config file
@@ -50,7 +49,7 @@ mods.woot.drops.recipeBuilder()
     .size(5, 10, 20, 50)
     .register()
 
-//mods.woot.drops.removeByEntity(new WootMobName('minecraft:ender_dragon'))
+mods.woot.drops.removeByEntity(new WootMobName('minecraft:ender_dragon'))
 mods.woot.drops.removeByEntity(entity('minecraft:ender_dragon'))
 mods.woot.drops.removeByEntity('minecraft:ender_dragon')
 mods.woot.drops.removeByEntity('minecraft:ender_dragon', '') // NBT tag
@@ -72,8 +71,8 @@ mods.woot.spawning.recipeBuilder()
     .register()
 
 
-//mods.woot.spawning.remove(new WootMobName('minecraft:ender_dragon'))
-//mods.woot.spawning.removeByEntity(new WootMobName('minecraft:ender_dragon'))
+mods.woot.spawning.remove(new WootMobName('minecraft:ender_dragon'))
+mods.woot.spawning.removeByEntity(new WootMobName('minecraft:ender_dragon'))
 mods.woot.spawning.removeByEntity(entity('minecraft:ender_dragon'))
 mods.woot.spawning.removeByEntity('minecraft:ender_dragon')
 mods.woot.spawning.removeByEntity('minecraft:ender_dragon', '') // NBT tag
diff --git a/src/main/java/com/cleanroommc/groovyscript/sandbox/Preprocessor.java b/src/main/java/com/cleanroommc/groovyscript/sandbox/Preprocessor.java
@@ -0,0 +1,104 @@
+package com.cleanroommc.groovyscript.sandbox;
+
+import com.cleanroommc.groovyscript.GroovyScript;
+import com.cleanroommc.groovyscript.api.GroovyLog;
+import com.cleanroommc.groovyscript.registry.ReloadableRegistryManager;
+import net.minecraftforge.fml.common.FMLCommonHandler;
+import net.minecraftforge.fml.common.Loader;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileReader;
+import java.io.IOException;
+import java.util.Arrays;
+
+public class Preprocessor {
+
+    public static boolean validatePreprocessors(File file) {
+        try (BufferedReader br = new BufferedReader(new FileReader(file))) {
+            boolean isComment = false;
+            String line;
+            while ((line = br.readLine()) != null) {
+                line = line.trim();
+                if (line.isEmpty()) continue;
+                if (line.startsWith("/*")) {
+                    isComment = true;
+                    line = line.substring(2).trim();
+                    if (line.isEmpty()) continue;
+                }
+                if (line.startsWith("//")) {
+                    line = line.substring(2).trim();
+                    if (line.isEmpty()) continue;
+                } else if (!isComment) {
+                    return true;
+                }
+                if (isComment && line.endsWith("*/")) {
+                    isComment = false;
+                }
+
+                if (!processPreprocessor(line)) {
+                    return false;
+                }
+            }
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+        return true;
+    }
+
+    private static boolean processPreprocessor(String line) {
+        if (line.startsWith("NO_RUN")) {
+            return false;
+        }
+        if (line.startsWith("DEBUG_ONLY")) {
+            return GroovyScript.getRunConfig().isDebug();
+        }
+        if (line.startsWith("NO_RELOAD")) {
+            return !ReloadableRegistryManager.isFirstLoad();
+        }
+        if (line.startsWith("MODS_LOADED")) {
+            return checkModsLoaded(getArguments(line));
+        }
+        if (line.startsWith("SIDE")) {
+            return checkSide(getArguments(line));
+        }
+        return true;
+    }
+
+    private static boolean checkModsLoaded(String[] mods) {
+        for (String mod : mods) {
+            if (!Loader.isModLoaded(mod)) {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    private static boolean checkSide(String[] sides) {
+        if (sides.length != 1) {
+            GroovyLog.get().error("Side preprocessor should have exactly one argument, but found {}", Arrays.asList(sides));
+            return true;
+        }
+        String side = sides[0].toUpperCase();
+        if (side.equals("CLIENT")) {
+            return FMLCommonHandler.instance().getSide().isClient();
+        }
+        if (side.equals("SERVER")) {
+            return FMLCommonHandler.instance().getSide().isServer();
+        }
+        GroovyLog.get().error("Side processor argument must be CLIENT or SERVER (lower case is allowed too)");
+        return true;
+    }
+
+    private static String[] getArguments(String line) {
+        String[] parts = line.split(":", 2);
+        if (parts.length < 2) {
+            return new String[0];
+        }
+        String[] args = parts[1].split(",");
+        for (int i = 0; i < args.length; i++) {
+            args[i] = args[i].trim();
+        }
+        return args;
+    }
+}
diff --git a/src/main/java/com/cleanroommc/groovyscript/sandbox/RunConfig.java b/src/main/java/com/cleanroommc/groovyscript/sandbox/RunConfig.java
@@ -229,6 +229,7 @@ private Collection<File> getSortedFilesOf(Collection<String> paths) {
             try (Stream<Path> stream = Files.walk(rootFile.toPath())) {
                 stream.filter(path1 -> isGroovyFile(path1.toString()))
                         .map(Path::toFile)
+                        .filter(Preprocessor::validatePreprocessors)
                         .sorted(Comparator.comparing(File::getPath))
                         .forEach(file -> {
                             if (files.containsKey(file)) {

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`
`2`		`-if (!isLoaded('bloodmagic')) return`
	`2`	`+// MODS_LOADED: bloodmagic`
`3`	`3`	`println 'mod \'bloodmagic\' detected, running script'`
`4`	`4`
`5`	`5`