regex: Toolkit for regex-base

[ bsd3, library, text ] [ Propose Tags ]

A Regular Expression Toolkit for regex-base with Compile-time checking of RE syntax, data types for matches and captures, a text replacement toolkit, portable options, high-level AWK-like tools for building text processing apps, regular expression macros and test bench, a tutorial and copious examples.

[Skip to Readme]


Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


  • No Candidates
Versions [RSS],,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, (info)
Change log changelog
Dependencies array (>=0.4), base (>=4 && <5), base-compat (>=0.6.0 && <0.10), bytestring (>=, containers (>=0.4), hashable (>=, regex-base (>=0.93.2), regex-tdfa (>=1.2.0), regex-tdfa-text (>=, template-haskell (>=2.7), text (>=, time (>=1.4.2), time-locale-compat (>=, transformers (>=0.2.2), unordered-containers (>= [details]
License BSD-3-Clause
Copyright Chris Dornan 2016-2017
Author Chris Dornan
Maintainer Chris Dornan <>
Revised Revision 1 made by phadej at 2019-11-14T11:21:48Z
Category Text
Home page
Bug tracker
Source repo head: git clone
this: git clone
Uploaded by ChrisDornan at 2017-03-29T22:25:23Z
Distributions LTSHaskell:, NixOS:, Stackage:
Reverse Dependencies 9 direct, 2 indirect [details]
Downloads 25345 total (125 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-03-29 [all 1 reports]

Readme for regex-

[back to package description]


regex is a regular expression toolkit for regex-base with:

  • text-replacement operations with named captures;
  • special datatypes for matches and captures;
  • compile-time checking of RE syntax;
  • a unified means of controlling case-sensitivity and multi-line options;
  • high-level AWK-like tools for building text processing apps;
  • the option of using match operators with reduced polymorphism on the text and/or result types;
  • regular expression macros including:
    • a number of useful RE macros;
    • a test bench for testing and documenting new macro environments;
  • built-in support for the TDFA and PCRE backends;
  • comprehensive documentation and copious examples.

See the About page for details.

regex and regex-examples

The library and tutorial, tests and examples have been split across two packages:

  • the regex package contains the regex library with the Posix TDFA back end
  • the regex-with-pcre library package contains the extra modules needed for the PCRE back end
  • the regex-examples package contains the tutorial, tests and example programs.

Road Map

    ☒  2017-01-26 v0.0.0.1 Pre-release (I)

    ☒  2017-01-30 v0.0.0.2 Pre-release (II)

    ☒  2017-02-18 v0.1.0.0 Proposed core API with presentable Haddocks

    ☒  2017-02-19 v0.2.0.0 Package split into regex and regex-examples

    ☒  2017-02-20 v0.2.0.1 Remove library from regex-examples

    ☒  2017-02-21 v0.2.0.2 Fix tests for Hackage

    ☒  2017-02-21 v0.2.0.3 Tweak README/index layout

    ☒  2017-02-22 v0.2.0.4 Repair re-gen-modules-test for Windows

    ☒  2017-02-26 v0.3.0.0 API adjustments

    ☒  2017-03-05 v0.5.0.0 Ready for review: API, tutorials and examples finalized

    ☒  2017-03-13 v0.6.0.0 Split out PCRE

    ☒  2017-03-13 v0.6.0.1 Fix .travis.yml release-stack script

    ☒  2017-03-15 v0.7.0.0 Better organization of API

    ☒  2017-03-16 v0.8.0.0 Tidy up the API

    ☒  2017-03-24 v0.9.0.0 Finish tidying up the API, Add type-safe replacement templates and exploit TemplateHaskellQuotes

    ☒  2017-03-27 v0.10.0.2 Tweak Templates, Fix release scripts and update Haddocks commentary

    ☒  2017-03-28 v0.10.0.3 Upgrade to LTS 8.6 and Improve Haddocks for Text.RE.{TDFA,PCRE}

    ☒  2017-03-29 v0.11.0.0 Simplify the API

    ☐  2017-03-31 v1.0.0.0 First stable release

    ☐  2017-08-31 v2.0.0.0 Fast text replacement with benchmarks

See the Roadmap page for details.

The regex blog

Check out the regex blog for news articles and discussion concerning all things regex.

Build Status

Hackage BSD3 License Un*x build Windows build Coverage

See build status page for details.

Installing the Package

The package can be easily installed with cabal or stack on GHC-8.0, 7.10 or 7.8 for the above platforms. See the Installation page for details.

The Tutorial Tests and Examples

See the Tutorial page and Examples page for details.

Helping Out

If you have any feedback or suggestion then please drop us a line.

    t @hregex\n     e\n     w

The Contact page has more details.


The Haddocks can be found at

The Macro Tables

The macro environments are an important part of the package and are documented here.

The Directory

A handy overview of the domain can be found here.

The Changelog

The changelog is posted here.

The Authors

This library was written and is currently maintained by Chris Dornan aka @cdornan