@@ -3,9 +3,6 @@
33#if __GLASGOW_HASKELL__ >= 702
44{-# LANGUAGE Trustworthy #-}
55#endif
6−#if __GLASGOW_HASKELL__ >= 708
7−{-# LANGUAGE TypeFamilies #-}
8−#endif
96
107-- |
118-- Module : Data.Text
@@ -14,7 +11,8 @@
1411-- (c) 2008, 2009 Tom Harper
1512--
1613-- License : BSD-style
17−-- Maintainer : bos@serpentine.com
14+-- Maintainer : bos@serpentine.com, rtomharper@googlemail.com,
15+-- duncan@haskell.org
1816-- Stability : experimental
1917-- Portability : GHC
2018--
@@ -32,8 +30,8 @@
3230--
3331-- To use an extended and very rich family of functions for working
3432-- with Unicode text (including normalization, regular expressions,
35−-- non-standard encodings, text breaking, and locales), see
36−-- <http://hackage.haskell.org/package/text-icu the text-icu package >.
33+-- non-standard encodings, text breaking, and locales), see the
34+-- @text-icu@ package: <http://hackage.haskell.org/package/text-icu>
3735
3836module Data.Text
3937 (
@@ -81,7 +79,6 @@ module Data.Text
8179 , toCaseFold
8280 , toLower
8381 , toUpper
84− , toTitle
8582
8683 -- ** Justification
8784 , justifyLeft
@@ -125,11 +122,8 @@ module Data.Text
125122
126123 -- ** Breaking strings
127124 , take
128− , takeEnd
129125 , drop
130− , dropEnd
131126 , takeWhile
132− , takeWhileEnd
133127 , dropWhile
134128 , dropWhileEnd
135129 , dropAround
@@ -192,94 +186,82 @@ module Data.Text
192186
193187 -- * Low level operations
194188 , copy
195− , unpackCString#
196189 ) where
197190
198191import Prelude (Char, Bool(..), Int, Maybe(..), String,
199192 Eq(..), Ord(..), Ordering(..), (++),
200− Read(..),
201− (&&), (||), (+), (-), (.), ($), ($!), (>>),
202− not, return, otherwise, quot)
193+ Read(..), Show(..),
194+ (&&), (||), (+), (-), (.), ($), ($!), (>>), (*),
195+ maxBound, not, return, otherwise, quot)
203196#if defined(HAVE_DEEPSEQ)
204−import Control.DeepSeq (NFData(rnf))
197+import Control.DeepSeq (NFData)
205198#endif
206199#if defined(ASSERTS)
207200import Control.Exception (assert)
208201#endif
209202import Data.Char (isSpace)
210−import Data.Data (Data(gfoldl, toConstr, gunfold, dataTypeOf), constrIndex,
211− Constr, mkConstr, DataType, mkDataType, Fixity(Prefix))
203+import Data.Data (Data(gfoldl, toConstr, gunfold, dataTypeOf))
204+import Data.Data (mkNoRepType)
212205import Control.Monad (foldM)
213−import Control.Monad.ST (ST)
214206import qualified Data.Text.Array as A
215207import qualified Data.List as L
216−import Data.Binary (Binary(get, put))
217208import Data.Monoid (Monoid(..))
218−#if MIN_VERSION_base(4,9,0)
219−import Data.Semigroup (Semigroup(..))
220−#endif
221209import Data.String (IsString(..))
222−import qualified Data.Text.Internal.Fusion as S
223−import qualified Data.Text.Internal.Fusion.Common as S
224−import Data.Text.Encoding (decodeUtf8', encodeUtf8)
225−import Data.Text.Internal.Fusion (stream, reverseStream, unstream)
226−import Data.Text.Internal.Private (span_)
227−import Data.Text.Internal (Text(..), empty, firstf, mul, safe, text)
228−import Data.Text.Show (singleton, unpack, unpackCString#)
210+import qualified Data.Text.Fusion as S
211+import qualified Data.Text.Fusion.Common as S
212+import Data.Text.Fusion (stream, reverseStream, unstream)
213+import Data.Text.Private (span_)
214+import Data.Text.Internal (Text(..), empty, firstf, safe, text, textP)
229215import qualified Prelude as P
230216import Data.Text.Unsafe (Iter(..), iter, iter_, lengthWord16, reverseIter,
231− reverseIter_, unsafeHead, unsafeTail)
232−import Data.Text.Internal.Unsafe.Char (unsafeChr)
233−import qualified Data.Text.Internal.Functions as F
234−import qualified Data.Text.Internal.Encoding.Utf16 as U16
235−import Data.Text.Internal.Search (indices)
217+ unsafeHead, unsafeTail)
218+import Data.Text.UnsafeChar (unsafeChr)
219+import qualified Data.Text.Util as U
220+import qualified Data.Text.Encoding.Utf16 as U16
221+import Data.Text.Search (indices)
236222#if defined(__HADDOCK__)
237223import Data.ByteString (ByteString)
238224import qualified Data.Text.Lazy as L
239225import Data.Int (Int64)
240226#endif
241−import GHC.Base (eqInt, neInt, gtInt, geInt, ltInt, leInt)
242−#if __GLASGOW_HASKELL__ >= 708
243−import qualified GHC.Exts as Exts
244−#endif
245−#if MIN_VERSION_base(4,7,0)
246−import Text.Printf (PrintfArg, formatArg, formatString)
227+#if __GLASGOW_HASKELL__ >= 702
228+import qualified GHC.CString as GHC
229+#else
230+import qualified GHC.Base as GHC
247231#endif
232+import GHC.Prim (Addr#)
248233
249234-- $strict
250235--
251236-- This package provides both strict and lazy 'Text' types. The
252−-- strict type is provided by the "Data.Text" module, while the lazy
253−-- type is provided by the "Data.Text.Lazy" module. Internally, the
237+-- strict type is provided by the 'Data.Text' package, while the lazy
238+-- type is provided by the 'Data.Text.Lazy' package. Internally, the
254239-- lazy @Text@ type consists of a list of strict chunks.
255240--
256241-- The strict 'Text' type requires that an entire string fit into
257−-- memory at once. The lazy 'Data.Text.Lazy.Text' type is capable of
258−-- streaming strings that are larger than memory using a small memory
259−-- footprint. In many cases, the overhead of chunked streaming makes
260−-- the lazy 'Data.Text.Lazy.Text' type slower than its strict
261−-- counterpart, but this is not always the case. Sometimes, the time
262−-- complexity of a function in one module may be different from the
263−-- other, due to their differing internal structures.
242+-- memory at once. The lazy @Text@ type is capable of streaming
243+-- strings that are larger than memory using a small memory footprint.
244+-- In many cases, the overhead of chunked streaming makes the lazy
245+-- @Text@ type slower than its strict counterpart, but this is not
246+-- always the case. Sometimes, the time complexity of a function in
247+-- one module may be different from the other, due to their differing
248+-- internal structures.
264249--
265250-- Each module provides an almost identical API, with the main
266251-- difference being that the strict module uses 'Int' values for
267−-- lengths and counts, while the lazy module uses 'Data.Int.Int64'
268−-- lengths.
252+-- lengths and counts, while the lazy module uses 'Int64' lengths.
269253
270254-- $replacement
271255--
272256-- A 'Text' value is a sequence of Unicode scalar values, as defined
273−-- in
274−-- <http://www.unicode.org/versions/Unicode5.2.0/ch03.pdf#page=35 §3.9, definition D76 of the Unicode 5.2 standard >.
275−-- As such, a 'Text' cannot contain values in the range U+D800 to
276−-- U+DFFF inclusive. Haskell implementations admit all Unicode code
277−-- points
278−-- (<http://www.unicode.org/versions/Unicode5.2.0/ch03.pdf#page=13 §3.4, definition D10 >)
279−-- as 'Char' values, including code points from this invalid range.
280−-- This means that there are some 'Char' values that are not valid
281−-- Unicode scalar values, and the functions in this module must handle
282−-- those cases.
257+-- in §3.9, definition D76 of the Unicode 5.2 standard:
258+-- <http://www.unicode.org/versions/Unicode5.2.0/ch03.pdf#page=35>. As
259+-- such, a 'Text' cannot contain values in the range U+D800 to U+DFFF
260+-- inclusive. Haskell implementations admit all Unicode code points
261+-- (§3.4, definition D10) as 'Char' values, including code points
262+-- from this invalid range. This means that there are some 'Char'
263+-- values that are not valid Unicode scalar values, and the functions
264+-- in this module must handle those cases.
283265--
284266-- Within this module, many functions construct a 'Text' from one or
285267-- more 'Char' values. Those functions will substitute 'Char' values
@@ -293,8 +275,8 @@ import Text.Printf (PrintfArg, formatArg, formatString)
293275-- range U+D800 through U+DFFF are used by UTF-16 to denote surrogate
294276-- code points, and so cannot be represented. The functions replace
295277-- invalid scalar values, instead of dropping them, as a security
296−-- measure. For details, see
297−-- <http://unicode.org/reports/tr36/#Deletion_of_Noncharacters Unicode Technical Report 36, §3.5 >.)
278+-- measure. For details, see Unicode Technical Report 36, §3.5:
279+-- <http://unicode.org/reports/tr36/#Deletion_of_Noncharacters>)
298280
299281-- $fusion
300282--
@@ -312,11 +294,11 @@ import Text.Printf (PrintfArg, formatArg, formatString)
312294-- > countChars = T.length . T.toUpper . E.decodeUtf8
313295--
314296-- From the type signatures involved, this looks like it should
315−-- allocate one 'Data.ByteString.ByteString' value, and two 'Text'
316−-- values. However, when a module is compiled with optimisation
317−-- enabled under GHC, the two intermediate 'Text' values will be
318−-- optimised away, and the function will be compiled down to a single
319−-- loop over the source 'Data.ByteString.ByteString'.
297+-- allocate one 'ByteString' value, and two 'Text' values. However,
298+-- when a module is compiled with optimisation enabled under GHC, the
299+-- two intermediate 'Text' values will be optimised away, and the
300+-- function will be compiled down to a single loop over the source
301+-- 'ByteString'.
320302--
321303-- Functions that can be fused by the compiler are documented with the
322304-- phrase \"Subject to fusion\".
@@ -330,82 +312,41 @@ instance Eq Text where
330312instance Ord Text where
331313 compare = compareText
332314
315+instance Show Text where
316+ showsPrec p ps r = showsPrec p (unpack ps) r
317+
333318instance Read Text where
334319 readsPrec p str = [(pack x,y) | (x,y) <- readsPrec p str]
335320
336−#if MIN_VERSION_base(4,9,0)
337−-- Semigroup orphan instances for older GHCs are provided by
338−-- 'semigroups` package
339−
340−instance Semigroup Text where
341− (<>) = append
342−#endif
343−
344321instance Monoid Text where
345322 mempty = empty
346−#if MIN_VERSION_base(4,9,0)
347− mappend = (<>) -- future-proof definition
348−#else
349323 mappend = append
350−#endif
351324 mconcat = concat
352325
353326instance IsString Text where
354327 fromString = pack
355328
356−#if __GLASGOW_HASKELL__ >= 708
357−instance Exts.IsList Text where
358− type Item Text = Char
359− fromList = pack
360− toList = unpack
361−#endif
362−
363329#if defined(HAVE_DEEPSEQ)
364−instance NFData Text where rnf !_ = ()
330+instance NFData Text
365331#endif
366332
367−instance Binary Text where
368− put t = put (encodeUtf8 t)
369− get = do
370− bs <- get
371− case decodeUtf8' bs of
372− P.Left exn -> P.fail (P.show exn)
373− P.Right a -> P.return a
374−
375−-- | This instance preserves data abstraction at the cost of inefficiency.
333+-- This instance preserves data abstraction at the cost of inefficiency.
376334-- We omit reflection services for the sake of data abstraction.
377335--
378−-- This instance was created by copying the updated behavior of
379−-- @"Data.Set".@'Data.Set.Set' and @"Data.Map".@'Data.Map.Map'. If you
380−-- feel a mistake has been made, please feel free to submit
381−-- improvements.
382−--
383−-- The original discussion is archived here:
384−-- <http://groups.google.com/group/haskell-cafe/browse_thread/thread/b5bbb1b28a7e525d/0639d46852575b93 could we get a Data instance for Data.Text.Text? >
336+-- This instance was created by copying the behavior of Data.Set and
337+-- Data.Map. If you feel a mistake has been made, please feel free to
338+-- submit improvements.
385339--
386−-- The followup discussion that changed the behavior of 'Data.Set.Set'
387−-- and 'Data.Map.Map' is archived here:
388−-- <http://markmail.org/message/trovdc6zkphyi3cr#query:+page:1+mid:a46der3iacwjcf6n+state:results Proposal: Allow gunfold for Data.Map, ... >
340+-- Original discussion is archived here:
341+
342+-- "could we get a Data instance for Data.Text.Text?"
343+-- http://groups.google.com/group/haskell-cafe/browse_thread/thread/b5bbb1b28a7e525d/0639d46852575b93
389344
390345instance Data Text where
391346 gfoldl f z txt = z pack `f` (unpack txt)
392− toConstr _ = packConstr
393− gunfold k z c = case constrIndex c of
394− 1 -> k (z pack)
395− _ -> P.error "gunfold"
396− dataTypeOf _ = textDataType
397−
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
402−#endif
403−
404−packConstr :: Constr
405−packConstr = mkConstr textDataType "pack" [] Prefix
406−
407−textDataType :: DataType
408−textDataType = mkDataType "Data.Text.Text" [packConstr]
347+ toConstr _ = P.error "Data.Text.Text.toConstr"
348+ gunfold _ _ = P.error "Data.Text.Text.gunfold"
349+ dataTypeOf _ = mkNoRepType "Data.Text.Text"
409350
410351-- | /O(n)/ Compare two 'Text' values lexicographically.
411352compareText :: Text -> Text -> Ordering
@@ -430,6 +371,30 @@ pack :: String -> Text
430371pack = unstream . S.map safe . S.streamList
431372{-# INLINE [1] pack #-}
432373
374+-- | /O(n)/ Convert a Text into a String. Subject to fusion.
375+unpack :: Text -> String
376+unpack = S.unstreamList . stream
377+{-# INLINE [1] unpack #-}
378+
379+-- | /O(n)/ Convert a literal string into a Text. Subject to fusion.
380+unpackCString# :: Addr# -> Text
381+unpackCString# addr# = unstream (S.streamCString# addr#)
382+{-# NOINLINE unpackCString# #-}
383+
384+{-# RULES "TEXT literal" forall a.
385+ unstream (S.map safe (S.streamList (GHC.unpackCString# a)))
386+ = unpackCString# a #-}
387+
388+{-# RULES "TEXT literal UTF8" forall a.
389+ unstream (S.map safe (S.streamList (GHC.unpackCStringUtf8# a)))
390+ = unpackCString# a #-}
391+
392+-- | /O(1)/ Convert a character into a Text. Subject to fusion.
393+-- Performs replacement on invalid scalar values.
394+singleton :: Char -> Text
395+singleton = unstream . S.singleton . safe
396+{-# INLINE [1] singleton #-}
397+
433398-- -----------------------------------------------------------------------------
434399-- * Basic functions
435400
@@ -460,13 +425,12 @@ append a@(Text arr1 off1 len1) b@(Text arr2 off2 len2)
460425 | otherwise = overflowError "append"
461426 where
462427 len = len1+len2
463− x :: ST s (A.MArray s)
464428 x = do
465429 arr <- A.new len
466430 A.copyI arr 0 arr1 off1 len1
467431 A.copyI arr len1 arr2 off2 len
468432 return arr
469−{-# NOINLINE append #-}
433+{-# INLINE append #-}
470434
471435{-# RULES
472436"TEXT append -> fused" [~1] forall t1 t2.
@@ -486,8 +450,8 @@ head t = S.head (stream t)
486450uncons :: Text -> Maybe (Char, Text)
487451uncons t@(Text arr off len)
488452 | len <= 0 = Nothing
489− | otherwise = Just $ let !(Iter c d) = iter t 0
490− in (c, text arr (off+d) (len-d))
453+ | otherwise = Just (c, textP arr (off+d) (len-d))
454+ where Iter c d = iter t 0
491455{-# INLINE [1] uncons #-}
492456
493457-- | Lifted from Control.Arrow and specialized.
@@ -517,7 +481,7 @@ last (Text arr off len)
517481tail :: Text -> Text
518482tail t@(Text arr off len)
519483 | len <= 0 = emptyError "tail"
520− | otherwise = text arr (off+d) (len-d)
484+ | otherwise = textP arr (off+d) (len-d)
521485 where d = iter_ t 0
522486{-# INLINE [1] tail #-}
523487
@@ -532,8 +496,8 @@ tail t@(Text arr off len)
532496-- be non-empty. Subject to fusion.
533497init :: Text -> Text
534498init (Text arr off len) | len <= 0 = emptyError "init"
535− | n >= 0xDC00 && n <= 0xDFFF = text arr off (len-2)
536− | otherwise = text arr off (len-1)
499+ | n >= 0xDC00 && n <= 0xDFFF = textP arr off (len-2)
500+ | otherwise = textP arr off (len-1)
537501 where
538502 n = A.unsafeIndex arr (off+len-1)
539503{-# INLINE [1] init #-}
@@ -572,9 +536,7 @@ isSingleton = S.isSingleton . stream
572536-- Subject to fusion.
573537length :: Text -> Int
574538length t = S.length (stream t)
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.
539+{-# INLINE length #-}
578540
579541-- | /O(n)/ Compare the count of characters in a 'Text' to a number.
580542-- Subject to fusion.
@@ -593,32 +555,32 @@ compareLength t n = S.compareLengthI (stream t) n
593555
594556{-# RULES
595557"TEXT ==N/length -> compareLength/==EQ" [~1] forall t n.
596− eqInt (length t) n = compareLength t n == EQ
558+ (==) (length t) n = compareLength t n == EQ
597559 #-}
598560
599561{-# RULES
600562"TEXT /=N/length -> compareLength//=EQ" [~1] forall t n.
601− neInt (length t) n = compareLength t n /= EQ
563+ (/=) (length t) n = compareLength t n /= EQ
602564 #-}
603565
604566{-# RULES
605567"TEXT <N/length -> compareLength/==LT" [~1] forall t n.
606− ltInt (length t) n = compareLength t n == LT
568+ (<) (length t) n = compareLength t n == LT
607569 #-}
608570
609571{-# RULES
610572"TEXT <=N/length -> compareLength//=GT" [~1] forall t n.
611− leInt (length t) n = compareLength t n /= GT
573+ (<=) (length t) n = compareLength t n /= GT
612574 #-}
613575
614576{-# RULES
615577"TEXT >N/length -> compareLength/==GT" [~1] forall t n.
616− gtInt (length t) n = compareLength t n == GT
578+ (>) (length t) n = compareLength t n == GT
617579 #-}
618580
619581{-# RULES
620582"TEXT >=N/length -> compareLength//=LT" [~1] forall t n.
621− geInt (length t) n = compareLength t n /= LT
583+ (>=) (length t) n = compareLength t n /= LT
622584 #-}
623585
624586-- -----------------------------------------------------------------------------
@@ -634,7 +596,7 @@ map f t = unstream (S.map (safe . f) (stream t))
634596-- 'Text's and concatenates the list after interspersing the first
635597-- argument between each element of the list.
636598intercalate :: Text -> [Text] -> Text
637−intercalate t = concat . (F.intersperse t)
599+intercalate t = concat . (U.intersperse t)
638600{-# INLINE intercalate #-}
639601
640602-- | /O(n)/ The 'intersperse' function takes a character and places it
@@ -649,59 +611,16 @@ reverse :: Text -> Text
649611reverse t = S.reverse (stream t)
650612{-# INLINE reverse #-}
651613
652−-- | /O(m+n)/ Replace every non-overlapping occurrence of @needle@ in
653−-- @haystack@ with @replacement@.
654−--
655−-- This function behaves as though it was defined as follows:
656−--
657−-- @
658−-- replace needle replacement haystack =
659−-- 'intercalate' replacement ('splitOn' needle haystack)
660−-- @
661−--
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:
665−--
666−-- > replace "oo" "foo" "oo" == "foo"
667−--
668−-- In cases where several instances of @needle@ overlap, only the
669−-- first one will be replaced:
670−--
671−-- > replace "ofo" "bar" "ofofo" == "barfo"
614+-- | /O(m+n)/ Replace every occurrence of one substring with another.
672615--
673616-- In (unlikely) bad cases, this function's time complexity degrades
674617-- towards /O(n*m)/.
675−replace :: Text
676− -- ^ @needle@ to search for. If this string is empty, an
677− -- error will occur.
678− -> Text
679− -- ^ @replacement@ to replace @needle@ with.
680− -> Text
681− -- ^ @haystack@ in which to search.
618+replace :: Text -- ^ Text to search for
619+ -> Text -- ^ Replacement text
620+ -> Text -- ^ Input text
682621 -> Text
683−replace needle@(Text _ _ neeLen)
684− (Text repArr repOff repLen)
685− haystack@(Text hayArr hayOff hayLen)
686− | neeLen == 0 = emptyError "replace"
687− | L.null ixs = haystack
688− | len > 0 = Text (A.run x) 0 len
689− | otherwise = empty
690− where
691− ixs = indices needle haystack
692− len = hayLen - (neeLen - repLen) `mul` L.length ixs
693− x :: ST s (A.MArray s)
694− x = do
695− marr <- A.new len
696− let loop (i:is) o d = do
697− let d0 = d + i - o
698− d1 = d0 + repLen
699− A.copyI marr d hayArr (hayOff+o) d0
700− A.copyI marr d0 repArr repOff d1
701− loop is (i + neeLen) d1
702− loop [] o d = A.copyI marr d hayArr (hayOff+o) len
703− loop ixs 0 0
704− return marr
622+replace s d = intercalate d . splitOn s
623+{-# INLINE replace #-}
705624
706625-- ----------------------------------------------------------------------------
707626-- ** Case conversions (folds)
@@ -720,13 +639,13 @@ replace needle@(Text _ _ neeLen)
720639-- /Note/: In some languages, case conversion is a locale- and
721640-- context-dependent operation. The case conversion functions in this
722641-- module are /not/ locale sensitive. Programs that require locale
723−-- sensitivity should use appropriate versions of the
724−-- <http://hackage.haskell.org/package/text-icu-0.6.3.7/docs/Data-Text-ICU.html#g:4 case mapping functions from the text-icu package >.
642+-- sensitivity should use appropriate versions of the case mapping
643+-- functions from the @text-icu@ package:
644+-- <http://hackage.haskell.org/package/text-icu>
725645
726−-- | /O(n)/ Convert a string to folded case. Subject to fusion.
727−--
728−-- This function is mainly useful for performing caseless (also known
729−-- as case insensitive) string comparisons.
646+-- | /O(n)/ Convert a string to folded case. This function is mainly
647+-- useful for performing caseless (also known as case insensitive)
648+-- string comparisons.
730649--
731650-- A string @x@ is a caseless match for a string @y@ if and only if:
732651--
@@ -741,51 +660,25 @@ replace needle@(Text _ _ neeLen)
741660-- instead of itself.
742661toCaseFold :: Text -> Text
743662toCaseFold t = unstream (S.toCaseFold (stream t))
744−{-# INLINE toCaseFold #-}
663+{-# INLINE [0] toCaseFold #-}
745664
746665-- | /O(n)/ Convert a string to lower case, using simple case
747−-- conversion. Subject to fusion.
748−--
749−-- The result string may be longer than the input string. For
750−-- instance, \"İ\" (Latin capital letter I with dot above,
751−-- U+0130) maps to the sequence \"i\" (Latin small letter i, U+0069)
752−-- followed by \" ̇\" (combining dot above, U+0307).
666+-- conversion. The result string may be longer than the input string.
667+-- For instance, \"İ\" (Latin capital letter I with dot above,
668+-- U+0130) maps to the sequence \"i\" (Latin small letter i, U+0069) followed
669+-- by \" ̇\" (combining dot above, U+0307).
753670toLower :: Text -> Text
754671toLower t = unstream (S.toLower (stream t))
755672{-# INLINE toLower #-}
756673
757674-- | /O(n)/ Convert a string to upper case, using simple case
758−-- conversion. Subject to fusion.
759−--
760−-- The result string may be longer than the input string. For
761−-- instance, the German \"ß\" (eszett, U+00DF) maps to the
675+-- conversion. The result string may be longer than the input string.
676+-- For instance, the German \"ß\" (eszett, U+00DF) maps to the
762677-- two-letter sequence \"SS\".
763678toUpper :: Text -> Text
764679toUpper t = unstream (S.toUpper (stream t))
765680{-# INLINE toUpper #-}
766681
767−-- | /O(n)/ Convert a string to title case, using simple case
768−-- conversion. Subject to fusion.
769−--
770−-- The first letter of the input is converted to title case, as is
771−-- every subsequent letter that immediately follows a non-letter.
772−-- Every letter that immediately follows another letter is converted
773−-- to lower case.
774−--
775−-- The result string may be longer than the input string. For example,
776−-- the Latin small ligature fl (U+FB02) is converted to the
777−-- sequence Latin capital letter F (U+0046) followed by Latin small
778−-- letter l (U+006C).
779−--
780−-- /Note/: this function does not take language or culture specific
781−-- rules into account. For instance, in English, different style
782−-- guides disagree on whether the book name \"The Hill of the Red
783−-- Fox\" is correctly title cased—but this function will
784−-- capitalize /every/ word.
785−toTitle :: Text -> Text
786−toTitle t = unstream (S.toTitle (stream t))
787−{-# INLINE toTitle #-}
788−
789682-- | /O(n)/ Left-justify a string to the given length, using the
790683-- specified fill character on the right. Subject to fusion.
791684-- Performs replacement on invalid scalar values.
@@ -901,7 +794,6 @@ concat ts = case ts' of
901794 where
902795 ts' = L.filter (not . null) ts
903796 len = sumP "concat" $ L.map lengthWord16 ts'
904− go :: ST s (A.MArray s)
905797 go = do
906798 arr <- A.new len
907799 let step i (Text a o l) =
@@ -915,13 +807,13 @@ concatMap f = concat . foldr ((:) . f) []
915807{-# INLINE concatMap #-}
916808
917809-- | /O(n)/ 'any' @p@ @t@ determines whether any character in the
918−-- 'Text' @t@ satisfies the predicate @p@. Subject to fusion.
810+-- 'Text' @t@ satisifes the predicate @p@. Subject to fusion.
919811any :: (Char -> Bool) -> Text -> Bool
920812any p t = S.any p (stream t)
921813{-# INLINE any #-}
922814
923815-- | /O(n)/ 'all' @p@ @t@ determines whether all characters in the
924−-- 'Text' @t@ satisfy the predicate @p@. Subject to fusion.
816+-- 'Text' @t@ satisify the predicate @p@. Subject to fusion.
925817all :: (Char -> Bool) -> Text -> Bool
926818all p t = S.all p (stream t)
927819{-# INLINE all #-}
@@ -1012,10 +904,10 @@ replicate n t@(Text a o l)
1012904 | n <= 0 || l <= 0 = empty
1013905 | n == 1 = t
1014906 | isSingleton t = replicateChar n (unsafeHead t)
1015− | otherwise = Text (A.run x) 0 len
907+ | n <= maxBound `quot` l = Text (A.run x) 0 len
908+ | otherwise = overflowError "replicate"
1016909 where
1017− len = l `mul` n
1018− x :: ST s (A.MArray s)
910+ len = l * n
1019911 x = do
1020912 arr <- A.new len
1021913 let loop !d !i | i >= n = return arr
@@ -1066,16 +958,14 @@ take :: Int -> Text -> Text
1066958take n t@(Text arr off len)
1067959 | n <= 0 = empty
1068960 | n >= len = t
1069− | otherwise = text arr off (iterN n t)
961+ | otherwise = Text arr off (loop 0 0)
962+ where
963+ loop !i !cnt
964+ | i >= len || cnt >= n = i
965+ | otherwise = loop (i+d) (cnt+1)
966+ where d = iter_ t i
1070967{-# INLINE [1] take #-}
1071968
1072−iterN :: Int -> Text -> Int
1073−iterN n t@(Text _arr _off len) = loop 0 0
1074− where loop !i !cnt
1075− | i >= len || cnt >= n = i
1076− | otherwise = loop (i+d) (cnt+1)
1077− where d = iter_ t i
1078−
1079969{-# RULES
1080970"TEXT take -> fused" [~1] forall n t.
1081971 take n t = unstream (S.take n (stream t))
@@ -1083,27 +973,6 @@ iterN n t@(Text _arr _off len) = loop 0 0
1083973 unstream (S.take n (stream t)) = take n t
1084974 #-}
1085975
1086−-- | /O(n)/ 'takeEnd' @n@ @t@ returns the suffix remaining after
1087−-- taking @n@ characters from the end of @t@.
1088−--
1089−-- Examples:
1090−--
1091−-- > takeEnd 3 "foobar" == "bar"
1092−takeEnd :: Int -> Text -> Text
1093−takeEnd n t@(Text arr off len)
1094− | n <= 0 = empty
1095− | n >= len = t
1096− | otherwise = text arr (off+i) (len-i)
1097− where i = iterNEnd n t
1098−
1099−iterNEnd :: Int -> Text -> Int
1100−iterNEnd n t@(Text _arr _off len) = loop (len-1) n
1101− where loop i !m
1102− | i <= 0 = 0
1103− | m <= 1 = i
1104− | otherwise = loop (i+d) (m-1)
1105− where d = reverseIter_ t i
1106−
1107976-- | /O(n)/ 'drop' @n@, applied to a 'Text', returns the suffix of the
1108977-- 'Text' after the first @n@ characters, or the empty 'Text' if @n@
1109978-- is greater than the length of the 'Text'. Subject to fusion.
@@ -1111,8 +980,11 @@ drop :: Int -> Text -> Text
1111980drop n t@(Text arr off len)
1112981 | n <= 0 = t
1113982 | n >= len = empty
1114− | otherwise = text arr (off+i) (len-i)
1115− where i = iterN n t
983+ | otherwise = loop 0 0
984+ where loop !i !cnt
985+ | i >= len || cnt >= n = Text arr (off+i) (len-i)
986+ | otherwise = loop (i+d) (cnt+1)
987+ where d = iter_ t i
1116988{-# INLINE [1] drop #-}
1117989
1118990{-# RULES
@@ -1122,18 +994,6 @@ drop n t@(Text arr off len)
1122994 unstream (S.drop n (stream t)) = drop n t
1123995 #-}
1124996
1125−-- | /O(n)/ 'dropEnd' @n@ @t@ returns the prefix remaining after
1126−-- dropping @n@ characters from the end of @t@.
1127−--
1128−-- Examples:
1129−--
1130−-- > dropEnd 3 "foobar" == "foo"
1131−dropEnd :: Int -> Text -> Text
1132−dropEnd n t@(Text arr off len)
1133− | n <= 0 = t
1134− | n >= len = empty
1135− | otherwise = text arr off (iterNEnd n t)
1136−
1137997-- | /O(n)/ 'takeWhile', applied to a predicate @p@ and a 'Text',
1138998-- returns the longest prefix (possibly empty) of elements that
1139999-- satisfy @p@. Subject to fusion.
@@ -1141,7 +1001,7 @@ takeWhile :: (Char -> Bool) -> Text -> Text
11411001takeWhile p t@(Text arr off len) = loop 0
11421002 where loop !i | i >= len = t
11431003 | p c = loop (i+d)
1144− | otherwise = text arr off i
1004+ | otherwise = textP arr off i
11451005 where Iter c d = iter t i
11461006{-# INLINE [1] takeWhile #-}
11471007
@@ -1152,27 +1012,6 @@ takeWhile p t@(Text arr off len) = loop 0
11521012 unstream (S.takeWhile p (stream t)) = takeWhile p t
11531013 #-}
11541014
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.
1158−-- Examples:
1159−--
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 #-}
1168−
1169−{-# RULES
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
1174− #-}
1175−
11761015-- | /O(n)/ 'dropWhile' @p@ @t@ returns the suffix remaining after
11771016-- 'takeWhile' @p@ @t@. Subject to fusion.
11781017dropWhile :: (Char -> Bool) -> Text -> Text
@@ -1191,9 +1030,8 @@ dropWhile p t@(Text arr off len) = loop 0 0
11911030 #-}
11921031
11931032-- | /O(n)/ 'dropWhileEnd' @p@ @t@ returns the prefix remaining after
1194−-- dropping characters that satisfy the predicate @p@ from the end of
1033+-- dropping characters that fail the predicate @p@ from the end of
11951034-- @t@. Subject to fusion.
1196−--
11971035-- Examples:
11981036--
11991037-- > dropWhileEnd (=='.') "foo..." == "foo"
@@ -1213,7 +1051,7 @@ dropWhileEnd p t@(Text arr off len) = loop (len-1) len
12131051 #-}
12141052
12151053-- | /O(n)/ 'dropAround' @p@ @t@ returns the substring remaining after
1216−-- dropping characters that satisfy the predicate @p@ from both the
1054+-- dropping characters that fail the predicate @p@ from both the
12171055-- beginning and end of @t@. Subject to fusion.
12181056dropAround :: (Char -> Bool) -> Text -> Text
12191057dropAround p = dropWhile p . dropWhileEnd p
@@ -1248,8 +1086,13 @@ splitAt :: Int -> Text -> (Text, Text)
12481086splitAt n t@(Text arr off len)
12491087 | n <= 0 = (empty, t)
12501088 | n >= len = (t, empty)
1251− | otherwise = let k = iterN n t
1252− in (text arr off k, text arr (off+k) (len-k))
1089+ | otherwise = (Text arr off k, Text arr (off+k) (len-k))
1090+ where k = loop 0 0
1091+ loop !i !cnt
1092+ | i >= len || cnt >= n = i
1093+ | otherwise = loop (i+d) (cnt+1)
1094+ where d = iter_ t i
1095+{-# INLINE splitAt #-}
12531096
12541097-- | /O(n)/ 'span', applied to a predicate @p@ and text @t@, returns
12551098-- a pair whose first element is the longest prefix (possibly empty)
@@ -1308,9 +1151,9 @@ tails t | null t = [empty]
13081151-- copies to create substrings; they just construct new 'Text's that
13091152-- are slices of the original.
13101153
1311−-- | /O(m+n)/ Break a 'Text' into pieces separated by the first 'Text'
1312−-- argument (which cannot be empty), consuming the delimiter. An empty
1313−-- delimiter is invalid, and will cause an error to be raised.
1154+-- | /O(m+n)/ Break a 'Text' into pieces separated by the first
1155+-- 'Text' argument, consuming the delimiter. An empty delimiter is
1156+-- invalid, and will cause an error to be raised.
13141157--
13151158-- Examples:
13161159--
@@ -1323,23 +1166,16 @@ tails t | null t = [empty]
13231166-- > intercalate s . splitOn s == id
13241167-- > splitOn (singleton c) == split (==c)
13251168--
1326−-- (Note: the string @s@ to split on above cannot be empty.)
1327−--
13281169-- In (unlikely) bad cases, this function's time complexity degrades
13291170-- towards /O(n*m)/.
1330−splitOn :: Text
1331− -- ^ String to split on. If this string is empty, an error
1332− -- will occur.
1333− -> Text
1334− -- ^ Input text.
1335− -> [Text]
1171+splitOn :: Text -> Text -> [Text]
13361172splitOn pat@(Text _ _ l) src@(Text arr off len)
13371173 | l <= 0 = emptyError "splitOn"
13381174 | isSingleton pat = split (== unsafeHead pat) src
13391175 | otherwise = go 0 (indices pat src)
13401176 where
1341− go !s (x:xs) = text arr (s+off) (x-s) : go (x+l) xs
1342− go s _ = [text arr (s+off) (len-s)]
1177+ go !s (x:xs) = textP arr (s+off) (x-s) : go (x+l) xs
1178+ go s _ = [textP arr (s+off) (len-s)]
13431179{-# INLINE [1] splitOn #-}
13441180
13451181{-# RULES
@@ -1431,7 +1267,7 @@ breakOn pat src@(Text arr off len)
14311267 | null pat = emptyError "breakOn"
14321268 | otherwise = case indices pat src of
14331269 [] -> (src, empty)
1434− (x:_) -> (text arr off x, text arr (off+x) (len-x))
1270+ (x:_) -> (textP arr off x, textP arr (off+x) (len-x))
14351271{-# INLINE breakOn #-}
14361272
14371273-- | /O(n+m)/ Similar to 'breakOn', but searches from the end of the
@@ -1473,7 +1309,7 @@ breakOnAll pat src@(Text arr off slen)
14731309 | otherwise = L.map step (indices pat src)
14741310 where
14751311 step x = (chunk 0 x, chunk x (slen-x))
1476− chunk !n !l = text arr (n+off) l
1312+ chunk !n !l = textP arr (n+off) l
14771313{-# INLINE breakOnAll #-}
14781314
14791315-------------------------------------------------------------------------------
@@ -1540,7 +1376,7 @@ countChar c t = S.countChar c (stream t)
15401376-- equivalent to a pair of 'unpack' operations.
15411377zip :: Text -> Text -> [(Char,Char)]
15421378zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1543−{-# INLINE zip #-}
1379+{-# INLINE [0] zip #-}
15441380
15451381-- | /O(n)/ 'zipWith' generalises 'zip' by zipping with the function
15461382-- given as the first argument, instead of a tupling function.
@@ -1548,7 +1384,7 @@ zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
15481384zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
15491385zipWith f t1 t2 = unstream (S.zipWith g (stream t1) (stream t2))
15501386 where g a b = safe (f a b)
1551−{-# INLINE zipWith #-}
1387+{-# INLINE [0] zipWith #-}
15521388
15531389-- | /O(n)/ Breaks a 'Text' up into a list of words, delimited by 'Char's
15541390-- representing white space.
@@ -1673,7 +1509,7 @@ isInfixOf needle haystack
16731509-- > fnordLength _ = -1
16741510stripPrefix :: Text -> Text -> Maybe Text
16751511stripPrefix p@(Text _arr _off plen) t@(Text arr off len)
1676− | p `isPrefixOf` t = Just $! text arr (off+plen) (len-plen)
1512+ | p `isPrefixOf` t = Just $! textP arr (off+plen) (len-plen)
16771513 | otherwise = Nothing
16781514
16791515-- | /O(n)/ Find the longest non-empty common prefix of two strings
@@ -1693,8 +1529,8 @@ commonPrefixes t0@(Text arr0 off0 len0) t1@(Text arr1 off1 len1) = go 0 0
16931529 where
16941530 go !i !j | i < len0 && j < len1 && a == b = go (i+d0) (j+d1)
16951531 | i > 0 = Just (Text arr0 off0 i,
1696− text arr0 (off0+i) (len0-i),
1697− text arr1 (off1+j) (len1-j))
1532+ textP arr0 (off0+i) (len0-i),
1533+ textP arr1 (off1+j) (len1-j))
16981534 | otherwise = Nothing
16991535 where Iter a d0 = iter t0 i
17001536 Iter b d1 = iter t1 j
@@ -1719,7 +1555,7 @@ commonPrefixes t0@(Text arr0 off0 len0) t1@(Text arr1 off1 len1) = go 0 0
17191555-- > quuxLength _ = -1
17201556stripSuffix :: Text -> Text -> Maybe Text
17211557stripSuffix p@(Text _arr _off plen) t@(Text arr off len)
1722− | p `isSuffixOf` t = Just $! text arr off (len-plen)
1558+ | p `isSuffixOf` t = Just $! textP arr off (len-plen)
17231559 | otherwise = Nothing
17241560
17251561-- | Add a list of non-negative numbers. Errors out on overflow.
@@ -1748,7 +1584,6 @@ overflowError fun = P.error $ "Data.Text." ++ fun ++ ": size overflow"
17481584copy :: Text -> Text
17491585copy (Text arr off len) = Text (A.run go) 0 len
17501586 where
1751− go :: ST s (A.MArray s)
17521587 go = do
17531588 marr <- A.new len
17541589 A.copyI marr 0 arr off len