TcBinds.hs 73.2 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2 3 4
{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998

5
\section[TcBinds]{TcBinds}
Austin Seipp's avatar
Austin Seipp committed
6
-}
7

8
{-# LANGUAGE CPP, RankNTypes, ScopedTypeVariables #-}
9
{-# LANGUAGE FlexibleContexts #-}
10

11
module TcBinds ( tcLocalBinds, tcTopBinds, tcRecSelBinds,
12 13
                 tcValBinds, tcHsBootSigs, tcPolyCheck,
                 tcVectDecls, addTypecheckedBinds,
14 15
                 chooseInferredQuantifiers,
                 badBootDeclErr ) where
16

17
import {-# SOURCE #-} TcMatches ( tcGRHSsPat, tcMatchesFun )
18
import {-# SOURCE #-} TcExpr  ( tcMonoExpr )
19
import {-# SOURCE #-} TcPatSyn ( tcInferPatSynDecl, tcCheckPatSynDecl
20
                               , tcPatSynBuilderBind )
21 22
import CoreSyn (Tickish (..))
import CostCentre (mkUserCC)
Simon Marlow's avatar
Simon Marlow committed
23
import DynFlags
24
import FastString
Simon Marlow's avatar
Simon Marlow committed
25
import HsSyn
26
import HscTypes( isHsBootOrSig )
27
import TcSigs
28
import TcRnMonad
Simon Marlow's avatar
Simon Marlow committed
29 30 31
import TcEnv
import TcUnify
import TcSimplify
32
import TcEvidence
Simon Marlow's avatar
Simon Marlow committed
33 34 35
import TcHsType
import TcPat
import TcMType
36
import Inst( deeplyInstantiate )
37 38
import FamInstEnv( normaliseType )
import FamInst( tcGetFamInstEnvs )
39
import TyCon
Simon Marlow's avatar
Simon Marlow committed
40
import TcType
41
import Type( mkStrLitTy, tidyOpenType, mkTyVarBinder )
Simon Marlow's avatar
Simon Marlow committed
42
import TysPrim
43
import TysWiredIn( cTupleTyConName )
Simon Marlow's avatar
Simon Marlow committed
44
import Id
45
import Var
46
import VarSet
47
import VarEnv( TidyEnv )
48
import Module
Simon Marlow's avatar
Simon Marlow committed
49
import Name
50
import NameSet
51
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
52
import SrcLoc
53
import Bag
54
import ListSetOps
Simon Marlow's avatar
Simon Marlow committed
55 56 57 58 59
import ErrUtils
import Digraph
import Maybes
import Util
import BasicTypes
60
import Outputable
61
import PrelNames( gHC_PRIM, ipClassName )
62
import TcValidity (checkValidType)
63
import Unique (getUnique)
niteria's avatar
niteria committed
64
import UniqFM
65
import qualified GHC.LanguageExtensions as LangExt
66 67

import Control.Monad
68 69

#include "HsVersions.h"
70

71 72 73 74 75 76 77 78
{- *********************************************************************
*                                                                      *
               A useful helper function
*                                                                      *
********************************************************************* -}

addTypecheckedBinds :: TcGblEnv -> [LHsBinds Id] -> TcGblEnv
addTypecheckedBinds tcg_env binds
79
  | isHsBootOrSig (tcg_src tcg_env) = tcg_env
80 81 82 83 84 85
    -- Do not add the code for record-selector bindings
    -- when compiling hs-boot files
  | otherwise = tcg_env { tcg_binds = foldr unionBags
                                            (tcg_binds tcg_env)
                                            binds }

Austin Seipp's avatar
Austin Seipp committed
86 87 88
{-
************************************************************************
*                                                                      *
89
\subsection{Type-checking bindings}
Austin Seipp's avatar
Austin Seipp committed
90 91
*                                                                      *
************************************************************************
92

93
@tcBindsAndThen@ typechecks a @HsBinds@.  The "and then" part is because
94 95 96 97 98 99 100 101 102 103
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".

104
The real work is done by @tcBindWithSigsAndThen@.
105 106 107 108 109 110 111 112 113 114

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.

115 116 117
At the top-level the LIE is sure to contain nothing but constant
dictionaries, which we resolve at the module level.

118 119
Note [Polymorphic recursion]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120
The game plan for polymorphic recursion in the code above is
121 122

        * Bind any variable for which we have a type signature
123
          to an Id with a polymorphic type.  Then when type-checking
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
          the RHSs we'll make a full polymorphic call.

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:

        f :: Eq a => [a] -> [a]
        f xs = ...f...

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

        f = /\a -> \d::Eq a -> let f' = f a d
                               in
                               \ys:[a] -> ...f'...

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)

        ff :: [Int] -> [Int]
        ff = f Int dEqInt

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.

        ff = f Int dEqInt

           = let f' = f Int dEqInt in \ys. ...f'...

           = let f' = let f' = f Int dEqInt in \ys. ...f'...
                      in \ys. ...f'...

Etc.

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

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.

Then we get

        f = /\a -> \d::Eq a -> letrec
                                 fm = \ys:[a] -> ...fm...
                               in
                               fm
Austin Seipp's avatar
Austin Seipp committed
176
-}
177

178
tcTopBinds :: [(RecFlag, LHsBinds Name)] -> [LSig Name] -> TcM (TcGblEnv, TcLclEnv)
179 180
-- The TcGblEnv contains the new tcg_binds and tcg_spects
-- The TcLclEnv has an extended type envt for the new bindings
181
tcTopBinds binds sigs
cactus's avatar
cactus committed
182 183 184 185 186
  = do  { -- Pattern synonym bindings populate the global environment
          (binds', (tcg_env, tcl_env)) <- tcValBinds TopLevel binds sigs $
            do { gbl <- getGblEnv
               ; lcl <- getLclEnv
               ; return (gbl, lcl) }
187 188
        ; specs <- tcImpPrags sigs   -- SPECIALISE prags for imported Ids

189 190
        ; let { tcg_env' = tcg_env { tcg_imp_specs = specs ++ tcg_imp_specs tcg_env }
                           `addTypecheckedBinds` map snd binds' }
191 192

        ; return (tcg_env', tcl_env) }
193
        -- The top level bindings are flattened into a giant
Ian Lynagh's avatar
Ian Lynagh committed
194
        -- implicitly-mutually-recursive LHsBinds
cactus's avatar
cactus committed
195

196 197
tcRecSelBinds :: HsValBinds Name -> TcM TcGblEnv
tcRecSelBinds (ValBindsOut binds sigs)
198
  = tcExtendGlobalValEnv [sel_id | L _ (IdSig sel_id) <- sigs] $
199 200 201
    do { (rec_sel_binds, tcg_env) <- discardWarnings $
                                     tcValBinds TopLevel binds sigs getGblEnv
       ; let tcg_env' = tcg_env `addTypecheckedBinds` map snd rec_sel_binds
202 203
       ; return tcg_env' }
tcRecSelBinds (ValBindsIn {}) = panic "tcRecSelBinds"
204

205
tcHsBootSigs :: [(RecFlag, LHsBinds Name)] -> [LSig Name] -> TcM [Id]
206 207
-- A hs-boot file has only one BindGroup, and it only has type
-- signatures in it.  The renamer checked all this
208
tcHsBootSigs binds sigs
Ian Lynagh's avatar
Ian Lynagh committed
209
  = do  { checkTc (null binds) badBootDeclErr
210
        ; concat <$> mapM (addLocM tc_boot_sig) (filter isTypeLSig sigs) }
211
  where
212
    tc_boot_sig (TypeSig lnames hs_ty) = mapM f lnames
213
      where
214
        f (L _ name)
215 216
          = do { sigma_ty <- solveEqualities $
                             tcHsSigWcType (FunSigCtxt name False) hs_ty
217
               ; return (mkVanillaGlobal name sigma_ty) }
Ian Lynagh's avatar
Ian Lynagh committed
218
        -- Notice that we make GlobalIds, not LocalIds
Ian Lynagh's avatar
Ian Lynagh committed
219
    tc_boot_sig s = pprPanic "tcHsBootSigs/tc_boot_sig" (ppr s)
220

221
badBootDeclErr :: MsgDoc
222
badBootDeclErr = text "Illegal declarations in an hs-boot file"
223

224 225
------------------------
tcLocalBinds :: HsLocalBinds Name -> TcM thing
Ian Lynagh's avatar
Ian Lynagh committed
226
             -> TcM (HsLocalBinds TcId, thing)
sof's avatar
sof committed
227

228
tcLocalBinds EmptyLocalBinds thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
229 230
  = do  { thing <- thing_inside
        ; return (EmptyLocalBinds, thing) }
sof's avatar
sof committed
231

232 233 234 235
tcLocalBinds (HsValBinds (ValBindsOut binds sigs)) thing_inside
  = do  { (binds', thing) <- tcValBinds NotTopLevel binds sigs thing_inside
        ; return (HsValBinds (ValBindsOut binds' sigs), thing) }
tcLocalBinds (HsValBinds (ValBindsIn {})) _ = panic "tcLocalBinds"
236

237
tcLocalBinds (HsIPBinds (IPBinds ip_binds _)) thing_inside
238 239
  = do  { ipClass <- tcLookupClass ipClassName
        ; (given_ips, ip_binds') <-
240
            mapAndUnzipM (wrapLocSndM (tc_ip_bind ipClass)) ip_binds
241

242
        -- If the binding binds ?x = E, we  must now
Ian Lynagh's avatar
Ian Lynagh committed
243
        -- discharge any ?x constraints in expr_lie
244
        -- See Note [Implicit parameter untouchables]
245
        ; (ev_binds, result) <- checkConstraints (IPSkol ips)
246
                                  [] given_ips thing_inside
247 248

        ; return (HsIPBinds (IPBinds ip_binds' ev_binds), result) }
249
  where
Alan Zimmerman's avatar
Alan Zimmerman committed
250
    ips = [ip | L _ (IPBind (Left (L _ ip)) _) <- ip_binds]
251

Ian Lynagh's avatar
Ian Lynagh committed
252 253 254
        -- I wonder if we should do these one at at time
        -- Consider     ?x = 4
        --              ?y = ?x + 1
Alan Zimmerman's avatar
Alan Zimmerman committed
255
    tc_ip_bind ipClass (IPBind (Left (L _ ip)) expr)
256
       = do { ty <- newOpenFlexiTyVarTy
257 258
            ; let p = mkStrLitTy $ hsIPNameFS ip
            ; ip_id <- newDict ipClass [ p, ty ]
259
            ; expr' <- tcMonoExpr expr (mkCheckExpType ty)
260 261 262 263 264 265
            ; let d = toDict ipClass p ty `fmap` expr'
            ; return (ip_id, (IPBind (Right ip_id) d)) }
    tc_ip_bind _ (IPBind (Right {}) _) = panic "tc_ip_bind"

    -- Coerces a `t` into a dictionry for `IP "x" t`.
    -- co : t -> IP "x" t
266
    toDict ipClass x ty = HsWrap $ mkWpCastR $
267
                          wrapIP $ mkClassPred ipClass [x,ty]
268

269 270
{- Note [Implicit parameter untouchables]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
271 272 273 274 275
We add the type variables in the types of the implicit parameters
as untouchables, not so much because we really must not unify them,
but rather because we otherwise end up with constraints like this
    Num alpha, Implic { wanted = alpha ~ Int }
The constraint solver solves alpha~Int by unification, but then
276
doesn't float that solved constraint out (it's not an unsolved
277
wanted).  Result disaster: the (Num alpha) is again solved, this
278 279
time by defaulting.  No no no.

280
However [Oct 10] this is all handled automatically by the
281
untouchable-range idea.
Austin Seipp's avatar
Austin Seipp committed
282
-}
283

284
tcValBinds :: TopLevelFlag
285 286
           -> [(RecFlag, LHsBinds Name)] -> [LSig Name]
           -> TcM thing
287
           -> TcM ([(RecFlag, LHsBinds TcId)], thing)
288

289
tcValBinds top_lvl binds sigs thing_inside
290 291 292 293
  = do  { let patsyns = getPatSynBinds binds

            -- Typecheck the signature
        ; (poly_ids, sig_fn) <- tcAddPatSynPlaceholders patsyns $
294
                                tcTySigs sigs
Ian Lynagh's avatar
Ian Lynagh committed
295

296 297
        ; let prag_fn = mkPragEnv sigs (foldr (unionBags . snd) emptyBag binds)

298 299 300 301 302
                -- Extend the envt right away with all the Ids
                -- declared with complete type signatures
                -- Do not extend the TcIdBinderStack; instead
                -- we extend it on a per-rhs basis in tcExtendForRhs
        ; tcExtendLetEnvIds top_lvl [(idName id, id) | id <- poly_ids] $ do
303 304
            { (binds', (extra_binds', thing)) <- tcBindGroups top_lvl sig_fn prag_fn binds $ do
                   { thing <- thing_inside
305
                     -- See Note [Pattern synonym builders don't yield dependencies]
306
                   ; patsyn_builders <- mapM tcPatSynBuilderBind patsyns
307
                   ; let extra_binds = [ (NonRecursive, builder) | builder <- patsyn_builders ]
308
                   ; return (extra_binds, thing) }
309
            ; return (binds' ++ extra_binds', thing) }}
310

311
------------------------
312
tcBindGroups :: TopLevelFlag -> TcSigFun -> TcPragEnv
Ian Lynagh's avatar
Ian Lynagh committed
313 314
             -> [(RecFlag, LHsBinds Name)] -> TcM thing
             -> TcM ([(RecFlag, LHsBinds TcId)], thing)
315 316
-- Typecheck a whole lot of value bindings,
-- one strongly-connected component at a time
317
-- Here a "strongly connected component" has the strightforward
318
-- meaning of a group of bindings that mention each other,
319
-- ignoring type signatures (that part comes later)
320

321
tcBindGroups _ _ _ [] thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
322 323
  = do  { thing <- thing_inside
        ; return ([], thing) }
324

325
tcBindGroups top_lvl sig_fn prag_fn (group : groups) thing_inside
326 327 328 329
  = do  { -- See Note [Closed binder groups]
          closed <- isClosedBndrGroup $ snd group
        ; (group', (groups', thing))
                <- tc_group top_lvl sig_fn prag_fn group closed $
330
                   tcBindGroups top_lvl sig_fn prag_fn groups thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
331
        ; return (group' ++ groups', thing) }
sof's avatar
sof committed
332

333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
-- Note [Closed binder groups]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
--  A mutually recursive group is "closed" if all of the free variables of
--  the bindings are closed. For example
--
-- >  h = \x -> let f = ...g...
-- >                g = ....f...x...
-- >             in ...
--
-- Here @g@ is not closed because it mentions @x@; and hence neither is @f@
-- closed.
--
-- So we need to compute closed-ness on each strongly connected components,
-- before we sub-divide it based on what type signatures it has.
--

350
------------------------
351
tc_group :: forall thing.
352
            TopLevelFlag -> TcSigFun -> TcPragEnv
353
         -> (RecFlag, LHsBinds Name) -> IsGroupClosed -> TcM thing
Ian Lynagh's avatar
Ian Lynagh committed
354
         -> TcM ([(RecFlag, LHsBinds TcId)], thing)
355 356

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

360
tc_group top_lvl sig_fn prag_fn (NonRecursive, binds) closed thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
361 362
        -- A single non-recursive binding
        -- We want to keep non-recursive things non-recursive
363
        -- so that we desugar unlifted bindings correctly
cactus's avatar
cactus committed
364 365
  = do { let bind = case bagToList binds of
                 [bind] -> bind
366 367
                 []     -> panic "tc_group: empty list of binds"
                 _      -> panic "tc_group: NonRecursive binds is not a singleton bag"
368 369
       ; (bind', thing) <- tc_single top_lvl sig_fn prag_fn bind closed
                                     thing_inside
cactus's avatar
cactus committed
370
       ; return ( [(NonRecursive, bind')], thing) }
371

372
tc_group top_lvl sig_fn prag_fn (Recursive, binds) closed thing_inside
373 374
  =     -- To maximise polymorphism, we do a new
        -- strongly-connected-component analysis, this time omitting
Ian Lynagh's avatar
Ian Lynagh committed
375
        -- any references to variables with type signatures.
376
        -- (This used to be optional, but isn't now.)
377
        -- See Note [Polymorphic recursion] in HsBinds.
378
    do  { traceTc "tc_group rec" (pprLHsBinds binds)
cactus's avatar
cactus committed
379
        ; when hasPatSyn $ recursivePatSynErr binds
380
        ; (binds1, thing) <- go sccs
381
        ; return ([(Recursive, binds1)], thing) }
Ian Lynagh's avatar
Ian Lynagh committed
382
                -- Rec them all together
383
  where
384
    hasPatSyn = anyBag (isPatSyn . unLoc) binds
cactus's avatar
cactus committed
385 386 387
    isPatSyn PatSynBind{} = True
    isPatSyn _ = False

388
    sccs :: [SCC (LHsBind Name)]
niteria's avatar
niteria committed
389
    sccs = stronglyConnCompFromEdgedVerticesUniq (mkEdges sig_fn binds)
390

391
    go :: [SCC (LHsBind Name)] -> TcM (LHsBinds TcId, thing)
392
    go (scc:sccs) = do  { (binds1, ids1) <- tc_scc scc
393 394
                        ; (binds2, thing) <- tcExtendLetEnv top_lvl closed ids1
                                                            (go sccs)
395 396
                        ; return (binds1 `unionBags` binds2, thing) }
    go []         = do  { thing <- thing_inside; return (emptyBag, thing) }
397

398 399
    tc_scc (AcyclicSCC bind) = tc_sub_group NonRecursive [bind]
    tc_scc (CyclicSCC binds) = tc_sub_group Recursive    binds
sof's avatar
sof committed
400

401 402
    tc_sub_group rec_tc binds =
      tcPolyBinds top_lvl sig_fn prag_fn Recursive rec_tc closed binds
sof's avatar
sof committed
403

cactus's avatar
cactus committed
404 405 406
recursivePatSynErr :: OutputableBndr name => LHsBinds name -> TcM a
recursivePatSynErr binds
  = failWithTc $
407
    hang (text "Recursive pattern synonym definition with following bindings:")
408
       2 (vcat $ map pprLBind . bagToList $ binds)
cactus's avatar
cactus committed
409
  where
410
    pprLoc loc  = parens (text "defined at" <+> ppr loc)
cactus's avatar
cactus committed
411 412 413 414
    pprLBind (L loc bind) = pprWithCommas ppr (collectHsBindBinders bind) <+>
                            pprLoc loc

tc_single :: forall thing.
415
            TopLevelFlag -> TcSigFun -> TcPragEnv
416
          -> LHsBind Name -> IsGroupClosed -> TcM thing
cactus's avatar
cactus committed
417
          -> TcM (LHsBinds TcId, thing)
418 419 420
tc_single _top_lvl sig_fn _prag_fn
          (L _ (PatSynBind psb@PSB{ psb_id = L _ name }))
          _ thing_inside
421 422
  = do { (aux_binds, tcg_env) <- tc_pat_syn_decl
       ; thing <- setGblEnv tcg_env thing_inside
cactus's avatar
cactus committed
423 424
       ; return (aux_binds, thing)
       }
425
  where
426
    tc_pat_syn_decl :: TcM (LHsBinds TcId, TcGblEnv)
427
    tc_pat_syn_decl = case sig_fn name of
428 429 430
        Nothing                 -> tcInferPatSynDecl psb
        Just (TcPatSynSig tpsi) -> tcCheckPatSynDecl psb tpsi
        Just                 _  -> panic "tc_single"
431

432
tc_single top_lvl sig_fn prag_fn lbind closed thing_inside
433 434
  = do { (binds1, ids) <- tcPolyBinds top_lvl sig_fn prag_fn
                                      NonRecursive NonRecursive
435
                                      closed
436
                                      [lbind]
437
       ; thing <- tcExtendLetEnv top_lvl closed ids thing_inside
cactus's avatar
cactus committed
438
       ; return (binds1, thing) }
439

440
------------------------
441
type BKey = Int -- Just number off the bindings
442

443 444
mkEdges :: TcSigFun -> LHsBinds Name -> [Node BKey (LHsBind Name)]
-- See Note [Polymorphic recursion] in HsBinds.
445
mkEdges sig_fn binds
niteria's avatar
niteria committed
446
  = [ (bind, key, [key | n <- nonDetEltsUFM (bind_fvs (unLoc bind)),
Ian Lynagh's avatar
Ian Lynagh committed
447
                         Just key <- [lookupNameEnv key_map n], no_sig n ])
448 449
    | (bind, key) <- keyd_binds
    ]
niteria's avatar
niteria committed
450 451 452
    -- It's OK to use nonDetEltsUFM here as stronglyConnCompFromEdgedVertices
    -- is still deterministic even if the edges are in nondeterministic order
    -- as explained in Note [Deterministic SCC] in Digraph.
453 454
  where
    no_sig :: Name -> Bool
thomasw's avatar
thomasw committed
455
    no_sig n = noCompleteSig (sig_fn n)
456 457 458

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

Ian Lynagh's avatar
Ian Lynagh committed
459
    key_map :: NameEnv BKey     -- Which binding it comes from
460
    key_map = mkNameEnv [(bndr, key) | (L _ bind, key) <- keyd_binds
461
                                     , bndr <- collectHsBindBinders bind ]
462

463
------------------------
464
tcPolyBinds :: TopLevelFlag -> TcSigFun -> TcPragEnv
465 466 467
            -> RecFlag         -- Whether the group is really recursive
            -> RecFlag         -- Whether it's recursive after breaking
                               -- dependencies based on type signatures
468
            -> IsGroupClosed   -- Whether the group is closed
469
            -> [LHsBind Name]  -- None are PatSynBind
470
            -> TcM (LHsBinds TcId, [TcId])
471

472
-- Typechecks a single bunch of values bindings all together,
473 474 475
-- and generalises them.  The bunch may be only part of a recursive
-- group, because we use type signatures to maximise polymorphism
--
476 477
-- Returns a list because the input may be a single non-recursive binding,
-- in which case the dependency order of the resulting bindings is
478 479
-- important.
--
480
-- Knows nothing about the scope of the bindings
481
-- None of the bindings are pattern synonyms
482

483
tcPolyBinds top_lvl sig_fn prag_fn rec_group rec_tc closed bind_list
484
  = setSrcSpan loc                              $
485
    recoverM (recoveryCode binder_names sig_fn) $ do
486
        -- Set up main recover; take advantage of any type sigs
487

488
    { traceTc "------------------------------------------------" Outputable.empty
489
    ; traceTc "Bindings for {" (ppr binder_names)
490
    ; dflags   <- getDynFlags
491
    ; let plan = decideGeneralisationPlan dflags bind_list closed sig_fn
492
    ; traceTc "Generalisation plan" (ppr plan)
493 494 495
    ; result@(tc_binds, poly_ids) <- case plan of
         NoGen              -> tcPolyNoGen rec_tc prag_fn sig_fn bind_list
         InferGen mn        -> tcPolyInfer rec_tc prag_fn sig_fn mn bind_list
496
         CheckGen lbind sig -> tcPolyCheck prag_fn sig lbind
497

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
498
        -- Check whether strict bindings are ok
Ian Lynagh's avatar
Ian Lynagh committed
499 500
        -- These must be non-recursive etc, and are not generalised
        -- They desugar to a case expression in the end
501 502 503 504
    ; checkStrictBinds top_lvl rec_group bind_list tc_binds poly_ids
    ; traceTc "} End of bindings for" (vcat [ ppr binder_names, ppr rec_group
                                            , vcat [ppr id <+> ppr (idType id) | id <- poly_ids]
                                          ])
505

506
    ; return result }
507
  where
508 509
    binder_names = collectHsBindListBinders bind_list
    loc = foldr1 combineSrcSpans (map getLoc bind_list)
510
         -- The mbinds have been dependency analysed and
511
         -- may no longer be adjacent; so find the narrowest
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
512
         -- span that includes them all
513

514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
--------------
-- If typechecking the binds fails, then return with each
-- signature-less binder given type (forall a.a), to minimise
-- subsequent error messages
recoveryCode :: [Name] -> TcSigFun -> TcM (LHsBinds TcId, [Id])
recoveryCode binder_names sig_fn
  = do  { traceTc "tcBindsWithSigs: error recovery" (ppr binder_names)
        ; let poly_ids = map mk_dummy binder_names
        ; return (emptyBag, poly_ids) }
  where
    mk_dummy name
      | Just sig <- sig_fn name
      , Just poly_id <- completeSigPolyId_maybe sig
      = poly_id
      | otherwise
      = mkLocalId name forall_a_a

forall_a_a :: TcType
forall_a_a = mkSpecForAllTys [runtimeRep1TyVar, openAlphaTyVar] openAlphaTy

{- *********************************************************************
*                                                                      *
                         tcPolyNoGen
*                                                                      *
********************************************************************* -}

540
tcPolyNoGen     -- No generalisation whatsoever
541
  :: RecFlag       -- Whether it's recursive after breaking
542
                   -- dependencies based on type signatures
543
  -> TcPragEnv -> TcSigFun
544
  -> [LHsBind Name]
545
  -> TcM (LHsBinds TcId, [TcId])
546

547 548
tcPolyNoGen rec_tc prag_fn tc_sig_fn bind_list
  = do { (binds', mono_infos) <- tcMonoBinds rec_tc tc_sig_fn
549
                                             (LetGblBndr prag_fn)
550
                                             bind_list
551
       ; mono_ids' <- mapM tc_mono_info mono_infos
552
       ; return (binds', mono_ids') }
553
  where
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
554
    tc_mono_info (MBI { mbi_poly_name = name, mbi_mono_id = mono_id })
555
      = do { mono_ty' <- zonkTcType (idType mono_id)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
556
             -- Zonk, mainly to expose unboxed types to checkStrictBinds
557
           ; let mono_id' = setIdType mono_id mono_ty'
558
           ; _specs <- tcSpecPrags mono_id' (lookupPragEnv prag_fn name)
559
           ; return mono_id' }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
560 561 562 563
           -- NB: tcPrags generates error messages for
           --     specialisation pragmas for non-overloaded sigs
           -- Indeed that is why we call it here!
           -- So we can safely ignore _specs
564

565 566 567 568 569 570 571 572 573 574

{- *********************************************************************
*                                                                      *
                         tcPolyCheck
*                                                                      *
********************************************************************* -}

tcPolyCheck :: TcPragEnv
            -> TcIdSigInfo     -- Must be a complete signature
            -> LHsBind Name    -- Must be a FunBind
575
            -> TcM (LHsBinds TcId, [TcId])
576
-- There is just one binding,
577
--   it is a Funbind
Simon Peyton Jones's avatar
Simon Peyton Jones committed
578
--   it has a complete type signature,
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
tcPolyCheck prag_fn
            (CompleteSig { sig_bndr  = poly_id
                         , sig_ctxt  = ctxt
                         , sig_loc   = sig_loc })
            (L loc (FunBind { fun_id = L nm_loc name
                            , fun_matches = matches }))
  = setSrcSpan sig_loc $
    do { traceTc "tcPolyCheck" (ppr poly_id $$ ppr sig_loc)
       ; (tv_prs, theta, tau) <- tcInstType (tcInstSigTyVars sig_loc) poly_id
                -- See Note [Instantiate sig with fresh variables]

       ; mono_name <- newNameAt (nameOccName name) nm_loc
       ; ev_vars   <- newEvVars theta
       ; let mono_id   = mkLocalId mono_name tau
             skol_info = SigSkol ctxt (mkPhiTy theta tau)
             skol_tvs  = map snd tv_prs

       ; (ev_binds, (co_fn, matches'))
            <- checkConstraints skol_info skol_tvs ev_vars $
               tcExtendIdBndrs [TcIdBndr mono_id NotTopLevel]  $
               tcExtendTyVarEnv2 tv_prs $
               setSrcSpan loc           $
               tcMatchesFun (L nm_loc mono_name) matches (mkCheckExpType tau)

       ; let prag_sigs = lookupPragEnv prag_fn name
604 605
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
606

607
       ; mod <- getModule
608 609 610 611
       ; let bind' = FunBind { fun_id      = L nm_loc mono_id
                             , fun_matches = matches'
                             , fun_co_fn   = co_fn
                             , bind_fvs    = placeHolderNamesTc
612
                             , fun_tick    = funBindTicks nm_loc mono_id mod prag_sigs }
613

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
614
             abs_bind = L loc $ AbsBindsSig
615 616 617 618
                        { abs_sig_export  = poly_id
                        , abs_tvs         = skol_tvs
                        , abs_ev_vars     = ev_vars
                        , abs_sig_prags   = SpecPrags spec_prags
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
619
                        , abs_sig_ev_bind = ev_binds
620
                        , abs_sig_bind    = L loc bind' }
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
621

622
       ; return (unitBag abs_bind, [poly_id]) }
623

624 625 626
tcPolyCheck _prag_fn sig bind
  = pprPanic "tcPolyCheck" (ppr sig $$ ppr bind)

627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
funBindTicks :: SrcSpan -> TcId -> Module -> [LSig Name] -> [Tickish TcId]
funBindTicks loc fun_id mod sigs
  | (mb_cc_str : _) <- [ cc_name | L _ (SCCFunSig _ _ cc_name) <- sigs ]
      -- this can only be a singleton list, as duplicate pragmas are rejected
      -- by the renamer
  , let cc_str
          | Just cc_str <- mb_cc_str
          = sl_fs cc_str
          | otherwise
          = getOccFS (Var.varName fun_id)
        cc_name = moduleNameFS (moduleName mod) `appendFS` consFS '.' cc_str
        cc = mkUserCC cc_name mod loc (getUnique fun_id)
  = [ProfNote cc True True]
  | otherwise
  = []

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
{- Note [Instantiate sig with fresh variables]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It's vital to instantiate a type signature with fresh variables.
For example:
      type T = forall a. [a] -> [a]
      f :: T;
      f = g where { g :: T; g = <rhs> }

 We must not use the same 'a' from the defn of T at both places!!
(Instantiation is only necessary because of type synonyms.  Otherwise,
it's all cool; each signature has distinct type variables from the renamer.)
-}


{- *********************************************************************
*                                                                      *
                         tcPolyInfer
*                                                                      *
********************************************************************* -}
662 663

tcPolyInfer
664
  :: RecFlag       -- Whether it's recursive after breaking
665
                   -- dependencies based on type signatures
666
  -> TcPragEnv -> TcSigFun
667
  -> Bool         -- True <=> apply the monomorphism restriction
668
  -> [LHsBind Name]
669 670
  -> TcM (LHsBinds TcId, [TcId])
tcPolyInfer rec_tc prag_fn tc_sig_fn mono bind_list
671
  = do { (tclvl, wanted, (binds', mono_infos))
672
             <- pushLevelAndCaptureConstraints  $
673 674
                tcMonoBinds rec_tc tc_sig_fn LetLclBndr bind_list

675 676 677 678
       ; let name_taus  = [ (mbi_poly_name info, idType (mbi_mono_id info))
                          | info <- mono_infos ]
             sigs       = [ sig | MBI { mbi_sig = Just sig } <- mono_infos ]
             infer_mode = if mono then ApplyMR else NoRestrictions
679

680 681
       ; mapM_ (checkOverloadedSig mono) sigs

682
       ; traceTc "simplifyInfer call" (ppr tclvl $$ ppr name_taus $$ ppr wanted)
683
       ; (qtvs, givens, ev_binds)
684
                 <- simplifyInfer tclvl infer_mode sigs name_taus wanted
685

686
       ; let inferred_theta = map evVarPred givens
687
       ; exports <- checkNoErrs $
688
                    mapM (mkExport prag_fn qtvs inferred_theta) mono_infos
thomasw's avatar
thomasw committed
689

690
       ; loc <- getSrcSpanM
691
       ; let poly_ids = map abe_poly exports
692
             abs_bind = L loc $
693
                        AbsBinds { abs_tvs = qtvs
694
                                 , abs_ev_vars = givens, abs_ev_binds = [ev_binds]
695
                                 , abs_exports = exports, abs_binds = binds' }
696

697 698
       ; traceTc "Binding:" (ppr (poly_ids `zip` map idType poly_ids))
       ; return (unitBag abs_bind, poly_ids) }
699
         -- poly_ids are guaranteed zonked by mkExport
700 701

--------------
702
mkExport :: TcPragEnv
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
703
         -> [TyVar] -> TcThetaType      -- Both already zonked
Ian Lynagh's avatar
Ian Lynagh committed
704
         -> MonoBindInfo
705
         -> TcM (ABExport Id)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
706
-- Only called for generalisation plan InferGen, not by CheckGen or NoGen
707 708 709
--
-- mkExport generates exports with
--      zonked type variables,
Ian Lynagh's avatar
Ian Lynagh committed
710
--      zonked poly_ids
711 712 713 714
-- 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
715
-- type environment; see the invariant on TcEnv.tcExtendIdEnv
716

717
-- Pre-condition: the qtvs and theta are already zonked
718

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
719 720 721 722
mkExport prag_fn qtvs theta
         mono_info@(MBI { mbi_poly_name = poly_name
                        , mbi_sig       = mb_sig
                        , mbi_mono_id   = mono_id })
723
  = do  { mono_ty <- zonkTcType (idType mono_id)
724
        ; poly_id <- mkInferredPolyId qtvs theta poly_name mb_sig mono_ty
725 726

        -- NB: poly_id has a zonked type
727
        ; poly_id <- addInlinePrags poly_id prag_sigs
728
        ; spec_prags <- tcSpecPrags poly_id prag_sigs
Ian Lynagh's avatar
Ian Lynagh committed
729
                -- tcPrags requires a zonked poly_id
730

731
        -- See Note [Impedence matching]
732 733
        -- NB: we have already done checkValidType, including an ambiguity check,
        --     on the type; either when we checked the sig or in mkInferredPolyId
734
        ; let poly_ty     = idType poly_id
735
              sel_poly_ty = mkInfSigmaTy qtvs theta mono_ty
736
                -- This type is just going into tcSubType,
737
                -- so Inferred vs. Specified doesn't matter
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
738 739

        ; wrap <- if sel_poly_ty `eqType` poly_ty  -- NB: eqType ignores visibility
740 741 742 743
                  then return idHsWrapper  -- Fast path; also avoids complaint when we infer
                                           -- an ambiguouse type and have AllowAmbiguousType
                                           -- e..g infer  x :: forall a. F a -> Int
                  else addErrCtxtM (mk_impedence_match_msg mono_info sel_poly_ty poly_ty) $
744
                       tcSubType_NC sig_ctxt sel_poly_ty (mkCheckExpType poly_ty)
745

manav's avatar
manav committed
746
        ; warn_missing_sigs <- woptM Opt_WarnMissingLocalSignatures
747 748
        ; when warn_missing_sigs $
              localSigWarn Opt_WarnMissingLocalSignatures poly_id mb_sig
749

750
        ; return (ABE { abe_wrap = wrap
751
                        -- abe_wrap :: idType poly_id ~ (forall qtvs. theta => mono_ty)
752 753
                      , abe_poly = poly_id
                      , abe_mono = mono_id
754
                      , abe_prags = SpecPrags spec_prags}) }
755
  where
756
    prag_sigs = lookupPragEnv prag_fn poly_name
757
    sig_ctxt  = InfSigCtxt poly_name
758

759
mkInferredPolyId :: [TyVar] -> TcThetaType
760
                 -> Name -> Maybe TcIdSigInst -> TcType
761
                 -> TcM TcId
762 763 764
mkInferredPolyId qtvs inferred_theta poly_name mb_sig_inst mono_ty
  | Just (TISI { sig_inst_sig = sig })  <- mb_sig_inst
  , CompleteSig { sig_bndr = poly_id } <- sig
765 766 767 768 769 770 771 772
  = return poly_id

  | otherwise  -- Either no type sig or partial type sig
  = checkNoErrs $  -- The checkNoErrs ensures that if the type is ambiguous
                   -- we don't carry on to the impedence matching, and generate
                   -- a duplicate ambiguity error.  There is a similar
                   -- checkNoErrs for complete type signatures too.
    do { fam_envs <- tcGetFamInstEnvs
773
       ; let (_co, mono_ty') = normaliseType fam_envs Nominal mono_ty
774 775
               -- Unification may not have normalised the type,
               -- (see Note [Lazy flattening] in TcFlatten) so do it
776 777 778
               -- here to make it as uncomplicated as possible.
               -- Example: f :: [F Int] -> Bool
               -- should be rewritten to f :: [Char] -> Bool, if possible
779
               --
Gabor Greif's avatar
Gabor Greif committed
780
               -- We can discard the coercion _co, because we'll reconstruct
781
               -- it in the call to tcSubType below
782

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
783
       ; (binders, theta') <- chooseInferredQuantifiers inferred_theta
784
                                (tyCoVarsOfType mono_ty') qtvs mb_sig_inst
785

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
786
       ; let inferred_poly_ty = mkForAllTys binders (mkPhiTy theta' mono_ty')
787

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
788
       ; traceTc "mkInferredPolyId" (vcat [ppr poly_name, ppr qtvs, ppr theta'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
789 790
                                          , ppr inferred_poly_ty])
       ; addErrCtxtM (mk_inf_msg poly_name inferred_poly_ty) $
791
         checkValidType (InfSigCtxt poly_name) inferred_poly_ty
792
         -- See Note [Validity of inferred types]
793

794
       ; return (mkLocalIdOrCoVar poly_name inferred_poly_ty) }
795

796

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
797 798 799
chooseInferredQuantifiers :: TcThetaType   -- inferred
                          -> TcTyVarSet    -- tvs free in tau type
                          -> [TcTyVar]     -- inferred quantified tvs
800
                          -> Maybe TcIdSigInst
801
                          -> TcM ([TyVarBinder], TcThetaType)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
802
chooseInferredQuantifiers inferred_theta tau_tvs qtvs Nothing
803
  = -- No type signature (partial or complete) for this binder,
804
    do { let free_tvs = closeOverKinds (growThetaTyVars inferred_theta tau_tvs)
805
                        -- Include kind variables!  Trac #7916
806
             my_theta = pickCapturedPreds free_tvs inferred_theta
807
             binders  = [ mkTyVarBinder Inferred tv
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
808 809 810
                        | tv <- qtvs
                        , tv `elemVarSet` free_tvs ]
       ; return (binders, my_theta) }
811

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
812
chooseInferredQuantifiers inferred_theta tau_tvs qtvs
813 814 815 816 817
                          (Just (TISI { sig_inst_sig   = sig  -- Always PartialSig
                                      , sig_inst_wcx   = wcx
                                      , sig_inst_theta = annotated_theta
                                      , sig_inst_skols = annotated_tvs }))
  | Nothing <- wcx
818 819
  = do { annotated_theta <- zonkTcTypes annotated_theta
       ; let free_tvs = closeOverKinds (tyCoVarsOfTypes annotated_theta
820
                                        `unionVarSet` tau_tvs)
821
       ; traceTc "ciq" (vcat [ ppr sig, ppr annotated_theta, ppr free_tvs])
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
822
       ; return (mk_binders free_tvs, annotated_theta) }
823

824
  | Just wc_var <- wcx
825 826
  = do { annotated_theta <- zonkTcTypes annotated_theta
       ; let free_tvs = closeOverKinds (tyCoVarsOfTypes annotated_theta
827
                                        `unionVarSet` tau_tvs)
828
             my_theta = pickCapturedPreds free_tvs inferred_theta
829 830 831 832

       -- Report the inferred constraints for an extra-constraints wildcard/hole as
       -- an error message, unless the PartialTypeSignatures flag is enabled. In this
       -- case, the extra inferred constraints are accepted without complaining.
833
       -- NB: inferred_theta already includes all the annotated constraints
834 835 836
             inferred_diff = [ pred
                             | pred <- my_theta
                             , all (not . (`eqType` pred)) annotated_theta ]
837 838
       ; ctuple <- mk_ctuple inferred_diff
       ; writeMetaTyVar wc_var ctuple
839
       ; traceTc "completeTheta" $
840
            vcat [ ppr sig
841 842
                 , ppr annotated_theta, ppr inferred_theta
                 , ppr inferred_diff ]
thomasw's avatar
thomasw committed
843

844
       ; return (mk_binders free_tvs, my_theta) }
845

846
  | otherwise  -- A complete type signature is dealt with in mkInferredPolyId
847
  = pprPanic "chooseInferredQuantifiers" (ppr sig)
848

thomasw's avatar
thomasw committed
849
  where
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
850 851
    spec_tv_set = mkVarSet $ map snd annotated_tvs
    mk_binders free_tvs
852
      = [ mkTyVarBinder vis tv
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
853 854 855
        | tv <- qtvs
        , tv `elemVarSet` free_tvs
        , let vis | tv `elemVarSet` spec_tv_set = Specified
856
                  | otherwise                   = Inferred ]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
857
                          -- Pulling from qtvs maintains original order
858

859 860 861 862
    mk_ctuple [pred] = return pred
    mk_ctuple preds  = do { tc <- tcLookupTyCon (cTupleTyConName (length preds))
                          ; return (mkTyConApp tc preds) }

863 864 865 866
mk_impedence_match_msg :: MonoBindInfo
                       -> TcType -> TcType
                       -> TidyEnv -> TcM (TidyEnv, SDoc)
-- This is a rare but rather awkward error messages
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
867 868
mk_impedence_match_msg (MBI { mbi_poly_name = name, mbi_sig = mb_sig })
                       inf_ty sig_ty tidy_env
869 870
 = do { (tidy_env1, inf_ty) <- zonkTidyTcType tidy_env  inf_ty
      ; (tidy_env2, sig_ty) <- zonkTidyTcType tidy_env1 sig_ty
871
      ; let msg = vcat [ text "When checking that the inferred type"
872
                       , nest 2 $ ppr name <+> dcolon <+> ppr inf_ty
873
                       , text "is as general as its" <+> what <+> text "signature"
874 875 876 877
                       , nest 2 $ ppr name <+> dcolon <+> ppr sig_ty ]
      ; return (tidy_env2, msg) }
  where
    what = case mb_sig of
878 879
             Nothing                     -> text "inferred"
             Just sig | isPartialSig sig -> text "(partial)"
880 881 882 883 884 885
                      | otherwise        -> empty


mk_inf_msg :: Name -> TcType -> TidyEnv -> TcM (TidyEnv, SDoc)
mk_inf_msg poly_name poly_ty tidy_env
 = do { (tidy_env1, poly_ty) <- zonkTidyTcType tidy_env poly_ty
886
      ; let msg = vcat [ text "When checking the inferred type"
887 888
                       , nest 2 $ ppr poly_name <+> dcolon <+> ppr poly_ty ]
      ; return (tidy_env1, msg) }
889

890 891

-- | Warn the user about polymorphic local binders that lack type signatures.
892
localSigWarn :: WarningFlag -> Id -> Maybe TcIdSigInst -> TcM ()
893
localSigWarn flag id mb_sig
894 895
  | Just _ <- mb_sig               = return ()
  | not