TcBinds.hs 71 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 37
import FamInstEnv( normaliseType )
import FamInst( tcGetFamInstEnvs )
38
import TyCon
Simon Marlow's avatar
Simon Marlow committed
39
import TcType
40
import Type( mkStrLitTy, tidyOpenType, mkTyVarBinder )
Simon Marlow's avatar
Simon Marlow committed
41
import TysPrim
42
import TysWiredIn( cTupleTyConName )
Simon Marlow's avatar
Simon Marlow committed
43
import Id
44
import Var
45
import VarSet
46
import VarEnv( TidyEnv )
47
import Module
Simon Marlow's avatar
Simon Marlow committed
48
import Name
49
import NameSet
50
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
51
import SrcLoc
52
import Bag
53
import ListSetOps
Simon Marlow's avatar
Simon Marlow committed
54 55 56 57 58
import ErrUtils
import Digraph
import Maybes
import Util
import BasicTypes
59
import Outputable
60
import PrelNames( gHC_PRIM, ipClassName )
61
import TcValidity (checkValidType)
62
import Unique (getUnique)
niteria's avatar
niteria committed
63
import UniqFM
64
import qualified GHC.LanguageExtensions as LangExt
65 66

import Control.Monad
67 68

#include "HsVersions.h"
69

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

addTypecheckedBinds :: TcGblEnv -> [LHsBinds Id] -> TcGblEnv
addTypecheckedBinds tcg_env binds
78
  | isHsBootOrSig (tcg_src tcg_env) = tcg_env
79 80 81 82 83 84
    -- 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
85 86 87
{-
************************************************************************
*                                                                      *
88
\subsection{Type-checking bindings}
Austin Seipp's avatar
Austin Seipp committed
89 90
*                                                                      *
************************************************************************
91

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

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

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.

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

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

        * Bind any variable for which we have a type signature
122
          to an Id with a polymorphic type.  Then when type-checking
123 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
          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
175
-}
176

177
tcTopBinds :: [(RecFlag, LHsBinds Name)] -> [LSig Name] -> TcM (TcGblEnv, TcLclEnv)
178 179
-- The TcGblEnv contains the new tcg_binds and tcg_spects
-- The TcLclEnv has an extended type envt for the new bindings
180
tcTopBinds binds sigs
cactus's avatar
cactus committed
181 182 183 184 185
  = 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) }
186 187
        ; specs <- tcImpPrags sigs   -- SPECIALISE prags for imported Ids

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

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

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

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

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

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

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

231 232 233 234
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"
235

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
251 252 253
        -- I wonder if we should do these one at at time
        -- Consider     ?x = 4
        --              ?y = ?x + 1
Alan Zimmerman's avatar
Alan Zimmerman committed
254
    tc_ip_bind ipClass (IPBind (Left (L _ ip)) expr)
255
       = do { ty <- newOpenFlexiTyVarTy
256 257
            ; let p = mkStrLitTy $ hsIPNameFS ip
            ; ip_id <- newDict ipClass [ p, ty ]
258
            ; expr' <- tcMonoExpr expr (mkCheckExpType ty)
259 260 261 262 263 264
            ; 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
265
    toDict ipClass x ty = HsWrap $ mkWpCastR $
266
                          wrapIP $ mkClassPred ipClass [x,ty]
267

268 269
{- Note [Implicit parameter untouchables]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
270 271 272 273 274
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
275
doesn't float that solved constraint out (it's not an unsolved
276
wanted).  Result disaster: the (Num alpha) is again solved, this
277 278
time by defaulting.  No no no.

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

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

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

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

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

297 298 299 300 301
                -- 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
302 303
            { (binds', (extra_binds', thing)) <- tcBindGroups top_lvl sig_fn prag_fn binds $ do
                   { thing <- thing_inside
304
                     -- See Note [Pattern synonym builders don't yield dependencies]
305
                   ; patsyn_builders <- mapM tcPatSynBuilderBind patsyns
306
                   ; let extra_binds = [ (NonRecursive, builder) | builder <- patsyn_builders ]
307
                   ; return (extra_binds, thing) }
308
            ; return (binds' ++ extra_binds', thing) }}
309

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

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

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

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
-- 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.
--

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

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

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

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

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

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

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

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

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

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

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

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

442 443
mkEdges :: TcSigFun -> LHsBinds Name -> [Node BKey (LHsBind Name)]
-- See Note [Polymorphic recursion] in HsBinds.
444
mkEdges sig_fn binds
niteria's avatar
niteria committed
445
  = [ (bind, key, [key | n <- nonDetEltsUFM (bind_fvs (unLoc bind)),
Ian Lynagh's avatar
Ian Lynagh committed
446
                         Just key <- [lookupNameEnv key_map n], no_sig n ])
447 448
    | (bind, key) <- keyd_binds
    ]
niteria's avatar
niteria committed
449 450 451
    -- 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.
452 453
  where
    no_sig :: Name -> Bool
thomasw's avatar
thomasw committed
454
    no_sig n = noCompleteSig (sig_fn n)
455 456 457

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

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

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

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

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

487
    { traceTc "------------------------------------------------" Outputable.empty
488
    ; traceTc "Bindings for {" (ppr binder_names)
489
    ; dflags   <- getDynFlags
490
    ; let plan = decideGeneralisationPlan dflags bind_list closed sig_fn
491
    ; traceTc "Generalisation plan" (ppr plan)
492 493 494
    ; 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
495
         CheckGen lbind sig -> tcPolyCheck prag_fn sig lbind
496

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
497
        -- Check whether strict bindings are ok
Ian Lynagh's avatar
Ian Lynagh committed
498 499
        -- These must be non-recursive etc, and are not generalised
        -- They desugar to a case expression in the end
500 501 502 503
    ; 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]
                                          ])
504

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

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
--------------
-- 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
*                                                                      *
********************************************************************* -}

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

546 547
tcPolyNoGen rec_tc prag_fn tc_sig_fn bind_list
  = do { (binds', mono_infos) <- tcMonoBinds rec_tc tc_sig_fn
548
                                             (LetGblBndr prag_fn)
549
                                             bind_list
550
       ; mono_ids' <- mapM tc_mono_info mono_infos
551
       ; return (binds', mono_ids') }
552
  where
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
553
    tc_mono_info (MBI { mbi_poly_name = name, mbi_mono_id = mono_id })
554
      = do { mono_ty' <- zonkTcType (idType mono_id)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
555
             -- Zonk, mainly to expose unboxed types to checkStrictBinds
556
           ; let mono_id' = setIdType mono_id mono_ty'
557
           ; _specs <- tcSpecPrags mono_id' (lookupPragEnv prag_fn name)
558
           ; return mono_id' }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
559 560 561 562
           -- 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
563

564 565 566 567 568 569 570 571 572 573

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

tcPolyCheck :: TcPragEnv
            -> TcIdSigInfo     -- Must be a complete signature
            -> LHsBind Name    -- Must be a FunBind
574
            -> TcM (LHsBinds TcId, [TcId])
575
-- There is just one binding,
576
--   it is a Funbind
Simon Peyton Jones's avatar
Simon Peyton Jones committed
577
--   it has a complete type signature,
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
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
603 604
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
605

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

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
613
             abs_bind = L loc $ AbsBindsSig
614 615 616 617
                        { 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
618
                        , abs_sig_ev_bind = ev_binds
619
                        , abs_sig_bind    = L loc bind' }
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
620

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

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

626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
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
  = []

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
{- 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
*                                                                      *
********************************************************************* -}
661 662

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

674 675 676 677
       ; 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
678

679 680
       ; mapM_ (checkOverloadedSig mono) sigs

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

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

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

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

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

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

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

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

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

        ; wrap <- if sel_poly_ty `eqType` poly_ty  -- NB: eqType ignores visibility
739 740 741 742
                  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) $
743
                       tcSubType_NC sig_ctxt sel_poly_ty poly_ty
744

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

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

758
mkInferredPolyId :: [TyVar] -> TcThetaType
759
                 -> Name -> Maybe TcIdSigInst -> TcType
760
                 -> TcM TcId
761 762 763
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
764 765 766 767 768 769 770 771
  = 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
772
       ; let (_co, mono_ty') = normaliseType fam_envs Nominal mono_ty
773 774
               -- Unification may not have normalised the type,
               -- (see Note [Lazy flattening] in TcFlatten) so do it
775 776 777
               -- here to make it as uncomplicated as possible.
               -- Example: f :: [F Int] -> Bool
               -- should be rewritten to f :: [Char] -> Bool, if possible
778
               --
Gabor Greif's avatar
Gabor Greif committed
779
               -- We can discard the coercion _co, because we'll reconstruct
780
               -- it in the call to tcSubType below
781

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

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

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

793
       ; return (mkLocalIdOrCoVar poly_name inferred_poly_ty) }
794

795

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

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

823
  | Just wc_var <- wcx
824
  = do { annotated_theta <- zonkTcTypes annotated_theta
825 826 827 828 829
       ; let free_tvs = closeOverKinds (growThetaTyVars inferred_theta seed_tvs)
                          -- growThetaVars just like the no-type-sig case
                          -- Omitting this caused #12844
             seed_tvs = tyCoVarsOfTypes annotated_theta  -- These are put there
                        `unionVarSet` tau_tvs            --       by the user
830
             my_theta = pickCapturedPreds free_tvs inferred_theta
831 832 833 834

       -- 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.
835
       -- NB: inferred_theta already includes all the annotated constraints
836 837 838
             inferred_diff = [ pred
                             | pred <- my_theta
                             , all (not . (`eqType` pred)) annotated_theta ]
839 840
       ; ctuple <- mk_ctuple inferred_diff
       ; writeMetaTyVar wc_var ctuple
841
       ; traceTc "completeTheta" $
842
            vcat [ ppr sig
843 844
                 , ppr annotated_theta, ppr inferred_theta
                 , ppr inferred_diff ]
thomasw's avatar
thomasw committed
845

846
       ; return (mk_binders free_tvs, my_theta) }
847

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

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

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

865 866 867 868
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
869 870
mk_impedence_match_msg (MBI { mbi_poly_name = name, mbi_sig = mb_sig })
                       inf_ty sig_ty tidy_env
871 872
 = do { (tidy_env1, inf_ty) <- zonkTidyTcType tidy_env  inf_ty
      ; (tidy_env2, sig_ty) <- zonkTidyTcType tidy_env1 sig_ty
873
      ; let msg = vcat [ text "When checking that the inferred type"
874
                       , nest 2 $ ppr name <+> dcolon <+> ppr inf_ty
875
                       , text "is as general as its" <+> what <+> text "signature"
876 877 878 879
                       , nest 2 $ ppr name <+> dcolon <+> ppr sig_ty ]
      ; return (tidy_env2, msg) }
  where
    what = case mb_sig of
880 881
             Nothing                     -> text "inferred"
             Just sig | isPartialSig sig -> text "(partial)"
882 883 884 885 886 887
                      | 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
888
      ; let msg = vcat [ text "When checking the inferred type"
889 890
                       , nest 2 $ ppr poly_name <+> dcolon <+> ppr poly_ty ]
      ; return (tidy_env1, msg) }
891

892 893

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