package js_of_ocaml

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

Install

Dune Dependency

Authors

Maintainers

Sources

js_of_ocaml-3.9.0.tbz
sha256=74d3b17b089af04cde29173c9e7a1154b9a784ba415aeef5026440aeb907cb54
sha512=affc91ed58d71e79752595345fcb2afe0d86378a73030ce64ef5624b9fef31925a2c2bb5e772fea017a508da292c351ad89b77e28361ff6f8ed345fecb78b31d

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: 15 Feb 2021

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

  1. js_of_ocaml-compiler >= "3.9.0" & < "3.10.0"
  2. uchar
  3. ppxlib >= "0.15.0"
  4. dune >= "2.5"
  5. ocaml >= "4.02.0"

Dev Dependencies

None

Used by (95)

  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.11.0"
  5. bls12-381-js
  6. bls12-381-js-gen
  7. bonsai = "v0.15.0"
  8. brr-lwd
  9. chartjs
  10. chartjs-annotation
  11. chartjs-colorschemes
  12. chartjs-datalabels
  13. chartjs-streaming
  14. cohttp-lwt-jsoo >= "2.5.0"
  15. coinst
  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. eliom = "6.3.0" | >= "6.5.0" & < "6.8.0" | >= "6.9.2" & < "6.10.1" | >= "7.0.0"
  23. eris
  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.0.0"
  38. graphv_font_js
  39. graphv_webgl_impl
  40. hardcaml = "1.2.0"
  41. hardcaml-examples >= "0.3.0"
  42. hardcaml-framework
  43. incr_dom < "v0.15.1"
  44. incr_dom_interactive < "v0.16.0"
  45. incr_dom_keyboard
  46. incr_dom_partial_render < "v0.16.0"
  47. incr_dom_sexp_form < "v0.16.0"
  48. incr_dom_widgets
  49. integers_stubs_js
  50. iocamljs-kernel = "0.4.5"
  51. irmin-indexeddb >= "2.0"
  52. joolog
  53. js_of_ocaml-lwt = "3.9.0"
  54. js_of_ocaml-ppx = "3.9.0"
  55. js_of_ocaml-ppx_deriving_json = "3.9.0"
  56. js_of_ocaml-toplevel = "3.9.0"
  57. js_of_ocaml-tyxml = "3.9.0"
  58. js_of_ocaml-webgpu
  59. js_of_ocaml-webidl
  60. json-data-encoding-browser
  61. jsonoo
  62. jsoo_broadcastchannel >= "2.0.0"
  63. jsoo_storage >= "1.0.1"
  64. kkmarkdown
  65. ldp_js
  66. leaflet
  67. learn-ocaml >= "0.12"
  68. liquidsoap-js
  69. lp-glpk-js
  70. memtrace_viewer < "v0.15.0"
  71. nanoid
  72. node_of_ocaml
  73. nuscr < "1.1.0"
  74. ocaml-gist
  75. ocp_reveal
  76. ocplib-json-typed-browser
  77. ocsigen-start >= "1.7.0" & != "2.15.1" & < "2.16.0"
  78. ocsigen-toolkit >= "2.13.0" & < "3.2.0"
  79. ojs-base >= "0.6.0"
  80. ojs_base
  81. plotly
  82. polynomial >= "0.4.0"
  83. ppx_css < "v0.16.0"
  84. ppx_jsobject_conv >= "0.6.0" & < "0.10.0"
  85. promise_jsoo
  86. rpclib-js
  87. spin >= "0.8.0"
  88. tezt >= "3.1.0"
  89. timmy-jsoo
  90. tyxml-lwd >= "0.2"
  91. vg = "0.9.4"
  92. virtual_dom < "v0.16.0"
  93. webtest-js
  94. wikitext
  95. xtmpl = "0.18.0"

Conflicts

None