package ppxlib

  1. Overview
  2. Docs
Standard infrastructure for ppx rewriters

Install

dune-project
 Dependency

Authors

Maintainers

Sources

ppxlib-0.33.0.tbz
sha256=ffa44ef551f23b75e21dbd698a30310431381aaf140b9fe4b81c2e70a2d2c63a
sha512=cd865efc78e85d662fab3d05de7675a46252a241db44cbf13a930017c6890da5f161fbf8511b97abd9d61bffca0cb84b3adf580b55a3820afdb4a2337e9a4a63

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: 25 Jul 2024

README

Ppxlib - Meta-programming for OCaml

ocaml-ci status trunk-build-status AppVeyor status

Ppxlib documentation

Overview

Ppxlib is the standard library 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 constructing 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.

For more information about ppxlib and how to use it, please consult the documentation.

What is the relation between ppxlib and other ppx libraries?

The ppx world has a long and storied history, and if you look around, you may find other projects that offer functionalities similar to ppxlib. The following blog post gives a good overview of the various libraries that have been developed over time. At this point, ppxlib is considered the de facto library for writing ppx rewriters.

History of the project

This repository was created by merging several older smaller projects that were developed at Jane Street. See the history for more details.

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 < "0.6.0"
  2. awsm-codegen
  3. bam-ppx < "0.4"
  4. base_quickcheck != "v0.14.0" & < "v0.17.1"
  5. bisect_ppx >= "2.8.3"
  6. bistro
  7. bonsai >= "v0.16.0"
  8. brisk-reconciler
  9. bytestring
  10. chatoyant
  11. clangml >= "4.7.0"
  12. cmdlang-to-base < "0.0.11"
  13. comby < "1.3.0"
  14. commons
  15. config
  16. crs < "0.0.20260307"
  17. diff
  18. dream-html >= "3.9.5" & < "3.11.2"
  19. dune = "3.17.2"
  20. ego
  21. eliom >= "8.9.0" & < "12.0.0"
  22. elpi
  23. embedded_ocaml_templates < "0.3.1" | >= "0.7"
  24. extunix >= "0.3.1" & < "0.4.4"
  25. flow_parser >= "0.229.1"
  26. frama-c >= "32.0~beta"
  27. fsml
  28. fstar >= "2025.02.17" & < "2025.06.20"
  29. GT = "0.5.1" | >= "0.5.3"
  30. gen_js_api < "1.0.8" | >= "1.1.1" & < "1.1.6"
  31. gendarme >= "0.4.1"
  32. goblint >= "2.5.0"
  33. gospel >= "0.2.0" & < "0.3.1"
  34. graphql_ppx >= "1.2.2"
  35. hack_parallel
  36. hardcaml >= "v0.14.1" & < "v0.17.1"
  37. html_of_jsx >= "0.0.2"
  38. http_async
  39. js_of_ocaml >= "3.8.0" & < "6.1.0" | >= "6.4.0"
  40. js_of_ocaml-compiler >= "3.8.0" & < "6.1.0" | >= "6.4.0"
  41. js_of_ocaml-lwt >= "3.10.0" & < "6.1.0"
  42. js_of_ocaml-ocamlbuild >= "3.10.0" & < "5.0"
  43. js_of_ocaml-ppx >= "3.8.0" & < "6.1.0" | >= "6.4.0"
  44. js_of_ocaml-ppx_deriving_json < "6.1.0" | >= "6.4.0"
  45. js_of_ocaml-toplevel >= "3.10.0" & < "6.1.0" | >= "6.4.0"
  46. js_of_ocaml-tyxml >= "3.10.0" & < "6.1.0"
  47. jsoo-react
  48. lablqml
  49. landmarks-ppx < "1.6"
  50. lascar >= "0.7.0"
  51. learn-ocaml
  52. learn-ocaml-client
  53. lens >= "1.2.5"
  54. logs-ppx
  55. lwt_ppx >= "2.0.2" & < "5.9.2"
  56. MlFront_Cli >= "2.1.4~prerel2" & < "2.3.1"
  57. MlFront_Config
  58. MlFront_Manip
  59. melange >= "1.0.0" & < "6.0.1-51"
  60. melange-json >= "1.2.0"
  61. melange-json-native
  62. merlin >= "4.7-412"
  63. metapp >= "0.4.4"
  64. metaquot >= "0.5.0"
  65. mlt_parser != "v0.14.0"
  66. mlx < "0.11"
  67. mutaml
  68. neural_nets_lib < "0.6.0"
  69. noCanren
  70. node_of_ocaml
  71. nuscr >= "2.0.0"
  72. OCanren-ppx
  73. obus >= "1.2.5"
  74. ocaml-monadic >= "0.5"
  75. ocamlmerlin-mlx < "0.11"
  76. ocf_ppx < "1.0.0"
  77. ocgtk < "0.1~preview2"
  78. ocsigen-i18n >= "4.0.0"
  79. ocsigen-ppx-rpc < "1.1"
  80. ojs_base_ppx < "0.9.0"
  81. ometrics = "0.2.0"
  82. ortac-core < "0.8.0"
  83. ortac-qcheck-stm < "0.8.0"
  84. ortac-wrapper < "0.8.0"
  85. pacomb < "1.4.3"
  86. pancake
  87. pgocaml_ppx >= "4.3.0"
  88. pla >= "2.0"
  89. polymarket >= "0.2.0"
  90. ppx-owl-opt
  91. ppx_accessor >= "v0.14.3"
  92. ppx_assert
  93. ppx_bap
  94. ppx_base
  95. ppx_bench >= "v0.15.1" & < "v0.17.1"
  96. ppx_bin_prot < "v0.17.1"
  97. ppx_bitstring = "4.1.0"
  98. ppx_blob >= "0.7.2"
  99. ppx_camlrack
  100. ppx_catch
  101. ppx_cold
  102. ppx_compare
  103. ppx_compose >= "0.2.1"
  104. ppx_const >= "2.0.1"
  105. ppx_conv_func
  106. ppx_counters
  107. ppx_css
  108. ppx_cstruct >= "6.0.0"
  109. ppx_cstubs >= "0.6.1"
  110. ppx_csv_conv
  111. ppx_custom_printf >= "v0.14.1"
  112. ppx_decimal
  113. ppx_default
  114. ppx_defer >= "0.5.0"
  115. ppx_demo
  116. ppx_derive_at_runtime < "v0.17.1"
  117. ppx_deriving >= "5.2" & < "6.1.0"
  118. ppx_deriving_cad
  119. ppx_deriving_decoders
  120. ppx_deriving_encoding >= "0.2"
  121. ppx_deriving_ezjsonm < "0.4.1"
  122. ppx_deriving_hardcaml
  123. ppx_deriving_hash < "0.1.3"
  124. ppx_deriving_json_schema
  125. ppx_deriving_jsonschema < "0.0.7"
  126. ppx_deriving_jsoo >= "0.2"
  127. ppx_deriving_madcast >= "0.2"
  128. ppx_deriving_popper
  129. ppx_deriving_protobuf
  130. ppx_deriving_rpc < "10.0.0"
  131. ppx_deriving_scad
  132. ppx_deriving_variant_string
  133. ppx_deriving_yaml < "0.4.1"
  134. ppx_deriving_yojson >= "3.7.0" & < "3.10.0"
  135. ppx_diff < "v0.17.1"
  136. ppx_disable_unused_warnings
  137. ppx_distr_guards >= "0.3"
  138. ppx_dream_eml
  139. ppx_embed_file
  140. ppx_enforce
  141. ppx_enumerate
  142. ppx_expect != "v0.14.0" & < "v0.17.3"
  143. ppx_expect_nobase = "v0.17.2.2"
  144. ppx_factory >= "0.2.0"
  145. ppx_fail
  146. ppx_fields_conv >= "v0.14.2"
  147. ppx_fixed_literal
  148. ppx_forbid
  149. ppx_format
  150. ppx_fun
  151. ppx_gen_rec >= "2.0.0"
  152. ppx_getenv >= "2.1"
  153. ppx_globalize < "v0.17.2"
  154. ppx_hardcaml < "v0.17.1"
  155. ppx_hash
  156. ppx_hegel_compat
  157. ppx_hegel_generator
  158. ppx_hegel_test
  159. ppx_here
  160. ppx_ignore_instrumentation
  161. ppx_import < "1.8.0" | = "1.11.0"
  162. ppx_inline_alcotest
  163. ppx_inline_test >= "v0.15.1" & < "v0.17.1"
  164. ppx_inline_test_nobase < "v0.17.0.3"
  165. ppx_interact < "0.2.0"
  166. ppx_irmin >= "3.0.0"
  167. ppx_jane
  168. ppx_js_style < "v0.17.1"
  169. ppx_jsobject_conv != "0.9.0" & < "0.21.1"
  170. ppx_jsonaf_conv >= "v0.15.1" & < "v0.17.1"
  171. ppx_let < "v0.17.1"
  172. ppx_log
  173. ppx_lun < "0.0.2"
  174. ppx_make
  175. ppx_map
  176. ppx_marshal
  177. ppx_marshal_ext
  178. ppx_matches
  179. ppx_mica
  180. ppx_minidebug < "2.3.0"
  181. ppx_mixins
  182. ppx_module_timer
  183. ppx_monad
  184. ppx_monoid >= "0.3.3"
  185. ppx_mysql >= "1.1.3"
  186. ppx_open
  187. ppx_optcomp >= "v0.14.2" & < "v0.17.1"
  188. ppx_optint
  189. ppx_optional
  190. ppx_parser < "0.2.1"
  191. ppx_partial
  192. ppx_pattern_bind < "v0.17.1"
  193. ppx_pipebang
  194. ppx_protocol_conv >= "5.1.3" & < "5.2.3"
  195. ppx_pyformat
  196. ppx_python >= "v0.15.0"
  197. ppx_quick_test < "v0.17.1"
  198. ppx_rapper < "1.0.1"
  199. ppx_regexp >= "0.5.1"
  200. ppx_repr >= "0.6.0" & < "0.8.0"
  201. ppx_seq
  202. ppx_sexp_conv >= "v0.15.1" & < "v0.17.1"
  203. ppx_sexp_message >= "v0.14.1"
  204. ppx_sexp_value
  205. ppx_show
  206. ppx_stable >= "v0.14.1" & < "v0.17.1"
  207. ppx_stable_witness
  208. ppx_string >= "v0.14.1"
  209. ppx_string_conv
  210. ppx_string_interpolation
  211. ppx_subliner
  212. ppx_system
  213. ppx_trace < "0.11"
  214. ppx_ts
  215. ppx_tydi < "v0.17.1"
  216. ppx_type_directed_value
  217. ppx_typed_fields < "v0.17.1"
  218. ppx_typerep_conv >= "v0.14.2" & < "v0.17.1"
  219. ppx_units
  220. ppx_update
  221. ppx_variants_conv >= "v0.14.2" & < "v0.17.1"
  222. ppx_viewpattern < "0.1.1"
  223. ppx_xml_conv
  224. ppx_yojson >= "1.3.0"
  225. ppx_yojson_conv >= "v0.15.1" & < "v0.17.1"
  226. ppxlib_jane < "v0.17.3"
  227. ppxx >= "2.5.0"
  228. pyro-caml-ppx
  229. qcow < "0.12.1"
  230. rdf_ppx
  231. reactjs-jsx-ppx
  232. reason >= "3.9.0" & < "3.16.0"
  233. reason-react-day-picker
  234. reason-react-ppx < "0.17.0"
  235. refl >= "0.4.1"
  236. repr-fuzz >= "0.2.1" & < "0.8.0"
  237. res_tailwindcss
  238. rescript-syntax
  239. sedlex >= "2.6"
  240. serde_derive
  241. server-reason-react >= "0.2.0" & < "0.4.1"
  242. spectrum_palette_ppx
  243. speed
  244. spin >= "0.8.0"
  245. spoc_ppx
  246. stdint-literals
  247. stk_ppx
  248. streamable < "v0.17.1"
  249. styled-ppx < "0.61.0"
  250. togglelog
  251. toplevel_expect_test >= "v0.14.1"
  252. tyxml-jsx >= "4.5.0"
  253. tyxml-ppx >= "4.5.0"
  254. tyxml-syntax >= "4.5.0"
  255. validate
  256. visitors >= "20210608" & < "20251010"
  257. vlt
  258. volgo < "0.0.21"
  259. volgo-base
  260. volgo-git-backend < "0.0.21"
  261. volgo-git-eio < "0.0.21"
  262. volgo-git-unix < "0.0.21"
  263. volgo-hg-backend < "0.0.21"
  264. volgo-hg-eio < "0.0.21"
  265. volgo-hg-unix < "0.0.21"
  266. volgo-vcs < "0.0.21"
  267. wasm_of_ocaml-compiler < "6.1.0" | >= "6.4.0"
  268. wtr < "3.0.0"
  269. wtr-ppx
  270. xtmpl_ppx < "1.2.0"

Conflicts (4)

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