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