[project @ 2001-04-27 19:35:50 by qrczak]
[ghc-hetmet.git] / ghc / compiler / basicTypes / Literal.lhs
index 907eba3..206df95 100644 (file)
@@ -8,13 +8,16 @@ module Literal
        ( Literal(..)           -- Exported to ParseIface
        , mkMachInt, mkMachWord
        , mkMachInt64, mkMachWord64
-       , isLitLitLit, maybeLitLit
+       , isLitLitLit, maybeLitLit, litSize, litIsDupable,
        , literalType, literalPrimRep
        , hashLiteral
 
-       , inIntRange, inWordRange, tARGET_MAX_INT
+       , inIntRange, inWordRange, tARGET_MAX_INT, inCharRange
 
-       , word2IntLit, int2WordLit, char2IntLit, int2CharLit
+       , word2IntLit, int2WordLit
+       , intToInt8Lit, intToInt16Lit, intToInt32Lit
+       , wordToWord8Lit, wordToWord16Lit, wordToWord32Lit
+       , char2IntLit, int2CharLit
        , float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit
        , addr2IntLit, int2AddrLit, float2DoubleLit, double2FloatLit
        ) where
@@ -24,19 +27,19 @@ module Literal
 import TysPrim         ( charPrimTy, addrPrimTy, floatPrimTy, doublePrimTy,
                          intPrimTy, wordPrimTy, int64PrimTy, word64PrimTy
                        )
-import Name            ( hashName )
 import PrimRep         ( PrimRep(..) )
-import TyCon           ( isNewTyCon )
 import Type            ( Type, typePrimRep )
 import PprType         ( pprParendType )
-import Demand          ( Demand )
-import CStrings                ( charToC, charToEasyHaskell, pprFSInCStyle )
+import CStrings                ( pprFSInCStyle )
 
 import Outputable
+import FastTypes
 import Util            ( thenCmp )
 
-import Ratio           ( numerator, denominator )
-import FastString      ( uniqueOfFS )
+import Ratio           ( numerator )
+import FastString      ( uniqueOfFS, lengthFS )
+import Int             ( Int8,  Int16,  Int32 )
+import Word            ( Word8, Word16, Word32 )
 import Char            ( ord, chr )
 \end{code}
 
@@ -63,6 +66,9 @@ tARGET_MIN_INT = -2147483648
 tARGET_MAX_INT =  2147483647
 #endif
 tARGET_MAX_WORD = (tARGET_MAX_INT * 2) + 1
+
+tARGET_MAX_CHAR :: Int
+tARGET_MAX_CHAR = 0x10ffff
 \end{code}
  
 
@@ -88,7 +94,7 @@ function applications, etc., etc., has not yet been done.
 data Literal
   =    ------------------
        -- First the primitive guys
-    MachChar   Char
+    MachChar   Int             -- Char#        At least 31 bits
   | MachStr    FAST_STRING
 
   | MachAddr   Integer -- Whatever this machine thinks is a "pointer"
@@ -101,7 +107,17 @@ data Literal
   | MachFloat  Rational
   | MachDouble Rational
 
-  | MachLitLit  FAST_STRING Type       -- Type might be Add# or Int# etc
+        -- MachLabel is used (only) for the literal derived from a 
+       -- "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#
+
+       -- 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
 \end{code}
 
 \begin{code}
@@ -137,25 +153,39 @@ mkMachWord64 x = MachWord64 x     -- Ditto?
 inIntRange, inWordRange :: Integer -> Bool
 inIntRange  x = x >= tARGET_MIN_INT && x <= tARGET_MAX_INT
 inWordRange x = x >= 0             && x <= tARGET_MAX_WORD
+
+inCharRange :: Int -> Bool
+inCharRange c =  c >= 0 && c <= tARGET_MAX_CHAR
 \end{code}
 
        Coercions
        ~~~~~~~~~
 \begin{code}
-word2IntLit, int2WordLit, char2IntLit, int2CharLit,
- float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit,
- addr2IntLit, int2AddrLit, float2DoubleLit, double2FloatLit :: Literal -> Literal
+word2IntLit, int2WordLit,
+  intToInt8Lit, intToInt16Lit, intToInt32Lit,
+  wordToWord8Lit, wordToWord16Lit, wordToWord32Lit,
+  char2IntLit, int2CharLit,
+  float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit,
+  addr2IntLit, int2AddrLit, float2DoubleLit, double2FloatLit
+  :: Literal -> Literal
 
 word2IntLit (MachWord w) 
-  | w > tARGET_MAX_INT = MachInt ((-1) + tARGET_MAX_WORD - w)
+  | w > tARGET_MAX_INT = MachInt (w - tARGET_MAX_WORD - 1)
   | otherwise         = MachInt w
 
 int2WordLit (MachInt i)
   | i < 0     = MachWord (1 + tARGET_MAX_WORD + i)     -- (-1)  --->  tARGET_MAX_WORD
   | otherwise = MachWord i
 
-char2IntLit (MachChar c) = MachInt  (toInteger (ord c))
-int2CharLit (MachInt  i) = MachChar (chr (fromInteger i))
+intToInt8Lit    (MachInt  i) = MachInt  (toInteger (fromInteger i :: Int8))
+intToInt16Lit   (MachInt  i) = MachInt  (toInteger (fromInteger i :: Int16))
+intToInt32Lit   (MachInt  i) = MachInt  (toInteger (fromInteger i :: Int32))
+wordToWord8Lit  (MachWord w) = MachWord (toInteger (fromInteger w :: Word8))
+wordToWord16Lit (MachWord w) = MachWord (toInteger (fromInteger w :: Word16))
+wordToWord32Lit (MachWord w) = MachWord (toInteger (fromInteger w :: Word32))
+
+char2IntLit (MachChar c) = MachInt  (toInteger c)
+int2CharLit (MachInt  i) = MachChar (fromInteger i)
 
 float2IntLit (MachFloat f) = MachInt   (truncate    f)
 int2FloatLit (MachInt   i) = MachFloat (fromInteger i)
@@ -178,6 +208,17 @@ isLitLitLit _                   = False
 
 maybeLitLit (MachLitLit s t) = Just (s,t)
 maybeLitLit _               = Nothing
+
+litIsDupable :: Literal -> Bool
+       -- True if code space does not go bad if we duplicate this literal
+       -- False principally of strings
+litIsDupable (MachStr _) = False
+litIsDupable other      = True
+
+litSize :: Literal -> Int
+       -- used by CoreUnfold.sizeExpr
+litSize (MachStr str) = lengthFS str `div` 4
+litSize _other       = 1
 \end{code}
 
        Types
@@ -193,6 +234,7 @@ literalType (MachInt64  _)    = int64PrimTy
 literalType (MachWord64  _)      = word64PrimTy
 literalType (MachFloat _)        = floatPrimTy
 literalType (MachDouble _)       = doublePrimTy
+literalType (MachLabel _)        = addrPrimTy
 literalType (MachLitLit _ ty)    = ty
 \end{code}
 
@@ -208,6 +250,7 @@ literalPrimRep (MachInt64 _)          = Int64Rep
 literalPrimRep (MachWord64 _)    = Word64Rep
 literalPrimRep (MachFloat _)     = FloatRep
 literalPrimRep (MachDouble _)    = DoubleRep
+literalPrimRep (MachLabel _)     = AddrRep
 literalPrimRep (MachLitLit _ ty)  = typePrimRep ty
 \end{code}
 
@@ -224,20 +267,22 @@ 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 (MachLitLit    a b) (MachLitLit    c d)  = (a `compare` c) `thenCmp` (b `compare` d)
-cmpLit lit1               lit2                 | litTag lit1 _LT_ litTag lit2 = LT
+cmpLit lit1               lit2                 | litTag lit1 <# litTag lit2 = LT
                                                | otherwise                    = GT
 
-litTag (MachChar      _)   = ILIT(1)
-litTag (MachStr       _)   = ILIT(2)
-litTag (MachAddr      _)   = 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 (MachLitLit    _ _) = ILIT(10)
+litTag (MachChar      _)   = _ILIT(1)
+litTag (MachStr       _)   = _ILIT(2)
+litTag (MachAddr      _)   = _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)
 \end{code}
 
        Printing
@@ -253,13 +298,13 @@ pprLit lit
       iface_style = ifaceStyle sty
     in
     case lit of
-      MachChar ch | code_style  -> hcat [ptext SLIT("(C_)"), char '\'', 
-                                        text (charToC ch), char '\'']
-                 | iface_style -> char '\'' <> text (charToEasyHaskell ch) <> char '\''
-                 | otherwise   -> text ['\'', ch, '\'']
+      MachChar ch | code_style -> hcat [ptext SLIT("(C_)"), text (show ch)]
+                 | otherwise  -> pprHsChar ch
 
       MachStr s | code_style -> pprFSInCStyle s
-               | otherwise  -> pprFSAsString s
+               | otherwise  -> pprHsString s
+      -- Warning: printing MachStr in code_style assumes it contains
+      -- only characters '\0'..'\xFF'!
 
       MachInt i | code_style && i == tARGET_MIN_INT -> parens (integer (i+1) <> text "-1")
                                -- Avoid a problem whereby gcc interprets
@@ -284,9 +329,12 @@ pprLit lit
       MachAddr p | code_style -> ptext SLIT("(void*)") <> integer p
                 | otherwise  -> ptext SLIT("__addr") <+> integer p
 
+      MachLabel l | code_style -> ptext SLIT("(&") <> ptext l <> char ')'
+                 | otherwise  -> ptext SLIT("__label") <+> pprHsString l
+
       MachLitLit s ty | code_style  -> ptext s
                      | otherwise   -> parens (hsep [ptext SLIT("__litlit"), 
-                                                    pprFSAsString s,
+                                                    pprHsString s,
                                                     pprParendType ty])
 
 pprIntVal :: Integer -> SDoc
@@ -319,7 +367,7 @@ Hash values should be zero or a positive integer.  No negatives please.
 
 \begin{code}
 hashLiteral :: Literal -> Int
-hashLiteral (MachChar c)       = ord c + 1000  -- Keep it out of range of common ints
+hashLiteral (MachChar c)       = c + 1000      -- Keep it out of range of common ints
 hashLiteral (MachStr s)        = hashFS s
 hashLiteral (MachAddr i)       = hashInteger i
 hashLiteral (MachInt i)        = hashInteger i
@@ -328,6 +376,7 @@ 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 (MachLitLit s _)    = hashFS s
 
 hashRational :: Rational -> Int
@@ -339,5 +388,5 @@ hashInteger i = 1 + abs (fromInteger (i `rem` 10000))
                -- since we use * to combine hash values
 
 hashFS :: FAST_STRING -> Int
-hashFS s = IBOX( uniqueOfFS s )
+hashFS s = iBox (uniqueOfFS s)
 \end{code}