TcBinds.hs 88.1 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 9
{-# LANGUAGE CPP, RankNTypes, ScopedTypeVariables #-}

10
module TcBinds ( tcLocalBinds, tcTopBinds, tcRecSelBinds,
11
                 tcValBinds, tcHsBootSigs, tcPolyCheck,
12
                 tcSpecPrags, tcSpecWrapper,
13
                 tcVectDecls, addTypecheckedBinds,
14 15
                 TcSigInfo(..), TcSigFun,
                 TcPragEnv, mkPragEnv,
16 17
                 tcUserTypeSig, instTcTySig, chooseInferredQuantifiers,
                 instTcTySigFromId, tcExtendTyVarEnvFromSig,
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
18
                 badBootDeclErr ) where
19

ross's avatar
ross committed
20
import {-# SOURCE #-} TcMatches ( tcGRHSsPat, tcMatchesFun )
21
import {-# SOURCE #-} TcExpr  ( tcMonoExpr )
22 23
import {-# SOURCE #-} TcPatSyn ( tcInferPatSynDecl, tcCheckPatSynDecl
                               , tcPatSynBuilderBind, tcPatSynSig )
Simon Marlow's avatar
Simon Marlow committed
24 25
import DynFlags
import HsSyn
26
import HscTypes( isHsBootOrSig )
27
import TcRnMonad
Simon Marlow's avatar
Simon Marlow committed
28 29 30
import TcEnv
import TcUnify
import TcSimplify
31
import TcEvidence
Simon Marlow's avatar
Simon Marlow committed
32 33 34
import TcHsType
import TcPat
import TcMType
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
35
import Inst( topInstantiate, deeplyInstantiate )
36 37
import FamInstEnv( normaliseType )
import FamInst( tcGetFamInstEnvs )
38
import TyCon
Simon Marlow's avatar
Simon Marlow committed
39 40 41
import TcType
import TysPrim
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 Type(mkStrLitTy, tidyOpenType)
59
import PrelNames( mkUnboundName, gHC_PRIM, ipClassName )
60
import TcValidity (checkValidType)
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 sig_fn) 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) -> TopLevelFlag -> 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 -> TopLevelFlag -> 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
501
  = [ (bind, key, [key | n <- nameSetElems (bind_fvs (unLoc bind)),
Ian Lynagh's avatar
Ian Lynagh committed
502
                         Just key <- [lookupNameEnv key_map n], no_sig n ])
503 504 505 506
    | (bind, key) <- keyd_binds
    ]
  where
    no_sig :: Name -> Bool
thomasw's avatar
thomasw committed
507
    no_sig n = noCompleteSig (sig_fn n)
508 509 510

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

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

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

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

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

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

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

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

566
------------------
567
tcPolyNoGen     -- No generalisation whatsoever
568
  :: RecFlag       -- Whether it's recursive after breaking
569
                   -- dependencies based on type signatures
570
  -> TcPragEnv -> TcSigFun
571
  -> [LHsBind Name]
572
  -> TcM (LHsBinds TcId, [TcId])
573

574 575
tcPolyNoGen rec_tc prag_fn tc_sig_fn bind_list
  = do { (binds', mono_infos) <- tcMonoBinds rec_tc tc_sig_fn
576
                                             (LetGblBndr prag_fn)
577
                                             bind_list
578
       ; mono_ids' <- mapM tc_mono_info mono_infos
579
       ; return (binds', mono_ids') }
580
  where
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
581
    tc_mono_info (MBI { mbi_poly_name = name, mbi_mono_id = mono_id })
582
      = do { mono_ty' <- zonkTcType (idType mono_id)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
583
             -- Zonk, mainly to expose unboxed types to checkStrictBinds
584
           ; let mono_id' = setIdType mono_id mono_ty'
585
           ; _specs <- tcSpecPrags mono_id' (lookupPragEnv prag_fn name)
586
           ; return mono_id' }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
587 588 589 590
           -- 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
591 592

------------------
593
tcPolyCheck :: RecFlag       -- Whether it's recursive after breaking
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
594
                             -- dependencies based on type signatures
595
            -> TcPragEnv
596
            -> TcIdSigInfo
597
            -> LHsBind Name
598
            -> TcM (LHsBinds TcId, [TcId])
599
-- There is just one binding,
600
--   it binds a single variable,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
601
--   it has a complete type signature,
602
tcPolyCheck rec_tc prag_fn
603
            sig@(TISI { sig_bndr  = CompleteSig poly_id
604
                      , sig_skols = skol_prs
605 606 607 608
                      , sig_theta = theta
                      , sig_tau   = tau
                      , sig_ctxt  = ctxt
                      , sig_loc   = loc })
609
            bind
610
  = do { ev_vars <- newEvVars theta
611
       ; let skol_info = SigSkol ctxt (mkPhiTy theta tau)
612
             prag_sigs = lookupPragEnv prag_fn name
613
             skol_tvs  = map snd skol_prs
614 615 616 617
                 -- Find the location of the original source type sig, if
                 -- there is was one.  This will appear in messages like
                 -- "type variable x is bound by .. at <loc>"
             name = idName poly_id
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
618
       ; (ev_binds, (binds', _))
619
            <- setSrcSpan loc $
620
               checkConstraints skol_info skol_tvs ev_vars $
621
               tcMonoBinds rec_tc (\_ -> Just (TcIdSig sig)) LetLclBndr [bind]
622

623 624
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
625

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
626 627 628 629
       ; let bind' = case bagToList binds' of
                       [b] -> b
                       _   -> pprPanic "tcPolyCheck" (ppr binds')
             abs_bind = L loc $ AbsBindsSig
630
                        { abs_tvs = skol_tvs
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
631 632 633 634 635 636
                        , abs_ev_vars = ev_vars
                        , abs_sig_export = poly_id
                        , abs_sig_prags = SpecPrags spec_prags
                        , abs_sig_ev_bind = ev_binds
                        , abs_sig_bind    = bind' }

637
       ; return (unitBag abs_bind, [poly_id]) }
638

639 640 641
tcPolyCheck _rec_tc _prag_fn sig _bind
  = pprPanic "tcPolyCheck" (ppr sig)

642
------------------
643
tcPolyInfer
644
  :: RecFlag       -- Whether it's recursive after breaking
645
                   -- dependencies based on type signatures
646
  -> TcPragEnv -> TcSigFun
647
  -> Bool         -- True <=> apply the monomorphism restriction
648
  -> [LHsBind Name]
649 650
  -> TcM (LHsBinds TcId, [TcId])
tcPolyInfer rec_tc prag_fn tc_sig_fn mono bind_list
651
  = do { (tclvl, wanted, (binds', mono_infos))
652
             <- pushLevelAndCaptureConstraints  $
653 654 655 656
                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
657
             sigs      = [ sig | MBI { mbi_sig = Just sig } <- mono_infos ]
658

659
       ; traceTc "simplifyInfer call" (ppr tclvl $$ ppr name_taus $$ ppr wanted)
660
       ; (qtvs, givens, ev_binds)
661
                 <- simplifyInfer tclvl mono sigs name_taus wanted
662

663
       ; let inferred_theta = map evVarPred givens
664
       ; exports <- checkNoErrs $
665
                    mapM (mkExport prag_fn qtvs inferred_theta) mono_infos
thomasw's avatar
thomasw committed
666

667
       ; loc <- getSrcSpanM
668
       ; let poly_ids = map abe_poly exports
669
             abs_bind = L loc $
670
                        AbsBinds { abs_tvs = qtvs
671
                                 , abs_ev_vars = givens, abs_ev_binds = [ev_binds]
672
                                 , abs_exports = exports, abs_binds = binds' }
673

674 675
       ; traceTc "Binding:" (ppr (poly_ids `zip` map idType poly_ids))
       ; return (unitBag abs_bind, poly_ids) }
676
         -- poly_ids are guaranteed zonked by mkExport
677 678

--------------
679
mkExport :: TcPragEnv
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
680
         -> [TyVar] -> TcThetaType      -- Both already zonked
Ian Lynagh's avatar
Ian Lynagh committed
681
         -> MonoBindInfo
682
         -> TcM (ABExport Id)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
683
-- Only called for generalisation plan InferGen, not by CheckGen or NoGen
684 685 686
--
-- mkExport generates exports with
--      zonked type variables,
Ian Lynagh's avatar
Ian Lynagh committed
687
--      zonked poly_ids
688 689 690 691
-- 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
692
-- type environment; see the invariant on TcEnv.tcExtendIdEnv
693

694
-- Pre-condition: the qtvs and theta are already zonked
695

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
696 697 698 699
mkExport prag_fn qtvs theta
         mono_info@(MBI { mbi_poly_name = poly_name
                        , mbi_sig       = mb_sig
                        , mbi_mono_id   = mono_id })
700
  = do  { mono_ty <- zonkTcType (idType mono_id)
701
        ; poly_id <- mkInferredPolyId qtvs theta poly_name mb_sig mono_ty
702 703

        -- NB: poly_id has a zonked type
704
        ; poly_id <- addInlinePrags poly_id prag_sigs
705
        ; spec_prags <- tcSpecPrags poly_id prag_sigs
Ian Lynagh's avatar
Ian Lynagh committed
706
                -- tcPrags requires a zonked poly_id
707

708
        -- See Note [Impedence matching]
709 710
        -- NB: we have already done checkValidType, including an ambiguity check,
        --     on the type; either when we checked the sig or in mkInferredPolyId
711
        ; let sel_poly_ty = mkInvSigmaTy qtvs theta mono_ty
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
712 713 714
                -- this type is just going into tcSubType, so Inv vs. Spec doesn't
                -- matter

715
              poly_ty     = idType poly_id
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
716
        ; wrap <- if sel_poly_ty `eqType` poly_ty  -- NB: eqType ignores visibility
717 718 719 720
                  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) $
721
                       tcSubType_NC sig_ctxt sel_poly_ty (mkCheckExpType poly_ty)
722

manav's avatar
manav committed
723
        ; warn_missing_sigs <- woptM Opt_WarnMissingLocalSignatures
724 725
        ; when warn_missing_sigs $
              localSigWarn Opt_WarnMissingLocalSignatures poly_id mb_sig
726

727
        ; return (ABE { abe_wrap = wrap
728
                        -- abe_wrap :: idType poly_id ~ (forall qtvs. theta => mono_ty)
729 730
                      , abe_poly = poly_id
                      , abe_mono = mono_id
731
                      , abe_prags = SpecPrags spec_prags}) }
732
  where
733
    prag_sigs = lookupPragEnv prag_fn poly_name
734
    sig_ctxt  = InfSigCtxt poly_name
735

736 737 738 739
mkInferredPolyId :: [TyVar] -> TcThetaType
                 -> Name -> Maybe TcIdSigInfo -> TcType
                 -> TcM TcId
mkInferredPolyId qtvs inferred_theta poly_name mb_sig mono_ty
740 741 742 743 744 745 746 747 748 749
  | Just sig     <- mb_sig
  , Just poly_id <- completeIdSigPolyId_maybe sig
  = 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
750
       ; let (_co, mono_ty') = normaliseType fam_envs Nominal mono_ty
751 752
               -- Unification may not have normalised the type,
               -- (see Note [Lazy flattening] in TcFlatten) so do it
753 754 755
               -- here to make it as uncomplicated as possible.
               -- Example: f :: [F Int] -> Bool
               -- should be rewritten to f :: [Char] -> Bool, if possible
756
               --
Gabor Greif's avatar
Gabor Greif committed
757
               -- We can discard the coercion _co, because we'll reconstruct
758
               -- it in the call to tcSubType below
759

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
760 761
       ; (binders, theta') <- chooseInferredQuantifiers inferred_theta
                                (tyCoVarsOfType mono_ty') qtvs mb_sig
762

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

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
765
       ; traceTc "mkInferredPolyId" (vcat [ppr poly_name, ppr qtvs, ppr theta'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
766 767
                                          , ppr inferred_poly_ty])
       ; addErrCtxtM (mk_inf_msg poly_name inferred_poly_ty) $
768
         checkValidType (InfSigCtxt poly_name) inferred_poly_ty
769
         -- See Note [Validity of inferred types]
770

771
       ; return (mkLocalIdOrCoVar poly_name inferred_poly_ty) }
772

773

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
774 775 776 777 778 779
chooseInferredQuantifiers :: TcThetaType   -- inferred
                          -> TcTyVarSet    -- tvs free in tau type
                          -> [TcTyVar]     -- inferred quantified tvs
                          -> Maybe TcIdSigInfo
                          -> TcM ([TcTyBinder], TcThetaType)
chooseInferredQuantifiers inferred_theta tau_tvs qtvs Nothing
780 781
  = -- No type signature for this binder
    do { let free_tvs = closeOverKinds (growThetaTyVars inferred_theta tau_tvs)
782
                        -- Include kind variables!  Trac #7916
Eric Seidel's avatar
Eric Seidel committed
783
             my_theta = pickQuantifiablePreds free_tvs [] inferred_theta
784
             binders  = [ mkNamedBinder Invisible tv
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
785 786 787
                        | tv <- qtvs
                        , tv `elemVarSet` free_tvs ]
       ; return (binders, my_theta) }
788

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
789
chooseInferredQuantifiers inferred_theta tau_tvs qtvs
790
                          (Just (TISI { sig_bndr = bndr_info  -- Always PartialSig
791
                                      , sig_ctxt = ctxt
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
792 793
                                      , sig_theta = annotated_theta
                                      , sig_skols = annotated_tvs }))
794 795
  | PartialSig { sig_cts = extra } <- bndr_info
  , Nothing <- extra
796 797
  = do { annotated_theta <- zonkTcTypes annotated_theta
       ; let free_tvs = closeOverKinds (tyCoVarsOfTypes annotated_theta
798 799
                                        `unionVarSet` tau_tvs)
       ; traceTc "ciq" (vcat [ ppr bndr_info, ppr annotated_theta, ppr free_tvs])
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
800
       ; return (mk_binders free_tvs, annotated_theta) }
801

802
  | PartialSig { sig_cts = extra, sig_hs_ty = hs_ty } <- bndr_info
803
  , Just loc <- extra
804 805
  = do { annotated_theta <- zonkTcTypes annotated_theta
       ; let free_tvs = closeOverKinds (tyCoVarsOfTypes annotated_theta
806
                                        `unionVarSet` tau_tvs)
Eric Seidel's avatar
Eric Seidel committed
807
             my_theta = pickQuantifiablePreds free_tvs annotated_theta inferred_theta