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

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

8
{-# LANGUAGE CPP, RankNTypes, ScopedTypeVariables #-}
9
{-# LANGUAGE FlexibleContexts #-}
10
{-# LANGUAGE TypeFamilies #-}
11

12
module TcBinds ( tcLocalBinds, tcTopBinds, tcRecSelBinds,
13
                 tcHsBootSigs, tcPolyCheck,
14
                 tcVectDecls, addTypecheckedBinds,
15 16
                 chooseInferredQuantifiers,
                 badBootDeclErr ) where
17

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

import Control.Monad
70 71

#include "HsVersions.h"
72

73 74 75 76 77 78
{- *********************************************************************
*                                                                      *
               A useful helper function
*                                                                      *
********************************************************************* -}

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

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

106
The real work is done by @tcBindWithSigsAndThen@.
107 108 109 110 111 112 113 114 115 116

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.

117 118 119
At the top-level the LIE is sure to contain nothing but constant
dictionaries, which we resolve at the module level.

120 121
Note [Polymorphic recursion]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122
The game plan for polymorphic recursion in the code above is
123 124

        * Bind any variable for which we have a type signature
125
          to an Id with a polymorphic type.  Then when type-checking
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
          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
178
-}
179

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

192 193 194 195 196 197 198 199 200
        ; complete_matches <- setEnvs (tcg_env, tcl_env) $ tcCompleteSigs sigs
        ; traceTc "complete_matches" (ppr binds $$ ppr sigs)
        ; traceTc "complete_matches" (ppr complete_matches)

        ; let { tcg_env' = tcg_env { tcg_imp_specs
                                      = specs ++ tcg_imp_specs tcg_env
                                   , tcg_complete_matches
                                      = complete_matches
                                          ++ tcg_complete_matches tcg_env }
201
                           `addTypecheckedBinds` map snd binds' }
202 203

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

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

-- Note [Typechecking Complete Matches]
-- Much like when a user bundled a pattern synonym, the result types of
-- all the constructors in the match pragma must be consistent.
--
-- If we allowed pragmas with inconsistent types then it would be
-- impossible to ever match every constructor in the list and so
-- the pragma would be useless.





-- This is only used in `tcCompleteSig`. We fold over all the conlikes,
-- this accumulator keeps track of the first `ConLike` with a concrete
-- return type. After fixing the return type, all other constructors with
-- a fixed return type must agree with this.
--
-- The fields of `Fixed` cache the first conlike and its return type so
-- that that we can compare all the other conlikes to it. The conlike is
-- stored for error messages.
--
-- `Nothing` in the case that the type is fixed by a type signature
data CompleteSigType = AcceptAny | Fixed (Maybe ConLike) TyCon

232
tcCompleteSigs  :: [LSig GhcRn] -> TcM [CompleteMatch]
233 234
tcCompleteSigs sigs =
  let
235
      doOne :: Sig GhcRn -> TcM (Maybe CompleteMatch)
236 237 238 239 240 241 242 243 244 245 246 247 248 249
      doOne c@(CompleteMatchSig _ lns mtc)
        = fmap Just $ do
           addErrCtxt (text "In" <+> ppr c) $
            case mtc of
              Nothing -> infer_complete_match
              Just tc -> check_complete_match tc
        where

          checkCLTypes acc = foldM checkCLType (acc, []) (unLoc lns)

          infer_complete_match = do
            (res, cls) <- checkCLTypes AcceptAny
            case res of
              AcceptAny -> failWithTc ambiguousError
250
              Fixed _ tc  -> return $ mkMatch cls tc
251 252 253 254

          check_complete_match tc_name = do
            ty_con <- tcLookupLocatedTyCon tc_name
            (_, cls) <- checkCLTypes (Fixed Nothing ty_con)
255 256 257 258 259 260 261
            return $ mkMatch cls ty_con

          mkMatch :: [ConLike] -> TyCon -> CompleteMatch
          mkMatch cls ty_con = CompleteMatch {
            completeMatchConLikes = map conLikeName cls,
            completeMatchTyCon = tyConName ty_con
            }
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 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
      doOne _ = return Nothing

      ambiguousError :: SDoc
      ambiguousError =
        text "A type signature must be provided for a set of polymorphic"
          <+> text "pattern synonyms."


      -- See note [Typechecking Complete Matches]
      checkCLType :: (CompleteSigType, [ConLike]) -> Located Name
                  -> TcM (CompleteSigType, [ConLike])
      checkCLType (cst, cs) n = do
        cl <- addLocM tcLookupConLike n
        let   (_,_,_,_,_,_, res_ty) = conLikeFullSig cl
              res_ty_con = fst <$> splitTyConApp_maybe res_ty
        case (cst, res_ty_con) of
          (AcceptAny, Nothing) -> return (AcceptAny, cl:cs)
          (AcceptAny, Just tc) -> return (Fixed (Just cl) tc, cl:cs)
          (Fixed mfcl tc, Nothing)  -> return (Fixed mfcl tc, cl:cs)
          (Fixed mfcl tc, Just tc') ->
            if tc == tc'
              then return (Fixed mfcl tc, cl:cs)
              else case mfcl of
                     Nothing ->
                      addErrCtxt (text "In" <+> ppr cl) $
                        failWithTc typeSigErrMsg
                     Just cl -> failWithTc (errMsg cl)
             where
              typeSigErrMsg :: SDoc
              typeSigErrMsg =
                text "Couldn't match expected type"
                      <+> quotes (ppr tc)
                      <+> text "with"
                      <+> quotes (ppr tc')

              errMsg :: ConLike -> SDoc
              errMsg fcl =
                text "Cannot form a group of complete patterns from patterns"
                  <+> quotes (ppr fcl) <+> text "and" <+> quotes (ppr cl)
                  <+> text "as they match different type constructors"
                  <+> parens (quotes (ppr tc)
                               <+> text "resp."
                               <+> quotes (ppr tc'))
  in  mapMaybeM (addLocM doOne) sigs

307
tcRecSelBinds :: HsValBinds GhcRn -> TcM TcGblEnv
308
tcRecSelBinds (ValBindsOut binds sigs)
309
  = tcExtendGlobalValEnv [sel_id | L _ (IdSig sel_id) <- sigs] $
310 311 312
    do { (rec_sel_binds, tcg_env) <- discardWarnings $
                                     tcValBinds TopLevel binds sigs getGblEnv
       ; let tcg_env' = tcg_env `addTypecheckedBinds` map snd rec_sel_binds
313 314
       ; return tcg_env' }
tcRecSelBinds (ValBindsIn {}) = panic "tcRecSelBinds"
315

316
tcHsBootSigs :: [(RecFlag, LHsBinds GhcRn)] -> [LSig GhcRn] -> TcM [Id]
317 318
-- A hs-boot file has only one BindGroup, and it only has type
-- signatures in it.  The renamer checked all this
319
tcHsBootSigs binds sigs
Ian Lynagh's avatar
Ian Lynagh committed
320
  = do  { checkTc (null binds) badBootDeclErr
321
        ; concat <$> mapM (addLocM tc_boot_sig) (filter isTypeLSig sigs) }
322
  where
323
    tc_boot_sig (TypeSig lnames hs_ty) = mapM f lnames
324
      where
325
        f (L _ name)
Richard Eisenberg's avatar
Richard Eisenberg committed
326
          = do { sigma_ty <- tcHsSigWcType (FunSigCtxt name False) hs_ty
327
               ; return (mkVanillaGlobal name sigma_ty) }
Ian Lynagh's avatar
Ian Lynagh committed
328
        -- Notice that we make GlobalIds, not LocalIds
Ian Lynagh's avatar
Ian Lynagh committed
329
    tc_boot_sig s = pprPanic "tcHsBootSigs/tc_boot_sig" (ppr s)
330

331
badBootDeclErr :: MsgDoc
332
badBootDeclErr = text "Illegal declarations in an hs-boot file"
333

334
------------------------
335 336
tcLocalBinds :: HsLocalBinds GhcRn -> TcM thing
             -> TcM (HsLocalBinds GhcTcId, thing)
sof's avatar
sof committed
337

338
tcLocalBinds EmptyLocalBinds thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
339 340
  = do  { thing <- thing_inside
        ; return (EmptyLocalBinds, thing) }
sof's avatar
sof committed
341

342 343 344 345
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"
346

347
tcLocalBinds (HsIPBinds (IPBinds ip_binds _)) thing_inside
348 349
  = do  { ipClass <- tcLookupClass ipClassName
        ; (given_ips, ip_binds') <-
350
            mapAndUnzipM (wrapLocSndM (tc_ip_bind ipClass)) ip_binds
351

352
        -- If the binding binds ?x = E, we  must now
Ian Lynagh's avatar
Ian Lynagh committed
353
        -- discharge any ?x constraints in expr_lie
354
        -- See Note [Implicit parameter untouchables]
355
        ; (ev_binds, result) <- checkConstraints (IPSkol ips)
356
                                  [] given_ips thing_inside
357 358

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

Ian Lynagh's avatar
Ian Lynagh committed
362 363 364
        -- I wonder if we should do these one at at time
        -- Consider     ?x = 4
        --              ?y = ?x + 1
Alan Zimmerman's avatar
Alan Zimmerman committed
365
    tc_ip_bind ipClass (IPBind (Left (L _ ip)) expr)
366
       = do { ty <- newOpenFlexiTyVarTy
367 368
            ; let p = mkStrLitTy $ hsIPNameFS ip
            ; ip_id <- newDict ipClass [ p, ty ]
369
            ; expr' <- tcMonoExpr expr (mkCheckExpType ty)
370 371 372 373 374 375
            ; 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
376
    toDict ipClass x ty = mkHsWrap $ mkWpCastR $
377
                          wrapIP $ mkClassPred ipClass [x,ty]
378

379 380
{- Note [Implicit parameter untouchables]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
381 382 383 384 385
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
386
doesn't float that solved constraint out (it's not an unsolved
387
wanted).  Result disaster: the (Num alpha) is again solved, this
388 389
time by defaulting.  No no no.

390
However [Oct 10] this is all handled automatically by the
391
untouchable-range idea.
Austin Seipp's avatar
Austin Seipp committed
392
-}
393

394
tcValBinds :: TopLevelFlag
395
           -> [(RecFlag, LHsBinds GhcRn)] -> [LSig GhcRn]
396
           -> TcM thing
397
           -> TcM ([(RecFlag, LHsBinds GhcTcId)], thing)
398

399
tcValBinds top_lvl binds sigs thing_inside
400 401 402 403
  = do  { let patsyns = getPatSynBinds binds

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

406 407
        ; let prag_fn = mkPragEnv sigs (foldr (unionBags . snd) emptyBag binds)

408 409 410 411
                -- 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
412
        ; tcExtendSigIds top_lvl poly_ids $ do
413 414
            { (binds', (extra_binds', thing)) <- tcBindGroups top_lvl sig_fn prag_fn binds $ do
                   { thing <- thing_inside
415
                     -- See Note [Pattern synonym builders don't yield dependencies]
416
                     --     in RnBinds
417
                   ; patsyn_builders <- mapM tcPatSynBuilderBind patsyns
418
                   ; let extra_binds = [ (NonRecursive, builder) | builder <- patsyn_builders ]
419
                   ; return (extra_binds, thing) }
420
            ; return (binds' ++ extra_binds', thing) }}
421

422
------------------------
423
tcBindGroups :: TopLevelFlag -> TcSigFun -> TcPragEnv
424 425
             -> [(RecFlag, LHsBinds GhcRn)] -> TcM thing
             -> TcM ([(RecFlag, LHsBinds GhcTcId)], thing)
426 427
-- Typecheck a whole lot of value bindings,
-- one strongly-connected component at a time
428
-- Here a "strongly connected component" has the strightforward
429
-- meaning of a group of bindings that mention each other,
430
-- ignoring type signatures (that part comes later)
431

432
tcBindGroups _ _ _ [] thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
433 434
  = do  { thing <- thing_inside
        ; return ([], thing) }
435

436
tcBindGroups top_lvl sig_fn prag_fn (group : groups) thing_inside
437
  = do  { -- See Note [Closed binder groups]
438 439
          type_env <- getLclTypeEnv
        ; let closed = isClosedBndrGroup type_env (snd group)
440 441
        ; (group', (groups', thing))
                <- tc_group top_lvl sig_fn prag_fn group closed $
442
                   tcBindGroups top_lvl sig_fn prag_fn groups thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
443
        ; return (group' ++ groups', thing) }
sof's avatar
sof committed
444

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
-- 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.
--

462
------------------------
463
tc_group :: forall thing.
464
            TopLevelFlag -> TcSigFun -> TcPragEnv
465 466
         -> (RecFlag, LHsBinds GhcRn) -> IsGroupClosed -> TcM thing
         -> TcM ([(RecFlag, LHsBinds GhcTcId)], thing)
467 468

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

472
tc_group top_lvl sig_fn prag_fn (NonRecursive, binds) closed thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
473 474
        -- A single non-recursive binding
        -- We want to keep non-recursive things non-recursive
475
        -- so that we desugar unlifted bindings correctly
cactus's avatar
cactus committed
476 477
  = do { let bind = case bagToList binds of
                 [bind] -> bind
478 479
                 []     -> panic "tc_group: empty list of binds"
                 _      -> panic "tc_group: NonRecursive binds is not a singleton bag"
480 481
       ; (bind', thing) <- tc_single top_lvl sig_fn prag_fn bind closed
                                     thing_inside
cactus's avatar
cactus committed
482
       ; return ( [(NonRecursive, bind')], thing) }
483

484
tc_group top_lvl sig_fn prag_fn (Recursive, binds) closed thing_inside
485 486
  =     -- To maximise polymorphism, we do a new
        -- strongly-connected-component analysis, this time omitting
Ian Lynagh's avatar
Ian Lynagh committed
487
        -- any references to variables with type signatures.
488
        -- (This used to be optional, but isn't now.)
489
        -- See Note [Polymorphic recursion] in HsBinds.
490
    do  { traceTc "tc_group rec" (pprLHsBinds binds)
cactus's avatar
cactus committed
491
        ; when hasPatSyn $ recursivePatSynErr binds
492
        ; (binds1, thing) <- go sccs
493
        ; return ([(Recursive, binds1)], thing) }
Ian Lynagh's avatar
Ian Lynagh committed
494
                -- Rec them all together
495
  where
496
    hasPatSyn = anyBag (isPatSyn . unLoc) binds
cactus's avatar
cactus committed
497 498 499
    isPatSyn PatSynBind{} = True
    isPatSyn _ = False

500
    sccs :: [SCC (LHsBind GhcRn)]
niteria's avatar
niteria committed
501
    sccs = stronglyConnCompFromEdgedVerticesUniq (mkEdges sig_fn binds)
502

503
    go :: [SCC (LHsBind GhcRn)] -> TcM (LHsBinds GhcTcId, thing)
504
    go (scc:sccs) = do  { (binds1, ids1) <- tc_scc scc
505 506 507
                        ; (binds2, thing) <- tcExtendLetEnv top_lvl sig_fn
                                                            closed ids1 $
                                             go sccs
508 509
                        ; return (binds1 `unionBags` binds2, thing) }
    go []         = do  { thing <- thing_inside; return (emptyBag, thing) }
510

511 512
    tc_scc (AcyclicSCC bind) = tc_sub_group NonRecursive [bind]
    tc_scc (CyclicSCC binds) = tc_sub_group Recursive    binds
sof's avatar
sof committed
513

514
    tc_sub_group rec_tc binds =
515
      tcPolyBinds sig_fn prag_fn Recursive rec_tc closed binds
sof's avatar
sof committed
516

517
recursivePatSynErr :: OutputableBndrId name => LHsBinds name -> TcM a
cactus's avatar
cactus committed
518 519
recursivePatSynErr binds
  = failWithTc $
520
    hang (text "Recursive pattern synonym definition with following bindings:")
521
       2 (vcat $ map pprLBind . bagToList $ binds)
cactus's avatar
cactus committed
522
  where
523
    pprLoc loc  = parens (text "defined at" <+> ppr loc)
cactus's avatar
cactus committed
524 525 526 527
    pprLBind (L loc bind) = pprWithCommas ppr (collectHsBindBinders bind) <+>
                            pprLoc loc

tc_single :: forall thing.
528
            TopLevelFlag -> TcSigFun -> TcPragEnv
529 530
          -> LHsBind GhcRn -> IsGroupClosed -> TcM thing
          -> TcM (LHsBinds GhcTcId, thing)
531 532 533
tc_single _top_lvl sig_fn _prag_fn
          (L _ (PatSynBind psb@PSB{ psb_id = L _ name }))
          _ thing_inside
534 535
  = do { (aux_binds, tcg_env) <- tc_pat_syn_decl
       ; thing <- setGblEnv tcg_env thing_inside
cactus's avatar
cactus committed
536 537
       ; return (aux_binds, thing)
       }
538
  where
539
    tc_pat_syn_decl :: TcM (LHsBinds GhcTcId, TcGblEnv)
540
    tc_pat_syn_decl = case sig_fn name of
541 542 543
        Nothing                 -> tcInferPatSynDecl psb
        Just (TcPatSynSig tpsi) -> tcCheckPatSynDecl psb tpsi
        Just                 _  -> panic "tc_single"
544

545
tc_single top_lvl sig_fn prag_fn lbind closed thing_inside
546
  = do { (binds1, ids) <- tcPolyBinds sig_fn prag_fn
547
                                      NonRecursive NonRecursive
548
                                      closed
549
                                      [lbind]
550
       ; thing <- tcExtendLetEnv top_lvl sig_fn closed ids thing_inside
cactus's avatar
cactus committed
551
       ; return (binds1, thing) }
552

553
------------------------
554
type BKey = Int -- Just number off the bindings
555

556
mkEdges :: TcSigFun -> LHsBinds GhcRn -> [Node BKey (LHsBind GhcRn)]
557
-- See Note [Polymorphic recursion] in HsBinds.
558
mkEdges sig_fn binds
559 560
  = [ DigraphNode bind key [key | n <- nonDetEltsUniqSet (bind_fvs (unLoc bind)),
                         Just key <- [lookupNameEnv key_map n], no_sig n ]
561 562
    | (bind, key) <- keyd_binds
    ]
niteria's avatar
niteria committed
563 564 565
    -- 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.
566 567
  where
    no_sig :: Name -> Bool
568
    no_sig n = not (hasCompleteSig sig_fn n)
569 570 571

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

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

576
------------------------
577
tcPolyBinds :: TcSigFun -> TcPragEnv
578 579 580
            -> RecFlag         -- Whether the group is really recursive
            -> RecFlag         -- Whether it's recursive after breaking
                               -- dependencies based on type signatures
581
            -> IsGroupClosed   -- Whether the group is closed
582 583
            -> [LHsBind GhcRn]  -- None are PatSynBind
            -> TcM (LHsBinds GhcTcId, [TcId])
584

585
-- Typechecks a single bunch of values bindings all together,
586 587 588
-- and generalises them.  The bunch may be only part of a recursive
-- group, because we use type signatures to maximise polymorphism
--
589 590
-- Returns a list because the input may be a single non-recursive binding,
-- in which case the dependency order of the resulting bindings is
591 592
-- important.
--
593
-- Knows nothing about the scope of the bindings
594
-- None of the bindings are pattern synonyms
595

596
tcPolyBinds sig_fn prag_fn rec_group rec_tc closed bind_list
597
  = setSrcSpan loc                              $
598
    recoverM (recoveryCode binder_names sig_fn) $ do
599
        -- Set up main recover; take advantage of any type sigs
600

601
    { traceTc "------------------------------------------------" Outputable.empty
602
    ; traceTc "Bindings for {" (ppr binder_names)
603
    ; dflags   <- getDynFlags
604
    ; let plan = decideGeneralisationPlan dflags bind_list closed sig_fn
605
    ; traceTc "Generalisation plan" (ppr plan)
606
    ; result@(_, poly_ids) <- case plan of
607 608
         NoGen              -> tcPolyNoGen rec_tc prag_fn sig_fn bind_list
         InferGen mn        -> tcPolyInfer rec_tc prag_fn sig_fn mn bind_list
609
         CheckGen lbind sig -> tcPolyCheck prag_fn sig lbind
610

611 612 613
    ; traceTc "} End of bindings for" (vcat [ ppr binder_names, ppr rec_group
                                            , vcat [ppr id <+> ppr (idType id) | id <- poly_ids]
                                          ])
614

615
    ; return result }
616
  where
617 618
    binder_names = collectHsBindListBinders bind_list
    loc = foldr1 combineSrcSpans (map getLoc bind_list)
619
         -- The mbinds have been dependency analysed and
620
         -- may no longer be adjacent; so find the narrowest
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
621
         -- span that includes them all
622

623 624 625 626
--------------
-- If typechecking the binds fails, then return with each
-- signature-less binder given type (forall a.a), to minimise
-- subsequent error messages
627
recoveryCode :: [Name] -> TcSigFun -> TcM (LHsBinds GhcTcId, [Id])
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
recoveryCode binder_names sig_fn
  = do  { traceTc "tcBindsWithSigs: error recovery" (ppr binder_names)
        ; let poly_ids = map mk_dummy binder_names
        ; return (emptyBag, poly_ids) }
  where
    mk_dummy name
      | Just sig <- sig_fn name
      , Just poly_id <- completeSigPolyId_maybe sig
      = poly_id
      | otherwise
      = mkLocalId name forall_a_a

forall_a_a :: TcType
forall_a_a = mkSpecForAllTys [runtimeRep1TyVar, openAlphaTyVar] openAlphaTy

{- *********************************************************************
*                                                                      *
                         tcPolyNoGen
*                                                                      *
********************************************************************* -}

649
tcPolyNoGen     -- No generalisation whatsoever
650
  :: RecFlag       -- Whether it's recursive after breaking
651
                   -- dependencies based on type signatures
652
  -> TcPragEnv -> TcSigFun
653 654
  -> [LHsBind GhcRn]
  -> TcM (LHsBinds GhcTcId, [TcId])
655

656 657
tcPolyNoGen rec_tc prag_fn tc_sig_fn bind_list
  = do { (binds', mono_infos) <- tcMonoBinds rec_tc tc_sig_fn
658
                                             (LetGblBndr prag_fn)
659
                                             bind_list
660
       ; mono_ids' <- mapM tc_mono_info mono_infos
661
       ; return (binds', mono_ids') }
662
  where
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
663
    tc_mono_info (MBI { mbi_poly_name = name, mbi_mono_id = mono_id })
664 665
      = do { _specs <- tcSpecPrags mono_id (lookupPragEnv prag_fn name)
           ; return mono_id }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
666 667 668 669
           -- 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
670

671 672 673 674 675 676 677 678 679

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

tcPolyCheck :: TcPragEnv
            -> TcIdSigInfo     -- Must be a complete signature
680 681
            -> LHsBind GhcRn   -- Must be a FunBind
            -> TcM (LHsBinds GhcTcId, [TcId])
682
-- There is just one binding,
683
--   it is a Funbind
Simon Peyton Jones's avatar
Simon Peyton Jones committed
684
--   it has a complete type signature,
685 686 687 688 689 690 691 692
tcPolyCheck prag_fn
            (CompleteSig { sig_bndr  = poly_id
                         , sig_ctxt  = ctxt
                         , sig_loc   = sig_loc })
            (L loc (FunBind { fun_id = L nm_loc name
                            , fun_matches = matches }))
  = setSrcSpan sig_loc $
    do { traceTc "tcPolyCheck" (ppr poly_id $$ ppr sig_loc)
693
       ; (tv_prs, theta, tau) <- tcInstType tcInstSkolTyVars poly_id
694 695 696 697 698
                -- See Note [Instantiate sig with fresh variables]

       ; mono_name <- newNameAt (nameOccName name) nm_loc
       ; ev_vars   <- newEvVars theta
       ; let mono_id   = mkLocalId mono_name tau
699
             skol_info = SigSkol ctxt (idType poly_id) tv_prs
700 701 702 703 704 705 706 707 708 709
             skol_tvs  = map snd tv_prs

       ; (ev_binds, (co_fn, matches'))
            <- checkConstraints skol_info skol_tvs ev_vars $
               tcExtendIdBndrs [TcIdBndr mono_id NotTopLevel]  $
               tcExtendTyVarEnv2 tv_prs $
               setSrcSpan loc           $
               tcMatchesFun (L nm_loc mono_name) matches (mkCheckExpType tau)

       ; let prag_sigs = lookupPragEnv prag_fn name
710 711
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
712

713
       ; mod <- getModule
714 715 716 717
       ; let bind' = FunBind { fun_id      = L nm_loc mono_id
                             , fun_matches = matches'
                             , fun_co_fn   = co_fn
                             , bind_fvs    = placeHolderNamesTc
718
                             , fun_tick    = funBindTicks nm_loc mono_id mod prag_sigs }
719

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
720
             abs_bind = L loc $ AbsBindsSig
721 722 723 724
                        { abs_sig_export  = poly_id
                        , abs_tvs         = skol_tvs
                        , abs_ev_vars     = ev_vars
                        , abs_sig_prags   = SpecPrags spec_prags
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
725
                        , abs_sig_ev_bind = ev_binds
726
                        , abs_sig_bind    = L loc bind' }
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
727

728
       ; return (unitBag abs_bind, [poly_id]) }
729

730 731 732
tcPolyCheck _prag_fn sig bind
  = pprPanic "tcPolyCheck" (ppr sig $$ ppr bind)

733 734
funBindTicks :: SrcSpan -> TcId -> Module -> [LSig GhcRn]
             -> [Tickish TcId]
735 736 737 738 739 740
funBindTicks loc fun_id mod sigs
  | (mb_cc_str : _) <- [ cc_name | L _ (SCCFunSig _ _ cc_name) <- sigs ]
      -- this can only be a singleton list, as duplicate pragmas are rejected
      -- by the renamer
  , let cc_str
          | Just cc_str <- mb_cc_str
741
          = sl_fs $ unLoc cc_str
742 743 744 745 746 747 748 749
          | otherwise
          = getOccFS (Var.varName fun_id)
        cc_name = moduleNameFS (moduleName mod) `appendFS` consFS '.' cc_str
        cc = mkUserCC cc_name mod loc (getUnique fun_id)
  = [ProfNote cc True True]
  | otherwise
  = []

750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
{- Note [Instantiate sig with fresh variables]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It's vital to instantiate a type signature with fresh variables.
For example:
      type T = forall a. [a] -> [a]
      f :: T;
      f = g where { g :: T; g = <rhs> }

 We must not use the same 'a' from the defn of T at both places!!
(Instantiation is only necessary because of type synonyms.  Otherwise,
it's all cool; each signature has distinct type variables from the renamer.)
-}


{- *********************************************************************
*                                                                      *
                         tcPolyInfer
*                                                                      *
********************************************************************* -}
769 770

tcPolyInfer
771
  :: RecFlag       -- Whether it's recursive after breaking
772
                   -- dependencies based on type signatures
773
  -> TcPragEnv -> TcSigFun
774
  -> Bool         -- True <=> apply the monomorphism restriction
775 776
  -> [LHsBind GhcRn]
  -> TcM (LHsBinds GhcTcId, [TcId])
777
tcPolyInfer rec_tc prag_fn tc_sig_fn mono bind_list
778
  = do { (tclvl, wanted, (binds', mono_infos))
779
             <- pushLevelAndCaptureConstraints  $
780 781
                tcMonoBinds rec_tc tc_sig_fn LetLclBndr bind_list

782 783 784 785
       ; let name_taus  = [ (mbi_poly_name info, idType (mbi_mono_id info))
                          | info <- mono_infos ]
             sigs       = [ sig | MBI { mbi_sig = Just sig } <- mono_infos ]
             infer_mode = if mono then ApplyMR else NoRestrictions
786

787 788
       ; mapM_ (checkOverloadedSig mono) sigs

789
       ; traceTc "simplifyInfer call" (ppr tclvl $$ ppr name_taus $$ ppr wanted)
790
       ; (qtvs, givens, ev_binds, insoluble)
791
                 <- simplifyInfer tclvl infer_mode sigs name_taus wanted
792

793
       ; let inferred_theta = map evVarPred givens
794
       ; exports <- checkNoErrs $
795
                    mapM (mkExport prag_fn insoluble qtvs inferred_theta) mono_infos
thomasw's avatar
thomasw committed
796

797
       ; loc <- getSrcSpanM
798
       ; let poly_ids = map abe_poly exports
799
             abs_bind = L loc $
800
                        AbsBinds { abs_tvs = qtvs
801
                                 , abs_ev_vars = givens, abs_ev_binds = [ev_binds]
802
                                 , abs_exports = exports, abs_binds = binds' }
803

804 805
       ; traceTc "Binding:" (ppr (poly_ids `zip` map idType poly_ids))
       ; return (unitBag abs_bind, poly_ids) }
806
         -- poly_ids are guaranteed zonked by mkExport
807 808

--------------
809
mkExport :: TcPragEnv
810 811
         -> Bool                        -- True <=> there was an insoluble type error
                                        --          when typechecking the bindings
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
812
         -> [TyVar] -> TcThetaType      -- Both already zonked
Ian Lynagh's avatar
Ian Lynagh committed
813
         -> MonoBindInfo
814
         -> TcM (ABExport GhcTc)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
815
-- Only called for generalisation plan InferGen, not by CheckGen or NoGen
816 817 818
--
-- mkExport generates exports with
--      zonked type variables,
Ian Lynagh's avatar
Ian Lynagh committed
819
--      zonked poly_ids
820 821 822 823
-- 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
824
-- type environment; see the invariant on TcEnv.tcExtendIdEnv
825

826
-- Pre-condition: the qtvs and theta are already zonked
827

828
mkExport prag_fn insoluble qtvs theta
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
829 830 831
         mono_info@(MBI { mbi_poly_name = poly_name
                        , mbi_sig       = mb_sig
                        , mbi_mono_id   = mono_id })
832
  = do  { mono_ty <- zonkTcType (idType mono_id)
833
        ; poly_id <- mkInferredPolyId insoluble qtvs theta poly_name mb_sig mono_ty
834 835

        -- NB: poly_id has a zonked type
836
        ; poly_id <- addInlinePrags poly_id prag_sigs
837
        ; spec_prags <- tcSpecPrags poly_id prag_sigs
Ian Lynagh's avatar
Ian Lynagh committed
838
                -- tcPrags requires a zonked poly_id
839

Gabor Greif's avatar
Gabor Greif committed
840
        -- See Note [Impedance matching]
841 842
        -- NB: we have already done checkValidType, including an ambiguity check,
        --     on the type; either when we checked the sig or in mkInferredPolyId
843
        ; let poly_ty     = idType poly_id
844
              sel_poly_ty = mkInfSigmaTy qtvs theta mono_ty
845
                -- This type is just going into tcSubType,
846
                -- so Inferred vs. Specified doesn't matter
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
847 848

        ; wrap <- if sel_poly_ty `eqType` poly_ty  -- NB: eqType ignores visibility
849
                  then return idHsWrapper  -- Fast path; also avoids complaint when we infer
850
                                           -- an ambiguous type and have AllowAmbiguousType
851
                                           -- e..g infer  x :: forall a. F a -> Int
Gabor Greif's avatar
Gabor Greif committed
852
                  else addErrCtxtM (mk_impedance_match_msg mono_info sel_poly_ty poly_ty) $
853
                       tcSubType_NC sig_ctxt sel_poly_ty poly_ty
854

manav's avatar
manav committed
855
        ; warn_missing_sigs <- woptM Opt_WarnMissingLocalSignatures
856 857
        ; when warn_missing_sigs $
              localSigWarn Opt_WarnMissingLocalSignatures poly_id mb_sig
858

859
        ; return (ABE { abe_wrap = wrap
860
                        -- abe_wrap :: idType poly_id ~ (forall qtvs. theta => mono_ty)
861 862
                      , abe_poly = poly_id
                      , abe_mono = mono_id
863
                      , abe_prags = SpecPrags spec_prags}) }
864
  where
865
    prag_sigs = lookupPragEnv prag_fn poly_name
866
    sig_ctxt  = InfSigCtxt poly_name
867

868 869 870
mkInferredPolyId :: Bool  -- True <=> there was an insoluble error when
                          --          checking the binding group for this Id
                 -> [TyVar] -> TcThetaType
871
                 -> Name -> Maybe TcIdSigInst -> TcType
872
                 -> TcM TcId
873
mkInferredPolyId insoluble qtvs inferred_theta poly_name mb_sig_inst mono_ty
874 875
  | Just (TISI { sig_inst_sig = sig })  <- mb_sig_inst
  , CompleteSig { sig_bndr = poly_id } <- sig
876 877 878 879
  = return poly_id

  | otherwise  -- Either no type sig or partial type sig
  = checkNoErrs $  -- The checkNoErrs ensures that if the type is ambiguous
Gabor Greif's avatar
Gabor Greif committed
880
                   -- we don't carry on to the impedance matching, and generate
881 882 883
                   -- a duplicate ambiguity error.  There is a similar
                   -- checkNoErrs for complete type signatures too.
    do { fam_envs <- tcGetFamInstEnvs
884
       ; let (_co, mono_ty') = normaliseType fam_envs Nominal mono_ty
885 886
               -- Unification may not have normalised the type,
               -- (see Note [Lazy flattening] in TcFlatten) so do it
887 888 889
               -- here to make it as uncomplicated as possible.
               -- Example: f :: [F Int] -> Bool
               -- should be rewritten to f :: [Char] -> Bool, if possible
890
               --
Gabor Greif's avatar
Gabor Greif committed
891
               -- We can discard the coercion _co, because we'll reconstruct
892
               -- it in the call to tcSubType below
893

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

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

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
899
       ; traceTc "mkInferredPolyId" (vcat [ppr poly_name, ppr qtvs, ppr theta'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
900
                                          , ppr inferred_poly_ty])
901 902
       ; unless insoluble $
         addErrCtxtM (mk_inf_msg poly_name inferred_poly_ty) $
903
         checkValidType (InfSigCtxt poly_name) inferred_poly_ty
904
         -- See Note [Validity of inferred types]
905 906 907
         -- If we found an insoluble error in the function definition, don't
         -- do this check; otherwise (Trac #14000) we may report an ambiguity
         -- error for a rather bogus type.
908

909
       ; return (mkLocalIdOrCoVar poly_name inferred_poly_ty) }
910

911

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
912 913 914
chooseInferredQuantifiers :: TcThetaType   -- inferred
                          -> TcTyVarSet    -- tvs free in tau type
                          -> [TcTyVar]     -- inferred quantified tvs
915
                          -> Maybe TcIdSigInst
916
                          -> TcM ([TyVarBinder], TcThetaType)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
917
chooseInferredQuantifiers inferred_theta tau_tvs qtvs Nothing
918
  = -- No type signature (partial or complete) for this binder,
919
    do { let free_tvs = closeOverKinds (growThetaTyVars inferred_theta tau_tvs)
920
                        -- Include kind variables!  Trac #7916
921
             my_theta = pickCapturedPreds free_tvs inferred_theta
922
             binders  = [ mkTyVarBinder Inferred tv
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
923 924 925
                        | tv <- qtvs
                        , tv `elemVarSet` free_tvs ]
       ; return (binders, my_theta) }
926

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
927
chooseInferredQuantifiers inferred_theta tau_tvs qtvs
928 929 930 931 932
                          (Just (TISI { sig_inst_sig   = sig  -- Always PartialSig
                                      , sig_inst_wcx   = wcx
                                      , sig_inst_theta = annotated_theta
                                      , sig_inst_skols = annotated_tvs }))
  | Nothing <- wcx
933 934
  = do { annotated_theta <- zonkTcTypes annotated_theta
       ; let free_tvs = closeOverKinds (tyCoVarsOfTypes annotated_theta
935
                                        `unionVarSet` tau_tvs)
936
       ; traceTc "ciq" (vcat [ ppr sig, ppr annotated_theta, ppr free_tvs])
937 938
       ; psig_qtvs <- mk_psig_qtvs annotated_tvs
       ; return (mk_final_qtvs psig_qtvs