FastString.lhs 19 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
import Util
97

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

108 109 110 111 112 113
#if __GLASGOW_HASKELL__ >= 611
import GHC.IO ( IO(..) )
#else
import GHC.IOBase ( IO(..) )
#endif

Ian Lynagh's avatar
Ian Lynagh committed
114
import GHC.Ptr          ( Ptr(..) )
Ian Lynagh's avatar
Ian Lynagh committed
115 116 117
#if defined(__GLASGOW_HASKELL__)
import GHC.Base         ( unpackCString# )
#endif
118

119 120
#define hASH_TBL_SIZE          4091
#define hASH_TBL_SIZE_UNBOXED  4091#
121 122


123 124 125 126 127
{-|
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.
128

129 130 131 132
'FastString's support a memoized conversion to the Z-encoding via zEncodeFS.
-}

data FastString = FastString {
Ian Lynagh's avatar
Ian Lynagh committed
133 134 135
      uniq    :: {-# UNPACK #-} !Int, -- unique id
      n_bytes :: {-# UNPACK #-} !Int, -- number of bytes
      n_chars :: {-# UNPACK #-} !Int, -- number of chars
136 137
      buf     :: {-# UNPACK #-} !(ForeignPtr Word8),
      enc     :: FSEncoding
138
  } deriving Typeable
139 140

data FSEncoding
Ian Lynagh's avatar
Ian Lynagh committed
141
    -- including strings that don't need any encoding
142
  = ZEncoded
Ian Lynagh's avatar
Ian Lynagh committed
143
    -- A UTF-8 string with a memoized Z-encoding
144
  | UTF8Encoded {-# UNPACK #-} !(IORef (Maybe FastString))
145

146 147
instance Eq FastString where
  f1 == f2  =  uniq f1 == uniq f2
148

149
instance Ord FastString where
Ian Lynagh's avatar
Ian Lynagh committed
150
    -- Compares lexicographically, not by unique
151
    a <= b = case cmpFS a b of { LT -> True;  EQ -> True;  GT -> False }
Ian Lynagh's avatar
Ian Lynagh committed
152
    a <  b = case cmpFS a b of { LT -> True;  EQ -> False; GT -> False }
153
    a >= b = case cmpFS a b of { LT -> False; EQ -> True;  GT -> True  }
Ian Lynagh's avatar
Ian Lynagh committed
154 155 156 157 158
    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
159
    compare a b = cmpFS a b
160

161 162 163
instance Show FastString where
   show fs = show (unpackFS fs)

164 165 166 167 168 169
instance Data FastString where
  -- don't traverse?
  toConstr _   = abstractConstr "FastString"
  gunfold _ _  = error "gunfold"
  dataTypeOf _ = mkNoRepType "FastString"

170 171 172
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
173 174 175 176 177 178 179 180 181 182 183
  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
184

185
#ifndef __HADDOCK__
Ian Lynagh's avatar
Ian Lynagh committed
186
foreign import ccall unsafe "ghc_memcmp"
187 188
  memcmp :: Ptr a -> Ptr b -> Int -> IO Int
#endif
189

190 191
-- -----------------------------------------------------------------------------
-- Construction
192

193
{-
194 195 196 197
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.
198
-}
199

Ian Lynagh's avatar
Ian Lynagh committed
200
data FastStringTable =
201
 FastStringTable
202
    {-# UNPACK #-} !Int
203
    (MutableArray# RealWorld [FastString])
204

205
{-# NOINLINE string_table #-}
206
string_table :: IORef FastStringTable
Ian Lynagh's avatar
Ian Lynagh committed
207
string_table =
208
 unsafePerformIO $ do
209 210 211 212
   tab <- IO $ \s1# -> case newArray# hASH_TBL_SIZE_UNBOXED [] s1# of
                           (# s2#, arr# #) ->
                               (# s2#, FastStringTable 0 arr# #)
   newIORef tab
213 214 215 216 217

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

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

223
mkFastString# :: Addr# -> FastString
224
mkFastString# a# = mkFastStringBytes ptr (ptrStrLength ptr)
225
  where ptr = Ptr a#
226

227
mkFastStringBytes :: Ptr Word8 -> Int -> FastString
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
mkFastStringBytes ptr len = unsafePerformIO $ do
  ft@(FastStringTable uid _) <- readIORef string_table
  let
   h = hashStr ptr len
   add_it ls = do
        fs <- copyNewFastString uid ptr len
        updTbl string_table ft h (fs:ls)
        {- _trace ("new: " ++ show f_str)   $ -}
        return fs
  --
  lookup_result <- lookupTbl ft h
  case lookup_result of
    [] -> add_it []
    ls -> do
       b <- bucket_match ls len ptr
       case b of
         Nothing -> add_it ls
         Just v  -> {- _trace ("re-use: "++show v) $ -} return v
246 247

mkZFastStringBytes :: Ptr Word8 -> Int -> FastString
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
mkZFastStringBytes ptr len = unsafePerformIO $ do
  ft@(FastStringTable uid _) <- readIORef string_table
  let
   h = hashStr ptr len
   add_it ls = do
        fs <- copyNewZFastString uid ptr len
        updTbl string_table ft h (fs:ls)
        {- _trace ("new: " ++ show f_str)   $ -}
        return fs
  --
  lookup_result <- lookupTbl ft h
  case lookup_result of
    [] -> add_it []
    ls -> do
       b <- bucket_match ls len ptr
       case b of
         Nothing -> add_it ls
         Just v  -> {- _trace ("re-use: "++show v) $ -} return v
266 267 268 269 270 271

-- | 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
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
  ft@(FastStringTable uid _) <- readIORef string_table
--  _trace ("hashed: "++show (I# h)) $
  let
    h = hashStr ptr len
    add_it ls = do
        fs <- mkNewFastString uid ptr fp len
        updTbl string_table ft h (fs:ls)
        {- _trace ("new: " ++ show f_str)   $ -}
        return fs
  --
  lookup_result <- lookupTbl ft h
  case lookup_result of
    [] -> add_it []
    ls -> do
       b <- bucket_match ls len ptr
       case b of
         Nothing -> add_it ls
         Just v  -> {- _trace ("re-use: "++show v) $ -} return v
290 291 292

mkZFastStringForeignPtr :: Ptr Word8 -> ForeignPtr Word8 -> Int -> IO FastString
mkZFastStringForeignPtr ptr fp len = do
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
  ft@(FastStringTable uid _) <- readIORef string_table
--  _trace ("hashed: "++show (I# h)) $
  let
    h = hashStr ptr len
    add_it ls = do
        fs <- mkNewZFastString uid ptr fp len
        updTbl string_table ft h (fs:ls)
        {- _trace ("new: " ++ show f_str)   $ -}
        return fs
  --
  lookup_result <- lookupTbl ft h
  case lookup_result of
    [] -> add_it []
    ls -> do
       b <- bucket_match ls len ptr
       case b of
         Nothing -> add_it ls
         Just v  -> {- _trace ("re-use: "++show v) $ -} return v

312

313 314
-- | Creates a UTF-8 encoded 'FastString' from a 'String'
mkFastString :: String -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
315
mkFastString str =
316 317 318 319 320
  inlinePerformIO $ do
    let l = utf8EncodedLength str
    buf <- mallocForeignPtrBytes l
    withForeignPtr buf $ \ptr -> do
      utf8EncodeString ptr str
Ian Lynagh's avatar
Ian Lynagh committed
321
      mkFastStringForeignPtr ptr buf l
322

323 324
-- | Creates a 'FastString' from a UTF-8 encoded @[Word8]@
mkFastStringByteList :: [Word8] -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
325
mkFastStringByteList str =
326 327 328 329 330
  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
331
      mkFastStringForeignPtr ptr buf l
332 333 334

-- | Creates a Z-encoded 'FastString' from a 'String'
mkZFastString :: String -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
335
mkZFastString str =
336 337 338 339 340
  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
341
      mkZFastStringForeignPtr ptr buf l
342

343
bucket_match :: [FastString] -> Int -> Ptr Word8 -> IO (Maybe FastString)
344 345 346
bucket_match [] _ _ = return Nothing
bucket_match (v@(FastString _ l _ buf _):ls) len ptr
      | len == l  =  do
Ian Lynagh's avatar
Ian Lynagh committed
347 348 349 350 351
         b <- cmpStringPrefix ptr buf len
         if b then return (Just v)
              else bucket_match ls len ptr
      | otherwise =
         bucket_match ls len ptr
352

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

360 361 362
mkNewZFastString :: Int -> Ptr Word8 -> ForeignPtr Word8 -> Int
                 -> IO FastString
mkNewZFastString uid _ fp len = do
363 364
  return (FastString uid len len fp ZEncoded)

365
copyNewFastString :: Int -> Ptr Word8 -> Int -> IO FastString
366 367 368 369 370 371
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))

372
copyNewZFastString :: Int -> Ptr Word8 -> Int -> IO FastString
373 374 375 376
copyNewZFastString uid ptr len = do
  fp <- copyBytesToForeignPtr ptr len
  return (FastString uid len len fp ZEncoded)

377
copyBytesToForeignPtr :: Ptr Word8 -> Int -> IO (ForeignPtr Word8)
378 379 380 381 382 383 384 385 386 387 388 389 390
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
391
 -- use the Addr to produce a hash value between 0 & m (inclusive)
392
hashStr (Ptr a#) (I# len#) = loop 0# 0#
Ian Lynagh's avatar
Ian Lynagh committed
393
   where
394
    loop h n | n GHC.Exts.==# len# = I# h
Ian Lynagh's avatar
Ian Lynagh committed
395
             | otherwise  = loop h2 (n GHC.Exts.+# 1#)
396 397 398
          where !c = ord# (indexCharOffAddr# a# n)
                !h2 = (c GHC.Exts.+# (h GHC.Exts.*# 128#)) `remInt#`
                      hASH_TBL_SIZE#
399

400 401
-- -----------------------------------------------------------------------------
-- Operations
402

403 404 405
-- | Returns the length of the 'FastString' in characters
lengthFS :: FastString -> Int
lengthFS f = n_chars f
406

407
-- | Returns @True@ if the 'FastString' is Z-encoded
408 409
isZEncoded :: FastString -> Bool
isZEncoded fs | ZEncoded <- enc fs = True
Ian Lynagh's avatar
Ian Lynagh committed
410
              | otherwise          = False
411

412
-- | Returns @True@ if this 'FastString' is not Z-encoded but already has
413 414
-- a Z-encoding cached (used in producing stats).
hasZEncoding :: FastString -> Bool
415
hasZEncoding (FastString _ _ _ _ enc) =
416 417 418 419 420
  case enc of
    ZEncoded -> False
    UTF8Encoded ref ->
      inlinePerformIO $ do
        m <- readIORef ref
Ian Lynagh's avatar
Ian Lynagh committed
421
        return (isJust m)
422

423
-- | Returns @True@ if the 'FastString' is empty
424 425 426
nullFS :: FastString -> Bool
nullFS f  =  n_bytes f == 0

427
-- | Unpacks and decodes the FastString
428
unpackFS :: FastString -> String
Ian Lynagh's avatar
Ian Lynagh committed
429
unpackFS (FastString _ n_bytes _ buf enc) =
430 431
  inlinePerformIO $ withForeignPtr buf $ \ptr ->
    case enc of
Ian Lynagh's avatar
Ian Lynagh committed
432 433
        ZEncoded      -> peekCAStringLen (castPtr ptr,n_bytes)
        UTF8Encoded _ -> utf8DecodeString ptr n_bytes
434 435

bytesFS :: FastString -> [Word8]
436
bytesFS (FastString _ n_bytes _ buf _) =
437 438 439
  inlinePerformIO $ withForeignPtr buf $ \ptr ->
    peekArray n_bytes ptr

440
-- | Returns a Z-encoded version of a 'FastString'.  This might be the
441 442 443 444 445
-- 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
446
zEncodeFS fs@(FastString _ _ _ _ enc) =
447 448 449 450
  case enc of
    ZEncoded -> fs
    UTF8Encoded ref ->
      inlinePerformIO $ do
451 452 453 454 455 456 457
        m <- readIORef ref
        case m of
          Just fs -> return fs
          Nothing -> do
            let efs = mkZFastString (zEncodeString (unpackFS fs))
            writeIORef ref (Just efs)
            return efs
458 459

appendFS :: FastString -> FastString -> FastString
ich@christoph-bauer.net's avatar
ich@christoph-bauer.net committed
460 461 462 463 464 465 466 467 468 469 470 471
appendFS fs1 fs2 =
  inlinePerformIO $ do
    r <- mallocForeignPtrBytes len
    withForeignPtr r $ \ r' -> do
    withForeignPtr (buf fs1) $ \ fs1Ptr -> do
    withForeignPtr (buf fs2) $ \ fs2Ptr -> do
        copyBytes r' fs1Ptr len1
        copyBytes (advancePtr r' len1) fs2Ptr len2
        mkFastStringForeignPtr r' r len
  where len  = len1 + len2
        len1 = lengthFS fs1
        len2 = lengthFS fs2
472 473 474 475 476

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

headFS :: FastString -> Char
477 478
headFS (FastString _ 0 _ _ _) = panic "headFS: Empty FastString"
headFS (FastString _ _ _ buf enc) =
479 480
  inlinePerformIO $ withForeignPtr buf $ \ptr -> do
    case enc of
Ian Lynagh's avatar
Ian Lynagh committed
481 482 483 484 485
      ZEncoded -> do
         w <- peek (castPtr ptr)
         return (castCCharToChar w)
      UTF8Encoded _ ->
         return (fst (utf8DecodeChar ptr))
486 487

tailFS :: FastString -> FastString
488
tailFS (FastString _ 0 _ _ _) = panic "tailFS: Empty FastString"
Ian Lynagh's avatar
Ian Lynagh committed
489
tailFS (FastString _ n_bytes _ buf enc) =
490 491 492
  inlinePerformIO $ withForeignPtr buf $ \ptr -> do
    case enc of
      ZEncoded -> do
Ian Lynagh's avatar
Ian Lynagh committed
493
        return $! mkZFastStringBytes (ptr `plusPtr` 1) (n_bytes - 1)
494
      UTF8Encoded _ -> do
Ian Lynagh's avatar
Ian Lynagh committed
495 496 497
         let (_,ptr') = utf8DecodeChar ptr
         let off = ptr' `minusPtr` ptr
         return $! mkFastStringBytes (ptr `plusPtr` off) (n_bytes - off)
498 499 500 501

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

502 503
uniqueOfFS :: FastString -> FastInt
uniqueOfFS (FastString u _ _ _ _) = iUnbox u
504

505
nilFS :: FastString
506
nilFS = mkFastString ""
507

508 509 510 511 512 513
-- -----------------------------------------------------------------------------
-- Stats

getFastStringTable :: IO [[FastString]]
getFastStringTable = do
  tbl <- readIORef string_table
514
  buckets <- mapM (lookupTbl tbl) [0 .. hASH_TBL_SIZE]
515 516
  return buckets

517 518 519
-- -----------------------------------------------------------------------------
-- Outputting 'FastString's

520 521
-- |Outputs a 'FastString' with /no decoding at all/, that is, you
-- get the actual bytes in the 'FastString' written to the 'Handle'.
522
hPutFS :: Handle -> FastString -> IO ()
523 524 525
hPutFS handle (FastString _ len _ fp _)
  | len == 0  = return ()
  | otherwise = do withForeignPtr fp $ \ptr -> hPutBuf handle ptr len
526

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

530 531
-- -----------------------------------------------------------------------------
-- LitStrings, here for convenience only.
532

533 534 535 536 537 538 539
-- 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
540

541
#if defined(__GLASGOW_HASKELL__)
542
mkLitString# :: Addr# -> LitString
543
mkLitString# a# = Ptr a#
Ian Lynagh's avatar
Ian Lynagh committed
544
#endif
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
--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
563 564 565
     -- XXX GHC isn't smart enough to know that we have already covered
     -- this case.
     loop _ [] = panic "mkLitString"
566 567 568 569 570 571 572 573 574 575 576 577
   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))

578 579
lengthLS :: LitString -> Int
lengthLS = ptrStrLength
580 581 582 583 584 585 586 587 588 589 590 591

-- 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

592 593
lengthLS :: LitString -> Int
lengthLS = length
594 595

#endif
596 597 598 599

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

Ian Lynagh's avatar
Ian Lynagh committed
600
foreign import ccall unsafe "ghc_strlen"
601
  ptrStrLength :: Ptr Word8 -> Int
602

603
-- NB. does *not* add a '\0'-terminator.
604 605
-- We only use CChar here to be parallel to the imported
-- peekC(A)StringLen.
606 607 608
pokeCAString :: Ptr CChar -> String -> IO ()
pokeCAString ptr str =
  let
609
        go [] _     = return ()
Ian Lynagh's avatar
Ian Lynagh committed
610
        go (c:cs) n = do pokeElemOff ptr n (castCharToCChar c); go cs (n+1)
611 612 613
  in
  go str 0

Ian Lynagh's avatar
Ian Lynagh committed
614 615 616 617 618 619 620 621 622 623 624 625
{-# 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 #-}
626
\end{code}