compiler/typecheck/TcTyClsDecls.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The AQUA Project, Glasgow University, 1996-1998
   4 %
   5
   6 TcTyClsDecls: Typecheck type and class declarations
   7
   8 \begin{code}
   9 module TcTyClsDecls (
  10         tcTyAndClassDecls, tcFamInstDecl
  11     ) where
  12
  13 #include "HsVersions.h"
  14
  15 import HsSyn
  16 import HsTypes
  17 import BasicTypes
  18 import HscTypes
  19 import BuildTyCl
  20 import TcRnMonad
  21 import TcEnv
  22 import TcTyDecls
  23 import TcClassDcl
  24 import TcHsType
  25 import TcMType
  26 import TcType
  27 import FunDeps
  28 import Type
  29 import Generics
  30 import Class
  31 import TyCon
  32 import DataCon
  33 import Var
  34 import VarSet
  35 import Name
  36 import OccName
  37 import Outputable
  38 import Maybes
  39 import Monad
  40 import Unify
  41 import Util
  42 import SrcLoc
  43 import ListSetOps
  44 import Digraph
  45 import DynFlags
  46
  47 import Data.List        ( partition, elemIndex )
  48 import Control.Monad    ( mplus )
  49 \end{code}
  50
  51
  52 %************************************************************************
  53 %*                                                                      *
  54 \subsection{Type checking for type and class declarations}
  55 %*                                                                      *
  56 %************************************************************************
  57
  58 Dealing with a group
  59 ~~~~~~~~~~~~~~~~~~~~
  60 Consider a mutually-recursive group, binding
  61 a type constructor T and a class C.
  62
  63 Step 1:         getInitialKind
  64         Construct a KindEnv by binding T and C to a kind variable
  65
  66 Step 2:         kcTyClDecl
  67         In that environment, do a kind check
  68
  69 Step 3: Zonk the kinds
  70
  71 Step 4:         buildTyConOrClass
  72         Construct an environment binding T to a TyCon and C to a Class.
  73         a) Their kinds comes from zonking the relevant kind variable
  74         b) Their arity (for synonyms) comes direct from the decl
  75         c) The funcional dependencies come from the decl
  76         d) The rest comes a knot-tied binding of T and C, returned from Step 4
  77         e) The variances of the tycons in the group is calculated from
  78                 the knot-tied stuff
  79
  80 Step 5:         tcTyClDecl1
  81         In this environment, walk over the decls, constructing the TyCons and Classes.
  82         This uses in a strict way items (a)-(c) above, which is why they must
  83         be constructed in Step 4. Feed the results back to Step 4.
  84         For this step, pass the is-recursive flag as the wimp-out flag
  85         to tcTyClDecl1.
  86
  87
  88 Step 6:         Extend environment
  89         We extend the type environment with bindings not only for the TyCons and Classes,
  90         but also for their "implicit Ids" like data constructors and class selectors
  91
  92 Step 7:         checkValidTyCl
  93         For a recursive group only, check all the decls again, just
  94         to check all the side conditions on validity.  We could not
  95         do this before because we were in a mutually recursive knot.
  96
  97 Identification of recursive TyCons
  98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  99 The knot-tying parameters: @rec_details_list@ is an alist mapping @Name@s to
 100 @TyThing@s.
 101
 102 Identifying a TyCon as recursive serves two purposes
 103
 104 1.  Avoid infinite types.  Non-recursive newtypes are treated as
 105 "transparent", like type synonyms, after the type checker.  If we did
 106 this for all newtypes, we'd get infinite types.  So we figure out for
 107 each newtype whether it is "recursive", and add a coercion if so.  In
 108 effect, we are trying to "cut the loops" by identifying a loop-breaker.
 109
 110 2.  Avoid infinite unboxing.  This is nothing to do with newtypes.
 111 Suppose we have
 112         data T = MkT Int T
 113         f (MkT x t) = f t
 114 Well, this function diverges, but we don't want the strictness analyser
 115 to diverge.  But the strictness analyser will diverge because it looks
 116 deeper and deeper into the structure of T.   (I believe there are
 117 examples where the function does something sane, and the strictness
 118 analyser still diverges, but I can't see one now.)
 119
 120 Now, concerning (1), the FC2 branch currently adds a coercion for ALL
 121 newtypes.  I did this as an experiment, to try to expose cases in which
 122 the coercions got in the way of optimisations.  If it turns out that we
 123 can indeed always use a coercion, then we don't risk recursive types,
 124 and don't need to figure out what the loop breakers are.
 125
 126 For newtype *families* though, we will always have a coercion, so they
 127 are always loop breakers!  So you can easily adjust the current
 128 algorithm by simply treating all newtype families as loop breakers (and
 129 indeed type families).  I think.
 130
 131 \begin{code}
 132 tcTyAndClassDecls :: ModDetails -> [LTyClDecl Name]
 133                    -> TcM TcGblEnv      -- Input env extended by types and classes
 134                                         -- and their implicit Ids,DataCons
 135 tcTyAndClassDecls boot_details allDecls
 136   = do  {       -- Omit instances of indexed types; they are handled together
 137                 -- with the *heads* of class instances
 138         ; let decls = filter (not . isFamInstDecl . unLoc) allDecls
 139
 140                 -- First check for cyclic type synonysm or classes
 141                 -- See notes with checkCycleErrs
 142         ; checkCycleErrs decls
 143         ; mod <- getModule
 144         ; traceTc (text "tcTyAndCl" <+> ppr mod)
 145         ; (syn_tycons, alg_tyclss) <- fixM (\ ~(rec_syn_tycons, rec_alg_tyclss) ->
 146           do    { let { -- Seperate ordinary synonyms from all other type and
 147                         -- class declarations and add all associated type
 148                         -- declarations from type classes.  The latter is
 149                         -- required so that the temporary environment for the
 150                         -- knot includes all associated family declarations.
 151                       ; (syn_decls, alg_decls) = partition (isSynDecl . unLoc)
 152                                                    decls
 153                       ; alg_at_decls           = concatMap addATs alg_decls
 154                       }
 155                         -- Extend the global env with the knot-tied results
 156                         -- for data types and classes
 157                         --
 158                         -- We must populate the environment with the loop-tied
 159                         -- T's right away, because the kind checker may "fault
 160                         -- in" some type  constructors that recursively
 161                         -- mention T
 162                 ; let gbl_things = mkGlobalThings alg_at_decls rec_alg_tyclss
 163                 ; tcExtendRecEnv gbl_things $ do
 164
 165                         -- Kind-check the declarations
 166                 { (kc_syn_decls, kc_alg_decls) <- kcTyClDecls syn_decls alg_decls
 167
 168                 ; let { -- Calculate rec-flag
 169                       ; calc_rec  = calcRecFlags boot_details rec_alg_tyclss
 170                       ; tc_decl   = addLocM (tcTyClDecl calc_rec) }
 171
 172                         -- Type-check the type synonyms, and extend the envt
 173                 ; syn_tycons <- tcSynDecls kc_syn_decls
 174                 ; tcExtendGlobalEnv syn_tycons $ do
 175
 176                         -- Type-check the data types and classes
 177                 { alg_tyclss <- mappM tc_decl kc_alg_decls
 178                 ; return (syn_tycons, concat alg_tyclss)
 179             }}})
 180         -- Finished with knot-tying now
 181         -- Extend the environment with the finished things
 182         ; tcExtendGlobalEnv (syn_tycons ++ alg_tyclss) $ do
 183
 184         -- Perform the validity check
 185         { traceTc (text "ready for validity check")
 186         ; mappM_ (addLocM checkValidTyCl) decls
 187         ; traceTc (text "done")
 188
 189         -- Add the implicit things;
 190         -- we want them in the environment because
 191         -- they may be mentioned in interface files
 192         -- NB: All associated types and their implicit things will be added a
 193         --     second time here.  This doesn't matter as the definitions are
 194         --     the same.
 195         ; let { implicit_things = concatMap implicitTyThings alg_tyclss }
 196         ; traceTc ((text "Adding" <+> ppr alg_tyclss)
 197                    $$ (text "and" <+> ppr implicit_things))
 198         ; tcExtendGlobalEnv implicit_things getGblEnv
 199     }}
 200   where
 201     -- Pull associated types out of class declarations, to tie them into the
 202     -- knot above.
 203     -- NB: We put them in the same place in the list as `tcTyClDecl' will
 204     --     eventually put the matching `TyThing's.  That's crucial; otherwise,
 205     --     the two argument lists of `mkGlobalThings' don't match up.
 206     addATs decl@(L _ (ClassDecl {tcdATs = ats})) = decl : ats
 207     addATs decl                                  = [decl]
 208
 209 mkGlobalThings :: [LTyClDecl Name]      -- The decls
 210                -> [TyThing]             -- Knot-tied, in 1-1 correspondence with the decls
 211                -> [(Name,TyThing)]
 212 -- Driven by the Decls, and treating the TyThings lazily
 213 -- make a TypeEnv for the new things
 214 mkGlobalThings decls things
 215   = map mk_thing (decls `zipLazy` things)
 216   where
 217     mk_thing (L _ (ClassDecl {tcdLName = L _ name}), ~(AClass cl))
 218          = (name, AClass cl)
 219     mk_thing (L _ decl, ~(ATyCon tc))
 220          = (tcdName decl, ATyCon tc)
 221 \end{code}
 222
 223
 224 %************************************************************************
 225 %*                                                                      *
 226 \subsection{Type checking family instances}
 227 %*                                                                      *
 228 %************************************************************************
 229
 230 Family instances are somewhat of a hybrid.  They are processed together with
 231 class instance heads, but can contain data constructors and hence they share a
 232 lot of kinding and type checking code with ordinary algebraic data types (and
 233 GADTs).
 234
 235 \begin{code}
 236 tcFamInstDecl :: LTyClDecl Name -> TcM (Maybe TyThing)   -- Nothing if error
 237 tcFamInstDecl (L loc decl)
 238   =     -- Prime error recovery, set source location
 239     recoverM (returnM Nothing)                  $
 240     setSrcSpan loc                              $
 241     tcAddDeclCtxt decl                          $
 242     do { -- type families require -findexed-types and can't be in an
 243          -- hs-boot file
 244        ; gla_exts <- doptM Opt_IndexedTypes
 245        ; is_boot  <- tcIsHsBoot   -- Are we compiling an hs-boot file?
 246        ; checkTc gla_exts      $ badFamInstDecl (tcdLName decl)
 247        ; checkTc (not is_boot) $ badBootFamInstDeclErr
 248
 249          -- perform kind and type checking
 250        ; tcFamInstDecl1 decl
 251        }
 252
 253 tcFamInstDecl1 :: TyClDecl Name -> TcM (Maybe TyThing)   -- Nothing if error
 254
 255   -- "type instance"
 256 tcFamInstDecl1 (decl@TySynonym {tcdLName = L loc tc_name})
 257   = kcIdxTyPats decl $ \k_tvs k_typats resKind family ->
 258     do { -- check that the family declaration is for a synonym
 259          unless (isSynTyCon family) $
 260            addErr (wrongKindOfFamily family)
 261
 262        ; -- (1) kind check the right hand side of the type equation
 263        ; k_rhs <- kcCheckHsType (tcdSynRhs decl) resKind
 264
 265          -- (2) type check type equation
 266        ; tcTyVarBndrs k_tvs $ \t_tvs -> do {  -- turn kinded into proper tyvars
 267        ; t_typats <- mappM tcHsKindedType k_typats
 268        ; t_rhs    <- tcHsKindedType k_rhs
 269
 270          -- (3) construct representation tycon
 271        ; rep_tc_name <- newFamInstTyConName tc_name (srcSpanStart loc)
 272        ; tycon <- buildSynTyCon rep_tc_name t_tvs (SynonymTyCon t_rhs)
 273                                 (Just (family, t_typats))
 274
 275        ; return $ Just (ATyCon tycon)
 276        }}
 277
 278   -- "newtype instance" and "data instance"
 279 tcFamInstDecl1 (decl@TyData {tcdND = new_or_data, tcdLName = L loc tc_name,
 280                              tcdCons = cons})
 281   = kcIdxTyPats decl $ \k_tvs k_typats resKind family ->
 282     do { -- check that the family declaration is for the right kind
 283          unless (new_or_data == NewType  && isNewTyCon  family ||
 284                  new_or_data == DataType && isDataTyCon family) $
 285            addErr (wrongKindOfFamily family)
 286
 287        ; -- (1) kind check the data declaration as usual
 288        ; k_decl <- kcDataDecl decl k_tvs
 289        ; let k_ctxt = tcdCtxt k_decl
 290              k_cons = tcdCons k_decl
 291
 292          -- result kind must be '*' (otherwise, we have too few patterns)
 293        ; checkTc (isLiftedTypeKind resKind) $ tooFewParmsErr tc_name
 294
 295          -- (2) type check indexed data type declaration
 296        ; tcTyVarBndrs k_tvs $ \t_tvs -> do {  -- turn kinded into proper tyvars
 297        ; unbox_strict <- doptM Opt_UnboxStrictFields
 298
 299          -- Check that we don't use GADT syntax for indexed types
 300        ; checkTc h98_syntax (badGadtIdxTyDecl tc_name)
 301
 302          -- Check that a newtype has exactly one constructor
 303        ; checkTc (new_or_data == DataType || isSingleton k_cons) $
 304            newtypeConError tc_name (length k_cons)
 305
 306        ; t_typats     <- mappM tcHsKindedType k_typats
 307        ; stupid_theta <- tcHsKindedContext k_ctxt
 308
 309          -- (3) construct representation tycon
 310        ; rep_tc_name <- newFamInstTyConName tc_name (srcSpanStart loc)
 311        ; tycon <- fixM (\ tycon -> do
 312              { data_cons <- mappM (addLocM (tcConDecl unbox_strict tycon t_tvs))
 313                                   k_cons
 314              ; tc_rhs <-
 315                  case new_or_data of
 316                    DataType -> return (mkDataTyConRhs data_cons)
 317                    NewType  -> ASSERT( isSingleton data_cons )
 318                                mkNewTyConRhs tc_name tycon (head data_cons)
 319              ; buildAlgTyCon rep_tc_name t_tvs stupid_theta tc_rhs Recursive
 320                              False h98_syntax (Just (family, t_typats))
 321                  -- We always assume that indexed types are recursive.  Why?
 322                  -- (1) Due to their open nature, we can never be sure that a
 323                  -- further instance might not introduce a new recursive
 324                  -- dependency.  (2) They are always valid loop breakers as
 325                  -- they involve a coercion.
 326              })
 327
 328          -- construct result
 329        ; return $ Just (ATyCon tycon)
 330        }}
 331        where
 332          h98_syntax = case cons of      -- All constructors have same shape
 333                         L _ (ConDecl { con_res = ResTyGADT _ }) : _ -> False
 334                         other -> True
 335
 336 -- Kind checking of indexed types
 337 -- -
 338
 339 -- Kind check type patterns and kind annotate the embedded type variables.
 340 --
 341 -- * Here we check that a type instance matches its kind signature, but we do
 342 --   not check whether there is a pattern for each type index; the latter
 343 --   check is only required for type functions.
 344 --
 345 kcIdxTyPats :: TyClDecl Name
 346             -> ([LHsTyVarBndr Name] -> [LHsType Name] -> Kind -> TyCon -> TcM a)
 347                -- ^^kinded tvs         ^^kinded ty pats  ^^res kind
 348             -> TcM a
 349 kcIdxTyPats decl thing_inside
 350   = kcHsTyVars (tcdTyVars decl) $ \tvs ->
 351     do { family <- tcLookupLocatedTyCon (tcdLName decl)
 352        ; let { (kinds, resKind) = splitKindFunTys (tyConKind family)
 353              ; hs_typats        = fromJust $ tcdTyPats decl }
 354
 355          -- we may not have more parameters than the kind indicates
 356        ; checkTc (length kinds >= length hs_typats) $
 357            tooManyParmsErr (tcdLName decl)
 358
 359          -- type functions can have a higher-kinded result
 360        ; let resultKind = mkArrowKinds (drop (length hs_typats) kinds) resKind
 361        ; typats <- TcRnMonad.zipWithM kcCheckHsType hs_typats kinds
 362        ; thing_inside tvs typats resultKind family
 363        }
 364   where
 365 \end{code}
 366
 367
 368 %************************************************************************
 369 %*                                                                      *
 370                 Kind checking
 371 %*                                                                      *
 372 %************************************************************************
 373
 374 We need to kind check all types in the mutually recursive group
 375 before we know the kind of the type variables.  For example:
 376
 377 class C a where
 378    op :: D b => a -> b -> b
 379
 380 class D c where
 381    bop :: (Monad c) => ...
 382
 383 Here, the kind of the locally-polymorphic type variable "b"
 384 depends on *all the uses of class D*.  For example, the use of
 385 Monad c in bop's type signature means that D must have kind Type->Type.
 386
 387 However type synonyms work differently.  They can have kinds which don't
 388 just involve (->) and *:
 389         type R = Int#           -- Kind #
 390         type S a = Array# a     -- Kind * -> #
 391         type T a b = (# a,b #)  -- Kind * -> * -> (# a,b #)
 392 So we must infer their kinds from their right-hand sides *first* and then
 393 use them, whereas for the mutually recursive data types D we bring into
 394 scope kind bindings D -> k, where k is a kind variable, and do inference.
 395
 396 Indexed Types
 397 ~~~~~~~~~~~~~
 398 This treatment of type synonyms only applies to Haskell 98-style synonyms.
 399 General type functions can be recursive, and hence, appear in `alg_decls'.
 400
 401 The kind of a type family is solely determinded by its kind signature;
 402 hence, only kind signatures participate in the construction of the initial
 403 kind environment (as constructed by `getInitialKind').  In fact, we ignore
 404 instances of families altogether in the following.  However, we need to
 405 include the kinds of associated families into the construction of the
 406 initial kind environment.  (This is handled by `allDecls').
 407
 408 \begin{code}
 409 kcTyClDecls syn_decls alg_decls
 410   = do  {       -- First extend the kind env with each data type, class, and
 411                 -- indexed type, mapping them to a type variable
 412           let initialKindDecls = concat [allDecls decl | L _ decl <- alg_decls]
 413         ; alg_kinds <- mappM getInitialKind initialKindDecls
 414         ; tcExtendKindEnv alg_kinds $ do
 415
 416                 -- Now kind-check the type synonyms, in dependency order
 417                 -- We do these differently to data type and classes,
 418                 -- because a type synonym can be an unboxed type
 419                 --      type Foo = Int#
 420                 -- and a kind variable can't unify with UnboxedTypeKind
 421                 -- So we infer their kinds in dependency order
 422         { (kc_syn_decls, syn_kinds) <- kcSynDecls (calcSynCycles syn_decls)
 423         ; tcExtendKindEnv syn_kinds $  do
 424
 425                 -- Now kind-check the data type, class, and kind signatures,
 426                 -- returning kind-annotated decls; we don't kind-check
 427                 -- instances of indexed types yet, but leave this to
 428                 -- `tcInstDecls1'
 429         { kc_alg_decls <- mappM (wrapLocM kcTyClDecl)
 430                             (filter (not . isFamInstDecl . unLoc) alg_decls)
 431
 432         ; return (kc_syn_decls, kc_alg_decls) }}}
 433   where
 434     -- get all declarations relevant for determining the initial kind
 435     -- environment
 436     allDecls (decl@ClassDecl {tcdATs = ats}) = decl : [ at
 437                                                       | L _ at <- ats
 438                                                       , isFamilyDecl at]
 439     allDecls decl | isFamInstDecl decl = []
 440                   | otherwise          = [decl]
 441
 442 ------------------------------------------------------------------------
 443 getInitialKind :: TyClDecl Name -> TcM (Name, TcKind)
 444 -- Only for data type, class, and indexed type declarations
 445 -- Get as much info as possible from the data, class, or indexed type decl,
 446 -- so as to maximise usefulness of error messages
 447 getInitialKind decl
 448   = do  { arg_kinds <- mapM (mk_arg_kind . unLoc) (tyClDeclTyVars decl)
 449         ; res_kind  <- mk_res_kind decl
 450         ; return (tcdName decl, mkArrowKinds arg_kinds res_kind) }
 451   where
 452     mk_arg_kind (UserTyVar _)        = newKindVar
 453     mk_arg_kind (KindedTyVar _ kind) = return kind
 454
 455     mk_res_kind (TyFamily { tcdKind    = Just kind }) = return kind
 456     mk_res_kind (TyData   { tcdKindSig = Just kind }) = return kind
 457         -- On GADT-style declarations we allow a kind signature
 458         --      data T :: *->* where { ... }
 459     mk_res_kind other = return liftedTypeKind
 460
 461
 462 ----------------
 463 kcSynDecls :: [SCC (LTyClDecl Name)]
 464            -> TcM ([LTyClDecl Name],    -- Kind-annotated decls
 465                    [(Name,TcKind)])     -- Kind bindings
 466 kcSynDecls []
 467   = return ([], [])
 468 kcSynDecls (group : groups)
 469   = do  { (decl,  nk)  <- kcSynDecl group
 470         ; (decls, nks) <- tcExtendKindEnv [nk] (kcSynDecls groups)
 471         ; return (decl:decls, nk:nks) }
 472
 473 ----------------
 474 kcSynDecl :: SCC (LTyClDecl Name)
 475            -> TcM (LTyClDecl Name,      -- Kind-annotated decls
 476                    (Name,TcKind))       -- Kind bindings
 477 kcSynDecl (AcyclicSCC ldecl@(L loc decl))
 478   = tcAddDeclCtxt decl  $
 479     kcHsTyVars (tcdTyVars decl) (\ k_tvs ->
 480     do { traceTc (text "kcd1" <+> ppr (unLoc (tcdLName decl)) <+> brackets (ppr (tcdTyVars decl))
 481                         <+> brackets (ppr k_tvs))
 482        ; (k_rhs, rhs_kind) <- kcHsType (tcdSynRhs decl)
 483        ; traceTc (text "kcd2" <+> ppr (unLoc (tcdLName decl)))
 484        ; let tc_kind = foldr (mkArrowKind . kindedTyVarKind) rhs_kind k_tvs
 485        ; return (L loc (decl { tcdTyVars = k_tvs, tcdSynRhs = k_rhs }),
 486                  (unLoc (tcdLName decl), tc_kind)) })
 487
 488 kcSynDecl (CyclicSCC decls)
 489   = do { recSynErr decls; failM }       -- Fail here to avoid error cascade
 490                                         -- of out-of-scope tycons
 491
 492 kindedTyVarKind (L _ (KindedTyVar _ k)) = k
 493
 494 ------------------------------------------------------------------------
 495 kcTyClDecl :: TyClDecl Name -> TcM (TyClDecl Name)
 496         -- Not used for type synonyms (see kcSynDecl)
 497
 498 kcTyClDecl decl@(TyData {})
 499   = ASSERT( not . isFamInstDecl $ decl )   -- must not be a family instance
 500     kcTyClDeclBody decl $
 501       kcDataDecl decl
 502
 503 kcTyClDecl decl@(TyFamily {tcdKind = kind})
 504   = kcTyClDeclBody decl $ \ tvs' ->
 505       return (decl {tcdTyVars = tvs',
 506                     tcdKind = kind `mplus` Just liftedTypeKind})
 507                     -- default result kind is '*'
 508
 509 kcTyClDecl decl@(ClassDecl {tcdCtxt = ctxt, tcdSigs = sigs, tcdATs = ats})
 510   = kcTyClDeclBody decl $ \ tvs' ->
 511     do  { is_boot <- tcIsHsBoot
 512         ; ctxt' <- kcHsContext ctxt
 513         ; ats'  <- mappM (wrapLocM kcTyClDecl) ats
 514         ; sigs' <- mappM (wrapLocM kc_sig    ) sigs
 515         ; return (decl {tcdTyVars = tvs', tcdCtxt = ctxt', tcdSigs = sigs',
 516                         tcdATs = ats'}) }
 517   where
 518     kc_sig (TypeSig nm op_ty) = do { op_ty' <- kcHsLiftedSigType op_ty
 519                                    ; return (TypeSig nm op_ty') }
 520     kc_sig other_sig          = return other_sig
 521
 522 kcTyClDecl decl@(ForeignType {})
 523   = return decl
 524
 525 kcTyClDeclBody :: TyClDecl Name
 526                -> ([LHsTyVarBndr Name] -> TcM a)
 527                -> TcM a
 528 -- getInitialKind has made a suitably-shaped kind for the type or class
 529 -- Unpack it, and attribute those kinds to the type variables
 530 -- Extend the env with bindings for the tyvars, taken from
 531 -- the kind of the tycon/class.  Give it to the thing inside, and
 532 -- check the result kind matches
 533 kcTyClDeclBody decl thing_inside
 534   = tcAddDeclCtxt decl          $
 535     do  { tc_ty_thing <- tcLookupLocated (tcdLName decl)
 536         ; let tc_kind    = case tc_ty_thing of { AThing k -> k }
 537               (kinds, _) = splitKindFunTys tc_kind
 538               hs_tvs     = tcdTyVars decl
 539               kinded_tvs = ASSERT( length kinds >= length hs_tvs )
 540                            [ L loc (KindedTyVar (hsTyVarName tv) k)
 541                            | (L loc tv, k) <- zip hs_tvs kinds]
 542         ; tcExtendKindEnvTvs kinded_tvs (thing_inside kinded_tvs) }
 543
 544 -- Kind check a data declaration, assuming that we already extended the
 545 -- kind environment with the type variables of the left-hand side (these
 546 -- kinded type variables are also passed as the second parameter).
 547 --
 548 kcDataDecl :: TyClDecl Name -> [LHsTyVarBndr Name] -> TcM (TyClDecl Name)
 549 kcDataDecl decl@(TyData {tcdND = new_or_data, tcdCtxt = ctxt, tcdCons = cons})
 550            tvs
 551   = do  { ctxt' <- kcHsContext ctxt
 552         ; cons' <- mappM (wrapLocM kc_con_decl) cons
 553         ; return (decl {tcdTyVars = tvs, tcdCtxt = ctxt', tcdCons = cons'}) }
 554   where
 555     -- doc comments are typechecked to Nothing here
 556     kc_con_decl (ConDecl name expl ex_tvs ex_ctxt details res _) = do
 557       kcHsTyVars ex_tvs $ \ex_tvs' -> do
 558         ex_ctxt' <- kcHsContext ex_ctxt
 559         details' <- kc_con_details details
 560         res'     <- case res of
 561           ResTyH98 -> return ResTyH98
 562           ResTyGADT ty -> do { ty' <- kcHsSigType ty; return (ResTyGADT ty') }
 563         return (ConDecl name expl ex_tvs' ex_ctxt' details' res' Nothing)
 564
 565     kc_con_details (PrefixCon btys)
 566         = do { btys' <- mappM kc_larg_ty btys ; return (PrefixCon btys') }
 567     kc_con_details (InfixCon bty1 bty2)
 568         = do { bty1' <- kc_larg_ty bty1; bty2' <- kc_larg_ty bty2; return (InfixCon bty1' bty2') }
 569     kc_con_details (RecCon fields)
 570         = do { fields' <- mappM kc_field fields; return (RecCon fields') }
 571
 572     kc_field (HsRecField fld bty d) = do { bty' <- kc_larg_ty bty ; return (HsRecField fld bty' d) }
 573
 574     kc_larg_ty bty = case new_or_data of
 575                         DataType -> kcHsSigType bty
 576                         NewType  -> kcHsLiftedSigType bty
 577         -- Can't allow an unlifted type for newtypes, because we're effectively
 578         -- going to remove the constructor while coercing it to a lifted type.
 579         -- And newtypes can't be bang'd
 580 \end{code}
 581
 582
 583 %************************************************************************
 584 %*                                                                      *
 585 \subsection{Type checking}
 586 %*                                                                      *
 587 %************************************************************************
 588
 589 \begin{code}
 590 tcSynDecls :: [LTyClDecl Name] -> TcM [TyThing]
 591 tcSynDecls [] = return []
 592 tcSynDecls (decl : decls)
 593   = do { syn_tc <- addLocM tcSynDecl decl
 594        ; syn_tcs <- tcExtendGlobalEnv [syn_tc] (tcSynDecls decls)
 595        ; return (syn_tc : syn_tcs) }
 596
 597   -- "type"
 598 tcSynDecl
 599   (TySynonym {tcdLName = L _ tc_name, tcdTyVars = tvs, tcdSynRhs = rhs_ty})
 600   = tcTyVarBndrs tvs            $ \ tvs' -> do
 601     { traceTc (text "tcd1" <+> ppr tc_name)
 602     ; rhs_ty' <- tcHsKindedType rhs_ty
 603     ; tycon <- buildSynTyCon tc_name tvs' (SynonymTyCon rhs_ty') Nothing
 604     ; return (ATyCon tycon)
 605     }
 606
 607 --------------------
 608 tcTyClDecl :: (Name -> RecFlag) -> TyClDecl Name -> TcM [TyThing]
 609
 610 tcTyClDecl calc_isrec decl
 611   = tcAddDeclCtxt decl (tcTyClDecl1 calc_isrec decl)
 612
 613   -- "type family" declarations
 614 tcTyClDecl1 _calc_isrec
 615   (TyFamily {tcdFlavour = TypeFamily,
 616              tcdLName = L _ tc_name, tcdTyVars = tvs, tcdKind = Just kind})
 617                                                       -- NB: kind at latest
 618                                                       --     added during
 619                                                       --     kind checking
 620   = tcTyVarBndrs tvs  $ \ tvs' -> do
 621   { traceTc (text "type family: " <+> ppr tc_name)
 622   ; idx_tys <- doptM Opt_IndexedTypes
 623
 624         -- Check that we don't use families without -findexed-types
 625   ; checkTc idx_tys $ badFamInstDecl tc_name
 626
 627   ; tycon <- buildSynTyCon tc_name tvs' (OpenSynTyCon kind Nothing) Nothing
 628   ; return [ATyCon tycon]
 629   }
 630
 631   -- "newtype family" or "data family" declaration
 632 tcTyClDecl1 _calc_isrec
 633   (TyFamily {tcdFlavour = DataFamily new_or_data,
 634              tcdLName = L _ tc_name, tcdTyVars = tvs, tcdKind = mb_kind})
 635   = tcTyVarBndrs tvs  $ \ tvs' -> do
 636   { traceTc (text "data/newtype family: " <+> ppr tc_name)
 637   ; extra_tvs <- tcDataKindSig mb_kind
 638   ; let final_tvs = tvs' ++ extra_tvs    -- we may not need these
 639
 640   ; idx_tys <- doptM Opt_IndexedTypes
 641
 642         -- Check that we don't use families without -findexed-types
 643   ; checkTc idx_tys $ badFamInstDecl tc_name
 644
 645   ; tycon <- buildAlgTyCon tc_name final_tvs []
 646                (case new_or_data of
 647                   DataType -> mkOpenDataTyConRhs
 648                   NewType  -> mkOpenNewTyConRhs)
 649                Recursive False True Nothing
 650   ; return [ATyCon tycon]
 651   }
 652
 653   -- "newtype" and "data"
 654 tcTyClDecl1 calc_isrec
 655   (TyData {tcdND = new_or_data, tcdCtxt = ctxt, tcdTyVars = tvs,
 656            tcdLName = L _ tc_name, tcdKindSig = mb_ksig, tcdCons = cons})
 657   = tcTyVarBndrs tvs    $ \ tvs' -> do
 658   { extra_tvs <- tcDataKindSig mb_ksig
 659   ; let final_tvs = tvs' ++ extra_tvs
 660   ; stupid_theta <- tcHsKindedContext ctxt
 661   ; want_generic <- doptM Opt_Generics
 662   ; unbox_strict <- doptM Opt_UnboxStrictFields
 663   ; gla_exts     <- doptM Opt_GlasgowExts
 664   ; is_boot      <- tcIsHsBoot  -- Are we compiling an hs-boot file?
 665
 666         -- Check that we don't use GADT syntax in H98 world
 667   ; checkTc (gla_exts || h98_syntax) (badGadtDecl tc_name)
 668
 669         -- Check that we don't use kind signatures without Glasgow extensions
 670   ; checkTc (gla_exts || isNothing mb_ksig) (badSigTyDecl tc_name)
 671
 672         -- Check that the stupid theta is empty for a GADT-style declaration
 673   ; checkTc (null stupid_theta || h98_syntax) (badStupidTheta tc_name)
 674
 675         -- Check that there's at least one condecl,
 676         -- or else we're reading an hs-boot file, or -fglasgow-exts
 677   ; checkTc (not (null cons) || gla_exts || is_boot)
 678             (emptyConDeclsErr tc_name)
 679
 680         -- Check that a newtype has exactly one constructor
 681   ; checkTc (new_or_data == DataType || isSingleton cons)
 682             (newtypeConError tc_name (length cons))
 683
 684   ; tycon <- fixM (\ tycon -> do
 685         { data_cons <- mappM (addLocM (tcConDecl unbox_strict tycon final_tvs))
 686                              cons
 687         ; tc_rhs <-
 688             if null cons && is_boot     -- In a hs-boot file, empty cons means
 689             then return AbstractTyCon   -- "don't know"; hence Abstract
 690             else case new_or_data of
 691                    DataType -> return (mkDataTyConRhs data_cons)
 692                    NewType  ->
 693                        ASSERT( isSingleton data_cons )
 694                        mkNewTyConRhs tc_name tycon (head data_cons)
 695         ; buildAlgTyCon tc_name final_tvs stupid_theta tc_rhs is_rec
 696             (want_generic && canDoGenerics data_cons) h98_syntax Nothing
 697         })
 698   ; return [ATyCon tycon]
 699   }
 700   where
 701     is_rec   = calc_isrec tc_name
 702     h98_syntax = case cons of   -- All constructors have same shape
 703                         L _ (ConDecl { con_res = ResTyGADT _ }) : _ -> False
 704                         other -> True
 705
 706 tcTyClDecl1 calc_isrec
 707   (ClassDecl {tcdLName = L _ class_name, tcdTyVars = tvs,
 708               tcdCtxt = ctxt, tcdMeths = meths,
 709               tcdFDs = fundeps, tcdSigs = sigs, tcdATs = ats} )
 710   = tcTyVarBndrs tvs            $ \ tvs' -> do
 711   { ctxt' <- tcHsKindedContext ctxt
 712   ; fds' <- mappM (addLocM tc_fundep) fundeps
 713   ; atss <- mappM (addLocM (tcTyClDecl1 (const Recursive))) ats
 714   ; let ats' = zipWith setTyThingPoss atss (map (tcdTyVars . unLoc) ats)
 715   ; sig_stuff <- tcClassSigs class_name sigs meths
 716   ; clas <- fixM (\ clas ->
 717                 let     -- This little knot is just so we can get
 718                         -- hold of the name of the class TyCon, which we
 719                         -- need to look up its recursiveness
 720                     tycon_name = tyConName (classTyCon clas)
 721                     tc_isrec = calc_isrec tycon_name
 722                 in
 723                 buildClass class_name tvs' ctxt' fds' ats'
 724                            sig_stuff tc_isrec)
 725   ; return (AClass clas : ats')
 726       -- NB: Order is important due to the call to `mkGlobalThings' when
 727       --     tying the the type and class declaration type checking knot.
 728   }
 729   where
 730     tc_fundep (tvs1, tvs2) = do { tvs1' <- mappM tcLookupTyVar tvs1 ;
 731                                 ; tvs2' <- mappM tcLookupTyVar tvs2 ;
 732                                 ; return (tvs1', tvs2') }
 733
 734     -- For each AT argument compute the position of the corresponding class
 735     -- parameter in the class head.  This will later serve as a permutation
 736     -- vector when checking the validity of instance declarations.
 737     setTyThingPoss [ATyCon tycon] atTyVars =
 738       let classTyVars = hsLTyVarNames tvs
 739           poss        =   catMaybes
 740                         . map (`elemIndex` classTyVars)
 741                         . hsLTyVarNames
 742                         $ atTyVars
 743                      -- There will be no Nothing, as we already passed renaming
 744       in
 745       ATyCon (setTyConArgPoss tycon poss)
 746     setTyThingPoss _              _ = panic "TcTyClsDecls.setTyThingPoss"
 747
 748 tcTyClDecl1 calc_isrec
 749   (ForeignType {tcdLName = L _ tc_name, tcdExtName = tc_ext_name})
 750   = returnM [ATyCon (mkForeignTyCon tc_name tc_ext_name liftedTypeKind 0)]
 751
 752 -----------------------------------
 753 tcConDecl :: Bool               -- True <=> -funbox-strict_fields
 754           -> TyCon -> [TyVar]
 755           -> ConDecl Name
 756           -> TcM DataCon
 757
 758 tcConDecl unbox_strict tycon tc_tvs     -- Data types
 759           (ConDecl name _ tvs ctxt details res_ty _)
 760   = tcTyVarBndrs tvs            $ \ tvs' -> do
 761     { ctxt' <- tcHsKindedContext ctxt
 762     ; (univ_tvs, ex_tvs, eq_preds, data_tc) <- tcResultType tycon tc_tvs tvs' res_ty
 763     ; let
 764         -- Tiresome: tidy the tyvar binders, since tc_tvs and tvs' may have the same OccNames
 765         tc_datacon is_infix field_lbls btys
 766           = do { let bangs = map getBangStrictness btys
 767                ; arg_tys <- mappM tcHsBangType btys
 768                ; buildDataCon (unLoc name) is_infix
 769                     (argStrictness unbox_strict bangs arg_tys)
 770                     (map unLoc field_lbls)
 771                     univ_tvs ex_tvs eq_preds ctxt' arg_tys
 772                     data_tc }
 773                 -- NB:  we put data_tc, the type constructor gotten from the
 774                 --      constructor type signature into the data constructor;
 775                 --      that way checkValidDataCon can complain if it's wrong.
 776
 777     ; case details of
 778         PrefixCon btys     -> tc_datacon False [] btys
 779         InfixCon bty1 bty2 -> tc_datacon True  [] [bty1,bty2]
 780         RecCon fields      -> tc_datacon False field_names btys
 781                            where
 782                               (field_names, btys) = unzip [ (n, t) | HsRecField n t _ <- fields ]
 783
 784     }
 785
 786 tcResultType :: TyCon
 787              -> [TyVar]         -- data T a b c = ...
 788              -> [TyVar]         -- where MkT :: forall a b c. ...
 789              -> ResType Name
 790              -> TcM ([TyVar],           -- Universal
 791                      [TyVar],           -- Existential (distinct OccNames from univs)
 792                      [(TyVar,Type)],    -- Equality predicates
 793                      TyCon)             -- TyCon given in the ResTy
 794         -- We don't check that the TyCon given in the ResTy is
 795         -- the same as the parent tycon, becuase we are in the middle
 796         -- of a recursive knot; so it's postponed until checkValidDataCon
 797
 798 tcResultType decl_tycon tc_tvs dc_tvs ResTyH98
 799   = return (tc_tvs, dc_tvs, [], decl_tycon)
 800         -- In H98 syntax the dc_tvs are the existential ones
 801         --      data T a b c = forall d e. MkT ...
 802         -- The {a,b,c} are tc_tvs, and {d,e} are dc_tvs
 803
 804 tcResultType _ tc_tvs dc_tvs (ResTyGADT res_ty)
 805         -- E.g.  data T a b c where
 806         --         MkT :: forall x y z. T (x,y) z z
 807         -- Then we generate
 808         --      ([a,z,c], [x,y], [a:=:(x,y), c:=:z], T)
 809
 810   = do  { (dc_tycon, res_tys) <- tcLHsConResTy res_ty
 811
 812         ; let univ_tvs = choose_univs [] tidy_tc_tvs res_tys
 813                 -- Each univ_tv is either a dc_tv or a tc_tv
 814               ex_tvs = dc_tvs `minusList` univ_tvs
 815               eq_spec = [ (tv, ty) | (tv,ty) <- univ_tvs `zip` res_tys,
 816                                       tv `elem` tc_tvs]
 817         ; return (univ_tvs, ex_tvs, eq_spec, dc_tycon) }
 818   where
 819         -- choose_univs uses the res_ty itself if it's a type variable
 820         -- and hasn't already been used; otherwise it uses one of the tc_tvs
 821     choose_univs used tc_tvs []
 822         = ASSERT( null tc_tvs ) []
 823     choose_univs used (tc_tv:tc_tvs) (res_ty:res_tys)
 824         | Just tv <- tcGetTyVar_maybe res_ty, not (tv `elem` used)
 825         = tv    : choose_univs (tv:used) tc_tvs res_tys
 826         | otherwise
 827         = tc_tv : choose_univs used tc_tvs res_tys
 828
 829         -- NB: tc_tvs and dc_tvs are distinct, but
 830         -- we want them to be *visibly* distinct, both for
 831         -- interface files and general confusion.  So rename
 832         -- the tc_tvs, since they are not used yet (no
 833         -- consequential renaming needed)
 834     init_occ_env     = initTidyOccEnv (map getOccName dc_tvs)
 835     (_, tidy_tc_tvs) = mapAccumL tidy_one init_occ_env tc_tvs
 836     tidy_one env tv  = (env', setTyVarName tv (tidyNameOcc name occ'))
 837               where
 838                  name = tyVarName tv
 839                  (env', occ') = tidyOccName env (getOccName name)
 840
 841               -------------------
 842 argStrictness :: Bool           -- True <=> -funbox-strict_fields
 843               -> [HsBang]
 844               -> [TcType] -> [StrictnessMark]
 845 argStrictness unbox_strict bangs arg_tys
 846  = ASSERT( length bangs == length arg_tys )
 847    zipWith (chooseBoxingStrategy unbox_strict) arg_tys bangs
 848
 849 -- We attempt to unbox/unpack a strict field when either:
 850 --   (i)  The field is marked '!!', or
 851 --   (ii) The field is marked '!', and the -funbox-strict-fields flag is on.
 852 --
 853 -- We have turned off unboxing of newtypes because coercions make unboxing
 854 -- and reboxing more complicated
 855 chooseBoxingStrategy :: Bool -> TcType -> HsBang -> StrictnessMark
 856 chooseBoxingStrategy unbox_strict_fields arg_ty bang
 857   = case bang of
 858         HsNoBang                                    -> NotMarkedStrict
 859         HsStrict | unbox_strict_fields
 860                    && can_unbox arg_ty              -> MarkedUnboxed
 861         HsUnbox  | can_unbox arg_ty                 -> MarkedUnboxed
 862         other                                       -> MarkedStrict
 863   where
 864     -- we can unbox if the type is a chain of newtypes with a product tycon
 865     -- at the end
 866     can_unbox arg_ty = case splitTyConApp_maybe arg_ty of
 867                    Nothing                      -> False
 868                    Just (arg_tycon, tycon_args) ->
 869                        not (isRecursiveTyCon arg_tycon) &&      -- Note [Recusive unboxing]
 870                        isProductTyCon arg_tycon &&
 871                        (if isNewTyCon arg_tycon then
 872                             can_unbox (newTyConInstRhs arg_tycon tycon_args)
 873                         else True)
 874 \end{code}
 875
 876 Note [Recursive unboxing]
 877 ~~~~~~~~~~~~~~~~~~~~~~~~~
 878 Be careful not to try to unbox this!
 879         data T = MkT !T Int
 880 But it's the *argument* type that matters. This is fine:
 881         data S = MkS S !Int
 882 because Int is non-recursive.
 883
 884 %************************************************************************
 885 %*                                                                      *
 886 \subsection{Dependency analysis}
 887 %*                                                                      *
 888 %************************************************************************
 889
 890 Validity checking is done once the mutually-recursive knot has been
 891 tied, so we can look at things freely.
 892
 893 \begin{code}
 894 checkCycleErrs :: [LTyClDecl Name] -> TcM ()
 895 checkCycleErrs tyclss
 896   | null cls_cycles
 897   = return ()
 898   | otherwise
 899   = do  { mappM_ recClsErr cls_cycles
 900         ; failM }       -- Give up now, because later checkValidTyCl
 901                         -- will loop if the synonym is recursive
 902   where
 903     cls_cycles = calcClassCycles tyclss
 904
 905 checkValidTyCl :: TyClDecl Name -> TcM ()
 906 -- We do the validity check over declarations, rather than TyThings
 907 -- only so that we can add a nice context with tcAddDeclCtxt
 908 checkValidTyCl decl
 909   = tcAddDeclCtxt decl $
 910     do  { thing <- tcLookupLocatedGlobal (tcdLName decl)
 911         ; traceTc (text "Validity of" <+> ppr thing)
 912         ; case thing of
 913             ATyCon tc -> checkValidTyCon tc
 914             AClass cl -> checkValidClass cl
 915         ; traceTc (text "Done validity of" <+> ppr thing)
 916         }
 917
 918 -------------------------
 919 -- For data types declared with record syntax, we require
 920 -- that each constructor that has a field 'f'
 921 --      (a) has the same result type
 922 --      (b) has the same type for 'f'
 923 -- module alpha conversion of the quantified type variables
 924 -- of the constructor.
 925
 926 checkValidTyCon :: TyCon -> TcM ()
 927 checkValidTyCon tc
 928   | isSynTyCon tc
 929   = case synTyConRhs tc of
 930       OpenSynTyCon _ _ -> return ()
 931       SynonymTyCon ty  -> checkValidType syn_ctxt ty
 932   | otherwise
 933   =     -- Check the context on the data decl
 934     checkValidTheta (DataTyCtxt name) (tyConStupidTheta tc)     `thenM_`
 935
 936         -- Check arg types of data constructors
 937     mappM_ (checkValidDataCon tc) data_cons                     `thenM_`
 938
 939         -- Check that fields with the same name share a type
 940     mappM_ check_fields groups
 941
 942   where
 943     syn_ctxt  = TySynCtxt name
 944     name      = tyConName tc
 945     data_cons = tyConDataCons tc
 946
 947     groups = equivClasses cmp_fld (concatMap get_fields data_cons)
 948     cmp_fld (f1,_) (f2,_) = f1 `compare` f2
 949     get_fields con = dataConFieldLabels con `zip` repeat con
 950         -- dataConFieldLabels may return the empty list, which is fine
 951
 952     -- See Note [GADT record selectors] in MkId.lhs
 953     -- We must check (a) that the named field has the same
 954     --                   type in each constructor
 955     --               (b) that those constructors have the same result type
 956     --
 957     -- However, the constructors may have differently named type variable
 958     -- and (worse) we don't know how the correspond to each other.  E.g.
 959     --     C1 :: forall a b. { f :: a, g :: b } -> T a b
 960     --     C2 :: forall d c. { f :: c, g :: c } -> T c d
 961     --
 962     -- So what we do is to ust Unify.tcMatchTys to compare the first candidate's
 963     -- result type against other candidates' types BOTH WAYS ROUND.
 964     -- If they magically agrees, take the substitution and
 965     -- apply them to the latter ones, and see if they match perfectly.
 966     check_fields fields@((label, con1) : other_fields)
 967         -- These fields all have the same name, but are from
 968         -- different constructors in the data type
 969         = recoverM (return ()) $ mapM_ checkOne other_fields
 970                 -- Check that all the fields in the group have the same type
 971                 -- NB: this check assumes that all the constructors of a given
 972                 -- data type use the same type variables
 973         where
 974         (tvs1, _, _, res1) = dataConSig con1
 975         ts1 = mkVarSet tvs1
 976         fty1 = dataConFieldType con1 label
 977
 978         checkOne (_, con2)    -- Do it bothways to ensure they are structurally identical
 979             = do { checkFieldCompat label con1 con2 ts1 res1 res2 fty1 fty2
 980                  ; checkFieldCompat label con2 con1 ts2 res2 res1 fty2 fty1 }
 981             where
 982                 (tvs2, _, _, res2) = dataConSig con2
 983                 ts2 = mkVarSet tvs2
 984                 fty2 = dataConFieldType con2 label
 985
 986 checkFieldCompat fld con1 con2 tvs1 res1 res2 fty1 fty2
 987   = do  { checkTc (isJust mb_subst1) (resultTypeMisMatch fld con1 con2)
 988         ; checkTc (isJust mb_subst2) (fieldTypeMisMatch fld con1 con2) }
 989   where
 990     mb_subst1 = tcMatchTy tvs1 res1 res2
 991     mb_subst2 = tcMatchTyX tvs1 (expectJust "checkFieldCompat" mb_subst1) fty1 fty2
 992
 993 -------------------------------
 994 checkValidDataCon :: TyCon -> DataCon -> TcM ()
 995 checkValidDataCon tc con
 996   = setSrcSpan (srcLocSpan (getSrcLoc con))     $
 997     addErrCtxt (dataConCtxt con)                $
 998     do  { checkTc (dataConTyCon con == tc) (badDataConTyCon con)
 999         ; checkValidType ctxt (dataConUserType con)
1000         ; ifM (isNewTyCon tc) (checkNewDataCon con)
1001     }
1002   where
1003     ctxt = ConArgCtxt (dataConName con)
1004
1005 -------------------------------
1006 checkNewDataCon :: DataCon -> TcM ()
1007 -- Checks for the data constructor of a newtype
1008 checkNewDataCon con
1009   = do  { checkTc (isSingleton arg_tys) (newtypeFieldErr con (length arg_tys))
1010                 -- One argument
1011         ; checkTc (null eq_spec) (newtypePredError con)
1012                 -- Return type is (T a b c)
1013         ; checkTc (null ex_tvs && null theta) (newtypeExError con)
1014                 -- No existentials
1015     }
1016   where
1017     (_univ_tvs, ex_tvs, eq_spec, theta, arg_tys, _res_ty) = dataConFullSig con
1018
1019 -------------------------------
1020 checkValidClass :: Class -> TcM ()
1021 checkValidClass cls
1022   = do  {       -- CHECK ARITY 1 FOR HASKELL 1.4
1023           gla_exts <- doptM Opt_GlasgowExts
1024
1025         -- Check that the class is unary, unless GlaExs
1026         ; checkTc (notNull tyvars) (nullaryClassErr cls)
1027         ; checkTc (gla_exts || unary) (classArityErr cls)
1028
1029         -- Check the super-classes
1030         ; checkValidTheta (ClassSCCtxt (className cls)) theta
1031
1032         -- Check the class operations
1033         ; mappM_ (check_op gla_exts) op_stuff
1034
1035         -- Check that if the class has generic methods, then the
1036         -- class has only one parameter.  We can't do generic
1037         -- multi-parameter type classes!
1038         ; checkTc (unary || no_generics) (genericMultiParamErr cls)
1039         }
1040   where
1041     (tyvars, theta, _, op_stuff) = classBigSig cls
1042     unary       = isSingleton tyvars
1043     no_generics = null [() | (_, GenDefMeth) <- op_stuff]
1044
1045     check_op gla_exts (sel_id, dm)
1046       = addErrCtxt (classOpCtxt sel_id tau) $ do
1047         { checkValidTheta SigmaCtxt (tail theta)
1048                 -- The 'tail' removes the initial (C a) from the
1049                 -- class itself, leaving just the method type
1050
1051         ; checkValidType (FunSigCtxt op_name) tau
1052
1053                 -- Check that the type mentions at least one of
1054                 -- the class type variables...or at least one reachable
1055                 -- from one of the class variables.  Example: tc223
1056                 --   class Error e => Game b mv e | b -> mv e where
1057                 --      newBoard :: MonadState b m => m ()
1058                 -- Here, MonadState has a fundep m->b, so newBoard is fine
1059         ; let grown_tyvars = grow theta (mkVarSet tyvars)
1060         ; checkTc (tyVarsOfType tau `intersectsVarSet` grown_tyvars)
1061                   (noClassTyVarErr cls sel_id)
1062
1063                 -- Check that for a generic method, the type of
1064                 -- the method is sufficiently simple
1065         ; checkTc (dm /= GenDefMeth || validGenericMethodType tau)
1066                   (badGenericMethodType op_name op_ty)
1067         }
1068         where
1069           op_name = idName sel_id
1070           op_ty   = idType sel_id
1071           (_,theta1,tau1) = tcSplitSigmaTy op_ty
1072           (_,theta2,tau2)  = tcSplitSigmaTy tau1
1073           (theta,tau) | gla_exts  = (theta1 ++ theta2, tau2)
1074                       | otherwise = (theta1,           mkPhiTy (tail theta1) tau1)
1075                 -- Ugh!  The function might have a type like
1076                 --      op :: forall a. C a => forall b. (Eq b, Eq a) => tau2
1077                 -- With -fglasgow-exts, we want to allow this, even though the inner
1078                 -- forall has an (Eq a) constraint.  Whereas in general, each constraint
1079                 -- in the context of a for-all must mention at least one quantified
1080                 -- type variable.  What a mess!
1081
1082
1083 ---------------------------------------------------------------------
1084 resultTypeMisMatch field_name con1 con2
1085   = vcat [sep [ptext SLIT("Constructors") <+> ppr con1 <+> ptext SLIT("and") <+> ppr con2,
1086                 ptext SLIT("have a common field") <+> quotes (ppr field_name) <> comma],
1087           nest 2 $ ptext SLIT("but have different result types")]
1088 fieldTypeMisMatch field_name con1 con2
1089   = sep [ptext SLIT("Constructors") <+> ppr con1 <+> ptext SLIT("and") <+> ppr con2,
1090          ptext SLIT("give different types for field"), quotes (ppr field_name)]
1091
1092 dataConCtxt con = ptext SLIT("In the definition of data constructor") <+> quotes (ppr con)
1093
1094 classOpCtxt sel_id tau = sep [ptext SLIT("When checking the class method:"),
1095                               nest 2 (ppr sel_id <+> dcolon <+> ppr tau)]
1096
1097 nullaryClassErr cls
1098   = ptext SLIT("No parameters for class")  <+> quotes (ppr cls)
1099
1100 classArityErr cls
1101   = vcat [ptext SLIT("Too many parameters for class") <+> quotes (ppr cls),
1102           parens (ptext SLIT("Use -fglasgow-exts to allow multi-parameter classes"))]
1103
1104 noClassTyVarErr clas op
1105   = sep [ptext SLIT("The class method") <+> quotes (ppr op),
1106          ptext SLIT("mentions none of the type variables of the class") <+>
1107                 ppr clas <+> hsep (map ppr (classTyVars clas))]
1108
1109 genericMultiParamErr clas
1110   = ptext SLIT("The multi-parameter class") <+> quotes (ppr clas) <+>
1111     ptext SLIT("cannot have generic methods")
1112
1113 badGenericMethodType op op_ty
1114   = hang (ptext SLIT("Generic method type is too complex"))
1115        4 (vcat [ppr op <+> dcolon <+> ppr op_ty,
1116                 ptext SLIT("You can only use type variables, arrows, lists, and tuples")])
1117
1118 recSynErr syn_decls
1119   = setSrcSpan (getLoc (head sorted_decls)) $
1120     addErr (sep [ptext SLIT("Cycle in type synonym declarations:"),
1121                  nest 2 (vcat (map ppr_decl sorted_decls))])
1122   where
1123     sorted_decls = sortLocated syn_decls
1124     ppr_decl (L loc decl) = ppr loc <> colon <+> ppr decl
1125
1126 recClsErr cls_decls
1127   = setSrcSpan (getLoc (head sorted_decls)) $
1128     addErr (sep [ptext SLIT("Cycle in class declarations (via superclasses):"),
1129                  nest 2 (vcat (map ppr_decl sorted_decls))])
1130   where
1131     sorted_decls = sortLocated cls_decls
1132     ppr_decl (L loc decl) = ppr loc <> colon <+> ppr (decl { tcdSigs = [] })
1133
1134 sortLocated :: [Located a] -> [Located a]
1135 sortLocated things = sortLe le things
1136   where
1137     le (L l1 _) (L l2 _) = l1 <= l2
1138
1139 badDataConTyCon data_con
1140   = hang (ptext SLIT("Data constructor") <+> quotes (ppr data_con) <+>
1141                 ptext SLIT("returns type") <+> quotes (ppr (dataConTyCon data_con)))
1142        2 (ptext SLIT("instead of its parent type"))
1143
1144 badGadtDecl tc_name
1145   = vcat [ ptext SLIT("Illegal generalised algebraic data declaration for") <+> quotes (ppr tc_name)
1146          , nest 2 (parens $ ptext SLIT("Use -fglasgow-exts to allow GADTs")) ]
1147
1148 badStupidTheta tc_name
1149   = ptext SLIT("A data type declared in GADT style cannot have a context:") <+> quotes (ppr tc_name)
1150
1151 newtypeConError tycon n
1152   = sep [ptext SLIT("A newtype must have exactly one constructor,"),
1153          nest 2 $ ptext SLIT("but") <+> quotes (ppr tycon) <+> ptext SLIT("has") <+> speakN n ]
1154
1155 newtypeExError con
1156   = sep [ptext SLIT("A newtype constructor cannot have an existential context,"),
1157          nest 2 $ ptext SLIT("but") <+> quotes (ppr con) <+> ptext SLIT("does")]
1158
1159 newtypePredError con
1160   = sep [ptext SLIT("A newtype constructor must have a return type of form T a1 ... an"),
1161          nest 2 $ ptext SLIT("but") <+> quotes (ppr con) <+> ptext SLIT("does not")]
1162
1163 newtypeFieldErr con_name n_flds
1164   = sep [ptext SLIT("The constructor of a newtype must have exactly one field"),
1165          nest 2 $ ptext SLIT("but") <+> quotes (ppr con_name) <+> ptext SLIT("has") <+> speakN n_flds]
1166
1167 badSigTyDecl tc_name
1168   = vcat [ ptext SLIT("Illegal kind signature") <+>
1169            quotes (ppr tc_name)
1170          , nest 2 (parens $ ptext SLIT("Use -fglasgow-exts to allow kind signatures")) ]
1171
1172 badFamInstDecl tc_name
1173   = vcat [ ptext SLIT("Illegal family instance for") <+>
1174            quotes (ppr tc_name)
1175          , nest 2 (parens $ ptext SLIT("Use -findexed-types to allow indexed type families")) ]
1176
1177 badGadtIdxTyDecl tc_name
1178   = vcat [ ptext SLIT("Illegal generalised algebraic data declaration for") <+>
1179            quotes (ppr tc_name)
1180          , nest 2 (parens $ ptext SLIT("Family instances can not yet use GADT declarations")) ]
1181
1182 tooManyParmsErr tc_name
1183   = ptext SLIT("Family instance has too many parameters:") <+>
1184     quotes (ppr tc_name)
1185
1186 tooFewParmsErr tc_name
1187   = ptext SLIT("Family instance has too few parameters:") <+>
1188     quotes (ppr tc_name)
1189
1190 badBootFamInstDeclErr =
1191   ptext SLIT("Illegal family instance in hs-boot file")
1192
1193 wrongKindOfFamily family =
1194   ptext SLIT("Wrong category of family instance; declaration was for a") <+>
1195   kindOfFamily
1196   where
1197     kindOfFamily | isSynTyCon  family = ptext SLIT("type synonym")
1198                  | isDataTyCon family = ptext SLIT("data type")
1199                  | isNewTyCon  family = ptext SLIT("newtype")
1200                  | otherwise = pprPanic "wrongKindOfFamily" (ppr family)
1201
1202 emptyConDeclsErr tycon
1203   = sep [quotes (ppr tycon) <+> ptext SLIT("has no constructors"),
1204          nest 2 $ ptext SLIT("(-fglasgow-exts permits this)")]
1205 \end{code}