[project @ 2003-06-25 16:24:56 by simonpj]
[ghc-hetmet.git] / ghc / compiler / types / TyCon.lhs
index 4fc0348..6f1ac54 100644 (file)
@@ -5,7 +5,10 @@
 
 \begin{code}
 module TyCon(
-       TyCon, KindCon, SuperKindCon, ArgVrcs, AlgTyConFlavour(..),
+       TyCon, KindCon, SuperKindCon, ArgVrcs, 
+
+       AlgTyConFlavour(..), 
+       DataConDetails(..), visibleDataCons,
 
        isFunTyCon, isUnLiftedTyCon, isBoxedTyCon, isProductTyCon,
        isAlgTyCon, isDataTyCon, isSynTyCon, isNewTyCon, isPrimTyCon,
@@ -15,10 +18,11 @@ module TyCon(
 
        mkForeignTyCon, isForeignTyCon,
 
-       mkAlgTyCon, --mkAlgTyCon, 
+       mkAlgTyCon,
        mkClassTyCon,
        mkFunTyCon,
        mkPrimTyCon,
+       mkLiftedPrimTyCon,
        mkTupleTyCon,
        mkSynTyCon,
        mkKindCon,
@@ -31,7 +35,7 @@ module TyCon(
        tyConUnique,
        tyConTyVars,
        tyConArgVrcs_maybe,
-       tyConDataCons, tyConDataConsIfAvailable, tyConFamilySize,
+       tyConDataConDetails, tyConDataCons, tyConDataCons_maybe, tyConFamilySize,
        tyConSelIds,
        tyConTheta,
        tyConPrimRep,
@@ -63,6 +67,7 @@ import BasicTypes     ( Arity, RecFlag(..), Boxity(..),
 import Name            ( Name, nameUnique, NamedThing(getName) )
 import PrelNames       ( Unique, Uniquable(..), anyBoxConKey )
 import PrimRep         ( PrimRep(..), isFollowableRep )
+import Maybes          ( orElse )
 import Outputable
 import FastString
 \end{code}
@@ -97,33 +102,21 @@ data TyCon
        tyConArgVrcs  :: ArgVrcs,
        algTyConTheta :: [PredType],
 
-       dataCons :: [DataCon],
-               -- Its data constructors, with fully polymorphic types
-               --      This list can be empty, when we import a data type abstractly,
-               --      either (a) the interface is hand-written and doesn't give
-               --                 the constructors, or
-               --             (b) in a quest for fast compilation we don't import 
-               --                 the constructors
+       dataCons :: DataConDetails DataCon,
 
        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
+       algTyConRec     :: RecFlag,     -- Tells whether the data type is part of 
+                                       -- a mutually-recursive group or not
 
        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 :: Maybe Class    -- Just cl if this tycon came from a class declaration
+       algTyConClass :: Maybe Class
+               -- Just cl if this tycon came from a class declaration
     }
 
   | PrimTyCon {                        -- Primitive types; cannot be defined in Haskell
@@ -182,21 +175,41 @@ type ArgVrcs = [(Bool,Bool)]  -- Tyvar variance info: [(occPos,occNeg)]
 
 data AlgTyConFlavour
   = DataTyCon          -- Data type
+
   | EnumTyCon          -- Special sort of enumeration type
+
   | NewTyCon Type      -- Newtype, with its *ultimate* representation type
                        -- By 'ultimate' I mean that the rep type is not itself
                        -- a newtype or type synonym.
-
-                       -- The rep type has explicit for-alls for the tyvars of
-                       -- the TyCon.  Thus:
-                       --      newtype T a = MkT [(a,Int)]
-                       -- The rep type is forall a. [(a,Int)]
-                       --
                        -- The rep type isn't entirely simple:
                        --  for a recursive newtype we pick () as the rep type
                        --      newtype T = MkT T
+                       --
+                       -- The rep type has free type variables the tyConTyVars
+                       -- Thus:
+                       --      newtype T a = MkT [(a,Int)]
+                       -- 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.
+
+data DataConDetails datacon
+  = DataCons [datacon] -- Its data constructors, with fully polymorphic types
+                       -- A type can have zero constructors
+
+  | Unknown            -- We're importing this data type from an hi-boot file
+                       -- and we don't know what its constructors are
+
+  | HasCons Int                -- In a quest for compilation speed we have imported
+                       -- only the number of constructors (to get return 
+                       -- conventions right) but not the constructors themselves
+
+visibleDataCons (DataCons cs) = cs
+visibleDataCons other        = []
 \end{code}
 
+
 %************************************************************************
 %*                                                                     *
 \subsection{TyCon Construction}
@@ -248,7 +261,7 @@ tyConGenIds tycon = case tyConGenInfo tycon of
 -- 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 
+mkAlgTyCon name kind tyvars theta argvrcs cons sels flavour is_rec 
              gen_info
   = AlgTyCon { 
        tyConName               = name,
@@ -260,14 +273,13 @@ mkAlgTyCon name kind tyvars theta argvrcs cons ncons sels flavour rec
        algTyConTheta           = theta,
        dataCons                = cons, 
        selIds                  = sels,
-       noOfDataCons            = ncons,
        algTyConClass           = Nothing,
        algTyConFlavour         = flavour,
-       algTyConRec             = rec,
+       algTyConRec             = is_rec,
        genInfo                 = gen_info
     }
 
-mkClassTyCon name kind tyvars argvrcs con clas flavour
+mkClassTyCon name kind tyvars argvrcs con clas flavour is_rec
   = AlgTyCon { 
        tyConName               = name,
        tyConUnique             = nameUnique name,
@@ -276,12 +288,11 @@ mkClassTyCon name kind tyvars argvrcs con clas flavour
        tyConTyVars             = tyvars,
        tyConArgVrcs            = argvrcs,
        algTyConTheta           = [],
-       dataCons                = [con],
+       dataCons                = DataCons [con],
        selIds                  = [],
-       noOfDataCons            = 1,
        algTyConClass           = Just clas,
        algTyConFlavour         = flavour,
-       algTyConRec             = NonRecursive,
+       algTyConRec             = is_rec,
        genInfo                 = Nothing
     }
 
@@ -316,7 +327,15 @@ mkForeignTyCon name ext_name kind arity arg_vrcs
     }
 
 
+-- most Prim tycons are lifted
 mkPrimTyCon name kind arity arg_vrcs rep
+  = mkPrimTyCon' name kind arity arg_vrcs rep True  
+
+-- but RealWorld is lifted
+mkLiftedPrimTyCon name kind arity arg_vrcs rep
+  = mkPrimTyCon' name kind arity arg_vrcs rep False
+
+mkPrimTyCon' name kind arity arg_vrcs rep is_unlifted
   = PrimTyCon {
        tyConName    = name,
        tyConUnique  = nameUnique name,
@@ -324,7 +343,7 @@ mkPrimTyCon name kind arity arg_vrcs rep
        tyConArity   = arity,
         tyConArgVrcs = arg_vrcs,
        primTyConRep = rep,
-       isUnLifted   = True,
+       isUnLifted   = is_unlifted,
        tyConExtName = Nothing
     }
 
@@ -344,40 +363,53 @@ setTyConName tc name = tc {tyConName = name, tyConUnique = nameUnique name}
 \end{code}
 
 \begin{code}
+isFunTyCon :: TyCon -> Bool
 isFunTyCon (FunTyCon {}) = True
 isFunTyCon _             = False
 
+isPrimTyCon :: TyCon -> Bool
 isPrimTyCon (PrimTyCon {}) = True
 isPrimTyCon _              = False
 
+isUnLiftedTyCon :: TyCon -> Bool
 isUnLiftedTyCon (PrimTyCon  {isUnLifted = is_unlifted}) = is_unlifted
 isUnLiftedTyCon (TupleTyCon {tyConBoxed = boxity})      = not (isBoxed boxity)
 isUnLiftedTyCon _                                      = False
 
 -- 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
 
 -- isAlgTyCon returns True for both @data@ and @newtype@
+isAlgTyCon :: TyCon -> Bool
 isAlgTyCon (AlgTyCon {})   = True
 isAlgTyCon (TupleTyCon {}) = True
 isAlgTyCon other          = False
 
--- isDataTyCon returns False for @newtype@ and for unboxed tuples
-isDataTyCon (AlgTyCon {algTyConFlavour = new_or_data})  = case new_or_data of
-                                                               NewTyCon _ -> False
-                                                               other   -> True
+isDataTyCon :: TyCon -> Bool
+-- isDataTyCon returns True for data types that are represented by
+-- heap-allocated constructors.
+-- These are srcutinised by Core-level @case@ expressions, and they
+-- get info tables allocated for them.
+--     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 (TupleTyCon {tyConBoxed = boxity}) = isBoxed boxity
 isDataTyCon other = False
 
+isNewTyCon :: TyCon -> Bool
 isNewTyCon (AlgTyCon {algTyConFlavour = NewTyCon _}) = True 
 isNewTyCon other                                    = False
 
-newTyConRep (AlgTyCon {algTyConFlavour = NewTyCon rep}) = Just rep
-newTyConRep other                                      = Nothing
-
+isProductTyCon :: TyCon -> Bool
 -- A "product" tycon
 --     has *one* constructor, 
 --     is *not* existential
@@ -385,33 +417,40 @@ newTyConRep other                                 = Nothing
 --     may be  DataType or NewType, 
 --     may be  unboxed or not, 
 --     may be  recursive or not
-isProductTyCon (AlgTyCon {dataCons = [data_con]}) = not (isExistentialDataCon data_con)
-isProductTyCon (TupleTyCon {})                           = True
-isProductTyCon other                             = False
+isProductTyCon (AlgTyCon {dataCons = DataCons [data_con]}) = not (isExistentialDataCon data_con)
+isProductTyCon (TupleTyCon {})                                    = True   
+isProductTyCon other                                      = False
 
+isSynTyCon :: TyCon -> Bool
 isSynTyCon (SynTyCon {}) = True
 isSynTyCon _            = False
 
+isEnumerationTyCon :: TyCon -> Bool
 isEnumerationTyCon (AlgTyCon {algTyConFlavour = EnumTyCon}) = True
 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
 isTupleTyCon (TupleTyCon {}) = True
 isTupleTyCon other          = False
 
+isUnboxedTupleTyCon :: TyCon -> Bool
 isUnboxedTupleTyCon (TupleTyCon {tyConBoxed = boxity}) = not (isBoxed boxity)
 isUnboxedTupleTyCon other = False
 
+isBoxedTupleTyCon :: TyCon -> Bool
 isBoxedTupleTyCon (TupleTyCon {tyConBoxed = boxity}) = isBoxed boxity
 isBoxedTupleTyCon other = False
 
 tupleTyConBoxity tc = tyConBoxed tc
 
+isRecursiveTyCon :: TyCon -> Bool
 isRecursiveTyCon (AlgTyCon {algTyConRec = Recursive}) = True
 isRecursiveTyCon 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
@@ -419,22 +458,25 @@ isForeignTyCon other                                    = False
 \end{code}
 
 \begin{code}
+tyConDataConDetails :: TyCon -> DataConDetails DataCon
+tyConDataConDetails (AlgTyCon {dataCons = cons}) = cons
+tyConDataConDetails (TupleTyCon {dataCon = con}) = DataCons [con]
+tyConDataConDetails other                       = Unknown
+
 tyConDataCons :: TyCon -> [DataCon]
-tyConDataCons 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.
+-- 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
 
 tyConFamilySize  :: TyCon -> Int
-tyConFamilySize (AlgTyCon {noOfDataCons = n}) = n
-tyConFamilySize (TupleTyCon {})              = 1
+tyConFamilySize (AlgTyCon {dataCons = DataCons cs}) = length cs
+tyConFamilySize (AlgTyCon {dataCons = HasCons n})   = n
+tyConFamilySize (TupleTyCon {})                    = 1
 #ifdef DEBUG
 tyConFamilySize other = pprPanic "tyConFamilySize:" (ppr other)
 #endif
@@ -445,15 +487,22 @@ tyConSelIds other_tycon                  = []
 \end{code}
 
 \begin{code}
+newTyConRep :: TyCon -> ([TyVar], Type)
+newTyConRep (AlgTyCon {tyConTyVars = tvs, algTyConFlavour = NewTyCon rep}) = (tvs, rep)
+
 tyConPrimRep :: TyCon -> PrimRep
 tyConPrimRep (PrimTyCon {primTyConRep = rep}) = rep
-tyConPrimRep _                               = PtrRep
+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.
 \end{code}
 
 \begin{code}
 tyConTheta :: TyCon -> [PredType]
 tyConTheta (AlgTyCon {algTyConTheta = theta}) = theta
--- should ask about anything else
+tyConTheta (TupleTyCon {}) = []
+-- shouldn't ask about anything else
 \end{code}
 
 @tyConArgVrcs_maybe@ gives a list of (occPos,occNeg) flags, one for
@@ -478,13 +527,12 @@ getSynTyConDefn (SynTyCon {tyConTyVars = tyvars, synTyConDefn = ty}) = (tyvars,t
 
 \begin{code}
 maybeTyConSingleCon :: TyCon -> Maybe DataCon
-maybeTyConSingleCon (AlgTyCon {dataCons = [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
+maybeTyConSingleCon (AlgTyCon {dataCons = DataCons [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}