TcBinds.hs 71.7 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
{-# LANGUAGE ViewPatterns #-}
12

13
module TcBinds ( tcLocalBinds, tcTopBinds, tcValBinds,
14
                 tcHsBootSigs, tcPolyCheck,
15
                 addTypecheckedBinds,
16 17
                 chooseInferredQuantifiers,
                 badBootDeclErr ) where
18

19 20
import GhcPrelude

21
import {-# SOURCE #-} TcMatches ( tcGRHSsPat, tcMatchesFun )
22
import {-# SOURCE #-} TcExpr  ( tcMonoExpr )
23
import {-# SOURCE #-} TcPatSyn ( tcPatSynDecl, 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, mkCastTy)
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
Simon Marlow's avatar
Simon Marlow committed
56 57 58 59 60
import ErrUtils
import Digraph
import Maybes
import Util
import BasicTypes
61
import Outputable
62
import PrelNames( ipClassName )
63
import TcValidity (checkValidType)
niteria's avatar
niteria committed
64
import UniqFM
David Feuer's avatar
David Feuer committed
65
import UniqSet
66
import qualified GHC.LanguageExtensions as LangExt
67
import ConLike
68 69

import Control.Monad
70 71

#include "HsVersions.h"
72

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

79
addTypecheckedBinds :: TcGblEnv -> [LHsBinds GhcTc] -> TcGblEnv
80
addTypecheckedBinds tcg_env binds
81
  | isHsBootOrSig (tcg_src tcg_env) = tcg_env
82 83 84 85 86 87
    -- Do not add the code for record-selector bindings
    -- when compiling hs-boot files
  | otherwise = tcg_env { tcg_binds = foldr unionBags
                                            (tcg_binds tcg_env)
                                            binds }

Austin Seipp's avatar
Austin Seipp committed
88 89 90
{-
************************************************************************
*                                                                      *
91
\subsection{Type-checking bindings}
Austin Seipp's avatar
Austin Seipp committed
92 93
*                                                                      *
************************************************************************
94

95
@tcBindsAndThen@ typechecks a @HsBinds@.  The "and then" part is because
96 97 98 99 100 101 102 103 104 105
it needs to know something about the {\em usage} of the things bound,
so that it can create specialisations of them.  So @tcBindsAndThen@
takes a function which, given an extended environment, E, typechecks
the scope of the bindings returning a typechecked thing and (most
important) an LIE.  It is this LIE which is then used as the basis for
specialising the things bound.

@tcBindsAndThen@ also takes a "combiner" which glues together the
bindings and the "thing" to make a new "thing".

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

Recursive and non-recursive binds are handled in essentially the same
way: because of uniques there are no scoping issues left.  The only
difference is that non-recursive bindings can bind primitive values.

Even for non-recursive binding groups we add typings for each binder
to the LVE for the following reason.  When each individual binding is
checked the type of its LHS is unified with that of its RHS; and
type-checking the LHS of course requires that the binder is in scope.

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

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

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

140
Notice the stupid construction of (f a d), which is of course
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
identical to the function we're executing.  In this case, the
polymorphic recursion isn't being used (but that's a very common case).
This can lead to a massive space leak, from the following top-level defn
(post-typechecking)

        ff :: [Int] -> [Int]
        ff = f Int dEqInt

Now (f dEqInt) evaluates to a lambda that has f' as a free variable; but
f' is another thunk which evaluates to the same thing... and you end
up with a chain of identical values all hung onto by the CAF ff.

        ff = f Int dEqInt

           = let f' = f Int dEqInt in \ys. ...f'...

           = let f' = let f' = f Int dEqInt in \ys. ...f'...
                      in \ys. ...f'...

Etc.

NOTE: a bit of arity anaysis would push the (f a d) inside the (\ys...),
which would make the space leak go away in this case

Solution: when typechecking the RHSs we always have in hand the
*monomorphic* Ids for each binding.  So we just need to make sure that
if (Method f a d) shows up in the constraints emerging from (...f...)
we just use the monomorphic Id.  We achieve this by adding monomorphic Ids
to the "givens" when simplifying constraints.  That's what the "lies_avail"
is doing.

Then we get

        f = /\a -> \d::Eq a -> letrec
                                 fm = \ys:[a] -> ...fm...
                               in
                               fm
Austin Seipp's avatar
Austin Seipp committed
178
-}
179

180 181
tcTopBinds :: [(RecFlag, LHsBinds GhcRn)] -> [LSig GhcRn]
           -> TcM (TcGblEnv, TcLclEnv)
182 183
-- The TcGblEnv contains the new tcg_binds and tcg_spects
-- The TcLclEnv has an extended type envt for the new bindings
184
tcTopBinds binds sigs
cactus's avatar
cactus committed
185 186 187 188 189
  = do  { -- Pattern synonym bindings populate the global environment
          (binds', (tcg_env, tcl_env)) <- tcValBinds TopLevel binds sigs $
            do { gbl <- getGblEnv
               ; lcl <- getLclEnv
               ; return (gbl, lcl) }
190 191
        ; specs <- tcImpPrags sigs   -- SPECIALISE prags for imported Ids

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

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

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

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

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





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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

543
------------------------
544
type BKey = Int -- Just number off the bindings
545

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

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

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

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

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

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

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

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

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

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

617 618 619 620
--------------
-- If typechecking the binds fails, then return with each
-- signature-less binder given type (forall a.a), to minimise
-- subsequent error messages
621
recoveryCode :: [Name] -> TcSigFun -> TcM (LHsBinds GhcTcId, [Id])
622 623 624 625 626 627 628 629 630 631 632 633 634
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
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).
640
-- See #15276
641
forall_a_a = mkSpecForAllTys [alphaTyVar] alphaTy
642 643 644 645 646 647 648

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

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

656 657
tcPolyNoGen rec_tc prag_fn tc_sig_fn bind_list
  = do { (binds', mono_infos) <- tcMonoBinds rec_tc tc_sig_fn
658
                                             (LetGblBndr prag_fn)
659
                                             bind_list
660
       ; mono_ids' <- mapM tc_mono_info mono_infos
661
       ; return (binds', mono_ids') }
662
  where
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
663
    tc_mono_info (MBI { mbi_poly_name = name, mbi_mono_id = mono_id })
664 665
      = do { _specs <- tcSpecPrags mono_id (lookupPragEnv prag_fn name)
           ; return mono_id }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
666 667 668 669
           -- NB: tcPrags generates error messages for
           --     specialisation pragmas for non-overloaded sigs
           -- Indeed that is why we call it here!
           -- So we can safely ignore _specs
670

671 672 673 674 675 676 677 678 679

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

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

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

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

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

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

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

727
             abs_bind = cL loc $
728 729
                        AbsBinds { abs_ext = noExt
                                 , abs_tvs      = skol_tvs
730 731 732
                                 , abs_ev_vars  = ev_vars
                                 , abs_ev_binds = [ev_binds]
                                 , abs_exports  = [export]
733
                                 , abs_binds    = unitBag (cL loc bind')
734
                                 , 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
funBindTicks loc fun_id mod sigs
744
  | (mb_cc_str : _) <- [ cc_name | (dL->L _ (SCCFunSig _ _ _ cc_name)) <- sigs ]
745 746 747 748
      -- 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, residual, insoluble)
801
                 <- simplifyInfer tclvl infer_mode sigs name_taus wanted
802
       ; emitConstraints residual
803

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

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

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

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

839
-- Pre-condition: the qtvs and theta are already zonked
840

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

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

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

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

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

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

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

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

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