package js_of_ocaml-ppx

  1. Overview
  2. Docs
Compiler from OCaml bytecode to JavaScript

Install

Dune Dependency

ocsigen.github.io Readme Changelog GPL-2.0-or-later AND LGPL-2.1-or-later WITH OCaml-LGPL-linking-exception License Edit opam file Versions (32)

Authors

  1. O
    Ocsigen team <dev@ocsigen.org>

Maintainers

  1. O
    Ocsigen team <dev@ocsigen.org>

Sources

js_of_ocaml-3.11.0.tbz
sha256=158dafe7271ac79157981d1c3f5f177ec78a0099c38f861ae14e7ac06bd29c3a
sha512=d83f0988aa1089fa01a0a693d7e6a832018c5a8ce707f44685809769377ef7ef59ce48229b1612966bd9166b610d66ddff8f2606f6c3f09c49f601b74842fde1

Description

Js_of_ocaml is a compiler from OCaml bytecode to JavaScript. It makes it possible to run pure OCaml programs in JavaScript environment like browsers and Node.js

Published: 07 Oct 2021

README

Js_of_ocaml (jsoo)

Js_of_ocaml is a compiler from OCaml bytecode to JavaScript. It makes it possible to run pure OCaml programs in JavaScript environment like browsers and Node.js.

  • It is easy to install and use as it works with an existing installation of OCaml, with no need to recompile any library.

  • It comes with bindings for a large part of the browser APIs.

  • According to our benchmarks, the generated programs runs typically faster than with the OCaml bytecode interpreter.

  • We believe this compiler will prove much easier to maintain than a retargeted OCaml compiler, as the bytecode provides a very stable API.

Requirements

See opam file for version constraints.

optional

Toplevel requirements

  • tyxml, reactiveData

  • ocp-indent: needed to support indentation in the toplevel

  • higlo: needed to support Syntax highlighting in the toplevel

  • cohttp: needed to build the toplevel webserver

Installation

Opam

opam install js_of_ocaml js_of_ocaml-compiler js_of_ocaml-ppx

Usage

Your program must first be compiled using the OCaml bytecode compiler ocamlc. JavaScript bindings are provided by the js_of_ocaml package. The syntax extension is provided by js_of_ocaml.syntax package.

ocamlfind ocamlc -package js_of_ocaml -package js_of_ocaml-ppx -linkpkg -o cubes.byte cubes.ml

Then, run the js_of_ocaml compiler to produce JavaScript code:

js_of_ocaml cubes.byte

Features

Most of the OCaml standard library is supported. However,

  • Weak semantic cannot be implemented using JavaScript. A dummy implementation is provided.

  • Most of the Sys module is not supported.

Extra libraries distributed with OCaml (such as Thread) are not supported in general. However,

  • Bigarray: bigarrays are supported using Typed Arrays

  • Num: supported

  • Str: supported

  • Graphics: partially supported using canvas (see js_of_ocaml-lwt.graphics)

  • Unix: time related functions are supported

Tail call is not optimized in general. However, mutually recursive functions are optimized:

  • self recursive functions (when the tail calls are the function itself) are compiled using a loop.

  • trampolines are used otherwise. More about tail call optimization.

Data representation

Data representation differs from the usual one. Most notably, integers are 32 bits (rather than 31 bits or 63 bits), which is their natural size in JavaScript, and floats are not boxed. As a consequence, marshalling, polymorphic comparison, and hashing functions can yield results different from usual:

  • marshalling of floats is not supported (unmarshalling works);

  • the polymorphic hash function will not give the same results on datastructures containing floats;

  • these functions may be more prone to stack overflow.

Ocaml javascript
int number (32bit int)
int32 number (32bit int)
nativeint number (32bit int)
int64 Object (MlInt64)
float number
string string or object (MlBytes)
bytes object (MlBytes)
"immediate" (e.g. true, false, None, ()) number (32bit int)
"block" array with tag as first element (e.g. C(1,2) => [tag,1,2])
array block with tag 0 (e.g. [\|1;2\|] => [0,1,2])
tuple block with tag 0 (e.g. (1,2) => [0,1,2])
record block (e.g. {x=1;y=2} => [0,1,2])
contructor with arguments block (e.g. C (1, 2) => [tag,1,2])
module block
exception and extensible variant block or immediate
function function

Toplevel

Contents of the distribution

Filename Description
LICENSE license and copyright notice
README this file
compiler/ compiler
examples/ small examples
lib/ library for interfacing with JavaScript APIs
ppx/ ppx syntax extensions
runtime/ runtime system
toplevel/ web-based OCaml toplevel
ocamlbuild/ ocamlbuild plugin for js_of_ocaml

Dependencies (4)

  1. ppxlib >= "0.15.0"
  2. js_of_ocaml = version
  3. ocaml >= "4.04"
  4. dune >= "2.8"

Dev Dependencies (4)

  1. odoc with-doc
  2. re >= "1.9.0" & with-test
  3. ppx_expect with-test
  4. num with-test

Used by (82)

  1. alba >= "0.4.1"
  2. archetype >= "1.2.7"
  3. async_js >= "v0.10.0" & < "v0.16.0"
  4. atable
  5. binaryen >= "0.3.0" & < "0.15.0"
  6. bls12-381-js
  7. bls12-381-js-gen
  8. bonsai = "v0.15.0"
  9. catala >= "0.3.0" & < "0.7.0"
  10. chartjs
  11. chartjs-annotation
  12. chartjs-colorschemes
  13. chartjs-datalabels
  14. chartjs-streaming
  15. cohttp-lwt-jsoo = "1.2.0" | >= "2.5.0"
  16. d3 >= "0.3.0"
  17. dream >= "1.0.0~alpha5"
  18. eliom >= "6.3.0" & < "6.8.0" | >= "6.9.2" & < "6.10.1" | >= "7.0.0" & < "11.1.0"
  19. ezjs_ace
  20. ezjs_blockies
  21. ezjs_cleave
  22. ezjs_cytoscape
  23. ezjs_d3pie
  24. ezjs_fetch < "0.2"
  25. ezjs_jquery
  26. ezjs_min < "0.3.0"
  27. ezjs_odometer
  28. ezjs_push < "0.2"
  29. ezjs_qrcode
  30. ezjs_recaptcha
  31. ezjs_timeline
  32. fmlib_js < "0.5.0"
  33. github-jsoo < "3.0.1"
  34. graphql_jsoo_client
  35. graphv_font_js
  36. graphv_webgl_impl
  37. incr_dom >= "v0.10.0" & < "v0.15.1"
  38. incr_dom_interactive < "v0.16.0"
  39. incr_dom_keyboard
  40. incr_dom_partial_render < "v0.16.0"
  41. incr_dom_sexp_form < "v0.16.0"
  42. incr_dom_widgets
  43. incr_select >= "v0.10.0" & < "v0.12.0"
  44. irmin-indexeddb >= "2.0"
  45. js_of_ocaml-lwt = "3.11.0"
  46. js_of_ocaml-toplevel = "3.11.0"
  47. js_of_ocaml-tyxml = "3.11.0"
  48. js_of_ocaml-webgpu
  49. js_of_ocaml-webidl
  50. jsonoo < "0.3.0"
  51. jsoo-react
  52. jsoo_broadcastchannel >= "2.0.0"
  53. jsoo_storage >= "1.0.1"
  54. kkmarkdown
  55. ldp_js
  56. leaflet
  57. learn-ocaml >= "0.12"
  58. liquidsoap-js
  59. lp-glpk-js
  60. memtrace_viewer
  61. monaco_jsoo
  62. nuscr < "1.1.0"
  63. ocp_reveal
  64. ojs_base
  65. opam2web >= "2.0"
  66. plotly
  67. polynomial >= "0.4.0"
  68. ppx_css < "v0.16.0"
  69. promise_jsoo < "0.4.2"
  70. rpclib-js
  71. scaml >= "1.5.0"
  72. spin >= "0.8.0"
  73. timedesc-tzlocal-js
  74. timmy-jsoo
  75. tyxml-lwd >= "0.2"
  76. vg >= "0.9.0" & < "0.9.5"
  77. virtual_dom >= "v0.10.0" & < "v0.16.0"
  78. vue-jsoo < "0.3"
  79. webtest-js
  80. xmldiff_js
  81. xtmpl >= "0.17.0" & < "0.19.0"
  82. xtmpl_js

Conflicts

None

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct