TcBinds.hs 74.1 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
import CoreSyn (Tickish (..))
25
import CostCentre (mkUserCC, CCFlavour(DeclCC))
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( 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)
niteria's avatar
niteria committed
65
import UniqFM
David Feuer's avatar
David Feuer committed
66
import UniqSet
67
import qualified GHC.LanguageExtensions as LangExt
68
import ConLike
69 70

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

#include "HsVersions.h"
74

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

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

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

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

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.

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

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

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

142
Notice the stupid construction of (f a d), which is of course
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
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
180
-}
181

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

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

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

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

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

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

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

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

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

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

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

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

Ben Gamari's avatar
Ben Gamari committed
344
tcLocalBinds (HsValBinds (ValBindsOut binds sigs)) thing_inside
345
  = do  { (binds', thing) <- tcValBinds NotTopLevel binds sigs thing_inside
Ben Gamari's avatar
Ben Gamari committed
346 347
        ; return (HsValBinds (ValBindsOut binds' sigs), thing) }
tcLocalBinds (HsValBinds (ValBindsIn {})) _ = panic "tcLocalBinds"
348

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

673 674 675 676 677 678 679 680 681

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

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

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

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

715
       ; mod <- getModule
716
       ; tick <- funBindTicks nm_loc mono_id mod prag_sigs
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    = tick }
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
funBindTicks :: SrcSpan -> TcId -> Module -> [LSig GhcRn]
742
             -> TcM [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
          | otherwise
          = getOccFS (Var.varName fun_id)
        cc_name = moduleNameFS (moduleName mod) `appendFS` consFS '.' cc_str
753 754 755 756
  = do
      flavour <- DeclCC <$> getCCIndexM cc_name
      let cc = mkUserCC cc_name mod loc flavour
      return [ProfNote cc True True]
757
  | otherwise
758
  = return []
759

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

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

792 793 794 795
       ; 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
796

797 798
       ; mapM_ (checkOverloadedSig mono) sigs

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

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

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

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

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

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

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

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

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

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

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

870
        ; return (ABE { 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
                          -> TcTyVarSet    -- tvs free in tau type
                          -> [TcTyVar]     -- inferred quantified tvs
926
                          -> Maybe TcIdSigInst
927
                          -> TcM ([TyVarBinder], TcThetaType)
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
928
chooseInferredQuantifiers inferred_theta tau_tvs qtvs Nothing
929
  = -- No type signature (partial or complete) for this binder,
930
    do { let free_tvs = closeOverKinds (growThetaTyVars inferred_theta tau_tvs)