package js_of_ocaml

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

Install

Dune Dependency

Authors

Maintainers

Sources

js_of_ocaml-3.10.0.tbz
sha256=7bfe95c283e30a53df9364555517aa4ea614876be566a86b33e6d0fefc4a6126
sha512=1815f0bfcea65a28082293756350a9365304584d3a19af0983e1498c6f8d7d25a751aec18560aa7b633b64b8adfb4417e9647cdf703bedcb7aaf316abf9a3243

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: 06 Sep 2021

README

Js_of_ocaml (jsoo)

Build Status"

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 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.

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 (5)

  1. uchar
  2. ppxlib >= "0.15"
  3. js_of_ocaml-compiler = version
  4. ocaml >= "4.04"
  5. 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 (89)

  1. alba >= "0.4.1"
  2. archetype >= "1.2.7"
  3. async_js >= "v0.13.0" & < "v0.16.0"
  4. binaryen >= "0.3.0" & < "0.15.0"
  5. bls12-381-js
  6. bls12-381-js-gen
  7. bonsai = "v0.15.0"
  8. brisk-reconciler
  9. brr-lwd
  10. chartjs
  11. chartjs-annotation
  12. chartjs-colorschemes
  13. chartjs-datalabels
  14. chartjs-streaming
  15. cohttp-lwt-jsoo
  16. cordova
  17. cordova-plugin-background-mode
  18. cordova-plugin-battery-status
  19. cordova-plugin-local-notifications
  20. cordova-plugin-sim-card
  21. dream >= "1.0.0~alpha5"
  22. dune = "3.17.2"
  23. eliom >= "6.9.2" & < "6.10.1" | >= "7.0.0" & < "11.1.0"
  24. ezjs_ace
  25. ezjs_blockies
  26. ezjs_cleave
  27. ezjs_d3pie
  28. ezjs_fetch < "0.2"
  29. ezjs_min < "0.2"
  30. ezjs_odometer
  31. ezjs_push < "0.2"
  32. ezjs_qrcode
  33. ezjs_recaptcha
  34. ezjs_timeline
  35. fmlib_js < "0.5.0"
  36. gen_js_api < "1.0.7"
  37. github-jsoo < "4.1.0"
  38. graphv_font_js
  39. graphv_webgl_impl
  40. incr_dom < "v0.15.1"
  41. incr_dom_interactive < "v0.16.0"
  42. incr_dom_keyboard
  43. incr_dom_partial_render < "v0.16.0"
  44. incr_dom_sexp_form < "v0.16.0"
  45. incr_dom_widgets
  46. integers_stubs_js
  47. irmin-indexeddb
  48. joolog
  49. js_of_ocaml-lwt = "3.10.0"
  50. js_of_ocaml-ppx = "3.10.0"
  51. js_of_ocaml-ppx_deriving_json = "3.10.0"
  52. js_of_ocaml-toplevel = "3.10.0"
  53. js_of_ocaml-tyxml = "3.10.0"
  54. js_of_ocaml-webgpu
  55. js_of_ocaml-webidl
  56. json-data-encoding-browser
  57. jsonoo
  58. jsoo_broadcastchannel
  59. jsoo_storage
  60. kkmarkdown
  61. ldp_js < "0.5.0"
  62. leaflet
  63. lp-glpk-js
  64. memtrace_viewer < "v0.15.0"
  65. nanoid
  66. node_of_ocaml
  67. nuscr < "1.1.0"
  68. ocp_reveal
  69. ocplib-json-typed-browser
  70. ocsigen-start != "2.15.1" & < "2.16.0" | = "7.0.0"
  71. ocsigen-toolkit >= "2.13.0" & < "3.2.0"
  72. ojs-base
  73. ojs_base < "0.8.0"
  74. plotly
  75. polynomial >= "0.4.0"
  76. ppx_css < "v0.16.0"
  77. ppx_jsobject_conv < "0.10.0"
  78. promise_jsoo
  79. re >= "1.13.2"
  80. rpclib-js
  81. spin >= "0.8.0"
  82. tezt >= "3.1.0"
  83. timmy-jsoo
  84. tyxml-lwd >= "0.2"
  85. vg < "0.9.5"
  86. virtual_dom < "v0.16.0"
  87. webtest-js
  88. wikitext
  89. xtmpl = "0.18.0"

Conflicts

None

OCaml

Innovation. Community. Security.