Initial commit

.

.

.

.

.

.

.

.

.

.

Author: bugra9

.editorconfig

@@ -0,0 +1,14 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+max_line_length = 150
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,39 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+dist
+tmp
+/out-tsc
+
+# dependencies
+node_modules
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db

.prettierignore

@@ -0,0 +1,4 @@
+# Add files here to ignore them from prettier formatting
+
+/dist
+/coverage

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

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.

README.md

@@ -0,0 +1,49 @@
+# cpp.js
+
+cpp.js is a framework for building tiny, blazingly fast binaries for all major desktop, mobile and web platforms. Developers can integrate any front-end framework that compiles to HTML, JS and CSS for building their user interface. The backend of the application is a cpp-sourced binary with an API that the front-end can interact with.
+
+## Guide
+### Installation
+- Install and start docker. Add user to docker group.
+- Install plugin according to the builder used. (rollup-plugin-cppjs, vite-plugin-cppjs)
+- Add plugin to builder config. (e.g: vite.config.js)
+
+### Basic Usage
+- Create native folder in the project root.
+- Create .h and .cpp files as you like.
+- If you want to use a library, just install it. (e.g: yarn add cppjs-lib-sample-web)
+
+Check out the [Sample app](https://github.com/bugra9/cpp.js/tree/main/packages/cppjs-sample-vite-vue).
+
+## TODO
+
+### Urgent
+- [x] Implement swig-emscripten integration
+- [x] Add overloading support using parameter types for embind
+- [x] Crete and upload docker image
+- [x] Implement swig interface generator
+- [x] Implement cpp-js bridge file generator
+- [x] Implement wasm generator
+- [x] Create rollup plugin
+- [x] Create vite plugin for development
+- [ ] Create webpack plugin
+- [ ] Create turbopack plugin
+- [x] Create vite + vue example
+- [ ] Create vite + react example
+- [ ] Create webpack + react example
+- [ ] Handle other cpp formats (h, hpp, hh, c, cpp, cc, cxx)
+- [ ] Use user defined interface file if available.
+- [x] Use user defined CMakeLists.txt if available.
+- [ ] Implement Hot Module Replacement (HMR) for the Vite plugin.
+
+### Important
+- [ ] Implement swig-jsi integration
+- [ ] Implement cpp-jsi bridge file generator
+- [ ] Implement React Native integration
+- [ ] Implement cpp-node bridge file generator
+- [ ] Implement Electron integration
+- [ ] Create documentation
+
+### Libs
+- [ ] Create CartoMobileSDK cppjs web library
+- [ ] Create gdal3.js cppjs web library

package.json

@@ -0,0 +1,6 @@
+{
+    "devDependencies": {
+        "cpp.js": "workspace:^",
+        "prettier": "^2.6.2"
+    }
+}

packages/cppjs-app-cli/.mocharc.yaml

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

packages/cppjs-app-cli/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")

packages/cppjs-app-cli/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "cpp.js",
+    "version": "0.1.0",
+    "license": "MIT",
+    "type": "module",
+    "scripts": {
+        "test": "mocha"
+    },
+    "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": "workspace:^"
+    }
+}

packages/cppjs-app-cli/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);
+}

packages/cppjs-app-cli/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`;
+}

packages/cppjs-app-cli/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);
+    });
+});

packages/cppjs-app-cli/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;
+}

packages/cppjs-app-cli/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);
+}

packages/cppjs-app-cli/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';
+}