[project @ 2003-07-09 11:08:03 by simonpj]
[ghc-hetmet.git] / ghc / compiler / basicTypes / Literal.lhs
index 7df6fca..1e39e65 100644 (file)
@@ -8,11 +8,13 @@ module Literal
        ( Literal(..)           -- Exported to ParseIface
        , mkMachInt, mkMachWord
        , mkMachInt64, mkMachWord64
-       , isLitLitLit, maybeLitLit, litSize, litIsDupable,
+       , isLitLitLit, maybeLitLit, litSize
+       , litIsDupable, litIsTrivial
        , literalType, literalPrimRep
        , hashLiteral
 
        , inIntRange, inWordRange, tARGET_MAX_INT, inCharRange
+       , isZeroLit,
 
        , word2IntLit, int2WordLit
        , narrow8IntLit, narrow16IntLit, narrow32IntLit
@@ -35,12 +37,14 @@ import CStrings             ( pprFSInCStyle )
 
 import Outputable
 import FastTypes
+import FastString
+import Binary
 import Util            ( thenCmp )
 
 import Ratio           ( numerator )
 import FastString      ( uniqueOfFS, lengthFS )
-import Int             ( Int8,  Int16,  Int32 )
-import Word            ( Word8, Word16, Word32 )
+import DATA_INT                ( Int8,  Int16,  Int32 )
+import DATA_WORD       ( Word8, Word16, Word32 )
 import Char            ( ord, chr )
 \end{code}
 
@@ -96,9 +100,10 @@ data Literal
   =    ------------------
        -- First the primitive guys
     MachChar   Int             -- Char#        At least 31 bits
-  | MachStr    FAST_STRING
+  | MachStr    FastString
 
-  | MachAddr   Integer -- Whatever this machine thinks is a "pointer"
+  | MachNullAddr                -- the NULL pointer, the only pointer value
+                                -- that can be represented as a Literal.
 
   | MachInt    Integer         -- Int#         At least WORD_SIZE_IN_BITS bits
   | MachInt64  Integer         -- Int64#       At least 64 bits
@@ -112,13 +117,72 @@ data Literal
        -- "foreign label" declaration.
        -- string argument is the name of a symbol.  This literal
        -- refers to the *address* of the label.
-  | MachLabel   FAST_STRING            -- always an Addr#
+  | MachLabel   FastString             -- always an Addr#
+               (Maybe Int)             -- the size (in bytes) of the arguments
+                                       -- the label expects. Only applicable with
+                                       -- 'stdcall' labels.
+                                       -- Just x => "@<x>" will be appended to label
+                                       --           name when emitting asm.
 
        -- lit-lits only work for via-C compilation, hence they
        -- are deprecated.  The string is emitted verbatim into
        -- the C file, and can therefore be any C expression,
        -- macro call, #defined constant etc.
-  | MachLitLit  FAST_STRING Type       -- Type might be Addr# or Int# etc
+  | MachLitLit  FastString Type        -- Type might be Addr# or Int# etc
+\end{code}
+
+Binary instance: must do this manually, because we don't want the type
+arg of MachLitLit involved.
+
+\begin{code}
+instance Binary Literal where
+    put_ bh (MachChar aa)     = do putByte bh 0; put_ bh aa
+    put_ bh (MachStr ab)      = do putByte bh 1; put_ bh ab
+    put_ bh (MachNullAddr)    = do putByte bh 2
+    put_ bh (MachInt ad)      = do putByte bh 3; put_ bh ad
+    put_ bh (MachInt64 ae)    = do putByte bh 4; put_ bh ae
+    put_ bh (MachWord af)     = do putByte bh 5; put_ bh af
+    put_ bh (MachWord64 ag)   = do putByte bh 6; put_ bh ag
+    put_ bh (MachFloat ah)    = do putByte bh 7; put_ bh ah
+    put_ bh (MachDouble ai)   = do putByte bh 8; put_ bh ai
+    put_ bh (MachLabel aj mb) = do putByte bh 9; put_ bh aj ; put_ bh mb
+    put_ bh (MachLitLit ak _) = do putByte bh 10; put_ bh ak
+    get bh = do
+           h <- getByte bh
+           case h of
+             0 -> do
+                   aa <- get bh
+                   return (MachChar aa)
+             1 -> do
+                   ab <- get bh
+                   return (MachStr ab)
+             2 -> do
+                   return (MachNullAddr)
+             3 -> do
+                   ad <- get bh
+                   return (MachInt ad)
+             4 -> do
+                   ae <- get bh
+                   return (MachInt64 ae)
+             5 -> do
+                   af <- get bh
+                   return (MachWord af)
+             6 -> do
+                   ag <- get bh
+                   return (MachWord64 ag)
+             7 -> do
+                   ah <- get bh
+                   return (MachFloat ah)
+             8 -> do
+                   ai <- get bh
+                   return (MachDouble ai)
+             9 -> do
+                   aj <- get bh
+                   mb <- get bh
+                   return (MachLabel aj mb)
+             10 -> do
+                   ak <- get bh
+                   return (MachLitLit ak (error "MachLitLit: no type"))
 \end{code}
 
 \begin{code}
@@ -163,6 +227,15 @@ inWordRange x = x >= 0                 && x <= tARGET_MAX_WORD
 
 inCharRange :: Int -> Bool
 inCharRange c =  c >= 0 && c <= tARGET_MAX_CHAR
+
+isZeroLit :: Literal -> Bool
+isZeroLit (MachInt    0) = True
+isZeroLit (MachInt64  0) = True
+isZeroLit (MachWord   0) = True
+isZeroLit (MachWord64 0) = True
+isZeroLit (MachFloat  0) = True
+isZeroLit (MachDouble 0) = True
+isZeroLit other                 = False
 \end{code}
 
        Coercions
@@ -204,7 +277,7 @@ float2DoubleLit (MachFloat  f) = MachDouble f
 double2FloatLit (MachDouble d) = MachFloat  d
 
 nullAddrLit :: Literal
-nullAddrLit = MachAddr 0
+nullAddrLit = MachNullAddr
 \end{code}
 
        Predicates
@@ -216,15 +289,26 @@ isLitLitLit _                  = False
 maybeLitLit (MachLitLit s t) = Just (s,t)
 maybeLitLit _               = Nothing
 
+litIsTrivial :: Literal -> Bool
+-- True if there is absolutely no penalty to duplicating the literal
+--     c.f. CoreUtils.exprIsTrivial
+-- False principally of strings
+litIsTrivial (MachStr _) = False
+litIsTrivial other      = True
+
 litIsDupable :: Literal -> Bool
-       -- True if code space does not go bad if we duplicate this literal
-       -- False principally of strings
+-- True if code space does not go bad if we duplicate this literal
+--     c.f. CoreUtils.exprIsDupable
+-- Currently we treat it just like litIsTrivial
 litIsDupable (MachStr _) = False
 litIsDupable other      = True
 
 litSize :: Literal -> Int
-       -- used by CoreUnfold.sizeExpr
-litSize (MachStr str) = lengthFS str `div` 4
+-- Used by CoreUnfold.sizeExpr
+litSize (MachStr str) = 1 + (lengthFS str `div` 4)
+       -- Every literal has size at least 1, otherwise
+       --      f "x" 
+       -- might be too small
 litSize _other       = 1
 \end{code}
 
@@ -234,14 +318,14 @@ litSize _other          = 1
 literalType :: Literal -> Type
 literalType (MachChar _)         = charPrimTy
 literalType (MachStr  _)         = addrPrimTy
-literalType (MachAddr _)         = addrPrimTy
+literalType (MachNullAddr)       = addrPrimTy
 literalType (MachInt  _)         = intPrimTy
 literalType (MachWord  _)        = wordPrimTy
 literalType (MachInt64  _)       = int64PrimTy
 literalType (MachWord64  _)      = word64PrimTy
 literalType (MachFloat _)        = floatPrimTy
 literalType (MachDouble _)       = doublePrimTy
-literalType (MachLabel _)        = addrPrimTy
+literalType (MachLabel _ _)      = addrPrimTy
 literalType (MachLitLit _ ty)    = ty
 \end{code}
 
@@ -250,14 +334,14 @@ literalPrimRep :: Literal -> PrimRep
 
 literalPrimRep (MachChar _)      = CharRep
 literalPrimRep (MachStr _)       = AddrRep  -- specifically: "char *"
-literalPrimRep (MachAddr  _)     = AddrRep
+literalPrimRep (MachNullAddr)    = AddrRep
 literalPrimRep (MachInt _)       = IntRep
 literalPrimRep (MachWord _)      = WordRep
 literalPrimRep (MachInt64 _)     = Int64Rep
 literalPrimRep (MachWord64 _)    = Word64Rep
 literalPrimRep (MachFloat _)     = FloatRep
 literalPrimRep (MachDouble _)    = DoubleRep
-literalPrimRep (MachLabel _)     = AddrRep
+literalPrimRep (MachLabel _ _)   = AddrRep
 literalPrimRep (MachLitLit _ ty)  = typePrimRep ty
 \end{code}
 
@@ -267,42 +351,41 @@ literalPrimRep (MachLitLit _ ty)  = typePrimRep ty
 \begin{code}
 cmpLit (MachChar      a)   (MachChar      b)   = a `compare` b
 cmpLit (MachStr       a)   (MachStr       b)   = a `compare` b
-cmpLit (MachAddr      a)   (MachAddr      b)   = a `compare` b
+cmpLit (MachNullAddr)      (MachNullAddr)       = EQ
 cmpLit (MachInt       a)   (MachInt       b)   = a `compare` b
 cmpLit (MachWord      a)   (MachWord      b)   = a `compare` b
 cmpLit (MachInt64     a)   (MachInt64     b)   = a `compare` b
 cmpLit (MachWord64    a)   (MachWord64    b)   = a `compare` b
 cmpLit (MachFloat     a)   (MachFloat     b)   = a `compare` b
 cmpLit (MachDouble    a)   (MachDouble    b)   = a `compare` b
-cmpLit (MachLabel     a)   (MachLabel      b)   = a `compare` b
+cmpLit (MachLabel     a _) (MachLabel      b _) = a `compare` b
 cmpLit (MachLitLit    a b) (MachLitLit    c d)  = (a `compare` c) `thenCmp` (b `tcCmpType` d)
 cmpLit lit1               lit2                 | litTag lit1 <# litTag lit2 = LT
                                                | otherwise                    = GT
 
 litTag (MachChar      _)   = _ILIT(1)
 litTag (MachStr       _)   = _ILIT(2)
-litTag (MachAddr      _)   = _ILIT(3)
+litTag (MachNullAddr)      = _ILIT(3)
 litTag (MachInt       _)   = _ILIT(4)
 litTag (MachWord      _)   = _ILIT(5)
 litTag (MachInt64     _)   = _ILIT(6)
 litTag (MachWord64    _)   = _ILIT(7)
 litTag (MachFloat     _)   = _ILIT(8)
 litTag (MachDouble    _)   = _ILIT(9)
-litTag (MachLabel     _)   = _ILIT(10)
-litTag (MachLitLit    _ _) = _ILIT(11)
+litTag (MachLabel   _ _)   = _ILIT(10)
+litTag (MachLitLit  _ _)   = _ILIT(11)
 \end{code}
 
        Printing
        ~~~~~~~~
 * MachX (i.e. unboxed) things are printed unadornded (e.g. 3, 'a', "foo")
-  exceptions: MachFloat and MachAddr get an initial keyword prefix
+  exceptions: MachFloat gets an initial keyword prefix.
 
 \begin{code}
 pprLit lit
   = getPprStyle $ \ sty ->
     let
       code_style  = codeStyle  sty
-      iface_style = ifaceStyle sty
     in
     case lit of
       MachChar ch | code_style -> hcat [ptext SLIT("(C_)"), text (show ch)]
@@ -327,23 +410,32 @@ pprLit lit
       MachWord64 w | code_style -> pprHexVal w
                   | otherwise  -> ptext SLIT("__word64") <+> integer w
 
-      MachFloat f | code_style -> ptext SLIT("(StgFloat)") <> rational f
+      MachFloat f | code_style -> ptext SLIT("(StgFloat)") <> code_rational f
                   | otherwise  -> ptext SLIT("__float") <+> rational f
 
-      MachDouble d | iface_style && d < 0 -> parens (rational d)
-                  | otherwise            -> rational d
+      MachDouble d | code_style -> code_rational d
+                  | otherwise  -> rational d
 
-      MachAddr p | code_style -> ptext SLIT("(void*)") <> integer p
-                | otherwise  -> ptext SLIT("__addr") <+> integer p
+      MachNullAddr | code_style -> ptext SLIT("(void*)0")
+                  | otherwise  -> ptext SLIT("__NULL")
 
-      MachLabel l | code_style -> ptext SLIT("(&") <> ptext l <> char ')'
-                 | otherwise  -> ptext SLIT("__label") <+> pprHsString l
+      MachLabel l mb
+         | code_style -> ptext SLIT("(&") <> ftext l <> char ')'
+        | otherwise  -> ptext SLIT("__label") <+> 
+            case mb of
+              Nothing -> pprHsString l
+              Just x  -> doubleQuotes (text (unpackFS l ++ '@':show x))
 
-      MachLitLit s ty | code_style  -> ptext s
+      MachLitLit s ty | code_style  -> ftext s
                      | otherwise   -> parens (hsep [ptext SLIT("__litlit"), 
                                                     pprHsString s,
                                                     pprParendType ty])
 
+-- negative floating literals in code style need parentheses to avoid
+-- interacting with surrounding syntax.
+code_rational d | d < 0     = parens (rational d)
+                | otherwise = rational d
+
 pprIntVal :: Integer -> SDoc
 -- Print negative integers with parens to be sure it's unambiguous
 pprIntVal i | i < 0     = parens (integer i)
@@ -376,14 +468,14 @@ Hash values should be zero or a positive integer.  No negatives please.
 hashLiteral :: Literal -> Int
 hashLiteral (MachChar c)       = c + 1000      -- Keep it out of range of common ints
 hashLiteral (MachStr s)        = hashFS s
-hashLiteral (MachAddr i)       = hashInteger i
+hashLiteral (MachNullAddr)     = 0
 hashLiteral (MachInt i)        = hashInteger i
 hashLiteral (MachInt64 i)      = hashInteger i
 hashLiteral (MachWord i)       = hashInteger i
 hashLiteral (MachWord64 i)     = hashInteger i
 hashLiteral (MachFloat r)      = hashRational r
 hashLiteral (MachDouble r)     = hashRational r
-hashLiteral (MachLabel s)       = hashFS s
+hashLiteral (MachLabel s _)     = hashFS s
 hashLiteral (MachLitLit s _)    = hashFS s
 
 hashRational :: Rational -> Int
@@ -394,6 +486,6 @@ hashInteger i = 1 + abs (fromInteger (i `rem` 10000))
                -- The 1+ is to avoid zero, which is a Bad Number
                -- since we use * to combine hash values
 
-hashFS :: FAST_STRING -> Int
+hashFS :: FastString -> Int
 hashFS s = iBox (uniqueOfFS s)
 \end{code}