package re

  1. Overview
  2. Docs
RE is a regular expression library for OCaml

Install

Dune Dependency

github.com Readme Changelog LGPL-2.1-or-later WITH OCaml-LGPL-linking-exception License Edit opam file Versions (18)

Authors

  1. J
    Jerome Vouillon
  2. T
    Thomas Gazagnaire
  3. A
    Anil Madhavapeddy
  4. R
    Rudi Grinberg
  5. Gabriel Radanne

Maintainers

  1. R
    rudi.grinberg@gmail.com

Sources

re-1.12.0.tbz
sha256=a01f2bf22f72c2f4ababd8d3e7635e35c1bf6bc5a41ad6d5a007454ddabad1d4
sha512=f0726826e1e677f7ecdf447d46d814a11d3844ec6e5c0527be8c73c7afdb08aacfca47ea764eda325bcd7064aff07c1d3441c935ee5a0fc99ede8707f81a451d

Description

Pure OCaml regular expressions with:

  • Perl-style regular expressions (module Re.Perl)
  • Posix extended regular expressions (module Re.Posix)
  • Emacs-style regular expressions (module Re.Emacs)
  • Shell-style file globbing (module Re.Glob)
  • Compatibility layer for OCaml's built-in Str module (module Re.Str)

Published: 03 Sep 2024

README

Description

Re is a regular expression library for OCaml.

Contact

This library has been written by Jerome Vouillon (Jerome.Vouillon@pps.univ-paris-diderot.fr). It can be downloaded from https://github.com/ocaml/ocaml-re

Bug reports, suggestions and contributions are welcome.

Features

The following styles of regular expressions are supported:

  • Perl-style regular expressions (module Re.Perl);

  • Posix extended regular expressions (module Re.Posix);

  • Emacs-style regular expressions (module Re.Emacs);

  • Shell-style file globbing (module Re.Glob).

It is also possible to build regular expressions by combining simpler regular expressions (module Re).

The most notable missing features are back-references and look-ahead/look-behind assertions.

There is also a subset of the PCRE interface available in the Re.Pcre module. This makes it easier to port code from that library to Re with minimal changes.

Performances

The matches are performed by lazily building a DFA (deterministic finite automaton) from the regular expression. As a consequence, matching takes linear time in the length of the matched string.

The compilation of patterns is slower than with libraries using back-tracking, such as PCRE. But, once a large enough part of the DFA is built, matching is extremely fast.

Of course, for some combinations of regular expression and string, the part of the DFA that needs to be build is so large that this point is never reached, and matching will be slow. This is not expected to happen often in practice, and actually a lot of expressions that behaves badly with a backtracking implementation are very efficient with this implementation.

The library is at the moment entirely written in OCaml. As a consequence, regular expression matching is much slower when the library is compiled to bytecode than when it is compiled to native code.

Here are some timing results (Pentium III 500Mhz):

  • Scanning a 1Mb string containing only as, except for the last character which is a b, searching for the pattern aa?b (repeated 100 times):

    • RE: 2.6s

    • PCRE: 68s

  • Regular expression example from http://www.bagley.org/~doug/shootout/ [1]

    • RE: 0.43s

    • PCRE: 3.68s

    [1] this page is no longer up but is available via the Internet Archive http://web.archive.org/web/20010429190941/http://www.bagley.org/~doug/shootout/bench/regexmatch/

  • The large regular expression (about 2000 characters long) that Unison uses with my preference file to decide whether a file should be ignored or not. This expression is matched against a filename about 20000 times.

    • RE: 0.31s

    • PCRE: 3.7s However, RE is only faster than PCRE when there are more than about 300 filenames.

Dependencies (3)

  1. seq
  2. dune >= "2.0"
  3. ocaml >= "4.12"

Dev Dependencies (1)

  1. ounit2 with-test

  1. alcotest
  2. alcotest-async >= "1.3.0"
  3. alcotest-lwt >= "1.3.0"
  4. alcotest-mirage >= "1.3.0"
  5. atd >= "2.2.1"
  6. atdcpp
  7. atdd
  8. atdgen >= "2.3.3"
  9. atdgen-runtime = "2.2.1"
  10. atdj >= "2.2.1"
  11. atdpy >= "2.4.1"
  12. atds < "2.3.3"
  13. atdts
  14. aws-config
  15. awsm-codegen
  16. BetterErrors
  17. bap-byteweight-frontend
  18. bap-callgraph-collator
  19. bap-fsi-benchmark
  20. bap-ida
  21. bap-objdump
  22. bap-print >= "2.2.0"
  23. bap-radare2
  24. benchpress
  25. bio_io >= "0.5.1"
  26. biocaml
  27. bistro < "0.6.0"
  28. bonsai >= "v0.15.0"
  29. calculon
  30. calculon-web
  31. caldav
  32. calendar >= "3.0.0"
  33. camlp5 >= "8.00.05"
  34. camlp5-buildscripts
  35. camyll
  36. caqti >= "1.7.0"
  37. catala
  38. chamo
  39. cinaps >= "v0.10.0"
  40. cohttp
  41. coin
  42. colibri2
  43. commons
  44. conan >= "0.0.6"
  45. core_bench
  46. core_extended
  47. cosovo
  48. cowabloga >= "0.4.0"
  49. cucumber
  50. cuid
  51. current
  52. current_web >= "0.4"
  53. daypack-lib
  54. debian-formats
  55. decompress < "1.0.0"
  56. dkml-install-installer >= "0.4.0"
  57. dns < "4.0.0"
  58. doi2bib >= "0.5.1"
  59. dose3
  60. dune-release >= "0.2.0"
  61. dunolint-lib
  62. duppy >= "0.9.4"
  63. elpi
  64. expect >= "0.1.0"
  65. expect_test_helpers_core
  66. expect_test_helpers_kernel
  67. ez_file
  68. ez_search
  69. fat-filesystem
  70. git >= "1.9.0" & < "2.0.0"
  71. git-split < "1.0.0"
  72. gpiod
  73. graphql_parser >= "0.11.0"
  74. hardcaml_verify
  75. hardcaml_waveterm
  76. hardcaml_xilinx_components
  77. hlarp >= "0.0.3"
  78. horned_worm
  79. humane-re
  80. icalendar
  81. index
  82. index-bench
  83. irmin-bench >= "2.4.0"
  84. jingoo >= "1.2.21"
  85. js_of_ocaml >= "3.10.0"
  86. js_of_ocaml-compiler >= "3.10.0"
  87. js_of_ocaml-lwt >= "3.10.0"
  88. js_of_ocaml-ocamlbuild >= "3.10.0" & < "5.0"
  89. js_of_ocaml-ppx >= "3.10.0"
  90. js_of_ocaml-ppx_deriving_json >= "3.10.0"
  91. js_of_ocaml-toplevel >= "3.10.0"
  92. js_of_ocaml-tyxml >= "3.10.0"
  93. jwt
  94. jwto
  95. kappa-library
  96. kubecaml
  97. labrys
  98. lastfm >= "0.3.4"
  99. ldap >= "2.5.1"
  100. learn-ocaml
  101. lipsum
  102. liquidsoap >= "2.3.1"
  103. liquidsoap-core >= "2.3.0"
  104. liquidsoap-lang >= "2.3.0"
  105. MlFront_Cli >= "2.1.4~prerel2"
  106. MlFront_ZipFile
  107. magic-trace
  108. mdx
  109. mehari
  110. mirage-bootvar-xen < "0.3.2"
  111. mparser-re
  112. naboris
  113. netsnmp
  114. ninja_utils
  115. obelisk >= "0.5.0"
  116. ocaml-lsp-server >= "1.7.0"
  117. ocamlformat >= "0.11.0"
  118. ocamlformat-mlx
  119. ocamlformat-rpc < "0.21.0"
  120. ocamlmig
  121. ocp-build
  122. ocp-index
  123. ocsigen-start
  124. ocsigenserver >= "5.1.0"
  125. octez-bls12-381-signature
  126. octez-libs
  127. odoc >= "2.0.0" & < "2.1.0"
  128. opam-bin >= "0.9.5" & < "1.1.0"
  129. opam-client
  130. opam-compiler
  131. opam-core
  132. opam-format >= "2.0.8" & < "2.1.0~beta2" | >= "2.1.0~rc"
  133. opam-lib
  134. opam-solver >= "2.0.8" & < "2.1.0~beta2" | >= "2.2.0~alpha"
  135. opam-state >= "2.2.0~alpha"
  136. opam_bin_lib
  137. opium
  138. opium_kernel
  139. oranger
  140. orun
  141. ostap
  142. ozulip
  143. pa_ppx_parsetree
  144. pa_ppx_regexp >= "0.04"
  145. pa_ppx_string
  146. patdiff
  147. pgocaml >= "2.3"
  148. pgx
  149. plato
  150. podge >= "0.3"
  151. ppx_css < "v0.17.0"
  152. ppx_cstubs
  153. ppx_expect < "v0.17.0"
  154. ppx_expect_nobase
  155. ppx_minidebug >= "1.0.0"
  156. ppx_regexp >= "0.3.2"
  157. ppx_test
  158. ppx_tyre
  159. ppxlib >= "0.21.0"
  160. prometheus >= "0.2"
  161. prometheus-app
  162. pyml_bindgen >= "0.3.1"
  163. rdf >= "0.12.0"
  164. re_parser
  165. redis
  166. regenerate
  167. rfc1951 < "1.0.0"
  168. safemoney >= "0.3.0"
  169. sarek
  170. sarif >= "0.2.1"
  171. satyrographos >= "0.0.2.7"
  172. semantic_version
  173. sexp_pretty
  174. simple-diff
  175. slug
  176. soupault
  177. spoc
  178. swagger
  179. tar < "2.2.0"
  180. tar-mirage < "2.2.1"
  181. tar-unix < "2.2.0"
  182. testo
  183. testo-lwt
  184. testo-util
  185. tezos-clic >= "16.0"
  186. tezos-stdlib-unix
  187. tezt
  188. timere-parse
  189. touist >= "3.5.0"
  190. tyre >= "0.4"
  191. tyxml >= "4.2.0"
  192. tyxml-syntax
  193. uri < "4.0.0"
  194. uri-re
  195. user-agent-parser
  196. user-setup
  197. uuuu
  198. validate
  199. vendredi
  200. wasm_of_ocaml-compiler
  201. webmachine
  202. xtmpl >= "0.18.0"

Conflicts

None

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct