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

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

14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
-- |
-- 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'.
31 32
module FastString
       (
Ian Lynagh's avatar
Ian Lynagh committed
33 34
        -- * FastStrings
        FastString(..),     -- not abstract, for now.
35

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

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

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

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

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

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

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

91
#include "HsVersions.h"
92

93
import Encoding
94 95
import FastTypes
import FastFunctions
96
import Panic
97
import Util
98

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

109
import GhcIO ( IO(..) )
110

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

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


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

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

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

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

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

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

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

161 162 163 164 165 166
instance Data FastString where
  -- don't traverse?
  toConstr _   = abstractConstr "FastString"
  gunfold _ _  = error "gunfold"
  dataTypeOf _ = mkNoRepType "FastString"

167 168 169
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
170 171 172 173 174 175 176 177 178 179 180
  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
181

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

187 188
-- -----------------------------------------------------------------------------
-- Construction
189

190
{-
191 192 193 194
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.
195
-}
196

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

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

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

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

220
mkFastString# :: Addr# -> FastString
221
mkFastString# a# = mkFastStringBytes ptr (ptrStrLength ptr)
222
  where ptr = Ptr a#
223

224
mkFastStringBytes :: Ptr Word8 -> Int -> FastString
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
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
243 244

mkZFastStringBytes :: Ptr Word8 -> Int -> FastString
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
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
263 264 265 266 267 268

-- | 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
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
  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
287 288 289

mkZFastStringForeignPtr :: Ptr Word8 -> ForeignPtr Word8 -> Int -> IO FastString
mkZFastStringForeignPtr ptr fp len = do
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
  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

309

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

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

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

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

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

357 358 359
mkNewZFastString :: Int -> Ptr Word8 -> ForeignPtr Word8 -> Int
                 -> IO FastString
mkNewZFastString uid _ fp len = do
360 361
  return (FastString uid len len fp ZEncoded)

362
copyNewFastString :: Int -> Ptr Word8 -> Int -> IO FastString
363 364 365 366 367 368
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))

369
copyNewZFastString :: Int -> Ptr Word8 -> Int -> IO FastString
370 371 372 373
copyNewZFastString uid ptr len = do
  fp <- copyBytesToForeignPtr ptr len
  return (FastString uid len len fp ZEncoded)

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

397 398
-- -----------------------------------------------------------------------------
-- Operations
399

400 401 402
-- | Returns the length of the 'FastString' in characters
lengthFS :: FastString -> Int
lengthFS f = n_chars f
403

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

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

420
-- | Returns @True@ if the 'FastString' is empty
421 422 423
nullFS :: FastString -> Bool
nullFS f  =  n_bytes f == 0

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

bytesFS :: FastString -> [Word8]
433
bytesFS (FastString _ n_bytes _ buf _) =
434 435 436
  inlinePerformIO $ withForeignPtr buf $ \ptr ->
    peekArray n_bytes ptr

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

appendFS :: FastString -> FastString -> FastString
ich@christoph-bauer.net's avatar
ich@christoph-bauer.net committed
457 458 459 460 461 462 463 464 465 466 467 468
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
469 470 471 472 473

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

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

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

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

499 500
uniqueOfFS :: FastString -> FastInt
uniqueOfFS (FastString u _ _ _ _) = iUnbox u
501

502
nilFS :: FastString
503
nilFS = mkFastString ""
504

505 506 507 508 509 510
-- -----------------------------------------------------------------------------
-- Stats

getFastStringTable :: IO [[FastString]]
getFastStringTable = do
  tbl <- readIORef string_table
511
  buckets <- mapM (lookupTbl tbl) [0 .. hASH_TBL_SIZE]
512 513
  return buckets

514 515 516
-- -----------------------------------------------------------------------------
-- Outputting 'FastString's

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

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

527 528
-- -----------------------------------------------------------------------------
-- LitStrings, here for convenience only.
529

530 531 532 533 534 535 536
-- 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
537

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

575 576
lengthLS :: LitString -> Int
lengthLS = ptrStrLength
577 578 579 580 581 582 583 584 585 586 587 588

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

589 590
lengthLS :: LitString -> Int
lengthLS = length
591 592

#endif
593 594 595 596

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

Ian Lynagh's avatar
Ian Lynagh committed
597
foreign import ccall unsafe "ghc_strlen"
598
  ptrStrLength :: Ptr Word8 -> Int
599

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

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