Merge pull request #77 from roginvs/add_builtin_sslc_compiler

Add built-in compiler for Fallout2 .ssl files

Author: burner1024

.vscodeignore

@@ -14,6 +14,8 @@
 # Rollup native bindings
 !server/node_modules/@rollup/rollup*/**
 
+!server/node_modules/sslc-emscripten-noderawfs/**
+
 !preview/package.json
 !preview/out/index.html
 !preview/out/index.css

README.md

@@ -20,6 +20,7 @@ BGforge MLS is a VScode extension adding support for [Star-Trek Scripting Langua
 - [Hovers](#fallout-highlighting-and-hovers)
 - [Error reporting](#error-reporting)
 - Signature help, diagnostics, docstrings, etc. See the [forum](https://forums.bgforge.net/viewforum.php?f=35).
+- Embedded cross-platform .ssl compiler (check `falloutSSL.useBuiltInCompiler` option) 
 
 ### Installation
 
@@ -48,3 +49,5 @@ BGforge MLS is a VScode extension adding support for [Star-Trek Scripting Langua
 #### Error reporting
 
 ![error reporting example](docs/error_reporting.png)
+
+

docs/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.3.0
+
+Add built-in .ssl compiler
+
 ## 2.2.6
 
 Cosmetic: fixed double dot in tmp filenames, introduced in 2.2.5.

docs/settings.md

@@ -17,6 +17,7 @@ _([How to change settings in VScode](https://code.visualstudio.com/docs/getstart
 ### Fallout SSL
 
 - `bgforge.falloutSSL.compilePath`: Path to compile.exe from sfall modders pack. Alternatively, you can add compile.exe to system PATH and leave default here.
+- `bgforge.falloutSSL.useBuiltInCompiler`: Use built-in compiler instead of external compile.exe
 - `bgforge.falloutSSL.compileOptions`: Compilation options for compile.exe from sfall modders pack.
 - `bgforge.falloutSSL.outputDirectory`: Where to put the compiled Fallout SSL scripts, absolute path. Default is to put compiled scripts next to the source file. You'll probably want to set this to `data/scripts` of your Fallout 2 game directory.
 - `bgforge.falloutSSL.headersDirectory`: Path to an additional directory with Fallout headers to scan for defines.

package.json

@@ -2,7 +2,7 @@
     "name": "bgforge-mls",
     "displayName": "BGforge MLS",
     "description": "BGforge multilanguage server",
-    "version": "2.2.6",
+    "version": "2.3.0",
     "author": "BGforge",
     "repository": {
         "type": "git",
@@ -344,10 +344,15 @@
             "type": "object",
             "title": "BGforge MLS",
             "properties": {
+                "bgforge.falloutSSL.useBuiltInCompiler": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "Use built-in compiler instead of external compile.exe"
+                },
                 "bgforge.falloutSSL.compilePath": {
                     "type": "string",
                     "default": "wine ~/bin/compile",
-                    "description": "Path to compile.exe from sfall modders pack. Alternatively, you can add compile.exe to system PATH and leave default here."
+                    "description": "Path to compile.exe from sfall modders pack. Alternatively, you can add compile.exe to system PATH and leave default here. Ignored if 'Use built-in compiler' is enabled."
                 },
                 "bgforge.falloutSSL.compileOptions": {
                     "type": "string",
@@ -443,4 +448,4 @@
             "esbuild"
         ]
     }
-}
+}

server/package-lock.json

@@ -1,13 +1,14 @@
 {
     "name": "bgforge-mls-server",
     "description": "BGforge multilanguage server",
-    "version": "2.2.6",
+    "version": "2.3.0",
     "author": "BGforge",
     "license": "SEE LICENSE IN LICENSE.txt",
     "engines": {
         "vscode": "^1.69.2",
         "node": "*"
     },
+    "scripts": {},
     "repository": {
         "type": "git",
         "url": "https://github.com/BGforgeNet/VScode-BGforge-MLS/server"
@@ -17,6 +18,7 @@
         "@supercharge/promise-pool": "^2.3.2",
         "fast-glob": "^3.2.12",
         "rollup": "^4.30.1",
+        "sslc-emscripten-noderawfs": "https://github.com/sfall-team/sslc/releases/download/2025-06-18-01-40-04/wasm-emscripten-node-noderawfs.tar.gz",
         "strip-literal": "^1.0.0",
         "ts-morph": "^24.0.0",
         "tslib": "^2.8.1",
@@ -35,4 +37,4 @@
         "@types/vscode": "^1.69.1",
         "@vscode/test-electron": "^2.2.1"
     }
-}
+}

server/package.json

@@ -59,7 +59,7 @@ export async function compile(uri: string, langId: string, interactive = false,
 
     if (falloutLanguages.includes(langId)) {
         clearDiagnostics(uri);
-        fallout.compile(uri, settings.falloutSSL, interactive, text);
+        await fallout.compile(uri, settings.falloutSSL, interactive, text);
         return;
     }
 

server/src/compile.ts

@@ -24,6 +24,7 @@ import { Edge, Node } from "./preview";
 import { connection, documents } from "./server";
 import { SSLsettings } from "./settings";
 import * as signature from "./signature";
+import { ssl_compile as ssl_builtin_compiler } from "./sslc/ssl_compiler";
 
 interface FalloutHeaderData {
     macros: Macros;
@@ -36,7 +37,7 @@ interface Procedure {
     detail: string;
     jsdoc?: jsdoc.JSdoc;
 }
-interface Procedures extends Array<Procedure> { }
+interface Procedures extends Array<Procedure> {}
 interface Macro {
     label: string;
     detail: string;
@@ -45,7 +46,7 @@ interface Macro {
     firstline: string;
     jsdoc?: jsdoc.JSdoc;
 }
-interface Macros extends Array<Macro> { }
+interface Macros extends Array<Macro> {}
 
 const tooltipLangId = "fallout-ssl-tooltip";
 const sslExt = ".ssl";
@@ -594,7 +595,32 @@ function sendDiagnostics(uri: string, outputText: string, tmpUri: string) {
     sendParseResult(parseResult, uri, tmpUri);
 }
 
-export function compile(uri: string, sslSettings: SSLsettings, interactive = false, text: string) {
+let successfullCompilerPath: string | null = null;
+async function checkExternalCompiler(compilePath: string) {
+    if (compilePath === successfullCompilerPath) {
+        // Check compiler only once
+        return Promise.resolve(true);
+    }
+
+    return new Promise<boolean>((resolve) => {
+        cp.exec(`${compilePath} --version`, (err) => {
+            conlog(`Compiler check '${compilePath} --version' err=${err}`);
+            if (err) {
+                resolve(false);
+            } else {
+                successfullCompilerPath = compilePath;
+                resolve(true);
+            }
+        });
+    });
+}
+
+export async function compile(
+    uri: string,
+    sslSettings: SSLsettings,
+    interactive = false,
+    text: string,
+) {
     const filepath = uriToPath(uri);
     const cwdTo = path.dirname(filepath);
     // tmp file has to be in the same dir, because includes can be relative or absolute
@@ -618,6 +644,46 @@ export function compile(uri: string, sslSettings: SSLsettings, interactive = fal
     conlog(`compiling ${baseName}...`);
 
     fs.writeFileSync(tmpPath, text);
+
+    let useBuiltInCompiler = sslSettings.useBuiltInCompiler;
+
+    if (!useBuiltInCompiler && !(await checkExternalCompiler(sslSettings.compilePath))) {
+        const response = await connection.window.showErrorMessage(
+            `Failed to run '${sslSettings.compilePath}'! Use built-in compiler this time?`,
+            { title: "Yes", id: "yes" },
+            { title: "No", id: "no" },
+        );
+        if (response?.id === "yes") {
+            useBuiltInCompiler = true;
+        }
+    }
+
+    if (useBuiltInCompiler) {
+        const { stdout, returnCode } = await ssl_builtin_compiler({
+            interactive,
+            cwd: cwdTo,
+            inputFileName: tmpName,
+            outputFileName: dstPath,
+            options: sslSettings.compileOptions,
+            headersDir: sslSettings.headersDirectory,
+        });
+        if (returnCode === 0) {
+            if (interactive) {
+                connection.window.showInformationMessage(`Successfully compiled ${baseName}.`);
+            }
+        } else {
+            if (interactive) {
+                connection.window.showErrorMessage(`Failed to compile ${baseName}!`);
+            }
+        }
+        sendDiagnostics(uri, stdout, tmpUri);
+        // sometimes it gets deleted due to async runs?
+        if (fs.existsSync(tmpPath)) {
+            fs.unlinkSync(tmpPath);
+        }
+        return;
+    }
+
     conlog(`${compileCmd} "${tmpName}" -o "${dstPath}"`);
     cp.exec(
         `${compileCmd} "${tmpName}" -o "${dstPath}"`,

server/src/fallout.ts

@@ -5,6 +5,7 @@ import { conlog } from "./common";
 
 export interface SSLsettings {
     compilePath: string;
+    useBuiltInCompiler: boolean;
     compileOptions: string;
     outputDirectory: string;
     headersDirectory: string;
@@ -29,6 +30,7 @@ export interface MLSsettings {
 export const defaultSettings: MLSsettings = {
     falloutSSL: {
         compilePath: "compile",
+        useBuiltInCompiler: false,
         compileOptions: "-q -p -l -O2 -d -s -n",
         outputDirectory: "",
         headersDirectory: "",