TcBinds.hs 71.3 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 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
27
import GHC.Hs
28
import TcSigs
29
import TcRnMonad
Simon Marlow's avatar
Simon Marlow committed
30 31 32
import TcEnv
import TcUnify
import TcSimplify
33
import TcEvidence
Simon Marlow's avatar
Simon Marlow committed
34 35 36
import TcHsType
import TcPat
import TcMType
37 38
import FamInstEnv( normaliseType )
import FamInst( tcGetFamInstEnvs )
39
import TyCon
Simon Marlow's avatar
Simon Marlow committed
40
import TcType
41
import Type( mkStrLitTy, tidyOpenType, splitTyConApp_maybe, mkCastTy)
Simon Marlow's avatar
Simon Marlow committed
42
import TysPrim
43
import TysWiredIn( mkBoxedTupleTy )
Simon Marlow's avatar
Simon Marlow committed
44
import Id
45
import Var
46
import VarSet
47
import VarEnv( TidyEnv )
48
import Module
Simon Marlow's avatar
Simon Marlow committed
49
import Name
50
import NameSet
51
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
52
import SrcLoc
53
import Bag
Simon Marlow's avatar
Simon Marlow committed
54 55 56 57 58
import ErrUtils
import Digraph
import Maybes
import Util
import BasicTypes
59
import Outputable
60
import PrelNames( ipClassName )
61
import TcValidity (checkValidType)
niteria's avatar
niteria committed
62
import UniqFM
David Feuer's avatar
David Feuer committed
63
import UniqSet
64
import qualified GHC.LanguageExtensions as LangExt
65
import ConLike
66 67

import Control.Monad
68
import Data.Foldable (find)
69 70

#include "HsVersions.h"
71

Austin Seipp's avatar
Austin Seipp committed
72 73 74
{-
************************************************************************
*                                                                      *
75
\subsection{Type-checking bindings}
Austin Seipp's avatar
Austin Seipp committed
76 77
*                                                                      *
************************************************************************
78

79
@tcBindsAndThen@ typechecks a @HsBinds@.  The "and then" part is because
80 81 82 83 84 85 86 87 88 89
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".

90
The real work is done by @tcBindWithSigsAndThen@.
91 92 93 94 95 96 97 98 99 100

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.

101 102 103
At the top-level the LIE is sure to contain nothing but constant
dictionaries, which we resolve at the module level.

104 105
Note [Polymorphic recursion]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106
The game plan for polymorphic recursion in the code above is
107 108

        * Bind any variable for which we have a type signature
109
          to an Id with a polymorphic type.  Then when type-checking
110 111 112 113 114 115 116 117 118 119 120 121 122 123
          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'...

124
Notice the stupid construction of (f a d), which is of course
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
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
162
-}
163

164 165
tcTopBinds :: [(RecFlag, LHsBinds GhcRn)] -> [LSig GhcRn]
           -> TcM (TcGblEnv, TcLclEnv)
166 167
-- The TcGblEnv contains the new tcg_binds and tcg_spects
-- The TcLclEnv has an extended type envt for the new bindings
168
tcTopBinds binds sigs
cactus's avatar
cactus committed
169 170 171 172 173
  = 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) }
174 175
        ; specs <- tcImpPrags sigs   -- SPECIALISE prags for imported Ids

176 177 178 179 180 181 182 183 184
        ; 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 }
185
                           `addTypecheckedBinds` map snd binds' }
186 187

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

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215

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

216
tcCompleteSigs  :: [LSig GhcRn] -> TcM [CompleteMatch]
217 218
tcCompleteSigs sigs =
  let
219
      doOne :: Sig GhcRn -> TcM (Maybe CompleteMatch)
220
      doOne c@(CompleteMatchSig _ _ lns mtc)
221 222 223 224 225 226 227 228 229 230 231 232 233
        = 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
234
              Fixed _ tc  -> return $ mkMatch cls tc
235 236 237 238

          check_complete_match tc_name = do
            ty_con <- tcLookupLocatedTyCon tc_name
            (_, cls) <- checkCLTypes (Fixed Nothing ty_con)
239 240 241 242 243 244 245
            return $ mkMatch cls ty_con

          mkMatch :: [ConLike] -> TyCon -> CompleteMatch
          mkMatch cls ty_con = CompleteMatch {
            completeMatchConLikes = map conLikeName cls,
            completeMatchTyCon = tyConName ty_con
            }
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 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
      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

291
tcHsBootSigs :: [(RecFlag, LHsBinds GhcRn)] -> [LSig GhcRn] -> TcM [Id]
292 293
-- A hs-boot file has only one BindGroup, and it only has type
-- signatures in it.  The renamer checked all this
294
tcHsBootSigs binds sigs
Ian Lynagh's avatar
Ian Lynagh committed
295
  = do  { checkTc (null binds) badBootDeclErr
296
        ; concat <$> mapM (addLocM tc_boot_sig) (filter isTypeLSig sigs) }
297
  where
298
    tc_boot_sig (TypeSig _ lnames hs_ty) = mapM f lnames
299
      where
300
        f (dL->L _ name)
Richard Eisenberg's avatar
Richard Eisenberg committed
301
          = do { sigma_ty <- tcHsSigWcType (FunSigCtxt name False) hs_ty
302
               ; return (mkVanillaGlobal name sigma_ty) }
Ian Lynagh's avatar
Ian Lynagh committed
303
        -- Notice that we make GlobalIds, not LocalIds
Ian Lynagh's avatar
Ian Lynagh committed
304
    tc_boot_sig s = pprPanic "tcHsBootSigs/tc_boot_sig" (ppr s)
305

306
badBootDeclErr :: MsgDoc
307
badBootDeclErr = text "Illegal declarations in an hs-boot file"
308

309
------------------------
310 311
tcLocalBinds :: HsLocalBinds GhcRn -> TcM thing
             -> TcM (HsLocalBinds GhcTcId, thing)
sof's avatar
sof committed
312

313
tcLocalBinds (EmptyLocalBinds x) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
314
  = do  { thing <- thing_inside
315
        ; return (EmptyLocalBinds x, thing) }
sof's avatar
sof committed
316

317
tcLocalBinds (HsValBinds x (XValBindsLR (NValBinds binds sigs))) thing_inside
318
  = do  { (binds', thing) <- tcValBinds NotTopLevel binds sigs thing_inside
319 320
        ; return (HsValBinds x (XValBindsLR (NValBinds binds' sigs)), thing) }
tcLocalBinds (HsValBinds _ (ValBinds {})) _ = panic "tcLocalBinds"
321

322
tcLocalBinds (HsIPBinds x (IPBinds _ ip_binds)) thing_inside
323 324
  = do  { ipClass <- tcLookupClass ipClassName
        ; (given_ips, ip_binds') <-
325
            mapAndUnzipM (wrapLocSndM (tc_ip_bind ipClass)) ip_binds
326

327
        -- If the binding binds ?x = E, we  must now
Ian Lynagh's avatar
Ian Lynagh committed
328
        -- discharge any ?x constraints in expr_lie
329
        -- See Note [Implicit parameter untouchables]
330
        ; (ev_binds, result) <- checkConstraints (IPSkol ips)
331
                                  [] given_ips thing_inside
332

333
        ; return (HsIPBinds x (IPBinds ev_binds ip_binds') , result) }
334
  where
335
    ips = [ip | (dL->L _ (IPBind _ (Left (dL->L _ ip)) _)) <- ip_binds]
336

Ian Lynagh's avatar
Ian Lynagh committed
337 338 339
        -- I wonder if we should do these one at at time
        -- Consider     ?x = 4
        --              ?y = ?x + 1
340
    tc_ip_bind ipClass (IPBind _ (Left (dL->L _ ip)) expr)
341
       = do { ty <- newOpenFlexiTyVarTy
342 343
            ; let p = mkStrLitTy $ hsIPNameFS ip
            ; ip_id <- newDict ipClass [ p, ty ]
344
            ; expr' <- tcMonoExpr expr (mkCheckExpType ty)
345
            ; let d = toDict ipClass p ty `fmap` expr'
346
            ; return (ip_id, (IPBind noExtField (Right ip_id) d)) }
347
    tc_ip_bind _ (IPBind _ (Right {}) _) = panic "tc_ip_bind"
348
    tc_ip_bind _ (XIPBind nec) = noExtCon nec
349 350 351

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

355 356
tcLocalBinds (HsIPBinds _ (XHsIPBinds nec)) _ = noExtCon nec
tcLocalBinds (XHsLocalBindsLR nec)          _ = noExtCon nec
357

358 359
{- Note [Implicit parameter untouchables]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
360 361 362 363 364
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
365
doesn't float that solved constraint out (it's not an unsolved
366
wanted).  Result disaster: the (Num alpha) is again solved, this
367 368
time by defaulting.  No no no.

369
However [Oct 10] this is all handled automatically by the
370
untouchable-range idea.
Austin Seipp's avatar
Austin Seipp committed
371
-}
372

373
tcValBinds :: TopLevelFlag
374
           -> [(RecFlag, LHsBinds GhcRn)] -> [LSig GhcRn]
375
           -> TcM thing
376
           -> TcM ([(RecFlag, LHsBinds GhcTcId)], thing)
377

378
tcValBinds top_lvl binds sigs thing_inside
379 380 381 382
  = do  {   -- Typecheck the signatures
            -- It's easier to do so now, once for all the SCCs together
            -- because a single signature  f,g :: <type>
            -- might relate to more than one SCC
383
        ; (poly_ids, sig_fn) <- tcAddPatSynPlaceholders patsyns $
384
                                tcTySigs sigs
Ian Lynagh's avatar
Ian Lynagh committed
385

386 387
                -- Extend the envt right away with all the Ids
                -- declared with complete type signatures
388
                -- Do not extend the TcBinderStack; instead
389
                -- we extend it on a per-rhs basis in tcExtendForRhs
390
        ; tcExtendSigIds top_lvl poly_ids $ do
391 392
            { (binds', (extra_binds', thing)) <- tcBindGroups top_lvl sig_fn prag_fn binds $ do
                   { thing <- thing_inside
393
                     -- See Note [Pattern synonym builders don't yield dependencies]
394
                     --     in RnBinds
395
                   ; patsyn_builders <- mapM tcPatSynBuilderBind patsyns
396
                   ; let extra_binds = [ (NonRecursive, builder) | builder <- patsyn_builders ]
397
                   ; return (extra_binds, thing) }
398
            ; return (binds' ++ extra_binds', thing) }}
399 400 401
  where
    patsyns = getPatSynBinds binds
    prag_fn = mkPragEnv sigs (foldr (unionBags . snd) emptyBag binds)
402

403
------------------------
404
tcBindGroups :: TopLevelFlag -> TcSigFun -> TcPragEnv
405 406
             -> [(RecFlag, LHsBinds GhcRn)] -> TcM thing
             -> TcM ([(RecFlag, LHsBinds GhcTcId)], thing)
407 408
-- Typecheck a whole lot of value bindings,
-- one strongly-connected component at a time
409
-- Here a "strongly connected component" has the strightforward
410
-- meaning of a group of bindings that mention each other,
411
-- ignoring type signatures (that part comes later)
412

413
tcBindGroups _ _ _ [] thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
414 415
  = do  { thing <- thing_inside
        ; return ([], thing) }
416

417
tcBindGroups top_lvl sig_fn prag_fn (group : groups) thing_inside
418
  = do  { -- See Note [Closed binder groups]
419 420
          type_env <- getLclTypeEnv
        ; let closed = isClosedBndrGroup type_env (snd group)
421 422
        ; (group', (groups', thing))
                <- tc_group top_lvl sig_fn prag_fn group closed $
423
                   tcBindGroups top_lvl sig_fn prag_fn groups thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
424
        ; return (group' ++ groups', thing) }
sof's avatar
sof committed
425

426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
-- 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.
--

443
------------------------
444
tc_group :: forall thing.
445
            TopLevelFlag -> TcSigFun -> TcPragEnv
446 447
         -> (RecFlag, LHsBinds GhcRn) -> IsGroupClosed -> TcM thing
         -> TcM ([(RecFlag, LHsBinds GhcTcId)], thing)
448 449

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

453
tc_group top_lvl sig_fn prag_fn (NonRecursive, binds) closed thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
454 455
        -- A single non-recursive binding
        -- We want to keep non-recursive things non-recursive
456
        -- so that we desugar unlifted bindings correctly
cactus's avatar
cactus committed
457 458
  = do { let bind = case bagToList binds of
                 [bind] -> bind
459 460
                 []     -> panic "tc_group: empty list of binds"
                 _      -> panic "tc_group: NonRecursive binds is not a singleton bag"
461 462
       ; (bind', thing) <- tc_single top_lvl sig_fn prag_fn bind closed
                                     thing_inside
cactus's avatar
cactus committed
463
       ; return ( [(NonRecursive, bind')], thing) }
464

465
tc_group top_lvl sig_fn prag_fn (Recursive, binds) closed thing_inside
466 467
  =     -- To maximise polymorphism, we do a new
        -- strongly-connected-component analysis, this time omitting
Ian Lynagh's avatar
Ian Lynagh committed
468
        -- any references to variables with type signatures.
469
        -- (This used to be optional, but isn't now.)
470
        -- See Note [Polymorphic recursion] in HsBinds.
471
    do  { traceTc "tc_group rec" (pprLHsBinds binds)
472 473
        ; whenIsJust mbFirstPatSyn $ \lpat_syn ->
            recursivePatSynErr (getLoc lpat_syn) binds
474
        ; (binds1, thing) <- go sccs
475
        ; return ([(Recursive, binds1)], thing) }
Ian Lynagh's avatar
Ian Lynagh committed
476
                -- Rec them all together
477
  where
478
    mbFirstPatSyn = find (isPatSyn . unLoc) binds
cactus's avatar
cactus committed
479 480 481
    isPatSyn PatSynBind{} = True
    isPatSyn _ = False

482
    sccs :: [SCC (LHsBind GhcRn)]
niteria's avatar
niteria committed
483
    sccs = stronglyConnCompFromEdgedVerticesUniq (mkEdges sig_fn binds)
484

485
    go :: [SCC (LHsBind GhcRn)] -> TcM (LHsBinds GhcTcId, thing)
486
    go (scc:sccs) = do  { (binds1, ids1) <- tc_scc scc
487 488 489
                        ; (binds2, thing) <- tcExtendLetEnv top_lvl sig_fn
                                                            closed ids1 $
                                             go sccs
490 491
                        ; return (binds1 `unionBags` binds2, thing) }
    go []         = do  { thing <- thing_inside; return (emptyBag, thing) }
492

493 494
    tc_scc (AcyclicSCC bind) = tc_sub_group NonRecursive [bind]
    tc_scc (CyclicSCC binds) = tc_sub_group Recursive    binds
sof's avatar
sof committed
495

496
    tc_sub_group rec_tc binds =
497
      tcPolyBinds sig_fn prag_fn Recursive rec_tc closed binds
sof's avatar
sof committed
498

499 500 501 502 503 504 505 506
recursivePatSynErr ::
     OutputableBndrId (GhcPass p) =>
     SrcSpan -- ^ The location of the first pattern synonym binding
             --   (for error reporting)
  -> LHsBinds (GhcPass p)
  -> TcM a
recursivePatSynErr loc binds
  = failAt loc $
507
    hang (text "Recursive pattern synonym definition with following bindings:")
508
       2 (vcat $ map pprLBind . bagToList $ binds)
cactus's avatar
cactus committed
509
  where
510
    pprLoc loc  = parens (text "defined at" <+> ppr loc)
511 512
    pprLBind (dL->L loc bind) = pprWithCommas ppr (collectHsBindBinders bind)
                                <+> pprLoc loc
cactus's avatar
cactus committed
513 514

tc_single :: forall thing.
515
            TopLevelFlag -> TcSigFun -> TcPragEnv
516 517
          -> LHsBind GhcRn -> IsGroupClosed -> TcM thing
          -> TcM (LHsBinds GhcTcId, thing)
518
tc_single _top_lvl sig_fn _prag_fn
519
          (dL->L _ (PatSynBind _ psb@PSB{ psb_id = (dL->L _ name) }))
520
          _ thing_inside
521
  = do { (aux_binds, tcg_env) <- tcPatSynDecl psb (sig_fn name)
522
       ; thing <- setGblEnv tcg_env thing_inside
cactus's avatar
cactus committed
523 524
       ; return (aux_binds, thing)
       }
525

526
tc_single top_lvl sig_fn prag_fn lbind closed thing_inside
527
  = do { (binds1, ids) <- tcPolyBinds sig_fn prag_fn
528
                                      NonRecursive NonRecursive
529
                                      closed
530
                                      [lbind]
531
       ; thing <- tcExtendLetEnv top_lvl sig_fn closed ids thing_inside
cactus's avatar
cactus committed
532
       ; return (binds1, thing) }
533

534
------------------------
535
type BKey = Int -- Just number off the bindings
536

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

552
    no_sig :: Name -> Bool
553
    no_sig n = not (hasCompleteSig sig_fn n)
554 555 556

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

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

561
------------------------
562
tcPolyBinds :: TcSigFun -> TcPragEnv
563 564 565
            -> RecFlag         -- Whether the group is really recursive
            -> RecFlag         -- Whether it's recursive after breaking
                               -- dependencies based on type signatures
566
            -> IsGroupClosed   -- Whether the group is closed
567 568
            -> [LHsBind GhcRn]  -- None are PatSynBind
            -> TcM (LHsBinds GhcTcId, [TcId])
569

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

581
tcPolyBinds sig_fn prag_fn rec_group rec_tc closed bind_list
582
  = setSrcSpan loc                              $
583
    recoverM (recoveryCode binder_names sig_fn) $ do
584
        -- Set up main recover; take advantage of any type sigs
585

586
    { traceTc "------------------------------------------------" Outputable.empty
587
    ; traceTc "Bindings for {" (ppr binder_names)
588
    ; dflags   <- getDynFlags
589
    ; let plan = decideGeneralisationPlan dflags bind_list closed sig_fn
590
    ; traceTc "Generalisation plan" (ppr plan)
591
    ; result@(_, poly_ids) <- case plan of
592 593
         NoGen              -> tcPolyNoGen rec_tc prag_fn sig_fn bind_list
         InferGen mn        -> tcPolyInfer rec_tc prag_fn sig_fn mn bind_list
594
         CheckGen lbind sig -> tcPolyCheck prag_fn sig lbind
595

596 597 598
    ; traceTc "} End of bindings for" (vcat [ ppr binder_names, ppr rec_group
                                            , vcat [ppr id <+> ppr (idType id) | id <- poly_ids]
                                          ])
599

600
    ; return result }
601
  where
602 603
    binder_names = collectHsBindListBinders bind_list
    loc = foldr1 combineSrcSpans (map getLoc bind_list)
604
         -- The mbinds have been dependency analysed and
605
         -- may no longer be adjacent; so find the narrowest
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
606
         -- span that includes them all
607

608 609 610 611
--------------
-- If typechecking the binds fails, then return with each
-- signature-less binder given type (forall a.a), to minimise
-- subsequent error messages
612
recoveryCode :: [Name] -> TcSigFun -> TcM (LHsBinds GhcTcId, [Id])
613 614 615 616 617 618 619 620 621 622 623 624 625
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
626 627 628 629 630
-- 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).
631
-- See #15276
632
forall_a_a = mkSpecForAllTys [alphaTyVar] alphaTy
633 634 635 636 637 638 639

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

640
tcPolyNoGen     -- No generalisation whatsoever
641
  :: RecFlag       -- Whether it's recursive after breaking
642
                   -- dependencies based on type signatures
643
  -> TcPragEnv -> TcSigFun
644 645
  -> [LHsBind GhcRn]
  -> TcM (LHsBinds GhcTcId, [TcId])
646

647 648
tcPolyNoGen rec_tc prag_fn tc_sig_fn bind_list
  = do { (binds', mono_infos) <- tcMonoBinds rec_tc tc_sig_fn
649
                                             (LetGblBndr prag_fn)
650
                                             bind_list
651
       ; mono_ids' <- mapM tc_mono_info mono_infos
652
       ; return (binds', mono_ids') }
653
  where
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
654
    tc_mono_info (MBI { mbi_poly_name = name, mbi_mono_id = mono_id })
655 656
      = 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
657 658 659 660
           -- 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
661

662 663 664 665 666 667 668 669 670

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

tcPolyCheck :: TcPragEnv
            -> TcIdSigInfo     -- Must be a complete signature
671 672
            -> LHsBind GhcRn   -- Must be a FunBind
            -> TcM (LHsBinds GhcTcId, [TcId])
673
-- There is just one binding,
674
--   it is a Funbind
Simon Peyton Jones's avatar
Simon Peyton Jones committed
675
--   it has a complete type signature,
676 677 678 679
tcPolyCheck prag_fn
            (CompleteSig { sig_bndr  = poly_id
                         , sig_ctxt  = ctxt
                         , sig_loc   = sig_loc })
680 681
            (dL->L loc (FunBind { fun_id = (dL->L nm_loc name)
                                , fun_matches = matches }))
682 683
  = setSrcSpan sig_loc $
    do { traceTc "tcPolyCheck" (ppr poly_id $$ ppr sig_loc)
684
       ; (tv_prs, theta, tau) <- tcInstType tcInstSkolTyVars poly_id
685 686 687 688 689
                -- 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
690
             skol_info = SigSkol ctxt (idType poly_id) tv_prs
691 692 693 694
             skol_tvs  = map snd tv_prs

       ; (ev_binds, (co_fn, matches'))
            <- checkConstraints skol_info skol_tvs ev_vars $
695
               tcExtendBinderStack [TcIdBndr mono_id NotTopLevel]  $
696
               tcExtendNameTyVarEnv tv_prs $
697
               setSrcSpan loc           $
698
               tcMatchesFun (cL nm_loc mono_name) matches (mkCheckExpType tau)
699 700

       ; let prag_sigs = lookupPragEnv prag_fn name
701 702
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
703

704
       ; mod <- getModule
705
       ; tick <- funBindTicks nm_loc mono_id mod prag_sigs
706
       ; let bind' = FunBind { fun_id      = cL nm_loc mono_id
707 708
                             , fun_matches = matches'
                             , fun_co_fn   = co_fn
709
                             , fun_ext     = placeHolderNamesTc
710
                             , fun_tick    = tick }
711

712 713
             export = ABE { abe_ext   = noExtField
                          , abe_wrap  = idHsWrapper
714 715 716 717
                          , abe_poly  = poly_id
                          , abe_mono  = mono_id
                          , abe_prags = SpecPrags spec_prags }

718
             abs_bind = cL loc $
719
                        AbsBinds { abs_ext      = noExtField
720
                                 , abs_tvs      = skol_tvs
721 722 723
                                 , abs_ev_vars  = ev_vars
                                 , abs_ev_binds = [ev_binds]
                                 , abs_exports  = [export]
724
                                 , abs_binds    = unitBag (cL loc bind')
725
                                 , abs_sig      = True }
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
726

727
       ; return (unitBag abs_bind, [poly_id]) }
728

729 730 731
tcPolyCheck _prag_fn sig bind
  = pprPanic "tcPolyCheck" (ppr sig $$ ppr bind)

732
funBindTicks :: SrcSpan -> TcId -> Module -> [LSig GhcRn]
733
             -> TcM [Tickish TcId]
734
funBindTicks loc fun_id mod sigs
735
  | (mb_cc_str : _) <- [ cc_name | (dL->L _ (SCCFunSig _ _ _ cc_name)) <- sigs ]
736 737 738 739
      -- this can only be a singleton list, as duplicate pragmas are rejected
      -- by the renamer
  , let cc_str
          | Just cc_str <- mb_cc_str
740
          = sl_fs $ unLoc cc_str
741 742 743
          | otherwise
          = getOccFS (Var.varName fun_id)
        cc_name = moduleNameFS (moduleName mod) `appendFS` consFS '.' cc_str
744 745 746 747
  = do
      flavour <- DeclCC <$> getCCIndexM cc_name
      let cc = mkUserCC cc_name mod loc flavour
      return [ProfNote cc True True]
748
  | otherwise
749
  = return []
750

751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
{- 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
*                                                                      *
********************************************************************* -}
770 771

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

783 784 785 786
       ; 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
787

788 789
       ; mapM_ (checkOverloadedSig mono) sigs

790
       ; traceTc "simplifyInfer call" (ppr tclvl $$ ppr name_taus $$ ppr wanted)
791
       ; (qtvs, givens, ev_binds, residual, insoluble)
792
                 <- simplifyInfer tclvl infer_mode sigs name_taus wanted
793
       ; emitConstraints residual
794

795
       ; let inferred_theta = map evVarPred givens
796
       ; exports <- checkNoErrs $
797
                    mapM (mkExport prag_fn insoluble qtvs inferred_theta) mono_infos
thomasw's avatar
thomasw committed
798

799
       ; loc <- getSrcSpanM
800
       ; let poly_ids = map abe_poly exports
801
             abs_bind = cL loc $
802
                        AbsBinds { abs_ext = noExtField
803
                                 , abs_tvs = qtvs
804
                                 , abs_ev_vars = givens, abs_ev_binds = [ev_binds]
805 806
                                 , abs_exports = exports, abs_binds = binds'
                                 , abs_sig = False }
807

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

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

830
-- Pre-condition: the qtvs and theta are already zonked
831

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

        -- NB: poly_id has a zonked type
840
        ; poly_id <- addInlinePrags poly_id prag_sigs
841
        ; spec_prags <- tcSpecPrags poly_id prag_sigs
Ian Lynagh's avatar
Ian Lynagh committed
842
                -- tcPrags requires a zonked poly_id
843

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

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

manav's avatar
manav committed
859
        ; warn_missing_sigs <- woptM Opt_WarnMissingLocalSignatures
860 861
        ; when warn_missing_sigs $
              localSigWarn Opt_WarnMissingLocalSignatures poly_id mb_sig
862

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

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

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

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

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
904
       ; traceTc "mkInferredPolyId" (vcat [ppr poly_name, ppr qtvs, ppr theta'
Simon Peyton Jones's avatar
Simon Peyton Jones committed
905
                                          , ppr inferred_poly_ty])