compiler/typecheck/TcBinds.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   4 %
   5 \section[TcBinds]{TcBinds}
   6
   7 \begin{code}
   8 module TcBinds ( tcLocalBinds, tcTopBinds,
   9                  tcHsBootSigs, tcMonoBinds, tcPolyBinds,
  10                  TcPragFun, tcSpecPrag, tcPrags, mkPragFun,
  11                  TcSigInfo(..), TcSigFun, mkTcSigFun,
  12                  badBootDeclErr ) where
  13
  14 import {-# SOURCE #-} TcMatches ( tcGRHSsPat, tcMatchesFun )
  15 import {-# SOURCE #-} TcExpr  ( tcMonoExpr )
  16
  17 import DynFlags
  18 import HsSyn
  19
  20 import TcRnMonad
  21 import Inst
  22 import TcEnv
  23 import TcUnify
  24 import TcSimplify
  25 import TcHsType
  26 import TcPat
  27 import TcMType
  28 import TcType
  29 import {- Kind parts of -} Type
  30 import Coercion
  31 import VarEnv
  32 import TysPrim
  33 import Id
  34 import Var
  35 import Name
  36 import NameSet
  37 import NameEnv
  38 import VarSet
  39 import SrcLoc
  40 import Bag
  41 import ErrUtils
  42 import Digraph
  43 import Maybes
  44 import List
  45 import Util
  46 import BasicTypes
  47 import Outputable
  48 import FastString
  49
  50 import Control.Monad
  51 \end{code}
  52
  53
  54 %************************************************************************
  55 %*                                                                      *
  56 \subsection{Type-checking bindings}
  57 %*                                                                      *
  58 %************************************************************************
  59
  60 @tcBindsAndThen@ typechecks a @HsBinds@.  The "and then" part is because
  61 it needs to know something about the {\em usage} of the things bound,
  62 so that it can create specialisations of them.  So @tcBindsAndThen@
  63 takes a function which, given an extended environment, E, typechecks
  64 the scope of the bindings returning a typechecked thing and (most
  65 important) an LIE.  It is this LIE which is then used as the basis for
  66 specialising the things bound.
  67
  68 @tcBindsAndThen@ also takes a "combiner" which glues together the
  69 bindings and the "thing" to make a new "thing".
  70
  71 The real work is done by @tcBindWithSigsAndThen@.
  72
  73 Recursive and non-recursive binds are handled in essentially the same
  74 way: because of uniques there are no scoping issues left.  The only
  75 difference is that non-recursive bindings can bind primitive values.
  76
  77 Even for non-recursive binding groups we add typings for each binder
  78 to the LVE for the following reason.  When each individual binding is
  79 checked the type of its LHS is unified with that of its RHS; and
  80 type-checking the LHS of course requires that the binder is in scope.
  81
  82 At the top-level the LIE is sure to contain nothing but constant
  83 dictionaries, which we resolve at the module level.
  84
  85 \begin{code}
  86 tcTopBinds :: HsValBinds Name -> TcM (LHsBinds TcId, TcLclEnv)
  87         -- Note: returning the TcLclEnv is more than we really
  88         --       want.  The bit we care about is the local bindings
  89         --       and the free type variables thereof
  90 tcTopBinds binds
  91   = do  { (ValBindsOut prs _, env) <- tcValBinds TopLevel binds getLclEnv
  92         ; return (foldr (unionBags . snd) emptyBag prs, env) }
  93         -- The top level bindings are flattened into a giant
  94         -- implicitly-mutually-recursive LHsBinds
  95
  96 tcHsBootSigs :: HsValBinds Name -> TcM [Id]
  97 -- A hs-boot file has only one BindGroup, and it only has type
  98 -- signatures in it.  The renamer checked all this
  99 tcHsBootSigs (ValBindsOut binds sigs)
 100   = do  { checkTc (null binds) badBootDeclErr
 101         ; mapM (addLocM tc_boot_sig) (filter isTypeLSig sigs) }
 102   where
 103     tc_boot_sig (TypeSig (L _ name) ty)
 104       = do { sigma_ty <- tcHsSigType (FunSigCtxt name) ty
 105            ; return (mkVanillaGlobal name sigma_ty) }
 106         -- Notice that we make GlobalIds, not LocalIds
 107     tc_boot_sig s = pprPanic "tcHsBootSigs/tc_boot_sig" (ppr s)
 108 tcHsBootSigs groups = pprPanic "tcHsBootSigs" (ppr groups)
 109
 110 badBootDeclErr :: Message
 111 badBootDeclErr = ptext (sLit "Illegal declarations in an hs-boot file")
 112
 113 ------------------------
 114 tcLocalBinds :: HsLocalBinds Name -> TcM thing
 115              -> TcM (HsLocalBinds TcId, thing)
 116
 117 tcLocalBinds EmptyLocalBinds thing_inside
 118   = do  { thing <- thing_inside
 119         ; return (EmptyLocalBinds, thing) }
 120
 121 tcLocalBinds (HsValBinds binds) thing_inside
 122   = do  { (binds', thing) <- tcValBinds NotTopLevel binds thing_inside
 123         ; return (HsValBinds binds', thing) }
 124
 125 tcLocalBinds (HsIPBinds (IPBinds ip_binds _)) thing_inside
 126   = do  { (thing, lie) <- getLIE thing_inside
 127         ; (avail_ips, ip_binds') <- mapAndUnzipM (wrapLocSndM tc_ip_bind) ip_binds
 128
 129         -- If the binding binds ?x = E, we  must now
 130         -- discharge any ?x constraints in expr_lie
 131         ; dict_binds <- tcSimplifyIPs avail_ips lie
 132         ; return (HsIPBinds (IPBinds ip_binds' dict_binds), thing) }
 133   where
 134         -- I wonder if we should do these one at at time
 135         -- Consider     ?x = 4
 136         --              ?y = ?x + 1
 137     tc_ip_bind (IPBind ip expr) = do
 138         ty <- newFlexiTyVarTy argTypeKind
 139         (ip', ip_inst) <- newIPDict (IPBindOrigin ip) ip ty
 140         expr' <- tcMonoExpr expr ty
 141         return (ip_inst, (IPBind ip' expr'))
 142
 143 ------------------------
 144 tcValBinds :: TopLevelFlag
 145            -> HsValBinds Name -> TcM thing
 146            -> TcM (HsValBinds TcId, thing)
 147
 148 tcValBinds _ (ValBindsIn binds _) _
 149   = pprPanic "tcValBinds" (ppr binds)
 150
 151 tcValBinds top_lvl (ValBindsOut binds sigs) thing_inside
 152   = do  {       -- Typecheck the signature
 153         ; let { prag_fn = mkPragFun sigs
 154               ; ty_sigs = filter isTypeLSig sigs
 155               ; sig_fn  = mkTcSigFun ty_sigs }
 156
 157         ; poly_ids <- checkNoErrs (mapAndRecoverM tcTySig ty_sigs)
 158                 -- No recovery from bad signatures, because the type sigs
 159                 -- may bind type variables, so proceeding without them
 160                 -- can lead to a cascade of errors
 161                 -- ToDo: this means we fall over immediately if any type sig
 162                 -- is wrong, which is over-conservative, see Trac bug #745
 163
 164                 -- Extend the envt right away with all
 165                 -- the Ids declared with type signatures
 166         ; poly_rec <- doptM Opt_RelaxedPolyRec
 167         ; (binds', thing) <- tcExtendIdEnv poly_ids $
 168                              tcBindGroups poly_rec top_lvl sig_fn prag_fn
 169                                           binds thing_inside
 170
 171         ; return (ValBindsOut binds' sigs, thing) }
 172
 173 ------------------------
 174 tcBindGroups :: Bool -> TopLevelFlag -> TcSigFun -> TcPragFun
 175              -> [(RecFlag, LHsBinds Name)] -> TcM thing
 176              -> TcM ([(RecFlag, LHsBinds TcId)], thing)
 177 -- Typecheck a whole lot of value bindings,
 178 -- one strongly-connected component at a time
 179 -- Here a "strongly connected component" has the strightforward
 180 -- meaning of a group of bindings that mention each other,
 181 -- ignoring type signatures (that part comes later)
 182
 183 tcBindGroups _ _ _ _ [] thing_inside
 184   = do  { thing <- thing_inside
 185         ; return ([], thing) }
 186
 187 tcBindGroups poly_rec top_lvl sig_fn prag_fn (group : groups) thing_inside
 188   = do  { (group', (groups', thing))
 189                 <- tc_group poly_rec top_lvl sig_fn prag_fn group $
 190                    tcBindGroups poly_rec top_lvl sig_fn prag_fn groups thing_inside
 191         ; return (group' ++ groups', thing) }
 192
 193 ------------------------
 194 tc_group :: Bool -> TopLevelFlag -> TcSigFun -> TcPragFun
 195          -> (RecFlag, LHsBinds Name) -> TcM thing
 196          -> TcM ([(RecFlag, LHsBinds TcId)], thing)
 197
 198 -- Typecheck one strongly-connected component of the original program.
 199 -- We get a list of groups back, because there may
 200 -- be specialisations etc as well
 201
 202 tc_group _ top_lvl sig_fn prag_fn (NonRecursive, binds) thing_inside
 203         -- A single non-recursive binding
 204         -- We want to keep non-recursive things non-recursive
 205         -- so that we desugar unlifted bindings correctly
 206  =  do  { (binds1, lie_binds, thing) <- tc_haskell98 top_lvl sig_fn prag_fn
 207                                                      NonRecursive binds thing_inside
 208         ; return ( [(NonRecursive, unitBag b) | b <- bagToList binds1]
 209                      ++ [(Recursive, lie_binds)]  -- TcDictBinds have scrambled dependency order
 210                  , thing) }
 211
 212 tc_group poly_rec top_lvl sig_fn prag_fn (Recursive, binds) thing_inside
 213   | not poly_rec        -- Recursive group, normal Haskell 98 route
 214   = do  { (binds1, lie_binds, thing) <- tc_haskell98 top_lvl sig_fn prag_fn
 215                                                      Recursive binds thing_inside
 216         ; return ([(Recursive, binds1 `unionBags` lie_binds)], thing) }
 217
 218   | otherwise           -- Recursive group, with -XRelaxedPolyRec
 219   =     -- To maximise polymorphism (with -XRelaxedPolyRec), we do a new
 220         -- strongly-connected-component analysis, this time omitting
 221         -- any references to variables with type signatures.
 222         --
 223         -- Notice that the bindInsts thing covers *all* the bindings in
 224         -- the original group at once; an earlier one may use a later one!
 225     do  { traceTc (text "tc_group rec" <+> pprLHsBinds binds)
 226         ; (binds1,lie_binds,thing) <- bindLocalInsts top_lvl $
 227                             go (stronglyConnCompFromEdgedVertices (mkEdges sig_fn binds))
 228         ; return ([(Recursive, binds1 `unionBags` lie_binds)], thing) }
 229                 -- Rec them all together
 230   where
 231 --  go :: SCC (LHsBind Name) -> TcM (LHsBinds TcId, [TcId], thing)
 232     go (scc:sccs) = do  { (binds1, ids1) <- tc_scc scc
 233                         ; (binds2, ids2, thing) <- tcExtendIdEnv ids1 $ go sccs
 234                         ; return (binds1 `unionBags` binds2, ids1 ++ ids2, thing) }
 235     go []         = do  { thing <- thing_inside; return (emptyBag, [], thing) }
 236
 237     tc_scc (AcyclicSCC bind) = tc_sub_group NonRecursive (unitBag bind)
 238     tc_scc (CyclicSCC binds) = tc_sub_group Recursive    (listToBag binds)
 239
 240     tc_sub_group = tcPolyBinds top_lvl sig_fn prag_fn Recursive
 241
 242 tc_haskell98 :: TopLevelFlag -> TcSigFun -> TcPragFun -> RecFlag
 243              -> LHsBinds Name -> TcM a -> TcM (LHsBinds TcId, TcDictBinds, a)
 244 tc_haskell98 top_lvl sig_fn prag_fn rec_flag binds thing_inside
 245   = bindLocalInsts top_lvl $
 246     do { (binds1, ids) <- tcPolyBinds top_lvl sig_fn prag_fn rec_flag rec_flag binds
 247        ; thing <- tcExtendIdEnv ids thing_inside
 248        ; return (binds1, ids, thing) }
 249
 250 ------------------------
 251 bindLocalInsts :: TopLevelFlag
 252                -> TcM (LHsBinds TcId, [TcId],      a)
 253                -> TcM (LHsBinds TcId, TcDictBinds, a)
 254 bindLocalInsts top_lvl thing_inside
 255   | isTopLevel top_lvl
 256   = do { (binds, _, thing) <- thing_inside; return (binds, emptyBag, thing) }
 257         -- For the top level don't bother with all this bindInstsOfLocalFuns stuff.
 258         -- All the top level things are rec'd together anyway, so it's fine to
 259         -- leave them to the tcSimplifyTop, and quite a bit faster too
 260
 261   | otherwise   -- Nested case
 262   = do  { ((binds, ids, thing), lie) <- getLIE thing_inside
 263         ; lie_binds <- bindInstsOfLocalFuns lie ids
 264         ; return (binds, lie_binds, thing) }
 265
 266 ------------------------
 267 mkEdges :: TcSigFun -> LHsBinds Name
 268         -> [(LHsBind Name, BKey, [BKey])]
 269
 270 type BKey  = Int -- Just number off the bindings
 271
 272 mkEdges sig_fn binds
 273   = [ (bind, key, [key | n <- nameSetToList (bind_fvs (unLoc bind)),
 274                          Just key <- [lookupNameEnv key_map n], no_sig n ])
 275     | (bind, key) <- keyd_binds
 276     ]
 277   where
 278     no_sig :: Name -> Bool
 279     no_sig n = isNothing (sig_fn n)
 280
 281     keyd_binds = bagToList binds `zip` [0::BKey ..]
 282
 283     key_map :: NameEnv BKey     -- Which binding it comes from
 284     key_map = mkNameEnv [(bndr, key) | (L _ bind, key) <- keyd_binds
 285                                      , bndr <- bindersOfHsBind bind ]
 286
 287 bindersOfHsBind :: HsBind Name -> [Name]
 288 bindersOfHsBind (PatBind { pat_lhs = pat })  = collectPatBinders pat
 289 bindersOfHsBind (FunBind { fun_id = L _ f }) = [f]
 290 bindersOfHsBind (AbsBinds {})                = panic "bindersOfHsBind AbsBinds"
 291 bindersOfHsBind (VarBind {})                 = panic "bindersOfHsBind VarBind"
 292
 293 ------------------------
 294 tcPolyBinds :: TopLevelFlag -> TcSigFun -> TcPragFun
 295             -> RecFlag                  -- Whether the group is really recursive
 296             -> RecFlag                  -- Whether it's recursive after breaking
 297                                         -- dependencies based on type signatures
 298             -> LHsBinds Name
 299             -> TcM (LHsBinds TcId, [TcId])
 300
 301 -- Typechecks a single bunch of bindings all together,
 302 -- and generalises them.  The bunch may be only part of a recursive
 303 -- group, because we use type signatures to maximise polymorphism
 304 --
 305 -- Returns a list because the input may be a single non-recursive binding,
 306 -- in which case the dependency order of the resulting bindings is
 307 -- important.
 308 --
 309 -- Knows nothing about the scope of the bindings
 310
 311 tcPolyBinds top_lvl sig_fn prag_fn rec_group rec_tc binds
 312   = let
 313         bind_list    = bagToList binds
 314         binder_names = collectHsBindBinders binds
 315         loc          = getLoc (head bind_list)
 316                 -- TODO: location a bit awkward, but the mbinds have been
 317                 --       dependency analysed and may no longer be adjacent
 318     in
 319         -- SET UP THE MAIN RECOVERY; take advantage of any type sigs
 320     setSrcSpan loc                              $
 321     recoverM (recoveryCode binder_names sig_fn) $ do
 322
 323   { traceTc (ptext (sLit "------------------------------------------------"))
 324   ; traceTc (ptext (sLit "Bindings for") <+> ppr binder_names)
 325
 326         -- TYPECHECK THE BINDINGS
 327   ; ((binds', mono_bind_infos), lie_req)
 328         <- getLIE (tcMonoBinds bind_list sig_fn rec_tc)
 329   ; traceTc (text "temp" <+> (ppr binds' $$ ppr lie_req))
 330
 331         -- CHECK FOR UNLIFTED BINDINGS
 332         -- These must be non-recursive etc, and are not generalised
 333         -- They desugar to a case expression in the end
 334   ; zonked_mono_tys <- zonkTcTypes (map getMonoType mono_bind_infos)
 335   ; is_strict <- checkStrictBinds top_lvl rec_group binds'
 336                                   zonked_mono_tys mono_bind_infos
 337   ; if is_strict then
 338     do  { extendLIEs lie_req
 339         ; let exports = zipWith mk_export mono_bind_infos zonked_mono_tys
 340               mk_export (name, Nothing,  mono_id) mono_ty = ([], mkLocalId name mono_ty, mono_id, [])
 341               mk_export (_,    Just sig, mono_id) _       = ([], sig_id sig,             mono_id, [])
 342                         -- ToDo: prags for unlifted bindings
 343
 344         ; return ( unitBag $ L loc $ AbsBinds [] [] exports binds',
 345                    [poly_id | (_, poly_id, _, _) <- exports]) } -- Guaranteed zonked
 346
 347     else do     -- The normal lifted case: GENERALISE
 348   { dflags <- getDOpts
 349   ; (tyvars_to_gen, dicts, dict_binds)
 350         <- addErrCtxt (genCtxt (bndrNames mono_bind_infos)) $
 351            generalise dflags top_lvl bind_list sig_fn mono_bind_infos lie_req
 352
 353         -- BUILD THE POLYMORPHIC RESULT IDs
 354   ; let dict_vars = map instToVar dicts -- May include equality constraints
 355   ; exports <- mapM (mkExport top_lvl prag_fn tyvars_to_gen (map varType dict_vars))
 356                     mono_bind_infos
 357
 358   ; let poly_ids = [poly_id | (_, poly_id, _, _) <- exports]
 359   ; traceTc (text "binding:" <+> ppr (poly_ids `zip` map idType poly_ids))
 360
 361   ; let abs_bind = L loc $ AbsBinds tyvars_to_gen
 362                                     dict_vars exports
 363                                     (dict_binds `unionBags` binds')
 364
 365   ; return (unitBag abs_bind, poly_ids)       -- poly_ids are guaranteed zonked by mkExport
 366   } }
 367
 368
 369 --------------
 370 mkExport :: TopLevelFlag -> TcPragFun -> [TyVar] -> [TcType]
 371          -> MonoBindInfo
 372          -> TcM ([TyVar], Id, Id, [LPrag])
 373 -- mkExport generates exports with
 374 --      zonked type variables,
 375 --      zonked poly_ids
 376 -- The former is just because no further unifications will change
 377 -- the quantified type variables, so we can fix their final form
 378 -- right now.
 379 -- The latter is needed because the poly_ids are used to extend the
 380 -- type environment; see the invariant on TcEnv.tcExtendIdEnv
 381
 382 -- Pre-condition: the inferred_tvs are already zonked
 383
 384 mkExport top_lvl prag_fn inferred_tvs dict_tys (poly_name, mb_sig, mono_id)
 385   = do  { warn_missing_sigs <- doptM Opt_WarnMissingSigs
 386         ; let warn = isTopLevel top_lvl && warn_missing_sigs
 387         ; (tvs, poly_id) <- mk_poly_id warn mb_sig
 388                 -- poly_id has a zonked type
 389
 390         ; prags <- tcPrags poly_id (prag_fn poly_name)
 391                 -- tcPrags requires a zonked poly_id
 392
 393         ; return (tvs, poly_id, mono_id, prags) }
 394   where
 395     poly_ty = mkForAllTys inferred_tvs (mkFunTys dict_tys (idType mono_id))
 396
 397     mk_poly_id warn Nothing    = do { poly_ty' <- zonkTcType poly_ty
 398                                     ; missingSigWarn warn poly_name poly_ty'
 399                                     ; return (inferred_tvs, mkLocalId poly_name poly_ty') }
 400     mk_poly_id _    (Just sig) = do { tvs <- mapM zonk_tv (sig_tvs sig)
 401                                     ; return (tvs,  sig_id sig) }
 402
 403     zonk_tv tv = do { ty <- zonkTcTyVar tv; return (tcGetTyVar "mkExport" ty) }
 404
 405 ------------------------
 406 type TcPragFun = Name -> [LSig Name]
 407
 408 mkPragFun :: [LSig Name] -> TcPragFun
 409 mkPragFun sigs = \n -> lookupNameEnv env n `orElse` []
 410         where
 411           prs = [(expectJust "mkPragFun" (sigName sig), sig)
 412                 | sig <- sigs, isPragLSig sig]
 413           env = foldl add emptyNameEnv prs
 414           add env (n,p) = extendNameEnv_Acc (:) singleton env n p
 415
 416 tcPrags :: Id -> [LSig Name] -> TcM [LPrag]
 417 tcPrags poly_id prags = mapM (wrapLocM tc_prag) prags
 418   where
 419     tc_prag prag = addErrCtxt (pragSigCtxt prag) $
 420                    tcPrag poly_id prag
 421
 422 pragSigCtxt :: Sig Name -> SDoc
 423 pragSigCtxt prag = hang (ptext (sLit "In the pragma")) 2 (ppr prag)
 424
 425 tcPrag :: TcId -> Sig Name -> TcM Prag
 426 -- Pre-condition: the poly_id is zonked
 427 -- Reason: required by tcSubExp
 428 tcPrag poly_id (SpecSig _ hs_ty inl) = tcSpecPrag poly_id hs_ty inl
 429 tcPrag poly_id (SpecInstSig hs_ty)   = tcSpecPrag poly_id hs_ty defaultInlineSpec
 430 tcPrag _       (InlineSig _ inl)     = return (InlinePrag inl)
 431 tcPrag _       sig                   = pprPanic "tcPrag" (ppr sig)
 432
 433
 434 tcSpecPrag :: TcId -> LHsType Name -> InlineSpec -> TcM Prag
 435 tcSpecPrag poly_id hs_ty inl
 436   = do  { let name = idName poly_id
 437         ; spec_ty <- tcHsSigType (FunSigCtxt name) hs_ty
 438         ; co_fn <- tcSubExp (SpecPragOrigin name) (idType poly_id) spec_ty
 439         ; return (SpecPrag (mkHsWrap co_fn (HsVar poly_id)) spec_ty inl) }
 440         -- Most of the work of specialisation is done by
 441         -- the desugarer, guided by the SpecPrag
 442
 443 --------------
 444 -- If typechecking the binds fails, then return with each
 445 -- signature-less binder given type (forall a.a), to minimise
 446 -- subsequent error messages
 447 recoveryCode :: [Name] -> (Name -> Maybe [Name])
 448              -> TcM (LHsBinds TcId, [Id])
 449 recoveryCode binder_names sig_fn
 450   = do  { traceTc (text "tcBindsWithSigs: error recovery" <+> ppr binder_names)
 451         ; poly_ids <- mapM mk_dummy binder_names
 452         ; return (emptyBag, poly_ids) }
 453   where
 454     mk_dummy name
 455         | isJust (sig_fn name) = tcLookupId name        -- Had signature; look it up
 456         | otherwise            = return (mkLocalId name forall_a_a)    -- No signature
 457
 458 forall_a_a :: TcType
 459 forall_a_a = mkForAllTy alphaTyVar (mkTyVarTy alphaTyVar)
 460
 461
 462 -- Check that non-overloaded unlifted bindings are
 463 --      a) non-recursive,
 464 --      b) not top level,
 465 --      c) not a multiple-binding group (more or less implied by (a))
 466
 467 checkStrictBinds :: TopLevelFlag -> RecFlag
 468                  -> LHsBinds TcId -> [TcType] -> [MonoBindInfo]
 469                  -> TcM Bool
 470 checkStrictBinds top_lvl rec_group mbind mono_tys infos
 471   | unlifted || bang_pat
 472   = do  { checkTc (isNotTopLevel top_lvl)
 473                   (strictBindErr "Top-level" unlifted mbind)
 474         ; checkTc (isNonRec rec_group)
 475                   (strictBindErr "Recursive" unlifted mbind)
 476         ; checkTc (isSingletonBag mbind)
 477                   (strictBindErr "Multiple" unlifted mbind)
 478         ; mapM_ check_sig infos
 479         ; return True }
 480   | otherwise
 481   = return False
 482   where
 483     unlifted = any isUnLiftedType mono_tys
 484     bang_pat = anyBag (isBangHsBind . unLoc) mbind
 485     check_sig (_, Just sig, _) = checkTc (null (sig_tvs sig) && null (sig_theta sig))
 486                                          (badStrictSig unlifted sig)
 487     check_sig _                = return ()
 488
 489 strictBindErr :: String -> Bool -> LHsBindsLR Var Var -> SDoc
 490 strictBindErr flavour unlifted mbind
 491   = hang (text flavour <+> msg <+> ptext (sLit "aren't allowed:"))
 492          4 (pprLHsBinds mbind)
 493   where
 494     msg | unlifted  = ptext (sLit "bindings for unlifted types")
 495         | otherwise = ptext (sLit "bang-pattern bindings")
 496
 497 badStrictSig :: Bool -> TcSigInfo -> SDoc
 498 badStrictSig unlifted sig
 499   = hang (ptext (sLit "Illegal polymorphic signature in") <+> msg)
 500          4 (ppr sig)
 501   where
 502     msg | unlifted  = ptext (sLit "an unlifted binding")
 503         | otherwise = ptext (sLit "a bang-pattern binding")
 504 \end{code}
 505
 506
 507 %************************************************************************
 508 %*                                                                      *
 509 \subsection{tcMonoBind}
 510 %*                                                                      *
 511 %************************************************************************
 512
 513 @tcMonoBinds@ deals with a perhaps-recursive group of HsBinds.
 514 The signatures have been dealt with already.
 515
 516 \begin{code}
 517 tcMonoBinds :: [LHsBind Name]
 518             -> TcSigFun
 519             -> RecFlag  -- Whether the binding is recursive for typechecking purposes
 520                         -- i.e. the binders are mentioned in their RHSs, and
 521                         --      we are not resuced by a type signature
 522             -> TcM (LHsBinds TcId, [MonoBindInfo])
 523
 524 tcMonoBinds [L b_loc (FunBind { fun_id = L nm_loc name, fun_infix = inf,
 525                                 fun_matches = matches, bind_fvs = fvs })]
 526             sig_fn              -- Single function binding,
 527             NonRecursive        -- binder isn't mentioned in RHS,
 528   | Nothing <- sig_fn name      -- ...with no type signature
 529   =     -- In this very special case we infer the type of the
 530         -- right hand side first (it may have a higher-rank type)
 531         -- and *then* make the monomorphic Id for the LHS
 532         -- e.g.         f = \(x::forall a. a->a) -> <body>
 533         --      We want to infer a higher-rank type for f
 534     setSrcSpan b_loc    $
 535     do  { ((co_fn, matches'), rhs_ty) <- tcInfer (tcMatchesFun name inf matches)
 536
 537                 -- Check for an unboxed tuple type
 538                 --      f = (# True, False #)
 539                 -- Zonk first just in case it's hidden inside a meta type variable
 540                 -- (This shows up as a (more obscure) kind error
 541                 --  in the 'otherwise' case of tcMonoBinds.)
 542         ; zonked_rhs_ty <- zonkTcType rhs_ty
 543         ; checkTc (not (isUnboxedTupleType zonked_rhs_ty))
 544                   (unboxedTupleErr name zonked_rhs_ty)
 545
 546         ; mono_name <- newLocalName name
 547         ; let mono_id = mkLocalId mono_name zonked_rhs_ty
 548         ; return (unitBag (L b_loc (FunBind { fun_id = L nm_loc mono_id, fun_infix = inf,
 549                                               fun_matches = matches', bind_fvs = fvs,
 550                                               fun_co_fn = co_fn, fun_tick = Nothing })),
 551                   [(name, Nothing, mono_id)]) }
 552
 553 tcMonoBinds [L b_loc (FunBind { fun_id = L nm_loc name, fun_infix = inf,
 554                                 fun_matches = matches })]
 555             sig_fn              -- Single function binding
 556             _
 557   | Just scoped_tvs <- sig_fn name      -- ...with a type signature
 558   =     -- When we have a single function binding, with a type signature
 559         -- we can (a) use genuine, rigid skolem constants for the type variables
 560         --        (b) bring (rigid) scoped type variables into scope
 561     setSrcSpan b_loc    $
 562     do  { tc_sig <- tcInstSig True name
 563         ; mono_name <- newLocalName name
 564         ; let mono_ty = sig_tau tc_sig
 565               mono_id = mkLocalId mono_name mono_ty
 566               rhs_tvs = [ (name, mkTyVarTy tv)
 567                         | (name, tv) <- scoped_tvs `zip` sig_tvs tc_sig ]
 568                         -- See Note [More instantiated than scoped]
 569                         -- Note that the scoped_tvs and the (sig_tvs sig)
 570                         -- may have different Names. That's quite ok.
 571
 572         ; traceTc (text "tcMoonBinds" <+> ppr scoped_tvs $$ ppr tc_sig)
 573         ; (co_fn, matches') <- tcExtendTyVarEnv2 rhs_tvs $
 574                                tcMatchesFun mono_name inf matches mono_ty
 575              -- Note that "mono_ty" might actually be a polymorphic type,
 576              -- if the original function had a signature like
 577              --    forall a. Eq a => forall b. Ord b => ....
 578              -- But that's ok: tcMatchesFun can deal with that
 579              -- It happens, too!  See Note [Polymorphic methods] in TcClassDcl.
 580
 581         ; let fun_bind' = FunBind { fun_id = L nm_loc mono_id,
 582                                     fun_infix = inf, fun_matches = matches',
 583                                     bind_fvs = placeHolderNames, fun_co_fn = co_fn,
 584                                     fun_tick = Nothing }
 585         ; return (unitBag (L b_loc fun_bind'),
 586                   [(name, Just tc_sig, mono_id)]) }
 587
 588 tcMonoBinds binds sig_fn _
 589   = do  { tc_binds <- mapM (wrapLocM (tcLhs sig_fn)) binds
 590
 591         -- Bring the monomorphic Ids, into scope for the RHSs
 592         ; let mono_info  = getMonoBindInfo tc_binds
 593               rhs_id_env = [(name,mono_id) | (name, Nothing, mono_id) <- mono_info]
 594                                 -- A monomorphic binding for each term variable that lacks
 595                                 -- a type sig.  (Ones with a sig are already in scope.)
 596
 597         ; binds' <- tcExtendIdEnv2 rhs_id_env $ do
 598                     traceTc (text "tcMonoBinds" <+> vcat [ ppr n <+> ppr id <+> ppr (idType id)
 599                                                          | (n,id) <- rhs_id_env])
 600                     mapM (wrapLocM tcRhs) tc_binds
 601         ; return (listToBag binds', mono_info) }
 602
 603 ------------------------
 604 -- tcLhs typechecks the LHS of the bindings, to construct the environment in which
 605 -- we typecheck the RHSs.  Basically what we are doing is this: for each binder:
 606 --      if there's a signature for it, use the instantiated signature type
 607 --      otherwise invent a type variable
 608 -- You see that quite directly in the FunBind case.
 609 --
 610 -- But there's a complication for pattern bindings:
 611 --      data T = MkT (forall a. a->a)
 612 --      MkT f = e
 613 -- Here we can guess a type variable for the entire LHS (which will be refined to T)
 614 -- but we want to get (f::forall a. a->a) as the RHS environment.
 615 -- The simplest way to do this is to typecheck the pattern, and then look up the
 616 -- bound mono-ids.  Then we want to retain the typechecked pattern to avoid re-doing
 617 -- it; hence the TcMonoBind data type in which the LHS is done but the RHS isn't
 618
 619 data TcMonoBind         -- Half completed; LHS done, RHS not done
 620   = TcFunBind  MonoBindInfo  (Located TcId) Bool (MatchGroup Name)
 621   | TcPatBind [MonoBindInfo] (LPat TcId) (GRHSs Name) TcSigmaType
 622
 623 type MonoBindInfo = (Name, Maybe TcSigInfo, TcId)
 624         -- Type signature (if any), and
 625         -- the monomorphic bound things
 626
 627 bndrNames :: [MonoBindInfo] -> [Name]
 628 bndrNames mbi = [n | (n,_,_) <- mbi]
 629
 630 getMonoType :: MonoBindInfo -> TcTauType
 631 getMonoType (_,_,mono_id) = idType mono_id
 632
 633 tcLhs :: TcSigFun -> HsBind Name -> TcM TcMonoBind
 634 tcLhs sig_fn (FunBind { fun_id = L nm_loc name, fun_infix = inf, fun_matches = matches })
 635   = do  { mb_sig <- tcInstSig_maybe sig_fn name
 636         ; mono_name <- newLocalName name
 637         ; mono_ty   <- mk_mono_ty mb_sig
 638         ; let mono_id = mkLocalId mono_name mono_ty
 639         ; return (TcFunBind (name, mb_sig, mono_id) (L nm_loc mono_id) inf matches) }
 640   where
 641     mk_mono_ty (Just sig) = return (sig_tau sig)
 642     mk_mono_ty Nothing    = newFlexiTyVarTy argTypeKind
 643
 644 tcLhs sig_fn (PatBind { pat_lhs = pat, pat_rhs = grhss })
 645   = do  { mb_sigs <- mapM (tcInstSig_maybe sig_fn) names
 646         ; mono_pat_binds <- doptM Opt_MonoPatBinds
 647                 -- With -XMonoPatBinds, we do no generalisation of pattern bindings
 648                 -- But the signature can still be polymoprhic!
 649                 --      data T = MkT (forall a. a->a)
 650                 --      x :: forall a. a->a
 651                 --      MkT x = <rhs>
 652                 -- The function get_sig_ty decides whether the pattern-bound variables
 653                 -- should have exactly the type in the type signature (-XMonoPatBinds),
 654                 -- or the instantiated version (-XMonoPatBinds)
 655
 656         ; let nm_sig_prs  = names `zip` mb_sigs
 657               get_sig_ty | mono_pat_binds = idType . sig_id
 658                          | otherwise      = sig_tau
 659               tau_sig_env = mkNameEnv [ (name, get_sig_ty sig)
 660                                       | (name, Just sig) <- nm_sig_prs]
 661               sig_tau_fn  = lookupNameEnv tau_sig_env
 662
 663               tc_pat exp_ty = tcLetPat sig_tau_fn pat exp_ty $
 664                               mapM lookup_info nm_sig_prs
 665
 666                 -- After typechecking the pattern, look up the binder
 667                 -- names, which the pattern has brought into scope.
 668               lookup_info :: (Name, Maybe TcSigInfo) -> TcM MonoBindInfo
 669               lookup_info (name, mb_sig) = do { mono_id <- tcLookupId name
 670                                               ; return (name, mb_sig, mono_id) }
 671
 672         ; ((pat', infos), pat_ty) <- addErrCtxt (patMonoBindsCtxt pat grhss) $
 673                                      tcInfer tc_pat
 674
 675         ; return (TcPatBind infos pat' grhss pat_ty) }
 676   where
 677     names = collectPatBinders pat
 678
 679
 680 tcLhs _ other_bind = pprPanic "tcLhs" (ppr other_bind)
 681         -- AbsBind, VarBind impossible
 682
 683 -------------------
 684 tcRhs :: TcMonoBind -> TcM (HsBind TcId)
 685 -- When we are doing pattern bindings, or multiple function bindings at a time
 686 -- we *don't* bring any scoped type variables into scope
 687 -- Wny not?  They are not completely rigid.
 688 -- That's why we have the special case for a single FunBind in tcMonoBinds
 689 tcRhs (TcFunBind (_,_,mono_id) fun' inf matches)
 690   = do  { (co_fn, matches') <- tcMatchesFun (idName mono_id) inf
 691                                             matches (idType mono_id)
 692         ; return (FunBind { fun_id = fun', fun_infix = inf, fun_matches = matches',
 693                             bind_fvs = placeHolderNames, fun_co_fn = co_fn,
 694                             fun_tick = Nothing }) }
 695
 696 tcRhs (TcPatBind _ pat' grhss pat_ty)
 697   = do  { grhss' <- addErrCtxt (patMonoBindsCtxt pat' grhss) $
 698                     tcGRHSsPat grhss pat_ty
 699         ; return (PatBind { pat_lhs = pat', pat_rhs = grhss', pat_rhs_ty = pat_ty,
 700                             bind_fvs = placeHolderNames }) }
 701
 702
 703 ---------------------
 704 getMonoBindInfo :: [Located TcMonoBind] -> [MonoBindInfo]
 705 getMonoBindInfo tc_binds
 706   = foldr (get_info . unLoc) [] tc_binds
 707   where
 708     get_info (TcFunBind info _ _ _)  rest = info : rest
 709     get_info (TcPatBind infos _ _ _) rest = infos ++ rest
 710 \end{code}
 711
 712
 713 %************************************************************************
 714 %*                                                                      *
 715                 Generalisation
 716 %*                                                                      *
 717 %************************************************************************
 718
 719 \begin{code}
 720 generalise :: DynFlags -> TopLevelFlag
 721            -> [LHsBind Name] -> TcSigFun
 722            -> [MonoBindInfo] -> [Inst]
 723            -> TcM ([TyVar], [Inst], TcDictBinds)
 724 -- The returned [TyVar] are all ready to quantify
 725
 726 generalise dflags top_lvl bind_list sig_fn mono_infos lie_req
 727   | isMonoGroup dflags bind_list
 728   = do  { extendLIEs lie_req
 729         ; return ([], [], emptyBag) }
 730
 731   | isRestrictedGroup dflags bind_list sig_fn   -- RESTRICTED CASE
 732   =     -- Check signature contexts are empty
 733     do  { checkTc (all is_mono_sig sigs)
 734                   (restrictedBindCtxtErr bndrs)
 735
 736         -- Now simplify with exactly that set of tyvars
 737         -- We have to squash those Methods
 738         ; (qtvs, binds) <- tcSimplifyRestricted doc top_lvl bndrs
 739                                                 tau_tvs lie_req
 740
 741         -- Check that signature type variables are OK
 742         ; final_qtvs <- checkSigsTyVars qtvs sigs
 743
 744         ; return (final_qtvs, [], binds) }
 745
 746   | null sigs   -- UNRESTRICTED CASE, NO TYPE SIGS
 747   = tcSimplifyInfer doc tau_tvs lie_req
 748
 749   | otherwise   -- UNRESTRICTED CASE, WITH TYPE SIGS
 750   = do  { sig_lie <- unifyCtxts sigs    -- sigs is non-empty; sig_lie is zonked
 751         ; let   -- The "sig_avails" is the stuff available.  We get that from
 752                 -- the context of the type signature, BUT ALSO the lie_avail
 753                 -- so that polymorphic recursion works right (see Note [Polymorphic recursion])
 754                 local_meths = [mkMethInst sig mono_id | (_, Just sig, mono_id) <- mono_infos]
 755                 sig_avails = sig_lie ++ local_meths
 756                 loc = sig_loc (head sigs)
 757
 758         -- Check that the needed dicts can be
 759         -- expressed in terms of the signature ones
 760         ; (qtvs, binds) <- tcSimplifyInferCheck loc tau_tvs sig_avails lie_req
 761
 762         -- Check that signature type variables are OK
 763         ; final_qtvs <- checkSigsTyVars qtvs sigs
 764
 765         ; return (final_qtvs, sig_lie, binds) }
 766   where
 767     bndrs   = bndrNames mono_infos
 768     sigs    = [sig | (_, Just sig, _) <- mono_infos]
 769     get_tvs | isTopLevel top_lvl = tyVarsOfType  -- See Note [Silly type synonym] in TcType
 770             | otherwise          = exactTyVarsOfType
 771     tau_tvs = foldr (unionVarSet . get_tvs . getMonoType) emptyVarSet mono_infos
 772     is_mono_sig sig = null (sig_theta sig)
 773     doc = ptext (sLit "type signature(s) for") <+> pprBinders bndrs
 774
 775     mkMethInst (TcSigInfo { sig_id = poly_id, sig_tvs = tvs,
 776                             sig_theta = theta, sig_loc = loc }) mono_id
 777       = Method {tci_id = mono_id, tci_oid = poly_id, tci_tys = mkTyVarTys tvs,
 778                 tci_theta = theta, tci_loc = loc}
 779 \end{code}
 780
 781 unifyCtxts checks that all the signature contexts are the same
 782 The type signatures on a mutually-recursive group of definitions
 783 must all have the same context (or none).
 784
 785 The trick here is that all the signatures should have the same
 786 context, and we want to share type variables for that context, so that
 787 all the right hand sides agree a common vocabulary for their type
 788 constraints
 789
 790 We unify them because, with polymorphic recursion, their types
 791 might not otherwise be related.  This is a rather subtle issue.
 792
 793 \begin{code}
 794 unifyCtxts :: [TcSigInfo] -> TcM [Inst]
 795 -- Post-condition: the returned Insts are full zonked
 796 unifyCtxts [] = panic "unifyCtxts []"
 797 unifyCtxts (sig1 : sigs)        -- Argument is always non-empty
 798   = do  { mapM unify_ctxt sigs
 799         ; theta <- zonkTcThetaType (sig_theta sig1)
 800         ; newDictBndrs (sig_loc sig1) theta }
 801   where
 802     theta1 = sig_theta sig1
 803     unify_ctxt :: TcSigInfo -> TcM ()
 804     unify_ctxt sig@(TcSigInfo { sig_theta = theta })
 805         = setSrcSpan (instLocSpan (sig_loc sig))        $
 806           addErrCtxt (sigContextsCtxt sig1 sig)         $
 807           do { cois <- unifyTheta theta1 theta
 808              ; -- Check whether all coercions are identity coercions
 809                -- That can happen if we have, say
 810                --         f :: C [a]   => ...
 811                --         g :: C (F a) => ...
 812                -- where F is a type function and (F a ~ [a])
 813                -- Then unification might succeed with a coercion.  But it's much
 814                -- much simpler to require that such signatures have identical contexts
 815                checkTc (all isIdentityCoercion cois)
 816                        (ptext (sLit "Mutually dependent functions have syntactically distinct contexts"))
 817              }
 818
 819 checkSigsTyVars :: [TcTyVar] -> [TcSigInfo] -> TcM [TcTyVar]
 820 checkSigsTyVars qtvs sigs
 821   = do  { gbl_tvs <- tcGetGlobalTyVars
 822         ; sig_tvs_s <- mapM (check_sig gbl_tvs) sigs
 823
 824         ; let   -- Sigh.  Make sure that all the tyvars in the type sigs
 825                 -- appear in the returned ty var list, which is what we are
 826                 -- going to generalise over.  Reason: we occasionally get
 827                 -- silly types like
 828                 --      type T a = () -> ()
 829                 --      f :: T a
 830                 --      f () = ()
 831                 -- Here, 'a' won't appear in qtvs, so we have to add it
 832                 sig_tvs = foldl extendVarSetList emptyVarSet sig_tvs_s
 833                 all_tvs = varSetElems (extendVarSetList sig_tvs qtvs)
 834         ; return all_tvs }
 835   where
 836     check_sig gbl_tvs (TcSigInfo {sig_id = id, sig_tvs = tvs,
 837                                   sig_theta = theta, sig_tau = tau})
 838       = addErrCtxt (ptext (sLit "In the type signature for") <+> quotes (ppr id))       $
 839         addErrCtxtM (sigCtxt id tvs theta tau)                                          $
 840         do { tvs' <- checkDistinctTyVars tvs
 841            ; when (any (`elemVarSet` gbl_tvs) tvs')
 842                   (bleatEscapedTvs gbl_tvs tvs tvs')
 843            ; return tvs' }
 844
 845 checkDistinctTyVars :: [TcTyVar] -> TcM [TcTyVar]
 846 -- (checkDistinctTyVars tvs) checks that the tvs from one type signature
 847 -- are still all type variables, and all distinct from each other.
 848 -- It returns a zonked set of type variables.
 849 -- For example, if the type sig is
 850 --      f :: forall a b. a -> b -> b
 851 -- we want to check that 'a' and 'b' haven't
 852 --      (a) been unified with a non-tyvar type
 853 --      (b) been unified with each other (all distinct)
 854
 855 checkDistinctTyVars sig_tvs
 856   = do  { zonked_tvs <- mapM zonkSigTyVar sig_tvs
 857         ; foldlM check_dup emptyVarEnv (sig_tvs `zip` zonked_tvs)
 858         ; return zonked_tvs }
 859   where
 860     check_dup :: TyVarEnv TcTyVar -> (TcTyVar, TcTyVar) -> TcM (TyVarEnv TcTyVar)
 861         -- The TyVarEnv maps each zonked type variable back to its
 862         -- corresponding user-written signature type variable
 863     check_dup acc (sig_tv, zonked_tv)
 864         = case lookupVarEnv acc zonked_tv of
 865                 Just sig_tv' -> bomb_out sig_tv sig_tv'
 866
 867                 Nothing -> return (extendVarEnv acc zonked_tv sig_tv)
 868
 869     bomb_out sig_tv1 sig_tv2
 870        = do { env0 <- tcInitTidyEnv
 871             ; let (env1, tidy_tv1) = tidyOpenTyVar env0 sig_tv1
 872                   (env2, tidy_tv2) = tidyOpenTyVar env1 sig_tv2
 873                   msg = ptext (sLit "Quantified type variable") <+> quotes (ppr tidy_tv1)
 874                          <+> ptext (sLit "is unified with another quantified type variable")
 875                          <+> quotes (ppr tidy_tv2)
 876             ; failWithTcM (env2, msg) }
 877 \end{code}
 878
 879
 880 @getTyVarsToGen@ decides what type variables to generalise over.
 881
 882 For a "restricted group" -- see the monomorphism restriction
 883 for a definition -- we bind no dictionaries, and
 884 remove from tyvars_to_gen any constrained type variables
 885
 886 *Don't* simplify dicts at this point, because we aren't going
 887 to generalise over these dicts.  By the time we do simplify them
 888 we may well know more.  For example (this actually came up)
 889         f :: Array Int Int
 890         f x = array ... xs where xs = [1,2,3,4,5]
 891 We don't want to generate lots of (fromInt Int 1), (fromInt Int 2)
 892 stuff.  If we simplify only at the f-binding (not the xs-binding)
 893 we'll know that the literals are all Ints, and we can just produce
 894 Int literals!
 895
 896 Find all the type variables involved in overloading, the
 897 "constrained_tyvars".  These are the ones we *aren't* going to
 898 generalise.  We must be careful about doing this:
 899
 900  (a) If we fail to generalise a tyvar which is not actually
 901         constrained, then it will never, ever get bound, and lands
 902         up printed out in interface files!  Notorious example:
 903                 instance Eq a => Eq (Foo a b) where ..
 904         Here, b is not constrained, even though it looks as if it is.
 905         Another, more common, example is when there's a Method inst in
 906         the LIE, whose type might very well involve non-overloaded
 907         type variables.
 908   [NOTE: Jan 2001: I don't understand the problem here so I'm doing
 909         the simple thing instead]
 910
 911  (b) On the other hand, we mustn't generalise tyvars which are constrained,
 912         because we are going to pass on out the unmodified LIE, with those
 913         tyvars in it.  They won't be in scope if we've generalised them.
 914
 915 So we are careful, and do a complete simplification just to find the
 916 constrained tyvars. We don't use any of the results, except to
 917 find which tyvars are constrained.
 918
 919 Note [Polymorphic recursion]
 920 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 921 The game plan for polymorphic recursion in the code above is
 922
 923         * Bind any variable for which we have a type signature
 924           to an Id with a polymorphic type.  Then when type-checking
 925           the RHSs we'll make a full polymorphic call.
 926
 927 This fine, but if you aren't a bit careful you end up with a horrendous
 928 amount of partial application and (worse) a huge space leak. For example:
 929
 930         f :: Eq a => [a] -> [a]
 931         f xs = ...f...
 932
 933 If we don't take care, after typechecking we get
 934
 935         f = /\a -> \d::Eq a -> let f' = f a d
 936                                in
 937                                \ys:[a] -> ...f'...
 938
 939 Notice the the stupid construction of (f a d), which is of course
 940 identical to the function we're executing.  In this case, the
 941 polymorphic recursion isn't being used (but that's a very common case).
 942 This can lead to a massive space leak, from the following top-level defn
 943 (post-typechecking)
 944
 945         ff :: [Int] -> [Int]
 946         ff = f Int dEqInt
 947
 948 Now (f dEqInt) evaluates to a lambda that has f' as a free variable; but
 949 f' is another thunk which evaluates to the same thing... and you end
 950 up with a chain of identical values all hung onto by the CAF ff.
 951
 952         ff = f Int dEqInt
 953
 954            = let f' = f Int dEqInt in \ys. ...f'...
 955
 956            = let f' = let f' = f Int dEqInt in \ys. ...f'...
 957                       in \ys. ...f'...
 958
 959 Etc.
 960
 961 NOTE: a bit of arity anaysis would push the (f a d) inside the (\ys...),
 962 which would make the space leak go away in this case
 963
 964 Solution: when typechecking the RHSs we always have in hand the
 965 *monomorphic* Ids for each binding.  So we just need to make sure that
 966 if (Method f a d) shows up in the constraints emerging from (...f...)
 967 we just use the monomorphic Id.  We achieve this by adding monomorphic Ids
 968 to the "givens" when simplifying constraints.  That's what the "lies_avail"
 969 is doing.
 970
 971 Then we get
 972
 973         f = /\a -> \d::Eq a -> letrec
 974                                  fm = \ys:[a] -> ...fm...
 975                                in
 976                                fm
 977
 978
 979
 980 %************************************************************************
 981 %*                                                                      *
 982                 Signatures
 983 %*                                                                      *
 984 %************************************************************************
 985
 986 Type signatures are tricky.  See Note [Signature skolems] in TcType
 987
 988 @tcSigs@ checks the signatures for validity, and returns a list of
 989 {\em freshly-instantiated} signatures.  That is, the types are already
 990 split up, and have fresh type variables installed.  All non-type-signature
 991 "RenamedSigs" are ignored.
 992
 993 The @TcSigInfo@ contains @TcTypes@ because they are unified with
 994 the variable's type, and after that checked to see whether they've
 995 been instantiated.
 996
 997 Note [Scoped tyvars]
 998 ~~~~~~~~~~~~~~~~~~~~
 999 The -XScopedTypeVariables flag brings lexically-scoped type variables
1000 into scope for any explicitly forall-quantified type variables:
1001         f :: forall a. a -> a
1002         f x = e
1003 Then 'a' is in scope inside 'e'.
1004
1005 However, we do *not* support this
1006   - For pattern bindings e.g
1007         f :: forall a. a->a
1008         (f,g) = e
1009
1010   - For multiple function bindings, unless Opt_RelaxedPolyRec is on
1011         f :: forall a. a -> a
1012         f = g
1013         g :: forall b. b -> b
1014         g = ...f...
1015     Reason: we use mutable variables for 'a' and 'b', since they may
1016     unify to each other, and that means the scoped type variable would
1017     not stand for a completely rigid variable.
1018
1019     Currently, we simply make Opt_ScopedTypeVariables imply Opt_RelaxedPolyRec
1020
1021
1022 Note [More instantiated than scoped]
1023 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1024 There may be more instantiated type variables than lexically-scoped
1025 ones.  For example:
1026         type T a = forall b. b -> (a,b)
1027         f :: forall c. T c
1028 Here, the signature for f will have one scoped type variable, c,
1029 but two instantiated type variables, c' and b'.
1030
1031 We assume that the scoped ones are at the *front* of sig_tvs,
1032 and remember the names from the original HsForAllTy in the TcSigFun.
1033
1034
1035 \begin{code}
1036 type TcSigFun = Name -> Maybe [Name]    -- Maps a let-binder to the list of
1037                                         -- type variables brought into scope
1038                                         -- by its type signature.
1039                                         -- Nothing => no type signature
1040
1041 mkTcSigFun :: [LSig Name] -> TcSigFun
1042 -- Search for a particular type signature
1043 -- Precondition: the sigs are all type sigs
1044 -- Precondition: no duplicates
1045 mkTcSigFun sigs = lookupNameEnv env
1046   where
1047     env = mkNameEnv (mapCatMaybes mk_pair sigs)
1048     mk_pair (L _ (TypeSig (L _ name) lhs_ty)) = Just (name, hsExplicitTvs lhs_ty)
1049     mk_pair (L _ (IdSig id))                  = Just (idName id, [])
1050     mk_pair _                                 = Nothing
1051         -- The scoped names are the ones explicitly mentioned
1052         -- in the HsForAll.  (There may be more in sigma_ty, because
1053         -- of nested type synonyms.  See Note [More instantiated than scoped].)
1054         -- See Note [Only scoped tyvars are in the TyVarEnv]
1055
1056 ---------------
1057 data TcSigInfo
1058   = TcSigInfo {
1059         sig_id     :: TcId,             --  *Polymorphic* binder for this value...
1060
1061         sig_tvs    :: [TcTyVar],        -- Instantiated type variables
1062                                         -- See Note [Instantiate sig]
1063
1064         sig_theta  :: TcThetaType,      -- Instantiated theta
1065         sig_tau    :: TcTauType,        -- Instantiated tau
1066         sig_loc    :: InstLoc           -- The location of the signature
1067     }
1068
1069
1070 --      Note [Only scoped tyvars are in the TyVarEnv]
1071 -- We are careful to keep only the *lexically scoped* type variables in
1072 -- the type environment.  Why?  After all, the renamer has ensured
1073 -- that only legal occurrences occur, so we could put all type variables
1074 -- into the type env.
1075 --
1076 -- But we want to check that two distinct lexically scoped type variables
1077 -- do not map to the same internal type variable.  So we need to know which
1078 -- the lexically-scoped ones are... and at the moment we do that by putting
1079 -- only the lexically scoped ones into the environment.
1080
1081
1082 --      Note [Instantiate sig]
1083 -- It's vital to instantiate a type signature with fresh variables.
1084 -- For example:
1085 --      type S = forall a. a->a
1086 --      f,g :: S
1087 --      f = ...
1088 --      g = ...
1089 -- Here, we must use distinct type variables when checking f,g's right hand sides.
1090 -- (Instantiation is only necessary because of type synonyms.  Otherwise,
1091 -- it's all cool; each signature has distinct type variables from the renamer.)
1092
1093 instance Outputable TcSigInfo where
1094     ppr (TcSigInfo { sig_id = id, sig_tvs = tyvars, sig_theta = theta, sig_tau = tau})
1095         = ppr id <+> ptext (sLit "::") <+> ppr tyvars <+> ppr theta <+> ptext (sLit "=>") <+> ppr tau
1096 \end{code}
1097
1098 \begin{code}
1099 tcTySig :: LSig Name -> TcM TcId
1100 tcTySig (L span (TypeSig (L _ name) ty))
1101   = setSrcSpan span             $
1102     do  { sigma_ty <- tcHsSigType (FunSigCtxt name) ty
1103         ; return (mkLocalId name sigma_ty) }
1104 tcTySig (L _ (IdSig id))
1105   = return id
1106 tcTySig s = pprPanic "tcTySig" (ppr s)
1107
1108 -------------------
1109 tcInstSig_maybe :: TcSigFun -> Name -> TcM (Maybe TcSigInfo)
1110 -- Instantiate with *meta* type variables;
1111 -- this signature is part of a multi-signature group
1112 tcInstSig_maybe sig_fn name
1113   = case sig_fn name of
1114         Nothing -> return Nothing
1115         Just _scoped_tvs -> do   { tc_sig <- tcInstSig False name
1116                                  ; return (Just tc_sig) }
1117         -- NB: the _scoped_tvs may be non-empty, but we can
1118         -- just ignore them.  See Note [Scoped tyvars].
1119
1120 tcInstSig :: Bool -> Name -> TcM TcSigInfo
1121 -- Instantiate the signature, with either skolems or meta-type variables
1122 -- depending on the use_skols boolean.  This variable is set True
1123 -- when we are typechecking a single function binding; and False for
1124 -- pattern bindings and a group of several function bindings.
1125 -- Reason: in the latter cases, the "skolems" can be unified together,
1126 --         so they aren't properly rigid in the type-refinement sense.
1127 -- NB: unless we are doing H98, each function with a sig will be done
1128 --     separately, even if it's mutually recursive, so use_skols will be True
1129 --
1130 -- We always instantiate with fresh uniques,
1131 -- although we keep the same print-name
1132 --
1133 --      type T = forall a. [a] -> [a]
1134 --      f :: T;
1135 --      f = g where { g :: T; g = <rhs> }
1136 --
1137 -- We must not use the same 'a' from the defn of T at both places!!
1138
1139 tcInstSig use_skols name
1140   = do  { poly_id <- tcLookupId name    -- Cannot fail; the poly ids are put into
1141                                         -- scope when starting the binding group
1142         ; let skol_info = SigSkol (FunSigCtxt name)
1143         ; (tvs, theta, tau) <- tcInstSigType use_skols skol_info (idType poly_id)
1144         ; loc <- getInstLoc (SigOrigin skol_info)
1145         ; return (TcSigInfo { sig_id = poly_id,
1146                               sig_tvs = tvs, sig_theta = theta, sig_tau = tau,
1147                               sig_loc = loc }) }
1148
1149 -------------------
1150 isMonoGroup :: DynFlags -> [LHsBind Name] -> Bool
1151 -- No generalisation at all
1152 isMonoGroup dflags binds
1153   = dopt Opt_MonoPatBinds dflags && any is_pat_bind binds
1154   where
1155     is_pat_bind (L _ (PatBind {})) = True
1156     is_pat_bind _                  = False
1157
1158 -------------------
1159 isRestrictedGroup :: DynFlags -> [LHsBind Name] -> TcSigFun -> Bool
1160 isRestrictedGroup dflags binds sig_fn
1161   = mono_restriction && not all_unrestricted
1162   where
1163     mono_restriction = dopt Opt_MonomorphismRestriction dflags
1164     all_unrestricted = all (unrestricted . unLoc) binds
1165     has_sig n = isJust (sig_fn n)
1166
1167     unrestricted (PatBind {})                                    = False
1168     unrestricted (VarBind { var_id = v })                        = has_sig v
1169     unrestricted (FunBind { fun_id = v, fun_matches = matches }) = unrestricted_match matches
1170                                                                  || has_sig (unLoc v)
1171     unrestricted (AbsBinds {})
1172         = panic "isRestrictedGroup/unrestricted AbsBinds"
1173
1174     unrestricted_match (MatchGroup (L _ (Match [] _ _) : _) _) = False
1175         -- No args => like a pattern binding
1176     unrestricted_match _                                       = True
1177         -- Some args => a function binding
1178 \end{code}
1179
1180
1181 %************************************************************************
1182 %*                                                                      *
1183 \subsection[TcBinds-errors]{Error contexts and messages}
1184 %*                                                                      *
1185 %************************************************************************
1186
1187
1188 \begin{code}
1189 -- This one is called on LHS, when pat and grhss are both Name
1190 -- and on RHS, when pat is TcId and grhss is still Name
1191 patMonoBindsCtxt :: OutputableBndr id => LPat id -> GRHSs Name -> SDoc
1192 patMonoBindsCtxt pat grhss
1193   = hang (ptext (sLit "In a pattern binding:")) 4 (pprPatBind pat grhss)
1194
1195 -----------------------------------------------
1196 sigContextsCtxt :: TcSigInfo -> TcSigInfo -> SDoc
1197 sigContextsCtxt sig1 sig2
1198   = vcat [ptext (sLit "When matching the contexts of the signatures for"),
1199           nest 2 (vcat [ppr id1 <+> dcolon <+> ppr (idType id1),
1200                         ppr id2 <+> dcolon <+> ppr (idType id2)]),
1201           ptext (sLit "The signature contexts in a mutually recursive group should all be identical")]
1202   where
1203     id1 = sig_id sig1
1204     id2 = sig_id sig2
1205
1206
1207 -----------------------------------------------
1208 unboxedTupleErr :: Name -> Type -> SDoc
1209 unboxedTupleErr name ty
1210   = hang (ptext (sLit "Illegal binding of unboxed tuple"))
1211          4 (ppr name <+> dcolon <+> ppr ty)
1212
1213 -----------------------------------------------
1214 restrictedBindCtxtErr :: [Name] -> SDoc
1215 restrictedBindCtxtErr binder_names
1216   = hang (ptext (sLit "Illegal overloaded type signature(s)"))
1217        4 (vcat [ptext (sLit "in a binding group for") <+> pprBinders binder_names,
1218                 ptext (sLit "that falls under the monomorphism restriction")])
1219
1220 genCtxt :: [Name] -> SDoc
1221 genCtxt binder_names
1222   = ptext (sLit "When generalising the type(s) for") <+> pprBinders binder_names
1223
1224 missingSigWarn :: Bool -> Name -> Type -> TcM ()
1225 missingSigWarn False _    _  = return ()
1226 missingSigWarn True  name ty
1227   = do  { env0 <- tcInitTidyEnv
1228         ; let (env1, tidy_ty) = tidyOpenType env0 ty
1229         ; addWarnTcM (env1, mk_msg tidy_ty) }
1230   where
1231     mk_msg ty = vcat [ptext (sLit "Definition but no type signature for") <+> quotes (ppr name),
1232                       sep [ptext (sLit "Inferred type:") <+> pprHsVar name <+> dcolon <+> ppr ty]]
1233 \end{code}