@@ -1,48 +1,29 @@
1−{-# LANGUAGE BangPatterns, CPP, MagicHash, Rank2Types, UnboxedTuples #-}
1+{-# LANGUAGE BangPatterns, CPP, Rank2Types #-}
2{-# OPTIONS_GHC -fno-warn-orphans #-}
2{-# OPTIONS_GHC -fno-warn-orphans #-}
3−#if __GLASGOW_HASKELL__ >= 702
4−{-# LANGUAGE Trustworthy #-}
6−#if __GLASGOW_HASKELL__ >= 708
7−{-# LANGUAGE TypeFamilies #-}
11-- Module : Data.Text
5-- Module : Data.Text
6+-- Copyright : (c) Tom Harper 2008-2009,
12−-- Copyright : (c) 2009, 2010, 2011, 2012 Bryan O'Sullivan,
7+-- (c) Bryan O'Sullivan 2009,
13−-- (c) 2009 Duncan Coutts,
8+-- (c) Duncan Coutts 2009
14−-- (c) 2008, 2009 Tom Harper
16-- License : BSD-style
10-- License : BSD-style
17−-- Maintainer : bos@serpentine.com
11+-- Maintainer : bos@serpentine.com, rtomharper@googlemail.com,
18-- Stability : experimental
13-- Stability : experimental
19-- Portability : GHC
14-- Portability : GHC
21−-- A time and space-efficient implementation of Unicode text.
16+-- A time and space-efficient implementation of Unicode text using
22−-- Suitable for performance critical use, both in terms of large data
17+-- packed Word16 arrays. Suitable for performance critical use, both
23−-- quantities and high speed.
18+-- in terms of large data quantities and high speed.
25−-- /Note/: Read below the synopsis for important notes on the use of
28-- This module is intended to be imported @qualified@, to avoid name
20-- This module is intended to be imported @qualified@, to avoid name
29-- clashes with "Prelude" functions, e.g.
21-- clashes with "Prelude" functions, e.g.
31-- > import qualified Data.Text as T
23-- > import qualified Data.Text as T
33−-- To use an extended and very rich family of functions for working
34−-- 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 >.
38module Data.Text
25module Data.Text
40− -- * Strict vs lazy types
46 -- * Fusion
27 -- * Fusion
47 -- $fusion
28 -- $fusion
@@ -66,7 +47,6 @@ module Data.Text
71 -- * Transformations
51 -- * Transformations
@@ -81,7 +61,6 @@ module Data.Text
81 , toCaseFold
61 , toCaseFold
86 -- ** Justification
65 -- ** Justification
87 , justifyLeft
66 , justifyLeft
@@ -125,11 +104,8 @@ module Data.Text
126 -- ** Breaking strings
105 -- ** Breaking strings
131 , takeWhile
108 , takeWhile
133 , dropWhile
109 , dropWhile
134 , dropWhileEnd
110 , dropWhileEnd
135 , dropAround
111 , dropAround
@@ -137,10 +113,10 @@ module Data.Text
137 , stripStart
113 , stripStart
138 , stripEnd
114 , stripEnd
139 , splitAt
115 , splitAt
140− , breakOn
116+ , spanBy
143− , span
118+ , breakEnd
145 , groupBy
121 , groupBy
@@ -148,8 +124,8 @@ module Data.Text
149 -- ** Breaking into many substrings
125 -- ** Breaking into many substrings
150 -- $split
126 -- $split
153 , chunksOf
129 , chunksOf
155 -- ** Breaking into lines and words
131 -- ** Breaking into lines and words
@@ -165,308 +141,166 @@ module Data.Text
165 , isInfixOf
141 , isInfixOf
167 -- ** View patterns
143 -- ** View patterns
168− , stripPrefix
144+ , prefixed
169− , stripSuffix
145+ , suffixed
172 -- * Searching
147 -- * Searching
176− , partition
150+ , findBy
178 -- , findSubstring
153 -- , findSubstring
180 -- * Indexing
155 -- * Indexing
181 -- $index
156 -- $index
183 , findIndex
158 , findIndex
186− -- * Zipping
161+ -- * Zipping and unzipping
188 , zipWith
163 , zipWith
190 -- -* Ordered text
165 -- -* Ordered text
191 -- , sort
166 -- , sort
193− -- * Low level operations
198−import Prelude (Char, Bool(..), Int, Maybe(..), String,
169+import Prelude (Char, Bool(..), Functor(..), Int, Maybe(..), String,
199− Eq(..), Ord(..), Ordering(..), (++),
170+ Eq(..), Ord(..), (++),
200− Read(..),
171+ Read(..), Show(..),
201− (&&), (||), (+), (-), (.), ($), ($!), (>>),
172+ (&&), (||), (+), (-), (.), ($), ($!), (>>), (*),
202− not, return, otherwise, quot)
173+ div, error, not, return, otherwise)
203#if defined(HAVE_DEEPSEQ)
174#if defined(HAVE_DEEPSEQ)
204−import Control.DeepSeq (NFData(rnf))
175+import Control.DeepSeq (NFData)
206#if defined(ASSERTS)
177#if defined(ASSERTS)
207import Control.Exception (assert)
178import Control.Exception (assert)
209import Data.Char (isSpace)
180import Data.Char (isSpace)
210−import Data.Data (Data(gfoldl, toConstr, gunfold, dataTypeOf), constrIndex,
181+import Data.Data (Data(gfoldl, toConstr, gunfold, dataTypeOf))
211− Constr, mkConstr, DataType, mkDataType, Fixity(Prefix))
182+#if __GLASGOW_HASKELL__ >= 612
183+import Data.Data (mkNoRepType)
185+import Data.Data (mkNorepType)
212import Control.Monad (foldM)
187import Control.Monad (foldM)
213import Control.Monad.ST (ST)
188import Control.Monad.ST (ST)
214import qualified Data.Text.Array as A
189import qualified Data.Text.Array as A
215import qualified Data.List as L
190import qualified Data.List as L
216−import Data.Binary (Binary(get, put))
217import Data.Monoid (Monoid(..))
191import Data.Monoid (Monoid(..))
218−#if MIN_VERSION_base(4,9,0)
219−import Data.Semigroup (Semigroup(..))
221import Data.String (IsString(..))
192import Data.String (IsString(..))
222−import qualified Data.Text.Internal.Fusion as S
193+import qualified Data.Text.Fusion as S
223−import qualified Data.Text.Internal.Fusion.Common as S
194+import qualified Data.Text.Fusion.Common as S
224−import Data.Text.Encoding (decodeUtf8', encodeUtf8)
225−import Data.Text.Internal.Fusion (stream, reverseStream, unstream)
195+import Data.Text.Fusion (stream, reverseStream, unstream)
226−import Data.Text.Internal.Private (span_)
196+import Data.Text.Internal (Text(..), empty, text, textP)
227−import Data.Text.Internal (Text(..), empty, firstf, mul, safe, text)
228−import Data.Text.Show (singleton, unpack, unpackCString#)
229import qualified Prelude as P
197import qualified Prelude as P
230−import Data.Text.Unsafe (Iter(..), iter, iter_, lengthWord16, reverseIter,
198+import Data.Text.Unsafe (iter, iter_, reverseIter, unsafeHead, unsafeTail)
231− reverseIter_, unsafeHead, unsafeTail)
232−import Data.Text.Internal.Unsafe.Char (unsafeChr)
199+import Data.Text.UnsafeChar (unsafeChr)
233−import qualified Data.Text.Internal.Functions as F
200+import qualified Data.Text.Encoding.Utf16 as U16
234−import qualified Data.Text.Internal.Encoding.Utf16 as U16
235−import Data.Text.Internal.Search (indices)
201+import Data.Text.Search (indices)
236−#if defined(__HADDOCK__)
237−import Data.ByteString (ByteString)
238−import qualified Data.Text.Lazy as L
239−import Data.Int (Int64)
241−import GHC.Base (eqInt, neInt, gtInt, geInt, ltInt, leInt)
242−#if __GLASGOW_HASKELL__ >= 708
243−import qualified GHC.Exts as Exts
245−#if MIN_VERSION_base(4,7,0)
246−import Text.Printf (PrintfArg, formatArg, formatString)
251−-- 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
254−-- lazy @Text@ type consists of a list of strict chunks.
256−-- 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.
265−-- Each module provides an almost identical API, with the main
266−-- difference being that the strict module uses 'Int' values for
267−-- lengths and counts, while the lazy module uses 'Data.Int.Int64'
272−-- A 'Text' value is a sequence of Unicode scalar values, as defined
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
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
284−-- Within this module, many functions construct a 'Text' from one or
285−-- more 'Char' values. Those functions will substitute 'Char' values
286−-- that are not valid Unicode scalar values with the replacement
287−-- character \"�\" (U+FFFD). Functions that perform this
288−-- inspection and replacement are documented with the phrase
289−-- \"Performs replacement on invalid scalar values\".
291−-- (One reason for this policy of replacement is that internally, a
292−-- 'Text' value is represented as packed UTF-16 data. Values in the
293−-- range U+D800 through U+DFFF are used by UTF-16 to denote surrogate
294−-- code points, and so cannot be represented. The functions replace
295−-- 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 >.)
299-- $fusion
203-- $fusion
301-- Most of the functions in this module are subject to /fusion/,
205-- Most of the functions in this module are subject to /fusion/,
302-- meaning that a pipeline of such functions will usually allocate at
206-- meaning that a pipeline of such functions will usually allocate at
303-- most one 'Text' value.
207-- most one 'Text' value.
305−-- As an example, consider the following pipeline:
307−-- > import Data.Text as T
308−-- > import Data.Text.Encoding as E
309−-- > import Data.ByteString (ByteString)
311−-- > countChars :: ByteString -> Int
312−-- > countChars = T.length . T.toUpper . E.decodeUtf8
314−-- 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'.
321−-- Functions that can be fused by the compiler are documented with the
322−-- phrase \"Subject to fusion\".
324instance Eq Text where
209instance Eq Text where
325− Text arrA offA lenA == Text arrB offB lenB
210+ t1 == t2 = stream t1 == stream t2
326− | lenA == lenB = A.equal arrA offA arrB offB lenA
328 {-# INLINE (==) #-}
211 {-# INLINE (==) #-}
330instance Ord Text where
213instance Ord Text where
331− compare = compareText
214+ compare t1 t2 = compare (stream t1) (stream t2)
215+ {-# INLINE compare #-}
217+instance Show Text where
218+ showsPrec p ps r = showsPrec p (unpack ps) r
333instance Read Text where
220instance Read Text where
334 readsPrec p str = [(pack x,y) | (x,y) <- readsPrec p str]
221 readsPrec p str = [(pack x,y) | (x,y) <- readsPrec p str]
336−#if MIN_VERSION_base(4,9,0)
337−-- Semigroup orphan instances for older GHCs are provided by
338−-- 'semigroups` package
340−instance Semigroup Text where
344instance Monoid Text where
223instance Monoid Text where
345 mempty = empty
224 mempty = empty
346−#if MIN_VERSION_base(4,9,0)
347− mappend = (<>) -- future-proof definition
349 mappend = append
225 mappend = append
351 mconcat = concat
226 mconcat = concat
353instance IsString Text where
228instance IsString Text where
354 fromString = pack
229 fromString = pack
356−#if __GLASGOW_HASKELL__ >= 708
357−instance Exts.IsList Text where
358− type Item Text = Char
363#if defined(HAVE_DEEPSEQ)
231#if defined(HAVE_DEEPSEQ)
364−instance NFData Text where rnf !_ = ()
232+instance NFData Text
367−instance Binary Text where
368− put t = put (encodeUtf8 t)
371− case decodeUtf8' bs of
372− P.Left exn -> P.fail (P.show exn)
373− P.Right a -> P.return a
375−-- | This instance preserves data abstraction at the cost of inefficiency.
235+-- This instance preserves data abstraction at the cost of inefficiency.
376-- We omit reflection services for the sake of data abstraction.
236-- We omit reflection services for the sake of data abstraction.
238+-- This instance was created by copying the behavior of Data.Set and
239+-- Data.Map. If you feel a mistake has been made, please feel free to
240+-- submit improvements.
378−-- This instance was created by copying the updated behavior of
242+-- Original discussion is archived here:
379−-- @"Data.Set".@'Data.Set.Set' and @"Data.Map".@'Data.Map.Map'. If you
243+
380−-- feel a mistake has been made, please feel free to submit
244+-- "could we get a Data instance for Data.Text.Text?"
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? >
245+-- http://groups.google.com/group/haskell-cafe/browse_thread/thread/b5bbb1b28a7e525d/0639d46852575b93
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, ... >
390instance Data Text where
247instance Data Text where
391 gfoldl f z txt = z pack `f` (unpack txt)
248 gfoldl f z txt = z pack `f` (unpack txt)
392− toConstr _ = packConstr
249+ toConstr _ = error "Data.Text.Text.toConstr"
393− gunfold k z c = case constrIndex c of
395− _ -> P.error "gunfold"
250+ gunfold _ _ = error "Data.Text.Text.gunfold"
396− dataTypeOf _ = textDataType
251+#if __GLASGOW_HASKELL__ >= 612
397−
252+ dataTypeOf _ = mkNoRepType "Data.Text.Text"
398−#if MIN_VERSION_base(4,7,0)
253+#else
399−-- | Only defined for @base-4.7.0.0@ and later
254+ dataTypeOf _ = mkNorepType "Data.Text.Text"
400−instance PrintfArg Text where
401− formatArg txt = formatString $ unpack txt
405−packConstr = mkConstr textDataType "pack" [] Prefix
407−textDataType :: DataType
408−textDataType = mkDataType "Data.Text.Text" [packConstr]
410−-- | /O(n)/ Compare two 'Text' values lexicographically.
411−compareText :: Text -> Text -> Ordering
412−compareText ta@(Text _arrA _offA lenA) tb@(Text _arrB _offB lenB)
413− | lenA == 0 && lenB == 0 = EQ
414− | otherwise = go 0 0
417− | i >= lenA || j >= lenB = compare lenA lenB
420− | otherwise = go (i+di) (j+dj)
421− where Iter a di = iter ta i
422− Iter b dj = iter tb j
424-- -----------------------------------------------------------------------------
257-- -----------------------------------------------------------------------------
425-- * Conversion to/from 'Text'
258-- * Conversion to/from 'Text'
427−-- | /O(n)/ Convert a 'String' into a 'Text'. Subject to
260+-- | /O(n)/ Convert a 'String' into a 'Text'. Subject to fusion.
428−-- fusion. Performs replacement on invalid scalar values.
429pack :: String -> Text
261pack :: String -> Text
430−pack = unstream . S.map safe . S.streamList
262+pack = unstream . S.streamList
431{-# INLINE [1] pack #-}
263{-# INLINE [1] pack #-}
265+-- | /O(n)/ Convert a Text into a String. Subject to fusion.
266+unpack :: Text -> String
267+unpack = S.unstreamList . stream
268+{-# INLINE [1] unpack #-}
270+-- | /O(1)/ Convert a character into a Text.
271+-- Subject to fusion.
272+singleton :: Char -> Text
273+singleton = unstream . S.singleton
274+{-# INLINE [1] singleton #-}
433-- -----------------------------------------------------------------------------
276-- -----------------------------------------------------------------------------
434-- * Basic functions
277-- * Basic functions
436-- | /O(n)/ Adds a character to the front of a 'Text'. This function
279-- | /O(n)/ Adds a character to the front of a 'Text'. This function
437-- is more costly than its 'List' counterpart because it requires
280-- is more costly than its 'List' counterpart because it requires
438−-- copying a new array. Subject to fusion. Performs replacement on
281+-- copying a new array. Subject to fusion.
439−-- invalid scalar values.
440cons :: Char -> Text -> Text
282cons :: Char -> Text -> Text
441−cons c t = unstream (S.cons (safe c) (stream t))
283+cons c t = unstream (S.cons c (stream t))
442{-# INLINE cons #-}
284{-# INLINE cons #-}
446-- | /O(n)/ Adds a character to the end of a 'Text'. This copies the
286-- | /O(n)/ Adds a character to the end of a 'Text'. This copies the
447-- entire array in the process, unless fused. Subject to fusion.
287-- entire array in the process, unless fused. Subject to fusion.
448−-- Performs replacement on invalid scalar values.
449snoc :: Text -> Char -> Text
288snoc :: Text -> Char -> Text
450−snoc t c = unstream (S.snoc (stream t) (safe c))
289+snoc t c = unstream (S.snoc (stream t) c)
451{-# INLINE snoc #-}
290{-# INLINE snoc #-}
453-- | /O(n)/ Appends one 'Text' to the other by copying both of them
292-- | /O(n)/ Appends one 'Text' to the other by copying both of them
454-- into a new 'Text'. Subject to fusion.
293-- into a new 'Text'. Subject to fusion.
455append :: Text -> Text -> Text
294append :: Text -> Text -> Text
456−append a@(Text arr1 off1 len1) b@(Text arr2 off2 len2)
295+append (Text arr1 off1 len1) (Text arr2 off2 len2) = Text (A.run x) 0 len
459− | len > 0 = Text (A.run x) 0 len
460− | otherwise = overflowError "append"
462 len = len1+len2
297 len = len1+len2
463− x :: ST s (A.MArray s)
465− arr <- A.new len
299+ arr <- A.unsafeNew len
466− A.copyI arr 0 arr1 off1 len1
300+ copy arr 0 arr1 off1 len1
467− A.copyI arr len1 arr2 off2 len
301+ copy arr len1 arr2 off2 (len1+len2)
468 return arr
302 return arr
469−{-# NOINLINE append #-}
303+{-# INLINE append #-}
472"TEXT append -> fused" [~1] forall t1 t2.
306"TEXT append -> fused" [~1] forall t1 t2.
@@ -475,6 +309,14 @@ append a@(Text arr1 off1 len1) b@(Text arr2 off2 len2)
475 unstream (S.append (stream t1) (stream t2)) = append t1 t2
309 unstream (S.append (stream t1) (stream t2)) = append t1 t2
312+copy :: forall s. A.MArray s -> Int -> A.Array -> Int -> Int
314+copy dest i0 src j0 top = go i0 j0
316+ go i j | i >= top = return ()
317+ | otherwise = do A.unsafeWrite dest i (src `A.unsafeIndex` j)
478-- | /O(1)/ Returns the first character of a 'Text', which must be
320-- | /O(1)/ Returns the first character of a 'Text', which must be
479-- non-empty. Subject to fusion.
321-- non-empty. Subject to fusion.
480head :: Text -> Char
322head :: Text -> Char
@@ -486,14 +328,21 @@ head t = S.head (stream t)
486uncons :: Text -> Maybe (Char, Text)
328uncons :: Text -> Maybe (Char, Text)
487uncons t@(Text arr off len)
329uncons t@(Text arr off len)
488 | len <= 0 = Nothing
330 | len <= 0 = Nothing
489− | otherwise = Just $ let !(Iter c d) = iter t 0
490− in (c, text arr (off+d) (len-d))
331+ | otherwise = Just (c, textP arr (off+d) (len-d))
332+ where (c,d) = iter t 0
491{-# INLINE [1] uncons #-}
333{-# INLINE [1] uncons #-}
493-- | Lifted from Control.Arrow and specialized.
335-- | Lifted from Control.Arrow and specialized.
494second :: (b -> c) -> (a,b) -> (a,c)
336second :: (b -> c) -> (a,b) -> (a,c)
495second f (a, b) = (a, f b)
337second f (a, b) = (a, f b)
340+"TEXT uncons -> fused" [~1] forall t.
341+ uncons t = fmap (second unstream) (S.uncons (stream t))
342+"TEXT uncons -> unfused" [1] forall t.
343+ fmap (second unstream) (S.uncons (stream t)) = uncons t
497-- | /O(1)/ Returns the last character of a 'Text', which must be
346-- | /O(1)/ Returns the last character of a 'Text', which must be
498-- non-empty. Subject to fusion.
347-- non-empty. Subject to fusion.
499last :: Text -> Char
348last :: Text -> Char
@@ -517,7 +366,7 @@ last (Text arr off len)
517tail :: Text -> Text
366tail :: Text -> Text
518tail t@(Text arr off len)
367tail t@(Text arr off len)
519 | len <= 0 = emptyError "tail"
368 | len <= 0 = emptyError "tail"
520− | otherwise = text arr (off+d) (len-d)
369+ | otherwise = textP arr (off+d) (len-d)
521 where d = iter_ t 0
370 where d = iter_ t 0
522{-# INLINE [1] tail #-}
371{-# INLINE [1] tail #-}
@@ -532,8 +381,8 @@ tail t@(Text arr off len)
532-- be non-empty. Subject to fusion.
381-- be non-empty. Subject to fusion.
533init :: Text -> Text
382init :: Text -> Text
534init (Text arr off len) | len <= 0 = emptyError "init"
383init (Text arr off len) | len <= 0 = emptyError "init"
535− | n >= 0xDC00 && n <= 0xDFFF = text arr off (len-2)
384+ | n >= 0xDC00 && n <= 0xDFFF = textP arr off (len-2)
536− | otherwise = text arr off (len-1)
385+ | otherwise = textP arr off (len-1)
538 n = A.unsafeIndex arr (off+len-1)
387 n = A.unsafeIndex arr (off+len-1)
539{-# INLINE [1] init #-}
388{-# INLINE [1] init #-}
@@ -572,76 +421,27 @@ isSingleton = S.isSingleton . stream
572-- Subject to fusion.
421-- Subject to fusion.
573length :: Text -> Int
422length :: Text -> Int
574length t = S.length (stream t)
423length t = S.length (stream t)
575−{-# INLINE [0] length #-}
424+{-# INLINE length #-}
576−-- length needs to be phased after the compareN/length rules otherwise
577−-- it may inline before the rules have an opportunity to fire.
579−-- | /O(n)/ Compare the count of characters in a 'Text' to a number.
580−-- Subject to fusion.
582−-- This function gives the same answer as comparing against the result
583−-- of 'length', but can short circuit if the count of characters is
584−-- greater than the number, and hence be more efficient.
585−compareLength :: Text -> Int -> Ordering
586−compareLength t n = S.compareLengthI (stream t) n
587−{-# INLINE [1] compareLength #-}
590−"TEXT compareN/length -> compareLength" [~1] forall t n.
591− compare (length t) n = compareLength t n
595−"TEXT ==N/length -> compareLength/==EQ" [~1] forall t n.
596− eqInt (length t) n = compareLength t n == EQ
600−"TEXT /=N/length -> compareLength//=EQ" [~1] forall t n.
601− neInt (length t) n = compareLength t n /= EQ
605−"TEXT <N/length -> compareLength/==LT" [~1] forall t n.
606− ltInt (length t) n = compareLength t n == LT
610−"TEXT <=N/length -> compareLength//=GT" [~1] forall t n.
611− leInt (length t) n = compareLength t n /= GT
615−"TEXT >N/length -> compareLength/==GT" [~1] forall t n.
616− gtInt (length t) n = compareLength t n == GT
620−"TEXT >=N/length -> compareLength//=LT" [~1] forall t n.
621− geInt (length t) n = compareLength t n /= LT
624-- -----------------------------------------------------------------------------
426-- -----------------------------------------------------------------------------
625-- * Transformations
427-- * Transformations
626-- | /O(n)/ 'map' @f@ @t@ is the 'Text' obtained by applying @f@ to
428-- | /O(n)/ 'map' @f@ @t@ is the 'Text' obtained by applying @f@ to
627−-- each element of @t@. Subject to fusion. Performs replacement on
429+-- each element of @t@. Subject to fusion.
628−-- invalid scalar values.
629map :: (Char -> Char) -> Text -> Text
430map :: (Char -> Char) -> Text -> Text
630−map f t = unstream (S.map (safe . f) (stream t))
431+map f t = unstream (S.map f (stream t))
631{-# INLINE [1] map #-}
432{-# INLINE [1] map #-}
633-- | /O(n)/ The 'intercalate' function takes a 'Text' and a list of
434-- | /O(n)/ The 'intercalate' function takes a 'Text' and a list of
634-- 'Text's and concatenates the list after interspersing the first
435-- 'Text's and concatenates the list after interspersing the first
635-- argument between each element of the list.
436-- argument between each element of the list.
636intercalate :: Text -> [Text] -> Text
437intercalate :: Text -> [Text] -> Text
637−intercalate t = concat . (F.intersperse t)
438+intercalate t = concat . (L.intersperse t)
638{-# INLINE intercalate #-}
439{-# INLINE intercalate #-}
640-- | /O(n)/ The 'intersperse' function takes a character and places it
441-- | /O(n)/ The 'intersperse' function takes a character and places it
641−-- between the characters of a 'Text'. Subject to fusion. Performs
442+-- between the characters of a 'Text'. Subject to fusion.
642−-- replacement on invalid scalar values.
643intersperse :: Char -> Text -> Text
443intersperse :: Char -> Text -> Text
644−intersperse c t = unstream (S.intersperse (safe c) (stream t))
444+intersperse c t = unstream (S.intersperse c (stream t))
645{-# INLINE intersperse #-}
445{-# INLINE intersperse #-}
647-- | /O(n)/ Reverse the characters of a string. Subject to fusion.
447-- | /O(n)/ Reverse the characters of a string. Subject to fusion.
@@ -649,59 +449,13 @@ reverse :: Text -> Text
649reverse t = S.reverse (stream t)
449reverse t = S.reverse (stream t)
650{-# INLINE reverse #-}
450{-# INLINE reverse #-}
652−-- | /O(m+n)/ Replace every non-overlapping occurrence of @needle@ in
452+-- | /O(m+n)/ Replace every occurrence of one substring with another.
653−-- @haystack@ with @replacement@.
655−-- This function behaves as though it was defined as follows:
658−-- replace needle replacement haystack =
659−-- 'intercalate' replacement ('splitOn' needle haystack)
662−-- As this suggests, each occurrence is replaced exactly once. So if
663−-- @needle@ occurs in @replacement@, that occurrence will /not/ itself
664−-- be replaced recursively:
666−-- > replace "oo" "foo" "oo" == "foo"
668−-- In cases where several instances of @needle@ overlap, only the
669−-- first one will be replaced:
671−-- > replace "ofo" "bar" "ofofo" == "barfo"
673−-- In (unlikely) bad cases, this function's time complexity degrades
675−replace :: Text
453+replace :: Text -- ^ Text to search for
676− -- ^ @needle@ to search for. If this string is empty, an
454+ -> Text -- ^ Replacement text
677− -- error will occur.
679− -- ^ @replacement@ to replace @needle@ with.
680− -> Text
455+ -> Text -- ^ Input text
681− -- ^ @haystack@ in which to search.
683−replace needle@(Text _ _ neeLen)
457+replace s d = intercalate d . split s
684− (Text repArr repOff repLen)
458+{-# INLINE replace #-}
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
691− ixs = indices needle haystack
692− len = hayLen - (neeLen - repLen) `mul` L.length ixs
693− x :: ST s (A.MArray s)
696− let loop (i:is) o d = do
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
706-- ----------------------------------------------------------------------------
460-- ----------------------------------------------------------------------------
707-- ** Case conversions (folds)
461-- ** Case conversions (folds)
@@ -716,17 +470,10 @@ replace needle@(Text _ _ neeLen)
716-- case conversion rules. As a result, these functions may map one
470-- case conversion rules. As a result, these functions may map one
717-- input character to two or three output characters. For examples,
471-- input character to two or three output characters. For examples,
718-- see the documentation of each function.
472-- see the documentation of each function.
720−-- /Note/: In some languages, case conversion is a locale- and
721−-- context-dependent operation. The case conversion functions in this
722−-- 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 >.
726−-- | /O(n)/ Convert a string to folded case. Subject to fusion.
474+-- | /O(n)/ Convert a string to folded case. This function is mainly
728−-- This function is mainly useful for performing caseless (also known
475+-- useful for performing caseless (also known as case insensitive)
729−-- as case insensitive) string comparisons.
476+-- string comparisons.
731-- A string @x@ is a caseless match for a string @y@ if and only if:
478-- A string @x@ is a caseless match for a string @y@ if and only if:
@@ -741,56 +488,27 @@ replace needle@(Text _ _ neeLen)
741-- instead of itself.
488-- instead of itself.
742toCaseFold :: Text -> Text
489toCaseFold :: Text -> Text
743toCaseFold t = unstream (S.toCaseFold (stream t))
490toCaseFold t = unstream (S.toCaseFold (stream t))
744−{-# INLINE toCaseFold #-}
491+{-# INLINE [0] toCaseFold #-}
746-- | /O(n)/ Convert a string to lower case, using simple case
493-- | /O(n)/ Convert a string to lower case, using simple case
747−-- conversion. Subject to fusion.
749−-- The result string may be longer than the input string. For
494+-- conversion. The result string may be longer than the input string.
750−-- instance, \"İ\" (Latin capital letter I with dot above,
495+-- For instance, \"İ\" (Latin capital letter I with dot above,
751−-- U+0130) maps to the sequence \"i\" (Latin small letter i, U+0069)
496+-- U+0130) maps to the sequence \"i\" (Latin small letter i, U+0069) followed
752−-- followed by \" ̇\" (combining dot above, U+0307).
497+-- by \" ̇\" (combining dot above, U+0307).
753toLower :: Text -> Text
498toLower :: Text -> Text
754toLower t = unstream (S.toLower (stream t))
499toLower t = unstream (S.toLower (stream t))
755{-# INLINE toLower #-}
500{-# INLINE toLower #-}
757-- | /O(n)/ Convert a string to upper case, using simple case
502-- | /O(n)/ Convert a string to upper case, using simple case
758−-- conversion. Subject to fusion.
760−-- The result string may be longer than the input string. For
503+-- conversion. The result string may be longer than the input string.
761−-- instance, the German \"ß\" (eszett, U+00DF) maps to the
504+-- For instance, the German \"ß\" (eszett, U+00DF) maps to the
762-- two-letter sequence \"SS\".
505-- two-letter sequence \"SS\".
763toUpper :: Text -> Text
506toUpper :: Text -> Text
764toUpper t = unstream (S.toUpper (stream t))
507toUpper t = unstream (S.toUpper (stream t))
765{-# INLINE toUpper #-}
508{-# INLINE toUpper #-}
767−-- | /O(n)/ Convert a string to title case, using simple case
768−-- conversion. Subject to fusion.
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
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).
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 #-}
789-- | /O(n)/ Left-justify a string to the given length, using the
510-- | /O(n)/ Left-justify a string to the given length, using the
790−-- specified fill character on the right. Subject to fusion.
511+-- specified fill character on the right. Subject to fusion. Examples:
791−-- Performs replacement on invalid scalar values.
795-- > justifyLeft 7 'x' "foo" == "fooxxxx"
513-- > justifyLeft 7 'x' "foo" == "fooxxxx"
796-- > justifyLeft 3 'x' "foobar" == "foobar"
514-- > justifyLeft 3 'x' "foobar" == "foobar"
@@ -809,10 +527,7 @@ justifyLeft k c t
811-- | /O(n)/ Right-justify a string to the given length, using the
529-- | /O(n)/ Right-justify a string to the given length, using the
812−-- specified fill character on the left. Performs replacement on
530+-- specified fill character on the left. Examples:
813−-- invalid scalar values.
817-- > justifyRight 7 'x' "bar" == "xxxxbar"
532-- > justifyRight 7 'x' "bar" == "xxxxbar"
818-- > justifyRight 3 'x' "foobar" == "foobar"
533-- > justifyRight 3 'x' "foobar" == "foobar"
@@ -823,11 +538,8 @@ justifyRight k c t
823 where len = length t
538 where len = length t
824{-# INLINE justifyRight #-}
539{-# INLINE justifyRight #-}
826−-- | /O(n)/ Center a string to the given length, using the specified
541+-- | /O(n)/ Center a string to the given length, using the
827−-- fill character on either side. Performs replacement on invalid
542+-- specified fill character on either side. Examples:
832-- > center 8 'x' "HS" = "xxxHSxxx"
544-- > center 8 'x' "HS" = "xxxHSxxx"
833center :: Int -> Char -> Text -> Text
545center :: Int -> Char -> Text -> Text
@@ -836,7 +548,7 @@ center k c t
836 | otherwise = replicateChar l c `append` t `append` replicateChar r c
548 | otherwise = replicateChar l c `append` t `append` replicateChar r c
837 where len = length t
549 where len = length t
838 d = k - len
550 d = k - len
839− r = d `quot` 2
551+ r = d `div` 2
840 l = d - r
552 l = d - r
841{-# INLINE center #-}
553{-# INLINE center #-}
@@ -854,12 +566,12 @@ transpose ts = P.map pack (L.transpose (P.map unpack ts))
854-- (typically the left-identity of the operator), and a 'Text',
566-- (typically the left-identity of the operator), and a 'Text',
855-- reduces the 'Text' using the binary operator, from left to right.
567-- reduces the 'Text' using the binary operator, from left to right.
856-- Subject to fusion.
568-- Subject to fusion.
857−foldl :: (a -> Char -> a) -> a -> Text -> a
569+foldl :: (b -> Char -> b) -> b -> Text -> b
858foldl f z t = S.foldl f z (stream t)
570foldl f z t = S.foldl f z (stream t)
859{-# INLINE foldl #-}
571{-# INLINE foldl #-}
861-- | /O(n)/ A strict version of 'foldl'. Subject to fusion.
573-- | /O(n)/ A strict version of 'foldl'. Subject to fusion.
862−foldl' :: (a -> Char -> a) -> a -> Text -> a
574+foldl' :: (b -> Char -> b) -> b -> Text -> b
863foldl' f z t = S.foldl' f z (stream t)
575foldl' f z t = S.foldl' f z (stream t)
864{-# INLINE foldl' #-}
576{-# INLINE foldl' #-}
@@ -878,12 +590,12 @@ foldl1' f t = S.foldl1' f (stream t)
878-- (typically the right-identity of the operator), and a 'Text',
590-- (typically the right-identity of the operator), and a 'Text',
879-- reduces the 'Text' using the binary operator, from right to left.
591-- reduces the 'Text' using the binary operator, from right to left.
880-- Subject to fusion.
592-- Subject to fusion.
881−foldr :: (Char -> a -> a) -> a -> Text -> a
593+foldr :: (Char -> b -> b) -> b -> Text -> b
882foldr f z t = S.foldr f z (stream t)
594foldr f z t = S.foldr f z (stream t)
883{-# INLINE foldr #-}
595{-# INLINE foldr #-}
885-- | /O(n)/ A variant of 'foldr' that has no starting value argument,
597-- | /O(n)/ A variant of 'foldr' that has no starting value argument,
886−-- and thus must be applied to a non-empty 'Text'. Subject to
598+-- and thust must be applied to a non-empty 'Text'. Subject to
887-- fusion.
599-- fusion.
888foldr1 :: (Char -> Char -> Char) -> Text -> Char
600foldr1 :: (Char -> Char -> Char) -> Text -> Char
889foldr1 f t = S.foldr1 f (stream t)
601foldr1 f t = S.foldr1 f (stream t)
@@ -894,19 +606,14 @@ foldr1 f t = S.foldr1 f (stream t)
895-- | /O(n)/ Concatenate a list of 'Text's.
607-- | /O(n)/ Concatenate a list of 'Text's.
896concat :: [Text] -> Text
608concat :: [Text] -> Text
897−concat ts = case ts' of
900− _ -> Text (A.run go) 0 len
609+concat ts = Text (A.run go) 0 len
902− ts' = L.filter (not . null) ts
611+ len = L.sum (L.map (\(Text _ _ l) -> l) ts)
903− len = sumP "concat" $ L.map lengthWord16 ts'
904− go :: ST s (A.MArray s)
906− arr <- A.new len
613+ arr <- A.unsafeNew len
907− let step i (Text a o l) =
908− let !j = i + l in A.copyI arr i a o j >> return j
614+ let step i (Text a o l) = let j = i + l in copy arr i a o j >> return j
909− foldM step 0 ts' >> return arr
615+ foldM step 0 ts >> return arr
616+{-# INLINE concat #-}
911-- | /O(n)/ Map a function over a 'Text' that results in a 'Text', and
618-- | /O(n)/ Map a function over a 'Text' that results in a 'Text', and
912-- concatenate the results.
619-- concatenate the results.
@@ -915,13 +622,13 @@ concatMap f = concat . foldr ((:) . f) []
915{-# INLINE concatMap #-}
622{-# INLINE concatMap #-}
917-- | /O(n)/ 'any' @p@ @t@ determines whether any character in the
624-- | /O(n)/ 'any' @p@ @t@ determines whether any character in the
918−-- 'Text' @t@ satisfies the predicate @p@. Subject to fusion.
625+-- 'Text' @t@ satisifes the predicate @p@. Subject to fusion.
919any :: (Char -> Bool) -> Text -> Bool
626any :: (Char -> Bool) -> Text -> Bool
920any p t = S.any p (stream t)
627any p t = S.any p (stream t)
921{-# INLINE any #-}
628{-# INLINE any #-}
923-- | /O(n)/ 'all' @p@ @t@ determines whether all characters in the
630-- | /O(n)/ 'all' @p@ @t@ determines whether all characters in the
924−-- 'Text' @t@ satisfy the predicate @p@. Subject to fusion.
631+-- 'Text' @t@ satisify the predicate @p@. Subject to fusion.
925all :: (Char -> Bool) -> Text -> Bool
632all :: (Char -> Bool) -> Text -> Bool
926all p t = S.all p (stream t)
633all p t = S.all p (stream t)
927{-# INLINE all #-}
634{-# INLINE all #-}
@@ -943,7 +650,6 @@ minimum t = S.minimum (stream t)
944-- | /O(n)/ 'scanl' is similar to 'foldl', but returns a list of
651-- | /O(n)/ 'scanl' is similar to 'foldl', but returns a list of
945-- successive reduced values from the left. Subject to fusion.
652-- successive reduced values from the left. Subject to fusion.
946−-- Performs replacement on invalid scalar values.
948-- > scanl f z [x1, x2, ...] == [z, z `f` x1, (z `f` x1) `f` x2, ...]
654-- > scanl f z [x1, x2, ...] == [z, z `f` x1, (z `f` x1) `f` x2, ...]
@@ -951,13 +657,11 @@ minimum t = S.minimum (stream t)
952-- > last (scanl f z xs) == foldl f z xs.
658-- > last (scanl f z xs) == foldl f z xs.
953scanl :: (Char -> Char -> Char) -> Char -> Text -> Text
659scanl :: (Char -> Char -> Char) -> Char -> Text -> Text
954−scanl f z t = unstream (S.scanl g z (stream t))
660+scanl f z t = unstream (S.scanl f z (stream t))
955− where g a b = safe (f a b)
956{-# INLINE scanl #-}
661{-# INLINE scanl #-}
958-- | /O(n)/ 'scanl1' is a variant of 'scanl' that has no starting
663-- | /O(n)/ 'scanl1' is a variant of 'scanl' that has no starting
959−-- value argument. Subject to fusion. Performs replacement on
664+-- value argument. Subject to fusion.
960−-- invalid scalar values.
962-- > scanl1 f [x1, x2, ...] == [x1, x1 `f` x2, ...]
666-- > scanl1 f [x1, x2, ...] == [x1, x1 `f` x2, ...]
963scanl1 :: (Char -> Char -> Char) -> Text -> Text
667scanl1 :: (Char -> Char -> Char) -> Text -> Text
@@ -965,42 +669,40 @@ scanl1 f t | null t = empty
965 | otherwise = scanl f (unsafeHead t) (unsafeTail t)
669 | otherwise = scanl f (unsafeHead t) (unsafeTail t)
966{-# INLINE scanl1 #-}
670{-# INLINE scanl1 #-}
968−-- | /O(n)/ 'scanr' is the right-to-left dual of 'scanl'. Performs
672+-- | /O(n)/ 'scanr' is the right-to-left dual of 'scanl'.
969−-- replacement on invalid scalar values.
971-- > scanr f v == reverse . scanl (flip f) v . reverse
674-- > scanr f v == reverse . scanl (flip f) v . reverse
972scanr :: (Char -> Char -> Char) -> Char -> Text -> Text
675scanr :: (Char -> Char -> Char) -> Char -> Text -> Text
973−scanr f z = S.reverse . S.reverseScanr g z . reverseStream
676+scanr f z = S.reverse . S.reverseScanr f z . reverseStream
974− where g a b = safe (f a b)
975{-# INLINE scanr #-}
677{-# INLINE scanr #-}
977-- | /O(n)/ 'scanr1' is a variant of 'scanr' that has no starting
679-- | /O(n)/ 'scanr1' is a variant of 'scanr' that has no starting
978−-- value argument. Subject to fusion. Performs replacement on
680+-- value argument. Subject to fusion.
979−-- invalid scalar values.
980scanr1 :: (Char -> Char -> Char) -> Text -> Text
681scanr1 :: (Char -> Char -> Char) -> Text -> Text
981scanr1 f t | null t = empty
682scanr1 f t | null t = empty
982 | otherwise = scanr f (last t) (init t)
683 | otherwise = scanr f (last t) (init t)
983{-# INLINE scanr1 #-}
684{-# INLINE scanr1 #-}
985−-- | /O(n)/ Like a combination of 'map' and 'foldl''. Applies a
686+-- | /O(n)/ Like a combination of 'map' and 'foldl'. Applies a
986-- function to each element of a 'Text', passing an accumulating
687-- function to each element of a 'Text', passing an accumulating
987−-- parameter from left to right, and returns a final 'Text'. Performs
688+-- parameter from left to right, and returns a final 'Text'.
988−-- replacement on invalid scalar values.
989mapAccumL :: (a -> Char -> (a,Char)) -> a -> Text -> (a, Text)
689mapAccumL :: (a -> Char -> (a,Char)) -> a -> Text -> (a, Text)
990−mapAccumL f z0 = S.mapAccumL g z0 . stream
690+mapAccumL f s t = case uncons t of
991− where g a b = second safe (f a b)
691+ Nothing -> (s, empty)
692+ Just (x, xs) -> (s'', cons y ys)
693+ where (s', y ) = f s x
992−{-# INLINE mapAccumL #-}
694+ (s'',ys) = mapAccumL f s' xs
994-- | The 'mapAccumR' function behaves like a combination of 'map' and
696-- | The 'mapAccumR' function behaves like a combination of 'map' and
995−-- a strict 'foldr'; it applies a function to each element of a
697+-- 'foldr'; it applies a function to each element of a 'Text', passing
996−-- 'Text', passing an accumulating parameter from right to left, and
698+-- an accumulating parameter from right to left, and returning a final
997−-- returning a final value of this accumulator together with the new
699+-- value of this accumulator together with the new 'Text'.
999−-- Performs replacement on invalid scalar values.
1000mapAccumR :: (a -> Char -> (a,Char)) -> a -> Text -> (a, Text)
700mapAccumR :: (a -> Char -> (a,Char)) -> a -> Text -> (a, Text)
1001−mapAccumR f z0 = second reverse . S.mapAccumL g z0 . reverseStream
701+mapAccumR f s t = case uncons t of
1002− where g a b = second safe (f a b)
702+ Nothing -> (s, empty)
703+ Just (x, xs) -> (s'', cons y ys)
704+ where (s'',y ) = f s' x
1003−{-# INLINE mapAccumR #-}
705+ (s', ys) = mapAccumR f s xs
1005-- -----------------------------------------------------------------------------
707-- -----------------------------------------------------------------------------
1006-- ** Generating and unfolding 'Text's
708-- ** Generating and unfolding 'Text's
@@ -1009,18 +711,17 @@ mapAccumR f z0 = second reverse . S.mapAccumL g z0 . reverseStream
1009-- @t@ repeated @n@ times.
711-- @t@ repeated @n@ times.
1010replicate :: Int -> Text -> Text
712replicate :: Int -> Text -> Text
1011replicate n t@(Text a o l)
713replicate n t@(Text a o l)
1012− | n <= 0 || l <= 0 = empty
714+ | n <= 0 || l <= 0 = empty
1013− | n == 1 = t
715+ | n == 1 = t
1014− | isSingleton t = replicateChar n (unsafeHead t)
716+ | isSingleton t = replicateChar n (unsafeHead t)
1015− | otherwise = Text (A.run x) 0 len
717+ | otherwise = Text (A.run x) 0 len
1017− len = l `mul` n
719+ len = l * n
1018− x :: ST s (A.MArray s)
1020− arr <- A.new len
721+ arr <- A.unsafeNew len
1021 let loop !d !i | i >= n = return arr
722 let loop !d !i | i >= n = return arr
1022 | otherwise = let m = d + l
723 | otherwise = let m = d + l
1023− in A.copyI arr d a o m >> loop m (i+1)
724+ in copy arr d a o m >> loop m (i+1)
1024 loop 0 0
725 loop 0 0
1025{-# INLINE [1] replicate #-}
726{-# INLINE [1] replicate #-}
@@ -1032,7 +733,7 @@ replicate n t@(Text a o l)
1032-- | /O(n)/ 'replicateChar' @n@ @c@ is a 'Text' of length @n@ with @c@ the
733-- | /O(n)/ 'replicateChar' @n@ @c@ is a 'Text' of length @n@ with @c@ the
1033-- value of every element. Subject to fusion.
734-- value of every element. Subject to fusion.
1034replicateChar :: Int -> Char -> Text
735replicateChar :: Int -> Char -> Text
1035−replicateChar n c = unstream (S.replicateCharI n (safe c))
736+replicateChar n c = unstream (S.replicateCharI n c)
1036{-# INLINE replicateChar #-}
737{-# INLINE replicateChar #-}
1038-- | /O(n)/, where @n@ is the length of the result. The 'unfoldr'
739-- | /O(n)/, where @n@ is the length of the result. The 'unfoldr'
@@ -1041,9 +742,9 @@ replicateChar n c = unstream (S.replicateCharI n (safe c))
1041-- returns 'Nothing' if it is done producing the 'Text', otherwise
742-- returns 'Nothing' if it is done producing the 'Text', otherwise
1042-- 'Just' @(a,b)@. In this case, @a@ is the next 'Char' in the
743-- 'Just' @(a,b)@. In this case, @a@ is the next 'Char' in the
1043-- string, and @b@ is the seed value for further production. Subject
744-- string, and @b@ is the seed value for further production. Subject
1044−-- to fusion. Performs replacement on invalid scalar values.
745+-- to fusion.
1045unfoldr :: (a -> Maybe (Char,a)) -> a -> Text
746unfoldr :: (a -> Maybe (Char,a)) -> a -> Text
1046−unfoldr f s = unstream (S.unfoldr (firstf safe . f) s)
747+unfoldr f s = unstream (S.unfoldr f s)
1047{-# INLINE unfoldr #-}
748{-# INLINE unfoldr #-}
1049-- | /O(n)/ Like 'unfoldr', 'unfoldrN' builds a 'Text' from a seed
750-- | /O(n)/ Like 'unfoldr', 'unfoldrN' builds a 'Text' from a seed
@@ -1051,9 +752,9 @@ unfoldr f s = unstream (S.unfoldr (firstf safe . f) s)
1051-- first argument to 'unfoldrN'. This function is more efficient than
752-- first argument to 'unfoldrN'. This function is more efficient than
1052-- 'unfoldr' when the maximum length of the result is known and
753-- 'unfoldr' when the maximum length of the result is known and
1053-- correct, otherwise its performance is similar to 'unfoldr'. Subject
754-- correct, otherwise its performance is similar to 'unfoldr'. Subject
1054−-- to fusion. Performs replacement on invalid scalar values.
755+-- to fusion.
1055unfoldrN :: Int -> (a -> Maybe (Char,a)) -> a -> Text
756unfoldrN :: Int -> (a -> Maybe (Char,a)) -> a -> Text
1056−unfoldrN n f s = unstream (S.unfoldrN n (firstf safe . f) s)
757+unfoldrN n f s = unstream (S.unfoldrN n f s)
1057{-# INLINE unfoldrN #-}
758{-# INLINE unfoldrN #-}
1059-- -----------------------------------------------------------------------------
760-- -----------------------------------------------------------------------------
@@ -1066,16 +767,14 @@ take :: Int -> Text -> Text
1066take n t@(Text arr off len)
767take n t@(Text arr off len)
1067 | n <= 0 = empty
768 | n <= 0 = empty
1068 | n >= len = t
769 | n >= len = t
1069− | otherwise = text arr off (iterN n t)
770+ | otherwise = Text arr off (loop 0 0)
773+ | i >= len || cnt >= n = i
774+ | otherwise = loop (i+d) (cnt+1)
1070{-# INLINE [1] take #-}
776{-# INLINE [1] take #-}
1072−iterN :: Int -> Text -> Int
1073−iterN n t@(Text _arr _off len) = loop 0 0
1075− | i >= len || cnt >= n = i
1076− | otherwise = loop (i+d) (cnt+1)
1077− where d = iter_ t i
1079{-# RULES
778{-# RULES
1080"TEXT take -> fused" [~1] forall n t.
779"TEXT take -> fused" [~1] forall n t.
1081 take n t = unstream (S.take n (stream t))
780 take n t = unstream (S.take n (stream t))
@@ -1083,27 +782,6 @@ iterN n t@(Text _arr _off len) = loop 0 0
1083 unstream (S.take n (stream t)) = take n t
782 unstream (S.take n (stream t)) = take n t
1086−-- | /O(n)/ 'takeEnd' @n@ @t@ returns the suffix remaining after
1087−-- taking @n@ characters from the end of @t@.
1091−-- > takeEnd 3 "foobar" == "bar"
1092−takeEnd :: Int -> Text -> Text
1093−takeEnd n t@(Text arr off len)
1096− | otherwise = text arr (off+i) (len-i)
1097− where i = iterNEnd n t
1099−iterNEnd :: Int -> Text -> Int
1100−iterNEnd n t@(Text _arr _off len) = loop (len-1) n
1104− | otherwise = loop (i+d) (m-1)
1105− where d = reverseIter_ t i
1107-- | /O(n)/ 'drop' @n@, applied to a 'Text', returns the suffix of the
785-- | /O(n)/ 'drop' @n@, applied to a 'Text', returns the suffix of the
1108-- 'Text' after the first @n@ characters, or the empty 'Text' if @n@
786-- 'Text' after the first @n@ characters, or the empty 'Text' if @n@
1109-- is greater than the length of the 'Text'. Subject to fusion.
787-- is greater than the length of the 'Text'. Subject to fusion.
@@ -1111,8 +789,11 @@ drop :: Int -> Text -> Text
1111drop n t@(Text arr off len)
789drop n t@(Text arr off len)
1112 | n <= 0 = t
790 | n <= 0 = t
1113 | n >= len = empty
791 | n >= len = empty
1114− | otherwise = text arr (off+i) (len-i)
792+ | otherwise = loop 0 0
1115− where i = iterN n t
793+ where loop !i !cnt
794+ | i >= len || cnt >= n = Text arr (off+i) (len-i)
795+ | otherwise = loop (i+d) (cnt+1)
1116{-# INLINE [1] drop #-}
797{-# INLINE [1] drop #-}
1118{-# RULES
799{-# RULES
@@ -1122,18 +803,6 @@ drop n t@(Text arr off len)
1122 unstream (S.drop n (stream t)) = drop n t
803 unstream (S.drop n (stream t)) = drop n t
1125−-- | /O(n)/ 'dropEnd' @n@ @t@ returns the prefix remaining after
1126−-- dropping @n@ characters from the end of @t@.
1130−-- > dropEnd 3 "foobar" == "foo"
1131−dropEnd :: Int -> Text -> Text
1132−dropEnd n t@(Text arr off len)
1135− | otherwise = text arr off (iterNEnd n t)
1137-- | /O(n)/ 'takeWhile', applied to a predicate @p@ and a 'Text',
806-- | /O(n)/ 'takeWhile', applied to a predicate @p@ and a 'Text',
1138-- returns the longest prefix (possibly empty) of elements that
807-- returns the longest prefix (possibly empty) of elements that
1139-- satisfy @p@. Subject to fusion.
808-- satisfy @p@. Subject to fusion.
@@ -1141,8 +810,8 @@ takeWhile :: (Char -> Bool) -> Text -> Text
1141takeWhile p t@(Text arr off len) = loop 0
810takeWhile p t@(Text arr off len) = loop 0
1142 where loop !i | i >= len = t
811 where loop !i | i >= len = t
1143 | p c = loop (i+d)
812 | p c = loop (i+d)
1144− | otherwise = text arr off i
813+ | otherwise = textP arr off i
1145− where Iter c d = iter t i
814+ where (c,d) = iter t i
1146{-# INLINE [1] takeWhile #-}
815{-# INLINE [1] takeWhile #-}
1148{-# RULES
817{-# RULES
@@ -1152,27 +821,6 @@ takeWhile p t@(Text arr off len) = loop 0
1152 unstream (S.takeWhile p (stream t)) = takeWhile p t
821 unstream (S.takeWhile p (stream t)) = takeWhile p t
1155−-- | /O(n)/ 'takeWhileEnd', applied to a predicate @p@ and a 'Text',
1156−-- returns the longest suffix (possibly empty) of elements that
1157−-- satisfy @p@. Subject to fusion.
1160−-- > takeWhileEnd (=='o') "foo" == "oo"
1161−takeWhileEnd :: (Char -> Bool) -> Text -> Text
1162−takeWhileEnd p t@(Text arr off len) = loop (len-1) len
1163− where loop !i !l | l <= 0 = t
1164− | p c = loop (i+d) (l+d)
1165− | otherwise = text arr (off+l) (len-l)
1166− where (c,d) = reverseIter t i
1167−{-# INLINE [1] takeWhileEnd #-}
1170−"TEXT takeWhileEnd -> fused" [~1] forall p t.
1171− takeWhileEnd p t = S.reverse (S.takeWhile p (S.reverseStream t))
1172−"TEXT takeWhileEnd -> unfused" [1] forall p t.
1173− S.reverse (S.takeWhile p (S.reverseStream t)) = takeWhileEnd p t
1176-- | /O(n)/ 'dropWhile' @p@ @t@ returns the suffix remaining after
824-- | /O(n)/ 'dropWhile' @p@ @t@ returns the suffix remaining after
1177-- 'takeWhile' @p@ @t@. Subject to fusion.
825-- 'takeWhile' @p@ @t@. Subject to fusion.
1178dropWhile :: (Char -> Bool) -> Text -> Text
826dropWhile :: (Char -> Bool) -> Text -> Text
@@ -1180,7 +828,7 @@ dropWhile p t@(Text arr off len) = loop 0 0
1180 where loop !i !l | l >= len = empty
828 where loop !i !l | l >= len = empty
1181 | p c = loop (i+d) (l+d)
829 | p c = loop (i+d) (l+d)
1182 | otherwise = Text arr (off+i) (len-l)
830 | otherwise = Text arr (off+i) (len-l)
1183− where Iter c d = iter t i
831+ where (c,d) = iter t i
1184{-# INLINE [1] dropWhile #-}
832{-# INLINE [1] dropWhile #-}
1186{-# RULES
834{-# RULES
@@ -1191,9 +839,8 @@ dropWhile p t@(Text arr off len) = loop 0 0
1193-- | /O(n)/ 'dropWhileEnd' @p@ @t@ returns the prefix remaining after
841-- | /O(n)/ 'dropWhileEnd' @p@ @t@ returns the prefix remaining after
1194−-- dropping characters that satisfy the predicate @p@ from the end of
842+-- dropping characters that fail the predicate @p@ from the end of
1195-- @t@. Subject to fusion.
843-- @t@. Subject to fusion.
1197-- Examples:
844-- Examples:
1199-- > dropWhileEnd (=='.') "foo..." == "foo"
846-- > dropWhileEnd (=='.') "foo..." == "foo"
@@ -1213,7 +860,7 @@ dropWhileEnd p t@(Text arr off len) = loop (len-1) len
1215-- | /O(n)/ 'dropAround' @p@ @t@ returns the substring remaining after
862-- | /O(n)/ 'dropAround' @p@ @t@ returns the substring remaining after
1216−-- dropping characters that satisfy the predicate @p@ from both the
863+-- dropping characters that fail the predicate @p@ from both the
1217-- beginning and end of @t@. Subject to fusion.
864-- beginning and end of @t@. Subject to fusion.
1218dropAround :: (Char -> Bool) -> Text -> Text
865dropAround :: (Char -> Bool) -> Text -> Text
1219dropAround p = dropWhile p . dropWhileEnd p
866dropAround p = dropWhile p . dropWhileEnd p
@@ -1248,23 +895,31 @@ splitAt :: Int -> Text -> (Text, Text)
1248splitAt n t@(Text arr off len)
895splitAt n t@(Text arr off len)
1249 | n <= 0 = (empty, t)
896 | n <= 0 = (empty, t)
1250 | n >= len = (t, empty)
897 | n >= len = (t, empty)
1251− | otherwise = let k = iterN n t
898+ | otherwise = (Text arr off k, Text arr (off+k) (len-k))
1252− in (text arr off k, text arr (off+k) (len-k))
899+ where k = loop 0 0
901+ | i >= len || cnt >= n = i
902+ | otherwise = loop (i+d) (cnt+1)
904+{-# INLINE splitAt #-}
1254−-- | /O(n)/ 'span', applied to a predicate @p@ and text @t@, returns
906+-- | /O(n)/ 'spanBy', applied to a predicate @p@ and text @t@, returns
1255-- a pair whose first element is the longest prefix (possibly empty)
907-- a pair whose first element is the longest prefix (possibly empty)
1256-- of @t@ of elements that satisfy @p@, and whose second is the
908-- of @t@ of elements that satisfy @p@, and whose second is the
1257-- remainder of the list.
909-- remainder of the list.
1258−span :: (Char -> Bool) -> Text -> (Text, Text)
910+spanBy :: (Char -> Bool) -> Text -> (Text, Text)
1259−span p t = case span_ p t of
911+spanBy p t@(Text arr off len) = (textP arr off k, textP arr (off+k) (len-k))
1260− (# hd,tl #) -> (hd,tl)
912+ where k = loop 0
913+ loop !i | i >= len || not (p c) = i
914+ | otherwise = loop (i+d)
915+ where (c,d) = iter t i
1261−{-# INLINE span #-}
916+{-# INLINE spanBy #-}
1263−-- | /O(n)/ 'break' is like 'span', but the prefix returned is
918+-- | /O(n)/ 'breakBy' is like 'spanBy', but the prefix returned is
1264-- over elements that fail the predicate @p@.
919-- over elements that fail the predicate @p@.
1265−break :: (Char -> Bool) -> Text -> (Text, Text)
920+breakBy :: (Char -> Bool) -> Text -> (Text, Text)
1266−break p = span (not . p)
921+breakBy p = spanBy (not . p)
1267−{-# INLINE break #-}
922+{-# INLINE breakBy #-}
1269-- | /O(n)/ Group characters in a string according to a predicate.
924-- | /O(n)/ Group characters in a string according to a predicate.
1270groupBy :: (Char -> Char -> Bool) -> Text -> [Text]
925groupBy :: (Char -> Char -> Bool) -> Text -> [Text]
@@ -1273,7 +928,7 @@ groupBy p = loop
1273 loop t@(Text arr off len)
928 loop t@(Text arr off len)
1274 | null t = []
929 | null t = []
1275 | otherwise = text arr off n : loop (text arr (off+n) (len-n))
930 | otherwise = text arr off n : loop (text arr (off+n) (len-n))
1276− where Iter c d = iter t 0
931+ where (c,d) = iter t 0
1277 n = d + findAIndexOrEnd (not . p c) (Text arr (off+d) (len-d))
932 n = d + findAIndexOrEnd (not . p c) (Text arr (off+d) (len-d))
1279-- | Returns the /array/ index (in units of 'Word16') at which a
934-- | Returns the /array/ index (in units of 'Word16') at which a
@@ -1283,8 +938,8 @@ findAIndexOrEnd :: (Char -> Bool) -> Text -> Int
1283findAIndexOrEnd q t@(Text _arr _off len) = go 0
938findAIndexOrEnd q t@(Text _arr _off len) = go 0
1284 where go !i | i >= len || q c = i
939 where go !i | i >= len || q c = i
1285 | otherwise = go (i+d)
940 | otherwise = go (i+d)
1286− where Iter c d = iter t i
941+ where (c,d) = iter t i
1288-- | /O(n)/ Group characters in a string by equality.
943-- | /O(n)/ Group characters in a string by equality.
1289group :: Text -> [Text]
944group :: Text -> [Text]
1290group = groupBy (==)
945group = groupBy (==)
@@ -1308,43 +963,36 @@ tails t | null t = [empty]
1308-- copies to create substrings; they just construct new 'Text's that
963-- copies to create substrings; they just construct new 'Text's that
1309-- are slices of the original.
964-- are slices of the original.
1311−-- | /O(m+n)/ Break a 'Text' into pieces separated by the first 'Text'
966+-- | /O(m+n)/ Break a 'Text' into pieces separated by the first
1312−-- argument (which cannot be empty), consuming the delimiter. An empty
967+-- 'Text' argument, consuming the delimiter. An empty delimiter is
1313−-- delimiter is invalid, and will cause an error to be raised.
968+-- invalid, and will cause an error to be raised.
1315-- Examples:
970-- Examples:
1317−-- > splitOn "\r\n" "a\r\nb\r\nd\r\ne" == ["a","b","d","e"]
972+-- > split "\r\n" "a\r\nb\r\nd\r\ne" == ["a","b","d","e"]
1318−-- > splitOn "aaa" "aaaXaaaXaaaXaaa" == ["","X","X","X",""]
973+-- > split "aaa" "aaaXaaaXaaaXaaa" == ["","X","X","X",""]
1319−-- > splitOn "x" "x" == ["",""]
974+-- > split "x" "x" == ["",""]
1323−-- > intercalate s . splitOn s == id
978+-- > intercalate s . split s == id
1324−-- > splitOn (singleton c) == split (==c)
979+-- > split (singleton c) == splitBy (==c)
1326−-- (Note: the string @s@ to split on above cannot be empty.)
1328-- In (unlikely) bad cases, this function's time complexity degrades
981-- In (unlikely) bad cases, this function's time complexity degrades
1329-- towards /O(n*m)/.
982-- towards /O(n*m)/.
1330−splitOn :: Text
983+split :: Text -> Text -> [Text]
1331− -- ^ String to split on. If this string is empty, an error
1336−splitOn pat@(Text _ _ l) src@(Text arr off len)
984+split pat@(Text _ _ l) src@(Text arr off len)
1337− | l <= 0 = emptyError "splitOn"
985+ | l <= 0 = emptyError "split"
1338− | isSingleton pat = split (== unsafeHead pat) src
986+ | isSingleton pat = splitBy (== unsafeHead pat) src
1339 | otherwise = go 0 (indices pat src)
987 | otherwise = go 0 (indices pat src)
1341− go !s (x:xs) = text arr (s+off) (x-s) : go (x+l) xs
989+ go !s (x:xs) = textP arr (s+off) (x-s) : go (x+l) xs
1342− go s _ = [text arr (s+off) (len-s)]
990+ go s _ = [textP arr (s+off) (len-s)]
1343−{-# INLINE [1] splitOn #-}
991+{-# INLINE [1] split #-}
1345{-# RULES
993{-# RULES
1346−"TEXT splitOn/singleton -> split/==" [~1] forall c t.
994+"TEXT split/singleton -> splitBy/==" [~1] forall c t.
1347− splitOn (singleton c) t = split (==c) t
995+ split (singleton c) t = splitBy (==c) t
1350-- | /O(n)/ Splits a 'Text' into components delimited by separators,
998-- | /O(n)/ Splits a 'Text' into components delimited by separators,
@@ -1352,15 +1000,15 @@ splitOn pat@(Text _ _ l) src@(Text arr off len)
1352-- resulting components do not contain the separators. Two adjacent
1000-- resulting components do not contain the separators. Two adjacent
1353-- separators result in an empty component in the output. eg.
1001-- separators result in an empty component in the output. eg.
1355−-- > split (=='a') "aabbaca" == ["","","bb","c",""]
1003+-- > splitBy (=='a') "aabbaca" == ["","","bb","c",""]
1356−-- > split (=='a') "" == [""]
1004+-- > splitBy (=='a') "" == [""]
1357−split :: (Char -> Bool) -> Text -> [Text]
1005+splitBy :: (Char -> Bool) -> Text -> [Text]
1358−split _ t@(Text _off _arr 0) = [t]
1006+splitBy _ t@(Text _off _arr 0) = [t]
1359−split p t = loop t
1007+splitBy p t = loop t
1360 where loop s | null s' = [l]
1008 where loop s | null s' = [l]
1361 | otherwise = l : loop (unsafeTail s')
1009 | otherwise = l : loop (unsafeTail s')
1362− where (# l, s' #) = span_ (not . p) s
1010+ where (l, s') = breakBy p s
1363−{-# INLINE split #-}
1011+{-# INLINE splitBy #-}
1365-- | /O(n)/ Splits a 'Text' into components of length @k@. The last
1013-- | /O(n)/ Splits a 'Text' into components of length @k@. The last
1366-- element may be shorter than the other chunks, depending on the
1014-- element may be shorter than the other chunks, depending on the
@@ -1382,21 +1030,21 @@ chunksOf k = go
1382-------------------------------------------------------------------------------
1030-------------------------------------------------------------------------------
1383-- ** Searching with a predicate
1031-- ** Searching with a predicate
1385−-- | /O(n)/ The 'find' function takes a predicate and a 'Text', and
1033+-- | /O(n)/ The 'findBy' function takes a predicate and a 'Text', and
1386−-- returns the first element matching the predicate, or 'Nothing' if
1034+-- returns the first element in matching the predicate, or 'Nothing'
1387−-- there is no such element.
1035+-- if there is no such element.
1388−find :: (Char -> Bool) -> Text -> Maybe Char
1036+findBy :: (Char -> Bool) -> Text -> Maybe Char
1389−find p t = S.findBy p (stream t)
1037+findBy p t = S.findBy p (stream t)
1390−{-# INLINE find #-}
1038+{-# INLINE findBy #-}
1392−-- | /O(n)/ The 'partition' function takes a predicate and a 'Text',
1040+-- | /O(n)/ The 'partitionBy' function takes a predicate and a 'Text',
1393-- and returns the pair of 'Text's with elements which do and do not
1041-- and returns the pair of 'Text's with elements which do and do not
1394-- satisfy the predicate, respectively; i.e.
1042-- satisfy the predicate, respectively; i.e.
1396−-- > partition p t == (filter p t, filter (not . p) t)
1044+-- > partitionBy p t == (filter p t, filter (not . p) t)
1397−partition :: (Char -> Bool) -> Text -> (Text, Text)
1045+partitionBy :: (Char -> Bool) -> Text -> (Text, Text)
1398−partition p t = (filter p t, filter (not . p) t)
1046+partitionBy p t = (filter p t, filter (not . p) t)
1399−{-# INLINE partition #-}
1047+{-# INLINE partitionBy #-}
1401-- | /O(n)/ 'filter', applied to a predicate and a 'Text',
1049-- | /O(n)/ 'filter', applied to a predicate and a 'Text',
1402-- returns a 'Text' containing those characters that satisfy the
1050-- returns a 'Text' containing those characters that satisfy the
@@ -1412,40 +1060,39 @@ filter p t = unstream (S.filter p (stream t))
1413-- Examples:
1061-- Examples:
1415−-- > breakOn "::" "a::b::c" ==> ("a", "::b::c")
1063+-- > break "::" "a::b::c" ==> ("a", "::b::c")
1416−-- > breakOn "/" "foobar" ==> ("foobar", "")
1064+-- > break "/" "foobar" ==> ("foobar", "")
1420-- > append prefix match == haystack
1068-- > append prefix match == haystack
1421−-- > where (prefix, match) = breakOn needle haystack
1069+-- > where (prefix, match) = break needle haystack
1423-- If you need to break a string by a substring repeatedly (e.g. you
1071-- If you need to break a string by a substring repeatedly (e.g. you
1424−-- want to break on every instance of a substring), use 'breakOnAll'
1072+-- want to break on every instance of a substring), use 'find'
1425-- instead, as it has lower startup overhead.
1073-- instead, as it has lower startup overhead.
1427-- In (unlikely) bad cases, this function's time complexity degrades
1075-- In (unlikely) bad cases, this function's time complexity degrades
1428-- towards /O(n*m)/.
1076-- towards /O(n*m)/.
1429−breakOn :: Text -> Text -> (Text, Text)
1077+break :: Text -> Text -> (Text, Text)
1430−breakOn pat src@(Text arr off len)
1078+break pat src@(Text arr off len)
1431− | null pat = emptyError "breakOn"
1079+ | null pat = emptyError "break"
1432 | otherwise = case indices pat src of
1080 | otherwise = case indices pat src of
1433 [] -> (src, empty)
1081 [] -> (src, empty)
1434− (x:_) -> (text arr off x, text arr (off+x) (len-x))
1082+ (x:_) -> (textP arr off x, textP arr (off+x) (len-x))
1435−{-# INLINE breakOn #-}
1083+{-# INLINE break #-}
1437−-- | /O(n+m)/ Similar to 'breakOn', but searches from the end of the
1085+-- | /O(n+m)/ Similar to 'break', but searches from the end of the string.
1440-- The first element of the returned tuple is the prefix of @haystack@
1087-- The first element of the returned tuple is the prefix of @haystack@
1441-- up to and including the last match of @needle@. The second is the
1088-- up to and including the last match of @needle@. The second is the
1442-- remainder of @haystack@, following the match.
1089-- remainder of @haystack@, following the match.
1444−-- > breakOnEnd "::" "a::b::c" ==> ("a::b::", "c")
1091+-- > breakEnd "::" "a::b::c" ==> ("a::b::", "c")
1445−breakOnEnd :: Text -> Text -> (Text, Text)
1092+breakEnd :: Text -> Text -> (Text, Text)
1446−breakOnEnd pat src = (reverse b, reverse a)
1447− where (a,b) = breakOn (reverse pat) (reverse src)
1093+breakEnd pat src = let (a,b) = break (reverse pat) (reverse src)
1094+ in (reverse b, reverse a)
1448−{-# INLINE breakOnEnd #-}
1095+{-# INLINE breakEnd #-}
1450-- | /O(n+m)/ Find all non-overlapping instances of @needle@ in
1097-- | /O(n+m)/ Find all non-overlapping instances of @needle@ in
1451-- @haystack@. Each element of the returned list consists of a pair:
1098-- @haystack@. Each element of the returned list consists of a pair:
@@ -1456,25 +1103,25 @@ breakOnEnd pat src = (reverse b, reverse a)
1457-- Examples:
1104-- Examples:
1459−-- > breakOnAll "::" ""
1106+-- > find "::" ""
1460-- > ==> []
1107-- > ==> []
1461−-- > breakOnAll "/" "a/b/c/"
1108+-- > find "/" "a/b/c/"
1462-- > ==> [("a", "/b/c/"), ("a/b", "/c/"), ("a/b/c", "/")]
1109-- > ==> [("a", "/b/c/"), ("a/b", "/c/"), ("a/b/c", "/")]
1464-- In (unlikely) bad cases, this function's time complexity degrades
1111-- In (unlikely) bad cases, this function's time complexity degrades
1465-- towards /O(n*m)/.
1112-- towards /O(n*m)/.
1467-- The @needle@ parameter may not be empty.
1114-- The @needle@ parameter may not be empty.
1468−breakOnAll :: Text -- ^ @needle@ to search for
1115+find :: Text -- ^ @needle@ to search for
1469− -> Text -- ^ @haystack@ in which to search
1116+ -> Text -- ^ @haystack@ in which to search
1470− -> [(Text, Text)]
1117+ -> [(Text, Text)]
1471−breakOnAll pat src@(Text arr off slen)
1118+find pat src@(Text arr off slen)
1472− | null pat = emptyError "breakOnAll"
1119+ | null pat = emptyError "find"
1473 | otherwise = L.map step (indices pat src)
1120 | otherwise = L.map step (indices pat src)
1475 step x = (chunk 0 x, chunk x (slen-x))
1122 step x = (chunk 0 x, chunk x (slen-x))
1476− chunk !n !l = text arr (n+off) l
1123+ chunk !n !l = textP arr (n+off) l
1477−{-# INLINE breakOnAll #-}
1124+{-# INLINE find #-}
1479-------------------------------------------------------------------------------
1126-------------------------------------------------------------------------------
1480-- ** Indexing 'Text's
1127-- ** Indexing 'Text's
@@ -1493,7 +1140,7 @@ breakOnAll pat src@(Text arr off slen)
1493-- For example, suppose you have a string that you want to split on
1140-- For example, suppose you have a string that you want to split on
1494-- the substring @\"::\"@, such as @\"foo::bar::quux\"@. Instead of
1141-- the substring @\"::\"@, such as @\"foo::bar::quux\"@. Instead of
1495-- searching for the index of @\"::\"@ and taking the substrings
1142-- searching for the index of @\"::\"@ and taking the substrings
1496−-- before and after that index, you would instead use @breakOnAll \"::\"@.
1143+-- before and after that index, you would instead use @find \"::\"@.
1498-- | /O(n)/ 'Text' index (subscript) operator, starting from 0.
1145-- | /O(n)/ 'Text' index (subscript) operator, starting from 0.
1499index :: Text -> Int -> Char
1146index :: Text -> Int -> Char
@@ -1540,15 +1187,13 @@ countChar c t = S.countChar c (stream t)
1540-- equivalent to a pair of 'unpack' operations.
1187-- equivalent to a pair of 'unpack' operations.
1541zip :: Text -> Text -> [(Char,Char)]
1188zip :: Text -> Text -> [(Char,Char)]
1542zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1189zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1543−{-# INLINE zip #-}
1190+{-# INLINE [0] zip #-}
1545-- | /O(n)/ 'zipWith' generalises 'zip' by zipping with the function
1192-- | /O(n)/ 'zipWith' generalises 'zip' by zipping with the function
1546-- given as the first argument, instead of a tupling function.
1193-- given as the first argument, instead of a tupling function.
1547−-- Performs replacement on invalid scalar values.
1548zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
1194zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
1549−zipWith f t1 t2 = unstream (S.zipWith g (stream t1) (stream t2))
1195+zipWith f t1 t2 = unstream (S.zipWith f (stream t1) (stream t2))
1550− where g a b = safe (f a b)
1551−{-# INLINE zipWith #-}
1196+{-# INLINE [0] zipWith #-}
1553-- | /O(n)/ Breaks a 'Text' up into a list of words, delimited by 'Char's
1198-- | /O(n)/ Breaks a 'Text' up into a list of words, delimited by 'Char's
1554-- representing white space.
1199-- representing white space.
@@ -1564,7 +1209,7 @@ words t@(Text arr off len) = loop 0 0
1564 then loop (start+1) (start+1)
1209 then loop (start+1) (start+1)
1565 else Text arr (start+off) (n-start) : loop (n+d) (n+d)
1210 else Text arr (start+off) (n-start) : loop (n+d) (n+d)
1566 | otherwise = loop start (n+d)
1211 | otherwise = loop start (n+d)
1567− where Iter c d = iter t n
1212+ where (c,d) = iter t n
1568{-# INLINE words #-}
1213{-# INLINE words #-}
1570-- | /O(n)/ Breaks a 'Text' up into a list of 'Text's at
1215-- | /O(n)/ Breaks a 'Text' up into a list of 'Text's at
@@ -1574,7 +1219,7 @@ lines ps | null ps = []
1574 | otherwise = h : if null t
1219 | otherwise = h : if null t
1576 else lines (unsafeTail t)
1221 else lines (unsafeTail t)
1577− where (# h,t #) = span_ (/= '\n') ps
1222+ where (h,t) = spanBy (/= '\n') ps
1578{-# INLINE lines #-}
1223{-# INLINE lines #-}
@@ -1611,7 +1256,8 @@ unwords = intercalate (singleton ' ')
1611{-# INLINE unwords #-}
1256{-# INLINE unwords #-}
1613-- | /O(n)/ The 'isPrefixOf' function takes two 'Text's and returns
1258-- | /O(n)/ The 'isPrefixOf' function takes two 'Text's and returns
1614−-- 'True' iff the first is a prefix of the second. Subject to fusion.
1259+-- 'True' iff the first is a prefix of the second. This function is
1260+-- subject to fusion.
1615isPrefixOf :: Text -> Text -> Bool
1261isPrefixOf :: Text -> Text -> Bool
1616isPrefixOf a@(Text _ _ alen) b@(Text _ _ blen) =
1262isPrefixOf a@(Text _ _ alen) b@(Text _ _ blen) =
1617 alen <= blen && S.isPrefixOf (stream a) (stream b)
1263 alen <= blen && S.isPrefixOf (stream a) (stream b)
@@ -1620,6 +1266,8 @@ isPrefixOf a@(Text _ _ alen) b@(Text _ _ blen) =
1620{-# RULES
1266{-# RULES
1621"TEXT isPrefixOf -> fused" [~1] forall s t.
1267"TEXT isPrefixOf -> fused" [~1] forall s t.
1622 isPrefixOf s t = S.isPrefixOf (stream s) (stream t)
1268 isPrefixOf s t = S.isPrefixOf (stream s) (stream t)
1269+"TEXT isPrefixOf -> unfused" [1] forall s t.
1270+ S.isPrefixOf (stream s) (stream t) = isPrefixOf s t
1625-- | /O(n)/ The 'isSuffixOf' function takes two 'Text's and returns
1273-- | /O(n)/ The 'isSuffixOf' function takes two 'Text's and returns
@@ -1653,14 +1301,13 @@ isInfixOf needle haystack
1653-------------------------------------------------------------------------------
1301-------------------------------------------------------------------------------
1654-- * View patterns
1302-- * View patterns
1656−-- | /O(n)/ Return the suffix of the second string if its prefix
1304+-- | /O(n)/ Returns the suffix of the second string if its prefix
1657−-- matches the entire first string.
1305+-- matches the first.
1659-- Examples:
1307-- Examples:
1661−-- > stripPrefix "foo" "foobar" == Just "bar"
1309+-- > prefixed "foo" "foobar" == Just "bar"
1662−-- > stripPrefix "" "baz" == Just "baz"
1663−-- > stripPrefix "foo" "quux" == Nothing
1310+-- > prefixed "foo" "quux" == Nothing
1665-- This is particularly useful with the @ViewPatterns@ extension to
1312-- This is particularly useful with the @ViewPatterns@ extension to
1666-- GHC, as follows:
1313-- GHC, as follows:
@@ -1669,44 +1316,20 @@ isInfixOf needle haystack
1669-- > import Data.Text as T
1316-- > import Data.Text as T
1671-- > fnordLength :: Text -> Int
1318-- > fnordLength :: Text -> Int
1672−-- > fnordLength (stripPrefix "fnord" -> Just suf) = T.length suf
1319+-- > fnordLength (prefixed "fnord" -> Just suf) = T.length suf
1673−-- > fnordLength _ = -1
1320+-- > fnordLength _ = -1
1674−stripPrefix :: Text -> Text -> Maybe Text
1321+prefixed :: Text -> Text -> Maybe Text
1675−stripPrefix p@(Text _arr _off plen) t@(Text arr off len)
1322+prefixed p@(Text _arr _off plen) t@(Text arr off len)
1676− | p `isPrefixOf` t = Just $! text arr (off+plen) (len-plen)
1323+ | p `isPrefixOf` t = Just $! textP arr (off+plen) (len-plen)
1677 | otherwise = Nothing
1324 | otherwise = Nothing
1679−-- | /O(n)/ Find the longest non-empty common prefix of two strings
1326+-- | /O(n)/ Returns the prefix of the second string if its suffix
1680−-- and return it, along with the suffixes of each string at which they
1327+-- matches the first.
1683−-- If the strings do not have a common prefix or either one is empty,
1684−-- this function returns 'Nothing'.
1686-- Examples:
1329-- Examples:
1688−-- > commonPrefixes "foobar" "fooquux" == Just ("foo","bar","quux")
1689−-- > commonPrefixes "veeble" "fetzer" == Nothing
1690−-- > commonPrefixes "" "baz" == Nothing
1691−commonPrefixes :: Text -> Text -> Maybe (Text,Text,Text)
1692−commonPrefixes t0@(Text arr0 off0 len0) t1@(Text arr1 off1 len1) = go 0 0
1694− go !i !j | i < len0 && j < len1 && a == b = go (i+d0) (j+d1)
1695− | i > 0 = Just (Text arr0 off0 i,
1696− text arr0 (off0+i) (len0-i),
1697− text arr1 (off1+j) (len1-j))
1698− | otherwise = Nothing
1699− where Iter a d0 = iter t0 i
1700− Iter b d1 = iter t1 j
1702−-- | /O(n)/ Return the prefix of the second string if its suffix
1703−-- matches the entire first string.
1707−-- > stripSuffix "bar" "foobar" == Just "foo"
1331+-- > suffixed "bar" "foobar" == Just "foo"
1708−-- > stripSuffix "" "baz" == Just "baz"
1709−-- > stripSuffix "foo" "quux" == Nothing
1332+-- > suffixed "foo" "quux" == Nothing
1711-- This is particularly useful with the @ViewPatterns@ extension to
1334-- This is particularly useful with the @ViewPatterns@ extension to
1712-- GHC, as follows:
1335-- GHC, as follows:
@@ -1715,41 +1338,12 @@ commonPrefixes t0@(Text arr0 off0 len0) t1@(Text arr1 off1 len1) = go 0 0
1715-- > import Data.Text as T
1338-- > import Data.Text as T
1717-- > quuxLength :: Text -> Int
1340-- > quuxLength :: Text -> Int
1718−-- > quuxLength (stripSuffix "quux" -> Just pre) = T.length pre
1341+-- > quuxLength (suffixed "quux" -> Just pre) = T.length pre
1719−-- > quuxLength _ = -1
1342+-- > quuxLength _ = -1
1720−stripSuffix :: Text -> Text -> Maybe Text
1343+suffixed :: Text -> Text -> Maybe Text
1721−stripSuffix p@(Text _arr _off plen) t@(Text arr off len)
1344+suffixed p@(Text _arr _off plen) t@(Text arr off len)
1722− | p `isSuffixOf` t = Just $! text arr off (len-plen)
1345+ | p `isSuffixOf` t = Just $! textP arr off (len-plen)
1723 | otherwise = Nothing
1346 | otherwise = Nothing
1725−-- | Add a list of non-negative numbers. Errors out on overflow.
1726−sumP :: String -> [Int] -> Int
1729− | ax >= 0 = go ax xs
1730− | otherwise = overflowError fun
1734emptyError :: String -> a
1348emptyError :: String -> a
1735−emptyError fun = P.error $ "Data.Text." ++ fun ++ ": empty input"
1349+emptyError fun = P.error ("Data.Text." ++ fun ++ ": empty input")
1737−overflowError :: String -> a
1738−overflowError fun = P.error $ "Data.Text." ++ fun ++ ": size overflow"
1740−-- | /O(n)/ Make a distinct copy of the given string, sharing no
1741−-- storage with the original string.
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
1751− go :: ST s (A.MArray s)
1754− A.copyI marr 0 arr off len