ghc/compiler/typecheck/TcTyDecls.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1996-1998
   3 %
   4 \section[TcTyDecls]{Typecheck type declarations}
   5
   6 \begin{code}
   7 module TcTyDecls (
   8         tcTyDecl, kcTyDecl,
   9         tcConDecl,
  10         mkImplicitDataBinds
  11     ) where
  12
  13 #include "HsVersions.h"
  14
  15 import HsSyn            ( MonoBinds(..),
  16                           TyClDecl(..), ConDecl(..), ConDetails(..), BangType(..),
  17                           andMonoBindList
  18                         )
  19 import RnHsSyn          ( RenamedTyClDecl, RenamedConDecl )
  20 import TcHsSyn          ( TcMonoBinds, idsToMonoBinds )
  21 import BasicTypes       ( RecFlag(..), NewOrData(..) )
  22
  23 import TcMonoType       ( tcExtendTopTyVarScope, tcExtendTyVarScope,
  24                           tcHsTypeKind, tcHsType, tcHsTopType, tcHsTopBoxedType,
  25                           tcContext, tcHsTopTypeKind
  26                         )
  27 import TcType           ( zonkTcTyVarToTyVar, zonkTcClassConstraints )
  28 import TcEnv            ( tcLookupTy, TcTyThing(..) )
  29 import TcMonad
  30 import TcUnify          ( unifyKind )
  31
  32 import Class            ( Class )
  33 import DataCon          ( DataCon, dataConSig, mkDataCon, isNullaryDataCon,
  34                           dataConFieldLabels, dataConId, dataConWrapId,
  35                           markedStrict, notMarkedStrict, markedUnboxed
  36                         )
  37 import MkId             ( mkDataConId, mkDataConWrapId, mkRecordSelId )
  38 import Id               ( idUnfolding )
  39 import CoreUnfold       ( unfoldingTemplate )
  40 import FieldLabel
  41 import Var              ( Id, TyVar )
  42 import Name             ( Name, isLocallyDefined, OccName, NamedThing(..), nameUnique )
  43 import Outputable
  44 import TyCon            ( TyCon, ArgVrcs, mkSynTyCon, mkAlgTyCon, isAlgTyCon,
  45                           isSynTyCon, tyConDataCons, isNewTyCon
  46                         )
  47 import Type             ( getTyVar, tyVarsOfTypes,
  48                           mkTyConApp, mkTyVarTys, mkForAllTys, mkFunTy,
  49                           mkTyVarTy,
  50                           mkArrowKind, mkArrowKinds, boxedTypeKind,
  51                           isUnboxedType, Type, ThetaType, classesOfPreds
  52                         )
  53 import Var              ( tyVarKind )
  54 import VarSet           ( intersectVarSet, isEmptyVarSet )
  55 import Util             ( equivClasses )
  56 import FiniteMap        ( FiniteMap, lookupWithDefaultFM )
  57 \end{code}
  58
  59 %************************************************************************
  60 %*                                                                      *
  61 \subsection{Kind checking}
  62 %*                                                                      *
  63 %************************************************************************
  64
  65 \begin{code}
  66 kcTyDecl :: RenamedTyClDecl -> TcM s ()
  67
  68 kcTyDecl (TySynonym name tyvar_names rhs src_loc)
  69   = tcLookupTy name                             `thenNF_Tc` \ (kind, _, _) ->
  70     tcExtendTopTyVarScope kind tyvar_names      $ \ _ result_kind ->
  71     tcHsTypeKind rhs                            `thenTc` \ (rhs_kind, _) ->
  72     unifyKind result_kind rhs_kind
  73
  74 kcTyDecl (TyData _ context tycon_name tyvar_names con_decls _ _ src_loc)
  75   = tcLookupTy tycon_name                       `thenNF_Tc` \ (kind, _, _) ->
  76     tcExtendTopTyVarScope kind tyvar_names      $ \ result_kind _ ->
  77     tcContext context                           `thenTc_`
  78     mapTc kcConDecl con_decls                   `thenTc_`
  79     returnTc ()
  80
  81 kcConDecl (ConDecl _ _ ex_tvs ex_ctxt details loc)
  82   = tcAddSrcLoc loc                     (
  83     tcExtendTyVarScope ex_tvs           ( \ tyvars ->
  84     tcContext ex_ctxt                   `thenTc_`
  85     kc_con details                      `thenTc_`
  86     returnTc ()
  87     ))
  88   where
  89     kc_con (VanillaCon btys)    = mapTc kc_bty btys             `thenTc_` returnTc ()
  90     kc_con (InfixCon bty1 bty2) = mapTc kc_bty [bty1,bty2]      `thenTc_` returnTc ()
  91     kc_con (NewCon ty _)        = tcHsType ty                   `thenTc_` returnTc ()
  92     kc_con (RecCon flds)        = mapTc kc_field flds           `thenTc_` returnTc ()
  93
  94     kc_bty (Banged ty)   = tcHsType ty
  95     kc_bty (Unbanged ty) = tcHsType ty
  96     kc_bty (Unpacked ty) = tcHsType ty
  97
  98     kc_field (_, bty)    = kc_bty bty
  99 \end{code}
 100
 101
 102 %************************************************************************
 103 %*                                                                      *
 104 \subsection{Type checking}
 105 %*                                                                      *
 106 %************************************************************************
 107
 108 \begin{code}
 109 tcTyDecl :: RecFlag -> FiniteMap Name ArgVrcs -> RenamedTyClDecl -> TcM s TyCon
 110
 111 tcTyDecl is_rec rec_vrcs (TySynonym tycon_name tyvar_names rhs src_loc)
 112   = tcLookupTy tycon_name                               `thenNF_Tc` \ (tycon_kind, Just arity, _) ->
 113     tcExtendTopTyVarScope tycon_kind tyvar_names        $ \ tyvars _ ->
 114     tcHsTopTypeKind rhs                                 `thenTc` \ (_, rhs_ty) ->
 115     let
 116         -- Construct the tycon
 117         argvrcs = lookupWithDefaultFM rec_vrcs (pprPanic "tcTyDecl: argvrcs:" $ ppr tycon_name)
 118                                       tycon_name
 119         tycon = mkSynTyCon tycon_name tycon_kind arity tyvars rhs_ty argvrcs
 120     in
 121     returnTc tycon
 122
 123
 124 tcTyDecl is_rec rec_vrcs (TyData data_or_new context tycon_name tyvar_names con_decls derivings pragmas src_loc)
 125   =     -- Lookup the pieces
 126     tcLookupTy tycon_name                               `thenNF_Tc` \ (tycon_kind, _, ATyCon rec_tycon) ->
 127     tcExtendTopTyVarScope tycon_kind tyvar_names        $ \ tyvars _ ->
 128
 129         -- Typecheck the pieces
 130     tcContext context                                   `thenTc` \ ctxt ->
 131     let ctxt' = classesOfPreds ctxt in
 132     mapTc (tcConDecl rec_tycon tyvars ctxt') con_decls  `thenTc` \ data_cons ->
 133     tc_derivs derivings                                 `thenTc` \ derived_classes ->
 134
 135     let
 136         -- Construct the tycon
 137         real_data_or_new = case data_or_new of
 138                                 NewType -> NewType
 139                                 DataType | all isNullaryDataCon data_cons -> EnumType
 140                                          | otherwise                      -> DataType
 141
 142         argvrcs = lookupWithDefaultFM rec_vrcs (pprPanic "tcTyDecl: argvrcs:" $ ppr tycon_name)
 143                                       tycon_name
 144
 145         tycon = mkAlgTyCon tycon_name tycon_kind tyvars ctxt' argvrcs
 146                            data_cons
 147                            derived_classes
 148                            Nothing              -- Not a dictionary
 149                            real_data_or_new is_rec
 150     in
 151     returnTc tycon
 152   where
 153         tc_derivs Nothing   = returnTc []
 154         tc_derivs (Just ds) = mapTc tc_deriv ds
 155
 156         tc_deriv name = tcLookupTy name `thenTc` \ (_, _, AClass clas) ->
 157                         returnTc clas
 158 \end{code}
 159
 160
 161 %************************************************************************
 162 %*                                                                      *
 163 \subsection{Type check constructors}
 164 %*                                                                      *
 165 %************************************************************************
 166
 167 \begin{code}
 168 tcConDecl :: TyCon -> [TyVar] -> [(Class,[Type])] -> RenamedConDecl -> TcM s DataCon
 169
 170 tcConDecl tycon tyvars ctxt (ConDecl name wkr_name ex_tvs ex_ctxt details src_loc)
 171   = tcAddSrcLoc src_loc                 $
 172     tcExtendTyVarScope ex_tvs           $ \ ex_tyvars ->
 173     tcContext ex_ctxt                   `thenTc` \ ex_theta ->
 174     let
 175         ex_ctxt' = classesOfPreds ex_theta
 176     in
 177     tc_con_decl_help tycon tyvars ctxt name wkr_name ex_tyvars ex_ctxt' details
 178
 179 tc_con_decl_help tycon tyvars ctxt name wkr_name ex_tyvars ex_theta details
 180   = case details of
 181         VanillaCon btys    -> tc_datacon btys
 182         InfixCon bty1 bty2 -> tc_datacon [bty1,bty2]
 183         NewCon ty mb_f     -> tc_newcon ty mb_f
 184         RecCon fields      -> tc_rec_con fields
 185   where
 186     tc_datacon btys
 187       = let
 188             arg_stricts = map get_strictness btys
 189             tys         = map get_pty btys
 190         in
 191         mapTc tcHsTopType tys `thenTc` \ arg_tys ->
 192         mk_data_con arg_stricts arg_tys []
 193
 194     tc_newcon ty mb_f
 195       = tcHsTopBoxedType ty     `thenTc` \ arg_ty ->
 196             -- can't allow an unboxed type here, because we're effectively
 197             -- going to remove the constructor while coercing it to a boxed type.
 198         let
 199           field_label =
 200             case mb_f of
 201               Nothing -> []
 202               Just f  -> [mkFieldLabel (getName f) arg_ty (head allFieldLabelTags)]
 203         in
 204         mk_data_con [notMarkedStrict] [arg_ty] field_label
 205
 206     tc_rec_con fields
 207       = checkTc (null ex_tyvars) (exRecConErr name)         `thenTc_`
 208         mapTc tc_field fields   `thenTc` \ field_label_infos_s ->
 209         let
 210             field_label_infos = concat field_label_infos_s
 211             arg_stricts       = [strict | (_, _, strict) <- field_label_infos]
 212             arg_tys           = [ty     | (_, ty, _)     <- field_label_infos]
 213
 214             field_labels      = [ mkFieldLabel (getName name) ty tag
 215                               | ((name, ty, _), tag) <- field_label_infos `zip` allFieldLabelTags ]
 216         in
 217         mk_data_con arg_stricts arg_tys field_labels
 218
 219     tc_field (field_label_names, bty)
 220       = tcHsTopType (get_pty bty)       `thenTc` \ field_ty ->
 221         returnTc [(name, field_ty, get_strictness bty) | name <- field_label_names]
 222
 223     mk_data_con arg_stricts arg_tys fields
 224       =         -- Now we've checked all the field types we must
 225                 -- zonk the existential tyvars to finish the kind
 226                 -- inference on their kinds, and commit them to being
 227                 -- immutable type variables.  (The top-level tyvars are
 228                 -- already fixed, by the preceding kind-inference pass.)
 229         mapNF_Tc zonkTcTyVarToTyVar ex_tyvars   `thenNF_Tc` \ ex_tyvars' ->
 230         zonkTcClassConstraints  ex_theta        `thenNF_Tc` \ ex_theta' ->
 231         let
 232            data_con = mkDataCon name arg_stricts fields
 233                            tyvars (thinContext arg_tys ctxt)
 234                            ex_tyvars' ex_theta'
 235                            arg_tys
 236                            tycon data_con_id data_con_wrap_id
 237            data_con_id      = mkDataConId wkr_name data_con
 238            data_con_wrap_id = mkDataConWrapId data_con
 239         in
 240         returnNF_Tc data_con
 241
 242 -- The context for a data constructor should be limited to
 243 -- the type variables mentioned in the arg_tys
 244 thinContext arg_tys ctxt
 245   = filter in_arg_tys ctxt
 246   where
 247       arg_tyvars = tyVarsOfTypes arg_tys
 248       in_arg_tys (clas,tys) = not $ isEmptyVarSet $
 249                               tyVarsOfTypes tys `intersectVarSet` arg_tyvars
 250
 251 get_strictness (Banged   _) = markedStrict
 252 get_strictness (Unbanged _) = notMarkedStrict
 253 get_strictness (Unpacked _) = markedUnboxed
 254
 255 get_pty (Banged ty)   = ty
 256 get_pty (Unbanged ty) = ty
 257 get_pty (Unpacked ty) = ty
 258 \end{code}
 259
 260
 261
 262 %************************************************************************
 263 %*                                                                      *
 264 \subsection{Generating constructor/selector bindings for data declarations}
 265 %*                                                                      *
 266 %************************************************************************
 267
 268 \begin{code}
 269 mkImplicitDataBinds :: [TyCon] -> TcM s ([Id], TcMonoBinds)
 270 mkImplicitDataBinds [] = returnTc ([], EmptyMonoBinds)
 271 mkImplicitDataBinds (tycon : tycons)
 272   | isSynTyCon tycon = mkImplicitDataBinds tycons
 273   | otherwise        = mkImplicitDataBinds_one tycon    `thenTc` \ (ids1, b1) ->
 274                        mkImplicitDataBinds tycons       `thenTc` \ (ids2, b2) ->
 275                        returnTc (ids1++ids2, b1 `AndMonoBinds` b2)
 276
 277 mkImplicitDataBinds_one tycon
 278   = mapTc (mkRecordSelector tycon) groups       `thenTc` \ sel_ids ->
 279     let
 280         unf_ids = sel_ids ++ data_con_wrapper_ids
 281         all_ids = map dataConId data_cons ++ unf_ids
 282
 283         -- For the locally-defined things
 284         -- we need to turn the unfoldings inside the selector Ids into bindings,
 285         -- and build bindigns for the constructor wrappers
 286         binds | isLocallyDefined tycon = idsToMonoBinds unf_ids
 287               | otherwise              = EmptyMonoBinds
 288     in
 289     returnTc (all_ids, binds)
 290   where
 291     data_cons = tyConDataCons tycon
 292
 293     data_con_wrapper_ids = map dataConWrapId data_cons
 294
 295     fields = [ (con, field) | con   <- data_cons,
 296                               field <- dataConFieldLabels con
 297              ]
 298
 299         -- groups is list of fields that share a common name
 300     groups = equivClasses cmp_name fields
 301     cmp_name (_, field1) (_, field2)
 302         = fieldLabelName field1 `compare` fieldLabelName field2
 303 \end{code}
 304
 305 \begin{code}
 306 mkRecordSelector tycon fields@((first_con, first_field_label) : other_fields)
 307                 -- These fields all have the same name, but are from
 308                 -- different constructors in the data type
 309         -- Check that all the fields in the group have the same type
 310         -- This check assumes that all the constructors of a given
 311         -- data type use the same type variables
 312   = checkTc (all (== field_ty) other_tys)
 313             (fieldTypeMisMatch field_name)      `thenTc_`
 314     returnTc (mkRecordSelId tycon first_field_label)
 315   where
 316     field_ty   = fieldLabelType first_field_label
 317     field_name = fieldLabelName first_field_label
 318     other_tys  = [fieldLabelType fl | (_, fl) <- other_fields]
 319 \end{code}
 320
 321
 322 Errors and contexts
 323 ~~~~~~~~~~~~~~~~~~~
 324 \begin{code}
 325 fieldTypeMisMatch field_name
 326   = sep [ptext SLIT("Declared types differ for field"), quotes (ppr field_name)]
 327
 328 exRecConErr name
 329   = ptext SLIT("Can't combine named fields with locally-quantified type variables")
 330     $$
 331     (ptext SLIT("In the declaration of data constructor") <+> ppr name)
 332 \end{code}