ocaml-migrate-parsetree

Convert OCaml parsetrees between different versions
README

Convert OCaml parsetrees between different major versions

This library converts between parsetrees of different OCaml versions.

Supported versions are 4.02, 4.03, 4.04, 4.05, 4.06, 4.07, 4.08 and 4.09.
For each version, there is a snapshot of the parsetree and conversion functions
to the next and/or previous version.

Asts

module Ast_402, Ast_403, Ast_404, Ast_405, Ast_406, Ast_407, Ast_408, Ast_409 : sig

  (* These two modules didn't change between compiler versions.
     Just share the ones from compiler-libs. *)
  module Location = Location
  module Longident = Longident

  (* Version specific copy of AST *)
  module Asttypes
  module Parsetree
  module Outcometree

  (* Other modules that are useful for implementing PPX.

     Docstrings and Ast_mapper only contain general definitions
     In particular, the internal state used by compiler-libs has been
     removed.
     Also equalities are lost for abstract types (Docstring.docstring).  *)
  module Docstrings
  module Ast_helper
  module Ast_mapper

  (* Magic numbers used for marshalling *)
  module Config : sig
    val ast_impl_magic_number : string
    val ast_intf_magic_number : string
  end
end

These embed copies of AST definitions for each supported OCaml major version.

The AST matching the version of the OCaml toolchain will contain equalities
relating the copy of types to the definitions from compiler-libs. For
instance, when installed with OCaml 4.04.x, Ast_404.Parsetree looks
like.

Migration modules

For each pair of versions $(n) and $(n+1), the two modules
Migrate_parsetree_$(n)_$(n+1) and Migrate_parsetree_$(n+1)_$(n) convert the AST forward and backward.

The forward conversion is total while the backward conversion is partial: when
a feature is not available in a previous version of the parsetree, a
Migrate_parsetree_def.Migration_error exception is raised detailing the
failure case.

Migrate_parsetree_versions abstract versions of the compiler. Each version is
represented as a module with OCaml_version signature. Instances are named
OCaml_402, OCaml_403, ... OCaml_current is an alias to the version of the
current compiler.
The Convert functor takes two versions of OCaml and produce conversion
functions.

Finally, the Migrate_parsetree_ast_io provides an easy interface for
marshalling/unmarshalling.

Migrate_parsetree.Driver

The Migrate_parsetree.Driver provides an API for ppx rewriters to
register OCaml AST rewriters. Ppx rewriters using this API can be used
as standalone rewriter executable or as part of a driver including
several rewriters.

Using a single driver for several rewritings has the advantage that it
is faster. Especially when using many ppx rewriters, it can speed up
compilation a lot.

If using Dune, you can
consult the dune manual to see how to define and use ppx
rewriters. Dune automatically creates drivers based on
ocaml-migrate-parsetree on demand.

The rest of this section describes how to do things manually or with
ocamlbuild.

Building a custom driver using ocamlfind

To build a custom driver using ocamlfind, simply link all the ppx
rewriter libraries together with the
ocaml-migrate-parsetree.driver-main package at the end:

ocamlfind ocamlopt -predicates ppx_driver -o ppx -linkpkg \
  -package ppx_sexp_conv -package ppx_bin_prot \
  -package ocaml-migrate-parsetree.driver-main

Normally, ocaml-migrate-parsetree based rewriters should be build with
the approriate -linkall option on individual libraries. If one is
missing this option, the rewriter might not get linked in. If this is
the case, a workaround is to pass -linkall when linking the custom
driver.

The resulting ppx program can be used as follow:

  • ./ppx file.ml to print the transformed code

  • ocamlc -pp './ppx --as-pp' ... to use it as a pre-processor

  • ocamlc -ppx './ppx --as-ppx' ... to use it as a -ppx rewriter

Development

It started from the work of Alain Frisch in
ppx_tools.

The library is distributed under LGPL 2.1 and is copyright INRIA.

Adding a new OCaml version

We use Cinaps to generate boilerplate.
You can install it via opam: opam install cinaps.

Add the new version in
src/cinaps_helpers
supported_versions.

Copy the last src/ast_xxx.ml file to src/ast_<new_version>.ml,
then go over the file and update each sub-module by replacing its
signature and implementation with the code from the compiler. For the
Config sub-module, update the two variables with the values in
utils/config.mlp in the compiler source tree.

Once this is done, call:

$ dune exec tools/add_special_comments.exe src/ast_<new_version>.ml

Then diff the src/ast_xxx.ml and src/ast_<new_version>.ml and go
over the diff to make sure the difference are relevant. The ast_...
files require some adjustments which should pop up when you do this
diff. Port the old adjustments to the new file as required.

Add migration functions:

  • Manually compile the asts (ocamlc -c src/ast_{NEW,OLD}.ml -I +compiler-libs -I _build/default/src/.migrate_parsetree.objs/byte/ -open Migrate_parsetree__)

  • Using tools/gencopy.exe (dune build tools/gencopy.exe), generate copy code to and from previous version (assuming it is 408):

_build/default/tools/gencopy.exe -I . -I src/ -I +compiler-libs -map Ast_409:Ast_408 Ast_409.Parsetree.{expression,expr,pattern,pat,core_type,typ,toplevel_phrase} Ast_409.Outcometree.{out_phrase,out_type_extension} > src/migrate_parsetree_409_408_migrate.ml
_build/default/tools/gencopy.exe -I . -I src/ -I +compiler-libs -map Ast_408:Ast_409 Ast_408.Parsetree.{expression,expr,pattern,pat,core_type,typ,toplevel_phrase} Ast_408.Outcometree.{out_phrase,out_type_extension} > src/migrate_parsetree_408_409_migrate.ml
  • Fix the generated code by implementing new cases

  • The migration functor expects specific names, look at Migrate_parsetree_versions interface.

TODO: specialize and improve gencopy for these cases

Add mapper lifting functions in the files migrate_parsetree_NEW_408.ml and
migrate_parsetree_408_NEW.ml:

  • include the corresponding Migrate_parsetree_40x_40y_migrate module

  • define copy_mapper function, look at existing Migrate_parsetree_40x_40y
    for guidance.

At any time, you can expand boilerplate code by running make cinaps.

Update build system:

  • make sure make cinaps reaches a fixed point :)

  • make should succeed

Install
Published
23 Oct 2020
Sources
ocaml-migrate-parsetree-v1.8.0.tbz
sha256=b1c2d176ff1444041f2775786ba605be796e46dfd2acb06c96f35d2bb88b8fb5
sha512=c14ffacbba9fda34243b3e8310ce49414415b530bbd982eaa6c1891517c5a9a6a35887afa7d6f15f7f94e225a7f15cc25417fd3337e685d4a7d6ee160e50e66e
Dependencies
ocaml
>= "4.02.3" & < "4.13"
dune
>= "1.9.0"
Reverse Dependencies
async
>= "v0.9.0" & < "v0.12.0"
async_durable
< "v0.12.0"
async_extended
>= "v0.9.0"
async_extra
>= "v0.9.0" & < "v0.12.0"
async_find
>= "v0.9.0" & < "v0.12.0"
async_inotify
>= "v0.9.0" & < "v0.12.0"
async_js
< "v0.12.0"
async_kernel
>= "v0.9.0" & < "v0.12.0"
async_parallel
>= "v0.9.0"
async_rpc_kernel
>= "v0.9.0" & < "v0.12.0"
async_sendfile
< "v0.12.0"
async_shell
>= "v0.9.0" & < "v0.12.0"
async_smtp
>= "v0.9.0" & < "v0.12.0"
async_ssl
>= "v0.9.0" & < "v0.12.0"
async_unix
>= "v0.9.0" & < "v0.12.0"
bignum
>= "v0.9.0" & < "v0.12.0"
bin_prot
>= "v0.9.0" & < "v0.12.0"
bisect_ppx
>= "1.3.0" & < "2.6.0"
bitstring
>= "3.0.0" & < "4.0.0"
command_rpc
< "v0.12.0"
configurator
< "v0.10.0"
core
>= "v0.9.0" & < "v0.12.0"
core_bench
>= "v0.9.0" & < "v0.12.0"
core_extended
>= "v0.9.0" & < "v0.12.0"
core_kernel
>= "v0.9.0" & < "v0.12.0"
core_profiler
>= "v0.9.0" & < "v0.12.0"
cstruct
= "2.4.1"
csvfields
< "v0.12.0"
dockerfile
>= "3.0.0" & < "6.0.0"
dockerfile-opam
>= "4.0.0" & < "6.0.0"
ecaml
< "v0.12.0"
elpi
< "1.13.2"
email_message
>= "v0.9.0" & < "v0.12.0"
extunix
= "0.2.0"
fieldslib
>= "v0.9.0" & < "v0.12.0"
fstar
>= "0.9.6.0" & < "2021.06.06"
GT
< "0.4.0"
gdbprofiler
>= "0.2" & < "0.4"
gen_js_api
>= "1.0.6" & < "1.0.8"
graphql
< "0.4.0"
graphql_ppx
< "1.2.2"
incr_dom
< "v0.12.0"
incr_dom_widgets
< "v0.12.0"
incr_map
< "v0.12.0"
incr_select
< "v0.12.0"
incremental
>= "v0.9.0" & < "v0.12.0"
ipaddr
= "2.8.0"
jenga
>= "v0.9.0"
js_of_ocaml
>= "3.0" & < "3.8.0"
js_of_ocaml-compiler
>= "3.5.0" & < "3.8.0"
js_of_ocaml-ppx_deriving_json
>= "3.5.0" & < "3.8.0"
jupyter
>= "2.0.0" & < "2.2.2"
lablqml
= "0.5.2"
landmarks
= "1.3"
learn-ocaml
>= "0.14.0"
levenshtein
>= "1.1.3"
line-up-words
< "v0.12.0"
loga
>= "0.0.5"
logs-ppx
< "0.2.0"
lwt
>= "3.1.0" & < "4.0.0"
lwt_ppx
< "2.0.2"
mdx
>= "1.2.0" & < "1.8.1"
memtrace_viewer
< "v0.15.0"
metapp
< "0.3.0"
metaquot
< "0.3.0"
mlpost
>= "0.9"
mlt_parser
< "v0.12.0"
notty_async
< "v0.12.0"
nsq
>= "0.2.4"
obus
>= "1.2.0" & < "1.2.3"
ocaml-basics
>= "0.5.0"
ocaml-monadic
>= "0.4.0" & < "0.5"
ocaml_plugin
>= "v0.9.0" & < "v0.12.0"
ocamlformat
< "0.15.1"
odoc
>= "2.0.0" & < "2.1.0"
omonad
>= "0.3.3"
parsexp
< "v0.11.0"
parsexp_io
< "v0.12.0"
patdiff
>= "v0.9.0" & < "v0.12.0"
patience_diff
>= "v0.9.0" & < "v0.12.0"
pattern
>= "0.2.0"
pgocaml
>= "3.1" & < "4.0"
pgocaml_ppx
< "4.3.0"
pla
>= "1.2" & < "2.0"
posixat
>= "v0.10.0" & < "v0.12.0"
ppx_assert
>= "v0.9.0" & < "v0.12.0"
ppx_ast
< "v0.11.0"
ppx_base
< "v0.12.0"
ppx_bench
>= "v0.9.0" & < "v0.12.0"
ppx_bigarray
>= "3.0.0"
ppx_bin_prot
>= "v0.9.0" & < "v0.12.0"
ppx_bitstring
>= "2.0.0" & < "4.0.0"
ppx_blob
>= "0.3.0" & < "0.7.2"
ppx_compare
>= "v0.9.0" & < "v0.12.0"
ppx_compose
< "0.2.1"
ppx_conv_func
>= "v0.9.0" & < "v0.12.0"
ppx_cstruct
>= "3.0.1" & < "6.0.0"
ppx_cstubs
< "0.6.0"
ppx_csv_conv
>= "v0.9.0" & < "v0.12.0"
ppx_custom_printf
>= "v0.9.0" & < "v0.12.0"
ppx_defer
>= "0.3.0" & < "0.5.0"
ppx_deriving
>= "4.2" & < "5.2"
ppx_driver
>= "v0.9.0" & < "v0.11.0"
ppx_enumerate
>= "v0.9.0" & < "v0.12.0"
ppx_expect
>= "v0.9.0" & < "v0.12.0"
ppx_fail
>= "v0.9.0" & < "v0.12.0"
ppx_fields_conv
>= "v0.9.0" & < "v0.12.0"
ppx_gen_rec
< "2.0.0"
ppx_hash
< "v0.12.0"
ppx_here
>= "v0.9.0" & < "v0.12.0"
ppx_implicits
>= "0.2.0"
ppx_import
>= "1.5-3-gbd627d5" & < "1.9.0"
ppx_inline_test
>= "v0.9.0" & < "v0.12.0"
ppx_jane
>= "v0.9.0" & < "v0.12.0"
ppx_js_style
< "v0.12.0"
ppx_jsobject_conv
>= "0.5.0" & < "0.9.0"
ppx_let
>= "v0.9.0" & < "v0.12.0"
ppx_metaquot
< "v0.11.0"
ppx_monoid
= "0.3.2"
ppx_optional
< "v0.12.0"
ppx_pipebang
>= "v0.9.0" & < "v0.12.0"
ppx_regexp
< "0.5.0"
ppx_relit
>= "0.2.0"
ppx_sexp_conv
>= "v0.9.0" & < "v0.12.0"
ppx_sexp_message
>= "v0.9.0" & < "v0.12.0"
ppx_sexp_value
>= "v0.9.0" & < "v0.12.0"
ppx_traverse
< "v0.11.0"
ppx_type_conv
>= "v0.9.0" & < "v0.11.0"
ppx_typerep_conv
>= "v0.9.0" & < "v0.12.0"
ppx_variants_conv
>= "v0.9.0" & < "v0.12.0"
ppx_xml_conv
>= "v0.9.0" & < "v0.12.0"
ppxfind
>= "1.4"
ppxlib
< "0.16.0"
ppxx
>= "2.0.0" & < "2.5.0"
protocol-9p
>= "0.11.2" & < "1.0.0"
protocol-9p-unix
= "0.11.3" | = "0.12.1"
re2
>= "v0.9.0" & < "v0.12.0"
reason
>= "1.11.0" & < "3.6.2"
record_builder
< "v0.12.0"
relit_helper
>= "0.2.0"
resource_cache
< "v0.12.0"
rpc_parallel
>= "v0.9.0" & < "v0.12.0"
sedlex
>= "1.99.4" & < "2.3"
sequencer_table
< "v0.12.0"
sexp_pretty
< "v0.12.0"
splay_tree
< "v0.12.0"
spotlib
= "4.0.3"
ssh-agent
< "0.2.0"
string_dict
< "v0.12.0"
tcpip
>= "3.4.1" & < "3.7.0"
textutils
>= "v0.9.0" & < "v0.12.0"
textutils_kernel
< "v0.12.0"
toplevel_expect_test
>= "v0.9.1" & < "v0.12.0"
topological_sort
< "v0.12.0"
treeprint
>= "2.2.0"
typerep_extended
>= "v0.9.0"
unmagic
>= "1.0.3"
uri
>= "1.9.4" & < "2.0.0"
variantslib
>= "v0.9.0" & < "v0.12.0"
virtual_dom
< "v0.12.0"
vmnet
>= "1.3.0" & < "1.3.2"
wcs-lib
>= "2017-05-26.02"
yaml
< "1.0.0"