Skip to content

0.8.0.0: Tidy up the API #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cdornan merged 1 commit into from
Mar 17, 2017
Merged

0.8.0.0: Tidy up the API #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ See the [About page](http://about.regex.uk) for details.
The library and tutorial, tests and examples have been split across
two packages:

* the `regex` package contains the regex library and
* 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.

Expand All @@ -44,7 +47,8 @@ two packages:
- [X] 2017-03-13 v0.6.0.0 [Split out PCRE](https://github.com/iconnect/regex/milestone/7)
- [X] 2017-03-13 v0.6.0.1 [Fix .travis.yml release-stack script](https://github.com/iconnect/regex/issues/67)
- [X] 2017-03-15 v0.7.0.0 [Better organization of API](https://github.com/iconnect/regex/milestone/8)
- [ ] 2017-03-17 v0.8.0.0 [Add type-safe replacement templates and use TemplateHaskellQuotes](https://github.com/iconnect/regex/milestone/9)
- [X] 2017-03-16 v0.8.0.0 [Tidy up the API](https://github.com/iconnect/regex/milestone/10)
- [ ] 2017-03-18 v0.9.0.0 [Add type-safe replacement templates and use TemplateHaskellQuotes](https://github.com/iconnect/regex/milestone/9)
- [ ] 2017-03-31 v1.0.0.0 [First stable release](https://github.com/iconnect/regex/milestone/3)
- [ ] 2017-08-31 v2.0.0.0 [Fast text replacement with benchmarks](https://github.com/iconnect/regex/milestone/4)

Expand Down
20 changes: 12 additions & 8 deletions Text/RE.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

module Text.RE
(
-- * Tutorial
-- * The Tutorial
-- $tutorial

-- * How to use this library
Expand Down Expand Up @@ -98,14 +98,8 @@ import Text.RE.Types.Replace
-- or indeed a good old-fashioned polymorphic operators?
--
-- While we aim to provide all combinations of these choices, some of them
-- are currently not available. We have:
-- are currently not available. In the regex package we have:
--
-- * "Text.RE.PCRE"
-- * "Text.RE.PCRE.ByteString"
-- * "Text.RE.PCRE.ByteString.Lazy"
-- * "Text.RE.PCRE.RE"
-- * "Text.RE.PCRE.Sequence"
-- * "Text.RE.PCRE.String"
-- * "Text.RE.TDFA"
-- * "Text.RE.TDFA.ByteString"
-- * "Text.RE.TDFA.ByteString.Lazy"
Expand All @@ -114,6 +108,16 @@ import Text.RE.Types.Replace
-- * "Text.RE.TDFA.String"
-- * "Text.RE.TDFA.Text"
-- * "Text.RE.TDFA.Text.Lazy"
--
-- The PCRE modules are contained in the separate @regex-with-pcre@
-- package:
--
-- * "Text.RE.PCRE"
-- * "Text.RE.PCRE.ByteString"
-- * "Text.RE.PCRE.ByteString.Lazy"
-- * "Text.RE.PCRE.RE"
-- * "Text.RE.PCRE.Sequence"
-- * "Text.RE.PCRE.String"

-- $operators
--
Expand Down
20 changes: 13 additions & 7 deletions Text/RE/PCRE/ByteString.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 800
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
#endif
Expand All @@ -21,8 +22,13 @@ module Text.RE.PCRE.ByteString
-- * The Toolkit
-- $toolkit
, module Text.RE
-- * The 'RE' Type
-- * The 'RE' Type and functions
-- $re
, RE
, reSource
, compileRegex
, compileRegexWith
, escape
, module Text.RE.PCRE.RE
) where

Expand Down
20 changes: 13 additions & 7 deletions Text/RE/PCRE/ByteString/Lazy.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 800
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
#endif
Expand All @@ -21,8 +22,13 @@ module Text.RE.PCRE.ByteString.Lazy
-- * The Toolkit
-- $toolkit
, module Text.RE
-- * The 'RE' Type
-- * The 'RE' Type and functions
-- $re
, RE
, reSource
, compileRegex
, compileRegexWith
, escape
, module Text.RE.PCRE.RE
) where

Expand Down
20 changes: 13 additions & 7 deletions Text/RE/PCRE/Sequence.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 800
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
#endif
Expand All @@ -21,8 +22,13 @@ module Text.RE.PCRE.Sequence
-- * The Toolkit
-- $toolkit
, module Text.RE
-- * The 'RE' Type
-- * The 'RE' Type and functions
-- $re
, RE
, reSource
, compileRegex
, compileRegexWith
, escape
, module Text.RE.PCRE.RE
) where

Expand Down
20 changes: 13 additions & 7 deletions Text/RE/PCRE/String.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 800
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
#endif
Expand All @@ -21,8 +22,13 @@ module Text.RE.PCRE.String
-- * The Toolkit
-- $toolkit
, module Text.RE
-- * The 'RE' Type
-- * The 'RE' Type and functions
-- $re
, RE
, reSource
, compileRegex
, compileRegexWith
, escape
, module Text.RE.PCRE.RE
) where

Expand Down
20 changes: 13 additions & 7 deletions Text/RE/TDFA/ByteString.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 800
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
#endif
Expand All @@ -21,8 +22,13 @@ module Text.RE.TDFA.ByteString
-- * The Toolkit
-- $toolkit
, module Text.RE
-- * The 'RE' Type
-- * The 'RE' Type and functions
-- $re
, RE
, reSource
, compileRegex
, compileRegexWith
, escape
, module Text.RE.TDFA.RE
) where

Expand Down
20 changes: 13 additions & 7 deletions Text/RE/TDFA/ByteString/Lazy.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 800
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
#endif
Expand All @@ -21,8 +22,13 @@ module Text.RE.TDFA.ByteString.Lazy
-- * The Toolkit
-- $toolkit
, module Text.RE
-- * The 'RE' Type
-- * The 'RE' Type and functions
-- $re
, RE
, reSource
, compileRegex
, compileRegexWith
, escape
, module Text.RE.TDFA.RE
) where

Expand Down
20 changes: 13 additions & 7 deletions Text/RE/TDFA/Sequence.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 800
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
#endif
Expand All @@ -21,8 +22,13 @@ module Text.RE.TDFA.Sequence
-- * The Toolkit
-- $toolkit
, module Text.RE
-- * The 'RE' Type
-- * The 'RE' Type and functions
-- $re
, RE
, reSource
, compileRegex
, compileRegexWith
, escape
, module Text.RE.TDFA.RE
) where

Expand Down
20 changes: 13 additions & 7 deletions Text/RE/TDFA/String.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 800
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
#endif
Expand All @@ -21,8 +22,13 @@ module Text.RE.TDFA.String
-- * The Toolkit
-- $toolkit
, module Text.RE
-- * The 'RE' Type
-- * The 'RE' Type and functions
-- $re
, RE
, reSource
, compileRegex
, compileRegexWith
, escape
, module Text.RE.TDFA.RE
) where

Expand Down
20 changes: 13 additions & 7 deletions Text/RE/TDFA/Text.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 800
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
#endif
Expand All @@ -21,8 +22,13 @@ module Text.RE.TDFA.Text
-- * The Toolkit
-- $toolkit
, module Text.RE
-- * The 'RE' Type
-- * The 'RE' Type and functions
-- $re
, RE
, reSource
, compileRegex
, compileRegexWith
, escape
, module Text.RE.TDFA.RE
) where

Expand Down
20 changes: 13 additions & 7 deletions Text/RE/TDFA/Text/Lazy.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# LANGUAGE CPP #-}
#if __GLASGOW_HASKELL__ >= 800
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
#endif
Expand All @@ -21,8 +22,13 @@ module Text.RE.TDFA.Text.Lazy
-- * The Toolkit
-- $toolkit
, module Text.RE
-- * The 'RE' Type
-- * The 'RE' Type and functions
-- $re
, RE
, reSource
, compileRegex
, compileRegexWith
, escape
, module Text.RE.TDFA.RE
) where

Expand Down
Loading