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