Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/epatrizio/miniml2wasm
MiniML to WebAssembly compiler
https://github.com/epatrizio/miniml2wasm
compiler ocaml-library wasm webassembly
Last synced: about 2 months ago
JSON representation
MiniML to WebAssembly compiler
- Host: GitHub
- URL: https://github.com/epatrizio/miniml2wasm
- Owner: epatrizio
- License: unlicense
- Created: 2024-08-30T13:08:18.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T17:41:50.000Z (3 months ago)
- Last Synced: 2024-10-25T18:17:22.065Z (3 months ago)
- Topics: compiler, ocaml-library, wasm, webassembly
- Language: OCaml
- Homepage:
- Size: 116 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# miniml2wasm - MiniML to WebAssembly compiler written in OCaml
This project is a compiler of a `miniml` language to [WebAssembly](https://webassembly.org) (in bytecode format)
written in [OCaml](https://ocaml.org) with the [Dune](https://dune.build) build system.
- Build standard command: `dune build @all`
- Execute [Cram test](https://dune.readthedocs.io/en/stable/tests.html): `dune test` or `dune runtest`
- Run: `dune exec miniml2wasm -- file_name.mml`
- Run in debug mode: `dune exec miniml2wasm -- file_name.mml --debug`
Debug mode displays the `miniml` input file twice in the console:
original version - after scope analysis version (variables renamed with a unique name).
```ml
(* type is optional, it can be inferred *)
let x = 40; (* global scope *)
let y : i32 = 2 in (* local scope *)
(x + y)
```
```sh
$ dune exec -- miniml2wasm --help
usage: dune exec miniml2wasm -- file_name.ml [options]
--debug Debug mode
-help Display this list of options
--help Display this list of options
```
## Non-formal language specification elements
My `miniml` is a small fragment of a ML-language whose syntax is very similar to OCaml.
Typing is static, strong, inferred.
A `miniml` program is a sequence of expressions (a block).
An expression produces a typed value.
A block is also an expression (only the last expression of the sequence may not be of type `unit`)
A statement should be seen as an expression of type unit.
Summary of supported language features:
- Value types: unit, bool, i32, reference of type, array of type (fixed size)
- Expressions: Constants, unary and binary operations, blocks, if condition, let binding local and global, array
- Statements: assignements, while loop, array_size and print primitives
Compilation steps:
```shell-session
$ dune exec miniml2wasm -- fact.mml
parsing ...
scope analysing ...
typechecking ...
compiling ...
compilation target file _wasm/fact.wasm: done!
```
See [test suite files](https://github.com/epatrizio/miniml2wasm/tree/main/test/) for examples of all language elements.
## WebAssembly tools
To program and test, I use the following tools:
- [Reference interpreter](https://github.com/WebAssembly/spec/tree/main/interpreter) to convert text<>binary format
- [Owi](https://github.com/OCamlPro/owi) to interpret with a stack trace display
Here is the command sequence used for testing:
```shell-session
$ dune exec miniml2wasm -- test/42.mml
$ wasm -d _wasm/42.wasm -o _wasm/42.wat
$ owi _wasm/42.wat --debug
```
Here are some more classic tools:
- [WABT: The WebAssembly Binary Toolkit](https://github.com/WebAssembly/wabt)
- [Binaryen](https://github.com/WebAssembly/binaryen): optimizations and other stuffs
## Why ?
It’s always difficult to write a compiler! More difficult than writing an [interpreter](https://github.com/epatrizio/ola/).
This project allows me to experiment and gives me a better understanding of ML-languages
and the [Wasm bytecode](https://webassembly.github.io/spec/core/binary/index.html).
## Current status
This is the very beginning of the project. Its status is experimental.\
However, It's already possible to do some fun stuff, and when functions will be supported (next step),
this `miniml` language fragment will start to look interesting.
- See [./examples](https://github.com/epatrizio/miniml2wasm/tree/main/examples)
- See [./test/compiler](https://github.com/epatrizio/miniml2wasm/tree/main/test/compiler)
## Contribute
*More fun in a group than alone!*
Feel free: Contact me, suggest issues and pull requests.