package js_of_ocaml-ppx

Build not checked
  1. Overview
  2. Docs
Compiler from OCaml bytecode to Javascript

Install

dune-project
 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

Added to opam-repository:

README

Build Status

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

  1. js_of_ocaml = version
  2. ppxlib >= "0.15.0" & < "0.36.0"
  3. dune >= "2.5"
  4. ocaml >= "4.02.0"

Dev Dependencies

None

Optional Dependencies

None

Used by (79)

  1. alba >= "0.4.1"
  2. archetype >= "1.2.7"
  3. async_js < "v0.16.0"
  4. atable
  5. binaryen >= "0.3.0" & < "0.11.0"
  6. bls12-381-js
  7. bls12-381-js-gen
  8. bonsai = "v0.15.0"
  9. brisk-reconciler
  10. catala >= "0.3.0" & < "0.7.0"
  11. chartjs
  12. chartjs-annotation
  13. chartjs-colorschemes
  14. chartjs-datalabels
  15. chartjs-streaming
  16. cohttp-lwt-jsoo
  17. cosmetyc_js
  18. dream >= "1.0.0~alpha5"
  19. eliom >= "7.0.0" & < "11.1.0"
  20. ezjs_ace
  21. ezjs_blockies
  22. ezjs_cleave
  23. ezjs_cytoscape
  24. ezjs_d3pie
  25. ezjs_fetch < "0.2"
  26. ezjs_jquery
  27. ezjs_min < "0.3.0"
  28. ezjs_odometer
  29. ezjs_push < "0.2"
  30. ezjs_qrcode
  31. ezjs_recaptcha
  32. ezjs_timeline
  33. fmlib_js < "0.5.0"
  34. graphql_jsoo_client
  35. graphv_font_js
  36. graphv_webgl_impl
  37. incr_dom < "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. irmin-indexeddb
  44. js_of_ocaml-lwt = "3.9.0"
  45. js_of_ocaml-toplevel = "3.9.0"
  46. js_of_ocaml-tyxml = "3.9.0"
  47. js_of_ocaml-webgpu
  48. js_of_ocaml-webidl
  49. jsonoo < "0.3.0"
  50. jsoo-react
  51. jsoo_broadcastchannel
  52. jsoo_storage
  53. kkmarkdown
  54. ldp_js < "0.5.0"
  55. leaflet < "0.2"
  56. learn-ocaml
  57. liquidsoap-js
  58. lp-glpk-js
  59. memtrace_viewer
  60. monaco_jsoo
  61. ocp_reveal
  62. ojs_base < "0.8.0"
  63. pgn_to_tex >= "0.1.0"
  64. plotly
  65. polynomial >= "0.4.0"
  66. ppx_css < "v0.16.0"
  67. promise_jsoo < "0.4.2"
  68. quickterface
  69. regl
  70. rpclib-js
  71. spin >= "0.8.0"
  72. timedesc-tzlocal-js
  73. timmy-jsoo
  74. tyxml-lwd >= "0.2"
  75. vg < "0.9.5"
  76. virtual_dom < "v0.16.0"
  77. vue-jsoo < "0.3"
  78. webtest-js
  79. xtmpl = "0.18.0"

Conflicts

None

Build status

Results of building js_of_ocaml-ppx with each compiler on check.ci.ocaml.org, run of against opam-repository 8d8d144. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

This version is not in the latest run; the versions below are.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
6.5.0 n/a good good good good
6.0.1 good n/a good n/a n/a
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure