TcBinds.hs 72.8 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

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

import Control.Monad
64 65

#include "HsVersions.h"
66

67 68 69 70 71 72 73 74
{- *********************************************************************
*                                                                      *
               A useful helper function
*                                                                      *
********************************************************************* -}

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

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

100
The real work is done by @tcBindWithSigsAndThen@.
101 102 103 104 105 106 107 108 109 110

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.

111 112 113
At the top-level the LIE is sure to contain nothing but constant
dictionaries, which we resolve at the module level.

114 115
Note [Polymorphic recursion]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
116
The game plan for polymorphic recursion in the code above is
117 118

        * Bind any variable for which we have a type signature
119
          to an Id with a polymorphic type.  Then when type-checking
120 121 122 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
          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
172
-}
173

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

185 186
        ; let { tcg_env' = tcg_env { tcg_imp_specs = specs ++ tcg_imp_specs tcg_env }
                           `addTypecheckedBinds` map snd binds' }
187 188

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

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

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

217
badBootDeclErr :: MsgDoc
218
badBootDeclErr = text "Illegal declarations in an hs-boot file"
219

220 221
------------------------
tcLocalBinds :: HsLocalBinds Name -> TcM thing
Ian Lynagh's avatar
Ian Lynagh committed
222
             -> TcM (HsLocalBinds TcId, thing)
sof's avatar
sof committed
223

224
tcLocalBinds EmptyLocalBinds thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
225 226
  = do  { thing <- thing_inside
        ; return (EmptyLocalBinds, thing) }
sof's avatar
sof committed
227

228 229 230 231
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"
232

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

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

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

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

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

276
However [Oct 10] this is all handled automatically by the
277 278
untouchable-range idea.

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
Note [Inlining and hs-boot files]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider this example (Trac #10083):

    ---------- RSR.hs-boot ------------
    module RSR where
      data RSR
      eqRSR :: RSR -> RSR -> Bool

    ---------- SR.hs ------------
    module SR where
      import {-# SOURCE #-} RSR
      data SR = MkSR RSR
      eqSR (MkSR r1) (MkSR r2) = eqRSR r1 r2

    ---------- RSR.hs ------------
    module RSR where
      import SR
      data RSR = MkRSR SR -- deriving( Eq )
      eqRSR (MkRSR s1) (MkRSR s2) = (eqSR s1 s2)
      foo x y = not (eqRSR x y)

When compiling RSR we get this code

    RSR.eqRSR :: RSR -> RSR -> Bool
    RSR.eqRSR = \ (ds1 :: RSR.RSR) (ds2 :: RSR.RSR) ->
                case ds1 of _ { RSR.MkRSR s1 ->
                case ds2 of _ { RSR.MkRSR s2 ->
                SR.eqSR s1 s2 }}

    RSR.foo :: RSR -> RSR -> Bool
    RSR.foo = \ (x :: RSR) (y :: RSR) -> not (RSR.eqRSR x y)

Now, when optimising foo:
    Inline eqRSR (small, non-rec)
    Inline eqSR  (small, non-rec)
but the result of inlining eqSR from SR is another call to eqRSR, so
everything repeats.  Neither eqSR nor eqRSR are (apparently) loop
breakers.

Solution: when compiling RSR, add a NOINLINE pragma to every function
exported by the boot-file for RSR (if it exists).

ALAS: doing so makes the boostrappted GHC itself slower by 8% overall
      (on Trac #9872a-d, and T1969.  So I un-did this change, and
      parked it for now.  Sigh.
Austin Seipp's avatar
Austin Seipp committed
325
-}
326

327
tcValBinds :: TopLevelFlag
328 329
           -> [(RecFlag, LHsBinds Name)] -> [LSig Name]
           -> TcM thing
330
           -> TcM ([(RecFlag, LHsBinds TcId)], thing)
331

332
tcValBinds top_lvl binds sigs thing_inside
333 334 335 336
  = do  { let patsyns = getPatSynBinds binds

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

339 340 341 342 343 344 345 346 347 348 349 350 351
        ; _self_boot <- tcSelfBootInfo
        ; let prag_fn = mkPragEnv sigs (foldr (unionBags . snd) emptyBag binds)

-- -------  See Note [Inlining and hs-boot files] (change parked) --------
--              prag_fn | isTopLevel top_lvl   -- See Note [Inlining and hs-boot files]
--                      , SelfBoot { sb_ids = boot_id_names } <- self_boot
--                      = foldNameSet add_no_inl prag_fn1 boot_id_names
--                      | otherwise
--                      = prag_fn1
--              add_no_inl boot_id_name prag_fn
--                = extendPragEnv prag_fn (boot_id_name, no_inl_sig boot_id_name)
--              no_inl_sig name = L boot_loc (InlineSig (L boot_loc name) neverInlinePragma)
--              boot_loc = mkGeneralSrcSpan (fsLit "The hs-boot file for this module")
Ian Lynagh's avatar
Ian Lynagh committed
352

353 354 355 356 357
                -- 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
358 359
            { (binds', (extra_binds', thing)) <- tcBindGroups top_lvl sig_fn prag_fn binds $ do
                   { thing <- thing_inside
360
                     -- See Note [Pattern synonym builders don't yield dependencies]
361
                   ; patsyn_builders <- mapM tcPatSynBuilderBind patsyns
362
                   ; let extra_binds = [ (NonRecursive, builder) | builder <- patsyn_builders ]
363
                   ; return (extra_binds, thing) }
364
            ; return (binds' ++ extra_binds', thing) }}
365

366
------------------------
367
tcBindGroups :: TopLevelFlag -> TcSigFun -> TcPragEnv
Ian Lynagh's avatar
Ian Lynagh committed
368 369
             -> [(RecFlag, LHsBinds Name)] -> TcM thing
             -> TcM ([(RecFlag, LHsBinds TcId)], thing)
370 371
-- Typecheck a whole lot of value bindings,
-- one strongly-connected component at a time
372
-- Here a "strongly connected component" has the strightforward
373
-- meaning of a group of bindings that mention each other,
374
-- ignoring type signatures (that part comes later)
375

376
tcBindGroups _ _ _ [] thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
377 378
  = do  { thing <- thing_inside
        ; return ([], thing) }
379

380
tcBindGroups top_lvl sig_fn prag_fn (group : groups) thing_inside
381 382 383 384
  = do  { -- See Note [Closed binder groups]
          closed <- isClosedBndrGroup $ snd group
        ; (group', (groups', thing))
                <- tc_group top_lvl sig_fn prag_fn group closed $
385
                   tcBindGroups top_lvl sig_fn prag_fn groups thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
386
        ; return (group' ++ groups', thing) }
sof's avatar
sof committed
387

388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
-- 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.
--

405
------------------------
406
tc_group :: forall thing.
407
            TopLevelFlag -> TcSigFun -> TcPragEnv
408
         -> (RecFlag, LHsBinds Name) -> IsGroupClosed -> TcM thing
Ian Lynagh's avatar
Ian Lynagh committed
409
         -> TcM ([(RecFlag, LHsBinds TcId)], thing)
410 411

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

415
tc_group top_lvl sig_fn prag_fn (NonRecursive, binds) closed thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
416 417
        -- A single non-recursive binding
        -- We want to keep non-recursive things non-recursive
418
        -- so that we desugar unlifted bindings correctly
cactus's avatar
cactus committed
419 420
  = do { let bind = case bagToList binds of
                 [bind] -> bind
421 422
                 []     -> panic "tc_group: empty list of binds"
                 _      -> panic "tc_group: NonRecursive binds is not a singleton bag"
423 424
       ; (bind', thing) <- tc_single top_lvl sig_fn prag_fn bind closed
                                     thing_inside
cactus's avatar
cactus committed
425
       ; return ( [(NonRecursive, bind')], thing) }
426

427
tc_group top_lvl sig_fn prag_fn (Recursive, binds) closed thing_inside
428 429
  =     -- To maximise polymorphism, we do a new
        -- strongly-connected-component analysis, this time omitting
Ian Lynagh's avatar
Ian Lynagh committed
430
        -- any references to variables with type signatures.
431
        -- (This used to be optional, but isn't now.)
432
        -- See Note [Polymorphic recursion] in HsBinds.
433
    do  { traceTc "tc_group rec" (pprLHsBinds binds)
cactus's avatar
cactus committed
434
        ; when hasPatSyn $ recursivePatSynErr binds
435
        ; (binds1, thing) <- go sccs
436
        ; return ([(Recursive, binds1)], thing) }
Ian Lynagh's avatar
Ian Lynagh committed
437
                -- Rec them all together
438
  where
439
    hasPatSyn = anyBag (isPatSyn . unLoc) binds
cactus's avatar
cactus committed
440 441 442
    isPatSyn PatSynBind{} = True
    isPatSyn _ = False

443
    sccs :: [SCC (LHsBind Name)]
444 445
    sccs = stronglyConnCompFromEdgedVertices (mkEdges sig_fn binds)

446
    go :: [SCC (LHsBind Name)] -> TcM (LHsBinds TcId, thing)
447
    go (scc:sccs) = do  { (binds1, ids1) <- tc_scc scc
448 449
                        ; (binds2, thing) <- tcExtendLetEnv top_lvl closed ids1
                                                            (go sccs)
450 451
                        ; return (binds1 `unionBags` binds2, thing) }
    go []         = do  { thing <- thing_inside; return (emptyBag, thing) }
452

453 454
    tc_scc (AcyclicSCC bind) = tc_sub_group NonRecursive [bind]
    tc_scc (CyclicSCC binds) = tc_sub_group Recursive    binds
sof's avatar
sof committed
455

456 457
    tc_sub_group rec_tc binds =
      tcPolyBinds top_lvl sig_fn prag_fn Recursive rec_tc closed binds
sof's avatar
sof committed
458

cactus's avatar
cactus committed
459 460 461
recursivePatSynErr :: OutputableBndr name => LHsBinds name -> TcM a
recursivePatSynErr binds
  = failWithTc $
462
    hang (text "Recursive pattern synonym definition with following bindings:")
463
       2 (vcat $ map pprLBind . bagToList $ binds)
cactus's avatar
cactus committed
464
  where
465
    pprLoc loc  = parens (text "defined at" <+> ppr loc)
cactus's avatar
cactus committed
466 467 468 469
    pprLBind (L loc bind) = pprWithCommas ppr (collectHsBindBinders bind) <+>
                            pprLoc loc

tc_single :: forall thing.
470
            TopLevelFlag -> TcSigFun -> TcPragEnv
471
          -> LHsBind Name -> IsGroupClosed -> TcM thing
cactus's avatar
cactus committed
472
          -> TcM (LHsBinds TcId, thing)
473 474 475
tc_single _top_lvl sig_fn _prag_fn
          (L _ (PatSynBind psb@PSB{ psb_id = L _ name }))
          _ thing_inside
476 477
  = do { (aux_binds, tcg_env) <- tc_pat_syn_decl
       ; thing <- setGblEnv tcg_env thing_inside
cactus's avatar
cactus committed
478 479
       ; return (aux_binds, thing)
       }
480
  where
481
    tc_pat_syn_decl :: TcM (LHsBinds TcId, TcGblEnv)
482
    tc_pat_syn_decl = case sig_fn name of
483 484 485
        Nothing                 -> tcInferPatSynDecl psb
        Just (TcPatSynSig tpsi) -> tcCheckPatSynDecl psb tpsi
        Just                 _  -> panic "tc_single"
486

487
tc_single top_lvl sig_fn prag_fn lbind closed thing_inside
488 489
  = do { (binds1, ids) <- tcPolyBinds top_lvl sig_fn prag_fn
                                      NonRecursive NonRecursive
490
                                      closed
491
                                      [lbind]
492
       ; thing <- tcExtendLetEnv top_lvl closed ids thing_inside
cactus's avatar
cactus committed
493
       ; return (binds1, thing) }
494

495
------------------------
496
type BKey = Int -- Just number off the bindings
497

498 499
mkEdges :: TcSigFun -> LHsBinds Name -> [Node BKey (LHsBind Name)]
-- See Note [Polymorphic recursion] in HsBinds.
500
mkEdges sig_fn binds
niteria's avatar
niteria committed
501
  = [ (bind, key, [key | n <- nonDetEltsUFM (bind_fvs (unLoc bind)),
Ian Lynagh's avatar
Ian Lynagh committed
502
                         Just key <- [lookupNameEnv key_map n], no_sig n ])
503 504
    | (bind, key) <- keyd_binds
    ]
niteria's avatar
niteria committed
505 506 507
    -- 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.
508 509
  where
    no_sig :: Name -> Bool
thomasw's avatar
thomasw committed
510
    no_sig n = noCompleteSig (sig_fn n)
511 512 513

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

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

518
------------------------
519
tcPolyBinds :: TopLevelFlag -> TcSigFun -> TcPragEnv
520 521 522
            -> RecFlag         -- Whether the group is really recursive
            -> RecFlag         -- Whether it's recursive after breaking
                               -- dependencies based on type signatures
523
            -> IsGroupClosed   -- Whether the group is closed
524
            -> [LHsBind Name]  -- None are PatSynBind
525
            -> TcM (LHsBinds TcId, [TcId])
526

527
-- Typechecks a single bunch of values bindings all together,
528 529 530
-- and generalises them.  The bunch may be only part of a recursive
-- group, because we use type signatures to maximise polymorphism
--
531 532
-- Returns a list because the input may be a single non-recursive binding,
-- in which case the dependency order of the resulting bindings is
533 534
-- important.
--
535
-- Knows nothing about the scope of the bindings
536
-- None of the bindings are pattern synonyms
537

538
tcPolyBinds top_lvl sig_fn prag_fn rec_group rec_tc closed bind_list
539
  = setSrcSpan loc                              $
540
    recoverM (recoveryCode binder_names sig_fn) $ do
541
        -- Set up main recover; take advantage of any type sigs
542

543
    { traceTc "------------------------------------------------" Outputable.empty
544
    ; traceTc "Bindings for {" (ppr binder_names)
545
    ; dflags   <- getDynFlags
546
    ; let plan = decideGeneralisationPlan dflags bind_list closed sig_fn
547
    ; traceTc "Generalisation plan" (ppr plan)
548 549 550
    ; 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
551
         CheckGen lbind sig -> tcPolyCheck prag_fn sig lbind
552

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
553
        -- Check whether strict bindings are ok
Ian Lynagh's avatar
Ian Lynagh committed
554 555
        -- These must be non-recursive etc, and are not generalised
        -- They desugar to a case expression in the end
556 557 558 559
    ; 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]
                                          ])
560

561
    ; return result }
562
  where
563 564
    binder_names = collectHsBindListBinders bind_list
    loc = foldr1 combineSrcSpans (map getLoc bind_list)
565
         -- The mbinds have been dependency analysed and
566
         -- may no longer be adjacent; so find the narrowest
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
567
         -- span that includes them all
568

569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
--------------
-- 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
*                                                                      *
********************************************************************* -}

595
tcPolyNoGen     -- No generalisation whatsoever
596
  :: RecFlag       -- Whether it's recursive after breaking
597
                   -- dependencies based on type signatures
598
  -> TcPragEnv -> TcSigFun
599
  -> [LHsBind Name]
600
  -> TcM (LHsBinds TcId, [TcId])
601

602 603
tcPolyNoGen rec_tc prag_fn tc_sig_fn bind_list
  = do { (binds', mono_infos) <- tcMonoBinds rec_tc tc_sig_fn
604
                                             (LetGblBndr prag_fn)
605
                                             bind_list
606
       ; mono_ids' <- mapM tc_mono_info mono_infos
607
       ; return (binds', mono_ids') }
608
  where
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
609
    tc_mono_info (MBI { mbi_poly_name = name, mbi_mono_id = mono_id })
610
      = do { mono_ty' <- zonkTcType (idType mono_id)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
611
             -- Zonk, mainly to expose unboxed types to checkStrictBinds
612
           ; let mono_id' = setIdType mono_id mono_ty'
613
           ; _specs <- tcSpecPrags mono_id' (lookupPragEnv prag_fn name)
614
           ; return mono_id' }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
615 616 617 618
           -- 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
619

620 621 622 623 624 625 626 627 628 629

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

tcPolyCheck :: TcPragEnv
            -> TcIdSigInfo     -- Must be a complete signature
            -> LHsBind Name    -- Must be a FunBind
630
            -> TcM (LHsBinds TcId, [TcId])
631
-- There is just one binding,
632
--   it is a Funbind
Simon Peyton Jones's avatar
Simon Peyton Jones committed
633
--   it has a complete type signature,
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
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
659 660
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
661

662 663 664 665 666 667
       ; let bind' = FunBind { fun_id      = L nm_loc mono_id
                             , fun_matches = matches'
                             , fun_co_fn   = co_fn
                             , bind_fvs    = placeHolderNamesTc
                             , fun_tick    = [] }

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
668
             abs_bind = L loc $ AbsBindsSig
669 670 671 672
                        { 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
673
                        , abs_sig_ev_bind = ev_binds
674
                        , abs_sig_bind    = L loc bind' }
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
675

676
       ; return (unitBag abs_bind, [poly_id]) }
677

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
tcPolyCheck _prag_fn sig bind
  = pprPanic "tcPolyCheck" (ppr sig $$ ppr bind)

{- 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
*                                                                      *
********************************************************************* -}
700 701

tcPolyInfer
702
  :: RecFlag       -- Whether it's recursive after breaking
703
                   -- dependencies based on type signatures
704
  -> TcPragEnv -> TcSigFun
705
  -> Bool         -- True <=> apply the monomorphism restriction
706
  -> [LHsBind Name]
707 708
  -> TcM (LHsBinds TcId, [TcId])
tcPolyInfer rec_tc prag_fn tc_sig_fn mono bind_list
709
  = do { (tclvl, wanted, (binds', mono_infos))
710
             <- pushLevelAndCaptureConstraints  $
711 712 713 714
                tcMonoBinds rec_tc tc_sig_fn LetLclBndr bind_list

       ; let name_taus = [ (mbi_poly_name info, idType (mbi_mono_id info))
                         | info <- mono_infos ]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
715
             sigs      = [ sig | MBI { mbi_sig = Just sig } <- mono_infos ]
716

717 718
       ; mapM_ (checkOverloadedSig mono) sigs

719
       ; traceTc "simplifyInfer call" (ppr tclvl $$ ppr name_taus $$ ppr wanted)
720
       ; (qtvs, givens, ev_binds)
721
                 <- simplifyInfer tclvl mono sigs name_taus wanted
722

723
       ; let inferred_theta = map evVarPred givens
724
       ; exports <- checkNoErrs $
725
                    mapM (mkExport prag_fn qtvs inferred_theta) mono_infos
thomasw's avatar
thomasw committed
726

727
       ; loc <- getSrcSpanM
728
       ; let poly_ids = map abe_poly exports
729
             abs_bind = L loc $
730
                        AbsBinds { abs_tvs = qtvs
731
                                 , abs_ev_vars = givens, abs_ev_binds = [ev_binds]
732
                                 , abs_exports = exports, abs_binds = binds' }
733

734 735
       ; traceTc "Binding:" (ppr (poly_ids `zip` map idType poly_ids))
       ; return (unitBag abs_bind, poly_ids) }
736
         -- poly_ids are guaranteed zonked by mkExport
737 738

--------------
739
mkExport :: TcPragEnv
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
740
         -> [TyVar] -> TcThetaType      -- Both already zonked
Ian Lynagh's avatar
Ian Lynagh committed
741
         -> MonoBindInfo
742
         -> TcM (ABExport Id)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
743
-- Only called for generalisation plan InferGen, not by CheckGen or NoGen
744 745 746
--
-- mkExport generates exports with
--      zonked type variables,
Ian Lynagh's avatar
Ian Lynagh committed
747
--      zonked poly_ids
748 749 750 751
-- 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
752
-- type environment; see the invariant on TcEnv.tcExtendIdEnv
753

754
-- Pre-condition: the qtvs and theta are already zonked
755

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
756 757 758 759
mkExport prag_fn qtvs theta
         mono_info@(MBI { mbi_poly_name = poly_name
                        , mbi_sig       = mb_sig
                        , mbi_mono_id   = mono_id })
760
  = do  { mono_ty <- zonkTcType (idType mono_id)
761
        ; poly_id <- mkInferredPolyId qtvs theta poly_name mb_sig mono_ty
762 763

        -- NB: poly_id has a zonked type
764
        ; poly_id <- addInlinePrags poly_id prag_sigs
765
        ; spec_prags <- tcSpecPrags poly_id prag_sigs
Ian Lynagh's avatar
Ian Lynagh committed
766
                -- tcPrags requires a zonked poly_id
767

768
        -- See Note [Impedence matching]
769 770
        -- NB: we have already done checkValidType, including an ambiguity check,
        --     on the type; either when we checked the sig or in mkInferredPolyId
771 772 773 774
        ; let poly_ty     = idType poly_id
              sel_poly_ty = mkInvSigmaTy qtvs theta mono_ty
                -- This type is just going into tcSubType,
                -- so Inv vs. Spec doesn't matter
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
775 776

        ; wrap <- if sel_poly_ty `eqType` poly_ty  -- NB: eqType ignores visibility
777 778 779 780
                  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) $
781
                       tcSubType_NC sig_ctxt sel_poly_ty (mkCheckExpType poly_ty)
782

manav's avatar
manav committed
783
        ; warn_missing_sigs <- woptM Opt_WarnMissingLocalSignatures
784 785
        ; when warn_missing_sigs $
              localSigWarn Opt_WarnMissingLocalSignatures poly_id mb_sig
786

787
        ; return (ABE { abe_wrap = wrap
788
                        -- abe_wrap :: idType poly_id ~ (forall qtvs. theta => mono_ty)
789 790
                      , abe_poly = poly_id
                      , abe_mono = mono_id
791
                      , abe_prags = SpecPrags spec_prags}) }
792
  where
793
    prag_sigs = lookupPragEnv prag_fn poly_name
794
    sig_ctxt  = InfSigCtxt poly_name
795

796
mkInferredPolyId :: [TyVar] -> TcThetaType
797
                 -> Name -> Maybe TcIdSigInst -> TcType
798
                 -> TcM TcId
799 800 801
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
802 803 804 805 806 807 808 809
  = 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
810
       ; let (_co, mono_ty') = normaliseType fam_envs Nominal mono_ty
811 812
               -- Unification may not have normalised the type,
               -- (see Note [Lazy flattening] in TcFlatten) so do it
813 814 815
               -- here to make it as uncomplicated as possible.
               -- Example: f :: [F Int] -> Bool
               -- should be rewritten to f :: [Char] -> Bool, if possible
816
               --
Gabor Greif's avatar
Gabor Greif committed
817
               -- We can discard the coercion _co, because we'll reconstruct
818
               -- it in the call to tcSubType below
819

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

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

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
825
       ; traceTc "mkInferredPolyId" (vcat [ppr poly_name, ppr qtvs, ppr theta'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
826 827
                                          , ppr inferred_poly_ty])
       ; addErrCtxtM (mk_inf_msg poly_name inferred_poly_ty) $
828
         checkValidType (InfSigCtxt poly_name) inferred_poly_ty
829
         -- See Note [Validity of inferred types]
830

831
       ; return (mkLocalIdOrCoVar poly_name inferred_poly_ty) }
832

833

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
834 835 836
chooseInferredQuantifiers :: TcThetaType   -- inferred
                          -> TcTyVarSet    -- tvs free in tau type
                          -> [TcTyVar]     -- inferred quantified tvs
837
                          -> Maybe TcIdSigInst
Simon Peyton Jones's avatar
Simon Peyton Jones committed
838
                          -> TcM ([TyVarBinder], TcThetaType)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
839
chooseInferredQuantifiers inferred_theta tau_tvs qtvs Nothing
840
  = -- No type signature (partial or complete) for this binder,
841
    do { let free_tvs = closeOverKinds (growThetaTyVars inferred_theta tau_tvs)
842
                        -- Include kind variables!  Trac #7916
843
             my_theta = pickCapturedPreds free_tvs inferred_theta
Simon Peyton Jones's avatar
Simon Peyton Jones committed
844
             binders  = [ mkTyVarBinder Invisible tv
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
845 846 847
                        | tv <- qtvs
                        , tv `elemVarSet` free_tvs ]
       ; return (binders, my_theta) }
848

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
849
chooseInferredQuantifiers inferred_theta tau_tvs qtvs
850 851 852 853 854
                          (Just (TISI { sig_inst_sig   = sig  -- Always PartialSig
                                      , sig_inst_wcx   = wcx
                                      , sig_inst_theta = annotated_theta
                                      , sig_inst_skols = annotated_tvs }))
  | Nothing <- wcx
855 856
  = do { annotated_theta <- zonkTcTypes annotated_theta
       ; let free_tvs = closeOverKinds (tyCoVarsOfTypes annotated_theta
857
                                        `unionVarSet` tau_tvs)