Import OCaml programs to Coq.
https://clarus.github.io/coq-of-ocaml/
Start with the file main.ml
:
type 'a tree =
| Leaf of 'a
| Node of 'a tree * 'a tree
let rec sum tree =
match tree with
| Leaf n -> n
| Node (tree1, tree2) -> sum tree1 + sum tree2
Run:
coq-of-ocaml main.ml
Get a file Main.v
:
Require Import CoqOfOCaml.CoqOfOCaml.
Require Import CoqOfOCaml.Settings.
Inductive tree (a : Set) : Set :=
| Leaf : a -> tree a
| Node : tree a -> tree a -> tree a.
Arguments Leaf {_}.
Arguments Node {_}.
Fixpoint sum (tree : tree int) : int :=
match tree with
| Leaf n => n
| Node tree1 tree2 => Z.add (sum tree1) (sum tree2)
end.
- core of OCaml (functions, let bindings, pattern-matching,...) βοΈ
- type definitions (records, inductive types, synonyms, mutual types) βοΈ
- modules as namespaces βοΈ
- modules as dependent records (signatures, functors, first-class modules) βοΈ
- projects with complex dependencies using
.merlin
files βοΈ .ml
and.mli
files βοΈ- existential types βοΈ
- partial support of GADTs π
- partial support of polymorphic variants π
- partial support of extensible types π
- ignores side-effects β
Even in case of errors we try to generate some Coq code. The generated Coq code should be readable and with a size similar to the OCaml source. One should not hesitate to fix remaining compilation errors, by hand or with a script (name collisions, missing Require
,...).
Using the package manager opam,
opam install coq-of-ocaml
To install the current development version:
opam pin add https://github.com/clarus/coq-of-ocaml.git#master
Read the coq-of-ocaml.opam
file at the root of the project to know the dependencies to install and get the list of commands to build the project.
coq-of-ocaml
compiles the .ml
or .mli
files using Merlin to understand the dependencies of a project. One first needs to have a compiled project with a working configuration of Merlin. The basic command is:
coq-of-ocaml file.ml
If this does not work as expected, you may specify the path to a .merlin
file:
coq-of-ocaml -merlin src/.merlin path/file.ml
You can start to experiment with the test files in tests/
or look at our online examples.
MIT Β© Guillaume Claret.