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