package ppxlib

  1. Overview
  2. Docs
package ppxlib
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Ppxlib.ExtensionSource

Declare extenders to rewrite extension nodes.

Sourcetype (_, _) equality =
  1. | Eq : ('a, 'a) equality
  2. | Ne : (_, _) equality
Sourcemodule Context : sig ... end
Sourcetype t

Type of declared extensions.

Sourceval declare : string -> 'context Context.t -> (Astlib.Ast_500.Parsetree.payload, 'a, 'context) Ast_pattern.t -> (loc:Location.t -> path:string -> 'a) -> t

declare name context pattern expander declares the extension names name for context.

expander is responsible for producing the code to replace the extension in the AST. It receives as argument:

  • loc: the location of the enclosing node. For instance for expression it is the pexp_loc field
  • path: the current module path
Sourceval declare_with_path_arg : string -> 'context Context.t -> (Astlib.Ast_500.Parsetree.payload, 'a, 'context) Ast_pattern.t -> (loc:Location.t -> path:string -> arg:Longident.t Ppxlib_ast.Asttypes.loc option -> 'a) -> t

Same as declare except that the extension name takes an additional path argument. The path is the part of the name that start with a capitalized component. For instance in the following, the extension "map" would receive the path argument Foo.Bar:

  let%map.Foo.Bar x = 1 in
  ...
Sourceval declare_inline : string -> 'context Context.t -> (Astlib.Ast_500.Parsetree.payload, 'a, 'context list) Ast_pattern.t -> (loc:Location.t -> path:string -> 'a) -> t

Inline the result of the expansion into its parent. Only works for these contexts:

  • class_field
  • class_type_field
  • signature_item
  • structure_item
Sourceval declare_inline_with_path_arg : string -> 'context Context.t -> (Astlib.Ast_500.Parsetree.payload, 'a, 'context list) Ast_pattern.t -> (loc:Location.t -> path:string -> arg:Longident.t Ppxlib_ast.Asttypes.loc option -> 'a) -> t
Sourcemodule For_context : sig ... end

This module is used to implement Context_free.map_top_down

Sourceval filter_by_context : 'a Context.t -> t list -> 'a For_context.t list

Given a context and a list of extension expander, returns all the ones that are for this context.

Sourcemodule Expert : sig ... end

This module allows to declare extensions that do not produce a value of the context type. This is typically useful for extensions point that depends on more things from the context than the path and location.

Sourceval check_unused : Ast_traverse.iter
Sourceval collect_unhandled_extension_errors : Location.Error.t list Ast_traverse.fold
Sourcemodule V2 : sig ... end
Sourcemodule V3 : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct