swipl-wasm 1.0.0

package/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "files.exclude": {
+    "wasm/swipl-devel": true,
+    "wasm/zlib-1.2.12": true,
+    "wasm/zlib-1.2.12.tar.gz": true
+  }
+}

package/LICENSE.txt

@@ -0,0 +1,41 @@
+# SWI-Prolog copyright status
+
+SWI-Prolog is covered by the Simplified BSD license:
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in
+       the documentation and/or other materials provided with the
+       distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+
+## Possible additional license requirements
+
+Note that SWI-Prolog may be linked with libraries covered by more
+restrictive license and therefore the above conditions may not suffice
+for a particular version of SWI-Prolog or a program loaded into
+SWI-Prolog. Run the following predicate to find which components with
+additional requirements are loaded into a particular version.
+
+  ```
+  ?- license.
+  ```
+

package/README.md

@@ -0,0 +1,82 @@
+# swipl-wasm
+
+SWI-Prolog WebAssembly build as a NPM package. Please see this page
+for ongoing progress and information:
+<https://swi-prolog.discourse.group/t/swi-prolog-in-the-browser-using-wasm/5650>
+
+## Usage
+
+In browser:
+
+```html
+<div id="solution"></div>
+<script src="/dist/swipl/swipl-web.js"></script>
+<script>
+  (async () => {
+    const swipl = await SWIPL({
+      noInitialRun: true,
+      arguments: ["-q"],
+      locateFile: (url) => {
+        if (url === "swipl-web.data") {
+          return "/dist/swipl/swipl-web.data";
+        } else if (url === "swipl-web.wasm") {
+          return "/dist/swipl/swipl-web.wasm";
+        }
+        return url;
+      },
+    });
+    const query = "member(X, [a, b, c]).";
+    const solutionElement = document.getElementById("solution");
+    // See https://swi-prolog.discourse.group/t/swi-prolog-in-the-browser-using-wasm/5650/1
+    const firstSolution = swipl.prolog.query(query).once().X;
+    solutionElement.textContent = firstSolution;
+  })();
+</script>
+```
+
+You can run this example by executing `npm run test:serve-http` and
+visiting <http://localhost:8080/examples/browser.html>.
+
+In Nodejs:
+
+```js
+// This helps to find the correct locations of the
+// .data and .wasm files.
+const swiplModuleLocation = require.resolve("swipl-wasm/swipl");
+const swipl = await SWIPL({
+  noInitialRun: true,
+  arguments: ["-q"],
+  locateFile: (url) => {
+    // These are common with the web version.
+    if (url === "swipl-web.data") {
+      return path.join(path.dirname(swiplModuleLocation), "swipl-web.data");
+    } else if (url === "swipl-web.wasm") {
+      return path.join(path.dirname(swiplModuleLocation), "swipl-web.wasm");
+    }
+    return url;
+  },
+});
+// See https://swi-prolog.discourse.group/t/swi-prolog-in-the-browser-using-wasm/5650/1
+console.log(swipl.prolog.query("member(X, [a, b, c]).").once().X);
+```
+
+You can run this example with `node examples/run-on-node.js`.
+
+## Build
+
+The package can be built using npm or yarn. Please use yarn to
+add new dependencies and update yarn.lock file. SWI-Prolog WebAssembly
+version is currently built inside Docker with Emscripten.
+
+## TODO
+
+- More examples (how to bundle with webpack)
+- Integrate with SWI-Prolog CI
+- TypeScript types for Prolog.js (and the Query interface)
+- Use EcmaScript modules as output:
+  <https://github.com/emscripten-core/emscripten/issues/11792>
+
+## License
+
+Same as SWI-Prolog license, BSD simplified:
+<https://github.com/SWI-Prolog/swipl-devel/blob/master/LICENSE>

package/docker/Dockerfile

@@ -0,0 +1,53 @@
+# Builds SWI-Prolog WebAssembly version.
+# https://swi-prolog.discourse.group/t/swi-prolog-in-the-browser-using-wasm/5650
+
+FROM debian:bullseye
+
+# Installs build dependencies.
+
+ENV DEBIAN_FRONTEND noninteractive
+
+RUN apt-get update && apt-get install -y \
+  bzip2 \
+  cmake \
+  git \
+  ninja-build \
+  python3 \
+  wget \
+  xz-utils
+
+RUN git config --global pull.ff only
+
+# Installs Emscripten.
+# See https://emscripten.org/docs/getting_started/downloads.html
+
+ENV EMSDK_VERSION 3.1.20
+
+RUN git clone https://github.com/emscripten-core/emsdk.git /emsdk
+WORKDIR /emsdk
+RUN git pull
+RUN ./emsdk install $EMSDK_VERSION
+RUN ./emsdk activate $EMSDK_VERSION
+
+# Downloads ZLIB.
+
+RUN wget --no-verbose https://zlib.net/zlib-1.2.12.tar.gz -O /zlib-1.2.12.tar.gz
+RUN tar -xf /zlib-1.2.12.tar.gz --directory /
+
+# Clones SWI-Prolog.
+
+RUN git clone https://github.com/SWI-Prolog/swipl-devel.git /swipl-devel
+WORKDIR /swipl-devel
+
+# Uncomment the following to build a specific commit.
+# ENV SWIPL_COMMIT 5c7d1f8352b27d45cb8066eac5af95cf925a05b7
+# RUN git checkout $SWIPL_COMMIT -b local-wasm
+
+RUN git fetch
+RUN git submodule update --init
+
+# Compiles everything.
+
+COPY build-all.sh /build-all.sh
+RUN chmod +x /build-all.sh
+RUN /build-all.sh

package/docker/build-all.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+set -o errexit
+set -o xtrace
+
+source /emsdk/emsdk_env.sh
+
+# ZLIB
+
+cd /zlib-1.2.12
+emconfigure ./configure
+EMCC_CFLAGS=-Wno-deprecated-non-prototype emmake make
+
+# SWI-Prolog
+
+mkdir /swipl-devel/swipl.wasm
+cd /swipl-devel/swipl.wasm
+cmake -DCMAKE_TOOLCHAIN_FILE=/emsdk/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DZLIB_LIBRARY=/zlib-1.2.12/libz.a \
+  -DZLIB_INCLUDE_DIR=/zlib-1.2.12 \
+  -DINSTALL_DOCUMENTATION=OFF \
+  -DMULTI_THREADED=OFF \
+  -DUSE_SIGNALS=OFF \
+  -DUSE_GMP=OFF \
+  -DBUILD_SWIPL_LD=OFF \
+  -DSWIPL_PACKAGES=OFF \
+  -G Ninja ..
+ninja

package/examples/browser.html

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF8">
+    <title>SWI-Prolog WebAssembly browser test</title>
+  </head>
+  <body>
+    <div id="solution"></div>
+    <script src="/dist/swipl/swipl-web.js"></script>
+    <script>
+      (async () => {
+        const swipl = await SWIPL({
+          noInitialRun: true,
+          arguments: ['-q'],
+          locateFile: (url) => {
+            if (url === 'swipl-web.data') {
+              return '/dist/swipl/swipl-web.data';
+            } else if (url === 'swipl-web.wasm') {
+              return '/dist/swipl/swipl-web.wasm';
+            }
+            return url;
+          }
+        });
+        const query = "member(X, [a, b, c]).";
+        const solutionElement = document.getElementById('solution');
+        // See https://swi-prolog.discourse.group/t/swi-prolog-in-the-browser-using-wasm/5650/1      
+        const firstSolution = swipl.prolog.query(query).once().X;
+        solutionElement.textContent = firstSolution;
+      })();
+    </script>
+  </body>
+</html>

package/examples/run-on-node.js

@@ -0,0 +1,23 @@
+const path = require('path');
+const SWIPL = require('swipl-wasm/swipl');
+
+(async () => {
+  // This helps to find the correct locations of the
+  // .data and .wasm files.
+  const swiplModuleLocation = require.resolve('swipl-wasm/swipl');
+  const swipl = await SWIPL({
+    noInitialRun: true,
+    arguments: ['-q'],
+    locateFile: (url) => {
+      // These are common with the web version.
+      if (url === 'swipl-web.data') {
+        return path.join(path.dirname(swiplModuleLocation), 'swipl-web.data');
+      } else if (url === 'swipl-web.wasm') {
+        return path.join(path.dirname(swiplModuleLocation), 'swipl-web.wasm');
+      }
+      return url;
+    }
+  });
+  // See https://swi-prolog.discourse.group/t/swi-prolog-in-the-browser-using-wasm/5650/1
+  console.log(swipl.prolog.query("member(X, [a, b, c]).").once().X);
+})();

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "swipl-wasm",
+  "version": "1.0.0",
+  "exports": {
+    "./swipl": "./dist/swipl/swipl.js",
+    "./swipl-web": "./dist/swipl/swipl-web.js"
+  },
+  "author": "Raivo Laanemets",
+  "license": "BSD-2-Clause",
+  "type": "commonjs",
+  "devDependencies": {
+    "npm-run-all": "^4.1.5",
+    "http-server": "^14.1.1"
+  },
+  "scripts": {
+    "build:wasm-docker:build": "docker build -t swipl-wasm-image docker",
+    "build:wasm-docker:create": "docker create --name swipl-wasm swipl-wasm-image",
+    "build:wasm-docker:remove": "docker rm swipl-wasm",
+    "build:wasm-docker:extract:data": "docker cp swipl-wasm:/swipl-devel/swipl.wasm/src/swipl-web.data dist/swipl/swipl-web.data",
+    "build:wasm-docker:extract:wasm": "docker cp swipl-wasm:/swipl-devel/swipl.wasm/src/swipl-web.wasm dist/swipl/swipl-web.wasm",
+    "build:wasm-docker:extract:web": "docker cp swipl-wasm:/swipl-devel/swipl.wasm/src/swipl-web.js dist/swipl/swipl-web.js",
+    "build:wasm-docker:extract:node": "docker cp swipl-wasm:/swipl-devel/swipl.wasm/src/swipl-web.js dist/swipl/swipl.js",
+    "build:wasm-docker:extract": "run-s build:wasm-docker:extract:*",
+    "build:wasm-docker": "run-s build:wasm-docker:build build:wasm-docker:create build:wasm-docker:extract build:wasm-docker:remove",
+    "build": "run-s build:wasm-docker",
+    "test:serve-http": "http-server . -c-1"
+  }
+}