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