Remove the distinction between data and newtype families
[ghc-hetmet.git] / compiler / iface / TcIface.lhs
1 %
2 % (c) The University of Glasgow 2006
3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 %
5
6 Type checking of type signatures in interface files
7
8 \begin{code}
9 module TcIface ( 
10         tcImportDecl, checkWiredInTyCon, tcHiBootIface, typecheckIface, 
11         tcIfaceDecl, tcIfaceInst, tcIfaceFamInst, tcIfaceRules,
12         tcIfaceVectInfo, tcIfaceGlobal, tcExtCoreBindings
13  ) where
14
15 #include "HsVersions.h"
16
17 import IfaceSyn
18 import LoadIface
19 import IfaceEnv
20 import BuildTyCl
21 import TcRnMonad
22 import Type
23 import TypeRep
24 import HscTypes
25 import InstEnv
26 import FamInstEnv
27 import CoreSyn
28 import CoreUtils
29 import CoreUnfold
30 import CoreLint
31 import WorkWrap
32 import Id
33 import MkId
34 import IdInfo
35 import Class
36 import TyCon
37 import DataCon
38 import TysWiredIn
39 import Var              ( TyVar )
40 import qualified Var
41 import VarEnv
42 import Name
43 import NameEnv
44 import OccName
45 import Module
46 import UniqFM
47 import UniqSupply
48 import Outputable       
49 import ErrUtils
50 import Maybes
51 import SrcLoc
52 import DynFlags
53 import Control.Monad
54
55 import Data.List
56 import Data.Maybe
57 \end{code}
58
59 This module takes
60
61         IfaceDecl -> TyThing
62         IfaceType -> Type
63         etc
64
65 An IfaceDecl is populated with RdrNames, and these are not renamed to
66 Names before typechecking, because there should be no scope errors etc.
67
68         -- For (b) consider: f = $(...h....)
69         -- where h is imported, and calls f via an hi-boot file.  
70         -- This is bad!  But it is not seen as a staging error, because h
71         -- is indeed imported.  We don't want the type-checker to black-hole 
72         -- when simplifying and compiling the splice!
73         --
74         -- Simple solution: discard any unfolding that mentions a variable
75         -- bound in this module (and hence not yet processed).
76         -- The discarding happens when forkM finds a type error.
77
78 %************************************************************************
79 %*                                                                      *
80 %*      tcImportDecl is the key function for "faulting in"              *
81 %*      imported things
82 %*                                                                      *
83 %************************************************************************
84
85 The main idea is this.  We are chugging along type-checking source code, and
86 find a reference to GHC.Base.map.  We call tcLookupGlobal, which doesn't find
87 it in the EPS type envt.  So it 
88         1 loads GHC.Base.hi
89         2 gets the decl for GHC.Base.map
90         3 typechecks it via tcIfaceDecl
91         4 and adds it to the type env in the EPS
92
93 Note that DURING STEP 4, we may find that map's type mentions a type 
94 constructor that also 
95
96 Notice that for imported things we read the current version from the EPS
97 mutable variable.  This is important in situations like
98         ...$(e1)...$(e2)...
99 where the code that e1 expands to might import some defns that 
100 also turn out to be needed by the code that e2 expands to.
101
102 \begin{code}
103 tcImportDecl :: Name -> TcM TyThing
104 -- Entry point for *source-code* uses of importDecl
105 tcImportDecl name 
106   | Just thing <- wiredInNameTyThing_maybe name
107   = do  { initIfaceTcRn (loadWiredInHomeIface name) 
108         ; return thing }
109   | otherwise
110   = do  { traceIf (text "tcImportDecl" <+> ppr name)
111         ; mb_thing <- initIfaceTcRn (importDecl name)
112         ; case mb_thing of
113             Succeeded thing -> return thing
114             Failed err      -> failWithTc err }
115
116 checkWiredInTyCon :: TyCon -> TcM ()
117 -- Ensure that the home module of the TyCon (and hence its instances)
118 -- are loaded. It might not be a wired-in tycon (see the calls in TcUnify),
119 -- in which case this is a no-op.
120 checkWiredInTyCon tc    
121   | not (isWiredInName tc_name) 
122   = return ()
123   | otherwise
124   = do  { mod <- getModule
125         ; unless (mod == nameModule tc_name)
126                  (initIfaceTcRn (loadWiredInHomeIface tc_name))
127                 -- Don't look for (non-existent) Float.hi when
128                 -- compiling Float.lhs, which mentions Float of course
129                 -- A bit yukky to call initIfaceTcRn here
130         }
131   where
132     tc_name = tyConName tc
133
134 importDecl :: Name -> IfM lcl (MaybeErr Message TyThing)
135 -- Get the TyThing for this Name from an interface file
136 -- It's not a wired-in thing -- the caller caught that
137 importDecl name
138   = ASSERT( not (isWiredInName name) )
139     do  { traceIf nd_doc
140
141         -- Load the interface, which should populate the PTE
142         ; mb_iface <- loadInterface nd_doc (nameModule name) ImportBySystem
143         ; case mb_iface of {
144                 Failed err_msg  -> return (Failed err_msg) ;
145                 Succeeded iface -> do
146
147         -- Now look it up again; this time we should find it
148         { eps <- getEps 
149         ; case lookupTypeEnv (eps_PTE eps) name of
150             Just thing -> return (Succeeded thing)
151             Nothing    -> return (Failed not_found_msg)
152     }}}
153   where
154     nd_doc = ptext SLIT("Need decl for") <+> ppr name
155     not_found_msg = hang (ptext SLIT("Can't find interface-file declaration for") <+>
156                                 pprNameSpace (occNameSpace (nameOccName name)) <+> ppr name)
157                        2 (vcat [ptext SLIT("Probable cause: bug in .hi-boot file, or inconsistent .hi file"),
158                                 ptext SLIT("Use -ddump-if-trace to get an idea of which file caused the error")])
159 \end{code}
160
161 %************************************************************************
162 %*                                                                      *
163                 Type-checking a complete interface
164 %*                                                                      *
165 %************************************************************************
166
167 Suppose we discover we don't need to recompile.  Then we must type
168 check the old interface file.  This is a bit different to the
169 incremental type checking we do as we suck in interface files.  Instead
170 we do things similarly as when we are typechecking source decls: we
171 bring into scope the type envt for the interface all at once, using a
172 knot.  Remember, the decls aren't necessarily in dependency order --
173 and even if they were, the type decls might be mutually recursive.
174
175 \begin{code}
176 typecheckIface :: ModIface      -- Get the decls from here
177                -> TcRnIf gbl lcl ModDetails
178 typecheckIface iface
179   = initIfaceTc iface $ \ tc_env_var -> do
180         -- The tc_env_var is freshly allocated, private to 
181         -- type-checking this particular interface
182         {       -- Get the right set of decls and rules.  If we are compiling without -O
183                 -- we discard pragmas before typechecking, so that we don't "see"
184                 -- information that we shouldn't.  From a versioning point of view
185                 -- It's not actually *wrong* to do so, but in fact GHCi is unable 
186                 -- to handle unboxed tuples, so it must not see unfoldings.
187           ignore_prags <- doptM Opt_IgnoreInterfacePragmas
188
189                 -- Typecheck the decls.  This is done lazily, so that the knot-tying
190                 -- within this single module work out right.  In the If monad there is
191                 -- no global envt for the current interface; instead, the knot is tied
192                 -- through the if_rec_types field of IfGblEnv
193         ; names_w_things <- loadDecls ignore_prags (mi_decls iface)
194         ; let type_env = mkNameEnv names_w_things
195         ; writeMutVar tc_env_var type_env
196
197                 -- Now do those rules and instances
198         ; insts     <- mapM tcIfaceInst    (mi_insts     iface)
199         ; fam_insts <- mapM tcIfaceFamInst (mi_fam_insts iface)
200         ; rules     <- tcIfaceRules ignore_prags (mi_rules iface)
201
202                 -- Vectorisation information
203         ; vect_info <- tcIfaceVectInfo (mi_module iface) type_env 
204                                        (mi_vect_info iface)
205
206                 -- Exports
207         ; exports <- ifaceExportNames (mi_exports iface)
208
209                 -- Finished
210         ; traceIf (vcat [text "Finished typechecking interface for" <+> ppr (mi_module iface),
211                          text "Type envt:" <+> ppr type_env])
212         ; return $ ModDetails { md_types     = type_env
213                               , md_insts     = insts
214                               , md_fam_insts = fam_insts
215                               , md_rules     = rules
216                               , md_vect_info = vect_info
217                               , md_exports   = exports
218                               , md_modBreaks = emptyModBreaks
219                               }
220     }
221 \end{code}
222
223
224 %************************************************************************
225 %*                                                                      *
226                 Type and class declarations
227 %*                                                                      *
228 %************************************************************************
229
230 \begin{code}
231 tcHiBootIface :: HscSource -> Module -> TcRn ModDetails
232 -- Load the hi-boot iface for the module being compiled,
233 -- if it indeed exists in the transitive closure of imports
234 -- Return the ModDetails, empty if no hi-boot iface
235 tcHiBootIface hsc_src mod
236   | isHsBoot hsc_src            -- Already compiling a hs-boot file
237   = return emptyModDetails
238   | otherwise
239   = do  { traceIf (text "loadHiBootInterface" <+> ppr mod)
240
241         ; mode <- getGhcMode
242         ; if not (isOneShot mode)
243                 -- In --make and interactive mode, if this module has an hs-boot file
244                 -- we'll have compiled it already, and it'll be in the HPT
245                 -- 
246                 -- We check wheher the interface is a *boot* interface.
247                 -- It can happen (when using GHC from Visual Studio) that we
248                 -- compile a module in TypecheckOnly mode, with a stable, 
249                 -- fully-populated HPT.  In that case the boot interface isn't there
250                 -- (it's been replaced by the mother module) so we can't check it.
251                 -- And that's fine, because if M's ModInfo is in the HPT, then 
252                 -- it's been compiled once, and we don't need to check the boot iface
253           then do { hpt <- getHpt
254                   ; case lookupUFM hpt (moduleName mod) of
255                       Just info | mi_boot (hm_iface info) 
256                                 -> return (hm_details info)
257                       other -> return emptyModDetails }
258           else do
259
260         -- OK, so we're in one-shot mode.  
261         -- In that case, we're read all the direct imports by now, 
262         -- so eps_is_boot will record if any of our imports mention us by 
263         -- way of hi-boot file
264         { eps <- getEps
265         ; case lookupUFM (eps_is_boot eps) (moduleName mod) of {
266             Nothing -> return emptyModDetails ; -- The typical case
267
268             Just (_, False) -> failWithTc moduleLoop ;
269                 -- Someone below us imported us!
270                 -- This is a loop with no hi-boot in the way
271                 
272             Just (_mod, True) ->        -- There's a hi-boot interface below us
273                 
274     do  { read_result <- findAndReadIface 
275                                 need mod
276                                 True    -- Hi-boot file
277
278         ; case read_result of
279                 Failed err               -> failWithTc (elaborate err)
280                 Succeeded (iface, _path) -> typecheckIface iface
281     }}}}
282   where
283     need = ptext SLIT("Need the hi-boot interface for") <+> ppr mod
284                  <+> ptext SLIT("to compare against the Real Thing")
285
286     moduleLoop = ptext SLIT("Circular imports: module") <+> quotes (ppr mod) 
287                      <+> ptext SLIT("depends on itself")
288
289     elaborate err = hang (ptext SLIT("Could not find hi-boot interface for") <+> 
290                           quotes (ppr mod) <> colon) 4 err
291 \end{code}
292
293
294 %************************************************************************
295 %*                                                                      *
296                 Type and class declarations
297 %*                                                                      *
298 %************************************************************************
299
300 When typechecking a data type decl, we *lazily* (via forkM) typecheck
301 the constructor argument types.  This is in the hope that we may never
302 poke on those argument types, and hence may never need to load the
303 interface files for types mentioned in the arg types.
304
305 E.g.    
306         data Foo.S = MkS Baz.T
307 Mabye we can get away without even loading the interface for Baz!
308
309 This is not just a performance thing.  Suppose we have
310         data Foo.S = MkS Baz.T
311         data Baz.T = MkT Foo.S
312 (in different interface files, of course).
313 Now, first we load and typecheck Foo.S, and add it to the type envt.  
314 If we do explore MkS's argument, we'll load and typecheck Baz.T.
315 If we explore MkT's argument we'll find Foo.S already in the envt.  
316
317 If we typechecked constructor args eagerly, when loading Foo.S we'd try to
318 typecheck the type Baz.T.  So we'd fault in Baz.T... and then need Foo.S...
319 which isn't done yet.
320
321 All very cunning. However, there is a rather subtle gotcha which bit
322 me when developing this stuff.  When we typecheck the decl for S, we
323 extend the type envt with S, MkS, and all its implicit Ids.  Suppose
324 (a bug, but it happened) that the list of implicit Ids depended in
325 turn on the constructor arg types.  Then the following sequence of
326 events takes place:
327         * we build a thunk <t> for the constructor arg tys
328         * we build a thunk for the extended type environment (depends on <t>)
329         * we write the extended type envt into the global EPS mutvar
330         
331 Now we look something up in the type envt
332         * that pulls on <t>
333         * which reads the global type envt out of the global EPS mutvar
334         * but that depends in turn on <t>
335
336 It's subtle, because, it'd work fine if we typechecked the constructor args 
337 eagerly -- they don't need the extended type envt.  They just get the extended
338 type envt by accident, because they look at it later.
339
340 What this means is that the implicitTyThings MUST NOT DEPEND on any of
341 the forkM stuff.
342
343
344 \begin{code}
345 tcIfaceDecl :: Bool     -- True <=> discard IdInfo on IfaceId bindings
346             -> IfaceDecl
347             -> IfL TyThing
348
349 tcIfaceDecl ignore_prags (IfaceId {ifName = occ_name, ifType = iface_type, ifIdInfo = info})
350   = do  { name <- lookupIfaceTop occ_name
351         ; ty <- tcIfaceType iface_type
352         ; info <- tcIdInfo ignore_prags name ty info
353         ; return (AnId (mkVanillaGlobal name ty info)) }
354
355 tcIfaceDecl ignore_prags 
356             (IfaceData {ifName = occ_name, 
357                         ifTyVars = tv_bndrs, 
358                         ifCtxt = ctxt, ifGadtSyntax = gadt_syn,
359                         ifCons = rdr_cons, 
360                         ifRec = is_rec, 
361                         ifGeneric = want_generic,
362                         ifFamInst = mb_family })
363   = do  { tc_name <- lookupIfaceTop occ_name
364         ; bindIfaceTyVars tv_bndrs $ \ tyvars -> do
365
366         { tycon <- fixM ( \ tycon -> do
367             { stupid_theta <- tcIfaceCtxt ctxt
368             ; famInst <- 
369                 case mb_family of
370                   Nothing         -> return Nothing
371                   Just (fam, tys) -> 
372                     do { famTyCon <- tcIfaceTyCon fam
373                        ; insttys <- mapM tcIfaceType tys
374                        ; return $ Just (famTyCon, insttys)
375                        }
376             ; cons <- tcIfaceDataCons tc_name tycon tyvars rdr_cons
377             ; buildAlgTyCon tc_name tyvars stupid_theta
378                             cons is_rec want_generic gadt_syn famInst
379             })
380         ; traceIf (text "tcIfaceDecl4" <+> ppr tycon)
381         ; return (ATyCon tycon)
382     }}
383
384 tcIfaceDecl ignore_prags 
385             (IfaceSyn {ifName = occ_name, ifTyVars = tv_bndrs, 
386                        ifOpenSyn = isOpen, ifSynRhs = rdr_rhs_ty})
387    = bindIfaceTyVars tv_bndrs $ \ tyvars -> do
388      { tc_name <- lookupIfaceTop occ_name
389      ; rhs_tyki <- tcIfaceType rdr_rhs_ty
390      ; let rhs = if isOpen then OpenSynTyCon rhs_tyki Nothing
391                            else SynonymTyCon rhs_tyki
392      -- !!!TODO: read mb_family info from iface and pass as last argument
393      ; tycon <- buildSynTyCon tc_name tyvars rhs Nothing
394      ; return $ ATyCon tycon
395      }
396
397 tcIfaceDecl ignore_prags
398             (IfaceClass {ifCtxt = rdr_ctxt, ifName = occ_name, 
399                          ifTyVars = tv_bndrs, ifFDs = rdr_fds, 
400                          ifATs = rdr_ats, ifSigs = rdr_sigs, 
401                          ifRec = tc_isrec })
402 -- ToDo: in hs-boot files we should really treat abstract classes specially,
403 --       as we do abstract tycons
404   = bindIfaceTyVars tv_bndrs $ \ tyvars -> do
405     { cls_name <- lookupIfaceTop occ_name
406     ; ctxt <- tcIfaceCtxt rdr_ctxt
407     ; sigs <- mappM tc_sig rdr_sigs
408     ; fds  <- mappM tc_fd rdr_fds
409     ; ats'  <- mappM (tcIfaceDecl ignore_prags) rdr_ats
410     ; let ats = zipWith setTyThingPoss ats' (map ifTyVars rdr_ats)
411     ; cls  <- buildClass cls_name tyvars ctxt fds ats sigs tc_isrec
412     ; return (AClass cls) }
413   where
414    tc_sig (IfaceClassOp occ dm rdr_ty)
415      = do { op_name <- lookupIfaceTop occ
416           ; op_ty   <- forkM (mk_doc op_name rdr_ty) (tcIfaceType rdr_ty)
417                 -- Must be done lazily for just the same reason as the 
418                 -- type of a data con; to avoid sucking in types that
419                 -- it mentions unless it's necessray to do so
420           ; return (op_name, dm, op_ty) }
421
422    mk_doc op_name op_ty = ptext SLIT("Class op") <+> sep [ppr op_name, ppr op_ty]
423
424    tc_fd (tvs1, tvs2) = do { tvs1' <- mappM tcIfaceTyVar tvs1
425                            ; tvs2' <- mappM tcIfaceTyVar tvs2
426                            ; return (tvs1', tvs2') }
427
428    -- For each AT argument compute the position of the corresponding class
429    -- parameter in the class head.  This will later serve as a permutation
430    -- vector when checking the validity of instance declarations.
431    setTyThingPoss (ATyCon tycon) atTyVars = 
432      let classTyVars = map fst tv_bndrs
433          poss        =   catMaybes 
434                        . map ((`elemIndex` classTyVars) . fst) 
435                        $ atTyVars
436                     -- There will be no Nothing, as we already passed renaming
437      in 
438      ATyCon (setTyConArgPoss tycon poss)
439    setTyThingPoss _               _ = panic "TcIface.setTyThingPoss"
440
441 tcIfaceDecl ignore_prags (IfaceForeign {ifName = rdr_name, ifExtName = ext_name})
442   = do  { name <- lookupIfaceTop rdr_name
443         ; return (ATyCon (mkForeignTyCon name ext_name 
444                                          liftedTypeKind 0)) }
445
446 tcIfaceDataCons tycon_name tycon tc_tyvars if_cons
447   = case if_cons of
448         IfAbstractTyCon  -> return mkAbstractTyConRhs
449         IfOpenDataTyCon  -> return mkOpenDataTyConRhs
450         IfDataTyCon cons -> do  { data_cons <- mappM tc_con_decl cons
451                                 ; return (mkDataTyConRhs data_cons) }
452         IfNewTyCon con   -> do  { data_con <- tc_con_decl con
453                                 ; mkNewTyConRhs tycon_name tycon data_con }
454   where
455     tc_con_decl (IfCon { ifConInfix = is_infix, 
456                          ifConUnivTvs = univ_tvs, ifConExTvs = ex_tvs,
457                          ifConOcc = occ, ifConCtxt = ctxt, ifConEqSpec = spec,
458                          ifConArgTys = args, ifConFields = field_lbls,
459                          ifConStricts = stricts})
460      = bindIfaceTyVars univ_tvs $ \ univ_tyvars -> do
461        bindIfaceTyVars ex_tvs    $ \ ex_tyvars -> do
462         { name  <- lookupIfaceTop occ
463         ; eq_spec <- tcIfaceEqSpec spec
464         ; theta <- tcIfaceCtxt ctxt     -- Laziness seems not worth the bother here
465                 -- At one stage I thought that this context checking *had*
466                 -- to be lazy, because of possible mutual recursion between the
467                 -- type and the classe: 
468                 -- E.g. 
469                 --      class Real a where { toRat :: a -> Ratio Integer }
470                 --      data (Real a) => Ratio a = ...
471                 -- But now I think that the laziness in checking class ops breaks 
472                 -- the loop, so no laziness needed
473
474         -- Read the argument types, but lazily to avoid faulting in
475         -- the component types unless they are really needed
476         ; arg_tys <- forkM (mk_doc name) (mappM tcIfaceType args)
477         ; lbl_names <- mappM lookupIfaceTop field_lbls
478
479         ; buildDataCon name is_infix {- Not infix -}
480                        stricts lbl_names
481                        univ_tyvars ex_tyvars 
482                        eq_spec theta 
483                        arg_tys tycon
484         }
485     mk_doc con_name = ptext SLIT("Constructor") <+> ppr con_name
486
487 tcIfaceEqSpec spec
488   = mapM do_item spec
489   where
490     do_item (occ, if_ty) = do { tv <- tcIfaceTyVar (occNameFS occ)
491                               ; ty <- tcIfaceType if_ty
492                               ; return (tv,ty) }
493 \end{code}      
494
495
496 %************************************************************************
497 %*                                                                      *
498                 Instances
499 %*                                                                      *
500 %************************************************************************
501
502 \begin{code}
503 tcIfaceInst :: IfaceInst -> IfL Instance
504 tcIfaceInst (IfaceInst { ifDFun = dfun_occ, ifOFlag = oflag,
505                          ifInstCls = cls, ifInstTys = mb_tcs,
506                          ifInstOrph = orph })
507   = do  { dfun    <- forkM (ptext SLIT("Dict fun") <+> ppr dfun_occ) $
508                      tcIfaceExtId dfun_occ
509         ; let mb_tcs' = map (fmap ifaceTyConName) mb_tcs
510         ; return (mkImportedInstance cls mb_tcs' dfun oflag) }
511
512 tcIfaceFamInst :: IfaceFamInst -> IfL FamInst
513 tcIfaceFamInst (IfaceFamInst { ifFamInstTyCon = tycon, 
514                                ifFamInstFam = fam, ifFamInstTys = mb_tcs })
515 --  = do        { tycon'  <- forkM (ptext SLIT("Inst tycon") <+> ppr tycon) $
516 -- ^^^this line doesn't work, but vvv this does => CPP in Haskell = evil!
517   = do  { tycon'  <- forkM (text ("Inst tycon") <+> ppr tycon) $
518                      tcIfaceTyCon tycon
519         ; let mb_tcs' = map (fmap ifaceTyConName) mb_tcs
520         ; return (mkImportedFamInst fam mb_tcs' tycon') }
521 \end{code}
522
523
524 %************************************************************************
525 %*                                                                      *
526                 Rules
527 %*                                                                      *
528 %************************************************************************
529
530 We move a IfaceRule from eps_rules to eps_rule_base when all its LHS free vars
531 are in the type environment.  However, remember that typechecking a Rule may 
532 (as a side effect) augment the type envt, and so we may need to iterate the process.
533
534 \begin{code}
535 tcIfaceRules :: Bool            -- True <=> ignore rules
536              -> [IfaceRule]
537              -> IfL [CoreRule]
538 tcIfaceRules ignore_prags if_rules
539   | ignore_prags = return []
540   | otherwise    = mapM tcIfaceRule if_rules
541
542 tcIfaceRule :: IfaceRule -> IfL CoreRule
543 tcIfaceRule (IfaceRule {ifRuleName = name, ifActivation = act, ifRuleBndrs = bndrs,
544                         ifRuleHead = fn, ifRuleArgs = args, ifRuleRhs = rhs,
545                         ifRuleOrph = orph })
546   = do  { ~(bndrs', args', rhs') <- 
547                 -- Typecheck the payload lazily, in the hope it'll never be looked at
548                 forkM (ptext SLIT("Rule") <+> ftext name) $
549                 bindIfaceBndrs bndrs                      $ \ bndrs' ->
550                 do { args' <- mappM tcIfaceExpr args
551                    ; rhs'  <- tcIfaceExpr rhs
552                    ; return (bndrs', args', rhs') }
553         ; let mb_tcs = map ifTopFreeName args
554         ; lcl <- getLclEnv
555         ; returnM (Rule { ru_name = name, ru_fn = fn, ru_act = act, 
556                           ru_bndrs = bndrs', ru_args = args', 
557                           ru_rhs = rhs', 
558                           ru_rough = mb_tcs,
559                           ru_local = False }) } -- An imported RULE is never for a local Id
560                                                 -- or, even if it is (module loop, perhaps)
561                                                 -- we'll just leave it in the non-local set
562   where
563         -- This function *must* mirror exactly what Rules.topFreeName does
564         -- We could have stored the ru_rough field in the iface file
565         -- but that would be redundant, I think.
566         -- The only wrinkle is that we must not be deceived by
567         -- type syononyms at the top of a type arg.  Since
568         -- we can't tell at this point, we are careful not
569         -- to write them out in coreRuleToIfaceRule
570     ifTopFreeName :: IfaceExpr -> Maybe Name
571     ifTopFreeName (IfaceType (IfaceTyConApp tc _ )) = Just (ifaceTyConName tc)
572     ifTopFreeName (IfaceApp f a)                    = ifTopFreeName f
573     ifTopFreeName (IfaceExt n)                      = Just n
574     ifTopFreeName other                             = Nothing
575 \end{code}
576
577
578 %************************************************************************
579 %*                                                                      *
580                 Vectorisation information
581 %*                                                                      *
582 %************************************************************************
583
584 \begin{code}
585 tcIfaceVectInfo :: Module -> TypeEnv  -> IfaceVectInfo -> IfL VectInfo
586 tcIfaceVectInfo mod typeEnv (IfaceVectInfo names)
587   = do { ccVars <- mapM ccMapping names
588        ; return $ VectInfo (mkVarEnv ccVars)
589        }
590   where
591     ccMapping name 
592       = do { ccName <- lookupOrig mod (mkCloOcc (nameOccName name))
593            ; let { var   = lookup name
594                  ; ccVar = lookup ccName
595                  }
596            ; return (var, (var, ccVar))
597            }
598     lookup name = case lookupTypeEnv typeEnv name of
599                     Just (AnId var) -> var
600                     Just _          -> 
601                       panic "TcIface.tcIfaceVectInfo: wrong TyThing"
602                     Nothing         ->
603                       panic "TcIface.tcIfaceVectInfo: unknown name"
604 \end{code}
605
606 %************************************************************************
607 %*                                                                      *
608                         Types
609 %*                                                                      *
610 %************************************************************************
611
612 \begin{code}
613 tcIfaceType :: IfaceType -> IfL Type
614 tcIfaceType (IfaceTyVar n)        = do { tv <- tcIfaceTyVar n; return (TyVarTy tv) }
615 tcIfaceType (IfaceAppTy t1 t2)    = do { t1' <- tcIfaceType t1; t2' <- tcIfaceType t2; return (AppTy t1' t2') }
616 tcIfaceType (IfaceFunTy t1 t2)    = do { t1' <- tcIfaceType t1; t2' <- tcIfaceType t2; return (FunTy t1' t2') }
617 tcIfaceType (IfaceTyConApp tc ts) = do { tc' <- tcIfaceTyCon tc; ts' <- tcIfaceTypes ts; return (mkTyConApp tc' ts') }
618 tcIfaceType (IfaceForAllTy tv t)  = bindIfaceTyVar tv $ \ tv' -> do { t' <- tcIfaceType t; return (ForAllTy tv' t') }
619 tcIfaceType (IfacePredTy st)      = do { st' <- tcIfacePredType st; return (PredTy st') }
620
621 tcIfaceTypes tys = mapM tcIfaceType tys
622
623 -----------------------------------------
624 tcIfacePredType :: IfacePredType -> IfL PredType
625 tcIfacePredType (IfaceClassP cls ts) = do { cls' <- tcIfaceClass cls; ts' <- tcIfaceTypes ts; return (ClassP cls' ts') }
626 tcIfacePredType (IfaceIParam ip t)   = do { ip' <- newIPName ip; t' <- tcIfaceType t; return (IParam ip' t') }
627 tcIfacePredType (IfaceEqPred t1 t2)  = do { t1' <- tcIfaceType t1; t2' <- tcIfaceType t2; return (EqPred t1' t2') }
628
629 -----------------------------------------
630 tcIfaceCtxt :: IfaceContext -> IfL ThetaType
631 tcIfaceCtxt sts = mappM tcIfacePredType sts
632 \end{code}
633
634
635 %************************************************************************
636 %*                                                                      *
637                         Core
638 %*                                                                      *
639 %************************************************************************
640
641 \begin{code}
642 tcIfaceExpr :: IfaceExpr -> IfL CoreExpr
643 tcIfaceExpr (IfaceType ty)
644   = tcIfaceType ty              `thenM` \ ty' ->
645     returnM (Type ty')
646
647 tcIfaceExpr (IfaceLcl name)
648   = tcIfaceLclId name   `thenM` \ id ->
649     returnM (Var id)
650
651 tcIfaceExpr (IfaceExt gbl)
652   = tcIfaceExtId gbl    `thenM` \ id ->
653     returnM (Var id)
654
655 tcIfaceExpr (IfaceLit lit)
656   = returnM (Lit lit)
657
658 tcIfaceExpr (IfaceFCall cc ty)
659   = tcIfaceType ty      `thenM` \ ty' ->
660     newUnique           `thenM` \ u ->
661     returnM (Var (mkFCallId u cc ty'))
662
663 tcIfaceExpr (IfaceTuple boxity args) 
664   = mappM tcIfaceExpr args      `thenM` \ args' ->
665     let
666         -- Put the missing type arguments back in
667         con_args = map (Type . exprType) args' ++ args'
668     in
669     returnM (mkApps (Var con_id) con_args)
670   where
671     arity = length args
672     con_id = dataConWorkId (tupleCon boxity arity)
673     
674
675 tcIfaceExpr (IfaceLam bndr body)
676   = bindIfaceBndr bndr          $ \ bndr' ->
677     tcIfaceExpr body            `thenM` \ body' ->
678     returnM (Lam bndr' body')
679
680 tcIfaceExpr (IfaceApp fun arg)
681   = tcIfaceExpr fun             `thenM` \ fun' ->
682     tcIfaceExpr arg             `thenM` \ arg' ->
683     returnM (App fun' arg')
684
685 tcIfaceExpr (IfaceCase scrut case_bndr ty alts) 
686   = tcIfaceExpr scrut           `thenM` \ scrut' ->
687     newIfaceName (mkVarOccFS case_bndr) `thenM` \ case_bndr_name ->
688     let
689         scrut_ty   = exprType scrut'
690         case_bndr' = mkLocalId case_bndr_name scrut_ty
691         tc_app     = splitTyConApp scrut_ty
692                 -- NB: Won't always succeed (polymoprhic case)
693                 --     but won't be demanded in those cases
694                 -- NB: not tcSplitTyConApp; we are looking at Core here
695                 --     look through non-rec newtypes to find the tycon that
696                 --     corresponds to the datacon in this case alternative
697     in
698     extendIfaceIdEnv [case_bndr']       $
699     mappM (tcIfaceAlt tc_app) alts      `thenM` \ alts' ->
700     tcIfaceType ty              `thenM` \ ty' ->
701     returnM (Case scrut' case_bndr' ty' alts')
702
703 tcIfaceExpr (IfaceLet (IfaceNonRec bndr rhs) body)
704   = do  { rhs' <- tcIfaceExpr rhs
705         ; id   <- tcIfaceLetBndr bndr
706         ; body' <- extendIfaceIdEnv [id] (tcIfaceExpr body)
707         ; return (Let (NonRec id rhs') body') }
708
709 tcIfaceExpr (IfaceLet (IfaceRec pairs) body)
710   = do  { ids <- mapM tcIfaceLetBndr bndrs
711         ; extendIfaceIdEnv ids $ do
712         { rhss' <- mapM tcIfaceExpr rhss
713         ; body' <- tcIfaceExpr body
714         ; return (Let (Rec (ids `zip` rhss')) body') } }
715   where
716     (bndrs, rhss) = unzip pairs
717
718 tcIfaceExpr (IfaceCast expr co) = do
719   expr' <- tcIfaceExpr expr
720   co' <- tcIfaceType co
721   returnM (Cast expr' co')
722
723 tcIfaceExpr (IfaceNote note expr) 
724   = tcIfaceExpr expr            `thenM` \ expr' ->
725     case note of
726         IfaceInlineMe     -> returnM (Note InlineMe   expr')
727         IfaceSCC cc       -> returnM (Note (SCC cc)   expr')
728         IfaceCoreNote n   -> returnM (Note (CoreNote n) expr')
729
730 -------------------------
731 tcIfaceAlt _ (IfaceDefault, names, rhs)
732   = ASSERT( null names )
733     tcIfaceExpr rhs             `thenM` \ rhs' ->
734     returnM (DEFAULT, [], rhs')
735   
736 tcIfaceAlt _ (IfaceLitAlt lit, names, rhs)
737   = ASSERT( null names )
738     tcIfaceExpr rhs             `thenM` \ rhs' ->
739     returnM (LitAlt lit, [], rhs')
740
741 -- A case alternative is made quite a bit more complicated
742 -- by the fact that we omit type annotations because we can
743 -- work them out.  True enough, but its not that easy!
744 tcIfaceAlt (tycon, inst_tys) (IfaceDataAlt data_occ, arg_strs, rhs)
745   = do  { con <- tcIfaceDataCon data_occ
746         ; ASSERT2( con `elem` tyConDataCons tycon,
747                    ppr con $$ ppr tycon $$ ppr (tyConDataCons tycon) )
748           tcIfaceDataAlt con inst_tys arg_strs rhs }
749                   
750 tcIfaceAlt (tycon, inst_tys) (IfaceTupleAlt boxity, arg_occs, rhs)
751   = ASSERT( isTupleTyCon tycon )
752     do  { let [data_con] = tyConDataCons tycon
753         ; tcIfaceDataAlt data_con inst_tys arg_occs rhs }
754
755 tcIfaceDataAlt con inst_tys arg_strs rhs
756   = do  { us <- newUniqueSupply
757         ; let uniqs = uniqsFromSupply us
758         ; let (ex_tvs, co_tvs, arg_ids)
759                       = dataConRepFSInstPat arg_strs uniqs con inst_tys
760               all_tvs = ex_tvs ++ co_tvs
761
762         ; rhs' <- extendIfaceTyVarEnv all_tvs   $
763                   extendIfaceIdEnv arg_ids      $
764                   tcIfaceExpr rhs
765         ; return (DataAlt con, all_tvs ++ arg_ids, rhs') }
766 \end{code}
767
768
769 \begin{code}
770 tcExtCoreBindings :: [IfaceBinding] -> IfL [CoreBind]   -- Used for external core
771 tcExtCoreBindings []     = return []
772 tcExtCoreBindings (b:bs) = do_one b (tcExtCoreBindings bs)
773
774 do_one :: IfaceBinding -> IfL [CoreBind] -> IfL [CoreBind]
775 do_one (IfaceNonRec bndr rhs) thing_inside
776   = do  { rhs' <- tcIfaceExpr rhs
777         ; bndr' <- newExtCoreBndr bndr
778         ; extendIfaceIdEnv [bndr'] $ do 
779         { core_binds <- thing_inside
780         ; return (NonRec bndr' rhs' : core_binds) }}
781
782 do_one (IfaceRec pairs) thing_inside
783   = do  { bndrs' <- mappM newExtCoreBndr bndrs
784         ; extendIfaceIdEnv bndrs' $ do
785         { rhss' <- mappM tcIfaceExpr rhss
786         ; core_binds <- thing_inside
787         ; return (Rec (bndrs' `zip` rhss') : core_binds) }}
788   where
789     (bndrs,rhss) = unzip pairs
790 \end{code}
791
792
793 %************************************************************************
794 %*                                                                      *
795                 IdInfo
796 %*                                                                      *
797 %************************************************************************
798
799 \begin{code}
800 tcIdInfo :: Bool -> Name -> Type -> IfaceIdInfo -> IfL IdInfo
801 tcIdInfo ignore_prags name ty info 
802   | ignore_prags = return vanillaIdInfo
803   | otherwise    = case info of
804                         NoInfo       -> return vanillaIdInfo
805                         HasInfo info -> foldlM tcPrag init_info info
806   where
807     -- Set the CgInfo to something sensible but uninformative before
808     -- we start; default assumption is that it has CAFs
809     init_info = vanillaIdInfo
810
811     tcPrag info HsNoCafRefs         = returnM (info `setCafInfo`   NoCafRefs)
812     tcPrag info (HsArity arity)     = returnM (info `setArityInfo` arity)
813     tcPrag info (HsStrictness str)  = returnM (info `setAllStrictnessInfo` Just str)
814
815         -- The next two are lazy, so they don't transitively suck stuff in
816     tcPrag info (HsWorker nm arity) = tcWorkerInfo ty info nm arity
817     tcPrag info (HsInline inline_prag) = returnM (info `setInlinePragInfo` inline_prag)
818     tcPrag info (HsUnfold expr)
819         = tcPragExpr name expr  `thenM` \ maybe_expr' ->
820           let
821                 -- maybe_expr' doesn't get looked at if the unfolding
822                 -- is never inspected; so the typecheck doesn't even happen
823                 unfold_info = case maybe_expr' of
824                                 Nothing    -> noUnfolding
825                                 Just expr' -> mkTopUnfolding expr' 
826           in
827           returnM (info `setUnfoldingInfoLazily` unfold_info)
828 \end{code}
829
830 \begin{code}
831 tcWorkerInfo ty info wkr arity
832   = do  { mb_wkr_id <- forkM_maybe doc (tcIfaceExtId wkr)
833
834         -- We return without testing maybe_wkr_id, but as soon as info is
835         -- looked at we will test it.  That's ok, because its outside the
836         -- knot; and there seems no big reason to further defer the
837         -- tcIfaceId lookup.  (Contrast with tcPragExpr, where postponing walking
838         -- over the unfolding until it's actually used does seem worth while.)
839         ; us <- newUniqueSupply
840
841         ; returnM (case mb_wkr_id of
842                      Nothing     -> info
843                      Just wkr_id -> add_wkr_info us wkr_id info) }
844   where
845     doc = text "Worker for" <+> ppr wkr
846     add_wkr_info us wkr_id info
847         = info `setUnfoldingInfoLazily`  mk_unfolding us wkr_id
848                `setWorkerInfo`           HasWorker wkr_id arity
849
850     mk_unfolding us wkr_id = mkTopUnfolding (initUs_ us (mkWrapper ty strict_sig) wkr_id)
851
852         -- We are relying here on strictness info always appearing 
853         -- before worker info,  fingers crossed ....
854     strict_sig = case newStrictnessInfo info of
855                    Just sig -> sig
856                    Nothing  -> pprPanic "Worker info but no strictness for" (ppr wkr)
857 \end{code}
858
859 For unfoldings we try to do the job lazily, so that we never type check
860 an unfolding that isn't going to be looked at.
861
862 \begin{code}
863 tcPragExpr :: Name -> IfaceExpr -> IfL (Maybe CoreExpr)
864 tcPragExpr name expr
865   = forkM_maybe doc $
866     tcIfaceExpr expr            `thenM` \ core_expr' ->
867
868                 -- Check for type consistency in the unfolding
869     ifOptM Opt_DoCoreLinting (
870         get_in_scope_ids                        `thenM` \ in_scope -> 
871         case lintUnfolding noSrcLoc in_scope core_expr' of
872           Nothing       -> returnM ()
873           Just fail_msg -> pprPanic "Iface Lint failure" (hang doc 2 fail_msg)
874     )                           `thenM_`
875
876    returnM core_expr'   
877   where
878     doc = text "Unfolding of" <+> ppr name
879     get_in_scope_ids    -- Urgh; but just for linting
880         = setLclEnv () $ 
881           do    { env <- getGblEnv 
882                 ; case if_rec_types env of {
883                           Nothing -> return [] ;
884                           Just (_, get_env) -> do
885                 { type_env <- get_env
886                 ; return (typeEnvIds type_env) }}}
887 \end{code}
888
889
890
891 %************************************************************************
892 %*                                                                      *
893                 Getting from Names to TyThings
894 %*                                                                      *
895 %************************************************************************
896
897 \begin{code}
898 tcIfaceGlobal :: Name -> IfL TyThing
899 tcIfaceGlobal name
900   | Just thing <- wiredInNameTyThing_maybe name
901         -- Wired-in things include TyCons, DataCons, and Ids
902   = do { ifCheckWiredInThing name; return thing }
903   | otherwise
904   = do  { (eps,hpt) <- getEpsAndHpt
905         ; dflags <- getDOpts
906         ; case lookupType dflags hpt (eps_PTE eps) name of {
907             Just thing -> return thing ;
908             Nothing    -> do
909
910         { env <- getGblEnv
911         ; case if_rec_types env of {
912             Just (mod, get_type_env) 
913                 | nameIsLocalOrFrom mod name
914                 -> do           -- It's defined in the module being compiled
915                 { type_env <- setLclEnv () get_type_env         -- yuk
916                 ; case lookupNameEnv type_env name of
917                         Just thing -> return thing
918                         Nothing    -> pprPanic "tcIfaceGlobal (local): not found:"  
919                                                 (ppr name $$ ppr type_env) }
920
921           ; other -> do
922
923         { mb_thing <- importDecl name   -- It's imported; go get it
924         ; case mb_thing of
925             Failed err      -> failIfM err
926             Succeeded thing -> return thing
927     }}}}}
928
929 ifCheckWiredInThing :: Name -> IfL ()
930 -- Even though we are in an interface file, we want to make
931 -- sure the instances of a wired-in thing are loaded (imagine f :: Double -> Double)
932 -- Ditto want to ensure that RULES are loaded too
933 ifCheckWiredInThing name 
934   = do  { mod <- getIfModule
935                 -- Check whether we are typechecking the interface for this
936                 -- very module.  E.g when compiling the base library in --make mode
937                 -- we may typecheck GHC.Base.hi. At that point, GHC.Base is not in
938                 -- the HPT, so without the test we'll demand-load it into the PIT!
939                 -- C.f. the same test in checkWiredInTyCon above
940         ; unless (mod == nameModule name)
941                  (loadWiredInHomeIface name) }
942
943 tcIfaceTyCon :: IfaceTyCon -> IfL TyCon
944 tcIfaceTyCon IfaceIntTc         = tcWiredInTyCon intTyCon
945 tcIfaceTyCon IfaceBoolTc        = tcWiredInTyCon boolTyCon
946 tcIfaceTyCon IfaceCharTc        = tcWiredInTyCon charTyCon
947 tcIfaceTyCon IfaceListTc        = tcWiredInTyCon listTyCon
948 tcIfaceTyCon IfacePArrTc        = tcWiredInTyCon parrTyCon
949 tcIfaceTyCon (IfaceTupTc bx ar) = tcWiredInTyCon (tupleTyCon bx ar)
950 tcIfaceTyCon (IfaceTc name)     = do { thing <- tcIfaceGlobal name 
951                                      ; return (check_tc (tyThingTyCon thing)) }
952   where
953 #ifdef DEBUG
954     check_tc tc = case toIfaceTyCon tc of
955                    IfaceTc _ -> tc
956                    other     -> pprTrace "check_tc" (ppr tc) tc
957 #else
958     check_tc tc = tc
959 #endif
960 -- we should be okay just returning Kind constructors without extra loading
961 tcIfaceTyCon IfaceLiftedTypeKindTc   = return liftedTypeKindTyCon
962 tcIfaceTyCon IfaceOpenTypeKindTc     = return openTypeKindTyCon
963 tcIfaceTyCon IfaceUnliftedTypeKindTc = return unliftedTypeKindTyCon
964 tcIfaceTyCon IfaceArgTypeKindTc      = return argTypeKindTyCon
965 tcIfaceTyCon IfaceUbxTupleKindTc     = return ubxTupleKindTyCon
966
967 -- Even though we are in an interface file, we want to make
968 -- sure the instances and RULES of this tycon are loaded 
969 -- Imagine: f :: Double -> Double
970 tcWiredInTyCon :: TyCon -> IfL TyCon
971 tcWiredInTyCon tc = do { ifCheckWiredInThing (tyConName tc)
972                        ; return tc }
973
974 tcIfaceClass :: Name -> IfL Class
975 tcIfaceClass name = do { thing <- tcIfaceGlobal name
976                        ; return (tyThingClass thing) }
977
978 tcIfaceDataCon :: Name -> IfL DataCon
979 tcIfaceDataCon name = do { thing <- tcIfaceGlobal name
980                          ; case thing of
981                                 ADataCon dc -> return dc
982                                 other   -> pprPanic "tcIfaceExtDC" (ppr name$$ ppr thing) }
983
984 tcIfaceExtId :: Name -> IfL Id
985 tcIfaceExtId name = do { thing <- tcIfaceGlobal name
986                        ; case thing of
987                           AnId id -> return id
988                           other   -> pprPanic "tcIfaceExtId" (ppr name$$ ppr thing) }
989 \end{code}
990
991 %************************************************************************
992 %*                                                                      *
993                 Bindings
994 %*                                                                      *
995 %************************************************************************
996
997 \begin{code}
998 bindIfaceBndr :: IfaceBndr -> (CoreBndr -> IfL a) -> IfL a
999 bindIfaceBndr (IfaceIdBndr (fs, ty)) thing_inside
1000   = do  { name <- newIfaceName (mkVarOccFS fs)
1001         ; ty' <- tcIfaceType ty
1002         ; let id = mkLocalId name ty'
1003         ; extendIfaceIdEnv [id] (thing_inside id) }
1004 bindIfaceBndr (IfaceTvBndr bndr) thing_inside
1005   = bindIfaceTyVar bndr thing_inside
1006     
1007 bindIfaceBndrs :: [IfaceBndr] -> ([CoreBndr] -> IfL a) -> IfL a
1008 bindIfaceBndrs []     thing_inside = thing_inside []
1009 bindIfaceBndrs (b:bs) thing_inside
1010   = bindIfaceBndr b     $ \ b' ->
1011     bindIfaceBndrs bs   $ \ bs' ->
1012     thing_inside (b':bs')
1013
1014 -----------------------
1015 tcIfaceLetBndr (IfLetBndr fs ty info)
1016   = do  { name <- newIfaceName (mkVarOccFS fs)
1017         ; ty' <- tcIfaceType ty
1018         ; case info of
1019                 NoInfo    -> return (mkLocalId name ty')
1020                 HasInfo i -> return (mkLocalIdWithInfo name ty' (tc_info i)) } 
1021   where
1022         -- Similar to tcIdInfo, but much simpler
1023     tc_info [] = vanillaIdInfo
1024     tc_info (HsInline p     : i) = tc_info i `setInlinePragInfo` p 
1025     tc_info (HsArity a      : i) = tc_info i `setArityInfo` a 
1026     tc_info (HsStrictness s : i) = tc_info i `setAllStrictnessInfo` Just s 
1027     tc_info (other          : i) = pprTrace "tcIfaceLetBndr: discarding unexpected IdInfo" 
1028                                             (ppr other) (tc_info i)
1029
1030 -----------------------
1031 newExtCoreBndr :: IfaceLetBndr -> IfL Id
1032 newExtCoreBndr (IfLetBndr var ty _)     -- Ignoring IdInfo for now
1033   = do  { mod <- getIfModule
1034         ; name <- newGlobalBinder mod (mkVarOccFS var) noSrcSpan
1035         ; ty' <- tcIfaceType ty
1036         ; return (mkLocalId name ty') }
1037
1038 -----------------------
1039 bindIfaceTyVar :: IfaceTvBndr -> (TyVar -> IfL a) -> IfL a
1040 bindIfaceTyVar (occ,kind) thing_inside
1041   = do  { name <- newIfaceName (mkTyVarOcc occ)
1042         ; tyvar <- mk_iface_tyvar name kind
1043         ; extendIfaceTyVarEnv [tyvar] (thing_inside tyvar) }
1044
1045 bindIfaceTyVars :: [IfaceTvBndr] -> ([TyVar] -> IfL a) -> IfL a
1046 bindIfaceTyVars bndrs thing_inside
1047   = do  { names <- newIfaceNames (map mkTyVarOcc occs)
1048         ; tyvars <- TcRnMonad.zipWithM mk_iface_tyvar names kinds
1049         ; extendIfaceTyVarEnv tyvars (thing_inside tyvars) }
1050   where
1051     (occs,kinds) = unzip bndrs
1052
1053 mk_iface_tyvar :: Name -> IfaceKind -> IfL TyVar
1054 mk_iface_tyvar name ifKind
1055    = do { kind <- tcIfaceType ifKind
1056         ; if isCoercionKind kind then 
1057                 return (Var.mkCoVar name kind)
1058           else
1059                 return (Var.mkTyVar name kind) }
1060 \end{code}
1061