regex 0.7.0.0 → 0.8.0.0

raw patch · 16 files changed

+246/−90 lines, 16 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• README.markdown +7/−2
• Text/RE.hs +12/−8
• Text/RE/TDFA/ByteString.hs +13/−7
• Text/RE/TDFA/ByteString/Lazy.hs +13/−7
• Text/RE/TDFA/Sequence.hs +13/−7
• Text/RE/TDFA/String.hs +13/−7
• Text/RE/TDFA/Text.hs +13/−7
• Text/RE/TDFA/Text/Lazy.hs +13/−7
• Text/RE/TestBench.lhs +6/−4
• Text/RE/Tools.hs +40/−0
• Text/RE/Tools/Edit.lhs +25/−7
• Text/RE/Tools/Grep.lhs +42/−13
• Text/RE/Tools/Lex.lhs +7/−1
• Text/RE/Tools/Sed.lhs +21/−9
• changelog +3/−0
• regex.cabal +5/−4

@@ -24,7 +24,10 @@ 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. @@ -57,7 +60,9 @@      ☒  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)+    ☒  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) 

@@ -9,7 +9,7 @@  module Text.RE   (-  -- * Tutorial+  -- * The Tutorial   -- $tutorial    -- * How to use this library@@ -98,14 +98,8 @@ --   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"@@ -114,6 +108,16 @@ -- * "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 --

@@ -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@@ -21,8 +22,13 @@   -- * 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 

@@ -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@@ -21,8 +22,13 @@   -- * 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 

@@ -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@@ -21,8 +22,13 @@   -- * 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 

@@ -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@@ -21,8 +22,13 @@   -- * 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 

@@ -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@@ -21,8 +22,13 @@   -- * 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 

@@ -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@@ -21,8 +22,13 @@   -- * 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 

@@ -34,6 +34,10 @@   , formatMacroSource   , testMacroDescriptors   , mdRegexSource+  -- * Parsers+  , module Text.RE.TestBench.Parsers+  -- * Text.RE+  , module Text.RE   ) where  import           Data.Array@@ -45,11 +49,9 @@ import           Data.String import           Text.Printf import           Prelude.Compat-import           Text.RE.Types.Capture+import           Text.RE+import           Text.RE.TestBench.Parsers import           Text.RE.Types.Options-import           Text.RE.Types.Match-import           Text.RE.Types.Matches-import           Text.RE.Types.Replace \end{code}  Types

@@ -0,0 +1,40 @@+module Text.RE.Tools+  (+  -- * The Tools+  -- $tools++  -- * Sed+    sed+  , sed'+  -- * Grep+  , grep+  , grepLines+  , GrepScript+  , grepScript+  , linesMatched+  -- * Lex+  , alex+  , alex'+  -- * IsRegex+  , IsRegex(..)+  -- * Edit+  , Edits(..)+  , Edit(..)+  , LineEdit(..)+  , applyEdits+  , applyEdit+  , applyLineEdit+  -- * LineNo+  , LineNo(..)+  , firstLine+  , getLineNo+  , lineNo+  -- * Text.RE+  , module Text.RE+  ) where++import           Text.RE+import           Text.RE.Tools.Edit+import           Text.RE.Tools.Grep+import           Text.RE.Tools.Lex+import           Text.RE.Tools.Sed

@@ -7,40 +7,50 @@ #endif  module Text.RE.Tools.Edit-  ( LineNo-  , Edits(..)+  ( Edits(..)   , Edit(..)   , LineEdit(..)   , applyEdits   , applyEdit   , applyLineEdit+  -- * LineNo+  , LineNo(..)+  , firstLine+  , getLineNo+  , lineNo+  -- * Text.RE+  , module Text.RE   ) where  import           Data.Maybe import           Prelude.Compat-import           Text.RE.Types.Capture-import           Text.RE.Types.Match-import           Text.RE.Types.Matches+import           Text.RE import           Text.RE.Types.IsRegex import           Text.RE.Types.LineNo-import           Text.RE.Types.Replace  +-- | an 'Edits' script will, for each line in the file, either perform+-- the action selected by the first RE in the list, or perform all of the+-- actions on line, arranged as a pipeline data Edits m re s   = Select [(re,Edit m s)]   | Pipe   [(re,Edit m s)] +-- | each Edit action specifies how the match should be processed data Edit m s   = Template s   | Function Context (LineNo->Match s->Location->Capture s->m (Maybe s))   | LineEdit         (LineNo->Matches s->m (LineEdit s)) +-- | a LineEdit is the most general action thar can be performed on a line+-- and is the only means of deleting a line data LineEdit s   = NoEdit   | ReplaceWith s   | Delete   deriving (Show) +-- | apply an 'Edit' script to a single line applyEdits :: (IsRegex re s,Monad m,Functor m)            => LineNo            -> Edits m re s@@ -50,6 +60,10 @@   Select ez -> select_edit_scripts lno ez s0   Pipe   ez -> pipe_edit_scripts   lno ez s0 +-- | apply a single edit action to a line, the function in the first argument+-- being used to add a new line onto the end of the line where appropriate;+-- the function returns @Nothing@ if no edit is to be performed on the line,+-- @Just mempty@ to delete the line applyEdit :: (IsRegex re s,Monad m,Functor m)           => (s->s)           -> LineNo@@ -68,10 +82,14 @@     s'  = anl s     acs = matchMany re s +-- | apply a 'LineEdit' to a line, using the function in the first+-- argument to append a new line to the result; Nothing should be+-- returned if no edit is to be performed,  @Just mempty@ to+-- delete the line applyLineEdit :: Monoid s => (s->s) -> LineEdit s -> Maybe s applyLineEdit _    NoEdit         = Nothing applyLineEdit anl (ReplaceWith s) = Just $ anl s-applyLineEdit _    Delete         = Just $ mempty+applyLineEdit _    Delete         = Just   mempty  select_edit_scripts :: (IsRegex re s,Monad m,Functor m)                     => LineNo

@@ -5,15 +5,23 @@ {-# LANGUAGE CPP                        #-}  module Text.RE.Tools.Grep-  ( Line(..)-  , grep+  ( grep+  , Line(..)   , grepLines   , GrepScript   , grepScript+  , report+  , Verbosity(..)   , linesMatched+  -- * IsRegex+  , IsRegex(..)+  -- * LineNo+  , LineNo(..)+  , firstLine+  , getLineNo+  , lineNo+  -- * Text.RE   , module Text.RE-  , module Text.RE.Types.IsRegex-  , module Text.RE.Types.LineNo   ) where  import qualified Data.ByteString.Lazy.Char8               as LBS@@ -24,24 +32,32 @@ import           Text.RE.Types.LineNo  +-- | operates a bit like classic @grep@ printing out the lines matched+grep :: IsRegex re LBS.ByteString => Verbosity -> re -> FilePath -> IO ()+grep v rex fp = grepLines rex fp >>= putStr . report v++-- | 'grepLines' returns a 'Line' for each line in the file, listing all+-- of the 'Matches' for that line data Line =   Line-    { getLineNumber  :: LineNo-    , getLineMatches :: Matches LBS.ByteString+    { getLineNumber  :: LineNo                  -- ^ the 'LineNo' for this line+    , getLineMatches :: Matches LBS.ByteString  -- ^ all the 'Matches' of the RE on this line     }   deriving (Show) -grep :: IsRegex re LBS.ByteString => re -> FilePath -> IO ()-grep rex fp = grepLines rex fp >>= putStr . report-+-- | returns a 'Line' for each line in the file enumerating all of the+-- matches for that line. grepLines :: IsRegex re LBS.ByteString => re -> FilePath -> IO [Line] grepLines rex fp =     grepScript [(rex,mk)] . LBS.lines <$> LBS.readFile fp   where     mk i mtchs = Just $ Line i mtchs +-- | a GrepScript lists RE-action associations, with the first RE to match+-- a line selecting the action to be executed on each line in the file type GrepScript re s t = [(re,LineNo -> Matches s -> Maybe t)] +-- | given a list of lines, apply the 'GrepScript' to each line of the file grepScript :: IsRegex re s => GrepScript re s t -> [s] -> [t] grepScript scr = loop firstLine   where@@ -53,13 +69,26 @@       Nothing -> choose i ln lns scr'       Just t  -> t : loop (succ i) lns -report :: [Line] -> String-report = unlines . map fmt . linesMatched+-- | generate a grep report from a list of 'Line'+report :: Verbosity -> [Line] -> String+report v = unlines . map fmt . linesMatched v   where     fmt Line{..} =       printf "%05d %s" (getLineNo getLineNumber) $           LBS.unpack $ matchesSource getLineMatches -linesMatched :: [Line] -> [Line]-linesMatched = filter $ anyMatches . getLineMatches+-- | specifies whether to return the linss matched or missed+data Verbosity+  = LinesMatched+  | LinesNotMatched+  deriving (Show,Eq,Ord)++-- | given a 'velocity' flag filter out either the lines matched or not+-- matched+linesMatched :: Verbosity -> [Line] -> [Line]+linesMatched v = filter $ f . anyMatches . getLineMatches+  where+    f = case v of+      LinesMatched    -> id+      LinesNotMatched -> not \end{code}

@@ -4,8 +4,10 @@ module Text.RE.Tools.Lex   ( alex   , alex'+  -- * IsRegex+  , IsRegex(..)+  -- * Text.RE   , module Text.RE-  , module Text.RE.Types.IsRegex   ) where  import           Prelude.Compat@@ -13,9 +15,13 @@ import           Text.RE.Types.IsRegex  +-- | a simple regex-based scanner interpretter for prototyping+-- scanners alex :: IsRegex re s => [(re,Match s->Maybe t)] -> t -> s -> [t] alex = alex' matchOnce +-- | a higher order version of 'alex' parameterised over the @matchOnce@+-- function alex' :: Replace s       => (re->s->Match s)       -> [(re,Match s->Maybe t)]

@@ -8,27 +8,38 @@ #endif  module Text.RE.Tools.Sed-  ( SedScript-  , sed+  ( sed   , sed'+  -- * IsRegex+  , IsRegex(..)+  -- * Edit+  , Edits(..)+  , Edit(..)+  , LineEdit(..)+  , applyEdits+  , applyEdit+  , applyLineEdit+  -- * LineNo+  , LineNo(..)+  , firstLine+  , getLineNo+  , lineNo+  -- * Text.RE   , module Text.RE-  , module Text.RE.Types.IsRegex-  , module Text.RE.Tools.Edit-  , module Text.RE.Types.LineNo   ) where  import qualified Data.ByteString.Lazy.Char8               as LBS import           Prelude.Compat import           Text.RE import           Text.RE.Tools.Edit-import           Text.RE.Types.LineNo import           Text.RE.Types.IsRegex  -type SedScript re = Edits IO re LBS.ByteString-+-- | read a file, apply an 'Edits' script to each line it and+-- write the file out again; "-" is used to indicate standard input+-- standard output as appropriate sed :: IsRegex re LBS.ByteString-    => SedScript re+    => Edits IO re LBS.ByteString     -> FilePath     -> FilePath     -> IO ()@@ -40,6 +51,7 @@         ]   write_file o_fp $ LBS.concat lns' +-- | apply an 'Edits' script to each line of the argument text sed' :: (IsRegex re a,Monad m,Functor m)      => Edits m re a      -> a

@@ -1,5 +1,8 @@ -*-change-log-*- +0.8.0.0 Chris Dornan <chris.dornan@irisconnect.co.uk> 2017-03-16+  * Tidy up the API after recent reorganization (#76)+ 0.7.0.0 Chris Dornan <chris.dornan@irisconnect.co.uk> 2017-03-15   * Fix and extend Replace class (#74)   * Better package organisation (#73)

@@ -1,5 +1,5 @@ Name:                   regex-Version:                0.7.0.0+Version:                0.8.0.0 Synopsis:               Toolkit for regex-base Description:            A Regular Expression Toolkit for regex-base with                         Compile-time checking of RE syntax, data types for@@ -31,7 +31,7 @@ Source-Repository this     Type:               git     Location:           https://github.com/iconnect/regex.git-    Tag:                0.7.0.0+    Tag:                0.8.0.0   @@ -45,8 +45,6 @@       Text.RE.Internal.NamedCaptures       Text.RE.Internal.PreludeMacros       Text.RE.Internal.QQ-      Text.RE.Types.IsRegex-      Text.RE.Types.Replace       Text.RE.TDFA       Text.RE.TDFA.ByteString       Text.RE.TDFA.ByteString.Lazy@@ -57,16 +55,19 @@       Text.RE.TDFA.Text.Lazy       Text.RE.TestBench       Text.RE.TestBench.Parsers+      Text.RE.Tools       Text.RE.Tools.Edit       Text.RE.Tools.Grep       Text.RE.Tools.Lex       Text.RE.Tools.Sed       Text.RE.Types.Capture       Text.RE.Types.CaptureID+      Text.RE.Types.IsRegex       Text.RE.Types.LineNo       Text.RE.Types.Match       Text.RE.Types.Matches       Text.RE.Types.Options+      Text.RE.Types.Replace      Default-Language:   Haskell2010     GHC-Options: