TcBinds.lhs 51.6 KB
Newer Older
1
%
Simon Marlow's avatar
Simon Marlow committed
2
% (c) The University of Glasgow 2006
3
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4
5
6
7
%
\section[TcBinds]{TcBinds}

\begin{code}
8
module TcBinds ( tcLocalBinds, tcTopBinds, 
9
                 tcHsBootSigs, tcMonoBinds, tcPolyBinds,
Ian Lynagh's avatar
Ian Lynagh committed
10
11
12
                 TcPragFun, tcSpecPrag, tcPrags, mkPragFun, 
                 TcSigInfo(..), TcSigFun, mkTcSigFun,
                 badBootDeclErr ) where
13

ross's avatar
ross committed
14
import {-# SOURCE #-} TcMatches ( tcGRHSsPat, tcMatchesFun )
15
import {-# SOURCE #-} TcExpr  ( tcMonoExpr )
16

Simon Marlow's avatar
Simon Marlow committed
17
18
import DynFlags
import HsSyn
19

20
import TcRnMonad
Simon Marlow's avatar
Simon Marlow committed
21
22
23
24
25
26
27
28
29
import Inst
import TcEnv
import TcUnify
import TcSimplify
import TcHsType
import TcPat
import TcMType
import TcType
import {- Kind parts of -} Type
30
import Coercion
Simon Marlow's avatar
Simon Marlow committed
31
32
33
import VarEnv
import TysPrim
import Id
34
import Var
Simon Marlow's avatar
Simon Marlow committed
35
import Name
36
import NameSet
37
import NameEnv
38
import VarSet
Simon Marlow's avatar
Simon Marlow committed
39
import SrcLoc
40
import Bag
Simon Marlow's avatar
Simon Marlow committed
41
42
43
import ErrUtils
import Digraph
import Maybes
44
import List
Simon Marlow's avatar
Simon Marlow committed
45
46
import Util
import BasicTypes
47
import Outputable
48
import FastString
49
50

import Control.Monad
51
\end{code}
52

53

54
%************************************************************************
Ian Lynagh's avatar
Ian Lynagh committed
55
%*                                                                      *
56
\subsection{Type-checking bindings}
Ian Lynagh's avatar
Ian Lynagh committed
57
%*                                                                      *
58
59
%************************************************************************

60
@tcBindsAndThen@ typechecks a @HsBinds@.  The "and then" part is because
61
62
63
64
65
66
67
68
69
70
it needs to know something about the {\em usage} of the things bound,
so that it can create specialisations of them.  So @tcBindsAndThen@
takes a function which, given an extended environment, E, typechecks
the scope of the bindings returning a typechecked thing and (most
important) an LIE.  It is this LIE which is then used as the basis for
specialising the things bound.

@tcBindsAndThen@ also takes a "combiner" which glues together the
bindings and the "thing" to make a new "thing".

71
The real work is done by @tcBindWithSigsAndThen@.
72
73
74
75
76
77
78
79
80
81

Recursive and non-recursive binds are handled in essentially the same
way: because of uniques there are no scoping issues left.  The only
difference is that non-recursive bindings can bind primitive values.

Even for non-recursive binding groups we add typings for each binder
to the LVE for the following reason.  When each individual binding is
checked the type of its LHS is unified with that of its RHS; and
type-checking the LHS of course requires that the binder is in scope.

82
83
84
At the top-level the LIE is sure to contain nothing but constant
dictionaries, which we resolve at the module level.

85
\begin{code}
86
tcTopBinds :: HsValBinds Name -> TcM (LHsBinds TcId, TcLclEnv)
Ian Lynagh's avatar
Ian Lynagh committed
87
88
89
        -- Note: returning the TcLclEnv is more than we really
        --       want.  The bit we care about is the local bindings
        --       and the free type variables thereof
90
tcTopBinds binds
Ian Lynagh's avatar
Ian Lynagh committed
91
92
93
94
  = do  { (ValBindsOut prs _, env) <- tcValBinds TopLevel binds getLclEnv
        ; return (foldr (unionBags . snd) emptyBag prs, env) }
        -- The top level bindings are flattened into a giant 
        -- implicitly-mutually-recursive LHsBinds
95

96
tcHsBootSigs :: HsValBinds Name -> TcM [Id]
97
98
-- A hs-boot file has only one BindGroup, and it only has type
-- signatures in it.  The renamer checked all this
99
tcHsBootSigs (ValBindsOut binds sigs)
Ian Lynagh's avatar
Ian Lynagh committed
100
101
  = do  { checkTc (null binds) badBootDeclErr
        ; mapM (addLocM tc_boot_sig) (filter isVanillaLSig sigs) }
102
  where
103
    tc_boot_sig (TypeSig (L _ name) ty)
104
      = do { sigma_ty <- tcHsSigType (FunSigCtxt name) ty
105
           ; return (mkVanillaGlobal name sigma_ty) }
Ian Lynagh's avatar
Ian Lynagh committed
106
        -- Notice that we make GlobalIds, not LocalIds
Ian Lynagh's avatar
Ian Lynagh committed
107
    tc_boot_sig s = pprPanic "tcHsBootSigs/tc_boot_sig" (ppr s)
108
tcHsBootSigs groups = pprPanic "tcHsBootSigs" (ppr groups)
109

110
badBootDeclErr :: Message
Ian Lynagh's avatar
Ian Lynagh committed
111
badBootDeclErr = ptext (sLit "Illegal declarations in an hs-boot file")
112

113
114
------------------------
tcLocalBinds :: HsLocalBinds Name -> TcM thing
Ian Lynagh's avatar
Ian Lynagh committed
115
             -> TcM (HsLocalBinds TcId, thing)
sof's avatar
sof committed
116

117
tcLocalBinds EmptyLocalBinds thing_inside 
Ian Lynagh's avatar
Ian Lynagh committed
118
119
  = do  { thing <- thing_inside
        ; return (EmptyLocalBinds, thing) }
sof's avatar
sof committed
120

121
tcLocalBinds (HsValBinds binds) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
122
123
  = do  { (binds', thing) <- tcValBinds NotTopLevel binds thing_inside
        ; return (HsValBinds binds', thing) }
124

125
tcLocalBinds (HsIPBinds (IPBinds ip_binds _)) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
126
127
  = do  { (thing, lie) <- getLIE thing_inside
        ; (avail_ips, ip_binds') <- mapAndUnzipM (wrapLocSndM tc_ip_bind) ip_binds
128

Ian Lynagh's avatar
Ian Lynagh committed
129
130
131
132
        -- If the binding binds ?x = E, we  must now 
        -- discharge any ?x constraints in expr_lie
        ; dict_binds <- tcSimplifyIPs avail_ips lie
        ; return (HsIPBinds (IPBinds ip_binds' dict_binds), thing) }
133
  where
Ian Lynagh's avatar
Ian Lynagh committed
134
135
136
        -- I wonder if we should do these one at at time
        -- Consider     ?x = 4
        --              ?y = ?x + 1
137
138
139
140
141
    tc_ip_bind (IPBind ip expr) = do
        ty <- newFlexiTyVarTy argTypeKind
        (ip', ip_inst) <- newIPDict (IPBindOrigin ip) ip ty
        expr' <- tcMonoExpr expr ty
        return (ip_inst, (IPBind ip' expr'))
142

143
144
------------------------
tcValBinds :: TopLevelFlag 
Ian Lynagh's avatar
Ian Lynagh committed
145
146
           -> HsValBinds Name -> TcM thing
           -> TcM (HsValBinds TcId, thing) 
147

Ian Lynagh's avatar
Ian Lynagh committed
148
tcValBinds _ (ValBindsIn binds _) _
149
150
  = pprPanic "tcValBinds" (ppr binds)

151
tcValBinds top_lvl (ValBindsOut binds sigs) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
152
153
154
155
156
  = do  {       -- Typecheck the signature
        ; let { prag_fn = mkPragFun sigs
              ; ty_sigs = filter isVanillaLSig sigs
              ; sig_fn  = mkTcSigFun ty_sigs }

157
        ; poly_ids <- checkNoErrs (mapAndRecoverM tcTySig ty_sigs)
Ian Lynagh's avatar
Ian Lynagh committed
158
159
160
161
162
163
164
165
166
167
                -- No recovery from bad signatures, because the type sigs
                -- may bind type variables, so proceeding without them
                -- can lead to a cascade of errors
                -- ToDo: this means we fall over immediately if any type sig
                -- is wrong, which is over-conservative, see Trac bug #745

                -- Extend the envt right away with all 
                -- the Ids declared with type signatures
        ; poly_rec <- doptM Opt_RelaxedPolyRec
        ; (binds', thing) <- tcExtendIdEnv poly_ids $
168
                             tcBindGroups poly_rec top_lvl sig_fn prag_fn 
Ian Lynagh's avatar
Ian Lynagh committed
169
170
171
                                          binds thing_inside

        ; return (ValBindsOut binds' sigs, thing) }
172

173
------------------------
174
tcBindGroups :: Bool -> TopLevelFlag -> TcSigFun -> TcPragFun
Ian Lynagh's avatar
Ian Lynagh committed
175
176
             -> [(RecFlag, LHsBinds Name)] -> TcM thing
             -> TcM ([(RecFlag, LHsBinds TcId)], thing)
177
178
-- Typecheck a whole lot of value bindings,
-- one strongly-connected component at a time
179
180
181
-- Here a "strongly connected component" has the strightforward
-- meaning of a group of bindings that mention each other, 
-- ignoring type signatures (that part comes later)
182

183
tcBindGroups _ _ _ _ [] thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
184
185
  = do  { thing <- thing_inside
        ; return ([], thing) }
186

187
tcBindGroups poly_rec top_lvl sig_fn prag_fn (group : groups) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
188
189
  = do  { (group', (groups', thing))
                <- tc_group poly_rec top_lvl sig_fn prag_fn group $ 
190
                   tcBindGroups poly_rec top_lvl sig_fn prag_fn groups thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
191
        ; return (group' ++ groups', thing) }
sof's avatar
sof committed
192

193
------------------------
194
tc_group :: Bool -> TopLevelFlag -> TcSigFun -> TcPragFun
Ian Lynagh's avatar
Ian Lynagh committed
195
196
         -> (RecFlag, LHsBinds Name) -> TcM thing
         -> TcM ([(RecFlag, LHsBinds TcId)], thing)
197
198
199
200
201

-- Typecheck one strongly-connected component of the original program.
-- We get a list of groups back, because there may 
-- be specialisations etc as well

Ian Lynagh's avatar
Ian Lynagh committed
202
tc_group _ top_lvl sig_fn prag_fn (NonRecursive, binds) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
203
204
        -- A single non-recursive binding
        -- We want to keep non-recursive things non-recursive
205
        -- so that we desugar unlifted bindings correctly
Ian Lynagh's avatar
Ian Lynagh committed
206
207
 =  do  { (binds, thing) <- tc_haskell98 top_lvl sig_fn prag_fn NonRecursive binds thing_inside
        ; return ([(NonRecursive, b) | b <- binds], thing) }
208

209
tc_group poly_rec top_lvl sig_fn prag_fn (Recursive, binds) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
210
211
212
213
214
  | not poly_rec        -- Recursive group, normal Haskell 98 route
  = do  { (binds1, thing) <- tc_haskell98 top_lvl sig_fn prag_fn Recursive binds thing_inside
        ; return ([(Recursive, unionManyBags binds1)], thing) }

  | otherwise           -- Recursive group, with gla-exts
215
  =     -- To maximise polymorphism (with -XRelaxedPolyRec), we do a new 
Ian Lynagh's avatar
Ian Lynagh committed
216
217
218
        -- strongly-connected-component analysis, this time omitting 
        -- any references to variables with type signatures.
        --
219
220
        -- Notice that the bindInsts thing covers *all* the bindings in
        -- the original group at once; an earlier one may use a later one!
Ian Lynagh's avatar
Ian Lynagh committed
221
222
    do  { traceTc (text "tc_group rec" <+> pprLHsBinds binds)
        ; (binds1,thing) <- bindLocalInsts top_lvl $
223
                            go (stronglyConnCompFromEdgedVertices (mkEdges sig_fn binds))
Ian Lynagh's avatar
Ian Lynagh committed
224
225
        ; return ([(Recursive, unionManyBags binds1)], thing) }
                -- Rec them all together
226
  where
227
--  go :: SCC (LHsBind Name) -> TcM ([LHsBind TcId], [TcId], thing)
Ian Lynagh's avatar
Ian Lynagh committed
228
229
230
231
    go (scc:sccs) = do  { (binds1, ids1) <- tc_scc scc
                        ; (binds2, ids2, thing) <- tcExtendIdEnv ids1 $ go sccs
                        ; return (binds1 ++ binds2, ids1 ++ ids2, thing) }
    go []         = do  { thing <- thing_inside; return ([], [], thing) }
232

233
234
    tc_scc (AcyclicSCC bind) = tc_sub_group NonRecursive (unitBag bind)
    tc_scc (CyclicSCC binds) = tc_sub_group Recursive    (listToBag binds)
sof's avatar
sof committed
235

236
    tc_sub_group = tcPolyBinds top_lvl sig_fn prag_fn Recursive
sof's avatar
sof committed
237

Ian Lynagh's avatar
Ian Lynagh committed
238
239
tc_haskell98 :: TopLevelFlag -> TcSigFun -> TcPragFun -> RecFlag
             -> LHsBinds Name -> TcM a -> TcM ([LHsBinds TcId], a)
240
241
242
243
244
245
246
247
248
tc_haskell98 top_lvl sig_fn prag_fn rec_flag binds thing_inside
  = bindLocalInsts top_lvl $ do
    { (binds1, ids) <- tcPolyBinds top_lvl sig_fn prag_fn rec_flag rec_flag binds
    ; thing <- tcExtendIdEnv ids thing_inside
    ; return (binds1, ids, thing) }

------------------------
bindLocalInsts :: TopLevelFlag -> TcM ([LHsBinds TcId], [TcId], a) -> TcM ([LHsBinds TcId], a)
bindLocalInsts top_lvl thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
249
  | isTopLevel top_lvl = do { (binds, _, thing) <- thing_inside; return (binds, thing) }
Ian Lynagh's avatar
Ian Lynagh committed
250
251
252
        -- For the top level don't bother with all this bindInstsOfLocalFuns stuff. 
        -- All the top level things are rec'd together anyway, so it's fine to
        -- leave them to the tcSimplifyTop, and quite a bit faster too
253

Ian Lynagh's avatar
Ian Lynagh committed
254
255
256
257
  | otherwise   -- Nested case
  = do  { ((binds, ids, thing), lie) <- getLIE thing_inside
        ; lie_binds <- bindInstsOfLocalFuns lie ids
        ; return (binds ++ [lie_binds], thing) }
258
259
260

------------------------
mkEdges :: TcSigFun -> LHsBinds Name
Ian Lynagh's avatar
Ian Lynagh committed
261
        -> [(LHsBind Name, BKey, [BKey])]
262
263
264
265

type BKey  = Int -- Just number off the bindings

mkEdges sig_fn binds
266
  = [ (bind, key, [key | n <- nameSetToList (bind_fvs (unLoc bind)),
Ian Lynagh's avatar
Ian Lynagh committed
267
                         Just key <- [lookupNameEnv key_map n], no_sig n ])
268
269
270
271
272
273
274
275
    | (bind, key) <- keyd_binds
    ]
  where
    no_sig :: Name -> Bool
    no_sig n = isNothing (sig_fn n)

    keyd_binds = bagToList binds `zip` [0::BKey ..]

Ian Lynagh's avatar
Ian Lynagh committed
276
    key_map :: NameEnv BKey     -- Which binding it comes from
277
    key_map = mkNameEnv [(bndr, key) | (L _ bind, key) <- keyd_binds
Ian Lynagh's avatar
Ian Lynagh committed
278
                                     , bndr <- bindersOfHsBind bind ]
279
280

bindersOfHsBind :: HsBind Name -> [Name]
281
282
bindersOfHsBind (PatBind { pat_lhs = pat })  = collectPatBinders pat
bindersOfHsBind (FunBind { fun_id = L _ f }) = [f]
Ian Lynagh's avatar
Ian Lynagh committed
283
284
bindersOfHsBind (AbsBinds {})                = panic "bindersOfHsBind AbsBinds"
bindersOfHsBind (VarBind {})                 = panic "bindersOfHsBind VarBind"
285

286
------------------------
287
tcPolyBinds :: TopLevelFlag -> TcSigFun -> TcPragFun
Ian Lynagh's avatar
Ian Lynagh committed
288
289
290
291
292
            -> RecFlag                  -- Whether the group is really recursive
            -> RecFlag                  -- Whether it's recursive after breaking
                                        -- dependencies based on type signatures
            -> LHsBinds Name
            -> TcM ([LHsBinds TcId], [TcId])
293
294
295
296
297

-- Typechecks a single bunch of bindings all together, 
-- and generalises them.  The bunch may be only part of a recursive
-- group, because we use type signatures to maximise polymorphism
--
298
299
300
-- Returns a list because the input may be a single non-recursive binding,
-- in which case the dependency order of the resulting bindings is
-- important.  
301
-- 
302
303
-- Knows nothing about the scope of the bindings

304
tcPolyBinds top_lvl sig_fn prag_fn rec_group rec_tc binds
305
  = let 
Ian Lynagh's avatar
Ian Lynagh committed
306
        bind_list    = bagToList binds
307
        binder_names = collectHsBindBinders binds
Ian Lynagh's avatar
Ian Lynagh committed
308
309
310
        loc          = getLoc (head bind_list)
                -- TODO: location a bit awkward, but the mbinds have been
                --       dependency analysed and may no longer be adjacent
311
    in
Ian Lynagh's avatar
Ian Lynagh committed
312
313
314
        -- SET UP THE MAIN RECOVERY; take advantage of any type sigs
    setSrcSpan loc                              $
    recoverM (recoveryCode binder_names sig_fn) $ do 
315

Ian Lynagh's avatar
Ian Lynagh committed
316
317
  { traceTc (ptext (sLit "------------------------------------------------"))
  ; traceTc (ptext (sLit "Bindings for") <+> ppr binder_names)
318

Ian Lynagh's avatar
Ian Lynagh committed
319
        -- TYPECHECK THE BINDINGS
320
  ; ((binds', mono_bind_infos), lie_req) 
Ian Lynagh's avatar
Ian Lynagh committed
321
        <- getLIE (tcMonoBinds bind_list sig_fn rec_tc)
322
  ; traceTc (text "temp" <+> (ppr binds' $$ ppr lie_req))
323

Ian Lynagh's avatar
Ian Lynagh committed
324
325
326
        -- CHECK FOR UNLIFTED BINDINGS
        -- These must be non-recursive etc, and are not generalised
        -- They desugar to a case expression in the end
327
  ; zonked_mono_tys <- zonkTcTypes (map getMonoType mono_bind_infos)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
328
  ; is_strict <- checkStrictBinds top_lvl rec_group binds' 
Ian Lynagh's avatar
Ian Lynagh committed
329
                                  zonked_mono_tys mono_bind_infos
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
330
  ; if is_strict then
Ian Lynagh's avatar
Ian Lynagh committed
331
332
333
    do  { extendLIEs lie_req
        ; let exports = zipWith mk_export mono_bind_infos zonked_mono_tys
              mk_export (name, Nothing,  mono_id) mono_ty = ([], mkLocalId name mono_ty, mono_id, [])
Ian Lynagh's avatar
Ian Lynagh committed
334
              mk_export (_,    Just sig, mono_id) _       = ([], sig_id sig,             mono_id, [])
Ian Lynagh's avatar
Ian Lynagh committed
335
                        -- ToDo: prags for unlifted bindings
336

Ian Lynagh's avatar
Ian Lynagh committed
337
338
        ; return ( [unitBag $ L loc $ AbsBinds [] [] exports binds'],
                   [poly_id | (_, poly_id, _, _) <- exports]) } -- Guaranteed zonked
339

Ian Lynagh's avatar
Ian Lynagh committed
340
    else do     -- The normal lifted case: GENERALISE
341
  { dflags <- getDOpts 
342
  ; (tyvars_to_gen, dicts, dict_binds)
Ian Lynagh's avatar
Ian Lynagh committed
343
344
        <- addErrCtxt (genCtxt (bndrNames mono_bind_infos)) $
           generalise dflags top_lvl bind_list sig_fn mono_bind_infos lie_req
345

Ian Lynagh's avatar
Ian Lynagh committed
346
347
        -- BUILD THE POLYMORPHIC RESULT IDs
  ; 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))
Ian Lynagh's avatar
Ian Lynagh committed
349
                    mono_bind_infos
sof's avatar
sof committed
350

Ian Lynagh's avatar
Ian Lynagh committed
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
Ian Lynagh's avatar
Ian Lynagh committed
355
356
                                    dict_vars exports
                                    (dict_binds `unionBags` binds')
357

Ian Lynagh's avatar
Ian Lynagh committed
358
  ; return ([unitBag abs_bind], poly_ids)       -- poly_ids are guaranteed zonked by mkExport
359
360
361
362
  } }


--------------
363
mkExport :: TopLevelFlag -> TcPragFun -> [TyVar] -> [TcType]
Ian Lynagh's avatar
Ian Lynagh committed
364
365
         -> MonoBindInfo
         -> TcM ([TyVar], Id, Id, [LPrag])
366
-- mkExport generates exports with 
Ian Lynagh's avatar
Ian Lynagh committed
367
368
--      zonked type variables, 
--      zonked poly_ids
369
370
371
372
373
374
375
376
-- The former is just because no further unifications will change
-- the quantified type variables, so we can fix their final form
-- right now.
-- The latter is needed because the poly_ids are used to extend the
-- type environment; see the invariant on TcEnv.tcExtendIdEnv 

-- Pre-condition: the inferred_tvs are already zonked

377
mkExport top_lvl prag_fn inferred_tvs dict_tys (poly_name, mb_sig, mono_id)
Ian Lynagh's avatar
Ian Lynagh committed
378
379
380
381
  = do  { warn_missing_sigs <- doptM Opt_WarnMissingSigs
        ; let warn = isTopLevel top_lvl && warn_missing_sigs
        ; (tvs, poly_id) <- mk_poly_id warn mb_sig
                -- poly_id has a zonked type
382

Ian Lynagh's avatar
Ian Lynagh committed
383
384
        ; prags <- tcPrags poly_id (prag_fn poly_name)
                -- tcPrags requires a zonked poly_id
385

Ian Lynagh's avatar
Ian Lynagh committed
386
        ; return (tvs, poly_id, mono_id, prags) }
387
388
389
  where
    poly_ty = mkForAllTys inferred_tvs (mkFunTys dict_tys (idType mono_id))

390
    mk_poly_id warn Nothing    = do { poly_ty' <- zonkTcType poly_ty
Ian Lynagh's avatar
Ian Lynagh committed
391
392
                                    ; missingSigWarn warn poly_name poly_ty'
                                    ; return (inferred_tvs, mkLocalId poly_name poly_ty') }
Ian Lynagh's avatar
Ian Lynagh committed
393
    mk_poly_id _    (Just sig) = do { tvs <- mapM zonk_tv (sig_tvs sig)
Ian Lynagh's avatar
Ian Lynagh committed
394
                                    ; return (tvs,  sig_id sig) }
395

396
    zonk_tv tv = do { ty <- zonkTcTyVar tv; return (tcGetTyVar "mkExport" ty) }
397
398
399
400
401
402

------------------------
type TcPragFun = Name -> [LSig Name]

mkPragFun :: [LSig Name] -> TcPragFun
mkPragFun sigs = \n -> lookupNameEnv env n `orElse` []
Ian Lynagh's avatar
Ian Lynagh committed
403
404
405
406
407
        where
          prs = [(expectJust "mkPragFun" (sigName sig), sig) 
                | sig <- sigs, isPragLSig sig]
          env = foldl add emptyNameEnv prs
          add env (n,p) = extendNameEnv_Acc (:) singleton env n p
408

409
410
tcPrags :: Id -> [LSig Name] -> TcM [LPrag]
tcPrags poly_id prags = mapM (wrapLocM tc_prag) prags
411
  where
412
    tc_prag prag = addErrCtxt (pragSigCtxt prag) $ 
Ian Lynagh's avatar
Ian Lynagh committed
413
                   tcPrag poly_id prag
414

Ian Lynagh's avatar
Ian Lynagh committed
415
pragSigCtxt :: Sig Name -> SDoc
Ian Lynagh's avatar
Ian Lynagh committed
416
pragSigCtxt prag = hang (ptext (sLit "In the pragma")) 2 (ppr prag)
417
418

tcPrag :: TcId -> Sig Name -> TcM Prag
419
420
-- Pre-condition: the poly_id is zonked
-- Reason: required by tcSubExp
Ian Lynagh's avatar
Ian Lynagh committed
421
422
423
424
425
tcPrag poly_id (SpecSig _ hs_ty inl) = tcSpecPrag poly_id hs_ty inl
tcPrag poly_id (SpecInstSig hs_ty)   = tcSpecPrag poly_id hs_ty defaultInlineSpec
tcPrag _       (InlineSig _ inl)     = return (InlinePrag inl)
tcPrag _       (FixSig {})           = panic "tcPrag FixSig"
tcPrag _       (TypeSig {})          = panic "tcPrag TypeSig"
426

427

428
429
tcSpecPrag :: TcId -> LHsType Name -> InlineSpec -> TcM Prag
tcSpecPrag poly_id hs_ty inl
Ian Lynagh's avatar
Ian Lynagh committed
430
431
432
433
434
435
  = do  { let name = idName poly_id
        ; spec_ty <- tcHsSigType (FunSigCtxt name) hs_ty
        ; co_fn <- tcSubExp (SpecPragOrigin name) (idType poly_id) spec_ty
        ; return (SpecPrag (mkHsWrap co_fn (HsVar poly_id)) spec_ty inl) }
        -- Most of the work of specialisation is done by 
        -- the desugarer, guided by the SpecPrag
436
437
  
--------------
438
439
440
-- If typechecking the binds fails, then return with each
-- signature-less binder given type (forall a.a), to minimise 
-- subsequent error messages
Ian Lynagh's avatar
Ian Lynagh committed
441
442
recoveryCode :: [Name] -> (Name -> Maybe [Name])
             -> TcM ([Bag (LHsBindLR Id Var)], [Id])
443
recoveryCode binder_names sig_fn
Ian Lynagh's avatar
Ian Lynagh committed
444
445
446
  = do  { traceTc (text "tcBindsWithSigs: error recovery" <+> ppr binder_names)
        ; poly_ids <- mapM mk_dummy binder_names
        ; return ([], poly_ids) }
447
  where
448
    mk_dummy name 
Ian Lynagh's avatar
Ian Lynagh committed
449
450
        | isJust (sig_fn name) = tcLookupId name        -- Had signature; look it up
        | otherwise            = return (mkLocalId name forall_a_a)    -- No signature
451
452
453
454

forall_a_a :: TcType
forall_a_a = mkForAllTy alphaTyVar (mkTyVarTy alphaTyVar)

455

456
-- Check that non-overloaded unlifted bindings are
Ian Lynagh's avatar
Ian Lynagh committed
457
458
459
--      a) non-recursive,
--      b) not top level, 
--      c) not a multiple-binding group (more or less implied by (a))
460

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
461
checkStrictBinds :: TopLevelFlag -> RecFlag
Ian Lynagh's avatar
Ian Lynagh committed
462
463
                 -> LHsBinds TcId -> [TcType] -> [MonoBindInfo]
                 -> TcM Bool
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
464
465
checkStrictBinds top_lvl rec_group mbind mono_tys infos
  | unlifted || bang_pat
Ian Lynagh's avatar
Ian Lynagh committed
466
467
468
469
470
471
472
473
  = do  { checkTc (isNotTopLevel top_lvl)
                  (strictBindErr "Top-level" unlifted mbind)
        ; checkTc (isNonRec rec_group)
                  (strictBindErr "Recursive" unlifted mbind)
        ; checkTc (isSingletonBag mbind)
                  (strictBindErr "Multiple" unlifted mbind) 
        ; mapM_ check_sig infos
        ; return True }
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
474
475
  | otherwise
  = return False
476
  where
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
477
478
    unlifted = any isUnLiftedType mono_tys
    bang_pat = anyBag (isBangHsBind . unLoc) mbind
479
    check_sig (_, Just sig, _) = checkTc (null (sig_tvs sig) && null (sig_theta sig))
Ian Lynagh's avatar
Ian Lynagh committed
480
                                         (badStrictSig unlifted sig)
Ian Lynagh's avatar
Ian Lynagh committed
481
    check_sig _                = return ()
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
482

Ian Lynagh's avatar
Ian Lynagh committed
483
strictBindErr :: String -> Bool -> LHsBindsLR Var Var -> SDoc
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
484
strictBindErr flavour unlifted mbind
Ian Lynagh's avatar
Ian Lynagh committed
485
  = hang (text flavour <+> msg <+> ptext (sLit "aren't allowed:")) 
Ian Lynagh's avatar
Ian Lynagh committed
486
         4 (pprLHsBinds mbind)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
487
  where
Ian Lynagh's avatar
Ian Lynagh committed
488
    msg | unlifted  = ptext (sLit "bindings for unlifted types")
Ian Lynagh's avatar
Ian Lynagh committed
489
        | otherwise = ptext (sLit "bang-pattern bindings")
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
490

Ian Lynagh's avatar
Ian Lynagh committed
491
badStrictSig :: Bool -> TcSigInfo -> SDoc
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
492
badStrictSig unlifted sig
Ian Lynagh's avatar
Ian Lynagh committed
493
  = hang (ptext (sLit "Illegal polymorphic signature in") <+> msg)
Ian Lynagh's avatar
Ian Lynagh committed
494
         4 (ppr sig)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
495
  where
Ian Lynagh's avatar
Ian Lynagh committed
496
    msg | unlifted  = ptext (sLit "an unlifted binding")
Ian Lynagh's avatar
Ian Lynagh committed
497
        | otherwise = ptext (sLit "a bang-pattern binding")
498
499
\end{code}

500

501
%************************************************************************
Ian Lynagh's avatar
Ian Lynagh committed
502
%*                                                                      *
503
\subsection{tcMonoBind}
Ian Lynagh's avatar
Ian Lynagh committed
504
%*                                                                      *
505
506
%************************************************************************

507
@tcMonoBinds@ deals with a perhaps-recursive group of HsBinds.
508
509
The signatures have been dealt with already.

510
\begin{code}
511
tcMonoBinds :: [LHsBind Name]
Ian Lynagh's avatar
Ian Lynagh committed
512
513
514
515
516
            -> TcSigFun
            -> RecFlag  -- Whether the binding is recursive for typechecking purposes
                        -- i.e. the binders are mentioned in their RHSs, and
                        --      we are not resuced by a type signature
            -> TcM (LHsBinds TcId, [MonoBindInfo])
517

518
tcMonoBinds [L b_loc (FunBind { fun_id = L nm_loc name, fun_infix = inf, 
Ian Lynagh's avatar
Ian Lynagh committed
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
                                fun_matches = matches, bind_fvs = fvs })]
            sig_fn              -- Single function binding,
            NonRecursive        -- binder isn't mentioned in RHS,
  | Nothing <- sig_fn name      -- ...with no type signature
  =     -- In this very special case we infer the type of the
        -- right hand side first (it may have a higher-rank type)
        -- and *then* make the monomorphic Id for the LHS
        -- e.g.         f = \(x::forall a. a->a) -> <body>
        --      We want to infer a higher-rank type for f
    setSrcSpan b_loc    $
    do  { ((co_fn, matches'), rhs_ty) <- tcInfer (tcMatchesFun name inf matches)

                -- Check for an unboxed tuple type
                --      f = (# True, False #)
                -- Zonk first just in case it's hidden inside a meta type variable
                -- (This shows up as a (more obscure) kind error 
                --  in the 'otherwise' case of tcMonoBinds.)
        ; zonked_rhs_ty <- zonkTcType rhs_ty
        ; checkTc (not (isUnboxedTupleType zonked_rhs_ty))
                  (unboxedTupleErr name zonked_rhs_ty)

        ; mono_name <- newLocalName name
        ; let mono_id = mkLocalId mono_name zonked_rhs_ty
        ; return (unitBag (L b_loc (FunBind { fun_id = L nm_loc mono_id, fun_infix = inf,
                                              fun_matches = matches', bind_fvs = fvs,
                                              fun_co_fn = co_fn, fun_tick = Nothing })),
                  [(name, Nothing, mono_id)]) }
546

547
tcMonoBinds [L b_loc (FunBind { fun_id = L nm_loc name, fun_infix = inf, 
Ian Lynagh's avatar
Ian Lynagh committed
548
                                fun_matches = matches })]
Ian Lynagh's avatar
Ian Lynagh committed
549
            sig_fn              -- Single function binding
Ian Lynagh's avatar
Ian Lynagh committed
550
            _
Ian Lynagh's avatar
Ian Lynagh committed
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
  | Just scoped_tvs <- sig_fn name      -- ...with a type signature
  =     -- When we have a single function binding, with a type signature
        -- we can (a) use genuine, rigid skolem constants for the type variables
        --        (b) bring (rigid) scoped type variables into scope
    setSrcSpan b_loc    $
    do  { tc_sig <- tcInstSig True name
        ; mono_name <- newLocalName name
        ; let mono_ty = sig_tau tc_sig
              mono_id = mkLocalId mono_name mono_ty
              rhs_tvs = [ (name, mkTyVarTy tv)
                        | (name, tv) <- scoped_tvs `zip` sig_tvs tc_sig ]
                        -- See Note [More instantiated than scoped]
                        -- Note that the scoped_tvs and the (sig_tvs sig) 
                        -- may have different Names. That's quite ok.

566
	; traceTc (text "tcMoonBinds" <+> ppr scoped_tvs $$ ppr tc_sig)
Ian Lynagh's avatar
Ian Lynagh committed
567
568
        ; (co_fn, matches') <- tcExtendTyVarEnv2 rhs_tvs $
                               tcMatchesFun mono_name inf matches mono_ty
569
570
571
572
573
	     -- Note that "mono_ty" might actually be a polymorphic type,
	     -- if the original function had a signature like
	     --    forall a. Eq a => forall b. Ord b => ....
	     -- But that's ok: tcMatchesFun can deal with that
	     -- It happens, too!  See Note [Polymorphic methods] in TcClassDcl.
Ian Lynagh's avatar
Ian Lynagh committed
574
575
576
577
578
579
580

        ; let fun_bind' = FunBind { fun_id = L nm_loc mono_id, 
                                    fun_infix = inf, fun_matches = matches',
                                    bind_fvs = placeHolderNames, fun_co_fn = co_fn, 
                                    fun_tick = Nothing }
        ; return (unitBag (L b_loc fun_bind'),
                  [(name, Just tc_sig, mono_id)]) }
581

Ian Lynagh's avatar
Ian Lynagh committed
582
tcMonoBinds binds sig_fn _
Ian Lynagh's avatar
Ian Lynagh committed
583
  = do  { tc_binds <- mapM (wrapLocM (tcLhs sig_fn)) binds
584

Ian Lynagh's avatar
Ian Lynagh committed
585
586
587
588
589
        -- Bring the monomorphic Ids, into scope for the RHSs
        ; let mono_info  = getMonoBindInfo tc_binds
              rhs_id_env = [(name,mono_id) | (name, Nothing, mono_id) <- mono_info]
                                -- A monomorphic binding for each term variable that lacks 
                                -- a type sig.  (Ones with a sig are already in scope.)
590

Ian Lynagh's avatar
Ian Lynagh committed
591
592
593
594
595
        ; binds' <- tcExtendIdEnv2 rhs_id_env $ do
                    traceTc (text "tcMonoBinds" <+> vcat [ ppr n <+> ppr id <+> ppr (idType id) 
                                                         | (n,id) <- rhs_id_env])
                    mapM (wrapLocM tcRhs) tc_binds
        ; return (listToBag binds', mono_info) }
596
597
598
599

------------------------
-- tcLhs typechecks the LHS of the bindings, to construct the environment in which
-- we typecheck the RHSs.  Basically what we are doing is this: for each binder:
Ian Lynagh's avatar
Ian Lynagh committed
600
601
--      if there's a signature for it, use the instantiated signature type
--      otherwise invent a type variable
602
603
604
-- You see that quite directly in the FunBind case.
-- 
-- But there's a complication for pattern bindings:
Ian Lynagh's avatar
Ian Lynagh committed
605
606
--      data T = MkT (forall a. a->a)
--      MkT f = e
607
608
609
610
611
612
-- Here we can guess a type variable for the entire LHS (which will be refined to T)
-- but we want to get (f::forall a. a->a) as the RHS environment.
-- The simplest way to do this is to typecheck the pattern, and then look up the
-- bound mono-ids.  Then we want to retain the typechecked pattern to avoid re-doing
-- it; hence the TcMonoBind data type in which the LHS is done but the RHS isn't

Ian Lynagh's avatar
Ian Lynagh committed
613
data TcMonoBind         -- Half completed; LHS done, RHS not done
614
615
616
  = TcFunBind  MonoBindInfo  (Located TcId) Bool (MatchGroup Name) 
  | TcPatBind [MonoBindInfo] (LPat TcId) (GRHSs Name) TcSigmaType

617
type MonoBindInfo = (Name, Maybe TcSigInfo, TcId)
Ian Lynagh's avatar
Ian Lynagh committed
618
619
        -- Type signature (if any), and
        -- the monomorphic bound things
620
621
622
623
624
625
626

bndrNames :: [MonoBindInfo] -> [Name]
bndrNames mbi = [n | (n,_,_) <- mbi]

getMonoType :: MonoBindInfo -> TcTauType
getMonoType (_,_,mono_id) = idType mono_id

627
tcLhs :: TcSigFun -> HsBind Name -> TcM TcMonoBind
628
tcLhs sig_fn (FunBind { fun_id = L nm_loc name, fun_infix = inf, fun_matches = matches })
Ian Lynagh's avatar
Ian Lynagh committed
629
630
631
632
633
  = do  { mb_sig <- tcInstSig_maybe sig_fn name
        ; mono_name <- newLocalName name
        ; mono_ty   <- mk_mono_ty mb_sig
        ; let mono_id = mkLocalId mono_name mono_ty
        ; return (TcFunBind (name, mb_sig, mono_id) (L nm_loc mono_id) inf matches) }
634
635
  where
    mk_mono_ty (Just sig) = return (sig_tau sig)
636
637
    mk_mono_ty Nothing    = newFlexiTyVarTy argTypeKind

Ian Lynagh's avatar
Ian Lynagh committed
638
tcLhs sig_fn (PatBind { pat_lhs = pat, pat_rhs = grhss })
Ian Lynagh's avatar
Ian Lynagh committed
639
640
  = do  { mb_sigs <- mapM (tcInstSig_maybe sig_fn) names
        ; mono_pat_binds <- doptM Opt_MonoPatBinds
641
                -- With -XMonoPatBinds, we do no generalisation of pattern bindings
Ian Lynagh's avatar
Ian Lynagh committed
642
643
644
645
646
                -- But the signature can still be polymoprhic!
                --      data T = MkT (forall a. a->a)
                --      x :: forall a. a->a
                --      MkT x = <rhs>
                -- The function get_sig_ty decides whether the pattern-bound variables
647
648
                -- should have exactly the type in the type signature (-XMonoPatBinds), 
                -- or the instantiated version (-XMonoPatBinds)
Ian Lynagh's avatar
Ian Lynagh committed
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669

        ; let nm_sig_prs  = names `zip` mb_sigs
              get_sig_ty | mono_pat_binds = idType . sig_id
                         | otherwise      = sig_tau
              tau_sig_env = mkNameEnv [ (name, get_sig_ty sig) 
                                      | (name, Just sig) <- nm_sig_prs]
              sig_tau_fn  = lookupNameEnv tau_sig_env

              tc_pat exp_ty = tcLetPat sig_tau_fn pat exp_ty $
                              mapM lookup_info nm_sig_prs

                -- After typechecking the pattern, look up the binder
                -- names, which the pattern has brought into scope.
              lookup_info :: (Name, Maybe TcSigInfo) -> TcM MonoBindInfo
              lookup_info (name, mb_sig) = do { mono_id <- tcLookupId name
                                              ; return (name, mb_sig, mono_id) }

        ; ((pat', infos), pat_ty) <- addErrCtxt (patMonoBindsCtxt pat grhss) $
                                     tcInfer tc_pat

        ; return (TcPatBind infos pat' grhss pat_ty) }
670
671
672
673
  where
    names = collectPatBinders pat


Ian Lynagh's avatar
Ian Lynagh committed
674
tcLhs _ other_bind = pprPanic "tcLhs" (ppr other_bind)
Ian Lynagh's avatar
Ian Lynagh committed
675
        -- AbsBind, VarBind impossible
676

677
678
-------------------
tcRhs :: TcMonoBind -> TcM (HsBind TcId)
679
680
681
682
683
-- When we are doing pattern bindings, or multiple function bindings at a time
-- we *don't* bring any scoped type variables into scope
-- Wny not?  They are not completely rigid.
-- That's why we have the special case for a single FunBind in tcMonoBinds
tcRhs (TcFunBind (_,_,mono_id) fun' inf matches)
Ian Lynagh's avatar
Ian Lynagh committed
684
685
686
687
688
  = do  { (co_fn, matches') <- tcMatchesFun (idName mono_id) inf 
                                            matches (idType mono_id)
        ; return (FunBind { fun_id = fun', fun_infix = inf, fun_matches = matches',
                            bind_fvs = placeHolderNames, fun_co_fn = co_fn,
                            fun_tick = Nothing }) }
689

Ian Lynagh's avatar
Ian Lynagh committed
690
tcRhs (TcPatBind _ pat' grhss pat_ty)
Ian Lynagh's avatar
Ian Lynagh committed
691
692
693
694
  = do  { grhss' <- addErrCtxt (patMonoBindsCtxt pat' grhss) $
                    tcGRHSsPat grhss pat_ty
        ; return (PatBind { pat_lhs = pat', pat_rhs = grhss', pat_rhs_ty = pat_ty, 
                            bind_fvs = placeHolderNames }) }
695
696
697


---------------------
698
getMonoBindInfo :: [Located TcMonoBind] -> [MonoBindInfo]
699
getMonoBindInfo tc_binds
700
  = foldr (get_info . unLoc) [] tc_binds
701
702
703
704
705
706
707
  where
    get_info (TcFunBind info _ _ _)  rest = info : rest
    get_info (TcPatBind infos _ _ _) rest = infos ++ rest
\end{code}


%************************************************************************
Ian Lynagh's avatar
Ian Lynagh committed
708
709
710
%*                                                                      *
                Generalisation
%*                                                                      *
711
712
713
%************************************************************************

\begin{code}
714
generalise :: DynFlags -> TopLevelFlag 
Ian Lynagh's avatar
Ian Lynagh committed
715
716
717
           -> [LHsBind Name] -> TcSigFun 
           -> [MonoBindInfo] -> [Inst]
           -> TcM ([TyVar], [Inst], TcDictBinds)
718
719
-- The returned [TyVar] are all ready to quantify

720
721
generalise dflags top_lvl bind_list sig_fn mono_infos lie_req
  | isMonoGroup dflags bind_list
Ian Lynagh's avatar
Ian Lynagh committed
722
723
  = do  { extendLIEs lie_req
        ; return ([], [], emptyBag) }
724

Ian Lynagh's avatar
Ian Lynagh committed
725
726
727
728
  | isRestrictedGroup dflags bind_list sig_fn   -- RESTRICTED CASE
  =     -- Check signature contexts are empty 
    do  { checkTc (all is_mono_sig sigs)
                  (restrictedBindCtxtErr bndrs)
729

Ian Lynagh's avatar
Ian Lynagh committed
730
731
732
733
        -- Now simplify with exactly that set of tyvars
        -- We have to squash those Methods
        ; (qtvs, binds) <- tcSimplifyRestricted doc top_lvl bndrs 
                                                tau_tvs lie_req
734

Ian Lynagh's avatar
Ian Lynagh committed
735
736
        -- Check that signature type variables are OK
        ; final_qtvs <- checkSigsTyVars qtvs sigs
737

Ian Lynagh's avatar
Ian Lynagh committed
738
        ; return (final_qtvs, [], binds) }
739

Ian Lynagh's avatar
Ian Lynagh committed
740
  | null sigs   -- UNRESTRICTED CASE, NO TYPE SIGS
741
742
  = tcSimplifyInfer doc tau_tvs lie_req

Ian Lynagh's avatar
Ian Lynagh committed
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
  | otherwise   -- UNRESTRICTED CASE, WITH TYPE SIGS
  = do  { sig_lie <- unifyCtxts sigs    -- sigs is non-empty; sig_lie is zonked
        ; let   -- The "sig_avails" is the stuff available.  We get that from
                -- the context of the type signature, BUT ALSO the lie_avail
                -- so that polymorphic recursion works right (see Note [Polymorphic recursion])
                local_meths = [mkMethInst sig mono_id | (_, Just sig, mono_id) <- mono_infos]
                sig_avails = sig_lie ++ local_meths
                loc = sig_loc (head sigs)

        -- Check that the needed dicts can be
        -- expressed in terms of the signature ones
        ; (qtvs, binds) <- tcSimplifyInferCheck loc tau_tvs sig_avails lie_req
        
        -- Check that signature type variables are OK
        ; final_qtvs <- checkSigsTyVars qtvs sigs

        ; return (final_qtvs, sig_lie, binds) }
760
  where
761
762
    bndrs   = bndrNames mono_infos
    sigs    = [sig | (_, Just sig, _) <- mono_infos]
Ian Lynagh's avatar
Ian Lynagh committed
763
764
    get_tvs | isTopLevel top_lvl = tyVarsOfType  -- See Note [Silly type synonym] in TcType
            | otherwise          = exactTyVarsOfType
765
    tau_tvs = foldr (unionVarSet . get_tvs . getMonoType) emptyVarSet mono_infos
766
    is_mono_sig sig = null (sig_theta sig)
Ian Lynagh's avatar
Ian Lynagh committed
767
    doc = ptext (sLit "type signature(s) for") <+> pprBinders bndrs
768

769
    mkMethInst (TcSigInfo { sig_id = poly_id, sig_tvs = tvs, 
Ian Lynagh's avatar
Ian Lynagh committed
770
                            sig_theta = theta, sig_loc = loc }) mono_id
771
      = Method {tci_id = mono_id, tci_oid = poly_id, tci_tys = mkTyVarTys tvs,
Ian Lynagh's avatar
Ian Lynagh committed
772
                tci_theta = theta, tci_loc = loc}
773
\end{code}
774

775
776
777
unifyCtxts checks that all the signature contexts are the same
The type signatures on a mutually-recursive group of definitions
must all have the same context (or none).
778

779
780
781
782
783
784
785
786
787
The trick here is that all the signatures should have the same
context, and we want to share type variables for that context, so that
all the right hand sides agree a common vocabulary for their type
constraints

We unify them because, with polymorphic recursion, their types
might not otherwise be related.  This is a rather subtle issue.

\begin{code}
788
unifyCtxts :: [TcSigInfo] -> TcM [Inst]
789
-- Post-condition: the returned Insts are full zonked
Ian Lynagh's avatar
Ian Lynagh committed
790
unifyCtxts [] = panic "unifyCtxts []"
Ian Lynagh's avatar
Ian Lynagh committed
791
792
793
794
unifyCtxts (sig1 : sigs)        -- Argument is always non-empty
  = do  { mapM unify_ctxt sigs
        ; theta <- zonkTcThetaType (sig_theta sig1)
        ; newDictBndrs (sig_loc sig1) theta }
795
796
797
798
  where
    theta1 = sig_theta sig1
    unify_ctxt :: TcSigInfo -> TcM ()
    unify_ctxt sig@(TcSigInfo { sig_theta = theta })
Ian Lynagh's avatar
Ian Lynagh committed
799
800
801
802
803
804
805
806
807
808
809
810
811
        = setSrcSpan (instLocSpan (sig_loc sig))        $
          addErrCtxt (sigContextsCtxt sig1 sig)         $
          do { cois <- unifyTheta theta1 theta
             ; -- Check whether all coercions are identity coercions
               -- That can happen if we have, say
               --         f :: C [a]   => ...
               --         g :: C (F a) => ...
               -- where F is a type function and (F a ~ [a])
               -- Then unification might succeed with a coercion.  But it's much
               -- much simpler to require that such signatures have identical contexts
               checkTc (all isIdentityCoercion cois)
                       (ptext (sLit "Mutually dependent functions have syntactically distinct contexts"))
             }
812

813
814
checkSigsTyVars :: [TcTyVar] -> [TcSigInfo] -> TcM [TcTyVar]
checkSigsTyVars qtvs sigs 
Ian Lynagh's avatar
Ian Lynagh committed
815
816
817
818
819
820
821
822
823
824
825
826
827
828
  = do  { gbl_tvs <- tcGetGlobalTyVars
        ; sig_tvs_s <- mapM (check_sig gbl_tvs) sigs

        ; let   -- Sigh.  Make sure that all the tyvars in the type sigs
                -- appear in the returned ty var list, which is what we are
                -- going to generalise over.  Reason: we occasionally get
                -- silly types like
                --      type T a = () -> ()
                --      f :: T a
                --      f () = ()
                -- Here, 'a' won't appear in qtvs, so we have to add it
                sig_tvs = foldl extendVarSetList emptyVarSet sig_tvs_s
                all_tvs = varSetElems (extendVarSetList sig_tvs qtvs)
        ; return all_tvs }
829
  where
830
    check_sig gbl_tvs (TcSigInfo {sig_id = id, sig_tvs = tvs, 
Ian Lynagh's avatar
Ian Lynagh committed
831
832
833
834
835
836
837
                                  sig_theta = theta, sig_tau = tau})
      = addErrCtxt (ptext (sLit "In the type signature for") <+> quotes (ppr id))       $
        addErrCtxtM (sigCtxt id tvs theta tau)                                          $
        do { tvs' <- checkDistinctTyVars tvs
           ; when (any (`elemVarSet` gbl_tvs) tvs')
                  (bleatEscapedTvs gbl_tvs tvs tvs')
           ; return tvs' }
838
839
840
841
842
843

checkDistinctTyVars :: [TcTyVar] -> TcM [TcTyVar]
-- (checkDistinctTyVars tvs) checks that the tvs from one type signature
-- are still all type variables, and all distinct from each other.  
-- It returns a zonked set of type variables.
-- For example, if the type sig is
Ian Lynagh's avatar
Ian Lynagh committed
844
--      f :: forall a b. a -> b -> b
845
-- we want to check that 'a' and 'b' haven't 
Ian Lynagh's avatar
Ian Lynagh committed
846
847
--      (a) been unified with a non-tyvar type
--      (b) been unified with each other (all distinct)
848
849

checkDistinctTyVars sig_tvs
Ian Lynagh's avatar
Ian Lynagh committed
850
851
852
  = do  { zonked_tvs <- mapM zonkSigTyVar sig_tvs
        ; foldlM check_dup emptyVarEnv (sig_tvs `zip` zonked_tvs)
        ; return zonked_tvs }
853
854
  where
    check_dup :: TyVarEnv TcTyVar -> (TcTyVar, TcTyVar) -> TcM (TyVarEnv TcTyVar)
Ian Lynagh's avatar
Ian Lynagh committed
855
856
        -- The TyVarEnv maps each zonked type variable back to its
        -- corresponding user-written signature type variable
857
    check_dup acc (sig_tv, zonked_tv)
Ian Lynagh's avatar
Ian Lynagh committed
858
859
        = case lookupVarEnv acc zonked_tv of
                Just sig_tv' -> bomb_out sig_tv sig_tv'
860

Ian Lynagh's avatar
Ian Lynagh committed
861
                Nothing -> return (extendVarEnv acc zonked_tv sig_tv)
862

863
    bomb_out sig_tv1 sig_tv2
864
       = do { env0 <- tcInitTidyEnv
Ian Lynagh's avatar
Ian Lynagh committed
865
866
867
868
869
870
            ; let (env1, tidy_tv1) = tidyOpenTyVar env0 sig_tv1
                  (env2, tidy_tv2) = tidyOpenTyVar env1 sig_tv2
                  msg = ptext (sLit "Quantified type variable") <+> quotes (ppr tidy_tv1) 
                         <+> ptext (sLit "is unified with another quantified type variable") 
                         <+> quotes (ppr tidy_tv2)
            ; failWithTcM (env2, msg) }
871
\end{code}
872

873

874
@getTyVarsToGen@ decides what type variables to generalise over.
875
876
877
878
879
880
881
882

For a "restricted group" -- see the monomorphism restriction
for a definition -- we bind no dictionaries, and
remove from tyvars_to_gen any constrained type variables

*Don't* simplify dicts at this point, because we aren't going
to generalise over these dicts.  By the time we do simplify them
we may well know more.  For example (this actually came up)
Ian Lynagh's avatar
Ian Lynagh committed
883
884
        f :: Array Int Int
        f x = array ... xs where xs = [1,2,3,4,5]
885
886
887
888
889
We don't want to generate lots of (fromInt Int 1), (fromInt Int 2)
stuff.  If we simplify only at the f-binding (not the xs-binding)
we'll know that the literals are all Ints, and we can just produce
Int literals!

890
891
892
893
Find all the type variables involved in overloading, the
"constrained_tyvars".  These are the ones we *aren't* going to
generalise.  We must be careful about doing this:

894
 (a) If we fail to generalise a tyvar which is not actually
Ian Lynagh's avatar
Ian Lynagh committed
895
896
897
898
899
900
901
        constrained, then it will never, ever get bound, and lands
        up printed out in interface files!  Notorious example:
                instance Eq a => Eq (Foo a b) where ..
        Here, b is not constrained, even though it looks as if it is.
        Another, more common, example is when there's a Method inst in
        the LIE, whose type might very well involve non-overloaded
        type variables.
902
  [NOTE: Jan 2001: I don't understand the problem here so I'm doing 
Ian Lynagh's avatar
Ian Lynagh committed
903
        the simple thing instead]
904

905
 (b) On the other hand, we mustn't generalise tyvars which are constrained,
Ian Lynagh's avatar
Ian Lynagh committed
906
907
        because we are going to pass on out the unmodified LIE, with those
        tyvars in it.  They won't be in scope if we've generalised them.
908
909
910
911
912

So we are careful, and do a complete simplification just to find the
constrained tyvars. We don't use any of the results, except to
find which tyvars are constrained.

913
914
915
Note [Polymorphic recursion]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The game plan for polymorphic recursion in the code above is 
916

Ian Lynagh's avatar
Ian Lynagh committed
917
918
919
        * Bind any variable for which we have a type signature
          to an Id with a polymorphic type.  Then when type-checking 
          the RHSs we'll make a full polymorphic call.
920

921
922
This fine, but if you aren't a bit careful you end up with a horrendous
amount of partial application and (worse) a huge space leak. For example:
923

Ian Lynagh's avatar
Ian Lynagh committed
924
925
        f :: Eq a => [a] -> [a]
        f xs = ...f...
926
927
928

If we don't take care, after typechecking we get

Ian Lynagh's avatar
Ian Lynagh committed
929
930
931
        f = /\a -> \d::Eq a -> let f' = f a d
                               in
                               \ys:[a] -> ...f'...
932
933
934
935
936
937
938

Notice the the stupid construction of (f a d), which is of course
identical to the function we're executing.  In this case, the
polymorphic recursion isn't being used (but that's a very common case).
This can lead to a massive space leak, from the following top-level defn
(post-typechecking)

Ian Lynagh's avatar
Ian Lynagh committed
939
940
        ff :: [Int] -> [Int]
        ff = f Int dEqInt
941
942
943
944
945

Now (f dEqInt) evaluates to a lambda that has f' as a free variable; but
f' is another thunk which evaluates to the same thing... and you end
up with a chain of identical values all hung onto by the CAF ff.

Ian Lynagh's avatar
Ian Lynagh committed
946
        ff = f Int dEqInt
947

Ian Lynagh's avatar
Ian Lynagh committed
948
           = let f' = f Int dEqInt in \ys. ...f'...
949

Ian Lynagh's avatar
Ian Lynagh committed
950
951
           = let f' = let f' = f Int dEqInt in \ys. ...f'...
                      in \ys. ...f'...
952
953

Etc.
954
955
956
957

NOTE: a bit of arity anaysis would push the (f a d) inside the (\ys...),
which would make the space leak go away in this case

958
959
960
961
962
963
Solution: when typechecking the RHSs we always have in hand the
*monomorphic* Ids for each binding.  So we just need to make sure that
if (Method f a d) shows up in the constraints emerging from (...f...)
we just use the monomorphic Id.  We achieve this by adding monomorphic Ids
to the "givens" when simplifying constraints.  That's what the "lies_avail"
is doing.
964

965
966
Then we get

Ian Lynagh's avatar
Ian Lynagh committed
967
968
969
970
        f = /\a -> \d::Eq a -> letrec
                                 fm = \ys:[a] -> ...fm...
                               in
                               fm
971
972


973
974

%************************************************************************
Ian Lynagh's avatar
Ian Lynagh committed
975
976
977
%*                                                                      *
                Signatures
%*                                                                      *
978
979
%************************************************************************

980
Type signatures are tricky.  See Note [Signature skolems] in TcType
981

982
983
984
985
986
987
988
989
990
@tcSigs@ checks the signatures for validity, and returns a list of
{\em freshly-instantiated} signatures.  That is, the types are already
split up, and have fresh type variables installed.  All non-type-signature
"RenamedSigs" are ignored.

The @TcSigInfo@ contains @TcTypes@ because they are unified with
the variable's type, and after that checked to see whether they've
been instantiated.

991
992
993
994
Note [Scoped tyvars]
~~~~~~~~~~~~~~~~~~~~
The -XScopedTypeVariables flag brings lexically-scoped type variables
into scope for any explicitly forall-quantified type variables:
Ian Lynagh's avatar
Ian Lynagh committed
995
996
        f :: forall a. a -> a
        f x = e
997
998
999
1000
Then 'a' is in scope inside 'e'.

However, we do *not* support this 
  - For pattern bindings e.g
For faster browsing, not all history is shown. View entire blame