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

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

8 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

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)
niteria's avatar
niteria committed
61
import UniqFM
62
import qualified GHC.LanguageExtensions as LangExt
63 64

import Control.Monad
65 66

#include "HsVersions.h"
67

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 325
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
326
-}
327

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

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

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

340 341 342 343 344 345 346 347 348 349 350 351 352
        ; _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
353

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

------------------
597
tcPolyCheck :: RecFlag       -- Whether it's recursive after breaking
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
598
                             -- dependencies based on type signatures
599
            -> TcPragEnv
600
            -> TcIdSigInfo
601
            -> LHsBind Name
602
            -> TcM (LHsBinds TcId, [TcId])
603
-- There is just one binding,
604
--   it binds a single variable,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
605
--   it has a complete type signature,
606
tcPolyCheck rec_tc prag_fn
607
            sig@(TISI { sig_bndr  = CompleteSig poly_id
608
                      , sig_skols = skol_prs
609 610 611 612
                      , sig_theta = theta
                      , sig_tau   = tau
                      , sig_ctxt  = ctxt
                      , sig_loc   = loc })
613
            bind
614
  = do { ev_vars <- newEvVars theta
615
       ; let skol_info = SigSkol ctxt (mkPhiTy theta tau)
616
             prag_sigs = lookupPragEnv prag_fn name
617
             skol_tvs  = map snd skol_prs
618 619 620 621
                 -- 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
622
       ; (ev_binds, (binds', _))
623
            <- setSrcSpan loc $
624
               checkConstraints skol_info skol_tvs ev_vars $
625
               tcMonoBinds rec_tc (\_ -> Just (TcIdSig sig)) LetLclBndr [bind]
626

627 628
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
629

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
630 631 632 633
       ; let bind' = case bagToList binds' of
                       [b] -> b
                       _   -> pprPanic "tcPolyCheck" (ppr binds')
             abs_bind = L loc $ AbsBindsSig
634
                        { abs_tvs = skol_tvs
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
635 636 637 638 639 640
                        , 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' }

641
       ; return (unitBag abs_bind, [poly_id]) }
642

643 644 645
tcPolyCheck _rec_tc _prag_fn sig _bind
  = pprPanic "tcPolyCheck" (ppr sig)

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

663
       ; traceTc "simplifyInfer call" (ppr tclvl $$ ppr name_taus $$ ppr wanted)
664
       ; (qtvs, givens, ev_binds)
665
                 <- simplifyInfer tclvl mono sigs name_taus wanted
666

667
       ; let inferred_theta = map evVarPred givens
668
       ; exports <- checkNoErrs $
669
                    mapM (mkExport prag_fn qtvs inferred_theta) mono_infos
thomasw's avatar
thomasw committed
670

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

678 679
       ; traceTc "Binding:" (ppr (poly_ids `zip` map idType poly_ids))
       ; return (unitBag abs_bind, poly_ids) }
680
         -- poly_ids are guaranteed zonked by mkExport
681 682

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

698
-- Pre-condition: the qtvs and theta are already zonked
699

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

        -- NB: poly_id has a zonked type
708
        ; poly_id <- addInlinePrags poly_id prag_sigs
709
        ; spec_prags <- tcSpecPrags poly_id prag_sigs
Ian Lynagh's avatar
Ian Lynagh committed
710
                -- tcPrags requires a zonked poly_id
711

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

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

manav's avatar
manav committed
727
        ; warn_missing_sigs <- woptM Opt_WarnMissingLocalSignatures
728 729
        ; when warn_missing_sigs $
              localSigWarn Opt_WarnMissingLocalSignatures poly_id mb_sig
730

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

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

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

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

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

775
       ; return (mkLocalIdOrCoVar poly_name inferred_poly_ty) }
776

777

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
778 779 780 781 782 783
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
784
  = -- No type signature (partial or complete) for this binder,
785
    do { let free_tvs = closeOverKinds (growThetaTyVars inferred_theta tau_tvs)
786
                        -- Include kind variables!  Trac #7916
787
             my_theta = pickCapturedPreds free_tvs inferred_theta
788
             binders  = [ mkNamedBinder Invisible tv
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
789 790 791
                        | tv <- qtvs
                        , tv `elemVarSet` free_tvs ]
       ; return (binders, my_theta) }
792

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
793
chooseInferredQuantifiers inferred_theta tau_tvs qtvs
794
                          (Just (TISI { sig_bndr = bndr_info  -- Always PartialSig
795
                                      , sig_ctxt = ctxt
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
796 797
                                      , sig_theta = annotated_theta
                                      , sig_skols = annotated_tvs }))
798 799
  | PartialSig { sig_cts = extra } <- bndr_info
  , Nothing <- extra
800 801
  = do { annotated_theta <- zonkTcTypes annotated_theta
       ; let free_tvs = closeOverKinds (tyCoVarsOfTypes annotated_theta
802 803
                                        `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
804
       ; return (mk_binders free_tvs, annotated_theta) }
805

806
  | PartialSig { sig_cts = extra, sig_hs_ty = hs_ty } <- bndr_info
807
  , Just loc <- extra
808 809
  = do { annotated_theta <- zonkTcTypes annotated_theta
       ; let free_tvs = closeOverKinds (tyCoVarsOfTypes annotated_theta
810
                                        `unionVarSet` tau_tvs)
811
             my_theta = pickCapturedPreds free_tvs inferred_theta
812 813 814 815

       -- 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.
816
       -- NB: inferred_theta already includes all the annotated constraints
817 818 819
             inferred_diff = [ pred
                             | pred <- my_theta
                             , all (not . (`eqType` pred)) annotated_theta ]
820
       ; partial_sigs      <- xoptM LangExt.PartialTypeSignatures
thomasw's avatar
thomasw committed
821
       ; warn_partial_sigs <- woptM Opt_WarnPartialTypeSignatures
822
       ; msg <- mkLongErrAt loc (mk_msg inferred_diff partial_sigs hs_ty) empty
823 824 825 826
       ; traceTc "completeTheta" $
            vcat [ ppr bndr_info
                 , ppr annotated_theta, ppr inferred_theta
                 , ppr inferred_diff ]
thomasw's avatar
thomasw committed
827
       ; case partial_sigs of
828 829
           True | warn_partial_sigs ->
                      reportWarning (Reason Opt_WarnPartialTypeSignatures) msg
thomasw's avatar
thomasw committed
830 831 832
                | otherwise         -> return ()
           False                    -> reportError msg

833
       ; return (mk_binders free_tvs, my_theta) }
834

835 836
  | otherwise  -- A complete type signature is dealt with in mkInferredPolyId
  = pprPanic "chooseInferredQuantifiers" (ppr bndr_info)
837

thomasw's avatar
thomasw committed
838 839
  where
    pts_hint = text "To use the inferred type, enable PartialTypeSignatures"
840
    mk_msg inferred_diff suppress_hint hs_ty
841 842
       = vcat [ hang ((text "Found constraint wildcard") <+> quotes (char '_'))
                   2 (text "standing for") <+> quotes (pprTheta inferred_diff)
thomasw's avatar
thomasw committed
843
              , if suppress_hint then empty else pts_hint
844
              , pprSigCtxt ctxt (ppr hs_ty) ]
845

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

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

882 883

-- | Warn the user about polymorphic local binders that lack type signatures.
884 885
localSigWarn :: WarningFlag -> Id -> Maybe TcIdSigInfo -> TcM ()
localSigWarn flag id mb_sig
886 887
  | Just _ <- mb_sig               = return ()
  | not (isSigmaTy (idType id))    = return ()
888
  | otherwise                      = warnMissingSignatures flag msg id
889
  where
890
    msg = text "Polymorphic local binding with no type signature:"