compiler/typecheck/TcHsSyn.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The AQUA Project, Glasgow University, 1996-1998
   4 %
   5
   6 TcHsSyn: Specialisations of the @HsSyn@ syntax for the typechecker
   7
   8 This module is an extension of @HsSyn@ syntax, for use in the type
   9 checker.
  10
  11 \begin{code}
  12 {-# OPTIONS -w #-}
  13 -- The above warning supression flag is a temporary kludge.
  14 -- While working on this module you are encouraged to remove it and fix
  15 -- any warnings in the module. See
  16 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
  17 -- for details
  18
  19 module TcHsSyn (
  20         mkHsConApp, mkHsDictLet, mkHsApp,
  21         hsLitType, hsLPatType, hsPatType,
  22         mkHsAppTy, mkSimpleHsAlt,
  23         nlHsIntLit, mkVanillaTuplePat,
  24
  25         mkArbitraryType,        -- Put this elsewhere?
  26
  27         -- re-exported from TcMonad
  28         TcId, TcIdSet, TcDictBinds,
  29
  30         zonkTopDecls, zonkTopExpr, zonkTopLExpr,
  31         zonkId, zonkTopBndrs
  32   ) where
  33
  34 #include "HsVersions.h"
  35
  36 -- friends:
  37 import HsSyn    -- oodles of it
  38
  39 -- others:
  40 import Id
  41
  42 import TcRnMonad
  43 import Type
  44 import TcType
  45 import TcMType
  46 import TysPrim
  47 import TysWiredIn
  48 import TyCon
  49 import Name
  50 import Var
  51 import VarSet
  52 import VarEnv
  53 import BasicTypes
  54 import Maybes
  55 import Unique
  56 import SrcLoc
  57 import Util
  58 import Bag
  59 import Outputable
  60 \end{code}
  61
  62
  63 %************************************************************************
  64 %*                                                                      *
  65 \subsection[mkFailurePair]{Code for pattern-matching and other failures}
  66 %*                                                                      *
  67 %************************************************************************
  68
  69 Note: If @hsLPatType@ doesn't bear a strong resemblance to @exprType@,
  70 then something is wrong.
  71 \begin{code}
  72 mkVanillaTuplePat :: [OutPat Id] -> Boxity -> Pat Id
  73 -- A vanilla tuple pattern simply gets its type from its sub-patterns
  74 mkVanillaTuplePat pats box
  75   = TuplePat pats box (mkTupleTy box (length pats) (map hsLPatType pats))
  76
  77 hsLPatType :: OutPat Id -> Type
  78 hsLPatType (L _ pat) = hsPatType pat
  79
  80 hsPatType (ParPat pat)              = hsLPatType pat
  81 hsPatType (WildPat ty)              = ty
  82 hsPatType (VarPat var)              = idType var
  83 hsPatType (VarPatOut var _)         = idType var
  84 hsPatType (BangPat pat)             = hsLPatType pat
  85 hsPatType (LazyPat pat)             = hsLPatType pat
  86 hsPatType (LitPat lit)              = hsLitType lit
  87 hsPatType (AsPat var pat)           = idType (unLoc var)
  88 hsPatType (ViewPat expr pat ty)     = ty
  89 hsPatType (ListPat _ ty)            = mkListTy ty
  90 hsPatType (PArrPat _ ty)            = mkPArrTy ty
  91 hsPatType (TuplePat pats box ty)    = ty
  92 hsPatType (ConPatOut{ pat_ty = ty })= ty
  93 hsPatType (SigPatOut pat ty)        = ty
  94 hsPatType (NPat lit _ _)            = overLitType lit
  95 hsPatType (NPlusKPat id _ _ _)      = idType (unLoc id)
  96 hsPatType (CoPat _ _ ty)            = ty
  97
  98 hsLitType :: HsLit -> TcType
  99 hsLitType (HsChar c)       = charTy
 100 hsLitType (HsCharPrim c)   = charPrimTy
 101 hsLitType (HsString str)   = stringTy
 102 hsLitType (HsStringPrim s) = addrPrimTy
 103 hsLitType (HsInt i)        = intTy
 104 hsLitType (HsIntPrim i)    = intPrimTy
 105 hsLitType (HsInteger i ty) = ty
 106 hsLitType (HsRat _ ty)     = ty
 107 hsLitType (HsFloatPrim f)  = floatPrimTy
 108 hsLitType (HsDoublePrim d) = doublePrimTy
 109 \end{code}
 110
 111
 112 %************************************************************************
 113 %*                                                                      *
 114 \subsection[BackSubst-HsBinds]{Running a substitution over @HsBinds@}
 115 %*                                                                      *
 116 %************************************************************************
 117
 118 \begin{code}
 119 -- zonkId is used *during* typechecking just to zonk the Id's type
 120 zonkId :: TcId -> TcM TcId
 121 zonkId id
 122   = zonkTcType (idType id) `thenM` \ ty' ->
 123     returnM (Id.setIdType id ty')
 124 \end{code}
 125
 126 The rest of the zonking is done *after* typechecking.
 127 The main zonking pass runs over the bindings
 128
 129  a) to convert TcTyVars to TyVars etc, dereferencing any bindings etc
 130  b) convert unbound TcTyVar to Void
 131  c) convert each TcId to an Id by zonking its type
 132
 133 The type variables are converted by binding mutable tyvars to immutable ones
 134 and then zonking as normal.
 135
 136 The Ids are converted by binding them in the normal Tc envt; that
 137 way we maintain sharing; eg an Id is zonked at its binding site and they
 138 all occurrences of that Id point to the common zonked copy
 139
 140 It's all pretty boring stuff, because HsSyn is such a large type, and
 141 the environment manipulation is tiresome.
 142
 143 \begin{code}
 144 data ZonkEnv = ZonkEnv  (TcType -> TcM Type)    -- How to zonk a type
 145                         (IdEnv Id)              -- What variables are in scope
 146         -- Maps an Id to its zonked version; both have the same Name
 147         -- Is only consulted lazily; hence knot-tying
 148
 149 emptyZonkEnv = ZonkEnv zonkTypeZapping emptyVarEnv
 150
 151 extendZonkEnv :: ZonkEnv -> [Id] -> ZonkEnv
 152 extendZonkEnv (ZonkEnv zonk_ty env) ids
 153   = ZonkEnv zonk_ty (extendVarEnvList env [(id,id) | id <- ids])
 154
 155 extendZonkEnv1 :: ZonkEnv -> Id -> ZonkEnv
 156 extendZonkEnv1 (ZonkEnv zonk_ty env) id
 157   = ZonkEnv zonk_ty (extendVarEnv env id id)
 158
 159 setZonkType :: ZonkEnv -> (TcType -> TcM Type) -> ZonkEnv
 160 setZonkType (ZonkEnv _ env) zonk_ty = ZonkEnv zonk_ty env
 161
 162 zonkEnvIds :: ZonkEnv -> [Id]
 163 zonkEnvIds (ZonkEnv _ env) = varEnvElts env
 164
 165 zonkIdOcc :: ZonkEnv -> TcId -> Id
 166 -- Ids defined in this module should be in the envt;
 167 -- ignore others.  (Actually, data constructors are also
 168 -- not LocalVars, even when locally defined, but that is fine.)
 169 -- (Also foreign-imported things aren't currently in the ZonkEnv;
 170 --  that's ok because they don't need zonking.)
 171 --
 172 -- Actually, Template Haskell works in 'chunks' of declarations, and
 173 -- an earlier chunk won't be in the 'env' that the zonking phase
 174 -- carries around.  Instead it'll be in the tcg_gbl_env, already fully
 175 -- zonked.  There's no point in looking it up there (except for error
 176 -- checking), and it's not conveniently to hand; hence the simple
 177 -- 'orElse' case in the LocalVar branch.
 178 --
 179 -- Even without template splices, in module Main, the checking of
 180 -- 'main' is done as a separate chunk.
 181 zonkIdOcc (ZonkEnv zonk_ty env) id
 182   | isLocalVar id = lookupVarEnv env id `orElse` id
 183   | otherwise     = id
 184
 185 zonkIdOccs env ids = map (zonkIdOcc env) ids
 186
 187 -- zonkIdBndr is used *after* typechecking to get the Id's type
 188 -- to its final form.  The TyVarEnv give
 189 zonkIdBndr :: ZonkEnv -> TcId -> TcM Id
 190 zonkIdBndr env id
 191   = zonkTcTypeToType env (idType id)    `thenM` \ ty' ->
 192     returnM (Id.setIdType id ty')
 193
 194 zonkIdBndrs :: ZonkEnv -> [TcId] -> TcM [Id]
 195 zonkIdBndrs env ids = mappM (zonkIdBndr env) ids
 196
 197 zonkDictBndrs :: ZonkEnv -> [Var] -> TcM [Var]
 198 -- "Dictionary" binders can be coercion variables or dictionary variables
 199 zonkDictBndrs env ids = mappM (zonkDictBndr env) ids
 200
 201 zonkDictBndr env var | isTyVar var = return var
 202                      | otherwise   = zonkIdBndr env var
 203
 204 zonkTopBndrs :: [TcId] -> TcM [Id]
 205 zonkTopBndrs ids = zonkIdBndrs emptyZonkEnv ids
 206 \end{code}
 207
 208
 209 \begin{code}
 210 zonkTopExpr :: HsExpr TcId -> TcM (HsExpr Id)
 211 zonkTopExpr e = zonkExpr emptyZonkEnv e
 212
 213 zonkTopLExpr :: LHsExpr TcId -> TcM (LHsExpr Id)
 214 zonkTopLExpr e = zonkLExpr emptyZonkEnv e
 215
 216 zonkTopDecls :: LHsBinds TcId -> [LRuleDecl TcId] -> [LForeignDecl TcId]
 217              -> TcM ([Id],
 218                      Bag (LHsBind  Id),
 219                      [LForeignDecl Id],
 220                      [LRuleDecl    Id])
 221 zonkTopDecls binds rules fords
 222   = do  { (env, binds') <- zonkRecMonoBinds emptyZonkEnv binds
 223                         -- Top level is implicitly recursive
 224         ; rules' <- zonkRules env rules
 225         ; fords' <- zonkForeignExports env fords
 226         ; return (zonkEnvIds env, binds', fords', rules') }
 227
 228 ---------------------------------------------
 229 zonkLocalBinds :: ZonkEnv -> HsLocalBinds TcId -> TcM (ZonkEnv, HsLocalBinds Id)
 230 zonkLocalBinds env EmptyLocalBinds
 231   = return (env, EmptyLocalBinds)
 232
 233 zonkLocalBinds env (HsValBinds binds)
 234   = do  { (env1, new_binds) <- zonkValBinds env binds
 235         ; return (env1, HsValBinds new_binds) }
 236
 237 zonkLocalBinds env (HsIPBinds (IPBinds binds dict_binds))
 238   = mappM (wrapLocM zonk_ip_bind) binds `thenM` \ new_binds ->
 239     let
 240         env1 = extendZonkEnv env [ipNameName n | L _ (IPBind n _) <- new_binds]
 241     in
 242     zonkRecMonoBinds env1 dict_binds    `thenM` \ (env2, new_dict_binds) ->
 243     returnM (env2, HsIPBinds (IPBinds new_binds new_dict_binds))
 244   where
 245     zonk_ip_bind (IPBind n e)
 246         = mapIPNameTc (zonkIdBndr env) n        `thenM` \ n' ->
 247           zonkLExpr env e                       `thenM` \ e' ->
 248           returnM (IPBind n' e')
 249
 250
 251 ---------------------------------------------
 252 zonkValBinds :: ZonkEnv -> HsValBinds TcId -> TcM (ZonkEnv, HsValBinds Id)
 253 zonkValBinds env bs@(ValBindsIn _ _)
 254   = panic "zonkValBinds"        -- Not in typechecker output
 255 zonkValBinds env (ValBindsOut binds sigs)
 256   = do  { (env1, new_binds) <- go env binds
 257         ; return (env1, ValBindsOut new_binds sigs) }
 258   where
 259     go env []         = return (env, [])
 260     go env ((r,b):bs) = do { (env1, b')  <- zonkRecMonoBinds env b
 261                            ; (env2, bs') <- go env1 bs
 262                            ; return (env2, (r,b'):bs') }
 263
 264 ---------------------------------------------
 265 zonkRecMonoBinds :: ZonkEnv -> LHsBinds TcId -> TcM (ZonkEnv, LHsBinds Id)
 266 zonkRecMonoBinds env binds
 267  = fixM (\ ~(_, new_binds) -> do
 268         { let env1 = extendZonkEnv env (collectHsBindBinders new_binds)
 269         ; binds' <- zonkMonoBinds env1 binds
 270         ; return (env1, binds') })
 271
 272 ---------------------------------------------
 273 zonkMonoBinds :: ZonkEnv -> LHsBinds TcId -> TcM (LHsBinds Id)
 274 zonkMonoBinds env binds = mapBagM (wrapLocM (zonk_bind env)) binds
 275
 276 zonk_bind :: ZonkEnv -> HsBind TcId -> TcM (HsBind Id)
 277 zonk_bind env bind@(PatBind { pat_lhs = pat, pat_rhs = grhss, pat_rhs_ty = ty})
 278   = do  { (_env, new_pat) <- zonkPat env pat            -- Env already extended
 279         ; new_grhss <- zonkGRHSs env grhss
 280         ; new_ty    <- zonkTcTypeToType env ty
 281         ; return (bind { pat_lhs = new_pat, pat_rhs = new_grhss, pat_rhs_ty = new_ty }) }
 282
 283 zonk_bind env (VarBind { var_id = var, var_rhs = expr })
 284   = zonkIdBndr env var                  `thenM` \ new_var ->
 285     zonkLExpr env expr                  `thenM` \ new_expr ->
 286     returnM (VarBind { var_id = new_var, var_rhs = new_expr })
 287
 288 zonk_bind env bind@(FunBind { fun_id = var, fun_matches = ms, fun_co_fn = co_fn })
 289   = wrapLocM (zonkIdBndr env) var       `thenM` \ new_var ->
 290     zonkCoFn env co_fn                  `thenM` \ (env1, new_co_fn) ->
 291     zonkMatchGroup env1 ms              `thenM` \ new_ms ->
 292     returnM (bind { fun_id = new_var, fun_matches = new_ms, fun_co_fn = new_co_fn })
 293
 294 zonk_bind env (AbsBinds { abs_tvs = tyvars, abs_dicts = dicts,
 295                           abs_exports = exports, abs_binds = val_binds })
 296   = ASSERT( all isImmutableTyVar tyvars )
 297     zonkDictBndrs env dicts                     `thenM` \ new_dicts ->
 298     fixM (\ ~(new_val_binds, _) ->
 299         let
 300           env1 = extendZonkEnv env new_dicts
 301           env2 = extendZonkEnv env1 (collectHsBindBinders new_val_binds)
 302         in
 303         zonkMonoBinds env2 val_binds            `thenM` \ new_val_binds ->
 304         mappM (zonkExport env2) exports         `thenM` \ new_exports ->
 305         returnM (new_val_binds, new_exports)
 306     )                                           `thenM` \ (new_val_bind, new_exports) ->
 307     returnM (AbsBinds { abs_tvs = tyvars, abs_dicts = new_dicts,
 308                         abs_exports = new_exports, abs_binds = new_val_bind })
 309   where
 310     zonkExport env (tyvars, global, local, prags)
 311         -- The tyvars are already zonked
 312         = zonkIdBndr env global                 `thenM` \ new_global ->
 313           mapM zonk_prag prags                  `thenM` \ new_prags ->
 314           returnM (tyvars, new_global, zonkIdOcc env local, new_prags)
 315     zonk_prag prag@(L _ (InlinePrag {}))  = return prag
 316     zonk_prag (L loc (SpecPrag expr ty ds inl))
 317         = do { expr' <- zonkExpr env expr
 318              ; ty'   <- zonkTcTypeToType env ty
 319              ; let ds' = zonkIdOccs env ds
 320              ; return (L loc (SpecPrag expr' ty' ds' inl)) }
 321 \end{code}
 322
 323 %************************************************************************
 324 %*                                                                      *
 325 \subsection[BackSubst-Match-GRHSs]{Match and GRHSs}
 326 %*                                                                      *
 327 %************************************************************************
 328
 329 \begin{code}
 330 zonkMatchGroup :: ZonkEnv -> MatchGroup TcId-> TcM (MatchGroup Id)
 331 zonkMatchGroup env (MatchGroup ms ty)
 332   = do  { ms' <- mapM (zonkMatch env) ms
 333         ; ty' <- zonkTcTypeToType env ty
 334         ; return (MatchGroup ms' ty') }
 335
 336 zonkMatch :: ZonkEnv -> LMatch TcId-> TcM (LMatch Id)
 337 zonkMatch env (L loc (Match pats _ grhss))
 338   = do  { (env1, new_pats) <- zonkPats env pats
 339         ; new_grhss <- zonkGRHSs env1 grhss
 340         ; return (L loc (Match new_pats Nothing new_grhss)) }
 341
 342 -------------------------------------------------------------------------
 343 zonkGRHSs :: ZonkEnv -> GRHSs TcId -> TcM (GRHSs Id)
 344
 345 zonkGRHSs env (GRHSs grhss binds)
 346   = zonkLocalBinds env binds    `thenM` \ (new_env, new_binds) ->
 347     let
 348         zonk_grhs (GRHS guarded rhs)
 349           = zonkStmts new_env guarded   `thenM` \ (env2, new_guarded) ->
 350             zonkLExpr env2 rhs          `thenM` \ new_rhs ->
 351             returnM (GRHS new_guarded new_rhs)
 352     in
 353     mappM (wrapLocM zonk_grhs) grhss    `thenM` \ new_grhss ->
 354     returnM (GRHSs new_grhss new_binds)
 355 \end{code}
 356
 357 %************************************************************************
 358 %*                                                                      *
 359 \subsection[BackSubst-HsExpr]{Running a zonkitution over a TypeCheckedExpr}
 360 %*                                                                      *
 361 %************************************************************************
 362
 363 \begin{code}
 364 zonkLExprs :: ZonkEnv -> [LHsExpr TcId] -> TcM [LHsExpr Id]
 365 zonkLExpr  :: ZonkEnv -> LHsExpr TcId   -> TcM (LHsExpr Id)
 366 zonkExpr   :: ZonkEnv -> HsExpr TcId    -> TcM (HsExpr Id)
 367
 368 zonkLExprs env exprs = mappM (zonkLExpr env) exprs
 369 zonkLExpr  env expr  = wrapLocM (zonkExpr env) expr
 370
 371 zonkExpr env (HsVar id)
 372   = returnM (HsVar (zonkIdOcc env id))
 373
 374 zonkExpr env (HsIPVar id)
 375   = returnM (HsIPVar (mapIPName (zonkIdOcc env) id))
 376
 377 zonkExpr env (HsLit (HsRat f ty))
 378   = zonkTcTypeToType env ty        `thenM` \ new_ty  ->
 379     returnM (HsLit (HsRat f new_ty))
 380
 381 zonkExpr env (HsLit lit)
 382   = returnM (HsLit lit)
 383
 384 zonkExpr env (HsOverLit lit)
 385   = do  { lit' <- zonkOverLit env lit
 386         ; return (HsOverLit lit') }
 387
 388 zonkExpr env (HsLam matches)
 389   = zonkMatchGroup env matches  `thenM` \ new_matches ->
 390     returnM (HsLam new_matches)
 391
 392 zonkExpr env (HsApp e1 e2)
 393   = zonkLExpr env e1    `thenM` \ new_e1 ->
 394     zonkLExpr env e2    `thenM` \ new_e2 ->
 395     returnM (HsApp new_e1 new_e2)
 396
 397 zonkExpr env (HsBracketOut body bs)
 398   = mappM zonk_b bs     `thenM` \ bs' ->
 399     returnM (HsBracketOut body bs')
 400   where
 401     zonk_b (n,e) = zonkLExpr env e      `thenM` \ e' ->
 402                    returnM (n,e')
 403
 404 zonkExpr env (HsSpliceE s) = WARN( True, ppr s )        -- Should not happen
 405                              returnM (HsSpliceE s)
 406
 407 zonkExpr env (OpApp e1 op fixity e2)
 408   = zonkLExpr env e1    `thenM` \ new_e1 ->
 409     zonkLExpr env op    `thenM` \ new_op ->
 410     zonkLExpr env e2    `thenM` \ new_e2 ->
 411     returnM (OpApp new_e1 new_op fixity new_e2)
 412
 413 zonkExpr env (NegApp expr op)
 414   = zonkLExpr env expr  `thenM` \ new_expr ->
 415     zonkExpr env op     `thenM` \ new_op ->
 416     returnM (NegApp new_expr new_op)
 417
 418 zonkExpr env (HsPar e)
 419   = zonkLExpr env e     `thenM` \new_e ->
 420     returnM (HsPar new_e)
 421
 422 zonkExpr env (SectionL expr op)
 423   = zonkLExpr env expr  `thenM` \ new_expr ->
 424     zonkLExpr env op            `thenM` \ new_op ->
 425     returnM (SectionL new_expr new_op)
 426
 427 zonkExpr env (SectionR op expr)
 428   = zonkLExpr env op            `thenM` \ new_op ->
 429     zonkLExpr env expr          `thenM` \ new_expr ->
 430     returnM (SectionR new_op new_expr)
 431
 432 zonkExpr env (HsCase expr ms)
 433   = zonkLExpr env expr          `thenM` \ new_expr ->
 434     zonkMatchGroup env ms       `thenM` \ new_ms ->
 435     returnM (HsCase new_expr new_ms)
 436
 437 zonkExpr env (HsIf e1 e2 e3)
 438   = zonkLExpr env e1    `thenM` \ new_e1 ->
 439     zonkLExpr env e2    `thenM` \ new_e2 ->
 440     zonkLExpr env e3    `thenM` \ new_e3 ->
 441     returnM (HsIf new_e1 new_e2 new_e3)
 442
 443 zonkExpr env (HsLet binds expr)
 444   = zonkLocalBinds env binds    `thenM` \ (new_env, new_binds) ->
 445     zonkLExpr new_env expr      `thenM` \ new_expr ->
 446     returnM (HsLet new_binds new_expr)
 447
 448 zonkExpr env (HsDo do_or_lc stmts body ty)
 449   = zonkStmts env stmts         `thenM` \ (new_env, new_stmts) ->
 450     zonkLExpr new_env body      `thenM` \ new_body ->
 451     zonkTcTypeToType env ty     `thenM` \ new_ty   ->
 452     returnM (HsDo (zonkDo env do_or_lc)
 453                   new_stmts new_body new_ty)
 454
 455 zonkExpr env (ExplicitList ty exprs)
 456   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
 457     zonkLExprs env exprs        `thenM` \ new_exprs ->
 458     returnM (ExplicitList new_ty new_exprs)
 459
 460 zonkExpr env (ExplicitPArr ty exprs)
 461   = zonkTcTypeToType env ty     `thenM` \ new_ty ->
 462     zonkLExprs env exprs        `thenM` \ new_exprs ->
 463     returnM (ExplicitPArr new_ty new_exprs)
 464
 465 zonkExpr env (ExplicitTuple exprs boxed)
 466   = zonkLExprs env exprs        `thenM` \ new_exprs ->
 467     returnM (ExplicitTuple new_exprs boxed)
 468
 469 zonkExpr env (RecordCon data_con con_expr rbinds)
 470   = do  { new_con_expr <- zonkExpr env con_expr
 471         ; new_rbinds   <- zonkRecFields env rbinds
 472         ; return (RecordCon data_con new_con_expr new_rbinds) }
 473
 474 zonkExpr env (RecordUpd expr rbinds cons in_tys out_tys)
 475   = do  { new_expr    <- zonkLExpr env expr
 476         ; new_in_tys  <- mapM (zonkTcTypeToType env) in_tys
 477         ; new_out_tys <- mapM (zonkTcTypeToType env) out_tys
 478         ; new_rbinds  <- zonkRecFields env rbinds
 479         ; return (RecordUpd new_expr new_rbinds cons new_in_tys new_out_tys) }
 480
 481 zonkExpr env (ExprWithTySigOut e ty)
 482   = do { e' <- zonkLExpr env e
 483        ; return (ExprWithTySigOut e' ty) }
 484
 485 zonkExpr env (ExprWithTySig _ _) = panic "zonkExpr env:ExprWithTySig"
 486
 487 zonkExpr env (ArithSeq expr info)
 488   = zonkExpr env expr           `thenM` \ new_expr ->
 489     zonkArithSeq env info       `thenM` \ new_info ->
 490     returnM (ArithSeq new_expr new_info)
 491
 492 zonkExpr env (PArrSeq expr info)
 493   = zonkExpr env expr           `thenM` \ new_expr ->
 494     zonkArithSeq env info       `thenM` \ new_info ->
 495     returnM (PArrSeq new_expr new_info)
 496
 497 zonkExpr env (HsSCC lbl expr)
 498   = zonkLExpr env expr  `thenM` \ new_expr ->
 499     returnM (HsSCC lbl new_expr)
 500
 501 zonkExpr env (HsTickPragma info expr)
 502   = zonkLExpr env expr  `thenM` \ new_expr ->
 503     returnM (HsTickPragma info new_expr)
 504
 505 -- hdaume: core annotations
 506 zonkExpr env (HsCoreAnn lbl expr)
 507   = zonkLExpr env expr   `thenM` \ new_expr ->
 508     returnM (HsCoreAnn lbl new_expr)
 509
 510 -- arrow notation extensions
 511 zonkExpr env (HsProc pat body)
 512   = do  { (env1, new_pat) <- zonkPat env pat
 513         ; new_body <- zonkCmdTop env1 body
 514         ; return (HsProc new_pat new_body) }
 515
 516 zonkExpr env (HsArrApp e1 e2 ty ho rl)
 517   = zonkLExpr env e1                    `thenM` \ new_e1 ->
 518     zonkLExpr env e2                    `thenM` \ new_e2 ->
 519     zonkTcTypeToType env ty             `thenM` \ new_ty ->
 520     returnM (HsArrApp new_e1 new_e2 new_ty ho rl)
 521
 522 zonkExpr env (HsArrForm op fixity args)
 523   = zonkLExpr env op                    `thenM` \ new_op ->
 524     mappM (zonkCmdTop env) args         `thenM` \ new_args ->
 525     returnM (HsArrForm new_op fixity new_args)
 526
 527 zonkExpr env (HsWrap co_fn expr)
 528   = zonkCoFn env co_fn  `thenM` \ (env1, new_co_fn) ->
 529     zonkExpr env1 expr  `thenM` \ new_expr ->
 530     return (HsWrap new_co_fn new_expr)
 531
 532 zonkExpr env other = pprPanic "zonkExpr" (ppr other)
 533
 534 zonkCmdTop :: ZonkEnv -> LHsCmdTop TcId -> TcM (LHsCmdTop Id)
 535 zonkCmdTop env cmd = wrapLocM (zonk_cmd_top env) cmd
 536
 537 zonk_cmd_top env (HsCmdTop cmd stack_tys ty ids)
 538   = zonkLExpr env cmd                   `thenM` \ new_cmd ->
 539     zonkTcTypeToTypes env stack_tys     `thenM` \ new_stack_tys ->
 540     zonkTcTypeToType env ty             `thenM` \ new_ty ->
 541     mapSndM (zonkExpr env) ids          `thenM` \ new_ids ->
 542     returnM (HsCmdTop new_cmd new_stack_tys new_ty new_ids)
 543
 544 -------------------------------------------------------------------------
 545 zonkCoFn :: ZonkEnv -> HsWrapper -> TcM (ZonkEnv, HsWrapper)
 546 zonkCoFn env WpHole   = return (env, WpHole)
 547 zonkCoFn env WpInline = return (env, WpInline)
 548 zonkCoFn env (WpCompose c1 c2) = do { (env1, c1') <- zonkCoFn env c1
 549                                     ; (env2, c2') <- zonkCoFn env1 c2
 550                                     ; return (env2, WpCompose c1' c2') }
 551 zonkCoFn env (WpCo co)      = do { co' <- zonkTcTypeToType env co
 552                                  ; return (env, WpCo co') }
 553 zonkCoFn env (WpLam id)     = do { id' <- zonkIdBndr env id
 554                                  ; let env1 = extendZonkEnv1 env id'
 555                                  ; return (env1, WpLam id') }
 556 zonkCoFn env (WpTyLam tv)   = ASSERT( isImmutableTyVar tv )
 557                               do { return (env, WpTyLam tv) }
 558 zonkCoFn env (WpApp id)     = do { return (env, WpApp (zonkIdOcc env id)) }
 559 zonkCoFn env (WpTyApp ty)   = do { ty' <- zonkTcTypeToType env ty
 560                                  ; return (env, WpTyApp ty') }
 561 zonkCoFn env (WpLet bs)     = do { (env1, bs') <- zonkRecMonoBinds env bs
 562                                  ; return (env1, WpLet bs') }
 563
 564
 565 -------------------------------------------------------------------------
 566 zonkDo :: ZonkEnv -> HsStmtContext Name -> HsStmtContext Name
 567 -- Only used for 'do', so the only Ids are in a MDoExpr table
 568 zonkDo env (MDoExpr tbl) = MDoExpr (mapSnd (zonkIdOcc env) tbl)
 569 zonkDo env do_or_lc      = do_or_lc
 570
 571 -------------------------------------------------------------------------
 572 zonkOverLit :: ZonkEnv -> HsOverLit TcId -> TcM (HsOverLit Id)
 573 zonkOverLit env ol =
 574     let
 575         zonkedStuff = do ty' <- zonkTcTypeToType env (overLitType ol)
 576                          e' <- zonkExpr env (overLitExpr ol)
 577                          return (e', ty')
 578         ru f (x, y) = return (f x y)
 579     in
 580       case ol of
 581         (HsIntegral i _ _)   -> ru (HsIntegral i) =<< zonkedStuff
 582         (HsFractional r _ _) -> ru (HsFractional r) =<< zonkedStuff
 583         (HsIsString s _ _)   -> ru (HsIsString s) =<< zonkedStuff
 584
 585 -------------------------------------------------------------------------
 586 zonkArithSeq :: ZonkEnv -> ArithSeqInfo TcId -> TcM (ArithSeqInfo Id)
 587
 588 zonkArithSeq env (From e)
 589   = zonkLExpr env e             `thenM` \ new_e ->
 590     returnM (From new_e)
 591
 592 zonkArithSeq env (FromThen e1 e2)
 593   = zonkLExpr env e1    `thenM` \ new_e1 ->
 594     zonkLExpr env e2    `thenM` \ new_e2 ->
 595     returnM (FromThen new_e1 new_e2)
 596
 597 zonkArithSeq env (FromTo e1 e2)
 598   = zonkLExpr env e1    `thenM` \ new_e1 ->
 599     zonkLExpr env e2    `thenM` \ new_e2 ->
 600     returnM (FromTo new_e1 new_e2)
 601
 602 zonkArithSeq env (FromThenTo e1 e2 e3)
 603   = zonkLExpr env e1    `thenM` \ new_e1 ->
 604     zonkLExpr env e2    `thenM` \ new_e2 ->
 605     zonkLExpr env e3    `thenM` \ new_e3 ->
 606     returnM (FromThenTo new_e1 new_e2 new_e3)
 607
 608
 609 -------------------------------------------------------------------------
 610 zonkStmts :: ZonkEnv -> [LStmt TcId] -> TcM (ZonkEnv, [LStmt Id])
 611 zonkStmts env []     = return (env, [])
 612 zonkStmts env (s:ss) = do { (env1, s')  <- wrapLocSndM (zonkStmt env) s
 613                           ; (env2, ss') <- zonkStmts env1 ss
 614                           ; return (env2, s' : ss') }
 615
 616 zonkStmt :: ZonkEnv -> Stmt TcId -> TcM (ZonkEnv, Stmt Id)
 617 zonkStmt env (ParStmt stmts_w_bndrs)
 618   = mappM zonk_branch stmts_w_bndrs     `thenM` \ new_stmts_w_bndrs ->
 619     let
 620         new_binders = concat (map snd new_stmts_w_bndrs)
 621         env1 = extendZonkEnv env new_binders
 622     in
 623     return (env1, ParStmt new_stmts_w_bndrs)
 624   where
 625     zonk_branch (stmts, bndrs) = zonkStmts env stmts    `thenM` \ (env1, new_stmts) ->
 626                                  returnM (new_stmts, zonkIdOccs env1 bndrs)
 627
 628 zonkStmt env (RecStmt segStmts lvs rvs rets binds)
 629   = zonkIdBndrs env rvs         `thenM` \ new_rvs ->
 630     let
 631         env1 = extendZonkEnv env new_rvs
 632     in
 633     zonkStmts env1 segStmts     `thenM` \ (env2, new_segStmts) ->
 634         -- Zonk the ret-expressions in an envt that
 635         -- has the polymorphic bindings in the envt
 636     mapM (zonkExpr env2) rets   `thenM` \ new_rets ->
 637     let
 638         new_lvs = zonkIdOccs env2 lvs
 639         env3 = extendZonkEnv env new_lvs        -- Only the lvs are needed
 640     in
 641     zonkRecMonoBinds env3 binds `thenM` \ (env4, new_binds) ->
 642     returnM (env4, RecStmt new_segStmts new_lvs new_rvs new_rets new_binds)
 643
 644 zonkStmt env (ExprStmt expr then_op ty)
 645   = zonkLExpr env expr          `thenM` \ new_expr ->
 646     zonkExpr env then_op        `thenM` \ new_then ->
 647     zonkTcTypeToType env ty     `thenM` \ new_ty ->
 648     returnM (env, ExprStmt new_expr new_then new_ty)
 649
 650 zonkStmt env (TransformStmt (stmts, binders) usingExpr maybeByExpr)
 651   = do { (env', stmts') <- zonkStmts env stmts
 652     ; let binders' = zonkIdOccs env' binders
 653     ; usingExpr' <- zonkLExpr env' usingExpr
 654     ; maybeByExpr' <- zonkMaybeLExpr env' maybeByExpr
 655     ; return (env', TransformStmt (stmts', binders') usingExpr' maybeByExpr') }
 656
 657 zonkStmt env (GroupStmt (stmts, binderMap) groupByClause)
 658   = do { (env', stmts') <- zonkStmts env stmts
 659     ; binderMap' <- mappM (zonkBinderMapEntry env') binderMap
 660     ; groupByClause' <-
 661         case groupByClause of
 662             GroupByNothing usingExpr -> (zonkLExpr env' usingExpr) >>= (return . GroupByNothing)
 663             GroupBySomething eitherUsingExpr byExpr -> do
 664                 eitherUsingExpr' <- mapEitherM (zonkLExpr env') (zonkExpr env') eitherUsingExpr
 665                 byExpr' <- zonkLExpr env' byExpr
 666                 return $ GroupBySomething eitherUsingExpr' byExpr'
 667
 668     ; let env'' = extendZonkEnv env' (map snd binderMap')
 669     ; return (env'', GroupStmt (stmts', binderMap') groupByClause') }
 670   where
 671     mapEitherM f g x = do
 672       case x of
 673         Left a -> f a >>= (return . Left)
 674         Right b -> g b >>= (return . Right)
 675
 676     zonkBinderMapEntry env (oldBinder, newBinder) = do
 677         let oldBinder' = zonkIdOcc env oldBinder
 678         newBinder' <- zonkIdBndr env newBinder
 679         return (oldBinder', newBinder')
 680
 681 zonkStmt env (LetStmt binds)
 682   = zonkLocalBinds env binds    `thenM` \ (env1, new_binds) ->
 683     returnM (env1, LetStmt new_binds)
 684
 685 zonkStmt env (BindStmt pat expr bind_op fail_op)
 686   = do  { new_expr <- zonkLExpr env expr
 687         ; (env1, new_pat) <- zonkPat env pat
 688         ; new_bind <- zonkExpr env bind_op
 689         ; new_fail <- zonkExpr env fail_op
 690         ; return (env1, BindStmt new_pat new_expr new_bind new_fail) }
 691
 692 zonkMaybeLExpr env Nothing = return Nothing
 693 zonkMaybeLExpr env (Just e) = (zonkLExpr env e) >>= (return . Just)
 694
 695
 696 -------------------------------------------------------------------------
 697 zonkRecFields :: ZonkEnv -> HsRecordBinds TcId -> TcM (HsRecordBinds TcId)
 698 zonkRecFields env (HsRecFields flds dd)
 699   = do  { flds' <- mappM zonk_rbind flds
 700         ; return (HsRecFields flds' dd) }
 701   where
 702     zonk_rbind fld
 703       = do { new_expr <- zonkLExpr env (hsRecFieldArg fld)
 704            ; return (fld { hsRecFieldArg = new_expr }) }
 705         -- Field selectors have declared types; hence no zonking
 706
 707 -------------------------------------------------------------------------
 708 mapIPNameTc :: (a -> TcM b) -> IPName a -> TcM (IPName b)
 709 mapIPNameTc f (IPName n) = f n  `thenM` \ r -> returnM (IPName r)
 710 \end{code}
 711
 712
 713 %************************************************************************
 714 %*                                                                      *
 715 \subsection[BackSubst-Pats]{Patterns}
 716 %*                                                                      *
 717 %************************************************************************
 718
 719 \begin{code}
 720 zonkPat :: ZonkEnv -> OutPat TcId -> TcM (ZonkEnv, OutPat Id)
 721 -- Extend the environment as we go, because it's possible for one
 722 -- pattern to bind something that is used in another (inside or
 723 -- to the right)
 724 zonkPat env pat = wrapLocSndM (zonk_pat env) pat
 725
 726 zonk_pat env (ParPat p)
 727   = do  { (env', p') <- zonkPat env p
 728         ; return (env', ParPat p') }
 729
 730 zonk_pat env (WildPat ty)
 731   = do  { ty' <- zonkTcTypeToType env ty
 732         ; return (env, WildPat ty') }
 733
 734 zonk_pat env (VarPat v)
 735   = do  { v' <- zonkIdBndr env v
 736         ; return (extendZonkEnv1 env v', VarPat v') }
 737
 738 zonk_pat env (VarPatOut v binds)
 739   = do  { v' <- zonkIdBndr env v
 740         ; (env', binds') <- zonkRecMonoBinds (extendZonkEnv1 env v') binds
 741         ; returnM (env', VarPatOut v' binds') }
 742
 743 zonk_pat env (LazyPat pat)
 744   = do  { (env', pat') <- zonkPat env pat
 745         ; return (env',  LazyPat pat') }
 746
 747 zonk_pat env (BangPat pat)
 748   = do  { (env', pat') <- zonkPat env pat
 749         ; return (env',  BangPat pat') }
 750
 751 zonk_pat env (AsPat (L loc v) pat)
 752   = do  { v' <- zonkIdBndr env v
 753         ; (env', pat') <- zonkPat (extendZonkEnv1 env v') pat
 754         ; return (env', AsPat (L loc v') pat') }
 755
 756 zonk_pat env (ViewPat expr pat ty)
 757   = do  { expr' <- zonkLExpr env expr
 758         ; (env', pat') <- zonkPat env pat
 759         ; return (env', ViewPat expr' pat' ty) }
 760
 761 zonk_pat env (ListPat pats ty)
 762   = do  { ty' <- zonkTcTypeToType env ty
 763         ; (env', pats') <- zonkPats env pats
 764         ; return (env', ListPat pats' ty') }
 765
 766 zonk_pat env (PArrPat pats ty)
 767   = do  { ty' <- zonkTcTypeToType env ty
 768         ; (env', pats') <- zonkPats env pats
 769         ; return (env', PArrPat pats' ty') }
 770
 771 zonk_pat env (TuplePat pats boxed ty)
 772   = do  { ty' <- zonkTcTypeToType env ty
 773         ; (env', pats') <- zonkPats env pats
 774         ; return (env', TuplePat pats' boxed ty') }
 775
 776 zonk_pat env p@(ConPatOut { pat_ty = ty, pat_dicts = dicts, pat_binds = binds, pat_args = args })
 777   = ASSERT( all isImmutableTyVar (pat_tvs p) )
 778     do  { new_ty <- zonkTcTypeToType env ty
 779         ; new_dicts <- zonkIdBndrs env dicts
 780         ; let env1 = extendZonkEnv env new_dicts
 781         ; (env2, new_binds) <- zonkRecMonoBinds env1 binds
 782         ; (env', new_args) <- zonkConStuff env2 args
 783         ; returnM (env', p { pat_ty = new_ty, pat_dicts = new_dicts,
 784                              pat_binds = new_binds, pat_args = new_args }) }
 785
 786 zonk_pat env (LitPat lit) = return (env, LitPat lit)
 787
 788 zonk_pat env (SigPatOut pat ty)
 789   = do  { ty' <- zonkTcTypeToType env ty
 790         ; (env', pat') <- zonkPat env pat
 791         ; return (env', SigPatOut pat' ty') }
 792
 793 zonk_pat env (NPat lit mb_neg eq_expr)
 794   = do  { lit' <- zonkOverLit env lit
 795         ; mb_neg' <- case mb_neg of
 796                         Nothing  -> return Nothing
 797                         Just neg -> do { neg' <- zonkExpr env neg
 798                                        ; return (Just neg') }
 799         ; eq_expr' <- zonkExpr env eq_expr
 800         ; return (env, NPat lit' mb_neg' eq_expr') }
 801
 802 zonk_pat env (NPlusKPat (L loc n) lit e1 e2)
 803   = do  { n' <- zonkIdBndr env n
 804         ; lit' <- zonkOverLit env lit
 805         ; e1' <- zonkExpr env e1
 806         ; e2' <- zonkExpr env e2
 807         ; return (extendZonkEnv1 env n', NPlusKPat (L loc n') lit' e1' e2') }
 808
 809 zonk_pat env (CoPat co_fn pat ty)
 810   = do { (env', co_fn') <- zonkCoFn env co_fn
 811        ; (env'', pat') <- zonkPat env' (noLoc pat)
 812        ; ty' <- zonkTcTypeToType env'' ty
 813        ; return (env'', CoPat co_fn' (unLoc pat') ty') }
 814
 815 zonk_pat env pat = pprPanic "zonk_pat" (ppr pat)
 816
 817 ---------------------------
 818 zonkConStuff env (PrefixCon pats)
 819   = do  { (env', pats') <- zonkPats env pats
 820         ; return (env', PrefixCon pats') }
 821
 822 zonkConStuff env (InfixCon p1 p2)
 823   = do  { (env1, p1') <- zonkPat env  p1
 824         ; (env', p2') <- zonkPat env1 p2
 825         ; return (env', InfixCon p1' p2') }
 826
 827 zonkConStuff env (RecCon (HsRecFields rpats dd))
 828   = do  { (env', pats') <- zonkPats env (map hsRecFieldArg rpats)
 829         ; let rpats' = zipWith (\rp p' -> rp { hsRecFieldArg = p' }) rpats pats'
 830         ; returnM (env', RecCon (HsRecFields rpats' dd)) }
 831         -- Field selectors have declared types; hence no zonking
 832
 833 ---------------------------
 834 zonkPats env []         = return (env, [])
 835 zonkPats env (pat:pats) = do { (env1, pat') <- zonkPat env pat
 836                      ; (env', pats') <- zonkPats env1 pats
 837                      ; return (env', pat':pats') }
 838 \end{code}
 839
 840 %************************************************************************
 841 %*                                                                      *
 842 \subsection[BackSubst-Foreign]{Foreign exports}
 843 %*                                                                      *
 844 %************************************************************************
 845
 846
 847 \begin{code}
 848 zonkForeignExports :: ZonkEnv -> [LForeignDecl TcId] -> TcM [LForeignDecl Id]
 849 zonkForeignExports env ls = mappM (wrapLocM (zonkForeignExport env)) ls
 850
 851 zonkForeignExport :: ZonkEnv -> ForeignDecl TcId -> TcM (ForeignDecl Id)
 852 zonkForeignExport env (ForeignExport i hs_ty spec) =
 853    returnM (ForeignExport (fmap (zonkIdOcc env) i) undefined spec)
 854 zonkForeignExport env for_imp
 855   = returnM for_imp     -- Foreign imports don't need zonking
 856 \end{code}
 857
 858 \begin{code}
 859 zonkRules :: ZonkEnv -> [LRuleDecl TcId] -> TcM [LRuleDecl Id]
 860 zonkRules env rs = mappM (wrapLocM (zonkRule env)) rs
 861
 862 zonkRule :: ZonkEnv -> RuleDecl TcId -> TcM (RuleDecl Id)
 863 zonkRule env (HsRule name act (vars::[RuleBndr TcId]) lhs fv_lhs rhs fv_rhs)
 864   = mappM zonk_bndr vars                `thenM` \ new_bndrs ->
 865     newMutVar emptyVarSet               `thenM` \ unbound_tv_set ->
 866     let
 867         env_rhs = extendZonkEnv env [id | b <- new_bndrs, let id = unLoc b, isId id]
 868         -- Type variables don't need an envt
 869         -- They are bound through the mutable mechanism
 870
 871         env_lhs = setZonkType env_rhs (zonkTypeCollecting unbound_tv_set)
 872         -- We need to gather the type variables mentioned on the LHS so we can
 873         -- quantify over them.  Example:
 874         --   data T a = C
 875         --
 876         --   foo :: T a -> Int
 877         --   foo C = 1
 878         --
 879         --   {-# RULES "myrule"  foo C = 1 #-}
 880         --
 881         -- After type checking the LHS becomes (foo a (C a))
 882         -- and we do not want to zap the unbound tyvar 'a' to (), because
 883         -- that limits the applicability of the rule.  Instead, we
 884         -- want to quantify over it!
 885         --
 886         -- It's easiest to find the free tyvars here. Attempts to do so earlier
 887         -- are tiresome, because (a) the data type is big and (b) finding the
 888         -- free type vars of an expression is necessarily monadic operation.
 889         --      (consider /\a -> f @ b, where b is side-effected to a)
 890     in
 891     zonkLExpr env_lhs lhs               `thenM` \ new_lhs ->
 892     zonkLExpr env_rhs rhs               `thenM` \ new_rhs ->
 893
 894     readMutVar unbound_tv_set           `thenM` \ unbound_tvs ->
 895     let
 896         final_bndrs :: [Located Var]
 897         final_bndrs = map noLoc (varSetElems unbound_tvs) ++ new_bndrs
 898     in
 899     returnM (HsRule name act (map RuleBndr final_bndrs) new_lhs fv_lhs new_rhs fv_rhs)
 900                 -- I hate this map RuleBndr stuff
 901   where
 902    zonk_bndr (RuleBndr v)
 903         | isId (unLoc v) = wrapLocM (zonkIdBndr env)   v
 904         | otherwise      = ASSERT( isImmutableTyVar (unLoc v) )
 905                            return v
 906 \end{code}
 907
 908
 909 %************************************************************************
 910 %*                                                                      *
 911 \subsection[BackSubst-Foreign]{Foreign exports}
 912 %*                                                                      *
 913 %************************************************************************
 914
 915 \begin{code}
 916 zonkTcTypeToType :: ZonkEnv -> TcType -> TcM Type
 917 zonkTcTypeToType (ZonkEnv zonk_ty _) ty = zonk_ty ty
 918
 919 zonkTcTypeToTypes :: ZonkEnv -> [TcType] -> TcM [Type]
 920 zonkTcTypeToTypes env tys = mapM (zonkTcTypeToType env) tys
 921
 922 zonkTypeCollecting :: TcRef TyVarSet -> TcType -> TcM Type
 923 -- This variant collects unbound type variables in a mutable variable
 924 zonkTypeCollecting unbound_tv_set
 925   = zonkType zonk_unbound_tyvar
 926   where
 927     zonk_unbound_tyvar tv
 928         = zonkQuantifiedTyVar tv                                `thenM` \ tv' ->
 929           readMutVar unbound_tv_set                             `thenM` \ tv_set ->
 930           writeMutVar unbound_tv_set (extendVarSet tv_set tv')  `thenM_`
 931           return (mkTyVarTy tv')
 932
 933 zonkTypeZapping :: TcType -> TcM Type
 934 -- This variant is used for everything except the LHS of rules
 935 -- It zaps unbound type variables to (), or some other arbitrary type
 936 zonkTypeZapping ty
 937   = zonkType zonk_unbound_tyvar ty
 938   where
 939         -- Zonk a mutable but unbound type variable to an arbitrary type
 940         -- We know it's unbound even though we don't carry an environment,
 941         -- because at the binding site for a type variable we bind the
 942         -- mutable tyvar to a fresh immutable one.  So the mutable store
 943         -- plays the role of an environment.  If we come across a mutable
 944         -- type variable that isn't so bound, it must be completely free.
 945     zonk_unbound_tyvar tv = do { ty <- mkArbitraryType warn tv
 946                                ; writeMetaTyVar tv ty
 947                                ; return ty }
 948         where
 949             warn span msg = setSrcSpan span (addWarnTc msg)
 950
 951
 952 {-      Note [Strangely-kinded void TyCons]
 953         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 954         See Trac #959 for more examples
 955
 956 When the type checker finds a type variable with no binding, which
 957 means it can be instantiated with an arbitrary type, it usually
 958 instantiates it to Void.  Eg.
 959
 960         length []
 961 ===>
 962         length Void (Nil Void)
 963
 964 But in really obscure programs, the type variable might have a kind
 965 other than *, so we need to invent a suitably-kinded type.
 966
 967 This commit uses
 968         Void for kind *
 969         List for kind *->*
 970         Tuple for kind *->...*->*
 971
 972 which deals with most cases.  (Previously, it only dealt with
 973 kind *.)
 974
 975 In the other cases, it just makes up a TyCon with a suitable kind.  If
 976 this gets into an interface file, anyone reading that file won't
 977 understand it.  This is fixable (by making the client of the interface
 978 file make up a TyCon too) but it is tiresome and never happens, so I
 979 am leaving it.
 980
 981 Meanwhile I have now fixed GHC to emit a civilized warning.
 982  -}
 983
 984 mkArbitraryType :: (SrcSpan -> SDoc -> TcRnIf g l a)    -- How to complain
 985                 -> TcTyVar
 986                 -> TcRnIf g l Type              -- Used by desugarer too
 987 -- Make up an arbitrary type whose kind is the same as the tyvar.
 988 -- We'll use this to instantiate the (unbound) tyvar.
 989 --
 990 -- Also used by the desugarer; hence the (tiresome) parameter
 991 -- to use when generating a warning
 992 mkArbitraryType warn tv
 993   | liftedTypeKind `isSubKind` kind             -- The vastly common case
 994    = return anyPrimTy
 995   | eqKind kind (tyConKind anyPrimTyCon1)       --  *->*
 996   = return (mkTyConApp anyPrimTyCon1 [])        --     No tuples this size
 997   | all isLiftedTypeKind args                   -- *-> ... ->*->*
 998   , isLiftedTypeKind res                        --    Horrible hack to make less use
 999   = return (mkTyConApp tup_tc [])               --    of mkAnyPrimTyCon
1000   | otherwise
1001   = do  { warn (getSrcSpan tv) msg
1002         ; return (mkTyConApp (mkAnyPrimTyCon (getUnique tv) kind) []) }
1003                 -- Same name as the tyvar, apart from making it start with a colon (sigh)
1004                 -- I dread to think what will happen if this gets out into an
1005                 -- interface file.  Catastrophe likely.  Major sigh.
1006   where
1007     kind       = tyVarKind tv
1008     (args,res) = splitKindFunTys kind
1009     tup_tc     = tupleTyCon Boxed (length args)
1010
1011     msg = vcat [ hang (ptext SLIT("Inventing strangely-kinded Any TyCon"))
1012                     2 (ptext SLIT("of kind") <+> quotes (ppr kind))
1013                , nest 2 (ptext SLIT("from an instantiation of type variable") <+> quotes (ppr tv))
1014                , ptext SLIT("This warning can be suppressed by a type signature fixing") <+> quotes (ppr tv)
1015                , nest 2 (ptext SLIT("but is harmless without -O (and usually harmless anyway)."))
1016                , ptext SLIT("See http://hackage.haskell.org/trac/ghc/ticket/959 for details")  ]
1017 \end{code}