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.25.1.tbz
sha256=a51b3868029e62ff14a0f2bd8d278dacfc0c3fc5b22d484a296be90c53e4ffd7
sha512=6a6d9af49344e901cc9e6da7bcf38c2973705c8cee4cff1c64c0393e9ccc55a6abec1f58d5b56d0807939a3741bec722ee7bfc244f94619167a30438f182488a

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