compiler/typecheck/TcTyClsDecls.lhs

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