@@ -3,7 +3,9 @@
3#if __GLASGOW_HASKELL__ >= 702
3#if __GLASGOW_HASKELL__ >= 702
4{-# LANGUAGE Trustworthy #-}
4{-# LANGUAGE Trustworthy #-}
6−{-# LANGUAGE MonoLocalBinds #-}
6+#if __GLASGOW_HASKELL__ >= 708
7+{-# LANGUAGE TypeFamilies #-}
9-- Module : Data.Text
11-- Module : Data.Text
@@ -127,6 +129,7 @@ module Data.Text
128 , dropEnd
130 , dropEnd
129 , takeWhile
131 , takeWhile
130 , dropWhile
133 , dropWhile
131 , dropWhileEnd
134 , dropWhileEnd
132 , dropAround
135 , dropAround
@@ -189,15 +192,16 @@ module Data.Text
190 -- * Low level operations
193 -- * Low level operations
194import Prelude (Char, Bool(..), Int, Maybe(..), String,
198import Prelude (Char, Bool(..), Int, Maybe(..), String,
195 Eq(..), Ord(..), Ordering(..), (++),
199 Eq(..), Ord(..), Ordering(..), (++),
196− Read(..), Show(..),
200+ Read(..),
197 (&&), (||), (+), (-), (.), ($), ($!), (>>),
201 (&&), (||), (+), (-), (.), ($), ($!), (>>),
198 not, return, otherwise, quot)
202 not, return, otherwise, quot)
199#if defined(HAVE_DEEPSEQ)
203#if defined(HAVE_DEEPSEQ)
200−import Control.DeepSeq (NFData)
204+import Control.DeepSeq (NFData(rnf))
202#if defined(ASSERTS)
206#if defined(ASSERTS)
203import Control.Exception (assert)
207import Control.Exception (assert)
@@ -209,13 +213,19 @@ import Control.Monad (foldM)
209import Control.Monad.ST (ST)
213import Control.Monad.ST (ST)
210import qualified Data.Text.Array as A
214import qualified Data.Text.Array as A
211import qualified Data.List as L
215import qualified Data.List as L
216+import Data.Binary (Binary(get, put))
212import Data.Monoid (Monoid(..))
217import Data.Monoid (Monoid(..))
218+#if MIN_VERSION_base(4,9,0)
219+import Data.Semigroup (Semigroup(..))
213import Data.String (IsString(..))
221import Data.String (IsString(..))
214import qualified Data.Text.Internal.Fusion as S
222import qualified Data.Text.Internal.Fusion as S
215import qualified Data.Text.Internal.Fusion.Common as S
223import qualified Data.Text.Internal.Fusion.Common as S
224+import Data.Text.Encoding (decodeUtf8', encodeUtf8)
216import Data.Text.Internal.Fusion (stream, reverseStream, unstream)
225import Data.Text.Internal.Fusion (stream, reverseStream, unstream)
217import Data.Text.Internal.Private (span_)
226import Data.Text.Internal.Private (span_)
218import Data.Text.Internal (Text(..), empty, firstf, mul, safe, text)
227import Data.Text.Internal (Text(..), empty, firstf, mul, safe, text)
228+import Data.Text.Show (singleton, unpack, unpackCString#)
219import qualified Prelude as P
229import qualified Prelude as P
220import Data.Text.Unsafe (Iter(..), iter, iter_, lengthWord16, reverseIter,
230import Data.Text.Unsafe (Iter(..), iter, iter_, lengthWord16, reverseIter,
221 reverseIter_, unsafeHead, unsafeTail)
231 reverseIter_, unsafeHead, unsafeTail)
@@ -228,12 +238,13 @@ import Data.ByteString (ByteString)
228import qualified Data.Text.Lazy as L
238import qualified Data.Text.Lazy as L
229import Data.Int (Int64)
239import Data.Int (Int64)
241+import GHC.Base (eqInt, neInt, gtInt, geInt, ltInt, leInt)
231−#if __GLASGOW_HASKELL__ >= 702
242+#if __GLASGOW_HASKELL__ >= 708
232−import qualified GHC.CString as GHC
243+import qualified GHC.Exts as Exts
234−import qualified GHC.Base as GHC
245+#if MIN_VERSION_base(4,7,0)
246+import Text.Printf (PrintfArg, formatArg, formatString)
236−import GHC.Prim (Addr#)
238-- $strict
249-- $strict
@@ -319,24 +330,48 @@ instance Eq Text where
319instance Ord Text where
330instance Ord Text where
320 compare = compareText
331 compare = compareText
322−instance Show Text where
323− showsPrec p ps r = showsPrec p (unpack ps) r
325instance Read Text where
333instance Read Text where
326 readsPrec p str = [(pack x,y) | (x,y) <- readsPrec p str]
334 readsPrec p str = [(pack x,y) | (x,y) <- readsPrec p str]
336+#if MIN_VERSION_base(4,9,0)
337+-- Semigroup orphan instances for older GHCs are provided by
338+-- 'semigroups` package
340+instance Semigroup Text where
328instance Monoid Text where
344instance Monoid Text where
329 mempty = empty
345 mempty = empty
346+#if MIN_VERSION_base(4,9,0)
347+ mappend = (<>) -- future-proof definition
330 mappend = append
349 mappend = append
331 mconcat = concat
351 mconcat = concat
333instance IsString Text where
353instance IsString Text where
334 fromString = pack
354 fromString = pack
356+#if __GLASGOW_HASKELL__ >= 708
357+instance Exts.IsList Text where
358+ type Item Text = Char
336#if defined(HAVE_DEEPSEQ)
363#if defined(HAVE_DEEPSEQ)
337−instance NFData Text
364+instance NFData Text where rnf !_ = ()
367+instance Binary Text where
368+ put t = put (encodeUtf8 t)
371+ case decodeUtf8' bs of
372+ P.Left exn -> P.fail (P.show exn)
373+ P.Right a -> P.return a
340-- | This instance preserves data abstraction at the cost of inefficiency.
375-- | This instance preserves data abstraction at the cost of inefficiency.
341-- We omit reflection services for the sake of data abstraction.
376-- We omit reflection services for the sake of data abstraction.
@@ -360,6 +395,12 @@ instance Data Text where
360 _ -> P.error "gunfold"
395 _ -> P.error "gunfold"
361 dataTypeOf _ = textDataType
396 dataTypeOf _ = textDataType
398+#if MIN_VERSION_base(4,7,0)
399+-- | Only defined for @base-4.7.0.0@ and later
400+instance PrintfArg Text where
401+ formatArg txt = formatString $ unpack txt
363packConstr :: Constr
404packConstr :: Constr
364packConstr = mkConstr textDataType "pack" [] Prefix
405packConstr = mkConstr textDataType "pack" [] Prefix
@@ -389,30 +430,6 @@ pack :: String -> Text
389pack = unstream . S.map safe . S.streamList
430pack = unstream . S.map safe . S.streamList
390{-# INLINE [1] pack #-}
431{-# INLINE [1] pack #-}
392−-- | /O(n)/ Convert a 'Text' into a 'String'. Subject to fusion.
393−unpack :: Text -> String
394−unpack = S.unstreamList . stream
395−{-# INLINE [1] unpack #-}
397−-- | /O(n)/ Convert a literal string into a Text. Subject to fusion.
398−unpackCString# :: Addr# -> Text
399−unpackCString# addr# = unstream (S.streamCString# addr#)
400−{-# NOINLINE unpackCString# #-}
402−{-# RULES "TEXT literal" forall a.
403− unstream (S.map safe (S.streamList (GHC.unpackCString# a)))
404− = unpackCString# a #-}
406−{-# RULES "TEXT literal UTF8" forall a.
407− unstream (S.map safe (S.streamList (GHC.unpackCStringUtf8# a)))
408− = unpackCString# a #-}
410−-- | /O(1)/ Convert a character into a Text. Subject to fusion.
411−-- Performs replacement on invalid scalar values.
412−singleton :: Char -> Text
413−singleton = unstream . S.singleton . safe
414−{-# INLINE [1] singleton #-}
416-- -----------------------------------------------------------------------------
433-- -----------------------------------------------------------------------------
417-- * Basic functions
434-- * Basic functions
@@ -469,8 +486,8 @@ head t = S.head (stream t)
469uncons :: Text -> Maybe (Char, Text)
486uncons :: Text -> Maybe (Char, Text)
470uncons t@(Text arr off len)
487uncons t@(Text arr off len)
471 | len <= 0 = Nothing
488 | len <= 0 = Nothing
489+ | otherwise = Just $ let !(Iter c d) = iter t 0
472− | otherwise = Just (c, text arr (off+d) (len-d))
490+ in (c, text arr (off+d) (len-d))
473− where Iter c d = iter t 0
474{-# INLINE [1] uncons #-}
491{-# INLINE [1] uncons #-}
476-- | Lifted from Control.Arrow and specialized.
493-- | Lifted from Control.Arrow and specialized.
@@ -555,7 +572,9 @@ isSingleton = S.isSingleton . stream
555-- Subject to fusion.
572-- Subject to fusion.
556length :: Text -> Int
573length :: Text -> Int
557length t = S.length (stream t)
574length t = S.length (stream t)
558−{-# INLINE length #-}
575+{-# INLINE [0] length #-}
576+-- length needs to be phased after the compareN/length rules otherwise
577+-- it may inline before the rules have an opportunity to fire.
560-- | /O(n)/ Compare the count of characters in a 'Text' to a number.
579-- | /O(n)/ Compare the count of characters in a 'Text' to a number.
561-- Subject to fusion.
580-- Subject to fusion.
@@ -574,32 +593,32 @@ compareLength t n = S.compareLengthI (stream t) n
576"TEXT ==N/length -> compareLength/==EQ" [~1] forall t n.
595"TEXT ==N/length -> compareLength/==EQ" [~1] forall t n.
577− (==) (length t) n = compareLength t n == EQ
596+ eqInt (length t) n = compareLength t n == EQ
581"TEXT /=N/length -> compareLength//=EQ" [~1] forall t n.
600"TEXT /=N/length -> compareLength//=EQ" [~1] forall t n.
582− (/=) (length t) n = compareLength t n /= EQ
601+ neInt (length t) n = compareLength t n /= EQ
586"TEXT <N/length -> compareLength/==LT" [~1] forall t n.
605"TEXT <N/length -> compareLength/==LT" [~1] forall t n.
587− (<) (length t) n = compareLength t n == LT
606+ ltInt (length t) n = compareLength t n == LT
591"TEXT <=N/length -> compareLength//=GT" [~1] forall t n.
610"TEXT <=N/length -> compareLength//=GT" [~1] forall t n.
592− (<=) (length t) n = compareLength t n /= GT
611+ leInt (length t) n = compareLength t n /= GT
596"TEXT >N/length -> compareLength/==GT" [~1] forall t n.
615"TEXT >N/length -> compareLength/==GT" [~1] forall t n.
597− (>) (length t) n = compareLength t n == GT
616+ gtInt (length t) n = compareLength t n == GT
601"TEXT >=N/length -> compareLength//=LT" [~1] forall t n.
620"TEXT >=N/length -> compareLength//=LT" [~1] forall t n.
602− (>=) (length t) n = compareLength t n /= LT
621+ geInt (length t) n = compareLength t n /= LT
605-- -----------------------------------------------------------------------------
624-- -----------------------------------------------------------------------------
@@ -630,11 +649,37 @@ reverse :: Text -> Text
630reverse t = S.reverse (stream t)
649reverse t = S.reverse (stream t)
631{-# INLINE reverse #-}
650{-# INLINE reverse #-}
633−-- | /O(m+n)/ Replace every occurrence of one substring with another.
652+-- | /O(m+n)/ Replace every non-overlapping occurrence of @needle@ in
653+-- @haystack@ with @replacement@.
655+-- This function behaves as though it was defined as follows:
658+-- replace needle replacement haystack =
659+-- 'intercalate' replacement ('splitOn' needle haystack)
662+-- As this suggests, each occurrence is replaced exactly once. So if
663+-- @needle@ occurs in @replacement@, that occurrence will /not/ itself
664+-- be replaced recursively:
666+-- > replace "oo" "foo" "oo" == "foo"
668+-- In cases where several instances of @needle@ overlap, only the
669+-- first one will be replaced:
671+-- > replace "ofo" "bar" "ofofo" == "barfo"
635-- In (unlikely) bad cases, this function's time complexity degrades
673-- In (unlikely) bad cases, this function's time complexity degrades
636-- towards /O(n*m)/.
674-- towards /O(n*m)/.
637−replace :: Text -> Text -> Text -> Text
675+replace :: Text
676+ -- ^ @needle@ to search for. If this string is empty, an
677+ -- error will occur.
679+ -- ^ @replacement@ to replace @needle@ with.
681+ -- ^ @haystack@ in which to search.
638replace needle@(Text _ _ neeLen)
683replace needle@(Text _ _ neeLen)
639 (Text repArr repOff repLen)
684 (Text repArr repOff repLen)
640 haystack@(Text hayArr hayOff hayLen)
685 haystack@(Text hayArr hayOff hayLen)
@@ -696,7 +741,7 @@ replace needle@(Text _ _ neeLen)
696-- instead of itself.
741-- instead of itself.
697toCaseFold :: Text -> Text
742toCaseFold :: Text -> Text
698toCaseFold t = unstream (S.toCaseFold (stream t))
743toCaseFold t = unstream (S.toCaseFold (stream t))
699−{-# INLINE [0] toCaseFold #-}
744+{-# INLINE toCaseFold #-}
701-- | /O(n)/ Convert a string to lower case, using simple case
746-- | /O(n)/ Convert a string to lower case, using simple case
702-- conversion. Subject to fusion.
747-- conversion. Subject to fusion.
@@ -870,13 +915,13 @@ concatMap f = concat . foldr ((:) . f) []
870{-# INLINE concatMap #-}
915{-# INLINE concatMap #-}
872-- | /O(n)/ 'any' @p@ @t@ determines whether any character in the
917-- | /O(n)/ 'any' @p@ @t@ determines whether any character in the
873−-- 'Text' @t@ satisifes the predicate @p@. Subject to fusion.
918+-- 'Text' @t@ satisfies the predicate @p@. Subject to fusion.
874any :: (Char -> Bool) -> Text -> Bool
919any :: (Char -> Bool) -> Text -> Bool
875any p t = S.any p (stream t)
920any p t = S.any p (stream t)
876{-# INLINE any #-}
921{-# INLINE any #-}
878-- | /O(n)/ 'all' @p@ @t@ determines whether all characters in the
923-- | /O(n)/ 'all' @p@ @t@ determines whether all characters in the
879−-- 'Text' @t@ satisify the predicate @p@. Subject to fusion.
924+-- 'Text' @t@ satisfy the predicate @p@. Subject to fusion.
880all :: (Char -> Bool) -> Text -> Bool
925all :: (Char -> Bool) -> Text -> Bool
881all p t = S.all p (stream t)
926all p t = S.all p (stream t)
882{-# INLINE all #-}
927{-# INLINE all #-}
@@ -1107,6 +1152,27 @@ takeWhile p t@(Text arr off len) = loop 0
1107 unstream (S.takeWhile p (stream t)) = takeWhile p t
1152 unstream (S.takeWhile p (stream t)) = takeWhile p t
1155+-- | /O(n)/ 'takeWhileEnd', applied to a predicate @p@ and a 'Text',
1156+-- returns the longest suffix (possibly empty) of elements that
1157+-- satisfy @p@. Subject to fusion.
1160+-- > takeWhileEnd (=='o') "foo" == "oo"
1161+takeWhileEnd :: (Char -> Bool) -> Text -> Text
1162+takeWhileEnd p t@(Text arr off len) = loop (len-1) len
1163+ where loop !i !l | l <= 0 = t
1164+ | p c = loop (i+d) (l+d)
1165+ | otherwise = text arr (off+l) (len-l)
1166+ where (c,d) = reverseIter t i
1167+{-# INLINE [1] takeWhileEnd #-}
1170+"TEXT takeWhileEnd -> fused" [~1] forall p t.
1171+ takeWhileEnd p t = S.reverse (S.takeWhile p (S.reverseStream t))
1172+"TEXT takeWhileEnd -> unfused" [1] forall p t.
1173+ S.reverse (S.takeWhile p (S.reverseStream t)) = takeWhileEnd p t
1110-- | /O(n)/ 'dropWhile' @p@ @t@ returns the suffix remaining after
1176-- | /O(n)/ 'dropWhile' @p@ @t@ returns the suffix remaining after
1111-- 'takeWhile' @p@ @t@. Subject to fusion.
1177-- 'takeWhile' @p@ @t@. Subject to fusion.
1112dropWhile :: (Char -> Bool) -> Text -> Text
1178dropWhile :: (Char -> Bool) -> Text -> Text
@@ -1125,8 +1191,9 @@ dropWhile p t@(Text arr off len) = loop 0 0
1127-- | /O(n)/ 'dropWhileEnd' @p@ @t@ returns the prefix remaining after
1193-- | /O(n)/ 'dropWhileEnd' @p@ @t@ returns the prefix remaining after
1128−-- dropping characters that fail the predicate @p@ from the end of
1194+-- dropping characters that satisfy the predicate @p@ from the end of
1129-- @t@. Subject to fusion.
1195-- @t@. Subject to fusion.
1130-- Examples:
1197-- Examples:
1132-- > dropWhileEnd (=='.') "foo..." == "foo"
1199-- > dropWhileEnd (=='.') "foo..." == "foo"
@@ -1146,7 +1213,7 @@ dropWhileEnd p t@(Text arr off len) = loop (len-1) len
1148-- | /O(n)/ 'dropAround' @p@ @t@ returns the substring remaining after
1215-- | /O(n)/ 'dropAround' @p@ @t@ returns the substring remaining after
1149−-- dropping characters that fail the predicate @p@ from both the
1216+-- dropping characters that satisfy the predicate @p@ from both the
1150-- beginning and end of @t@. Subject to fusion.
1217-- beginning and end of @t@. Subject to fusion.
1151dropAround :: (Char -> Bool) -> Text -> Text
1218dropAround :: (Char -> Bool) -> Text -> Text
1152dropAround p = dropWhile p . dropWhileEnd p
1219dropAround p = dropWhile p . dropWhileEnd p
@@ -1241,9 +1308,9 @@ tails t | null t = [empty]
1241-- copies to create substrings; they just construct new 'Text's that
1308-- copies to create substrings; they just construct new 'Text's that
1242-- are slices of the original.
1309-- are slices of the original.
1244−-- | /O(m+n)/ Break a 'Text' into pieces separated by the first
1311+-- | /O(m+n)/ Break a 'Text' into pieces separated by the first 'Text'
1245−-- 'Text' argument, consuming the delimiter. An empty delimiter is
1312+-- argument (which cannot be empty), consuming the delimiter. An empty
1246−-- invalid, and will cause an error to be raised.
1313+-- delimiter is invalid, and will cause an error to be raised.
1248-- Examples:
1315-- Examples:
@@ -1256,9 +1323,16 @@ tails t | null t = [empty]
1256-- > intercalate s . splitOn s == id
1323-- > intercalate s . splitOn s == id
1257-- > splitOn (singleton c) == split (==c)
1324-- > splitOn (singleton c) == split (==c)
1326+-- (Note: the string @s@ to split on above cannot be empty.)
1259-- In (unlikely) bad cases, this function's time complexity degrades
1328-- In (unlikely) bad cases, this function's time complexity degrades
1260-- towards /O(n*m)/.
1329-- towards /O(n*m)/.
1261−splitOn :: Text -> Text -> [Text]
1330+splitOn :: Text
1331+ -- ^ String to split on. If this string is empty, an error
1262splitOn pat@(Text _ _ l) src@(Text arr off len)
1336splitOn pat@(Text _ _ l) src@(Text arr off len)
1263 | l <= 0 = emptyError "splitOn"
1337 | l <= 0 = emptyError "splitOn"
1264 | isSingleton pat = split (== unsafeHead pat) src
1338 | isSingleton pat = split (== unsafeHead pat) src
@@ -1466,7 +1540,7 @@ countChar c t = S.countChar c (stream t)
1466-- equivalent to a pair of 'unpack' operations.
1540-- equivalent to a pair of 'unpack' operations.
1467zip :: Text -> Text -> [(Char,Char)]
1541zip :: Text -> Text -> [(Char,Char)]
1468zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1542zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1469−{-# INLINE [0] zip #-}
1543+{-# INLINE zip #-}
1471-- | /O(n)/ 'zipWith' generalises 'zip' by zipping with the function
1545-- | /O(n)/ 'zipWith' generalises 'zip' by zipping with the function
1472-- given as the first argument, instead of a tupling function.
1546-- given as the first argument, instead of a tupling function.
@@ -1474,7 +1548,7 @@ zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1474zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
1548zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
1475zipWith f t1 t2 = unstream (S.zipWith g (stream t1) (stream t2))
1549zipWith f t1 t2 = unstream (S.zipWith g (stream t1) (stream t2))
1476 where g a b = safe (f a b)
1550 where g a b = safe (f a b)
1477−{-# INLINE [0] zipWith #-}
1551+{-# INLINE zipWith #-}
1479-- | /O(n)/ Breaks a 'Text' up into a list of words, delimited by 'Char's
1553-- | /O(n)/ Breaks a 'Text' up into a list of words, delimited by 'Char's
1480-- representing white space.
1554-- representing white space.