[project @ 2001-05-22 13:43:14 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcTyDecls.lhs
index 3ad7b06..afbd15e 100644 (file)
 %
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1995
+% (c) The AQUA Project, Glasgow University, 1996-1998
 %
-\section[TcTyDecls]{Typecheck algebraic datatypes and type synonyms}
+\section[TcTyDecls]{Typecheck type declarations}
 
 \begin{code}
-#include "HsVersions.h"
+module TcTyDecls (
+       tcTyDecl1, kcConDetails, mkNewTyConRep
+    ) where
 
-module TcTyDecls ( tcTyDecls ) where
+#include "HsVersions.h"
 
-import TcMonad         -- typechecking monad machinery
-import AbsSyn          -- the stuff being typechecked
+import HsSyn           ( TyClDecl(..), ConDecl(..), ConDetails(..), 
+                         getBangType, getBangStrictness, conDetailsTys
+                       )
+import RnHsSyn         ( RenamedTyClDecl, RenamedConDecl, RenamedContext )
+import BasicTypes      ( NewOrData(..), RecFlag, isRec )
 
-import AbsUniType      ( applyTyCon, mkDataTyCon, mkSynonymTyCon,
-                         getUniDataTyCon, isUnboxedDataType,
-                         isTyVarTemplateTy, cmpUniTypeMaybeList,
-                         pprMaybeTy
+import TcMonoType      ( tcHsRecType, tcHsTyVars, tcRecTheta,
+                         kcHsContext, kcHsSigType, kcHsLiftedSigType
+                       )
+import TcEnv           ( tcExtendTyVarEnv, 
+                         tcLookupTyCon, tcLookupRecId, 
+                         TyThingDetails(..), RecTcEnv
                        )
-import CE              ( lookupCE, CE(..) )
-import CmdLineOpts     ( GlobalSwitch(..) )
-import E               ( getE_TCE, getE_CE, plusGVE, nullGVE, GVE(..), E )
-import ErrUtils                ( addShortErrLocLine )
-import Errors          ( confusedNameErr, specDataNoSpecErr, specDataUnboxedErr )
-import FiniteMap       ( FiniteMap, emptyFM, plusFM, singletonFM )
-import IdInfo          ( SpecEnv, mkSpecEnv, SpecInfo(..) )
-import Pretty
-import SpecTyFuns      ( specialiseConstrTys )
-import TCE             -- ( nullTCE, unitTCE, lookupTCE, plusTCE, TCE(..), UniqFM )
-import TVE             ( mkTVE, TVE(..) )
-import TcConDecls      ( tcConDecls )
-import TcMonoType      ( tcMonoType )
-import TcPragmas       ( tcDataPragmas, tcTypePragmas )
-import Util
+import TcMonad
+
+import DataCon         ( DataCon, mkDataCon, dataConFieldLabels, dataConRepType )
+import MkId            ( mkDataConId, mkDataConWrapId, mkRecordSelId )
+import FieldLabel
+import Var             ( TyVar )
+import Name            ( Name, NamedThing(..) )
+import Outputable
+import TyCon           ( TyCon, isNewTyCon, tyConTyVars )
+import Type            ( tyVarsOfTypes, tyVarsOfPred, splitFunTy, applyTys,
+                         mkTyConApp, mkTyVarTys, mkForAllTys, 
+                         splitAlgTyConApp_maybe, Type, ThetaType
+                       )
+import TysWiredIn      ( unitTy )
+import VarSet          ( intersectVarSet, isEmptyVarSet )
+import PrelNames       ( unpackCStringName, unpackCStringUtf8Name )
+import ListSetOps      ( equivClasses )
 \end{code}
 
-We consult the @CE@/@TCE@ arguments {\em only} to build knots!
-
-The resulting @TCE@ has info about the type constructors in it; the
-@GVE@ has info about their data constructors.
+%************************************************************************
+%*                                                                     *
+\subsection{Type checking}
+%*                                                                     *
+%************************************************************************
 
 \begin{code}
-tcTyDecls :: E
-         -> (Name -> Bool)                     -- given Name, is it an abstract synonym?
-         -> (Name -> [RenamedDataTypeSig])     -- given Name, get specialisation pragmas
-         -> [RenamedTyDecl]
-         -> Baby_TcM (TCE, GVE, 
-                      FiniteMap TyCon [(Bool, [Maybe UniType])])
-                                               -- specialisations:
-                                               --   True  => imported data types i.e. from interface file
-                                               --   False => local data types i.e. requsted by source pragmas
-
-tcTyDecls e _ _ [] = returnB_Tc (nullTCE, nullGVE, emptyFM)
-
-tcTyDecls e is_abs_syn get_spec_sigs (tyd: tyds)
-  = tc_decl   tyd          `thenB_Tc` \ (tce1, gve1, specs1) ->
-    tcTyDecls e is_abs_syn get_spec_sigs tyds
-                           `thenB_Tc` \ (tce2, gve2, specs2) ->
+tcTyDecl1 :: RecFlag -> RecTcEnv -> RenamedTyClDecl -> TcM (Name, TyThingDetails)
+tcTyDecl1 is_rec unf_env (TySynonym {tcdName = tycon_name, tcdSynRhs = rhs})
+  = tcLookupTyCon tycon_name                   `thenNF_Tc` \ tycon ->
+    tcExtendTyVarEnv (tyConTyVars tycon)       $
+    tcHsRecType is_rec rhs                     `thenTc` \ rhs_ty ->
+       -- Note tcHsRecType not tcHsRecSigType; we allow type synonyms
+       -- that aren't types; e.g.  type List = []
+       --
+       -- If the RHS mentions tyvars that aren't in scope, we'll 
+       -- quantify over them:
+       --      e.g.    type T = a->a
+       -- will become  type T = forall a. a->a
+       --
+       -- With gla-exts that's right, but for H98 we should complain. 
+       -- We can now do that here without falling into
+       -- a black hole, we still do it in rnDecl (TySynonym case)
+
+    returnTc (tycon_name, SynTyDetails rhs_ty)
+
+tcTyDecl1 is_rec unf_env (TyData {tcdND = new_or_data, tcdCtxt = context,
+                                 tcdName = tycon_name, tcdCons = con_decls})
+  = tcLookupTyCon tycon_name                   `thenNF_Tc` \ tycon ->
     let
-       tce3   = tce1 `plusTCE` tce2
-       gve3   = gve1 `plusGVE` gve2
-       specs3 = specs1 `plusFM` specs2
+       tyvars = tyConTyVars tycon
     in
-    returnB_Tc (tce3, gve3, specs3)
-  where
-    rec_ce  = getE_CE  e
-    rec_tce = getE_TCE e
+    tcExtendTyVarEnv tyvars                            $
 
-    -- continued...
+       -- Typecheck the pieces
+    tcRecTheta is_rec context                                          `thenTc` \ ctxt ->
+    mapTc (tcConDecl is_rec new_or_data tycon tyvars ctxt) con_decls   `thenTc` \ data_cons ->
+    tcRecordSelectors is_rec unf_env tycon data_cons                   `thenTc` \ sel_ids -> 
+    returnTc (tycon_name, DataTyDetails ctxt data_cons sel_ids)
 \end{code}
 
-We don't need to substitute here, because the @TCE@s
-(which are at the top level) cannot contain free type variables.
-
-Gather relevant info:
 \begin{code}
-    tc_decl (TyData context name@(PreludeTyCon uniq full_name arity True{-"data"-})
-                   tyvars con_decls derivings pragmas src_loc)
-                           -- ToDo: context
-      = tc_data_decl uniq name full_name arity tyvars con_decls
-                    derivings pragmas src_loc
-
-    tc_decl (TyData context name@(OtherTyCon uniq full_name arity True{-"data"-} _)
-                   tyvars con_decls derivings pragmas src_loc)
-                           -- ToDo: context
-      = tc_data_decl uniq name full_name arity tyvars con_decls
-                    derivings pragmas src_loc
-
-    tc_decl (TyData _ bad_name _ _ _ _ src_loc)
-      = failB_Tc (confusedNameErr "Bad name on a datatype constructor (a Prelude name?)"
-                   bad_name src_loc)
-
-    tc_decl (TySynonym name@(PreludeTyCon uniq full_name arity False{-"type"-})
-                       tyvars mono_ty pragmas src_loc)
-      = tc_syn_decl uniq name full_name arity tyvars mono_ty pragmas src_loc
-
-    tc_decl (TySynonym name@(OtherTyCon uniq full_name arity False{-"type"-} _)
-                       tyvars mono_ty pragmas src_loc)
-      = tc_syn_decl uniq name full_name arity tyvars mono_ty pragmas src_loc
-
-    tc_decl (TySynonym bad_name _ _ _ src_loc)
-      = failB_Tc (confusedNameErr "Bad name on a type-synonym constructor (a Prelude name?)"
-                   bad_name src_loc)
+mkNewTyConRep :: TyCon -> Type
+-- Find the representation type for this newtype TyCon
+-- The trick is to to deal correctly with recursive newtypes
+-- such as     newtype T = MkT T
+
+mkNewTyConRep tc
+  = mkForAllTys tvs (loop [] (mkTyConApp tc (mkTyVarTys tvs)))
+  where
+    tvs = tyConTyVars tc
+    loop tcs ty = case splitAlgTyConApp_maybe ty of {
+                       Nothing -> ty ;
+                       Just (tc, tys, data_cons) | not (isNewTyCon tc) -> ty
+                                                 | tc `elem` tcs       -> unitTy
+                                                 | otherwise           ->
+
+                 case splitFunTy (applyTys (dataConRepType (head data_cons)) tys) of
+                       (rep_ty, _) -> loop (tc:tcs) rep_ty
+                 }
 \end{code}
 
-Real work for @data@ declarations:
-\begin{code}
-    tc_data_decl uniq name full_name arity tyvars con_decls derivings pragmas src_loc
-      = addSrcLocB_Tc src_loc (
-       let
-           (tve, new_tyvars, _) = mkTVE tyvars
-           rec_tycon            = lookupTCE rec_tce name
-               -- We know the lookup will succeed, because we are just
-               -- about to put it in the outgoing TCE!
 
-           spec_sigs = get_spec_sigs name
-       in
-       tcSpecDataSigs rec_tce spec_sigs []     `thenB_Tc` \ user_spec_infos ->
+%************************************************************************
+%*                                                                     *
+\subsection{Kind and type check constructors}
+%*                                                                     *
+%************************************************************************
 
-       recoverIgnoreErrorsB_Tc ([], []) (
-           tcDataPragmas rec_tce tve rec_tycon new_tyvars pragmas
-       )               `thenB_Tc` \ (pragma_con_decls, pragma_spec_infos) ->
+\begin{code}
+kcConDetails :: NewOrData -> RenamedContext -> ConDetails Name -> TcM ()
+kcConDetails new_or_data ex_ctxt details
+  = kcHsContext ex_ctxt                `thenTc_`
+    mapTc_ kc_sig_type (conDetailsTys details)
+  where
+    kc_sig_type = case new_or_data of
+                   DataType -> kcHsSigType
+                   NewType  -> kcHsLiftedSigType
+           -- Can't allow an unlifted type here, because we're effectively
+           -- going to remove the constructor while coercing it to a lifted type.
+
+
+tcConDecl :: RecFlag -> NewOrData -> TyCon -> [TyVar] -> ThetaType -> RenamedConDecl -> TcM DataCon
+
+tcConDecl is_rec new_or_data tycon tyvars ctxt (ConDecl name wkr_name ex_tvs ex_ctxt details src_loc)
+  = tcAddSrcLoc src_loc                                                        $
+    tcHsTyVars ex_tvs (kcConDetails new_or_data ex_ctxt details)       $ \ ex_tyvars ->
+    tcRecTheta is_rec ex_ctxt                                          `thenTc` \ ex_theta ->
+    case details of
+       VanillaCon btys    -> tc_datacon ex_tyvars ex_theta btys
+       InfixCon bty1 bty2 -> tc_datacon ex_tyvars ex_theta [bty1,bty2]
+       RecCon fields      -> tc_rec_con ex_tyvars ex_theta fields
+  where
+    tc_datacon ex_tyvars ex_theta btys
+      = let
+           arg_stricts = map getBangStrictness btys
+           tys         = map getBangType btys
+        in
+       mapTc (tcHsRecType is_rec) tys          `thenTc` \ arg_tys ->
+       mk_data_con ex_tyvars ex_theta arg_stricts arg_tys []
+
+    tc_rec_con ex_tyvars ex_theta fields
+      = checkTc (null ex_tyvars) (exRecConErr name)    `thenTc_`
+       mapTc tc_field (fields `zip` allFieldLabelTags) `thenTc` \ field_labels_s ->
        let
-           (condecls_to_use, ignore_condecl_errors_if_pragma)
-             = if null pragma_con_decls then
-                   (con_decls, id)
-               else
-                   if null con_decls
-                   then (pragma_con_decls, recoverIgnoreErrorsB_Tc nullGVE)
-                   else panic "tcTyDecls:data: user and pragma condecls!"
-
-           (imported_specs, specinfos_to_use)
-             = if null pragma_spec_infos then
-                   (False, user_spec_infos)
-               else
-                   if null user_spec_infos
-                   then (True, pragma_spec_infos)
-                   else panic "tcTyDecls:data: user and pragma specinfos!"
-
-           specenv_to_use = mkSpecEnv specinfos_to_use
+           field_labels = concat field_labels_s
+           arg_stricts = [str | (ns, bty) <- fields, 
+                                let str = getBangStrictness bty, 
+                                n <- ns                -- One for each.  E.g   x,y,z :: !Int
+                         ]
        in
-       ignore_condecl_errors_if_pragma
-       (tcConDecls rec_tce tve rec_tycon new_tyvars specenv_to_use condecls_to_use)
-                                                       `thenB_Tc` \ gve ->
-       let
-           condecls = map snd gve
-
-           derived_classes = map (lookupCE rec_ce) derivings
-
-           new_tycon
-             = mkDataTyCon uniq
-                           full_name arity new_tyvars condecls
-                           derived_classes
-                           (null pragma_con_decls)
-                           -- if constrs are from pragma we are *abstract*
-
-           spec_list
-             = [(imported_specs, maybe_tys) | (SpecInfo maybe_tys _ _) <- specinfos_to_use]
-
-           spec_map
-             = if null spec_list then
-                   emptyFM
-               else
-                   singletonFM rec_tycon spec_list
+       mk_data_con ex_tyvars ex_theta arg_stricts 
+                   (map fieldLabelType field_labels) field_labels
+
+    tc_field ((field_label_names, bty), tag)
+      = tcHsRecType is_rec (getBangType bty)           `thenTc` \ field_ty ->
+       returnTc [mkFieldLabel (getName name) tycon field_ty tag | name <- field_label_names]
+
+    mk_data_con ex_tyvars ex_theta arg_stricts arg_tys fields
+      = let
+          data_con = mkDataCon name arg_stricts fields
+                          tyvars (thinContext arg_tys ctxt)
+                          ex_tyvars ex_theta
+                          arg_tys
+                          tycon data_con_id data_con_wrap_id
+
+          data_con_id      = mkDataConId wkr_name data_con
+          data_con_wrap_id = mkDataConWrapId data_con
        in
-       returnB_Tc (unitTCE uniq new_tycon, gve, spec_map)
-           -- It's OK to return pragma condecls in gve, even
-           -- though some of those names should be "invisible",
-           -- because the *renamer* is supposed to have dealt with
-           -- naming/scope issues already.
-       )
-\end{code}
+       returnNF_Tc data_con
 
-Real work for @type@ (synonym) declarations:
-\begin{code}
-    tc_syn_decl uniq name full_name arity tyvars mono_ty pragmas src_loc
-      = addSrcLocB_Tc src_loc (
-
-       let (tve, new_tyvars, _) = mkTVE tyvars
-       in
-       tcMonoType rec_ce rec_tce tve mono_ty   `thenB_Tc` \ expansion ->
-       let
-           -- abstractness info either comes from the interface pragmas
-           -- (tcTypePragmas) or from a user-pragma in this module
-           -- (is_abs_syn)
-           abstract = tcTypePragmas pragmas
-                   || is_abs_syn name
-
-           new_tycon = mkSynonymTyCon uniq full_name
-                           arity new_tyvars expansion (not abstract)
-       in
-       returnB_Tc (unitTCE uniq new_tycon, nullGVE, emptyFM)
-       )
+-- The context for a data constructor should be limited to
+-- the type variables mentioned in the arg_tys
+thinContext arg_tys ctxt
+  = filter in_arg_tys ctxt
+  where
+      arg_tyvars = tyVarsOfTypes arg_tys
+      in_arg_tys pred = not $ isEmptyVarSet $ 
+                       tyVarsOfPred pred `intersectVarSet` arg_tyvars
 \end{code}
 
+
 %************************************************************************
 %*                                                                     *
-\subsection{Specialisation Signatures for Data Type declarations}
+\subsection{Record selectors}
 %*                                                                     *
 %************************************************************************
 
-@tcSpecDataSigs@ checks data type specialisation signatures for
-validity, and returns the list of specialisation requests.
-
 \begin{code}
-tcSpecDataSigs :: TCE
-              -> [RenamedDataTypeSig]
-              -> [(RenamedDataTypeSig,SpecInfo)]
-              -> Baby_TcM [SpecInfo]
-
-tcSpecDataSigs tce (s:ss) accum
-  = tc_sig s                   `thenB_Tc` \ info  ->
-    tcSpecDataSigs tce ss ((s,info):accum)
+tcRecordSelectors is_rec unf_env tycon data_cons
+       -- Omit the check that the fields have consistent types if 
+       -- the group is recursive; TcTyClsDecls.tcGroup will repeat 
+       -- with NonRecursive once we have tied the knot
+  | isRec is_rec = returnTc sel_ids
+  | otherwise   = mapTc check groups   `thenTc_` 
+                  returnTc sel_ids
   where
-    tc_sig (SpecDataSig n ty src_loc)
-      = addSrcLocB_Tc src_loc (
-       let 
-           ty_names  = extractMonoTyNames (==) ty
-           (tve,_,_) = mkTVE ty_names
-           fake_CE   = panic "tcSpecDataSigs:CE"
-       in
-           -- Typecheck specialising type (includes arity check)
-       tcMonoType fake_CE tce tve ty                   `thenB_Tc` \ tau_ty ->
-       let
-           (_,ty_args,_) = getUniDataTyCon tau_ty
-           is_unboxed_or_tyvar ty = isUnboxedDataType ty || isTyVarTemplateTy ty
-       in
-           -- Check at least one unboxed type in specialisation
-       checkB_Tc (not (any isUnboxedDataType ty_args))
-                 (specDataNoSpecErr n ty_args src_loc) `thenB_Tc_`
-
-           -- Check all types are unboxed or tyvars
-           -- (specific boxed types are redundant)
-       checkB_Tc (not (all is_unboxed_or_tyvar ty_args))
-                 (specDataUnboxedErr n ty_args src_loc) `thenB_Tc_`
+    fields = [ field | con   <- data_cons
+                    , field <- dataConFieldLabels con ]
+
+       -- groups is list of fields that share a common name
+    groups                = equivClasses cmp_name fields
+    cmp_name field1 field2 = fieldLabelName field1 `compare` fieldLabelName field2
+
+    sel_ids = [ mkRecordSelId tycon field unpack_id unpackUtf8_id
+             | (field : _) <- groups ]
+
+    check fields@(first_field_label : other_fields)
+       -- These fields all have the same name, but are from
+       -- different constructors in the data type
+       =       -- Check that all the fields in the group have the same type
+               -- NB: this check assumes that all the constructors of a given
+               -- data type use the same type variables
+         checkTc (all (== field_ty) other_tys) (fieldTypeMisMatch field_name)
+       where
+           field_ty   = fieldLabelType first_field_label
+           field_name = fieldLabelName first_field_label
+           other_tys  = map fieldLabelType other_fields
+
+    unpack_id     = tcLookupRecId unf_env unpackCStringName
+    unpackUtf8_id = tcLookupRecId unf_env unpackCStringUtf8Name
+\end{code}
 
-       let
-           maybe_tys     = specialiseConstrTys ty_args
-       in
-       returnB_Tc (SpecInfo maybe_tys 0 (panic "SpecData:SpecInfo:SpecId"))
-       )
-
-tcSpecDataSigs tce [] accum
-  = -- Remove any duplicates from accumulated specinfos
-    getSwitchCheckerB_Tc               `thenB_Tc` \ sw_chkr ->
-    
-    (if sw_chkr SpecialiseTrace && not (null duplicates) then
-        pprTrace "Duplicate SPECIALIZE data pragmas:\n"
-                 (ppAboves (map specmsg sep_dups))
-     else id)(
-
-    (if sw_chkr SpecialiseTrace && not (null spec_infos) then
-        pprTrace "Specialising "
-                 (ppHang (ppCat [ppr PprDebug name, ppStr "at types:"])
-                       4 (ppAboves (map pp_spec spec_infos)))
-
-    else id) (
-
-    returnB_Tc (spec_infos)
-    ))
-  where
-    spec_infos = map (snd . head) equiv
 
-    equiv      = equivClasses cmp_info accum
-    duplicates = filter (not . singleton) equiv
 
-    cmp_info (_, SpecInfo tys1 _ _) (_, SpecInfo tys2 _ _)
-      = cmpUniTypeMaybeList tys1 tys2
+%************************************************************************
+%*                                                                     *
+\subsection{Errors and contexts}
+%*                                                                     *
+%************************************************************************
 
-    singleton [_] = True
-    singleton _   = False
 
-    sep_dups = tail (concat (map ((:) Nothing . map Just) duplicates))
-    specmsg (Just (SpecDataSig _ ty locn, _))
-      = addShortErrLocLine locn ( \ sty -> ppr sty ty ) PprDebug
-    specmsg Nothing
-      = ppStr "***"
+\begin{code}
+fieldTypeMisMatch field_name
+  = sep [ptext SLIT("Different constructors give different types for field"), quotes (ppr field_name)]
 
-    ((SpecDataSig name _ _, _):_) = accum    
-    pp_spec (SpecInfo tys _ _) = ppInterleave ppNil [pprMaybeTy PprDebug ty | ty <- tys]
+exRecConErr name
+  = ptext SLIT("Can't combine named fields with locally-quantified type variables")
+    $$
+    (ptext SLIT("In the declaration of data constructor") <+> ppr name)
 \end{code}