TcBinds.hs 79.2 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 9
{-# LANGUAGE CPP, RankNTypes, ScopedTypeVariables #-}

10
module TcBinds ( tcLocalBinds, tcTopBinds, tcRecSelBinds,
11
                 tcHsBootSigs, tcPolyCheck,
12
                 tcSpecPrags, tcSpecWrapper,
13
                 tcVectDecls,
14 15
                 TcSigInfo(..), TcSigFun,
                 TcPragEnv, mkPragEnv,
16
                 instTcTySig, instTcTySigFromId, findScopedTyVars,
17
                 badBootDeclErr, mkExport ) where
18

19
import {-# SOURCE #-} TcMatches ( tcGRHSsPat, tcMatchesFun )
20
import {-# SOURCE #-} TcExpr  ( tcMonoExpr )
21
import {-# SOURCE #-} TcPatSyn ( tcInferPatSynDecl, tcCheckPatSynDecl, tcPatSynBuilderBind )
Simon Marlow's avatar
Simon Marlow committed
22 23
import DynFlags
import HsSyn
24
import HscTypes( isHsBoot )
25
import TcRnMonad
Simon Marlow's avatar
Simon Marlow committed
26 27 28
import TcEnv
import TcUnify
import TcSimplify
29
import TcEvidence
Simon Marlow's avatar
Simon Marlow committed
30 31 32
import TcHsType
import TcPat
import TcMType
cactus's avatar
cactus committed
33
import ConLike
34
import Inst( deeplyInstantiate )
35 36
import FamInstEnv( normaliseType )
import FamInst( tcGetFamInstEnvs )
37
import TyCon
Simon Marlow's avatar
Simon Marlow committed
38 39
import TcType
import TysPrim
40
import TysWiredIn
Simon Marlow's avatar
Simon Marlow committed
41
import Id
42
import Var
43
import VarSet
44
import VarEnv( TidyEnv )
45
import Module
Simon Marlow's avatar
Simon Marlow committed
46
import Name
47
import NameSet
48
import NameEnv
Simon Marlow's avatar
Simon Marlow committed
49
import SrcLoc
50
import Bag
Matthew Pickering's avatar
Matthew Pickering committed
51
import PatSyn
52
import ListSetOps
Simon Marlow's avatar
Simon Marlow committed
53 54 55 56 57
import ErrUtils
import Digraph
import Maybes
import Util
import BasicTypes
58
import Outputable
59
import FastString
60
import Type(mkStrLitTy)
61
import PrelNames( gHC_PRIM )
62
import TcValidity (checkValidType)
63 64

import Control.Monad
65
import Data.List (partition)
66 67

#include "HsVersions.h"
68

Austin Seipp's avatar
Austin Seipp committed
69 70 71
{-
************************************************************************
*                                                                      *
72
\subsection{Type-checking bindings}
Austin Seipp's avatar
Austin Seipp committed
73 74
*                                                                      *
************************************************************************
75

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

87
The real work is done by @tcBindWithSigsAndThen@.
88 89 90 91 92 93 94 95 96 97

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.

98 99 100
At the top-level the LIE is sure to contain nothing but constant
dictionaries, which we resolve at the module level.

101 102
Note [Polymorphic recursion]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103
The game plan for polymorphic recursion in the code above is
104 105

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

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

161 162 163 164
tcTopBinds :: HsValBinds Name -> TcM (TcGblEnv, TcLclEnv)
-- The TcGblEnv contains the new tcg_binds and tcg_spects
-- The TcLclEnv has an extended type envt for the new bindings
tcTopBinds (ValBindsOut binds sigs)
cactus's avatar
cactus committed
165 166 167 168 169
  = 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) }
170 171
        ; specs <- tcImpPrags sigs   -- SPECIALISE prags for imported Ids

172 173 174 175
        ; let { tcg_env' = tcg_env { tcg_binds = foldr (unionBags . snd)
                                                       (tcg_binds tcg_env)
                                                       binds'
                                   , tcg_imp_specs = specs ++ tcg_imp_specs tcg_env } }
176 177

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

181 182 183 184
tcTopBinds (ValBindsIn {}) = panic "tcTopBinds"

tcRecSelBinds :: HsValBinds Name -> TcM TcGblEnv
tcRecSelBinds (ValBindsOut binds sigs)
185 186
  = tcExtendGlobalValEnv [sel_id | L _ (IdSig sel_id) <- sigs] $
    do { (rec_sel_binds, tcg_env) <- discardWarnings (tcValBinds TopLevel binds sigs getGblEnv)
187
       ; let tcg_env'
188
              | isHsBoot (tcg_src tcg_env) = tcg_env
189 190 191
              | otherwise = tcg_env { tcg_binds = foldr (unionBags . snd)
                                                        (tcg_binds tcg_env)
                                                        rec_sel_binds }
192 193
              -- Do not add the code for record-selector bindings when
              -- compiling hs-boot files
194 195
       ; return tcg_env' }
tcRecSelBinds (ValBindsIn {}) = panic "tcRecSelBinds"
196

197
tcHsBootSigs :: HsValBinds Name -> TcM [Id]
198 199
-- A hs-boot file has only one BindGroup, and it only has type
-- signatures in it.  The renamer checked all this
200
tcHsBootSigs (ValBindsOut binds sigs)
Ian Lynagh's avatar
Ian Lynagh committed
201
  = do  { checkTc (null binds) badBootDeclErr
202
        ; concat <$> mapM (addLocM tc_boot_sig) (filter isTypeLSig sigs) }
203
  where
204
    tc_boot_sig (TypeSig lnames hs_ty _) = mapM f lnames
205
      where
206 207 208
        f (L _ name)
          = do { sigma_ty <- tcHsSigType (FunSigCtxt name False) hs_ty
               ; return (mkVanillaGlobal name sigma_ty) }
Ian Lynagh's avatar
Ian Lynagh committed
209
        -- Notice that we make GlobalIds, not LocalIds
Ian Lynagh's avatar
Ian Lynagh committed
210
    tc_boot_sig s = pprPanic "tcHsBootSigs/tc_boot_sig" (ppr s)
211
tcHsBootSigs groups = pprPanic "tcHsBootSigs" (ppr groups)
212

213
badBootDeclErr :: MsgDoc
Ian Lynagh's avatar
Ian Lynagh committed
214
badBootDeclErr = ptext (sLit "Illegal declarations in an hs-boot file")
215

216 217
------------------------
tcLocalBinds :: HsLocalBinds Name -> TcM thing
Ian Lynagh's avatar
Ian Lynagh committed
218
             -> TcM (HsLocalBinds TcId, thing)
sof's avatar
sof committed
219

220
tcLocalBinds EmptyLocalBinds thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
221 222
  = do  { thing <- thing_inside
        ; return (EmptyLocalBinds, thing) }
sof's avatar
sof committed
223

224 225 226 227
tcLocalBinds (HsValBinds (ValBindsOut binds sigs)) thing_inside
  = do  { (binds', thing) <- tcValBinds NotTopLevel binds sigs thing_inside
        ; return (HsValBinds (ValBindsOut binds' sigs), thing) }
tcLocalBinds (HsValBinds (ValBindsIn {})) _ = panic "tcLocalBinds"
228

229
tcLocalBinds (HsIPBinds (IPBinds ip_binds _)) thing_inside
230
  = do  { (given_ips, ip_binds') <-
231
            mapAndUnzipM (wrapLocSndM (tc_ip_bind ipClass)) ip_binds
232

233
        -- If the binding binds ?x = E, we  must now
Ian Lynagh's avatar
Ian Lynagh committed
234
        -- discharge any ?x constraints in expr_lie
235
        -- See Note [Implicit parameter untouchables]
236
        ; (ev_binds, result) <- checkConstraints (IPSkol ips)
237
                                  [] given_ips thing_inside
238 239

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

Ian Lynagh's avatar
Ian Lynagh committed
243 244 245
        -- I wonder if we should do these one at at time
        -- Consider     ?x = 4
        --              ?y = ?x + 1
Alan Zimmerman's avatar
Alan Zimmerman committed
246
    tc_ip_bind ipClass (IPBind (Left (L _ ip)) expr)
247
       = do { ty <- newFlexiTyVarTy openTypeKind
248 249
            ; let p = mkStrLitTy $ hsIPNameFS ip
            ; ip_id <- newDict ipClass [ p, ty ]
250
            ; expr' <- tcMonoExpr expr ty
251 252 253 254 255 256
            ; let d = toDict ipClass p ty `fmap` expr'
            ; return (ip_id, (IPBind (Right ip_id) d)) }
    tc_ip_bind _ (IPBind (Right {}) _) = panic "tc_ip_bind"

    -- Coerces a `t` into a dictionry for `IP "x" t`.
    -- co : t -> IP "x" t
257 258
    toDict ipClass x ty = HsWrap $ mkWpCast $ TcCoercion $
                          wrapIP $ mkClassPred ipClass [x,ty]
259

Austin Seipp's avatar
Austin Seipp committed
260
{-
261 262 263 264 265 266 267
Note [Implicit parameter untouchables]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
268
doesn't float that solved constraint out (it's not an unsolved
269
wanted).  Result disaster: the (Num alpha) is again solved, this
270 271
time by defaulting.  No no no.

272
However [Oct 10] this is all handled automatically by the
273 274
untouchable-range idea.

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
Note [Placeholder PatSyn kinds]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider this (Trac #9161)

  {-# LANGUAGE PatternSynonyms, DataKinds #-}
  pattern A = ()
  b :: A
  b = undefined

Here, the type signature for b mentions A.  But A is a pattern
synonym, which is typechecked (for very good reasons; a view pattern
in the RHS may mention a value binding) as part of a group of
bindings.  It is entirely resonable to reject this, but to do so
we need A to be in the kind environment when kind-checking the signature for B.

Hence the tcExtendKindEnv2 patsyn_placeholder_kinds, which adds a binding
    A -> AGlobal (AConLike (PatSynCon _|_))
to the environment. Then TcHsType.tcTyVar will find A in the kind environment,
and will give a 'wrongThingErr' as a result.  But the lookup of A won't fail.

The _|_ (= panic "fakePatSynCon") works because the wrongThingErr call, in
tcTyVar, doesn't look inside the TcTyThing.
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343

Note [Inlining and hs-boot files]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider this example (Trac #10083):

    ---------- RSR.hs-boot ------------
    module RSR where
      data RSR
      eqRSR :: RSR -> RSR -> Bool

    ---------- SR.hs ------------
    module SR where
      import {-# SOURCE #-} RSR
      data SR = MkSR RSR
      eqSR (MkSR r1) (MkSR r2) = eqRSR r1 r2

    ---------- RSR.hs ------------
    module RSR where
      import SR
      data RSR = MkRSR SR -- deriving( Eq )
      eqRSR (MkRSR s1) (MkRSR s2) = (eqSR s1 s2)
      foo x y = not (eqRSR x y)

When compiling RSR we get this code

    RSR.eqRSR :: RSR -> RSR -> Bool
    RSR.eqRSR = \ (ds1 :: RSR.RSR) (ds2 :: RSR.RSR) ->
                case ds1 of _ { RSR.MkRSR s1 ->
                case ds2 of _ { RSR.MkRSR s2 ->
                SR.eqSR s1 s2 }}

    RSR.foo :: RSR -> RSR -> Bool
    RSR.foo = \ (x :: RSR) (y :: RSR) -> not (RSR.eqRSR x y)

Now, when optimising foo:
    Inline eqRSR (small, non-rec)
    Inline eqSR  (small, non-rec)
but the result of inlining eqSR from SR is another call to eqRSR, so
everything repeats.  Neither eqSR nor eqRSR are (apparently) loop
breakers.

Solution: when compiling RSR, add a NOINLINE pragma to every function
exported by the boot-file for RSR (if it exists).

ALAS: doing so makes the boostrappted GHC itself slower by 8% overall
      (on Trac #9872a-d, and T1969.  So I un-did this change, and
      parked it for now.  Sigh.
Austin Seipp's avatar
Austin Seipp committed
344
-}
345

346
tcValBinds :: TopLevelFlag
347 348
           -> [(RecFlag, LHsBinds Name)] -> [LSig Name]
           -> TcM thing
349
           -> TcM ([(RecFlag, LHsBinds TcId)], thing)
350

351
tcValBinds top_lvl binds sigs thing_inside
352
  = do  {  -- Typecheck the signature
353
        ; (poly_ids, sig_fn) <- tcExtendKindEnv2 patsyn_placeholder_kinds $
thomasw's avatar
thomasw committed
354
                                         -- See Note [Placeholder PatSyn kinds]
355
                                tcTySigs sigs
Ian Lynagh's avatar
Ian Lynagh committed
356

357 358 359 360 361 362 363 364 365 366 367 368 369
        ; _self_boot <- tcSelfBootInfo
        ; let prag_fn = mkPragEnv sigs (foldr (unionBags . snd) emptyBag binds)

-- -------  See Note [Inlining and hs-boot files] (change parked) --------
--              prag_fn | isTopLevel top_lvl   -- See Note [Inlining and hs-boot files]
--                      , SelfBoot { sb_ids = boot_id_names } <- self_boot
--                      = foldNameSet add_no_inl prag_fn1 boot_id_names
--                      | otherwise
--                      = prag_fn1
--              add_no_inl boot_id_name prag_fn
--                = extendPragEnv prag_fn (boot_id_name, no_inl_sig boot_id_name)
--              no_inl_sig name = L boot_loc (InlineSig (L boot_loc name) neverInlinePragma)
--              boot_loc = mkGeneralSrcSpan (fsLit "The hs-boot file for this module")
Ian Lynagh's avatar
Ian Lynagh committed
370

371 372 373 374 375
                -- Extend the envt right away with all the Ids
                -- declared with complete type signatures
                -- Do not extend the TcIdBinderStack; instead
                -- we extend it on a per-rhs basis in tcExtendForRhs
        ; tcExtendLetEnvIds top_lvl [(idName id, id) | id <- poly_ids] $ do
376 377
            { (binds', (extra_binds', thing)) <- tcBindGroups top_lvl sig_fn prag_fn binds $ do
                   { thing <- thing_inside
378 379 380
                     -- See Note [Pattern synonym builders don't yield dependencies]
                   ; patsyn_builders <- mapM tcPatSynBuilderBind patsyns
                   ; let extra_binds = [ (NonRecursive, builder) | builder <- patsyn_builders ]
381 382
                   ; return (extra_binds, thing) }
             ; return (binds' ++ extra_binds', thing) }}
383
  where
384
    patsyns = [psb | (_, lbinds) <- binds, L _ (PatSynBind psb) <- bagToList lbinds]
385
    patsyn_placeholder_kinds -- See Note [Placeholder PatSyn kinds]
386
      = [(name, placeholder_patsyn_tything)| PSB{ psb_id = L _ name } <- patsyns ]
387
    placeholder_patsyn_tything
388
      = AGlobal $ AConLike $ PatSynCon $ panic "fakePatSynCon"
389

390
------------------------
391
tcBindGroups :: TopLevelFlag -> TcSigFun -> TcPragEnv
Ian Lynagh's avatar
Ian Lynagh committed
392 393
             -> [(RecFlag, LHsBinds Name)] -> TcM thing
             -> TcM ([(RecFlag, LHsBinds TcId)], thing)
394 395
-- Typecheck a whole lot of value bindings,
-- one strongly-connected component at a time
396
-- Here a "strongly connected component" has the strightforward
397
-- meaning of a group of bindings that mention each other,
398
-- ignoring type signatures (that part comes later)
399

400
tcBindGroups _ _ _ [] thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
401 402
  = do  { thing <- thing_inside
        ; return ([], thing) }
403

404
tcBindGroups top_lvl sig_fn prag_fn (group : groups) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
405
  = do  { (group', (groups', thing))
406
                <- tc_group top_lvl sig_fn prag_fn group $
407
                   tcBindGroups top_lvl sig_fn prag_fn groups thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
408
        ; return (group' ++ groups', thing) }
sof's avatar
sof committed
409

410
------------------------
411
tc_group :: forall thing.
412
            TopLevelFlag -> TcSigFun -> TcPragEnv
Ian Lynagh's avatar
Ian Lynagh committed
413 414
         -> (RecFlag, LHsBinds Name) -> TcM thing
         -> TcM ([(RecFlag, LHsBinds TcId)], thing)
415 416

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

420
tc_group top_lvl sig_fn prag_fn (NonRecursive, binds) thing_inside
Ian Lynagh's avatar
Ian Lynagh committed
421 422
        -- A single non-recursive binding
        -- We want to keep non-recursive things non-recursive
423
        -- so that we desugar unlifted bindings correctly
cactus's avatar
cactus committed
424 425
  = do { let bind = case bagToList binds of
                 [bind] -> bind
426 427
                 []     -> panic "tc_group: empty list of binds"
                 _      -> panic "tc_group: NonRecursive binds is not a singleton bag"
cactus's avatar
cactus committed
428 429
       ; (bind', thing) <- tc_single top_lvl sig_fn prag_fn bind thing_inside
       ; return ( [(NonRecursive, bind')], thing) }
430 431

tc_group top_lvl sig_fn prag_fn (Recursive, binds) thing_inside
432 433
  =     -- To maximise polymorphism, we do a new
        -- strongly-connected-component analysis, this time omitting
Ian Lynagh's avatar
Ian Lynagh committed
434
        -- any references to variables with type signatures.
435
        -- (This used to be optional, but isn't now.)
436
    do  { traceTc "tc_group rec" (pprLHsBinds binds)
cactus's avatar
cactus committed
437
        ; when hasPatSyn $ recursivePatSynErr binds
438
        ; (binds1, thing) <- go sccs
439
        ; return ([(Recursive, binds1)], thing) }
Ian Lynagh's avatar
Ian Lynagh committed
440
                -- Rec them all together
441
  where
442
    hasPatSyn = anyBag (isPatSyn . unLoc) binds
cactus's avatar
cactus committed
443 444 445
    isPatSyn PatSynBind{} = True
    isPatSyn _ = False

446
    sccs :: [SCC (LHsBind Name)]
447 448
    sccs = stronglyConnCompFromEdgedVertices (mkEdges sig_fn binds)

449
    go :: [SCC (LHsBind Name)] -> TcM (LHsBinds TcId, thing)
450 451
    go (scc:sccs) = do  { (binds1, ids1) <- tc_scc scc
                        ; (binds2, thing) <- tcExtendLetEnv top_lvl ids1 $
452 453 454
                                             go sccs
                        ; return (binds1 `unionBags` binds2, thing) }
    go []         = do  { thing <- thing_inside; return (emptyBag, thing) }
455

456 457
    tc_scc (AcyclicSCC bind) = tc_sub_group NonRecursive [bind]
    tc_scc (CyclicSCC binds) = tc_sub_group Recursive    binds
sof's avatar
sof committed
458

459
    tc_sub_group = tcPolyBinds top_lvl sig_fn prag_fn Recursive
sof's avatar
sof committed
460

cactus's avatar
cactus committed
461 462 463 464
recursivePatSynErr :: OutputableBndr name => LHsBinds name -> TcM a
recursivePatSynErr binds
  = failWithTc $
    hang (ptext (sLit "Recursive pattern synonym definition with following bindings:"))
465
       2 (vcat $ map pprLBind . bagToList $ binds)
cactus's avatar
cactus committed
466 467 468 469 470 471
  where
    pprLoc loc  = parens (ptext (sLit "defined at") <+> ppr loc)
    pprLBind (L loc bind) = pprWithCommas ppr (collectHsBindBinders bind) <+>
                            pprLoc loc

tc_single :: forall thing.
472
            TopLevelFlag -> TcSigFun -> TcPragEnv
473
          -> LHsBind Name -> TcM thing
cactus's avatar
cactus committed
474
          -> TcM (LHsBinds TcId, thing)
475
tc_single _top_lvl sig_fn _prag_fn (L _ (PatSynBind psb@PSB{ psb_id = L _ name })) thing_inside
Matthew Pickering's avatar
Matthew Pickering committed
476
  = do { (pat_syn, aux_binds, tcg_env) <- tc_pat_syn_decl
cactus's avatar
cactus committed
477
       ; let tything = AConLike (PatSynCon pat_syn)
Matthew Pickering's avatar
Matthew Pickering committed
478
       ; thing <- setGblEnv tcg_env  $ tcExtendGlobalEnv [tything] thing_inside
cactus's avatar
cactus committed
479 480
       ; return (aux_binds, thing)
       }
481
  where
Matthew Pickering's avatar
Matthew Pickering committed
482
    tc_pat_syn_decl :: TcM (PatSyn, LHsBinds TcId, TcGblEnv)
483
    tc_pat_syn_decl = case sig_fn name of
484 485 486
        Nothing                 -> tcInferPatSynDecl psb
        Just (TcPatSynSig tpsi) -> tcCheckPatSynDecl psb tpsi
        Just                 _  -> panic "tc_single"
487

cactus's avatar
cactus committed
488
tc_single top_lvl sig_fn prag_fn lbind thing_inside
489 490 491 492
  = do { (binds1, ids) <- tcPolyBinds top_lvl sig_fn prag_fn
                                      NonRecursive NonRecursive
                                      [lbind]
       ; thing <- tcExtendLetEnv top_lvl ids thing_inside
cactus's avatar
cactus committed
493
       ; return (binds1, thing) }
494

495
------------------------
496
mkEdges :: TcSigFun -> LHsBinds Name -> [Node BKey (LHsBind Name)]
497

498
type BKey = Int -- Just number off the bindings
499 500

mkEdges sig_fn binds
501
  = [ (bind, key, [key | n <- nameSetElems (bind_fvs (unLoc bind)),
Ian Lynagh's avatar
Ian Lynagh committed
502
                         Just key <- [lookupNameEnv key_map n], no_sig n ])
503 504 505 506
    | (bind, key) <- keyd_binds
    ]
  where
    no_sig :: Name -> Bool
thomasw's avatar
thomasw committed
507
    no_sig n = noCompleteSig (sig_fn n)
508 509 510

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

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

515
------------------------
516
tcPolyBinds :: TopLevelFlag -> TcSigFun -> TcPragEnv
517 518 519 520
            -> RecFlag         -- Whether the group is really recursive
            -> RecFlag         -- Whether it's recursive after breaking
                               -- dependencies based on type signatures
            -> [LHsBind Name]  -- None are PatSynBind
521
            -> TcM (LHsBinds TcId, [TcId])
522

523
-- Typechecks a single bunch of values bindings all together,
524 525 526
-- and generalises them.  The bunch may be only part of a recursive
-- group, because we use type signatures to maximise polymorphism
--
527 528
-- Returns a list because the input may be a single non-recursive binding,
-- in which case the dependency order of the resulting bindings is
529 530
-- important.
--
531
-- Knows nothing about the scope of the bindings
532
-- None of the bindings are pattern synonyms
533

534 535
tcPolyBinds top_lvl sig_fn prag_fn rec_group rec_tc bind_list
  = setSrcSpan loc                              $
536
    recoverM (recoveryCode binder_names sig_fn) $ do
537
        -- Set up main recover; take advantage of any type sigs
538

539
    { traceTc "------------------------------------------------" Outputable.empty
540
    ; traceTc "Bindings for {" (ppr binder_names)
541
    ; dflags   <- getDynFlags
542
    ; type_env <- getLclTypeEnv
543
    ; let plan = decideGeneralisationPlan dflags type_env
544
                         binder_names bind_list sig_fn
545
    ; traceTc "Generalisation plan" (ppr plan)
546 547 548 549
    ; result@(tc_binds, poly_ids) <- case plan of
         NoGen              -> tcPolyNoGen rec_tc prag_fn sig_fn bind_list
         InferGen mn        -> tcPolyInfer rec_tc prag_fn sig_fn mn bind_list
         CheckGen lbind sig -> tcPolyCheck rec_tc prag_fn sig lbind
550

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
551
        -- Check whether strict bindings are ok
Ian Lynagh's avatar
Ian Lynagh committed
552 553
        -- These must be non-recursive etc, and are not generalised
        -- They desugar to a case expression in the end
554 555 556 557
    ; checkStrictBinds top_lvl rec_group bind_list tc_binds poly_ids
    ; traceTc "} End of bindings for" (vcat [ ppr binder_names, ppr rec_group
                                            , vcat [ppr id <+> ppr (idType id) | id <- poly_ids]
                                          ])
558

559
    ; return result }
560
  where
561 562
    binder_names = collectHsBindListBinders bind_list
    loc = foldr1 combineSrcSpans (map getLoc bind_list)
563
         -- The mbinds have been dependency analysed and
564
         -- may no longer be adjacent; so find the narrowest
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
565
         -- span that includes them all
566

567
------------------
568
tcPolyNoGen     -- No generalisation whatsoever
569
  :: RecFlag       -- Whether it's recursive after breaking
570
                   -- dependencies based on type signatures
571
  -> TcPragEnv -> TcSigFun
572
  -> [LHsBind Name]
573
  -> TcM (LHsBinds TcId, [TcId])
574

575 576
tcPolyNoGen rec_tc prag_fn tc_sig_fn bind_list
  = do { (binds', mono_infos) <- tcMonoBinds rec_tc tc_sig_fn
577
                                             (LetGblBndr prag_fn)
578
                                             bind_list
579
       ; mono_ids' <- mapM tc_mono_info mono_infos
580
       ; return (binds', mono_ids') }
581 582
  where
    tc_mono_info (name, _, mono_id)
583
      = do { mono_ty' <- zonkTcType (idType mono_id)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
584
             -- Zonk, mainly to expose unboxed types to checkStrictBinds
585
           ; let mono_id' = setIdType mono_id mono_ty'
586
           ; _specs <- tcSpecPrags mono_id' (lookupPragEnv prag_fn name)
587
           ; return mono_id' }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
588 589 590 591
           -- 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
592 593

------------------
594
tcPolyCheck :: RecFlag       -- Whether it's recursive after breaking
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
595
                             -- dependencies based on type signatures
596
            -> TcPragEnv
597
            -> TcIdSigInfo
598
            -> LHsBind Name
599
            -> TcM (LHsBinds TcId, [TcId])
600
-- There is just one binding,
601
--   it binds a single variable,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
602
--   it has a complete type signature,
603
tcPolyCheck rec_tc prag_fn
604 605 606 607 608 609
            sig@(TISI { sig_bndr  = CompleteSig poly_id
                      , sig_tvs   = tvs_w_scoped
                      , sig_theta = theta
                      , sig_tau   = tau
                      , sig_ctxt  = ctxt
                      , sig_loc   = loc })
610
            bind
611 612
  = do { ev_vars <- newEvVars theta
       ; let skol_info = SigSkol ctxt (mkPhiTy theta tau)
613
             prag_sigs = lookupPragEnv prag_fn name
614
             tvs = map snd tvs_w_scoped
615 616 617 618
                 -- Find the location of the original source type sig, if
                 -- there is was one.  This will appear in messages like
                 -- "type variable x is bound by .. at <loc>"
             name = idName poly_id
619 620
       ; (ev_binds, (binds', [mono_info]))
            <- setSrcSpan loc $
621
               checkConstraints skol_info tvs ev_vars $
622
               tcMonoBinds rec_tc (\_ -> Just (TcIdSig sig)) LetLclBndr [bind]
623

624 625
       ; spec_prags <- tcSpecPrags poly_id prag_sigs
       ; poly_id    <- addInlinePrags poly_id prag_sigs
626

627 628 629 630 631
       ; let (_, _, mono_id) = mono_info
             export = ABE { abe_wrap = idHsWrapper
                          , abe_poly = poly_id
                          , abe_mono = mono_id
                          , abe_prags = SpecPrags spec_prags }
632
             abs_bind = L loc $ AbsBinds
633
                        { abs_tvs = tvs
634
                        , abs_ev_vars = ev_vars, abs_ev_binds = [ev_binds]
635
                        , abs_exports = [export], abs_binds = binds' }
636
       ; return (unitBag abs_bind, [poly_id]) }
637

638 639 640
tcPolyCheck _rec_tc _prag_fn sig _bind
  = pprPanic "tcPolyCheck" (ppr sig)

641
------------------
642
tcPolyInfer
643
  :: RecFlag       -- Whether it's recursive after breaking
644
                   -- dependencies based on type signatures
645
  -> TcPragEnv -> TcSigFun
646
  -> Bool         -- True <=> apply the monomorphism restriction
647
  -> [LHsBind Name]
648 649
  -> TcM (LHsBinds TcId, [TcId])
tcPolyInfer rec_tc prag_fn tc_sig_fn mono bind_list
650 651
  = do { ((binds', mono_infos), tclvl, wanted)
             <- pushLevelAndCaptureConstraints  $
652
                tcMonoBinds rec_tc tc_sig_fn LetLclBndr bind_list
653

654
       ; let name_taus = [(name, idType mono_id) | (name, _, mono_id) <- mono_infos]
655 656
             sig_qtvs   = [ tv | (_, Just sig, _) <- mono_infos
                               , (_, tv) <- sig_tvs sig ]
657
       ; traceTc "simplifyInfer call" (ppr name_taus $$ ppr wanted)
658
       ; (qtvs, givens, ev_binds)
659
                 <- simplifyInfer tclvl mono sig_qtvs name_taus wanted
660

661
       ; let inferred_theta = map evVarPred givens
662 663
       ; exports <- checkNoErrs $
                    mapM (mkExport prag_fn qtvs inferred_theta) mono_infos
thomasw's avatar
thomasw committed
664

665
       ; loc <- getSrcSpanM
666
       ; let poly_ids = map abe_poly exports
667
             abs_bind = L loc $
668
                        AbsBinds { abs_tvs = qtvs
669
                                 , abs_ev_vars = givens, abs_ev_binds = [ev_binds]
670
                                 , abs_exports = exports, abs_binds = binds' }
671

672 673
       ; traceTc "Binding:" (ppr (poly_ids `zip` map idType poly_ids))
       ; return (unitBag abs_bind, poly_ids) }
674
         -- poly_ids are guaranteed zonked by mkExport
675 676

--------------
677
mkExport :: TcPragEnv
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
678
         -> [TyVar] -> TcThetaType      -- Both already zonked
Ian Lynagh's avatar
Ian Lynagh committed
679
         -> MonoBindInfo
680
         -> TcM (ABExport Id)
681 682 683 684
-- Only called for generalisation plan IferGen, not by CheckGen or NoGen
--
-- mkExport generates exports with
--      zonked type variables,
Ian Lynagh's avatar
Ian Lynagh committed
685
--      zonked poly_ids
686 687 688 689
-- 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
690
-- type environment; see the invariant on TcEnv.tcExtendIdEnv
691

692
-- Pre-condition: the qtvs and theta are already zonked
693

thomasw's avatar
thomasw committed
694
mkExport prag_fn qtvs inferred_theta (poly_name, mb_sig, mono_id)
695
  = do  { mono_ty <- zonkTcType (idType mono_id)
696

697 698 699
        ; (poly_id, inferred) <- case mb_sig of
              Nothing  -> do { poly_id <- mkInferredPolyId poly_name qtvs inferred_theta mono_ty
                             ; return (poly_id, True) }
700
              Just sig | Just poly_id <- completeIdSigPolyId_maybe sig
701 702 703 704 705
                       -> return (poly_id, False)
                       | otherwise
                       -> do { final_theta <- completeTheta inferred_theta sig
                             ; poly_id <- mkInferredPolyId poly_name qtvs final_theta mono_ty
                             ; return (poly_id, True) }
706 707

        -- NB: poly_id has a zonked type
708
        ; poly_id <- addInlinePrags poly_id prag_sigs
709
        ; spec_prags <- tcSpecPrags poly_id prag_sigs
Ian Lynagh's avatar
Ian Lynagh committed
710
                -- tcPrags requires a zonked poly_id
711

thomasw's avatar
thomasw committed
712
        ; let sel_poly_ty = mkSigmaTy qtvs inferred_theta mono_ty
713
        ; traceTc "mkExport: check sig"
thomasw's avatar
thomasw committed
714
                  (vcat [ ppr poly_name, ppr sel_poly_ty, ppr (idType poly_id) ])
715

Gabor Greif's avatar
Gabor Greif committed
716
        -- Perform the impedance-matching and ambiguity check
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
717 718
        -- right away.  If it fails, we want to fail now (and recover
        -- in tcPolyBinds).  If we delay checking, we get an error cascade.
719
        -- Remember we are in the tcPolyInfer case, so the type envt is
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
720 721
        -- closed (unless we are doing NoMonoLocalBinds in which case all bets
        -- are off)
722
        -- See Note [Impedence matching]
723
        ; (wrap, wanted) <- addErrCtxtM (mk_bind_msg inferred True poly_name (idType poly_id)) $
724
                            captureConstraints $
725
                            tcSubType_NC sig_ctxt sel_poly_ty (idType poly_id)
726
        ; ev_binds <- simplifyTop wanted
727 728 729 730

        ; return (ABE { abe_wrap = mkWpLet (EvBinds ev_binds) <.> wrap
                      , abe_poly = poly_id
                      , abe_mono = mono_id
731
                      , abe_prags = SpecPrags spec_prags}) }
732
  where
733
    prag_sigs = lookupPragEnv prag_fn poly_name
734
    sig_ctxt  = InfSigCtxt poly_name
735 736 737 738 739 740

mkInferredPolyId :: Name -> [TyVar] -> TcThetaType -> TcType -> TcM Id
-- In the inference case (no signature) this stuff figures out
-- the right type variables and theta to quantify over
-- See Note [Validity of inferred types]
mkInferredPolyId poly_name qtvs theta mono_ty
741 742 743
  = do { fam_envs <- tcGetFamInstEnvs

       ; let (_co, norm_mono_ty) = normaliseType fam_envs Nominal mono_ty
744 745
               -- Unification may not have normalised the type,
               -- (see Note [Lazy flattening] in TcFlatten) so do it
746 747 748
               -- here to make it as uncomplicated as possible.
               -- Example: f :: [F Int] -> Bool
               -- should be rewritten to f :: [Char] -> Bool, if possible
749

750
             my_tvs2 = closeOverKinds (growThetaTyVars theta (tyVarsOfType norm_mono_ty))
751
                  -- Include kind variables!  Trac #7916
752

753 754
       ; my_theta <- pickQuantifiablePreds my_tvs2 theta

Simon Peyton Jones's avatar
Simon Peyton Jones committed
755
       ; let my_tvs = filter (`elemVarSet` my_tvs2) qtvs   -- Maintain original order
756 757 758 759
             inferred_poly_ty = mkSigmaTy my_tvs my_theta norm_mono_ty

       ; addErrCtxtM (mk_bind_msg True False poly_name inferred_poly_ty) $
         checkValidType (InfSigCtxt poly_name) inferred_poly_ty
760

761
       ; return (mkLocalId poly_name inferred_poly_ty) }
762 763 764

mk_bind_msg :: Bool -> Bool -> Name -> TcType -> TidyEnv -> TcM (TidyEnv, SDoc)
mk_bind_msg inferred want_ambig poly_name poly_ty tidy_env
765 766
 = do { (tidy_env', tidy_ty) <- zonkTidyTcType tidy_env poly_ty
      ; return (tidy_env', mk_msg tidy_ty) }
767
 where
768 769 770 771 772
   mk_msg ty = vcat [ ptext (sLit "When checking that") <+> quotes (ppr poly_name)
                      <+> ptext (sLit "has the") <+> what <+> ptext (sLit "type")
                    , nest 2 (ppr poly_name <+> dcolon <+> ppr ty)
                    , ppWhen want_ambig $
                      ptext (sLit "Probable cause: the inferred type is ambiguous") ]
773 774
   what | inferred  = ptext (sLit "inferred")
        | otherwise = ptext (sLit "specified")
thomasw's avatar
thomasw committed
775 776 777 778 779 780


-- | Report the inferred constraints for an extra-constraints wildcard/hole as
-- an error message, unless the PartialTypeSignatures flag is enabled. In this
-- case, the extra inferred constraints are accepted without complaining.
-- Returns the annotated constraints combined with the inferred constraints.
781
completeTheta :: TcThetaType -> TcIdSigInfo -> TcM TcThetaType
thomasw's avatar
thomasw committed
782
completeTheta inferred_theta
783 784 785
              (TISI { sig_bndr  = s_bndr
                    , sig_theta = annotated_theta })
  | PartialSig { sig_cts = Just loc } <- s_bndr
thomasw's avatar
thomasw committed
786 787 788 789 790 791 792
  = do { annotated_theta <- zonkTcThetaType annotated_theta
       ; let inferred_diff = minusList inferred_theta annotated_theta
             final_theta   = annotated_theta ++ inferred_diff
       ; partial_sigs      <- xoptM Opt_PartialTypeSignatures
       ; warn_partial_sigs <- woptM Opt_WarnPartialTypeSignatures
       ; msg <- mkLongErrAt loc (mk_msg inferred_diff partial_sigs) empty
       ; case partial_sigs of
793
           True | warn_partial_sigs -> reportWarning msg
thomasw's avatar
thomasw committed
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
                | otherwise         -> return ()
           False                    -> reportError msg
       ; return final_theta }

  | otherwise
  = zonkTcThetaType annotated_theta
    -- No extra-constraints wildcard means no extra constraints will be added
    -- to the context, so just return the possibly empty (zonked)
    -- annotated_theta.
  where
    pts_hint = text "To use the inferred type, enable PartialTypeSignatures"
    mk_msg inferred_diff suppress_hint
       = vcat [ hang ((text "Found hole") <+> quotes (char '_'))
                   2 (text "with inferred constraints:")
                      <+> pprTheta inferred_diff
              , if suppress_hint then empty else pts_hint
810
              , typeSigCtxt s_bndr ]
811

Austin Seipp's avatar
Austin Seipp committed
812
{-
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
Note [Partial type signatures and generalisation]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When we have a partial type signature, like
   f :: _ -> Int
then we *always* use the InferGen plan, and hence tcPolyInfer.
We do this even for a local binding with -XMonoLocalBinds.
Reasons:
  * The TcSigInfo for 'f' has a unification variable for the '_',
    whose TcLevel is one level deeper than the current level.
    (See pushTcLevelM in tcTySig.)  But NoGen doesn't increase
    the TcLevel like InferGen, so we lose the level invariant.

  * The signature might be   f :: forall a. _ -> a
    so it really is polymorphic.  It's not clear what it would
    mean to use NoGen on this, and indeed the ASSERT in tcLhs,
    in the (Just sig) case, checks that if there is a signature
    then we are using LetLclBndr, and hence a nested AbsBinds with
    increased TcLevel

It might be possible to fix these difficulties somehow, but there
doesn't seem much point.  Indeed, adding a partial type signature is a
way to get per-binding inferred generalisation.

836 837
Note [Validity of inferred types]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
838
We need to check inferred type for validity, in case it uses language
839 840 841 842 843 844 845 846 847 848
extensions that are not turned on.  The principle is that if the user
simply adds the inferred type to the program source, it'll compile fine.
See #8883.

Examples that might fail:
 - an inferred theta that requires type equalities e.g. (F a ~ G b)
                                or multi-parameter type classes
 - an inferred type that includes unboxed tuples

However we don't do the ambiguity check (checkValidType omits it for
Gabor Greif's avatar
Gabor Greif committed
849
InfSigCtxt) because the impedance-matching stage, which follows
850
immediately, will do it and we don't want two error messages.
Gabor Greif's avatar
Gabor Greif committed
851
Moreover, because of the impedance matching stage, the ambiguity-check
852 853 854
suggestion of -XAllowAmbiguiousTypes will not work.


855 856 857 858 859 860 861 862 863 864
Note [Impedence matching]
~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
   f 0 x = x
   f n x = g [] (not x)

   g [] y = f 10 y
   g _  y = f 9  y

After typechecking we'll get
865 866
  f_mono_ty :: a -> Bool -> Bool
  g_mono_ty :: [b] -> Bool -> Bool
867 868 869 870 871 872 873 874
with constraints
  (Eq a, Num a)

Note that f is polymorphic in 'a' and g in 'b'; and these are not linked.
The types we really want for f and g are
   f :: forall a. (Eq a, Num a) => a -> Bool -> Bool
   g :: forall b. [b] -> Bool -> Bool

Gabor Greif's avatar
Gabor Greif committed
875
We can get these by "impedance matching":
876 877 878 879 880 881 882
   tuple :: forall a b. (Eq a, Num a) => (a -> Bool -> Bool, [b] -> Bool -> Bool)
   tuple a b d1 d1 = let ...bind f_mono, g_mono in (f_mono, g_mono)

   f a d1 d2 = case tuple a Any d1 d2 of (f, g) -> f
   g b = case tuple Integer b dEqInteger dNumInteger of (f,g) -> g

Suppose the shared quantified tyvars are qtvs and constraints theta.
883
Then we want to check that
884
   f's polytype  is more polymorphic than   forall qtvs. theta => f_mono_ty
Gabor Greif's avatar
Gabor Greif committed
885
and the proof is the impedance matcher.
886

Gabor Greif's avatar
Gabor Greif committed
887
Notice that the impedance matcher may do defaulting.  See Trac #7173.
888 889 890 891

It also cleverly does an ambiguity check; for example, rejecting
   f :: F a -> a
where F is a non-injective type function.
Austin Seipp's avatar
Austin Seipp committed
892
-}
893

894 895 896 897
--------------
-- If typechecking the binds fails, then return with each
-- signature-less binder given type (forall a.a), to minimise
-- subsequent error messages
898
recoveryCode :: [Name] -> TcSigFun -> TcM (LHsBinds TcId, [Id])
899 900
recoveryCode binder_names sig_fn
  = do  { traceTc "tcBindsWithSigs: error recovery" (ppr binder_names)
thomasw's avatar
thomasw committed
901
        ; let poly_ids = map mk_dummy binder_names
902
        ; return (emptyBag, poly_ids) }
903 904
  where
    mk_dummy name
905 906
      | Just sig <- sig_fn name
      , Just poly_id <- completeSigPolyId_maybe sig
thomasw's avatar
thomasw committed
907 908 909
      = poly_id
      | otherwise
      = mkLocalId name forall_a_a
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927

forall_a_a :: TcType
forall_a_a = mkForAllTy openAlphaTyVar (mkTyVarTy openAlphaTyVar)


{- *********************************************************************
*                                                                      *
                   Pragmas, including SPECIALISE
*                                                                      *
************************************************************************

Note [Handling SPECIALISE pragmas]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The basic idea is this:

   f:: Num a => a -> b -> a
   {-# SPECIALISE foo :: Int -> b -> Int #-}

928 929 930
We check that
   (forall a. Num a => a -> a)
      is more polymorphic than
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
   Int -> Int
(for which we could use tcSubType, but see below), generating a HsWrapper
to connect the two, something like
      wrap = /\b. <hole> Int b dNumInt
This wrapper is put in the TcSpecPrag, in the ABExport record of
the AbsBinds.


        f :: (Eq a, Ix b) => a -> b -> Bool
        {-# SPECIALISE f :: (Ix p, Ix q) => Int -> (p,q) -> Bool #-}
        f = <poly_rhs>

From this the typechecker generates

    AbsBinds [ab] [d1,d2] [([ab], f, f_mono, prags)] binds

    SpecPrag (wrap_fn :: forall a b. (Eq a, Ix b) => XXX
                      -> forall p q. (Ix p, Ix q) => XXX[ Int/a, (p,q)/b ])

From these we generate:

    Rule:       forall p, q, (dp:Ix p), (dq:Ix q).
                    f Int (p,q) dInt ($dfInPair dp dq) = f_spec p q dp dq

    Spec bind:  f_spec = wrap_fn <poly_rhs>

Note that

  * The LHS of the rule may mention dictionary *expressions* (eg
    $dfIxPair dp dq), and that is essential because the dp, dq are
    needed on the RHS.

  * The RHS of f_spec, <poly_rhs> has a *copy* of 'binds', so that it
    can fully specialise it.



From the TcSpecPrag, in DsBinds we generate a binding for f_spec and a RULE:

   f_spec :: Int -> b -> Int
   f_spec = wrap<f rhs>

   RULE: forall b (d:Num b). f b d = f_spec b

The RULE is generated by taking apart the HsWrapper, which is a little
Matthew Pickering's avatar
Matthew Pickering committed
976
delicate, but works.
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012

Some wrinkles

1. We don't use full-on tcSubType, because that does co and contra
   variance and that in turn will generate too complex a LHS for the
   RULE.  So we use a single invocation of deeplySkolemise /
   deeplyInstantiate in tcSpecWrapper.  (Actually I think that even
   the "deeply" stuff may be too much, because it introduces lambdas,
   though I think it can be made to work without too much trouble.)

2. We need to take care with type families (Trac #5821).  Consider
      type instance F Int = Bool
      f :: Num a => a -> F a
      {-# SPECIALISE foo :: Int -> Bool #-}

  We *could* try to generate an f_spec with precisely the declared type:
      f_spec :: Int -> Bool
      f_spec = <f rhs> Int dNumInt |> co

      RULE: forall d. f Int d = f_spec |> sym co

  but the 'co' and 'sym co' are (a) playing no useful role, and (b) are
  hard to generate.  At all costs we must avoid this:
      RULE: forall d. f Int d |> co = f_spec
  because the LHS will never match (indeed it's rejected in
  decomposeRuleLhs).

  So we simply do this:
    - Generate a constraint to check that the specialised type (after
      skolemiseation) is equal to the instantiated function type.
    - But *discard* the evidence (coercion) for that constraint,
      so that we ultimately generate the simpler code
          f_spec :: Int -> F Int
          f_spec = <f rhs> Int dNumInt

          RULE: forall d. f Int d = f_spec
1013
      You can see this discarding happening in
1014 1015 1016 1017 1018 1019 1020 1021 1022

3. Note that the HsWrapper can transform *any* function with the right
   type prefix
       forall ab. (Eq a, Ix b) => XXX
   regardless of XXX.  It's sort of polymorphic in XXX.  This is
   useful: we use the same wrapper to transform each of the class ops, as
   well as the dict.  That's what goes on in TcInstDcls.mk_meth_spec_prags
-}

1023 1024 1025
mkPragEnv :: [LSig Name] -> LHsBinds Name -> TcPragEnv
mkPragEnv sigs binds
  = foldl extendPragEnv emptyNameEnv prs
1026
  where
Icelandjack's avatar
Icelandjack committed
1027
    prs = mapMaybe get_sig sigs
1028

1029 1030 1031 1032
    get_sig :: LSig Name -> Maybe (Name, LSig Name)
    get_sig (L l (SpecSig lnm@(L _ nm) ty inl)) = Just (nm, L l $ SpecSig   lnm ty (add_arity nm inl))
    get_sig (L l (InlineSig lnm@(L _ nm) inl))  = Just (nm, L l $ InlineSig lnm    (add_arity nm inl))
    get_sig _                                   = Nothing
1033