fuath / jscoq Goto Github PK

jsCoq is an Online Integrated Development Environment for the Coq proof assistant and runs in your browser! We aim to enable new UI/interaction possibilities and to improve the accessibility of the Coq platform itself. Current stable version is jsCoq 0.8b supporting Coq 8.8, try it:

https://x80.org/rhino-coq/

JsCoq is written in ES2015, thus any standard-compliant browser should work. Chrome (>= 48) and Firefox (>= 45) are reported to work OK, jsCoq also runs in my 5-year old Galaxy Nexus. Browser performance is greatly variable these days, see the Browser Optimization section if you have browser problems.

Coq is compiled to javascript using the js_of_ocaml compiler. No servers or external programs are needed. We want to strongly thank the js_of_ocaml developers. Without their great and quick support jsCoq wouldn't have been possible.

Note: By default, the Coq standard libraries are qualified in jsCoq, thus you need to prefix your imports:

Require Import Lists.
(* should become *)
From Coq Require Import Lists.

You should be able to tweak this behavior using an option, however, due to the large number of packages bundled we recommend you write qualified Coq imports.

Browser performance is very variable these days, it is the case that some jsCoq workloads work better in Firefox and some others work better in Chrome. Browser performance seems to get better at every iteration so we are hopeful about the future.

Are you getting a StackOverflow exception? We recommend using the --js-flags="--harmony-tailcalls" command line flag in Google Chrome; this setup greatly alleviates the problem. Firefox may work better in this regard. Fiferox also seems to do better when loading a lot of libraries is involved.

Older Google Chrome versions that don't use the Ignition engine usually require the chrome://flags/#enable-javascript-harmony flag enabled for heavy workloads.

Warning for Chrome users: be aware of privacy/DRM issues in Chrome bug page. We recommend Chrome just for jsCoq, not for other uses.

Development for jsCoq 0.9 takes place in the js-worker branch. This branch provides significant advantages due to Coq being ran in a Worker thread. While the branch is not yet ready for general use, it is the mandatory for developers. A preview build of jsCoq 0.9 is usually available at:

https://x80.org/rhino-coq/v8.8-js-worker/

Be warned that the version uploaded to the link is quite unstable. Big structural changes are happening in 0.9, please stop by gitter or by the mailing list if you would to contribute. See below for build instructions.

jsCoq is easy to develop using the Chrome developer tools; the jsCoq object has a debug flag, and it is possible to compile Coq with debug information by setting the makefile variable JSCOQ_DEBUG=yes.

Previous Coq versions can be accessed at:

• https://x80.org/rhino-coq/v8.5/
• https://x80.org/rhino-coq/v8.6/
• https://x80.org/rhino-coq/v8.7/
• https://x80.org/rhino-coq/v8.8/

In the future, we may provide builds corresponding to particular git hashes. See below for more jsCoq versions, including one adapted to HoTT.

A paper describing the ideas behind jsCoq 0.9 has been published in the proceeding of the UITP 2016 workshop. The paper is available from the open access EPTCS proceedings. The recommended citation is:

@Inproceedings{gallego:uitp2016,
  author    = {Gallego Arias, Emilio Jes\'us and Pin, Beno\^it and Jouvelot, Pierre},
  year      = {2017},
  title     = {{jsCoq}: Towards Hybrid Theorem Proving Interfaces},
  editor    = {Autexier, Serge and Quaresma, Pedro},
  booktitle = {{\rmfamily Proceedings of the 12th Workshop on}
               User Interfaces for Theorem Provers,
               {\rmfamily Coimbra, Portugal, 2nd July 2016}},
  series    = {Electronic Proceedings in Theoretical Computer Science},
  volume    = {239},
  publisher = {Open Publishing Association},
  pages     = {15-27},
  doi       = {10.4204/EPTCS.239.2},
  issn      = {2075-2180}
}

Some further ideas behind jsCoq are also discussed in SerAPI: Machine-Friendly, Data-Centric Serialization for COQ. Technical Report

A small pastebin-like server based on haste is available at https://x80.org/collacoq

Note that this is totally experimental, and data loss is guaranteed.

See also the branch at https://github.com/ejgallego/haste-server/tree/collacoq

Help with Collacoq is very welcome!

• Clearing the browser cache usually solves lots of issues.
• Consider using --js-flags="--stack-size=65536" in Chrome if you get StackOverflows.
• Use the --js-flags="--harmony-tailcalls" command line flag.
• Enable the chrome://flags/#enable-javascript-harmony flag if you get StackOverflows.

JsCoq provides a coqManager javascript object for embedding Coq in your particular application, blog, or webpage. The basic pattern to add jsCoq to webpage with Coq code is:

  <script src="$path/js/jscoq-loader.js" type="text/javascript"></script>
  <script type="text/javascript">
    loadJsCoq($path).then( () => new CoqManager ($list_of_ids, [$options]) );
  </script>

where $path is the path the jsCoq distribution, $list_of_ids is the list of textareas that will form the Coq document. See below for available $options.

The jsCoq (landing webpage)[newide.html] is a good actually running example.

JsCoq accepts the following options as an optional second parameter to the constructor:

• base_path: Path where jsCoq is installed.
• wrapper_id: id of the div where to attach the panel.
• all_pkgs, init_pkgs: List of Coq's packages to show/preload.
• prelude: bool: Whether to load Coq's prelude or not.

jsCoq supports the HoTT library which requires a special build of Coq, an online version is at: https://x80.org/rhino-hott/

The main page includes a proof of the infinitude of primes by G. Gonthier. We provide some more examples as a showcase of the tool:

• dft.v: https://x80.org/rhino-coq/v8.6/examples/dft.html

  A small development of the theory of the Fourier Transform following Julius Orion Smith III's "The Mathematics of the Discrete Fourier Transform"

• The IRIS program logic, by Robbert Krebbers et al.

  https://x80.org/rhino-coq/v8.7/examples/iris.html

• Mtac: The Mtac tutorial by Beta Zilliani:

  https://x80.org/rhino-coq/v8.5/examples/mtac_tutorial.html

• Stlc: The "Simply Typed Lambda Calculus" chapter from Software Foundations by Benjamin Pierce et al:

  https://x80.org/rhino-coq/v8.6/examples/Stlc.html

• StackMachine: The First chapter of the book "Certified Programming with Dependent Types" by Adam Chlipala:

  https://x80.org/rhino-coq/examples/Cpdt.StackMachine.html

• MirrorCore:

  • A simple demo: https://x80.org/rhino-coq/v8.5/examples/mirrorcore.html
  • A demo of developing a cancellation algorithm for commutative monoids: https://x80.org/rhino-coq/v8.5/examples/mirror-core-rtac-demo.html

A coqdoc replacement that is better suited to produce jsCoq output while (mostly) remaining compatible is being developed at https://github.com/ejgallego/udoc

It works kind of OK for converting coqdoc files, but it produces some artifacts and omits some declarations.

There also is a superseded experimental version of coqdoc outputting jsCoq at https://github.com/ejgallego/coq/tree/coqdoc

Just build coqdoc normally and use the option --backend=jscoq.

You can subscribe to the jsCoq mailing list at:

https://x80.org/cgi-bin/mailman/listinfo/jscoq

The list archives should be also available through Gmane at group:

gmane.science.mathematics.logic.coq.jscoq

you can post to the list using nntp.

This is certainly an alpha-status project, but any contribution or comment is really welcome! Please submit your pull request for review to the mailing list using git request-pull. You can also submit a github PR, but it is not guaranteed that we'll look into it.

Feel free to use the issue tracker. Please include your browser/OS/user-agent and command line options.

CodeMirror has played a crucial role in the project, we are very happy with it, thanks a lot!

Please consider supporting the development of CodeMirror with a donation.

• Loading ML modules is slow.
• Loading .vo files is slow.
• There surely are threading and performance problems.
• vm_compute and native_compute are devired to regular compute.

jsCoq has been make possible thanks to funding by the FEEVER project.

Contact: Emilio J. Gallego Arias e+jscoq at x80.org.

Incomplete list of places where jsCoq has been used:

• Coq Winter School 2016: “Advanced Software Verification And Computer Proof”. Sophia Antipolis https://team.inria.fr/marelle/en/advanced-coq-winter-school-2016/
• Coq Winter School 2016-2017 (SSReflect & MathComp) “Advanced Software Verification And Computer Proof”. Sophia Antipolis https://team.inria.fr/marelle/en/advanced-coq-winter-school-2016-2017/
• Mathematical Components, an Introduction, Satellite workshop of the ITP 2016 conference, August 27th, Nancy, France https://github.com/math-comp/wiki/wiki/tutorial-itp2016
• Several examples of the "Mathematical Components Book" https://math-comp.github.io/mcb/
• School on "Preuves et Programmes" at l'École de Mines https://www-sop.inria.fr/marelle/mines/
• Mini Corso di Coq a Pavoda: http://www-sop.inria.fr/members/Enrico.Tassi/padova2017/
• Elpi Tutorial / Demo at CoqPL 2017 Los Angeles https://lpcic.github.io/coq-elpi-www/tutorial-demo_CoqPL2018.html
• Coq Winter School 2017-2018 (SSReflect & MathComp) Sophia Antipolis https://team.inria.fr/marelle/en/coq-winter-school-2017-2018-ssreflect-mathcomp/
• Lectures at the "Journées Nationales du Calcul Formel" by Assia Mahboubi: https://specfun.inria.fr/amahboub/Jncf18/cours2.html
• Types Summer School: http://www-sop.inria.fr/teams/marelle/types18/

• http://www.mines-paristech.fr/Actualites/jsCoq-ou-Coq-dans-un-navigateur/2118
• https://news.ycombinator.com/item?id=9836900

You can download ready-to-use builds from https://github.com/ejgallego/jscoq-builds/ ; find below the instructions to build JsCoq yourself, it is reasonably easy.

Short instructions:

$ ./toolchain-setup.sh
$ make coq
$ ./build.sh
$ git submodule update --remote
$ cd ui-external/CodeMirror && npm install

Here are the explanations of the steps:

• First, let's setup a 32-bit Ocaml toolchain. Install a recent opam and a multiarch gcc (gcc-multilib package in Debian/Ubuntu), then:

  $ ./toolchain-setup.sh
  

  will do the job.

• Second, build a 32-bit Coq v8.8 and all the libraries to be installed. make coq should do it automatically. jsCoq is compatible with vanilla Coq v8.8.

• You also need jsCoq's version of CodeMirror:

  $ git submodules update --remote
  $ cd ui-external/CodeMirror && npm install
  

  hopefully, the Coq mode will be merged in CodeMirror some day.

• Finally:

  $ ./build.sh
  

  will build jsCoq. The script manages the 32/64 bit toolchain switching; you can also use make directly if you want finer control over the build process.

• To run jsCoq locally you need to start your browser with some options:

  $ google-chrome --allow-file-access-from-files --js-flags="--harmony-tailcalls" --js-flags="--stack-size=65536" index.html
  

• ?

• Profit!

One of jsCoq's strengths is its support for bundling addon packages. In order to add your Coq package to jsCoq, you need to add a definition file in the coq-addons repository. We recommend you use one of the existing files as a model.

Also, you need to define a jsCoq package by editing the coq-tools/dftlibs.ml file. Once that is done, calling build.sh and make coq should build your package.

JsCoq used to support serialization to Json or Sexps for Coq's internal data structures, but this effort has been split to an independent development. See https://github.com/ejgallego/coq-serapi for more information.

• [jscoq]: ML/Coq interface.
• [ui]: Html/Css commit
• [cm]: CodeMirror provider.
• [libs]: Coq Library support and format.
• [addons]: Addons support.
• [build]: Build system.

See the etc/notes/ directory for some random notes about the project.