@@ -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
@@ -125,22 +104,17 @@ 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− , stripStart
113+ , stripLeft
138− , stripEnd
114+ , stripRight
139 , splitAt
115 , splitAt
145 , groupBy
119 , groupBy
@@ -148,8 +122,11 @@ module Data.Text
149 -- ** Breaking into many substrings
123 -- ** Breaking into many substrings
150 -- $split
124 -- $split
153 , chunksOf
130 , chunksOf
155 -- ** Breaking into lines and words
132 -- ** Breaking into lines and words
@@ -164,309 +141,135 @@ module Data.Text
164 , isSuffixOf
141 , isSuffixOf
165 , isInfixOf
142 , isInfixOf
172 -- * Searching
144 -- * Searching
176 , partition
148 , partition
178 -- , findSubstring
150 -- , findSubstring
180 -- * Indexing
152 -- * Indexing
181 -- $index
153 -- $index
183 , findIndex
155 , 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, not, return, otherwise)
203−#if defined(HAVE_DEEPSEQ)
204−import Control.DeepSeq (NFData(rnf))
207import Control.Exception (assert)
174import Control.Exception (assert)
209import Data.Char (isSpace)
175import 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)
176import Control.Monad.ST (ST)
214import qualified Data.Text.Array as A
177import qualified Data.Text.Array as A
215import qualified Data.List as L
178import qualified Data.List as L
216−import Data.Binary (Binary(get, put))
217import Data.Monoid (Monoid(..))
179import Data.Monoid (Monoid(..))
218−#if MIN_VERSION_base(4,9,0)
219−import Data.Semigroup (Semigroup(..))
180+import Data.Word (Word16)
221import Data.String (IsString(..))
181import Data.String (IsString(..))
222−import qualified Data.Text.Internal.Fusion as S
223−import qualified Data.Text.Internal.Fusion.Common as S
224−import Data.Text.Encoding (decodeUtf8', encodeUtf8)
225−import Data.Text.Internal.Fusion (stream, reverseStream, unstream)
226−import Data.Text.Internal.Private (span_)
227−import Data.Text.Internal (Text(..), empty, firstf, mul, safe, text)
228−import Data.Text.Show (singleton, unpack, unpackCString#)
229−import qualified Prelude as P
230−import Data.Text.Unsafe (Iter(..), iter, iter_, lengthWord16, reverseIter,
231− reverseIter_, unsafeHead, unsafeTail)
232−import Data.Text.Internal.Unsafe.Char (unsafeChr)
233−import qualified Data.Text.Internal.Functions as F
234−import qualified Data.Text.Internal.Encoding.Utf16 as U16
235−import Data.Text.Internal.Search (indices)
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'
270−-- $replacement
183+import qualified Data.Text.Fusion as S
271−--
184+import qualified Data.Text.Fusion.Common as S
272−-- A 'Text' value is a sequence of Unicode scalar values, as defined
185+import Data.Text.Fusion (stream, reverseStream, unstream)
274−-- <http://www.unicode.org/versions/Unicode5.2.0/ch03.pdf#page=35 §3.9, definition D76 of the Unicode 5.2 standard >.
187+import Data.Text.Internal (Text(..), empty, text, textP)
275−-- As such, a 'Text' cannot contain values in the range U+D800 to
188+import qualified Prelude as P
276−-- U+DFFF inclusive. Haskell implementations admit all Unicode code
189+import Data.Text.Unsafe (iter, iter_, reverseIter, unsafeHead, unsafeTail)
277−-- points
190+import Data.Text.UnsafeChar (unsafeChr)
278−-- (<http://www.unicode.org/versions/Unicode5.2.0/ch03.pdf#page=13 §3.4, definition D10 >)
191+import qualified Data.Text.Encoding.Utf16 as U16
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
193-- $fusion
301-- Most of the functions in this module are subject to /fusion/,
195-- Most of the functions in this module are subject to /fusion/,
302-- meaning that a pipeline of such functions will usually allocate at
196-- meaning that a pipeline of such functions will usually allocate at
303-- most one 'Text' value.
197-- 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
199instance Eq Text where
325− Text arrA offA lenA == Text arrB offB lenB
200+ t1 == t2 = stream t1 == stream t2
326− | lenA == lenB = A.equal arrA offA arrB offB lenA
328 {-# INLINE (==) #-}
201 {-# INLINE (==) #-}
330instance Ord Text where
203instance Ord Text where
331− compare = compareText
204+ compare t1 t2 = compare (stream t1) (stream t2)
205+ {-# INLINE compare #-}
207+instance Show Text where
208+ showsPrec p ps r = showsPrec p (unpack ps) r
333instance Read Text where
210instance Read Text where
334 readsPrec p str = [(pack x,y) | (x,y) <- readsPrec p str]
211 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
213instance Monoid Text where
345 mempty = empty
214 mempty = empty
346−#if MIN_VERSION_base(4,9,0)
347− mappend = (<>) -- future-proof definition
349 mappend = append
215 mappend = append
351 mconcat = concat
216 mconcat = concat
353instance IsString Text where
218instance IsString Text where
354 fromString = pack
219 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-- -----------------------------------------------------------------------------
221-- -----------------------------------------------------------------------------
425-- * Conversion to/from 'Text'
222-- * Conversion to/from 'Text'
427−-- | /O(n)/ Convert a 'String' into a 'Text'. Subject to
224+-- | /O(n)/ Convert a 'String' into a 'Text'. Subject to fusion.
428−-- fusion. Performs replacement on invalid scalar values.
429pack :: String -> Text
225pack :: String -> Text
430−pack = unstream . S.map safe . S.streamList
226+pack = unstream . S.streamList
431{-# INLINE [1] pack #-}
227{-# INLINE [1] pack #-}
229+-- | /O(n)/ Convert a Text into a String. Subject to fusion.
230+unpack :: Text -> String
231+unpack = S.unstreamList . stream
232+{-# INLINE [1] unpack #-}
234+-- | /O(1)/ Convert a character into a Text.
235+-- Subject to fusion.
236+singleton :: Char -> Text
237+singleton = unstream . S.singleton
238+{-# INLINE [1] singleton #-}
433-- -----------------------------------------------------------------------------
240-- -----------------------------------------------------------------------------
434-- * Basic functions
241-- * Basic functions
436-- | /O(n)/ Adds a character to the front of a 'Text'. This function
243-- | /O(n)/ Adds a character to the front of a 'Text'. This function
437-- is more costly than its 'List' counterpart because it requires
244-- is more costly than its 'List' counterpart because it requires
438−-- copying a new array. Subject to fusion. Performs replacement on
245+-- copying a new array. Subject to fusion.
439−-- invalid scalar values.
440cons :: Char -> Text -> Text
246cons :: Char -> Text -> Text
441−cons c t = unstream (S.cons (safe c) (stream t))
247+cons c t = unstream (S.cons c (stream t))
442{-# INLINE cons #-}
248{-# INLINE cons #-}
446-- | /O(n)/ Adds a character to the end of a 'Text'. This copies the
250-- | /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.
251-- entire array in the process, unless fused. Subject to fusion.
448−-- Performs replacement on invalid scalar values.
449snoc :: Text -> Char -> Text
252snoc :: Text -> Char -> Text
450−snoc t c = unstream (S.snoc (stream t) (safe c))
253+snoc t c = unstream (S.snoc (stream t) c)
451{-# INLINE snoc #-}
254{-# INLINE snoc #-}
453-- | /O(n)/ Appends one 'Text' to the other by copying both of them
256-- | /O(n)/ Appends one 'Text' to the other by copying both of them
454-- into a new 'Text'. Subject to fusion.
257-- into a new 'Text'. Subject to fusion.
455append :: Text -> Text -> Text
258append :: Text -> Text -> Text
456−append a@(Text arr1 off1 len1) b@(Text arr2 off2 len2)
259+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
261 len = len1+len2
463− x :: ST s (A.MArray s)
465− arr <- A.new len
263+ arr <- A.unsafeNew len :: ST s (A.MArray s Word16)
466− A.copyI arr 0 arr1 off1 len1
264+ copy arr1 off1 (len1+off1) arr 0
467− A.copyI arr len1 arr2 off2 len
265+ copy arr2 off2 (len2+off2) arr len1
468 return arr
266 return arr
268+ copy arr i top arr' j
269+ | i >= top = return ()
270+ | otherwise = do A.unsafeWrite arr' j (arr `A.unsafeIndex` i)
271+ copy arr (i+1) top arr' (j+1)
469−{-# NOINLINE append #-}
272+{-# INLINE append #-}
472"TEXT append -> fused" [~1] forall t1 t2.
275"TEXT append -> fused" [~1] forall t1 t2.
@@ -486,14 +289,21 @@ head t = S.head (stream t)
486uncons :: Text -> Maybe (Char, Text)
289uncons :: Text -> Maybe (Char, Text)
487uncons t@(Text arr off len)
290uncons t@(Text arr off len)
488 | len <= 0 = Nothing
291 | len <= 0 = Nothing
489− | otherwise = Just $ let !(Iter c d) = iter t 0
490− in (c, text arr (off+d) (len-d))
292+ | otherwise = Just (c, textP arr (off+d) (len-d))
293+ where (c,d) = iter t 0
491−{-# INLINE [1] uncons #-}
294+{-# INLINE uncons #-}
493-- | Lifted from Control.Arrow and specialized.
296-- | Lifted from Control.Arrow and specialized.
494second :: (b -> c) -> (a,b) -> (a,c)
297second :: (b -> c) -> (a,b) -> (a,c)
495second f (a, b) = (a, f b)
298second f (a, b) = (a, f b)
301+"TEXT uncons -> fused" [~1] forall t.
302+ uncons t = fmap (second unstream) (S.uncons (stream t))
303+"TEXT uncons -> unfused" [1] forall t.
304+ fmap (second unstream) (S.uncons (stream t)) = uncons t
497-- | /O(1)/ Returns the last character of a 'Text', which must be
307-- | /O(1)/ Returns the last character of a 'Text', which must be
498-- non-empty. Subject to fusion.
308-- non-empty. Subject to fusion.
499last :: Text -> Char
309last :: Text -> Char
@@ -517,7 +327,7 @@ last (Text arr off len)
517tail :: Text -> Text
327tail :: Text -> Text
518tail t@(Text arr off len)
328tail t@(Text arr off len)
519 | len <= 0 = emptyError "tail"
329 | len <= 0 = emptyError "tail"
520− | otherwise = text arr (off+d) (len-d)
330+ | otherwise = textP arr (off+d) (len-d)
521 where d = iter_ t 0
331 where d = iter_ t 0
522{-# INLINE [1] tail #-}
332{-# INLINE [1] tail #-}
@@ -532,8 +342,8 @@ tail t@(Text arr off len)
532-- be non-empty. Subject to fusion.
342-- be non-empty. Subject to fusion.
533init :: Text -> Text
343init :: Text -> Text
534init (Text arr off len) | len <= 0 = emptyError "init"
344init (Text arr off len) | len <= 0 = emptyError "init"
535− | n >= 0xDC00 && n <= 0xDFFF = text arr off (len-2)
345+ | n >= 0xDC00 && n <= 0xDFFF = textP arr off (len-2)
536− | otherwise = text arr off (len-1)
346+ | otherwise = textP arr off (len-1)
538 n = A.unsafeIndex arr (off+len-1)
348 n = A.unsafeIndex arr (off+len-1)
539{-# INLINE [1] init #-}
349{-# INLINE [1] init #-}
@@ -548,11 +358,7 @@ init (Text arr off len) | len <= 0 = emptyError "init"
548-- | /O(1)/ Tests whether a 'Text' is empty or not. Subject to
358-- | /O(1)/ Tests whether a 'Text' is empty or not. Subject to
549-- fusion.
359-- fusion.
550null :: Text -> Bool
360null :: Text -> Bool
551−null (Text _arr _off len) =
361+null (Text _arr _off len) = assert (len >= 0) $ len <= 0
556{-# INLINE [1] null #-}
362{-# INLINE [1] null #-}
@@ -562,86 +368,31 @@ null (Text _arr _off len) =
562 S.null (stream t) = null t
368 S.null (stream t) = null t
565−-- | /O(1)/ Tests whether a 'Text' contains exactly one character.
566−-- Subject to fusion.
567−isSingleton :: Text -> Bool
568−isSingleton = S.isSingleton . stream
569−{-# INLINE isSingleton #-}
571-- | /O(n)/ Returns the number of characters in a 'Text'.
371-- | /O(n)/ Returns the number of characters in a 'Text'.
572-- Subject to fusion.
372-- Subject to fusion.
573length :: Text -> Int
373length :: Text -> Int
574length t = S.length (stream t)
374length t = S.length (stream t)
575−{-# INLINE [0] length #-}
375+{-# 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-- -----------------------------------------------------------------------------
377-- -----------------------------------------------------------------------------
625-- * Transformations
378-- * Transformations
626-- | /O(n)/ 'map' @f@ @t@ is the 'Text' obtained by applying @f@ to
379-- | /O(n)/ 'map' @f@ @t@ is the 'Text' obtained by applying @f@ to
627−-- each element of @t@. Subject to fusion. Performs replacement on
380+-- each element of @t@. Subject to fusion.
628−-- invalid scalar values.
629map :: (Char -> Char) -> Text -> Text
381map :: (Char -> Char) -> Text -> Text
630−map f t = unstream (S.map (safe . f) (stream t))
382+map f t = unstream (S.map f (stream t))
631{-# INLINE [1] map #-}
383{-# INLINE [1] map #-}
633-- | /O(n)/ The 'intercalate' function takes a 'Text' and a list of
385-- | /O(n)/ The 'intercalate' function takes a 'Text' and a list of
634-- 'Text's and concatenates the list after interspersing the first
386-- 'Text's and concatenates the list after interspersing the first
635-- argument between each element of the list.
387-- argument between each element of the list.
636intercalate :: Text -> [Text] -> Text
388intercalate :: Text -> [Text] -> Text
637−intercalate t = concat . (F.intersperse t)
389+intercalate t ts = unstream (S.intercalate (stream t) (L.map stream ts))
638{-# INLINE intercalate #-}
390{-# INLINE intercalate #-}
640-- | /O(n)/ The 'intersperse' function takes a character and places it
392-- | /O(n)/ The 'intersperse' function takes a character and places it
641−-- between the characters of a 'Text'. Subject to fusion. Performs
393+-- between the characters of a 'Text'. Subject to fusion.
642−-- replacement on invalid scalar values.
643intersperse :: Char -> Text -> Text
394intersperse :: Char -> Text -> Text
644−intersperse c t = unstream (S.intersperse (safe c) (stream t))
395+intersperse c t = unstream (S.intersperse c (stream t))
645{-# INLINE intersperse #-}
396{-# INLINE intersperse #-}
647-- | /O(n)/ Reverse the characters of a string. Subject to fusion.
398-- | /O(n)/ Reverse the characters of a string. Subject to fusion.
@@ -649,59 +400,13 @@ reverse :: Text -> Text
649reverse t = S.reverse (stream t)
400reverse t = S.reverse (stream t)
650{-# INLINE reverse #-}
401{-# INLINE reverse #-}
652−-- | /O(m+n)/ Replace every non-overlapping occurrence of @needle@ in
403+-- | /O(m)*O(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
404+replace :: Text -- ^ Text to search for
676− -- ^ @needle@ to search for. If this string is empty, an
405+ -> Text -- ^ Replacement text
677− -- error will occur.
679− -- ^ @replacement@ to replace @needle@ with.
680− -> Text
406+ -> Text -- ^ Input text
681− -- ^ @haystack@ in which to search.
683−replace needle@(Text _ _ neeLen)
408+replace s d = intercalate d . split s
684− (Text repArr repOff repLen)
409+{-# 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-- ----------------------------------------------------------------------------
411-- ----------------------------------------------------------------------------
707-- ** Case conversions (folds)
412-- ** Case conversions (folds)
@@ -716,17 +421,10 @@ replace needle@(Text _ _ neeLen)
716-- case conversion rules. As a result, these functions may map one
421-- case conversion rules. As a result, these functions may map one
717-- input character to two or three output characters. For examples,
422-- input character to two or three output characters. For examples,
718-- see the documentation of each function.
423-- 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.
425+-- | /O(n)/ Convert a string to folded case. This function is mainly
728−-- This function is mainly useful for performing caseless (also known
426+-- useful for performing caseless (also known as case insensitive)
729−-- as case insensitive) string comparisons.
427+-- string comparisons.
731-- A string @x@ is a caseless match for a string @y@ if and only if:
429-- A string @x@ is a caseless match for a string @y@ if and only if:
@@ -741,102 +439,67 @@ replace needle@(Text _ _ neeLen)
741-- instead of itself.
439-- instead of itself.
742toCaseFold :: Text -> Text
440toCaseFold :: Text -> Text
743toCaseFold t = unstream (S.toCaseFold (stream t))
441toCaseFold t = unstream (S.toCaseFold (stream t))
744−{-# INLINE toCaseFold #-}
442+{-# INLINE [0] toCaseFold #-}
746-- | /O(n)/ Convert a string to lower case, using simple case
444-- | /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
445+-- conversion. The result string may be longer than the input string.
750−-- instance, \"İ\" (Latin capital letter I with dot above,
446+-- For instance, \"İ\" (Latin capital letter I with dot above,
751−-- U+0130) maps to the sequence \"i\" (Latin small letter i, U+0069)
447+-- U+0130) maps to the sequence \"i\" (Latin small letter i, U+0069) followed
752−-- followed by \" ̇\" (combining dot above, U+0307).
448+-- by \" ̇\" (combining dot above, U+0307).
753toLower :: Text -> Text
449toLower :: Text -> Text
754toLower t = unstream (S.toLower (stream t))
450toLower t = unstream (S.toLower (stream t))
755{-# INLINE toLower #-}
451{-# INLINE toLower #-}
757-- | /O(n)/ Convert a string to upper case, using simple case
453-- | /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
454+-- conversion. The result string may be longer than the input string.
761−-- instance, the German \"ß\" (eszett, U+00DF) maps to the
455+-- For instance, the German \"ß\" (eszett, U+00DF) maps to the
762-- two-letter sequence \"SS\".
456-- two-letter sequence \"SS\".
763toUpper :: Text -> Text
457toUpper :: Text -> Text
764toUpper t = unstream (S.toUpper (stream t))
458toUpper t = unstream (S.toUpper (stream t))
765{-# INLINE toUpper #-}
459{-# 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
461-- | /O(n)/ Left-justify a string to the given length, using the
790−-- specified fill character on the right. Subject to fusion.
462+-- specified fill character on the right. Subject to fusion. Examples:
791−-- Performs replacement on invalid scalar values.
795-- > justifyLeft 7 'x' "foo" == "fooxxxx"
464-- > justifyLeft 7 'x' "foo" == "fooxxxx"
796-- > justifyLeft 3 'x' "foobar" == "foobar"
465-- > justifyLeft 3 'x' "foobar" == "foobar"
797justifyLeft :: Int -> Char -> Text -> Text
466justifyLeft :: Int -> Char -> Text -> Text
798justifyLeft k c t
467justifyLeft k c t
799 | len >= k = t
468 | len >= k = t
800− | otherwise = t `append` replicateChar (k-len) c
469+ | otherwise = t `append` replicate (k-len) c
801 where len = length t
470 where len = length t
802{-# INLINE [1] justifyLeft #-}
471{-# INLINE [1] justifyLeft #-}
805"TEXT justifyLeft -> fused" [~1] forall k c t.
474"TEXT justifyLeft -> fused" [~1] forall k c t.
806− justifyLeft k c t = unstream (S.justifyLeftI k c (stream t))
475+ justifyLeft k c t = unstream (S.justifyLeft k c (stream t))
807"TEXT justifyLeft -> unfused" [1] forall k c t.
476"TEXT justifyLeft -> unfused" [1] forall k c t.
808− unstream (S.justifyLeftI k c (stream t)) = justifyLeft k c t
477+ unstream (S.justifyLeft k c (stream t)) = justifyLeft k c t
811-- | /O(n)/ Right-justify a string to the given length, using the
480-- | /O(n)/ Right-justify a string to the given length, using the
812−-- specified fill character on the left. Performs replacement on
481+-- specified fill character on the left. Examples:
813−-- invalid scalar values.
817-- > justifyRight 7 'x' "bar" == "xxxxbar"
483-- > justifyRight 7 'x' "bar" == "xxxxbar"
818-- > justifyRight 3 'x' "foobar" == "foobar"
484-- > justifyRight 3 'x' "foobar" == "foobar"
819justifyRight :: Int -> Char -> Text -> Text
485justifyRight :: Int -> Char -> Text -> Text
820justifyRight k c t
486justifyRight k c t
821 | len >= k = t
487 | len >= k = t
822− | otherwise = replicateChar (k-len) c `append` t
488+ | otherwise = replicate (k-len) c `append` t
823 where len = length t
489 where len = length t
824{-# INLINE justifyRight #-}
490{-# INLINE justifyRight #-}
826−-- | /O(n)/ Center a string to the given length, using the specified
492+-- | /O(n)/ Center a string to the given length, using the
827−-- fill character on either side. Performs replacement on invalid
493+-- specified fill character on either side. Examples:
832-- > center 8 'x' "HS" = "xxxHSxxx"
495-- > center 8 'x' "HS" = "xxxHSxxx"
833center :: Int -> Char -> Text -> Text
496center :: Int -> Char -> Text -> Text
834center k c t
497center k c t
835 | len >= k = t
498 | len >= k = t
836− | otherwise = replicateChar l c `append` t `append` replicateChar r c
499+ | otherwise = replicate l c `append` t `append` replicate r c
837 where len = length t
500 where len = length t
838 d = k - len
501 d = k - len
839− r = d `quot` 2
502+ r = d `div` 2
840 l = d - r
503 l = d - r
841{-# INLINE center #-}
504{-# INLINE center #-}
@@ -854,12 +517,12 @@ transpose ts = P.map pack (L.transpose (P.map unpack ts))
854-- (typically the left-identity of the operator), and a 'Text',
517-- (typically the left-identity of the operator), and a 'Text',
855-- reduces the 'Text' using the binary operator, from left to right.
518-- reduces the 'Text' using the binary operator, from left to right.
856-- Subject to fusion.
519-- Subject to fusion.
857−foldl :: (a -> Char -> a) -> a -> Text -> a
520+foldl :: (b -> Char -> b) -> b -> Text -> b
858foldl f z t = S.foldl f z (stream t)
521foldl f z t = S.foldl f z (stream t)
859{-# INLINE foldl #-}
522{-# INLINE foldl #-}
861-- | /O(n)/ A strict version of 'foldl'. Subject to fusion.
524-- | /O(n)/ A strict version of 'foldl'. Subject to fusion.
862−foldl' :: (a -> Char -> a) -> a -> Text -> a
525+foldl' :: (b -> Char -> b) -> b -> Text -> b
863foldl' f z t = S.foldl' f z (stream t)
526foldl' f z t = S.foldl' f z (stream t)
864{-# INLINE foldl' #-}
527{-# INLINE foldl' #-}
@@ -878,12 +541,12 @@ foldl1' f t = S.foldl1' f (stream t)
878-- (typically the right-identity of the operator), and a 'Text',
541-- (typically the right-identity of the operator), and a 'Text',
879-- reduces the 'Text' using the binary operator, from right to left.
542-- reduces the 'Text' using the binary operator, from right to left.
880-- Subject to fusion.
543-- Subject to fusion.
881−foldr :: (Char -> a -> a) -> a -> Text -> a
544+foldr :: (Char -> b -> b) -> b -> Text -> b
882foldr f z t = S.foldr f z (stream t)
545foldr f z t = S.foldr f z (stream t)
883{-# INLINE foldr #-}
546{-# INLINE foldr #-}
885-- | /O(n)/ A variant of 'foldr' that has no starting value argument,
548-- | /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
549+-- and thust must be applied to a non-empty 'Text'. Subject to
887-- fusion.
550-- fusion.
888foldr1 :: (Char -> Char -> Char) -> Text -> Char
551foldr1 :: (Char -> Char -> Char) -> Text -> Char
889foldr1 f t = S.foldr1 f (stream t)
552foldr1 f t = S.foldr1 f (stream t)
@@ -892,36 +555,28 @@ foldr1 f t = S.foldr1 f (stream t)
892-- -----------------------------------------------------------------------------
555-- -----------------------------------------------------------------------------
893-- ** Special folds
556-- ** Special folds
895−-- | /O(n)/ Concatenate a list of 'Text's.
558+-- | /O(n)/ Concatenate a list of 'Text's. Subject to fusion.
896concat :: [Text] -> Text
559concat :: [Text] -> Text
897−concat ts = case ts' of
560+concat ts = unstream (S.concat (L.map stream ts))
898− [] -> empty
561+{-# 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
563-- | /O(n)/ Map a function over a 'Text' that results in a 'Text', and
912−-- concatenate the results.
564+-- concatenate the results. Subject to fusion.
566+-- Note: if in 'concatMap' @f@ @t@, @f@ is defined in terms of fusible
567+-- functions, it will also be fusible.
913concatMap :: (Char -> Text) -> Text -> Text
568concatMap :: (Char -> Text) -> Text -> Text
914−concatMap f = concat . foldr ((:) . f) []
569+concatMap f t = unstream (S.concatMap (stream . f) (stream t))
915{-# INLINE concatMap #-}
570{-# INLINE concatMap #-}
917-- | /O(n)/ 'any' @p@ @t@ determines whether any character in the
572-- | /O(n)/ 'any' @p@ @t@ determines whether any character in the
918−-- 'Text' @t@ satisfies the predicate @p@. Subject to fusion.
573+-- 'Text' @t@ satisifes the predicate @p@. Subject to fusion.
919any :: (Char -> Bool) -> Text -> Bool
574any :: (Char -> Bool) -> Text -> Bool
920any p t = S.any p (stream t)
575any p t = S.any p (stream t)
921{-# INLINE any #-}
576{-# INLINE any #-}
923-- | /O(n)/ 'all' @p@ @t@ determines whether all characters in the
578-- | /O(n)/ 'all' @p@ @t@ determines whether all characters in the
924−-- 'Text' @t@ satisfy the predicate @p@. Subject to fusion.
579+-- 'Text' @t@ satisify the predicate @p@. Subject to fusion.
925all :: (Char -> Bool) -> Text -> Bool
580all :: (Char -> Bool) -> Text -> Bool
926all p t = S.all p (stream t)
581all p t = S.all p (stream t)
927{-# INLINE all #-}
582{-# INLINE all #-}
@@ -943,7 +598,6 @@ minimum t = S.minimum (stream t)
944-- | /O(n)/ 'scanl' is similar to 'foldl', but returns a list of
599-- | /O(n)/ 'scanl' is similar to 'foldl', but returns a list of
945-- successive reduced values from the left. Subject to fusion.
600-- 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, ...]
602-- > scanl f z [x1, x2, ...] == [z, z `f` x1, (z `f` x1) `f` x2, ...]
@@ -951,13 +605,11 @@ minimum t = S.minimum (stream t)
952-- > last (scanl f z xs) == foldl f z xs.
606-- > last (scanl f z xs) == foldl f z xs.
953scanl :: (Char -> Char -> Char) -> Char -> Text -> Text
607scanl :: (Char -> Char -> Char) -> Char -> Text -> Text
954−scanl f z t = unstream (S.scanl g z (stream t))
608+scanl f z t = unstream (S.scanl f z (stream t))
955− where g a b = safe (f a b)
956{-# INLINE scanl #-}
609{-# INLINE scanl #-}
958-- | /O(n)/ 'scanl1' is a variant of 'scanl' that has no starting
611-- | /O(n)/ 'scanl1' is a variant of 'scanl' that has no starting
959−-- value argument. Subject to fusion. Performs replacement on
612+-- value argument. Subject to fusion.
960−-- invalid scalar values.
962-- > scanl1 f [x1, x2, ...] == [x1, x1 `f` x2, ...]
614-- > scanl1 f [x1, x2, ...] == [x1, x1 `f` x2, ...]
963scanl1 :: (Char -> Char -> Char) -> Text -> Text
615scanl1 :: (Char -> Char -> Char) -> Text -> Text
@@ -965,75 +617,49 @@ scanl1 f t | null t = empty
965 | otherwise = scanl f (unsafeHead t) (unsafeTail t)
617 | otherwise = scanl f (unsafeHead t) (unsafeTail t)
966{-# INLINE scanl1 #-}
618{-# INLINE scanl1 #-}
968−-- | /O(n)/ 'scanr' is the right-to-left dual of 'scanl'. Performs
620+-- | /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
622-- > scanr f v == reverse . scanl (flip f) v . reverse
972scanr :: (Char -> Char -> Char) -> Char -> Text -> Text
623scanr :: (Char -> Char -> Char) -> Char -> Text -> Text
973−scanr f z = S.reverse . S.reverseScanr g z . reverseStream
624+scanr f z = S.reverse . S.reverseScanr f z . reverseStream
974− where g a b = safe (f a b)
975{-# INLINE scanr #-}
625{-# INLINE scanr #-}
977-- | /O(n)/ 'scanr1' is a variant of 'scanr' that has no starting
627-- | /O(n)/ 'scanr1' is a variant of 'scanr' that has no starting
978−-- value argument. Subject to fusion. Performs replacement on
628+-- value argument. Subject to fusion.
979−-- invalid scalar values.
980scanr1 :: (Char -> Char -> Char) -> Text -> Text
629scanr1 :: (Char -> Char -> Char) -> Text -> Text
981scanr1 f t | null t = empty
630scanr1 f t | null t = empty
982 | otherwise = scanr f (last t) (init t)
631 | otherwise = scanr f (last t) (init t)
983{-# INLINE scanr1 #-}
632{-# INLINE scanr1 #-}
985−-- | /O(n)/ Like a combination of 'map' and 'foldl''. Applies a
634+-- | /O(n)/ Like a combination of 'map' and 'foldl'. Applies a
986-- function to each element of a 'Text', passing an accumulating
635-- function to each element of a 'Text', passing an accumulating
987−-- parameter from left to right, and returns a final 'Text'. Performs
636+-- 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)
637mapAccumL :: (a -> Char -> (a,Char)) -> a -> Text -> (a, Text)
990−mapAccumL f z0 = S.mapAccumL g z0 . stream
638+mapAccumL f s t = case uncons t of
991− where g a b = second safe (f a b)
639+ Nothing -> (s, empty)
640+ Just (x, xs) -> (s'', cons y ys)
641+ where (s', y ) = f s x
992−{-# INLINE mapAccumL #-}
642+ (s'',ys) = mapAccumL f s' xs
994-- | The 'mapAccumR' function behaves like a combination of 'map' and
644-- | The 'mapAccumR' function behaves like a combination of 'map' and
995−-- a strict 'foldr'; it applies a function to each element of a
645+-- 'foldr'; it applies a function to each element of a 'Text', passing
996−-- 'Text', passing an accumulating parameter from right to left, and
646+-- an accumulating parameter from right to left, and returning a final
997−-- returning a final value of this accumulator together with the new
647+-- 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)
648mapAccumR :: (a -> Char -> (a,Char)) -> a -> Text -> (a, Text)
1001−mapAccumR f z0 = second reverse . S.mapAccumL g z0 . reverseStream
649+mapAccumR f s t = case uncons t of
1002− where g a b = second safe (f a b)
650+ Nothing -> (s, empty)
651+ Just (x, xs) -> (s'', cons y ys)
652+ where (s'',y ) = f s' x
1003−{-# INLINE mapAccumR #-}
653+ (s', ys) = mapAccumR f s xs
1005-- -----------------------------------------------------------------------------
655-- -----------------------------------------------------------------------------
1006-- ** Generating and unfolding 'Text's
656-- ** Generating and unfolding 'Text's
1008−-- | /O(n*m)/ 'replicate' @n@ @t@ is a 'Text' consisting of the input
1009−-- @t@ repeated @n@ times.
1010−replicate :: Int -> Text -> Text
1011−replicate n t@(Text a o l)
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 #-}
1028−"TEXT replicate/singleton -> replicateChar" [~1] forall n c.
1029− replicate n (singleton c) = replicateChar n c
1032−-- | /O(n)/ 'replicateChar' @n@ @c@ is a 'Text' of length @n@ with @c@ the
658+-- | /O(n)/ 'replicate' @n@ @c@ is a 'Text' of length @n@ with @c@ the
1033-- value of every element. Subject to fusion.
659-- value of every element. Subject to fusion.
1034−replicateChar :: Int -> Char -> Text
660+replicate :: Int -> Char -> Text
1035−replicateChar n c = unstream (S.replicateCharI n (safe c))
661+replicate n c = unstream (S.replicate n c)
1036−{-# INLINE replicateChar #-}
662+{-# INLINE replicate #-}
1038-- | /O(n)/, where @n@ is the length of the result. The 'unfoldr'
664-- | /O(n)/, where @n@ is the length of the result. The 'unfoldr'
1039-- function is analogous to the List 'L.unfoldr'. 'unfoldr' builds a
665-- function is analogous to the List 'L.unfoldr'. 'unfoldr' builds a
@@ -1041,9 +667,9 @@ replicateChar n c = unstream (S.replicateCharI n (safe c))
1041-- returns 'Nothing' if it is done producing the 'Text', otherwise
667-- returns 'Nothing' if it is done producing the 'Text', otherwise
1042-- 'Just' @(a,b)@. In this case, @a@ is the next 'Char' in the
668-- '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
669-- string, and @b@ is the seed value for further production. Subject
1044−-- to fusion. Performs replacement on invalid scalar values.
670+-- to fusion.
1045unfoldr :: (a -> Maybe (Char,a)) -> a -> Text
671unfoldr :: (a -> Maybe (Char,a)) -> a -> Text
1046−unfoldr f s = unstream (S.unfoldr (firstf safe . f) s)
672+unfoldr f s = unstream (S.unfoldr f s)
1047{-# INLINE unfoldr #-}
673{-# INLINE unfoldr #-}
1049-- | /O(n)/ Like 'unfoldr', 'unfoldrN' builds a 'Text' from a seed
675-- | /O(n)/ Like 'unfoldr', 'unfoldrN' builds a 'Text' from a seed
@@ -1051,9 +677,9 @@ unfoldr f s = unstream (S.unfoldr (firstf safe . f) s)
1051-- first argument to 'unfoldrN'. This function is more efficient than
677-- first argument to 'unfoldrN'. This function is more efficient than
1052-- 'unfoldr' when the maximum length of the result is known and
678-- 'unfoldr' when the maximum length of the result is known and
1053-- correct, otherwise its performance is similar to 'unfoldr'. Subject
679-- correct, otherwise its performance is similar to 'unfoldr'. Subject
1054−-- to fusion. Performs replacement on invalid scalar values.
680+-- to fusion.
1055unfoldrN :: Int -> (a -> Maybe (Char,a)) -> a -> Text
681unfoldrN :: Int -> (a -> Maybe (Char,a)) -> a -> Text
1056−unfoldrN n f s = unstream (S.unfoldrN n (firstf safe . f) s)
682+unfoldrN n f s = unstream (S.unfoldrN n f s)
1057{-# INLINE unfoldrN #-}
683{-# INLINE unfoldrN #-}
1059-- -----------------------------------------------------------------------------
685-- -----------------------------------------------------------------------------
@@ -1066,16 +692,14 @@ take :: Int -> Text -> Text
1066take n t@(Text arr off len)
692take n t@(Text arr off len)
1067 | n <= 0 = empty
693 | n <= 0 = empty
1068 | n >= len = t
694 | n >= len = t
1069− | otherwise = text arr off (iterN n t)
695+ | otherwise = Text arr off (loop 0 0)
698+ | i >= len || cnt >= n = i
699+ | otherwise = loop (i+d) (cnt+1)
1070{-# INLINE [1] take #-}
701{-# 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
703{-# RULES
1080"TEXT take -> fused" [~1] forall n t.
704"TEXT take -> fused" [~1] forall n t.
1081 take n t = unstream (S.take n (stream t))
705 take n t = unstream (S.take n (stream t))
@@ -1083,36 +707,18 @@ iterN n t@(Text _arr _off len) = loop 0 0
1083 unstream (S.take n (stream t)) = take n t
707 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
710-- | /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@
711+-- '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.
712+-- length of the 'Text'. Subject to fusion.
1110drop :: Int -> Text -> Text
713drop :: Int -> Text -> Text
1111drop n t@(Text arr off len)
714drop n t@(Text arr off len)
1112 | n <= 0 = t
715 | n <= 0 = t
1113 | n >= len = empty
716 | n >= len = empty
1114− | otherwise = text arr (off+i) (len-i)
717+ | otherwise = loop 0 0
1115− where i = iterN n t
718+ where loop !i !cnt
719+ | i >= len || cnt >= n = Text arr (off+i) (len-i)
720+ | otherwise = loop (i+d) (cnt+1)
1116{-# INLINE [1] drop #-}
722{-# INLINE [1] drop #-}
1118{-# RULES
724{-# RULES
@@ -1122,18 +728,6 @@ drop n t@(Text arr off len)
1122 unstream (S.drop n (stream t)) = drop n t
728 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',
731-- | /O(n)/ 'takeWhile', applied to a predicate @p@ and a 'Text',
1138-- returns the longest prefix (possibly empty) of elements that
732-- returns the longest prefix (possibly empty) of elements that
1139-- satisfy @p@. Subject to fusion.
733-- satisfy @p@. Subject to fusion.
@@ -1141,8 +735,8 @@ takeWhile :: (Char -> Bool) -> Text -> Text
1141takeWhile p t@(Text arr off len) = loop 0
735takeWhile p t@(Text arr off len) = loop 0
1142 where loop !i | i >= len = t
736 where loop !i | i >= len = t
1143 | p c = loop (i+d)
737 | p c = loop (i+d)
1144− | otherwise = text arr off i
738+ | otherwise = textP arr off i
1145− where Iter c d = iter t i
739+ where (c,d) = iter t i
1146{-# INLINE [1] takeWhile #-}
740{-# INLINE [1] takeWhile #-}
1148{-# RULES
742{-# RULES
@@ -1152,27 +746,6 @@ takeWhile p t@(Text arr off len) = loop 0
1152 unstream (S.takeWhile p (stream t)) = takeWhile p t
746 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
749-- | /O(n)/ 'dropWhile' @p@ @t@ returns the suffix remaining after
1177-- 'takeWhile' @p@ @t@. Subject to fusion.
750-- 'takeWhile' @p@ @t@. Subject to fusion.
1178dropWhile :: (Char -> Bool) -> Text -> Text
751dropWhile :: (Char -> Bool) -> Text -> Text
@@ -1180,7 +753,7 @@ dropWhile p t@(Text arr off len) = loop 0 0
1180 where loop !i !l | l >= len = empty
753 where loop !i !l | l >= len = empty
1181 | p c = loop (i+d) (l+d)
754 | p c = loop (i+d) (l+d)
1182 | otherwise = Text arr (off+i) (len-l)
755 | otherwise = Text arr (off+i) (len-l)
1183− where Iter c d = iter t i
756+ where (c,d) = iter t i
1184{-# INLINE [1] dropWhile #-}
757{-# INLINE [1] dropWhile #-}
1186{-# RULES
759{-# RULES
@@ -1191,9 +764,8 @@ dropWhile p t@(Text arr off len) = loop 0 0
1193-- | /O(n)/ 'dropWhileEnd' @p@ @t@ returns the prefix remaining after
766-- | /O(n)/ 'dropWhileEnd' @p@ @t@ returns the prefix remaining after
1194−-- dropping characters that satisfy the predicate @p@ from the end of
767+-- dropping characters that fail the predicate @p@ from the end of
1195-- @t@. Subject to fusion.
768-- @t@. Subject to fusion.
1197-- Examples:
769-- Examples:
1199-- > dropWhileEnd (=='.') "foo..." == "foo"
771-- > dropWhileEnd (=='.') "foo..." == "foo"
@@ -1213,7 +785,7 @@ dropWhileEnd p t@(Text arr off len) = loop (len-1) len
1215-- | /O(n)/ 'dropAround' @p@ @t@ returns the substring remaining after
787-- | /O(n)/ 'dropAround' @p@ @t@ returns the substring remaining after
1216−-- dropping characters that satisfy the predicate @p@ from both the
788+-- dropping characters that fail the predicate @p@ from both the
1217-- beginning and end of @t@. Subject to fusion.
789-- beginning and end of @t@. Subject to fusion.
1218dropAround :: (Char -> Bool) -> Text -> Text
790dropAround :: (Char -> Bool) -> Text -> Text
1219dropAround p = dropWhile p . dropWhileEnd p
791dropAround p = dropWhile p . dropWhileEnd p
@@ -1222,16 +794,16 @@ dropAround p = dropWhile p . dropWhileEnd p
1222-- | /O(n)/ Remove leading white space from a string. Equivalent to:
794-- | /O(n)/ Remove leading white space from a string. Equivalent to:
1224-- > dropWhile isSpace
796-- > dropWhile isSpace
1225−stripStart :: Text -> Text
797+stripLeft :: Text -> Text
1226−stripStart = dropWhile isSpace
798+stripLeft = dropWhile isSpace
1227−{-# INLINE [1] stripStart #-}
799+{-# INLINE [1] stripLeft #-}
1229-- | /O(n)/ Remove trailing white space from a string. Equivalent to:
801-- | /O(n)/ Remove trailing white space from a string. Equivalent to:
1231-- > dropWhileEnd isSpace
803-- > dropWhileEnd isSpace
1232−stripEnd :: Text -> Text
804+stripRight :: Text -> Text
1233−stripEnd = dropWhileEnd isSpace
805+stripRight = dropWhileEnd isSpace
1234−{-# INLINE [1] stripEnd #-}
806+{-# INLINE [1] stripRight #-}
1236-- | /O(n)/ Remove leading and trailing white space from a string.
808-- | /O(n)/ Remove leading and trailing white space from a string.
1237-- Equivalent to:
809-- Equivalent to:
@@ -1248,20 +820,28 @@ splitAt :: Int -> Text -> (Text, Text)
1248splitAt n t@(Text arr off len)
820splitAt n t@(Text arr off len)
1249 | n <= 0 = (empty, t)
821 | n <= 0 = (empty, t)
1250 | n >= len = (t, empty)
822 | n >= len = (t, empty)
1251− | otherwise = let k = iterN n t
823+ | otherwise = (Text arr off k, Text arr (off+k) (len-k))
1252− in (text arr off k, text arr (off+k) (len-k))
824+ where k = loop 0 0
826+ | i >= len || cnt >= n = i
827+ | otherwise = loop (i+d) (cnt+1)
829+{-# INLINE splitAt #-}
1254−-- | /O(n)/ 'span', applied to a predicate @p@ and text @t@, returns
831+-- | /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)
832+-- pair whose first element is the longest prefix (possibly empty) of
1256−-- of @t@ of elements that satisfy @p@, and whose second is the
833+-- @t@ of elements that satisfy @p@, and whose second is the remainder
1257−-- remainder of the list.
834+-- of the list.
1258span :: (Char -> Bool) -> Text -> (Text, Text)
835span :: (Char -> Bool) -> Text -> (Text, Text)
1259−span p t = case span_ p t of
836+span p t@(Text arr off len) = (textP arr off k, textP arr (off+k) (len-k))
1260− (# hd,tl #) -> (hd,tl)
837+ where k = loop 0
838+ loop !i | i >= len || not (p c) = i
839+ | otherwise = loop (i+d)
840+ where (c,d) = iter t i
1261{-# INLINE span #-}
841{-# INLINE span #-}
1263−-- | /O(n)/ 'break' is like 'span', but the prefix returned is
843+-- | /O(n)/ 'break' is like 'span', but the prefix returned is over
1264−-- over elements that fail the predicate @p@.
844+-- elements that fail the predicate @p@.
1265break :: (Char -> Bool) -> Text -> (Text, Text)
845break :: (Char -> Bool) -> Text -> (Text, Text)
1266break p = span (not . p)
846break p = span (not . p)
1267{-# INLINE break #-}
847{-# INLINE break #-}
@@ -1273,7 +853,7 @@ groupBy p = loop
1273 loop t@(Text arr off len)
853 loop t@(Text arr off len)
1274 | null t = []
854 | null t = []
1275 | otherwise = text arr off n : loop (text arr (off+n) (len-n))
855 | otherwise = text arr off n : loop (text arr (off+n) (len-n))
1276− where Iter c d = iter t 0
856+ where (c,d) = iter t 0
1277 n = d + findAIndexOrEnd (not . p c) (Text arr (off+d) (len-d))
857 n = d + findAIndexOrEnd (not . p c) (Text arr (off+d) (len-d))
1279-- | Returns the /array/ index (in units of 'Word16') at which a
859-- | Returns the /array/ index (in units of 'Word16') at which a
@@ -1283,8 +863,8 @@ findAIndexOrEnd :: (Char -> Bool) -> Text -> Int
1283findAIndexOrEnd q t@(Text _arr _off len) = go 0
863findAIndexOrEnd q t@(Text _arr _off len) = go 0
1284 where go !i | i >= len || q c = i
864 where go !i | i >= len || q c = i
1285 | otherwise = go (i+d)
865 | otherwise = go (i+d)
1286− where Iter c d = iter t i
866+ where (c,d) = iter t i
1288-- | /O(n)/ Group characters in a string by equality.
868-- | /O(n)/ Group characters in a string by equality.
1289group :: Text -> [Text]
869group :: Text -> [Text]
1290group = groupBy (==)
870group = groupBy (==)
@@ -1302,65 +882,116 @@ tails :: Text -> [Text]
1302tails t | null t = [empty]
882tails t | null t = [empty]
1303 | otherwise = t : tails (unsafeTail t)
883 | otherwise = t : tails (unsafeTail t)
885+-- | /O(n)/ Break a 'Text' into pieces separated by the 'Char'
886+-- argument, consuming the delimiter. I.e.
888+-- > splitChar '\n' "a\nb\nd\ne" == ["a","b","d","e"]
889+-- > splitChar 'a' "aXaXaXa" == ["","X","X","X",""]
890+-- > splitChar 'x' "x" == ["",""]
894+-- > intercalate (singleton c) . splitChar c == id
895+-- > splitChar == splitWith . (==)
896+splitChar :: Char -> Text -> [Text]
897+splitChar c = splitWith (==c)
898+{-# INLINE splitChar #-}
1305-- $split
900-- $split
1307-- Splitting functions in this library do not perform character-wise
902-- Splitting functions in this library do not perform character-wise
1308-- copies to create substrings; they just construct new 'Text's that
903-- copies to create substrings; they just construct new 'Text's that
1309-- are slices of the original.
904-- are slices of the original.
1311−-- | /O(m+n)/ Break a 'Text' into pieces separated by the first 'Text'
906+-- | /O(m)*O(n)/ Break a 'Text' into pieces separated by the first
1312−-- argument (which cannot be empty), consuming the delimiter. An empty
907+-- 'Text' argument, consuming the delimiter. Examples:
1313−-- delimiter is invalid, and will cause an error to be raised.
908+--
909+-- > split "\r\n" "a\r\nb\r\nd\r\ne" == ["a","b","d","e"]
910+-- > split "aaa" "aaaXaaaXaaaXaaa" == ["","X","X","X",""]
911+-- > split "x" "x" == ["",""]
915+-- > intercalate s . split s == id
916+split :: Text -- ^ Text to split on
917+ -> Text -- ^ Input text
921+ | otherwise = go src0
924+ go src = search 0 src
927+ | null s = [src] -- not found
928+ | pat `isPrefixOf` s = take n src : go (drop l s)
929+ | otherwise = search (n+1) (unsafeTail s)
932+-- | /O(m)*O(n)/ Break a 'Text' into pieces at most @k@ times,
933+-- treating the first 'Text' argument as the delimiter to break on,
934+-- and consuming the delimiter. The last element of the list contains
935+-- the remaining text after the number of times to split has been
936+-- reached. A value of zero or less for @k@ causes no splitting to
1315-- Examples:
939-- Examples:
1317−-- > splitOn "\r\n" "a\r\nb\r\nd\r\ne" == ["a","b","d","e"]
941+-- > splitTimes 0 "//" "a//b//c" == ["a//b//c"]
1318−-- > splitOn "aaa" "aaaXaaaXaaaXaaa" == ["","X","X","X",""]
942+-- > splitTimes 2 ":" "a:b:c:d:e" == ["a","b","c:d:e"]
1319−-- > splitOn "x" "x" == ["",""]
943+-- > splitTimes 100 "???" "a????b" == ["a","?b"]
1323−-- > intercalate s . splitOn s == id
947+-- > intercalate s . splitTimes k s == id
1324−-- > splitOn (singleton c) == split (==c)
948+splitTimes :: Int -- ^ Maximum number of times to split
949+ -> Text -- ^ Text to split on
950+ -> Text -- ^ Input text
952+splitTimes k pat src0
953+ | k <= 0 || l == 0 = [src0]
954+ | otherwise = go k src0
957+ go !i src = search 0 src
960+ | i == 0 || null s = [src] -- not found or limit reached
961+ | pat `isPrefixOf` s = take n src : go (i-1) (drop l s)
962+ | otherwise = search (n+1) (unsafeTail s)
963+{-# INLINE splitTimes #-}
965+-- | /O(m)*O(n)/ Break a 'Text' into pieces at most @k@ times, like
966+-- 'splitTimes', but start from the end of the input and work towards
1326−-- (Note: the string @s@ to split on above cannot be empty.)
969+-- Examples:
1328−-- In (unlikely) bad cases, this function's time complexity degrades
971+-- > splitTimes 2 "::" "a::b::c::d::e" == ["a","b","c::d::e"]
1329−-- towards /O(n*m)/.
972+-- > splitTimesEnd 2 "::" "a::b::c::d::e" == ["a::b::c","d","e"]
1330−splitOn :: Text
973+splitTimesEnd :: Int -- ^ Maximum number of times to split
1331− -- ^ String to split on. If this string is empty, an error
974+ -> Text -- ^ Text to split on
1334− -- ^ Input text.
975+ -> Text -- ^ Input text
1335− -> [Text]
976+ -> [Text]
1336−splitOn pat@(Text _ _ l) src@(Text arr off len)
977+splitTimesEnd k pat src =
1337− | l <= 0 = emptyError "splitOn"
978+ L.reverse . L.map reverse $ splitTimes k (reverse pat) (reverse src)
1338− | isSingleton pat = split (== unsafeHead pat) src
979+{-# INLINE splitTimesEnd #-}
1339− | otherwise = go 0 (indices pat src)
1341− go !s (x:xs) = text arr (s+off) (x-s) : go (x+l) xs
1342− go s _ = [text arr (s+off) (len-s)]
1343−{-# INLINE [1] splitOn #-}
1346−"TEXT splitOn/singleton -> split/==" [~1] forall c t.
1347− splitOn (singleton c) t = split (==c) t
1350-- | /O(n)/ Splits a 'Text' into components delimited by separators,
981-- | /O(n)/ Splits a 'Text' into components delimited by separators,
1351-- where the predicate returns True for a separator element. The
982-- where the predicate returns True for a separator element. The
1352-- resulting components do not contain the separators. Two adjacent
983-- resulting components do not contain the separators. Two adjacent
1353-- separators result in an empty component in the output. eg.
984-- separators result in an empty component in the output. eg.
1355−-- > split (=='a') "aabbaca" == ["","","bb","c",""]
986+-- > splitWith (=='a') "aabbaca" == ["","","bb","c",""]
1356−-- > split (=='a') "" == [""]
987+-- > splitWith (=='a') "" == [""]
1357−split :: (Char -> Bool) -> Text -> [Text]
988+splitWith :: (Char -> Bool) -> Text -> [Text]
1358−split _ t@(Text _off _arr 0) = [t]
989+splitWith _ t@(Text _off _arr 0) = [t]
1359−split p t = loop t
990+splitWith p t = loop t
1360 where loop s | null s' = [l]
991 where loop s | null s' = [l]
1361 | otherwise = l : loop (unsafeTail s')
992 | otherwise = l : loop (unsafeTail s')
1362− where (# l, s' #) = span_ (not . p) s
993+ where (l, s') = break p s
1363−{-# INLINE split #-}
994+{-# INLINE splitWith #-}
1365-- | /O(n)/ Splits a 'Text' into components of length @k@. The last
996-- | /O(n)/ Splits a 'Text' into components of length @k@. The last
1366-- element may be shorter than the other chunks, depending on the
997-- element may be shorter than the other chunks, depending on the
@@ -1379,14 +1010,22 @@ chunksOf k = go
1379-- ----------------------------------------------------------------------------
1010-- ----------------------------------------------------------------------------
1380-- * Searching
1011-- * Searching
1013+-------------------------------------------------------------------------------
1014+-- ** Searching by equality
1016+-- | /O(n)/ 'elem' is the 'Text' membership predicate.
1017+elem :: Char -> Text -> Bool
1018+elem c t = S.elem c (stream t)
1382-------------------------------------------------------------------------------
1021-------------------------------------------------------------------------------
1383-- ** Searching with a predicate
1022-- ** Searching with a predicate
1385−-- | /O(n)/ The 'find' function takes a predicate and a 'Text', and
1024+-- | /O(n)/ The 'find' function takes a predicate and a 'Text',
1386−-- returns the first element matching the predicate, or 'Nothing' if
1025+-- and returns the first element in matching the predicate, or 'Nothing'
1387−-- there is no such element.
1026+-- if there is no such element.
1388find :: (Char -> Bool) -> Text -> Maybe Char
1027find :: (Char -> Bool) -> Text -> Maybe Char
1389−find p t = S.findBy p (stream t)
1028+find p t = S.find p (stream t)
1390{-# INLINE find #-}
1029{-# INLINE find #-}
1392-- | /O(n)/ The 'partition' function takes a predicate and a 'Text',
1031-- | /O(n)/ The 'partition' function takes a predicate and a 'Text',
@@ -1405,76 +1044,6 @@ filter :: (Char -> Bool) -> Text -> Text
1405filter p t = unstream (S.filter p (stream t))
1044filter p t = unstream (S.filter p (stream t))
1406{-# INLINE filter #-}
1045{-# INLINE filter #-}
1408−-- | /O(n+m)/ Find the first instance of @needle@ (which must be
1409−-- non-'null') in @haystack@. The first element of the returned tuple
1410−-- is the prefix of @haystack@ before @needle@ is matched. The second
1411−-- is the remainder of @haystack@, starting with the match.
1415−-- > breakOn "::" "a::b::c" ==> ("a", "::b::c")
1416−-- > breakOn "/" "foobar" ==> ("foobar", "")
1420−-- > append prefix match == haystack
1421−-- > where (prefix, match) = breakOn 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
1428−-- towards /O(n*m)/.
1429−breakOn :: Text -> Text -> (Text, Text)
1430−breakOn pat src@(Text arr off len)
1431− | null pat = emptyError "breakOn"
1432− | otherwise = case indices pat src of
1434− (x:_) -> (text arr off x, text arr (off+x) (len-x))
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))
1476− chunk !n !l = text arr (n+off) l
1477−{-# INLINE breakOnAll #-}
1479-------------------------------------------------------------------------------
1048-------------------------------------------------------------------------------
1480-- ** Indexing 'Text's
1049-- ** Indexing 'Text's
@@ -1493,7 +1062,8 @@ breakOnAll pat src@(Text arr off slen)
1493-- For example, suppose you have a string that you want to split on
1062-- For example, suppose you have a string that you want to split on
1494-- the substring @\"::\"@, such as @\"foo::bar::quux\"@. Instead of
1063-- the substring @\"::\"@, such as @\"foo::bar::quux\"@. Instead of
1495-- searching for the index of @\"::\"@ and taking the substrings
1064-- searching for the index of @\"::\"@ and taking the substrings
1496−-- before and after that index, you would instead use @breakOnAll \"::\"@.
1065+-- before and after that index, you would instead use @splitTimes 1
1498-- | /O(n)/ 'Text' index (subscript) operator, starting from 0.
1068-- | /O(n)/ 'Text' index (subscript) operator, starting from 0.
1499index :: Text -> Int -> Char
1069index :: Text -> Int -> Char
@@ -1507,29 +1077,32 @@ findIndex :: (Char -> Bool) -> Text -> Maybe Int
1507findIndex p t = S.findIndex p (stream t)
1077findIndex p t = S.findIndex p (stream t)
1508{-# INLINE findIndex #-}
1078{-# INLINE findIndex #-}
1510−-- | /O(n+m)/ The 'count' function returns the number of times the
1080+-- | The 'findIndices' function extends 'findIndex', by returning the
1511−-- query string appears in the given 'Text'. An empty query string is
1081+-- indices of all elements satisfying the predicate, in ascending
1512−-- invalid, and will cause an error to be raised.
1082+-- order. Subject to fusion.
1513−--
1083+findIndices :: (Char -> Bool) -> Text -> [Int]
1514−-- In (unlikely) bad cases, this function's time complexity degrades
1084+findIndices p t = S.findIndices p (stream t)
1515−-- towards /O(n*m)/.
1516−count :: Text -> Text -> Int
1518− | null pat = emptyError "count"
1519− | isSingleton pat = countChar (unsafeHead pat) src
1520− | otherwise = L.length (indices pat src)
1521−{-# INLINE [1] count #-}
1085+{-# INLINE findIndices #-}
1523−{-# RULES
1087+-- | /O(n)/ The 'elemIndex' function returns the index of the first
1524−"TEXT count/singleton -> countChar" [~1] forall c t.
1088+-- element in the given 'Text' which is equal to the query element, or
1525− count (singleton c) t = countChar c t
1089+-- 'Nothing' if there is no such element. Subject to fusion.
1526− #-}
1090+elemIndex :: Char -> Text -> Maybe Int
1527−
1091+elemIndex c t = S.elemIndex c (stream t)
1092+{-# INLINE elemIndex #-}
1094+-- | /O(n)/ The 'elemIndices' function returns the index of every
1095+-- element in the given 'Text' which is equal to the query
1096+-- element. Subject to fusion.
1097+elemIndices :: Char -> Text -> [Int]
1098+elemIndices c t = S.elemIndices c (stream t)
1099+{-# INLINE elemIndices #-}
1528−-- | /O(n)/ The 'countChar' function returns the number of times the
1101+-- | /O(n)/ The 'count' function returns the number of times the query
1529−-- query element appears in the given 'Text'. Subject to fusion.
1102+-- element appears in the given 'Text'. Subject to fusion.
1530−countChar :: Char -> Text -> Int
1103+count :: Char -> Text -> Int
1531−countChar c t = S.countChar c (stream t)
1104+count c t = S.count c (stream t)
1532−{-# INLINE countChar #-}
1105+{-# INLINE count #-}
1534-------------------------------------------------------------------------------
1107-------------------------------------------------------------------------------
1535-- * Zipping
1108-- * Zipping
@@ -1540,15 +1113,13 @@ countChar c t = S.countChar c (stream t)
1540-- equivalent to a pair of 'unpack' operations.
1113-- equivalent to a pair of 'unpack' operations.
1541zip :: Text -> Text -> [(Char,Char)]
1114zip :: Text -> Text -> [(Char,Char)]
1542zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1115zip a b = S.unstreamList $ S.zipWith (,) (stream a) (stream b)
1543−{-# INLINE zip #-}
1116+{-# INLINE [0] zip #-}
1545-- | /O(n)/ 'zipWith' generalises 'zip' by zipping with the function
1118-- | /O(n)/ 'zipWith' generalises 'zip' by zipping with the function
1546-- given as the first argument, instead of a tupling function.
1119-- given as the first argument, instead of a tupling function.
1547−-- Performs replacement on invalid scalar values.
1548zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
1120zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
1549−zipWith f t1 t2 = unstream (S.zipWith g (stream t1) (stream t2))
1121+zipWith f t1 t2 = unstream (S.zipWith f (stream t1) (stream t2))
1550− where g a b = safe (f a b)
1551−{-# INLINE zipWith #-}
1122+{-# INLINE [0] zipWith #-}
1553-- | /O(n)/ Breaks a 'Text' up into a list of words, delimited by 'Char's
1124-- | /O(n)/ Breaks a 'Text' up into a list of words, delimited by 'Char's
1554-- representing white space.
1125-- representing white space.
@@ -1564,7 +1135,7 @@ words t@(Text arr off len) = loop 0 0
1564 then loop (start+1) (start+1)
1135 then loop (start+1) (start+1)
1565 else Text arr (start+off) (n-start) : loop (n+d) (n+d)
1136 else Text arr (start+off) (n-start) : loop (n+d) (n+d)
1566 | otherwise = loop start (n+d)
1137 | otherwise = loop start (n+d)
1567− where Iter c d = iter t n
1138+ where (c,d) = iter t n
1568{-# INLINE words #-}
1139{-# INLINE words #-}
1570-- | /O(n)/ Breaks a 'Text' up into a list of 'Text's at
1141-- | /O(n)/ Breaks a 'Text' up into a list of 'Text's at
@@ -1574,10 +1145,9 @@ lines ps | null ps = []
1574 | otherwise = h : if null t
1145 | otherwise = h : if null t
1576 else lines (unsafeTail t)
1147 else lines (unsafeTail t)
1577− where (# h,t #) = span_ (/= '\n') ps
1148+ where (h,t) = span (/= '\n') ps
1578{-# INLINE lines #-}
1149{-# INLINE lines #-}
1581-- | /O(n)/ Portably breaks a 'Text' up into a list of 'Text's at line
1151-- | /O(n)/ Portably breaks a 'Text' up into a list of 'Text's at line
1582-- boundaries.
1152-- boundaries.
@@ -1585,6 +1155,7 @@ lines ps | null ps = []
1585-- return immediately followed by a line feed, or a carriage return.
1155-- return immediately followed by a line feed, or a carriage return.
1586-- This accounts for both Unix and Windows line ending conventions,
1156-- This accounts for both Unix and Windows line ending conventions,
1587-- and for the old convention used on Mac OS 9 and earlier.
1157-- and for the old convention used on Mac OS 9 and earlier.
1588lines' :: Text -> [Text]
1159lines' :: Text -> [Text]
1589lines' ps | null ps = []
1160lines' ps | null ps = []
1590 | otherwise = h : case uncons t of
1161 | otherwise = h : case uncons t of
@@ -1611,7 +1182,8 @@ unwords = intercalate (singleton ' ')
1611{-# INLINE unwords #-}
1182{-# INLINE unwords #-}
1613-- | /O(n)/ The 'isPrefixOf' function takes two 'Text's and returns
1184-- | /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.
1185+-- 'True' iff the first is a prefix of the second. This function is
1186+-- subject to fusion.
1615isPrefixOf :: Text -> Text -> Bool
1187isPrefixOf :: Text -> Text -> Bool
1616isPrefixOf a@(Text _ _ alen) b@(Text _ _ blen) =
1188isPrefixOf a@(Text _ _ alen) b@(Text _ _ blen) =
1617 alen <= blen && S.isPrefixOf (stream a) (stream b)
1189 alen <= blen && S.isPrefixOf (stream a) (stream b)
@@ -1620,6 +1192,8 @@ isPrefixOf a@(Text _ _ alen) b@(Text _ _ blen) =
1620{-# RULES
1192{-# RULES
1621"TEXT isPrefixOf -> fused" [~1] forall s t.
1193"TEXT isPrefixOf -> fused" [~1] forall s t.
1622 isPrefixOf s t = S.isPrefixOf (stream s) (stream t)
1194 isPrefixOf s t = S.isPrefixOf (stream s) (stream t)
1195+"TEXT isPrefixOf -> unfused" [1] forall s t.
1196+ S.isPrefixOf (stream s) (stream t) = isPrefixOf s t
1625-- | /O(n)/ The 'isSuffixOf' function takes two 'Text's and returns
1199-- | /O(n)/ The 'isSuffixOf' function takes two 'Text's and returns
@@ -1632,124 +1206,13 @@ isSuffixOf a@(Text _aarr _aoff alen) b@(Text barr boff blen) =
1632 | otherwise = Text barr (boff+d) alen
1206 | otherwise = Text barr (boff+d) alen
1633{-# INLINE isSuffixOf #-}
1207{-# INLINE isSuffixOf #-}
1635−-- | /O(n+m)/ The 'isInfixOf' function takes two 'Text's and returns
1209+-- | /O(n)/ The 'isInfixOf' function takes two 'Text's and returns
1636-- 'True' iff the first is contained, wholly and intact, anywhere
1210-- 'True' iff the first is contained, wholly and intact, anywhere
1637-- within the second.
1211-- within the second.
1639−-- In (unlikely) bad cases, this function's time complexity degrades
1640−-- towards /O(n*m)/.
1641isInfixOf :: Text -> Text -> Bool
1212isInfixOf :: Text -> Text -> Bool
1642−isInfixOf needle haystack
1213+isInfixOf needle haystack = L.any (isPrefixOf needle) (tails haystack)
1643− | null needle = True
1214+{-# INLINE isInfixOf #-}
1644− | isSingleton needle = S.elem (unsafeHead needle) . S.stream $ haystack
1215+-- TODO: a better implementation
1645− | otherwise = not . L.null . indices needle $ haystack
1646−{-# INLINE [1] 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
1217emptyError :: String -> a
1735−emptyError fun = P.error $ "Data.Text." ++ fun ++ ": empty input"
1218+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