package ppxlib

Build not checked
  1. Overview
  2. Docs
Standard library for ppx rewriters

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (25)

Authors

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Maintainers

  1. O
    opensource@janestreet.com

Sources

ppxlib-0.24.0.tbz
sha256=7766027c2ecd0f5b3b460e9212a70709c6744278113eb91f317c56c41e7a90c8
sha512=726e48899c43f8bee1935618827e68b2953753a62868e424a2dadf2e156cc60794abacea658686a8a160eccde0f75b95b98daacf2b9242b4f86a92798d47b597

Description

Ppxlib is the standard library for ppx rewriters and other programs that manipulate the in-memory reprensation 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.

Added to opam-repository:

README

Ppxlib - Meta-programming for OCaml

ocaml-ci status AppVeyor status

User manual API 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 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.

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

What is the relation between ppxlib and other ppx libraries?

The ppx world has a long historied 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 as 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" & < "4.15"
  6. dune >= "2.7"

Dev Dependencies (7)

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

Optional Dependencies

None

  1. arrayjit < "0.5.2"
  2. base_quickcheck != "v0.14.0" & < "v0.16.0"
  3. bisect_ppx >= "2.6.0" & < "2.8.2"
  4. bistro
  5. brisk-reconciler
  6. chatoyant
  7. clangml >= "4.5.0"
  8. comby < "1.3.0"
  9. dune = "3.17.2"
  10. ego
  11. eliom >= "8.9.0" & < "12.0.0"
  12. elpi
  13. embedded_ocaml_templates < "0.3.1" | >= "0.7"
  14. extunix >= "0.3.1" & < "0.4.4"
  15. fsml
  16. fstar < "2025.02.17"
  17. GT >= "0.5.0" & < "0.5.5"
  18. gen_js_api < "1.1.1"
  19. gospel < "0.2.0"
  20. graphql_ppx >= "1.2.2"
  21. hack_parallel
  22. hardcaml >= "v0.14.1" & < "v0.16.0"
  23. html_of_jsx < "0.0.4"
  24. http_async
  25. js_of_ocaml >= "3.8.0" & < "6.1.0"
  26. js_of_ocaml-compiler >= "3.8.0" & < "6.1.0"
  27. js_of_ocaml-lwt >= "3.10.0" & < "6.1.0"
  28. js_of_ocaml-ocamlbuild >= "3.10.0" & < "5.0"
  29. js_of_ocaml-ppx >= "3.8.0" & < "6.1.0"
  30. js_of_ocaml-ppx_deriving_json < "6.1.0"
  31. js_of_ocaml-toplevel >= "3.10.0" & < "6.1.0"
  32. js_of_ocaml-tyxml >= "3.10.0" & < "6.1.0"
  33. jsoo-react
  34. lablqml
  35. landmarks-ppx < "1.6"
  36. lascar >= "0.7.0"
  37. learn-ocaml
  38. learn-ocaml-client
  39. lens >= "1.2.5"
  40. logs-ppx
  41. lwt_ppx >= "2.0.2" & < "5.9.2"
  42. melange = "1.0.0"
  43. melange-json >= "1.2.0" & < "2.0.0"
  44. merlin >= "4.7-412"
  45. metapp >= "0.4.0"
  46. metaquot >= "0.5.0"
  47. mlt_parser != "v0.14.0" & < "v0.16.0"
  48. neural_nets_lib < "0.5.2"
  49. noCanren
  50. node_of_ocaml
  51. nuscr >= "2.0.0"
  52. OCanren-ppx
  53. obus = "1.2.3"
  54. ocaml-in-python
  55. ocaml-monadic >= "0.5"
  56. ocf_ppx < "1.0.0"
  57. ocgtk < "0.1~preview2"
  58. ocsigen-i18n >= "4.0.0"
  59. ocsigen-ppx-rpc < "1.1"
  60. ojs_base_ppx < "0.9.0"
  61. ometrics >= "0.2.1"
  62. override >= "0.4.0"
  63. pacomb < "1.4.3"
  64. pgocaml_ppx >= "4.3.0"
  65. pla >= "2.0"
  66. ppx-owl-opt
  67. ppx_accessor >= "v0.14.3" & < "v0.16.0"
  68. ppx_assert < "v0.16.0"
  69. ppx_bap
  70. ppx_base < "v0.16.0"
  71. ppx_bench >= "v0.14.1" & < "v0.16.0"
  72. ppx_bin_prot < "v0.16.0"
  73. ppx_bitstring = "4.1.0"
  74. ppx_blob >= "0.7.2"
  75. ppx_camlrack
  76. ppx_cold < "v0.16.0"
  77. ppx_compare < "v0.16.0"
  78. ppx_compose >= "0.2.1"
  79. ppx_const >= "2.0.1"
  80. ppx_conv_func < "v0.16.0"
  81. ppx_counters
  82. ppx_css < "v0.16.0"
  83. ppx_cstruct >= "6.0.0"
  84. ppx_cstubs >= "0.6.1"
  85. ppx_csv_conv < "v0.16.0"
  86. ppx_custom_printf >= "v0.14.1" & < "v0.16.0"
  87. ppx_defer >= "0.5.0"
  88. ppx_deriving >= "5.2" & < "6.0.2"
  89. ppx_deriving_cad
  90. ppx_deriving_cmdliner >= "0.6.0"
  91. ppx_deriving_decoders
  92. ppx_deriving_encoding >= "0.2" & < "0.4.0"
  93. ppx_deriving_hardcaml < "v0.16.0"
  94. ppx_deriving_hash < "0.1.3"
  95. ppx_deriving_jsonschema < "0.0.7"
  96. ppx_deriving_jsoo >= "0.2"
  97. ppx_deriving_madcast >= "0.2"
  98. ppx_deriving_popper
  99. ppx_deriving_protobuf
  100. ppx_deriving_rpc < "10.0.0"
  101. ppx_deriving_scad
  102. ppx_deriving_variant_string
  103. ppx_deriving_yaml < "0.2.2"
  104. ppx_deriving_yojson = "3.6.1"
  105. ppx_disable_unused_warnings < "v0.16.0"
  106. ppx_distr_guards >= "0.3"
  107. ppx_dream_eml
  108. ppx_enumerate < "v0.16.0"
  109. ppx_expect != "v0.14.0" & < "v0.16.0"
  110. ppx_factory >= "0.2.0"
  111. ppx_fail
  112. ppx_fields_conv >= "v0.14.2" & < "v0.16.0"
  113. ppx_fixed_literal < "v0.16.0"
  114. ppx_fun
  115. ppx_gen_rec >= "2.0.0"
  116. ppx_getenv >= "2.1"
  117. ppx_hash < "v0.16.0"
  118. ppx_here < "v0.16.0"
  119. ppx_ignore_instrumentation < "v0.16.0"
  120. ppx_import != "1.8.0" & < "1.10.0"
  121. ppx_inline_alcotest
  122. ppx_inline_test >= "v0.14.1" & < "v0.16.0"
  123. ppx_irmin >= "3.0.0"
  124. ppx_jane < "v0.16.0"
  125. ppx_js_style < "v0.16.0"
  126. ppx_jsobject_conv < "0.9.3"
  127. ppx_jsonaf_conv < "v0.16.0"
  128. ppx_let < "v0.16.0"
  129. ppx_log < "v0.16.0"
  130. ppx_make
  131. ppx_matches < "0.1.0"
  132. ppx_module_timer < "v0.16.0"
  133. ppx_monad
  134. ppx_mysql >= "1.1.3"
  135. ppx_open
  136. ppx_optcomp >= "v0.14.2" & < "v0.16.0"
  137. ppx_optint
  138. ppx_optional < "v0.16.0"
  139. ppx_pattern_bind < "v0.16.0"
  140. ppx_pipebang < "v0.16.0"
  141. ppx_protocol_conv >= "5.1.3" & < "5.2.3"
  142. ppx_pyformat
  143. ppx_python = "v0.15.0"
  144. ppx_rapper
  145. ppx_rapper_async
  146. ppx_rapper_lwt
  147. ppx_regexp = "0.5.1"
  148. ppx_repr >= "0.6.0" & < "0.8.0"
  149. ppx_seq
  150. ppx_sexp_conv < "v0.14.0" | >= "v0.14.3" & < "v0.15.1"
  151. ppx_sexp_message >= "v0.14.1" & < "v0.16.0"
  152. ppx_sexp_value < "v0.16.0"
  153. ppx_show
  154. ppx_stable >= "v0.14.1" & < "v0.16.0"
  155. ppx_string >= "v0.14.1" & < "v0.16.0"
  156. ppx_string_interpolation
  157. ppx_subliner
  158. ppx_system
  159. ppx_ts
  160. ppx_type_directed_value
  161. ppx_typed_fields < "v0.16.0"
  162. ppx_typerep_conv >= "v0.14.2" & < "v0.16.0"
  163. ppx_units
  164. ppx_variants_conv >= "v0.14.2" & < "v0.16.0"
  165. ppx_viewpattern < "0.1.1"
  166. ppx_xml_conv < "v0.16.0"
  167. ppx_yojson >= "1.1.0" & < "1.3.0"
  168. ppx_yojson_conv < "v0.16.0"
  169. ppxx >= "2.5.0"
  170. pyro-caml-ppx
  171. qcow < "0.12.1"
  172. rdf_ppx < "1.0.0"
  173. reason-react-day-picker
  174. refl >= "0.4.0"
  175. repr-fuzz >= "0.2.1" & < "0.8.0"
  176. res_tailwindcss
  177. sedlex >= "2.3" & < "2.6"
  178. server-reason-react < "0.4.1"
  179. spectrum_palette_ppx
  180. speed
  181. spin >= "0.8.0"
  182. spoc_ppx
  183. stdint-literals
  184. stk_ppx
  185. togglelog
  186. toplevel_expect_test >= "v0.14.1" & < "v0.16.0"
  187. tyxml-jsx >= "4.5.0" & < "5.0.0"
  188. tyxml-ppx >= "4.5.0" & < "5.0.0"
  189. tyxml-syntax >= "4.5.0" & < "5.0.0"
  190. validate
  191. visitors >= "20210608" & < "20251010"
  192. wasm_of_ocaml-compiler < "6.1.0"
  193. wtr < "3.0.0"
  194. wtr-ppx
  195. xtmpl_ppx < "1.2.0"

Build status

Results of building ppxlib with each compiler on check.ci.ocaml.org, run of against opam-repository 7cdc698. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

This version is not in the latest run; the versions below are.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.39.0 good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure