package ppxlib

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

Module PpxlibSource

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 Parsetree := Ocaml_shadow.Parsetree with module Pprintast := Ocaml_shadow.Pprintast with module Syntaxerr := Ocaml_shadow.Syntaxerr
Sourcemodule Do_not_use_directly = Ocaml_shadow.Do_not_use_directly
Sourcemodule Afl_instrument = Ocaml_shadow.Afl_instrument
Sourcemodule Alias_analysis = Ocaml_shadow.Alias_analysis
Sourcemodule Allocated_const = Ocaml_shadow.Allocated_const
Sourcemodule Arg_helper = Ocaml_shadow.Arg_helper
Sourcemodule Asmlibrarian = Ocaml_shadow.Asmlibrarian
Sourcemodule Asmpackager = Ocaml_shadow.Asmpackager
Sourcemodule Ast_invariants = Ocaml_shadow.Ast_invariants
Sourcemodule Ast_iterator = Ocaml_shadow.Ast_iterator
Sourcemodule Ast_mapper = Ocaml_shadow.Ast_mapper
Sourcemodule Attr_helper = Ocaml_shadow.Attr_helper
Sourcemodule Augment_specialised_args = Ocaml_shadow.Augment_specialised_args
Sourcemodule Backend_intf = Ocaml_shadow.Backend_intf
Sourcemodule Backend_var = Ocaml_shadow.Backend_var
Sourcemodule Binutils = Ocaml_shadow.Binutils
Sourcemodule Branch_relaxation = Ocaml_shadow.Branch_relaxation
Sourcemodule Branch_relaxation_intf = Ocaml_shadow.Branch_relaxation_intf
Sourcemodule Build_export_info = Ocaml_shadow.Build_export_info
Sourcemodule Build_path_prefix_map = Ocaml_shadow.Build_path_prefix_map
Sourcemodule Builtin_attributes = Ocaml_shadow.Builtin_attributes
Sourcemodule Bytelibrarian = Ocaml_shadow.Bytelibrarian
Sourcemodule Bytepackager = Ocaml_shadow.Bytepackager
Sourcemodule Bytesections = Ocaml_shadow.Bytesections
Sourcemodule CamlinternalMenhirLib = Ocaml_shadow.CamlinternalMenhirLib
Sourcemodule Clambda_primitives = Ocaml_shadow.Clambda_primitives
Sourcemodule Closure_conversion = Ocaml_shadow.Closure_conversion
Sourcemodule Closure_conversion_aux = Ocaml_shadow.Closure_conversion_aux
Sourcemodule Closure_element = Ocaml_shadow.Closure_element
Sourcemodule Closure_id = Ocaml_shadow.Closure_id
Sourcemodule Closure_middle_end = Ocaml_shadow.Closure_middle_end
Sourcemodule Closure_offsets = Ocaml_shadow.Closure_offsets
Sourcemodule Closure_origin = Ocaml_shadow.Closure_origin
Sourcemodule Cmi_format = Ocaml_shadow.Cmi_format
Sourcemodule Cmm_helpers = Ocaml_shadow.Cmm_helpers
Sourcemodule Cmm_invariants = Ocaml_shadow.Cmm_invariants
Sourcemodule Cmmgen_state = Ocaml_shadow.Cmmgen_state
Sourcemodule Cmo_format = Ocaml_shadow.Cmo_format
Sourcemodule Cmt2annot = Ocaml_shadow.Cmt2annot
Sourcemodule Cmt_format = Ocaml_shadow.Cmt_format
Sourcemodule Cmx_format = Ocaml_shadow.Cmx_format
Sourcemodule Cmxs_format = Ocaml_shadow.Cmxs_format
Sourcemodule Coloring = Ocaml_shadow.Coloring
Sourcemodule Comballoc = Ocaml_shadow.Comballoc
Sourcemodule Compilation_unit = Ocaml_shadow.Compilation_unit
Sourcemodule Compile_common = Ocaml_shadow.Compile_common
Sourcemodule Compilenv = Ocaml_shadow.Compilenv
Sourcemodule Compmisc = Ocaml_shadow.Compmisc
Sourcemodule Config_boot = Ocaml_shadow.Config_boot
Sourcemodule Config_main = Ocaml_shadow.Config_main
Sourcemodule Consistbl = Ocaml_shadow.Consistbl
Sourcemodule Convert_primitives = Ocaml_shadow.Convert_primitives
Sourcemodule Dataflow = Ocaml_shadow.Dataflow
Sourcemodule Datarepr = Ocaml_shadow.Datarepr
Sourcemodule Deadcode = Ocaml_shadow.Deadcode
Sourcemodule Debuginfo = Ocaml_shadow.Debuginfo
Sourcemodule Diffing_with_keys = Ocaml_shadow.Diffing_with_keys
Sourcemodule Domainstate = Ocaml_shadow.Domainstate
Sourcemodule Effect_analysis = Ocaml_shadow.Effect_analysis
Sourcemodule Emitcode = Ocaml_shadow.Emitcode
Sourcemodule Errortrace = Ocaml_shadow.Errortrace
Sourcemodule Export_id = Ocaml_shadow.Export_id
Sourcemodule Export_info = Ocaml_shadow.Export_info
Sourcemodule Export_info_for_pack = Ocaml_shadow.Export_info_for_pack
Sourcemodule Extract_projections = Ocaml_shadow.Extract_projections
Sourcemodule Find_recursive_functions = Ocaml_shadow.Find_recursive_functions
Sourcemodule Flambda_invariants = Ocaml_shadow.Flambda_invariants
Sourcemodule Flambda_iterators = Ocaml_shadow.Flambda_iterators
Sourcemodule Flambda_middle_end = Ocaml_shadow.Flambda_middle_end
Sourcemodule Flambda_to_clambda = Ocaml_shadow.Flambda_to_clambda
Sourcemodule Flambda_utils = Ocaml_shadow.Flambda_utils
Sourcemodule Freshening = Ocaml_shadow.Freshening
Sourcemodule Genprintval = Ocaml_shadow.Genprintval
Sourcemodule Id_types = Ocaml_shadow.Id_types
Sourcemodule Import_approx = Ocaml_shadow.Import_approx
Sourcemodule Includeclass = Ocaml_shadow.Includeclass
Sourcemodule Includecore = Ocaml_shadow.Includecore
Sourcemodule Includemod = Ocaml_shadow.Includemod
Sourcemodule Includemod_errorprinter = Ocaml_shadow.Includemod_errorprinter
Sourcemodule Inconstant_idents = Ocaml_shadow.Inconstant_idents
Sourcemodule Initialize_symbol_to_let_symbol = Ocaml_shadow.Initialize_symbol_to_let_symbol
Sourcemodule Inline_and_simplify = Ocaml_shadow.Inline_and_simplify
Sourcemodule Inline_and_simplify_aux = Ocaml_shadow.Inline_and_simplify_aux
Sourcemodule Inlining_cost = Ocaml_shadow.Inlining_cost
Sourcemodule Inlining_decision = Ocaml_shadow.Inlining_decision
Sourcemodule Inlining_decision_intf = Ocaml_shadow.Inlining_decision_intf
Sourcemodule Inlining_stats = Ocaml_shadow.Inlining_stats
Sourcemodule Inlining_stats_types = Ocaml_shadow.Inlining_stats_types
Sourcemodule Inlining_transforms = Ocaml_shadow.Inlining_transforms
Sourcemodule Instruct = Ocaml_shadow.Instruct
Sourcemodule Int_replace_polymorphic_compare = Ocaml_shadow.Int_replace_polymorphic_compare
Sourcemodule Internal_variable_names = Ocaml_shadow.Internal_variable_names
Sourcemodule Interval = Ocaml_shadow.Interval
Sourcemodule Invariant_params = Ocaml_shadow.Invariant_params
Sourcemodule Lazy_backtrack = Ocaml_shadow.Lazy_backtrack
Sourcemodule Lift_code = Ocaml_shadow.Lift_code
Sourcemodule Lift_constants = Ocaml_shadow.Lift_constants
Sourcemodule Lift_let_to_initialize_symbol = Ocaml_shadow.Lift_let_to_initialize_symbol
Sourcemodule Linear_format = Ocaml_shadow.Linear_format
Sourcemodule Linearize = Ocaml_shadow.Linearize
Sourcemodule Linkage_name = Ocaml_shadow.Linkage_name
Sourcemodule Liveness = Ocaml_shadow.Liveness
Sourcemodule Load_path = Ocaml_shadow.Load_path
Sourcemodule Local_store = Ocaml_shadow.Local_store
Sourcemodule Main_args = Ocaml_shadow.Main_args
Sourcemodule Maindriver = Ocaml_shadow.Maindriver
Sourcemodule Makedepend = Ocaml_shadow.Makedepend
Sourcemodule Matching = Ocaml_shadow.Matching
Sourcemodule Mutable_variable = Ocaml_shadow.Mutable_variable
Sourcemodule Optcompile = Ocaml_shadow.Optcompile
Sourcemodule Opterrors = Ocaml_shadow.Opterrors
Sourcemodule Optmaindriver = Ocaml_shadow.Optmaindriver
Sourcemodule Outcometree = Ocaml_shadow.Outcometree
Sourcemodule Parameter = Ocaml_shadow.Parameter
Sourcemodule Parmatch = Ocaml_shadow.Parmatch
Sourcemodule Pass_wrapper = Ocaml_shadow.Pass_wrapper
Sourcemodule Patterns = Ocaml_shadow.Patterns
Sourcemodule Persistent_env = Ocaml_shadow.Persistent_env
Sourcemodule Primitive = Ocaml_shadow.Primitive
Sourcemodule Printast = Ocaml_shadow.Printast
Sourcemodule Printclambda = Ocaml_shadow.Printclambda
Sourcemodule Printclambda_primitives = Ocaml_shadow.Printclambda_primitives
Sourcemodule Printcmm = Ocaml_shadow.Printcmm
Sourcemodule Printinstr = Ocaml_shadow.Printinstr
Sourcemodule Printlambda = Ocaml_shadow.Printlambda
Sourcemodule Printlinear = Ocaml_shadow.Printlinear
Sourcemodule Printmach = Ocaml_shadow.Printmach
Sourcemodule Printpat = Ocaml_shadow.Printpat
Sourcemodule Printtyp = Ocaml_shadow.Printtyp
Sourcemodule Printtyped = Ocaml_shadow.Printtyped
Sourcemodule Projection = Ocaml_shadow.Projection
Sourcemodule Rec_check = Ocaml_shadow.Rec_check
Sourcemodule Ref_to_variables = Ocaml_shadow.Ref_to_variables
Sourcemodule Reloadgen = Ocaml_shadow.Reloadgen
Sourcemodule Remove_free_vars_equal_to_args = Ocaml_shadow.Remove_free_vars_equal_to_args
Sourcemodule Remove_unused_arguments = Ocaml_shadow.Remove_unused_arguments
Sourcemodule Remove_unused_closure_vars = Ocaml_shadow.Remove_unused_closure_vars
Sourcemodule Remove_unused_program_constructs = Ocaml_shadow.Remove_unused_program_constructs
Sourcemodule Runtimedef = Ocaml_shadow.Runtimedef
Sourcemodule Schedgen = Ocaml_shadow.Schedgen
Sourcemodule Scheduling = Ocaml_shadow.Scheduling
Sourcemodule Selectgen = Ocaml_shadow.Selectgen
Sourcemodule Selection = Ocaml_shadow.Selection
Sourcemodule Semantics_of_primitives = Ocaml_shadow.Semantics_of_primitives
Sourcemodule Set_of_closures_id = Ocaml_shadow.Set_of_closures_id
Sourcemodule Set_of_closures_origin = Ocaml_shadow.Set_of_closures_origin
Sourcemodule Share_constants = Ocaml_shadow.Share_constants
Sourcemodule Signature_group = Ocaml_shadow.Signature_group
Sourcemodule Simple_value_approx = Ocaml_shadow.Simple_value_approx
Sourcemodule Simplify_boxed_integer_ops = Ocaml_shadow.Simplify_boxed_integer_ops
Sourcemodule Simplify_boxed_integer_ops_intf = Ocaml_shadow.Simplify_boxed_integer_ops_intf
Sourcemodule Simplify_common = Ocaml_shadow.Simplify_common
Sourcemodule Simplify_primitives = Ocaml_shadow.Simplify_primitives
Sourcemodule Static_exception = Ocaml_shadow.Static_exception
Sourcemodule Strmatch = Ocaml_shadow.Strmatch
Sourcemodule Strongly_connected_components = Ocaml_shadow.Strongly_connected_components
Sourcemodule Symtable = Ocaml_shadow.Symtable
Sourcemodule Targetint = Ocaml_shadow.Targetint
Sourcemodule Tast_iterator = Ocaml_shadow.Tast_iterator
Sourcemodule Tast_mapper = Ocaml_shadow.Tast_mapper
Sourcemodule Terminfo = Ocaml_shadow.Terminfo
Sourcemodule Topcommon = Ocaml_shadow.Topcommon
Sourcemodule Tophooks = Ocaml_shadow.Tophooks
Sourcemodule Topstart = Ocaml_shadow.Topstart
Sourcemodule Translattribute = Ocaml_shadow.Translattribute
Sourcemodule Translclass = Ocaml_shadow.Translclass
Sourcemodule Translcore = Ocaml_shadow.Translcore
Sourcemodule Translmod = Ocaml_shadow.Translmod
Sourcemodule Translobj = Ocaml_shadow.Translobj
Sourcemodule Translprim = Ocaml_shadow.Translprim
Sourcemodule Traverse_for_exported_symbols = Ocaml_shadow.Traverse_for_exported_symbols
Sourcemodule Type_immediacy = Ocaml_shadow.Type_immediacy
Sourcemodule Typeclass = Ocaml_shadow.Typeclass
Sourcemodule Typecore = Ocaml_shadow.Typecore
Sourcemodule Typedecl = Ocaml_shadow.Typedecl
Sourcemodule Typedecl_immediacy = Ocaml_shadow.Typedecl_immediacy
Sourcemodule Typedecl_properties = Ocaml_shadow.Typedecl_properties
Sourcemodule Typedecl_separability = Ocaml_shadow.Typedecl_separability
Sourcemodule Typedecl_unboxed = Ocaml_shadow.Typedecl_unboxed
Sourcemodule Typedecl_variance = Ocaml_shadow.Typedecl_variance
Sourcemodule Typedtree = Ocaml_shadow.Typedtree
Sourcemodule Typetexp = Ocaml_shadow.Typetexp
Sourcemodule Unbox_closures = Ocaml_shadow.Unbox_closures
Sourcemodule Unbox_free_vars_of_closures = Ocaml_shadow.Unbox_free_vars_of_closures
Sourcemodule Unbox_specialised_args = Ocaml_shadow.Unbox_specialised_args
Sourcemodule Untypeast = Ocaml_shadow.Untypeast
Sourcemodule Var_within_closure = Ocaml_shadow.Var_within_closure
Sourcemodule Variable = Ocaml_shadow.Variable
Sourcemodule Warnings = Ocaml_shadow.Warnings
Sourcemodule X86_masm = Ocaml_shadow.X86_masm
Sourcemodule X86_proc = Ocaml_shadow.X86_proc

Expose some modules from Ppxlib_ast; in particular, overwrite some of the modules above

Sourcemodule Ast_helper = Ppxlib_ast.Ast_helper
Sourcemodule Asttypes = Ppxlib_ast.Asttypes
Sourcemodule Parse = Ppxlib_ast.Parse
Sourcemodule Parsetree = Ppxlib_ast.Parsetree
Sourcemodule Pprintast = Ppxlib_ast.Pprintast
Sourcemodule Selected_ast = Ppxlib_ast.Selected_ast

Include all the Ast definitions since we need them in every single ppx

include module type of struct include Ast end
Sourcetype position = Lexing.position = {
  1. pos_fname : string;
  2. pos_lnum : int;
  3. pos_bol : int;
  4. pos_cnum : int;
}
Sourceand location = Astlib.Location.t = {
  1. loc_start : position;
  2. loc_end : position;
  3. loc_ghost : bool;
}
Sourceand location_stack = location list
Sourceand 'a loc = 'a Astlib.Location.loc = {
  1. txt : 'a;
  2. loc : location;
}
Sourceand longident = Astlib.Longident.t =
  1. | Lident of string
  2. | Ldot of longident * string
  3. | Lapply of longident * longident
Sourceand longident_loc = longident loc

Auxiliary AST types used by parsetree and typedtree.

Sourceand rec_flag = Astlib.Ast_412.Asttypes.rec_flag =
  1. | Nonrecursive
  2. | Recursive
Sourceand direction_flag = Astlib.Ast_412.Asttypes.direction_flag =
  1. | Upto
  2. | Downto
Sourceand private_flag = Astlib.Ast_412.Asttypes.private_flag =
  1. | Private
  2. | Public
Sourceand mutable_flag = Astlib.Ast_412.Asttypes.mutable_flag =
  1. | Immutable
  2. | Mutable
Sourceand virtual_flag = Astlib.Ast_412.Asttypes.virtual_flag =
  1. | Virtual
  2. | Concrete
Sourceand override_flag = Astlib.Ast_412.Asttypes.override_flag =
  1. | Override
  2. | Fresh
Sourceand closed_flag = Astlib.Ast_412.Asttypes.closed_flag =
  1. | Closed
  2. | Open
Sourceand label = string
Sourceand arg_label = Astlib.Ast_412.Asttypes.arg_label =
  1. | Nolabel
  2. | Labelled of string
  3. | Optional of string
Sourceand variance = Astlib.Ast_412.Asttypes.variance =
  1. | Covariant
  2. | Contravariant
  3. | NoVariance
Sourceand injectivity = Astlib.Ast_412.Asttypes.injectivity =
  1. | Injective
  2. | NoInjectivity

Abstract syntax tree produced by parsing

Sourceand constant = Astlib.Ast_412.Parsetree.constant =
  1. | Pconst_integer of string * char option
  2. | Pconst_char of char
  3. | Pconst_string of string * location * string option
  4. | Pconst_float of string * char option

Extension points

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

Core language

Sourceand core_type = Astlib.Ast_412.Parsetree.core_type = {
  1. ptyp_desc : core_type_desc;
  2. ptyp_loc : location;
  3. ptyp_loc_stack : location_stack;
  4. ptyp_attributes : attributes;
}
Sourceand core_type_desc = Astlib.Ast_412.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
Sourceand package_type = longident_loc * (longident_loc * core_type) list
Sourceand row_field = Astlib.Ast_412.Parsetree.row_field = {
  1. prf_desc : row_field_desc;
  2. prf_loc : location;
  3. prf_attributes : attributes;
}
Sourceand row_field_desc = Astlib.Ast_412.Parsetree.row_field_desc =
  1. | Rtag of label loc * bool * core_type list
  2. | Rinherit of core_type
Sourceand object_field = Astlib.Ast_412.Parsetree.object_field = {
  1. pof_desc : object_field_desc;
  2. pof_loc : location;
  3. pof_attributes : attributes;
}
Sourceand object_field_desc = Astlib.Ast_412.Parsetree.object_field_desc =
  1. | Otag of label loc * core_type
  2. | Oinherit of core_type
Sourceand pattern = Astlib.Ast_412.Parsetree.pattern = {
  1. ppat_desc : pattern_desc;
  2. ppat_loc : location;
  3. ppat_loc_stack : location_stack;
  4. ppat_attributes : attributes;
}
Sourceand pattern_desc = Astlib.Ast_412.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 option loc
  16. | Ppat_exception of pattern
  17. | Ppat_extension of extension
  18. | Ppat_open of longident_loc * pattern
Sourceand expression = Astlib.Ast_412.Parsetree.expression = {
  1. pexp_desc : expression_desc;
  2. pexp_loc : location;
  3. pexp_loc_stack : location_stack;
  4. pexp_attributes : attributes;
}
Sourceand expression_desc = Astlib.Ast_412.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 cases
  5. | Pexp_fun of arg_label * expression option * pattern * expression
  6. | Pexp_apply of expression * (arg_label * expression) list
  7. | Pexp_match of expression * cases
  8. | Pexp_try of expression * cases
  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 option 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
Sourceand case = Astlib.Ast_412.Parsetree.case = {
  1. pc_lhs : pattern;
  2. pc_guard : expression option;
  3. pc_rhs : expression;
}
Sourceand letop = Astlib.Ast_412.Parsetree.letop = {
  1. let_ : binding_op;
  2. ands : binding_op list;
  3. body : expression;
}
Sourceand binding_op = Astlib.Ast_412.Parsetree.binding_op = {
  1. pbop_op : string loc;
  2. pbop_pat : pattern;
  3. pbop_exp : expression;
  4. pbop_loc : location;
}
Sourceand value_description = Astlib.Ast_412.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;
}
Sourceand type_declaration = Astlib.Ast_412.Parsetree.type_declaration = {
  1. ptype_name : string loc;
  2. ptype_params : (core_type * (variance * injectivity)) 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;
}
Sourceand type_kind = Astlib.Ast_412.Parsetree.type_kind =
  1. | Ptype_abstract
  2. | Ptype_variant of constructor_declaration list
  3. | Ptype_record of label_declaration list
  4. | Ptype_open
Sourceand label_declaration = Astlib.Ast_412.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;
}
Sourceand constructor_declaration = Astlib.Ast_412.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;
}
Sourceand constructor_arguments = Astlib.Ast_412.Parsetree.constructor_arguments =
  1. | Pcstr_tuple of core_type list
  2. | Pcstr_record of label_declaration list
Sourceand type_extension = Astlib.Ast_412.Parsetree.type_extension = {
  1. ptyext_path : longident_loc;
  2. ptyext_params : (core_type * (variance * injectivity)) list;
  3. ptyext_constructors : extension_constructor list;
  4. ptyext_private : private_flag;
  5. ptyext_loc : location;
  6. ptyext_attributes : attributes;
}
Sourceand extension_constructor = Astlib.Ast_412.Parsetree.extension_constructor = {
  1. pext_name : string loc;
  2. pext_kind : extension_constructor_kind;
  3. pext_loc : location;
  4. pext_attributes : attributes;
}
Sourceand type_exception = Astlib.Ast_412.Parsetree.type_exception = {
  1. ptyexn_constructor : extension_constructor;
  2. ptyexn_loc : location;
  3. ptyexn_attributes : attributes;
}
Sourceand extension_constructor_kind = Astlib.Ast_412.Parsetree.extension_constructor_kind =
  1. | Pext_decl of constructor_arguments * core_type option
  2. | Pext_rebind of longident_loc

Class language

Sourceand class_type = Astlib.Ast_412.Parsetree.class_type = {
  1. pcty_desc : class_type_desc;
  2. pcty_loc : location;
  3. pcty_attributes : attributes;
}
Sourceand class_type_desc = Astlib.Ast_412.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
Sourceand class_signature = Astlib.Ast_412.Parsetree.class_signature = {
  1. pcsig_self : core_type;
  2. pcsig_fields : class_type_field list;
}
Sourceand class_type_field = Astlib.Ast_412.Parsetree.class_type_field = {
  1. pctf_desc : class_type_field_desc;
  2. pctf_loc : location;
  3. pctf_attributes : attributes;
}
Sourceand class_type_field_desc = Astlib.Ast_412.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
Sourceand 'a class_infos = 'a Astlib.Ast_412.Parsetree.class_infos = {
  1. pci_virt : virtual_flag;
  2. pci_params : (core_type * (variance * injectivity)) list;
  3. pci_name : string loc;
  4. pci_expr : 'a;
  5. pci_loc : location;
  6. pci_attributes : attributes;
}
Sourceand class_description = class_type class_infos
Sourceand class_type_declaration = class_type class_infos
Sourceand class_expr = Astlib.Ast_412.Parsetree.class_expr = {
  1. pcl_desc : class_expr_desc;
  2. pcl_loc : location;
  3. pcl_attributes : attributes;
}
Sourceand class_expr_desc = Astlib.Ast_412.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
Sourceand class_structure = Astlib.Ast_412.Parsetree.class_structure = {
  1. pcstr_self : pattern;
  2. pcstr_fields : class_field list;
}
Sourceand class_field = Astlib.Ast_412.Parsetree.class_field = {
  1. pcf_desc : class_field_desc;
  2. pcf_loc : location;
  3. pcf_attributes : attributes;
}
Sourceand class_field_desc = Astlib.Ast_412.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
Sourceand class_field_kind = Astlib.Ast_412.Parsetree.class_field_kind =
  1. | Cfk_virtual of core_type
  2. | Cfk_concrete of override_flag * expression
Sourceand class_declaration = class_expr class_infos

Module language

Sourceand module_type = Astlib.Ast_412.Parsetree.module_type = {
  1. pmty_desc : module_type_desc;
  2. pmty_loc : location;
  3. pmty_attributes : attributes;
}
Sourceand module_type_desc = Astlib.Ast_412.Parsetree.module_type_desc =
  1. | Pmty_ident of longident_loc
  2. | Pmty_signature of signature
  3. | Pmty_functor of functor_parameter * 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
Sourceand functor_parameter = Astlib.Ast_412.Parsetree.functor_parameter =
  1. | Unit
  2. | Named of string option loc * module_type
Sourceand signature = signature_item list
Sourceand signature_item = Astlib.Ast_412.Parsetree.signature_item = {
  1. psig_desc : signature_item_desc;
  2. psig_loc : location;
}
Sourceand signature_item_desc = Astlib.Ast_412.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
Sourceand module_declaration = Astlib.Ast_412.Parsetree.module_declaration = {
  1. pmd_name : string option loc;
  2. pmd_type : module_type;
  3. pmd_attributes : attributes;
  4. pmd_loc : location;
}
Sourceand module_substitution = Astlib.Ast_412.Parsetree.module_substitution = {
  1. pms_name : string loc;
  2. pms_manifest : longident_loc;
  3. pms_attributes : attributes;
  4. pms_loc : location;
}
Sourceand module_type_declaration = Astlib.Ast_412.Parsetree.module_type_declaration = {
  1. pmtd_name : string loc;
  2. pmtd_type : module_type option;
  3. pmtd_attributes : attributes;
  4. pmtd_loc : location;
}
Sourceand 'a open_infos = 'a Astlib.Ast_412.Parsetree.open_infos = {
  1. popen_expr : 'a;
  2. popen_override : override_flag;
  3. popen_loc : location;
  4. popen_attributes : attributes;
}
Sourceand open_description = longident_loc open_infos
Sourceand open_declaration = module_expr open_infos
Sourceand 'a include_infos = 'a Astlib.Ast_412.Parsetree.include_infos = {
  1. pincl_mod : 'a;
  2. pincl_loc : location;
  3. pincl_attributes : attributes;
}
Sourceand include_description = module_type include_infos
Sourceand include_declaration = module_expr include_infos
Sourceand with_constraint = Astlib.Ast_412.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
Sourceand module_expr = Astlib.Ast_412.Parsetree.module_expr = {
  1. pmod_desc : module_expr_desc;
  2. pmod_loc : location;
  3. pmod_attributes : attributes;
}
Sourceand module_expr_desc = Astlib.Ast_412.Parsetree.module_expr_desc =
  1. | Pmod_ident of longident_loc
  2. | Pmod_structure of structure
  3. | Pmod_functor of functor_parameter * 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
Sourceand structure = structure_item list
Sourceand structure_item = Astlib.Ast_412.Parsetree.structure_item = {
  1. pstr_desc : structure_item_desc;
  2. pstr_loc : location;
}
Sourceand structure_item_desc = Astlib.Ast_412.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
Sourceand value_binding = Astlib.Ast_412.Parsetree.value_binding = {
  1. pvb_pat : pattern;
  2. pvb_expr : expression;
  3. pvb_attributes : attributes;
  4. pvb_loc : location;
}
Sourceand module_binding = Astlib.Ast_412.Parsetree.module_binding = {
  1. pmb_name : string option loc;
  2. pmb_expr : module_expr;
  3. pmb_attributes : attributes;
  4. pmb_loc : location;
}

Toplevel

Sourceand toplevel_phrase = Astlib.Ast_412.Parsetree.toplevel_phrase =
  1. | Ptop_def of structure
  2. | Ptop_dir of toplevel_directive
Sourceand toplevel_directive = Astlib.Ast_412.Parsetree.toplevel_directive = {
  1. pdir_name : string loc;
  2. pdir_arg : directive_argument option;
  3. pdir_loc : location;
}
Sourceand directive_argument = Astlib.Ast_412.Parsetree.directive_argument = {
  1. pdira_desc : directive_argument_desc;
  2. pdira_loc : location;
}
Sourceand directive_argument_desc = Astlib.Ast_412.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
Sourceand cases = case list
Sourceclass virtual map : object ... end
Sourceclass virtual iter : object ... end
Sourceclass virtual 'acc fold : object ... end
Sourceclass virtual 'acc fold_map : object ... end
Sourceclass virtual 'ctx map_with_context : object ... end
Sourceclass virtual 'res lift : object ... end
Sourcemodule Ast_builder : sig ... end

Helpers for build OCaml AST fragments

Sourcemodule Ast_pattern : sig ... end

First class AST patterns

Sourcemodule Ast_traverse : sig ... end

AST traversal classes

Sourcemodule Attribute : sig ... end

Attribute hygiene

Sourcemodule Code_path : sig ... end
Sourcemodule Caller_id : sig ... end
Sourcemodule Context_free : sig ... end

Context free rewriting

Sourcemodule Deriving : sig ... end

Deriving code from type declarations

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

Return the path used as root in a file

Sourcemodule Keyword : sig ... end
Sourcemodule Loc : sig ... end

Located items

Sourcemodule Location : sig ... end

Overrides the Location module of OCaml

Sourcemodule Longident : sig ... end

Overrides the Longident module of OCaml

Sourcemodule Merlin_helpers : sig ... end

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

Sourcemodule Reserved_namespaces : sig ... end
Sourcemodule Spellcheck : sig ... end
Sourcemodule Quoter : sig ... end

Generate expressions in a hygienic way.

Sourcemodule Ast_io : sig ... end
Sourceval lident : string -> Longident.t
Sourceval gen_symbol : ?prefix:string -> unit -> string

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

  • parameter prefix

    default = "_x"

Sourceval string_of_core_type : Astlib.Ast_412.Parsetree.core_type -> string
Sourceval assert_no_attributes : Astlib.Ast_412.Parsetree.attribute list -> unit
Sourceval 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

Sourceval attribute_of_warning : Location.t -> string -> Astlib.Ast_412.Parsetree.attribute

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.

Sourceval is_polymorphic_variant : Astlib.Ast_412.Parsetree.type_declaration -> sig_:bool -> [> `Definitely | `Maybe | `Surely_not ]
Sourceval mk_named_sig : loc:Location.t -> sg_name:string -> handle_polymorphic_variant:bool -> Astlib.Ast_412.Parsetree.type_declaration list -> Astlib.Ast_412.Parsetree.module_type Astlib.Ast_412.Parsetree.include_infos option

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.

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