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