ghc/compiler/typecheck/TcTyClsDecls.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1996-1998
   3 %
   4 \section[TcTyClsDecls]{Typecheck type and class declarations}
   5
   6 \begin{code}
   7 module TcTyClsDecls (
   8         tcTyAndClassDecls
   9     ) where
  10
  11 #include "HsVersions.h"
  12
  13 import HsSyn            ( TyClDecl(..),  HsConDetails(..), HsTyVarBndr(..),
  14                           ConDecl(..),   Sig(..), , NewOrData(..),
  15                           tyClDeclTyVars, isSynDecl, LConDecl,
  16                           LTyClDecl, tcdName, LHsTyVarBndr, LHsContext
  17                         )
  18 import HsTypes          ( HsBang(..), getBangStrictness )
  19 import BasicTypes       ( RecFlag(..), StrictnessMark(..) )
  20 import HscTypes         ( implicitTyThings )
  21 import BuildTyCl        ( buildClass, buildAlgTyCon, buildSynTyCon, buildDataCon,
  22                           mkDataTyConRhs, mkNewTyConRhs )
  23 import TcRnMonad
  24 import TcEnv            ( TcTyThing(..), TyThing(..),
  25                           tcLookupLocated, tcLookupLocatedGlobal,
  26                           tcExtendGlobalEnv, tcExtendKindEnv,
  27                           tcExtendRecEnv, tcLookupTyVar )
  28 import TcTyDecls        ( calcTyConArgVrcs, calcRecFlags, calcClassCycles, calcSynCycles )
  29 import TcClassDcl       ( tcClassSigs, tcAddDeclCtxt )
  30 import TcHsType         ( kcHsTyVars, kcHsLiftedSigType, kcHsType,
  31                           kcHsContext, tcTyVarBndrs, tcHsKindedType, tcHsKindedContext,
  32                           kcHsSigType, tcHsBangType, tcLHsConSig )
  33 import TcMType          ( newKindVar, checkValidTheta, checkValidType, checkFreeness,
  34                           UserTypeCtxt(..), SourceTyCtxt(..) )
  35 import TcUnify          ( unifyKind )
  36 import TcType           ( TcKind, ThetaType, TcType, tyVarsOfType,
  37                           mkArrowKind, liftedTypeKind, mkTyVarTys, tcEqTypes,
  38                           tcSplitSigmaTy, tcEqType )
  39 import Type             ( splitTyConApp_maybe, pprThetaArrow, pprParendType )
  40 import Generics         ( validGenericMethodType, canDoGenerics )
  41 import Class            ( Class, className, classTyCon, DefMeth(..), classBigSig, classTyVars )
  42 import TyCon            ( TyCon, ArgVrcs,
  43                           tyConDataCons, mkForeignTyCon, isProductTyCon, isRecursiveTyCon,
  44                           tyConStupidTheta, getSynTyConDefn, tyConDataCons, isSynTyCon, tyConName )
  45 import DataCon          ( DataCon, dataConWrapId, dataConName, dataConSig,
  46                           dataConFieldLabels, dataConOrigArgTys, dataConTyCon )
  47 import Type             ( zipTopTvSubst, substTys )
  48 import Var              ( TyVar, idType, idName )
  49 import VarSet           ( elemVarSet )
  50 import Name             ( Name )
  51 import Outputable
  52 import Util             ( zipLazy, isSingleton, notNull )
  53 import List             ( partition )
  54 import SrcLoc           ( Located(..), unLoc, getLoc )
  55 import ListSetOps       ( equivClasses )
  56 import Digraph          ( SCC(..) )
  57 import CmdLineOpts      ( DynFlag( Opt_GlasgowExts, Opt_Generics, Opt_UnboxStrictFields ) )
  58 \end{code}
  59
  60
  61 %************************************************************************
  62 %*                                                                      *
  63 \subsection{Type checking for type and class declarations}
  64 %*                                                                      *
  65 %************************************************************************
  66
  67 Dealing with a group
  68 ~~~~~~~~~~~~~~~~~~~~
  69 Consider a mutually-recursive group, binding
  70 a type constructor T and a class C.
  71
  72 Step 1:         getInitialKind
  73         Construct a KindEnv by binding T and C to a kind variable
  74
  75 Step 2:         kcTyClDecl
  76         In that environment, do a kind check
  77
  78 Step 3: Zonk the kinds
  79
  80 Step 4:         buildTyConOrClass
  81         Construct an environment binding T to a TyCon and C to a Class.
  82         a) Their kinds comes from zonking the relevant kind variable
  83         b) Their arity (for synonyms) comes direct from the decl
  84         c) The funcional dependencies come from the decl
  85         d) The rest comes a knot-tied binding of T and C, returned from Step 4
  86         e) The variances of the tycons in the group is calculated from
  87                 the knot-tied stuff
  88
  89 Step 5:         tcTyClDecl1
  90         In this environment, walk over the decls, constructing the TyCons and Classes.
  91         This uses in a strict way items (a)-(c) above, which is why they must
  92         be constructed in Step 4. Feed the results back to Step 4.
  93         For this step, pass the is-recursive flag as the wimp-out flag
  94         to tcTyClDecl1.
  95
  96
  97 Step 6:         Extend environment
  98         We extend the type environment with bindings not only for the TyCons and Classes,
  99         but also for their "implicit Ids" like data constructors and class selectors
 100
 101 Step 7:         checkValidTyCl
 102         For a recursive group only, check all the decls again, just
 103         to check all the side conditions on validity.  We could not
 104         do this before because we were in a mutually recursive knot.
 105
 106
 107 The knot-tying parameters: @rec_details_list@ is an alist mapping @Name@s to
 108 @TyThing@s.  @rec_vrcs@ is a finite map from @Name@s to @ArgVrcs@s.
 109
 110 \begin{code}
 111 tcTyAndClassDecls :: [Name] -> [LTyClDecl Name]
 112                    -> TcM TcGblEnv      -- Input env extended by types and classes
 113                                         -- and their implicit Ids,DataCons
 114 tcTyAndClassDecls boot_names decls
 115   = do  {       -- First check for cyclic type synonysm or classes
 116                 -- See notes with checkCycleErrs
 117           checkCycleErrs decls
 118
 119         ; (syn_tycons, alg_tyclss) <- fixM (\ ~(rec_syn_tycons, rec_alg_tyclss) ->
 120           do    { let { -- Calculate variances and rec-flag
 121                       ; (syn_decls, alg_decls) = partition (isSynDecl . unLoc) decls }
 122
 123                         -- Extend the global env with the knot-tied results
 124                         -- for data types and classes
 125                         --
 126                         -- We must populate the environment with the loop-tied T's right
 127                         -- away, because the kind checker may "fault in" some type
 128                         -- constructors that recursively mention T
 129                 ; let { gbl_things = mkGlobalThings alg_decls rec_alg_tyclss }
 130                 ; tcExtendRecEnv gbl_things $ do
 131
 132                         -- Kind-check the declarations
 133                 { (kc_syn_decls, kc_alg_decls) <- kcTyClDecls syn_decls alg_decls
 134
 135                 ; let { calc_vrcs = calcTyConArgVrcs (rec_syn_tycons ++ rec_alg_tyclss)
 136                       ; calc_rec  = calcRecFlags boot_names rec_alg_tyclss
 137                       ; tc_decl   = addLocM (tcTyClDecl calc_vrcs calc_rec) }
 138                         -- Type-check the type synonyms, and extend the envt
 139                 ; syn_tycons <- tcSynDecls calc_vrcs kc_syn_decls
 140                 ; tcExtendGlobalEnv syn_tycons $ do
 141
 142                         -- Type-check the data types and classes
 143                 { alg_tyclss <- mappM tc_decl kc_alg_decls
 144                 ; return (syn_tycons, alg_tyclss)
 145             }}})
 146         -- Finished with knot-tying now
 147         -- Extend the environment with the finished things
 148         ; tcExtendGlobalEnv (syn_tycons ++ alg_tyclss) $ do
 149
 150         -- Perform the validity check
 151         { traceTc (text "ready for validity check")
 152         ; mappM_ (addLocM checkValidTyCl) decls
 153         ; traceTc (text "done")
 154
 155         -- Add the implicit things;
 156         -- we want them in the environment because
 157         -- they may be mentioned in interface files
 158         ; let { implicit_things = concatMap implicitTyThings alg_tyclss }
 159         ; traceTc ((text "Adding" <+> ppr alg_tyclss) $$ (text "and" <+> ppr implicit_things))
 160         ; tcExtendGlobalEnv implicit_things getGblEnv
 161     }}
 162
 163 mkGlobalThings :: [LTyClDecl Name]      -- The decls
 164                -> [TyThing]             -- Knot-tied, in 1-1 correspondence with the decls
 165                -> [(Name,TyThing)]
 166 -- Driven by the Decls, and treating the TyThings lazily
 167 -- make a TypeEnv for the new things
 168 mkGlobalThings decls things
 169   = map mk_thing (decls `zipLazy` things)
 170   where
 171     mk_thing (L _ (ClassDecl {tcdLName = L _ name}), ~(AClass cl))
 172          = (name, AClass cl)
 173     mk_thing (L _ decl, ~(ATyCon tc))
 174          = (tcdName decl, ATyCon tc)
 175 \end{code}
 176
 177
 178 %************************************************************************
 179 %*                                                                      *
 180                 Kind checking
 181 %*                                                                      *
 182 %************************************************************************
 183
 184 We need to kind check all types in the mutually recursive group
 185 before we know the kind of the type variables.  For example:
 186
 187 class C a where
 188    op :: D b => a -> b -> b
 189
 190 class D c where
 191    bop :: (Monad c) => ...
 192
 193 Here, the kind of the locally-polymorphic type variable "b"
 194 depends on *all the uses of class D*.  For example, the use of
 195 Monad c in bop's type signature means that D must have kind Type->Type.
 196
 197 However type synonyms work differently.  They can have kinds which don't
 198 just involve (->) and *:
 199         type R = Int#           -- Kind #
 200         type S a = Array# a     -- Kind * -> #
 201         type T a b = (# a,b #)  -- Kind * -> * -> (# a,b #)
 202 So we must infer their kinds from their right-hand sides *first* and then
 203 use them, whereas for the mutually recursive data types D we bring into
 204 scope kind bindings D -> k, where k is a kind variable, and do inference.
 205
 206 \begin{code}
 207 kcTyClDecls syn_decls alg_decls
 208   = do  {       -- First extend the kind env with each data
 209                 -- type and class, mapping them to a type variable
 210           alg_kinds <- mappM getInitialKind alg_decls
 211         ; tcExtendKindEnv alg_kinds $ do
 212
 213                 -- Now kind-check the type synonyms, in dependency order
 214                 -- We do these differently to data type and classes,
 215                 -- because a type synonym can be an unboxed type
 216                 --      type Foo = Int#
 217                 -- and a kind variable can't unify with UnboxedTypeKind
 218                 -- So we infer their kinds in dependency order
 219         { (kc_syn_decls, syn_kinds) <- kcSynDecls (calcSynCycles syn_decls)
 220         ; tcExtendKindEnv syn_kinds $  do
 221
 222                 -- Now kind-check the data type and class declarations,
 223                 -- returning kind-annotated decls
 224         { kc_alg_decls <- mappM (wrapLocM kcTyClDecl) alg_decls
 225
 226         ; return (kc_syn_decls, kc_alg_decls) }}}
 227
 228 ------------------------------------------------------------------------
 229 getInitialKind :: LTyClDecl Name -> TcM (Name, TcKind)
 230
 231 getInitialKind decl
 232  = newKindVar                   `thenM` \ kind  ->
 233    returnM (unLoc (tcdLName (unLoc decl)), kind)
 234
 235 ----------------
 236 kcSynDecls :: [SCC (LTyClDecl Name)]
 237            -> TcM ([LTyClDecl Name],    -- Kind-annotated decls
 238                    [(Name,TcKind)])     -- Kind bindings
 239 kcSynDecls []
 240   = return ([], [])
 241 kcSynDecls (group : groups)
 242   = do  { (decl,  nk)  <- kcSynDecl group
 243         ; (decls, nks) <- tcExtendKindEnv [nk] (kcSynDecls groups)
 244         ; return (decl:decls, nk:nks) }
 245
 246 ----------------
 247 kcSynDecl :: SCC (LTyClDecl Name)
 248            -> TcM (LTyClDecl Name,      -- Kind-annotated decls
 249                    (Name,TcKind))       -- Kind bindings
 250 kcSynDecl (AcyclicSCC ldecl@(L loc decl))
 251   = tcAddDeclCtxt decl  $
 252     kcHsTyVars (tcdTyVars decl) (\ k_tvs ->
 253     do { traceTc (text "kcd1" <+> ppr (unLoc (tcdLName decl)) <+> brackets (ppr (tcdTyVars decl))
 254                         <+> brackets (ppr k_tvs))
 255        ; (k_rhs, rhs_kind) <- kcHsType (tcdSynRhs decl)
 256        ; traceTc (text "kcd2" <+> ppr (unLoc (tcdLName decl)))
 257        ; let tc_kind = foldr (mkArrowKind . kindedTyVarKind) rhs_kind k_tvs
 258        ; return (L loc (decl { tcdTyVars = k_tvs, tcdSynRhs = k_rhs }),
 259                  (unLoc (tcdLName decl), tc_kind)) })
 260
 261 kcSynDecl (CyclicSCC decls)
 262   = do { recSynErr decls; failM }       -- Fail here to avoid error cascade
 263                                         -- of out-of-scope tycons
 264
 265 ------------------------------------------------------------------------
 266 kcTyClDecl :: TyClDecl Name -> TcM (TyClDecl Name)
 267         -- Not used for type synonyms (see kcSynDecl)
 268
 269 kcTyClDecl decl@(TyData {tcdND = new_or_data, tcdCtxt = ctxt, tcdCons = cons})
 270   = kcTyClDeclBody decl $ \ tvs' ->
 271     do  { ctxt' <- kcHsContext ctxt
 272         ; cons' <- mappM (wrapLocM kc_con_decl) cons
 273         ; return (decl {tcdTyVars = tvs', tcdCtxt = ctxt', tcdCons = cons'}) }
 274   where
 275     kc_con_decl (ConDecl name ex_tvs ex_ctxt details)
 276       = kcHsTyVars ex_tvs               $ \ ex_tvs' ->
 277         do { ex_ctxt' <- kcHsContext ex_ctxt
 278            ; details' <- kc_con_details details
 279            ; return (ConDecl name ex_tvs' ex_ctxt' details')}
 280     kc_con_decl (GadtDecl name ty)
 281         = do { ty' <- kcHsSigType ty
 282              ; return (GadtDecl name ty') }
 283
 284     kc_con_details (PrefixCon btys)
 285         = do { btys' <- mappM kc_larg_ty btys ; return (PrefixCon btys') }
 286     kc_con_details (InfixCon bty1 bty2)
 287         = do { bty1' <- kc_larg_ty bty1; bty2' <- kc_larg_ty bty2; return (InfixCon bty1' bty2') }
 288     kc_con_details (RecCon fields)
 289         = do { fields' <- mappM kc_field fields; return (RecCon fields') }
 290
 291     kc_field (fld, bty) = do { bty' <- kc_larg_ty bty ; return (fld, bty') }
 292
 293     kc_larg_ty bty = case new_or_data of
 294                         DataType -> kcHsSigType bty
 295                         NewType  -> kcHsLiftedSigType bty
 296         -- Can't allow an unlifted type for newtypes, because we're effectively
 297         -- going to remove the constructor while coercing it to a lifted type.
 298         -- And newtypes can't be bang'd
 299
 300 kcTyClDecl decl@(ClassDecl {tcdCtxt = ctxt,  tcdSigs = sigs})
 301   = kcTyClDeclBody decl $ \ tvs' ->
 302     do  { ctxt' <- kcHsContext ctxt
 303         ; sigs' <- mappM (wrapLocM kc_sig) sigs
 304         ; return (decl {tcdTyVars = tvs', tcdCtxt = ctxt', tcdSigs = sigs'}) }
 305   where
 306     kc_sig (Sig nm op_ty) = do { op_ty' <- kcHsLiftedSigType op_ty
 307                                 ; return (Sig nm op_ty') }
 308     kc_sig other_sig          = return other_sig
 309
 310 kcTyClDecl decl@(ForeignType {})
 311   = return decl
 312
 313 kcTyClDeclBody :: TyClDecl Name
 314                -> ([LHsTyVarBndr Name] -> TcM a)
 315                -> TcM a
 316   -- Extend the env with bindings for the tyvars, taken from
 317   -- the kind of the tycon/class.  Give it to the thing inside, and
 318   -- check the result kind matches
 319 kcTyClDeclBody decl thing_inside
 320   = tcAddDeclCtxt decl          $
 321     kcHsTyVars (tyClDeclTyVars decl)    $ \ kinded_tvs ->
 322     do  { tc_ty_thing <- tcLookupLocated (tcdLName decl)
 323         ; let tc_kind = case tc_ty_thing of { AThing k -> k }
 324         ; unifyKind tc_kind (foldr (mkArrowKind . kindedTyVarKind)
 325                                    liftedTypeKind kinded_tvs)
 326         ; thing_inside kinded_tvs }
 327
 328 kindedTyVarKind (L _ (KindedTyVar _ k)) = k
 329 \end{code}
 330
 331
 332 %************************************************************************
 333 %*                                                                      *
 334 \subsection{Type checking}
 335 %*                                                                      *
 336 %************************************************************************
 337
 338 \begin{code}
 339 tcSynDecls :: (Name -> ArgVrcs) -> [LTyClDecl Name] -> TcM [TyThing]
 340 tcSynDecls calc_vrcs [] = return []
 341 tcSynDecls calc_vrcs (decl : decls)
 342   = do { syn_tc <- addLocM (tcSynDecl calc_vrcs) decl
 343        ; syn_tcs <- tcExtendGlobalEnv [syn_tc] (tcSynDecls calc_vrcs decls)
 344        ; return (syn_tc : syn_tcs) }
 345
 346 tcSynDecl calc_vrcs
 347   (TySynonym {tcdLName = L _ tc_name, tcdTyVars = tvs, tcdSynRhs = rhs_ty})
 348   = tcTyVarBndrs tvs            $ \ tvs' -> do
 349     { traceTc (text "tcd1" <+> ppr tc_name)
 350     ; rhs_ty' <- tcHsKindedType rhs_ty
 351     ; return (ATyCon (buildSynTyCon tc_name tvs' rhs_ty' (calc_vrcs tc_name))) }
 352
 353 --------------------
 354 tcTyClDecl :: (Name -> ArgVrcs) -> (Name -> RecFlag)
 355            -> TyClDecl Name -> TcM TyThing
 356
 357 tcTyClDecl calc_vrcs calc_isrec decl
 358   = tcAddDeclCtxt decl (tcTyClDecl1 calc_vrcs calc_isrec decl)
 359
 360 tcTyClDecl1 calc_vrcs calc_isrec
 361   (TyData {tcdND = new_or_data, tcdCtxt = ctxt, tcdTyVars = tvs,
 362            tcdLName = L _ tc_name, tcdCons = cons})
 363   = tcTyVarBndrs tvs            $ \ tvs' -> do
 364   { stupid_theta <- tcStupidTheta ctxt cons
 365   ; want_generic <- doptM Opt_Generics
 366   ; tycon <- fixM (\ tycon -> do
 367         { unbox_strict <- doptM Opt_UnboxStrictFields
 368         ; data_cons <- mappM (addLocM (tcConDecl unbox_strict new_or_data tycon tvs')) cons
 369         ; let tc_rhs = case new_or_data of
 370                         DataType -> mkDataTyConRhs stupid_theta data_cons
 371                         NewType  -> ASSERT( isSingleton data_cons )
 372                                     mkNewTyConRhs tycon (head data_cons)
 373         ; buildAlgTyCon tc_name tvs' tc_rhs arg_vrcs is_rec
 374                         (want_generic && canDoGenerics data_cons)
 375         })
 376   ; return (ATyCon tycon)
 377   }
 378   where
 379     arg_vrcs = calc_vrcs tc_name
 380     is_rec   = calc_isrec tc_name
 381
 382 tcTyClDecl1 calc_vrcs calc_isrec
 383   (ClassDecl {tcdLName = L _ class_name, tcdTyVars = tvs,
 384               tcdCtxt = ctxt, tcdMeths = meths,
 385               tcdFDs = fundeps, tcdSigs = sigs} )
 386   = tcTyVarBndrs tvs            $ \ tvs' -> do
 387   { ctxt' <- tcHsKindedContext ctxt
 388   ; fds' <- mappM (addLocM tc_fundep) fundeps
 389   ; sig_stuff <- tcClassSigs class_name sigs meths
 390   ; clas <- fixM (\ clas ->
 391                 let     -- This little knot is just so we can get
 392                         -- hold of the name of the class TyCon, which we
 393                         -- need to look up its recursiveness and variance
 394                     tycon_name = tyConName (classTyCon clas)
 395                     tc_isrec = calc_isrec tycon_name
 396                     tc_vrcs  = calc_vrcs  tycon_name
 397                 in
 398                 buildClass class_name tvs' ctxt' fds'
 399                            sig_stuff tc_isrec tc_vrcs)
 400   ; return (AClass clas) }
 401   where
 402     tc_fundep (tvs1, tvs2) = do { tvs1' <- mappM tcLookupTyVar tvs1 ;
 403                                 ; tvs2' <- mappM tcLookupTyVar tvs2 ;
 404                                 ; return (tvs1', tvs2') }
 405
 406
 407 tcTyClDecl1 calc_vrcs calc_isrec
 408   (ForeignType {tcdLName = L _ tc_name, tcdExtName = tc_ext_name})
 409   = returnM (ATyCon (mkForeignTyCon tc_name tc_ext_name liftedTypeKind 0 []))
 410
 411 -----------------------------------
 412 tcConDecl :: Bool               -- True <=> -funbox-strict_fields
 413           -> NewOrData -> TyCon -> [TyVar]
 414           -> ConDecl Name -> TcM DataCon
 415
 416 tcConDecl unbox_strict new_or_data tycon tc_tvs
 417           (ConDecl name ex_tvs ex_ctxt details)
 418   = tcTyVarBndrs ex_tvs         $ \ ex_tvs' -> do
 419     { ex_ctxt' <- tcHsKindedContext ex_ctxt
 420     ; let
 421         is_vanilla = null ex_tvs && null (unLoc ex_ctxt)
 422                 -- Vanilla iff no ex_tvs and no context
 423
 424         tc_datacon is_infix field_lbls btys
 425           = do { let { bangs = map getBangStrictness btys }
 426                ; arg_tys <- mappM tcHsBangType btys
 427                ; buildDataCon (unLoc name) is_infix is_vanilla
 428                     (argStrictness unbox_strict tycon bangs arg_tys)
 429                     (map unLoc field_lbls)
 430                     (tc_tvs ++ ex_tvs')
 431                     ex_ctxt'
 432                     arg_tys
 433                     tycon (mkTyVarTys tc_tvs) }
 434     ; case details of
 435         PrefixCon btys     -> tc_datacon False [] btys
 436         InfixCon bty1 bty2 -> tc_datacon True [] [bty1,bty2]
 437         RecCon fields      -> do { checkTc is_vanilla (exRecConErr name)
 438                                  ; let { (field_names, btys) = unzip fields }
 439                                  ; tc_datacon False field_names btys } }
 440
 441 tcConDecl unbox_strict new_or_data tycon tc_tvs
 442           decl@(GadtDecl name con_ty)
 443   = do  { traceTc (text "tcConDecl"  <+> ppr name)
 444         ; (tvs, theta, bangs, arg_tys, tc, res_tys) <- tcLHsConSig con_ty
 445
 446         ; traceTc (text "tcConDecl1"  <+> ppr name)
 447         ; let   -- Now dis-assemble the type, and check its form
 448               is_vanilla = null theta && mkTyVarTys tvs `tcEqTypes` res_tys
 449
 450                 -- Vanilla datacons guarantee to use the same
 451                 -- type variables as the parent tycon
 452               (tvs', arg_tys', res_tys')
 453                   | is_vanilla = (tc_tvs, substTys subst arg_tys, substTys subst res_tys)
 454                   | otherwise  = (tvs, arg_tys, res_tys)
 455               subst = zipTopTvSubst tvs (mkTyVarTys tc_tvs)
 456
 457         ; traceTc (text "tcConDecl3"  <+> ppr name)
 458         ; buildDataCon (unLoc name) False {- Not infix -} is_vanilla
 459                        (argStrictness unbox_strict tycon bangs arg_tys)
 460                        [{- No field labels -}]
 461                        tvs' theta arg_tys' tycon res_tys' }
 462
 463 tcStupidTheta :: LHsContext Name -> [LConDecl Name] -> TcM (Maybe ThetaType)
 464 -- For GADTs we don't allow a context on the data declaration
 465 -- whereas for standard Haskell style data declarations, we do
 466 tcStupidTheta ctxt (L _ (ConDecl _ _ _ _) : _)
 467   = do { theta <- tcHsKindedContext ctxt; return (Just theta) }
 468 tcStupidTheta ctxt other        -- Includes an empty constructor list
 469   = ASSERT( null (unLoc ctxt) ) return Nothing
 470
 471 -------------------
 472 argStrictness :: Bool           -- True <=> -funbox-strict_fields
 473               -> TyCon -> [HsBang]
 474               -> [TcType] -> [StrictnessMark]
 475 argStrictness unbox_strict tycon bangs arg_tys
 476  = ASSERT( length bangs == length arg_tys )
 477    zipWith (chooseBoxingStrategy unbox_strict tycon) arg_tys bangs
 478
 479 -- We attempt to unbox/unpack a strict field when either:
 480 --   (i)  The field is marked '!!', or
 481 --   (ii) The field is marked '!', and the -funbox-strict-fields flag is on.
 482
 483 chooseBoxingStrategy :: Bool -> TyCon -> TcType -> HsBang -> StrictnessMark
 484 chooseBoxingStrategy unbox_strict_fields tycon arg_ty bang
 485   = case bang of
 486         HsNoBang                                    -> NotMarkedStrict
 487         HsStrict | unbox_strict_fields && can_unbox -> MarkedUnboxed
 488         HsUnbox  | can_unbox                        -> MarkedUnboxed
 489         other                                       -> MarkedStrict
 490   where
 491     can_unbox = case splitTyConApp_maybe arg_ty of
 492                    Nothing             -> False
 493                    Just (arg_tycon, _) -> not (isRecursiveTyCon tycon) &&
 494                                           isProductTyCon arg_tycon
 495 \end{code}
 496
 497 %************************************************************************
 498 %*                                                                      *
 499 \subsection{Dependency analysis}
 500 %*                                                                      *
 501 %************************************************************************
 502
 503 Validity checking is done once the mutually-recursive knot has been
 504 tied, so we can look at things freely.
 505
 506 \begin{code}
 507 checkCycleErrs :: [LTyClDecl Name] -> TcM ()
 508 checkCycleErrs tyclss
 509   | null cls_cycles
 510   = return ()
 511   | otherwise
 512   = do  { mappM_ recClsErr cls_cycles
 513         ; failM }       -- Give up now, because later checkValidTyCl
 514                         -- will loop if the synonym is recursive
 515   where
 516     cls_cycles = calcClassCycles tyclss
 517
 518 checkValidTyCl :: TyClDecl Name -> TcM ()
 519 -- We do the validity check over declarations, rather than TyThings
 520 -- only so that we can add a nice context with tcAddDeclCtxt
 521 checkValidTyCl decl
 522   = tcAddDeclCtxt decl $
 523     do  { thing <- tcLookupLocatedGlobal (tcdLName decl)
 524         ; traceTc (text "Validity of" <+> ppr thing)
 525         ; case thing of
 526             ATyCon tc -> checkValidTyCon tc
 527             AClass cl -> checkValidClass cl
 528         ; traceTc (text "Done validity of" <+> ppr thing)
 529         }
 530
 531 -------------------------
 532 checkValidTyCon :: TyCon -> TcM ()
 533 checkValidTyCon tc
 534   | isSynTyCon tc
 535   = checkValidType syn_ctxt syn_rhs
 536   | otherwise
 537   =     -- Check the context on the data decl
 538     checkValidTheta (DataTyCtxt name) (tyConStupidTheta tc)     `thenM_`
 539
 540         -- Check arg types of data constructors
 541     mappM_ (checkValidDataCon tc) data_cons                     `thenM_`
 542
 543         -- Check that fields with the same name share a type
 544     mappM_ check_fields groups
 545
 546   where
 547     syn_ctxt     = TySynCtxt name
 548     name         = tyConName tc
 549     (_, syn_rhs) = getSynTyConDefn tc
 550     data_cons    = tyConDataCons tc
 551
 552     groups = equivClasses cmp_fld (concatMap get_fields data_cons)
 553     cmp_fld (f1,_) (f2,_) = f1 `compare` f2
 554     get_fields con = dataConFieldLabels con `zip` dataConOrigArgTys con
 555         -- dataConFieldLabels may return the empty list, which is fine
 556
 557     check_fields fields@((first_field_label, field_ty) : other_fields)
 558         -- These fields all have the same name, but are from
 559         -- different constructors in the data type
 560         =       -- Check that all the fields in the group have the same type
 561                 -- NB: this check assumes that all the constructors of a given
 562                 -- data type use the same type variables
 563           checkTc (all (tcEqType field_ty . snd) other_fields)
 564                   (fieldTypeMisMatch first_field_label)
 565
 566 -------------------------------
 567 checkValidDataCon :: TyCon -> DataCon -> TcM ()
 568 checkValidDataCon tc con
 569   = addErrCtxt (dataConCtxt con) $
 570     do  { checkTc (dataConTyCon con == tc) (badDataConTyCon con)
 571         ; checkValidType ctxt (idType (dataConWrapId con)) }
 572
 573                 -- This checks the argument types and
 574                 -- ambiguity of the existential context (if any)
 575                 --
 576                 -- Note [Sept 04] Now that tvs is all the tvs, this
 577                 -- test doesn't actually check anything
 578 --      ; checkFreeness tvs ex_theta }
 579   where
 580     ctxt = ConArgCtxt (dataConName con)
 581     (tvs, ex_theta, _, _, _) = dataConSig con
 582
 583
 584 -------------------------------
 585 checkValidClass :: Class -> TcM ()
 586 checkValidClass cls
 587   = do  {       -- CHECK ARITY 1 FOR HASKELL 1.4
 588           gla_exts <- doptM Opt_GlasgowExts
 589
 590         -- Check that the class is unary, unless GlaExs
 591         ; checkTc (notNull tyvars) (nullaryClassErr cls)
 592         ; checkTc (gla_exts || unary) (classArityErr cls)
 593
 594         -- Check the super-classes
 595         ; checkValidTheta (ClassSCCtxt (className cls)) theta
 596
 597         -- Check the class operations
 598         ; mappM_ check_op op_stuff
 599
 600         -- Check that if the class has generic methods, then the
 601         -- class has only one parameter.  We can't do generic
 602         -- multi-parameter type classes!
 603         ; checkTc (unary || no_generics) (genericMultiParamErr cls)
 604         }
 605   where
 606     (tyvars, theta, _, op_stuff) = classBigSig cls
 607     unary       = isSingleton tyvars
 608     no_generics = null [() | (_, GenDefMeth) <- op_stuff]
 609
 610     check_op (sel_id, dm)
 611       = addErrCtxt (classOpCtxt sel_id tau) $ do
 612         { checkValidTheta SigmaCtxt (tail theta)
 613                 -- The 'tail' removes the initial (C a) from the
 614                 -- class itself, leaving just the method type
 615
 616         ; checkValidType (FunSigCtxt op_name) tau
 617
 618                 -- Check that the type mentions at least one of
 619                 -- the class type variables
 620         ; checkTc (any (`elemVarSet` tyVarsOfType tau) tyvars)
 621                   (noClassTyVarErr cls sel_id)
 622
 623                 -- Check that for a generic method, the type of
 624                 -- the method is sufficiently simple
 625         ; checkTc (dm /= GenDefMeth || validGenericMethodType op_ty)
 626                   (badGenericMethodType op_name op_ty)
 627         }
 628         where
 629           op_name = idName sel_id
 630           op_ty   = idType sel_id
 631           (_,theta,tau) = tcSplitSigmaTy op_ty
 632
 633
 634
 635 ---------------------------------------------------------------------
 636 fieldTypeMisMatch field_name
 637   = sep [ptext SLIT("Different constructors give different types for field"), quotes (ppr field_name)]
 638
 639 dataConCtxt con = sep [ptext SLIT("When checking the data constructor:"),
 640                        nest 2 (ex_part <+> pprThetaArrow ex_theta <+> ppr con <+> arg_part)]
 641   where
 642     (ex_tvs, ex_theta, arg_tys, _, _) = dataConSig con
 643     ex_part | null ex_tvs = empty
 644             | otherwise   = ptext SLIT("forall") <+> hsep (map ppr ex_tvs) <> dot
 645         -- The 'ex_theta' part could be non-empty, if the user (bogusly) wrote
 646         --      data T a = Eq a => T a a
 647         -- So we make sure to print it
 648
 649     fields = dataConFieldLabels con
 650     arg_part | null fields = sep (map pprParendType arg_tys)
 651              | otherwise   = braces (sep (punctuate comma
 652                              [ ppr n <+> dcolon <+> ppr ty
 653                              | (n,ty) <- fields `zip` arg_tys]))
 654
 655 classOpCtxt sel_id tau = sep [ptext SLIT("When checking the class method:"),
 656                               nest 2 (ppr sel_id <+> dcolon <+> ppr tau)]
 657
 658 nullaryClassErr cls
 659   = ptext SLIT("No parameters for class")  <+> quotes (ppr cls)
 660
 661 classArityErr cls
 662   = vcat [ptext SLIT("Too many parameters for class") <+> quotes (ppr cls),
 663           parens (ptext SLIT("Use -fglasgow-exts to allow multi-parameter classes"))]
 664
 665 noClassTyVarErr clas op
 666   = sep [ptext SLIT("The class method") <+> quotes (ppr op),
 667          ptext SLIT("mentions none of the type variables of the class") <+>
 668                 ppr clas <+> hsep (map ppr (classTyVars clas))]
 669
 670 genericMultiParamErr clas
 671   = ptext SLIT("The multi-parameter class") <+> quotes (ppr clas) <+>
 672     ptext SLIT("cannot have generic methods")
 673
 674 badGenericMethodType op op_ty
 675   = hang (ptext SLIT("Generic method type is too complex"))
 676        4 (vcat [ppr op <+> dcolon <+> ppr op_ty,
 677                 ptext SLIT("You can only use type variables, arrows, and tuples")])
 678
 679 recSynErr syn_decls
 680   = setSrcSpan (getLoc (head syn_decls)) $
 681     addErr (sep [ptext SLIT("Cycle in type synonym declarations:"),
 682                  nest 2 (vcat (map ppr_decl syn_decls))])
 683   where
 684     ppr_decl (L loc decl) = ppr loc <> colon <+> ppr decl
 685
 686 recClsErr cls_decls
 687   = setSrcSpan (getLoc (head cls_decls)) $
 688     addErr (sep [ptext SLIT("Cycle in class declarations (via superclasses):"),
 689                  nest 2 (vcat (map ppr_decl cls_decls))])
 690   where
 691     ppr_decl (L loc decl) = ppr loc <> colon <+> ppr (decl { tcdSigs = [] })
 692
 693 exRecConErr name
 694   = ptext SLIT("Can't combine named fields with locally-quantified type variables or context")
 695     $$
 696     (ptext SLIT("In the declaration of data constructor") <+> ppr name)
 697
 698 badDataConTyCon data_con
 699   = hang (ptext SLIT("Data constructor does not return its parent type:"))
 700        2 (ppr data_con)
 701 \end{code}