package re

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

Install 

dune-project
 Dependency

github.com Readme Changelog LGPL-2.0-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (19)

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.7.2.tbz
sha256=f04c5ab5278e8967aafe23ba3de1bf18a359d0a6ab19b6d7a37109f9882adad1
md5=d7c94a401d03f4688aabc60cd40217aa

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 Mar 2018

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 library. This makes it easier to port code from that library to Re without any changes beyond replacing the pcre findlib package with re.pcre.

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. base-bytes
  2. jbuilder >= "1.0+beta7"
  3. ocaml >= "4.02.3"

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. bibfmt
  25. biocaml
  26. bistro < "0.6.0"
  27. calculon
  28. calculon-web
  29. caldav
  30. calendar >= "3.0.0"
  31. caqti >= "1.7.0"
  32. cinaps >= "v0.10.0" & < "v0.12.0"
  33. cohttp < "2.4.0"
  34. coin
  35. cowabloga >= "0.4.0"
  36. cuid
  37. daypack-lib
  38. debian-formats < "0.1.2"
  39. decompress < "1.0.0"
  40. dkml-install-installer >= "0.4.0"
  41. dns < "4.4.1"
  42. doi2bib
  43. dose3
  44. dune-release >= "0.2.0"
  45. duppy >= "0.9.4"
  46. elpi
  47. fat-filesystem
  48. git-split < "0.0.4"
  49. graphql_parser >= "0.11.0"
  50. hlarp >= "0.0.3"
  51. humane-re
  52. icalendar
  53. index
  54. index-bench < "1.3.2" | = "1.4.0"
  55. jingoo >= "1.2.21"
  56. js_of_ocaml-compiler >= "3.10.0"
  57. jsonschema
  58. jwt
  59. jwto < "0.2.0"
  60. kappa-library
  61. labrys
  62. ldap >= "2.5.1"
  63. learn-ocaml
  64. ledes
  65. lipsum
  66. mdx
  67. mparser-re
  68. naboris
  69. nx-text
  70. obelisk >= "0.5.0"
  71. ocaml-lsp-server >= "1.9.0"
  72. ocamlformat >= "0.11.0" & < "0.25.1"
  73. ocamlformat-rpc >= "0.19.0" & < "0.21.0"
  74. ocp-index < "1.2"
  75. ocsigen-start
  76. opam-bin >= "0.9.5" & < "1.1.0"
  77. opam-client < "2.1.0"
  78. opam-compiler
  79. opam-core < "2.1.0~beta4"
  80. opam-format >= "2.0.8" & < "2.1.0~beta4"
  81. opam-lib
  82. opam-solver >= "2.0.8" & < "2.1.0"
  83. opam_bin_lib
  84. opium
  85. opium_kernel
  86. oranger < "3.0.1"
  87. ostap < "0.6"
  88. ozulip
  89. pgocaml >= "2.3"
  90. pgx
  91. podge >= "0.3"
  92. ppx_cstubs
  93. ppx_minidebug >= "1.6.0"
  94. ppx_regexp >= "0.3.2"
  95. ppx_tyre
  96. prometheus >= "0.2"
  97. redis
  98. regenerate
  99. rfc1951 < "1.0.0"
  100. safemoney >= "0.3.0"
  101. sarek
  102. sarif >= "0.2.1"
  103. simple-diff
  104. slug
  105. snf_mcp
  106. soupault < "3.2.0"
  107. spoc
  108. tezos-stdlib-unix < "16.0"
  109. tezt
  110. touist >= "3.5.0"
  111. tyre < "0.4"
  112. tyxml >= "4.2.0"
  113. tyxml-syntax
  114. uri < "2.2.1"
  115. user-setup
  116. uuuu
  117. validate
  118. wasm_of_ocaml-compiler
  119. webmachine

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