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 (23)

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 < "0.4.3" | >= "1.0.0"
  2. alcotest-async >= "1.3.0"
  3. alcotest-lwt >= "1.3.0"
  4. alcotest-mirage >= "1.3.0"
  5. atd >= "2.2.1"
  6. atdd
  7. atdgen >= "2.3.3"
  8. atdgen-runtime = "2.2.1"
  9. atdj >= "2.2.1" & < "20151001.01"
  10. atdpy >= "2.4.1"
  11. atds < "2.3.3"
  12. atdts
  13. aws-config
  14. awsm-codegen
  15. BetterErrors
  16. bap < "1.0.0"
  17. bap-byteweight-frontend
  18. bap-callgraph-collator
  19. bap-fsi-benchmark
  20. bap-ida
  21. bap-objdump < "1.4.0" | >= "1.6.0"
  22. bap-print >= "2.2.0"
  23. bap-radare2
  24. bap-server
  25. benchpress
  26. bio_io >= "0.5.1"
  27. biocaml = "0.4.0" | >= "0.8.0"
  28. bistro = "0.5.0"
  29. bonsai >= "v0.15.0"
  30. bulletml
  31. caisar
  32. calculon >= "0.2"
  33. calculon-web
  34. caldav
  35. calendar >= "3.0.0"
  36. camlp5 >= "8.00.05"
  37. camlp5-buildscripts
  38. camyll
  39. caqti >= "1.7.0"
  40. catala
  41. ccss >= "1.6"
  42. chamo >= "4.0"
  43. cinaps >= "v0.10.0"
  44. cohttp
  45. coin
  46. colibri2
  47. commons
  48. core_bench >= "v0.9.0"
  49. core_extended >= "v0.10.0"
  50. cosovo
  51. cow < "1.2.2"
  52. cowabloga >= "0.4.0"
  53. cucumber
  54. cuid
  55. current
  56. current_web >= "0.4"
  57. daypack-lib
  58. debian-formats
  59. decompress >= "0.8" & < "1.0.0"
  60. dkml-install-installer >= "0.4.0"
  61. dns < "4.0.0"
  62. dog < "0.2.1"
  63. doi2bib >= "0.5.1"
  64. dose
  65. dose3
  66. dune-release >= "0.2.0"
  67. duppy >= "0.9.4"
  68. elpi
  69. expect_test_helpers_core
  70. expect_test_helpers_kernel
  71. ez_file
  72. ez_search
  73. fat-filesystem != "0.12.0"
  74. frag
  75. gensqlite
  76. git < "1.3.0" | >= "1.9.0" & < "1.10.0"
  77. git-split < "1.0.0"
  78. git_split
  79. gpiod
  80. graphql_parser >= "0.11.0"
  81. hardcaml_verify
  82. hardcaml_waveterm
  83. hardcaml_xilinx_components
  84. hlarp >= "0.0.3"
  85. horned_worm
  86. http_router
  87. humane-re
  88. icalendar
  89. imaplet-lwt >= "0.1.9"
  90. index
  91. index-bench
  92. irmin != "0.8.1" & < "0.10.0" | >= "1.0.0" & < "1.2.0"
  93. irmin-bench >= "2.4.0"
  94. iso-filesystem
  95. jingoo >= "1.2.21"
  96. js_of_ocaml >= "3.10.0"
  97. js_of_ocaml-compiler >= "3.10.0"
  98. js_of_ocaml-lwt >= "3.10.0"
  99. js_of_ocaml-ocamlbuild >= "3.10.0" & < "5.0"
  100. js_of_ocaml-ppx >= "3.10.0"
  101. js_of_ocaml-ppx_deriving_json >= "3.10.0"
  102. js_of_ocaml-toplevel >= "3.10.0"
  103. js_of_ocaml-tyxml >= "3.10.0"
  104. jwt
  105. jwto
  106. kappa-library
  107. kubecaml
  108. labrys
  109. lastfm >= "0.3.4"
  110. ldap >= "2.5.1"
  111. learn-ocaml >= "0.13.0"
  112. libres3 >= "0.3"
  113. lipsum
  114. MlFront_Cli >= "2.1.4~prerel2"
  115. magic-trace
  116. mbr-format < "1.0.0"
  117. mdx
  118. mehari
  119. message-switch
  120. mirage >= "0.10.0" & < "2.4.0"
  121. mirage-bootvar-xen < "0.3.2"
  122. mirage-www < "1.0.0"
  123. mparser-re
  124. mustache < "2.0.0"
  125. naboris
  126. netsnmp
  127. ninja_utils
  128. obelisk >= "0.5.0"
  129. ocaml-lsp-server >= "1.7.0"
  130. ocamlformat >= "0.11.0"
  131. ocamlformat-rpc < "0.21.0"
  132. ocp-build >= "1.99.21"
  133. ocp-index >= "1.0.2"
  134. ocsigen-start >= "1.7.0"
  135. ocsigenserver >= "5.1.0"
  136. octez-bls12-381-signature
  137. octez-libs
  138. odoc >= "2.0.0" & < "2.1.0"
  139. opam-bin >= "0.9.5" & < "1.1.0"
  140. opam-build-revdeps
  141. opam-client >= "2.0.0~rc2"
  142. opam-compiler
  143. opam-core
  144. opam-format >= "2.0.8" & < "2.1.0~beta2" | >= "2.1.0~rc"
  145. opam-lib
  146. opam-solver >= "2.0.8" & < "2.1.0~beta2" | >= "2.2.0~alpha"
  147. opam-state >= "2.2.0~alpha"
  148. opam2web >= "1.3.0"
  149. opam_bin_lib
  150. operf-macro
  151. opium >= "0.13.1"
  152. opium_kernel
  153. oranger
  154. orun
  155. ostap
  156. ozulip
  157. pa_ppx_parsetree
  158. pa_ppx_regexp >= "0.02"
  159. pa_ppx_string
  160. patdiff >= "v0.12.0"
  161. pgocaml >= "2.3"
  162. pgx
  163. plato
  164. podge >= "0.3"
  165. ppx_css < "v0.17.0"
  166. ppx_cstubs
  167. ppx_expect >= "113.33.00" & < "v0.17.0"
  168. ppx_implicits >= "0.1.0"
  169. ppx_minidebug >= "1.0.0"
  170. ppx_orakuda >= "3.0.0"
  171. ppx_regexp >= "0.3.2"
  172. ppx_sqlexpr
  173. ppx_test >= "1.1.0"
  174. ppx_tyre
  175. ppxlib >= "0.21.0"
  176. prometheus >= "0.2"
  177. prometheus-app >= "0.2"
  178. pyml_bindgen >= "0.3.1"
  179. rdf >= "0.12.0"
  180. re_parser
  181. reason < "1.7.4"
  182. receive-mail
  183. redis >= "0.2.1"
  184. regenerate
  185. rfc1951 < "1.0.0"
  186. sarek >= "20210823"
  187. sarif >= "0.2.1"
  188. satyrographos >= "0.0.2.7"
  189. semantic_version
  190. sexp_pretty
  191. sill >= "1.3.1"
  192. simple-diff
  193. slug
  194. soupault
  195. spoc >= "20210823"
  196. sqlexpr >= "0.7.1" & < "0.9.0"
  197. swagger
  198. tar < "2.2.0"
  199. tar-format >= "0.2.0"
  200. tar-mirage < "2.2.0"
  201. tar-unix < "2.2.0"
  202. testrunner
  203. tezos-base < "7.4"
  204. tezos-clic < "8.0" | >= "13.0"
  205. tezos-protocol-compiler = "10.2" | = "13.0"
  206. tezos-stdlib-unix >= "7.4"
  207. tezt
  208. timere-parse
  209. touist >= "3.5.0"
  210. tyre >= "0.4"
  211. tyxml >= "4.0.0"
  212. tyxml-syntax
  213. uri < "4.0.0"
  214. uri-re
  215. user-agent-parser
  216. user-setup
  217. uuuu
  218. validate
  219. vendredi
  220. vhd-tool >= "0.12.0"
  221. webmachine
  222. xapi-idl
  223. xe
  224. xen-api-client >= "0.9.6"
  225. xtmpl >= "0.15.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