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