package binaryen
Install
Dune Dependency
Authors
Maintainers
Sources
md5=ec73e0a05ec01966380e6333fe49363a
sha512=8ab2f8c46c0532dddd4b695f22f48ab540a0e668bc893e7769f2725ed060a675d6d2f17f959994cda899c5d9b7a9a3c3653563f69f2214708db6480ae817a00e
Description
Published: 03 Apr 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
You'll need Node.js and esy
to build this project.
dune
will take care of 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 (6)
-
js_of_ocaml-compiler
>= "3.6.0"
-
js_of_ocaml-ppx
>= "3.6.0"
-
js_of_ocaml
>= "3.6.0"
-
dune-configurator
>= "2.7.1"
-
dune
>= "2.7.1"
-
ocaml
>= "4.09"
Dev Dependencies
None
Used by
None
Conflicts
None