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

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

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

12
module TcBinds ( tcLocalBinds, tcTopBinds, tcValBinds,
13
                 tcHsBootSigs, tcPolyCheck,
14
                 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 ( tcPatSynDecl, tcPatSynBuilderBind )
23
import CoreSyn (Tickish (..))
24
import CostCentre (mkUserCC, CCFlavour(DeclCC))
Simon Marlow's avatar
Simon Marlow committed
25
import DynFlags
26
import FastString
Simon Marlow's avatar
Simon Marlow committed
27
import HsSyn
28
import HscTypes( isHsBootOrSig )
29
import TcSigs
30
import TcRnMonad
Simon Marlow's avatar
Simon Marlow committed
31 32 33
import TcEnv
import TcUnify
import TcSimplify
34
import TcEvidence
Simon Marlow's avatar
Simon Marlow committed
35 36 37
import TcHsType
import TcPat
import TcMType
38 39
import FamInstEnv( normaliseType )
import FamInst( tcGetFamInstEnvs )
40
import TyCon
Simon Marlow's avatar
Simon Marlow committed
41
import TcType
42
import Type( mkStrLitTy, tidyOpenType, splitTyConApp_maybe, mkCastTy)
Simon Marlow's avatar
Simon Marlow committed
43
import TysPrim
44
import TysWiredIn( mkBoxedTupleTy )
Simon Marlow's avatar
Simon Marlow committed
45
import Id
46
import Var
47
import VarSet
48
import VarEnv( TidyEnv )
49
import Module
Simon Marlow's avatar
Simon Marlow committed
50
import Name
51
import NameSet
52
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
53
import SrcLoc
54
import Bag
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)
niteria's avatar
niteria committed
63
import UniqFM
David Feuer's avatar
David Feuer committed
64
import UniqSet
65
import qualified GHC.LanguageExtensions as LangExt
66
import ConLike
67 68

import Control.Monad
69 70

#include "HsVersions.h"
71

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

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

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

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

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.

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

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

        * Bind any variable for which we have a type signature
124
          to an Id with a polymorphic type.  Then when type-checking
125 126 127 128 129 130 131 132 133 134 135 136 137 138
          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'...

139
Notice the stupid construction of (f a d), which is of course
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
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
177
-}
178

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

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

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

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

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

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

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

          mkMatch :: [ConLike] -> TyCon -> CompleteMatch
          mkMatch cls ty_con = CompleteMatch {
            completeMatchConLikes = map conLikeName cls,
            completeMatchTyCon = tyConName ty_con
            }
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
      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

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

321
badBootDeclErr :: MsgDoc
322
badBootDeclErr = text "Illegal declarations in an hs-boot file"
323

324
------------------------
325 326
tcLocalBinds :: HsLocalBinds GhcRn -> TcM thing
             -> TcM (HsLocalBinds GhcTcId, thing)
sof's avatar
sof committed
327

328
tcLocalBinds (EmptyLocalBinds x) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
329
  = do  { thing <- thing_inside
330
        ; return (EmptyLocalBinds x, thing) }
sof's avatar
sof committed
331

332
tcLocalBinds (HsValBinds x (XValBindsLR (NValBinds binds sigs))) thing_inside
333
  = do  { (binds', thing) <- tcValBinds NotTopLevel binds sigs thing_inside
334 335
        ; return (HsValBinds x (XValBindsLR (NValBinds binds' sigs)), thing) }
tcLocalBinds (HsValBinds _ (ValBinds {})) _ = panic "tcLocalBinds"
336

337
tcLocalBinds (HsIPBinds x (IPBinds _ ip_binds)) thing_inside
338 339
  = do  { ipClass <- tcLookupClass ipClassName
        ; (given_ips, ip_binds') <-
340
            mapAndUnzipM (wrapLocSndM (tc_ip_bind ipClass)) ip_binds
341

342
        -- If the binding binds ?x = E, we  must now
Ian Lynagh's avatar
Ian Lynagh committed
343
        -- discharge any ?x constraints in expr_lie
344
        -- See Note [Implicit parameter untouchables]
345
        ; (ev_binds, result) <- checkConstraints (IPSkol ips)
346
                                  [] given_ips thing_inside
347

348
        ; return (HsIPBinds x (IPBinds ev_binds ip_binds') , result) }
349
  where
350
    ips = [ip | L _ (IPBind _ (Left (L _ ip)) _) <- ip_binds]
351

Ian Lynagh's avatar
Ian Lynagh committed
352 353 354
        -- I wonder if we should do these one at at time
        -- Consider     ?x = 4
        --              ?y = ?x + 1
355
    tc_ip_bind ipClass (IPBind _ (Left (L _ ip)) expr)
356
       = do { ty <- newOpenFlexiTyVarTy
357 358
            ; let p = mkStrLitTy $ hsIPNameFS ip
            ; ip_id <- newDict ipClass [ p, ty ]
359
            ; expr' <- tcMonoExpr expr (mkCheckExpType ty)
360
            ; let d = toDict ipClass p ty `fmap` expr'
361 362
            ; return (ip_id, (IPBind noExt (Right ip_id) d)) }
    tc_ip_bind _ (IPBind _ (Right {}) _) = panic "tc_ip_bind"
363
    tc_ip_bind _ (XIPBind _) = panic "tc_ip_bind"
364 365 366

    -- Coerces a `t` into a dictionry for `IP "x" t`.
    -- co : t -> IP "x" t
367
    toDict ipClass x ty = mkHsWrap $ mkWpCastR $
368
                          wrapIP $ mkClassPred ipClass [x,ty]
369

370 371 372
tcLocalBinds (HsIPBinds _ (XHsIPBinds _ )) _ = panic "tcLocalBinds"
tcLocalBinds (XHsLocalBindsLR _)           _ = panic "tcLocalBinds"

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

384
However [Oct 10] this is all handled automatically by the
385
untouchable-range idea.
Austin Seipp's avatar
Austin Seipp committed
386
-}
387

388
tcValBinds :: TopLevelFlag
389
           -> [(RecFlag, LHsBinds GhcRn)] -> [LSig GhcRn]
390
           -> TcM thing
391
           -> TcM ([(RecFlag, LHsBinds GhcTcId)], thing)
392

393
tcValBinds top_lvl binds sigs thing_inside
394 395 396 397
  = do  { let patsyns = getPatSynBinds binds

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

400 401
        ; let prag_fn = mkPragEnv sigs (foldr (unionBags . snd) emptyBag binds)

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

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

426
tcBindGroups _ _ _ [] thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
427 428
  = do  { thing <- thing_inside
        ; return ([], thing) }
429

430
tcBindGroups top_lvl sig_fn prag_fn (group : groups) thing_inside
431
  = do  { -- See Note [Closed binder groups]
432 433
          type_env <- getLclTypeEnv
        ; let closed = isClosedBndrGroup type_env (snd group)
434 435
        ; (group', (groups', thing))
                <- tc_group top_lvl sig_fn prag_fn group closed $
436
                   tcBindGroups top_lvl sig_fn prag_fn groups thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
437
        ; return (group' ++ groups', thing) }
sof's avatar
sof committed
438

439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
-- 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.
--

456
------------------------
457
tc_group :: forall thing.
458
            TopLevelFlag -> TcSigFun -> TcPragEnv
459 460
         -> (RecFlag, LHsBinds GhcRn) -> IsGroupClosed -> TcM thing
         -> TcM ([(RecFlag, LHsBinds GhcTcId)], thing)
461 462

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

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

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

494
    sccs :: [SCC (LHsBind GhcRn)]
niteria's avatar
niteria committed
495
    sccs = stronglyConnCompFromEdgedVerticesUniq (mkEdges sig_fn binds)
496

497
    go :: [SCC (LHsBind GhcRn)] -> TcM (LHsBinds GhcTcId, thing)
498
    go (scc:sccs) = do  { (binds1, ids1) <- tc_scc scc
499 500 501
                        ; (binds2, thing) <- tcExtendLetEnv top_lvl sig_fn
                                                            closed ids1 $
                                             go sccs
502 503
                        ; return (binds1 `unionBags` binds2, thing) }
    go []         = do  { thing <- thing_inside; return (emptyBag, thing) }
504

505 506
    tc_scc (AcyclicSCC bind) = tc_sub_group NonRecursive [bind]
    tc_scc (CyclicSCC binds) = tc_sub_group Recursive    binds
sof's avatar
sof committed
507

508
    tc_sub_group rec_tc binds =
509
      tcPolyBinds sig_fn prag_fn Recursive rec_tc closed binds
sof's avatar
sof committed
510

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

tc_single :: forall thing.
522
            TopLevelFlag -> TcSigFun -> TcPragEnv
523 524
          -> LHsBind GhcRn -> IsGroupClosed -> TcM thing
          -> TcM (LHsBinds GhcTcId, thing)
525
tc_single _top_lvl sig_fn _prag_fn
526
          (L _ (PatSynBind _ psb@PSB{ psb_id = L _ name }))
527
          _ thing_inside
528
  = do { (aux_binds, tcg_env) <- tcPatSynDecl psb (sig_fn name)
529
       ; thing <- setGblEnv tcg_env thing_inside
cactus's avatar
cactus committed
530 531
       ; return (aux_binds, thing)
       }
532

533
tc_single top_lvl sig_fn prag_fn lbind closed thing_inside
534
  = do { (binds1, ids) <- tcPolyBinds sig_fn prag_fn
535
                                      NonRecursive NonRecursive
536
                                      closed
537
                                      [lbind]
538
       ; thing <- tcExtendLetEnv top_lvl sig_fn closed ids thing_inside
cactus's avatar
cactus committed
539
       ; return (binds1, thing) }
540

541
------------------------
542
type BKey = Int -- Just number off the bindings
543

544
mkEdges :: TcSigFun -> LHsBinds GhcRn -> [Node BKey (LHsBind GhcRn)]
545
-- See Note [Polymorphic recursion] in HsBinds.
546
mkEdges sig_fn binds
547 548
  = [ DigraphNode bind key [key | n <- nonDetEltsUniqSet (bind_fvs (unLoc bind)),
                         Just key <- [lookupNameEnv key_map n], no_sig n ]
549 550
    | (bind, key) <- keyd_binds
    ]
niteria's avatar
niteria committed
551 552 553
    -- 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.
554
  where
555 556 557 558
    bind_fvs (FunBind { fun_ext = fvs }) = fvs
    bind_fvs (PatBind { pat_ext = fvs }) = fvs
    bind_fvs _                           = emptyNameSet

559
    no_sig :: Name -> Bool
560
    no_sig n = not (hasCompleteSig sig_fn n)
561 562 563

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

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

568
------------------------
569
tcPolyBinds :: TcSigFun -> TcPragEnv
570 571 572
            -> RecFlag         -- Whether the group is really recursive
            -> RecFlag         -- Whether it's recursive after breaking
                               -- dependencies based on type signatures
573
            -> IsGroupClosed   -- Whether the group is closed
574 575
            -> [LHsBind GhcRn]  -- None are PatSynBind
            -> TcM (LHsBinds GhcTcId, [TcId])
576

577
-- Typechecks a single bunch of values bindings all together,
578 579 580
-- and generalises them.  The bunch may be only part of a recursive
-- group, because we use type signatures to maximise polymorphism
--
581 582
-- Returns a list because the input may be a single non-recursive binding,
-- in which case the dependency order of the resulting bindings is
583 584
-- important.
--
585
-- Knows nothing about the scope of the bindings
586
-- None of the bindings are pattern synonyms
587

588
tcPolyBinds sig_fn prag_fn rec_group rec_tc closed bind_list
589
  = setSrcSpan loc                              $
590
    recoverM (recoveryCode binder_names sig_fn) $ do
591
        -- Set up main recover; take advantage of any type sigs
592

593
    { traceTc "------------------------------------------------" Outputable.empty
594
    ; traceTc "Bindings for {" (ppr binder_names)
595
    ; dflags   <- getDynFlags
596
    ; let plan = decideGeneralisationPlan dflags bind_list closed sig_fn
597
    ; traceTc "Generalisation plan" (ppr plan)
598
    ; result@(_, poly_ids) <- case plan of
599 600
         NoGen              -> tcPolyNoGen rec_tc prag_fn sig_fn bind_list
         InferGen mn        -> tcPolyInfer rec_tc prag_fn sig_fn mn bind_list
601
         CheckGen lbind sig -> tcPolyCheck prag_fn sig lbind
602

603 604 605
    ; traceTc "} End of bindings for" (vcat [ ppr binder_names, ppr rec_group
                                            , vcat [ppr id <+> ppr (idType id) | id <- poly_ids]
                                          ])
606

607
    ; return result }
608
  where
609 610
    binder_names = collectHsBindListBinders bind_list
    loc = foldr1 combineSrcSpans (map getLoc bind_list)
611
         -- The mbinds have been dependency analysed and
612
         -- may no longer be adjacent; so find the narrowest
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
613
         -- span that includes them all
614

615 616 617 618
--------------
-- If typechecking the binds fails, then return with each
-- signature-less binder given type (forall a.a), to minimise
-- subsequent error messages
619
recoveryCode :: [Name] -> TcSigFun -> TcM (LHsBinds GhcTcId, [Id])
620 621 622 623 624 625 626 627 628 629 630 631 632
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
633 634 635 636 637 638 639
-- At one point I had (forall r (a :: TYPE r). a), but of course
-- that type is ill-formed: its mentions 'r' which escapes r's scope.
-- Another alternative would be (forall (a :: TYPE kappa). a), where
-- kappa is a unification variable. But I don't think we need that
-- complication here. I'm going to just use (forall (a::*). a).
-- See Trac #15276
forall_a_a = mkSpecForAllTys [alphaTyVar] alphaTy
640 641 642 643 644 645 646

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

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

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

669 670 671 672 673 674 675 676 677

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

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

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

       ; let prag_sigs = lookupPragEnv prag_fn name
708 709
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
710

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

719 720
             export = ABE { abe_ext = noExt
                          , abe_wrap = idHsWrapper
721 722 723 724 725
                          , abe_poly  = poly_id
                          , abe_mono  = mono_id
                          , abe_prags = SpecPrags spec_prags }

             abs_bind = L loc $
726 727
                        AbsBinds { abs_ext = noExt
                                 , abs_tvs      = skol_tvs
728 729 730 731 732
                                 , 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
funBindTicks :: SrcSpan -> TcId -> Module -> [LSig GhcRn]
740
             -> TcM [Tickish TcId]
741
funBindTicks loc fun_id mod sigs
742
  | (mb_cc_str : _) <- [ cc_name | L _ (SCCFunSig _ _ _ cc_name) <- sigs ]
743 744 745 746
      -- 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
          | otherwise
          = getOccFS (Var.varName fun_id)
        cc_name = moduleNameFS (moduleName mod) `appendFS` consFS '.' cc_str
751 752 753 754
  = do
      flavour <- DeclCC <$> getCCIndexM cc_name
      let cc = mkUserCC cc_name mod loc flavour
      return [ProfNote cc True True]
755
  | otherwise
756
  = return []
757

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 809
                        AbsBinds { abs_ext = noExt
                                 , abs_tvs = qtvs
810
                                 , abs_ev_vars = givens, abs_ev_binds = [ev_binds]
811 812
                                 , abs_exports = exports, abs_binds = binds'
                                 , abs_sig = False }
813

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

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

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

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

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

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

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

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

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

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

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

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

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

920
       ; return (mkLocalIdOrCoVar poly_name inferred_poly_ty) }
921

922

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
923 924 925
chooseInferredQuantifiers :: TcThetaType   -- inferred