package ppxlib

You can search for identifiers within the package.

in-package search v0.2.0

package ppxlib

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
  - Quoter
  - 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

type (_, _) equality =

| Eq : ('a, 'a) equality
| Ne : (_, _) equality

module Context : sig ... end

type t

Type of declared extensions.

val declare : 
  Base.String.t ->
  'context Context.t ->
  (Migrate_parsetree.Ast_410.Parsetree.payload, 'a, 'context) Ast_pattern.t ->
  (loc:Location.t -> path:Base.String.t -> '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

val declare_with_path_arg : 
  Base.String.t ->
  'context Context.t ->
  (Migrate_parsetree.Ast_410.Parsetree.payload, 'a, 'context) Ast_pattern.t ->
  (loc:Location.t ->
    path:Base.String.t ->
    arg:Longident.t Ppxlib_ast.Asttypes.loc Base.Option.t ->
    '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
...

val declare_inline : 
  Base.String.t ->
  'context Context.t ->
  (Migrate_parsetree.Ast_410.Parsetree.payload, 'a, 'context Base.List.t)
    Ast_pattern.t ->
  (loc:Location.t -> path:Base.String.t -> '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

val declare_inline_with_path_arg : 
  Base.String.t ->
  'context Context.t ->
  (Migrate_parsetree.Ast_410.Parsetree.payload, 'a, 'context Base.List.t)
    Ast_pattern.t ->
  (loc:Location.t ->
    path:Base.String.t ->
    arg:Longident.t Ppxlib_ast.Asttypes.loc Base.Option.t ->
    'a) ->
  t

module For_context : sig ... end

This module is used to implement Context_free.V1.map_top_down

val filter_by_context : 
  'a Context.t ->
  t Base.List.t ->
  'a For_context.t Base.List.t

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

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

val check_unused : Ast_traverse.iter

module V2 : sig ... end

module V3 : sig ... end