{-# LANGUAGE CPP, DeriveDataTypeable #-}
module Literal
(
Literal(..)
, mkMachInt, mkMachIntWrap
, mkMachWord, mkMachWordWrap
, mkMachInt64, mkMachInt64Wrap
, mkMachWord64, mkMachWord64Wrap
, mkMachFloat, mkMachDouble
, mkMachChar, mkMachString
, mkLitInteger
, literalType
, absentLiteralOf
, pprLiteral
, litIsDupable, litIsTrivial, litIsLifted
, inIntRange, inWordRange, tARGET_MAX_INT, inCharRange
, isZeroLit
, litFitsInChar
, litValue, isLitValue, isLitValue_maybe, mapLitValue
, word2IntLit, int2WordLit
, narrow8IntLit, narrow16IntLit, narrow32IntLit
, narrow8WordLit, narrow16WordLit, narrow32WordLit
, char2IntLit, int2CharLit
, float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit
, nullAddrLit, float2DoubleLit, double2FloatLit
) where
#include "HsVersions.h"
import TysPrim
import PrelNames
import Type
import TyCon
import Outputable
import FastString
import BasicTypes
import Binary
import Constants
import DynFlags
import Platform
import UniqFM
import Util
import Data.ByteString (ByteString)
import Data.Int
import Data.Word
import Data.Char
import Data.Maybe ( isJust )
import Data.Data ( Data )
import Numeric ( fromRat )
data Literal
=
MachChar Char
| MachStr ByteString
| MachNullAddr
| MachInt Integer
| MachInt64 Integer
| MachWord Integer
| MachWord64 Integer
| MachFloat Rational
| MachDouble Rational
| MachLabel FastString
(Maybe Int)
FunctionOrData
| LitInteger Integer Type
deriving Data
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 fod)
= do putByte bh 9
put_ bh aj
put_ bh mb
put_ bh fod
put_ bh (LitInteger i _) = do putByte bh 10; put_ bh i
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
fod <- get bh
return (MachLabel aj mb fod)
_ -> do
i <- get bh
return $ mkLitInteger i (panic "Evaluated the place holder for mkInteger")
instance Outputable Literal where
ppr lit = pprLiteral (\d -> d) lit
instance Eq Literal where
a == b = case (a `compare` b) of { EQ -> True; _ -> False }
a /= b = case (a `compare` b) of { EQ -> False; _ -> True }
instance Ord Literal where
a <= b = case (a `compare` b) of { LT -> True; EQ -> True; GT -> False }
a < b = case (a `compare` b) of { LT -> True; EQ -> False; GT -> False }
a >= b = case (a `compare` b) of { LT -> False; EQ -> True; GT -> True }
a > b = case (a `compare` b) of { LT -> False; EQ -> False; GT -> True }
compare a b = cmpLit a b
mkMachInt :: DynFlags -> Integer -> Literal
mkMachInt dflags x = ASSERT2( inIntRange dflags x, integer x )
MachInt x
mkMachIntWrap :: DynFlags -> Integer -> Literal
mkMachIntWrap dflags i
= MachInt $ case platformWordSize (targetPlatform dflags) of
4 -> toInteger (fromIntegral i :: Int32)
8 -> toInteger (fromIntegral i :: Int64)
w -> panic ("toIntRange: Unknown platformWordSize: " ++ show w)
mkMachWord :: DynFlags -> Integer -> Literal
mkMachWord dflags x = ASSERT2( inWordRange dflags x, integer x )
MachWord x
mkMachWordWrap :: DynFlags -> Integer -> Literal
mkMachWordWrap dflags i
= MachWord $ case platformWordSize (targetPlatform dflags) of
4 -> toInteger (fromInteger i :: Word32)
8 -> toInteger (fromInteger i :: Word64)
w -> panic ("toWordRange: Unknown platformWordSize: " ++ show w)
mkMachInt64 :: Integer -> Literal
mkMachInt64 x = ASSERT2( inInt64Range x, integer x )
MachInt64 x
mkMachInt64Wrap :: Integer -> Literal
mkMachInt64Wrap i = MachInt64 (toInteger (fromIntegral i :: Int64))
mkMachWord64 :: Integer -> Literal
mkMachWord64 x = ASSERT2( inWord64Range x, integer x )
MachWord64 x
mkMachWord64Wrap :: Integer -> Literal
mkMachWord64Wrap i = MachWord64 (toInteger (fromIntegral i :: Word64))
mkMachFloat :: Rational -> Literal
mkMachFloat = MachFloat
mkMachDouble :: Rational -> Literal
mkMachDouble = MachDouble
mkMachChar :: Char -> Literal
mkMachChar = MachChar
mkMachString :: String -> Literal
mkMachString s = MachStr (fastStringToByteString $ mkFastString s)
mkLitInteger :: Integer -> Type -> Literal
mkLitInteger = LitInteger
inIntRange, inWordRange :: DynFlags -> Integer -> Bool
inIntRange dflags x = x >= tARGET_MIN_INT dflags && x <= tARGET_MAX_INT dflags
inWordRange dflags x = x >= 0 && x <= tARGET_MAX_WORD dflags
inInt64Range, inWord64Range :: Integer -> Bool
inInt64Range x = x >= toInteger (minBound :: Int64) &&
x <= toInteger (maxBound :: Int64)
inWord64Range x = x >= toInteger (minBound :: Word64) &&
x <= toInteger (maxBound :: Word64)
inCharRange :: Char -> Bool
inCharRange c = c >= '\0' && c <= chr 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 _ = False
litValue :: Literal -> Integer
litValue l = case isLitValue_maybe l of
Just x -> x
Nothing -> pprPanic "litValue" (ppr l)
isLitValue_maybe :: Literal -> Maybe Integer
isLitValue_maybe (MachChar c) = Just $ toInteger $ ord c
isLitValue_maybe (MachInt i) = Just i
isLitValue_maybe (MachInt64 i) = Just i
isLitValue_maybe (MachWord i) = Just i
isLitValue_maybe (MachWord64 i) = Just i
isLitValue_maybe (LitInteger i _) = Just i
isLitValue_maybe _ = Nothing
mapLitValue :: DynFlags -> (Integer -> Integer) -> Literal -> Literal
mapLitValue _ f (MachChar c) = mkMachChar (fchar c)
where fchar = chr . fromInteger . f . toInteger . ord
mapLitValue dflags f (MachInt i) = mkMachIntWrap dflags (f i)
mapLitValue _ f (MachInt64 i) = mkMachInt64Wrap (f i)
mapLitValue dflags f (MachWord i) = mkMachWordWrap dflags (f i)
mapLitValue _ f (MachWord64 i) = mkMachWord64Wrap (f i)
mapLitValue _ f (LitInteger i t) = mkLitInteger (f i) t
mapLitValue _ _ l = pprPanic "mapLitValue" (ppr l)
isLitValue :: Literal -> Bool
isLitValue = isJust . isLitValue_maybe
narrow8IntLit, narrow16IntLit, narrow32IntLit,
narrow8WordLit, narrow16WordLit, narrow32WordLit,
char2IntLit, int2CharLit,
float2IntLit, int2FloatLit, double2IntLit, int2DoubleLit,
float2DoubleLit, double2FloatLit
:: Literal -> Literal
word2IntLit, int2WordLit :: DynFlags -> Literal -> Literal
word2IntLit dflags (MachWord w)
| w > tARGET_MAX_INT dflags = MachInt (w - tARGET_MAX_WORD dflags - 1)
| otherwise = MachInt w
word2IntLit _ l = pprPanic "word2IntLit" (ppr l)
int2WordLit dflags (MachInt i)
| i < 0 = MachWord (1 + tARGET_MAX_WORD dflags + i)
| otherwise = MachWord i
int2WordLit _ l = pprPanic "int2WordLit" (ppr l)
narrow8IntLit (MachInt i) = MachInt (toInteger (fromInteger i :: Int8))
narrow8IntLit l = pprPanic "narrow8IntLit" (ppr l)
narrow16IntLit (MachInt i) = MachInt (toInteger (fromInteger i :: Int16))
narrow16IntLit l = pprPanic "narrow16IntLit" (ppr l)
narrow32IntLit (MachInt i) = MachInt (toInteger (fromInteger i :: Int32))
narrow32IntLit l = pprPanic "narrow32IntLit" (ppr l)
narrow8WordLit (MachWord w) = MachWord (toInteger (fromInteger w :: Word8))
narrow8WordLit l = pprPanic "narrow8WordLit" (ppr l)
narrow16WordLit (MachWord w) = MachWord (toInteger (fromInteger w :: Word16))
narrow16WordLit l = pprPanic "narrow16WordLit" (ppr l)
narrow32WordLit (MachWord w) = MachWord (toInteger (fromInteger w :: Word32))
narrow32WordLit l = pprPanic "narrow32WordLit" (ppr l)
char2IntLit (MachChar c) = MachInt (toInteger (ord c))
char2IntLit l = pprPanic "char2IntLit" (ppr l)
int2CharLit (MachInt i) = MachChar (chr (fromInteger i))
int2CharLit l = pprPanic "int2CharLit" (ppr l)
float2IntLit (MachFloat f) = MachInt (truncate f)
float2IntLit l = pprPanic "float2IntLit" (ppr l)
int2FloatLit (MachInt i) = MachFloat (fromInteger i)
int2FloatLit l = pprPanic "int2FloatLit" (ppr l)
double2IntLit (MachDouble f) = MachInt (truncate f)
double2IntLit l = pprPanic "double2IntLit" (ppr l)
int2DoubleLit (MachInt i) = MachDouble (fromInteger i)
int2DoubleLit l = pprPanic "int2DoubleLit" (ppr l)
float2DoubleLit (MachFloat f) = MachDouble f
float2DoubleLit l = pprPanic "float2DoubleLit" (ppr l)
double2FloatLit (MachDouble d) = MachFloat d
double2FloatLit l = pprPanic "double2FloatLit" (ppr l)
nullAddrLit :: Literal
nullAddrLit = MachNullAddr
litIsTrivial :: Literal -> Bool
litIsTrivial (MachStr _) = False
litIsTrivial (LitInteger {}) = False
litIsTrivial _ = True
litIsDupable :: DynFlags -> Literal -> Bool
litIsDupable _ (MachStr _) = False
litIsDupable dflags (LitInteger i _) = inIntRange dflags i
litIsDupable _ _ = True
litFitsInChar :: Literal -> Bool
litFitsInChar (MachInt i) = i >= toInteger (ord minBound)
&& i <= toInteger (ord maxBound)
litFitsInChar _ = False
litIsLifted :: Literal -> Bool
litIsLifted (LitInteger {}) = True
litIsLifted _ = False
literalType :: Literal -> Type
literalType MachNullAddr = addrPrimTy
literalType (MachChar _) = charPrimTy
literalType (MachStr _) = addrPrimTy
literalType (MachInt _) = intPrimTy
literalType (MachWord _) = wordPrimTy
literalType (MachInt64 _) = int64PrimTy
literalType (MachWord64 _) = word64PrimTy
literalType (MachFloat _) = floatPrimTy
literalType (MachDouble _) = doublePrimTy
literalType (MachLabel _ _ _) = addrPrimTy
literalType (LitInteger _ t) = t
absentLiteralOf :: TyCon -> Maybe Literal
absentLiteralOf tc = lookupUFM absent_lits (tyConName tc)
absent_lits :: UniqFM Literal
absent_lits = listToUFM [ (addrPrimTyConKey, MachNullAddr)
, (charPrimTyConKey, MachChar 'x')
, (intPrimTyConKey, MachInt 0)
, (int64PrimTyConKey, MachInt64 0)
, (floatPrimTyConKey, MachFloat 0)
, (doublePrimTyConKey, MachDouble 0)
, (wordPrimTyConKey, MachWord 0)
, (word64PrimTyConKey, MachWord64 0) ]
cmpLit :: Literal -> Literal -> Ordering
cmpLit (MachChar a) (MachChar b) = a `compare` b
cmpLit (MachStr a) (MachStr 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 (LitInteger a _) (LitInteger b _) = a `compare` b
cmpLit lit1 lit2 | litTag lit1 < litTag lit2 = LT
| otherwise = GT
litTag :: Literal -> Int
litTag (MachChar _) = 1
litTag (MachStr _) = 2
litTag (MachNullAddr) = 3
litTag (MachInt _) = 4
litTag (MachWord _) = 5
litTag (MachInt64 _) = 6
litTag (MachWord64 _) = 7
litTag (MachFloat _) = 8
litTag (MachDouble _) = 9
litTag (MachLabel _ _ _) = 10
litTag (LitInteger {}) = 11
pprLiteral :: (SDoc -> SDoc) -> Literal -> SDoc
pprLiteral _ (MachChar c) = pprPrimChar c
pprLiteral _ (MachStr s) = pprHsBytes s
pprLiteral _ (MachNullAddr) = text "__NULL"
pprLiteral _ (MachInt i) = pprPrimInt i
pprLiteral _ (MachInt64 i) = pprPrimInt64 i
pprLiteral _ (MachWord w) = pprPrimWord w
pprLiteral _ (MachWord64 w) = pprPrimWord64 w
pprLiteral _ (MachFloat f) = float (fromRat f) <> primFloatSuffix
pprLiteral _ (MachDouble d) = double (fromRat d) <> primDoubleSuffix
pprLiteral add_par (LitInteger i _) = pprIntegerVal add_par i
pprLiteral add_par (MachLabel l mb fod) = add_par (text "__label" <+> b <+> ppr fod)
where b = case mb of
Nothing -> pprHsString l
Just x -> doubleQuotes (text (unpackFS l ++ '@':show x))
pprIntegerVal :: (SDoc -> SDoc) -> Integer -> SDoc
pprIntegerVal add_par i | i < 0 = add_par (integer i)
| otherwise = integer i