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

10
module TcBinds ( tcLocalBinds, tcTopBinds, tcRecSelBinds,
11
                 tcHsBootSigs, tcPolyCheck,
12 13
                 PragFun, tcSpecPrags, tcVectDecls, mkPragFun,
                 TcSigInfo(..), TcSigFun,
14
                 instTcTySig, instTcTySigFromId, findScopedTyVars,
Facundo Domínguez's avatar
Facundo Domínguez committed
15
                 badBootDeclErr, mkExport ) where
16

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

import Control.Monad
62
import Data.List (partition)
63 64

#include "HsVersions.h"
65

Austin Seipp's avatar
Austin Seipp committed
66 67 68
{-
************************************************************************
*                                                                      *
69
\subsection{Type-checking bindings}
Austin Seipp's avatar
Austin Seipp committed
70 71
*                                                                      *
************************************************************************
72

73
@tcBindsAndThen@ typechecks a @HsBinds@.  The "and then" part is because
74 75 76 77 78 79 80 81 82 83
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".

84
The real work is done by @tcBindWithSigsAndThen@.
85 86 87 88 89 90 91 92 93 94

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.

95 96 97
At the top-level the LIE is sure to contain nothing but constant
dictionaries, which we resolve at the module level.

98 99
Note [Polymorphic recursion]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
100
The game plan for polymorphic recursion in the code above is
101 102

        * Bind any variable for which we have a type signature
103
          to an Id with a polymorphic type.  Then when type-checking
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 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
          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
156
-}
157

158 159 160 161
tcTopBinds :: HsValBinds Name -> TcM (TcGblEnv, TcLclEnv)
-- The TcGblEnv contains the new tcg_binds and tcg_spects
-- The TcLclEnv has an extended type envt for the new bindings
tcTopBinds (ValBindsOut binds sigs)
cactus's avatar
cactus committed
162 163 164 165 166
  = 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) }
167 168 169 170 171 172 173 174
        ; specs <- tcImpPrags sigs   -- SPECIALISE prags for imported Ids

        ; let { tcg_env' = tcg_env { tcg_binds = foldr (unionBags . snd)
                                                       (tcg_binds tcg_env)
                                                       binds'
                                   , tcg_imp_specs = specs ++ tcg_imp_specs tcg_env } }

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

178 179 180 181 182 183
tcTopBinds (ValBindsIn {}) = panic "tcTopBinds"

tcRecSelBinds :: HsValBinds Name -> TcM TcGblEnv
tcRecSelBinds (ValBindsOut binds sigs)
  = tcExtendGlobalValEnv [sel_id | L _ (IdSig sel_id) <- sigs] $
    do { (rec_sel_binds, tcg_env) <- discardWarnings (tcValBinds TopLevel binds sigs getGblEnv)
184
       ; let tcg_env'
185
              | isHsBootOrSig (tcg_src tcg_env) = tcg_env
186 187 188
              | otherwise = tcg_env { tcg_binds = foldr (unionBags . snd)
                                                        (tcg_binds tcg_env)
                                                        rec_sel_binds }
189
              -- Do not add the code for record-selector bindings when
190 191 192
              -- compiling hs-boot files
       ; return tcg_env' }
tcRecSelBinds (ValBindsIn {}) = panic "tcRecSelBinds"
193

194
tcHsBootSigs :: HsValBinds Name -> TcM [Id]
195 196
-- A hs-boot file has only one BindGroup, and it only has type
-- signatures in it.  The renamer checked all this
197
tcHsBootSigs (ValBindsOut binds sigs)
Ian Lynagh's avatar
Ian Lynagh committed
198
  = do  { checkTc (null binds) badBootDeclErr
199
        ; concat <$> mapM (addLocM tc_boot_sig) (filter isTypeLSig sigs) }
200
  where
thomasw's avatar
thomasw committed
201
    tc_boot_sig (TypeSig lnames ty _) = mapM f lnames
202
      where
203
        f (L _ name) = do  { sigma_ty <- tcHsSigType (FunSigCtxt name True) ty
204
                           ; return (mkVanillaGlobal name sigma_ty) }
Ian Lynagh's avatar
Ian Lynagh committed
205
        -- Notice that we make GlobalIds, not LocalIds
Ian Lynagh's avatar
Ian Lynagh committed
206
    tc_boot_sig s = pprPanic "tcHsBootSigs/tc_boot_sig" (ppr s)
207
tcHsBootSigs groups = pprPanic "tcHsBootSigs" (ppr groups)
208

209
badBootDeclErr :: MsgDoc
Ian Lynagh's avatar
Ian Lynagh committed
210
badBootDeclErr = ptext (sLit "Illegal declarations in an hs-boot file")
211

212 213
------------------------
tcLocalBinds :: HsLocalBinds Name -> TcM thing
Ian Lynagh's avatar
Ian Lynagh committed
214
             -> TcM (HsLocalBinds TcId, thing)
sof's avatar
sof committed
215

216
tcLocalBinds EmptyLocalBinds thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
217 218
  = do  { thing <- thing_inside
        ; return (EmptyLocalBinds, thing) }
sof's avatar
sof committed
219

220 221 222 223
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"
224

225
tcLocalBinds (HsIPBinds (IPBinds ip_binds _)) thing_inside
226 227 228
  = do  { ipClass <- tcLookupClass ipClassName
        ; (given_ips, ip_binds') <-
            mapAndUnzipM (wrapLocSndM (tc_ip_bind ipClass)) ip_binds
229

230
        -- If the binding binds ?x = E, we  must now
Ian Lynagh's avatar
Ian Lynagh committed
231
        -- discharge any ?x constraints in expr_lie
232
        -- See Note [Implicit parameter untouchables]
233
        ; (ev_binds, result) <- checkConstraints (IPSkol ips)
234
                                  [] given_ips thing_inside
235 236

        ; return (HsIPBinds (IPBinds ip_binds' ev_binds), result) }
237
  where
238
    ips = [ip | L _ (IPBind (Left ip) _) <- ip_binds]
239

Ian Lynagh's avatar
Ian Lynagh committed
240 241 242
        -- I wonder if we should do these one at at time
        -- Consider     ?x = 4
        --              ?y = ?x + 1
243
    tc_ip_bind ipClass (IPBind (Left ip) expr)
244
       = do { ty <- newFlexiTyVarTy openTypeKind
245 246
            ; let p = mkStrLitTy $ hsIPNameFS ip
            ; ip_id <- newDict ipClass [ p, ty ]
247
            ; expr' <- tcMonoExpr expr ty
248 249 250 251 252 253 254 255
            ; 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
    toDict ipClass x ty =
      case unwrapNewTyCon_maybe (classTyCon ipClass) of
Joachim Breitner's avatar
Joachim Breitner committed
256
        Just (_,_,ax) -> HsWrap $ mkWpCast $ mkTcSymCo $ mkTcUnbranchedAxInstCo Representational ax [x,ty]
257 258
        Nothing       -> panic "The dictionary for `IP` is not a newtype?"

Austin Seipp's avatar
Austin Seipp committed
259
{-
260 261 262 263 264 265 266
Note [Implicit parameter untouchables]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
267
doesn't float that solved constraint out (it's not an unsolved
268
wanted).  Result disaster: the (Num alpha) is again solved, this
269 270
time by defaulting.  No no no.

271
However [Oct 10] this is all handled automatically by the
272 273
untouchable-range idea.

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
Note [Placeholder PatSyn kinds]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider this (Trac #9161)

  {-# LANGUAGE PatternSynonyms, DataKinds #-}
  pattern A = ()
  b :: A
  b = undefined

Here, the type signature for b mentions A.  But A is a pattern
synonym, which is typechecked (for very good reasons; a view pattern
in the RHS may mention a value binding) as part of a group of
bindings.  It is entirely resonable to reject this, but to do so
we need A to be in the kind environment when kind-checking the signature for B.

Hence the tcExtendKindEnv2 patsyn_placeholder_kinds, which adds a binding
    A -> AGlobal (AConLike (PatSynCon _|_))
to the environment. Then TcHsType.tcTyVar will find A in the kind environment,
and will give a 'wrongThingErr' as a result.  But the lookup of A won't fail.

The _|_ (= panic "fakePatSynCon") works because the wrongThingErr call, in
tcTyVar, doesn't look inside the TcTyThing.
Austin Seipp's avatar
Austin Seipp committed
296
-}
297

298
tcValBinds :: TopLevelFlag
299 300
           -> [(RecFlag, LHsBinds Name)] -> [LSig Name]
           -> TcM thing
301
           -> TcM ([(RecFlag, LHsBinds TcId)], thing)
302

303
tcValBinds top_lvl binds sigs thing_inside
304
  = do  {  -- Typecheck the signature
thomasw's avatar
thomasw committed
305 306 307
        ; (poly_ids, sig_fn, nwc_tvs) <- tcExtendKindEnv2 patsyn_placeholder_kinds $
                                         -- See Note [Placeholder PatSyn kinds]
                                         tcTySigs sigs
Ian Lynagh's avatar
Ian Lynagh committed
308

309
        ; let prag_fn = mkPragFun sigs (foldr (unionBags . snd) emptyBag binds)
Ian Lynagh's avatar
Ian Lynagh committed
310

311
                -- Extend the envt right away with all
Ian Lynagh's avatar
Ian Lynagh committed
312
                -- the Ids declared with type signatures
thomasw's avatar
thomasw committed
313 314
                -- Use tcExtendIdEnv3 to avoid extending the TcIdBinder stack
        ; tcExtendIdEnv3 [(idName id, id) | id <- poly_ids] (mkVarSet nwc_tvs) $ do
315 316
            { (binds', (extra_binds', thing)) <- tcBindGroups top_lvl sig_fn prag_fn binds $ do
                   { thing <- thing_inside
317
                     -- See Note [Pattern synonym wrappers don't yield dependencies]
318
                   ; patsyn_workers <- mapM tcPatSynBuilderBind patsyns
319
                   ; let extra_binds = [ (NonRecursive, worker) | worker <- patsyn_workers ]
320 321
                   ; return (extra_binds, thing) }
             ; return (binds' ++ extra_binds', thing) }}
322
  where
323 324
    patsyns
      = [psb | (_, lbinds) <- binds, L _ (PatSynBind psb) <- bagToList lbinds]
325
    patsyn_placeholder_kinds -- See Note [Placeholder PatSyn kinds]
326
      = [(name, placeholder_patsyn_tything)| PSB{ psb_id = L _ name } <- patsyns ]
327
    placeholder_patsyn_tything
328
      = AGlobal $ AConLike $ PatSynCon $ panic "fakePatSynCon"
329

330
------------------------
331
tcBindGroups :: TopLevelFlag -> TcSigFun -> PragFun
Ian Lynagh's avatar
Ian Lynagh committed
332 333
             -> [(RecFlag, LHsBinds Name)] -> TcM thing
             -> TcM ([(RecFlag, LHsBinds TcId)], thing)
334 335
-- Typecheck a whole lot of value bindings,
-- one strongly-connected component at a time
336
-- Here a "strongly connected component" has the strightforward
337
-- meaning of a group of bindings that mention each other,
338
-- ignoring type signatures (that part comes later)
339

340
tcBindGroups _ _ _ [] thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
341 342
  = do  { thing <- thing_inside
        ; return ([], thing) }
343

344
tcBindGroups top_lvl sig_fn prag_fn (group : groups) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
345
  = do  { (group', (groups', thing))
346
                <- tc_group top_lvl sig_fn prag_fn group $
347
                   tcBindGroups top_lvl sig_fn prag_fn groups thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
348
        ; return (group' ++ groups', thing) }
sof's avatar
sof committed
349

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

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

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

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

386
    sccs :: [SCC (LHsBind Name)]
387 388
    sccs = stronglyConnCompFromEdgedVertices (mkEdges sig_fn binds)

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

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

399
    tc_sub_group = tcPolyBinds top_lvl sig_fn prag_fn Recursive
sof's avatar
sof committed
400

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

tc_single :: forall thing.
            TopLevelFlag -> TcSigFun -> PragFun
413
          -> LHsBind Name -> TcM thing
cactus's avatar
cactus committed
414
          -> TcM (LHsBinds TcId, thing)
415 416
tc_single _top_lvl sig_fn _prag_fn (L _ (PatSynBind psb@PSB{ psb_id = L _ name })) thing_inside
  = do { (pat_syn, aux_binds) <- tc_pat_syn_decl
cactus's avatar
cactus committed
417
       ; let tything = AConLike (PatSynCon pat_syn)
418
       ; thing <- tcExtendGlobalEnv [tything] thing_inside
cactus's avatar
cactus committed
419 420
       ; return (aux_binds, thing)
       }
421 422
  where
    tc_pat_syn_decl = case sig_fn name of
423
        Nothing                  -> tcInferPatSynDecl psb
424
        Just (TcPatSynInfo tpsi) -> tcCheckPatSynDecl psb tpsi
425
        Just                  _  -> panic "tc_single"
426

cactus's avatar
cactus committed
427 428 429 430 431 432
tc_single top_lvl sig_fn prag_fn lbind thing_inside
  = do { (binds1, ids, closed) <- tcPolyBinds top_lvl sig_fn prag_fn
                                    NonRecursive NonRecursive
                                    [lbind]
       ; thing <- tcExtendLetEnv top_lvl closed ids thing_inside
       ; return (binds1, thing) }
433

thomasw's avatar
thomasw committed
434 435 436 437 438
-- | No signature or a partial signature
noCompleteSig :: Maybe TcSigInfo -> Bool
noCompleteSig Nothing    = True
noCompleteSig (Just sig) = isPartialSig sig

439
------------------------
440
mkEdges :: TcSigFun -> LHsBinds Name -> [Node BKey (LHsBind Name)]
441

442
type BKey = Int -- Just number off the bindings
443 444

mkEdges sig_fn binds
445
  = [ (bind, key, [key | n <- nameSetElems (bind_fvs (unLoc bind)),
Ian Lynagh's avatar
Ian Lynagh committed
446
                         Just key <- [lookupNameEnv key_map n], no_sig n ])
447 448 449 450
    | (bind, key) <- keyd_binds
    ]
  where
    no_sig :: Name -> Bool
thomasw's avatar
thomasw committed
451
    no_sig n = noCompleteSig (sig_fn n)
452 453 454

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

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

459
------------------------
460
tcPolyBinds :: TopLevelFlag -> TcSigFun -> PragFun
461 462 463 464
            -> RecFlag         -- Whether the group is really recursive
            -> RecFlag         -- Whether it's recursive after breaking
                               -- dependencies based on type signatures
            -> [LHsBind Name]  -- None are PatSynBind
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
465
            -> TcM (LHsBinds TcId, [TcId], TopLevelFlag)
466

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

478 479
tcPolyBinds top_lvl sig_fn prag_fn rec_group rec_tc bind_list
  = setSrcSpan loc                              $
480
    recoverM (recoveryCode binder_names sig_fn) $ do
481
        -- Set up main recover; take advantage of any type sigs
482

483
    { traceTc "------------------------------------------------" Outputable.empty
484
    ; traceTc "Bindings for {" (ppr binder_names)
485
    ; dflags   <- getDynFlags
486
    ; type_env <- getLclTypeEnv
487
    ; let plan = decideGeneralisationPlan dflags type_env
488
                         binder_names bind_list sig_fn
489
    ; traceTc "Generalisation plan" (ppr plan)
490
    ; result@(tc_binds, poly_ids, _) <- case plan of
cactus's avatar
cactus committed
491 492 493
         NoGen               -> tcPolyNoGen rec_tc prag_fn sig_fn bind_list
         InferGen mn cl      -> tcPolyInfer rec_tc prag_fn sig_fn mn cl bind_list
         CheckGen lbind sig  -> tcPolyCheck rec_tc prag_fn sig lbind
494

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

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

511
------------------
512
tcPolyNoGen     -- No generalisation whatsoever
513
  :: RecFlag       -- Whether it's recursive after breaking
514
                   -- dependencies based on type signatures
515
  -> PragFun -> TcSigFun
516
  -> [LHsBind Name]
517
  -> TcM (LHsBinds TcId, [TcId], TopLevelFlag)
518

519 520
tcPolyNoGen rec_tc prag_fn tc_sig_fn bind_list
  = do { (binds', mono_infos) <- tcMonoBinds rec_tc tc_sig_fn
521
                                             (LetGblBndr prag_fn)
522
                                             bind_list
523
       ; mono_ids' <- mapM tc_mono_info mono_infos
524
       ; return (binds', mono_ids', NotTopLevel) }
525 526
  where
    tc_mono_info (name, _, mono_id)
527
      = do { mono_ty' <- zonkTcType (idType mono_id)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
528
             -- Zonk, mainly to expose unboxed types to checkStrictBinds
529
           ; let mono_id' = setIdType mono_id mono_ty'
530
           ; _specs <- tcSpecPrags mono_id' (prag_fn name)
531
           ; return mono_id' }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
532 533 534 535
           -- 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
536 537

------------------
538
tcPolyCheck :: RecFlag       -- Whether it's recursive after breaking
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
539
                             -- dependencies based on type signatures
540 541
            -> PragFun
            -> TcSigInfo
542
            -> LHsBind Name
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
543
            -> TcM (LHsBinds TcId, [TcId], TopLevelFlag)
544
-- There is just one binding,
545 546
--   it binds a single variable,
--   it has a signature,
547
tcPolyCheck rec_tc prag_fn
548
            sig@(TcSigInfo { sig_id = poly_id, sig_tvs = tvs_w_scoped
thomasw's avatar
thomasw committed
549
                           , sig_nwcs = sig_nwcs, sig_theta = theta
550 551
                           , sig_tau = tau, sig_loc = loc
                           , sig_warn_redundant = warn_redundant })
552
            bind
thomasw's avatar
thomasw committed
553 554
  = ASSERT( null sig_nwcs ) -- We should be in tcPolyInfer if there are wildcards
    do { ev_vars <- newEvVars theta
555 556
       ; let ctxt      = FunSigCtxt (idName poly_id) warn_redundant
             skol_info = SigSkol ctxt (mkPhiTy theta tau)
557
             prag_sigs = prag_fn (idName poly_id)
558
             tvs = map snd tvs_w_scoped
559 560
       ; (ev_binds, (binds', [mono_info]))
            <- setSrcSpan loc $
561
               checkConstraints skol_info tvs ev_vars $
cactus's avatar
cactus committed
562
               tcMonoBinds rec_tc (\_ -> Just sig) LetLclBndr [bind]
563

564 565
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
566

567 568 569 570 571
       ; let (_, _, mono_id) = mono_info
             export = ABE { abe_wrap = idHsWrapper
                          , abe_poly = poly_id
                          , abe_mono = mono_id
                          , abe_prags = SpecPrags spec_prags }
572
             abs_bind = L loc $ AbsBinds
573
                        { abs_tvs = tvs
574
                        , abs_ev_vars = ev_vars, abs_ev_binds = [ev_binds]
575
                        , abs_exports = [export], abs_binds = binds' }
576 577
             closed | isEmptyVarSet (tyVarsOfType (idType poly_id)) = TopLevel
                    | otherwise                                     = NotTopLevel
578
       ; return (unitBag abs_bind, [poly_id], closed) }
579

580 581 582
tcPolyCheck _rec_tc _prag_fn sig _bind
  = pprPanic "tcPolyCheck" (ppr sig)

583
------------------
584
tcPolyInfer
585
  :: RecFlag       -- Whether it's recursive after breaking
586
                   -- dependencies based on type signatures
587
  -> PragFun -> TcSigFun
588 589
  -> Bool         -- True <=> apply the monomorphism restriction
  -> Bool         -- True <=> free vars have closed types
590
  -> [LHsBind Name]
591
  -> TcM (LHsBinds TcId, [TcId], TopLevelFlag)
592
tcPolyInfer rec_tc prag_fn tc_sig_fn mono closed bind_list
593 594
  = do { ((binds', mono_infos), tclvl, wanted)
             <- pushLevelAndCaptureConstraints  $
595
                tcMonoBinds rec_tc tc_sig_fn LetLclBndr bind_list
596

597
       ; let name_taus = [(name, idType mono_id) | (name, _, mono_id) <- mono_infos]
598
       ; traceTc "simplifyInfer call" (ppr name_taus $$ ppr wanted)
599
       ; (qtvs, givens, mr_bites, ev_binds)
600
                 <- simplifyInfer tclvl mono name_taus wanted
601

thomasw's avatar
thomasw committed
602 603 604 605
       ; inferred_theta  <- zonkTcThetaType (map evVarPred givens)
       ; exports <- checkNoErrs $ mapM (mkExport prag_fn qtvs inferred_theta)
                                       mono_infos

606
       ; loc <- getSrcSpanM
607
       ; let poly_ids = map abe_poly exports
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
608 609
             final_closed | closed && not mr_bites = TopLevel
                          | otherwise              = NotTopLevel
610
             abs_bind = L loc $
611
                        AbsBinds { abs_tvs = qtvs
612
                                 , abs_ev_vars = givens, abs_ev_binds = [ev_binds]
613
                                 , abs_exports = exports, abs_binds = binds' }
614

Simon Peyton Jones's avatar
Simon Peyton Jones committed
615 616
       ; traceTc "Binding:" (ppr final_closed $$
                             ppr (poly_ids `zip` map idType poly_ids))
617
       ; return (unitBag abs_bind, poly_ids, final_closed) }
618
         -- poly_ids are guaranteed zonked by mkExport
619 620

--------------
621
mkExport :: PragFun
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
622
         -> [TyVar] -> TcThetaType      -- Both already zonked
Ian Lynagh's avatar
Ian Lynagh committed
623
         -> MonoBindInfo
624
         -> TcM (ABExport Id)
625 626 627 628
-- Only called for generalisation plan IferGen, not by CheckGen or NoGen
--
-- mkExport generates exports with
--      zonked type variables,
Ian Lynagh's avatar
Ian Lynagh committed
629
--      zonked poly_ids
630 631 632 633
-- 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
634
-- type environment; see the invariant on TcEnv.tcExtendIdEnv
635

636
-- Pre-condition: the qtvs and theta are already zonked
637

thomasw's avatar
thomasw committed
638
mkExport prag_fn qtvs inferred_theta (poly_name, mb_sig, mono_id)
639
  = do  { mono_ty <- zonkTcType (idType mono_id)
640

641
        ; poly_id <- case mb_sig of
thomasw's avatar
thomasw committed
642 643 644 645 646 647 648
              Nothing -> mkInferredPolyId poly_name qtvs inferred_theta mono_ty
              Just (TcPatSynInfo _) -> panic "mkExport"
              Just sig | isPartialSig sig
                       -> do { final_theta <- completeTheta inferred_theta sig
                             ; mkInferredPolyId poly_name qtvs final_theta mono_ty }
                       | otherwise
                       -> return (sig_id sig)
649 650

        -- NB: poly_id has a zonked type
651
        ; poly_id <- addInlinePrags poly_id prag_sigs
652
        ; spec_prags <- tcSpecPrags poly_id prag_sigs
Ian Lynagh's avatar
Ian Lynagh committed
653
                -- tcPrags requires a zonked poly_id
654

thomasw's avatar
thomasw committed
655
        ; let sel_poly_ty = mkSigmaTy qtvs inferred_theta mono_ty
656
        ; traceTc "mkExport: check sig"
thomasw's avatar
thomasw committed
657
                  (vcat [ ppr poly_name, ppr sel_poly_ty, ppr (idType poly_id) ])
658

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
659 660 661
        -- Perform the impedence-matching and ambiguity check
        -- right away.  If it fails, we want to fail now (and recover
        -- in tcPolyBinds).  If we delay checking, we get an error cascade.
662
        -- Remember we are in the tcPolyInfer case, so the type envt is
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
663 664
        -- closed (unless we are doing NoMonoLocalBinds in which case all bets
        -- are off)
665
        -- See Note [Impedence matching]
666
        ; (wrap, wanted) <- addErrCtxtM (mk_bind_msg inferred True poly_name (idType poly_id)) $
667
                            captureConstraints $
668
                            tcSubType_NC sig_ctxt sel_poly_ty (idType poly_id)
669
        ; ev_binds <- simplifyTop wanted
670 671 672 673 674

        ; return (ABE { abe_wrap = mkWpLet (EvBinds ev_binds) <.> wrap
                      , abe_poly = poly_id
                      , abe_mono = mono_id
                      , abe_prags = SpecPrags spec_prags }) }
675
  where
676 677 678
    inferred = isNothing mb_sig
    prag_sigs = prag_fn poly_name
    sig_ctxt  = InfSigCtxt poly_name
679 680 681 682 683 684

mkInferredPolyId :: Name -> [TyVar] -> TcThetaType -> TcType -> TcM Id
-- In the inference case (no signature) this stuff figures out
-- the right type variables and theta to quantify over
-- See Note [Validity of inferred types]
mkInferredPolyId poly_name qtvs theta mono_ty
685 686 687
  = do { fam_envs <- tcGetFamInstEnvs

       ; let (_co, norm_mono_ty) = normaliseType fam_envs Nominal mono_ty
688 689
               -- Unification may not have normalised the type,
               -- (see Note [Lazy flattening] in TcFlatten) so do it
690 691 692
               -- here to make it as uncomplicated as possible.
               -- Example: f :: [F Int] -> Bool
               -- should be rewritten to f :: [Char] -> Bool, if possible
693

694
             my_tvs2 = closeOverKinds (growThetaTyVars theta (tyVarsOfType norm_mono_ty))
695
                  -- Include kind variables!  Trac #7916
696

697 698 699 700 701 702
             my_tvs   = filter (`elemVarSet` my_tvs2) qtvs   -- Maintain original order
             my_theta = filter (quantifyPred my_tvs2) theta
             inferred_poly_ty = mkSigmaTy my_tvs my_theta norm_mono_ty

       ; addErrCtxtM (mk_bind_msg True False poly_name inferred_poly_ty) $
         checkValidType (InfSigCtxt poly_name) inferred_poly_ty
703

704
       ; return (mkLocalId poly_name inferred_poly_ty) }
705 706 707

mk_bind_msg :: Bool -> Bool -> Name -> TcType -> TidyEnv -> TcM (TidyEnv, SDoc)
mk_bind_msg inferred want_ambig poly_name poly_ty tidy_env
708 709
 = do { (tidy_env', tidy_ty) <- zonkTidyTcType tidy_env poly_ty
      ; return (tidy_env', mk_msg tidy_ty) }
710
 where
711 712 713 714 715
   mk_msg ty = vcat [ ptext (sLit "When checking that") <+> quotes (ppr poly_name)
                      <+> ptext (sLit "has the") <+> what <+> ptext (sLit "type")
                    , nest 2 (ppr poly_name <+> dcolon <+> ppr ty)
                    , ppWhen want_ambig $
                      ptext (sLit "Probable cause: the inferred type is ambiguous") ]
716 717
   what | inferred  = ptext (sLit "inferred")
        | otherwise = ptext (sLit "specified")
thomasw's avatar
thomasw committed
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738


-- | 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.
-- Returns the annotated constraints combined with the inferred constraints.
completeTheta :: TcThetaType -> TcSigInfo -> TcM TcThetaType
completeTheta _ (TcPatSynInfo _)
  = panic "Extra-constraints wildcard not supported in a pattern signature"
completeTheta inferred_theta
              sig@(TcSigInfo { sig_id = poly_id
                             , sig_extra_cts = mb_extra_cts
                             , sig_theta = annotated_theta })
  | Just loc <- mb_extra_cts
  = do { annotated_theta <- zonkTcThetaType annotated_theta
       ; let inferred_diff = minusList inferred_theta annotated_theta
             final_theta   = annotated_theta ++ inferred_diff
       ; partial_sigs      <- xoptM Opt_PartialTypeSignatures
       ; warn_partial_sigs <- woptM Opt_WarnPartialTypeSignatures
       ; msg <- mkLongErrAt loc (mk_msg inferred_diff partial_sigs) empty
       ; case partial_sigs of
739
           True | warn_partial_sigs -> reportWarning msg
thomasw's avatar
thomasw committed
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
                | otherwise         -> return ()
           False                    -> reportError msg
       ; return final_theta }

  | otherwise
  = zonkTcThetaType annotated_theta
    -- No extra-constraints wildcard means no extra constraints will be added
    -- to the context, so just return the possibly empty (zonked)
    -- annotated_theta.
  where
    pts_hint = text "To use the inferred type, enable PartialTypeSignatures"
    mk_msg inferred_diff suppress_hint
       = vcat [ hang ((text "Found hole") <+> quotes (char '_'))
                   2 (text "with inferred constraints:")
                      <+> pprTheta inferred_diff
              , if suppress_hint then empty else pts_hint
              , typeSigCtxt (idName poly_id) sig ]
757

Austin Seipp's avatar
Austin Seipp committed
758
{-
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
Note [Partial type signatures and generalisation]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When we have a partial type signature, like
   f :: _ -> Int
then we *always* use the InferGen plan, and hence tcPolyInfer.
We do this even for a local binding with -XMonoLocalBinds.
Reasons:
  * The TcSigInfo for 'f' has a unification variable for the '_',
    whose TcLevel is one level deeper than the current level.
    (See pushTcLevelM in tcTySig.)  But NoGen doesn't increase
    the TcLevel like InferGen, so we lose the level invariant.

  * The signature might be   f :: forall a. _ -> a
    so it really is polymorphic.  It's not clear what it would
    mean to use NoGen on this, and indeed the ASSERT in tcLhs,
    in the (Just sig) case, checks that if there is a signature
    then we are using LetLclBndr, and hence a nested AbsBinds with
    increased TcLevel

It might be possible to fix these difficulties somehow, but there
doesn't seem much point.  Indeed, adding a partial type signature is a
way to get per-binding inferred generalisation.

782 783
Note [Validity of inferred types]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
784
We need to check inferred type for validity, in case it uses language
785 786 787 788 789 790 791 792 793 794
extensions that are not turned on.  The principle is that if the user
simply adds the inferred type to the program source, it'll compile fine.
See #8883.

Examples that might fail:
 - an inferred theta that requires type equalities e.g. (F a ~ G b)
                                or multi-parameter type classes
 - an inferred type that includes unboxed tuples

However we don't do the ambiguity check (checkValidType omits it for
795
InfSigCtxt) because the impedence-matching stage, which follows
796 797 798 799 800
immediately, will do it and we don't want two error messages.
Moreover, because of the impedence matching stage, the ambiguity-check
suggestion of -XAllowAmbiguiousTypes will not work.


801 802 803 804 805 806 807 808 809 810
Note [Impedence matching]
~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
   f 0 x = x
   f n x = g [] (not x)

   g [] y = f 10 y
   g _  y = f 9  y

After typechecking we'll get
811 812
  f_mono_ty :: a -> Bool -> Bool
  g_mono_ty :: [b] -> Bool -> Bool
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
with constraints
  (Eq a, Num a)

Note that f is polymorphic in 'a' and g in 'b'; and these are not linked.
The types we really want for f and g are
   f :: forall a. (Eq a, Num a) => a -> Bool -> Bool
   g :: forall b. [b] -> Bool -> Bool

We can get these by "impedence matching":
   tuple :: forall a b. (Eq a, Num a) => (a -> Bool -> Bool, [b] -> Bool -> Bool)
   tuple a b d1 d1 = let ...bind f_mono, g_mono in (f_mono, g_mono)

   f a d1 d2 = case tuple a Any d1 d2 of (f, g) -> f
   g b = case tuple Integer b dEqInteger dNumInteger of (f,g) -> g

Suppose the shared quantified tyvars are qtvs and constraints theta.
829
Then we want to check that
830
   f's polytype  is more polymorphic than   forall qtvs. theta => f_mono_ty
831
and the proof is the impedence matcher.
832 833 834 835 836 837

Notice that the impedence matcher may do defaulting.  See Trac #7173.

It also cleverly does an ambiguity check; for example, rejecting
   f :: F a -> a
where F is a non-injective type function.
Austin Seipp's avatar
Austin Seipp committed
838
-}
839

840
type PragFun = Name -> [LSig Name]
841

842
mkPragFun :: [LSig Name] -> LHsBinds Name -> PragFun
843 844
mkPragFun sigs binds = \n -> lookupNameEnv prag_env n `orElse` []
  where
Icelandjack's avatar
Icelandjack committed
845
    prs = mapMaybe get_sig sigs
846 847 848 849 850 851 852

    get_sig :: LSig Name -> Maybe (Located Name, LSig Name)
    get_sig (L l (SpecSig nm ty inl)) = Just (nm, L l $ SpecSig  nm ty (add_arity nm inl))
    get_sig (L l (InlineSig nm inl))  = Just (nm, L l $ InlineSig nm   (add_arity nm inl))
    get_sig _                         = Nothing

    add_arity (L _ n) inl_prag   -- Adjust inl_sat field to match visible arity of function
853 854 855
      | Just ar <- lookupNameEnv ar_env n,
        Inline <- inl_inline inl_prag     = inl_prag { inl_sat = Just ar }
        -- add arity only for real INLINE pragmas, not INLINABLE