ppxlib's user manual

Overview

This is the user manual and API for ppxlib, the core of the PPX meta-programming system for OCaml and its derivatives, such as Reason. For a good introduction on PPXs, what they are, and how to use them, see the OCaml official guide on PPXs. This manual is mostly aimed at authors of PPX rewriters and contains everything one should know in order to write PPX rewriters.

Manual

The manual consists of several sections. It can be read linearly, but you can also jump directly to your section of interest:

1. An introduction to ppxlib
2. How ppxlib works internally
3. Compatibility with Multiple OCaml Versions
4. Registering a transformation
5. Generating AST nodes
6. Destructing AST nodes
7. Traversing the AST
8. Good practices
9. Examples

API

The API exposes the following modules:

• Ppxlib Standard library for ppx rewriters
• Ppxlib_ast
• Astlib
• Ppxlib_metaquot
• Ppxlib_metaquot_lifters
• Ppxlib_print_diff
• Ppxlib_runner
• Ppxlib_runner_as_ppx
• Stdppx
• Ppxlib_traverse
• Ppxlib_traverse_builtins