FastString.lhs 18.3 KB
Newer Older
1
%
2
% (c) The University of Glasgow, 1997-2006
3
%
4
\begin{code}
5 6 7 8
{-# OPTIONS -fno-warn-unused-imports #-}
-- XXX GHC 6.9 seems to be confused by unpackCString# being used only in
--     a RULE

9 10 11 12
{-# OPTIONS_GHC -O -funbox-strict-fields #-}
-- We always optimise this, otherwise performance of a non-optimised
-- compiler is severely affected

13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
-- |
-- There are two principal string types used internally by GHC:
--
-- 'FastString':
--               * A compact, hash-consed, representation of character strings.
--               * Comparison is O(1), and you can get a 'Unique.Unique' from them.
--               * Generated by 'fsLit'.
--               * Turn into 'Outputable.SDoc' with 'Outputable.ftext'.
--
-- 'LitString':
--               * Just a wrapper for the @Addr#@ of a C string (@Ptr CChar@).
--               * Practically no operations.
--               * Outputing them is fast.
--               * Generated by 'sLit'.
--               * Turn into 'Outputable.SDoc' with 'Outputable.ptext'
--
-- Use 'LitString' unless you want the facilities of 'FastString'.
30 31
module FastString
       (
Ian Lynagh's avatar
Ian Lynagh committed
32 33
        -- * FastStrings
        FastString(..),     -- not abstract, for now.
34

Ian Lynagh's avatar
Ian Lynagh committed
35
        -- ** Construction
36
        fsLit,
37
        mkFastString,
Ian Lynagh's avatar
Ian Lynagh committed
38
        mkFastStringBytes,
39
        mkFastStringByteList,
Ian Lynagh's avatar
Ian Lynagh committed
40
        mkFastStringForeignPtr,
41
#if defined(__GLASGOW_HASKELL__)
Ian Lynagh's avatar
Ian Lynagh committed
42
        mkFastString#,
43
#endif
Ian Lynagh's avatar
Ian Lynagh committed
44 45
        mkZFastString,
        mkZFastStringBytes,
46

Ian Lynagh's avatar
Ian Lynagh committed
47 48 49
        -- ** Deconstruction
        unpackFS,           -- :: FastString -> String
        bytesFS,            -- :: FastString -> [Word8]
50

Ian Lynagh's avatar
Ian Lynagh committed
51 52 53
        -- ** Encoding
        isZEncoded,
        zEncodeFS,
54

Ian Lynagh's avatar
Ian Lynagh committed
55
        -- ** Operations
56
        uniqueOfFS,
Ian Lynagh's avatar
Ian Lynagh committed
57 58 59
        lengthFS,
        nullFS,
        appendFS,
60 61
        headFS,
        tailFS,
Ian Lynagh's avatar
Ian Lynagh committed
62
        concatFS,
63
        consFS,
Ian Lynagh's avatar
Ian Lynagh committed
64
        nilFS,
65

Ian Lynagh's avatar
Ian Lynagh committed
66
        -- ** Outputing
67 68
        hPutFS,

Ian Lynagh's avatar
Ian Lynagh committed
69 70 71
        -- ** Internal
        getFastStringTable,
        hasZEncoding,
72

Ian Lynagh's avatar
Ian Lynagh committed
73 74
        -- * LitStrings
        LitString,
75 76 77
        
        -- ** Construction
        sLit,
78
#if defined(__GLASGOW_HASKELL__)
Ian Lynagh's avatar
Ian Lynagh committed
79
        mkLitString#,
80
#endif
Ian Lynagh's avatar
Ian Lynagh committed
81
        mkLitString,
82 83
        
        -- ** Deconstruction
Ian Lynagh's avatar
Ian Lynagh committed
84
        unpackLitString,
85 86 87
        
        -- ** Operations
        lengthLS
88 89
       ) where

90
#include "HsVersions.h"
91

92
import Encoding
93 94
import FastTypes
import FastFunctions
95
import Panic
96

97 98
import Foreign
import Foreign.C
99
import GHC.Exts
100
import System.IO
101
import System.IO.Unsafe ( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
102 103 104
import Data.IORef       ( IORef, newIORef, readIORef, writeIORef )
import Data.Maybe       ( isJust )
import Data.Char        ( ord )
105

Ian Lynagh's avatar
Ian Lynagh committed
106 107
import GHC.IOBase       ( IO(..) )
import GHC.Ptr          ( Ptr(..) )
Ian Lynagh's avatar
Ian Lynagh committed
108 109 110
#if defined(__GLASGOW_HASKELL__)
import GHC.Base         ( unpackCString# )
#endif
111

112 113
#define hASH_TBL_SIZE          4091
#define hASH_TBL_SIZE_UNBOXED  4091#
114 115


116 117 118 119 120
{-|
A 'FastString' is an array of bytes, hashed to support fast O(1)
comparison.  It is also associated with a character encoding, so that
we know how to convert a 'FastString' to the local encoding, or to the
Z-encoding used by the compiler internally.
121

122 123 124 125
'FastString's support a memoized conversion to the Z-encoding via zEncodeFS.
-}

data FastString = FastString {
Ian Lynagh's avatar
Ian Lynagh committed
126 127 128
      uniq    :: {-# UNPACK #-} !Int, -- unique id
      n_bytes :: {-# UNPACK #-} !Int, -- number of bytes
      n_chars :: {-# UNPACK #-} !Int, -- number of chars
129 130 131 132 133
      buf     :: {-# UNPACK #-} !(ForeignPtr Word8),
      enc     :: FSEncoding
  }

data FSEncoding
Ian Lynagh's avatar
Ian Lynagh committed
134
    -- including strings that don't need any encoding
135
  = ZEncoded
Ian Lynagh's avatar
Ian Lynagh committed
136
    -- A UTF-8 string with a memoized Z-encoding
137
  | UTF8Encoded {-# UNPACK #-} !(IORef (Maybe FastString))
138

139 140
instance Eq FastString where
  f1 == f2  =  uniq f1 == uniq f2
141

142
instance Ord FastString where
Ian Lynagh's avatar
Ian Lynagh committed
143
    -- Compares lexicographically, not by unique
144
    a <= b = case cmpFS a b of { LT -> True;  EQ -> True;  GT -> False }
Ian Lynagh's avatar
Ian Lynagh committed
145
    a <  b = case cmpFS a b of { LT -> True;  EQ -> False; GT -> False }
146
    a >= b = case cmpFS a b of { LT -> False; EQ -> True;  GT -> True  }
Ian Lynagh's avatar
Ian Lynagh committed
147 148 149 150 151
    a >  b = case cmpFS a b of { LT -> False; EQ -> False; GT -> True  }
    max x y | x >= y    =  x
            | otherwise =  y
    min x y | x <= y    =  x
            | otherwise =  y
152
    compare a b = cmpFS a b
153

154 155 156
instance Show FastString where
   show fs = show (unpackFS fs)

157 158 159
cmpFS :: FastString -> FastString -> Ordering
cmpFS (FastString u1 l1 _ buf1 _) (FastString u2 l2 _ buf2 _) =
  if u1 == u2 then EQ else
Isaac Dupree's avatar
Isaac Dupree committed
160 161 162 163 164 165 166 167 168 169 170
  case unsafeMemcmp buf1 buf2 (min l1 l2) `compare` 0 of
     LT -> LT
     EQ -> compare l1 l2
     GT -> GT

unsafeMemcmp :: ForeignPtr a -> ForeignPtr b -> Int -> Int
unsafeMemcmp buf1 buf2 l =
      inlinePerformIO $
        withForeignPtr buf1 $ \p1 ->
        withForeignPtr buf2 $ \p2 ->
          memcmp p1 p2 l
171

172
#ifndef __HADDOCK__
Ian Lynagh's avatar
Ian Lynagh committed
173
foreign import ccall unsafe "ghc_memcmp"
174 175
  memcmp :: Ptr a -> Ptr b -> Int -> IO Int
#endif
176

177 178
-- -----------------------------------------------------------------------------
-- Construction
179

180
{-
181 182 183 184
Internally, the compiler will maintain a fast string symbol
table, providing sharing and fast comparison. Creation of
new @FastString@s then covertly does a lookup, re-using the
@FastString@ if there was a hit.
185
-}
186

Ian Lynagh's avatar
Ian Lynagh committed
187
data FastStringTable =
188
 FastStringTable
189
    {-# UNPACK #-} !Int
190
    (MutableArray# RealWorld [FastString])
191

192
{-# NOINLINE string_table #-}
193
string_table :: IORef FastStringTable
Ian Lynagh's avatar
Ian Lynagh committed
194
string_table =
195
 unsafePerformIO $ do
196 197 198 199
   tab <- IO $ \s1# -> case newArray# hASH_TBL_SIZE_UNBOXED [] s1# of
                           (# s2#, arr# #) ->
                               (# s2#, FastStringTable 0 arr# #)
   newIORef tab
200 201 202 203 204 205 206 207 208

lookupTbl :: FastStringTable -> Int -> IO [FastString]
lookupTbl (FastStringTable _ arr#) (I# i#) =
  IO $ \ s# -> readArray# arr# i# s#

updTbl :: IORef FastStringTable -> FastStringTable -> Int -> [FastString] -> IO ()
updTbl fs_table_var (FastStringTable uid arr#) (I# i#) ls = do
  (IO $ \ s# -> case writeArray# arr# i# ls s# of { s2# -> (# s2#, () #) })
  writeIORef fs_table_var (FastStringTable (uid+1) arr#)
209

210
mkFastString# :: Addr# -> FastString
211
mkFastString# a# = mkFastStringBytes ptr (ptrStrLength ptr)
212
  where ptr = Ptr a#
213

214 215
mkFastStringBytes :: Ptr Word8 -> Int -> FastString
mkFastStringBytes ptr len = unsafePerformIO $ do
216
  ft@(FastStringTable uid _) <- readIORef string_table
217
  let
218 219
   h = hashStr ptr len
   add_it ls = do
Ian Lynagh's avatar
Ian Lynagh committed
220 221 222 223
        fs <- copyNewFastString uid ptr len
        updTbl string_table ft h (fs:ls)
        {- _trace ("new: " ++ show f_str)   $ -}
        return fs
224 225
  --
  lookup_result <- lookupTbl ft h
sof's avatar
sof committed
226
  case lookup_result of
227 228 229 230
    [] -> add_it []
    ls -> do
       b <- bucket_match ls len ptr
       case b of
Ian Lynagh's avatar
Ian Lynagh committed
231 232
         Nothing -> add_it ls
         Just v  -> {- _trace ("re-use: "++show v) $ -} return v
233 234 235

mkZFastStringBytes :: Ptr Word8 -> Int -> FastString
mkZFastStringBytes ptr len = unsafePerformIO $ do
236
  ft@(FastStringTable uid _) <- readIORef string_table
sof's avatar
sof committed
237
  let
238 239
   h = hashStr ptr len
   add_it ls = do
Ian Lynagh's avatar
Ian Lynagh committed
240 241 242 243
        fs <- copyNewZFastString uid ptr len
        updTbl string_table ft h (fs:ls)
        {- _trace ("new: " ++ show f_str)   $ -}
        return fs
244 245
  --
  lookup_result <- lookupTbl ft h
sof's avatar
sof committed
246
  case lookup_result of
247 248 249 250
    [] -> add_it []
    ls -> do
       b <- bucket_match ls len ptr
       case b of
Ian Lynagh's avatar
Ian Lynagh committed
251 252
         Nothing -> add_it ls
         Just v  -> {- _trace ("re-use: "++show v) $ -} return v
253 254 255 256 257 258

-- | Create a 'FastString' from an existing 'ForeignPtr'; the difference
-- between this and 'mkFastStringBytes' is that we don't have to copy
-- the bytes if the string is new to the table.
mkFastStringForeignPtr :: Ptr Word8 -> ForeignPtr Word8 -> Int -> IO FastString
mkFastStringForeignPtr ptr fp len = do
259
  ft@(FastStringTable uid _) <- readIORef string_table
260
--  _trace ("hashed: "++show (I# h)) $
261
  let
262 263
    h = hashStr ptr len
    add_it ls = do
Ian Lynagh's avatar
Ian Lynagh committed
264 265 266 267
        fs <- mkNewFastString uid ptr fp len
        updTbl string_table ft h (fs:ls)
        {- _trace ("new: " ++ show f_str)   $ -}
        return fs
268 269 270 271 272 273 274
  --
  lookup_result <- lookupTbl ft h
  case lookup_result of
    [] -> add_it []
    ls -> do
       b <- bucket_match ls len ptr
       case b of
Ian Lynagh's avatar
Ian Lynagh committed
275 276
         Nothing -> add_it ls
         Just v  -> {- _trace ("re-use: "++show v) $ -} return v
277 278 279

mkZFastStringForeignPtr :: Ptr Word8 -> ForeignPtr Word8 -> Int -> IO FastString
mkZFastStringForeignPtr ptr fp len = do
280
  ft@(FastStringTable uid _) <- readIORef string_table
281 282 283 284
--  _trace ("hashed: "++show (I# h)) $
  let
    h = hashStr ptr len
    add_it ls = do
Ian Lynagh's avatar
Ian Lynagh committed
285 286 287 288
        fs <- mkNewZFastString uid ptr fp len
        updTbl string_table ft h (fs:ls)
        {- _trace ("new: " ++ show f_str)   $ -}
        return fs
289 290
  --
  lookup_result <- lookupTbl ft h
291
  case lookup_result of
292 293 294 295
    [] -> add_it []
    ls -> do
       b <- bucket_match ls len ptr
       case b of
Ian Lynagh's avatar
Ian Lynagh committed
296 297
         Nothing -> add_it ls
         Just v  -> {- _trace ("re-use: "++show v) $ -} return v
298 299


300 301
-- | Creates a UTF-8 encoded 'FastString' from a 'String'
mkFastString :: String -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
302
mkFastString str =
303 304 305 306 307
  inlinePerformIO $ do
    let l = utf8EncodedLength str
    buf <- mallocForeignPtrBytes l
    withForeignPtr buf $ \ptr -> do
      utf8EncodeString ptr str
Ian Lynagh's avatar
Ian Lynagh committed
308
      mkFastStringForeignPtr ptr buf l
309

310 311
-- | Creates a 'FastString' from a UTF-8 encoded @[Word8]@
mkFastStringByteList :: [Word8] -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
312
mkFastStringByteList str =
313 314 315 316 317
  inlinePerformIO $ do
    let l = Prelude.length str
    buf <- mallocForeignPtrBytes l
    withForeignPtr buf $ \ptr -> do
      pokeArray (castPtr ptr) str
Ian Lynagh's avatar
Ian Lynagh committed
318
      mkFastStringForeignPtr ptr buf l
319 320 321

-- | Creates a Z-encoded 'FastString' from a 'String'
mkZFastString :: String -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
322
mkZFastString str =
323 324 325 326 327
  inlinePerformIO $ do
    let l = Prelude.length str
    buf <- mallocForeignPtrBytes l
    withForeignPtr buf $ \ptr -> do
      pokeCAString (castPtr ptr) str
Ian Lynagh's avatar
Ian Lynagh committed
328
      mkZFastStringForeignPtr ptr buf l
329

330
bucket_match :: [FastString] -> Int -> Ptr Word8 -> IO (Maybe FastString)
331 332 333
bucket_match [] _ _ = return Nothing
bucket_match (v@(FastString _ l _ buf _):ls) len ptr
      | len == l  =  do
Ian Lynagh's avatar
Ian Lynagh committed
334 335 336 337 338
         b <- cmpStringPrefix ptr buf len
         if b then return (Just v)
              else bucket_match ls len ptr
      | otherwise =
         bucket_match ls len ptr
339

340 341
mkNewFastString :: Int -> Ptr Word8 -> ForeignPtr Word8 -> Int
                -> IO FastString
342 343 344 345 346
mkNewFastString uid ptr fp len = do
  ref <- newIORef Nothing
  n_chars <- countUTF8Chars ptr len
  return (FastString uid len n_chars fp (UTF8Encoded ref))

347 348 349
mkNewZFastString :: Int -> Ptr Word8 -> ForeignPtr Word8 -> Int
                 -> IO FastString
mkNewZFastString uid _ fp len = do
350 351
  return (FastString uid len len fp ZEncoded)

352
copyNewFastString :: Int -> Ptr Word8 -> Int -> IO FastString
353 354 355 356 357 358
copyNewFastString uid ptr len = do
  fp <- copyBytesToForeignPtr ptr len
  ref <- newIORef Nothing
  n_chars <- countUTF8Chars ptr len
  return (FastString uid len n_chars fp (UTF8Encoded ref))

359
copyNewZFastString :: Int -> Ptr Word8 -> Int -> IO FastString
360 361 362 363
copyNewZFastString uid ptr len = do
  fp <- copyBytesToForeignPtr ptr len
  return (FastString uid len len fp ZEncoded)

364
copyBytesToForeignPtr :: Ptr Word8 -> Int -> IO (ForeignPtr Word8)
365 366 367 368 369 370 371 372 373 374 375 376 377
copyBytesToForeignPtr ptr len = do
  fp <- mallocForeignPtrBytes len
  withForeignPtr fp $ \ptr' -> copyBytes ptr' ptr len
  return fp

cmpStringPrefix :: Ptr Word8 -> ForeignPtr Word8 -> Int -> IO Bool
cmpStringPrefix ptr fp len =
  withForeignPtr fp $ \ptr' -> do
    r <- memcmp ptr ptr' len
    return (r == 0)


hashStr  :: Ptr Word8 -> Int -> Int
378
 -- use the Addr to produce a hash value between 0 & m (inclusive)
379
hashStr (Ptr a#) (I# len#) = loop 0# 0#
Ian Lynagh's avatar
Ian Lynagh committed
380
   where
381
    loop h n | n GHC.Exts.==# len# = I# h
Ian Lynagh's avatar
Ian Lynagh committed
382
             | otherwise  = loop h2 (n GHC.Exts.+# 1#)
383 384 385
          where !c = ord# (indexCharOffAddr# a# n)
                !h2 = (c GHC.Exts.+# (h GHC.Exts.*# 128#)) `remInt#`
                      hASH_TBL_SIZE#
386

387 388
-- -----------------------------------------------------------------------------
-- Operations
389

390 391 392
-- | Returns the length of the 'FastString' in characters
lengthFS :: FastString -> Int
lengthFS f = n_chars f
393

394
-- | Returns @True@ if the 'FastString' is Z-encoded
395 396
isZEncoded :: FastString -> Bool
isZEncoded fs | ZEncoded <- enc fs = True
Ian Lynagh's avatar
Ian Lynagh committed
397
              | otherwise          = False
398

399
-- | Returns @True@ if this 'FastString' is not Z-encoded but already has
400 401
-- a Z-encoding cached (used in producing stats).
hasZEncoding :: FastString -> Bool
402
hasZEncoding (FastString _ _ _ _ enc) =
403 404 405 406 407
  case enc of
    ZEncoded -> False
    UTF8Encoded ref ->
      inlinePerformIO $ do
        m <- readIORef ref
Ian Lynagh's avatar
Ian Lynagh committed
408
        return (isJust m)
409

410
-- | Returns @True@ if the 'FastString' is empty
411 412 413
nullFS :: FastString -> Bool
nullFS f  =  n_bytes f == 0

414
-- | Unpacks and decodes the FastString
415
unpackFS :: FastString -> String
Ian Lynagh's avatar
Ian Lynagh committed
416
unpackFS (FastString _ n_bytes _ buf enc) =
417 418
  inlinePerformIO $ withForeignPtr buf $ \ptr ->
    case enc of
Ian Lynagh's avatar
Ian Lynagh committed
419 420
        ZEncoded      -> peekCAStringLen (castPtr ptr,n_bytes)
        UTF8Encoded _ -> utf8DecodeString ptr n_bytes
421 422

bytesFS :: FastString -> [Word8]
423
bytesFS (FastString _ n_bytes _ buf _) =
424 425 426
  inlinePerformIO $ withForeignPtr buf $ \ptr ->
    peekArray n_bytes ptr

427
-- | Returns a Z-encoded version of a 'FastString'.  This might be the
428 429 430 431 432
-- original, if it was already Z-encoded.  The first time this
-- function is applied to a particular 'FastString', the results are
-- memoized.
--
zEncodeFS :: FastString -> FastString
433
zEncodeFS fs@(FastString _ _ _ _ enc) =
434 435 436 437 438 439
  case enc of
    ZEncoded -> fs
    UTF8Encoded ref ->
      inlinePerformIO $ do
        m <- readIORef ref
        case m of
Ian Lynagh's avatar
Ian Lynagh committed
440 441
          Just fs -> return fs
          Nothing -> do
442
            let efs = mkZFastString (zEncodeString (unpackFS fs))
Ian Lynagh's avatar
Ian Lynagh committed
443 444
            writeIORef ref (Just efs)
            return efs
445 446 447 448 449 450 451 452

appendFS :: FastString -> FastString -> FastString
appendFS fs1 fs2 = mkFastString (unpackFS fs1 ++ unpackFS fs2)

concatFS :: [FastString] -> FastString
concatFS ls = mkFastString (Prelude.concat (map unpackFS ls)) -- ToDo: do better

headFS :: FastString -> Char
453 454
headFS (FastString _ 0 _ _ _) = panic "headFS: Empty FastString"
headFS (FastString _ _ _ buf enc) =
455 456
  inlinePerformIO $ withForeignPtr buf $ \ptr -> do
    case enc of
Ian Lynagh's avatar
Ian Lynagh committed
457 458 459 460 461
      ZEncoded -> do
         w <- peek (castPtr ptr)
         return (castCCharToChar w)
      UTF8Encoded _ ->
         return (fst (utf8DecodeChar ptr))
462 463

tailFS :: FastString -> FastString
464
tailFS (FastString _ 0 _ _ _) = panic "tailFS: Empty FastString"
Ian Lynagh's avatar
Ian Lynagh committed
465
tailFS (FastString _ n_bytes _ buf enc) =
466 467 468
  inlinePerformIO $ withForeignPtr buf $ \ptr -> do
    case enc of
      ZEncoded -> do
Ian Lynagh's avatar
Ian Lynagh committed
469
        return $! mkZFastStringBytes (ptr `plusPtr` 1) (n_bytes - 1)
470
      UTF8Encoded _ -> do
Ian Lynagh's avatar
Ian Lynagh committed
471 472 473
         let (_,ptr') = utf8DecodeChar ptr
         let off = ptr' `minusPtr` ptr
         return $! mkFastStringBytes (ptr `plusPtr` off) (n_bytes - off)
474 475 476 477

consFS :: Char -> FastString -> FastString
consFS c fs = mkFastString (c : unpackFS fs)

478 479
uniqueOfFS :: FastString -> FastInt
uniqueOfFS (FastString u _ _ _ _) = iUnbox u
480

481
nilFS :: FastString
482
nilFS = mkFastString ""
483

484 485 486 487 488 489
-- -----------------------------------------------------------------------------
-- Stats

getFastStringTable :: IO [[FastString]]
getFastStringTable = do
  tbl <- readIORef string_table
490
  buckets <- mapM (lookupTbl tbl) [0 .. hASH_TBL_SIZE]
491 492
  return buckets

493 494 495
-- -----------------------------------------------------------------------------
-- Outputting 'FastString's

496 497
-- |Outputs a 'FastString' with /no decoding at all/, that is, you
-- get the actual bytes in the 'FastString' written to the 'Handle'.
498
hPutFS :: Handle -> FastString -> IO ()
499 500 501
hPutFS handle (FastString _ len _ fp _)
  | len == 0  = return ()
  | otherwise = do withForeignPtr fp $ \ptr -> hPutBuf handle ptr len
502

503 504
-- ToDo: we'll probably want an hPutFSLocal, or something, to output
-- in the current locale's encoding (for error messages and suchlike).
505

506 507
-- -----------------------------------------------------------------------------
-- LitStrings, here for convenience only.
508

509 510 511 512 513 514 515
-- hmm, not unboxed (or rather FastPtr), interesting
--a.k.a. Ptr CChar, Ptr Word8, Ptr (), hmph.  We don't
--really care about C types in naming, where we can help it.
type LitString = Ptr Word8
--Why do we recalculate length every time it's requested?
--If it's commonly needed, we should perhaps have
--data LitString = LitString {-#UNPACK#-}!(FastPtr Word8) {-#UNPACK#-}!FastInt
516

517
#if defined(__GLASGOW_HASKELL__)
518
mkLitString# :: Addr# -> LitString
519
mkLitString# a# = Ptr a#
Ian Lynagh's avatar
Ian Lynagh committed
520
#endif
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
--can/should we use FastTypes here?
--Is this likely to be memory-preserving if only used on constant strings?
--should we inline it? If lucky, that would make a CAF that wouldn't
--be computationally repeated... although admittedly we're not
--really intending to use mkLitString when __GLASGOW_HASKELL__...
--(I wonder, is unicode / multi-byte characters allowed in LitStrings
-- at all?)
{-# INLINE mkLitString #-}
mkLitString :: String -> LitString
mkLitString s =
 unsafePerformIO (do
   p <- mallocBytes (length s + 1)
   let
     loop :: Int -> String -> IO ()
     loop n cs | n `seq` null cs = pokeByteOff p n (0 :: Word8)
     loop n (c:cs) = do
        pokeByteOff p n (fromIntegral (ord c) :: Word8)
        loop (1+n) cs
Ian Lynagh's avatar
Ian Lynagh committed
539 540 541
     -- XXX GHC isn't smart enough to know that we have already covered
     -- this case.
     loop _ [] = panic "mkLitString"
542 543 544 545 546 547 548 549 550 551 552 553
   loop 0 s
   return p
 )

unpackLitString :: LitString -> String
unpackLitString p_ = case pUnbox p_ of
 p -> unpack (_ILIT(0))
  where
    unpack n = case indexWord8OffFastPtrAsFastChar p n of
      ch -> if ch `eqFastChar` _CLIT('\0')
            then [] else cBox ch : unpack (n +# _ILIT(1))

554 555
lengthLS :: LitString -> Int
lengthLS = ptrStrLength
556 557 558 559 560 561 562 563 564 565 566 567

-- for now, use a simple String representation
--no, let's not do that right now - it's work in other places
#if 0
type LitString = String

mkLitString :: String -> LitString
mkLitString = id

unpackLitString :: LitString -> String
unpackLitString = id

568 569
lengthLS :: LitString -> Int
lengthLS = length
570 571

#endif
572 573 574 575

-- -----------------------------------------------------------------------------
-- under the carpet

Ian Lynagh's avatar
Ian Lynagh committed
576
foreign import ccall unsafe "ghc_strlen"
577
  ptrStrLength :: Ptr Word8 -> Int
578

579
-- NB. does *not* add a '\0'-terminator.
580 581
-- We only use CChar here to be parallel to the imported
-- peekC(A)StringLen.
582 583 584
pokeCAString :: Ptr CChar -> String -> IO ()
pokeCAString ptr str =
  let
585
        go [] _     = return ()
Ian Lynagh's avatar
Ian Lynagh committed
586
        go (c:cs) n = do pokeElemOff ptr n (castCharToCChar c); go cs (n+1)
587 588 589
  in
  go str 0

Ian Lynagh's avatar
Ian Lynagh committed
590 591 592 593 594 595 596 597 598 599 600 601
{-# NOINLINE sLit #-}
sLit :: String -> LitString
sLit x  = mkLitString x

{-# NOINLINE fsLit #-}
fsLit :: String -> FastString
fsLit x = mkFastString x

{-# RULES "slit"
    forall x . sLit  (unpackCString# x) = mkLitString#  x #-}
{-# RULES "fslit"
    forall x . fsLit (unpackCString# x) = mkFastString# x #-}
602
\end{code}