TcBinds.hs 78.1 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2 3 4
{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998

5
\section[TcBinds]{TcBinds}
Austin Seipp's avatar
Austin Seipp committed
6
-}
7

8 9
{-# LANGUAGE CPP, RankNTypes, ScopedTypeVariables #-}

10
module TcBinds ( tcLocalBinds, tcTopBinds, tcRecSelBinds,
11
                 tcHsBootSigs, tcPolyCheck,
12 13 14 15
                 tcSpecPrags, tcSpecWrapper,
                 tcVectDecls,
                 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( isHsBootOrSig )
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 )
thomasw's avatar
thomasw committed
37
import Type( pprSigmaTypeExtraCts )
38
import TyCon
Simon Marlow's avatar
Simon Marlow committed
39 40 41
import TcType
import TysPrim
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
51
import ListSetOps
Simon Marlow's avatar
Simon Marlow committed
52 53 54 55 56
import ErrUtils
import Digraph
import Maybes
import Util
import BasicTypes
57
import Outputable
58
import FastString
59
import Type(mkStrLitTy)
60
import PrelNames( ipClassName, gHC_PRIM )
61
import TcValidity (checkValidType)
62 63

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

#include "HsVersions.h"
67

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

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

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

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.

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

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

        * Bind any variable for which we have a type signature
105
          to an Id with a polymorphic type.  Then when type-checking
106 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
          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
158
-}
159

160 161 162 163
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
164 165 166 167 168
  = 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) }
169 170 171 172 173 174 175 176
        ; specs <- tcImpPrags sigs   -- SPECIALISE prags for imported Ids

        ; let { tcg_env' = tcg_env { tcg_binds = foldr (unionBags . snd)
                                                       (tcg_binds tcg_env)
                                                       binds'
                                   , tcg_imp_specs = specs ++ tcg_imp_specs tcg_env } }

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

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

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

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

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

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

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

222 223 224 225
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"
226

227
tcLocalBinds (HsIPBinds (IPBinds ip_binds _)) thing_inside
228 229 230
  = do  { ipClass <- tcLookupClass ipClassName
        ; (given_ips, ip_binds') <-
            mapAndUnzipM (wrapLocSndM (tc_ip_bind ipClass)) ip_binds
231

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

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

Ian Lynagh's avatar
Ian Lynagh committed
242 243 244
        -- I wonder if we should do these one at at time
        -- Consider     ?x = 4
        --              ?y = ?x + 1
Alan Zimmerman's avatar
Alan Zimmerman committed
245
    tc_ip_bind ipClass (IPBind (Left (L _ ip)) expr)
246
       = do { ty <- newFlexiTyVarTy openTypeKind
247 248
            ; let p = mkStrLitTy $ hsIPNameFS ip
            ; ip_id <- newDict ipClass [ p, ty ]
249
            ; expr' <- tcMonoExpr expr ty
250 251 252 253 254 255
            ; 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
256 257
    toDict ipClass x ty = HsWrap $ mkWpCast $ TcCoercion $
                          wrapIP $ mkClassPred ipClass [x,ty]
258

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

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

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
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.
296 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

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
343
-}
344

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

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

356 357 358 359 360 361 362 363 364 365 366 367 368
        ; _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
369

370 371 372 373 374
                -- 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
375 376
            { (binds', (extra_binds', thing)) <- tcBindGroups top_lvl sig_fn prag_fn binds $ do
                   { thing <- thing_inside
377 378 379
                     -- See Note [Pattern synonym builders don't yield dependencies]
                   ; patsyn_builders <- mapM tcPatSynBuilderBind patsyns
                   ; let extra_binds = [ (NonRecursive, builder) | builder <- patsyn_builders ]
380 381
                   ; return (extra_binds, thing) }
             ; return (binds' ++ extra_binds', thing) }}
382
  where
383
    patsyns = [psb | (_, lbinds) <- binds, L _ (PatSynBind psb) <- bagToList lbinds]
384
    patsyn_placeholder_kinds -- See Note [Placeholder PatSyn kinds]
385
      = [(name, placeholder_patsyn_tything)| PSB{ psb_id = L _ name } <- patsyns ]
386
    placeholder_patsyn_tything
387
      = AGlobal $ AConLike $ PatSynCon $ panic "fakePatSynCon"
388

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

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

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

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

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

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

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

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

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

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

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

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

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

cactus's avatar
cactus committed
486
tc_single top_lvl sig_fn prag_fn lbind thing_inside
487 488 489 490
  = 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
491
       ; return (binds1, thing) }
492

thomasw's avatar
thomasw committed
493 494 495 496 497
-- | No signature or a partial signature
noCompleteSig :: Maybe TcSigInfo -> Bool
noCompleteSig Nothing    = True
noCompleteSig (Just sig) = isPartialSig sig

498
------------------------
499
mkEdges :: TcSigFun -> LHsBinds Name -> [Node BKey (LHsBind Name)]
500

501
type BKey = Int -- Just number off the bindings
502 503

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

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

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

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

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

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

542
    { traceTc "------------------------------------------------" Outputable.empty
543
    ; traceTc "Bindings for {" (ppr binder_names)
544
    ; dflags   <- getDynFlags
545
    ; type_env <- getLclTypeEnv
546
    ; let plan = decideGeneralisationPlan dflags type_env
547
                         binder_names bind_list sig_fn
548
    ; traceTc "Generalisation plan" (ppr plan)
549 550 551 552
    ; 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
553

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
554
        -- Check whether strict bindings are ok
Ian Lynagh's avatar
Ian Lynagh committed
555 556
        -- These must be non-recursive etc, and are not generalised
        -- They desugar to a case expression in the end
557 558 559 560
    ; 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]
                                          ])
561

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

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

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

------------------
597
tcPolyCheck :: RecFlag       -- Whether it's recursive after breaking
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
598
                             -- dependencies based on type signatures
599
            -> TcPragEnv
600
            -> TcSigInfo
601
            -> LHsBind Name
602
            -> TcM (LHsBinds TcId, [TcId])
603
-- There is just one binding,
604
--   it binds a single variable,
Simon Peyton Jones's avatar
Simon Peyton Jones committed
605
--   it has a complete type signature,
606
tcPolyCheck rec_tc prag_fn
thomasw's avatar
thomasw committed
607 608
            sig@(TcSigInfo { sig_name = name, sig_poly_id = Just poly_id
                           , sig_tvs = tvs_w_scoped
thomasw's avatar
thomasw committed
609
                           , sig_nwcs = sig_nwcs, sig_theta = theta
610 611
                           , sig_tau = tau, sig_loc = loc
                           , sig_warn_redundant = warn_redundant })
612
            bind
thomasw's avatar
thomasw committed
613 614
  = ASSERT( null sig_nwcs ) -- We should be in tcPolyInfer if there are wildcards
    do { ev_vars <- newEvVars theta
thomasw's avatar
thomasw committed
615
       ; let ctxt      = FunSigCtxt name warn_redundant
616
             skol_info = SigSkol ctxt (mkPhiTy theta tau)
617
             prag_sigs = lookupPragEnv prag_fn name
618
             tvs = map snd tvs_w_scoped
619 620
       ; (ev_binds, (binds', [mono_info]))
            <- setSrcSpan loc $
621
               checkConstraints skol_info tvs ev_vars $
cactus's avatar
cactus committed
622
               tcMonoBinds rec_tc (\_ -> Just 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
       ; traceTc "simplifyInfer call" (ppr name_taus $$ ppr wanted)
656
       ; (qtvs, givens, _mr_bites, ev_binds)
657
                 <- simplifyInfer tclvl mono name_taus wanted
658

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

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

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

--------------
675
mkExport :: TcPragEnv
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
676
         -> [TyVar] -> TcThetaType      -- Both already zonked
Ian Lynagh's avatar
Ian Lynagh committed
677
         -> MonoBindInfo
678
         -> TcM (ABExport Id)
679 680 681 682
-- 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
683
--      zonked poly_ids
684 685 686 687
-- 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
688
-- type environment; see the invariant on TcEnv.tcExtendIdEnv
689

690
-- Pre-condition: the qtvs and theta are already zonked
691

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

695 696 697 698 699 700 701 702 703
        ; (poly_id, inferred) <- case mb_sig of
              Nothing  -> do { poly_id <- mkInferredPolyId poly_name qtvs inferred_theta mono_ty
                             ; return (poly_id, True) }
              Just sig | Just poly_id <- completeSigPolyId_maybe sig
                       -> 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) }
704 705

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

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

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

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

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
739 740 741
  = do { fam_envs <- tcGetFamInstEnvs

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

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

751 752
       ; my_theta <- pickQuantifiablePreds my_tvs2 theta

Simon Peyton Jones's avatar
Simon Peyton Jones committed
753
       ; let my_tvs = filter (`elemVarSet` my_tvs2) qtvs   -- Maintain original order
754 755 756 757
             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
758

759
       ; return (mkLocalId poly_name inferred_poly_ty) }
760 761 762

mk_bind_msg :: Bool -> Bool -> Name -> TcType -> TidyEnv -> TcM (TidyEnv, SDoc)
mk_bind_msg inferred want_ambig poly_name poly_ty tidy_env
763 764
 = do { (tidy_env', tidy_ty) <- zonkTidyTcType tidy_env poly_ty
      ; return (tidy_env', mk_msg tidy_ty) }
765
 where
766 767 768 769 770
   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") ]
771 772
   what | inferred  = ptext (sLit "inferred")
        | otherwise = ptext (sLit "specified")
thomasw's avatar
thomasw committed
773 774 775 776 777 778 779 780 781 782


-- | 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.
completeTheta :: TcThetaType -> TcSigInfo -> TcM TcThetaType
completeTheta _ (TcPatSynInfo _)
  = panic "Extra-constraints wildcard not supported in a pattern signature"
completeTheta inferred_theta
thomasw's avatar
thomasw committed
783
              sig@(TcSigInfo { sig_extra_cts = mb_extra_cts
thomasw's avatar
thomasw committed
784 785 786 787 788 789 790 791 792
                             , sig_theta = annotated_theta })
  | Just loc <- mb_extra_cts
  = 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
thomasw's avatar
thomasw committed
810
              , typeSigCtxt sig ]
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
thomasw's avatar
thomasw committed
905 906 907 908
      | Just (TcSigInfo { sig_poly_id = Just poly_id }) <- sig_fn name
      = poly_id
      | otherwise
      = mkLocalId name forall_a_a
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926

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

927 928 929
We check that
   (forall a. Num a => a -> a)
      is more polymorphic than
930 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 976 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
   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
delicate, but works.  

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
1012
      You can see this discarding happening in
1013 1014 1015 1016 1017 1018 1019 1020 1021

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

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

1028 1029 1030 1031
    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
1032

1033 1034
    add_arity n inl_prag   -- Adjust inl_sat field to match visible arity of function
      | Inline <- inl_inline inl_prag
1035
        -- add arity only for real INLINE pragmas, not INLINABLE
1036 1037 1038 1039 1040
      = case lookupNameEnv ar_env n of
          Just ar -> inl_prag { inl_sat = Just ar }
          Nothing -> WARN( True, ptext (sLit "mkPragEnv no arity") <+> ppr n )
                     -- There really should be a binding for every INLINE pragma
                     inl_prag
1041 1042
      | otherwise
      = inl_prag
1043 1044 1045

    -- ar_env maps a local to the arity of its definition
    ar_env :: NameEnv Arity
1046
    ar_env = foldrBag lhsBindArity emptyNameEnv binds
1047

1048 1049 1050
extendPragEnv :: TcPragEnv -> (Name, LSig Name) -> TcPragEnv
extendPragEnv prag_fn (n, sig) = extendNameEnv_Acc (:) singleton prag_fn n sig

simonpj@microsoft.com's avatar