[project @ 2005-10-14 11:22:41 by simonpj]
[ghc-hetmet.git] / ghc / compiler / types / TyCon.lhs
index 24e94e5..3c1f923 100644 (file)
@@ -5,15 +5,20 @@
 
 \begin{code}
 module TyCon(
-       TyCon, ArgVrcs, 
+       TyCon, ArgVrcs, FieldLabel,
+
+       PrimRep(..),
+       tyConPrimRep,
 
        AlgTyConRhs(..), visibleDataCons,
 
-       isFunTyCon, isUnLiftedTyCon, isProductTyCon, isAbstractTyCon,
+       isFunTyCon, isUnLiftedTyCon, isProductTyCon, 
        isAlgTyCon, isDataTyCon, isSynTyCon, isNewTyCon, isPrimTyCon,
        isEnumerationTyCon, 
        isTupleTyCon, isUnboxedTupleTyCon, isBoxedTupleTyCon, tupleTyConBoxity,
-       isRecursiveTyCon, newTyConRep, newTyConRhs, isHiBootTyCon,
+       isRecursiveTyCon, newTyConRep, newTyConRhs, newTyConRhs_maybe, isHiBootTyCon,
+
+       makeTyConAbstract, isAbstractTyCon,
 
        mkForeignTyCon, isForeignTyCon,
 
@@ -32,8 +37,7 @@ module TyCon(
        tyConArgVrcs,
        algTyConRhs, tyConDataCons, tyConDataCons_maybe, tyConFamilySize,
        tyConSelIds,
-       tyConTheta,
-       tyConPrimRep,
+       tyConStupidTheta,
        tyConArity,
        isClassTyCon, tyConClass_maybe,
        getSynTyConDefn,
@@ -51,7 +55,7 @@ import {-# SOURCE #-} TypeRep ( Type, PredType )
  -- Should just be Type(Type), but this fails due to bug present up to
  -- and including 4.02 involving slurping of hi-boot files.  Bug is now fixed.
 
-import {-# SOURCE #-} DataCon ( DataCon, isExistentialDataCon )
+import {-# SOURCE #-} DataCon ( DataCon, isVanillaDataCon )
 
 
 import Var             ( TyVar, Id )
@@ -60,8 +64,8 @@ import Kind           ( Kind )
 import BasicTypes      ( Arity, RecFlag(..), Boxity(..), isBoxed )
 import Name            ( Name, nameUnique, NamedThing(getName) )
 import PrelNames       ( Unique, Uniquable(..) )
-import PrimRep         ( PrimRep(..) )
 import Maybes          ( orElse )
+import Util            ( equalLength )
 import Outputable
 import FastString
 \end{code}
@@ -89,33 +93,39 @@ data TyCon
        tyConKind   :: Kind,
        tyConArity  :: Arity,
        
-       tyConTyVars   :: [TyVar],
-       argVrcs       :: ArgVrcs,
-       algTyConTheta :: [PredType],
+       tyConTyVars :: [TyVar],         -- Scopes over (a) the [PredType] in AlgTyConRhs.DataTyCon
+                                       --             (b) the cached types in AlgTyConRhs.NewTyCon
+                                       -- But not over the data constructors
+       argVrcs     :: ArgVrcs,
+
+       algTcSelIds :: [Id],            -- Its record selectors (empty if none): 
 
-       selIds      :: [Id],            -- Its record selectors (if any)
+       algTcStupidTheta :: [PredType], -- The "stupid theta" for the data type
+                                       -- (always empty for GADTs)
 
-       algTyConRhs :: AlgTyConRhs,     -- Data constructors in here
+       algTcRhs :: AlgTyConRhs,        -- Data constructors in here
 
-       algTyConRec :: RecFlag,         -- Tells whether the data type is part of 
+       algTcRec :: RecFlag,            -- Tells whether the data type is part of 
                                        -- a mutually-recursive group or not
 
        hasGenerics :: Bool,            -- True <=> generic to/from functions are available
-                                       --          (in the exports of the data type's source module)
+                                       -- (in the exports of the data type's source module)
 
-       algTyConClass :: Maybe Class
+       algTcClass :: Maybe Class
                -- Just cl if this tycon came from a class declaration
     }
 
   | PrimTyCon {                        -- Primitive types; cannot be defined in Haskell
                                -- Now includes foreign-imported types
-       tyConUnique  :: Unique,
-       tyConName    :: Name,
-       tyConKind    :: Kind,
-       tyConArity   :: Arity,
-       argVrcs      :: ArgVrcs,
-       primTyConRep :: PrimRep,        -- Many primitive tycons are unboxed, but some are
-                                       -- boxed (represented by pointers). The PrimRep tells.
+       tyConUnique   :: Unique,
+       tyConName     :: Name,
+       tyConKind     :: Kind,
+       tyConArity    :: Arity,
+       argVrcs       :: ArgVrcs,
+
+       primTyConRep  :: PrimRep,
+                       -- Many primitive tycons are unboxed, but some are
+                       -- boxed (represented by pointers). The CgRep tells.
 
        isUnLifted   :: Bool,           -- Most primitive tycons are unlifted, 
                                        -- but foreign-imported ones may not be
@@ -123,7 +133,6 @@ data TyCon
     }
 
   | TupleTyCon {
-
        tyConUnique :: Unique,
        tyConName   :: Name,
        tyConKind   :: Kind,
@@ -147,6 +156,8 @@ data TyCon
        argVrcs :: ArgVrcs
     }
 
+type FieldLabel = Name
+
 type ArgVrcs = [(Bool,Bool)]  -- Tyvar variance info: [(occPos,occNeg)]
        -- [] means "no information, assume the worst"
 
@@ -159,7 +170,10 @@ data AlgTyConRhs
   | DataTyCon 
        [DataCon]       -- The constructors; can be empty if the user declares
                        --   the type to have no constructors
+                       -- INVARIANT: Kept in order of increasing tag
+                       --            (see the tag assignment in DataCon.mkDataCon)
        Bool            -- Cached: True <=> an enumeration type
+                       --         Includes data types with no constructors.
 
   | NewTyCon           -- Newtypes always have exactly one constructor
        DataCon         -- The unique constructor; it has no existentials
@@ -187,6 +201,42 @@ visibleDataCons (DataTyCon cs _) = cs
 visibleDataCons (NewTyCon c _ _) = [c]
 \end{code}
 
+%************************************************************************
+%*                                                                     *
+\subsection{PrimRep}
+%*                                                                     *
+%************************************************************************
+
+A PrimRep is an abstraction of a type.  It contains information that
+the code generator needs in order to pass arguments, return results,
+and store values of this type.
+
+A PrimRep is somewhat similar to a CgRep (see codeGen/SMRep) and a
+MachRep (see cmm/MachOp), although each of these types has a distinct
+and clearly defined purpose:
+
+  - A PrimRep is a CgRep + information about signedness + information
+    about primitive pointers (AddrRep).  Signedness and primitive
+    pointers are required when passing a primitive type to a foreign
+    function, but aren't needed for call/return conventions of Haskell
+    functions.
+
+  - A MachRep is a basic machine type (non-void, doesn't contain
+    information on pointerhood or signedness, but contains some
+    reps that don't have corresponding Haskell types).
+
+\begin{code}
+data PrimRep
+  = VoidRep
+  | PtrRep
+  | IntRep             -- signed, word-sized
+  | WordRep            -- unsinged, word-sized
+  | Int64Rep           -- signed, 64 bit (32-bit words only)
+  | Word64Rep          -- unsigned, 64 bit (32-bit words only)
+  | AddrRep            -- a pointer, but not to a Haskell value
+  | FloatRep
+  | DoubleRep
+\end{code}
 
 %************************************************************************
 %*                                                                     *
@@ -213,7 +263,7 @@ mkFunTyCon name kind
 -- This is the making of a TyCon. Just the same as the old mkAlgTyCon,
 -- but now you also have to pass in the generic information about the type
 -- constructor - you can get hold of it easily (see Generics module)
-mkAlgTyCon name kind tyvars theta argvrcs rhs sels is_rec gen_info
+mkAlgTyCon name kind tyvars argvrcs stupid rhs sel_ids is_rec gen_info
   = AlgTyCon { 
        tyConName        = name,
        tyConUnique      = nameUnique name,
@@ -221,11 +271,11 @@ mkAlgTyCon name kind tyvars theta argvrcs rhs sels is_rec gen_info
        tyConArity       = length tyvars,
        tyConTyVars      = tyvars,
        argVrcs          = argvrcs,
-       algTyConTheta    = theta,
-       algTyConRhs      = rhs,
-       selIds           = sels,
-       algTyConClass    = Nothing,
-       algTyConRec      = is_rec,
+       algTcStupidTheta = stupid,
+       algTcRhs         = rhs,
+       algTcSelIds      = sel_ids,
+       algTcClass       = Nothing,
+       algTcRec         = is_rec,
        hasGenerics = gen_info
     }
 
@@ -237,11 +287,11 @@ mkClassTyCon name kind tyvars argvrcs rhs clas is_rec
        tyConArity       = length tyvars,
        tyConTyVars      = tyvars,
        argVrcs          = argvrcs,
-       algTyConTheta    = [],
-       algTyConRhs      = rhs,
-       selIds           = [],
-       algTyConClass    = Just clas,
-       algTyConRec      = is_rec,
+       algTcStupidTheta = [],
+       algTcRhs         = rhs,
+       algTcSelIds      = [],
+       algTcClass       = Just clas,
+       algTcRec         = is_rec,
        hasGenerics = False
     }
 
@@ -262,7 +312,6 @@ mkTupleTyCon name kind arity tyvars con boxed gen_info
 -- as primitive, but *lifted*, TyCons for now. They are lifted
 -- because the Haskell type T representing the (foreign) .NET
 -- type T is actually implemented (in ILX) as a thunk<T>
--- They have PtrRep
 mkForeignTyCon name ext_name kind arity arg_vrcs
   = PrimTyCon {
        tyConName    = name,
@@ -270,7 +319,7 @@ mkForeignTyCon name ext_name kind arity arg_vrcs
        tyConKind    = kind,
        tyConArity   = arity,
         argVrcs      = arg_vrcs,
-       primTyConRep = PtrRep,
+       primTyConRep = PtrRep, -- they all do
        isUnLifted   = False,
        tyConExtName = ext_name
     }
@@ -314,9 +363,13 @@ isFunTyCon (FunTyCon {}) = True
 isFunTyCon _             = False
 
 isAbstractTyCon :: TyCon -> Bool
-isAbstractTyCon (AlgTyCon { algTyConRhs = AbstractTyCon }) = True
+isAbstractTyCon (AlgTyCon { algTcRhs = AbstractTyCon }) = True
 isAbstractTyCon _ = False
 
+makeTyConAbstract :: TyCon -> TyCon
+makeTyConAbstract tc@(AlgTyCon {}) = tc { algTcRhs = AbstractTyCon }
+makeTyConAbstract tc = pprPanic "makeTyConAbstract" (ppr tc)
+
 isPrimTyCon :: TyCon -> Bool
 isPrimTyCon (PrimTyCon {}) = True
 isPrimTyCon _              = False
@@ -340,18 +393,18 @@ isDataTyCon :: TyCon -> Bool
 --     True for all @data@ types
 --     False for newtypes
 --               unboxed tuples
-isDataTyCon (AlgTyCon {algTyConRhs = rhs})  
+isDataTyCon tc@(AlgTyCon {algTcRhs = rhs})  
   = case rhs of
        DataTyCon _ _  -> True
        NewTyCon _ _ _ -> False
-       AbstractTyCon  -> panic "isDataTyCon"
+       AbstractTyCon  -> pprPanic "isDataTyCon" (ppr tc)
 
 isDataTyCon (TupleTyCon {tyConBoxed = boxity}) = isBoxed boxity
 isDataTyCon other = False
 
 isNewTyCon :: TyCon -> Bool
-isNewTyCon (AlgTyCon {algTyConRhs = NewTyCon _ _ _}) = True 
-isNewTyCon other                                    = False
+isNewTyCon (AlgTyCon {algTcRhs = NewTyCon _ _ _}) = True 
+isNewTyCon other                                 = False
 
 isProductTyCon :: TyCon -> Bool
 -- A "product" tycon
@@ -361,8 +414,8 @@ isProductTyCon :: TyCon -> Bool
 --     may be  DataType or NewType, 
 --     may be  unboxed or not, 
 --     may be  recursive or not
-isProductTyCon tc@(AlgTyCon {}) = case algTyConRhs tc of
-                                   DataTyCon [data_con] _ -> not (isExistentialDataCon data_con)
+isProductTyCon tc@(AlgTyCon {}) = case algTcRhs tc of
+                                   DataTyCon [data_con] _ -> isVanillaDataCon data_con
                                    NewTyCon _ _ _         -> True
                                    other                  -> False
 isProductTyCon (TupleTyCon {})  = True   
@@ -373,13 +426,18 @@ isSynTyCon (SynTyCon {}) = True
 isSynTyCon _            = False
 
 isEnumerationTyCon :: TyCon -> Bool
-isEnumerationTyCon (AlgTyCon {algTyConRhs = DataTyCon _ is_enum}) = is_enum
-isEnumerationTyCon other                                         = False
+isEnumerationTyCon (AlgTyCon {algTcRhs = DataTyCon _ is_enum}) = is_enum
+isEnumerationTyCon other                                      = False
 
 isTupleTyCon :: TyCon -> Bool
 -- The unit tycon didn't used to be classed as a tuple tycon
 -- but I thought that was silly so I've undone it
 -- If it can't be for some reason, it should be a AlgTyCon
+--
+-- NB: when compiling Data.Tuple, the tycons won't reply True to
+-- isTupleTyCon, becuase they are built as AlgTyCons.  However they
+-- get spat into the interface file as tuple tycons, so I don't think
+-- it matters.
 isTupleTyCon (TupleTyCon {}) = True
 isTupleTyCon other          = False
 
@@ -394,19 +452,18 @@ isBoxedTupleTyCon other = False
 tupleTyConBoxity tc = tyConBoxed tc
 
 isRecursiveTyCon :: TyCon -> Bool
-isRecursiveTyCon (AlgTyCon {algTyConRec = Recursive}) = True
+isRecursiveTyCon (AlgTyCon {algTcRec = Recursive}) = True
 isRecursiveTyCon other                               = False
 
 isHiBootTyCon :: TyCon -> Bool
 -- Used for knot-tying in hi-boot files
-isHiBootTyCon (AlgTyCon {algTyConRhs = AbstractTyCon}) = True
-isHiBootTyCon other                                   = False
+isHiBootTyCon (AlgTyCon {algTcRhs = AbstractTyCon}) = True
+isHiBootTyCon other                                = False
 
 isForeignTyCon :: TyCon -> Bool
 -- isForeignTyCon identifies foreign-imported type constructors
--- For the moment, they are primitive but lifted, but that may change
-isForeignTyCon (PrimTyCon {isUnLifted = is_unlifted}) = not is_unlifted
-isForeignTyCon other                                 = False
+isForeignTyCon (PrimTyCon {tyConExtName = Just _}) = True
+isForeignTyCon other                              = False
 \end{code}
 
 \begin{code}
@@ -421,44 +478,64 @@ tyConDataCons :: TyCon -> [DataCon]
 tyConDataCons tycon = tyConDataCons_maybe tycon `orElse` []
 
 tyConDataCons_maybe :: TyCon -> Maybe [DataCon]
-tyConDataCons_maybe (AlgTyCon {algTyConRhs = DataTyCon cons _}) = Just cons
-tyConDataCons_maybe (AlgTyCon {algTyConRhs = NewTyCon con _ _}) = Just [con]
-tyConDataCons_maybe (TupleTyCon {dataCon = con})               = Just [con]
-tyConDataCons_maybe other                                      = Nothing
+tyConDataCons_maybe (AlgTyCon {algTcRhs = DataTyCon cons _}) = Just cons
+tyConDataCons_maybe (AlgTyCon {algTcRhs = NewTyCon con _ _}) = Just [con]
+tyConDataCons_maybe (TupleTyCon {dataCon = con})            = Just [con]
+tyConDataCons_maybe other                                   = Nothing
 
 tyConFamilySize  :: TyCon -> Int
-tyConFamilySize (AlgTyCon {algTyConRhs = DataTyCon cons _}) = length cons
-tyConFamilySize (AlgTyCon {algTyConRhs = NewTyCon _ _ _})   = 1
-tyConFamilySize (TupleTyCon {})                                    = 1
+tyConFamilySize (AlgTyCon {algTcRhs = DataTyCon cons _}) = length cons
+tyConFamilySize (AlgTyCon {algTcRhs = NewTyCon _ _ _})   = 1
+tyConFamilySize (TupleTyCon {})                                 = 1
 #ifdef DEBUG
 tyConFamilySize other = pprPanic "tyConFamilySize:" (ppr other)
 #endif
 
 tyConSelIds :: TyCon -> [Id]
-tyConSelIds (AlgTyCon {selIds = sels}) = sels
-tyConSelIds other_tycon                       = []
+tyConSelIds (AlgTyCon {algTcSelIds = fs}) = fs
+tyConSelIds other_tycon                          = []
+
+algTyConRhs :: TyCon -> AlgTyConRhs
+algTyConRhs (AlgTyCon {algTcRhs = rhs})  = rhs
+algTyConRhs (TupleTyCon {dataCon = con}) = DataTyCon [con] False
+algTyConRhs other = pprPanic "algTyConRhs" (ppr other)
 \end{code}
 
 \begin{code}
-newTyConRep :: TyCon -> ([TyVar], Type)
-newTyConRep (AlgTyCon {tyConTyVars = tvs, algTyConRhs = NewTyCon _ _ rep}) = (tvs, rep)
-
 newTyConRhs :: TyCon -> ([TyVar], Type)
-newTyConRhs (AlgTyCon {tyConTyVars = tvs, algTyConRhs = NewTyCon _ rhs _}) = (tvs, rhs)
+newTyConRhs (AlgTyCon {tyConTyVars = tvs, algTcRhs = NewTyCon _ rhs _}) = (tvs, rhs)
+newTyConRhs tycon = pprPanic "newTyConRhs" (ppr tycon)
+
+newTyConRhs_maybe :: TyCon 
+                 -> [Type]                     -- Args to tycon
+                 -> Maybe ([(TyVar,Type)],     -- Substitution
+                           Type)               -- Body type (not yet substituted)
+-- Non-recursive newtypes are transparent to Core; 
+-- Given an application to some types, return Just (tenv, ty)
+-- if it's a saturated, non-recursive newtype.
+newTyConRhs_maybe (AlgTyCon {tyConTyVars = tvs, 
+                            algTcRec = NonRecursive,   -- Not recursive
+                            algTcRhs = NewTyCon _ rhs _}) tys
+   | tvs `equalLength` tys     -- Saturated
+   = Just (tvs `zip` tys, rhs)
+       
+newTyConRhs_maybe other_tycon tys = Nothing
+
+
+newTyConRep :: TyCon -> ([TyVar], Type)
+newTyConRep (AlgTyCon {tyConTyVars = tvs, algTcRhs = NewTyCon _ _ rep}) = (tvs, rep)
+newTyConRep tycon = pprPanic "newTyConRep" (ppr tycon)
 
 tyConPrimRep :: TyCon -> PrimRep
 tyConPrimRep (PrimTyCon {primTyConRep = rep}) = rep
-tyConPrimRep tc                                      = ASSERT( not (isUnboxedTupleTyCon tc) )
-                                               PtrRep
-       -- We should not be asking what the representation of an
-       -- unboxed tuple is, because it isn't a first class value.
+tyConPrimRep tc = ASSERT(not (isUnboxedTupleTyCon tc)) PtrRep
 \end{code}
 
 \begin{code}
-tyConTheta :: TyCon -> [PredType]
-tyConTheta (AlgTyCon {algTyConTheta = theta}) = theta
-tyConTheta (TupleTyCon {}) = []
--- shouldn't ask about anything else
+tyConStupidTheta :: TyCon -> [PredType]
+tyConStupidTheta (AlgTyCon {algTcStupidTheta = stupid}) = stupid
+tyConStupidTheta (TupleTyCon {})                       = []
+tyConStupidTheta tycon = pprPanic "tyConStupidTheta" (ppr tycon)
 \end{code}
 
 @tyConArgVrcs_maybe@ gives a list of (occPos,occNeg) flags, one for
@@ -477,26 +554,27 @@ tyConArgVrcs (SynTyCon   {argVrcs = oi})       = oi
 \begin{code}
 getSynTyConDefn :: TyCon -> ([TyVar], Type)
 getSynTyConDefn (SynTyCon {tyConTyVars = tyvars, synTyConDefn = ty}) = (tyvars,ty)
+getSynTyConDefn tycon = pprPanic "getSynTyConDefn" (ppr tycon)
 \end{code}
 
 \begin{code}
 maybeTyConSingleCon :: TyCon -> Maybe DataCon
-maybeTyConSingleCon (AlgTyCon {algTyConRhs = DataTyCon [c] _}) = Just c
-maybeTyConSingleCon (AlgTyCon {algTyConRhs = NewTyCon c _ _})  = Just c
-maybeTyConSingleCon (AlgTyCon {})                             = Nothing
-maybeTyConSingleCon (TupleTyCon {dataCon = con})              = Just con
-maybeTyConSingleCon (PrimTyCon {})                            = Nothing
-maybeTyConSingleCon (FunTyCon {})                             = Nothing  -- case at funty
+maybeTyConSingleCon (AlgTyCon {algTcRhs = DataTyCon [c] _}) = Just c
+maybeTyConSingleCon (AlgTyCon {algTcRhs = NewTyCon c _ _})  = Just c
+maybeTyConSingleCon (AlgTyCon {})                          = Nothing
+maybeTyConSingleCon (TupleTyCon {dataCon = con})           = Just con
+maybeTyConSingleCon (PrimTyCon {})                         = Nothing
+maybeTyConSingleCon (FunTyCon {})                          = Nothing  -- case at funty
 maybeTyConSingleCon tc = pprPanic "maybeTyConSingleCon: unexpected tycon " $ ppr tc
 \end{code}
 
 \begin{code}
 isClassTyCon :: TyCon -> Bool
-isClassTyCon (AlgTyCon {algTyConClass = Just _}) = True
+isClassTyCon (AlgTyCon {algTcClass = Just _}) = True
 isClassTyCon other_tycon                        = False
 
 tyConClass_maybe :: TyCon -> Maybe Class
-tyConClass_maybe (AlgTyCon {algTyConClass = maybe_clas}) = maybe_clas
+tyConClass_maybe (AlgTyCon {algTcClass = maybe_clas}) = maybe_clas
 tyConClass_maybe ther_tycon                             = Nothing
 \end{code}