[project @ 2004-08-13 13:04:50 by simonmar]
[ghc-hetmet.git] / ghc / compiler / types / TyCon.lhs
index 681d6e3..51b81d6 100644 (file)
@@ -7,14 +7,16 @@
 module TyCon(
        TyCon, ArgVrcs, 
 
-       AlgTyConFlavour(..), 
-       DataConDetails(..), visibleDataCons,
+       PrimRep(..),
+       tyConPrimRep,
+
+       AlgTyConRhs(..), visibleDataCons,
 
-       isFunTyCon, isUnLiftedTyCon, isProductTyCon,
+       isFunTyCon, isUnLiftedTyCon, isProductTyCon, isAbstractTyCon,
        isAlgTyCon, isDataTyCon, isSynTyCon, isNewTyCon, isPrimTyCon,
        isEnumerationTyCon, 
        isTupleTyCon, isUnboxedTupleTyCon, isBoxedTupleTyCon, tupleTyConBoxity,
-       isRecursiveTyCon, newTyConRep, isHiBootTyCon,
+       isRecursiveTyCon, newTyConRep, newTyConRhs, isHiBootTyCon,
 
        mkForeignTyCon, isForeignTyCon,
 
@@ -31,10 +33,9 @@ module TyCon(
        tyConUnique,
        tyConTyVars,
        tyConArgVrcs,
-       tyConDataConDetails, tyConDataCons, tyConDataCons_maybe, tyConFamilySize,
+       algTyConRhs, tyConDataCons, tyConDataCons_maybe, tyConFamilySize,
        tyConSelIds,
        tyConTheta,
-       tyConPrimRep,
        tyConArity,
        isClassTyCon, tyConClass_maybe,
        getSynTyConDefn,
@@ -61,7 +62,6 @@ 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 Outputable
 import FastString
@@ -83,7 +83,7 @@ data TyCon
     }
 
 
-  | AlgTyCon {         -- Tuples, data type, and newtype decls.
+  | AlgTyCon {         -- Data type, and newtype decls.
                        -- All lifted, all boxed
        tyConUnique :: Unique,
        tyConName   :: Name,
@@ -94,15 +94,14 @@ data TyCon
        argVrcs       :: ArgVrcs,
        algTyConTheta :: [PredType],
 
-       dataCons :: DataConDetails DataCon,
+       selIds      :: [Id],            -- Its record selectors (if any)
 
-       selIds :: [Id], -- Its record selectors (if any)
+       algRhs :: AlgTyConRhs,  -- Data constructors in here
 
-       algTyConFlavour :: AlgTyConFlavour,
-       algTyConRec     :: RecFlag,     -- Tells whether the data type is part of 
+       algTyConRec :: RecFlag,         -- Tells whether the data type is part of 
                                        -- a mutually-recursive group or not
 
-       hasGenerics :: Bool,    -- True <=> generic to/from functions are available
+       hasGenerics :: Bool,            -- True <=> generic to/from functions are available
                                        --          (in the exports of the data type's source module)
 
        algTyConClass :: Maybe Class
@@ -111,21 +110,22 @@ data TyCon
 
   | 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.
-
-       isUnLifted   :: Bool,   -- Most primitive tycons are unlifted, 
-                               -- but foreign-imported ones may not be
+       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
        tyConExtName :: Maybe FastString        -- Just xx for foreign-imported types
     }
 
   | TupleTyCon {
-
        tyConUnique :: Unique,
        tyConName   :: Name,
        tyConKind   :: Kind,
@@ -152,10 +152,23 @@ data TyCon
 type ArgVrcs = [(Bool,Bool)]  -- Tyvar variance info: [(occPos,occNeg)]
        -- [] means "no information, assume the worst"
 
-data AlgTyConFlavour
-  = DataTyCon Bool     -- Data type; True <=> an enumeration type
+data AlgTyConRhs
+  = AbstractTyCon      -- We know nothing about this data type, except 
+                       -- that it's represented by a pointer
+                       -- Used when we export a data type abstractly into
+                       -- an hi file
+
+  | DataTyCon 
+       [DataCon]       -- The constructors; can be empty if the user declares
+                       --   the type to have no constructors
+       Bool            -- Cached: True <=> an enumeration type
 
-  | NewTyCon Type      -- Newtype, with its *ultimate* representation type
+  | NewTyCon           -- Newtypes always have exactly one constructor
+       DataCon         -- The unique constructor; it has no existentials
+       Type            -- Cached: the argument type of the constructor
+                       --  = the representation type of the tycon
+
+       Type            -- Cached: the *ultimate* representation type
                        -- By 'ultimate' I mean that the rep type is not itself
                        -- a newtype or type synonym.
                        -- The rep type isn't entirely simple:
@@ -168,20 +181,50 @@ data AlgTyConFlavour
                        -- The rep type is [(a,Int)]
        -- NB: the rep type isn't necessarily the original RHS of the
        --     newtype decl, because the rep type looks through other
-       --     newtypes.  If you want hte original RHS, look at the 
-       --     argument type of the data constructor.
+       --     newtypes.
 
-data DataConDetails datacon
-  = DataCons [datacon] -- Its data constructors, with fully polymorphic types
-                       -- A type can have zero constructors
+visibleDataCons :: AlgTyConRhs -> [DataCon]
+visibleDataCons AbstractTyCon    = []
+visibleDataCons (DataTyCon cs _) = cs
+visibleDataCons (NewTyCon c _ _) = [c]
+\end{code}
 
-  | Unknown            -- Used only when We're importing this data type from an 
-                       -- hi-boot file, so we don't know what its constructors are
+%************************************************************************
+%*                                                                     *
+\subsection{PrimRep}
+%*                                                                     *
+%************************************************************************
 
-visibleDataCons (DataCons cs) = cs
-visibleDataCons other        = []
-\end{code}
+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}
 
 %************************************************************************
 %*                                                                     *
@@ -208,38 +251,36 @@ 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 cons sels flavour is_rec gen_info
+mkAlgTyCon name kind tyvars theta argvrcs rhs sels is_rec gen_info
   = AlgTyCon { 
-       tyConName        = name,
-       tyConUnique      = nameUnique name,
-       tyConKind        = kind,
-       tyConArity       = length tyvars,
-       tyConTyVars      = tyvars,
-       argVrcs          = argvrcs,
-       algTyConTheta    = theta,
-       dataCons         = cons, 
-       selIds           = sels,
-       algTyConClass    = Nothing,
-       algTyConFlavour  = flavour,
-       algTyConRec      = is_rec,
-       hasGenerics = gen_info
+       tyConName      = name,
+       tyConUnique    = nameUnique name,
+       tyConKind      = kind,
+       tyConArity     = length tyvars,
+       tyConTyVars    = tyvars,
+       argVrcs        = argvrcs,
+       algTyConTheta  = theta,
+       algRhs         = rhs,
+       selIds         = sels,
+       algTyConClass  = Nothing,
+       algTyConRec    = is_rec,
+       hasGenerics    = gen_info
     }
 
-mkClassTyCon name kind tyvars argvrcs con clas flavour is_rec
+mkClassTyCon name kind tyvars argvrcs rhs clas is_rec
   = AlgTyCon { 
-       tyConName        = name,
-       tyConUnique      = nameUnique name,
-       tyConKind        = kind,
-       tyConArity       = length tyvars,
-       tyConTyVars      = tyvars,
-       argVrcs          = argvrcs,
-       algTyConTheta    = [],
-       dataCons         = DataCons [con],
-       selIds           = [],
-       algTyConClass    = Just clas,
-       algTyConFlavour  = flavour,
-       algTyConRec      = is_rec,
-       hasGenerics = False
+       tyConName      = name,
+       tyConUnique    = nameUnique name,
+       tyConKind      = kind,
+       tyConArity     = length tyvars,
+       tyConTyVars    = tyvars,
+       argVrcs        = argvrcs,
+       algTyConTheta  = [],
+       algRhs         = rhs,
+       selIds         = [],
+       algTyConClass  = Just clas,
+       algTyConRec    = is_rec,
+       hasGenerics    = False
     }
 
 
@@ -259,7 +300,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,
@@ -267,7 +307,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
     }
@@ -310,6 +350,10 @@ isFunTyCon :: TyCon -> Bool
 isFunTyCon (FunTyCon {}) = True
 isFunTyCon _             = False
 
+isAbstractTyCon :: TyCon -> Bool
+isAbstractTyCon (AlgTyCon { algRhs = AbstractTyCon }) = True
+isAbstractTyCon _ = False
+
 isPrimTyCon :: TyCon -> Bool
 isPrimTyCon (PrimTyCon {}) = True
 isPrimTyCon _              = False
@@ -319,21 +363,16 @@ isUnLiftedTyCon (PrimTyCon  {isUnLifted = is_unlifted}) = is_unlifted
 isUnLiftedTyCon (TupleTyCon {tyConBoxed = boxity})      = not (isBoxed boxity)
 isUnLiftedTyCon _                                      = False
 
-#ifdef UNUSED
--- isBoxedTyCon should not be applied to SynTyCon, nor KindCon
-isBoxedTyCon :: TyCon -> Bool
-isBoxedTyCon (AlgTyCon {}) = True
-isBoxedTyCon (FunTyCon {}) = True
-isBoxedTyCon (TupleTyCon {tyConBoxed = boxity}) = isBoxed boxity
-isBoxedTyCon (PrimTyCon {primTyConRep = rep}) = isFollowableRep rep
-#endif
-
 -- isAlgTyCon returns True for both @data@ and @newtype@
 isAlgTyCon :: TyCon -> Bool
 isAlgTyCon (AlgTyCon {})   = True
 isAlgTyCon (TupleTyCon {}) = True
 isAlgTyCon other          = False
 
+algTyConRhs :: TyCon -> AlgTyConRhs
+algTyConRhs (AlgTyCon {algRhs = rhs})   = rhs
+algTyConRhs (TupleTyCon {dataCon = dc}) = DataTyCon [dc] False
+
 isDataTyCon :: TyCon -> Bool
 -- isDataTyCon returns True for data types that are represented by
 -- heap-allocated constructors.
@@ -342,17 +381,18 @@ isDataTyCon :: TyCon -> Bool
 --     True for all @data@ types
 --     False for newtypes
 --               unboxed tuples
-isDataTyCon (AlgTyCon {algTyConFlavour = new_or_data})  
-  = case new_or_data of
-       NewTyCon _ -> False
-       other      -> True
+isDataTyCon (AlgTyCon {algRhs = rhs})  
+  = case rhs of
+       DataTyCon _ _  -> True
+       NewTyCon _ _ _ -> False
+       AbstractTyCon  -> panic "isDataTyCon"
 
 isDataTyCon (TupleTyCon {tyConBoxed = boxity}) = isBoxed boxity
 isDataTyCon other = False
 
 isNewTyCon :: TyCon -> Bool
-isNewTyCon (AlgTyCon {algTyConFlavour = NewTyCon _}) = True 
-isNewTyCon other                                    = False
+isNewTyCon (AlgTyCon {algRhs = NewTyCon _ _ _}) = True 
+isNewTyCon other                               = False
 
 isProductTyCon :: TyCon -> Bool
 -- A "product" tycon
@@ -362,17 +402,20 @@ isProductTyCon :: TyCon -> Bool
 --     may be  DataType or NewType, 
 --     may be  unboxed or not, 
 --     may be  recursive or not
-isProductTyCon (AlgTyCon {dataCons = DataCons [data_con]}) = not (isExistentialDataCon data_con)
-isProductTyCon (TupleTyCon {})                                    = True   
-isProductTyCon other                                      = False
+isProductTyCon tc@(AlgTyCon {}) = case algRhs tc of
+                                   DataTyCon [data_con] _ -> not (isExistentialDataCon data_con)
+                                   NewTyCon _ _ _         -> True
+                                   other                  -> False
+isProductTyCon (TupleTyCon {})  = True   
+isProductTyCon other           = False
 
 isSynTyCon :: TyCon -> Bool
 isSynTyCon (SynTyCon {}) = True
 isSynTyCon _            = False
 
 isEnumerationTyCon :: TyCon -> Bool
-isEnumerationTyCon (AlgTyCon {algTyConFlavour = DataTyCon is_enum}) = is_enum
-isEnumerationTyCon other                                           = False
+isEnumerationTyCon (AlgTyCon {algRhs = DataTyCon _ is_enum}) = is_enum
+isEnumerationTyCon other                                         = False
 
 isTupleTyCon :: TyCon -> Bool
 -- The unit tycon didn't used to be classed as a tuple tycon
@@ -397,14 +440,13 @@ isRecursiveTyCon other                                  = False
 
 isHiBootTyCon :: TyCon -> Bool
 -- Used for knot-tying in hi-boot files
-isHiBootTyCon (AlgTyCon {dataCons = Unknown}) = True
-isHiBootTyCon other                          = False
+isHiBootTyCon (AlgTyCon {algRhs = 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}
@@ -413,24 +455,21 @@ tyConHasGenerics (AlgTyCon {hasGenerics = hg})   = hg
 tyConHasGenerics (TupleTyCon {hasGenerics = hg}) = hg
 tyConHasGenerics other                          = False        -- Synonyms
 
-tyConDataConDetails :: TyCon -> DataConDetails DataCon
-tyConDataConDetails (AlgTyCon {dataCons = cons}) = cons
-tyConDataConDetails (TupleTyCon {dataCon = con}) = DataCons [con]
-tyConDataConDetails other                       = pprPanic "tyConDataConDetails" (ppr other)
-
 tyConDataCons :: TyCon -> [DataCon]
 -- It's convenient for tyConDataCons to return the
 -- empty list for type synonyms etc
 tyConDataCons tycon = tyConDataCons_maybe tycon `orElse` []
 
 tyConDataCons_maybe :: TyCon -> Maybe [DataCon]
-tyConDataCons_maybe (AlgTyCon {dataCons = DataCons cons}) = Just cons
-tyConDataCons_maybe (TupleTyCon {dataCon = con})         = Just [con]
-tyConDataCons_maybe other                                = Nothing
+tyConDataCons_maybe (AlgTyCon {algRhs = DataTyCon cons _}) = Just cons
+tyConDataCons_maybe (AlgTyCon {algRhs = NewTyCon con _ _}) = Just [con]
+tyConDataCons_maybe (TupleTyCon {dataCon = con})          = Just [con]
+tyConDataCons_maybe other                                 = Nothing
 
 tyConFamilySize  :: TyCon -> Int
-tyConFamilySize (AlgTyCon {dataCons = DataCons cs}) = length cs
-tyConFamilySize (TupleTyCon {})                    = 1
+tyConFamilySize (AlgTyCon {algRhs = DataTyCon cons _}) = length cons
+tyConFamilySize (AlgTyCon {algRhs = NewTyCon _ _ _})   = 1
+tyConFamilySize (TupleTyCon {})                               = 1
 #ifdef DEBUG
 tyConFamilySize other = pprPanic "tyConFamilySize:" (ppr other)
 #endif
@@ -442,14 +481,16 @@ tyConSelIds other_tycon                  = []
 
 \begin{code}
 newTyConRep :: TyCon -> ([TyVar], Type)
-newTyConRep (AlgTyCon {tyConTyVars = tvs, algTyConFlavour = NewTyCon rep}) = (tvs, rep)
+newTyConRep (AlgTyCon {tyConTyVars = tvs, algRhs = NewTyCon _ _ rep}) = (tvs, rep)
 
+newTyConRhs :: TyCon -> ([TyVar], Type)
+newTyConRhs (AlgTyCon {tyConTyVars = tvs, algRhs = NewTyCon _ rhs _}) = (tvs, rhs)
+\end{code}
+
+\begin{code}
 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}
@@ -479,8 +520,9 @@ getSynTyConDefn (SynTyCon {tyConTyVars = tyvars, synTyConDefn = ty}) = (tyvars,t
 
 \begin{code}
 maybeTyConSingleCon :: TyCon -> Maybe DataCon
-maybeTyConSingleCon (AlgTyCon {dataCons = DataCons [c]})  = Just c
-maybeTyConSingleCon (AlgTyCon {})                        = Nothing
+maybeTyConSingleCon (AlgTyCon {algRhs = DataTyCon [c] _}) = Just c
+maybeTyConSingleCon (AlgTyCon {algRhs = NewTyCon c _ _})  = Just c
+maybeTyConSingleCon (AlgTyCon {})                        = Nothing
 maybeTyConSingleCon (TupleTyCon {dataCon = con})         = Just con
 maybeTyConSingleCon (PrimTyCon {})                       = Nothing
 maybeTyConSingleCon (FunTyCon {})                        = Nothing  -- case at funty