cpp.js 0.1.0

package/.mocharc.yaml

@@ -0,0 +1,3 @@
+spec:
+  - 'src/**/*.spec.js'
+  - 'test/*.spec.js'

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Buğra Sarı
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/assets/CMakeLists.txt

@@ -0,0 +1,9 @@
+cmake_minimum_required(VERSION 3.1)
+project(cppjs)
+
+file(GLOB SRC_FILES "${BASE_DIR}/native/**/*.cpp" "${BASE_DIR}/native/*.cpp" "${BRIDGE_DIR}/*.i.cpp")
+add_library(cppjs STATIC ${SRC_FILES})
+
+file(GLOB HEADERS "${BASE_DIR}/node_modules/cppjs-lib-*/include")
+message("... ${SRC_FILES} . ${HEADERS};${BASE_DIR}/native")
+include_directories("${HEADERS};${BASE_DIR}/native")

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "cpp.js",
+  "version": "0.1.0",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "cpp.js": "./src/bin.js"
+  },
+  "main": "/src/index.js",
+  "dependencies": {
+    "commander": "^9.4.1",
+    "glob": "^8.0.3"
+  },
+  "devDependencies": {
+    "mocha": "^10.2.0",
+    "cppjs-lib-sample-web": "^0.1.0"
+  },
+  "scripts": {
+    "test": "mocha"
+  }
+}

package/src/bin.js

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+
+import packageJSON from '../package.json' assert { type: 'json' };
+import { Command, Argument } from 'commander';
+
+import { createBridge, findCMakeListsFile, findOrCreateInterfaceFile, createWasm } from './index.js';
+import { createTempDir } from './utils.js';
+
+const program = new Command();
+    program
+    .name('cpp.js')
+    .description('Compile c++ files to webassembly.')
+    .version(packageJSON.version)
+    .showHelpAfterError();
+
+    program.addArgument(new Argument('<type>', 'Creation type').choices(['bridge', 'wasm', 'all']));
+    program.argument('<input>', 'Input paths');
+    program
+        .option('-o, --output <string>', 'Output path');
+
+program.parse(process.argv);
+const options = program.opts();
+const args = program.args;
+
+const [type, ...inputs]= args;
+main(type, inputs);
+
+async function main(type, inputs, output = createTempDir('a'+Math.random())) {
+    if (type === 'bridge' || type === 'all') {
+        const interfaceFile = findOrCreateInterfaceFile(process.cwd()+'/'+inputs[0], output);
+        createBridge(interfaceFile, output);
+    }
+
+    if (type === 'wasm' || type === 'all') {
+        const cMakeListsFilePath = findCMakeListsFile();
+        createWasm(cMakeListsFilePath, output, output, { cc: ['-O3'] });
+    }
+    console.log('output: ' + output);
+}

package/src/createBridge.js

@@ -0,0 +1,18 @@
+import glob from 'glob';
+import { execFileSync } from 'child_process';
+import pullDockerImage from './pullDockerImage.js';
+
+export default function createBridge(filePath, outputPath) {
+    pullDockerImage();
+    const includePath = [
+        glob.sync("node_modules/cppjs-lib-*-web/include", { absolute: true })
+    ].map(path => `-I${path}`);
+
+    const options = { cwd: outputPath, stdio : 'pipe' };
+    const args = [
+        "run", "-v", `${outputPath}:/output`, "-v", "/:/live", "bugra9/cpp.js",
+        "swig", "-c++", '-emscripten', '-o', `/output/${filePath.split('/').at(-1)}.cpp`, ...includePath, `/live${filePath}`
+    ];
+    execFileSync("docker", args, options);
+    return `${outputPath}/${filePath.split('/').at(-1)}.cpp`;
+}

package/src/createBridge.spec.js

@@ -0,0 +1,52 @@
+import { assert } from 'chai';
+import fs from 'fs';
+import p, {dirname} from 'path';
+import * as url from 'node:url';
+import { tmpdir } from "os";
+import createBridge from './createBridge.js';
+
+const __filename = url.fileURLToPath(import.meta.url);
+const temp = __filename.split('/');
+temp.pop();
+temp.pop();
+const __dirname = temp.join('/');
+
+export function createTempDir(folder) {
+    let path = p.join(tmpdir(), "cppjs-app-cli-test");
+    if (folder) path = p.join(path, folder);
+
+    if (fs.existsSync(path)) fs.rmSync(path, { recursive: true, force: true });
+    fs.mkdirSync(path, { recursive: true });
+
+    return path;
+}
+
+describe('createBridge', function () {
+    let tempdir;
+    before(async function () {
+        tempdir = createTempDir();
+    });
+
+    it('createBridge', async function () {
+        const path = __dirname+'/test/data/sample.i';
+        const bridgeFilePath = createBridge(path, tempdir);
+        const bridgeFileData = fs.readFileSync(bridgeFilePath, 'utf8');
+
+        const startIndex = bridgeFileData.indexOf('#include <emscripten/bind.h>');
+        const bridgeFileDataTrim = bridgeFileData.substring(startIndex, bridgeFileData.length).trim();
+
+        const expectedContent =
+`#include <emscripten/bind.h>
+
+#include "sample.h"
+
+EMSCRIPTEN_BINDINGS(Sample) {
+  emscripten::class_<Sample>("Sample")
+    .constructor<>()
+    .function("t", &Sample::t)
+  ;
+}
+`.trim();
+        assert.equal(bridgeFileDataTrim, expectedContent);
+    });
+});

package/src/createWasm.js

@@ -0,0 +1,52 @@
+import { execFileSync } from 'child_process';
+import * as url from 'node:url';
+import pullDockerImage from './pullDockerImage.js';
+
+const __filename = url.fileURLToPath(import.meta.url);
+const temp = __filename.split('/');
+temp.pop();
+temp.pop();
+const __dirname = temp.join('/');
+
+export default function createWasm(cMakeFilePath, outputPath, tempPath, options = {}) {
+    pullDockerImage();
+    cmake(cMakeFilePath, tempPath);
+    make(tempPath);
+    cc(tempPath, outputPath, options.cc);
+
+    return outputPath;
+}
+
+function cmake(cMakeFilePath, outputPath) {
+    let cMakeParentPath = cMakeFilePath.split('/');
+    cMakeParentPath.pop();
+    cMakeParentPath = cMakeParentPath.join('/');
+
+    const args = [
+        "run", "-v", `${outputPath}:/output`, "-v", "/:/live", "--workdir", "/output", "bugra9/cpp.js",
+        "emcmake", "cmake", "/live"+cMakeParentPath, "-DCMAKE_INSTALL_PREFIX=/output", `-DBASE_DIR=/live${process.cwd()}`, '-DBRIDGE_DIR=/output',
+    ];
+    const options = { cwd: outputPath, stdio : 'pipe' };
+    execFileSync("docker", args, options);
+    return outputPath;
+}
+
+function make(outputPath) {
+    const args = [
+        "run", "-v", `${outputPath}:/output`, "-v", "/:/live", "--workdir", "/output", "bugra9/cpp.js",
+        "emmake", "make"
+    ];
+    const options = { cwd: outputPath, stdio : 'pipe' };
+    execFileSync("docker", args, options);
+    return outputPath;
+}
+
+function cc(tempPath, outputPath, flags = []) {
+    const args = [
+        "run", "-v", `${tempPath}:/tempPath`, "-v", `${outputPath}:/output`, "-v", `${__dirname}:/cli`, "-v", "/:/live", "bugra9/cpp.js",
+        "emcc", "-lembind", "-Wl,--whole-archive", '/tempPath/libcppjs.a', ...flags, "-s", "WASM=1", "-s", "MODULARIZE=1", '-o', '/output/cpp.js', '--extern-post-js', '/cli/src/extern-post.js'
+    ];
+    const options = { cwd: tempPath, stdio : 'pipe' };
+    execFileSync("docker", args, options);
+    return outputPath;
+}

package/src/extern-post.js

@@ -0,0 +1,14 @@
+export default async function then(cb) {
+    const m = {
+      locateFile(path) {
+        if(path.endsWith('.wasm')) {
+          return "cpp.wasm";
+        }
+        return path;
+      },
+      onRuntimeInitialized() {
+        cb(this);
+      }
+    };
+    Module(m);
+}

package/src/findCMakeListsFile.js

@@ -0,0 +1,17 @@
+import fs from 'fs';
+import glob from 'glob';
+import {dirname} from 'path';
+import * as url from 'node:url';
+
+export const __filename = url.fileURLToPath(import.meta.url);
+export const __dirname = dirname(dirname(__filename)+'..');
+
+export default function findCMakeListsFile() {
+    let temp = glob.sync("CMakeLists.txt", { absolute: true });
+    if (temp.length === 0) {
+        temp = glob.sync("*/CMakeLists.txt", { absolute: true, ignore: ['node_modules/*', 'dist/*', 'build/*'] });
+    }
+
+    if (temp.length > 0) return temp[0];
+    return __dirname + '/assets/CMakeLists.txt';
+}

package/src/findCMakeListsFile.spec.js

@@ -0,0 +1,34 @@
+import { assert } from 'chai';
+import fs from 'fs';
+import p from 'path';
+import * as url from 'node:url';
+import { tmpdir } from "os";
+import findCMakeListsFile from './findCMakeListsFile.js';
+
+const __filename = url.fileURLToPath(import.meta.url);
+const temp = __filename.split('/');
+temp.pop();
+temp.pop();
+const __dirname = temp.join('/');
+
+export function createTempDir(folder) {
+    let path = p.join(tmpdir(), "cppjs-app-cli-test");
+    if (folder) path = p.join(path, folder);
+
+    if (fs.existsSync(path)) fs.rmSync(path, { recursive: true, force: true });
+    fs.mkdirSync(path, { recursive: true });
+
+    return path;
+}
+
+describe('findCMakeListsFile', function () {
+    let tempdir;
+    before(async function () {
+        tempdir = createTempDir();
+    });
+
+    it('find CMakeLists.txt file', async function () {
+        const path = findCMakeListsFile(tempdir);
+        assert.equal(path, __dirname + '/assets/CMakeLists.txt');
+    });
+});

package/src/findOrCreateInterfaceFile.js

@@ -0,0 +1,33 @@
+import fs from 'fs';
+
+export default function findOrCreateInterfaceFile(filePath, outputPath) {
+    const temp = filePath.match(/^(.*)\..+?$/);
+    if (temp.length < 2) return null;
+
+    const filePathWithoutExt = temp[1];
+    const interfaceFile = filePathWithoutExt + '.i';
+
+    if (fs.existsSync(interfaceFile)) return interfaceFile;
+
+    const fileName = filePathWithoutExt.split('/').at(-1);
+    const fileNameWithExt = filePath.split('/').at(-1);
+
+    const content =
+`#ifndef _${fileName.toUpperCase()}_I
+#define _${fileName.toUpperCase()}_I
+
+%module ${fileName.toUpperCase()}
+
+%{
+#include "${fileNameWithExt}"
+%}
+
+%include "/live${filePath}"
+
+#endif
+`;
+
+    const outputFilePath = outputPath+'/'+fileName+'.i';
+    fs.writeFileSync(outputFilePath, content);
+    return outputFilePath;
+}

package/src/findOrCreateInterfaceFile.spec.js

@@ -0,0 +1,49 @@
+import { assert } from 'chai';
+import fs from 'fs';
+import p, {dirname} from 'path';
+import * as url from 'node:url';
+import { tmpdir } from "os";
+import findOrCreateInterfaceFile from './findOrCreateInterfaceFile.js';
+
+const __filename = url.fileURLToPath(import.meta.url);
+const temp = __filename.split('/');
+temp.pop();
+temp.pop();
+const __dirname = temp.join('/');
+
+export function createTempDir(folder) {
+    let path = p.join(tmpdir(), "cppjs-app-cli-test");
+    if (folder) path = p.join(path, folder);
+
+    if (fs.existsSync(path)) fs.rmSync(path, { recursive: true, force: true });
+    fs.mkdirSync(path, { recursive: true });
+
+    return path;
+}
+
+describe('findOrCreateInterfaceFile', function () {
+    let tempdir;
+    before(async function () {
+        tempdir = createTempDir();
+    });
+
+    it('find interface file', async function () {
+        const path = __dirname+'/test/data/sample.h';
+        const interfaceFile = findOrCreateInterfaceFile(path, tempdir);
+        assert.equal(interfaceFile, path.replace('.h', '.i'));
+    });
+
+    it('create interface file', async function () {
+        const path = __dirname+'/test/data/sample2.h';
+        const interfaceFile = findOrCreateInterfaceFile(path, tempdir);
+        const interfaceFileData = fs.readFileSync(interfaceFile, 'utf8');
+
+        const path2 = __dirname+'/test/data/sample2.ei';
+        const interfaceFileData2 = fs.readFileSync(path2, 'utf8');
+
+        assert.equal(
+            interfaceFileData.trim().replace(__dirname + '/test/data/', ''),
+            interfaceFileData2.trim().replace(__dirname + '/test/data/', '')
+        );
+    });
+});

package/src/index.js

@@ -0,0 +1,4 @@
+export { default as createBridge } from './createBridge.js';
+export { default as findCMakeListsFile } from './findCMakeListsFile.js';
+export { default as findOrCreateInterfaceFile } from './findOrCreateInterfaceFile.js';
+export { default as createWasm } from './createWasm.js';

package/src/pullDockerImage.js

@@ -0,0 +1,17 @@
+import { execFileSync } from 'child_process';
+
+export default function pullDockerImage() {
+    const isImageExist = execFileSync("docker", ["images", "-q", "bugra9/cpp.js"], {encoding: 'utf-8'}).trim() !== '';
+
+    if (!isImageExist) {
+        console.log('');
+        console.log('===========================================================');
+        console.log('============= Downloading the docker image... =============');
+        console.log('===========================================================');
+        console.log('');
+        execFileSync("docker", ["pull", "bugra9/cpp.js"], {stdio: 'inherit'});
+        console.log('');
+        console.log('===========================================================');
+        console.log('');
+    }
+}

package/src/utils.js

@@ -0,0 +1,56 @@
+import fs from 'fs';
+import p, {dirname} from 'path';
+import { tmpdir } from "os";
+import * as url from 'node:url';
+
+export const __filename = url.fileURLToPath(import.meta.url);
+export const __dirname = dirname(__filename);
+
+let config;
+export const mainPath = process.cwd();
+
+export function createTempDir(folder) {
+    let path = p.join(tmpdir(), "cppjs-app-cli");
+    if (folder) path = p.join(path, folder);
+
+    if (fs.existsSync(path)) fs.rmdirSync(path);
+    fs.mkdirSync(path, { recursive: true });
+
+    return path;
+}
+
+export function getFilesGivenDir(dir, options = {}) {
+    return new Promise((resolve, reject) => {
+        fs.readdir(dir, (err, files) => {
+            if (err) reject(err);
+
+            let filteredFiles = files;
+            if (options.ext && Array.isArray(options.ext) && options.ext.length > 0) {
+                const regex = new RegExp(`\.(${options.ext.join('|')})$`, 'g');
+                filteredFiles = filteredFiles.filter(file => regex.test(file));
+            }
+            if (options.filter) filteredFiles = filteredFiles.filter(options.filter);
+            resolve(filteredFiles);
+        });
+    });
+}
+
+export async function getConfig(projectPath) {
+    if (config) return config;
+    if (!projectPath) projectPath = mainPath;
+
+    config = {
+        projectPath,
+        modulesPath: projectPath,
+        modulesTempPath: createTempDir('modules'),
+        bridgesTempPath: createTempDir('bridges'),
+        output: `${projectPath}/dist`,
+    };
+
+    const configFilePath = `${projectPath}/.cppjs.config.js`;
+    if (fs.existsSync(configFilePath)) {
+        config = Object.assign({}, config, (await import(configFilePath)).default);
+    }
+
+    return config;
+}

package/test/data/sample.cpp

@@ -0,0 +1 @@
+#include "sample.h"

package/test/data/sample.h

@@ -0,0 +1,10 @@
+#ifndef _SAMPLE_H
+#define _SAMPLE_H
+
+class Sample {
+public:
+	Sample();
+	void t();
+};
+
+#endif

package/test/data/sample.i

@@ -0,0 +1,12 @@
+#ifndef _SAMPLE_I
+#define _SAMPLE_I
+
+%module Sample
+
+%{
+#include "sample.h"
+%}
+
+%include "sample.h"
+
+#endif

package/test/data/sample2.ei

@@ -0,0 +1,12 @@
+#ifndef _SAMPLE2_I
+#define _SAMPLE2_I
+
+%module SAMPLE2
+
+%{
+#include "sample2.h"
+%}
+
+%include "sample2.h"
+
+#endif

package/test/data/sample2.h

@@ -0,0 +1,10 @@
+#ifndef _SAMPLE2_H
+#define _SAMPLE2_H
+
+class Sample2 {
+public:
+	Sample2();
+	void y();
+};
+
+#endif