https://github.com/yhaiovyi/c-wasm-loader
Super change your browser with C/C++ power.
https://github.com/yhaiovyi/c-wasm-loader
c cpp wasm webpack webpack-loader webpack3
Last synced: about 1 year ago
JSON representation
Super change your browser with C/C++ power.
- Host: GitHub
- URL: https://github.com/yhaiovyi/c-wasm-loader
- Owner: yhaiovyi
- License: mit
- Created: 2018-02-25T01:55:54.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-28T04:42:24.000Z (about 8 years ago)
- Last Synced: 2025-04-14T21:13:09.358Z (about 1 year ago)
- Topics: c, cpp, wasm, webpack, webpack-loader, webpack3
- Language: JavaScript
- Homepage:
- Size: 397 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# c-wasm-loader
[![npm][npm]][npm-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![tests][tests]][tests-url]
[![builds][builds]][builds-url]
[![coverage][cover]][cover-url]
Webpack loader that allows you to import C/C++ files as WebAssembly.
This project is in very early development stage, and you're very welcome to contribute or file tickets, as well as it's not released yet, so api changes every day, publish process is not consistent, so some npm versions are broken.
Install
Install with npm:
```bash
npm install --save-dev c-wasm-loader
```
Install with yarn:
```bash
yarn add c-wasm-loader --dev
```
This package automatically installs portable emsdk, so you should have cmake only available.
Options
|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|**[`name`](#name)**|`{String\|Function}`|`[hash].[ext]`|Configure a custom filename template for your file|
|**`regExp`**|`{RegExp}`|`'undefined'`|Let you extract some parts of the file path to reuse them in the `name` property|
|**`outputPath`**|`{String\|Function}`|`'undefined'`|Configure a custom `output` path for your file|
|**`useRelativePath`**|`{Boolean}`|`false`|Should be `true` if you wish to generate a `context` relative URL for each file|
|**[`limit`](#limit)**|`{Number\|String}`|`undefined`|Byte limit to inline compiled files as Data URL|
|**`std`**|`{String}`|undefined|Choose one of ISO C++ standards (C++98 / C++03, C++11, and C++14)|
|**`includePaths`**|`{Array}`|undefined||
|**`bind`**|`{Boolean}`|`false`||
|**[`optimizationLevel`](#optimizationLevel)**|`{Number}`|`undefined`|Optimization level for emscripten compiler|
|**[`debugLevel`](#debugLevel)**|`{Number}`|`undefined`|Debug level for emscripten compiler|
### `name`
You can configure a custom filename template for your file using the query parameter `name`.
### `limit`
If the file is greater than the limit (in bytes) the [`file-loader`](https://github.com/webpack-contrib/file-loader) is used by default and all query parameters are passed to it.
The limit can be specified via loader options and defaults to no limit.
### `optimizationLevel`
Code is optimized by specifying optimization flags when running emcc. The levels include: 0 (no optimization), 1, 2, s, z, 3.
Emcc strips out most of the debug information from optimized builds by default. Optimisation levels 0 and above remove LLVM debug information, and also disable runtime ASSERTIONS checks. From optimization level -02 the code is minified by the Closure Compiler and becomes virtually unreadable.
### `debugLevel`
Can be used to preserve debug information in the compiled output. By default, this option preserves white-space, function names and variable names.
The flag can also be specified with one of five levels: 0, 1, 2, 3, 4. Each level builds on the last to provide progressively more debug information in the compiled output.
If set to 4 provides the most debug information — it generates source maps that allow you to view and debug the C/C++ source code in your browser’s debugger on Firefox, Chrome or Safari!
Usage
**hello.c**
```c
#include
extern "C" {
int main(int argc, char ** argv) {
printf("Hello\n");
}
int EMSCRIPTEN_KEEPALIVE world() {
printf("World\n");
}
}
```
**hello.js**
```js
import hello from './hello.c';
hello().then((module) => {
module._world();
});
```
**webpack.config.js**
```js
module.exports = {
externals: {
fs: true
},
module: {
rules: [
{
test: /\.(c|cpp)$/,
use: {
loader: 'c-wasm-loader',
options: {
outputPath: 'wasm',
name: '[name]-[hash].[ext]'
}
}
}
]
}
}
```
[npm]: https://img.shields.io/npm/v/c-wasm-loader.svg
[npm-url]: https://www.npmjs.com/package/c-wasm-loader
[node]: https://img.shields.io/node/v/c-wasm-loader.svg
[node-url]: https://nodejs.org
[deps]: https://img.shields.io/david/yhaiovyi/c-wasm-loader.svg
[deps-url]: https://david-dm.org/yhaiovyi/c-wasm-loader
[tests]: https://img.shields.io/travis/yhaiovyi/c-wasm-loader/master.svg
[tests-url]: https://travis-ci.org/yhaiovyi/c-wasm-loader
[builds-url]: https://ci.appveyor.com/project/sokra/webpack/yhaiovyi/c-wasm-loader
[builds]: https://ci.appveyor.com/api/projects/status/github/yhaiovyi/c-wasm-loader?svg=true
[cover]: https://coveralls.io/repos/github/yhaiovyi/c-wasm-loader/badge.svg?branch=master
[cover-url]: https://coveralls.io/github/yhaiovyi/c-wasm-loader?branch=master
