@@ -1,48 +1,29 @@
1−{-# LANGUAGE BangPatterns, CPP, MagicHash, Rank2Types, UnboxedTuples #-}
1+{-# LANGUAGE BangPatterns #-}
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, rtharper@aftereternity.co.uk,
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
@@ -118,6 +97,7 @@ module Data.Text
119 -- ** Generation and unfolding
98 -- ** Generation and unfolding
120 , replicate
99 , replicate
121 , unfoldr
101 , unfoldr
122 , unfoldrN
102 , unfoldrN
@@ -125,11 +105,8 @@ module Data.Text
126 -- ** Breaking strings
106 -- ** Breaking strings
131 , takeWhile
109 , takeWhile
133 , dropWhile
110 , dropWhile
134 , dropWhileEnd
111 , dropWhileEnd
135 , dropAround
112 , dropAround
@@ -137,10 +114,8 @@ module Data.Text
137 , stripStart
114 , stripStart
138 , stripEnd
115 , stripEnd
139 , splitAt
116 , splitAt
145 , groupBy
120 , groupBy
@@ -148,8 +123,10 @@ module Data.Text
149 -- ** Breaking into many substrings
124 -- ** Breaking into many substrings
150 -- $split
125 -- $split
153 , chunksOf
130 , chunksOf
155 -- ** Breaking into lines and words
132 -- ** Breaking into lines and words
@@ -164,309 +141,132 @@ module Data.Text
164 , isSuffixOf
141 , isSuffixOf
165 , isInfixOf
142 , isInfixOf
172 -- * Searching
144 -- * Searching
176 , partition
149 , partition
178 -- , findSubstring
151 -- , findSubstring
180 -- * Indexing
153 -- * Indexing
181 -- $index
154 -- $index
183 , findIndex
156 , findIndex
186− -- * Zipping
159+ -- * Zipping and unzipping
188 , zipWith
161 , zipWith
190 -- -* Ordered text
163 -- -* Ordered text
191 -- , sort
164 -- , sort
193− -- * Low level operations
198−import Prelude (Char, Bool(..), Int, Maybe(..), String,
167+import Prelude (Char, Bool(..), Functor(..), Int, Maybe(..), String,
199− Eq(..), Ord(..), Ordering(..), (++),
168+ Eq(..), Ord(..), (++),
200− Read(..),
169+ Read(..), Show(..),
201− (&&), (||), (+), (-), (.), ($), ($!), (>>),
170+ (&&), (||), (+), (-), (.), ($),
202− not, return, otherwise, quot)
171+ fromIntegral, div, not, return, otherwise)
203−#if defined(HAVE_DEEPSEQ)
204−import Control.DeepSeq (NFData(rnf))
207import Control.Exception (assert)
172import Control.Exception (assert)
209import Data.Char (isSpace)
173import Data.Char (isSpace)
210−import Data.Data (Data(gfoldl, toConstr, gunfold, dataTypeOf), constrIndex,
211− Constr, mkConstr, DataType, mkDataType, Fixity(Prefix))
212−import Control.Monad (foldM)
213import Control.Monad.ST (ST)
174import Control.Monad.ST (ST)
214import qualified Data.Text.Array as A
175import qualified Data.Text.Array as A
215import qualified Data.List as L
176import qualified Data.List as L
216−import Data.Binary (Binary(get, put))
217import Data.Monoid (Monoid(..))
177import Data.Monoid (Monoid(..))
218−#if MIN_VERSION_base(4,9,0)
219−import Data.Semigroup (Semigroup(..))
178+import Data.Word (Word16)
221import Data.String (IsString(..))
179import Data.String (IsString(..))
222−import qualified Data.Text.Internal.Fusion as S
180+import qualified Data.Text.Fusion as S
223−import qualified Data.Text.Internal.Fusion.Common as S
181+import qualified Data.Text.Fusion.Common as S
224−import Data.Text.Encoding (decodeUtf8', encodeUtf8)
225−import Data.Text.Internal.Fusion (stream, reverseStream, unstream)
182+import Data.Text.Fusion (stream, reverseStream, unstream)
226−import Data.Text.Internal.Private (span_)
183+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
184import qualified Prelude as P
230−import Data.Text.Unsafe (Iter(..), iter, iter_, lengthWord16, reverseIter,
185+import Data.Text.Unsafe (iter, iter_, reverseIter, unsafeHead, unsafeTail)
231− reverseIter_, unsafeHead, unsafeTail)
232−import Data.Text.Internal.Unsafe.Char (unsafeChr)
186+import Data.Text.UnsafeChar (unsafeChr)
233−import qualified Data.Text.Internal.Functions as F
187+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)
188+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
190-- $fusion
301-- Most of the functions in this module are subject to /fusion/,
192-- Most of the functions in this module are subject to /fusion/,
302-- meaning that a pipeline of such functions will usually allocate at
193-- meaning that a pipeline of such functions will usually allocate at
303-- most one 'Text' value.
194-- 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
196instance Eq Text where
325− Text arrA offA lenA == Text arrB offB lenB
197+ t1 == t2 = stream t1 == stream t2
326− | lenA == lenB = A.equal arrA offA arrB offB lenA
328 {-# INLINE (==) #-}
198 {-# INLINE (==) #-}
330instance Ord Text where
200instance Ord Text where
331− compare = compareText
201+ compare t1 t2 = compare (stream t1) (stream t2)
202+ {-# INLINE compare #-}
204+instance Show Text where
205+ showsPrec p ps r = showsPrec p (unpack ps) r
333instance Read Text where
207instance Read Text where
334 readsPrec p str = [(pack x,y) | (x,y) <- readsPrec p str]
208 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
210instance Monoid Text where
345 mempty = empty
211 mempty = empty
346−#if MIN_VERSION_base(4,9,0)
347− mappend = (<>) -- future-proof definition
349 mappend = append
212 mappend = append
351 mconcat = concat
213 mconcat = concat
353instance IsString Text where
215instance IsString Text where
354 fromString = pack
216 fromString = pack
356−#if __GLASGOW_HASKELL__ >= 708
357−instance Exts.IsList Text where
358− type Item Text = Char
363−#if defined(HAVE_DEEPSEQ)
364−instance NFData Text where rnf !_ = ()
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.
376−-- We omit reflection services for the sake of data abstraction.
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
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? >
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, ... >
390−instance Data Text where
391− gfoldl f z txt = z pack `f` (unpack txt)
392− toConstr _ = packConstr
393− gunfold k z c = case constrIndex c of
395− _ -> P.error "gunfold"
396− dataTypeOf _ = textDataType
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
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-- -----------------------------------------------------------------------------
218-- -----------------------------------------------------------------------------
425-- * Conversion to/from 'Text'
219-- * Conversion to/from 'Text'
427−-- | /O(n)/ Convert a 'String' into a 'Text'. Subject to
221+-- | /O(n)/ Convert a 'String' into a 'Text'. Subject to fusion.
428−-- fusion. Performs replacement on invalid scalar values.
429pack :: String -> Text
222pack :: String -> Text
430−pack = unstream . S.map safe . S.streamList
223+pack = unstream . S.streamList
431{-# INLINE [1] pack #-}
224{-# INLINE [1] pack #-}
226+-- | /O(n)/ Convert a Text into a String. Subject to fusion.
227+unpack :: Text -> String
228+unpack = S.unstreamList . stream
229+{-# INLINE [1] unpack #-}
231+-- | /O(1)/ Convert a character into a Text.
232+-- Subject to fusion.
233+singleton :: Char -> Text
234+singleton = unstream . S.singleton
235+{-# INLINE [1] singleton #-}
433-- -----------------------------------------------------------------------------
237-- -----------------------------------------------------------------------------
434-- * Basic functions
238-- * Basic functions
436-- | /O(n)/ Adds a character to the front of a 'Text'. This function
240-- | /O(n)/ Adds a character to the front of a 'Text'. This function
437-- is more costly than its 'List' counterpart because it requires
241-- is more costly than its 'List' counterpart because it requires
438−-- copying a new array. Subject to fusion. Performs replacement on
242+-- copying a new array. Subject to fusion.
439−-- invalid scalar values.
440cons :: Char -> Text -> Text
243cons :: Char -> Text -> Text
441−cons c t = unstream (S.cons (safe c) (stream t))
244+cons c t = unstream (S.cons c (stream t))
442{-# INLINE cons #-}
245{-# INLINE cons #-}
446-- | /O(n)/ Adds a character to the end of a 'Text'. This copies the
247-- | /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.
248-- entire array in the process, unless fused. Subject to fusion.
448−-- Performs replacement on invalid scalar values.
449snoc :: Text -> Char -> Text
249snoc :: Text -> Char -> Text
450−snoc t c = unstream (S.snoc (stream t) (safe c))
250+snoc t c = unstream (S.snoc (stream t) c)
451{-# INLINE snoc #-}
251{-# INLINE snoc #-}
453-- | /O(n)/ Appends one 'Text' to the other by copying both of them
253-- | /O(n)/ Appends one 'Text' to the other by copying both of them
454-- into a new 'Text'. Subject to fusion.
254-- into a new 'Text'. Subject to fusion.
455append :: Text -> Text -> Text
255append :: Text -> Text -> Text
456−append a@(Text arr1 off1 len1) b@(Text arr2 off2 len2)
256+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
258 len = len1+len2
463− x :: ST s (A.MArray s)
465− arr <- A.new len
260+ arr <- A.unsafeNew len :: ST s (A.MArray s Word16)
466− A.copyI arr 0 arr1 off1 len1
261+ copy arr1 off1 (len1+off1) arr 0
467− A.copyI arr len1 arr2 off2 len
262+ copy arr2 off2 (len2+off2) arr len1
468 return arr
263 return arr
265+ copy arr i top arr' j
266+ | i >= top = return ()
267+ | otherwise = do A.unsafeWrite arr' j (arr `A.unsafeIndex` i)
268+ copy arr (i+1) top arr' (j+1)
469−{-# NOINLINE append #-}
269+{-# INLINE append #-}
472"TEXT append -> fused" [~1] forall t1 t2.
272"TEXT append -> fused" [~1] forall t1 t2.
@@ -486,14 +286,21 @@ head t = S.head (stream t)
486uncons :: Text -> Maybe (Char, Text)
286uncons :: Text -> Maybe (Char, Text)
487uncons t@(Text arr off len)
287uncons t@(Text arr off len)
488 | len <= 0 = Nothing
288 | len <= 0 = Nothing
489− | otherwise = Just $ let !(Iter c d) = iter t 0
490− in (c, text arr (off+d) (len-d))
289+ | otherwise = Just (c, textP arr (off+d) (len-d))
290+ where (c,d) = iter t 0
491{-# INLINE [1] uncons #-}
291{-# INLINE [1] uncons #-}
493-- | Lifted from Control.Arrow and specialized.
293-- | Lifted from Control.Arrow and specialized.
494second :: (b -> c) -> (a,b) -> (a,c)
294second :: (b -> c) -> (a,b) -> (a,c)
495second f (a, b) = (a, f b)
295second f (a, b) = (a, f b)
298+"TEXT uncons -> fused" [~1] forall t.
299+ uncons t = fmap (second unstream) (S.uncons (stream t))
300+"TEXT uncons -> unfused" [1] forall t.
301+ fmap (second unstream) (S.uncons (stream t)) = uncons t
497-- | /O(1)/ Returns the last character of a 'Text', which must be
304-- | /O(1)/ Returns the last character of a 'Text', which must be
498-- non-empty. Subject to fusion.
305-- non-empty. Subject to fusion.
499last :: Text -> Char
306last :: Text -> Char
@@ -517,7 +324,7 @@ last (Text arr off len)
517tail :: Text -> Text
324tail :: Text -> Text
518tail t@(Text arr off len)
325tail t@(Text arr off len)
519 | len <= 0 = emptyError "tail"
326 | len <= 0 = emptyError "tail"
520− | otherwise = text arr (off+d) (len-d)
327+ | otherwise = textP arr (off+d) (len-d)
521 where d = iter_ t 0
328 where d = iter_ t 0
522{-# INLINE [1] tail #-}
329{-# INLINE [1] tail #-}
@@ -532,8 +339,8 @@ tail t@(Text arr off len)
532-- be non-empty. Subject to fusion.
339-- be non-empty. Subject to fusion.
533init :: Text -> Text
340init :: Text -> Text
534init (Text arr off len) | len <= 0 = emptyError "init"
341init (Text arr off len) | len <= 0 = emptyError "init"
535− | n >= 0xDC00 && n <= 0xDFFF = text arr off (len-2)
342+ | n >= 0xDC00 && n <= 0xDFFF = textP arr off (len-2)
536− | otherwise = text arr off (len-1)
343+ | otherwise = textP arr off (len-1)
538 n = A.unsafeIndex arr (off+len-1)
345 n = A.unsafeIndex arr (off+len-1)
539{-# INLINE [1] init #-}
346{-# INLINE [1] init #-}
@@ -548,11 +355,7 @@ init (Text arr off len) | len <= 0 = emptyError "init"
548-- | /O(1)/ Tests whether a 'Text' is empty or not. Subject to
355-- | /O(1)/ Tests whether a 'Text' is empty or not. Subject to
549-- fusion.
356-- fusion.
550null :: Text -> Bool
357null :: Text -> Bool
551−null (Text _arr _off len) =
358+null (Text _arr _off len) = assert (len >= 0) $ len <= 0
556{-# INLINE [1] null #-}
359{-# INLINE [1] null #-}
@@ -572,76 +375,27 @@ isSingleton = S.isSingleton . stream
572-- Subject to fusion.
375-- Subject to fusion.
573length :: Text -> Int
376length :: Text -> Int
574length t = S.length (stream t)
377length t = S.length (stream t)
575−{-# INLINE [0] length #-}
378+{-# 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-- -----------------------------------------------------------------------------
380-- -----------------------------------------------------------------------------
625-- * Transformations
381-- * Transformations
626-- | /O(n)/ 'map' @f@ @t@ is the 'Text' obtained by applying @f@ to
382-- | /O(n)/ 'map' @f@ @t@ is the 'Text' obtained by applying @f@ to
627−-- each element of @t@. Subject to fusion. Performs replacement on
383+-- each element of @t@. Subject to fusion.
628−-- invalid scalar values.
629map :: (Char -> Char) -> Text -> Text
384map :: (Char -> Char) -> Text -> Text
630−map f t = unstream (S.map (safe . f) (stream t))
385+map f t = unstream (S.map f (stream t))
631{-# INLINE [1] map #-}
386{-# INLINE [1] map #-}
633-- | /O(n)/ The 'intercalate' function takes a 'Text' and a list of
388-- | /O(n)/ The 'intercalate' function takes a 'Text' and a list of
634-- 'Text's and concatenates the list after interspersing the first
389-- 'Text's and concatenates the list after interspersing the first
635-- argument between each element of the list.
390-- argument between each element of the list.
636intercalate :: Text -> [Text] -> Text
391intercalate :: Text -> [Text] -> Text
637−intercalate t = concat . (F.intersperse t)
392+intercalate t ts = unstream (S.intercalate (stream t) (L.map stream ts))
638{-# INLINE intercalate #-}
393{-# INLINE intercalate #-}
640-- | /O(n)/ The 'intersperse' function takes a character and places it
395-- | /O(n)/ The 'intersperse' function takes a character and places it
641−-- between the characters of a 'Text'. Subject to fusion. Performs
396+-- between the characters of a 'Text'. Subject to fusion.
642−-- replacement on invalid scalar values.
643intersperse :: Char -> Text -> Text
397intersperse :: Char -> Text -> Text
644−intersperse c t = unstream (S.intersperse (safe c) (stream t))
398+intersperse c t = unstream (S.intersperse c (stream t))
645{-# INLINE intersperse #-}
399{-# INLINE intersperse #-}
647-- | /O(n)/ Reverse the characters of a string. Subject to fusion.
401-- | /O(n)/ Reverse the characters of a string. Subject to fusion.
@@ -649,59 +403,13 @@ reverse :: Text -> Text
649reverse t = S.reverse (stream t)
403reverse t = S.reverse (stream t)
650{-# INLINE reverse #-}
404{-# INLINE reverse #-}
652−-- | /O(m+n)/ Replace every non-overlapping occurrence of @needle@ in
406+-- | /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
407+replace :: Text -- ^ Text to search for
676− -- ^ @needle@ to search for. If this string is empty, an
408+ -> Text -- ^ Replacement text
677− -- error will occur.
678− -> Text
409+ -> Text -- ^ Input text
679− -- ^ @replacement@ to replace @needle@ with.
681− -- ^ @haystack@ in which to search.
411+replace s d = intercalate d . split s
682− -> Text
412+{-# INLINE replace #-}
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
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-- ----------------------------------------------------------------------------
414-- ----------------------------------------------------------------------------
707-- ** Case conversions (folds)
415-- ** Case conversions (folds)
@@ -716,17 +424,10 @@ replace needle@(Text _ _ neeLen)
716-- case conversion rules. As a result, these functions may map one
424-- case conversion rules. As a result, these functions may map one
717-- input character to two or three output characters. For examples,
425-- input character to two or three output characters. For examples,
718-- see the documentation of each function.
426-- 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.
428+-- | /O(n)/ Convert a string to folded case. This function is mainly
728−-- This function is mainly useful for performing caseless (also known
429+-- useful for performing caseless (also known as case insensitive)
729−-- as case insensitive) string comparisons.
430+-- string comparisons.
731-- A string @x@ is a caseless match for a string @y@ if and only if:
432-- A string @x@ is a caseless match for a string @y@ if and only if:
@@ -741,56 +442,27 @@ replace needle@(Text _ _ neeLen)
741-- instead of itself.
442-- instead of itself.
742toCaseFold :: Text -> Text
443toCaseFold :: Text -> Text
743toCaseFold t = unstream (S.toCaseFold (stream t))
444toCaseFold t = unstream (S.toCaseFold (stream t))
744−{-# INLINE toCaseFold #-}
445+{-# INLINE [0] toCaseFold #-}
746-- | /O(n)/ Convert a string to lower case, using simple case
447-- | /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
448+-- conversion. The result string may be longer than the input string.
750−-- instance, \"İ\" (Latin capital letter I with dot above,
449+-- For instance, \"İ\" (Latin capital letter I with dot above,
751−-- U+0130) maps to the sequence \"i\" (Latin small letter i, U+0069)
450+-- U+0130) maps to the sequence \"i\" (Latin small letter i, U+0069) followed
752−-- followed by \" ̇\" (combining dot above, U+0307).
451+-- by \" ̇\" (combining dot above, U+0307).
753toLower :: Text -> Text
452toLower :: Text -> Text
754toLower t = unstream (S.toLower (stream t))
453toLower t = unstream (S.toLower (stream t))
755{-# INLINE toLower #-}
454{-# INLINE toLower #-}
757-- | /O(n)/ Convert a string to upper case, using simple case
456-- | /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
457+-- conversion. The result string may be longer than the input string.
761−-- instance, the German \"ß\" (eszett, U+00DF) maps to the
458+-- For instance, the German \"ß\" (eszett, U+00DF) maps to the
762-- two-letter sequence \"SS\".
459-- two-letter sequence \"SS\".
763toUpper :: Text -> Text
460toUpper :: Text -> Text
764toUpper t = unstream (S.toUpper (stream t))
461toUpper t = unstream (S.toUpper (stream t))
765{-# INLINE toUpper #-}
462{-# 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
464-- | /O(n)/ Left-justify a string to the given length, using the
790−-- specified fill character on the right. Subject to fusion.
465+-- specified fill character on the right. Subject to fusion. Examples:
791−-- Performs replacement on invalid scalar values.
795-- > justifyLeft 7 'x' "foo" == "fooxxxx"
467-- > justifyLeft 7 'x' "foo" == "fooxxxx"
796-- > justifyLeft 3 'x' "foobar" == "foobar"
468-- > justifyLeft 3 'x' "foobar" == "foobar"
@@ -809,10 +481,7 @@ justifyLeft k c t
811-- | /O(n)/ Right-justify a string to the given length, using the
483-- | /O(n)/ Right-justify a string to the given length, using the
812−-- specified fill character on the left. Performs replacement on
484+-- specified fill character on the left. Examples:
813−-- invalid scalar values.
817-- > justifyRight 7 'x' "bar" == "xxxxbar"
486-- > justifyRight 7 'x' "bar" == "xxxxbar"
818-- > justifyRight 3 'x' "foobar" == "foobar"
487-- > justifyRight 3 'x' "foobar" == "foobar"
@@ -823,11 +492,8 @@ justifyRight k c t
823 where len = length t
492 where len = length t
824{-# INLINE justifyRight #-}
493{-# INLINE justifyRight #-}
826−-- | /O(n)/ Center a string to the given length, using the specified
495+-- | /O(n)/ Center a string to the given length, using the
827−-- fill character on either side. Performs replacement on invalid
496+-- specified fill character on either side. Examples:
832-- > center 8 'x' "HS" = "xxxHSxxx"
498-- > center 8 'x' "HS" = "xxxHSxxx"
833center :: Int -> Char -> Text -> Text
499center :: Int -> Char -> Text -> Text
@@ -836,7 +502,7 @@ center k c t
836 | otherwise = replicateChar l c `append` t `append` replicateChar r c
502 | otherwise = replicateChar l c `append` t `append` replicateChar r c
837 where len = length t
503 where len = length t
838 d = k - len
504 d = k - len
839− r = d `quot` 2
505+ r = d `div` 2
840 l = d - r
506 l = d - r
841{-# INLINE center #-}
507{-# INLINE center #-}
@@ -854,12 +520,12 @@ transpose ts = P.map pack (L.transpose (P.map unpack ts))
854-- (typically the left-identity of the operator), and a 'Text',
520-- (typically the left-identity of the operator), and a 'Text',
855-- reduces the 'Text' using the binary operator, from left to right.
521-- reduces the 'Text' using the binary operator, from left to right.
856-- Subject to fusion.
522-- Subject to fusion.
857−foldl :: (a -> Char -> a) -> a -> Text -> a
523+foldl :: (b -> Char -> b) -> b -> Text -> b
858foldl f z t = S.foldl f z (stream t)
524foldl f z t = S.foldl f z (stream t)
859{-# INLINE foldl #-}
525{-# INLINE foldl #-}
861-- | /O(n)/ A strict version of 'foldl'. Subject to fusion.
527-- | /O(n)/ A strict version of 'foldl'. Subject to fusion.
862−foldl' :: (a -> Char -> a) -> a -> Text -> a
528+foldl' :: (b -> Char -> b) -> b -> Text -> b
863foldl' f z t = S.foldl' f z (stream t)
529foldl' f z t = S.foldl' f z (stream t)
864{-# INLINE foldl' #-}
530{-# INLINE foldl' #-}
@@ -878,12 +544,12 @@ foldl1' f t = S.foldl1' f (stream t)
878-- (typically the right-identity of the operator), and a 'Text',
544-- (typically the right-identity of the operator), and a 'Text',
879-- reduces the 'Text' using the binary operator, from right to left.
545-- reduces the 'Text' using the binary operator, from right to left.
880-- Subject to fusion.
546-- Subject to fusion.
881−foldr :: (Char -> a -> a) -> a -> Text -> a
547+foldr :: (Char -> b -> b) -> b -> Text -> b
882foldr f z t = S.foldr f z (stream t)
548foldr f z t = S.foldr f z (stream t)
883{-# INLINE foldr #-}
549{-# INLINE foldr #-}
885-- | /O(n)/ A variant of 'foldr' that has no starting value argument,
551-- | /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
552+-- and thust must be applied to a non-empty 'Text'. Subject to
887-- fusion.
553-- fusion.
888foldr1 :: (Char -> Char -> Char) -> Text -> Char
554foldr1 :: (Char -> Char -> Char) -> Text -> Char
889foldr1 f t = S.foldr1 f (stream t)
555foldr1 f t = S.foldr1 f (stream t)
@@ -892,36 +558,28 @@ foldr1 f t = S.foldr1 f (stream t)
892-- -----------------------------------------------------------------------------
558-- -----------------------------------------------------------------------------
893-- ** Special folds
559-- ** Special folds
895−-- | /O(n)/ Concatenate a list of 'Text's.
561+-- | /O(n)/ Concatenate a list of 'Text's. Subject to fusion.
896concat :: [Text] -> Text
562concat :: [Text] -> Text
897−concat ts = case ts' of
563+concat ts = unstream (S.concat (L.map stream ts))
898− [] -> empty
564+{-# INLINE concat #-}
900− _ -> Text (A.run go) 0 len
902− ts' = L.filter (not . null) ts
903− len = sumP "concat" $ L.map lengthWord16 ts'
904− go :: ST s (A.MArray s)
907− let step i (Text a o l) =
908− let !j = i + l in A.copyI arr i a o j >> return j
909− foldM step 0 ts' >> return arr
911-- | /O(n)/ Map a function over a 'Text' that results in a 'Text', and
566-- | /O(n)/ Map a function over a 'Text' that results in a 'Text', and
912−-- concatenate the results.
567+-- concatenate the results. Subject to fusion.
569+-- Note: if in 'concatMap' @f@ @t@, @f@ is defined in terms of fusible
570+-- functions, it will also be fusible.
913concatMap :: (Char -> Text) -> Text -> Text
571concatMap :: (Char -> Text) -> Text -> Text
914−concatMap f = concat . foldr ((:) . f) []
572+concatMap f t = unstream (S.concatMap (stream . f) (stream t))
915{-# INLINE concatMap #-}
573{-# INLINE concatMap #-}
917-- | /O(n)/ 'any' @p@ @t@ determines whether any character in the
575-- | /O(n)/ 'any' @p@ @t@ determines whether any character in the
918−-- 'Text' @t@ satisfies the predicate @p@. Subject to fusion.
576+-- 'Text' @t@ satisifes the predicate @p@. Subject to fusion.
919any :: (Char -> Bool) -> Text -> Bool
577any :: (Char -> Bool) -> Text -> Bool
920any p t = S.any p (stream t)
578any p t = S.any p (stream t)
921{-# INLINE any #-}
579{-# INLINE any #-}
923-- | /O(n)/ 'all' @p@ @t@ determines whether all characters in the
581-- | /O(n)/ 'all' @p@ @t@ determines whether all characters in the
924−-- 'Text' @t@ satisfy the predicate @p@. Subject to fusion.
582+-- 'Text' @t@ satisify the predicate @p@. Subject to fusion.
925all :: (Char -> Bool) -> Text -> Bool
583all :: (Char -> Bool) -> Text -> Bool
926all p t = S.all p (stream t)
584all p t = S.all p (stream t)
927{-# INLINE all #-}
585{-# INLINE all #-}
@@ -943,7 +601,6 @@ minimum t = S.minimum (stream t)
944-- | /O(n)/ 'scanl' is similar to 'foldl', but returns a list of
602-- | /O(n)/ 'scanl' is similar to 'foldl', but returns a list of
945-- successive reduced values from the left. Subject to fusion.
603-- 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, ...]
605-- > scanl f z [x1, x2, ...] == [z, z `f` x1, (z `f` x1) `f` x2, ...]
@@ -951,13 +608,11 @@ minimum t = S.minimum (stream t)
952-- > last (scanl f z xs) == foldl f z xs.
609-- > last (scanl f z xs) == foldl f z xs.
953scanl :: (Char -> Char -> Char) -> Char -> Text -> Text
610scanl :: (Char -> Char -> Char) -> Char -> Text -> Text
954−scanl f z t = unstream (S.scanl g z (stream t))
611+scanl f z t = unstream (S.scanl f z (stream t))
955− where g a b = safe (f a b)
956{-# INLINE scanl #-}
612{-# INLINE scanl #-}
958-- | /O(n)/ 'scanl1' is a variant of 'scanl' that has no starting
614-- | /O(n)/ 'scanl1' is a variant of 'scanl' that has no starting
959−-- value argument. Subject to fusion. Performs replacement on
615+-- value argument. Subject to fusion.
960−-- invalid scalar values.
962-- > scanl1 f [x1, x2, ...] == [x1, x1 `f` x2, ...]
617-- > scanl1 f [x1, x2, ...] == [x1, x1 `f` x2, ...]
963scanl1 :: (Char -> Char -> Char) -> Text -> Text
618scanl1 :: (Char -> Char -> Char) -> Text -> Text
@@ -965,63 +620,48 @@ scanl1 f t | null t = empty
965 | otherwise = scanl f (unsafeHead t) (unsafeTail t)
620 | otherwise = scanl f (unsafeHead t) (unsafeTail t)
966{-# INLINE scanl1 #-}
621{-# INLINE scanl1 #-}
968−-- | /O(n)/ 'scanr' is the right-to-left dual of 'scanl'. Performs
623+-- | /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
625-- > scanr f v == reverse . scanl (flip f) v . reverse
972scanr :: (Char -> Char -> Char) -> Char -> Text -> Text
626scanr :: (Char -> Char -> Char) -> Char -> Text -> Text
973−scanr f z = S.reverse . S.reverseScanr g z . reverseStream
627+scanr f z = S.reverse . S.reverseScanr f z . reverseStream
974− where g a b = safe (f a b)
975{-# INLINE scanr #-}
628{-# INLINE scanr #-}
977-- | /O(n)/ 'scanr1' is a variant of 'scanr' that has no starting
630-- | /O(n)/ 'scanr1' is a variant of 'scanr' that has no starting
978−-- value argument. Subject to fusion. Performs replacement on
631+-- value argument. Subject to fusion.
979−-- invalid scalar values.
980scanr1 :: (Char -> Char -> Char) -> Text -> Text
632scanr1 :: (Char -> Char -> Char) -> Text -> Text
981scanr1 f t | null t = empty
633scanr1 f t | null t = empty
982 | otherwise = scanr f (last t) (init t)
634 | otherwise = scanr f (last t) (init t)
983{-# INLINE scanr1 #-}
635{-# INLINE scanr1 #-}
985−-- | /O(n)/ Like a combination of 'map' and 'foldl''. Applies a
637+-- | /O(n)/ Like a combination of 'map' and 'foldl'. Applies a
986-- function to each element of a 'Text', passing an accumulating
638-- function to each element of a 'Text', passing an accumulating
987−-- parameter from left to right, and returns a final 'Text'. Performs
639+-- 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)
640mapAccumL :: (a -> Char -> (a,Char)) -> a -> Text -> (a, Text)
990−mapAccumL f z0 = S.mapAccumL g z0 . stream
641+mapAccumL f s t = case uncons t of
991− where g a b = second safe (f a b)
642+ Nothing -> (s, empty)
643+ Just (x, xs) -> (s'', cons y ys)
644+ where (s', y ) = f s x
992−{-# INLINE mapAccumL #-}
645+ (s'',ys) = mapAccumL f s' xs
994-- | The 'mapAccumR' function behaves like a combination of 'map' and
647-- | The 'mapAccumR' function behaves like a combination of 'map' and
995−-- a strict 'foldr'; it applies a function to each element of a
648+-- 'foldr'; it applies a function to each element of a 'Text', passing
996−-- 'Text', passing an accumulating parameter from right to left, and
649+-- an accumulating parameter from right to left, and returning a final
997−-- returning a final value of this accumulator together with the new
650+-- 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)
651mapAccumR :: (a -> Char -> (a,Char)) -> a -> Text -> (a, Text)
1001−mapAccumR f z0 = second reverse . S.mapAccumL g z0 . reverseStream
652+mapAccumR f s t = case uncons t of
1002− where g a b = second safe (f a b)
653+ Nothing -> (s, empty)
654+ Just (x, xs) -> (s'', cons y ys)
655+ where (s'',y ) = f s' x
1003−{-# INLINE mapAccumR #-}
656+ (s', ys) = mapAccumR f s xs
1005-- -----------------------------------------------------------------------------
658-- -----------------------------------------------------------------------------
1006-- ** Generating and unfolding 'Text's
659-- ** Generating and unfolding 'Text's
1008-- | /O(n*m)/ 'replicate' @n@ @t@ is a 'Text' consisting of the input
661-- | /O(n*m)/ 'replicate' @n@ @t@ is a 'Text' consisting of the input
1009−-- @t@ repeated @n@ times.
662+-- @t@ repeated @n@ times. Subject to fusion.
1010replicate :: Int -> Text -> Text
663replicate :: Int -> Text -> Text
1011−replicate n t@(Text a o l)
664+replicate n t = unstream (S.replicateI (fromIntegral n) (S.stream t))
1012− | n <= 0 || l <= 0 = empty
1014− | isSingleton t = replicateChar n (unsafeHead t)
1015− | otherwise = Text (A.run x) 0 len
1018− x :: ST s (A.MArray s)
1021− let loop !d !i | i >= n = return arr
1022− | otherwise = let m = d + l
1023− in A.copyI arr d a o m >> loop m (i+1)
1025{-# INLINE [1] replicate #-}
665{-# INLINE [1] replicate #-}
1027{-# RULES
667{-# RULES
@@ -1032,8 +672,7 @@ replicate n t@(Text a o l)
1032-- | /O(n)/ 'replicateChar' @n@ @c@ is a 'Text' of length @n@ with @c@ the
672-- | /O(n)/ 'replicateChar' @n@ @c@ is a 'Text' of length @n@ with @c@ the
1033-- value of every element. Subject to fusion.
673-- value of every element. Subject to fusion.
1034replicateChar :: Int -> Char -> Text
674replicateChar :: Int -> Char -> Text
1035−replicateChar n c = unstream (S.replicateCharI n (safe c))
675+replicateChar n c = unstream (S.replicateCharI n c)
1036−{-# INLINE replicateChar #-}
1038-- | /O(n)/, where @n@ is the length of the result. The 'unfoldr'
677-- | /O(n)/, where @n@ is the length of the result. The 'unfoldr'
1039-- function is analogous to the List 'L.unfoldr'. 'unfoldr' builds a
678-- function is analogous to the List 'L.unfoldr'. 'unfoldr' builds a
@@ -1041,9 +680,9 @@ replicateChar n c = unstream (S.replicateCharI n (safe c))
1041-- returns 'Nothing' if it is done producing the 'Text', otherwise
680-- returns 'Nothing' if it is done producing the 'Text', otherwise
1042-- 'Just' @(a,b)@. In this case, @a@ is the next 'Char' in the
681-- '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
682-- string, and @b@ is the seed value for further production. Subject
1044−-- to fusion. Performs replacement on invalid scalar values.
683+-- to fusion.
1045unfoldr :: (a -> Maybe (Char,a)) -> a -> Text
684unfoldr :: (a -> Maybe (Char,a)) -> a -> Text
1046−unfoldr f s = unstream (S.unfoldr (firstf safe . f) s)
685+unfoldr f s = unstream (S.unfoldr f s)
1047{-# INLINE unfoldr #-}
686{-# INLINE unfoldr #-}
1049-- | /O(n)/ Like 'unfoldr', 'unfoldrN' builds a 'Text' from a seed
688-- | /O(n)/ Like 'unfoldr', 'unfoldrN' builds a 'Text' from a seed
@@ -1051,9 +690,9 @@ unfoldr f s = unstream (S.unfoldr (firstf safe . f) s)
1051-- first argument to 'unfoldrN'. This function is more efficient than
690-- first argument to 'unfoldrN'. This function is more efficient than
1052-- 'unfoldr' when the maximum length of the result is known and
691-- 'unfoldr' when the maximum length of the result is known and
1053-- correct, otherwise its performance is similar to 'unfoldr'. Subject
692-- correct, otherwise its performance is similar to 'unfoldr'. Subject
1054−-- to fusion. Performs replacement on invalid scalar values.
693+-- to fusion.
1055unfoldrN :: Int -> (a -> Maybe (Char,a)) -> a -> Text
694unfoldrN :: Int -> (a -> Maybe (Char,a)) -> a -> Text
1056−unfoldrN n f s = unstream (S.unfoldrN n (firstf safe . f) s)
695+unfoldrN n f s = unstream (S.unfoldrN n f s)
1057{-# INLINE unfoldrN #-}
696{-# INLINE unfoldrN #-}
1059-- -----------------------------------------------------------------------------
698-- -----------------------------------------------------------------------------
@@ -1066,16 +705,14 @@ take :: Int -> Text -> Text
1066take n t@(Text arr off len)
705take n t@(Text arr off len)
1067 | n <= 0 = empty
706 | n <= 0 = empty
1068 | n >= len = t
707 | n >= len = t
1069− | otherwise = text arr off (iterN n t)
708+ | otherwise = Text arr off (loop 0 0)
711+ | i >= len || cnt >= n = i
712+ | otherwise = loop (i+d) (cnt+1)
1070{-# INLINE [1] take #-}
714{-# 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
716{-# RULES
1080"TEXT take -> fused" [~1] forall n t.
717"TEXT take -> fused" [~1] forall n t.
1081 take n t = unstream (S.take n (stream t))
718 take n t = unstream (S.take n (stream t))
@@ -1083,36 +720,18 @@ iterN n t@(Text _arr _off len) = loop 0 0
1083 unstream (S.take n (stream t)) = take n t
720 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
723-- | /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@
724+-- 'Text' of length @n@, or the empty 'Text' if @n@ is greater than the
1109−-- is greater than the length of the 'Text'. Subject to fusion.
725+-- length of the 'Text'. Subject to fusion.
1110drop :: Int -> Text -> Text
726drop :: Int -> Text -> Text
1111drop n t@(Text arr off len)
727drop n t@(Text arr off len)
1112 | n <= 0 = t
728 | n <= 0 = t
1113 | n >= len = empty
729 | n >= len = empty
1114− | otherwise = text arr (off+i) (len-i)
730+ | otherwise = loop 0 0
1115− where i = iterN n t
731+ where loop !i !cnt
732+ | i >= len || cnt >= n = Text arr (off+i) (len-i)
733+ | otherwise = loop (i+d) (cnt+1)
1116{-# INLINE [1] drop #-}
735{-# INLINE [1] drop #-}
1118{-# RULES
737{-# RULES
@@ -1122,18 +741,6 @@ drop n t@(Text arr off len)
1122 unstream (S.drop n (stream t)) = drop n t
741 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',
744-- | /O(n)/ 'takeWhile', applied to a predicate @p@ and a 'Text',
1138-- returns the longest prefix (possibly empty) of elements that
745-- returns the longest prefix (possibly empty) of elements that
1139-- satisfy @p@. Subject to fusion.
746-- satisfy @p@. Subject to fusion.
@@ -1141,8 +748,8 @@ takeWhile :: (Char -> Bool) -> Text -> Text
1141takeWhile p t@(Text arr off len) = loop 0
748takeWhile p t@(Text arr off len) = loop 0
1142 where loop !i | i >= len = t
749 where loop !i | i >= len = t
1143 | p c = loop (i+d)
750 | p c = loop (i+d)
1144− | otherwise = text arr off i
751+ | otherwise = textP arr off i
1145− where Iter c d = iter t i
752+ where (c,d) = iter t i
1146{-# INLINE [1] takeWhile #-}
753{-# INLINE [1] takeWhile #-}
1148{-# RULES
755{-# RULES
@@ -1152,27 +759,6 @@ takeWhile p t@(Text arr off len) = loop 0
1152 unstream (S.takeWhile p (stream t)) = takeWhile p t
759 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
762-- | /O(n)/ 'dropWhile' @p@ @t@ returns the suffix remaining after
1177-- 'takeWhile' @p@ @t@. Subject to fusion.
763-- 'takeWhile' @p@ @t@. Subject to fusion.
1178dropWhile :: (Char -> Bool) -> Text -> Text
764dropWhile :: (Char -> Bool) -> Text -> Text
@@ -1180,7 +766,7 @@ dropWhile p t@(Text arr off len) = loop 0 0
1180 where loop !i !l | l >= len = empty
766 where loop !i !l | l >= len = empty
1181 | p c = loop (i+d) (l+d)
767 | p c = loop (i+d) (l+d)
1182 | otherwise = Text arr (off+i) (len-l)
768 | otherwise = Text arr (off+i) (len-l)
1183− where Iter c d = iter t i
769+ where (c,d) = iter t i
1184{-# INLINE [1] dropWhile #-}
770{-# INLINE [1] dropWhile #-}
1186{-# RULES
772{-# RULES
@@ -1191,9 +777,8 @@ dropWhile p t@(Text arr off len) = loop 0 0
1193-- | /O(n)/ 'dropWhileEnd' @p@ @t@ returns the prefix remaining after
779-- | /O(n)/ 'dropWhileEnd' @p@ @t@ returns the prefix remaining after
1194−-- dropping characters that satisfy the predicate @p@ from the end of
780+-- dropping characters that fail the predicate @p@ from the end of
1195-- @t@. Subject to fusion.
781-- @t@. Subject to fusion.
1197-- Examples:
782-- Examples:
1199-- > dropWhileEnd (=='.') "foo..." == "foo"
784-- > dropWhileEnd (=='.') "foo..." == "foo"
@@ -1213,7 +798,7 @@ dropWhileEnd p t@(Text arr off len) = loop (len-1) len
1215-- | /O(n)/ 'dropAround' @p@ @t@ returns the substring remaining after
800-- | /O(n)/ 'dropAround' @p@ @t@ returns the substring remaining after
1216−-- dropping characters that satisfy the predicate @p@ from both the
801+-- dropping characters that fail the predicate @p@ from both the
1217-- beginning and end of @t@. Subject to fusion.
802-- beginning and end of @t@. Subject to fusion.
1218dropAround :: (Char -> Bool) -> Text -> Text
803dropAround :: (Char -> Bool) -> Text -> Text
1219dropAround p = dropWhile p . dropWhileEnd p
804dropAround p = dropWhile p . dropWhileEnd p
@@ -1248,20 +833,28 @@ splitAt :: Int -> Text -> (Text, Text)
1248splitAt n t@(Text arr off len)
833splitAt n t@(Text arr off len)
1249 | n <= 0 = (empty, t)
834 | n <= 0 = (empty, t)
1250 | n >= len = (t, empty)
835 | n >= len = (t, empty)
1251− | otherwise = let k = iterN n t
836+ | otherwise = (Text arr off k, Text arr (off+k) (len-k))
1252− in (text arr off k, text arr (off+k) (len-k))
837+ where k = loop 0 0
839+ | i >= len || cnt >= n = i
840+ | otherwise = loop (i+d) (cnt+1)
842+{-# INLINE splitAt #-}
1254−-- | /O(n)/ 'span', applied to a predicate @p@ and text @t@, returns
844+-- | /O(n)/ 'span', applied to a predicate @p@ and text @t@, returns a
1255−-- a pair whose first element is the longest prefix (possibly empty)
845+-- pair whose first element is the longest prefix (possibly empty) of
1256−-- of @t@ of elements that satisfy @p@, and whose second is the
846+-- @t@ of elements that satisfy @p@, and whose second is the remainder
1257−-- remainder of the list.
847+-- of the list.
1258span :: (Char -> Bool) -> Text -> (Text, Text)
848span :: (Char -> Bool) -> Text -> (Text, Text)
1259−span p t = case span_ p t of
849+span p t@(Text arr off len) = (textP arr off k, textP arr (off+k) (len-k))
1260− (# hd,tl #) -> (hd,tl)
850+ where k = loop 0
851+ loop !i | i >= len || not (p c) = i
852+ | otherwise = loop (i+d)
853+ where (c,d) = iter t i
1261{-# INLINE span #-}
854{-# INLINE span #-}
1263−-- | /O(n)/ 'break' is like 'span', but the prefix returned is
856+-- | /O(n)/ 'break' is like 'span', but the prefix returned is over
1264−-- over elements that fail the predicate @p@.
857+-- elements that fail the predicate @p@.
1265break :: (Char -> Bool) -> Text -> (Text, Text)
858break :: (Char -> Bool) -> Text -> (Text, Text)
1266break p = span (not . p)
859break p = span (not . p)
1267{-# INLINE break #-}
860{-# INLINE break #-}
@@ -1273,7 +866,7 @@ groupBy p = loop
1273 loop t@(Text arr off len)
866 loop t@(Text arr off len)
1274 | null t = []
867 | null t = []
1275 | otherwise = text arr off n : loop (text arr (off+n) (len-n))
868 | otherwise = text arr off n : loop (text arr (off+n) (len-n))
1276− where Iter c d = iter t 0
869+ where (c,d) = iter t 0
1277 n = d + findAIndexOrEnd (not . p c) (Text arr (off+d) (len-d))
870 n = d + findAIndexOrEnd (not . p c) (Text arr (off+d) (len-d))
1279-- | Returns the /array/ index (in units of 'Word16') at which a
872-- | Returns the /array/ index (in units of 'Word16') at which a
@@ -1283,8 +876,8 @@ findAIndexOrEnd :: (Char -> Bool) -> Text -> Int
1283findAIndexOrEnd q t@(Text _arr _off len) = go 0
876findAIndexOrEnd q t@(Text _arr _off len) = go 0
1284 where go !i | i >= len || q c = i
877 where go !i | i >= len || q c = i
1285 | otherwise = go (i+d)
878 | otherwise = go (i+d)
1286− where Iter c d = iter t i
879+ where (c,d) = iter t i
1288-- | /O(n)/ Group characters in a string by equality.
881-- | /O(n)/ Group characters in a string by equality.
1289group :: Text -> [Text]
882group :: Text -> [Text]
1290group = groupBy (==)
883group = groupBy (==)
@@ -1308,59 +901,104 @@ tails t | null t = [empty]
1308-- copies to create substrings; they just construct new 'Text's that
901-- copies to create substrings; they just construct new 'Text's that
1309-- are slices of the original.
902-- are slices of the original.
1311−-- | /O(m+n)/ Break a 'Text' into pieces separated by the first 'Text'
904+-- | /O(m+n)/ Break a 'Text' into pieces separated by the first
1312−-- argument (which cannot be empty), consuming the delimiter. An empty
905+-- 'Text' argument, consuming the delimiter. An empty delimiter is
1313−-- delimiter is invalid, and will cause an error to be raised.
906+-- invalid, and will cause an error to be raised.
1315-- Examples:
908-- Examples:
1317−-- > splitOn "\r\n" "a\r\nb\r\nd\r\ne" == ["a","b","d","e"]
910+-- > split "\r\n" "a\r\nb\r\nd\r\ne" == ["a","b","d","e"]
1318−-- > splitOn "aaa" "aaaXaaaXaaaXaaa" == ["","X","X","X",""]
911+-- > split "aaa" "aaaXaaaXaaaXaaa" == ["","X","X","X",""]
1319−-- > splitOn "x" "x" == ["",""]
912+-- > split "x" "x" == ["",""]
1323−-- > intercalate s . splitOn s == id
916+-- > intercalate s . split s == id
1324−-- > splitOn (singleton c) == split (==c)
917+-- > split (singleton c) == splitWith (==c)
1326−-- (Note: the string @s@ to split on above cannot be empty.)
1328−-- In (unlikely) bad cases, this function's time complexity degrades
919+-- In (unlikely) bad cases, this function's time complexity
1329−-- towards /O(n*m)/.
920+-- degenerates towards /O(n*m)/.
1330−splitOn :: Text
921+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)
922+split pat@(Text _ _ l) src@(Text arr off len)
1337− | l <= 0 = emptyError "splitOn"
923+ | l <= 0 = emptyError "split"
1338− | isSingleton pat = split (== unsafeHead pat) src
924+ | isSingleton pat = splitWith (== unsafeHead pat) src
1339 | otherwise = go 0 (indices pat src)
925 | otherwise = go 0 (indices pat src)
1341− go !s (x:xs) = text arr (s+off) (x-s) : go (x+l) xs
927+ go !s (x:xs) = textP arr (s+off) (x-s) : go (x+l) xs
1342− go s _ = [text arr (s+off) (len-s)]
928+ go s _ = [textP arr (s+off) (len-s)]
1343−{-# INLINE [1] splitOn #-}
929+{-# INLINE [1] split #-}
1345{-# RULES
931{-# RULES
1346−"TEXT splitOn/singleton -> split/==" [~1] forall c t.
932+"TEXT split/singleton -> splitWith/==" [~1] forall c t.
1347− splitOn (singleton c) t = split (==c) t
933+ split (singleton c) t = splitWith (==c) t
936+-- | /O(m+n)/ Break a 'Text' into pieces at most @k@ times,
937+-- treating the first 'Text' argument as the delimiter to break on,
938+-- and consuming the delimiter. The last element of the list contains
939+-- the remaining text after the number of times to split has been
940+-- reached. A value of zero or less for @k@ causes no splitting to
941+-- occur. An empty delimiter is invalid, and will cause an error to be
946+-- > splitTimes 0 "//" "a//b//c" == ["a//b//c"]
947+-- > splitTimes 2 ":" "a:b:c:d:e" == ["a","b","c:d:e"]
948+-- > splitTimes 100 "???" "a????b" == ["a","?b"]
952+-- > intercalate s . splitTimes k s == id
954+-- In (unlikely) bad cases, this function's time complexity
955+-- degenerates towards /O(n*m)/.
956+splitTimes :: Int -- ^ Maximum number of times to split
957+ -> Text -- ^ Text to split on
958+ -> Text -- ^ Input text
960+splitTimes k pat@(Text _ _ l) src@(Text arr off len)
961+ | l <= 0 = emptyError "splitTimes"
962+ | otherwise = go 0 0 (indices pat src)
964+ go !s !i _ | i >= k = [textP arr (s+off) (len-s)]
965+ go !s _ [] = [textP arr (s+off) (len-s)]
966+ go !s !i (x:xs) = textP arr (s+off) (x-s) : go (x+l) (i+1) xs
967+{-# INLINE splitTimes #-}
969+-- | /O(m+n)/ Break a 'Text' into pieces at most @k@ times, like
970+-- 'splitTimes', but start from the end of the input and work towards
975+-- > splitTimes 2 "::" "a::b::c::d::e" == ["a","b","c::d::e"]
976+-- > splitTimesEnd 2 "::" "a::b::c::d::e" == ["a::b::c","d","e"]
978+-- In (unlikely) bad cases, this function's time complexity
979+-- degenerates towards /O(n*m)/.
980+splitTimesEnd :: Int -- ^ Maximum number of times to split
981+ -> Text -- ^ Text to split on
982+ -> Text -- ^ Input text
984+splitTimesEnd k pat src =
985+ L.reverse . L.map reverse $ splitTimes k (reverse pat) (reverse src)
986+{-# INLINE splitTimesEnd #-}
1350-- | /O(n)/ Splits a 'Text' into components delimited by separators,
988-- | /O(n)/ Splits a 'Text' into components delimited by separators,
1351-- where the predicate returns True for a separator element. The
989-- where the predicate returns True for a separator element. The
1352-- resulting components do not contain the separators. Two adjacent
990-- resulting components do not contain the separators. Two adjacent
1353-- separators result in an empty component in the output. eg.
991-- separators result in an empty component in the output. eg.
1355−-- > split (=='a') "aabbaca" == ["","","bb","c",""]
993+-- > splitWith (=='a') "aabbaca" == ["","","bb","c",""]
1356−-- > split (=='a') "" == [""]
994+-- > splitWith (=='a') "" == [""]
1357−split :: (Char -> Bool) -> Text -> [Text]
995+splitWith :: (Char -> Bool) -> Text -> [Text]
1358−split _ t@(Text _off _arr 0) = [t]
996+splitWith _ t@(Text _off _arr 0) = [t]
1359−split p t = loop t
997+splitWith p t = loop t
1360 where loop s | null s' = [l]
998 where loop s | null s' = [l]
1361 | otherwise = l : loop (unsafeTail s')
999 | otherwise = l : loop (unsafeTail s')
1362− where (# l, s' #) = span_ (not . p) s
1000+ where (l, s') = break p s
1363−{-# INLINE split #-}
1001+{-# INLINE splitWith #-}
1365-- | /O(n)/ Splits a 'Text' into components of length @k@. The last
1003-- | /O(n)/ Splits a 'Text' into components of length @k@. The last
1366-- element may be shorter than the other chunks, depending on the
1004-- element may be shorter than the other chunks, depending on the
@@ -1379,15 +1017,23 @@ chunksOf k = go
1379-- ----------------------------------------------------------------------------
1017-- ----------------------------------------------------------------------------
1380-- * Searching
1018-- * Searching
1020+-------------------------------------------------------------------------------
1021+-- ** Searching by equality
1023+-- | /O(n)/ 'elem' is the 'Text' membership predicate.
1024+elem :: Char -> Text -> Bool
1025+elem c t = S.elem c (stream t)
1382-------------------------------------------------------------------------------
1028-------------------------------------------------------------------------------
1383-- ** Searching with a predicate
1029-- ** Searching with a predicate
1385−-- | /O(n)/ The 'find' function takes a predicate and a 'Text', and
1031+-- | /O(n)/ The 'findBy' function takes a predicate and a 'Text', and
1386−-- returns the first element matching the predicate, or 'Nothing' if
1032+-- returns the first element in matching the predicate, or 'Nothing'
1387−-- there is no such element.
1033+-- if there is no such element.
1388−find :: (Char -> Bool) -> Text -> Maybe Char
1034+findBy :: (Char -> Bool) -> Text -> Maybe Char
1389−find p t = S.findBy p (stream t)
1035+findBy p t = S.findBy p (stream t)
1390−{-# INLINE find #-}
1036+{-# INLINE findBy #-}
1392-- | /O(n)/ The 'partition' function takes a predicate and a 'Text',
1038-- | /O(n)/ The 'partition' function takes a predicate and a 'Text',
1393-- and returns the pair of 'Text's with elements which do and do not
1039-- and returns the pair of 'Text's with elements which do and do not
@@ -1405,76 +1051,36 @@ filter :: (Char -> Bool) -> Text -> Text
1405filter p t = unstream (S.filter p (stream t))
1051filter p t = unstream (S.filter p (stream t))
1406{-# INLINE filter #-}
1052{-# INLINE filter #-}
1408−-- | /O(n+m)/ Find the first instance of @needle@ (which must be
1054+-- /O(n+m)/ Find all non-overlapping instances of @needle@ in
1409−-- non-'null') in @haystack@. The first element of the returned tuple
1055+-- @haystack@. The first element of the returned tuple is the prefix
1410−-- is the prefix of @haystack@ before @needle@ is matched. The second
1056+-- of @haystack@ before any matches of @needle@. The second element
1411−-- is the remainder of @haystack@, starting with the match.
1057+-- of the tuple is a list of non-overlapping substrings from
1058+-- @haystack@. Each begins with @needle@ and ends just before the
1059+-- following match. If @needle@ is not present in @haystack@, the
1060+-- list will be empty and the prefix will contain @haystack@.
1413-- Examples:
1062-- Examples:
1415−-- > breakOn "::" "a::b::c" ==> ("a", "::b::c")
1064+-- > find "::" "a::b::c" ==> ("a", ["::b", "::c"])
1416−-- > breakOn "/" "foobar" ==> ("foobar", "")
1065+-- > find "/" "foobar" ==> ("foobar", [])
1420−-- > append prefix match == haystack
1069+-- > concat (prefix : matches) == haystack
1421−-- > where (prefix, match) = breakOn needle haystack
1070+-- > where (prefix, matches) = find needle haystack
1423−-- 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'
1425−-- instead, as it has lower startup overhead.
1427−-- In (unlikely) bad cases, this function's time complexity degrades
1072+-- In (unlikely) bad cases, this function's time complexity
1428−-- towards /O(n*m)/.
1073+-- degenerates towards /O(n*m)/.
1429−breakOn :: Text -> Text -> (Text, Text)
1074+find :: Text -> Text -> (Text, [Text])
1430−breakOn pat src@(Text arr off len)
1075+find pat src@(Text arr off len)
1431− | null pat = emptyError "breakOn"
1076+ | null pat = emptyError "find"
1432 | otherwise = case indices pat src of
1077 | otherwise = case indices pat src of
1433− [] -> (src, empty)
1078+ [] -> (src, [])
1434− (x:_) -> (text arr off x, text arr (off+x) (len-x))
1079+ (x:xs) -> (textP arr off x, go x xs)
1435−{-# INLINE breakOn #-}
1437−-- | /O(n+m)/ Similar to 'breakOn', but searches from the end of the
1440−-- 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
1442−-- remainder of @haystack@, following the match.
1444−-- > breakOnEnd "::" "a::b::c" ==> ("a::b::", "c")
1445−breakOnEnd :: Text -> Text -> (Text, Text)
1446−breakOnEnd pat src = (reverse b, reverse a)
1447− where (a,b) = breakOn (reverse pat) (reverse src)
1448−{-# INLINE breakOnEnd #-}
1450−-- | /O(n+m)/ Find all non-overlapping instances of @needle@ in
1451−-- @haystack@. Each element of the returned list consists of a pair:
1453−-- * The entire string prior to the /k/th match (i.e. the prefix)
1455−-- * The /k/th match, followed by the remainder of the string
1459−-- > breakOnAll "::" ""
1461−-- > breakOnAll "/" "a/b/c/"
1462−-- > ==> [("a", "/b/c/"), ("a/b", "/c/"), ("a/b/c", "/")]
1464−-- In (unlikely) bad cases, this function's time complexity degrades
1465−-- towards /O(n*m)/.
1467−-- The @needle@ parameter may not be empty.
1468−breakOnAll :: Text -- ^ @needle@ to search for
1469− -> Text -- ^ @haystack@ in which to search
1471−breakOnAll pat src@(Text arr off slen)
1472− | null pat = emptyError "breakOnAll"
1473− | otherwise = L.map step (indices pat src)
1475− step x = (chunk 0 x, chunk x (slen-x))
1081+ go !s (x:xs) = textP arr (s+off) (x-s) : go x xs
1476− chunk !n !l = text arr (n+off) l
1082+ go s _ = [textP arr (s+off) (len-s)]
1477−{-# INLINE breakOnAll #-}
1083+{-# INLINE find #-}
1479-------------------------------------------------------------------------------
1085-------------------------------------------------------------------------------
1480-- ** Indexing 'Text's
1086-- ** Indexing 'Text's
@@ -1493,7 +1099,8 @@ breakOnAll pat src@(Text arr off slen)
1493-- For example, suppose you have a string that you want to split on
1099-- For example, suppose you have a string that you want to split on
1494-- the substring @\"::\"@, such as @\"foo::bar::quux\"@. Instead of
1100-- the substring @\"::\"@, such as @\"foo::bar::quux\"@. Instead of
1495-- searching for the index of @\"::\"@ and taking the substrings
1101-- searching for the index of @\"::\"@ and taking the substrings
1496−-- before and after that index, you would instead use @breakOnAll \"::\"@.
1102+-- before and after that index, you would instead use @splitTimes 1
1498-- | /O(n)/ 'Text' index (subscript) operator, starting from 0.
1105-- | /O(n)/ 'Text' index (subscript) operator, starting from 0.
1499index :: Text -> Int -> Char
1106index :: Text -> Int -> Char
@@ -1511,8 +1118,8 @@ findIndex p t = S.findIndex p (stream t)
1511-- query string appears in the given 'Text'. An empty query string is
1118-- query string appears in the given 'Text'. An empty query string is
1512-- invalid, and will cause an error to be raised.
1119-- invalid, and will cause an error to be raised.
1514−-- In (unlikely) bad cases, this function's time complexity degrades
1121+-- In (unlikely) bad cases, this function's time complexity
1515−-- towards /O(n*m)/.
1122+-- degenerates towards /O(n*m)/.
1516count :: Text -> Text -> Int
1123count :: Text -> Text -> Int
1517count pat src
1124count pat src
1518 | null pat = emptyError "count"
1125 | null pat = emptyError "count"
@@ -1540,15 +1147,13 @@ countChar c t = S.countChar c (stream t)
1540-- equivalent to a pair of 'unpack' operations.
1147-- equivalent to a pair of 'unpack' operations.
1541zip :: Text -> Text -> [(Char,Char)]
1148zip :: Text -> Text -> [(Char,Char)]
1542zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1149zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1543−{-# INLINE zip #-}
1150+{-# INLINE [0] zip #-}
1545-- | /O(n)/ 'zipWith' generalises 'zip' by zipping with the function
1152-- | /O(n)/ 'zipWith' generalises 'zip' by zipping with the function
1546-- given as the first argument, instead of a tupling function.
1153-- given as the first argument, instead of a tupling function.
1547−-- Performs replacement on invalid scalar values.
1548zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
1154zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
1549−zipWith f t1 t2 = unstream (S.zipWith g (stream t1) (stream t2))
1155+zipWith f t1 t2 = unstream (S.zipWith f (stream t1) (stream t2))
1550− where g a b = safe (f a b)
1551−{-# INLINE zipWith #-}
1156+{-# INLINE [0] zipWith #-}
1553-- | /O(n)/ Breaks a 'Text' up into a list of words, delimited by 'Char's
1158-- | /O(n)/ Breaks a 'Text' up into a list of words, delimited by 'Char's
1554-- representing white space.
1159-- representing white space.
@@ -1564,7 +1169,7 @@ words t@(Text arr off len) = loop 0 0
1564 then loop (start+1) (start+1)
1169 then loop (start+1) (start+1)
1565 else Text arr (start+off) (n-start) : loop (n+d) (n+d)
1170 else Text arr (start+off) (n-start) : loop (n+d) (n+d)
1566 | otherwise = loop start (n+d)
1171 | otherwise = loop start (n+d)
1567− where Iter c d = iter t n
1172+ where (c,d) = iter t n
1568{-# INLINE words #-}
1173{-# INLINE words #-}
1570-- | /O(n)/ Breaks a 'Text' up into a list of 'Text's at
1175-- | /O(n)/ Breaks a 'Text' up into a list of 'Text's at
@@ -1574,10 +1179,9 @@ lines ps | null ps = []
1574 | otherwise = h : if null t
1179 | otherwise = h : if null t
1576 else lines (unsafeTail t)
1181 else lines (unsafeTail t)
1577− where (# h,t #) = span_ (/= '\n') ps
1182+ where (h,t) = span (/= '\n') ps
1578{-# INLINE lines #-}
1183{-# INLINE lines #-}
1581-- | /O(n)/ Portably breaks a 'Text' up into a list of 'Text's at line
1185-- | /O(n)/ Portably breaks a 'Text' up into a list of 'Text's at line
1582-- boundaries.
1186-- boundaries.
@@ -1585,6 +1189,7 @@ lines ps | null ps = []
1585-- return immediately followed by a line feed, or a carriage return.
1189-- return immediately followed by a line feed, or a carriage return.
1586-- This accounts for both Unix and Windows line ending conventions,
1190-- This accounts for both Unix and Windows line ending conventions,
1587-- and for the old convention used on Mac OS 9 and earlier.
1191-- and for the old convention used on Mac OS 9 and earlier.
1588lines' :: Text -> [Text]
1193lines' :: Text -> [Text]
1589lines' ps | null ps = []
1194lines' ps | null ps = []
1590 | otherwise = h : case uncons t of
1195 | otherwise = h : case uncons t of
@@ -1611,7 +1216,8 @@ unwords = intercalate (singleton ' ')
1611{-# INLINE unwords #-}
1216{-# INLINE unwords #-}
1613-- | /O(n)/ The 'isPrefixOf' function takes two 'Text's and returns
1218-- | /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.
1219+-- 'True' iff the first is a prefix of the second. This function is
1220+-- subject to fusion.
1615isPrefixOf :: Text -> Text -> Bool
1221isPrefixOf :: Text -> Text -> Bool
1616isPrefixOf a@(Text _ _ alen) b@(Text _ _ blen) =
1222isPrefixOf a@(Text _ _ alen) b@(Text _ _ blen) =
1617 alen <= blen && S.isPrefixOf (stream a) (stream b)
1223 alen <= blen && S.isPrefixOf (stream a) (stream b)
@@ -1620,6 +1226,8 @@ isPrefixOf a@(Text _ _ alen) b@(Text _ _ blen) =
1620{-# RULES
1226{-# RULES
1621"TEXT isPrefixOf -> fused" [~1] forall s t.
1227"TEXT isPrefixOf -> fused" [~1] forall s t.
1622 isPrefixOf s t = S.isPrefixOf (stream s) (stream t)
1228 isPrefixOf s t = S.isPrefixOf (stream s) (stream t)
1229+"TEXT isPrefixOf -> unfused" [1] forall s t.
1230+ S.isPrefixOf (stream s) (stream t) = isPrefixOf s t
1625-- | /O(n)/ The 'isSuffixOf' function takes two 'Text's and returns
1233-- | /O(n)/ The 'isSuffixOf' function takes two 'Text's and returns
@@ -1636,120 +1244,11 @@ isSuffixOf a@(Text _aarr _aoff alen) b@(Text barr boff blen) =
1636-- 'True' iff the first is contained, wholly and intact, anywhere
1244-- 'True' iff the first is contained, wholly and intact, anywhere
1637-- within the second.
1245-- within the second.
1639−-- In (unlikely) bad cases, this function's time complexity degrades
1247+-- In (unlikely) bad cases, this function's time complexity
1640−-- towards /O(n*m)/.
1248+-- degenerates towards /O(n*m)/.
1641isInfixOf :: Text -> Text -> Bool
1249isInfixOf :: Text -> Text -> Bool
1642−isInfixOf needle haystack
1250+isInfixOf pat src = null pat || (not . L.null $ indices pat src)
1643− | null needle = True
1644− | isSingleton needle = S.elem (unsafeHead needle) . S.stream $ haystack
1645− | otherwise = not . L.null . indices needle $ haystack
1646−{-# INLINE [1] isInfixOf #-}
1251+{-# INLINE isInfixOf #-}
1649−"TEXT isInfixOf/singleton -> S.elem/S.stream" [~1] forall n h.
1650− isInfixOf (singleton n) h = S.elem n (S.stream h)
1653−-------------------------------------------------------------------------------
1656−-- | /O(n)/ Return the suffix of the second string if its prefix
1657−-- matches the entire first string.
1661−-- > stripPrefix "foo" "foobar" == Just "bar"
1662−-- > stripPrefix "" "baz" == Just "baz"
1663−-- > stripPrefix "foo" "quux" == Nothing
1665−-- This is particularly useful with the @ViewPatterns@ extension to
1668−-- > {-# LANGUAGE ViewPatterns #-}
1669−-- > import Data.Text as T
1671−-- > fnordLength :: Text -> Int
1672−-- > fnordLength (stripPrefix "fnord" -> Just suf) = T.length suf
1673−-- > fnordLength _ = -1
1674−stripPrefix :: Text -> Text -> Maybe Text
1675−stripPrefix p@(Text _arr _off plen) t@(Text arr off len)
1676− | p `isPrefixOf` t = Just $! text arr (off+plen) (len-plen)
1677− | otherwise = Nothing
1679−-- | /O(n)/ Find the longest non-empty common prefix of two strings
1680−-- and return it, along with the suffixes of each string at which they
1683−-- If the strings do not have a common prefix or either one is empty,
1684−-- this function returns 'Nothing'.
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"
1708−-- > stripSuffix "" "baz" == Just "baz"
1709−-- > stripSuffix "foo" "quux" == Nothing
1711−-- This is particularly useful with the @ViewPatterns@ extension to
1714−-- > {-# LANGUAGE ViewPatterns #-}
1715−-- > import Data.Text as T
1717−-- > quuxLength :: Text -> Int
1718−-- > quuxLength (stripSuffix "quux" -> Just pre) = T.length pre
1719−-- > quuxLength _ = -1
1720−stripSuffix :: Text -> Text -> Maybe Text
1721−stripSuffix p@(Text _arr _off plen) t@(Text arr off len)
1722− | p `isSuffixOf` t = Just $! text arr off (len-plen)
1723− | 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
1253emptyError :: String -> a
1735−emptyError fun = P.error $ "Data.Text." ++ fun ++ ": empty input"
1254+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