@@ -1,20 +1,15 @@
1−{-# LANGUAGE BangPatterns, CPP, MagicHash, Rank2Types, UnboxedTuples #-}
1+{-# LANGUAGE BangPatterns, CPP, Rank2Types #-}
22{-# OPTIONS_GHC -fno-warn-orphans #-}
3−#if __GLASGOW_HASKELL__ >= 702
4−{-# LANGUAGE Trustworthy #-}
5−#endif
6−#if __GLASGOW_HASKELL__ >= 708
7−{-# LANGUAGE TypeFamilies #-}
8−#endif
93
104-- |
115-- Module : Data.Text
12−-- Copyright : (c) 2009, 2010, 2011, 2012 Bryan O'Sullivan,
13−-- (c) 2009 Duncan Coutts,
14−-- (c) 2008, 2009 Tom Harper
6+-- Copyright : (c) 2008, 2009 Tom Harper,
7+-- (c) 2009, 2010 Bryan O'Sullivan,
8+-- (c) 2009 Duncan Coutts
159--
1610-- License : BSD-style
17−-- Maintainer : bos@serpentine.com
11+-- Maintainer : bos@serpentine.com, rtomharper@googlemail.com,
12+-- duncan@haskell.org
1813-- Stability : experimental
1914-- Portability : GHC
2015--
@@ -32,8 +27,8 @@
3227--
3328-- To use an extended and very rich family of functions for working
3429-- 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 >.
30+-- non-standard encodings, text breaking, and locales), see the
31+-- @text-icu@ package: <http://hackage.haskell.org/package/text-icu>
3732
3833module Data.Text
3934 (
@@ -81,7 +76,6 @@ module Data.Text
8176 , toCaseFold
8277 , toLower
8378 , toUpper
84− , toTitle
8579
8680 -- ** Justification
8781 , justifyLeft
@@ -125,11 +119,8 @@ module Data.Text
125119
126120 -- ** Breaking strings
127121 , take
128− , takeEnd
129122 , drop
130− , dropEnd
131123 , takeWhile
132− , takeWhileEnd
133124 , dropWhile
134125 , dropWhileEnd
135126 , dropAround
@@ -176,110 +167,92 @@ module Data.Text
176167 , partition
177168
178169 -- , findSubstring
179−
170+
180171 -- * Indexing
181172 -- $index
182173 , index
183174 , findIndex
184175 , count
185176
186− -- * Zipping
177+ -- * Zipping and unzipping
187178 , zip
188179 , zipWith
189180
190181 -- -* Ordered text
191182 -- , sort
192−
193− -- * Low level operations
194− , copy
195− , unpackCString#
196183 ) where
197184
198185import Prelude (Char, Bool(..), Int, Maybe(..), String,
199186 Eq(..), Ord(..), Ordering(..), (++),
200− Read(..),
201− (&&), (||), (+), (-), (.), ($), ($!), (>>),
202− not, return, otherwise, quot)
187+ Read(..), Show(..),
188+ (&&), (||), (+), (-), (.), ($), ($!), (>>), (*),
189+ div, maxBound, not, return, otherwise)
203190#if defined(HAVE_DEEPSEQ)
204−import Control.DeepSeq (NFData(rnf))
191+import Control.DeepSeq (NFData)
205192#endif
206193#if defined(ASSERTS)
207194import Control.Exception (assert)
208195#endif
209196import Data.Char (isSpace)
210−import Data.Data (Data(gfoldl, toConstr, gunfold, dataTypeOf), constrIndex,
211− Constr, mkConstr, DataType, mkDataType, Fixity(Prefix))
197+import Data.Data (Data(gfoldl, toConstr, gunfold, dataTypeOf))
198+#if __GLASGOW_HASKELL__ >= 612
199+import Data.Data (mkNoRepType)
200+#else
201+import Data.Data (mkNorepType)
202+#endif
212203import Control.Monad (foldM)
213−import Control.Monad.ST (ST)
214204import qualified Data.Text.Array as A
215205import qualified Data.List as L
216−import Data.Binary (Binary(get, put))
217206import Data.Monoid (Monoid(..))
218−#if MIN_VERSION_base(4,9,0)
219−import Data.Semigroup (Semigroup(..))
220−#endif
221207import 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#)
208+import qualified Data.Text.Fusion as S
209+import qualified Data.Text.Fusion.Common as S
210+import Data.Text.Fusion (stream, reverseStream, unstream)
211+import Data.Text.Internal (Text(..), empty, firstf, safe, text, textP)
229212import qualified Prelude as P
230213import 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)
214+ unsafeHead, unsafeTail)
215+import Data.Text.UnsafeChar (unsafeChr)
216+import qualified Data.Text.Util as U
217+import qualified Data.Text.Encoding.Utf16 as U16
218+import Data.Text.Search (indices)
236219#if defined(__HADDOCK__)
237220import Data.ByteString (ByteString)
238221import qualified Data.Text.Lazy as L
239222import Data.Int (Int64)
240223#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)
247−#endif
248224
249225-- $strict
250226--
251227-- 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
228+-- strict type is provided by the 'Data.Text' package, while the lazy
229+-- type is provided by the 'Data.Text.Lazy' package. Internally, the
254230-- lazy @Text@ type consists of a list of strict chunks.
255231--
256232-- 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.
233+-- memory at once. The lazy @Text@ type is capable of streaming
234+-- strings that are larger than memory using a small memory footprint.
235+-- In many cases, the overhead of chunked streaming makes the lazy
236+-- @Text@ type slower than its strict counterpart, but this is not
237+-- always the case. Sometimes, the time complexity of a function in
238+-- one module may be different from the other, due to their differing
239+-- internal structures.
264240--
265241-- Each module provides an almost identical API, with the main
266242-- difference being that the strict module uses 'Int' values for
267−-- lengths and counts, while the lazy module uses 'Data.Int.Int64'
268−-- lengths.
243+-- lengths and counts, while the lazy module uses 'Int64' lengths.
269244
270245-- $replacement
271246--
272247-- 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.
248+-- in §3.9, definition D76 of the Unicode 5.2 standard:
249+-- <http://www.unicode.org/versions/Unicode5.2.0/ch03.pdf#page=35>. As
250+-- such, a 'Text' cannot contain values in the range U+D800 to U+DFFF
251+-- inclusive. Haskell implementations admit all Unicode code points
252+-- (§3.4, definition D10) as 'Char' values, including code points
253+-- from this invalid range. This means that there are some 'Char'
254+-- values that are not valid Unicode scalar values, and the functions
255+-- in this module must handle those cases.
283256--
284257-- Within this module, many functions construct a 'Text' from one or
285258-- more 'Char' values. Those functions will substitute 'Char' values
@@ -293,8 +266,8 @@ import Text.Printf (PrintfArg, formatArg, formatString)
293266-- range U+D800 through U+DFFF are used by UTF-16 to denote surrogate
294267-- code points, and so cannot be represented. The functions replace
295268-- 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 >.)
269+-- measure. For details, see Unicode Technical Report 36, §3.5:
270+-- <http://unicode.org/reports/tr36/#Deletion_of_Noncharacters>)
298271
299272-- $fusion
300273--
@@ -312,11 +285,11 @@ import Text.Printf (PrintfArg, formatArg, formatString)
312285-- > countChars = T.length . T.toUpper . E.decodeUtf8
313286--
314287-- 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'.
288+-- allocate one 'ByteString' value, and two 'Text' values. However,
289+-- when a module is compiled with optimisation enabled under GHC, the
290+-- two intermediate 'Text' values will be optimised away, and the
291+-- function will be compiled down to a single loop over the source
292+-- 'ByteString'.
320293--
321294-- Functions that can be fused by the compiler are documented with the
322295-- phrase \"Subject to fusion\".
@@ -330,83 +303,46 @@ instance Eq Text where
330303instance Ord Text where
331304 compare = compareText
332305
306+instance Show Text where
307+ showsPrec p ps r = showsPrec p (unpack ps) r
308+
333309instance Read Text where
334310 readsPrec p str = [(pack x,y) | (x,y) <- readsPrec p str]
335311
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−
344312instance Monoid Text where
345313 mempty = empty
346−#if MIN_VERSION_base(4,9,0)
347− mappend = (<>) -- future-proof definition
348−#else
349314 mappend = append
350−#endif
351315 mconcat = concat
352316
353317instance IsString Text where
354318 fromString = pack
355319
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−
363320#if defined(HAVE_DEEPSEQ)
364−instance NFData Text where rnf !_ = ()
321+instance NFData Text
365322#endif
366323
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.
324+-- This instance preserves data abstraction at the cost of inefficiency.
376325-- We omit reflection services for the sake of data abstraction.
326+--
327+-- This instance was created by copying the behavior of Data.Set and
328+-- Data.Map. If you feel a mistake has been made, please feel free to
329+-- submit improvements.
377330--
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? >
385−--
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, ... >
331+-- Original discussion is archived here:
332+
333+-- "could we get a Data instance for Data.Text.Text?"
334+-- http://groups.google.com/group/haskell-cafe/browse_thread/thread/b5bbb1b28a7e525d/0639d46852575b93
389335
390336instance Data Text where
391337 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
338+ toConstr _ = P.error "Data.Text.Text.toConstr"
339+ gunfold _ _ = P.error "Data.Text.Text.gunfold"
340+#if __GLASGOW_HASKELL__ >= 612
341+ dataTypeOf _ = mkNoRepType "Data.Text.Text"
342+#else
343+ dataTypeOf _ = mkNorepType "Data.Text.Text"
402344#endif
403345
404−packConstr :: Constr
405−packConstr = mkConstr textDataType "pack" [] Prefix
406−
407−textDataType :: DataType
408−textDataType = mkDataType "Data.Text.Text" [packConstr]
409−
410346-- | /O(n)/ Compare two 'Text' values lexicographically.
411347compareText :: Text -> Text -> Ordering
412348compareText ta@(Text _arrA _offA lenA) tb@(Text _arrB _offB lenB)
@@ -427,9 +363,20 @@ compareText ta@(Text _arrA _offA lenA) tb@(Text _arrB _offB lenB)
427363-- | /O(n)/ Convert a 'String' into a 'Text'. Subject to
428364-- fusion. Performs replacement on invalid scalar values.
429365pack :: String -> Text
430−pack = unstream . S.map safe . S.streamList
366+pack = unstream . S.streamList . L.map safe
431367{-# INLINE [1] pack #-}
432368
369+-- | /O(n)/ Convert a Text into a String. Subject to fusion.
370+unpack :: Text -> String
371+unpack = S.unstreamList . stream
372+{-# INLINE [1] unpack #-}
373+
374+-- | /O(1)/ Convert a character into a Text. Subject to fusion.
375+-- Performs replacement on invalid scalar values.
376+singleton :: Char -> Text
377+singleton = unstream . S.singleton . safe
378+{-# INLINE [1] singleton #-}
379+
433380-- -----------------------------------------------------------------------------
434381-- * Basic functions
435382
@@ -460,13 +407,12 @@ append a@(Text arr1 off1 len1) b@(Text arr2 off2 len2)
460407 | otherwise = overflowError "append"
461408 where
462409 len = len1+len2
463− x :: ST s (A.MArray s)
464410 x = do
465411 arr <- A.new len
466412 A.copyI arr 0 arr1 off1 len1
467413 A.copyI arr len1 arr2 off2 len
468414 return arr
469−{-# NOINLINE append #-}
415+{-# INLINE append #-}
470416
471417{-# RULES
472418"TEXT append -> fused" [~1] forall t1 t2.
@@ -486,8 +432,8 @@ head t = S.head (stream t)
486432uncons :: Text -> Maybe (Char, Text)
487433uncons t@(Text arr off len)
488434 | len <= 0 = Nothing
489− | otherwise = Just $ let !(Iter c d) = iter t 0
490− in (c, text arr (off+d) (len-d))
435+ | otherwise = Just (c, textP arr (off+d) (len-d))
436+ where Iter c d = iter t 0
491437{-# INLINE [1] uncons #-}
492438
493439-- | Lifted from Control.Arrow and specialized.
@@ -517,7 +463,7 @@ last (Text arr off len)
517463tail :: Text -> Text
518464tail t@(Text arr off len)
519465 | len <= 0 = emptyError "tail"
520− | otherwise = text arr (off+d) (len-d)
466+ | otherwise = textP arr (off+d) (len-d)
521467 where d = iter_ t 0
522468{-# INLINE [1] tail #-}
523469
@@ -532,8 +478,8 @@ tail t@(Text arr off len)
532478-- be non-empty. Subject to fusion.
533479init :: Text -> Text
534480init (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)
481+ | n >= 0xDC00 && n <= 0xDFFF = textP arr off (len-2)
482+ | otherwise = textP arr off (len-1)
537483 where
538484 n = A.unsafeIndex arr (off+len-1)
539485{-# INLINE [1] init #-}
@@ -572,9 +518,7 @@ isSingleton = S.isSingleton . stream
572518-- Subject to fusion.
573519length :: Text -> Int
574520length 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.
521+{-# INLINE length #-}
578522
579523-- | /O(n)/ Compare the count of characters in a 'Text' to a number.
580524-- Subject to fusion.
@@ -593,32 +537,32 @@ compareLength t n = S.compareLengthI (stream t) n
593537
594538{-# RULES
595539"TEXT ==N/length -> compareLength/==EQ" [~1] forall t n.
596− eqInt (length t) n = compareLength t n == EQ
540+ (==) (length t) n = compareLength t n == EQ
597541 #-}
598542
599543{-# RULES
600544"TEXT /=N/length -> compareLength//=EQ" [~1] forall t n.
601− neInt (length t) n = compareLength t n /= EQ
545+ (/=) (length t) n = compareLength t n /= EQ
602546 #-}
603547
604548{-# RULES
605549"TEXT <N/length -> compareLength/==LT" [~1] forall t n.
606− ltInt (length t) n = compareLength t n == LT
550+ (<) (length t) n = compareLength t n == LT
607551 #-}
608552
609553{-# RULES
610554"TEXT <=N/length -> compareLength//=GT" [~1] forall t n.
611− leInt (length t) n = compareLength t n /= GT
555+ (<=) (length t) n = compareLength t n /= GT
612556 #-}
613557
614558{-# RULES
615559"TEXT >N/length -> compareLength/==GT" [~1] forall t n.
616− gtInt (length t) n = compareLength t n == GT
560+ (>) (length t) n = compareLength t n == GT
617561 #-}
618562
619563{-# RULES
620564"TEXT >=N/length -> compareLength//=LT" [~1] forall t n.
621− geInt (length t) n = compareLength t n /= LT
565+ (>=) (length t) n = compareLength t n /= LT
622566 #-}
623567
624568-- -----------------------------------------------------------------------------
@@ -634,7 +578,7 @@ map f t = unstream (S.map (safe . f) (stream t))
634578-- 'Text's and concatenates the list after interspersing the first
635579-- argument between each element of the list.
636580intercalate :: Text -> [Text] -> Text
637−intercalate t = concat . (F.intersperse t)
581+intercalate t = concat . (U.intersperse t)
638582{-# INLINE intercalate #-}
639583
640584-- | /O(n)/ The 'intersperse' function takes a character and places it
@@ -649,59 +593,16 @@ reverse :: Text -> Text
649593reverse t = S.reverse (stream t)
650594{-# INLINE reverse #-}
651595
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"
596+-- | /O(m+n)/ Replace every occurrence of one substring with another.
672597--
673598-- In (unlikely) bad cases, this function's time complexity degrades
674599-- 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.
600+replace :: Text -- ^ Text to search for
601+ -> Text -- ^ Replacement text
602+ -> Text -- ^ Input text
682603 -> 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
604+replace s d = intercalate d . splitOn s
605+{-# INLINE replace #-}
705606
706607-- ----------------------------------------------------------------------------
707608-- ** Case conversions (folds)
@@ -720,13 +621,13 @@ replace needle@(Text _ _ neeLen)
720621-- /Note/: In some languages, case conversion is a locale- and
721622-- context-dependent operation. The case conversion functions in this
722623-- 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 >.
624+-- sensitivity should use appropriate versions of the case mapping
625+-- functions from the @text-icu@ package:
626+-- <http://hackage.haskell.org/package/text-icu>
725627
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.
628+-- | /O(n)/ Convert a string to folded case. This function is mainly
629+-- useful for performing caseless (also known as case insensitive)
630+-- string comparisons.
730631--
731632-- A string @x@ is a caseless match for a string @y@ if and only if:
732633--
@@ -741,51 +642,25 @@ replace needle@(Text _ _ neeLen)
741642-- instead of itself.
742643toCaseFold :: Text -> Text
743644toCaseFold t = unstream (S.toCaseFold (stream t))
744−{-# INLINE toCaseFold #-}
645+{-# INLINE [0] toCaseFold #-}
745646
746647-- | /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).
648+-- conversion. The result string may be longer than the input string.
649+-- For instance, \"İ\" (Latin capital letter I with dot above,
650+-- U+0130) maps to the sequence \"i\" (Latin small letter i, U+0069) followed
651+-- by \" ̇\" (combining dot above, U+0307).
753652toLower :: Text -> Text
754653toLower t = unstream (S.toLower (stream t))
755654{-# INLINE toLower #-}
756655
757656-- | /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
657+-- conversion. The result string may be longer than the input string.
658+-- For instance, the German \"ß\" (eszett, U+00DF) maps to the
762659-- two-letter sequence \"SS\".
763660toUpper :: Text -> Text
764661toUpper t = unstream (S.toUpper (stream t))
765662{-# INLINE toUpper #-}
766663
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−
789664-- | /O(n)/ Left-justify a string to the given length, using the
790665-- specified fill character on the right. Subject to fusion.
791666-- Performs replacement on invalid scalar values.
@@ -836,7 +711,7 @@ center k c t
836711 | otherwise = replicateChar l c `append` t `append` replicateChar r c
837712 where len = length t
838713 d = k - len
839− r = d `quot` 2
714+ r = d `div` 2
840715 l = d - r
841716{-# INLINE center #-}
842717
@@ -901,7 +776,6 @@ concat ts = case ts' of
901776 where
902777 ts' = L.filter (not . null) ts
903778 len = sumP "concat" $ L.map lengthWord16 ts'
904− go :: ST s (A.MArray s)
905779 go = do
906780 arr <- A.new len
907781 let step i (Text a o l) =
@@ -915,13 +789,13 @@ concatMap f = concat . foldr ((:) . f) []
915789{-# INLINE concatMap #-}
916790
917791-- | /O(n)/ 'any' @p@ @t@ determines whether any character in the
918−-- 'Text' @t@ satisfies the predicate @p@. Subject to fusion.
792+-- 'Text' @t@ satisifes the predicate @p@. Subject to fusion.
919793any :: (Char -> Bool) -> Text -> Bool
920794any p t = S.any p (stream t)
921795{-# INLINE any #-}
922796
923797-- | /O(n)/ 'all' @p@ @t@ determines whether all characters in the
924−-- 'Text' @t@ satisfy the predicate @p@. Subject to fusion.
798+-- 'Text' @t@ satisify the predicate @p@. Subject to fusion.
925799all :: (Char -> Bool) -> Text -> Bool
926800all p t = S.all p (stream t)
927801{-# INLINE all #-}
@@ -1009,13 +883,13 @@ mapAccumR f z0 = second reverse . S.mapAccumL g z0 . reverseStream
1009883-- @t@ repeated @n@ times.
1010884replicate :: Int -> Text -> Text
1011885replicate n t@(Text a o l)
1012− | n <= 0 || l <= 0 = empty
1013− | n == 1 = t
1014− | isSingleton t = replicateChar n (unsafeHead t)
1015− | otherwise = Text (A.run x) 0 len
886+ | n <= 0 || l <= 0 = empty
887+ | n == 1 = t
888+ | isSingleton t = replicateChar n (unsafeHead t)
889+ | n <= maxBound `div` l = Text (A.run x) 0 len
890+ | otherwise = overflowError "replicate"
1016891 where
1017− len = l `mul` n
1018− x :: ST s (A.MArray s)
892+ len = l * n
1019893 x = do
1020894 arr <- A.new len
1021895 let loop !d !i | i >= n = return arr
@@ -1066,16 +940,14 @@ take :: Int -> Text -> Text
1066940take n t@(Text arr off len)
1067941 | n <= 0 = empty
1068942 | n >= len = t
1069− | otherwise = text arr off (iterN n t)
943+ | otherwise = Text arr off (loop 0 0)
944+ where
945+ loop !i !cnt
946+ | i >= len || cnt >= n = i
947+ | otherwise = loop (i+d) (cnt+1)
948+ where d = iter_ t i
1070949{-# INLINE [1] take #-}
1071950
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−
1079951{-# RULES
1080952"TEXT take -> fused" [~1] forall n t.
1081953 take n t = unstream (S.take n (stream t))
@@ -1083,27 +955,6 @@ iterN n t@(Text _arr _off len) = loop 0 0
1083955 unstream (S.take n (stream t)) = take n t
1084956 #-}
1085957
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−
1107958-- | /O(n)/ 'drop' @n@, applied to a 'Text', returns the suffix of the
1108959-- 'Text' after the first @n@ characters, or the empty 'Text' if @n@
1109960-- is greater than the length of the 'Text'. Subject to fusion.
@@ -1111,8 +962,11 @@ drop :: Int -> Text -> Text
1111962drop n t@(Text arr off len)
1112963 | n <= 0 = t
1113964 | n >= len = empty
1114− | otherwise = text arr (off+i) (len-i)
1115− where i = iterN n t
965+ | otherwise = loop 0 0
966+ where loop !i !cnt
967+ | i >= len || cnt >= n = Text arr (off+i) (len-i)
968+ | otherwise = loop (i+d) (cnt+1)
969+ where d = iter_ t i
1116970{-# INLINE [1] drop #-}
1117971
1118972{-# RULES
@@ -1122,18 +976,6 @@ drop n t@(Text arr off len)
1122976 unstream (S.drop n (stream t)) = drop n t
1123977 #-}
1124978
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−
1137979-- | /O(n)/ 'takeWhile', applied to a predicate @p@ and a 'Text',
1138980-- returns the longest prefix (possibly empty) of elements that
1139981-- satisfy @p@. Subject to fusion.
@@ -1141,7 +983,7 @@ takeWhile :: (Char -> Bool) -> Text -> Text
1141983takeWhile p t@(Text arr off len) = loop 0
1142984 where loop !i | i >= len = t
1143985 | p c = loop (i+d)
1144− | otherwise = text arr off i
986+ | otherwise = textP arr off i
1145987 where Iter c d = iter t i
1146988{-# INLINE [1] takeWhile #-}
1147989
@@ -1152,27 +994,6 @@ takeWhile p t@(Text arr off len) = loop 0
1152994 unstream (S.takeWhile p (stream t)) = takeWhile p t
1153995 #-}
1154996
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−
1176997-- | /O(n)/ 'dropWhile' @p@ @t@ returns the suffix remaining after
1177998-- 'takeWhile' @p@ @t@. Subject to fusion.
1178999dropWhile :: (Char -> Bool) -> Text -> Text
@@ -1191,9 +1012,8 @@ dropWhile p t@(Text arr off len) = loop 0 0
11911012 #-}
11921013
11931014-- | /O(n)/ 'dropWhileEnd' @p@ @t@ returns the prefix remaining after
1194−-- dropping characters that satisfy the predicate @p@ from the end of
1015+-- dropping characters that fail the predicate @p@ from the end of
11951016-- @t@. Subject to fusion.
1196−--
11971017-- Examples:
11981018--
11991019-- > dropWhileEnd (=='.') "foo..." == "foo"
@@ -1213,7 +1033,7 @@ dropWhileEnd p t@(Text arr off len) = loop (len-1) len
12131033 #-}
12141034
12151035-- | /O(n)/ 'dropAround' @p@ @t@ returns the substring remaining after
1216−-- dropping characters that satisfy the predicate @p@ from both the
1036+-- dropping characters that fail the predicate @p@ from both the
12171037-- beginning and end of @t@. Subject to fusion.
12181038dropAround :: (Char -> Bool) -> Text -> Text
12191039dropAround p = dropWhile p . dropWhileEnd p
@@ -1248,16 +1068,24 @@ splitAt :: Int -> Text -> (Text, Text)
12481068splitAt n t@(Text arr off len)
12491069 | n <= 0 = (empty, t)
12501070 | n >= len = (t, empty)
1251− | otherwise = let k = iterN n t
1252− in (text arr off k, text arr (off+k) (len-k))
1071+ | otherwise = (Text arr off k, Text arr (off+k) (len-k))
1072+ where k = loop 0 0
1073+ loop !i !cnt
1074+ | i >= len || cnt >= n = i
1075+ | otherwise = loop (i+d) (cnt+1)
1076+ where d = iter_ t i
1077+{-# INLINE splitAt #-}
12531078
12541079-- | /O(n)/ 'span', applied to a predicate @p@ and text @t@, returns
12551080-- a pair whose first element is the longest prefix (possibly empty)
12561081-- of @t@ of elements that satisfy @p@, and whose second is the
12571082-- remainder of the list.
12581083span :: (Char -> Bool) -> Text -> (Text, Text)
1259−span p t = case span_ p t of
1260− (# hd,tl #) -> (hd,tl)
1084+span p t@(Text arr off len) = (textP arr off k, textP arr (off+k) (len-k))
1085+ where k = loop 0
1086+ loop !i | i >= len || not (p c) = i
1087+ | otherwise = loop (i+d)
1088+ where Iter c d = iter t i
12611089{-# INLINE span #-}
12621090
12631091-- | /O(n)/ 'break' is like 'span', but the prefix returned is
@@ -1284,7 +1112,7 @@ findAIndexOrEnd q t@(Text _arr _off len) = go 0
12841112 where go !i | i >= len || q c = i
12851113 | otherwise = go (i+d)
12861114 where Iter c d = iter t i
1287−
1115+
12881116-- | /O(n)/ Group characters in a string by equality.
12891117group :: Text -> [Text]
12901118group = groupBy (==)
@@ -1308,38 +1136,31 @@ tails t | null t = [empty]
13081136-- copies to create substrings; they just construct new 'Text's that
13091137-- are slices of the original.
13101138
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.
1139+-- | /O(m+n)/ Break a 'Text' into pieces separated by the first
1140+-- 'Text' argument, consuming the delimiter. An empty delimiter is
1141+-- invalid, and will cause an error to be raised.
13141142--
13151143-- Examples:
13161144--
13171145-- > splitOn "\r\n" "a\r\nb\r\nd\r\ne" == ["a","b","d","e"]
13181146-- > splitOn "aaa" "aaaXaaaXaaaXaaa" == ["","X","X","X",""]
13191147-- > splitOn "x" "x" == ["",""]
1320−--
1148+--
13211149-- and
13221150--
13231151-- > intercalate s . splitOn s == id
13241152-- > splitOn (singleton c) == split (==c)
13251153--
1326−-- (Note: the string @s@ to split on above cannot be empty.)
1327−--
13281154-- In (unlikely) bad cases, this function's time complexity degrades
13291155-- 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]
1156+splitOn :: Text -> Text -> [Text]
13361157splitOn pat@(Text _ _ l) src@(Text arr off len)
13371158 | l <= 0 = emptyError "splitOn"
13381159 | isSingleton pat = split (== unsafeHead pat) src
13391160 | otherwise = go 0 (indices pat src)
13401161 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)]
1162+ go !s (x:xs) = textP arr (s+off) (x-s) : go (x+l) xs
1163+ go s _ = [textP arr (s+off) (len-s)]
13431164{-# INLINE [1] splitOn #-}
13441165
13451166{-# RULES
@@ -1359,7 +1180,7 @@ split _ t@(Text _off _arr 0) = [t]
13591180split p t = loop t
13601181 where loop s | null s' = [l]
13611182 | otherwise = l : loop (unsafeTail s')
1362− where (# l, s' #) = span_ (not . p) s
1183+ where (l, s') = break p s
13631184{-# INLINE split #-}
13641185
13651186-- | /O(n)/ Splits a 'Text' into components of length @k@. The last
@@ -1431,7 +1252,7 @@ breakOn pat src@(Text arr off len)
14311252 | null pat = emptyError "breakOn"
14321253 | otherwise = case indices pat src of
14331254 [] -> (src, empty)
1434− (x:_) -> (text arr off x, text arr (off+x) (len-x))
1255+ (x:_) -> (textP arr off x, textP arr (off+x) (len-x))
14351256{-# INLINE breakOn #-}
14361257
14371258-- | /O(n+m)/ Similar to 'breakOn', but searches from the end of the
@@ -1456,9 +1277,9 @@ breakOnEnd pat src = (reverse b, reverse a)
14561277--
14571278-- Examples:
14581279--
1459−-- > breakOnAll "::" ""
1280+-- > find "::" ""
14601281-- > ==> []
1461−-- > breakOnAll "/" "a/b/c/"
1282+-- > find "/" "a/b/c/"
14621283-- > ==> [("a", "/b/c/"), ("a/b", "/c/"), ("a/b/c", "/")]
14631284--
14641285-- In (unlikely) bad cases, this function's time complexity degrades
@@ -1473,7 +1294,7 @@ breakOnAll pat src@(Text arr off slen)
14731294 | otherwise = L.map step (indices pat src)
14741295 where
14751296 step x = (chunk 0 x, chunk x (slen-x))
1476− chunk !n !l = text arr (n+off) l
1297+ chunk !n !l = textP arr (n+off) l
14771298{-# INLINE breakOnAll #-}
14781299
14791300-------------------------------------------------------------------------------
@@ -1493,7 +1314,7 @@ breakOnAll pat src@(Text arr off slen)
14931314-- For example, suppose you have a string that you want to split on
14941315-- the substring @\"::\"@, such as @\"foo::bar::quux\"@. Instead of
14951316-- searching for the index of @\"::\"@ and taking the substrings
1496−-- before and after that index, you would instead use @breakOnAll \"::\"@.
1317+-- before and after that index, you would instead use @find \"::\"@.
14971318
14981319-- | /O(n)/ 'Text' index (subscript) operator, starting from 0.
14991320index :: Text -> Int -> Char
@@ -1540,7 +1361,7 @@ countChar c t = S.countChar c (stream t)
15401361-- equivalent to a pair of 'unpack' operations.
15411362zip :: Text -> Text -> [(Char,Char)]
15421363zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1543−{-# INLINE zip #-}
1364+{-# INLINE [0] zip #-}
15441365
15451366-- | /O(n)/ 'zipWith' generalises 'zip' by zipping with the function
15461367-- given as the first argument, instead of a tupling function.
@@ -1548,7 +1369,7 @@ zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
15481369zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
15491370zipWith f t1 t2 = unstream (S.zipWith g (stream t1) (stream t2))
15501371 where g a b = safe (f a b)
1551−{-# INLINE zipWith #-}
1372+{-# INLINE [0] zipWith #-}
15521373
15531374-- | /O(n)/ Breaks a 'Text' up into a list of words, delimited by 'Char's
15541375-- representing white space.
@@ -1574,7 +1395,7 @@ lines ps | null ps = []
15741395 | otherwise = h : if null t
15751396 then []
15761397 else lines (unsafeTail t)
1577− where (# h,t #) = span_ (/= '\n') ps
1398+ where (h,t) = span (/= '\n') ps
15781399{-# INLINE lines #-}
15791400
15801401{-
@@ -1620,6 +1441,8 @@ isPrefixOf a@(Text _ _ alen) b@(Text _ _ blen) =
16201441{-# RULES
16211442"TEXT isPrefixOf -> fused" [~1] forall s t.
16221443 isPrefixOf s t = S.isPrefixOf (stream s) (stream t)
1444+"TEXT isPrefixOf -> unfused" [1] forall s t.
1445+ S.isPrefixOf (stream s) (stream t) = isPrefixOf s t
16231446 #-}
16241447
16251448-- | /O(n)/ The 'isSuffixOf' function takes two 'Text's and returns
@@ -1673,7 +1496,7 @@ isInfixOf needle haystack
16731496-- > fnordLength _ = -1
16741497stripPrefix :: Text -> Text -> Maybe Text
16751498stripPrefix p@(Text _arr _off plen) t@(Text arr off len)
1676− | p `isPrefixOf` t = Just $! text arr (off+plen) (len-plen)
1499+ | p `isPrefixOf` t = Just $! textP arr (off+plen) (len-plen)
16771500 | otherwise = Nothing
16781501
16791502-- | /O(n)/ Find the longest non-empty common prefix of two strings
@@ -1693,8 +1516,8 @@ commonPrefixes t0@(Text arr0 off0 len0) t1@(Text arr1 off1 len1) = go 0 0
16931516 where
16941517 go !i !j | i < len0 && j < len1 && a == b = go (i+d0) (j+d1)
16951518 | i > 0 = Just (Text arr0 off0 i,
1696− text arr0 (off0+i) (len0-i),
1697− text arr1 (off1+j) (len1-j))
1519+ textP arr0 (off0+i) (len0-i),
1520+ textP arr1 (off1+j) (len1-j))
16981521 | otherwise = Nothing
16991522 where Iter a d0 = iter t0 i
17001523 Iter b d1 = iter t1 j
@@ -1719,7 +1542,7 @@ commonPrefixes t0@(Text arr0 off0 len0) t1@(Text arr1 off1 len1) = go 0 0
17191542-- > quuxLength _ = -1
17201543stripSuffix :: Text -> Text -> Maybe Text
17211544stripSuffix p@(Text _arr _off plen) t@(Text arr off len)
1722− | p `isSuffixOf` t = Just $! text arr off (len-plen)
1545+ | p `isSuffixOf` t = Just $! textP arr off (len-plen)
17231546 | otherwise = Nothing
17241547
17251548-- | Add a list of non-negative numbers. Errors out on overflow.
@@ -1736,20 +1559,3 @@ emptyError fun = P.error $ "Data.Text." ++ fun ++ ": empty input"
17361559
17371560overflowError :: String -> a
17381561overflowError fun = P.error $ "Data.Text." ++ fun ++ ": size overflow"
1739−
1740−-- | /O(n)/ Make a distinct copy of the given string, sharing no
1741−-- storage with the original string.
1742−--
1743−-- As an example, suppose you read a large string, of which you need
1744−-- only a small portion. If you do not use 'copy', the entire original
1745−-- array will be kept alive in memory by the smaller string. Making a
1746−-- copy \"breaks the link\" to the original array, allowing it to be
1747−-- garbage collected if there are no other live references to it.
1748−copy :: Text -> Text
1749−copy (Text arr off len) = Text (A.run go) 0 len
1750− where
1751− go :: ST s (A.MArray s)
1752− go = do
1753− marr <- A.new len
1754− A.copyI marr 0 arr off len
1755− return marr