package ppxlib

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Cookies

ppxlib
- Ppxlib
  - Ast_builder
    
    Default
    
    Located
    
    Loc
    
    Make
    
    Loc
    
    Located
    
    S
    
    Located
  - Ast_io
  - 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
    
    Instrument
    
    V2
    
    Lint_error
    
    V2
  - Expansion_context
    
    Base
    
    Deriver
    
    Extension
  - Extension
    
    Context
    
    Expert
    
    For_context
    
    V2
    
    V3
  - File_path
  - Keyword
  - 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
  - Ast_helper
    
    Attr
    
    Cf
    
    Ci
    
    Cl
    
    Const
    
    Csig
    
    Cstr
    
    Ctf
    
    Cty
    
    Exp
    
    Incl
    
    Mb
    
    Md
    
    Mod
    
    Ms
    
    Mtd
    
    Mty
    
    Of
    
    Opn
    
    Pat
    
    Rf
    
    Sig
    
    Str
    
    Te
    
    Typ
    
    Type
    
    Val
    
    Vb
  - Compiler_version
  - Convert
    
    A
    
    Ast
    
    Config
    
    Parsetree
    
    B
    
    Ast
    
    Config
    
    Parsetree
  - Extra_warnings
  - Find_version
  - Js
  - Location_error
  - OCaml_version
    
    Ast
    
    Config
    
    Parsetree
  - Parse
    
    Of_ocaml
  - Select_ast
    
    Ocaml
    
    Ast
    
    Config
    
    Parsetree
    
    Of_ocaml
    
    To_ocaml
    
    Type
  - Selected_ast
    
    Of_ocaml
    
    To_ocaml
    
    Type
ppxlib.astlib
- Astlib
  - Ast_402
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_403
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_404
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_405
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_406
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_407
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_408
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_409
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_410
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_411
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_412
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_413
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_414
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_500
    
    Asttypes
    
    Config
    
    Parsetree
  - Ast_metadata
  - Config
  - Keyword
  - Location
    
    Error
  - Longident
  - Migrate_402_403
  - Migrate_403_402
  - Migrate_403_404
  - Migrate_404_403
  - Migrate_404_405
  - Migrate_405_404
  - Migrate_405_406
  - Migrate_406_405
  - Migrate_406_407
  - Migrate_407_406
  - Migrate_407_408
  - Migrate_408_407
  - Migrate_408_409
  - Migrate_409_408
  - Migrate_409_410
  - Migrate_410_409
  - Migrate_410_411
  - Migrate_411_410
  - Migrate_411_412
  - Migrate_412_411
  - Migrate_412_413
  - Migrate_413_412
  - Migrate_413_414
  - Migrate_414_413
  - Migrate_414_500
  - Migrate_500_414
  - Parse
  - Pprintast
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.stdppx
- Stdppx
  - Bool
  - Bytes
  - Char
  - Comparisons
  - Exn
  - Float
  - Fn
  - Hashtbl
  - In_channel
  - Int
  - List
  - Option
  - Out_channel
  - Poly
  - String
    
    Map
    
    Set
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

Meta data related interface for a ppx rewriter

val add_ppx_context_str : 
  tool_name:string ->
  Parsetree.structure_item list ->
  Parsetree.structure_item list

Extract information from the current environment and encode it into an attribute which is prepended to the list of structure items in order to pass the information to an external processor.

val drop_ppx_context_str : 
  restore:bool ->
  Parsetree.structure_item list ->
  Parsetree.structure_item list

Drop the ocaml.ppx.context attribute from a structure. If restore is true, also restore the associated data in the current process.

val add_ppx_context_sig : 
  tool_name:string ->
  Parsetree.signature_item list ->
  Parsetree.signature_item list

Same as add_ppx_context_str, but for signatures.

val drop_ppx_context_sig : 
  restore:bool ->
  Parsetree.signature_item list ->
  Parsetree.signature_item list

Same as drop_ppx_context_str, but for signatures.

val tool_name : unit -> string

Can be used within a ppx preprocessor to know which tool is calling it "ocamlc", "ocamlopt", "ocamldoc", "ocamldep", "ocaml", ...

Cookies

Cookies are used to pass information from a ppx processor to a further invocation of itself, when called from the OCaml toplevel (or other tools that support cookies).

val set_cookie : string -> Parsetree.expression -> unit

val get_cookie : string -> Parsetree.expression option