package re

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

Install 

dune-project
 Dependency

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

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.11.0.tbz
sha256=01fc244780c0f6be72ae796b1fb750f367de18624fd75d07ee79782ed6df8d4f
sha512=3e3712cc1266ec1f27620f3508ea2ebba338f4083b07d8a69dccee1facfdc1971a6c39f9deea664d2a62fd7f2cfd2eae816ca4c274acfadaee992a3befc4b757

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: 23 Aug 2023

README

Description

Re is a regular expression library for OCaml. Build status

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.03"

Dev Dependencies (1)

  1. ounit with-test

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

Conflicts

None