package ppxlib

  1. Overview
  2. Docs
Module type
Class type
val add_arg : Ppxlib__.Import.Caml.Arg.key -> Ppxlib__.Import.Caml.Arg.spec -> doc:string -> unit

Add one argument to the command line

module Lint_error : sig ... end

Error reported by linters

module Cookies : sig ... end
module Instrument : sig ... end
val register_transformation : ?extensions:Extension.t list -> ?rules:Context_free.Rule.t list -> ?enclose_impl: (Location.t option -> Ppxlib_ast__.Import.Parsetree.structure_item list * Ppxlib_ast__.Import.Parsetree.structure_item list) -> ?enclose_intf: (Location.t option -> Ppxlib_ast__.Import.Parsetree.signature_item list * Ppxlib_ast__.Import.Parsetree.signature_item list) -> ?impl: (Ppxlib_ast__.Import.Parsetree.structure_item list -> Ppxlib_ast__.Import.Parsetree.structure_item list) -> ?intf: (Ppxlib_ast__.Import.Parsetree.signature_item list -> Ppxlib_ast__.Import.Parsetree.signature_item list) -> ?lint_impl: (Ppxlib_ast__.Import.Parsetree.structure_item list -> Lint_error.t list) -> ?lint_intf: (Ppxlib_ast__.Import.Parsetree.signature_item list -> Lint_error.t list) -> ?preprocess_impl: (Ppxlib_ast__.Import.Parsetree.structure_item list -> Ppxlib_ast__.Import.Parsetree.structure_item list) -> ?preprocess_intf: (Ppxlib_ast__.Import.Parsetree.signature_item list -> Ppxlib_ast__.Import.Parsetree.signature_item list) -> ?instrument:Instrument.t -> ?aliases:string list -> string -> unit

register_transformation name registers a code transformation.

name is a logical name for the transformation (such as sexp_conv or bin_prot). It is mostly used for debugging purposes.

rules is a list of context independent rewriting rules, such as extension point expanders. This is what most code transformation should use. Rules from all registered transformations are all applied at the same time, before any other transformations. Moreover they are applied in a top-down manner, giving more control to extensions on how they interpret their payload.

For instance:

  • some extensions capture a pretty-print of the payload in their expansion and using top-down ensures that the payload is as close as possible to the original code
  • some extensions process other extension in a special way inside their payload. For instance %here (from ppx_here) will normally expand to a record of type Lexing.position. However when used inside %sexp (from ppx_sexp_value) it will expand to the human-readable sexp representation of a source code position.

extensions is a special cases of rules and is deprecated. It is only kept for backward compatibility.

enclose_impl and enclose_intf produces a header and footer for implementation/interface files. They are a special case of impl and intf. The header is placed after any initial module-level attributes; the footer is placed after everything else. Both functions receive a location that denotes all of the items between header and footer, or None if the that list of items is empty.

impl is an optional function that is applied on implementation files and intf is an optional function that is applied on interface files. These two functions are applied on the AST of the whole file. They should only be used when the other mechanism are not enough. For instance if the transformation expands extension points that depend on the context.

If no rewriter is using impl and intf, then the whole transformation is completely independent of the order in which the various rewriter are specified. Moreover the resulting driver will be faster as it will do only one pass (excluding safety checks) on the whole AST.

lint_impl and lint_intf are applied to the unprocessed source. Errors they return will be reported to the user as preprocessor warnings.

instrument can be used to instrument implementation files. Its transformation is applied to the AST of the whole file. The difference to impl is that you can specify if it should be applied before or after all rewriters defined through rules, impl or intf are applied.

Rewritings are applied in the following order:

  • linters (lint_impl, lint_intf)
  • preprocessing (preprocess_impl, preprocess_intf)
  • "before" instrumentations (instrument, where instrument = Instrument.make ~position:Before (...))
  • context-independent rules (rules, extensions)
  • non-instrumentation whole-file transformations (impl, intf, enclose_impl, enclose_intf)
  • "after" instrumentations (instrument, where instrument = Instrument.make ~position:After (...))
val register_transformation_using_ocaml_current_ast : ?impl: (Ppxlib__.Import.Compiler_version.Ast.Parsetree.structure -> Ppxlib__.Import.Compiler_version.Ast.Parsetree.structure) -> ?intf: (Ppxlib__.Import.Compiler_version.Ast.Parsetree.signature -> Ppxlib__.Import.Compiler_version.Ast.Parsetree.signature) -> ?aliases:string list -> string -> unit

Same as register_transformation except that it uses the same AST as the current ocaml compiler.

This is not the intended way of using driver. This is only for ppx rewriters that are not written using ppxlib but want to export a driver compatible library.

val register_code_transformation : name:string -> ?aliases:string list -> impl: (Ppxlib_ast__.Import.Parsetree.structure_item list -> Ppxlib_ast__.Import.Parsetree.structure_item list) -> intf: (Ppxlib_ast__.Import.Parsetree.signature_item list -> Ppxlib_ast__.Import.Parsetree.signature_item list) -> unit

Same as:

  • deprecated [since 2015-11] use register_transformation instead
val register_correction : loc:Location.t -> repl:string -> unit

Rewriters might call this function to suggest a correction to the code source. When they do this, the driver will generate a file with the suggested replacement. The build system will then show the diff to the user who is free to accept the correction or not.

val register_process_file_hook : (unit -> unit) -> unit

Hook called before processing a file

module V2 : sig ... end
module Create_file_property (Name : sig ... end) (T : Stdppx.Sexpable.S) : sig ... end

Create a new file property.

val standalone : unit -> unit

Suitable for -pp and also usable as a standalone command line tool.

If the first command line argument is -as-ppx then it will run as a ppx rewriter.

val run_as_ppx_rewriter : unit -> unit

Suitable for -ppx. Used only for the public release.

val pretty : unit -> bool

If true, code transformations should avoid generating code that is not strictly necessary, such as extra type annotations.


Innovation. Community. Security.