Skip to content

Commit fa03c67

Browse files
FrottyFrotty
authored
Lua: fix w3i script injection & remove hashtable guards (#1177)
1 parent 3f740c9 commit fa03c67

9 files changed

Lines changed: 112 additions & 50 deletions

File tree

‎de.peeeq.wurstscript/build.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ dependencies {
108108
implementation 'com.github.albfernandez:juniversalchardet:2.4.0'
109109
implementation 'org.xerial:sqlite-jdbc:3.46.1.3'
110110
implementation 'com.github.inwc3:jmpq3:29b55f2c32'
111-
implementation 'com.github.inwc3:wc3libs:cc49c8e63c'
111+
implementation 'com.github.inwc3:wc3libs:6a96a79595'
112112
implementation('com.github.wurstscript:wurstsetup:393cf5ea39') {
113113
exclude group: 'org.eclipse.jgit', module: 'org.eclipse.jgit'
114114
exclude group: 'org.eclipse.jgit', module: 'org.eclipse.jgit.ssh.apache'

‎de.peeeq.wurstscript/src/main/java/de/peeeq/wurstio/languageserver/ProjectConfigBuilder.java‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,17 @@ public static MapRequest.CompilationResult apply(WurstProjectConfigData projectC
8282
applyBuildMapData(projectConfig, mapScript, buildDir, w3data, w3I, result, configHash, outputScriptName);
8383
} else if (!configNeedsApplying) {
8484
WLogger.info("Using cached w3i configuration");
85-
// Still need to set the result.script correctly
86-
result.script = mapScript;
85+
// Prefer the previously-injected script (with correct config() body) over the
86+
// raw map script. If it doesn't exist yet (e.g. first Lua build after a JASS-only
87+
// cache), fall through to re-inject so the config() body is never stale.
88+
File cachedInjectedScript = new File(buildDir, outputScriptName);
89+
if (cachedInjectedScript.exists()) {
90+
result.script = cachedInjectedScript;
91+
} else if (StringUtils.isNotBlank(buildMapData.getName())) {
92+
WLogger.info("Cached injected script missing, re-injecting config");
93+
applyBuildMapData(projectConfig, mapScript, buildDir, w3data, w3I, result, configHash, outputScriptName);
94+
}
95+
// else result.script stays as mapScript (no wurst.build name configured)
8796
}
8897

8998
result.w3i = new File(buildDir, "war3map.w3i");

‎de.peeeq.wurstscript/src/main/java/de/peeeq/wurstio/languageserver/requests/MapRequest.java‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -612,13 +612,19 @@ protected void injectMapData(WurstGui gui, Optional<File> testMap, CompilationRe
612612
mapScriptName = "war3map.j";
613613
}
614614

615-
// Delete old scripts
615+
// Delete old scripts (both root and scripts/ subdirectory locations)
616616
if (mpqEditor.hasFile("war3map.j")) {
617617
mpqEditor.deleteFile("war3map.j");
618618
}
619+
if (mpqEditor.hasFile("scripts\\war3map.j")) {
620+
mpqEditor.deleteFile("scripts\\war3map.j");
621+
}
619622
if (mpqEditor.hasFile("war3map.lua")) {
620623
mpqEditor.deleteFile("war3map.lua");
621624
}
625+
if (mpqEditor.hasFile("scripts\\war3map.lua")) {
626+
mpqEditor.deleteFile("scripts\\war3map.lua");
627+
}
622628

623629
// Insert new script
624630
mpqEditor.insertFile(mapScriptName, result.script);
@@ -696,6 +702,10 @@ protected File executeBuildMapPipeline(ModelManager modelManager, WurstGui gui,
696702
gui.sendProgress("Finalizing map");
697703
try (MpqEditor mpq = MpqEditorFactory.getEditor(Optional.of(targetMapFile))) {
698704
if (mpq != null) {
705+
// Strip internal Wurst cache files — they are dev-only metadata and should
706+
// not be present in the distributed map.
707+
if (mpq.hasFile("wurst_cache_manifest.txt")) mpq.deleteFile("wurst_cache_manifest.txt");
708+
if (mpq.hasFile("wurst_object_cache.txt")) mpq.deleteFile("wurst_object_cache.txt");
699709
mpq.closeWithCompression();
700710
}
701711
}
@@ -823,6 +833,9 @@ protected byte[] extractMapScript(Optional<File> mapCopy) throws Exception {
823833
if (mpqEditor.hasFile("war3map.j")) {
824834
return mpqEditor.extractFile("war3map.j");
825835
}
836+
if (mpqEditor.hasFile("scripts\\war3map.j")) {
837+
return mpqEditor.extractFile("scripts\\war3map.j");
838+
}
826839
}
827840
return null;
828841
}

‎de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/translation/imoptimizer/ImInliner.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,11 @@ private boolean isInlineCandidate(ImFunction f) {
482482
// this is only relevant for lua, because in JASS they are eliminated before inlining
483483
return false;
484484
}
485+
if (translator.luaInitFunctions.containsKey(f)) {
486+
// Lua package init functions must stay as ImFunctionCall nodes so StmtTranslation
487+
// can wrap them in xpcall. Inlining removes the call site and loses the guard.
488+
return false;
489+
}
485490
return true;
486491
}
487492

‎de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/translation/imtranslation/ImTranslator.java‎

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,14 @@ public class ImTranslator {
5959

6060
private final ImProg imProg;
6161

62-
final Map<WPackage, ImFunction> initFuncMap = new Object2ObjectLinkedOpenHashMap<>();
62+
public final Map<WPackage, ImFunction> initFuncMap = new Object2ObjectLinkedOpenHashMap<>();
63+
64+
/**
65+
* When targeting Lua, package init functions that should be called directly via xpcall
66+
* rather than through the JASS TriggerEvaluate thread-isolation pattern.
67+
* Populated during translateProg() when isLuaTarget() is true.
68+
*/
69+
public final Map<ImFunction, String> luaInitFunctions = new Object2ObjectLinkedOpenHashMap<>();
6370

6471
private final Map<TranslatedToImFunction, ImVar> thisVarMap = new Object2ObjectLinkedOpenHashMap<>();
6572

@@ -528,16 +535,23 @@ private void finishInitFunctions() {
528535
}
529536
Set<WPackage> calledInitializers = Sets.newLinkedHashSet();
530537

531-
ImVar initTrigVar = prepareTrigger();
538+
if (isLuaTarget()) {
539+
// In Lua mode, xpcall handles error isolation; no trigger handle is needed.
540+
for (WPackage p : Utils.sortByName(initFuncMap.keySet())) {
541+
callInitFunc(calledInitializers, p, null);
542+
}
543+
} else {
544+
ImVar initTrigVar = prepareTrigger();
532545

533-
for (WPackage p : Utils.sortByName(initFuncMap.keySet())) {
534-
callInitFunc(calledInitializers, p, initTrigVar);
535-
}
546+
for (WPackage p : Utils.sortByName(initFuncMap.keySet())) {
547+
callInitFunc(calledInitializers, p, initTrigVar);
548+
}
536549

537-
ImFunction native_DestroyTrigger = getNativeFunc("DestroyTrigger");
538-
if (native_DestroyTrigger != null) {
539-
getMainFunc().getBody().add(JassIm.ImFunctionCall(emptyTrace, native_DestroyTrigger, ImTypeArguments(),
540-
JassIm.ImExprs(JassIm.ImVarAccess(initTrigVar)), false, CallType.NORMAL));
550+
ImFunction native_DestroyTrigger = getNativeFunc("DestroyTrigger");
551+
if (native_DestroyTrigger != null) {
552+
getMainFunc().getBody().add(JassIm.ImFunctionCall(emptyTrace, native_DestroyTrigger, ImTypeArguments(),
553+
JassIm.ImExprs(JassIm.ImVarAccess(initTrigVar)), false, CallType.NORMAL));
554+
}
541555
}
542556
}
543557

@@ -563,7 +577,7 @@ private ImFunction getNativeFunc(String funcName) {
563577
return getFuncFor(Utils.getFirst(wurstFunc).getDef());
564578
}
565579

566-
private void callInitFunc(Set<WPackage> calledInitializers, WPackage p, ImVar initTrigVar) {
580+
private void callInitFunc(Set<WPackage> calledInitializers, WPackage p, @Nullable ImVar initTrigVar) {
567581
Preconditions.checkNotNull(p);
568582
if (calledInitializers.contains(p)) {
569583
return;
@@ -580,6 +594,14 @@ private void callInitFunc(Set<WPackage> calledInitializers, WPackage p, ImVar in
580594
if (initFunc.getBody().size() == 0) {
581595
return;
582596
}
597+
if (isLuaTarget()) {
598+
// In Lua mode, xpcall replaces TriggerEvaluate for error isolation without WC3 handle overhead.
599+
// Record the init function so the Lua translator can wrap it with xpcall.
600+
luaInitFunctions.put(initFunc, p.getName());
601+
getMainFunc().getBody().add(ImFunctionCall(initFunc.getTrace(), initFunc, ImTypeArguments(), ImExprs(), false, CallType.NORMAL));
602+
return;
603+
}
604+
583605
boolean successful = createInitFuncCall(p, initTrigVar, initFunc);
584606

585607
if (!successful) {

‎de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/translation/lua/translation/ExprTranslation.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public class ExprTranslation {
1313

1414
public static final String TYPE_ID = "__typeId__";
1515
public static final String WURST_SUPERTYPES = "__wurst_supertypes";
16-
private static final String WURST_ABORT_THREAD_SENTINEL = "__wurst_abort_thread";
16+
static final String WURST_ABORT_THREAD_SENTINEL = "__wurst_abort_thread";
1717
private static final Set<String> LUA_HANDLE_TO_INDEX = Set.of(
1818
"widgetToIndex", "unitToIndex", "destructableToIndex", "itemToIndex", "abilityToIndex",
1919
"forceToIndex", "groupToIndex", "triggerToIndex", "triggeractionToIndex", "triggerconditionToIndex",
@@ -89,7 +89,7 @@ public static LuaExpr translate(ImFuncRef e, LuaTranslator tr) {
8989
return LuaAst.LuaExprFunctionAbstraction(LuaAst.LuaParams(dots), callbackBody);
9090
}
9191

92-
private static String callErrorFunc(LuaTranslator tr, String msg) {
92+
static String callErrorFunc(LuaTranslator tr, String msg) {
9393
LuaFunction ef = tr.getErrorFunc();
9494
if (ef != null) {
9595
if (ef.getParams().size() == 2) {

‎de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/translation/lua/translation/LuaTranslator.java‎

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ public LuaMethod initFor(ImClass a) {
218218
LuaFunction ensureRealFunction = LuaAst.LuaFunction(uniqueName("realEnsure"), LuaAst.LuaParams(), LuaAst.LuaStatements());
219219

220220
private final Lazy<LuaFunction> errorFunc = Lazy.create(() ->
221-
Objects.requireNonNull(this.getProg().getFunctions().stream()
221+
this.getProg().getFunctions().stream()
222222
.flatMap(f -> {
223223
Element trace = f.attrTrace();
224224
if (trace instanceof FuncDef) {
@@ -233,8 +233,9 @@ public LuaMethod initFor(ImClass a) {
233233
}
234234
return Stream.empty();
235235
})
236-
.findFirst().orElse(null)));
237-
private final ImTranslator imTr;
236+
.findFirst().orElse(null));
237+
final ImTranslator imTr;
238+
238239

239240
public LuaTranslator(ImProg prog, ImTranslator imTr) {
240241
this.prog = prog;
@@ -322,7 +323,6 @@ public LuaCompilationUnit translate() {
322323
initClassTables(c);
323324
}
324325

325-
emitExperimentalHashtableLeakGuards();
326326
prependDeferredMainInitToMain();
327327
cleanStatements();
328328
enforceLuaLocalLimits();
@@ -354,22 +354,6 @@ private void ensureWurstContextCallbackHelpers() {
354354
}
355355
}
356356

357-
private void emitExperimentalHashtableLeakGuards() {
358-
deferMainInit(LuaAst.LuaLiteral("-- Wurst experimental Lua assertion guards: raw WC3 hashtable natives must not be called."));
359-
deferMainInit(LuaAst.LuaLiteral("do"));
360-
deferMainInit(LuaAst.LuaLiteral(" local __wurst_guard_ok = pcall(function()"));
361-
for (String nativeName : allHashtableNativeNames()) {
362-
deferMainInit(LuaAst.LuaLiteral(" if " + nativeName + " ~= nil then " + nativeName
363-
+ " = function(...) error(\"Wurst Lua assertion failed: unexpected call to native " + nativeName
364-
+ ". Expected __wurst_" + nativeName + ".\") end end"));
365-
}
366-
deferMainInit(LuaAst.LuaLiteral(" end)"));
367-
deferMainInit(LuaAst.LuaLiteral(" if not __wurst_guard_ok then"));
368-
deferMainInit(LuaAst.LuaLiteral(" -- Some Lua runtimes lock native globals. Compile-time leak checks stay authoritative."));
369-
deferMainInit(LuaAst.LuaLiteral(" end"));
370-
deferMainInit(LuaAst.LuaLiteral("end"));
371-
}
372-
373357
private void deferMainInit(LuaStatement statement) {
374358
deferredMainInit.add(statement);
375359
}

‎de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/translation/lua/translation/StmtTranslation.java‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,40 @@
55

66
import java.util.List;
77

8+
import static de.peeeq.wurstscript.translation.lua.translation.ExprTranslation.WURST_ABORT_THREAD_SENTINEL;
9+
import de.peeeq.wurstscript.jassIm.ImFunction;
10+
811
public class StmtTranslation {
912

1013
public static void translate(ImExpr e, List<LuaStatement> res, LuaTranslator tr) {
14+
// In Lua mode, package init functions are called directly and wrapped with xpcall.
15+
if (e instanceof ImFunctionCall) {
16+
ImFunctionCall call = (ImFunctionCall) e;
17+
if (tr.imTr.luaInitFunctions.containsKey(call.getFunc())) {
18+
emitLuaInitXpcall(call.getFunc(), res, tr);
19+
return;
20+
}
21+
}
1122
LuaExpr expr = e.translateToLua(tr);
1223
res.add(expr);
1324
}
1425

26+
private static void emitLuaInitXpcall(ImFunction initFunc, List<LuaStatement> res, LuaTranslator tr) {
27+
String funcName = tr.luaFunc.getFor(initFunc).getName();
28+
String packageName = tr.imTr.luaInitFunctions.getOrDefault(initFunc, "?");
29+
String errHandler = "function(err) if err == \"" + WURST_ABORT_THREAD_SENTINEL + "\" then return end"
30+
+ " BJDebugMsg(\"lua init error: \" .. tostring(err))"
31+
+ " xpcall(function() " + ExprTranslation.callErrorFunc(tr, "tostring(err)") + " end,"
32+
+ " function(err2) if err2 == \"" + WURST_ABORT_THREAD_SENTINEL + "\" then return end"
33+
+ " BJDebugMsg(\"error reporting error: \" .. tostring(err2)) end) end";
34+
res.add(LuaAst.LuaLiteral("do"));
35+
res.add(LuaAst.LuaLiteral(" local __wurst_init_ok = xpcall(" + funcName + ", " + errHandler + ")"));
36+
res.add(LuaAst.LuaLiteral(" if not __wurst_init_ok then"));
37+
res.add(LuaAst.LuaLiteral(" " + ExprTranslation.callErrorFunc(tr, "\"Could not initialize package " + packageName + ".\"") + ""));
38+
res.add(LuaAst.LuaLiteral(" end"));
39+
res.add(LuaAst.LuaLiteral("end"));
40+
}
41+
1542
public static void translate(ImExitwhen s, List<LuaStatement> res, LuaTranslator tr) {
1643
LuaIf r = LuaAst.LuaIf(s.getCondition().translateToLua(tr),
1744
LuaAst.LuaStatements(LuaAst.LuaBreak()),

‎de.peeeq.wurstscript/src/test/java/tests/wurstscript/tests/LuaTranslationTests.java‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -477,10 +477,8 @@ public void luaHeavyBootstrapStateIsSeededFromMain() throws IOException {
477477
String beforeMain = compiled.substring(0, mainPos);
478478
assertFalse(beforeMain.contains("__wurst_objectIndexMap = ({"));
479479
assertFalse(beforeMain.contains("__wurst_string_index_map = ({"));
480-
assertFalse(beforeMain.contains("Wurst experimental Lua assertion guards"));
481480
assertTrue(mainSection.contains("__wurst_objectIndexMap = ({"));
482481
assertTrue(mainSection.contains("__wurst_string_index_map = ({"));
483-
assertTrue(mainSection.contains("Wurst experimental Lua assertion guards"));
484482
}
485483

486484
@Test
@@ -531,7 +529,6 @@ public void luaDeferredBootstrapRunsBeforeInitGlobalsInMain() throws IOException
531529
assertOccursBefore(mainSection, "C.__wurst_supertypes =", "initGlobals()");
532530
assertOccursBefore(mainSection, "C.__typeId__ =", "initGlobals()");
533531
assertOccursBefore(mainSection, "C.C_f =", "initGlobals()");
534-
assertOccursBefore(mainSection, "Wurst experimental Lua assertion guards", "initGlobals()");
535532
}
536533

537534
@Test
@@ -1198,15 +1195,19 @@ public void reflectionNativeStubsAreGuardedByExistingDefinitions() throws IOExce
11981195
}
11991196

12001197
@Test
1201-
public void stdLibInitUsesTriggerEvaluateGuardInMain() throws IOException {
1198+
public void stdLibInitUsesXpcallInsteadOfTriggerEvaluateInMain() throws IOException {
12021199
test().testLua(true).withStdLib().lines(
12031200
"package Test",
12041201
"init",
12051202
" skip"
12061203
);
1207-
String compiled = Files.toString(new File("test-output/lua/LuaTranslationTests_stdLibInitUsesTriggerEvaluateGuardInMain.lua"), Charsets.UTF_8);
1208-
assertTrue(compiled.contains("if not(TriggerEvaluate("));
1209-
assertTrue(compiled.contains("TriggerClearConditions"));
1204+
String compiled = Files.toString(new File("test-output/lua/LuaTranslationTests_stdLibInitUsesXpcallInsteadOfTriggerEvaluateInMain.lua"), Charsets.UTF_8);
1205+
// Package inits use direct xpcall — no WC3 trigger handle overhead
1206+
assertTrue(compiled.contains("xpcall(init_"));
1207+
assertTrue(compiled.contains("__wurst_init_ok"));
1208+
// TriggerEvaluate pattern must NOT appear for init functions
1209+
assertFalse(compiled.contains("if not(TriggerEvaluate("));
1210+
assertFalse(compiled.contains("TriggerClearConditions"));
12101211
}
12111212

12121213
@Test
@@ -1261,22 +1262,23 @@ public void hashtableHandleExtensionsUseWurstLuaHelpers() throws IOException {
12611262
String compiled = Files.toString(new File("test-output/lua/LuaTranslationTests_hashtableHandleExtensionsUseWurstLuaHelpers.lua"), Charsets.UTF_8);
12621263
assertDoesNotContainRegex(compiled, "\\bHaveSavedHandle\\(");
12631264
assertContainsRegex(compiled, "\\b__wurst_HaveSavedHandle\\(");
1264-
assertTrue(compiled.contains("Wurst experimental Lua assertion guards"));
12651265
}
12661266

12671267
@Test
1268-
public void hashtableNativeOverrideGuardsAreRuntimeSafe() throws IOException {
1268+
public void hashtableNativesAreReplacedByWurstHelpers() throws IOException {
12691269
test().testLua(true).withStdLib().lines(
12701270
"package Test",
12711271
"init",
12721272
" let h = InitHashtable()",
12731273
" h.saveInt(1, 2, 7)"
12741274
);
1275-
String compiled = Files.toString(new File("test-output/lua/LuaTranslationTests_hashtableNativeOverrideGuardsAreRuntimeSafe.lua"), Charsets.UTF_8);
1276-
assertTrue(compiled.contains("Wurst experimental Lua assertion guards"));
1277-
assertContainsRegex(compiled, "\\blocal\\s+__wurst_guard_ok\\s*=\\s*pcall\\s*\\(\\s*function\\s*\\(");
1278-
assertContainsRegex(compiled, "\\bInitHashtable\\s*=\\s*function\\s*\\(");
1279-
assertContainsRegex(compiled, "\\bSaveInteger\\s*=\\s*function\\s*\\(");
1275+
String compiled = Files.toString(new File("test-output/lua/LuaTranslationTests_hashtableNativesAreReplacedByWurstHelpers.lua"), Charsets.UTF_8);
1276+
// Runtime guard overrides are removed; compile-time checks are authoritative.
1277+
assertFalse(compiled.contains("Wurst experimental Lua assertion guards"));
1278+
assertFalse(compiled.contains("__wurst_guard_ok"));
1279+
// __wurst_ helper definitions must still be present.
1280+
assertContainsRegex(compiled, "\\bfunction\\s+__wurst_InitHashtable\\s*\\(");
1281+
assertContainsRegex(compiled, "\\bfunction\\s+__wurst_SaveInteger\\s*\\(");
12801282
}
12811283

12821284
@Test

0 commit comments

Comments
 (0)