hvr / regex

regex: A Regular Expression Toolkit for regex-base

regex

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 and
• 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-20 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

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