TcBinds.hs 71.9 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, 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
import Data.List.NonEmpty ( NonEmpty(..) )
71 72

#include "HsVersions.h"
73

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

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

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

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

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.

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

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

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

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

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

        ; return (tcg_env', tcl_env) }
205
        -- The top level bindings are flattened into a giant
Ian Lynagh's avatar
Ian Lynagh committed
206
        -- implicitly-mutually-recursive LHsBinds
cactus's avatar
cactus committed
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 232

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

672 673 674 675 676 677 678 679 680

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

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

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

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

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

721 722 723 724 725 726 727 728 729 730 731 732
             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
733

734
       ; return (unitBag abs_bind, [poly_id]) }
735

736 737 738
tcPolyCheck _prag_fn sig bind
  = pprPanic "tcPolyCheck" (ppr sig $$ ppr bind)

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

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

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

788 789 790 791
       ; 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
792

793 794
       ; mapM_ (checkOverloadedSig mono) sigs

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

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

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

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

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

833
-- Pre-condition: the qtvs and theta are already zonked
834

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

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

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

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

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

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

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

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

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

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

916
       ; return (mkLocalIdOrCoVar poly_name inferred_poly_ty) }
917

918

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

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