FastString.lhs 18.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, writeIORef )
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 :: IORef FastStringTable -> FastStringTable -> Int -> [FastString] -> IO ()
updTbl fs_table_var (FastStringTable uid arr#) (I# i#) ls = do
212
  (IO $ \ s# -> case writeArray# arr# i# ls s# of { s2# -> (# s2#, () #) })
213
  writeIORef fs_table_var (FastStringTable (uid+1) arr#)
214

215
mkFastString# :: Addr# -> FastString
216
mkFastString# a# = mkFastStringBytes ptr (ptrStrLength ptr)
217
  where ptr = Ptr a#
218

219
mkFastStringBytes :: Ptr Word8 -> Int -> FastString
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
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
238 239

mkZFastStringBytes :: Ptr Word8 -> Int -> FastString
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
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
258 259 260 261 262 263

-- | 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
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
  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
282 283 284

mkZFastStringForeignPtr :: Ptr Word8 -> ForeignPtr Word8 -> Int -> IO FastString
mkZFastStringForeignPtr ptr fp len = do
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
  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

304

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

315 316
-- | Creates a 'FastString' from a UTF-8 encoded @[Word8]@
mkFastStringByteList :: [Word8] -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
317
mkFastStringByteList str =
318 319 320 321 322
  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
323
      mkFastStringForeignPtr ptr buf l
324 325 326

-- | Creates a Z-encoded 'FastString' from a 'String'
mkZFastString :: String -> FastString
Ian Lynagh's avatar
Ian Lynagh committed
327
mkZFastString str =
328 329 330 331 332
  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
333
      mkZFastStringForeignPtr ptr buf l
334

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

345 346
mkNewFastString :: Int -> Ptr Word8 -> ForeignPtr Word8 -> Int
                -> IO FastString
347 348 349 350 351
mkNewFastString uid ptr fp len = do
  ref <- newIORef Nothing
  n_chars <- countUTF8Chars ptr len
  return (FastString uid len n_chars fp (UTF8Encoded ref))

352 353 354
mkNewZFastString :: Int -> Ptr Word8 -> ForeignPtr Word8 -> Int
                 -> IO FastString
mkNewZFastString uid _ fp len = do
355 356
  return (FastString uid len len fp ZEncoded)

357
copyNewFastString :: Int -> Ptr Word8 -> Int -> IO FastString
358 359 360 361 362 363
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))

364
copyNewZFastString :: Int -> Ptr Word8 -> Int -> IO FastString
365 366 367 368
copyNewZFastString uid ptr len = do
  fp <- copyBytesToForeignPtr ptr len
  return (FastString uid len len fp ZEncoded)

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

392 393
-- -----------------------------------------------------------------------------
-- Operations
394

395 396 397
-- | Returns the length of the 'FastString' in characters
lengthFS :: FastString -> Int
lengthFS f = n_chars f
398

399
-- | Returns @True@ if the 'FastString' is Z-encoded
400 401
isZEncoded :: FastString -> Bool
isZEncoded fs | ZEncoded <- enc fs = True
Ian Lynagh's avatar
Ian Lynagh committed
402
              | otherwise          = False
403

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

415
-- | Returns @True@ if the 'FastString' is empty
416 417 418
nullFS :: FastString -> Bool
nullFS f  =  n_bytes f == 0

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

bytesFS :: FastString -> [Word8]
428
bytesFS (FastString _ n_bytes _ buf _) =
429 430 431
  inlinePerformIO $ withForeignPtr buf $ \ptr ->
    peekArray n_bytes ptr

432
-- | Returns a Z-encoded version of a 'FastString'.  This might be the
433 434 435 436 437
-- 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
438
zEncodeFS fs@(FastString _ _ _ _ enc) =
439 440 441 442
  case enc of
    ZEncoded -> fs
    UTF8Encoded ref ->
      inlinePerformIO $ do
443 444 445 446 447 448 449
        m <- readIORef ref
        case m of
          Just fs -> return fs
          Nothing -> do
            let efs = mkZFastString (zEncodeString (unpackFS fs))
            writeIORef ref (Just efs)
            return efs
450 451

appendFS :: FastString -> FastString -> FastString
ich@christoph-bauer.net's avatar
ich@christoph-bauer.net committed
452 453 454 455 456 457 458 459 460 461 462 463
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
464 465 466 467 468

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

headFS :: FastString -> Char
469 470
headFS (FastString _ 0 _ _ _) = panic "headFS: Empty FastString"
headFS (FastString _ _ _ buf enc) =
471 472
  inlinePerformIO $ withForeignPtr buf $ \ptr -> do
    case enc of
Ian Lynagh's avatar
Ian Lynagh committed
473 474 475 476 477
      ZEncoded -> do
         w <- peek (castPtr ptr)
         return (castCCharToChar w)
      UTF8Encoded _ ->
         return (fst (utf8DecodeChar ptr))
478 479

tailFS :: FastString -> FastString
480
tailFS (FastString _ 0 _ _ _) = panic "tailFS: Empty FastString"
Ian Lynagh's avatar
Ian Lynagh committed
481
tailFS (FastString _ n_bytes _ buf enc) =
482 483 484
  inlinePerformIO $ withForeignPtr buf $ \ptr -> do
    case enc of
      ZEncoded -> do
Ian Lynagh's avatar
Ian Lynagh committed
485
        return $! mkZFastStringBytes (ptr `plusPtr` 1) (n_bytes - 1)
486
      UTF8Encoded _ -> do
Ian Lynagh's avatar
Ian Lynagh committed
487 488 489
         let (_,ptr') = utf8DecodeChar ptr
         let off = ptr' `minusPtr` ptr
         return $! mkFastStringBytes (ptr `plusPtr` off) (n_bytes - off)
490 491 492 493

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

494 495
uniqueOfFS :: FastString -> FastInt
uniqueOfFS (FastString u _ _ _ _) = iUnbox u
496

497
nilFS :: FastString
498
nilFS = mkFastString ""
499

500 501 502 503 504 505
-- -----------------------------------------------------------------------------
-- Stats

getFastStringTable :: IO [[FastString]]
getFastStringTable = do
  tbl <- readIORef string_table
506
  buckets <- mapM (lookupTbl tbl) [0 .. hASH_TBL_SIZE]
507 508
  return buckets

509 510 511
-- -----------------------------------------------------------------------------
-- Outputting 'FastString's

512 513
-- |Outputs a 'FastString' with /no decoding at all/, that is, you
-- get the actual bytes in the 'FastString' written to the 'Handle'.
514
hPutFS :: Handle -> FastString -> IO ()
515 516 517
hPutFS handle (FastString _ len _ fp _)
  | len == 0  = return ()
  | otherwise = do withForeignPtr fp $ \ptr -> hPutBuf handle ptr len
518

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

522 523
-- -----------------------------------------------------------------------------
-- LitStrings, here for convenience only.
524

525 526 527 528 529 530 531
-- 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
532

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

570 571
lengthLS :: LitString -> Int
lengthLS = ptrStrLength
572 573 574 575 576 577 578 579 580 581 582 583

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

584 585
lengthLS :: LitString -> Int
lengthLS = length
586 587

#endif
588 589 590 591

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

Ian Lynagh's avatar
Ian Lynagh committed
592
foreign import ccall unsafe "ghc_strlen"
593
  ptrStrLength :: Ptr Word8 -> Int
594

595
-- NB. does *not* add a '\0'-terminator.
596 597
-- We only use CChar here to be parallel to the imported
-- peekC(A)StringLen.
598 599 600
pokeCAString :: Ptr CChar -> String -> IO ()
pokeCAString ptr str =
  let
601
        go [] _     = return ()
Ian Lynagh's avatar
Ian Lynagh committed
602
        go (c:cs) n = do pokeElemOff ptr n (castCharToCChar c); go cs (n+1)
603 604 605
  in
  go str 0

Ian Lynagh's avatar
Ian Lynagh committed
606 607 608 609 610 611 612 613 614 615 616 617
{-# 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 #-}
618
\end{code}