diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 98 |
1 files changed, 1 insertions, 97 deletions
@@ -15,15 +15,7 @@ Main contributors: - Peter Zotov (whitequark) - Gabriel Radanne (Drup) -Master : [](https://travis-ci.org/alainfrisch/ppx_tools) - -4.05 : [](https://travis-ci.org/alainfrisch/ppx_tools) - -4.04 : [](https://travis-ci.org/alainfrisch/ppx_tools) - -4.03 : [](https://travis-ci.org/alainfrisch/ppx_tools) - -4.02 : [](https://travis-ci.org/alainfrisch/ppx_tools) +[](https://travis-ci.org/ocaml-ppx/ppx_tools_versioned) ppx_metaquot ------------ @@ -39,21 +31,6 @@ Usage: ocamlfind ocamlc -c -package ppx_tools.metaquot my_ppx_code.ml -rewriter --------- - -An utility to help testing ppx rewriters that runs the rewriter on -user-provided code and returns the result. - -Usage: - - ocamlfind ppx_tools/rewriter ./my_ppx_rewriter sample.ml - -See the integrated help message for more details: - - ocamlfind ppx_tools/rewriter -help - - Ast_mapper_class ---------------- @@ -63,76 +40,3 @@ implemeting a deep identity copy, which can be customized with a custom behavior for each syntactic category. The difference with Ast_mapper is that Ast_mapper_class implements the open recursion using a class. - - -dumpast -------- - -This tool parses fragments of OCaml code (or entire source files) and -dump the resulting internal Parsetree representation. Intended uses: - - - Help to learn about the OCaml Parsetree structure and how it - corresponds to OCaml source syntax. - - - Create fragments of Parsetree to be copy-pasted into the source - code of syntax-manipulating programs (such as ppx rewriters). - -Usage: - - ocamlfind ppx_tools/dumpast -e "1 + 2" - -The tool can be used to show the Parsetree representation of small -fragments of syntax passed on the command line (-e for expressions, -p -for patterns, -t for type expressions) or for entire .ml/mli files. -The standard -pp and -ppx options are supported, but only applied on -whole files. The tool has further option to control how location and -attribute fields in the Parsetree should be displayed. - - -genlifter ---------- - -This tool generates a virtual "lifter" class for one or several OCaml -type constructors. It does so by loading the .cmi files which define -those types. The generated lifter class exposes one method to "reify" -type constructors passed on the command-line and other type -constructors accessible from them. The class is parametrized over the -target type of the reification, and it must provide method to deal -with basic types (int, string, char, int32, int64, nativeint) and data -type builders (record, constr, tuple, list, array). As an example, -calling: - - ocamlfind ppx_tools/genlifter -I +compiler-libs Location.t - -produces the following class: - - class virtual ['res] lifter = - object (this) - method lift_Location_t : Location.t -> 'res= - fun - { Location.loc_start = loc_start; Location.loc_end = loc_end; - Location.loc_ghost = loc_ghost } - -> - this#record "Location.t" - [("loc_start", (this#lift_Lexing_position loc_start)); - ("loc_end", (this#lift_Lexing_position loc_end)); - ("loc_ghost", (this#lift_bool loc_ghost))] - method lift_bool : bool -> 'res= - function - | false -> this#constr "bool" ("false", []) - | true -> this#constr "bool" ("true", []) - method lift_Lexing_position : Lexing.position -> 'res= - fun - { Lexing.pos_fname = pos_fname; Lexing.pos_lnum = pos_lnum; - Lexing.pos_bol = pos_bol; Lexing.pos_cnum = pos_cnum } - -> - this#record "Lexing.position" - [("pos_fname", (this#string pos_fname)); - ("pos_lnum", (this#int pos_lnum)); - ("pos_bol", (this#int pos_bol)); - ("pos_cnum", (this#int pos_cnum))] - end - -_dumpast_ is a direct example of using _genlifter_ applied on the -OCaml Parsetree definition itself. ppx_metaquot is another -similar example. |