package js_of_ocaml

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

Install 

dune-project
 Dependency

ocsigen.org Readme Changelog Edit opam file Versions (30)

Authors

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

Maintainers

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

Sources

js_of_ocaml-4.0.0.tbz
sha256=df02f819e5b2f48234af2b3e3e7c9781afa8212f8bece7ebcfbd8358b394495e
sha512=92e822849c8be14ce0428f7f4be3991449f76e65d408073a5b8b9674ba2d099439027aa11618b603c7ee31a179cf6976d54a929917a69b269425f0367926c200

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

Added to opam-repository:

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.

Js_of_ocaml is composed of multiple packages:

  • js_of_ocaml-compiler, the compiler.
  • js_of_ocaml-ppx, a ppx syntax extension.
  • js_of_ocaml, the base library.
  • js_of_ocaml-ppx_deriving_json
  • js_of_ocaml-lwt, lwt support.
  • js_of_ocaml-tyxml, tyxml support.
  • js_of_ocaml-toplevel, lib and tools to build an ocaml toplevel to javascript.

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

Dependencies (5)

  1. uchar
  2. ppxlib >= "0.15"
  3. js_of_ocaml-compiler = version
  4. ocaml >= "4.04"
  5. dune >= "2.9"

Dev Dependencies (4)

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

Used by (97)

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

Conflicts

None