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

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

#include "HsVersions.h"
72

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

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

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

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.

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

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

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

125
Notice the stupid construction of (f a d), which is of course
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 162
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
163
-}
164

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

379
tcValBinds top_lvl binds sigs thing_inside
380 381 382 383
  = 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
384
        ; (poly_ids, sig_fn) <- tcAddPatSynPlaceholders patsyns $
385
                                tcTySigs sigs
Ian Lynagh's avatar
Ian Lynagh committed
386

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

663 664 665 666 667 668 669 670 671

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

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

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

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

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

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

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

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

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

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

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

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

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

789 790
       ; mapM_ (checkOverloadedSig mono) sigs

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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