package ppxlib

  1. Overview
  2. Docs
Standard infrastructure for ppx rewriters

Install

Dune Dependency

Authors

Maintainers

Sources

04e050cbe2cf3e5cdb4441c480e4f472a5033941.tar.gz
sha256=f0e61123b33b2acca23a388a367226674a7bccdedbaa41b0fd62fa42344dccd9
sha512=1a192695ac3a7d587a49f3025239557a998febe72d3b469d3c69b5c32643cc91c55fb72703f8197e1395c02bfabacf17ce5f7ee2bdc367e15f9086e489082a9b

Description

Ppxlib is the standard infrastructure for ppx rewriters and other programs that manipulate the in-memory representation of OCaml programs, a.k.a the "Parsetree".

It also comes bundled with two ppx rewriters that are commonly used to write tools that manipulate and/or generate Parsetree values; ppxlib.metaquot which allows to construct Parsetree values using the OCaml syntax directly and ppxlib.traverse which provides various ways of automatically traversing values of a given type, in particular allowing to inject a complex structured value into generated code.

Published: 16 Feb 2024

README

Non-continuous trunk-support for Ppxlib

On this branch, we provide a Ppxlib version, which can be compiled with OCaml's trunk branch. Whenever you want to compile a project that (transitively) depends on PPXs with trunk, please pin Ppxlib to this branch.

The branch is maintained manually. So each time the compiler adds a new syntax feature, first we need to bring this branch back in sync with trunk and then you'll need to re-pin your Ppxlib. Please, open an issue or a PR, if this branch doesn't compile with trunk. Also open an issue, if there's a feature/bug-fix on Ppxlib's main branch that you'd like to have here, so that we rebase.

trunk-support vs trunk-feature support

Ppxlib supporting trunk can be interpreted in two different ways.

User perspective on the difference

One notion of trunk-support is that a project depending on Ppxlib can be compiled with trunk under the assumption that the project doesn't use the new syntax features in trunk. That's what this branch provides.

The other notion of trunk-support should actually be called trunk-feature support: you can use the new trunk syntax features in a project which depends on Ppxlib and that you compile with trunk. It's not unlikely that you'll get a Ppxlib runtime error (i.e. project compile time error), if you try to use this branch in that situation.

Ppxlib behavior perspective on the difference

The Ppxlib behavior in the situation of trunk support is: The parsetree version exposed by Ppxlib is still the one from the latest stable compiler and all PPXs are defined against that one. However, Ppxlib has hold of trunk's parsetree version and knows how to migrate between that parsetree version and the parsetree version of the latest stable compiler. You can find those parsetrees and parsertree migration modules in Ppxlib's Astlib library. So, when compiling a file with trunk, the Ppxlib driver will parse the file into the trunk parsetree, migrate down to the latest stable parsetree, do the PPX expansions and migrate back to trunk's parsetree. The downward migration will error, if the parsetree contains a feature that isn't well-defined in the latest stable parsetree version.

The behavior in the case of trunk-feature support would be different. In that case, Ppxlib would have to expose the trunk parsetree, so that the PPXs would be defined against that one. So, Ppxlib would have to bump its internal parsetree to the trunk parsetree. Bumping the Ppxlib parsetree always means potentially breaking PPXs. When bumping the Ppxlib parsetree to the parsetree of an about-to-be-released stable compiler version, we create a work-space with all opam PPXs and send patch PRs to the ones we break. However, for trunk we wouldn't do such an effort.

Dependencies (6)

  1. stdlib-shims
  2. sexplib0 >= "v0.12"
  3. ppx_derivers >= "1.0"
  4. ocaml-compiler-libs >= "v0.11.0"
  5. ocaml >= "4.04.1" & < "5.3.0"
  6. dune >= "2.7"

Dev Dependencies (5)

  1. odoc with-doc
  2. cinaps with-test & >= "v0.12.1"
  3. re with-test & >= "1.9.0"
  4. ocamlfind with-test
  5. sexplib0 with-test & >= "v0.15"

  1. arrayjit
  2. awsm-codegen
  3. bam-ppx
  4. base_quickcheck = "v0.13.0" | >= "v0.14.1"
  5. bisect_ppx >= "2.8.3"
  6. bistro >= "0.6.0"
  7. bonsai >= "v0.16.0"
  8. bytestring
  9. clangml >= "4.7.0"
  10. comby < "1.3.0"
  11. commons
  12. config
  13. diff
  14. ego
  15. eliom >= "8.9.0"
  16. elpi >= "1.11.0" & < "1.11.3" | >= "1.13.2"
  17. embedded_ocaml_templates < "0.3.1" | >= "0.7"
  18. extunix >= "0.3.1"
  19. flow_parser >= "0.229.1"
  20. fsml
  21. GT = "0.5.1"
  22. gen_js_api >= "1.0.6" & < "1.0.8" | >= "1.1.1"
  23. genprint = "0.3"
  24. gospel >= "0.2.0"
  25. graphql_ppx >= "1.2.2"
  26. hack_parallel >= "1.0.1"
  27. hardcaml >= "v0.14.1"
  28. html_of_jsx >= "0.0.2"
  29. http_async
  30. js_of_ocaml >= "3.8.0"
  31. js_of_ocaml-compiler >= "3.8.0"
  32. js_of_ocaml-lwt >= "3.10.0"
  33. js_of_ocaml-ocamlbuild >= "3.10.0" & < "5.0"
  34. js_of_ocaml-ppx >= "3.8.0"
  35. js_of_ocaml-ppx_deriving_json >= "3.7.1"
  36. js_of_ocaml-toplevel >= "3.10.0"
  37. js_of_ocaml-tyxml >= "3.10.0"
  38. jsoo-react
  39. lablqml >= "0.7"
  40. landmarks-ppx
  41. lascar >= "0.7.0"
  42. learn-ocaml >= "0.13.0"
  43. learn-ocaml-client >= "0.13.0"
  44. lens >= "1.2.5"
  45. let-if >= "0.2.0"
  46. logs-ppx
  47. lwt_ppx >= "2.0.2"
  48. melange >= "1.0.0"
  49. merlin >= "4.7-412"
  50. metapp >= "0.4.4"
  51. metaquot >= "0.5.0"
  52. mlt_parser = "v0.13.0" | >= "v0.14.1"
  53. neural_nets_lib
  54. noCanren >= "0.3.0~alpha1"
  55. node_of_ocaml
  56. nuscr >= "2.0.0"
  57. OCanren-ppx = "0.2.0" | >= "0.3.0"
  58. obus >= "1.2.5"
  59. ocaml-monadic >= "0.5"
  60. ocamlformat = "0.19.0~4.13preview"
  61. ocf_ppx
  62. ocsigen-i18n >= "4.0.0"
  63. ocsigen-ppx-rpc
  64. octez-internal-libs
  65. ojs_base_ppx
  66. ometrics = "0.2.0"
  67. ortac-core
  68. ortac-qcheck-stm
  69. override = "0.2.2"
  70. pacomb
  71. pancake
  72. pgocaml_ppx >= "4.3.0"
  73. pla >= "2.0"
  74. ppx-owl-opt
  75. ppx_accessor >= "v0.14.3"
  76. ppx_assert >= "v0.13.0"
  77. ppx_bap
  78. ppx_base >= "v0.13.0"
  79. ppx_bench >= "v0.15.1"
  80. ppx_bin_prot >= "v0.13.0"
  81. ppx_bitstring >= "4.1.0"
  82. ppx_blob >= "0.7.2"
  83. ppx_camlrack
  84. ppx_catch
  85. ppx_cold
  86. ppx_compare >= "v0.13.0"
  87. ppx_compose >= "0.2.1"
  88. ppx_const >= "2.0.1"
  89. ppx_conv_func >= "v0.13.0"
  90. ppx_counters
  91. ppx_css
  92. ppx_cstruct >= "6.0.0"
  93. ppx_cstubs >= "0.6.1"
  94. ppx_csv_conv >= "v0.13.0"
  95. ppx_custom_printf >= "v0.14.1"
  96. ppx_decimal
  97. ppx_default
  98. ppx_defer >= "0.5.0"
  99. ppx_demo
  100. ppx_derive_at_runtime
  101. ppx_deriving >= "5.2"
  102. ppx_deriving_cad
  103. ppx_deriving_encoding >= "0.2"
  104. ppx_deriving_hardcaml >= "v0.13.0"
  105. ppx_deriving_hash
  106. ppx_deriving_jsoo >= "0.2"
  107. ppx_deriving_madcast >= "0.2"
  108. ppx_deriving_popper
  109. ppx_deriving_protobuf >= "3.0.0"
  110. ppx_deriving_qcheck
  111. ppx_deriving_rpc >= "8.1.0"
  112. ppx_deriving_scad
  113. ppx_deriving_variant_string
  114. ppx_deriving_yaml
  115. ppx_deriving_yojson >= "3.7.0"
  116. ppx_diff
  117. ppx_disable_unused_warnings
  118. ppx_distr_guards >= "0.3"
  119. ppx_dream_eml
  120. ppx_embed_file
  121. ppx_enumerate >= "v0.13.0"
  122. ppx_expect >= "v0.13.0" & != "v0.14.0"
  123. ppx_factory = "0.1.0" | >= "0.2.0"
  124. ppx_fail >= "v0.13.0"
  125. ppx_fields_conv >= "v0.14.2"
  126. ppx_fixed_literal
  127. ppx_fun >= "0.0.9"
  128. ppx_gen_rec >= "2.0.0"
  129. ppx_getenv >= "2.1"
  130. ppx_globalize
  131. ppx_hardcaml >= "v0.17.0"
  132. ppx_hash >= "v0.13.0"
  133. ppx_here >= "v0.13.0"
  134. ppx_ignore_instrumentation
  135. ppx_import >= "1.7.0" & < "1.8.0" | >= "1.11.0"
  136. ppx_inline_alcotest
  137. ppx_inline_test >= "v0.15.1"
  138. ppx_interact
  139. ppx_irmin >= "3.0.0"
  140. ppx_jane >= "v0.13.0"
  141. ppx_js_style >= "v0.13.0"
  142. ppx_jsobject_conv = "0.8.0" | >= "0.9.3"
  143. ppx_jsonaf_conv >= "v0.15.1"
  144. ppx_let >= "v0.13.0"
  145. ppx_log
  146. ppx_lun
  147. ppx_make
  148. ppx_map
  149. ppx_matches
  150. ppx_minidebug
  151. ppx_module_timer >= "v0.13.0"
  152. ppx_monad
  153. ppx_monoid >= "0.3.3"
  154. ppx_mysql >= "1.1.3"
  155. ppx_open
  156. ppx_optcomp >= "v0.14.2"
  157. ppx_optint
  158. ppx_optional >= "v0.13.0"
  159. ppx_parser
  160. ppx_pattern_bind >= "v0.13.1"
  161. ppx_pipebang >= "v0.13.0"
  162. ppx_protocol_conv >= "5.1.3"
  163. ppx_pyformat
  164. ppx_python >= "v0.15.0"
  165. ppx_quick_test
  166. ppx_rapper < "1.0.1"
  167. ppx_regexp >= "0.5.0"
  168. ppx_repr >= "0.6.0"
  169. ppx_seq
  170. ppx_sexp_conv >= "v0.15.1"
  171. ppx_sexp_message >= "v0.14.1"
  172. ppx_sexp_value >= "v0.13.0"
  173. ppx_show >= "0.2.0"
  174. ppx_stable >= "v0.14.1"
  175. ppx_stable_witness
  176. ppx_string >= "v0.14.1"
  177. ppx_string_conv
  178. ppx_string_interpolation
  179. ppx_subliner
  180. ppx_system
  181. ppx_trace
  182. ppx_ts
  183. ppx_tydi
  184. ppx_type_directed_value
  185. ppx_typed_fields
  186. ppx_typerep_conv >= "v0.14.2"
  187. ppx_units
  188. ppx_update
  189. ppx_variants_conv >= "v0.14.2"
  190. ppx_viewpattern
  191. ppx_xml_conv >= "v0.13.0"
  192. ppx_yojson >= "1.3.0"
  193. ppx_yojson_conv >= "v0.15.1"
  194. ppxlib_jane
  195. ppxx >= "2.5.0"
  196. qcow >= "0.11.0"
  197. rdf_ppx
  198. reactjs-jsx-ppx
  199. reason >= "3.9.0"
  200. reason-react-ppx
  201. refl >= "0.4.1"
  202. repr-fuzz >= "0.2.1"
  203. res_tailwindcss
  204. rescript-syntax
  205. scaml != "1.2.0"
  206. sedlex >= "2.6"
  207. serde_derive
  208. server-reason-react
  209. speed
  210. spin >= "0.8.0"
  211. spoc_ppx
  212. stdint-literals
  213. streamable
  214. styled-ppx
  215. togglelog
  216. toplevel_expect_test >= "v0.14.1"
  217. tyxml-jsx >= "4.5.0"
  218. tyxml-ppx >= "4.5.0"
  219. tyxml-syntax >= "4.5.0"
  220. visitors >= "20210608"
  221. vlt
  222. wtr < "3.0.0"
  223. wtr-ppx
  224. xtmpl_ppx

Conflicts (4)

  1. ocaml-variants = "5.1.0~alpha1+options"
  2. ocaml-base-compiler = "5.1.0~alpha1"
  3. base-effects
  4. ocaml-migrate-parsetree < "2.0.0"
OCaml

Innovation. Community. Security.