package ppxlib

You can search for identifiers within the package.

in-package search v0.2.0

ppxlib
- Ppxlib
  - Ast_builder
    
    Default
    
    Located
    
    Loc
    
    Make
    
    Loc
    
    Located
    
    S
    
    Located
  - Ast_pattern
    
    Packed
  - Ast_traverse
    
    fold
    
    fold_map
    
    iter
    
    lift
    
    map
    
    map_with_context
    
    map_with_expansion_context
    
    map_with_path
    
    sexp_of
  - Attribute
    
    Context
    
    Floating
    
    Context
  - Caller_id
  - Code_path
  - Context_free
    
    Rule
    
    Constant_kind
    
    map_top_down
  - Deriving
    
    Args
    
    Generator
    
    V2
  - Driver
    
    Cookies
    
    Create_file_property
    
    Name
    
    T
    
    Lint_error
  - Expansion_context
    
    Base
    
    Deriver
    
    Extension
  - Extension
    
    Context
    
    Expert
    
    For_context
    
    V2
    
    V3
  - File_path
  - Loc
  - Location
    
    Error
  - Longident
  - Merlin_helpers
  - Reserved_namespaces
  - Spellcheck
  - fold
  - fold_map
  - iter
  - lift
  - map
  - map_with_context
  - type_is_recursive
ppxlib.ast
- Ppxlib_ast
  - Ast
    
    fold
    
    fold_map
    
    iter
    
    lift
    
    map
    
    map_with_context
  - Extra_warnings
  - Import_for_core
    
    Lexer
    
    Location
    
    Parse
    
    Of_ocaml
    
    Parser
    
    Of_ocaml
    
    Select_ast
    
    Ocaml
    
    Ast
    
    Ast_mapper
    
    Config
    
    Outcometree
    
    Parsetree
    
    Of_ocaml
    
    To_ocaml
    
    Type
    
    Selected_ast
    
    Of_ocaml
    
    To_ocaml
    
    Type
    
    Syntaxerr
  - Lexer
  - Parse
    
    Of_ocaml
  - Parser
    
    Of_ocaml
  - Pprintast
  - Select_ast
    
    Ocaml
    
    Ast
    
    Ast_mapper
    
    Config
    
    Outcometree
    
    Parsetree
    
    Of_ocaml
    
    To_ocaml
    
    Type
  - Selected_ast
    
    Of_ocaml
    
    To_ocaml
    
    Type
  - Syntaxerr
ppxlib.metaquot_lifters
- Ppxlib_metaquot_lifters
  - expression_lifters
  - pattern_lifters
ppxlib.print_diff
- Ppxlib_print_diff
ppxlib.runner
- Ppxlib_runner
  - Ppx_driver_runner
ppxlib.runner_as_ppx
- Ppxlib_runner_as_ppx
  - Ppx_driver_runner_as_ppx
ppxlib.traverse_builtins
- Ppxlib_traverse_builtins
  - T
  - fold
  - fold_map
  - iter
  - lift
  - map
  - map_with_context
  - std_lifters

Legend:
Library
Module
Module type
Parameter
Class
Class type

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.Ast_407.Parsetree.expression ->
    Migrate_parsetree.Ast_407.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.

If id is an operator identifier and contains dots, it should be parenthesized (e.g. "(+.+)").

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 deriving.

type ('a, 'b, 'c) attr_group_inline =
  ('b, 'c) Attribute.t ->
  (ctxt:Expansion_context.Deriver.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.Ast_407.Parsetree.structure_item,
    Migrate_parsetree.Ast_407.Parsetree.type_declaration,
    _)
    attr_group_inline

val attr_sig_type_decl : 
  (Migrate_parsetree.Ast_407.Parsetree.signature_item,
    Migrate_parsetree.Ast_407.Parsetree.type_declaration,
    _)
    attr_group_inline

val attr_str_type_decl_expect : 
  (Migrate_parsetree.Ast_407.Parsetree.structure_item,
    Migrate_parsetree.Ast_407.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.Ast_407.Parsetree.signature_item,
    Migrate_parsetree.Ast_407.Parsetree.type_declaration,
    _)
    attr_group_inline

type ('a, 'b, 'c) attr_inline =
  ('b, 'c) Attribute.t ->
  (ctxt:Expansion_context.Deriver.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.Ast_407.Parsetree.structure_item,
    Migrate_parsetree.Ast_407.Parsetree.type_extension,
    _)
    attr_inline

val attr_sig_type_ext : 
  (Migrate_parsetree.Ast_407.Parsetree.signature_item,
    Migrate_parsetree.Ast_407.Parsetree.type_extension,
    _)
    attr_inline

val attr_str_type_ext_expect : 
  (Migrate_parsetree.Ast_407.Parsetree.structure_item,
    Migrate_parsetree.Ast_407.Parsetree.type_extension,
    _)
    attr_inline

val attr_sig_type_ext_expect : 
  (Migrate_parsetree.Ast_407.Parsetree.signature_item,
    Migrate_parsetree.Ast_407.Parsetree.type_extension,
    _)
    attr_inline

val attr_str_exception : 
  (Migrate_parsetree.Ast_407.Parsetree.structure_item,
    Migrate_parsetree.Ast_407.Parsetree.extension_constructor,
    _)
    attr_inline

val attr_sig_exception : 
  (Migrate_parsetree.Ast_407.Parsetree.signature_item,
    Migrate_parsetree.Ast_407.Parsetree.extension_constructor,
    _)
    attr_inline

val attr_str_exception_expect : 
  (Migrate_parsetree.Ast_407.Parsetree.structure_item,
    Migrate_parsetree.Ast_407.Parsetree.extension_constructor,
    _)
    attr_inline

val attr_sig_exception_expect : 
  (Migrate_parsetree.Ast_407.Parsetree.signature_item,
    Migrate_parsetree.Ast_407.Parsetree.extension_constructor,
    _)
    attr_inline