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, tcIfaceAnnotations, 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 TcType
  23 import Type
  24 import TypeRep
  25 import HscTypes
  26 import Annotations
  27 import InstEnv
  28 import FamInstEnv
  29 import CoreSyn
  30 import CoreUtils
  31 import CoreUnfold
  32 import CoreLint
  33 import WorkWrap
  34 import Id
  35 import MkId
  36 import IdInfo
  37 import Class
  38 import TyCon
  39 import DataCon
  40 import TysWiredIn
  41 import TysPrim          ( anyTyConOfKind )
  42 import Var              ( Var, TyVar )
  43 import BasicTypes       ( Arity, nonRuleLoopBreaker )
  44 import qualified Var
  45 import VarEnv
  46 import Name
  47 import NameEnv
  48 import OccurAnal        ( occurAnalyseExpr )
  49 import Demand           ( isBottomingSig )
  50 import Module
  51 import UniqFM
  52 import UniqSupply
  53 import Outputable
  54 import ErrUtils
  55 import Maybes
  56 import SrcLoc
  57 import DynFlags
  58 import Util
  59 import FastString
  60
  61 import Control.Monad
  62 import Data.List
  63 \end{code}
  64
  65 This module takes
  66
  67         IfaceDecl -> TyThing
  68         IfaceType -> Type
  69         etc
  70
  71 An IfaceDecl is populated with RdrNames, and these are not renamed to
  72 Names before typechecking, because there should be no scope errors etc.
  73
  74         -- For (b) consider: f = \$(...h....)
  75         -- where h is imported, and calls f via an hi-boot file.
  76         -- This is bad!  But it is not seen as a staging error, because h
  77         -- is indeed imported.  We don't want the type-checker to black-hole
  78         -- when simplifying and compiling the splice!
  79         --
  80         -- Simple solution: discard any unfolding that mentions a variable
  81         -- bound in this module (and hence not yet processed).
  82         -- The discarding happens when forkM finds a type error.
  83
  84 %************************************************************************
  85 %*                                                                      *
  86 %*      tcImportDecl is the key function for "faulting in"              *
  87 %*      imported things
  88 %*                                                                      *
  89 %************************************************************************
  90
  91 The main idea is this.  We are chugging along type-checking source code, and
  92 find a reference to GHC.Base.map.  We call tcLookupGlobal, which doesn't find
  93 it in the EPS type envt.  So it
  94         1 loads GHC.Base.hi
  95         2 gets the decl for GHC.Base.map
  96         3 typechecks it via tcIfaceDecl
  97         4 and adds it to the type env in the EPS
  98
  99 Note that DURING STEP 4, we may find that map's type mentions a type
 100 constructor that also
 101
 102 Notice that for imported things we read the current version from the EPS
 103 mutable variable.  This is important in situations like
 104         ...$(e1)...$(e2)...
 105 where the code that e1 expands to might import some defns that
 106 also turn out to be needed by the code that e2 expands to.
 107
 108 \begin{code}
 109 tcImportDecl :: Name -> TcM TyThing
 110 -- Entry point for *source-code* uses of importDecl
 111 tcImportDecl name
 112   | Just thing <- wiredInNameTyThing_maybe name
 113   = do  { when (needWiredInHomeIface thing)
 114                (initIfaceTcRn (loadWiredInHomeIface name))
 115                 -- See Note [Loading instances for wired-in things]
 116         ; return thing }
 117   | otherwise
 118   = do  { traceIf (text "tcImportDecl" <+> ppr name)
 119         ; mb_thing <- initIfaceTcRn (importDecl name)
 120         ; case mb_thing of
 121             Succeeded thing -> return thing
 122             Failed err      -> failWithTc err }
 123
 124 importDecl :: Name -> IfM lcl (MaybeErr Message TyThing)
 125 -- Get the TyThing for this Name from an interface file
 126 -- It's not a wired-in thing -- the caller caught that
 127 importDecl name
 128   = ASSERT( not (isWiredInName name) )
 129     do  { traceIf nd_doc
 130
 131         -- Load the interface, which should populate the PTE
 132         ; mb_iface <- ASSERT2( isExternalName name, ppr name )
 133                       loadInterface nd_doc (nameModule name) ImportBySystem
 134         ; case mb_iface of {
 135                 Failed err_msg  -> return (Failed err_msg) ;
 136                 Succeeded _ -> do
 137
 138         -- Now look it up again; this time we should find it
 139         { eps <- getEps
 140         ; case lookupTypeEnv (eps_PTE eps) name of
 141             Just thing -> return (Succeeded thing)
 142             Nothing    -> return (Failed not_found_msg)
 143     }}}
 144   where
 145     nd_doc = ptext (sLit "Need decl for") <+> ppr name
 146     not_found_msg = hang (ptext (sLit "Can't find interface-file declaration for") <+>
 147                                 pprNameSpace (occNameSpace (nameOccName name)) <+> ppr name)
 148                        2 (vcat [ptext (sLit "Probable cause: bug in .hi-boot file, or inconsistent .hi file"),
 149                                 ptext (sLit "Use -ddump-if-trace to get an idea of which file caused the error")])
 150 \end{code}
 151
 152 %************************************************************************
 153 %*                                                                      *
 154            Checks for wired-in things
 155 %*                                                                      *
 156 %************************************************************************
 157
 158 Note [Loading instances for wired-in things]
 159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 160 We need to make sure that we have at least *read* the interface files
 161 for any module with an instance decl or RULE that we might want.
 162
 163 * If the instance decl is an orphan, we have a whole separate mechanism
 164   (loadOprhanModules)
 165
 166 * If the instance decl not an orphan, then the act of looking at the
 167   TyCon or Class will force in the defining module for the
 168   TyCon/Class, and hence the instance decl
 169
 170 * BUT, if the TyCon is a wired-in TyCon, we don't really need its interface;
 171   but we must make sure we read its interface in case it has instances or
 172   rules.  That is what LoadIface.loadWiredInHomeInterface does.  It's called
 173   from TcIface.{tcImportDecl, checkWiredInTyCon, ifCheckWiredInThing}
 174
 175 * HOWEVER, only do this for TyCons.  There are no wired-in Classes.  There
 176   are some wired-in Ids, but we don't want to load their interfaces. For
 177   example, Control.Exception.Base.recSelError is wired in, but that module
 178   is compiled late in the base library, and we don't want to force it to
 179   load before it's been compiled!
 180
 181 All of this is done by the type checker. The renamer plays no role.
 182 (It used to, but no longer.)
 183
 184
 185 \begin{code}
 186 checkWiredInTyCon :: TyCon -> TcM ()
 187 -- Ensure that the home module of the TyCon (and hence its instances)
 188 -- are loaded. See Note [Loading instances for wired-in things]
 189 -- It might not be a wired-in tycon (see the calls in TcUnify),
 190 -- in which case this is a no-op.
 191 checkWiredInTyCon tc
 192   | not (isWiredInName tc_name)
 193   = return ()
 194   | otherwise
 195   = do  { mod <- getModule
 196         ; ASSERT( isExternalName tc_name )
 197           when (mod /= nameModule tc_name)
 198                (initIfaceTcRn (loadWiredInHomeIface tc_name))
 199                 -- Don't look for (non-existent) Float.hi when
 200                 -- compiling Float.lhs, which mentions Float of course
 201                 -- A bit yukky to call initIfaceTcRn here
 202         }
 203   where
 204     tc_name = tyConName tc
 205
 206 ifCheckWiredInThing :: TyThing -> IfL ()
 207 -- Even though we are in an interface file, we want to make
 208 -- sure the instances of a wired-in thing are loaded (imagine f :: Double -> Double)
 209 -- Ditto want to ensure that RULES are loaded too
 210 -- See Note [Loading instances for wired-in things]
 211 ifCheckWiredInThing thing
 212   = do  { mod <- getIfModule
 213                 -- Check whether we are typechecking the interface for this
 214                 -- very module.  E.g when compiling the base library in --make mode
 215                 -- we may typecheck GHC.Base.hi. At that point, GHC.Base is not in
 216                 -- the HPT, so without the test we'll demand-load it into the PIT!
 217                 -- C.f. the same test in checkWiredInTyCon above
 218         ; let name = getName thing
 219         ; ASSERT2( isExternalName name, ppr name )
 220           when (needWiredInHomeIface thing && mod /= nameModule name)
 221                (loadWiredInHomeIface name) }
 222
 223 needWiredInHomeIface :: TyThing -> Bool
 224 -- Only for TyCons; see Note [Loading instances for wired-in things]
 225 needWiredInHomeIface (ATyCon {}) = True
 226 needWiredInHomeIface _           = False
 227 \end{code}
 228
 229 %************************************************************************
 230 %*                                                                      *
 231                 Type-checking a complete interface
 232 %*                                                                      *
 233 %************************************************************************
 234
 235 Suppose we discover we don't need to recompile.  Then we must type
 236 check the old interface file.  This is a bit different to the
 237 incremental type checking we do as we suck in interface files.  Instead
 238 we do things similarly as when we are typechecking source decls: we
 239 bring into scope the type envt for the interface all at once, using a
 240 knot.  Remember, the decls aren't necessarily in dependency order --
 241 and even if they were, the type decls might be mutually recursive.
 242
 243 \begin{code}
 244 typecheckIface :: ModIface      -- Get the decls from here
 245                -> TcRnIf gbl lcl ModDetails
 246 typecheckIface iface
 247   = initIfaceTc iface $ \ tc_env_var -> do
 248         -- The tc_env_var is freshly allocated, private to
 249         -- type-checking this particular interface
 250         {       -- Get the right set of decls and rules.  If we are compiling without -O
 251                 -- we discard pragmas before typechecking, so that we don't "see"
 252                 -- information that we shouldn't.  From a versioning point of view
 253                 -- It's not actually *wrong* to do so, but in fact GHCi is unable
 254                 -- to handle unboxed tuples, so it must not see unfoldings.
 255           ignore_prags <- doptM Opt_IgnoreInterfacePragmas
 256
 257                 -- Typecheck the decls.  This is done lazily, so that the knot-tying
 258                 -- within this single module work out right.  In the If monad there is
 259                 -- no global envt for the current interface; instead, the knot is tied
 260                 -- through the if_rec_types field of IfGblEnv
 261         ; names_w_things <- loadDecls ignore_prags (mi_decls iface)
 262         ; let type_env = mkNameEnv names_w_things
 263         ; writeMutVar tc_env_var type_env
 264
 265                 -- Now do those rules, instances and annotations
 266         ; insts     <- mapM tcIfaceInst    (mi_insts     iface)
 267         ; fam_insts <- mapM tcIfaceFamInst (mi_fam_insts iface)
 268         ; rules     <- tcIfaceRules ignore_prags (mi_rules iface)
 269         ; anns      <- tcIfaceAnnotations  (mi_anns iface)
 270
 271                 -- Vectorisation information
 272         ; vect_info <- tcIfaceVectInfo (mi_module iface) type_env
 273                                        (mi_vect_info iface)
 274
 275                 -- Exports
 276         ; exports <- ifaceExportNames (mi_exports iface)
 277
 278                 -- Finished
 279         ; traceIf (vcat [text "Finished typechecking interface for" <+> ppr (mi_module iface),
 280                          text "Type envt:" <+> ppr type_env])
 281         ; return $ ModDetails { md_types     = type_env
 282                               , md_insts     = insts
 283                               , md_fam_insts = fam_insts
 284                               , md_rules     = rules
 285                               , md_anns      = anns
 286                               , md_vect_info = vect_info
 287                               , md_exports   = exports
 288                               }
 289     }
 290 \end{code}
 291
 292
 293 %************************************************************************
 294 %*                                                                      *
 295                 Type and class declarations
 296 %*                                                                      *
 297 %************************************************************************
 298
 299 \begin{code}
 300 tcHiBootIface :: HscSource -> Module -> TcRn ModDetails
 301 -- Load the hi-boot iface for the module being compiled,
 302 -- if it indeed exists in the transitive closure of imports
 303 -- Return the ModDetails, empty if no hi-boot iface
 304 tcHiBootIface hsc_src mod
 305   | isHsBoot hsc_src            -- Already compiling a hs-boot file
 306   = return emptyModDetails
 307   | otherwise
 308   = do  { traceIf (text "loadHiBootInterface" <+> ppr mod)
 309
 310         ; mode <- getGhcMode
 311         ; if not (isOneShot mode)
 312                 -- In --make and interactive mode, if this module has an hs-boot file
 313                 -- we'll have compiled it already, and it'll be in the HPT
 314                 --
 315                 -- We check wheher the interface is a *boot* interface.
 316                 -- It can happen (when using GHC from Visual Studio) that we
 317                 -- compile a module in TypecheckOnly mode, with a stable,
 318                 -- fully-populated HPT.  In that case the boot interface isn't there
 319                 -- (it's been replaced by the mother module) so we can't check it.
 320                 -- And that's fine, because if M's ModInfo is in the HPT, then
 321                 -- it's been compiled once, and we don't need to check the boot iface
 322           then do { hpt <- getHpt
 323                   ; case lookupUFM hpt (moduleName mod) of
 324                       Just info | mi_boot (hm_iface info)
 325                                 -> return (hm_details info)
 326                       _ -> return emptyModDetails }
 327           else do
 328
 329         -- OK, so we're in one-shot mode.
 330         -- In that case, we're read all the direct imports by now,
 331         -- so eps_is_boot will record if any of our imports mention us by
 332         -- way of hi-boot file
 333         { eps <- getEps
 334         ; case lookupUFM (eps_is_boot eps) (moduleName mod) of {
 335             Nothing -> return emptyModDetails ; -- The typical case
 336
 337             Just (_, False) -> failWithTc moduleLoop ;
 338                 -- Someone below us imported us!
 339                 -- This is a loop with no hi-boot in the way
 340
 341             Just (_mod, True) ->        -- There's a hi-boot interface below us
 342
 343     do  { read_result <- findAndReadIface
 344                                 need mod
 345                                 True    -- Hi-boot file
 346
 347         ; case read_result of
 348                 Failed err               -> failWithTc (elaborate err)
 349                 Succeeded (iface, _path) -> typecheckIface iface
 350     }}}}
 351   where
 352     need = ptext (sLit "Need the hi-boot interface for") <+> ppr mod
 353                  <+> ptext (sLit "to compare against the Real Thing")
 354
 355     moduleLoop = ptext (sLit "Circular imports: module") <+> quotes (ppr mod)
 356                      <+> ptext (sLit "depends on itself")
 357
 358     elaborate err = hang (ptext (sLit "Could not find hi-boot interface for") <+>
 359                           quotes (ppr mod) <> colon) 4 err
 360 \end{code}
 361
 362
 363 %************************************************************************
 364 %*                                                                      *
 365                 Type and class declarations
 366 %*                                                                      *
 367 %************************************************************************
 368
 369 When typechecking a data type decl, we *lazily* (via forkM) typecheck
 370 the constructor argument types.  This is in the hope that we may never
 371 poke on those argument types, and hence may never need to load the
 372 interface files for types mentioned in the arg types.
 373
 374 E.g.
 375         data Foo.S = MkS Baz.T
 376 Mabye we can get away without even loading the interface for Baz!
 377
 378 This is not just a performance thing.  Suppose we have
 379         data Foo.S = MkS Baz.T
 380         data Baz.T = MkT Foo.S
 381 (in different interface files, of course).
 382 Now, first we load and typecheck Foo.S, and add it to the type envt.
 383 If we do explore MkS's argument, we'll load and typecheck Baz.T.
 384 If we explore MkT's argument we'll find Foo.S already in the envt.
 385
 386 If we typechecked constructor args eagerly, when loading Foo.S we'd try to
 387 typecheck the type Baz.T.  So we'd fault in Baz.T... and then need Foo.S...
 388 which isn't done yet.
 389
 390 All very cunning. However, there is a rather subtle gotcha which bit
 391 me when developing this stuff.  When we typecheck the decl for S, we
 392 extend the type envt with S, MkS, and all its implicit Ids.  Suppose
 393 (a bug, but it happened) that the list of implicit Ids depended in
 394 turn on the constructor arg types.  Then the following sequence of
 395 events takes place:
 396         * we build a thunk <t> for the constructor arg tys
 397         * we build a thunk for the extended type environment (depends on <t>)
 398         * we write the extended type envt into the global EPS mutvar
 399
 400 Now we look something up in the type envt
 401         * that pulls on <t>
 402         * which reads the global type envt out of the global EPS mutvar
 403         * but that depends in turn on <t>
 404
 405 It's subtle, because, it'd work fine if we typechecked the constructor args
 406 eagerly -- they don't need the extended type envt.  They just get the extended
 407 type envt by accident, because they look at it later.
 408
 409 What this means is that the implicitTyThings MUST NOT DEPEND on any of
 410 the forkM stuff.
 411
 412
 413 \begin{code}
 414 tcIfaceDecl :: Bool     -- True <=> discard IdInfo on IfaceId bindings
 415             -> IfaceDecl
 416             -> IfL TyThing
 417 tcIfaceDecl = tc_iface_decl NoParentTyCon
 418
 419 tc_iface_decl :: TyConParent    -- For nested declarations
 420               -> Bool   -- True <=> discard IdInfo on IfaceId bindings
 421               -> IfaceDecl
 422               -> IfL TyThing
 423 tc_iface_decl _ ignore_prags (IfaceId {ifName = occ_name, ifType = iface_type,
 424                                        ifIdDetails = details, ifIdInfo = info})
 425   = do  { name <- lookupIfaceTop occ_name
 426         ; ty <- tcIfaceType iface_type
 427         ; details <- tcIdDetails ty details
 428         ; info <- tcIdInfo ignore_prags name ty info
 429         ; return (AnId (mkGlobalId details name ty info)) }
 430
 431 tc_iface_decl parent _ (IfaceData {ifName = occ_name,
 432                           ifTyVars = tv_bndrs,
 433                           ifCtxt = ctxt, ifGadtSyntax = gadt_syn,
 434                           ifCons = rdr_cons,
 435                           ifRec = is_rec,
 436                           ifFamInst = mb_family })
 437   = bindIfaceTyVars_AT tv_bndrs $ \ tyvars -> do
 438     { tc_name <- lookupIfaceTop occ_name
 439     ; tycon <- fixM ( \ tycon -> do
 440             { stupid_theta <- tcIfaceCtxt ctxt
 441             ; cons <- tcIfaceDataCons tc_name tycon tyvars rdr_cons
 442             ; mb_fam_inst  <- tcFamInst mb_family
 443             ; buildAlgTyCon tc_name tyvars stupid_theta cons is_rec
 444                             gadt_syn parent mb_fam_inst
 445             })
 446     ; traceIf (text "tcIfaceDecl4" <+> ppr tycon)
 447     ; return (ATyCon tycon) }
 448
 449 tc_iface_decl parent _ (IfaceSyn {ifName = occ_name, ifTyVars = tv_bndrs,
 450                                   ifSynRhs = mb_rhs_ty,
 451                                   ifSynKind = kind, ifFamInst = mb_family})
 452    = bindIfaceTyVars_AT tv_bndrs $ \ tyvars -> do
 453      { tc_name  <- lookupIfaceTop occ_name
 454      ; rhs_kind <- tcIfaceType kind     -- Note [Synonym kind loop]
 455      ; rhs      <- forkM (mk_doc tc_name) $
 456                    tc_syn_rhs mb_rhs_ty
 457      ; fam_info <- tcFamInst mb_family
 458      ; tycon <- buildSynTyCon tc_name tyvars rhs rhs_kind parent fam_info
 459      ; return (ATyCon tycon)
 460      }
 461    where
 462      mk_doc n = ptext (sLit "Type syonym") <+> ppr n
 463      tc_syn_rhs Nothing   = return SynFamilyTyCon
 464      tc_syn_rhs (Just ty) = do { rhs_ty <- tcIfaceType ty
 465                                ; return (SynonymTyCon rhs_ty) }
 466
 467 tc_iface_decl _parent ignore_prags
 468             (IfaceClass {ifCtxt = rdr_ctxt, ifName = occ_name,
 469                          ifTyVars = tv_bndrs, ifFDs = rdr_fds,
 470                          ifATs = rdr_ats, ifSigs = rdr_sigs,
 471                          ifRec = tc_isrec })
 472 -- ToDo: in hs-boot files we should really treat abstract classes specially,
 473 --       as we do abstract tycons
 474   = bindIfaceTyVars tv_bndrs $ \ tyvars -> do
 475     { cls_name <- lookupIfaceTop occ_name
 476     ; ctxt <- tcIfaceCtxt rdr_ctxt
 477     ; sigs <- mapM tc_sig rdr_sigs
 478     ; fds  <- mapM tc_fd rdr_fds
 479     ; cls  <- fixM $ \ cls -> do
 480               { ats  <- mapM (tc_iface_decl (AssocFamilyTyCon cls) ignore_prags) rdr_ats
 481               ; buildClass ignore_prags cls_name tyvars ctxt fds ats sigs tc_isrec }
 482     ; return (AClass cls) }
 483   where
 484    tc_sig (IfaceClassOp occ dm rdr_ty)
 485      = do { op_name <- lookupIfaceTop occ
 486           ; op_ty   <- forkM (mk_doc op_name rdr_ty) (tcIfaceType rdr_ty)
 487                 -- Must be done lazily for just the same reason as the
 488                 -- type of a data con; to avoid sucking in types that
 489                 -- it mentions unless it's necessray to do so
 490           ; return (op_name, dm, op_ty) }
 491
 492    mk_doc op_name op_ty = ptext (sLit "Class op") <+> sep [ppr op_name, ppr op_ty]
 493
 494    tc_fd (tvs1, tvs2) = do { tvs1' <- mapM tcIfaceTyVar tvs1
 495                            ; tvs2' <- mapM tcIfaceTyVar tvs2
 496                            ; return (tvs1', tvs2') }
 497
 498 tc_iface_decl _ _ (IfaceForeign {ifName = rdr_name, ifExtName = ext_name})
 499   = do  { name <- lookupIfaceTop rdr_name
 500         ; return (ATyCon (mkForeignTyCon name ext_name
 501                                          liftedTypeKind 0)) }
 502
 503 tcFamInst :: Maybe (IfaceTyCon, [IfaceType]) -> IfL (Maybe (TyCon, [Type]))
 504 tcFamInst Nothing           = return Nothing
 505 tcFamInst (Just (fam, tys)) = do { famTyCon <- tcIfaceTyCon fam
 506                                  ; insttys <- mapM tcIfaceType tys
 507                                  ; return $ Just (famTyCon, insttys) }
 508
 509 tcIfaceDataCons :: Name -> TyCon -> [TyVar] -> IfaceConDecls -> IfL AlgTyConRhs
 510 tcIfaceDataCons tycon_name tycon _ if_cons
 511   = case if_cons of
 512         IfAbstractTyCon  -> return mkAbstractTyConRhs
 513         IfOpenDataTyCon  -> return DataFamilyTyCon
 514         IfDataTyCon cons -> do  { data_cons <- mapM tc_con_decl cons
 515                                 ; return (mkDataTyConRhs data_cons) }
 516         IfNewTyCon con   -> do  { data_con <- tc_con_decl con
 517                                 ; mkNewTyConRhs tycon_name tycon data_con }
 518   where
 519     tc_con_decl (IfCon { ifConInfix = is_infix,
 520                          ifConUnivTvs = univ_tvs, ifConExTvs = ex_tvs,
 521                          ifConOcc = occ, ifConCtxt = ctxt, ifConEqSpec = spec,
 522                          ifConArgTys = args, ifConFields = field_lbls,
 523                          ifConStricts = stricts})
 524      = bindIfaceTyVars univ_tvs $ \ univ_tyvars -> do
 525        bindIfaceTyVars ex_tvs    $ \ ex_tyvars -> do
 526         { name  <- lookupIfaceTop occ
 527         ; eq_spec <- tcIfaceEqSpec spec
 528         ; theta <- tcIfaceCtxt ctxt     -- Laziness seems not worth the bother here
 529                 -- At one stage I thought that this context checking *had*
 530                 -- to be lazy, because of possible mutual recursion between the
 531                 -- type and the classe:
 532                 -- E.g.
 533                 --      class Real a where { toRat :: a -> Ratio Integer }
 534                 --      data (Real a) => Ratio a = ...
 535                 -- But now I think that the laziness in checking class ops breaks
 536                 -- the loop, so no laziness needed
 537
 538         -- Read the argument types, but lazily to avoid faulting in
 539         -- the component types unless they are really needed
 540         ; arg_tys <- forkM (mk_doc name) (mapM tcIfaceType args)
 541         ; lbl_names <- mapM lookupIfaceTop field_lbls
 542
 543         -- Remember, tycon is the representation tycon
 544         ; let orig_res_ty = mkFamilyTyConApp tycon
 545                                 (substTyVars (mkTopTvSubst eq_spec) univ_tyvars)
 546
 547         ; buildDataCon name is_infix {- Not infix -}
 548                        stricts lbl_names
 549                        univ_tyvars ex_tyvars
 550                        eq_spec theta
 551                        arg_tys orig_res_ty tycon
 552         }
 553     mk_doc con_name = ptext (sLit "Constructor") <+> ppr con_name
 554
 555 tcIfaceEqSpec :: [(OccName, IfaceType)] -> IfL [(TyVar, Type)]
 556 tcIfaceEqSpec spec
 557   = mapM do_item spec
 558   where
 559     do_item (occ, if_ty) = do { tv <- tcIfaceTyVar (occNameFS occ)
 560                               ; ty <- tcIfaceType if_ty
 561                               ; return (tv,ty) }
 562 \end{code}
 563
 564 Note [Synonym kind loop]
 565 ~~~~~~~~~~~~~~~~~~~~~~~~
 566 Notice that we eagerly grab the *kind* from the interface file, but
 567 build a forkM thunk for the *rhs* (and family stuff).  To see why,
 568 consider this (Trac #2412)
 569
 570 M.hs:       module M where { import X; data T = MkT S }
 571 X.hs:       module X where { import {-# SOURCE #-} M; type S = T }
 572 M.hs-boot:  module M where { data T }
 573
 574 When kind-checking M.hs we need S's kind.  But we do not want to
 575 find S's kind from (typeKind S-rhs), because we don't want to look at
 576 S-rhs yet!  Since S is imported from X.hi, S gets just one chance to
 577 be defined, and we must not do that until we've finished with M.T.
 578
 579 Solution: record S's kind in the interface file; now we can safely
 580 look at it.
 581
 582 %************************************************************************
 583 %*                                                                      *
 584                 Instances
 585 %*                                                                      *
 586 %************************************************************************
 587
 588 \begin{code}
 589 tcIfaceInst :: IfaceInst -> IfL Instance
 590 tcIfaceInst (IfaceInst { ifDFun = dfun_occ, ifOFlag = oflag,
 591                          ifInstCls = cls, ifInstTys = mb_tcs })
 592   = do  { dfun    <- forkM (ptext (sLit "Dict fun") <+> ppr dfun_occ) $
 593                      tcIfaceExtId dfun_occ
 594         ; let mb_tcs' = map (fmap ifaceTyConName) mb_tcs
 595         ; return (mkImportedInstance cls mb_tcs' dfun oflag) }
 596
 597 tcIfaceFamInst :: IfaceFamInst -> IfL FamInst
 598 tcIfaceFamInst (IfaceFamInst { ifFamInstTyCon = tycon,
 599                                ifFamInstFam = fam, ifFamInstTys = mb_tcs })
 600 --      { tycon'  <- forkM (ptext (sLit "Inst tycon") <+> ppr tycon) $
 601 -- the above line doesn't work, but this below does => CPP in Haskell = evil!
 602     = do tycon'  <- forkM (text ("Inst tycon") <+> ppr tycon) $
 603                     tcIfaceTyCon tycon
 604          let mb_tcs' = map (fmap ifaceTyConName) mb_tcs
 605          return (mkImportedFamInst fam mb_tcs' tycon')
 606 \end{code}
 607
 608
 609 %************************************************************************
 610 %*                                                                      *
 611                 Rules
 612 %*                                                                      *
 613 %************************************************************************
 614
 615 We move a IfaceRule from eps_rules to eps_rule_base when all its LHS free vars
 616 are in the type environment.  However, remember that typechecking a Rule may
 617 (as a side effect) augment the type envt, and so we may need to iterate the process.
 618
 619 \begin{code}
 620 tcIfaceRules :: Bool            -- True <=> ignore rules
 621              -> [IfaceRule]
 622              -> IfL [CoreRule]
 623 tcIfaceRules ignore_prags if_rules
 624   | ignore_prags = return []
 625   | otherwise    = mapM tcIfaceRule if_rules
 626
 627 tcIfaceRule :: IfaceRule -> IfL CoreRule
 628 tcIfaceRule (IfaceRule {ifRuleName = name, ifActivation = act, ifRuleBndrs = bndrs,
 629                         ifRuleHead = fn, ifRuleArgs = args, ifRuleRhs = rhs,
 630                         ifRuleAuto = auto })
 631   = do  { ~(bndrs', args', rhs') <-
 632                 -- Typecheck the payload lazily, in the hope it'll never be looked at
 633                 forkM (ptext (sLit "Rule") <+> ftext name) $
 634                 bindIfaceBndrs bndrs                      $ \ bndrs' ->
 635                 do { args' <- mapM tcIfaceExpr args
 636                    ; rhs'  <- tcIfaceExpr rhs
 637                    ; return (bndrs', args', rhs') }
 638         ; let mb_tcs = map ifTopFreeName args
 639         ; return (Rule { ru_name = name, ru_fn = fn, ru_act = act,
 640                           ru_bndrs = bndrs', ru_args = args',
 641                           ru_rhs = occurAnalyseExpr rhs',
 642                           ru_rough = mb_tcs,
 643                           ru_auto = auto,
 644                           ru_local = False }) } -- An imported RULE is never for a local Id
 645                                                 -- or, even if it is (module loop, perhaps)
 646                                                 -- we'll just leave it in the non-local set
 647   where
 648         -- This function *must* mirror exactly what Rules.topFreeName does
 649         -- We could have stored the ru_rough field in the iface file
 650         -- but that would be redundant, I think.
 651         -- The only wrinkle is that we must not be deceived by
 652         -- type syononyms at the top of a type arg.  Since
 653         -- we can't tell at this point, we are careful not
 654         -- to write them out in coreRuleToIfaceRule
 655     ifTopFreeName :: IfaceExpr -> Maybe Name
 656     ifTopFreeName (IfaceType (IfaceTyConApp tc _ )) = Just (ifaceTyConName tc)
 657     ifTopFreeName (IfaceApp f _)                    = ifTopFreeName f
 658     ifTopFreeName (IfaceExt n)                      = Just n
 659     ifTopFreeName _                                 = Nothing
 660 \end{code}
 661
 662
 663 %************************************************************************
 664 %*                                                                      *
 665                 Annotations
 666 %*                                                                      *
 667 %************************************************************************
 668
 669 \begin{code}
 670 tcIfaceAnnotations :: [IfaceAnnotation] -> IfL [Annotation]
 671 tcIfaceAnnotations = mapM tcIfaceAnnotation
 672
 673 tcIfaceAnnotation :: IfaceAnnotation -> IfL Annotation
 674 tcIfaceAnnotation (IfaceAnnotation target serialized) = do
 675     target' <- tcIfaceAnnTarget target
 676     return $ Annotation {
 677         ann_target = target',
 678         ann_value = serialized
 679     }
 680
 681 tcIfaceAnnTarget :: IfaceAnnTarget -> IfL (AnnTarget Name)
 682 tcIfaceAnnTarget (NamedTarget occ) = do
 683     name <- lookupIfaceTop occ
 684     return $ NamedTarget name
 685 tcIfaceAnnTarget (ModuleTarget mod) = do
 686     return $ ModuleTarget mod
 687
 688 \end{code}
 689
 690
 691 %************************************************************************
 692 %*                                                                      *
 693                 Vectorisation information
 694 %*                                                                      *
 695 %************************************************************************
 696
 697 \begin{code}
 698 tcIfaceVectInfo :: Module -> TypeEnv  -> IfaceVectInfo -> IfL VectInfo
 699 tcIfaceVectInfo mod typeEnv (IfaceVectInfo
 700                              { ifaceVectInfoVar        = vars
 701                              , ifaceVectInfoTyCon      = tycons
 702                              , ifaceVectInfoTyConReuse = tyconsReuse
 703                              })
 704   = do { vVars     <- mapM vectVarMapping vars
 705        ; tyConRes1 <- mapM vectTyConMapping      tycons
 706        ; tyConRes2 <- mapM vectTyConReuseMapping tyconsReuse
 707        ; let (vTyCons, vDataCons, vPAs, vIsos) = unzip4 (tyConRes1 ++ tyConRes2)
 708        ; return $ VectInfo
 709                   { vectInfoVar     = mkVarEnv  vVars
 710                   , vectInfoTyCon   = mkNameEnv vTyCons
 711                   , vectInfoDataCon = mkNameEnv (concat vDataCons)
 712                   , vectInfoPADFun  = mkNameEnv vPAs
 713                   , vectInfoIso     = mkNameEnv vIsos
 714                   }
 715        }
 716   where
 717     vectVarMapping name
 718       = do { vName <- lookupOrig mod (mkVectOcc (nameOccName name))
 719            ; let { var  = lookupVar name
 720                  ; vVar = lookupVar vName
 721                  }
 722            ; return (var, (var, vVar))
 723            }
 724     vectTyConMapping name
 725       = do { vName   <- lookupOrig mod (mkVectTyConOcc (nameOccName name))
 726            ; paName  <- lookupOrig mod (mkPADFunOcc    (nameOccName name))
 727            ; isoName <- lookupOrig mod (mkVectIsoOcc   (nameOccName name))
 728            ; let { tycon    = lookupTyCon name
 729                  ; vTycon   = lookupTyCon vName
 730                  ; paTycon  = lookupVar paName
 731                  ; isoTycon = lookupVar isoName
 732                  }
 733            ; vDataCons <- mapM vectDataConMapping (tyConDataCons tycon)
 734            ; return ((name, (tycon, vTycon)),    -- (T, T_v)
 735                      vDataCons,                  -- list of (Ci, Ci_v)
 736                      (vName, (vTycon, paTycon)), -- (T_v, paT)
 737                      (name, (tycon, isoTycon)))  -- (T, isoT)
 738            }
 739     vectTyConReuseMapping name
 740       = do { paName  <- lookupOrig mod (mkPADFunOcc    (nameOccName name))
 741            ; isoName <- lookupOrig mod (mkVectIsoOcc   (nameOccName name))
 742            ; let { tycon      = lookupTyCon name
 743                  ; paTycon    = lookupVar paName
 744                  ; isoTycon   = lookupVar isoName
 745                  ; vDataCons  = [ (dataConName dc, (dc, dc))
 746                                 | dc <- tyConDataCons tycon]
 747                  }
 748            ; return ((name, (tycon, tycon)),     -- (T, T)
 749                      vDataCons,                  -- list of (Ci, Ci)
 750                      (name, (tycon, paTycon)),   -- (T, paT)
 751                      (name, (tycon, isoTycon)))  -- (T, isoT)
 752            }
 753     vectDataConMapping datacon
 754       = do { let name = dataConName datacon
 755            ; vName <- lookupOrig mod (mkVectDataConOcc (nameOccName name))
 756            ; let vDataCon = lookupDataCon vName
 757            ; return (name, (datacon, vDataCon))
 758            }
 759     --
 760     lookupVar name = case lookupTypeEnv typeEnv name of
 761                        Just (AnId var) -> var
 762                        Just _         ->
 763                          panic "TcIface.tcIfaceVectInfo: not an id"
 764                        Nothing        ->
 765                          panic "TcIface.tcIfaceVectInfo: unknown name"
 766     lookupTyCon name = case lookupTypeEnv typeEnv name of
 767                          Just (ATyCon tc) -> tc
 768                          Just _         ->
 769                            panic "TcIface.tcIfaceVectInfo: not a tycon"
 770                          Nothing        ->
 771                            panic "TcIface.tcIfaceVectInfo: unknown name"
 772     lookupDataCon name = case lookupTypeEnv typeEnv name of
 773                            Just (ADataCon dc) -> dc
 774                            Just _         ->
 775                              panic "TcIface.tcIfaceVectInfo: not a datacon"
 776                            Nothing        ->
 777                              panic "TcIface.tcIfaceVectInfo: unknown name"
 778 \end{code}
 779
 780 %************************************************************************
 781 %*                                                                      *
 782                         Types
 783 %*                                                                      *
 784 %************************************************************************
 785
 786 \begin{code}
 787 tcIfaceType :: IfaceType -> IfL Type
 788 tcIfaceType (IfaceTyVar n)        = do { tv <- tcIfaceTyVar n; return (TyVarTy tv) }
 789 tcIfaceType (IfaceAppTy t1 t2)    = do { t1' <- tcIfaceType t1; t2' <- tcIfaceType t2; return (AppTy t1' t2') }
 790 tcIfaceType (IfaceFunTy t1 t2)    = do { t1' <- tcIfaceType t1; t2' <- tcIfaceType t2; return (FunTy t1' t2') }
 791 tcIfaceType (IfaceTyConApp tc ts) = do { tc' <- tcIfaceTyCon tc; ts' <- tcIfaceTypes ts; return (mkTyConApp tc' ts') }
 792 tcIfaceType (IfaceForAllTy tv t)  = bindIfaceTyVar tv $ \ tv' -> do { t' <- tcIfaceType t; return (ForAllTy tv' t') }
 793 tcIfaceType (IfacePredTy st)      = do { st' <- tcIfacePredType st; return (PredTy st') }
 794
 795 tcIfaceTypes :: [IfaceType] -> IfL [Type]
 796 tcIfaceTypes tys = mapM tcIfaceType tys
 797
 798 -----------------------------------------
 799 tcIfacePredType :: IfacePredType -> IfL PredType
 800 tcIfacePredType (IfaceClassP cls ts) = do { cls' <- tcIfaceClass cls; ts' <- tcIfaceTypes ts; return (ClassP cls' ts') }
 801 tcIfacePredType (IfaceIParam ip t)   = do { ip' <- newIPName ip; t' <- tcIfaceType t; return (IParam ip' t') }
 802 tcIfacePredType (IfaceEqPred t1 t2)  = do { t1' <- tcIfaceType t1; t2' <- tcIfaceType t2; return (EqPred t1' t2') }
 803
 804 -----------------------------------------
 805 tcIfaceCtxt :: IfaceContext -> IfL ThetaType
 806 tcIfaceCtxt sts = mapM tcIfacePredType sts
 807 \end{code}
 808
 809
 810 %************************************************************************
 811 %*                                                                      *
 812                         Core
 813 %*                                                                      *
 814 %************************************************************************
 815
 816 \begin{code}
 817 tcIfaceExpr :: IfaceExpr -> IfL CoreExpr
 818 tcIfaceExpr (IfaceType ty)
 819   = Type <$> tcIfaceType ty
 820
 821 tcIfaceExpr (IfaceLcl name)
 822   = Var <$> tcIfaceLclId name
 823
 824 tcIfaceExpr (IfaceTick modName tickNo)
 825   = Var <$> tcIfaceTick modName tickNo
 826
 827 tcIfaceExpr (IfaceExt gbl)
 828   = Var <$> tcIfaceExtId gbl
 829
 830 tcIfaceExpr (IfaceLit lit)
 831   = return (Lit lit)
 832
 833 tcIfaceExpr (IfaceFCall cc ty) = do
 834     ty' <- tcIfaceType ty
 835     u <- newUnique
 836     return (Var (mkFCallId u cc ty'))
 837
 838 tcIfaceExpr (IfaceTuple boxity args)  = do
 839     args' <- mapM tcIfaceExpr args
 840     -- Put the missing type arguments back in
 841     let con_args = map (Type . exprType) args' ++ args'
 842     return (mkApps (Var con_id) con_args)
 843   where
 844     arity = length args
 845     con_id = dataConWorkId (tupleCon boxity arity)
 846
 847
 848 tcIfaceExpr (IfaceLam bndr body)
 849   = bindIfaceBndr bndr $ \bndr' ->
 850     Lam bndr' <$> tcIfaceExpr body
 851
 852 tcIfaceExpr (IfaceApp fun arg)
 853   = App <$> tcIfaceExpr fun <*> tcIfaceExpr arg
 854
 855 tcIfaceExpr (IfaceCase scrut case_bndr ty alts)  = do
 856     scrut' <- tcIfaceExpr scrut
 857     case_bndr_name <- newIfaceName (mkVarOccFS case_bndr)
 858     let
 859         scrut_ty   = exprType scrut'
 860         case_bndr' = mkLocalId case_bndr_name scrut_ty
 861         tc_app     = splitTyConApp scrut_ty
 862                 -- NB: Won't always succeed (polymoprhic case)
 863                 --     but won't be demanded in those cases
 864                 -- NB: not tcSplitTyConApp; we are looking at Core here
 865                 --     look through non-rec newtypes to find the tycon that
 866                 --     corresponds to the datacon in this case alternative
 867
 868     extendIfaceIdEnv [case_bndr'] $ do
 869      alts' <- mapM (tcIfaceAlt scrut' tc_app) alts
 870      ty' <- tcIfaceType ty
 871      return (Case scrut' case_bndr' ty' alts')
 872
 873 tcIfaceExpr (IfaceLet (IfaceNonRec (IfLetBndr fs ty info) rhs) body)
 874   = do  { name    <- newIfaceName (mkVarOccFS fs)
 875         ; ty'     <- tcIfaceType ty
 876         ; id_info <- tcIdInfo False {- Don't ignore prags; we are inside one! -}
 877                               name ty' info
 878         ; let id = mkLocalIdWithInfo name ty' id_info
 879         ; rhs' <- tcIfaceExpr rhs
 880         ; body' <- extendIfaceIdEnv [id] (tcIfaceExpr body)
 881         ; return (Let (NonRec id rhs') body') }
 882
 883 tcIfaceExpr (IfaceLet (IfaceRec pairs) body)
 884   = do { ids <- mapM tc_rec_bndr (map fst pairs)
 885        ; extendIfaceIdEnv ids $ do
 886        { pairs' <- zipWithM tc_pair pairs ids
 887        ; body' <- tcIfaceExpr body
 888        ; return (Let (Rec pairs') body') } }
 889  where
 890    tc_rec_bndr (IfLetBndr fs ty _)
 891      = do { name <- newIfaceName (mkVarOccFS fs)
 892           ; ty'  <- tcIfaceType ty
 893           ; return (mkLocalId name ty') }
 894    tc_pair (IfLetBndr _ _ info, rhs) id
 895      = do { rhs' <- tcIfaceExpr rhs
 896           ; id_info <- tcIdInfo False {- Don't ignore prags; we are inside one! -}
 897                                 (idName id) (idType id) info
 898           ; return (setIdInfo id id_info, rhs') }
 899
 900 tcIfaceExpr (IfaceCast expr co) = do
 901     expr' <- tcIfaceExpr expr
 902     co' <- tcIfaceType co
 903     return (Cast expr' co')
 904
 905 tcIfaceExpr (IfaceNote note expr) = do
 906     expr' <- tcIfaceExpr expr
 907     case note of
 908         IfaceSCC cc       -> return (Note (SCC cc)   expr')
 909         IfaceCoreNote n   -> return (Note (CoreNote n) expr')
 910
 911 -------------------------
 912 tcIfaceAlt :: CoreExpr -> (TyCon, [Type])
 913            -> (IfaceConAlt, [FastString], IfaceExpr)
 914            -> IfL (AltCon, [TyVar], CoreExpr)
 915 tcIfaceAlt _ _ (IfaceDefault, names, rhs)
 916   = ASSERT( null names ) do
 917     rhs' <- tcIfaceExpr rhs
 918     return (DEFAULT, [], rhs')
 919
 920 tcIfaceAlt _ _ (IfaceLitAlt lit, names, rhs)
 921   = ASSERT( null names ) do
 922     rhs' <- tcIfaceExpr rhs
 923     return (LitAlt lit, [], rhs')
 924
 925 -- A case alternative is made quite a bit more complicated
 926 -- by the fact that we omit type annotations because we can
 927 -- work them out.  True enough, but its not that easy!
 928 tcIfaceAlt scrut (tycon, inst_tys) (IfaceDataAlt data_occ, arg_strs, rhs)
 929   = do  { con <- tcIfaceDataCon data_occ
 930         ; when (debugIsOn && not (con `elem` tyConDataCons tycon))
 931                (failIfM (ppr scrut $$ ppr con $$ ppr tycon $$ ppr (tyConDataCons tycon)))
 932         ; tcIfaceDataAlt con inst_tys arg_strs rhs }
 933
 934 tcIfaceAlt _ (tycon, inst_tys) (IfaceTupleAlt _boxity, arg_occs, rhs)
 935   = ASSERT2( isTupleTyCon tycon, ppr tycon )
 936     do  { let [data_con] = tyConDataCons tycon
 937         ; tcIfaceDataAlt data_con inst_tys arg_occs rhs }
 938
 939 tcIfaceDataAlt :: DataCon -> [Type] -> [FastString] -> IfaceExpr
 940                -> IfL (AltCon, [TyVar], CoreExpr)
 941 tcIfaceDataAlt con inst_tys arg_strs rhs
 942   = do  { us <- newUniqueSupply
 943         ; let uniqs = uniqsFromSupply us
 944         ; let (ex_tvs, co_tvs, arg_ids)
 945                       = dataConRepFSInstPat arg_strs uniqs con inst_tys
 946               all_tvs = ex_tvs ++ co_tvs
 947
 948         ; rhs' <- extendIfaceTyVarEnv all_tvs   $
 949                   extendIfaceIdEnv arg_ids      $
 950                   tcIfaceExpr rhs
 951         ; return (DataAlt con, all_tvs ++ arg_ids, rhs') }
 952 \end{code}
 953
 954
 955 \begin{code}
 956 tcExtCoreBindings :: [IfaceBinding] -> IfL [CoreBind]   -- Used for external core
 957 tcExtCoreBindings []     = return []
 958 tcExtCoreBindings (b:bs) = do_one b (tcExtCoreBindings bs)
 959
 960 do_one :: IfaceBinding -> IfL [CoreBind] -> IfL [CoreBind]
 961 do_one (IfaceNonRec bndr rhs) thing_inside
 962   = do  { rhs' <- tcIfaceExpr rhs
 963         ; bndr' <- newExtCoreBndr bndr
 964         ; extendIfaceIdEnv [bndr'] $ do
 965         { core_binds <- thing_inside
 966         ; return (NonRec bndr' rhs' : core_binds) }}
 967
 968 do_one (IfaceRec pairs) thing_inside
 969   = do  { bndrs' <- mapM newExtCoreBndr bndrs
 970         ; extendIfaceIdEnv bndrs' $ do
 971         { rhss' <- mapM tcIfaceExpr rhss
 972         ; core_binds <- thing_inside
 973         ; return (Rec (bndrs' `zip` rhss') : core_binds) }}
 974   where
 975     (bndrs,rhss) = unzip pairs
 976 \end{code}
 977
 978
 979 %************************************************************************
 980 %*                                                                      *
 981                 IdInfo
 982 %*                                                                      *
 983 %************************************************************************
 984
 985 \begin{code}
 986 tcIdDetails :: Type -> IfaceIdDetails -> IfL IdDetails
 987 tcIdDetails _  IfVanillaId = return VanillaId
 988 tcIdDetails ty (IfDFunId ns)
 989   = return (DFunId ns (isNewTyCon (classTyCon cls)))
 990   where
 991     (_, _, cls, _) = tcSplitDFunTy ty
 992
 993 tcIdDetails _ (IfRecSelId tc naughty)
 994   = do { tc' <- tcIfaceTyCon tc
 995        ; return (RecSelId { sel_tycon = tc', sel_naughty = naughty }) }
 996
 997 tcIdInfo :: Bool -> Name -> Type -> IfaceIdInfo -> IfL IdInfo
 998 tcIdInfo ignore_prags name ty info
 999   | ignore_prags = return vanillaIdInfo
1000   | otherwise    = case info of
1001                         NoInfo       -> return vanillaIdInfo
1002                         HasInfo info -> foldlM tcPrag init_info info
1003   where
1004     -- Set the CgInfo to something sensible but uninformative before
1005     -- we start; default assumption is that it has CAFs
1006     init_info = vanillaIdInfo
1007
1008     tcPrag :: IdInfo -> IfaceInfoItem -> IfL IdInfo
1009     tcPrag info HsNoCafRefs        = return (info `setCafInfo`   NoCafRefs)
1010     tcPrag info (HsArity arity)    = return (info `setArityInfo` arity)
1011     tcPrag info (HsStrictness str) = return (info `setStrictnessInfo` Just str)
1012     tcPrag info (HsInline prag)    = return (info `setInlinePragInfo` prag)
1013
1014         -- The next two are lazy, so they don't transitively suck stuff in
1015     tcPrag info (HsUnfold lb if_unf)
1016       = do { unf <- tcUnfolding name ty info if_unf
1017            ; let info1 | lb        = info `setOccInfo` nonRuleLoopBreaker
1018                        | otherwise = info
1019            ; return (info1 `setUnfoldingInfoLazily` unf) }
1020 \end{code}
1021
1022 \begin{code}
1023 tcUnfolding :: Name -> Type -> IdInfo -> IfaceUnfolding -> IfL Unfolding
1024 tcUnfolding name _ info (IfCoreUnfold stable if_expr)
1025   = do  { mb_expr <- tcPragExpr name if_expr
1026         ; let unf_src = if stable then InlineStable else InlineRhs
1027         ; return (case mb_expr of
1028                     Nothing   -> NoUnfolding
1029                     Just expr -> mkUnfolding unf_src
1030                                              True {- Top level -}
1031                                              is_bottoming expr) }
1032   where
1033      -- Strictness should occur before unfolding!
1034     is_bottoming = case strictnessInfo info of
1035                      Just sig -> isBottomingSig sig
1036                      Nothing  -> False
1037
1038 tcUnfolding name _ _ (IfCompulsory if_expr)
1039   = do  { mb_expr <- tcPragExpr name if_expr
1040         ; return (case mb_expr of
1041                     Nothing   -> NoUnfolding
1042                     Just expr -> mkCompulsoryUnfolding expr) }
1043
1044 tcUnfolding name _ _ (IfInlineRule arity unsat_ok boring_ok if_expr)
1045   = do  { mb_expr <- tcPragExpr name if_expr
1046         ; return (case mb_expr of
1047                     Nothing   -> NoUnfolding
1048                     Just expr -> mkCoreUnfolding InlineStable True expr arity
1049                                                  (UnfWhen unsat_ok boring_ok))
1050     }
1051
1052 tcUnfolding name dfun_ty _ (IfDFunUnfold ops)
1053   = do { mb_ops1 <- forkM_maybe doc $ mapM tc_arg ops
1054        ; return (case mb_ops1 of
1055                     Nothing   -> noUnfolding
1056                     Just ops1 -> mkDFunUnfolding dfun_ty ops1) }
1057   where
1058     doc = text "Class ops for dfun" <+> ppr name
1059     tc_arg (DFunPolyArg  e) = do { e' <- tcIfaceExpr e; return (DFunPolyArg e') }
1060     tc_arg (DFunConstArg e) = do { e' <- tcIfaceExpr e; return (DFunConstArg e') }
1061     tc_arg (DFunLamArg i)   = return (DFunLamArg i)
1062
1063 tcUnfolding name ty info (IfExtWrapper arity wkr)
1064   = tcIfaceWrapper name ty info arity (tcIfaceExtId wkr)
1065 tcUnfolding name ty info (IfLclWrapper arity wkr)
1066   = tcIfaceWrapper name ty info arity (tcIfaceLclId wkr)
1067
1068 -------------
1069 tcIfaceWrapper :: Name -> Type -> IdInfo -> Arity -> IfL Id -> IfL Unfolding
1070 tcIfaceWrapper name ty info arity get_worker
1071   = do  { mb_wkr_id <- forkM_maybe doc get_worker
1072         ; us <- newUniqueSupply
1073         ; return (case mb_wkr_id of
1074                      Nothing     -> noUnfolding
1075                      Just wkr_id -> make_inline_rule wkr_id us) }
1076   where
1077     doc = text "Worker for" <+> ppr name
1078
1079     make_inline_rule wkr_id us
1080         = mkWwInlineRule wkr_id
1081                          (initUs_ us (mkWrapper ty strict_sig) wkr_id)
1082                          arity
1083
1084         -- Again we rely here on strictness info always appearing
1085         -- before unfolding
1086     strict_sig = case strictnessInfo info of
1087                    Just sig -> sig
1088                    Nothing  -> pprPanic "Worker info but no strictness for" (ppr name)
1089 \end{code}
1090
1091 For unfoldings we try to do the job lazily, so that we never type check
1092 an unfolding that isn't going to be looked at.
1093
1094 \begin{code}
1095 tcPragExpr :: Name -> IfaceExpr -> IfL (Maybe CoreExpr)
1096 tcPragExpr name expr
1097   = forkM_maybe doc $ do
1098     core_expr' <- tcIfaceExpr expr
1099
1100                 -- Check for type consistency in the unfolding
1101     ifDOptM Opt_DoCoreLinting $ do
1102         in_scope <- get_in_scope
1103         case lintUnfolding noSrcLoc in_scope core_expr' of
1104           Nothing       -> return ()
1105           Just fail_msg -> do { mod <- getIfModule
1106                               ; pprPanic "Iface Lint failure"
1107                                   (vcat [ ptext (sLit "In interface for") <+> ppr mod
1108                                         , hang doc 2 fail_msg
1109                                         , ppr name <+> equals <+> ppr core_expr'
1110                                         , ptext (sLit "Iface expr =") <+> ppr expr ]) }
1111     return core_expr'
1112   where
1113     doc = text "Unfolding of" <+> ppr name
1114
1115     get_in_scope :: IfL [Var] -- Totally disgusting; but just for linting
1116     get_in_scope
1117         = do { (gbl_env, lcl_env) <- getEnvs
1118              ; rec_ids <- case if_rec_types gbl_env of
1119                             Nothing -> return []
1120                             Just (_, get_env) -> do
1121                                { type_env <- setLclEnv () get_env
1122                                ; return (typeEnvIds type_env) }
1123              ; return (varEnvElts (if_tv_env lcl_env) ++
1124                        varEnvElts (if_id_env lcl_env) ++
1125                        rec_ids) }
1126 \end{code}
1127
1128
1129
1130 %************************************************************************
1131 %*                                                                      *
1132                 Getting from Names to TyThings
1133 %*                                                                      *
1134 %************************************************************************
1135
1136 \begin{code}
1137 tcIfaceGlobal :: Name -> IfL TyThing
1138 tcIfaceGlobal name
1139   | Just thing <- wiredInNameTyThing_maybe name
1140         -- Wired-in things include TyCons, DataCons, and Ids
1141   = do { ifCheckWiredInThing thing; return thing }
1142   | otherwise
1143   = do  { env <- getGblEnv
1144         ; case if_rec_types env of {    -- Note [Tying the knot]
1145             Just (mod, get_type_env)
1146                 | nameIsLocalOrFrom mod name
1147                 -> do           -- It's defined in the module being compiled
1148                 { type_env <- setLclEnv () get_type_env         -- yuk
1149                 ; case lookupNameEnv type_env name of
1150                         Just thing -> return thing
1151                         Nothing   -> pprPanic "tcIfaceGlobal (local): not found:"
1152                                                 (ppr name $$ ppr type_env) }
1153
1154           ; _ -> do
1155
1156         { hsc_env <- getTopEnv
1157         ; mb_thing <- liftIO (lookupTypeHscEnv hsc_env name)
1158         ; case mb_thing of {
1159             Just thing -> return thing ;
1160             Nothing    -> do
1161
1162         { mb_thing <- importDecl name   -- It's imported; go get it
1163         ; case mb_thing of
1164             Failed err      -> failIfM err
1165             Succeeded thing -> return thing
1166     }}}}}
1167
1168 -- Note [Tying the knot]
1169 -- ~~~~~~~~~~~~~~~~~~~~~
1170 -- The if_rec_types field is used in two situations:
1171 --
1172 -- a) Compiling M.hs, which indiretly imports Foo.hi, which mentions M.T
1173 --    Then we look up M.T in M's type environment, which is splatted into if_rec_types
1174 --    after we've built M's type envt.
1175 --
1176 -- b) In ghc --make, during the upsweep, we encounter M.hs, whose interface M.hi
1177 --    is up to date.  So we call typecheckIface on M.hi.  This splats M.T into
1178 --    if_rec_types so that the (lazily typechecked) decls see all the other decls
1179 --
1180 -- In case (b) it's important to do the if_rec_types check *before* looking in the HPT
1181 -- Because if M.hs also has M.hs-boot, M.T will *already be* in the HPT, but in its
1182 -- emasculated form (e.g. lacking data constructors).
1183
1184 tcIfaceTyCon :: IfaceTyCon -> IfL TyCon
1185 tcIfaceTyCon IfaceIntTc         = tcWiredInTyCon intTyCon
1186 tcIfaceTyCon IfaceBoolTc        = tcWiredInTyCon boolTyCon
1187 tcIfaceTyCon IfaceCharTc        = tcWiredInTyCon charTyCon
1188 tcIfaceTyCon IfaceListTc        = tcWiredInTyCon listTyCon
1189 tcIfaceTyCon IfacePArrTc        = tcWiredInTyCon parrTyCon
1190 tcIfaceTyCon (IfaceTupTc bx ar) = tcWiredInTyCon (tupleTyCon bx ar)
1191 tcIfaceTyCon (IfaceAnyTc kind)  = do { tc_kind <- tcIfaceType kind
1192                                      ; tcWiredInTyCon (anyTyConOfKind tc_kind) }
1193 tcIfaceTyCon (IfaceTc name)     = do { thing <- tcIfaceGlobal name
1194                                      ; return (check_tc (tyThingTyCon thing)) }
1195   where
1196     check_tc tc
1197      | debugIsOn = case toIfaceTyCon tc of
1198                    IfaceTc _ -> tc
1199                    _         -> pprTrace "check_tc" (ppr tc) tc
1200      | otherwise = tc
1201 -- we should be okay just returning Kind constructors without extra loading
1202 tcIfaceTyCon IfaceLiftedTypeKindTc   = return liftedTypeKindTyCon
1203 tcIfaceTyCon IfaceOpenTypeKindTc     = return openTypeKindTyCon
1204 tcIfaceTyCon IfaceUnliftedTypeKindTc = return unliftedTypeKindTyCon
1205 tcIfaceTyCon IfaceArgTypeKindTc      = return argTypeKindTyCon
1206 tcIfaceTyCon IfaceUbxTupleKindTc     = return ubxTupleKindTyCon
1207
1208 -- Even though we are in an interface file, we want to make
1209 -- sure the instances and RULES of this tycon are loaded
1210 -- Imagine: f :: Double -> Double
1211 tcWiredInTyCon :: TyCon -> IfL TyCon
1212 tcWiredInTyCon tc = do { ifCheckWiredInThing (ATyCon tc)
1213                        ; return tc }
1214
1215 tcIfaceClass :: Name -> IfL Class
1216 tcIfaceClass name = do { thing <- tcIfaceGlobal name
1217                        ; return (tyThingClass thing) }
1218
1219 tcIfaceDataCon :: Name -> IfL DataCon
1220 tcIfaceDataCon name = do { thing <- tcIfaceGlobal name
1221                          ; case thing of
1222                                 ADataCon dc -> return dc
1223                                 _       -> pprPanic "tcIfaceExtDC" (ppr name$$ ppr thing) }
1224
1225 tcIfaceExtId :: Name -> IfL Id
1226 tcIfaceExtId name = do { thing <- tcIfaceGlobal name
1227                        ; case thing of
1228                           AnId id -> return id
1229                           _       -> pprPanic "tcIfaceExtId" (ppr name$$ ppr thing) }
1230 \end{code}
1231
1232 %************************************************************************
1233 %*                                                                      *
1234                 Bindings
1235 %*                                                                      *
1236 %************************************************************************
1237
1238 \begin{code}
1239 bindIfaceBndr :: IfaceBndr -> (CoreBndr -> IfL a) -> IfL a
1240 bindIfaceBndr (IfaceIdBndr (fs, ty)) thing_inside
1241   = do  { name <- newIfaceName (mkVarOccFS fs)
1242         ; ty' <- tcIfaceType ty
1243         ; let id = mkLocalId name ty'
1244         ; extendIfaceIdEnv [id] (thing_inside id) }
1245 bindIfaceBndr (IfaceTvBndr bndr) thing_inside
1246   = bindIfaceTyVar bndr thing_inside
1247
1248 bindIfaceBndrs :: [IfaceBndr] -> ([CoreBndr] -> IfL a) -> IfL a
1249 bindIfaceBndrs []     thing_inside = thing_inside []
1250 bindIfaceBndrs (b:bs) thing_inside
1251   = bindIfaceBndr b     $ \ b' ->
1252     bindIfaceBndrs bs   $ \ bs' ->
1253     thing_inside (b':bs')
1254
1255 -----------------------
1256 newExtCoreBndr :: IfaceLetBndr -> IfL Id
1257 newExtCoreBndr (IfLetBndr var ty _)    -- Ignoring IdInfo for now
1258   = do  { mod <- getIfModule
1259         ; name <- newGlobalBinder mod (mkVarOccFS var) noSrcSpan
1260         ; ty' <- tcIfaceType ty
1261         ; return (mkLocalId name ty') }
1262
1263 -----------------------
1264 bindIfaceTyVar :: IfaceTvBndr -> (TyVar -> IfL a) -> IfL a
1265 bindIfaceTyVar (occ,kind) thing_inside
1266   = do  { name <- newIfaceName (mkTyVarOccFS occ)
1267         ; tyvar <- mk_iface_tyvar name kind
1268         ; extendIfaceTyVarEnv [tyvar] (thing_inside tyvar) }
1269
1270 bindIfaceTyVars :: [IfaceTvBndr] -> ([TyVar] -> IfL a) -> IfL a
1271 bindIfaceTyVars bndrs thing_inside
1272   = do  { names <- newIfaceNames (map mkTyVarOccFS occs)
1273         ; tyvars <- zipWithM mk_iface_tyvar names kinds
1274         ; extendIfaceTyVarEnv tyvars (thing_inside tyvars) }
1275   where
1276     (occs,kinds) = unzip bndrs
1277
1278 mk_iface_tyvar :: Name -> IfaceKind -> IfL TyVar
1279 mk_iface_tyvar name ifKind
1280    = do { kind <- tcIfaceType ifKind
1281         ; if isCoercionKind kind then
1282                 return (Var.mkCoVar name kind)
1283           else
1284                 return (Var.mkTyVar name kind) }
1285
1286 bindIfaceTyVars_AT :: [IfaceTvBndr] -> ([TyVar] -> IfL a) -> IfL a
1287 -- Used for type variable in nested associated data/type declarations
1288 -- where some of the type variables are already in scope
1289 --    class C a where { data T a b }
1290 -- Here 'a' is in scope when we look at the 'data T'
1291 bindIfaceTyVars_AT [] thing_inside
1292   = thing_inside []
1293 bindIfaceTyVars_AT (b@(tv_occ,_) : bs) thing_inside
1294   = bindIfaceTyVars_AT bs $ \ bs' ->
1295     do { mb_tv <- lookupIfaceTyVar tv_occ
1296        ; case mb_tv of
1297            Just b' -> thing_inside (b':bs')
1298            Nothing -> bindIfaceTyVar b $ \ b' ->
1299                       thing_inside (b':bs') }
1300 \end{code}
1301