ppxlib 0.1.0 · OCaml Package

Local rewriting rules.

This module lets you define local rewriting rules, such as extension point expanders. It is not completely generic and you cannot define any kind of rewriting, it currently focuses on what is commonly used. New scheme can be added on demand.

We have some ideas to make this fully generic, but this hasn't been a priority so far.

type t

val extension : Extension.t -> t

Rewrite an extension point

val special_function : 
  Base.String.t ->
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.expression ->
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.expression Base.Option.t) ->
  t

special_function id expand is a rule to rewrite a function call at parsing time. id is the identifier to match on and expand is used to expand the full function application (it gets the Pexp_apply node). If the function is found in the tree without being applied, expand gets only the identifier (Pexp_ident node) so you should handle both cases.

expand must decide whether the expression it receive can be rewritten or not. Especially ppxlib makes the assumption that expand is idempotent. It will loop if it is not.

module Constant_kind : sig ... end

Used for the constant function.

val constant : 
  Constant_kind.t ->
  Base.Char.t ->
  (Location.t -> Base.String.t -> Ppxlib_ast.Parsetree.expression) ->
  t

constant kind suffix expander Registers an extension for transforming constants literals, based on the suffix character.

The rest of this API is for rewriting rules that apply when a certain attribute is present. The API is not complete and is currently only enough to implement type_conv.

type ('a, 'b, 'c) attr_group_inline =
  ('b, 'c) Attribute.t ->
  (loc:Location.t ->
    path:Base.String.t ->
    Ppxlib_ast.Asttypes.rec_flag ->
    'b Base.List.t ->
    'c Base.Option.t Base.List.t ->
    'a Base.List.t) ->
  t

Match the attribute on a group of items, such as a group of recursive type definitions (Pstr_type, Psig_type). The expander will be triggered if any of the item has the attribute. The expander is called as follow:

expand ~loc ~path rec_flag items values

where values is the list of values associated to the attribute for each item in items. expand must return a list of element to add after the group. For instance a list of structure item to add after a group of type definitions.

val attr_str_type_decl : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.structure_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.type_declaration,
    _)
    attr_group_inline

val attr_sig_type_decl : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.signature_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.type_declaration,
    _)
    attr_group_inline

val attr_str_type_decl_expect : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.structure_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.type_declaration,
    _)
    attr_group_inline

The _expect variants are for producing code that is compared to what the user wrote in the source code.

val attr_sig_type_decl_expect : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.signature_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.type_declaration,
    _)
    attr_group_inline

type ('a, 'b, 'c) attr_inline =
  ('b, 'c) Attribute.t ->
  (loc:Location.t -> path:Base.String.t -> 'b -> 'c -> 'a Base.List.t) ->
  t

Same as attr_group_inline but for elements that are not part of a group, such as exceptions and type extensions

val attr_str_type_ext : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.structure_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.type_extension,
    _)
    attr_inline

val attr_sig_type_ext : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.signature_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.type_extension,
    _)
    attr_inline

val attr_str_type_ext_expect : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.structure_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.type_extension,
    _)
    attr_inline

val attr_sig_type_ext_expect : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.signature_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.type_extension,
    _)
    attr_inline

val attr_str_exception : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.structure_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.extension_constructor,
    _)
    attr_inline

val attr_sig_exception : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.signature_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.extension_constructor,
    _)
    attr_inline

val attr_str_exception_expect : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.structure_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.extension_constructor,
    _)
    attr_inline

val attr_sig_exception_expect : 
  (Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.signature_item,
    Migrate_parsetree_versions.OCaml_405.Ast.Parsetree.extension_constructor,
    _)
    attr_inline

package ppxlib