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

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

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

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

18 19
import GhcPrelude

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

import Control.Monad
72
import Data.List.NonEmpty ( NonEmpty(..) )
73 74

#include "HsVersions.h"
75

76 77 78 79 80 81
{- *********************************************************************
*                                                                      *
               A useful helper function
*                                                                      *
********************************************************************* -}

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

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

109
The real work is done by @tcBindWithSigsAndThen@.
110 111 112 113 114 115 116 117 118 119

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.

120 121 122
At the top-level the LIE is sure to contain nothing but constant
dictionaries, which we resolve at the module level.

123 124
Note [Polymorphic recursion]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125
The game plan for polymorphic recursion in the code above is
126 127

        * Bind any variable for which we have a type signature
128
          to an Id with a polymorphic type.  Then when type-checking
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 178 179 180
          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
181
-}
182

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

195 196 197 198 199 200 201 202 203
        ; 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 }
204
                           `addTypecheckedBinds` map snd binds' }
205 206

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

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234

-- 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

235
tcCompleteSigs  :: [LSig GhcRn] -> TcM [CompleteMatch]
236 237
tcCompleteSigs sigs =
  let
238
      doOne :: Sig GhcRn -> TcM (Maybe CompleteMatch)
239 240 241 242 243 244 245 246 247 248 249 250 251 252
      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
253
              Fixed _ tc  -> return $ mkMatch cls tc
254 255 256 257

          check_complete_match tc_name = do
            ty_con <- tcLookupLocatedTyCon tc_name
            (_, cls) <- checkCLTypes (Fixed Nothing ty_con)
258 259 260 261 262 263 264
            return $ mkMatch cls ty_con

          mkMatch :: [ConLike] -> TyCon -> CompleteMatch
          mkMatch cls ty_con = CompleteMatch {
            completeMatchConLikes = map conLikeName cls,
            completeMatchTyCon = tyConName ty_con
            }
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 307 308 309
      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

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

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

334
badBootDeclErr :: MsgDoc
335
badBootDeclErr = text "Illegal declarations in an hs-boot file"
336

337
------------------------
338 339
tcLocalBinds :: HsLocalBinds GhcRn -> TcM thing
             -> TcM (HsLocalBinds GhcTcId, thing)
sof's avatar
sof committed
340

341
tcLocalBinds EmptyLocalBinds thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
342 343
  = do  { thing <- thing_inside
        ; return (EmptyLocalBinds, thing) }
sof's avatar
sof committed
344

345 346 347 348
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"
349

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

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

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

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

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

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

397
tcValBinds :: TopLevelFlag
398
           -> [(RecFlag, LHsBinds GhcRn)] -> [LSig GhcRn]
399
           -> TcM thing
400
           -> TcM ([(RecFlag, LHsBinds GhcTcId)], thing)
401

402
tcValBinds top_lvl binds sigs thing_inside
403 404 405 406
  = do  { let patsyns = getPatSynBinds binds

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

409 410
        ; let prag_fn = mkPragEnv sigs (foldr (unionBags . snd) emptyBag binds)

411 412
                -- Extend the envt right away with all the Ids
                -- declared with complete type signatures
413
                -- Do not extend the TcBinderStack; instead
414
                -- we extend it on a per-rhs basis in tcExtendForRhs
415
        ; tcExtendSigIds top_lvl poly_ids $ do
416 417
            { (binds', (extra_binds', thing)) <- tcBindGroups top_lvl sig_fn prag_fn binds $ do
                   { thing <- thing_inside
418
                     -- See Note [Pattern synonym builders don't yield dependencies]
419
                     --     in RnBinds
420
                   ; patsyn_builders <- mapM tcPatSynBuilderBind patsyns
421
                   ; let extra_binds = [ (NonRecursive, builder) | builder <- patsyn_builders ]
422
                   ; return (extra_binds, thing) }
423
            ; return (binds' ++ extra_binds', thing) }}
424

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

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

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

448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
-- 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.
--

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

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

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

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

503
    sccs :: [SCC (LHsBind GhcRn)]
niteria's avatar
niteria committed
504
    sccs = stronglyConnCompFromEdgedVerticesUniq (mkEdges sig_fn binds)
505

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

514 515
    tc_scc (AcyclicSCC bind) = tc_sub_group NonRecursive [bind]
    tc_scc (CyclicSCC binds) = tc_sub_group Recursive    binds
sof's avatar
sof committed
516

517
    tc_sub_group rec_tc binds =
518
      tcPolyBinds sig_fn prag_fn Recursive rec_tc closed binds
sof's avatar
sof committed
519

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

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

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

556
------------------------
557
type BKey = Int -- Just number off the bindings
558

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

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

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

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

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

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

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

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

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

626 627 628 629
--------------
-- If typechecking the binds fails, then return with each
-- signature-less binder given type (forall a.a), to minimise
-- subsequent error messages
630
recoveryCode :: [Name] -> TcSigFun -> TcM (LHsBinds GhcTcId, [Id])
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
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
*                                                                      *
********************************************************************* -}

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

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

674 675 676 677 678 679 680 681 682

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

tcPolyCheck :: TcPragEnv
            -> TcIdSigInfo     -- Must be a complete signature
683 684
            -> LHsBind GhcRn   -- Must be a FunBind
            -> TcM (LHsBinds GhcTcId, [TcId])
685
-- There is just one binding,
686
--   it is a Funbind
Simon Peyton Jones's avatar
Simon Peyton Jones committed
687
--   it has a complete type signature,
688 689 690 691 692 693 694 695
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)
696
       ; (tv_prs, theta, tau) <- tcInstType tcInstSkolTyVars poly_id
697 698 699 700 701
                -- 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
702
             skol_info = SigSkol ctxt (idType poly_id) tv_prs
703 704 705 706
             skol_tvs  = map snd tv_prs

       ; (ev_binds, (co_fn, matches'))
            <- checkConstraints skol_info skol_tvs ev_vars $
707
               tcExtendBinderStack [TcIdBndr mono_id NotTopLevel]  $
708 709 710 711 712
               tcExtendTyVarEnv2 tv_prs $
               setSrcSpan loc           $
               tcMatchesFun (L nm_loc mono_name) matches (mkCheckExpType tau)

       ; let prag_sigs = lookupPragEnv prag_fn name
713 714
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
715

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

723 724 725 726 727 728 729 730 731 732 733 734
             export = ABE { abe_wrap = idHsWrapper
                          , abe_poly  = poly_id
                          , abe_mono  = mono_id
                          , abe_prags = SpecPrags spec_prags }

             abs_bind = L loc $
                        AbsBinds { abs_tvs      = skol_tvs
                                 , abs_ev_vars  = ev_vars
                                 , abs_ev_binds = [ev_binds]
                                 , abs_exports  = [export]
                                 , abs_binds    = unitBag (L loc bind')
                                 , abs_sig      = True }
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
735

736
       ; return (unitBag abs_bind, [poly_id]) }
737

738 739 740
tcPolyCheck _prag_fn sig bind
  = pprPanic "tcPolyCheck" (ppr sig $$ ppr bind)

741 742
funBindTicks :: SrcSpan -> TcId -> Module -> [LSig GhcRn]
             -> [Tickish TcId]
743 744 745 746 747 748
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
749
          = sl_fs $ unLoc cc_str
750 751 752 753 754 755 756 757
          | 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
  = []

758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
{- 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
*                                                                      *
********************************************************************* -}
777 778

tcPolyInfer
779
  :: RecFlag       -- Whether it's recursive after breaking
780
                   -- dependencies based on type signatures
781
  -> TcPragEnv -> TcSigFun
782
  -> Bool         -- True <=> apply the monomorphism restriction
783 784
  -> [LHsBind GhcRn]
  -> TcM (LHsBinds GhcTcId, [TcId])
785
tcPolyInfer rec_tc prag_fn tc_sig_fn mono bind_list
786
  = do { (tclvl, wanted, (binds', mono_infos))
787
             <- pushLevelAndCaptureConstraints  $
788 789
                tcMonoBinds rec_tc tc_sig_fn LetLclBndr bind_list

790 791 792 793
       ; 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
794

795 796
       ; mapM_ (checkOverloadedSig mono) sigs

797
       ; traceTc "simplifyInfer call" (ppr tclvl $$ ppr name_taus $$ ppr wanted)
798
       ; (qtvs, givens, ev_binds, insoluble)
799
                 <- simplifyInfer tclvl infer_mode sigs name_taus wanted
800

801
       ; let inferred_theta = map evVarPred givens
802
       ; exports <- checkNoErrs $
803
                    mapM (mkExport prag_fn insoluble qtvs inferred_theta) mono_infos
thomasw's avatar
thomasw committed
804

805
       ; loc <- getSrcSpanM
806
       ; let poly_ids = map abe_poly exports
807
             abs_bind = L loc $
808
                        AbsBinds { abs_tvs = qtvs
809
                                 , abs_ev_vars = givens, abs_ev_binds = [ev_binds]
810 811
                                 , abs_exports = exports, abs_binds = binds'
                                 , abs_sig = False }
812

813 814
       ; traceTc "Binding:" (ppr (poly_ids `zip` map idType poly_ids))
       ; return (unitBag abs_bind, poly_ids) }
815
         -- poly_ids are guaranteed zonked by mkExport
816 817

--------------
818
mkExport :: TcPragEnv
819 820
         -> 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
821
         -> [TyVar] -> TcThetaType      -- Both already zonked
Ian Lynagh's avatar
Ian Lynagh committed
822
         -> MonoBindInfo
823
         -> TcM (ABExport GhcTc)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
824
-- Only called for generalisation plan InferGen, not by CheckGen or NoGen
825 826 827
--
-- mkExport generates exports with
--      zonked type variables,
Ian Lynagh's avatar
Ian Lynagh committed
828
--      zonked poly_ids
829 830 831 832
-- 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
833
-- type environment; see the invariant on TcEnv.tcExtendIdEnv
834

835
-- Pre-condition: the qtvs and theta are already zonked
836

837
mkExport prag_fn insoluble qtvs theta
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
838 839 840
         mono_info@(MBI { mbi_poly_name = poly_name
                        , mbi_sig       = mb_sig
                        , mbi_mono_id   = mono_id })
841
  = do  { mono_ty <- zonkTcType (idType mono_id)
842
        ; poly_id <- mkInferredPolyId insoluble qtvs theta poly_name mb_sig mono_ty
843 844

        -- NB: poly_id has a zonked type
845
        ; poly_id <- addInlinePrags poly_id prag_sigs
846
        ; spec_prags <- tcSpecPrags poly_id prag_sigs
Ian Lynagh's avatar
Ian Lynagh committed
847
                -- tcPrags requires a zonked poly_id
848

Gabor Greif's avatar
Gabor Greif committed
849
        -- See Note [Impedance matching]
850 851
        -- NB: we have already done checkValidType, including an ambiguity check,
        --     on the type; either when we checked the sig or in mkInferredPolyId
852
        ; let poly_ty     = idType poly_id
853
              sel_poly_ty = mkInfSigmaTy qtvs theta mono_ty
854
                -- This type is just going into tcSubType,
855
                -- so Inferred vs. Specified doesn't matter
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
856 857

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

manav's avatar
manav committed
864
        ; warn_missing_sigs <- woptM Opt_WarnMissingLocalSignatures
865 866
        ; when warn_missing_sigs $
              localSigWarn Opt_WarnMissingLocalSignatures poly_id mb_sig
867

868
        ; return (ABE { abe_wrap = wrap
869
                        -- abe_wrap :: idType poly_id ~ (forall qtvs. theta => mono_ty)
870 871 872
                      , abe_poly  = poly_id
                      , abe_mono  = mono_id
                      , abe_prags = SpecPrags spec_prags }) }
873
  where
874
    prag_sigs = lookupPragEnv prag_fn poly_name
875
    sig_ctxt  = InfSigCtxt poly_name
876

877 878 879
mkInferredPolyId :: Bool  -- True <=> there was an insoluble error when
                          --          checking the binding group for this Id
                 -> [TyVar] -> TcThetaType
880
                 -> Name -> Maybe TcIdSigInst -> TcType
881
                 -> TcM TcId
882
mkInferredPolyId insoluble qtvs inferred_theta poly_name mb_sig_inst mono_ty
883 884
  | Just (TISI { sig_inst_sig = sig })  <- mb_sig_inst
  , CompleteSig { sig_bndr = poly_id } <- sig
885 886 887 888
  = 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
889
                   -- we don't carry on to the impedance matching, and generate
890 891 892
                   -- a duplicate ambiguity error.  There is a similar
                   -- checkNoErrs for complete type signatures too.
    do { fam_envs <- tcGetFamInstEnvs
893
       ; let (_co, mono_ty') = normaliseType fam_envs Nominal mono_ty
894 895
               -- Unification may not have normalised the type,
               -- (see Note [Lazy flattening] in TcFlatten) so do it
896 897 898
               -- here to make it as uncomplicated as possible.
               -- Example: f :: [F Int] -> Bool
               -- should be rewritten to f :: [Char] -> Bool, if possible
899
               --
Gabor Greif's avatar
Gabor Greif committed
900
               -- We can discard the coercion _co, because we'll reconstruct
901
               -- it in the call to tcSubType below
902

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

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

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
908
       ; traceTc "mkInferredPolyId" (vcat [ppr poly_name, ppr qtvs, ppr theta'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
909
                                          , ppr inferred_poly_ty])
910 911
       ; unless insoluble $
         addErrCtxtM (mk_inf_msg poly_name inferred_poly_ty) $
912
         checkValidType (InfSigCtxt poly_name) inferred_poly_ty
913
         -- See Note [Validity of inferred types]
914 915 916
         -- 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.
917

918
       ; return (mkLocalIdOrCoVar poly_name inferred_poly_ty) }
919

920

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

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
936
chooseInferredQuantifiers inferred_theta tau_tvs qtvs
937 938 939 940 941
                          (Just (TISI { sig_inst_sig   = sig  -- Always PartialSig
                                      , sig_inst_wcx   = wcx
                                      , sig_inst_theta = annotated_theta
                                      , sig_inst_skols = annotated_tvs }))
  | Nothing <- wcx
942 943
  = do { annotated_theta <- zonkTcTypes annotated_theta
       ; let free_tvs = closeOverKinds