package binaryen
Install
Dune Dependency
Authors
Maintainers
Sources
md5=2b98cd022c3b7b105cdacc68f17ec739
sha512=304c139b088c504c33ea43671076d4d01403da5ebf01464ec53f279e084b9338af8b85755f308fd7e579294713a41d5754fe35f28a8b8c419ecd524390a34630
Description
Published: 25 Jan 2021
README
Binaryen.ml
OCaml bindings for Binaryen.
Binaryen is a compiler and toolchain infrastructure for WebAssembly. It makes compilation to WebAssembly pretty darn easy.
Here's Binaryen's hello world test in OCaml form:
open Binaryen
let wasm_mod = Module.create ()
(* Create function type for i32 (i32, i32) *)
let params = Type.create [| Type.int32; Type.int32 |]
let results = Type.int32
(* Get arguments 0 and 1, add them *)
let x = Expression.local_get wasm_mod 0 Type.int32
let y = Expression.local_get wasm_mod 1 Type.int32
let add = Expression.binary wasm_mod Op.add_int32 x y
(* Create the add function *)
(* Note: no additional local variables *)
let adder = Function.add_function wasm_mod "adder" params results [||] add
let _ = Module.print wasm_mod
let _ = Module.dispose wasm_mod
Feature Parity
This project aims to provide full feature parity with the Binaryen C API. It's fairly complete, but a few things still need bindings:
SIMD instructions
Events
Atomics
Query operations on expressions
Query operations on functions
None of these are particularly challenging to create bindings for—they just haven't been written yet. If you need anything that's missing, feel free to open a PR.
Static Linking
If you are planning to create portable binaries for Windows, it will try to find Cygwin/MinGW locations in your PATH
. To avoid this, you probably want to add this to your (executable)
stanzas:
(executable
(name example)
(public_name example)
(package example)
+ (flags (:standard -ccopt -- -ccopt -static))
(modules example)
(libraries binaryen))
These flags might not work on other operating systems (like MacOS), so you'll probably need to use dune-configurator
to vary the flags per platform.
Contributing
After cloning the repository, be sure to initialize the Binaryen submodule:
git submodule update --init
You'll need Node.js and esy
to build this project, as well as cmake
to build Binaryen.
dune
will take care of building Binaryen and compiling the C stubs, so to build the project you'll only need to run:
esy
This will take a while. Once it's done, you can run the tests:
esy test
Dependencies (5)
-
js_of_ocaml-compiler
>= "3.6.0"
-
js_of_ocaml-ppx
>= "3.6.0"
-
js_of_ocaml
>= "3.6.0"
-
dune
>= "2.7.1"
-
ocaml
>= "4.09"
Dev Dependencies
None
Used by
None
Conflicts
None