[project @ 2001-03-01 15:59:51 by simonmar]
[ghc-hetmet.git] / ghc / compiler / types / TyCon.lhs
index 1ca3393..a4bf2bc 100644 (file)
@@ -9,10 +9,11 @@ module TyCon(
 
        isFunTyCon, isUnLiftedTyCon, isBoxedTyCon, isProductTyCon,
        isAlgTyCon, isDataTyCon, isSynTyCon, isNewTyCon, isPrimTyCon,
-       isEnumerationTyCon, isTupleTyCon, isUnboxedTupleTyCon,
+       isEnumerationTyCon, 
+       isTupleTyCon, isUnboxedTupleTyCon, isBoxedTupleTyCon, tupleTyConBoxity,
        isRecursiveTyCon, newTyConRep,
 
-       mkAlgTyCon,
+       mkAlgTyCon, --mkAlgTyCon, 
        mkClassTyCon,
        mkFunTyCon,
        mkPrimTyCon,
@@ -23,22 +24,25 @@ module TyCon(
 
        setTyConName,
 
+       tyConName,
        tyConKind,
        tyConUnique,
        tyConTyVars,
        tyConArgVrcs_maybe,
-       tyConDataCons,
-       tyConFamilySize,
-       tyConDerivings,
+       tyConDataCons, tyConDataConsIfAvailable, tyConFamilySize,
+       tyConSelIds,
        tyConTheta,
        tyConPrimRep,
        tyConArity,
-       tyConClass_maybe,
+       isClassTyCon,
        getSynTyConDefn,
 
         maybeTyConSingleCon,
 
-       matchesTyCon
+       matchesTyCon,
+
+       -- Generics
+        tyConGenIds, tyConGenInfo
 ) where
 
 #include "HsVersions.h"
@@ -49,12 +53,13 @@ import {-# SOURCE #-} TypeRep ( Type, Kind, SuperKind )
 
 import {-# SOURCE #-} DataCon ( DataCon, isExistentialDataCon )
 
-import Class           ( Class )
-import Var             ( TyVar )
-import BasicTypes      ( Arity, NewOrData(..), RecFlag(..) )
-import Maybes
+
+import Class           ( ClassContext )
+import Var             ( TyVar, Id )
+import BasicTypes      ( Arity, RecFlag(..), Boxity(..), 
+                         isBoxed, EP(..) )
 import Name            ( Name, nameUnique, NamedThing(getName) )
-import Unique          ( Unique, Uniquable(..), anyBoxConKey )
+import PrelNames       ( Unique, Uniquable(..), anyBoxConKey )
 import PrimRep         ( PrimRep(..), isFollowableRep )
 import Outputable
 \end{code}
@@ -87,7 +92,7 @@ data TyCon
        
        tyConTyVars   :: [TyVar],
        tyConArgVrcs  :: ArgVrcs,
-       algTyConTheta :: [(Class,[Type])],
+       algTyConTheta :: ClassContext,
 
        dataCons :: [DataCon],
                -- Its data constructors, with fully polymorphic types
@@ -97,16 +102,25 @@ data TyCon
                --             (b) in a quest for fast compilation we don't import 
                --                 the constructors
 
-       algTyConDerivings   :: [Class], -- Classes which have derived instances
+       selIds :: [Id], -- Its record selectors (if any)
 
+       noOfDataCons :: Int,    -- Number of data constructors
+                               -- Usually this is the same as the length of the
+                               -- dataCons field, but the latter may be empty if
+                               -- we imported the type abstractly.  But even if we import
+                               -- abstractly we still need to know the number of constructors
+                               -- so we can get the return convention right.  Tiresome!
+                               
        algTyConFlavour :: AlgTyConFlavour,
        algTyConRec     :: RecFlag,             -- Tells whether the data type is part of 
                                                -- a mutually-recursive group or not
 
-       algTyConClass_maybe :: Maybe Class      -- Nothing for ordinary types; 
-                                               -- Just c for the type constructor
-                                               -- for dictionaries of class c.
+       genInfo :: Maybe (EP Id),       -- Convert T <-> Tring
+                                       -- Some TyCons don't have it; 
+                                       -- e.g. the TyCon for a Class dictionary,
+                                       -- and TyCons with unboxed arguments
 
+       algTyConClass :: Bool           -- True if this tycon comes from a class declaration
     }
 
   | PrimTyCon {                -- Primitive types; cannot be defined in Haskell
@@ -125,9 +139,10 @@ data TyCon
        tyConName   :: Name,
        tyConKind   :: Kind,
        tyConArity  :: Arity,
-       tyConBoxed  :: Bool,            -- True for boxed; False for unboxed
+       tyConBoxed  :: Boxity,
        tyConTyVars :: [TyVar],
-       dataCon     :: DataCon
+       dataCon     :: DataCon,
+       genInfo     :: Maybe (EP Id)            -- Generic type and conv funs 
     }
 
   | SynTyCon {
@@ -156,8 +171,6 @@ data TyCon
     }
 
 type ArgVrcs = [(Bool,Bool)]  -- Tyvar variance info: [(occPos,occNeg)]
-                              -- *NB*: this is tyvar variance info, *not*
-                              --       termvar usage info.
 
 data AlgTyConFlavour
   = DataTyCon          -- Data type
@@ -212,8 +225,23 @@ mkFunTyCon name kind
        tyConKind   = kind,
        tyConArity  = 2
     }
-                           
-mkAlgTyCon name kind tyvars theta argvrcs cons derivs flavour rec
+
+tyConGenInfo :: TyCon -> Maybe (EP Id)
+tyConGenInfo (AlgTyCon   { genInfo = info }) = info
+tyConGenInfo (TupleTyCon { genInfo = info }) = info
+tyConGenInfo other                          = Nothing
+
+tyConGenIds :: TyCon -> [Id]
+-- Returns the generic-programming Ids; these Ids need bindings
+tyConGenIds tycon = case tyConGenInfo tycon of
+                       Nothing           -> []
+                       Just (EP from to) -> [from,to]
+
+-- 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 ncons sels flavour rec 
+             gen_info
   = AlgTyCon { 
        tyConName               = name,
        tyConUnique             = nameUnique name,
@@ -223,10 +251,12 @@ mkAlgTyCon name kind tyvars theta argvrcs cons derivs flavour rec
        tyConArgVrcs            = argvrcs,
        algTyConTheta           = theta,
        dataCons                = cons, 
-       algTyConDerivings       = derivs,
-       algTyConClass_maybe     = Nothing,
+       selIds                  = sels,
+       noOfDataCons            = ncons,
+       algTyConClass           = False,
        algTyConFlavour         = flavour,
-       algTyConRec             = rec
+       algTyConRec             = rec,
+       genInfo                 = gen_info
     }
 
 mkClassTyCon name kind tyvars argvrcs con clas flavour
@@ -239,14 +269,16 @@ mkClassTyCon name kind tyvars argvrcs con clas flavour
        tyConArgVrcs            = argvrcs,
        algTyConTheta           = [],
        dataCons                = [con],
-       algTyConDerivings       = [],
-       algTyConClass_maybe     = Just clas,
+       selIds                  = [],
+       noOfDataCons            = 1,
+       algTyConClass           = True,
        algTyConFlavour         = flavour,
-       algTyConRec             = NonRecursive
+       algTyConRec             = NonRecursive,
+       genInfo                 = Nothing
     }
 
 
-mkTupleTyCon name kind arity tyvars con boxed
+mkTupleTyCon name kind arity tyvars con boxed gen_info
   = TupleTyCon {
        tyConUnique = nameUnique name,
        tyConName = name,
@@ -254,7 +286,8 @@ mkTupleTyCon name kind arity tyvars con boxed
        tyConArity = arity,
        tyConBoxed = boxed,
        tyConTyVars = tyvars,
-       dataCon = con
+       dataCon = con,
+       genInfo = gen_info
     }
 
 mkPrimTyCon name kind arity arg_vrcs rep 
@@ -279,6 +312,7 @@ mkSynTyCon name kind arity tyvars rhs argvrcs
     }
 
 setTyConName tc name = tc {tyConName = name, tyConUnique = nameUnique name}
+
 \end{code}
 
 \begin{code}
@@ -289,13 +323,13 @@ isPrimTyCon (PrimTyCon {}) = True
 isPrimTyCon _              = False
 
 isUnLiftedTyCon (PrimTyCon {}) = True
-isUnLiftedTyCon (TupleTyCon { tyConBoxed = False }) = True
+isUnLiftedTyCon (TupleTyCon { tyConBoxed = boxity}) = not (isBoxed boxity)
 isUnLiftedTyCon _              = False
 
 -- isBoxedTyCon should not be applied to SynTyCon, nor KindCon
 isBoxedTyCon (AlgTyCon {}) = True
 isBoxedTyCon (FunTyCon {}) = True
-isBoxedTyCon (TupleTyCon {tyConBoxed = boxed}) = boxed
+isBoxedTyCon (TupleTyCon {tyConBoxed = boxity}) = isBoxed boxity
 isBoxedTyCon (PrimTyCon {primTyConRep = rep}) = isFollowableRep rep
 
 -- isAlgTyCon returns True for both @data@ and @newtype@
@@ -307,7 +341,7 @@ isAlgTyCon other       = False
 isDataTyCon (AlgTyCon {algTyConFlavour = new_or_data})  = case new_or_data of
                                                                NewTyCon _ -> False
                                                                other   -> True
-isDataTyCon (TupleTyCon {tyConBoxed = True}) = True    
+isDataTyCon (TupleTyCon {tyConBoxed = boxity}) = isBoxed boxity
 isDataTyCon other = False
 
 isNewTyCon (AlgTyCon {algTyConFlavour = NewTyCon _}) = True 
@@ -333,46 +367,59 @@ isSynTyCon _               = False
 isEnumerationTyCon (AlgTyCon {algTyConFlavour = EnumTyCon}) = True
 isEnumerationTyCon other                                   = False
 
--- The unit tycon isn't classed as a tuple tycon
-isTupleTyCon (TupleTyCon {tyConArity = arity, tyConBoxed = True}) = arity >= 2
-isTupleTyCon other = False
+-- 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
+isTupleTyCon (TupleTyCon {}) = True
+isTupleTyCon other          = False
 
-isUnboxedTupleTyCon (TupleTyCon {tyConBoxed = False}) = True
+isUnboxedTupleTyCon (TupleTyCon {tyConBoxed = boxity}) = not (isBoxed boxity)
 isUnboxedTupleTyCon other = False
 
+isBoxedTupleTyCon (TupleTyCon {tyConBoxed = boxity}) = isBoxed boxity
+isBoxedTupleTyCon other = False
+
+tupleTyConBoxity tc = tyConBoxed tc
+
 isRecursiveTyCon (AlgTyCon {algTyConRec = Recursive}) = True
 isRecursiveTyCon other                               = False
 \end{code}
 
 \begin{code}
 tyConDataCons :: TyCon -> [DataCon]
-tyConDataCons (AlgTyCon {dataCons = cons}) = cons
-tyConDataCons (TupleTyCon {dataCon = con}) = [con]
-tyConDataCons other                       = []
+tyConDataCons tycon = ASSERT2( not (null cons), ppr tycon ) 
+                     ASSERT2( length cons == tyConFamilySize tycon, ppr tycon )
+                     cons
+                   where
+                     cons = tyConDataConsIfAvailable tycon
+
+tyConDataConsIfAvailable (AlgTyCon {dataCons = cons}) = cons   -- Empty for abstract types
+tyConDataConsIfAvailable (TupleTyCon {dataCon = con}) = [con]
+tyConDataConsIfAvailable other                       = []
        -- You may think this last equation should fail,
        -- but it's quite convenient to return no constructors for
        -- a synonym; see for example the call in TcTyClsDecls.
 
 tyConFamilySize  :: TyCon -> Int
-tyConFamilySize (AlgTyCon {dataCons = cons}) = length cons
-tyConFamilySize (TupleTyCon {}) = 1
+tyConFamilySize (AlgTyCon {noOfDataCons = n}) = n
+tyConFamilySize (TupleTyCon {})              = 1
 #ifdef DEBUG
 tyConFamilySize other = pprPanic "tyConFamilySize:" (ppr other)
 #endif
 
-tyConPrimRep :: TyCon -> PrimRep
-tyConPrimRep (PrimTyCon {primTyConRep = rep}) = rep
-tyConPrimRep _                               = PtrRep
+tyConSelIds :: TyCon -> [Id]
+tyConSelIds (AlgTyCon {selIds = sels}) = sels
+tyConSelIds other_tycon                       = []
 \end{code}
 
 \begin{code}
-tyConDerivings :: TyCon -> [Class]
-tyConDerivings (AlgTyCon {algTyConDerivings = derivs}) = derivs
-tyConDerivings other                                  = []
+tyConPrimRep :: TyCon -> PrimRep
+tyConPrimRep (PrimTyCon {primTyConRep = rep}) = rep
+tyConPrimRep _                               = PtrRep
 \end{code}
 
 \begin{code}
-tyConTheta :: TyCon -> [(Class, [Type])]
+tyConTheta :: TyCon -> ClassContext
 tyConTheta (AlgTyCon {algTyConTheta = theta}) = theta
 -- should ask about anything else
 \end{code}
@@ -409,9 +456,9 @@ maybeTyConSingleCon tc = pprPanic "maybeTyConSingleCon: unexpected tycon " $
 \end{code}
 
 \begin{code}
-tyConClass_maybe :: TyCon -> Maybe Class
-tyConClass_maybe (AlgTyCon {algTyConClass_maybe = maybe_cls}) = maybe_cls
-tyConClass_maybe other_tycon                                 = Nothing
+isClassTyCon :: TyCon -> Bool
+isClassTyCon (AlgTyCon {algTyConClass = is_class_tycon}) = is_class_tycon
+isClassTyCon other_tycon                                = False
 \end{code}
 
 
@@ -442,7 +489,7 @@ instance Uniquable TyCon where
     getUnique tc = tyConUnique tc
 
 instance Outputable TyCon where
-    ppr tc  = ppr (getName tc)
+    ppr tc  = ppr (getName tc) 
 
 instance NamedThing TyCon where
     getName = tyConName
@@ -469,3 +516,6 @@ matchesTyCon tc1 tc2 =  uniq1 == uniq2 || uniq1 == anyBoxConKey
                        uniq1 = tyConUnique tc1
                        uniq2 = tyConUnique tc2
 \end{code}
+
+
+