Module Ast_iterator

Ast_iterator.iterator enables AST inspection using open recursion. A typical mapper would be based on Ast_iterator.default_iterator, a trivial iterator, and will fall back on it for handling the syntax it does not modify.

Warning: this module is unstable and part of compiler-libs.

A generic Parsetree iterator

type iterator = {
  1. attribute : iterator -> Parsetree.attribute -> unit;
  2. attributes : iterator -> Parsetree.attribute list -> unit;
  3. binding_op : iterator -> Parsetree.binding_op -> unit;
  4. case : iterator -> Parsetree.case -> unit;
  5. cases : iterator -> Parsetree.case list -> unit;
  6. class_declaration : iterator -> Parsetree.class_declaration -> unit;
  7. class_description : iterator -> Parsetree.class_description -> unit;
  8. class_expr : iterator -> Parsetree.class_expr -> unit;
  9. class_field : iterator -> Parsetree.class_field -> unit;
  10. class_signature : iterator -> Parsetree.class_signature -> unit;
  11. class_structure : iterator -> Parsetree.class_structure -> unit;
  12. class_type : iterator -> Parsetree.class_type -> unit;
  13. class_type_declaration : iterator -> Parsetree.class_type_declaration -> unit;
  14. class_type_field : iterator -> Parsetree.class_type_field -> unit;
  15. constructor_declaration : iterator -> Parsetree.constructor_declaration -> unit;
  16. directive_argument : iterator -> Parsetree.directive_argument -> unit;
  17. expr : iterator -> Parsetree.expression -> unit;
  18. extension : iterator -> Parsetree.extension -> unit;
  19. extension_constructor : iterator -> Parsetree.extension_constructor -> unit;
  20. include_declaration : iterator -> Parsetree.include_declaration -> unit;
  21. include_description : iterator -> Parsetree.include_description -> unit;
  22. label_declaration : iterator -> Parsetree.label_declaration -> unit;
  23. location : iterator -> Location.t -> unit;
  24. module_binding : iterator -> Parsetree.module_binding -> unit;
  25. module_declaration : iterator -> Parsetree.module_declaration -> unit;
  26. module_substitution : iterator -> Parsetree.module_substitution -> unit;
  27. module_expr : iterator -> Parsetree.module_expr -> unit;
  28. module_type : iterator -> Parsetree.module_type -> unit;
  29. module_type_declaration : iterator -> Parsetree.module_type_declaration -> unit;
  30. open_declaration : iterator -> Parsetree.open_declaration -> unit;
  31. open_description : iterator -> Parsetree.open_description -> unit;
  32. pat : iterator -> Parsetree.pattern -> unit;
  33. payload : iterator -> Parsetree.payload -> unit;
  34. signature : iterator -> Parsetree.signature -> unit;
  35. signature_item : iterator -> Parsetree.signature_item -> unit;
  36. structure : iterator -> Parsetree.structure -> unit;
  37. structure_item : iterator -> Parsetree.structure_item -> unit;
  38. toplevel_directive : iterator -> Parsetree.toplevel_directive -> unit;
  39. toplevel_phrase : iterator -> Parsetree.toplevel_phrase -> unit;
  40. typ : iterator -> Parsetree.core_type -> unit;
  41. row_field : iterator -> Parsetree.row_field -> unit;
  42. object_field : iterator -> Parsetree.object_field -> unit;
  43. type_declaration : iterator -> Parsetree.type_declaration -> unit;
  44. type_extension : iterator -> Parsetree.type_extension -> unit;
  45. type_exception : iterator -> Parsetree.type_exception -> unit;
  46. type_kind : iterator -> Parsetree.type_kind -> unit;
  47. value_binding : iterator -> Parsetree.value_binding -> unit;
  48. value_description : iterator -> Parsetree.value_description -> unit;
  49. with_constraint : iterator -> Parsetree.with_constraint -> unit;
}

A iterator record implements one "method" per syntactic category, using an open recursion style: each method takes as its first argument the iterator to be applied to children in the syntax tree.

val default_iterator : iterator

A default iterator, which implements a "do not do anything" mapping.