package ppxlib

  1. Overview
  2. Docs

Standard library for ppx rewriters

Make sure code using Ppxlib doesn't refer to compiler-libs without being explicit about it

include module type of struct include Ocaml_shadow end with module Ast_helper := Ocaml_shadow.Ast_helper with module Asttypes := Ocaml_shadow.Asttypes with module Docstrings := Ocaml_shadow.Docstrings with module Identifiable := Ocaml_shadow.Identifiable with module Lexer := Ocaml_shadow.Lexer with module Location := Ocaml_shadow.Location with module Longident := Ocaml_shadow.Longident with module Parse := Ocaml_shadow.Parse with module Parser := Ocaml_shadow.Parser with module Parsetree := Ocaml_shadow.Parsetree with module Pprintast := Ocaml_shadow.Pprintast with module Syntaxerr := Ocaml_shadow.Syntaxerr
module Do_not_use_directly = Ocaml_shadow.Do_not_use_directly
module Afl_instrument = Ocaml_shadow.Afl_instrument
module Alias_analysis = Ocaml_shadow.Alias_analysis
module Allocated_const = Ocaml_shadow.Allocated_const
module Annot = Ocaml_shadow.Annot
module Arch = Ocaml_shadow.Arch
module Arg_helper = Ocaml_shadow.Arg_helper
module Asmgen = Ocaml_shadow.Asmgen
module Asmlibrarian = Ocaml_shadow.Asmlibrarian
module Asmpackager = Ocaml_shadow.Asmpackager
module Ast_invariants = Ocaml_shadow.Ast_invariants
module Ast_iterator = Ocaml_shadow.Ast_iterator
module Ast_mapper = Ocaml_shadow.Ast_mapper
module Attr_helper = Ocaml_shadow.Attr_helper
module Augment_specialised_args = Ocaml_shadow.Augment_specialised_args
module Backend_intf = Ocaml_shadow.Backend_intf
module Branch_relaxation = Ocaml_shadow.Branch_relaxation
module Branch_relaxation_intf = Ocaml_shadow.Branch_relaxation_intf
module Btype = Ocaml_shadow.Btype
module Build_export_info = Ocaml_shadow.Build_export_info
module Builtin_attributes = Ocaml_shadow.Builtin_attributes
module Bytegen = Ocaml_shadow.Bytegen
module Bytelibrarian = Ocaml_shadow.Bytelibrarian
module Bytepackager = Ocaml_shadow.Bytepackager
module Bytesections = Ocaml_shadow.Bytesections
module CSE = Ocaml_shadow.CSE
module CSEgen = Ocaml_shadow.CSEgen
module Ccomp = Ocaml_shadow.Ccomp
module Clambda = Ocaml_shadow.Clambda
module Clflags = Ocaml_shadow.Clflags
module Closure = Ocaml_shadow.Closure
module Closure_conversion = Ocaml_shadow.Closure_conversion
module Closure_conversion_aux = Ocaml_shadow.Closure_conversion_aux
module Closure_element = Ocaml_shadow.Closure_element
module Closure_id = Ocaml_shadow.Closure_id
module Closure_offsets = Ocaml_shadow.Closure_offsets
module Cmi_format = Ocaml_shadow.Cmi_format
module Cmm = Ocaml_shadow.Cmm
module Cmmgen = Ocaml_shadow.Cmmgen
module Cmo_format = Ocaml_shadow.Cmo_format
module Cmt_format = Ocaml_shadow.Cmt_format
module Cmx_format = Ocaml_shadow.Cmx_format
module Coloring = Ocaml_shadow.Coloring
module Comballoc = Ocaml_shadow.Comballoc
module Compenv = Ocaml_shadow.Compenv
module Compilation_unit = Ocaml_shadow.Compilation_unit
module Compile = Ocaml_shadow.Compile
module Compilenv = Ocaml_shadow.Compilenv
module Compmisc = Ocaml_shadow.Compmisc
module Compplugin = Ocaml_shadow.Compplugin
module Config = Ocaml_shadow.Config
module Consistbl = Ocaml_shadow.Consistbl
module Ctype = Ocaml_shadow.Ctype
module Datarepr = Ocaml_shadow.Datarepr
module Deadcode = Ocaml_shadow.Deadcode
module Debuginfo = Ocaml_shadow.Debuginfo
module Depend = Ocaml_shadow.Depend
module Dll = Ocaml_shadow.Dll
module Effect_analysis = Ocaml_shadow.Effect_analysis
module Emit = Ocaml_shadow.Emit
module Emitaux = Ocaml_shadow.Emitaux
module Emitcode = Ocaml_shadow.Emitcode
module Env = Ocaml_shadow.Env
module Envaux = Ocaml_shadow.Envaux
module Errors = Ocaml_shadow.Errors
module Export_id = Ocaml_shadow.Export_id
module Export_info = Ocaml_shadow.Export_info
module Export_info_for_pack = Ocaml_shadow.Export_info_for_pack
module Expunge = Ocaml_shadow.Expunge
module Extract_projections = Ocaml_shadow.Extract_projections
module Find_recursive_functions = Ocaml_shadow.Find_recursive_functions
module Flambda = Ocaml_shadow.Flambda
module Flambda_invariants = Ocaml_shadow.Flambda_invariants
module Flambda_iterators = Ocaml_shadow.Flambda_iterators
module Flambda_to_clambda = Ocaml_shadow.Flambda_to_clambda
module Flambda_utils = Ocaml_shadow.Flambda_utils
module Freshening = Ocaml_shadow.Freshening
module Genprintval = Ocaml_shadow.Genprintval
module Id_types = Ocaml_shadow.Id_types
module Ident = Ocaml_shadow.Ident
module Import_approx = Ocaml_shadow.Import_approx
module Includeclass = Ocaml_shadow.Includeclass
module Includecore = Ocaml_shadow.Includecore
module Includemod = Ocaml_shadow.Includemod
module Inconstant_idents = Ocaml_shadow.Inconstant_idents
module Initialize_symbol_to_let_symbol = Ocaml_shadow.Initialize_symbol_to_let_symbol
module Inline_and_simplify = Ocaml_shadow.Inline_and_simplify
module Inline_and_simplify_aux = Ocaml_shadow.Inline_and_simplify_aux
module Inlining_cost = Ocaml_shadow.Inlining_cost
module Inlining_decision = Ocaml_shadow.Inlining_decision
module Inlining_decision_intf = Ocaml_shadow.Inlining_decision_intf
module Inlining_stats = Ocaml_shadow.Inlining_stats
module Inlining_stats_types = Ocaml_shadow.Inlining_stats_types
module Inlining_transforms = Ocaml_shadow.Inlining_transforms
module Instruct = Ocaml_shadow.Instruct
module Interf = Ocaml_shadow.Interf
module Invariant_params = Ocaml_shadow.Invariant_params
module Lambda = Ocaml_shadow.Lambda
module Lift_code = Ocaml_shadow.Lift_code
module Lift_constants = Ocaml_shadow.Lift_constants
module Lift_let_to_initialize_symbol = Ocaml_shadow.Lift_let_to_initialize_symbol
module Linearize = Ocaml_shadow.Linearize
module Linkage_name = Ocaml_shadow.Linkage_name
module Liveness = Ocaml_shadow.Liveness
module Mach = Ocaml_shadow.Mach
module Main = Ocaml_shadow.Main
module Main_args = Ocaml_shadow.Main_args
module Matching = Ocaml_shadow.Matching
module Meta = Ocaml_shadow.Meta
module Middle_end = Ocaml_shadow.Middle_end
module Misc = Ocaml_shadow.Misc
module Mtype = Ocaml_shadow.Mtype
module Mutable_variable = Ocaml_shadow.Mutable_variable
module Numbers = Ocaml_shadow.Numbers
module Opcodes = Ocaml_shadow.Opcodes
module Oprint = Ocaml_shadow.Oprint
module Optcompile = Ocaml_shadow.Optcompile
module Opterrors = Ocaml_shadow.Opterrors
module Optmain = Ocaml_shadow.Optmain
module Outcometree = Ocaml_shadow.Outcometree
module Parmatch = Ocaml_shadow.Parmatch
module Pass_wrapper = Ocaml_shadow.Pass_wrapper
module Path = Ocaml_shadow.Path
module Pparse = Ocaml_shadow.Pparse
module Predef = Ocaml_shadow.Predef
module Primitive = Ocaml_shadow.Primitive
module Printast = Ocaml_shadow.Printast
module Printclambda = Ocaml_shadow.Printclambda
module Printcmm = Ocaml_shadow.Printcmm
module Printinstr = Ocaml_shadow.Printinstr
module Printlambda = Ocaml_shadow.Printlambda
module Printlinear = Ocaml_shadow.Printlinear
module Printmach = Ocaml_shadow.Printmach
module Printtyp = Ocaml_shadow.Printtyp
module Printtyped = Ocaml_shadow.Printtyped
module Proc = Ocaml_shadow.Proc
module Projection = Ocaml_shadow.Projection
module Ref_to_variables = Ocaml_shadow.Ref_to_variables
module Reg = Ocaml_shadow.Reg
module Reload = Ocaml_shadow.Reload
module Reloadgen = Ocaml_shadow.Reloadgen
module Remove_free_vars_equal_to_args = Ocaml_shadow.Remove_free_vars_equal_to_args
module Remove_unused_arguments = Ocaml_shadow.Remove_unused_arguments
module Remove_unused_closure_vars = Ocaml_shadow.Remove_unused_closure_vars
module Remove_unused_program_constructs = Ocaml_shadow.Remove_unused_program_constructs
module Runtimedef = Ocaml_shadow.Runtimedef
module Schedgen = Ocaml_shadow.Schedgen
module Scheduling = Ocaml_shadow.Scheduling
module Selectgen = Ocaml_shadow.Selectgen
module Selection = Ocaml_shadow.Selection
module Semantics_of_primitives = Ocaml_shadow.Semantics_of_primitives
module Set_of_closures_id = Ocaml_shadow.Set_of_closures_id
module Set_of_closures_origin = Ocaml_shadow.Set_of_closures_origin
module Share_constants = Ocaml_shadow.Share_constants
module Simple_value_approx = Ocaml_shadow.Simple_value_approx
module Simplif = Ocaml_shadow.Simplif
module Simplify_boxed_integer_ops = Ocaml_shadow.Simplify_boxed_integer_ops
module Simplify_boxed_integer_ops_intf = Ocaml_shadow.Simplify_boxed_integer_ops_intf
module Simplify_common = Ocaml_shadow.Simplify_common
module Simplify_primitives = Ocaml_shadow.Simplify_primitives
module Spacetime_profiling = Ocaml_shadow.Spacetime_profiling
module Spill = Ocaml_shadow.Spill
module Split = Ocaml_shadow.Split
module Static_exception = Ocaml_shadow.Static_exception
module Strmatch = Ocaml_shadow.Strmatch
module Strongly_connected_components = Ocaml_shadow.Strongly_connected_components
module Stypes = Ocaml_shadow.Stypes
module Subst = Ocaml_shadow.Subst
module Switch = Ocaml_shadow.Switch
module Symbol = Ocaml_shadow.Symbol
module Symtable = Ocaml_shadow.Symtable
module Tag = Ocaml_shadow.Tag
module Targetint = Ocaml_shadow.Targetint
module Tast_mapper = Ocaml_shadow.Tast_mapper
module Tbl = Ocaml_shadow.Tbl
module Terminfo = Ocaml_shadow.Terminfo
module Timings = Ocaml_shadow.Timings
module Topdirs = Ocaml_shadow.Topdirs
module Toploop = Ocaml_shadow.Toploop
module Topmain = Ocaml_shadow.Topmain
module Topstart = Ocaml_shadow.Topstart
module Trace = Ocaml_shadow.Trace
module Translattribute = Ocaml_shadow.Translattribute
module Translclass = Ocaml_shadow.Translclass
module Translcore = Ocaml_shadow.Translcore
module Translmod = Ocaml_shadow.Translmod
module Translobj = Ocaml_shadow.Translobj
module Typeclass = Ocaml_shadow.Typeclass
module Typecore = Ocaml_shadow.Typecore
module Typedecl = Ocaml_shadow.Typedecl
module Typedtree = Ocaml_shadow.Typedtree
module TypedtreeIter = Ocaml_shadow.TypedtreeIter
module TypedtreeMap = Ocaml_shadow.TypedtreeMap
module Typemod = Ocaml_shadow.Typemod
module Typeopt = Ocaml_shadow.Typeopt
module Types = Ocaml_shadow.Types
module Typetexp = Ocaml_shadow.Typetexp
module Un_anf = Ocaml_shadow.Un_anf
module Unbox_closures = Ocaml_shadow.Unbox_closures
module Unbox_free_vars_of_closures = Ocaml_shadow.Unbox_free_vars_of_closures
module Unbox_specialised_args = Ocaml_shadow.Unbox_specialised_args
module Untypeast = Ocaml_shadow.Untypeast
module Var_within_closure = Ocaml_shadow.Var_within_closure
module Variable = Ocaml_shadow.Variable
module Warnings = Ocaml_shadow.Warnings
module X86_ast = Ocaml_shadow.X86_ast
module X86_dsl = Ocaml_shadow.X86_dsl
module X86_gas = Ocaml_shadow.X86_gas
module X86_masm = Ocaml_shadow.X86_masm
module X86_proc = Ocaml_shadow.X86_proc

Includes the overrides from Ppxlib_ast, as well as all the Ast definitions since we need them in every single ppx

include module type of struct include Ppxlib_ast end
module Ast = Ppxlib_ast.Ast
module Ast_helper = Ppxlib_ast.Ast_helper
module Ast_magic = Ppxlib_ast.Ast_magic
module Asttypes = Ppxlib_ast.Asttypes
module Docstrings = Ppxlib_ast.Docstrings
module Extra_warnings = Ppxlib_ast.Extra_warnings
module Lexer = Ppxlib_ast.Lexer
module Parse = Ppxlib_ast.Parse
module Parser = Ppxlib_ast.Parser
module Parsetree = Ppxlib_ast.Parsetree
module Pprintast = Ppxlib_ast.Pprintast
module Select_ast = Ppxlib_ast.Select_ast
module Selected_ast = Ppxlib_ast.Selected_ast
module Syntaxerr = Ppxlib_ast.Syntaxerr
module Import_for_core = Ppxlib_ast.Import_for_core
include module type of struct include Ast end
type position = Lexing.position = {
  1. pos_fname : string;
  2. pos_lnum : int;
  3. pos_bol : int;
  4. pos_cnum : int;
}
and location = Location.t = {
  1. loc_start : position;
  2. loc_end : position;
  3. loc_ghost : bool;
}
and location_stack = location list
and 'a loc = 'a Location.loc = {
  1. txt : 'a;
  2. loc : location;
}
and longident = Ocaml_common.Longident.t =
  1. | Lident of string
  2. | Ldot of longident * string
  3. | Lapply of longident * longident
and longident_loc = longident loc

Auxiliary AST types used by parsetree and typedtree.

and rec_flag = Migrate_parsetree.Ast_408.Asttypes.rec_flag =
  1. | Nonrecursive
  2. | Recursive
and direction_flag = Migrate_parsetree.Ast_408.Asttypes.direction_flag =
  1. | Upto
  2. | Downto
and private_flag = Migrate_parsetree.Ast_408.Asttypes.private_flag =
  1. | Private
  2. | Public
and mutable_flag = Migrate_parsetree.Ast_408.Asttypes.mutable_flag =
  1. | Immutable
  2. | Mutable
and virtual_flag = Migrate_parsetree.Ast_408.Asttypes.virtual_flag =
  1. | Virtual
  2. | Concrete
and override_flag = Migrate_parsetree.Ast_408.Asttypes.override_flag =
  1. | Override
  2. | Fresh
and closed_flag = Migrate_parsetree.Ast_408.Asttypes.closed_flag =
  1. | Closed
  2. | Open
and label = string
and arg_label = Migrate_parsetree.Ast_408.Asttypes.arg_label =
  1. | Nolabel
  2. | Labelled of string
  3. | Optional of string
and variance = Migrate_parsetree.Ast_408.Asttypes.variance =
  1. | Covariant
  2. | Contravariant
  3. | Invariant

Abstract syntax tree produced by parsing

and constant = Migrate_parsetree.Ast_408.Parsetree.constant =
  1. | Pconst_integer of string * char option
  2. | Pconst_char of char
  3. | Pconst_string of string * string option
  4. | Pconst_float of string * char option

Extension points

and attribute = Migrate_parsetree.Ast_408.Parsetree.attribute = {
  1. attr_name : string loc;
  2. attr_payload : payload;
  3. attr_loc : location;
}
and extension = string loc * payload
and attributes = attribute list
and payload = Migrate_parsetree.Ast_408.Parsetree.payload =
  1. | PStr of structure
  2. | PSig of signature
  3. | PTyp of core_type
  4. | PPat of pattern * expression option

Core language

and core_type = Migrate_parsetree.Ast_408.Parsetree.core_type = {
  1. ptyp_desc : core_type_desc;
  2. ptyp_loc : location;
  3. ptyp_loc_stack : location_stack;
  4. ptyp_attributes : attributes;
}
and core_type_desc = Migrate_parsetree.Ast_408.Parsetree.core_type_desc =
  1. | Ptyp_any
  2. | Ptyp_var of string
  3. | Ptyp_arrow of arg_label * core_type * core_type
  4. | Ptyp_tuple of core_type list
  5. | Ptyp_constr of longident_loc * core_type list
  6. | Ptyp_object of object_field list * closed_flag
  7. | Ptyp_class of longident_loc * core_type list
  8. | Ptyp_alias of core_type * string
  9. | Ptyp_variant of row_field list * closed_flag * label list option
  10. | Ptyp_poly of string loc list * core_type
  11. | Ptyp_package of package_type
  12. | Ptyp_extension of extension
and package_type = longident_loc * (longident_loc * core_type) list
and row_field = Migrate_parsetree.Ast_408.Parsetree.row_field = {
  1. prf_desc : row_field_desc;
  2. prf_loc : location;
  3. prf_attributes : attributes;
}
and row_field_desc = Migrate_parsetree.Ast_408.Parsetree.row_field_desc =
  1. | Rtag of label loc * bool * core_type list
  2. | Rinherit of core_type
and object_field = Migrate_parsetree.Ast_408.Parsetree.object_field = {
  1. pof_desc : object_field_desc;
  2. pof_loc : location;
  3. pof_attributes : attributes;
}
and object_field_desc = Migrate_parsetree.Ast_408.Parsetree.object_field_desc =
  1. | Otag of label loc * core_type
  2. | Oinherit of core_type
and pattern = Migrate_parsetree.Ast_408.Parsetree.pattern = {
  1. ppat_desc : pattern_desc;
  2. ppat_loc : location;
  3. ppat_loc_stack : location_stack;
  4. ppat_attributes : attributes;
}
and pattern_desc = Migrate_parsetree.Ast_408.Parsetree.pattern_desc =
  1. | Ppat_any
  2. | Ppat_var of string loc
  3. | Ppat_alias of pattern * string loc
  4. | Ppat_constant of constant
  5. | Ppat_interval of constant * constant
  6. | Ppat_tuple of pattern list
  7. | Ppat_construct of longident_loc * pattern option
  8. | Ppat_variant of label * pattern option
  9. | Ppat_record of (longident_loc * pattern) list * closed_flag
  10. | Ppat_array of pattern list
  11. | Ppat_or of pattern * pattern
  12. | Ppat_constraint of pattern * core_type
  13. | Ppat_type of longident_loc
  14. | Ppat_lazy of pattern
  15. | Ppat_unpack of string loc
  16. | Ppat_exception of pattern
  17. | Ppat_extension of extension
  18. | Ppat_open of longident_loc * pattern
and expression = Migrate_parsetree.Ast_408.Parsetree.expression = {
  1. pexp_desc : expression_desc;
  2. pexp_loc : location;
  3. pexp_loc_stack : location_stack;
  4. pexp_attributes : attributes;
}
and expression_desc = Migrate_parsetree.Ast_408.Parsetree.expression_desc =
  1. | Pexp_ident of longident_loc
  2. | Pexp_constant of constant
  3. | Pexp_let of rec_flag * value_binding list * expression
  4. | Pexp_function of case list
  5. | Pexp_fun of arg_label * expression option * pattern * expression
  6. | Pexp_apply of expression * (arg_label * expression) list
  7. | Pexp_match of expression * case list
  8. | Pexp_try of expression * case list
  9. | Pexp_tuple of expression list
  10. | Pexp_construct of longident_loc * expression option
  11. | Pexp_variant of label * expression option
  12. | Pexp_record of (longident_loc * expression) list * expression option
  13. | Pexp_field of expression * longident_loc
  14. | Pexp_setfield of expression * longident_loc * expression
  15. | Pexp_array of expression list
  16. | Pexp_ifthenelse of expression * expression * expression option
  17. | Pexp_sequence of expression * expression
  18. | Pexp_while of expression * expression
  19. | Pexp_for of pattern * expression * expression * direction_flag * expression
  20. | Pexp_constraint of expression * core_type
  21. | Pexp_coerce of expression * core_type option * core_type
  22. | Pexp_send of expression * label loc
  23. | Pexp_new of longident_loc
  24. | Pexp_setinstvar of label loc * expression
  25. | Pexp_override of (label loc * expression) list
  26. | Pexp_letmodule of string loc * module_expr * expression
  27. | Pexp_letexception of extension_constructor * expression
  28. | Pexp_assert of expression
  29. | Pexp_lazy of expression
  30. | Pexp_poly of expression * core_type option
  31. | Pexp_object of class_structure
  32. | Pexp_newtype of string loc * expression
  33. | Pexp_pack of module_expr
  34. | Pexp_open of open_declaration * expression
  35. | Pexp_letop of letop
  36. | Pexp_extension of extension
  37. | Pexp_unreachable
and case = Migrate_parsetree.Ast_408.Parsetree.case = {
  1. pc_lhs : pattern;
  2. pc_guard : expression option;
  3. pc_rhs : expression;
}
and binding_op = Migrate_parsetree.Ast_408.Parsetree.binding_op = {
  1. pbop_op : string loc;
  2. pbop_pat : pattern;
  3. pbop_exp : expression;
  4. pbop_loc : location;
}
and value_description = Migrate_parsetree.Ast_408.Parsetree.value_description = {
  1. pval_name : string loc;
  2. pval_type : core_type;
  3. pval_prim : string list;
  4. pval_attributes : attributes;
  5. pval_loc : location;
}
and type_declaration = Migrate_parsetree.Ast_408.Parsetree.type_declaration = {
  1. ptype_name : string loc;
  2. ptype_params : (core_type * variance) list;
  3. ptype_cstrs : (core_type * core_type * location) list;
  4. ptype_kind : type_kind;
  5. ptype_private : private_flag;
  6. ptype_manifest : core_type option;
  7. ptype_attributes : attributes;
  8. ptype_loc : location;
}
and type_kind = Migrate_parsetree.Ast_408.Parsetree.type_kind =
  1. | Ptype_abstract
  2. | Ptype_variant of constructor_declaration list
  3. | Ptype_record of label_declaration list
  4. | Ptype_open
and label_declaration = Migrate_parsetree.Ast_408.Parsetree.label_declaration = {
  1. pld_name : string loc;
  2. pld_mutable : mutable_flag;
  3. pld_type : core_type;
  4. pld_loc : location;
  5. pld_attributes : attributes;
}
and constructor_declaration = Migrate_parsetree.Ast_408.Parsetree.constructor_declaration = {
  1. pcd_name : string loc;
  2. pcd_args : constructor_arguments;
  3. pcd_res : core_type option;
  4. pcd_loc : location;
  5. pcd_attributes : attributes;
}
and constructor_arguments = Migrate_parsetree.Ast_408.Parsetree.constructor_arguments =
  1. | Pcstr_tuple of core_type list
  2. | Pcstr_record of label_declaration list
and type_extension = Migrate_parsetree.Ast_408.Parsetree.type_extension = {
  1. ptyext_path : longident_loc;
  2. ptyext_params : (core_type * variance) list;
  3. ptyext_constructors : extension_constructor list;
  4. ptyext_private : private_flag;
  5. ptyext_loc : location;
  6. ptyext_attributes : attributes;
}
and extension_constructor = Migrate_parsetree.Ast_408.Parsetree.extension_constructor = {
  1. pext_name : string loc;
  2. pext_kind : extension_constructor_kind;
  3. pext_loc : location;
  4. pext_attributes : attributes;
}
and type_exception = Migrate_parsetree.Ast_408.Parsetree.type_exception = {
  1. ptyexn_constructor : extension_constructor;
  2. ptyexn_loc : location;
  3. ptyexn_attributes : attributes;
}
and extension_constructor_kind = Migrate_parsetree.Ast_408.Parsetree.extension_constructor_kind =
  1. | Pext_decl of constructor_arguments * core_type option
  2. | Pext_rebind of longident_loc

Class language

and class_type = Migrate_parsetree.Ast_408.Parsetree.class_type = {
  1. pcty_desc : class_type_desc;
  2. pcty_loc : location;
  3. pcty_attributes : attributes;
}
and class_type_desc = Migrate_parsetree.Ast_408.Parsetree.class_type_desc =
  1. | Pcty_constr of longident_loc * core_type list
  2. | Pcty_signature of class_signature
  3. | Pcty_arrow of arg_label * core_type * class_type
  4. | Pcty_extension of extension
  5. | Pcty_open of open_description * class_type
and class_signature = Migrate_parsetree.Ast_408.Parsetree.class_signature = {
  1. pcsig_self : core_type;
  2. pcsig_fields : class_type_field list;
}
and class_type_field = Migrate_parsetree.Ast_408.Parsetree.class_type_field = {
  1. pctf_desc : class_type_field_desc;
  2. pctf_loc : location;
  3. pctf_attributes : attributes;
}
and class_type_field_desc = Migrate_parsetree.Ast_408.Parsetree.class_type_field_desc =
  1. | Pctf_inherit of class_type
  2. | Pctf_val of label loc * mutable_flag * virtual_flag * core_type
  3. | Pctf_method of label loc * private_flag * virtual_flag * core_type
  4. | Pctf_constraint of core_type * core_type
  5. | Pctf_attribute of attribute
  6. | Pctf_extension of extension
and 'a class_infos = 'a Migrate_parsetree.Ast_408.Parsetree.class_infos = {
  1. pci_virt : virtual_flag;
  2. pci_params : (core_type * variance) list;
  3. pci_name : string loc;
  4. pci_expr : 'a;
  5. pci_loc : location;
  6. pci_attributes : attributes;
}
and class_description = class_type class_infos
and class_type_declaration = class_type class_infos
and class_expr = Migrate_parsetree.Ast_408.Parsetree.class_expr = {
  1. pcl_desc : class_expr_desc;
  2. pcl_loc : location;
  3. pcl_attributes : attributes;
}
and class_expr_desc = Migrate_parsetree.Ast_408.Parsetree.class_expr_desc =
  1. | Pcl_constr of longident_loc * core_type list
  2. | Pcl_structure of class_structure
  3. | Pcl_fun of arg_label * expression option * pattern * class_expr
  4. | Pcl_apply of class_expr * (arg_label * expression) list
  5. | Pcl_let of rec_flag * value_binding list * class_expr
  6. | Pcl_constraint of class_expr * class_type
  7. | Pcl_extension of extension
  8. | Pcl_open of open_description * class_expr
and class_structure = Migrate_parsetree.Ast_408.Parsetree.class_structure = {
  1. pcstr_self : pattern;
  2. pcstr_fields : class_field list;
}
and class_field = Migrate_parsetree.Ast_408.Parsetree.class_field = {
  1. pcf_desc : class_field_desc;
  2. pcf_loc : location;
  3. pcf_attributes : attributes;
}
and class_field_desc = Migrate_parsetree.Ast_408.Parsetree.class_field_desc =
  1. | Pcf_inherit of override_flag * class_expr * string loc option
  2. | Pcf_val of label loc * mutable_flag * class_field_kind
  3. | Pcf_method of label loc * private_flag * class_field_kind
  4. | Pcf_constraint of core_type * core_type
  5. | Pcf_initializer of expression
  6. | Pcf_attribute of attribute
  7. | Pcf_extension of extension
and class_field_kind = Migrate_parsetree.Ast_408.Parsetree.class_field_kind =
  1. | Cfk_virtual of core_type
  2. | Cfk_concrete of override_flag * expression
and class_declaration = class_expr class_infos

Module language

and module_type = Migrate_parsetree.Ast_408.Parsetree.module_type = {
  1. pmty_desc : module_type_desc;
  2. pmty_loc : location;
  3. pmty_attributes : attributes;
}
and module_type_desc = Migrate_parsetree.Ast_408.Parsetree.module_type_desc =
  1. | Pmty_ident of longident_loc
  2. | Pmty_signature of signature
  3. | Pmty_functor of string loc * module_type option * module_type
  4. | Pmty_with of module_type * with_constraint list
  5. | Pmty_typeof of module_expr
  6. | Pmty_extension of extension
  7. | Pmty_alias of longident_loc
and signature = signature_item list
and signature_item_desc = Migrate_parsetree.Ast_408.Parsetree.signature_item_desc =
  1. | Psig_value of value_description
  2. | Psig_type of rec_flag * type_declaration list
  3. | Psig_typesubst of type_declaration list
  4. | Psig_typext of type_extension
  5. | Psig_exception of type_exception
  6. | Psig_module of module_declaration
  7. | Psig_modsubst of module_substitution
  8. | Psig_recmodule of module_declaration list
  9. | Psig_modtype of module_type_declaration
  10. | Psig_open of open_description
  11. | Psig_include of include_description
  12. | Psig_class of class_description list
  13. | Psig_class_type of class_type_declaration list
  14. | Psig_attribute of attribute
  15. | Psig_extension of extension * attributes
and module_declaration = Migrate_parsetree.Ast_408.Parsetree.module_declaration = {
  1. pmd_name : string loc;
  2. pmd_type : module_type;
  3. pmd_attributes : attributes;
  4. pmd_loc : location;
}
and module_substitution = Migrate_parsetree.Ast_408.Parsetree.module_substitution = {
  1. pms_name : string loc;
  2. pms_manifest : longident_loc;
  3. pms_attributes : attributes;
  4. pms_loc : location;
}
and module_type_declaration = Migrate_parsetree.Ast_408.Parsetree.module_type_declaration = {
  1. pmtd_name : string loc;
  2. pmtd_type : module_type option;
  3. pmtd_attributes : attributes;
  4. pmtd_loc : location;
}
and 'a open_infos = 'a Migrate_parsetree.Ast_408.Parsetree.open_infos = {
  1. popen_expr : 'a;
  2. popen_override : override_flag;
  3. popen_loc : location;
  4. popen_attributes : attributes;
}
and open_description = longident_loc open_infos
and open_declaration = module_expr open_infos
and 'a include_infos = 'a Migrate_parsetree.Ast_408.Parsetree.include_infos = {
  1. pincl_mod : 'a;
  2. pincl_loc : location;
  3. pincl_attributes : attributes;
}
and include_description = module_type include_infos
and include_declaration = module_expr include_infos
and with_constraint = Migrate_parsetree.Ast_408.Parsetree.with_constraint =
  1. | Pwith_type of longident_loc * type_declaration
  2. | Pwith_module of longident_loc * longident_loc
  3. | Pwith_typesubst of longident_loc * type_declaration
  4. | Pwith_modsubst of longident_loc * longident_loc
and module_expr = Migrate_parsetree.Ast_408.Parsetree.module_expr = {
  1. pmod_desc : module_expr_desc;
  2. pmod_loc : location;
  3. pmod_attributes : attributes;
}
and module_expr_desc = Migrate_parsetree.Ast_408.Parsetree.module_expr_desc =
  1. | Pmod_ident of longident_loc
  2. | Pmod_structure of structure
  3. | Pmod_functor of string loc * module_type option * module_expr
  4. | Pmod_apply of module_expr * module_expr
  5. | Pmod_constraint of module_expr * module_type
  6. | Pmod_unpack of expression
  7. | Pmod_extension of extension
and structure = structure_item list
and structure_item_desc = Migrate_parsetree.Ast_408.Parsetree.structure_item_desc =
  1. | Pstr_eval of expression * attributes
  2. | Pstr_value of rec_flag * value_binding list
  3. | Pstr_primitive of value_description
  4. | Pstr_type of rec_flag * type_declaration list
  5. | Pstr_typext of type_extension
  6. | Pstr_exception of type_exception
  7. | Pstr_module of module_binding
  8. | Pstr_recmodule of module_binding list
  9. | Pstr_modtype of module_type_declaration
  10. | Pstr_open of open_declaration
  11. | Pstr_class of class_declaration list
  12. | Pstr_class_type of class_type_declaration list
  13. | Pstr_include of include_declaration
  14. | Pstr_attribute of attribute
  15. | Pstr_extension of extension * attributes
and value_binding = Migrate_parsetree.Ast_408.Parsetree.value_binding = {
  1. pvb_pat : pattern;
  2. pvb_expr : expression;
  3. pvb_attributes : attributes;
  4. pvb_loc : location;
}
and module_binding = Migrate_parsetree.Ast_408.Parsetree.module_binding = {
  1. pmb_name : string loc;
  2. pmb_expr : module_expr;
  3. pmb_attributes : attributes;
  4. pmb_loc : location;
}

Toplevel

and toplevel_phrase = Migrate_parsetree.Ast_408.Parsetree.toplevel_phrase =
  1. | Ptop_def of structure
  2. | Ptop_dir of toplevel_directive
and toplevel_directive = Migrate_parsetree.Ast_408.Parsetree.toplevel_directive = {
  1. pdir_name : string loc;
  2. pdir_arg : directive_argument option;
  3. pdir_loc : location;
}
and directive_argument = Migrate_parsetree.Ast_408.Parsetree.directive_argument = {
  1. pdira_desc : directive_argument_desc;
  2. pdira_loc : location;
}
and directive_argument_desc = Migrate_parsetree.Ast_408.Parsetree.directive_argument_desc =
  1. | Pdir_string of string
  2. | Pdir_int of string * char option
  3. | Pdir_ident of longident
  4. | Pdir_bool of bool
class virtual map : object ... end
class virtual iter : object ... end
class virtual 'acc fold : object ... end
class virtual 'acc fold_map : object ... end
class virtual 'ctx map_with_context : object ... end
class virtual 'res lift : object ... end
module Ast_builder : sig ... end

Helpers for build OCaml AST fragments

module Ast_pattern : sig ... end

First class AST patterns

module Ast_traverse : sig ... end

AST traversal classes

module Attribute : sig ... end

Attribute hygiene

module Code_path : sig ... end
module Caller_id : sig ... end
module Context_free : sig ... end

Context free rewriting

module Deriving : sig ... end

Deriving code from type declarations

module Driver : sig ... end
module Expansion_context : sig ... end
module Extension : sig ... end
module File_path : sig ... end

Return the path used as root in a file

module Loc : sig ... end

Located items

module Location : sig ... end

Overrides the Location module of OCaml

module Longident : sig ... end

Overrides the Longident module of OCaml

module Merlin_helpers : sig ... end

Some helpers to annotate the AST so merlin can decide which branches to look at and which branches to ignore.

module Reserved_namespaces : sig ... end
module Spellcheck : sig ... end
val lident : Base.String.t -> Longident.t
val gen_symbol : ?prefix:Base.String.t -> Base.Unit.t -> Base.String.t

gen_symbol ?prefix () generates a fresh variable name with prefix.

  • parameter prefix

    default = "_x"

val assert_no_attributes_in : Ast_traverse.iter

get_tparam_id tp

  • returns

    the string identifier associated with tp if it is a type parameter.

(new type_is_recursive rec_flag tds)#go () returns whether rec_flag, tds is really a recursive type. We disregard recursive occurrences appearing in arrow types. You can override the search for certain type expressions by inheriting from this class.

really_recursive rec_flag tds = (new type_is_recursive rec_flag tds)#go ()

convert multi-arg function applications into a cascade of 1-arg applications

Encode a warning message into an 'ocaml.ppwarning' attribute which can be inserted in a generated Parsetree. The compiler will be responsible for reporting the warning.

val is_polymorphic_variant : Migrate_parsetree.Ast_408.Parsetree.type_declaration -> sig_:Base.Bool.t -> [> `Definitely | `Maybe | `Surely_not ]

mk_named_sig ~loc ~sg_name:"Foo" ~handle_polymorphic_variant tds will generate

include Foo (* or Foo1, Foo2, Foo3 *)
  with type (* ('a, 'b, 'c) *) t := (* ('a, 'b, 'c) *) t

when:

  • there is only one type declaration
  • the type is named t
  • there are less than 4 type parameters
  • there are no constraints on the type parameters

It will take care of giving fresh names to unnamed type parameters.

OCaml

Innovation. Community. Security.