@yowasp/clang 21.1.4-1 → 22.0.0-git20542-10

package/README.md

@@ -3,13 +3,49 @@ YoWASP Clang/LLD package
 
 This package provides a complete [Clang/LLD][] toolchain built for [WebAssembly][] and targeting WebAssembly as well. See the [overview of the YoWASP project][yowasp] for details.
 
-At the moment, this package only offers an API allowing to run Clang and LLD in a virtual filesystem; no executables are provided.
+At the moment, this package only offers an API allowing to run Clang and LLD in a virtual filesystem; no executables are provided. Note that if you are importing `.../gen/bundle.js` directly, you must use it as a module.
 
 [Clang/LLD]: https://llvm.org/
 [WebAssembly]: https://webassembly.org/
 [yowasp]: https://yowasp.github.io/
 
 
+Examples
+--------
+
+All examples below are written for Node.js; to run them, install `@yowasp/clang` first. The C/C++ code can be compiled equally well in the browser and other runtimes, but WASI is unevenly supported.
+
+### Hosted C++ executable
+
+```js
+import { runClang } from '@yowasp/clang';
+const { meow } = await runClang(['clang++', 'test.cc', '-o', 'meow'],
+    {"test.cc": `#include <iostream>\nint main() { std::cout << "meow++" << std::endl; }`});
+
+import { WASI } from 'node:wasi';
+const wasi = new WASI({ version: 'preview1' });
+const module = await WebAssembly.compile(meow);
+const instance = await WebAssembly.instantiate(module,
+    {wasi_snapshot_preview1: wasi.wasiImport});
+wasi.start(instance);
+// prints "meow++"
+```
+
+
+### Freestanding C library
+
+```js
+import { runClang } from '@yowasp/clang';
+const { 'a.out': wasm } = await runClang(['clang', '-nostdlib', '-Wl,--no-entry', 'test.c'], {
+    'test.c': 'int add(int a, int b) __attribute__((export_name("add"))) { return a + b; }'});
+
+const module = await WebAssembly.compile(wasm);
+const instance = await WebAssembly.instantiate(module);
+console.log('add(1, 2) =', instance.exports.add(1, 2));
+// prints "add(1, 2) = 3"
+```
+
+
 API reference
 -------------
 

package/gen/bundle.js

@@ -599,7 +599,7 @@ function parseTar(data, opts) {
   const files = [];
   let offset = 0;
   while (offset < buffer.byteLength - 512) {
-    const name = _readString(buffer, offset, 100);
+    let name = _readString(buffer, offset, 100);
     if (name.length === 0) {
       break;
     }
@@ -613,6 +613,7 @@ function parseTar(data, opts) {
     const type = _type === TAR_TYPE_FILE ? "file" : _type === TAR_TYPE_DIR ? "directory" : _type;
     const user = _readString(buffer, offset + 265, 32);
     const group = _readString(buffer, offset + 297, 32);
+    name = _sanitizePath(name);
     const meta = {
       name,
       type,
@@ -647,6 +648,29 @@ function parseTar(data, opts) {
   }
   return files;
 }
+function _sanitizePath(path) {
+  let normalized = path.replace(/\\/g, "/");
+  normalized = normalized.replace(/^[a-zA-Z]:\//, "");
+  normalized = normalized.replace(/^\/+/, "");
+  const hasLeadingDotSlash = normalized.startsWith("./");
+  const parts = normalized.split("/");
+  const resolved = [];
+  for (const part of parts) {
+    if (part === "..") {
+      resolved.pop();
+    } else if (part !== "." && part !== "") {
+      resolved.push(part);
+    }
+  }
+  let result = resolved.join("/");
+  if (hasLeadingDotSlash && !result.startsWith("./")) {
+    result = "./" + result;
+  }
+  if (path.endsWith("/") && !result.endsWith("/")) {
+    result += "/";
+  }
+  return result;
+}
 function _readString(buffer, offset, size) {
   const view = new Uint8Array(buffer, offset, size);
   const i = view.indexOf(0);
@@ -696,7 +720,7 @@ var modules = async (fetch3) => ({
 var filesystem = async (fetch3) => ({
   "usr": await fetch3(new URL("./llvm-resources.tar", import.meta.url)).then((resp) => resp.arrayBuffer()).then(unpackTarFilesystem)
 });
-var totalSize = 102337718;
+var totalSize = 105241285;
 
 // gen/llvm.js
 function instantiate(getCoreModule, imports, instantiateCore = WebAssembly.instantiate) {
@@ -7877,14 +7901,14 @@ function instantiate(getCoreModule, imports, instantiateCore = WebAssembly.insta
 var llvm = new Application(llvm_resources_exports, instantiate, "yowasp-llvm");
 var runLLVM = llvm.run.bind(llvm);
 function subcommand(command, subcommandName) {
-  return function(args, files, options) {
-    if (args === void 0 || args == null)
+  return function(args = null, files = {}, options = {}) {
+    if (args === null)
       return command(args, files, options);
     return command([subcommandName, ...args], files, options);
   };
 }
-function runClang(args, files, options = {}) {
-  if (args === void 0 || args === null)
+function runClang(args = null, files = {}, options = {}) {
+  if (args === null)
     return runLLVM(args, files, options);
   if (args.includes("-###"))
     return runLLVM(args, files, options);
@@ -8034,8 +8058,9 @@ var commands = {
   "clang": subcommand(runClang, "clang"),
   "clang++": subcommand(runClang, "clang++")
 };
-var version = "21.1.4-1";
+var version = "22.0.0-git20542-10";
 export {
+  Exit,
   commands,
   runClang,
   runLLVM,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yowasp/clang",
-  "version": "21.1.4-1",
+  "version": "22.0.0-git20542-10",
   "description": "LLVM/Clang/LLD toolchain targeting WebAssembly",
   "author": "Catherine <whitequark@whitequark.org>",
   "license": "ISC",
@@ -32,7 +32,7 @@
   "scripts": {
     "transpile": "jco new ../llvm-build/bin/llvm --wasi-command --output llvm.wasm && jco transpile llvm.wasm --instantiation async --no-typescript --no-namespaced-exports --map 'wasi:io/*=runtime#io' --map 'wasi:cli/*=runtime#cli' --map 'wasi:clocks/*=runtime#*' --map 'wasi:filesystem/*=runtime#fs' --map 'wasi:random/*=runtime#random' --out-dir gen/",
     "pack": "yowasp-pack-resources gen/llvm-resources.js gen ../wasi-prefix/usr usr",
-    "build": "esbuild --bundle lib/api.js --outfile=gen/bundle.js --format=esm --platform=node --define:VERSION=\\\"21.1.4-1\\\"",
+    "build": "esbuild --bundle lib/api.js --outfile=gen/bundle.js --format=esm --platform=node --define:VERSION=\\\"22.0.0-git20542-10\\\"",
     "all": "npm run transpile && npm run pack && npm run build"
   }
 }