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
  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 type families; 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 -ftype-families and can't be in an
 243          -- hs-boot file
 244        ; type_families <- doptM Opt_TypeFamilies
 245        ; is_boot  <- tcIsHsBoot   -- Are we compiling an hs-boot file?
 246        ; checkTc type_families $ 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) check that
 271          --     - left-hand side contains no type family applications
 272          --       (vanilla synonyms are fine, though)
 273        ; mappM_ checkTyFamFreeness t_typats
 274
 275          --     - the right-hand side is a tau type
 276        ; unless (isTauTy t_rhs) $
 277            addErr (polyTyErr t_rhs)
 278
 279          -- (4) construct representation tycon
 280        ; rep_tc_name <- newFamInstTyConName tc_name loc
 281        ; tycon <- buildSynTyCon rep_tc_name t_tvs (SynonymTyCon t_rhs)
 282                                 (Just (family, t_typats))
 283
 284        ; return $ Just (ATyCon tycon)
 285        }}
 286
 287   -- "newtype instance" and "data instance"
 288 tcFamInstDecl1 (decl@TyData {tcdND = new_or_data, tcdLName = L loc tc_name,
 289                              tcdCons = cons})
 290   = kcIdxTyPats decl $ \k_tvs k_typats resKind family ->
 291     do { -- check that the family declaration is for the right kind
 292          unless (isAlgTyCon family) $
 293            addErr (wrongKindOfFamily family)
 294
 295        ; -- (1) kind check the data declaration as usual
 296        ; k_decl <- kcDataDecl decl k_tvs
 297        ; let k_ctxt = tcdCtxt k_decl
 298              k_cons = tcdCons k_decl
 299
 300          -- result kind must be '*' (otherwise, we have too few patterns)
 301        ; checkTc (isLiftedTypeKind resKind) $ tooFewParmsErr tc_name
 302
 303          -- (2) type check indexed data type declaration
 304        ; tcTyVarBndrs k_tvs $ \t_tvs -> do {  -- turn kinded into proper tyvars
 305        ; unbox_strict <- doptM Opt_UnboxStrictFields
 306
 307          -- kind check the type indexes and the context
 308        ; t_typats     <- mappM tcHsKindedType k_typats
 309        ; stupid_theta <- tcHsKindedContext k_ctxt
 310
 311          -- (3) Check that
 312          --     - left-hand side contains no type family applications
 313          --       (vanilla synonyms are fine, though)
 314        ; mappM_ checkTyFamFreeness t_typats
 315
 316          --     - we don't use GADT syntax for indexed types
 317        ; checkTc h98_syntax (badGadtIdxTyDecl tc_name)
 318
 319          --     - a newtype has exactly one constructor
 320        ; checkTc (new_or_data == DataType || isSingleton k_cons) $
 321            newtypeConError tc_name (length k_cons)
 322
 323          -- (4) construct representation tycon
 324        ; rep_tc_name <- newFamInstTyConName tc_name loc
 325        ; tycon <- fixM (\ tycon -> do
 326              { data_cons <- mappM (addLocM (tcConDecl unbox_strict tycon t_tvs))
 327                                   k_cons
 328              ; tc_rhs <-
 329                  case new_or_data of
 330                    DataType -> return (mkDataTyConRhs data_cons)
 331                    NewType  -> ASSERT( isSingleton data_cons )
 332                                mkNewTyConRhs rep_tc_name tycon (head data_cons)
 333              ; buildAlgTyCon rep_tc_name t_tvs stupid_theta tc_rhs Recursive
 334                              False h98_syntax (Just (family, t_typats))
 335                  -- We always assume that indexed types are recursive.  Why?
 336                  -- (1) Due to their open nature, we can never be sure that a
 337                  -- further instance might not introduce a new recursive
 338                  -- dependency.  (2) They are always valid loop breakers as
 339                  -- they involve a coercion.
 340              })
 341
 342          -- construct result
 343        ; return $ Just (ATyCon tycon)
 344        }}
 345        where
 346          h98_syntax = case cons of      -- All constructors have same shape
 347                         L _ (ConDecl { con_res = ResTyGADT _ }) : _ -> False
 348                         other -> True
 349
 350 -- Check that a type index does not contain any type family applications
 351 --
 352 -- * Earlier phases have already checked that there are no foralls in the
 353 --   type; we also cannot have PredTys and NoteTys are being skipped by using
 354 --   the core view.
 355 --
 356 checkTyFamFreeness :: Type -> TcM ()
 357 checkTyFamFreeness ty | Just (tycon, tys) <- splitTyConApp_maybe ty
 358                       = if isSynTyCon tycon
 359                         then addErr $ tyFamAppInIndexErr ty
 360                         else mappM_ checkTyFamFreeness tys
 361                           -- splitTyConApp_maybe uses the core view; hence,
 362                           -- any synonym tycon must be a family tycon
 363
 364                       | Just (ty1, ty2) <- splitAppTy_maybe ty
 365                       = checkTyFamFreeness ty1 >> checkTyFamFreeness ty2
 366
 367                       | otherwise          -- only vars remaining
 368                       = return ()
 369
 370
 371 -- Kind checking of indexed types
 372 -- -
 373
 374 -- Kind check type patterns and kind annotate the embedded type variables.
 375 --
 376 -- * Here we check that a type instance matches its kind signature, but we do
 377 --   not check whether there is a pattern for each type index; the latter
 378 --   check is only required for type synonym instances.
 379 --
 380 kcIdxTyPats :: TyClDecl Name
 381             -> ([LHsTyVarBndr Name] -> [LHsType Name] -> Kind -> TyCon -> TcM a)
 382                -- ^^kinded tvs         ^^kinded ty pats  ^^res kind
 383             -> TcM a
 384 kcIdxTyPats decl thing_inside
 385   = kcHsTyVars (tcdTyVars decl) $ \tvs ->
 386     do { family <- tcLookupLocatedTyCon (tcdLName decl)
 387        ; let { (kinds, resKind) = splitKindFunTys (tyConKind family)
 388              ; hs_typats        = fromJust $ tcdTyPats decl }
 389
 390          -- we may not have more parameters than the kind indicates
 391        ; checkTc (length kinds >= length hs_typats) $
 392            tooManyParmsErr (tcdLName decl)
 393
 394          -- type functions can have a higher-kinded result
 395        ; let resultKind = mkArrowKinds (drop (length hs_typats) kinds) resKind
 396        ; typats <- TcRnMonad.zipWithM kcCheckHsType hs_typats kinds
 397        ; thing_inside tvs typats resultKind family
 398        }
 399   where
 400 \end{code}
 401
 402
 403 %************************************************************************
 404 %*                                                                      *
 405                 Kind checking
 406 %*                                                                      *
 407 %************************************************************************
 408
 409 We need to kind check all types in the mutually recursive group
 410 before we know the kind of the type variables.  For example:
 411
 412 class C a where
 413    op :: D b => a -> b -> b
 414
 415 class D c where
 416    bop :: (Monad c) => ...
 417
 418 Here, the kind of the locally-polymorphic type variable "b"
 419 depends on *all the uses of class D*.  For example, the use of
 420 Monad c in bop's type signature means that D must have kind Type->Type.
 421
 422 However type synonyms work differently.  They can have kinds which don't
 423 just involve (->) and *:
 424         type R = Int#           -- Kind #
 425         type S a = Array# a     -- Kind * -> #
 426         type T a b = (# a,b #)  -- Kind * -> * -> (# a,b #)
 427 So we must infer their kinds from their right-hand sides *first* and then
 428 use them, whereas for the mutually recursive data types D we bring into
 429 scope kind bindings D -> k, where k is a kind variable, and do inference.
 430
 431 Type families
 432 ~~~~~~~~~~~~~
 433 This treatment of type synonyms only applies to Haskell 98-style synonyms.
 434 General type functions can be recursive, and hence, appear in `alg_decls'.
 435
 436 The kind of a type family is solely determinded by its kind signature;
 437 hence, only kind signatures participate in the construction of the initial
 438 kind environment (as constructed by `getInitialKind').  In fact, we ignore
 439 instances of families altogether in the following.  However, we need to
 440 include the kinds of associated families into the construction of the
 441 initial kind environment.  (This is handled by `allDecls').
 442
 443 \begin{code}
 444 kcTyClDecls syn_decls alg_decls
 445   = do  {       -- First extend the kind env with each data type, class, and
 446                 -- indexed type, mapping them to a type variable
 447           let initialKindDecls = concat [allDecls decl | L _ decl <- alg_decls]
 448         ; alg_kinds <- mappM getInitialKind initialKindDecls
 449         ; tcExtendKindEnv alg_kinds $ do
 450
 451                 -- Now kind-check the type synonyms, in dependency order
 452                 -- We do these differently to data type and classes,
 453                 -- because a type synonym can be an unboxed type
 454                 --      type Foo = Int#
 455                 -- and a kind variable can't unify with UnboxedTypeKind
 456                 -- So we infer their kinds in dependency order
 457         { (kc_syn_decls, syn_kinds) <- kcSynDecls (calcSynCycles syn_decls)
 458         ; tcExtendKindEnv syn_kinds $  do
 459
 460                 -- Now kind-check the data type, class, and kind signatures,
 461                 -- returning kind-annotated decls; we don't kind-check
 462                 -- instances of indexed types yet, but leave this to
 463                 -- `tcInstDecls1'
 464         { kc_alg_decls <- mappM (wrapLocM kcTyClDecl)
 465                             (filter (not . isFamInstDecl . unLoc) alg_decls)
 466
 467         ; return (kc_syn_decls, kc_alg_decls) }}}
 468   where
 469     -- get all declarations relevant for determining the initial kind
 470     -- environment
 471     allDecls (decl@ClassDecl {tcdATs = ats}) = decl : [ at
 472                                                       | L _ at <- ats
 473                                                       , isFamilyDecl at]
 474     allDecls decl | isFamInstDecl decl = []
 475                   | otherwise          = [decl]
 476
 477 ------------------------------------------------------------------------
 478 getInitialKind :: TyClDecl Name -> TcM (Name, TcKind)
 479 -- Only for data type, class, and indexed type declarations
 480 -- Get as much info as possible from the data, class, or indexed type decl,
 481 -- so as to maximise usefulness of error messages
 482 getInitialKind decl
 483   = do  { arg_kinds <- mapM (mk_arg_kind . unLoc) (tyClDeclTyVars decl)
 484         ; res_kind  <- mk_res_kind decl
 485         ; return (tcdName decl, mkArrowKinds arg_kinds res_kind) }
 486   where
 487     mk_arg_kind (UserTyVar _)        = newKindVar
 488     mk_arg_kind (KindedTyVar _ kind) = return kind
 489
 490     mk_res_kind (TyFamily { tcdKind    = Just kind }) = return kind
 491     mk_res_kind (TyData   { tcdKindSig = Just kind }) = return kind
 492         -- On GADT-style declarations we allow a kind signature
 493         --      data T :: *->* where { ... }
 494     mk_res_kind other = return liftedTypeKind
 495
 496
 497 ----------------
 498 kcSynDecls :: [SCC (LTyClDecl Name)]
 499            -> TcM ([LTyClDecl Name],    -- Kind-annotated decls
 500                    [(Name,TcKind)])     -- Kind bindings
 501 kcSynDecls []
 502   = return ([], [])
 503 kcSynDecls (group : groups)
 504   = do  { (decl,  nk)  <- kcSynDecl group
 505         ; (decls, nks) <- tcExtendKindEnv [nk] (kcSynDecls groups)
 506         ; return (decl:decls, nk:nks) }
 507
 508 ----------------
 509 kcSynDecl :: SCC (LTyClDecl Name)
 510            -> TcM (LTyClDecl Name,      -- Kind-annotated decls
 511                    (Name,TcKind))       -- Kind bindings
 512 kcSynDecl (AcyclicSCC ldecl@(L loc decl))
 513   = tcAddDeclCtxt decl  $
 514     kcHsTyVars (tcdTyVars decl) (\ k_tvs ->
 515     do { traceTc (text "kcd1" <+> ppr (unLoc (tcdLName decl)) <+> brackets (ppr (tcdTyVars decl))
 516                         <+> brackets (ppr k_tvs))
 517        ; (k_rhs, rhs_kind) <- kcHsType (tcdSynRhs decl)
 518        ; traceTc (text "kcd2" <+> ppr (unLoc (tcdLName decl)))
 519        ; let tc_kind = foldr (mkArrowKind . kindedTyVarKind) rhs_kind k_tvs
 520        ; return (L loc (decl { tcdTyVars = k_tvs, tcdSynRhs = k_rhs }),
 521                  (unLoc (tcdLName decl), tc_kind)) })
 522
 523 kcSynDecl (CyclicSCC decls)
 524   = do { recSynErr decls; failM }       -- Fail here to avoid error cascade
 525                                         -- of out-of-scope tycons
 526
 527 kindedTyVarKind (L _ (KindedTyVar _ k)) = k
 528
 529 ------------------------------------------------------------------------
 530 kcTyClDecl :: TyClDecl Name -> TcM (TyClDecl Name)
 531         -- Not used for type synonyms (see kcSynDecl)
 532
 533 kcTyClDecl decl@(TyData {})
 534   = ASSERT( not . isFamInstDecl $ decl )   -- must not be a family instance
 535     kcTyClDeclBody decl $
 536       kcDataDecl decl
 537
 538 kcTyClDecl decl@(TyFamily {tcdKind = kind})
 539   = kcTyClDeclBody decl $ \ tvs' ->
 540       return (decl {tcdTyVars = tvs',
 541                     tcdKind = kind `mplus` Just liftedTypeKind})
 542                     -- default result kind is '*'
 543
 544 kcTyClDecl decl@(ClassDecl {tcdCtxt = ctxt, tcdSigs = sigs, tcdATs = ats})
 545   = kcTyClDeclBody decl $ \ tvs' ->
 546     do  { is_boot <- tcIsHsBoot
 547         ; ctxt' <- kcHsContext ctxt
 548         ; ats'  <- mappM (wrapLocM kcTyClDecl) ats
 549         ; sigs' <- mappM (wrapLocM kc_sig    ) sigs
 550         ; return (decl {tcdTyVars = tvs', tcdCtxt = ctxt', tcdSigs = sigs',
 551                         tcdATs = ats'}) }
 552   where
 553     kc_sig (TypeSig nm op_ty) = do { op_ty' <- kcHsLiftedSigType op_ty
 554                                    ; return (TypeSig nm op_ty') }
 555     kc_sig other_sig          = return other_sig
 556
 557 kcTyClDecl decl@(ForeignType {})
 558   = return decl
 559
 560 kcTyClDeclBody :: TyClDecl Name
 561                -> ([LHsTyVarBndr Name] -> TcM a)
 562                -> TcM a
 563 -- getInitialKind has made a suitably-shaped kind for the type or class
 564 -- Unpack it, and attribute those kinds to the type variables
 565 -- Extend the env with bindings for the tyvars, taken from
 566 -- the kind of the tycon/class.  Give it to the thing inside, and
 567 -- check the result kind matches
 568 kcTyClDeclBody decl thing_inside
 569   = tcAddDeclCtxt decl          $
 570     do  { tc_ty_thing <- tcLookupLocated (tcdLName decl)
 571         ; let tc_kind    = case tc_ty_thing of { AThing k -> k }
 572               (kinds, _) = splitKindFunTys tc_kind
 573               hs_tvs     = tcdTyVars decl
 574               kinded_tvs = ASSERT( length kinds >= length hs_tvs )
 575                            [ L loc (KindedTyVar (hsTyVarName tv) k)
 576                            | (L loc tv, k) <- zip hs_tvs kinds]
 577         ; tcExtendKindEnvTvs kinded_tvs (thing_inside kinded_tvs) }
 578
 579 -- Kind check a data declaration, assuming that we already extended the
 580 -- kind environment with the type variables of the left-hand side (these
 581 -- kinded type variables are also passed as the second parameter).
 582 --
 583 kcDataDecl :: TyClDecl Name -> [LHsTyVarBndr Name] -> TcM (TyClDecl Name)
 584 kcDataDecl decl@(TyData {tcdND = new_or_data, tcdCtxt = ctxt, tcdCons = cons})
 585            tvs
 586   = do  { ctxt' <- kcHsContext ctxt
 587         ; cons' <- mappM (wrapLocM kc_con_decl) cons
 588         ; return (decl {tcdTyVars = tvs, tcdCtxt = ctxt', tcdCons = cons'}) }
 589   where
 590     -- doc comments are typechecked to Nothing here
 591     kc_con_decl (ConDecl name expl ex_tvs ex_ctxt details res _) = do
 592       kcHsTyVars ex_tvs $ \ex_tvs' -> do
 593         ex_ctxt' <- kcHsContext ex_ctxt
 594         details' <- kc_con_details details
 595         res'     <- case res of
 596           ResTyH98 -> return ResTyH98
 597           ResTyGADT ty -> do { ty' <- kcHsSigType ty; return (ResTyGADT ty') }
 598         return (ConDecl name expl ex_tvs' ex_ctxt' details' res' Nothing)
 599
 600     kc_con_details (PrefixCon btys)
 601         = do { btys' <- mappM kc_larg_ty btys ; return (PrefixCon btys') }
 602     kc_con_details (InfixCon bty1 bty2)
 603         = do { bty1' <- kc_larg_ty bty1; bty2' <- kc_larg_ty bty2; return (InfixCon bty1' bty2') }
 604     kc_con_details (RecCon fields)
 605         = do { fields' <- mappM kc_field fields; return (RecCon fields') }
 606
 607     kc_field (ConDeclField fld bty d) = do { bty' <- kc_larg_ty bty
 608                                            ; return (ConDeclField fld bty' d) }
 609
 610     kc_larg_ty bty = case new_or_data of
 611                         DataType -> kcHsSigType bty
 612                         NewType  -> kcHsLiftedSigType bty
 613         -- Can't allow an unlifted type for newtypes, because we're effectively
 614         -- going to remove the constructor while coercing it to a lifted type.
 615         -- And newtypes can't be bang'd
 616 \end{code}
 617
 618
 619 %************************************************************************
 620 %*                                                                      *
 621 \subsection{Type checking}
 622 %*                                                                      *
 623 %************************************************************************
 624
 625 \begin{code}
 626 tcSynDecls :: [LTyClDecl Name] -> TcM [TyThing]
 627 tcSynDecls [] = return []
 628 tcSynDecls (decl : decls)
 629   = do { syn_tc <- addLocM tcSynDecl decl
 630        ; syn_tcs <- tcExtendGlobalEnv [syn_tc] (tcSynDecls decls)
 631        ; return (syn_tc : syn_tcs) }
 632
 633   -- "type"
 634 tcSynDecl
 635   (TySynonym {tcdLName = L _ tc_name, tcdTyVars = tvs, tcdSynRhs = rhs_ty})
 636   = tcTyVarBndrs tvs            $ \ tvs' -> do
 637     { traceTc (text "tcd1" <+> ppr tc_name)
 638     ; rhs_ty' <- tcHsKindedType rhs_ty
 639     ; tycon <- buildSynTyCon tc_name tvs' (SynonymTyCon rhs_ty') Nothing
 640     ; return (ATyCon tycon)
 641     }
 642
 643 --------------------
 644 tcTyClDecl :: (Name -> RecFlag) -> TyClDecl Name -> TcM [TyThing]
 645
 646 tcTyClDecl calc_isrec decl
 647   = tcAddDeclCtxt decl (tcTyClDecl1 calc_isrec decl)
 648
 649   -- "type family" declarations
 650 tcTyClDecl1 _calc_isrec
 651   (TyFamily {tcdFlavour = TypeFamily,
 652              tcdLName = L _ tc_name, tcdTyVars = tvs, tcdKind = Just kind})
 653                                                       -- NB: kind at latest
 654                                                       --     added during
 655                                                       --     kind checking
 656   = tcTyVarBndrs tvs  $ \ tvs' -> do
 657   { traceTc (text "type family: " <+> ppr tc_name)
 658   ; idx_tys <- doptM Opt_TypeFamilies
 659
 660         -- Check that we don't use families without -ftype-families
 661   ; checkTc idx_tys $ badFamInstDecl tc_name
 662
 663   ; tycon <- buildSynTyCon tc_name tvs' (OpenSynTyCon kind Nothing) Nothing
 664   ; return [ATyCon tycon]
 665   }
 666
 667   -- "newtype family" or "data family" declaration
 668 tcTyClDecl1 _calc_isrec
 669   (TyFamily {tcdFlavour = DataFamily,
 670              tcdLName = L _ tc_name, tcdTyVars = tvs, tcdKind = mb_kind})
 671   = tcTyVarBndrs tvs  $ \ tvs' -> do
 672   { traceTc (text "data family: " <+> ppr tc_name)
 673   ; extra_tvs <- tcDataKindSig mb_kind
 674   ; let final_tvs = tvs' ++ extra_tvs    -- we may not need these
 675
 676   ; idx_tys <- doptM Opt_TypeFamilies
 677
 678         -- Check that we don't use families without -ftype-families
 679   ; checkTc idx_tys $ badFamInstDecl tc_name
 680
 681   ; tycon <- buildAlgTyCon tc_name final_tvs []
 682                mkOpenDataTyConRhs Recursive False True Nothing
 683   ; return [ATyCon tycon]
 684   }
 685
 686   -- "newtype" and "data"
 687 tcTyClDecl1 calc_isrec
 688   (TyData {tcdND = new_or_data, tcdCtxt = ctxt, tcdTyVars = tvs,
 689            tcdLName = L _ tc_name, tcdKindSig = mb_ksig, tcdCons = cons})
 690   = tcTyVarBndrs tvs    $ \ tvs' -> do
 691   { extra_tvs <- tcDataKindSig mb_ksig
 692   ; let final_tvs = tvs' ++ extra_tvs
 693   ; stupid_theta <- tcHsKindedContext ctxt
 694   ; want_generic <- doptM Opt_Generics
 695   ; unbox_strict <- doptM Opt_UnboxStrictFields
 696   ; empty_data_decls <- doptM Opt_EmptyDataDecls
 697   ; kind_signatures <- doptM Opt_KindSignatures
 698   ; gadt_ok      <- doptM Opt_GADTs
 699   ; is_boot      <- tcIsHsBoot  -- Are we compiling an hs-boot file?
 700
 701         -- Check that we don't use GADT syntax in H98 world
 702   ; checkTc (gadt_ok || h98_syntax) (badGadtDecl tc_name)
 703
 704         -- Check that we don't use kind signatures without Glasgow extensions
 705   ; checkTc (kind_signatures || isNothing mb_ksig) (badSigTyDecl tc_name)
 706
 707         -- Check that the stupid theta is empty for a GADT-style declaration
 708   ; checkTc (null stupid_theta || h98_syntax) (badStupidTheta tc_name)
 709
 710         -- Check that there's at least one condecl,
 711         -- or else we're reading an hs-boot file, or -XEmptyDataDecls
 712   ; checkTc (not (null cons) || empty_data_decls || is_boot)
 713             (emptyConDeclsErr tc_name)
 714
 715         -- Check that a newtype has exactly one constructor
 716   ; checkTc (new_or_data == DataType || isSingleton cons)
 717             (newtypeConError tc_name (length cons))
 718
 719   ; tycon <- fixM (\ tycon -> do
 720         { data_cons <- mappM (addLocM (tcConDecl unbox_strict tycon final_tvs))
 721                              cons
 722         ; tc_rhs <-
 723             if null cons && is_boot     -- In a hs-boot file, empty cons means
 724             then return AbstractTyCon   -- "don't know"; hence Abstract
 725             else case new_or_data of
 726                    DataType -> return (mkDataTyConRhs data_cons)
 727                    NewType  ->
 728                        ASSERT( isSingleton data_cons )
 729                        mkNewTyConRhs tc_name tycon (head data_cons)
 730         ; buildAlgTyCon tc_name final_tvs stupid_theta tc_rhs is_rec
 731             (want_generic && canDoGenerics data_cons) h98_syntax Nothing
 732         })
 733   ; return [ATyCon tycon]
 734   }
 735   where
 736     is_rec   = calc_isrec tc_name
 737     h98_syntax = case cons of   -- All constructors have same shape
 738                         L _ (ConDecl { con_res = ResTyGADT _ }) : _ -> False
 739                         other -> True
 740
 741 tcTyClDecl1 calc_isrec
 742   (ClassDecl {tcdLName = L _ class_name, tcdTyVars = tvs,
 743               tcdCtxt = ctxt, tcdMeths = meths,
 744               tcdFDs = fundeps, tcdSigs = sigs, tcdATs = ats} )
 745   = tcTyVarBndrs tvs            $ \ tvs' -> do
 746   { ctxt' <- tcHsKindedContext ctxt
 747   ; fds' <- mappM (addLocM tc_fundep) fundeps
 748   ; atss <- mappM (addLocM (tcTyClDecl1 (const Recursive))) ats
 749   ; let ats' = zipWith setTyThingPoss atss (map (tcdTyVars . unLoc) ats)
 750   ; sig_stuff <- tcClassSigs class_name sigs meths
 751   ; clas <- fixM (\ clas ->
 752                 let     -- This little knot is just so we can get
 753                         -- hold of the name of the class TyCon, which we
 754                         -- need to look up its recursiveness
 755                     tycon_name = tyConName (classTyCon clas)
 756                     tc_isrec = calc_isrec tycon_name
 757                 in
 758                 buildClass class_name tvs' ctxt' fds' ats'
 759                            sig_stuff tc_isrec)
 760   ; return (AClass clas : ats')
 761       -- NB: Order is important due to the call to `mkGlobalThings' when
 762       --     tying the the type and class declaration type checking knot.
 763   }
 764   where
 765     tc_fundep (tvs1, tvs2) = do { tvs1' <- mappM tcLookupTyVar tvs1 ;
 766                                 ; tvs2' <- mappM tcLookupTyVar tvs2 ;
 767                                 ; return (tvs1', tvs2') }
 768
 769     -- For each AT argument compute the position of the corresponding class
 770     -- parameter in the class head.  This will later serve as a permutation
 771     -- vector when checking the validity of instance declarations.
 772     setTyThingPoss [ATyCon tycon] atTyVars =
 773       let classTyVars = hsLTyVarNames tvs
 774           poss        =   catMaybes
 775                         . map (`elemIndex` classTyVars)
 776                         . hsLTyVarNames
 777                         $ atTyVars
 778                      -- There will be no Nothing, as we already passed renaming
 779       in
 780       ATyCon (setTyConArgPoss tycon poss)
 781     setTyThingPoss _              _ = panic "TcTyClsDecls.setTyThingPoss"
 782
 783 tcTyClDecl1 calc_isrec
 784   (ForeignType {tcdLName = L _ tc_name, tcdExtName = tc_ext_name})
 785   = returnM [ATyCon (mkForeignTyCon tc_name tc_ext_name liftedTypeKind 0)]
 786
 787 -----------------------------------
 788 tcConDecl :: Bool               -- True <=> -funbox-strict_fields
 789           -> TyCon -> [TyVar]
 790           -> ConDecl Name
 791           -> TcM DataCon
 792
 793 tcConDecl unbox_strict tycon tc_tvs     -- Data types
 794           (ConDecl name _ tvs ctxt details res_ty _)
 795   = tcTyVarBndrs tvs            $ \ tvs' -> do
 796     { ctxt' <- tcHsKindedContext ctxt
 797     ; (univ_tvs, ex_tvs, eq_preds, data_tc) <- tcResultType tycon tc_tvs tvs' res_ty
 798     ; let
 799         -- Tiresome: tidy the tyvar binders, since tc_tvs and tvs' may have the same OccNames
 800         tc_datacon is_infix field_lbls btys
 801           = do { let bangs = map getBangStrictness btys
 802                ; arg_tys <- mappM tcHsBangType btys
 803                ; buildDataCon (unLoc name) is_infix
 804                     (argStrictness unbox_strict bangs arg_tys)
 805                     (map unLoc field_lbls)
 806                     univ_tvs ex_tvs eq_preds ctxt' arg_tys
 807                     data_tc }
 808                 -- NB:  we put data_tc, the type constructor gotten from the
 809                 --      constructor type signature into the data constructor;
 810                 --      that way checkValidDataCon can complain if it's wrong.
 811
 812     ; case details of
 813         PrefixCon btys     -> tc_datacon False [] btys
 814         InfixCon bty1 bty2 -> tc_datacon True  [] [bty1,bty2]
 815         RecCon fields      -> tc_datacon False field_names btys
 816                            where
 817                               field_names = map cd_fld_name fields
 818                               btys        = map cd_fld_type fields
 819     }
 820
 821 tcResultType :: TyCon
 822              -> [TyVar]         -- data T a b c = ...
 823              -> [TyVar]         -- where MkT :: forall a b c. ...
 824              -> ResType Name
 825              -> TcM ([TyVar],           -- Universal
 826                      [TyVar],           -- Existential (distinct OccNames from univs)
 827                      [(TyVar,Type)],    -- Equality predicates
 828                      TyCon)             -- TyCon given in the ResTy
 829         -- We don't check that the TyCon given in the ResTy is
 830         -- the same as the parent tycon, becuase we are in the middle
 831         -- of a recursive knot; so it's postponed until checkValidDataCon
 832
 833 tcResultType decl_tycon tc_tvs dc_tvs ResTyH98
 834   = return (tc_tvs, dc_tvs, [], decl_tycon)
 835         -- In H98 syntax the dc_tvs are the existential ones
 836         --      data T a b c = forall d e. MkT ...
 837         -- The {a,b,c} are tc_tvs, and {d,e} are dc_tvs
 838
 839 tcResultType _ tc_tvs dc_tvs (ResTyGADT res_ty)
 840         -- E.g.  data T a b c where
 841         --         MkT :: forall x y z. T (x,y) z z
 842         -- Then we generate
 843         --      ([a,z,c], [x,y], [a:=:(x,y), c:=:z], T)
 844
 845   = do  { (dc_tycon, res_tys) <- tcLHsConResTy res_ty
 846
 847         ; let univ_tvs = choose_univs [] tidy_tc_tvs res_tys
 848                 -- Each univ_tv is either a dc_tv or a tc_tv
 849               ex_tvs = dc_tvs `minusList` univ_tvs
 850               eq_spec = [ (tv, ty) | (tv,ty) <- univ_tvs `zip` res_tys,
 851                                       tv `elem` tc_tvs]
 852         ; return (univ_tvs, ex_tvs, eq_spec, dc_tycon) }
 853   where
 854         -- choose_univs uses the res_ty itself if it's a type variable
 855         -- and hasn't already been used; otherwise it uses one of the tc_tvs
 856     choose_univs used tc_tvs []
 857         = ASSERT( null tc_tvs ) []
 858     choose_univs used (tc_tv:tc_tvs) (res_ty:res_tys)
 859         | Just tv <- tcGetTyVar_maybe res_ty, not (tv `elem` used)
 860         = tv    : choose_univs (tv:used) tc_tvs res_tys
 861         | otherwise
 862         = tc_tv : choose_univs used tc_tvs res_tys
 863
 864         -- NB: tc_tvs and dc_tvs are distinct, but
 865         -- we want them to be *visibly* distinct, both for
 866         -- interface files and general confusion.  So rename
 867         -- the tc_tvs, since they are not used yet (no
 868         -- consequential renaming needed)
 869     init_occ_env     = initTidyOccEnv (map getOccName dc_tvs)
 870     (_, tidy_tc_tvs) = mapAccumL tidy_one init_occ_env tc_tvs
 871     tidy_one env tv  = (env', setTyVarName tv (tidyNameOcc name occ'))
 872               where
 873                  name = tyVarName tv
 874                  (env', occ') = tidyOccName env (getOccName name)
 875
 876               -------------------
 877 argStrictness :: Bool           -- True <=> -funbox-strict_fields
 878               -> [HsBang]
 879               -> [TcType] -> [StrictnessMark]
 880 argStrictness unbox_strict bangs arg_tys
 881  = ASSERT( length bangs == length arg_tys )
 882    zipWith (chooseBoxingStrategy unbox_strict) arg_tys bangs
 883
 884 -- We attempt to unbox/unpack a strict field when either:
 885 --   (i)  The field is marked '!!', or
 886 --   (ii) The field is marked '!', and the -funbox-strict-fields flag is on.
 887 --
 888 -- We have turned off unboxing of newtypes because coercions make unboxing
 889 -- and reboxing more complicated
 890 chooseBoxingStrategy :: Bool -> TcType -> HsBang -> StrictnessMark
 891 chooseBoxingStrategy unbox_strict_fields arg_ty bang
 892   = case bang of
 893         HsNoBang                                    -> NotMarkedStrict
 894         HsStrict | unbox_strict_fields
 895                    && can_unbox arg_ty              -> MarkedUnboxed
 896         HsUnbox  | can_unbox arg_ty                 -> MarkedUnboxed
 897         other                                       -> MarkedStrict
 898   where
 899     -- we can unbox if the type is a chain of newtypes with a product tycon
 900     -- at the end
 901     can_unbox arg_ty = case splitTyConApp_maybe arg_ty of
 902                    Nothing                      -> False
 903                    Just (arg_tycon, tycon_args) ->
 904                        not (isRecursiveTyCon arg_tycon) &&      -- Note [Recusive unboxing]
 905                        isProductTyCon arg_tycon &&
 906                        (if isNewTyCon arg_tycon then
 907                             can_unbox (newTyConInstRhs arg_tycon tycon_args)
 908                         else True)
 909 \end{code}
 910
 911 Note [Recursive unboxing]
 912 ~~~~~~~~~~~~~~~~~~~~~~~~~
 913 Be careful not to try to unbox this!
 914         data T = MkT !T Int
 915 But it's the *argument* type that matters. This is fine:
 916         data S = MkS S !Int
 917 because Int is non-recursive.
 918
 919 %************************************************************************
 920 %*                                                                      *
 921 \subsection{Dependency analysis}
 922 %*                                                                      *
 923 %************************************************************************
 924
 925 Validity checking is done once the mutually-recursive knot has been
 926 tied, so we can look at things freely.
 927
 928 \begin{code}
 929 checkCycleErrs :: [LTyClDecl Name] -> TcM ()
 930 checkCycleErrs tyclss
 931   | null cls_cycles
 932   = return ()
 933   | otherwise
 934   = do  { mappM_ recClsErr cls_cycles
 935         ; failM }       -- Give up now, because later checkValidTyCl
 936                         -- will loop if the synonym is recursive
 937   where
 938     cls_cycles = calcClassCycles tyclss
 939
 940 checkValidTyCl :: TyClDecl Name -> TcM ()
 941 -- We do the validity check over declarations, rather than TyThings
 942 -- only so that we can add a nice context with tcAddDeclCtxt
 943 checkValidTyCl decl
 944   = tcAddDeclCtxt decl $
 945     do  { thing <- tcLookupLocatedGlobal (tcdLName decl)
 946         ; traceTc (text "Validity of" <+> ppr thing)
 947         ; case thing of
 948             ATyCon tc -> checkValidTyCon tc
 949             AClass cl -> checkValidClass cl
 950         ; traceTc (text "Done validity of" <+> ppr thing)
 951         }
 952
 953 -------------------------
 954 -- For data types declared with record syntax, we require
 955 -- that each constructor that has a field 'f'
 956 --      (a) has the same result type
 957 --      (b) has the same type for 'f'
 958 -- module alpha conversion of the quantified type variables
 959 -- of the constructor.
 960
 961 checkValidTyCon :: TyCon -> TcM ()
 962 checkValidTyCon tc
 963   | isSynTyCon tc
 964   = case synTyConRhs tc of
 965       OpenSynTyCon _ _ -> return ()
 966       SynonymTyCon ty  -> checkValidType syn_ctxt ty
 967   | otherwise
 968   =     -- Check the context on the data decl
 969     checkValidTheta (DataTyCtxt name) (tyConStupidTheta tc)     `thenM_`
 970
 971         -- Check arg types of data constructors
 972     mappM_ (checkValidDataCon tc) data_cons                     `thenM_`
 973
 974         -- Check that fields with the same name share a type
 975     mappM_ check_fields groups
 976
 977   where
 978     syn_ctxt  = TySynCtxt name
 979     name      = tyConName tc
 980     data_cons = tyConDataCons tc
 981
 982     groups = equivClasses cmp_fld (concatMap get_fields data_cons)
 983     cmp_fld (f1,_) (f2,_) = f1 `compare` f2
 984     get_fields con = dataConFieldLabels con `zip` repeat con
 985         -- dataConFieldLabels may return the empty list, which is fine
 986
 987     -- See Note [GADT record selectors] in MkId.lhs
 988     -- We must check (a) that the named field has the same
 989     --                   type in each constructor
 990     --               (b) that those constructors have the same result type
 991     --
 992     -- However, the constructors may have differently named type variable
 993     -- and (worse) we don't know how the correspond to each other.  E.g.
 994     --     C1 :: forall a b. { f :: a, g :: b } -> T a b
 995     --     C2 :: forall d c. { f :: c, g :: c } -> T c d
 996     --
 997     -- So what we do is to ust Unify.tcMatchTys to compare the first candidate's
 998     -- result type against other candidates' types BOTH WAYS ROUND.
 999     -- If they magically agrees, take the substitution and
1000     -- apply them to the latter ones, and see if they match perfectly.
1001     check_fields fields@((label, con1) : other_fields)
1002         -- These fields all have the same name, but are from
1003         -- different constructors in the data type
1004         = recoverM (return ()) $ mapM_ checkOne other_fields
1005                 -- Check that all the fields in the group have the same type
1006                 -- NB: this check assumes that all the constructors of a given
1007                 -- data type use the same type variables
1008         where
1009         (tvs1, _, _, res1) = dataConSig con1
1010         ts1 = mkVarSet tvs1
1011         fty1 = dataConFieldType con1 label
1012
1013         checkOne (_, con2)    -- Do it bothways to ensure they are structurally identical
1014             = do { checkFieldCompat label con1 con2 ts1 res1 res2 fty1 fty2
1015                  ; checkFieldCompat label con2 con1 ts2 res2 res1 fty2 fty1 }
1016             where
1017                 (tvs2, _, _, res2) = dataConSig con2
1018                 ts2 = mkVarSet tvs2
1019                 fty2 = dataConFieldType con2 label
1020
1021 checkFieldCompat fld con1 con2 tvs1 res1 res2 fty1 fty2
1022   = do  { checkTc (isJust mb_subst1) (resultTypeMisMatch fld con1 con2)
1023         ; checkTc (isJust mb_subst2) (fieldTypeMisMatch fld con1 con2) }
1024   where
1025     mb_subst1 = tcMatchTy tvs1 res1 res2
1026     mb_subst2 = tcMatchTyX tvs1 (expectJust "checkFieldCompat" mb_subst1) fty1 fty2
1027
1028 -------------------------------
1029 checkValidDataCon :: TyCon -> DataCon -> TcM ()
1030 checkValidDataCon tc con
1031   = setSrcSpan (srcLocSpan (getSrcLoc con))     $
1032     addErrCtxt (dataConCtxt con)                $
1033     do  { checkTc (dataConTyCon con == tc) (badDataConTyCon con)
1034         ; checkValidType ctxt (dataConUserType con)
1035         ; ifM (isNewTyCon tc) (checkNewDataCon con)
1036     }
1037   where
1038     ctxt = ConArgCtxt (dataConName con)
1039
1040 -------------------------------
1041 checkNewDataCon :: DataCon -> TcM ()
1042 -- Checks for the data constructor of a newtype
1043 checkNewDataCon con
1044   = do  { checkTc (isSingleton arg_tys) (newtypeFieldErr con (length arg_tys))
1045                 -- One argument
1046         ; checkTc (null eq_spec) (newtypePredError con)
1047                 -- Return type is (T a b c)
1048         ; checkTc (null ex_tvs && null theta) (newtypeExError con)
1049                 -- No existentials
1050         ; checkTc (not (any isMarkedStrict (dataConStrictMarks con)))
1051                   (newtypeStrictError con)
1052                 -- No strictness
1053     }
1054   where
1055     (_univ_tvs, ex_tvs, eq_spec, theta, arg_tys, _res_ty) = dataConFullSig con
1056
1057 -------------------------------
1058 checkValidClass :: Class -> TcM ()
1059 checkValidClass cls
1060   = do  { constrained_class_methods <- doptM Opt_ConstrainedClassMethods
1061         ; multi_param_type_classes <- doptM Opt_MultiParamTypeClasses
1062         ; fundep_classes <- doptM Opt_FunctionalDependencies
1063
1064         -- Check that the class is unary, unless GlaExs
1065         ; checkTc (notNull tyvars) (nullaryClassErr cls)
1066         ; checkTc (multi_param_type_classes || unary) (classArityErr cls)
1067         ; checkTc (fundep_classes || null fundeps) (classFunDepsErr cls)
1068
1069         -- Check the super-classes
1070         ; checkValidTheta (ClassSCCtxt (className cls)) theta
1071
1072         -- Check the class operations
1073         ; mappM_ (check_op constrained_class_methods) op_stuff
1074
1075         -- Check that if the class has generic methods, then the
1076         -- class has only one parameter.  We can't do generic
1077         -- multi-parameter type classes!
1078         ; checkTc (unary || no_generics) (genericMultiParamErr cls)
1079         }
1080   where
1081     (tyvars, fundeps, theta, _, _, op_stuff) = classExtraBigSig cls
1082     unary       = isSingleton tyvars
1083     no_generics = null [() | (_, GenDefMeth) <- op_stuff]
1084
1085     check_op constrained_class_methods (sel_id, dm)
1086       = addErrCtxt (classOpCtxt sel_id tau) $ do
1087         { checkValidTheta SigmaCtxt (tail theta)
1088                 -- The 'tail' removes the initial (C a) from the
1089                 -- class itself, leaving just the method type
1090
1091         ; checkValidType (FunSigCtxt op_name) tau
1092
1093                 -- Check that the type mentions at least one of
1094                 -- the class type variables...or at least one reachable
1095                 -- from one of the class variables.  Example: tc223
1096                 --   class Error e => Game b mv e | b -> mv e where
1097                 --      newBoard :: MonadState b m => m ()
1098                 -- Here, MonadState has a fundep m->b, so newBoard is fine
1099         ; let grown_tyvars = grow theta (mkVarSet tyvars)
1100         ; checkTc (tyVarsOfType tau `intersectsVarSet` grown_tyvars)
1101                   (noClassTyVarErr cls sel_id)
1102
1103                 -- Check that for a generic method, the type of
1104                 -- the method is sufficiently simple
1105         ; checkTc (dm /= GenDefMeth || validGenericMethodType tau)
1106                   (badGenericMethodType op_name op_ty)
1107         }
1108         where
1109           op_name = idName sel_id
1110           op_ty   = idType sel_id
1111           (_,theta1,tau1) = tcSplitSigmaTy op_ty
1112           (_,theta2,tau2)  = tcSplitSigmaTy tau1
1113           (theta,tau) | constrained_class_methods = (theta1 ++ theta2, tau2)
1114                       | otherwise = (theta1, mkPhiTy (tail theta1) tau1)
1115                 -- Ugh!  The function might have a type like
1116                 --      op :: forall a. C a => forall b. (Eq b, Eq a) => tau2
1117                 -- With -XConstrainedClassMethods, we want to allow this, even though the inner
1118                 -- forall has an (Eq a) constraint.  Whereas in general, each constraint
1119                 -- in the context of a for-all must mention at least one quantified
1120                 -- type variable.  What a mess!
1121
1122
1123 ---------------------------------------------------------------------
1124 resultTypeMisMatch field_name con1 con2
1125   = vcat [sep [ptext SLIT("Constructors") <+> ppr con1 <+> ptext SLIT("and") <+> ppr con2,
1126                 ptext SLIT("have a common field") <+> quotes (ppr field_name) <> comma],
1127           nest 2 $ ptext SLIT("but have different result types")]
1128 fieldTypeMisMatch field_name con1 con2
1129   = sep [ptext SLIT("Constructors") <+> ppr con1 <+> ptext SLIT("and") <+> ppr con2,
1130          ptext SLIT("give different types for field"), quotes (ppr field_name)]
1131
1132 dataConCtxt con = ptext SLIT("In the definition of data constructor") <+> quotes (ppr con)
1133
1134 classOpCtxt sel_id tau = sep [ptext SLIT("When checking the class method:"),
1135                               nest 2 (ppr sel_id <+> dcolon <+> ppr tau)]
1136
1137 nullaryClassErr cls
1138   = ptext SLIT("No parameters for class")  <+> quotes (ppr cls)
1139
1140 classArityErr cls
1141   = vcat [ptext SLIT("Too many parameters for class") <+> quotes (ppr cls),
1142           parens (ptext SLIT("Use -XMultiParamTypeClasses to allow multi-parameter classes"))]
1143
1144 classFunDepsErr cls
1145   = vcat [ptext SLIT("Fundeps in class") <+> quotes (ppr cls),
1146           parens (ptext SLIT("Use -XFunctionalDependencies to allow fundeps"))]
1147
1148 noClassTyVarErr clas op
1149   = sep [ptext SLIT("The class method") <+> quotes (ppr op),
1150          ptext SLIT("mentions none of the type variables of the class") <+>
1151                 ppr clas <+> hsep (map ppr (classTyVars clas))]
1152
1153 genericMultiParamErr clas
1154   = ptext SLIT("The multi-parameter class") <+> quotes (ppr clas) <+>
1155     ptext SLIT("cannot have generic methods")
1156
1157 badGenericMethodType op op_ty
1158   = hang (ptext SLIT("Generic method type is too complex"))
1159        4 (vcat [ppr op <+> dcolon <+> ppr op_ty,
1160                 ptext SLIT("You can only use type variables, arrows, lists, and tuples")])
1161
1162 recSynErr syn_decls
1163   = setSrcSpan (getLoc (head sorted_decls)) $
1164     addErr (sep [ptext SLIT("Cycle in type synonym declarations:"),
1165                  nest 2 (vcat (map ppr_decl sorted_decls))])
1166   where
1167     sorted_decls = sortLocated syn_decls
1168     ppr_decl (L loc decl) = ppr loc <> colon <+> ppr decl
1169
1170 recClsErr cls_decls
1171   = setSrcSpan (getLoc (head sorted_decls)) $
1172     addErr (sep [ptext SLIT("Cycle in class declarations (via superclasses):"),
1173                  nest 2 (vcat (map ppr_decl sorted_decls))])
1174   where
1175     sorted_decls = sortLocated cls_decls
1176     ppr_decl (L loc decl) = ppr loc <> colon <+> ppr (decl { tcdSigs = [] })
1177
1178 sortLocated :: [Located a] -> [Located a]
1179 sortLocated things = sortLe le things
1180   where
1181     le (L l1 _) (L l2 _) = l1 <= l2
1182
1183 badDataConTyCon data_con
1184   = hang (ptext SLIT("Data constructor") <+> quotes (ppr data_con) <+>
1185                 ptext SLIT("returns type") <+> quotes (ppr (dataConTyCon data_con)))
1186        2 (ptext SLIT("instead of its parent type"))
1187
1188 badGadtDecl tc_name
1189   = vcat [ ptext SLIT("Illegal generalised algebraic data declaration for") <+> quotes (ppr tc_name)
1190          , nest 2 (parens $ ptext SLIT("Use -X=GADT to allow GADTs")) ]
1191
1192 badStupidTheta tc_name
1193   = ptext SLIT("A data type declared in GADT style cannot have a context:") <+> quotes (ppr tc_name)
1194
1195 newtypeConError tycon n
1196   = sep [ptext SLIT("A newtype must have exactly one constructor,"),
1197          nest 2 $ ptext SLIT("but") <+> quotes (ppr tycon) <+> ptext SLIT("has") <+> speakN n ]
1198
1199 newtypeExError con
1200   = sep [ptext SLIT("A newtype constructor cannot have an existential context,"),
1201          nest 2 $ ptext SLIT("but") <+> quotes (ppr con) <+> ptext SLIT("does")]
1202
1203 newtypeStrictError con
1204   = sep [ptext SLIT("A newtype constructor cannot have a strictness annotation,"),
1205          nest 2 $ ptext SLIT("but") <+> quotes (ppr con) <+> ptext SLIT("does")]
1206
1207 newtypePredError con
1208   = sep [ptext SLIT("A newtype constructor must have a return type of form T a1 ... an"),
1209          nest 2 $ ptext SLIT("but") <+> quotes (ppr con) <+> ptext SLIT("does not")]
1210
1211 newtypeFieldErr con_name n_flds
1212   = sep [ptext SLIT("The constructor of a newtype must have exactly one field"),
1213          nest 2 $ ptext SLIT("but") <+> quotes (ppr con_name) <+> ptext SLIT("has") <+> speakN n_flds]
1214
1215 badSigTyDecl tc_name
1216   = vcat [ ptext SLIT("Illegal kind signature") <+>
1217            quotes (ppr tc_name)
1218          , nest 2 (parens $ ptext SLIT("Use -XKindSignatures to allow kind signatures")) ]
1219
1220 badFamInstDecl tc_name
1221   = vcat [ ptext SLIT("Illegal family instance for") <+>
1222            quotes (ppr tc_name)
1223          , nest 2 (parens $ ptext SLIT("Use -X=TypeFamilies to allow indexed type families")) ]
1224
1225 badGadtIdxTyDecl tc_name
1226   = vcat [ ptext SLIT("Illegal generalised algebraic data declaration for") <+>
1227            quotes (ppr tc_name)
1228          , nest 2 (parens $ ptext SLIT("Family instances can not yet use GADT declarations")) ]
1229
1230 tooManyParmsErr tc_name
1231   = ptext SLIT("Family instance has too many parameters:") <+>
1232     quotes (ppr tc_name)
1233
1234 tooFewParmsErr tc_name
1235   = ptext SLIT("Family instance has too few parameters:") <+>
1236     quotes (ppr tc_name)
1237
1238 badBootFamInstDeclErr =
1239   ptext SLIT("Illegal family instance in hs-boot file")
1240
1241 wrongKindOfFamily family =
1242   ptext SLIT("Wrong category of family instance; declaration was for a") <+>
1243   kindOfFamily
1244   where
1245     kindOfFamily | isSynTyCon family = ptext SLIT("type synonym")
1246                  | isAlgTyCon family = ptext SLIT("data type")
1247                  | otherwise = pprPanic "wrongKindOfFamily" (ppr family)
1248
1249 polyTyErr ty
1250   = hang (ptext SLIT("Illegal polymorphic type in type instance") <> colon) 4 $
1251       ppr ty
1252
1253 tyFamAppInIndexErr ty
1254   = hang (ptext SLIT("Illegal type family application in type instance") <>
1255          colon) 4 $
1256       ppr ty
1257
1258 emptyConDeclsErr tycon
1259   = sep [quotes (ppr tycon) <+> ptext SLIT("has no constructors"),
1260          nest 2 $ ptext SLIT("(-XEmptyDataDecls permits this)")]
1261 \end{code}