package js_of_ocaml

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

Install

Dune Dependency

Authors

Maintainers

Sources

js_of_ocaml-3.7.1.tbz
sha256=36dba988e0ac14e54624da6f36337ad63a8d1f2b5195e7576d5e74a737ac1a44
sha512=88c01d33c8877ec9488ab8a73e84647a599120c11aa20b2ee06c02ecdf4bbbd6885e17bbf211e63299c5af244f3379f10787deb151930bfd8cb0d97fe8230156

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: 30 Sep 2020

README

README.md

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

  1. js_of_ocaml-compiler = version
  2. uchar
  3. ppx_tools_versioned >= "5.2.3"
  4. ocaml-migrate-parsetree >= "1.4" & < "2.0.0"
  5. dune >= "2.5"
  6. ocaml >= "4.02.0"

Dev Dependencies

None

Used by (85)

  1. alba >= "0.4.1"
  2. async_js >= "v0.13.0" & < "v0.15.0"
  3. binaryen >= "0.3.0" & < "0.11.0"
  4. bls12-381-js
  5. bls12-381-js-gen
  6. brr-lwd
  7. chartjs
  8. chartjs-annotation
  9. chartjs-colorschemes
  10. chartjs-datalabels
  11. chartjs-streaming
  12. cohttp-lwt-jsoo >= "2.5.0"
  13. coinst
  14. cordova
  15. cordova-plugin-background-mode
  16. cordova-plugin-battery-status
  17. cordova-plugin-local-notifications
  18. cordova-plugin-sim-card
  19. dream >= "1.0.0~alpha5"
  20. eliom = "6.3.0" | >= "6.5.0" & < "6.8.0" | >= "6.9.2"
  21. eris
  22. ezjs_ace
  23. ezjs_blockies
  24. ezjs_cleave
  25. ezjs_d3pie
  26. ezjs_fetch < "0.2"
  27. ezjs_min < "0.2"
  28. ezjs_odometer
  29. ezjs_push < "0.2"
  30. ezjs_qrcode
  31. ezjs_recaptcha
  32. ezjs_timeline
  33. gen_js_api < "1.0.7"
  34. github-jsoo < "4.0.0"
  35. hardcaml = "1.2.0"
  36. hardcaml-examples >= "0.3.0"
  37. hardcaml-framework
  38. incr_dom < "v0.15.0"
  39. incr_dom_interactive < "v0.15.0"
  40. incr_dom_keyboard
  41. incr_dom_partial_render < "v0.15.0"
  42. incr_dom_sexp_form < "v0.15.0"
  43. incr_dom_widgets
  44. integers_stubs_js
  45. iocamljs-kernel = "0.4.5"
  46. irmin-indexeddb >= "2.0"
  47. joolog
  48. js_of_ocaml-lwt = "3.7.1"
  49. js_of_ocaml-ppx = "3.7.1"
  50. js_of_ocaml-ppx_deriving_json = "3.7.1"
  51. js_of_ocaml-toplevel = "3.7.1"
  52. js_of_ocaml-tyxml = "3.7.1"
  53. js_of_ocaml-webgpu
  54. js_of_ocaml-webidl
  55. json-data-encoding-browser
  56. jsonoo
  57. jsoo_broadcastchannel >= "2.0.0"
  58. jsoo_storage >= "1.0.1"
  59. kkmarkdown
  60. leaflet
  61. learn-ocaml >= "0.12"
  62. liquidsoap-js
  63. lp-glpk-js
  64. memtrace_viewer < "v0.15.0"
  65. nanoid
  66. node_of_ocaml
  67. nuscr < "1.1.0"
  68. ocaml-gist
  69. ocp_reveal
  70. ocplib-json-typed-browser
  71. ocsigen-start >= "1.7.0" & != "2.15.1" & < "2.16.0"
  72. ocsigen-toolkit >= "2.13.0" & < "3.2.0"
  73. plotly
  74. polynomial >= "0.4.0"
  75. ppx_jsobject_conv >= "0.6.0" & < "0.9.0"
  76. promise_jsoo
  77. rpclib-js
  78. spin >= "0.8.0"
  79. tezt >= "3.1.0"
  80. timmy-jsoo
  81. tyxml-lwd
  82. vg = "0.9.4"
  83. virtual_dom < "v0.15.0"
  84. webtest-js
  85. wikitext

Conflicts

None