TcBinds.lhs 52 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
  = do  { checkTc (null binds) badBootDeclErr
101
        ; mapM (addLocM tc_boot_sig) (filter isTypeLSig sigs) }
102
  where
103
    tc_boot_sig (TypeSig (L _ name) ty)
104
      = do { sigma_ty <- tcHsSigType (FunSigCtxt name) ty
105
           ; return (mkVanillaGlobal name sigma_ty) }
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
  = do  {       -- Typecheck the signature
        ; let { prag_fn = mkPragFun sigs
154
              ; ty_sigs = filter isTypeLSig sigs
Ian Lynagh's avatar
Ian Lynagh committed
155 156
              ; 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
206 207 208 209 210
 =  do  { (binds1, lie_binds, thing) <- tc_haskell98 top_lvl sig_fn prag_fn 
    	  	   	      	     		     NonRecursive binds thing_inside
        ; return ( [(NonRecursive, unitBag b) | b <- bagToList binds1]
	  	     ++ [(Recursive, lie_binds)]  -- TcDictBinds have scrambled dependency order
		 , thing) }
211

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

218
  | otherwise           -- Recursive group, with -XRelaxedPolyRec
219
  =     -- To maximise polymorphism (with -XRelaxedPolyRec), we do a new 
Ian Lynagh's avatar
Ian Lynagh committed
220 221 222
        -- strongly-connected-component analysis, this time omitting 
        -- any references to variables with type signatures.
        --
223 224
        -- 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
225
    do  { traceTc (text "tc_group rec" <+> pprLHsBinds binds)
226
        ; (binds1,lie_binds,thing) <- bindLocalInsts top_lvl $
227
                            go (stronglyConnCompFromEdgedVertices (mkEdges sig_fn binds))
228
        ; return ([(Recursive, binds1 `unionBags` lie_binds)], thing) }
Ian Lynagh's avatar
Ian Lynagh committed
229
                -- Rec them all together
230
  where
231
--  go :: SCC (LHsBind Name) -> TcM (LHsBinds TcId, [TcId], thing)
Ian Lynagh's avatar
Ian Lynagh committed
232 233
    go (scc:sccs) = do  { (binds1, ids1) <- tc_scc scc
                        ; (binds2, ids2, thing) <- tcExtendIdEnv ids1 $ go sccs
234 235
                        ; return (binds1 `unionBags` binds2, ids1 ++ ids2, thing) }
    go []         = do  { thing <- thing_inside; return (emptyBag, [], thing) }
236

237 238
    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
239

240
    tc_sub_group = tcPolyBinds top_lvl sig_fn prag_fn Recursive
sof's avatar
sof committed
241

Ian Lynagh's avatar
Ian Lynagh committed
242
tc_haskell98 :: TopLevelFlag -> TcSigFun -> TcPragFun -> RecFlag
243
             -> LHsBinds Name -> TcM a -> TcM (LHsBinds TcId, TcDictBinds, a)
244
tc_haskell98 top_lvl sig_fn prag_fn rec_flag binds thing_inside
245 246 247 248
  = 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) }
249 250

------------------------
251 252 253
bindLocalInsts :: TopLevelFlag
	       -> TcM (LHsBinds TcId, [TcId],      a)
	       -> TcM (LHsBinds TcId, TcDictBinds, a)
254
bindLocalInsts top_lvl thing_inside
255 256
  | isTopLevel top_lvl
  = do { (binds, _, thing) <- thing_inside; return (binds, emptyBag, thing) }
Ian Lynagh's avatar
Ian Lynagh committed
257 258 259
        -- 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
260

Ian Lynagh's avatar
Ian Lynagh committed
261 262 263
  | otherwise   -- Nested case
  = do  { ((binds, ids, thing), lie) <- getLIE thing_inside
        ; lie_binds <- bindInstsOfLocalFuns lie ids
264
        ; return (binds, lie_binds, thing) }
265 266 267

------------------------
mkEdges :: TcSigFun -> LHsBinds Name
Ian Lynagh's avatar
Ian Lynagh committed
268
        -> [(LHsBind Name, BKey, [BKey])]
269 270 271 272

type BKey  = Int -- Just number off the bindings

mkEdges sig_fn binds
273
  = [ (bind, key, [key | n <- nameSetToList (bind_fvs (unLoc bind)),
Ian Lynagh's avatar
Ian Lynagh committed
274
                         Just key <- [lookupNameEnv key_map n], no_sig n ])
275 276 277 278 279 280 281 282
    | (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
283
    key_map :: NameEnv BKey     -- Which binding it comes from
284
    key_map = mkNameEnv [(bndr, key) | (L _ bind, key) <- keyd_binds
Ian Lynagh's avatar
Ian Lynagh committed
285
                                     , bndr <- bindersOfHsBind bind ]
286 287

bindersOfHsBind :: HsBind Name -> [Name]
288 289
bindersOfHsBind (PatBind { pat_lhs = pat })  = collectPatBinders pat
bindersOfHsBind (FunBind { fun_id = L _ f }) = [f]
Ian Lynagh's avatar
Ian Lynagh committed
290 291
bindersOfHsBind (AbsBinds {})                = panic "bindersOfHsBind AbsBinds"
bindersOfHsBind (VarBind {})                 = panic "bindersOfHsBind VarBind"
292

293
------------------------
294
tcPolyBinds :: TopLevelFlag -> TcSigFun -> TcPragFun
Ian Lynagh's avatar
Ian Lynagh committed
295 296 297 298
            -> RecFlag                  -- Whether the group is really recursive
            -> RecFlag                  -- Whether it's recursive after breaking
                                        -- dependencies based on type signatures
            -> LHsBinds Name
299
            -> TcM (LHsBinds TcId, [TcId])
300 301 302 303 304

-- 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
--
305 306 307
-- 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.  
308
-- 
309 310
-- Knows nothing about the scope of the bindings

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

Ian Lynagh's avatar
Ian Lynagh committed
323 324
  { traceTc (ptext (sLit "------------------------------------------------"))
  ; traceTc (ptext (sLit "Bindings for") <+> ppr binder_names)
325

Ian Lynagh's avatar
Ian Lynagh committed
326
        -- TYPECHECK THE BINDINGS
327
  ; ((binds', mono_bind_infos), lie_req) 
Ian Lynagh's avatar
Ian Lynagh committed
328
        <- getLIE (tcMonoBinds bind_list sig_fn rec_tc)
329
  ; traceTc (text "temp" <+> (ppr binds' $$ ppr lie_req))
330

Ian Lynagh's avatar
Ian Lynagh committed
331 332 333
        -- CHECK FOR UNLIFTED BINDINGS
        -- These must be non-recursive etc, and are not generalised
        -- They desugar to a case expression in the end
334
  ; zonked_mono_tys <- zonkTcTypes (map getMonoType mono_bind_infos)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
335
  ; is_strict <- checkStrictBinds top_lvl rec_group binds' 
Ian Lynagh's avatar
Ian Lynagh committed
336
                                  zonked_mono_tys mono_bind_infos
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
337
  ; if is_strict then
Ian Lynagh's avatar
Ian Lynagh committed
338 339 340
    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
341
              mk_export (_,    Just sig, mono_id) _       = ([], sig_id sig,             mono_id, [])
Ian Lynagh's avatar
Ian Lynagh committed
342
                        -- ToDo: prags for unlifted bindings
343

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

Ian Lynagh's avatar
Ian Lynagh committed
347
    else do     -- The normal lifted case: GENERALISE
348
  { dflags <- getDOpts 
349
  ; (tyvars_to_gen, dicts, dict_binds)
Ian Lynagh's avatar
Ian Lynagh committed
350 351
        <- addErrCtxt (genCtxt (bndrNames mono_bind_infos)) $
           generalise dflags top_lvl bind_list sig_fn mono_bind_infos lie_req
352

Ian Lynagh's avatar
Ian Lynagh committed
353 354
        -- BUILD THE POLYMORPHIC RESULT IDs
  ; let dict_vars = map instToVar dicts -- May include equality constraints
Simon Marlow's avatar
Simon Marlow committed
355
  ; exports <- mapM (mkExport top_lvl prag_fn tyvars_to_gen (map varType dict_vars))
Ian Lynagh's avatar
Ian Lynagh committed
356
                    mono_bind_infos
sof's avatar
sof committed
357

Ian Lynagh's avatar
Ian Lynagh committed
358
  ; let poly_ids = [poly_id | (_, poly_id, _, _) <- exports]
359
  ; traceTc (text "binding:" <+> ppr (poly_ids `zip` map idType poly_ids))
360

361
  ; let abs_bind = L loc $ AbsBinds tyvars_to_gen
Ian Lynagh's avatar
Ian Lynagh committed
362 363
                                    dict_vars exports
                                    (dict_binds `unionBags` binds')
364

365
  ; return (unitBag abs_bind, poly_ids)       -- poly_ids are guaranteed zonked by mkExport
366 367 368 369
  } }


--------------
Simon Marlow's avatar
Simon Marlow committed
370
mkExport :: TopLevelFlag -> TcPragFun -> [TyVar] -> [TcType]
Ian Lynagh's avatar
Ian Lynagh committed
371 372
         -> MonoBindInfo
         -> TcM ([TyVar], Id, Id, [LPrag])
373
-- mkExport generates exports with 
Ian Lynagh's avatar
Ian Lynagh committed
374 375
--      zonked type variables, 
--      zonked poly_ids
376 377 378 379 380 381 382 383
-- 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

Simon Marlow's avatar
Simon Marlow committed
384
mkExport top_lvl prag_fn inferred_tvs dict_tys (poly_name, mb_sig, mono_id)
Ian Lynagh's avatar
Ian Lynagh committed
385 386 387 388
  = 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
389

Simon Marlow's avatar
Simon Marlow committed
390
        ; prags <- tcPrags poly_id (prag_fn poly_name)
Ian Lynagh's avatar
Ian Lynagh committed
391
                -- tcPrags requires a zonked poly_id
392

Ian Lynagh's avatar
Ian Lynagh committed
393
        ; return (tvs, poly_id, mono_id, prags) }
394 395 396
  where
    poly_ty = mkForAllTys inferred_tvs (mkFunTys dict_tys (idType mono_id))

397
    mk_poly_id warn Nothing    = do { poly_ty' <- zonkTcType poly_ty
Ian Lynagh's avatar
Ian Lynagh committed
398 399
                                    ; missingSigWarn warn poly_name poly_ty'
                                    ; return (inferred_tvs, mkLocalId poly_name poly_ty') }
Ian Lynagh's avatar
Ian Lynagh committed
400
    mk_poly_id _    (Just sig) = do { tvs <- mapM zonk_tv (sig_tvs sig)
Ian Lynagh's avatar
Ian Lynagh committed
401
                                    ; return (tvs,  sig_id sig) }
402

403
    zonk_tv tv = do { ty <- zonkTcTyVar tv; return (tcGetTyVar "mkExport" ty) }
404 405 406 407 408 409

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

mkPragFun :: [LSig Name] -> TcPragFun
mkPragFun sigs = \n -> lookupNameEnv env n `orElse` []
Ian Lynagh's avatar
Ian Lynagh committed
410 411 412 413 414
        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
415

Simon Marlow's avatar
Simon Marlow committed
416 417
tcPrags :: Id -> [LSig Name] -> TcM [LPrag]
tcPrags poly_id prags = mapM (wrapLocM tc_prag) prags
418
  where
Simon Marlow's avatar
Simon Marlow committed
419 420
    tc_prag prag = addErrCtxt (pragSigCtxt prag) $ 
                   tcPrag poly_id prag
421

Ian Lynagh's avatar
Ian Lynagh committed
422
pragSigCtxt :: Sig Name -> SDoc
Ian Lynagh's avatar
Ian Lynagh committed
423
pragSigCtxt prag = hang (ptext (sLit "In the pragma")) 2 (ppr prag)
424

Simon Marlow's avatar
Simon Marlow committed
425 426 427 428 429 430
tcPrag :: TcId -> Sig Name -> TcM Prag
-- Pre-condition: the poly_id is zonked
-- Reason: required by tcSubExp
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)
431
tcPrag _       sig	             = pprPanic "tcPrag" (ppr sig)
Simon Marlow's avatar
Simon Marlow committed
432

433

434 435
tcSpecPrag :: TcId -> LHsType Name -> InlineSpec -> TcM Prag
tcSpecPrag poly_id hs_ty inl
Ian Lynagh's avatar
Ian Lynagh committed
436 437 438 439 440 441
  = 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
442 443
  
--------------
444 445 446
-- 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
447
recoveryCode :: [Name] -> (Name -> Maybe [Name])
448
             -> TcM (LHsBinds TcId, [Id])
449
recoveryCode binder_names sig_fn
Ian Lynagh's avatar
Ian Lynagh committed
450 451
  = do  { traceTc (text "tcBindsWithSigs: error recovery" <+> ppr binder_names)
        ; poly_ids <- mapM mk_dummy binder_names
452
        ; return (emptyBag, poly_ids) }
453
  where
454
    mk_dummy name 
Ian Lynagh's avatar
Ian Lynagh committed
455 456
        | isJust (sig_fn name) = tcLookupId name        -- Had signature; look it up
        | otherwise            = return (mkLocalId name forall_a_a)    -- No signature
457 458 459 460

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

461

462
-- Check that non-overloaded unlifted bindings are
Ian Lynagh's avatar
Ian Lynagh committed
463 464 465
--      a) non-recursive,
--      b) not top level, 
--      c) not a multiple-binding group (more or less implied by (a))
466

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
467
checkStrictBinds :: TopLevelFlag -> RecFlag
Ian Lynagh's avatar
Ian Lynagh committed
468 469
                 -> LHsBinds TcId -> [TcType] -> [MonoBindInfo]
                 -> TcM Bool
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
470 471
checkStrictBinds top_lvl rec_group mbind mono_tys infos
  | unlifted || bang_pat
Ian Lynagh's avatar
Ian Lynagh committed
472 473 474 475 476 477 478 479
  = 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
480 481
  | otherwise
  = return False
482
  where
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
483 484
    unlifted = any isUnLiftedType mono_tys
    bang_pat = anyBag (isBangHsBind . unLoc) mbind
485
    check_sig (_, Just sig, _) = checkTc (null (sig_tvs sig) && null (sig_theta sig))
Ian Lynagh's avatar
Ian Lynagh committed
486
                                         (badStrictSig unlifted sig)
Ian Lynagh's avatar
Ian Lynagh committed
487
    check_sig _                = return ()
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
488

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

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

506

507
%************************************************************************
Ian Lynagh's avatar
Ian Lynagh committed
508
%*                                                                      *
509
\subsection{tcMonoBind}
Ian Lynagh's avatar
Ian Lynagh committed
510
%*                                                                      *
511 512
%************************************************************************

513
@tcMonoBinds@ deals with a perhaps-recursive group of HsBinds.
514 515
The signatures have been dealt with already.

516
\begin{code}
517
tcMonoBinds :: [LHsBind Name]
Ian Lynagh's avatar
Ian Lynagh committed
518 519 520 521 522
            -> 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])
523

524
tcMonoBinds [L b_loc (FunBind { fun_id = L nm_loc name, fun_infix = inf, 
Ian Lynagh's avatar
Ian Lynagh committed
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
                                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)]) }
552

553
tcMonoBinds [L b_loc (FunBind { fun_id = L nm_loc name, fun_infix = inf, 
Ian Lynagh's avatar
Ian Lynagh committed
554
                                fun_matches = matches })]
Ian Lynagh's avatar
Ian Lynagh committed
555
            sig_fn              -- Single function binding
Ian Lynagh's avatar
Ian Lynagh committed
556
            _
Ian Lynagh's avatar
Ian Lynagh committed
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
  | 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.

572
	; traceTc (text "tcMoonBinds" <+> ppr scoped_tvs $$ ppr tc_sig)
Ian Lynagh's avatar
Ian Lynagh committed
573 574
        ; (co_fn, matches') <- tcExtendTyVarEnv2 rhs_tvs $
                               tcMatchesFun mono_name inf matches mono_ty
575 576 577 578 579
	     -- 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
580 581 582 583 584 585 586

        ; 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)]) }
587

Ian Lynagh's avatar
Ian Lynagh committed
588
tcMonoBinds binds sig_fn _
Ian Lynagh's avatar
Ian Lynagh committed
589
  = do  { tc_binds <- mapM (wrapLocM (tcLhs sig_fn)) binds
590

Ian Lynagh's avatar
Ian Lynagh committed
591 592 593 594 595
        -- 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.)
596

Ian Lynagh's avatar
Ian Lynagh committed
597 598 599 600 601
        ; 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) }
602 603 604 605

------------------------
-- 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
606 607
--      if there's a signature for it, use the instantiated signature type
--      otherwise invent a type variable
608 609 610
-- You see that quite directly in the FunBind case.
-- 
-- But there's a complication for pattern bindings:
Ian Lynagh's avatar
Ian Lynagh committed
611 612
--      data T = MkT (forall a. a->a)
--      MkT f = e
613 614 615 616 617 618
-- 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
619
data TcMonoBind         -- Half completed; LHS done, RHS not done
620 621 622
  = TcFunBind  MonoBindInfo  (Located TcId) Bool (MatchGroup Name) 
  | TcPatBind [MonoBindInfo] (LPat TcId) (GRHSs Name) TcSigmaType

623
type MonoBindInfo = (Name, Maybe TcSigInfo, TcId)
Ian Lynagh's avatar
Ian Lynagh committed
624 625
        -- Type signature (if any), and
        -- the monomorphic bound things
626 627 628 629 630 631 632

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

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

633
tcLhs :: TcSigFun -> HsBind Name -> TcM TcMonoBind
634
tcLhs sig_fn (FunBind { fun_id = L nm_loc name, fun_infix = inf, fun_matches = matches })
Ian Lynagh's avatar
Ian Lynagh committed
635 636 637 638 639
  = 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) }
640 641
  where
    mk_mono_ty (Just sig) = return (sig_tau sig)
642 643
    mk_mono_ty Nothing    = newFlexiTyVarTy argTypeKind

Ian Lynagh's avatar
Ian Lynagh committed
644
tcLhs sig_fn (PatBind { pat_lhs = pat, pat_rhs = grhss })
Ian Lynagh's avatar
Ian Lynagh committed
645 646
  = do  { mb_sigs <- mapM (tcInstSig_maybe sig_fn) names
        ; mono_pat_binds <- doptM Opt_MonoPatBinds
647
                -- With -XMonoPatBinds, we do no generalisation of pattern bindings
Ian Lynagh's avatar
Ian Lynagh committed
648 649 650 651 652
                -- 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
653 654
                -- should have exactly the type in the type signature (-XMonoPatBinds), 
                -- or the instantiated version (-XMonoPatBinds)
Ian Lynagh's avatar
Ian Lynagh committed
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675

        ; 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) }
676 677 678 679
  where
    names = collectPatBinders pat


Ian Lynagh's avatar
Ian Lynagh committed
680
tcLhs _ other_bind = pprPanic "tcLhs" (ppr other_bind)
Ian Lynagh's avatar
Ian Lynagh committed
681
        -- AbsBind, VarBind impossible
682

683 684
-------------------
tcRhs :: TcMonoBind -> TcM (HsBind TcId)
685 686 687 688 689
-- 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
690 691 692 693 694
  = 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 }) }
695

Ian Lynagh's avatar
Ian Lynagh committed
696
tcRhs (TcPatBind _ pat' grhss pat_ty)
Ian Lynagh's avatar
Ian Lynagh committed
697 698 699 700
  = 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 }) }
701 702 703


---------------------
704
getMonoBindInfo :: [Located TcMonoBind] -> [MonoBindInfo]
705
getMonoBindInfo tc_binds
706
  = foldr (get_info . unLoc) [] tc_binds
707 708 709 710 711 712 713
  where
    get_info (TcFunBind info _ _ _)  rest = info : rest
    get_info (TcPatBind infos _ _ _) rest = infos ++ rest
\end{code}


%************************************************************************
Ian Lynagh's avatar
Ian Lynagh committed
714 715 716
%*                                                                      *
                Generalisation
%*                                                                      *
717 718 719
%************************************************************************

\begin{code}
720
generalise :: DynFlags -> TopLevelFlag 
Ian Lynagh's avatar
Ian Lynagh committed
721 722 723
           -> [LHsBind Name] -> TcSigFun 
           -> [MonoBindInfo] -> [Inst]
           -> TcM ([TyVar], [Inst], TcDictBinds)
724 725
-- The returned [TyVar] are all ready to quantify

726 727
generalise dflags top_lvl bind_list sig_fn mono_infos lie_req
  | isMonoGroup dflags bind_list
Ian Lynagh's avatar
Ian Lynagh committed
728 729
  = do  { extendLIEs lie_req
        ; return ([], [], emptyBag) }
730

Ian Lynagh's avatar
Ian Lynagh committed
731 732 733 734
  | isRestrictedGroup dflags bind_list sig_fn   -- RESTRICTED CASE
  =     -- Check signature contexts are empty 
    do  { checkTc (all is_mono_sig sigs)
                  (restrictedBindCtxtErr bndrs)
735

Ian Lynagh's avatar
Ian Lynagh committed
736 737 738 739
        -- 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
740

Ian Lynagh's avatar
Ian Lynagh committed
741 742
        -- Check that signature type variables are OK
        ; final_qtvs <- checkSigsTyVars qtvs sigs
743

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

Ian Lynagh's avatar
Ian Lynagh committed
746
  | null sigs   -- UNRESTRICTED CASE, NO TYPE SIGS
747 748
  = tcSimplifyInfer doc tau_tvs lie_req

Ian Lynagh's avatar
Ian Lynagh committed
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
  | 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) }
766
  where
767 768
    bndrs   = bndrNames mono_infos
    sigs    = [sig | (_, Just sig, _) <- mono_infos]
Ian Lynagh's avatar
Ian Lynagh committed
769 770
    get_tvs | isTopLevel top_lvl = tyVarsOfType  -- See Note [Silly type synonym] in TcType
            | otherwise          = exactTyVarsOfType
771
    tau_tvs = foldr (unionVarSet . get_tvs . getMonoType) emptyVarSet mono_infos
772
    is_mono_sig sig = null (sig_theta sig)
Ian Lynagh's avatar
Ian Lynagh committed
773
    doc = ptext (sLit "type signature(s) for") <+> pprBinders bndrs
774

775
    mkMethInst (TcSigInfo { sig_id = poly_id, sig_tvs = tvs, 
Ian Lynagh's avatar
Ian Lynagh committed
776
                            sig_theta = theta, sig_loc = loc }) mono_id
777
      = Method {tci_id = mono_id, tci_oid = poly_id, tci_tys = mkTyVarTys tvs,
Ian Lynagh's avatar
Ian Lynagh committed
778
                tci_theta = theta, tci_loc = loc}
779
\end{code}
780

781 782 783
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).
784

785 786 787 788 789 790 791 792 793
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}
794
unifyCtxts :: [TcSigInfo] -> TcM [Inst]
795
-- Post-condition: the returned Insts are full zonked
Ian Lynagh's avatar
Ian Lynagh committed
796
unifyCtxts [] = panic "unifyCtxts []"
Ian Lynagh's avatar
Ian Lynagh committed
797 798 799 800
unifyCtxts (sig1 : sigs)        -- Argument is always non-empty
  = do  { mapM unify_ctxt sigs
        ; theta <- zonkTcThetaType (sig_theta sig1)
        ; newDictBndrs (sig_loc sig1) theta }
801 802 803 804
  where
    theta1 = sig_theta sig1
    unify_ctxt :: TcSigInfo -> TcM ()
    unify_ctxt sig@(TcSigInfo { sig_theta = theta })
Ian Lynagh's avatar
Ian Lynagh committed
805 806 807 808 809 810 811 812 813 814
        = 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
815
               checkTc (all isIdentityCoI cois)
Ian Lynagh's avatar
Ian Lynagh committed
816 817
                       (ptext (sLit "Mutually dependent functions have syntactically distinct contexts"))
             }
818

819 820
checkSigsTyVars :: [TcTyVar] -> [TcSigInfo] -> TcM [TcTyVar]
checkSigsTyVars qtvs sigs 
Ian Lynagh's avatar
Ian Lynagh committed
821 822 823 824 825 826 827 828 829 830 831 832 833 834
  = 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 }
835
  where
836
    check_sig gbl_tvs (TcSigInfo {sig_id = id, sig_tvs = tvs, 
Ian Lynagh's avatar
Ian Lynagh committed
837 838 839 840 841 842 843
                                  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' }
844 845 846 847 848 849

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
850
--      f :: forall a b. a -> b -> b
851
-- we want to check that 'a' and 'b' haven't 
Ian Lynagh's avatar
Ian Lynagh committed
852 853
--      (a) been unified with a non-tyvar type
--      (b) been unified with each other (all distinct)
854 855

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

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

869
    bomb_out sig_tv1 sig_tv2
870
       = do { env0 <- tcInitTidyEnv
Ian Lynagh's avatar
Ian Lynagh committed
871 872 873 874 875 876
            ; 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) }
SamB's avatar
SamB committed
877
\end{code}
878

879

880
@getTyVarsToGen@ decides what type variables to generalise over.
881 882 883 884 885 886 887 888

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
889 890
        f :: Array Int Int
        f x = array ... xs where xs = [1,2,3,4,5]
891 892 893 894 895
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!

896 897 898 899
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:

900
 (a) If we fail to generalise a tyvar which is not actually
Ian Lynagh's avatar
Ian Lynagh committed
901 902 903 904 905 906 907
        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.
908
  [NOTE: Jan 2001: I don't understand the problem here so I'm doing 
Ian Lynagh's avatar
Ian Lynagh committed
909
        the simple thing instead]
910

911
 (b) On the other hand, we mustn't generalise tyvars which are constrained,
Ian Lynagh's avatar
Ian Lynagh committed
912 913
        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.
914 915 916 917 918

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.

919 920 921
Note [Polymorphic recursion]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The game plan for polymorphic recursion in the code above is 
922

Ian Lynagh's avatar
Ian Lynagh committed
923 924 925
        * 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.
926

927 928
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:
929