@@ -34,7 +34,6 @@
34-- with Unicode text (including normalization, regular expressions,
34-- with Unicode text (including normalization, regular expressions,
35-- non-standard encodings, text breaking, and locales), see
35-- non-standard encodings, text breaking, and locales), see
36-- <http://hackage.haskell.org/package/text-icu the text-icu package >.
36-- <http://hackage.haskell.org/package/text-icu the text-icu package >.
39module Data.Text
38module Data.Text
@@ -44,9 +43,6 @@ module Data.Text
44 -- * Acceptable data
43 -- * Acceptable data
45 -- $replacement
44 -- $replacement
47− -- * Definition of character
48− -- $character_definition
50 -- * Fusion
46 -- * Fusion
51 -- $fusion
47 -- $fusion
@@ -64,7 +60,6 @@ module Data.Text
@@ -251,18 +246,6 @@ import qualified GHC.Exts as Exts
251import Text.Printf (PrintfArg, formatArg, formatString)
246import Text.Printf (PrintfArg, formatArg, formatString)
254−-- $character_definition
256−-- This package uses the term /character/ to denote Unicode /code points/.
258−-- Note that this is not the same thing as a grapheme (e.g. a
259−-- composition of code points that form one visual symbol). For
260−-- instance, consider the grapheme \"ä\". This symbol has two
261−-- Unicode representations: a single code-point representation
262−-- @U+00E4@ (the @LATIN SMALL LETTER A WITH DIAERESIS@ code point),
263−-- and a two code point representation @U+0061@ (the \"@A@\" code
264−-- point) and @U+0308@ (the @COMBINING DIAERESIS@ code point).
266-- $strict
249-- $strict
268-- This package provides both strict and lazy 'Text' types. The
251-- This package provides both strict and lazy 'Text' types. The
@@ -351,13 +334,9 @@ instance Read Text where
351 readsPrec p str = [(pack x,y) | (x,y) <- readsPrec p str]
334 readsPrec p str = [(pack x,y) | (x,y) <- readsPrec p str]
353#if MIN_VERSION_base(4,9,0)
336#if MIN_VERSION_base(4,9,0)
354−-- | Non-orphan 'Semigroup' instance only defined for
355−-- @base-4.9.0.0@ and later; orphan instances for older GHCs are
337+-- Semigroup orphan instances for older GHCs are provided by
357−-- the [semigroups](http://hackage.haskell.org/package/semigroups)
358−-- package
338+-- 'semigroups` package
361instance Semigroup Text where
340instance Semigroup Text where
362 (<>) = append
341 (<>) = append
@@ -375,7 +354,6 @@ instance IsString Text where
375 fromString = pack
354 fromString = pack
377#if __GLASGOW_HASKELL__ >= 708
356#if __GLASGOW_HASKELL__ >= 708
379instance Exts.IsList Text where
357instance Exts.IsList Text where
380 type Item Text = Char
358 type Item Text = Char
381 fromList = pack
359 fromList = pack
@@ -386,7 +364,6 @@ instance Exts.IsList Text where
386instance NFData Text where rnf !_ = ()
364instance NFData Text where rnf !_ = ()
390instance Binary Text where
367instance Binary Text where
391 put t = put (encodeUtf8 t)
368 put t = put (encodeUtf8 t)
@@ -420,8 +397,6 @@ instance Data Text where
421#if MIN_VERSION_base(4,7,0)
398#if MIN_VERSION_base(4,7,0)
422-- | Only defined for @base-4.7.0.0@ and later
399-- | Only defined for @base-4.7.0.0@ and later
425instance PrintfArg Text where
400instance PrintfArg Text where
426 formatArg txt = formatString $ unpack txt
401 formatArg txt = formatString $ unpack txt
@@ -570,19 +545,6 @@ init (Text arr off len) | len <= 0 = emptyError "init"
570 unstream (S.init (stream t)) = init t
545 unstream (S.init (stream t)) = init t
573−-- | /O(1)/ Returns all but the last character and the last character of a
574−-- 'Text', or 'Nothing' if empty.
577−unsnoc :: Text -> Maybe (Text, Char)
578−unsnoc (Text arr off len)
579− | len <= 0 = Nothing
580− | n < 0xDC00 || n > 0xDFFF = Just (text arr off (len-1), unsafeChr n)
581− | otherwise = Just (text arr off (len-2), U16.chr2 n0 n)
582− where n = A.unsafeIndex arr (off+len-1)
583− n0 = A.unsafeIndex arr (off+len-2)
584−{-# INLINE [1] unsnoc #-}
586-- | /O(1)/ Tests whether a 'Text' is empty or not. Subject to
548-- | /O(1)/ Tests whether a 'Text' is empty or not. Subject to
587-- fusion.
549-- fusion.
588null :: Text -> Bool
550null :: Text -> Bool
@@ -662,15 +624,8 @@ compareLength t n = S.compareLengthI (stream t) n
662-- -----------------------------------------------------------------------------
624-- -----------------------------------------------------------------------------
663-- * Transformations
625-- * Transformations
664-- | /O(n)/ 'map' @f@ @t@ is the 'Text' obtained by applying @f@ to
626-- | /O(n)/ 'map' @f@ @t@ is the 'Text' obtained by applying @f@ to
665−-- each element of @t@.
669−-- >>> let message = pack "I am not angry. Not at all."
670−-- >>> T.map (\c -> if c == '.' then '!' else c) message
671−-- "I am not angry! Not at all!"
673−-- Subject to fusion. Performs replacement on invalid scalar values.
627+-- each element of @t@. Subject to fusion. Performs replacement on
628+-- invalid scalar values.
674map :: (Char -> Char) -> Text -> Text
629map :: (Char -> Char) -> Text -> Text
675map f t = unstream (S.map (safe . f) (stream t))
630map f t = unstream (S.map (safe . f) (stream t))
676{-# INLINE [1] map #-}
631{-# INLINE [1] map #-}
@@ -678,36 +633,18 @@ map f t = unstream (S.map (safe . f) (stream t))
678-- | /O(n)/ The 'intercalate' function takes a 'Text' and a list of
633-- | /O(n)/ The 'intercalate' function takes a 'Text' and a list of
679-- 'Text's and concatenates the list after interspersing the first
634-- 'Text's and concatenates the list after interspersing the first
680-- argument between each element of the list.
635-- argument between each element of the list.
684−-- >>> T.intercalate "NI!" ["We", "seek", "the", "Holy", "Grail"]
685−-- "WeNI!seekNI!theNI!HolyNI!Grail"
686intercalate :: Text -> [Text] -> Text
636intercalate :: Text -> [Text] -> Text
687intercalate t = concat . (F.intersperse t)
637intercalate t = concat . (F.intersperse t)
688{-# INLINE intercalate #-}
638{-# INLINE intercalate #-}
690-- | /O(n)/ The 'intersperse' function takes a character and places it
640-- | /O(n)/ The 'intersperse' function takes a character and places it
691−-- between the characters of a 'Text'.
641+-- between the characters of a 'Text'. Subject to fusion. Performs
695−-- >>> T.intersperse '.' "SHIELD"
698−-- Subject to fusion. Performs replacement on invalid scalar values.
642+-- replacement on invalid scalar values.
699intersperse :: Char -> Text -> Text
643intersperse :: Char -> Text -> Text
700intersperse c t = unstream (S.intersperse (safe c) (stream t))
644intersperse c t = unstream (S.intersperse (safe c) (stream t))
701{-# INLINE intersperse #-}
645{-# INLINE intersperse #-}
703−-- | /O(n)/ Reverse the characters of a string.
647+-- | /O(n)/ Reverse the characters of a string. Subject to fusion.
707−-- >>> T.reverse "desrever"
710−-- Subject to fusion.
711reverse :: Text -> Text
648reverse :: Text -> Text
712reverse t = S.reverse (stream t)
649reverse t = S.reverse (stream t)
713{-# INLINE reverse #-}
650{-# INLINE reverse #-}
@@ -726,14 +663,12 @@ reverse t = S.reverse (stream t)
726-- @needle@ occurs in @replacement@, that occurrence will /not/ itself
663-- @needle@ occurs in @replacement@, that occurrence will /not/ itself
727-- be replaced recursively:
664-- be replaced recursively:
729−-- >>> replace "oo" "foo" "oo"
666+-- > replace "oo" "foo" "oo" == "foo"
732-- In cases where several instances of @needle@ overlap, only the
668-- In cases where several instances of @needle@ overlap, only the
733-- first one will be replaced:
669-- first one will be replaced:
735−-- >>> replace "ofo" "bar" "ofofo"
671+-- > replace "ofo" "bar" "ofofo" == "barfo"
738-- In (unlikely) bad cases, this function's time complexity degrades
673-- In (unlikely) bad cases, this function's time complexity degrades
739-- towards /O(n*m)/.
674-- towards /O(n*m)/.
@@ -847,8 +782,6 @@ toUpper t = unstream (S.toUpper (stream t))
847-- guides disagree on whether the book name \"The Hill of the Red
782-- guides disagree on whether the book name \"The Hill of the Red
848-- Fox\" is correctly title cased—but this function will
783-- Fox\" is correctly title cased—but this function will
849-- capitalize /every/ word.
784-- capitalize /every/ word.
852toTitle :: Text -> Text
785toTitle :: Text -> Text
853toTitle t = unstream (S.toTitle (stream t))
786toTitle t = unstream (S.toTitle (stream t))
854{-# INLINE toTitle #-}
787{-# INLINE toTitle #-}
@@ -859,11 +792,8 @@ toTitle t = unstream (S.toTitle (stream t))
860-- Examples:
793-- Examples:
862−-- >>> justifyLeft 7 'x' "foo"
795+-- > justifyLeft 7 'x' "foo" == "fooxxxx"
865−-- >>> justifyLeft 3 'x' "foobar"
796+-- > justifyLeft 3 'x' "foobar" == "foobar"
867justifyLeft :: Int -> Char -> Text -> Text
797justifyLeft :: Int -> Char -> Text -> Text
868justifyLeft k c t
798justifyLeft k c t
869 | len >= k = t
799 | len >= k = t
@@ -884,11 +814,8 @@ justifyLeft k c t
885-- Examples:
815-- Examples:
887−-- >>> justifyRight 7 'x' "bar"
817+-- > justifyRight 7 'x' "bar" == "xxxxbar"
890−-- >>> justifyRight 3 'x' "foobar"
818+-- > justifyRight 3 'x' "foobar" == "foobar"
892justifyRight :: Int -> Char -> Text -> Text
819justifyRight :: Int -> Char -> Text -> Text
893justifyRight k c t
820justifyRight k c t
894 | len >= k = t
821 | len >= k = t
@@ -902,8 +829,7 @@ justifyRight k c t
903-- Examples:
830-- Examples:
905−-- >>> center 8 'x' "HS"
832+-- > center 8 'x' "HS" = "xxxHSxxx"
907center :: Int -> Char -> Text -> Text
833center :: Int -> Char -> Text -> Text
908center k c t
834center k c t
909 | len >= k = t
835 | len >= k = t
@@ -918,14 +844,6 @@ center k c t
918-- of its 'Text' argument. Note that this function uses 'pack',
844-- of its 'Text' argument. Note that this function uses 'pack',
919-- 'unpack', and the list version of transpose, and is thus not very
845-- 'unpack', and the list version of transpose, and is thus not very
920-- efficient.
846-- efficient.
924−-- >>> transpose ["green","orange"]
925−-- ["go","rr","ea","en","ng","e"]
927−-- >>> transpose ["blue","red"]
928−-- ["br","le","ud","e"]
929transpose :: [Text] -> [Text]
847transpose :: [Text] -> [Text]
930transpose ts = P.map pack (L.transpose (P.map unpack ts))
848transpose ts = P.map pack (L.transpose (P.map unpack ts))
@@ -1170,10 +1088,7 @@ iterN n t@(Text _arr _off len) = loop 0 0
1171-- Examples:
1089-- Examples:
1173−-- >>> takeEnd 3 "foobar"
1091+-- > takeEnd 3 "foobar" == "bar"
1177takeEnd :: Int -> Text -> Text
1092takeEnd :: Int -> Text -> Text
1178takeEnd n t@(Text arr off len)
1093takeEnd n t@(Text arr off len)
1179 | n <= 0 = empty
1094 | n <= 0 = empty
@@ -1184,8 +1099,8 @@ takeEnd n t@(Text arr off len)
1184iterNEnd :: Int -> Text -> Int
1099iterNEnd :: Int -> Text -> Int
1185iterNEnd n t@(Text _arr _off len) = loop (len-1) n
1100iterNEnd n t@(Text _arr _off len) = loop (len-1) n
1186 where loop i !m
1101 where loop i !m
1188 | i <= 0 = 0
1102 | i <= 0 = 0
1189 | otherwise = loop (i+d) (m-1)
1104 | otherwise = loop (i+d) (m-1)
1190 where d = reverseIter_ t i
1105 where d = reverseIter_ t i
@@ -1212,10 +1127,7 @@ drop n t@(Text arr off len)
1213-- Examples:
1128-- Examples:
1215−-- >>> dropEnd 3 "foobar"
1130+-- > dropEnd 3 "foobar" == "foo"
1219dropEnd :: Int -> Text -> Text
1131dropEnd :: Int -> Text -> Text
1220dropEnd n t@(Text arr off len)
1132dropEnd n t@(Text arr off len)
1221 | n <= 0 = t
1133 | n <= 0 = t
@@ -1245,10 +1157,7 @@ takeWhile p t@(Text arr off len) = loop 0
1245-- satisfy @p@. Subject to fusion.
1157-- satisfy @p@. Subject to fusion.
1246-- Examples:
1158-- Examples:
1248−-- >>> takeWhileEnd (=='o') "foo"
1160+-- > takeWhileEnd (=='o') "foo" == "oo"
1252takeWhileEnd :: (Char -> Bool) -> Text -> Text
1161takeWhileEnd :: (Char -> Bool) -> Text -> Text
1253takeWhileEnd p t@(Text arr off len) = loop (len-1) len
1162takeWhileEnd p t@(Text arr off len) = loop (len-1) len
1254 where loop !i !l | l <= 0 = t
1163 where loop !i !l | l <= 0 = t
@@ -1287,8 +1196,7 @@ dropWhile p t@(Text arr off len) = loop 0 0
1288-- Examples:
1197-- Examples:
1290−-- >>> dropWhileEnd (=='.') "foo..."
1199+-- > dropWhileEnd (=='.') "foo..." == "foo"
1292dropWhileEnd :: (Char -> Bool) -> Text -> Text
1200dropWhileEnd :: (Char -> Bool) -> Text -> Text
1293dropWhileEnd p t@(Text arr off len) = loop (len-1) len
1201dropWhileEnd p t@(Text arr off len) = loop (len-1) len
1294 where loop !i !l | l <= 0 = empty
1202 where loop !i !l | l <= 0 = empty
@@ -1406,14 +1314,9 @@ tails t | null t = [empty]
1407-- Examples:
1315-- Examples:
1409−-- >>> splitOn "\r\n" "a\r\nb\r\nd\r\ne"
1317+-- > splitOn "\r\n" "a\r\nb\r\nd\r\ne" == ["a","b","d","e"]
1410−-- ["a","b","d","e"]
1412−-- >>> splitOn "aaa" "aaaXaaaXaaaXaaa"
1318+-- > splitOn "aaa" "aaaXaaaXaaaXaaa" == ["","X","X","X",""]
1413−-- ["","X","X","X",""]
1415−-- >>> splitOn "x" "x"
1319+-- > splitOn "x" "x" == ["",""]
@@ -1449,11 +1352,8 @@ splitOn pat@(Text _ _ l) src@(Text arr off len)
1449-- resulting components do not contain the separators. Two adjacent
1352-- resulting components do not contain the separators. Two adjacent
1450-- separators result in an empty component in the output. eg.
1353-- separators result in an empty component in the output. eg.
1452−-- >>> split (=='a') "aabbaca"
1355+-- > split (=='a') "aabbaca" == ["","","bb","c",""]
1453−-- ["","","bb","c",""]
1455−-- >>> split (=='a') ""
1356+-- > split (=='a') "" == [""]
1457split :: (Char -> Bool) -> Text -> [Text]
1357split :: (Char -> Bool) -> Text -> [Text]
1458split _ t@(Text _off _arr 0) = [t]
1358split _ t@(Text _off _arr 0) = [t]
1459split p t = loop t
1359split p t = loop t
@@ -1466,11 +1366,8 @@ split p t = loop t
1466-- element may be shorter than the other chunks, depending on the
1366-- element may be shorter than the other chunks, depending on the
1467-- length of the input. Examples:
1367-- length of the input. Examples:
1469−-- >>> chunksOf 3 "foobarbaz"
1369+-- > chunksOf 3 "foobarbaz" == ["foo","bar","baz"]
1470−-- ["foo","bar","baz"]
1472−-- >>> chunksOf 4 "haskell.org"
1370+-- > chunksOf 4 "haskell.org" == ["hask","ell.","org"]
1473−-- ["hask","ell.","org"]
1474chunksOf :: Int -> Text -> [Text]
1371chunksOf :: Int -> Text -> [Text]
1475chunksOf k = go
1372chunksOf k = go
@@ -1515,11 +1412,8 @@ filter p t = unstream (S.filter p (stream t))
1516-- Examples:
1413-- Examples:
1518−-- >>> breakOn "::" "a::b::c"
1415+-- > breakOn "::" "a::b::c" ==> ("a", "::b::c")
1521−-- >>> breakOn "/" "foobar"
1416+-- > breakOn "/" "foobar" ==> ("foobar", "")
@@ -1547,8 +1441,7 @@ breakOn pat src@(Text arr off len)
1547-- up to and including the last match of @needle@. The second is the
1441-- up to and including the last match of @needle@. The second is the
1548-- remainder of @haystack@, following the match.
1442-- remainder of @haystack@, following the match.
1550−-- >>> breakOnEnd "::" "a::b::c"
1444+-- > breakOnEnd "::" "a::b::c" ==> ("a::b::", "c")
1552breakOnEnd :: Text -> Text -> (Text, Text)
1445breakOnEnd :: Text -> Text -> (Text, Text)
1553breakOnEnd pat src = (reverse b, reverse a)
1446breakOnEnd pat src = (reverse b, reverse a)
1554 where (a,b) = breakOn (reverse pat) (reverse src)
1447 where (a,b) = breakOn (reverse pat) (reverse src)
@@ -1563,11 +1456,10 @@ breakOnEnd pat src = (reverse b, reverse a)
1564-- Examples:
1457-- Examples:
1566−-- >>> breakOnAll "::" ""
1459+-- > breakOnAll "::" ""
1567−-- []
1460+-- > ==> []
1569−-- >>> breakOnAll "/" "a/b/c/"
1461+-- > breakOnAll "/" "a/b/c/"
1570−-- [("a","/b/c/"),("a/b","/c/"),("a/b/c","/")]
1462+-- > ==> [("a", "/b/c/"), ("a/b", "/c/"), ("a/b/c", "/")]
1572-- In (unlikely) bad cases, this function's time complexity degrades
1464-- In (unlikely) bad cases, this function's time complexity degrades
1573-- towards /O(n*m)/.
1465-- towards /O(n*m)/.
@@ -1766,14 +1658,9 @@ isInfixOf needle haystack
1767-- Examples:
1659-- Examples:
1769−-- >>> stripPrefix "foo" "foobar"
1661+-- > stripPrefix "foo" "foobar" == Just "bar"
1772−-- >>> stripPrefix "" "baz"
1662+-- > stripPrefix "" "baz" == Just "baz"
1775−-- >>> stripPrefix "foo" "quux"
1663+-- > stripPrefix "foo" "quux" == Nothing
1778-- This is particularly useful with the @ViewPatterns@ extension to
1665-- This is particularly useful with the @ViewPatterns@ extension to
1779-- GHC, as follows:
1666-- GHC, as follows:
@@ -1798,14 +1685,9 @@ stripPrefix p@(Text _arr _off plen) t@(Text arr off len)
1799-- Examples:
1686-- Examples:
1801−-- >>> commonPrefixes "foobar" "fooquux"
1688+-- > commonPrefixes "foobar" "fooquux" == Just ("foo","bar","quux")
1802−-- Just ("foo","bar","quux")
1804−-- >>> commonPrefixes "veeble" "fetzer"
1689+-- > commonPrefixes "veeble" "fetzer" == Nothing
1807−-- >>> commonPrefixes "" "baz"
1690+-- > commonPrefixes "" "baz" == Nothing
1809commonPrefixes :: Text -> Text -> Maybe (Text,Text,Text)
1691commonPrefixes :: Text -> Text -> Maybe (Text,Text,Text)
1810commonPrefixes t0@(Text arr0 off0 len0) t1@(Text arr1 off1 len1) = go 0 0
1692commonPrefixes t0@(Text arr0 off0 len0) t1@(Text arr1 off1 len1) = go 0 0
@@ -1822,14 +1704,9 @@ commonPrefixes t0@(Text arr0 off0 len0) t1@(Text arr1 off1 len1) = go 0 0
1823-- Examples:
1705-- Examples:
1825−-- >>> stripSuffix "bar" "foobar"
1707+-- > stripSuffix "bar" "foobar" == Just "foo"
1828−-- >>> stripSuffix "" "baz"
1708+-- > stripSuffix "" "baz" == Just "baz"
1831−-- >>> stripSuffix "foo" "quux"
1709+-- > stripSuffix "foo" "quux" == Nothing
1834-- This is particularly useful with the @ViewPatterns@ extension to
1711-- This is particularly useful with the @ViewPatterns@ extension to
1835-- GHC, as follows:
1712-- GHC, as follows:
@@ -1876,12 +1753,3 @@ copy (Text arr off len) = Text (A.run go) 0 len
1876 marr <- A.new len
1753 marr <- A.new len
1877 A.copyI marr 0 arr off len
1754 A.copyI marr 0 arr off len
1878 return marr
1755 return marr
1881−-------------------------------------------------
1882−-- NOTE: the named chunk below used by doctest;
1883−-- verify the doctests via `doctest -fobject-code Data/Text.hs`
1886−-- >>> :set -XOverloadedStrings
1887−-- >>> import qualified Data.Text as T