@yowasp/yosys 0.0.0-experimental4 → 0.37.13-dev.624

package/README.md

@@ -0,0 +1,47 @@
+YoWASP Yosys package
+====================
+
+This package provides [Yosys][] binaries built for [WebAssembly][]. See the [overview of the YoWASP project][yowasp] for details.
+
+At the moment, this package only provides an API allowing to run Yosys in a virtual filesystem; no binaries are provided.
+
+This package does not provide access to `sby`, `yowasp-yosys-smtbmc`, and `yowasp-yosys-witness`; only the main `yosys` application is available.
+
+[yosys]: https://github.com/YosysHQ/yosys/
+[webassembly]: https://webassembly.org/
+[yowasp]: https://yowasp.github.io/
+
+
+API reference
+-------------
+
+This package provides one function:
+
+- `runYosys` (alias `cmd:yosys`)
+
+For more detail, see the documentation for [the JavaScript YoWASP runtime](https://github.com/YoWASP/runtime-js#api-reference).
+
+
+Versioning
+----------
+
+The version of this package is derived from the upstream Yosys package version in the `X.Y[.Z][+N]` format, and can be in one of the two formats, `X.Y.M` (for builds from release branches) or `X.(Y+1).N-dev.M` (for development builds), where the symbols are:
+
+1. `X`: Yosys major version
+2. `Y`: Yosys minor version
+3. `Z`: Yosys patch version; ignored if present
+4. `N`: matches the `N` in the `X.Y+N` upstream version, if present
+5. `M`: package build version; disambiguates different builds produced from the same Yosys source tree
+6. `-dev`: present only for packages built from unreleased Yosys snapshots; marks these packages as pre-releases
+
+With this scheme, there is a direct correspondence between upstream versions and [SemVer][semver] NPM package versions.
+
+Note that for development builds, the minor version is incremented as required by the SemVer comparison order. This means that an NPM package built from the upstream version `0.45+12` and the 120th commit in this repository will have the version `0.46.12-dev.120`. Because this is a pre-release package, it will not be matched by version specifiers such as `^0.46` or `>=0.46`.
+
+[semver]: https://semver.org/
+
+
+License
+-------
+
+This package is covered by the [ISC license](LICENSE.txt), which is the same as the [Yosys license](https://github.com/YosysHQ/yosys/blob/master/COPYING).

package/gen/bundle-browser.js

@@ -253,11 +253,17 @@ function directoryFromTree(tree) {
   }
   return new Directory(files);
 }
-function directoryIntoTree(directory) {
+function directoryIntoTree(directory, { decodeASCII = true } = {}) {
+  function isASCII(buffer) {
+    for (const byte of buffer)
+      if (byte < 32 && byte !== 9 && byte !== 10 && byte !== 13 || byte >= 127)
+        return false;
+    return true;
+  }
   const tree = {};
   for (const [filename, entry] of Object.entries(directory.files)) {
     if (entry instanceof File)
-      tree[filename] = new TextDecoder().decode(entry.data);
+      tree[filename] = decodeASCII && isASCII(entry.data) ? new TextDecoder().decode(entry.data) : entry.data;
     if (entry instanceof Directory)
       tree[filename] = directoryIntoTree(entry);
   }
@@ -346,7 +352,7 @@ var BaseApplication = class {
     this.instantiate = instantiate2;
     this.argv0 = argv0;
   }
-  async run(args, files = {}, printLine = console.log) {
+  async run(args, files = {}, { printLine = console.log, decodeASCII = true } = {}) {
     if (this._resources === null)
       this._resources = await this.getResources();
     const environment = new Environment();
@@ -359,15 +365,24 @@ var BaseApplication = class {
       (filename) => this.wasmModules[filename],
       { runtime: environment.exports }
     );
+    let error = null;
     try {
       wasmCommand.run.run();
     } catch (e) {
-      if (!(e instanceof Exit && e.code === 0))
+      if (!(e instanceof Exit))
         throw e;
+      if (e instanceof Exit && e.code !== 0)
+        error = e;
     }
     for (const dirName of Object.keys(this._resources))
       delete environment.root.files[dirName];
-    return directoryIntoTree(environment.root);
+    files = directoryIntoTree(environment.root, { decodeASCII });
+    if (error !== null) {
+      error.files = files;
+      throw error;
+    } else {
+      return files;
+    }
   }
 };
 
@@ -4548,5 +4563,6 @@ var yosys = new Application(import.meta.url, {
 var runYosys = yosys.run.bind(yosys);
 export {
   Exit,
+  runYosys as "cmd:yosys",
   runYosys
 };

package/gen/bundle-node.js

@@ -256,11 +256,17 @@ function directoryFromTree(tree) {
   }
   return new Directory(files);
 }
-function directoryIntoTree(directory) {
+function directoryIntoTree(directory, { decodeASCII = true } = {}) {
+  function isASCII(buffer) {
+    for (const byte of buffer)
+      if (byte < 32 && byte !== 9 && byte !== 10 && byte !== 13 || byte >= 127)
+        return false;
+    return true;
+  }
   const tree = {};
   for (const [filename, entry] of Object.entries(directory.files)) {
     if (entry instanceof File)
-      tree[filename] = new TextDecoder().decode(entry.data);
+      tree[filename] = decodeASCII && isASCII(entry.data) ? new TextDecoder().decode(entry.data) : entry.data;
     if (entry instanceof Directory)
       tree[filename] = directoryIntoTree(entry);
   }
@@ -349,7 +355,7 @@ var BaseApplication = class {
     this.instantiate = instantiate2;
     this.argv0 = argv0;
   }
-  async run(args, files = {}, printLine = console.log) {
+  async run(args, files = {}, { printLine = console.log, decodeASCII = true } = {}) {
     if (this._resources === null)
       this._resources = await this.getResources();
     const environment = new Environment();
@@ -362,15 +368,24 @@ var BaseApplication = class {
       (filename) => this.wasmModules[filename],
       { runtime: environment.exports }
     );
+    let error = null;
     try {
       wasmCommand.run.run();
     } catch (e) {
-      if (!(e instanceof Exit && e.code === 0))
+      if (!(e instanceof Exit))
         throw e;
+      if (e instanceof Exit && e.code !== 0)
+        error = e;
     }
     for (const dirName of Object.keys(this._resources))
       delete environment.root.files[dirName];
-    return directoryIntoTree(environment.root);
+    files = directoryIntoTree(environment.root, { decodeASCII });
+    if (error !== null) {
+      error.files = files;
+      throw error;
+    } else {
+      return files;
+    }
   }
 };
 
@@ -4551,5 +4566,6 @@ var yosys = new Application(import.meta.url, {
 var runYosys = yosys.run.bind(yosys);
 export {
   Exit,
+  runYosys as "cmd:yosys",
   runYosys
 };