FastString.lhs 17.7 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 )
102
import Data.IORef       ( IORef, newIORef, readIORef, atomicModifyIORef )
Ian Lynagh's avatar
Ian Lynagh committed
103 104
import Data.Maybe       ( isJust )
import Data.Char        ( ord )
105

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

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

117 118
#define hASH_TBL_SIZE          4091
#define hASH_TBL_SIZE_UNBOXED  4091#
119 120


121 122 123 124 125
{-|
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.
126

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

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

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

144 145
instance Eq FastString where
  f1 == f2  =  uniq f1 == uniq f2
146

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

159 160 161
instance Show FastString where
   show fs = show (unpackFS fs)

162 163 164
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
165 166 167 168 169 170 171 172 173 174 175
  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
176

177
#ifndef __HADDOCK__
Ian Lynagh's avatar
Ian Lynagh committed
178
foreign import ccall unsafe "ghc_memcmp"
179 180
  memcmp :: Ptr a -> Ptr b -> Int -> IO Int
#endif
181

182 183
-- -----------------------------------------------------------------------------
-- Construction
184

185
{-
186 187 188 189
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.
190
-}
191

Ian Lynagh's avatar
Ian Lynagh committed
192
data FastStringTable =
193
 FastStringTable
194
    {-# UNPACK #-} !Int
195
    (MutableArray# RealWorld [FastString])
196

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

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

210 211
updTbl :: FastStringTable -> Int -> [FastString] -> IO FastStringTable
updTbl (FastStringTable uid arr#) (I# i#) ls = do
212
  (IO $ \ s# -> case writeArray# arr# i# ls s# of { s2# -> (# s2#, () #) })
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
  return (FastStringTable (uid+1) arr#)

-- | Helper function for various forms of fast string constructors.
mkFSInternal :: Ptr Word8 -> Int
             -> (Int -> IO FastString)
             -> IO FastString
-- The interesting part is the use of unsafePerformIO to make the
-- argument to atomicModifyIORef pure.  This is safe because any
-- effect dependencies are enforced by data dependencies.
-- Furthermore, every result is used and hence there should be no
-- space leaks.
mkFSInternal ptr len mk_it = do
  r <- atomicModifyIORef string_table $
         \fs_tbl@(FastStringTable uid _) ->
           let h = hashStr ptr len
               add_it ls = do
                 fs <- mk_it uid
                 fst' <- updTbl fs_tbl h (fs:ls)
                 fs `seq` fst' `seq` return (fst', fs)
           in unsafePerformIO $ do
             lookup_result <- lookupTbl fs_tbl h
             case lookup_result of
               [] -> add_it []
               ls -> do
                 b <- bucket_match ls len ptr
                 case b of
                   Nothing -> add_it ls
                   Just v -> return (fs_tbl, v)
  r `seq` return r
242

243
mkFastString# :: Addr# -> FastString
244
mkFastString# a# = mkFastStringBytes ptr (ptrStrLength ptr)
245
  where ptr = Ptr a#
246

247
mkFastStringBytes :: Ptr Word8 -> Int -> FastString
248 249
mkFastStringBytes ptr len = inlinePerformIO $ do
  mkFSInternal ptr len (\uid -> copyNewFastString uid ptr len)
250 251

mkZFastStringBytes :: Ptr Word8 -> Int -> FastString
252 253
mkZFastStringBytes ptr len = inlinePerformIO $ do
  mkFSInternal ptr len (\uid -> copyNewZFastString uid ptr len)
254 255 256 257 258 259

-- | 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
260
  mkFSInternal ptr len (\uid -> mkNewFastString uid ptr fp len)
261 262 263

mkZFastStringForeignPtr :: Ptr Word8 -> ForeignPtr Word8 -> Int -> IO FastString
mkZFastStringForeignPtr ptr fp len = do
264
  mkFSInternal ptr len (\uid -> mkNewZFastString uid ptr fp len)
265

266 267
-- | Creates a UTF-8 encoded 'FastString' from a 'String'
mkFastString :: String -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
268
mkFastString str =
269 270 271 272 273
  inlinePerformIO $ do
    let l = utf8EncodedLength str
    buf <- mallocForeignPtrBytes l
    withForeignPtr buf $ \ptr -> do
      utf8EncodeString ptr str
Ian Lynagh's avatar
Ian Lynagh committed
274
      mkFastStringForeignPtr ptr buf l
275

276 277
-- | Creates a 'FastString' from a UTF-8 encoded @[Word8]@
mkFastStringByteList :: [Word8] -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
278
mkFastStringByteList str =
279 280 281 282 283
  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
284
      mkFastStringForeignPtr ptr buf l
285 286 287

-- | Creates a Z-encoded 'FastString' from a 'String'
mkZFastString :: String -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
288
mkZFastString str =
289 290 291 292 293
  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
294
      mkZFastStringForeignPtr ptr buf l
295

296
bucket_match :: [FastString] -> Int -> Ptr Word8 -> IO (Maybe FastString)
297 298 299
bucket_match [] _ _ = return Nothing
bucket_match (v@(FastString _ l _ buf _):ls) len ptr
      | len == l  =  do
Ian Lynagh's avatar
Ian Lynagh committed
300 301 302 303 304
         b <- cmpStringPrefix ptr buf len
         if b then return (Just v)
              else bucket_match ls len ptr
      | otherwise =
         bucket_match ls len ptr
305

306 307
mkNewFastString :: Int -> Ptr Word8 -> ForeignPtr Word8 -> Int
                -> IO FastString
308 309 310 311 312
mkNewFastString uid ptr fp len = do
  ref <- newIORef Nothing
  n_chars <- countUTF8Chars ptr len
  return (FastString uid len n_chars fp (UTF8Encoded ref))

313 314 315
mkNewZFastString :: Int -> Ptr Word8 -> ForeignPtr Word8 -> Int
                 -> IO FastString
mkNewZFastString uid _ fp len = do
316 317
  return (FastString uid len len fp ZEncoded)

318
copyNewFastString :: Int -> Ptr Word8 -> Int -> IO FastString
319 320 321 322 323 324
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))

325
copyNewZFastString :: Int -> Ptr Word8 -> Int -> IO FastString
326 327 328 329
copyNewZFastString uid ptr len = do
  fp <- copyBytesToForeignPtr ptr len
  return (FastString uid len len fp ZEncoded)

330
copyBytesToForeignPtr :: Ptr Word8 -> Int -> IO (ForeignPtr Word8)
331 332 333 334 335 336 337 338 339 340 341 342 343
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
344
 -- use the Addr to produce a hash value between 0 & m (inclusive)
345
hashStr (Ptr a#) (I# len#) = loop 0# 0#
Ian Lynagh's avatar
Ian Lynagh committed
346
   where
347
    loop h n | n GHC.Exts.==# len# = I# h
Ian Lynagh's avatar
Ian Lynagh committed
348
             | otherwise  = loop h2 (n GHC.Exts.+# 1#)
349 350 351
          where !c = ord# (indexCharOffAddr# a# n)
                !h2 = (c GHC.Exts.+# (h GHC.Exts.*# 128#)) `remInt#`
                      hASH_TBL_SIZE#
352

353 354
-- -----------------------------------------------------------------------------
-- Operations
355

356 357 358
-- | Returns the length of the 'FastString' in characters
lengthFS :: FastString -> Int
lengthFS f = n_chars f
359

360
-- | Returns @True@ if the 'FastString' is Z-encoded
361 362
isZEncoded :: FastString -> Bool
isZEncoded fs | ZEncoded <- enc fs = True
Ian Lynagh's avatar
Ian Lynagh committed
363
              | otherwise          = False
364

365
-- | Returns @True@ if this 'FastString' is not Z-encoded but already has
366 367
-- a Z-encoding cached (used in producing stats).
hasZEncoding :: FastString -> Bool
368
hasZEncoding (FastString _ _ _ _ enc) =
369 370 371 372 373
  case enc of
    ZEncoded -> False
    UTF8Encoded ref ->
      inlinePerformIO $ do
        m <- readIORef ref
Ian Lynagh's avatar
Ian Lynagh committed
374
        return (isJust m)
375

376
-- | Returns @True@ if the 'FastString' is empty
377 378 379
nullFS :: FastString -> Bool
nullFS f  =  n_bytes f == 0

380
-- | Unpacks and decodes the FastString
381
unpackFS :: FastString -> String
Ian Lynagh's avatar
Ian Lynagh committed
382
unpackFS (FastString _ n_bytes _ buf enc) =
383 384
  inlinePerformIO $ withForeignPtr buf $ \ptr ->
    case enc of
Ian Lynagh's avatar
Ian Lynagh committed
385 386
        ZEncoded      -> peekCAStringLen (castPtr ptr,n_bytes)
        UTF8Encoded _ -> utf8DecodeString ptr n_bytes
387 388

bytesFS :: FastString -> [Word8]
389
bytesFS (FastString _ n_bytes _ buf _) =
390 391 392
  inlinePerformIO $ withForeignPtr buf $ \ptr ->
    peekArray n_bytes ptr

393
-- | Returns a Z-encoded version of a 'FastString'.  This might be the
394 395 396 397 398
-- 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
399
zEncodeFS fs@(FastString _ _ _ _ enc) =
400 401 402 403
  case enc of
    ZEncoded -> fs
    UTF8Encoded ref ->
      inlinePerformIO $ do
404 405 406 407 408 409 410
        r <- atomicModifyIORef ref $ \m ->
               case m of
                 Just fs -> (m, fs)
                 Nothing ->
                   let efs = mkZFastString (zEncodeString (unpackFS fs)) in
                   efs `seq` (Just efs, efs)
        r `seq` return r
411 412 413 414 415 416 417 418

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
419 420
headFS (FastString _ 0 _ _ _) = panic "headFS: Empty FastString"
headFS (FastString _ _ _ buf enc) =
421 422
  inlinePerformIO $ withForeignPtr buf $ \ptr -> do
    case enc of
Ian Lynagh's avatar
Ian Lynagh committed
423 424 425 426 427
      ZEncoded -> do
         w <- peek (castPtr ptr)
         return (castCCharToChar w)
      UTF8Encoded _ ->
         return (fst (utf8DecodeChar ptr))
428 429

tailFS :: FastString -> FastString
430
tailFS (FastString _ 0 _ _ _) = panic "tailFS: Empty FastString"
Ian Lynagh's avatar
Ian Lynagh committed
431
tailFS (FastString _ n_bytes _ buf enc) =
432 433 434
  inlinePerformIO $ withForeignPtr buf $ \ptr -> do
    case enc of
      ZEncoded -> do
Ian Lynagh's avatar
Ian Lynagh committed
435
        return $! mkZFastStringBytes (ptr `plusPtr` 1) (n_bytes - 1)
436
      UTF8Encoded _ -> do
Ian Lynagh's avatar
Ian Lynagh committed
437 438 439
         let (_,ptr') = utf8DecodeChar ptr
         let off = ptr' `minusPtr` ptr
         return $! mkFastStringBytes (ptr `plusPtr` off) (n_bytes - off)
440 441 442 443

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

444 445
uniqueOfFS :: FastString -> FastInt
uniqueOfFS (FastString u _ _ _ _) = iUnbox u
446

447
nilFS :: FastString
448
nilFS = mkFastString ""
449

450 451 452 453 454 455
-- -----------------------------------------------------------------------------
-- Stats

getFastStringTable :: IO [[FastString]]
getFastStringTable = do
  tbl <- readIORef string_table
456
  buckets <- mapM (lookupTbl tbl) [0 .. hASH_TBL_SIZE]
457 458
  return buckets

459 460 461
-- -----------------------------------------------------------------------------
-- Outputting 'FastString's

462 463
-- |Outputs a 'FastString' with /no decoding at all/, that is, you
-- get the actual bytes in the 'FastString' written to the 'Handle'.
464
hPutFS :: Handle -> FastString -> IO ()
465 466 467
hPutFS handle (FastString _ len _ fp _)
  | len == 0  = return ()
  | otherwise = do withForeignPtr fp $ \ptr -> hPutBuf handle ptr len
468

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

472 473
-- -----------------------------------------------------------------------------
-- LitStrings, here for convenience only.
474

475 476 477 478 479 480 481
-- 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
482

483
#if defined(__GLASGOW_HASKELL__)
484
mkLitString# :: Addr# -> LitString
485
mkLitString# a# = Ptr a#
Ian Lynagh's avatar
Ian Lynagh committed
486
#endif
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
--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
505 506 507
     -- XXX GHC isn't smart enough to know that we have already covered
     -- this case.
     loop _ [] = panic "mkLitString"
508 509 510 511 512 513 514 515 516 517 518 519
   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))

520 521
lengthLS :: LitString -> Int
lengthLS = ptrStrLength
522 523 524 525 526 527 528 529 530 531 532 533

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

534 535
lengthLS :: LitString -> Int
lengthLS = length
536 537

#endif
538 539 540 541

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

Ian Lynagh's avatar
Ian Lynagh committed
542
foreign import ccall unsafe "ghc_strlen"
543
  ptrStrLength :: Ptr Word8 -> Int
544

545
-- NB. does *not* add a '\0'-terminator.
546 547
-- We only use CChar here to be parallel to the imported
-- peekC(A)StringLen.
548 549 550
pokeCAString :: Ptr CChar -> String -> IO ()
pokeCAString ptr str =
  let
551
        go [] _     = return ()
Ian Lynagh's avatar
Ian Lynagh committed
552
        go (c:cs) n = do pokeElemOff ptr n (castCharToCChar c); go cs (n+1)
553 554 555
  in
  go str 0

Ian Lynagh's avatar
Ian Lynagh committed
556 557 558 559 560 561 562 563 564 565 566 567
{-# 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 #-}
568
\end{code}