package pa_ppx_parsetree

  1. Overview
  2. Docs
package pa_ppx_parsetree
Legend:
Library
Module
Module type
Parameter
Class
Class type
type attribute = Parsetree.attribute = {
  1. attr_name : string located;
  2. attr_payload : payload;
  3. attr_loc : location;
}
and extension = string located * payload
and attributes = attribute list
and payload = Parsetree.payload =
  1. | PStr of structure
  2. | PSig of signature
  3. | PTyp of core_type
  4. | PPat of pattern * expression option
and core_type = 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 = 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_t located * core_type list
  6. | Ptyp_object of object_field list * closed_flag
  7. | Ptyp_class of longident_t located * 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 located list * core_type
  11. | Ptyp_package of package_type
  12. | Ptyp_extension of extension
and package_type = longident_t located * (longident_t located * core_type) list
and row_field = Parsetree.row_field = {
  1. prf_desc : row_field_desc;
  2. prf_loc : location;
  3. prf_attributes : attributes;
}
and row_field_desc = Parsetree.row_field_desc =
  1. | Rtag of label located * bool * core_type list
  2. | Rinherit of core_type
and object_field = Parsetree.object_field = {
  1. pof_desc : object_field_desc;
  2. pof_loc : location;
  3. pof_attributes : attributes;
}
and object_field_desc = Parsetree.object_field_desc =
  1. | Otag of label located * core_type
  2. | Oinherit of core_type
and pattern = Parsetree.pattern = {
  1. ppat_desc : pattern_desc;
  2. ppat_loc : location;
  3. ppat_loc_stack : location_stack;
  4. ppat_attributes : attributes;
}
and pattern_desc = Parsetree.pattern_desc =
  1. | Ppat_any
  2. | Ppat_var of string located
  3. | Ppat_alias of pattern * string located
  4. | Ppat_constant of constant
  5. | Ppat_interval of constant * constant
  6. | Ppat_tuple of pattern list
  7. | Ppat_construct of longident_t located * (string located list * pattern) option
  8. | Ppat_variant of label * pattern option
  9. | Ppat_record of (longident_t located * 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_t located
  14. | Ppat_lazy of pattern
  15. | Ppat_unpack of string option located
  16. | Ppat_exception of pattern
  17. | Ppat_extension of extension
  18. | Ppat_open of longident_t located * pattern
and expression = Parsetree.expression = {
  1. pexp_desc : expression_desc;
  2. pexp_loc : location;
  3. pexp_loc_stack : location_stack;
  4. pexp_attributes : attributes;
}
and expression_desc = Parsetree.expression_desc =
  1. | Pexp_ident of longident_t located
  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_t located * expression option
  11. | Pexp_variant of label * expression option
  12. | Pexp_record of (longident_t located * expression) list * expression option
  13. | Pexp_field of expression * longident_t located
  14. | Pexp_setfield of expression * longident_t located * 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 located
  23. | Pexp_new of longident_t located
  24. | Pexp_setinstvar of label located * expression
  25. | Pexp_override of (label located * expression) list
  26. | Pexp_letmodule of string option located * 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 located * 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 = Parsetree.case = {
  1. pc_lhs : pattern;
  2. pc_guard : expression option;
  3. pc_rhs : expression;
}
and letop = Parsetree.letop = {
  1. let_ : binding_op;
  2. ands : binding_op list;
  3. body : expression;
}
and binding_op = Parsetree.binding_op = {
  1. pbop_op : string located;
  2. pbop_pat : pattern;
  3. pbop_exp : expression;
  4. pbop_loc : location;
}
and value_description = Parsetree.value_description = {
  1. pval_name : string located;
  2. pval_type : core_type;
  3. pval_prim : string list;
  4. pval_attributes : attributes;
  5. pval_loc : location;
}
and type_declaration = Parsetree.type_declaration = {
  1. ptype_name : string located;
  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;
}
and type_kind = 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 = Parsetree.label_declaration = {
  1. pld_name : string located;
  2. pld_mutable : mutable_flag;
  3. pld_type : core_type;
  4. pld_loc : location;
  5. pld_attributes : attributes;
}
and constructor_declaration = Parsetree.constructor_declaration = {
  1. pcd_name : string located;
  2. pcd_vars : string located list;
  3. pcd_args : constructor_arguments;
  4. pcd_res : core_type option;
  5. pcd_loc : location;
  6. pcd_attributes : attributes;
}
and constructor_arguments = Parsetree.constructor_arguments =
  1. | Pcstr_tuple of core_type list
  2. | Pcstr_record of label_declaration list
and type_extension = Parsetree.type_extension = {
  1. ptyext_path : longident_t located;
  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;
}
and extension_constructor = Parsetree.extension_constructor = {
  1. pext_name : string located;
  2. pext_kind : extension_constructor_kind;
  3. pext_loc : location;
  4. pext_attributes : attributes;
}
and type_exception = Parsetree.type_exception = {
  1. ptyexn_constructor : extension_constructor;
  2. ptyexn_loc : location;
  3. ptyexn_attributes : attributes;
}
and extension_constructor_kind = Parsetree.extension_constructor_kind =
  1. | Pext_decl of string located list * constructor_arguments * core_type option
  2. | Pext_rebind of longident_t located
and class_type = Parsetree.class_type = {
  1. pcty_desc : class_type_desc;
  2. pcty_loc : location;
  3. pcty_attributes : attributes;
}
and class_type_desc = Parsetree.class_type_desc =
  1. | Pcty_constr of longident_t located * 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 = Parsetree.class_signature = {
  1. pcsig_self : core_type;
  2. pcsig_fields : class_type_field list;
}
and class_type_field = Parsetree.class_type_field = {
  1. pctf_desc : class_type_field_desc;
  2. pctf_loc : location;
  3. pctf_attributes : attributes;
}
and class_type_field_desc = Parsetree.class_type_field_desc =
  1. | Pctf_inherit of class_type
  2. | Pctf_val of label located * mutable_flag * virtual_flag * core_type
  3. | Pctf_method of label located * 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 Parsetree.class_infos = {
  1. pci_virt : virtual_flag;
  2. pci_params : (core_type * (variance * injectivity)) list;
  3. pci_name : string located;
  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 = Parsetree.class_expr = {
  1. pcl_desc : class_expr_desc;
  2. pcl_loc : location;
  3. pcl_attributes : attributes;
}
and class_expr_desc = Parsetree.class_expr_desc =
  1. | Pcl_constr of longident_t located * 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 = Parsetree.class_structure = {
  1. pcstr_self : pattern;
  2. pcstr_fields : class_field list;
}
and class_field = Parsetree.class_field = {
  1. pcf_desc : class_field_desc;
  2. pcf_loc : location;
  3. pcf_attributes : attributes;
}
and class_field_desc = Parsetree.class_field_desc =
  1. | Pcf_inherit of override_flag * class_expr * string located option
  2. | Pcf_val of label located * mutable_flag * class_field_kind
  3. | Pcf_method of label located * 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 = Parsetree.class_field_kind =
  1. | Cfk_virtual of core_type
  2. | Cfk_concrete of override_flag * expression
and class_declaration = class_expr class_infos
and module_type = Parsetree.module_type = {
  1. pmty_desc : module_type_desc;
  2. pmty_loc : location;
  3. pmty_attributes : attributes;
}
and module_type_desc = Parsetree.module_type_desc =
  1. | Pmty_ident of longident_t located
  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_t located
and functor_parameter = Parsetree.functor_parameter =
  1. | Unit
  2. | Named of string option located * module_type
and signature = signature_item list
and signature_item = Parsetree.signature_item = {
  1. psig_desc : signature_item_desc;
  2. psig_loc : location;
}
and signature_item_desc = 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_modtypesubst of module_type_declaration
  11. | Psig_open of open_description
  12. | Psig_include of include_description
  13. | Psig_class of class_description list
  14. | Psig_class_type of class_type_declaration list
  15. | Psig_attribute of attribute
  16. | Psig_extension of extension * attributes
and module_declaration = Parsetree.module_declaration = {
  1. pmd_name : string option located;
  2. pmd_type : module_type;
  3. pmd_attributes : attributes;
  4. pmd_loc : location;
}
and module_substitution = Parsetree.module_substitution = {
  1. pms_name : string located;
  2. pms_manifest : longident_t located;
  3. pms_attributes : attributes;
  4. pms_loc : location;
}
and module_type_declaration = Parsetree.module_type_declaration = {
  1. pmtd_name : string located;
  2. pmtd_type : module_type option;
  3. pmtd_attributes : attributes;
  4. pmtd_loc : location;
}
and !'a open_infos = 'a Parsetree.open_infos = {
  1. popen_expr : 'a;
  2. popen_override : override_flag;
  3. popen_loc : location;
  4. popen_attributes : attributes;
}
and open_description = longident_t located open_infos
and open_declaration = module_expr open_infos
and !'a include_infos = 'a 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 = Parsetree.with_constraint =
  1. | Pwith_type of longident_t located * type_declaration
  2. | Pwith_module of longident_t located * longident_t located
  3. | Pwith_modtype of longident_t located * module_type
  4. | Pwith_modtypesubst of longident_t located * module_type
  5. | Pwith_typesubst of longident_t located * type_declaration
  6. | Pwith_modsubst of longident_t located * longident_t located
and module_expr = Parsetree.module_expr = {
  1. pmod_desc : module_expr_desc;
  2. pmod_loc : location;
  3. pmod_attributes : attributes;
}
and module_expr_desc = Parsetree.module_expr_desc =
  1. | Pmod_ident of longident_t located
  2. | Pmod_structure of structure
  3. | Pmod_functor of functor_parameter * module_expr
  4. | Pmod_apply of module_expr * module_expr
  5. | Pmod_apply_unit of module_expr
  6. | Pmod_constraint of module_expr * module_type
  7. | Pmod_unpack of expression
  8. | Pmod_extension of extension
and structure = structure_item list
and structure_item = Parsetree.structure_item = {
  1. pstr_desc : structure_item_desc;
  2. pstr_loc : location;
}
and structure_item_desc = 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_constraint = Parsetree.value_constraint =
  1. | Pvc_constraint of {
    1. locally_abstract_univars : string located list;
    2. typ : core_type;
    }
  2. | Pvc_coercion of {
    1. ground : core_type option;
    2. coercion : core_type;
    }
and value_binding = Parsetree.value_binding = {
  1. pvb_pat : pattern;
  2. pvb_expr : expression;
  3. pvb_constraint : value_constraint option;
  4. pvb_attributes : attributes;
  5. pvb_loc : location;
}
and module_binding = Parsetree.module_binding = {
  1. pmb_name : string option located;
  2. pmb_expr : module_expr;
  3. pmb_attributes : attributes;
  4. pmb_loc : location;
}
and 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 !'a located = 'a Asttypes.loc = {
  1. txt : 'a;
  2. loc : location;
}
and longident_t = Longident.t =
  1. | Lident of string
  2. | Ldot of longident_t * string
  3. | Lapply of longident_t * longident_t
and ast_constant = Asttypes.constant =
  1. | Const_int of int
  2. | Const_char of char
  3. | Const_string of string * location * string option
  4. | Const_float of string
  5. | Const_int32 of int32
  6. | Const_int64 of int64
  7. | Const_nativeint of nativeint
and arg_label = Asttypes.arg_label =
  1. | Nolabel
  2. | Labelled of string
  3. | Optional of string
and label = string
and closed_flag = Asttypes.closed_flag =
  1. | Closed
  2. | Open
and rec_flag = Asttypes.rec_flag =
  1. | Nonrecursive
  2. | Recursive
and direction_flag = Asttypes.direction_flag =
  1. | Upto
  2. | Downto
and private_flag = Asttypes.private_flag =
  1. | Private
  2. | Public
and mutable_flag = Asttypes.mutable_flag =
  1. | Immutable
  2. | Mutable
and virtual_flag = Asttypes.virtual_flag =
  1. | Virtual
  2. | Concrete
and override_flag = Asttypes.override_flag =
  1. | Override
  2. | Fresh
and variance = Asttypes.variance =
  1. | Covariant
  2. | Contravariant
  3. | NoVariance
and injectivity = Asttypes.injectivity =
  1. | Injective
  2. | NoInjectivity
and constant = 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
and location_stack = location list
and toplevel_phrase = Parsetree.toplevel_phrase =
  1. | Ptop_def of structure
  2. | Ptop_dir of toplevel_directive
and toplevel_directive = Parsetree.toplevel_directive = {
  1. pdir_name : string located;
  2. pdir_arg : directive_argument option;
  3. pdir_loc : location;
}
and directive_argument = Parsetree.directive_argument = {
  1. pdira_desc : directive_argument_desc;
  2. pdira_loc : location;
}
and directive_argument_desc = Parsetree.directive_argument_desc =
  1. | Pdir_string of string
  2. | Pdir_int of string * char option
  3. | Pdir_ident of longident_t
  4. | Pdir_bool of bool
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