Toolkit for regex-base.

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 with parsers and test bench, comprehensive documentation, tutorials and copious examples.

regex

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

• a text-replacement toolkit with type-safe text-replacement templates;
• 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 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 back ends;
• comprehensive documentation, tutorials 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

• [X] 2017-04-10 v1.0.0.0 First stable release
• [X] 2017-06-03 v1.0.1.0 PCRE.Text, strict PVP, Update Stackage vrns, add re-top
• [X] 2017-06-04 v1.0.1.1 Fix 1.0.1.0 release bug and provisionally fix UTF8/PCRE interworking
• [X] 2017-06-05 v1.0.1.2 Permit utf8-string-1
• [X] 2017-06-05 v1.0.1.3 Suspend Windows tests for PCRE on UTF-8 text
• [X] 2018-12-14 v1.0.1.4 Fix for GHC 8.4.4, GHC-8.6.2
• [X] 2018-12-18 v1.0.1.5 TDFA quasi quoters not dealing with newlines
• [X] 2018-12-19 v1.0.2.0 Tidy build issues
• [X] 2020-01-27 v1.1.0.0 Adapt for MonadFail/base-4.13/GHC-8.8
• [X] 2021-12-18 v1.1.0.1 Fix for base-4.16.0.0/GHC 9.2.1

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

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
  
• e [email protected]
  
• w http://issues.regex.uk

The Contact page has more details.

The API

The Haddocks can be found at http://hs.regex.uk.

The Macro Tables

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

The regex.uk Directory

A handy overview of the regex.uk 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.