package ppx_core

  1. Overview
  2. Docs
include module type of struct include Ppx_ast end
module Ast = Ppx_ast.Ast
module Ast_helper = Ppx_ast.Ast_helper
module Ast_magic = Ppx_ast.Ast_magic
module Asttypes = Ppx_ast.Asttypes
module Docstrings = Ppx_ast.Docstrings
module Extra_warnings = Ppx_ast.Extra_warnings
module Lexer = Ppx_ast.Lexer
module Parse = Ppx_ast.Parse
module Parser = Ppx_ast.Parser
module Parsetree = Ppx_ast.Parsetree
module Pprintast = Ppx_ast.Pprintast
module Selected_ast = Ppx_ast.Selected_ast
module Syntaxerr = Ppx_ast.Syntaxerr
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 = Ocaml_common.Location.t = {
  1. loc_start : position;
  2. loc_end : position;
  3. loc_ghost : bool;
}
and 'a loc = 'a Ocaml_common.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
and rec_flag = Migrate_parsetree.OCaml_403.Ast.Asttypes.rec_flag =
  1. | Nonrecursive
  2. | Recursive
and direction_flag = Migrate_parsetree.OCaml_403.Ast.Asttypes.direction_flag =
  1. | Upto
  2. | Downto
and private_flag = Migrate_parsetree.OCaml_403.Ast.Asttypes.private_flag =
  1. | Private
  2. | Public
and mutable_flag = Migrate_parsetree.OCaml_403.Ast.Asttypes.mutable_flag =
  1. | Immutable
  2. | Mutable
and virtual_flag = Migrate_parsetree.OCaml_403.Ast.Asttypes.virtual_flag =
  1. | Virtual
  2. | Concrete
and override_flag = Migrate_parsetree.OCaml_403.Ast.Asttypes.override_flag =
  1. | Override
  2. | Fresh
and closed_flag = Migrate_parsetree.OCaml_403.Ast.Asttypes.closed_flag =
  1. | Closed
  2. | Open
and label = string
and arg_label = Migrate_parsetree.OCaml_403.Ast.Asttypes.arg_label =
  1. | Nolabel
  2. | Labelled of string
  3. | Optional of string
and variance = Migrate_parsetree.OCaml_403.Ast.Asttypes.variance =
  1. | Covariant
  2. | Contravariant
  3. | Invariant

Abstract syntax tree produced by parsing

and constant = Migrate_parsetree.OCaml_403.Ast.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 = string loc * payload
and extension = string loc * payload
and attributes = attribute list
and payload = Migrate_parsetree.OCaml_403.Ast.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.OCaml_403.Ast.Parsetree.core_type = {
  1. ptyp_desc : core_type_desc;
  2. ptyp_loc : location;
  3. ptyp_attributes : attributes;
}
and core_type_desc = Migrate_parsetree.OCaml_403.Ast.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 (string * attributes * core_type) 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 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.OCaml_403.Ast.Parsetree.row_field =
  1. | Rtag of label * attributes * bool * core_type list
  2. | Rinherit of core_type
and pattern = Migrate_parsetree.OCaml_403.Ast.Parsetree.pattern = {
  1. ppat_desc : pattern_desc;
  2. ppat_loc : location;
  3. ppat_attributes : attributes;
}
and pattern_desc = Migrate_parsetree.OCaml_403.Ast.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
and expression = Migrate_parsetree.OCaml_403.Ast.Parsetree.expression = {
  1. pexp_desc : expression_desc;
  2. pexp_loc : location;
  3. pexp_attributes : attributes;
}
and expression_desc = Migrate_parsetree.OCaml_403.Ast.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 * string
  23. | Pexp_new of longident_loc
  24. | Pexp_setinstvar of string loc * expression
  25. | Pexp_override of (string loc * expression) list
  26. | Pexp_letmodule of string loc * module_expr * expression
  27. | Pexp_assert of expression
  28. | Pexp_lazy of expression
  29. | Pexp_poly of expression * core_type option
  30. | Pexp_object of class_structure
  31. | Pexp_newtype of string * expression
  32. | Pexp_pack of module_expr
  33. | Pexp_open of override_flag * longident_loc * expression
  34. | Pexp_extension of extension
  35. | Pexp_unreachable
and case = Migrate_parsetree.OCaml_403.Ast.Parsetree.case = {
  1. pc_lhs : pattern;
  2. pc_guard : expression option;
  3. pc_rhs : expression;
}
and value_description = Migrate_parsetree.OCaml_403.Ast.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.OCaml_403.Ast.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.OCaml_403.Ast.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.OCaml_403.Ast.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.OCaml_403.Ast.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.OCaml_403.Ast.Parsetree.constructor_arguments =
  1. | Pcstr_tuple of core_type list
  2. | Pcstr_record of label_declaration list
and type_extension = Migrate_parsetree.OCaml_403.Ast.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_attributes : attributes;
}
and extension_constructor = Migrate_parsetree.OCaml_403.Ast.Parsetree.extension_constructor = {
  1. pext_name : string loc;
  2. pext_kind : extension_constructor_kind;
  3. pext_loc : location;
  4. pext_attributes : attributes;
}
and extension_constructor_kind = Migrate_parsetree.OCaml_403.Ast.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.OCaml_403.Ast.Parsetree.class_type = {
  1. pcty_desc : class_type_desc;
  2. pcty_loc : location;
  3. pcty_attributes : attributes;
}
and class_type_desc = Migrate_parsetree.OCaml_403.Ast.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
and class_signature = Migrate_parsetree.OCaml_403.Ast.Parsetree.class_signature = {
  1. pcsig_self : core_type;
  2. pcsig_fields : class_type_field list;
}
and class_type_field = Migrate_parsetree.OCaml_403.Ast.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.OCaml_403.Ast.Parsetree.class_type_field_desc =
  1. | Pctf_inherit of class_type
  2. | Pctf_val of string * mutable_flag * virtual_flag * core_type
  3. | Pctf_method of string * 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.OCaml_403.Ast.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.OCaml_403.Ast.Parsetree.class_expr = {
  1. pcl_desc : class_expr_desc;
  2. pcl_loc : location;
  3. pcl_attributes : attributes;
}
and class_expr_desc = Migrate_parsetree.OCaml_403.Ast.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
and class_structure = Migrate_parsetree.OCaml_403.Ast.Parsetree.class_structure = {
  1. pcstr_self : pattern;
  2. pcstr_fields : class_field list;
}
and class_field = Migrate_parsetree.OCaml_403.Ast.Parsetree.class_field = {
  1. pcf_desc : class_field_desc;
  2. pcf_loc : location;
  3. pcf_attributes : attributes;
}
and class_field_desc = Migrate_parsetree.OCaml_403.Ast.Parsetree.class_field_desc =
  1. | Pcf_inherit of override_flag * class_expr * string option
  2. | Pcf_val of string loc * mutable_flag * class_field_kind
  3. | Pcf_method of string 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.OCaml_403.Ast.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.OCaml_403.Ast.Parsetree.module_type = {
  1. pmty_desc : module_type_desc;
  2. pmty_loc : location;
  3. pmty_attributes : attributes;
}
and module_type_desc = Migrate_parsetree.OCaml_403.Ast.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.OCaml_403.Ast.Parsetree.signature_item_desc =
  1. | Psig_value of value_description
  2. | Psig_type of rec_flag * type_declaration list
  3. | Psig_typext of type_extension
  4. | Psig_exception of extension_constructor
  5. | Psig_module of module_declaration
  6. | Psig_recmodule of module_declaration list
  7. | Psig_modtype of module_type_declaration
  8. | Psig_open of open_description
  9. | Psig_include of include_description
  10. | Psig_class of class_description list
  11. | Psig_class_type of class_type_declaration list
  12. | Psig_attribute of attribute
  13. | Psig_extension of extension * attributes
and module_declaration = Migrate_parsetree.OCaml_403.Ast.Parsetree.module_declaration = {
  1. pmd_name : string loc;
  2. pmd_type : module_type;
  3. pmd_attributes : attributes;
  4. pmd_loc : location;
}
and module_type_declaration = Migrate_parsetree.OCaml_403.Ast.Parsetree.module_type_declaration = {
  1. pmtd_name : string loc;
  2. pmtd_type : module_type option;
  3. pmtd_attributes : attributes;
  4. pmtd_loc : location;
}
and open_description = Migrate_parsetree.OCaml_403.Ast.Parsetree.open_description = {
  1. popen_lid : longident_loc;
  2. popen_override : override_flag;
  3. popen_loc : location;
  4. popen_attributes : attributes;
}
and 'a include_infos = 'a Migrate_parsetree.OCaml_403.Ast.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.OCaml_403.Ast.Parsetree.with_constraint =
  1. | Pwith_type of longident_loc * type_declaration
  2. | Pwith_module of longident_loc * longident_loc
  3. | Pwith_typesubst of type_declaration
  4. | Pwith_modsubst of string loc * longident_loc
and module_expr = Migrate_parsetree.OCaml_403.Ast.Parsetree.module_expr = {
  1. pmod_desc : module_expr_desc;
  2. pmod_loc : location;
  3. pmod_attributes : attributes;
}
and module_expr_desc = Migrate_parsetree.OCaml_403.Ast.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.OCaml_403.Ast.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 extension_constructor
  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_description
  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.OCaml_403.Ast.Parsetree.value_binding = {
  1. pvb_pat : pattern;
  2. pvb_expr : expression;
  3. pvb_attributes : attributes;
  4. pvb_loc : location;
}
and module_binding = Migrate_parsetree.OCaml_403.Ast.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.OCaml_403.Ast.Parsetree.toplevel_phrase =
  1. | Ptop_def of structure
  2. | Ptop_dir of string * directive_argument
and directive_argument = Migrate_parsetree.OCaml_403.Ast.Parsetree.directive_argument =
  1. | Pdir_none
  2. | Pdir_string of string
  3. | Pdir_int of string * char option
  4. | Pdir_ident of longident
  5. | Pdir_bool of bool
class virtual map : object ... end
class virtual iter : object ... end
class virtual +'b fold : object ... end
class virtual +'b fold_map : object ... end
class virtual +'b map_with_context : object ... end
class virtual +'b lift : object ... end
include module type of struct include Std end
  • deprecated [since 2017-01] Use Ppx_core or Ppx_core.Light instead
module Ast_builder = Std.Ast_builder
module Ast_pattern = Std.Ast_pattern
module Ast_traverse = Std.Ast_traverse
module Attribute = Std.Attribute
module Caller_id = Std.Caller_id
module Context_free = Std.Context_free
module Extension = Std.Extension
module File_path = Std.File_path
module Loc = Std.Loc
module Reserved_namespaces = Std.Reserved_namespaces
module Spellcheck = Std.Spellcheck
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.

Returns whether the given type declarations refer to themselves.

short_circuit allows you to override the search for certain type expressions.

stop_on_functions allows to disregard the recursive occurences appearing in arrow types. The default is to disregard them.

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.

module Location = Location
module Longident = Longident
module Ast_builder_403 = Ast_builder
module Ast_pattern_403 = Ast_pattern
OCaml

Innovation. Community. Security.