2 % (c) The University of Glasgow, 2000
4 \section[HscTypes]{Types for the per-module compiler}
8 -- * Sessions and compilation state
9 Session(..), HscEnv(..), hscEPS,
10 FinderCache, FinderCacheEntry,
11 Target(..), TargetId(..), pprTarget, pprTargetId,
14 ModDetails(..), emptyModDetails,
15 ModGuts(..), CgGuts(..), ModImports(..), ForeignStubs(..),
17 ModSummary(..), showModMsg, isBootSummary,
18 msHsFilePath, msHiFilePath, msObjFilePath,
20 HscSource(..), isHsBoot, hscSourceString, -- Re-exported from DriverPhases
22 HomePackageTable, HomeModInfo(..), emptyHomePackageTable,
23 hptInstances, hptRules,
25 ExternalPackageState(..), EpsStats(..), addEpsInStats,
26 PackageTypeEnv, PackageIfaceTable, emptyPackageIfaceTable,
27 lookupIface, lookupIfaceByModule, emptyModIface,
29 InteractiveContext(..), emptyInteractiveContext,
30 icPrintUnqual, unQualInScope,
32 ModIface(..), mkIfaceDepCache, mkIfaceVerCache, mkIfaceFixCache,
35 Deprecs(..), IfaceDeprecs,
37 FixityEnv, FixItem(..), lookupFixity, emptyFixityEnv,
41 TyThing(..), tyThingClass, tyThingTyCon, tyThingDataCon, tyThingId,
42 TypeEnv, lookupType, mkTypeEnv, emptyTypeEnv,
43 extendTypeEnv, extendTypeEnvList, extendTypeEnvWithIds, lookupTypeEnv,
44 typeEnvElts, typeEnvClasses, typeEnvTyCons, typeEnvIds,
46 WhetherHasOrphans, IsBootInterface, Usage(..),
47 Dependencies(..), noDependencies,
48 NameCache(..), OrigNameCache, OrigIParamCache,
49 Avails, availsToNameSet, availName, availNames,
50 GenAvailInfo(..), AvailInfo, RdrAvailInfo,
53 Deprecations, DeprecTxt, lookupDeprec, plusDeprecs,
55 PackageInstEnv, PackageRuleBase,
58 Linkable(..), isObjectLinkable,
59 Unlinked(..), CompiledByteCode,
60 isObject, nameOfObject, isInterpretable, byteCodeOfObject
63 #include "HsVersions.h"
66 import ByteCodeAsm ( CompiledByteCode )
69 import RdrName ( GlobalRdrEnv, emptyGlobalRdrEnv,
70 LocalRdrEnv, emptyLocalRdrEnv,
71 GlobalRdrElt(..), mkRdrUnqual, lookupGRE_RdrName )
72 import Name ( Name, NamedThing, getName, nameOccName, nameModule )
75 import OccName ( OccName, OccEnv, lookupOccEnv, mkOccEnv, emptyOccEnv,
78 import InstEnv ( InstEnv, Instance )
79 import Rules ( RuleBase )
80 import CoreSyn ( CoreBind )
82 import Type ( TyThing(..) )
84 import Class ( Class, classSelIds, classTyCon )
85 import TyCon ( TyCon, tyConSelIds, tyConDataCons )
86 import DataCon ( dataConImplicitIds )
87 import Packages ( PackageIdH, PackageId, PackageConfig, HomeModules )
88 import DynFlags ( DynFlags(..), isOneShot )
89 import DriverPhases ( HscSource(..), isHsBoot, hscSourceString, Phase )
90 import BasicTypes ( Version, initialVersion, IPName,
91 Fixity, defaultFixity, DeprecTxt )
93 import IfaceSyn ( IfaceInst, IfaceRule, IfaceDecl(ifName) )
95 import FiniteMap ( FiniteMap )
96 import CoreSyn ( CoreRule )
97 import Maybes ( orElse, fromJust, expectJust )
99 import SrcLoc ( SrcSpan, Located )
100 import UniqSupply ( UniqSupply )
101 import FastString ( FastString )
103 import DATA_IOREF ( IORef, readIORef )
104 import StringBuffer ( StringBuffer )
105 import Time ( ClockTime )
109 %************************************************************************
111 \subsection{Compilation environment}
113 %************************************************************************
117 -- | The Session is a handle to the complete state of a compilation
118 -- session. A compilation session consists of a set of modules
119 -- constituting the current program or library, the context for
120 -- interactive evaluation, and various caches.
121 newtype Session = Session (IORef HscEnv)
124 HscEnv is like Session, except that some of the fields are immutable.
125 An HscEnv is used to compile a single module from plain Haskell source
126 code (after preprocessing) to either C, assembly or C--. Things like
127 the module graph don't change during a single compilation.
129 Historical note: "hsc" used to be the name of the compiler binary,
130 when there was a separate driver and compiler. To compile a single
131 module, the driver would invoke hsc on the source code... so nowadays
132 we think of hsc as the layer of the compiler that deals with compiling
138 hsc_dflags :: DynFlags,
139 -- The dynamic flag settings
141 hsc_targets :: [Target],
142 -- The targets (or roots) of the current session
144 hsc_mod_graph :: ModuleGraph,
145 -- The module graph of the current session
147 hsc_IC :: InteractiveContext,
148 -- The context for evaluating interactive statements
150 hsc_HPT :: HomePackageTable,
151 -- The home package table describes already-compiled
152 -- home-packge modules, *excluding* the module we
153 -- are compiling right now.
154 -- (In one-shot mode the current module is the only
155 -- home-package module, so hsc_HPT is empty. All other
156 -- modules count as "external-package" modules.
157 -- However, even in GHCi mode, hi-boot interfaces are
158 -- demand-loadeded into the external-package table.)
160 -- hsc_HPT is not mutable because we only demand-load
161 -- external packages; the home package is eagerly
162 -- loaded, module by module, by the compilation manager.
164 -- The HPT may contain modules compiled earlier by --make
165 -- but not actually below the current module in the dependency
166 -- graph. (This changes a previous invariant: changed Jan 05.)
168 hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
169 hsc_NC :: {-# UNPACK #-} !(IORef NameCache),
170 -- These are side-effected by compiling to reflect
171 -- sucking in interface files. They cache the state of
172 -- external interface files, in effect.
174 hsc_FC :: {-# UNPACK #-} !(IORef FinderCache)
175 -- The finder's cache. This caches the location of modules,
176 -- so we don't have to search the filesystem multiple times.
179 hscEPS :: HscEnv -> IO ExternalPackageState
180 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
182 -- | A compilation target.
184 -- A target may be supplied with the actual text of the
185 -- module. If so, use this instead of the file contents (this
186 -- is for use in an IDE where the file hasn't been saved by
188 data Target = Target TargetId (Maybe (StringBuffer,ClockTime))
191 = TargetModule Module
192 -- ^ A module name: search for the file
193 | TargetFile FilePath (Maybe Phase)
194 -- ^ A filename: preprocess & parse it to find the module name.
195 -- If specified, the Phase indicates how to compile this file
196 -- (which phase to start from). Nothing indicates the starting phase
197 -- should be determined from the suffix of the filename.
200 pprTarget :: Target -> SDoc
201 pprTarget (Target id _) = pprTargetId id
203 pprTargetId (TargetModule m) = ppr m
204 pprTargetId (TargetFile f _) = text f
206 type FinderCache = ModuleEnv FinderCacheEntry
207 type FinderCacheEntry = (ModLocation, Maybe (PackageConfig,Bool))
208 -- The finder's cache (see module Finder)
210 type HomePackageTable = ModuleEnv HomeModInfo
211 -- Domain = modules in the home package
212 type PackageIfaceTable = ModuleEnv ModIface
213 -- Domain = modules in the imported packages
215 emptyHomePackageTable = emptyModuleEnv
216 emptyPackageIfaceTable = emptyModuleEnv
219 = HomeModInfo { hm_iface :: !ModIface,
220 hm_details :: !ModDetails,
221 hm_linkable :: !(Maybe Linkable) }
222 -- hm_linkable might be Nothing if:
223 -- a) this is an .hs-boot module
224 -- b) temporarily during compilation if we pruned away
225 -- the old linkable because it was out of date.
226 -- after a complete compilation (GHC.load), all hm_linkable
227 -- fields in the HPT will be Just.
229 -- When re-linking a module (hscNoRecomp), we construct
230 -- the HomModInfo by building a new ModDetails from the
231 -- old ModIface (only).
234 Simple lookups in the symbol table.
237 lookupIface :: HomePackageTable -> PackageIfaceTable -> Module -> Maybe ModIface
238 -- We often have two IfaceTables, and want to do a lookup
239 lookupIface hpt pit mod
240 = case lookupModuleEnv hpt mod of
241 Just mod_info -> Just (hm_iface mod_info)
242 Nothing -> lookupModuleEnv pit mod
244 lookupIfaceByModule :: HomePackageTable -> PackageIfaceTable -> Module -> Maybe ModIface
245 -- We often have two IfaceTables, and want to do a lookup
246 lookupIfaceByModule hpt pit mod
247 = case lookupModuleEnv hpt mod of
248 Just mod_info -> Just (hm_iface mod_info)
249 Nothing -> lookupModuleEnv pit mod
254 hptInstances :: HscEnv -> (Module -> Bool) -> [Instance]
255 -- Find all the instance declarations that are in modules imported
256 -- by this one, directly or indirectly, and are in the Home Package Table
257 -- This ensures that we don't see instances from modules --make compiled
258 -- before this one, but which are not below this one
259 hptInstances hsc_env want_this_module
261 | mod_info <- moduleEnvElts (hsc_HPT hsc_env)
262 , want_this_module (mi_module (hm_iface mod_info))
263 , ispec <- md_insts (hm_details mod_info) ]
265 hptRules :: HscEnv -> [(Module, IsBootInterface)] -> [CoreRule]
266 -- Get rules from modules "below" this one (in the dependency sense)
267 -- C.f Inst.hptInstances
268 hptRules hsc_env deps
269 | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
272 hpt = hsc_HPT hsc_env
275 | -- Find each non-hi-boot module below me
278 -- Look it up in the HPT
279 , let mod_info = ASSERT( mod `elemModuleEnv` hpt )
280 fromJust (lookupModuleEnv hpt mod)
283 , rule <- md_rules (hm_details mod_info) ]
287 %************************************************************************
289 \subsection{Symbol tables and Module details}
291 %************************************************************************
293 A @ModIface@ plus a @ModDetails@ summarises everything we know
294 about a compiled module. The @ModIface@ is the stuff *before* linking,
295 and can be written out to an interface file. (The @ModDetails@ is after
296 linking; it is the "linked" form of the mi_decls field.)
298 When we *read* an interface file, we also construct a @ModIface@ from it,
299 except that the mi_decls part is empty; when reading we consolidate
300 the declarations into a single indexed map in the @PersistentRenamerState@.
305 mi_package :: !PackageIdH, -- Which package the module comes from
306 mi_module :: !Module,
307 mi_mod_vers :: !Version, -- Module version: changes when anything changes
309 mi_orphan :: !WhetherHasOrphans, -- Whether this module has orphans
310 mi_boot :: !IsBootInterface, -- Read from an hi-boot file?
312 mi_deps :: Dependencies,
313 -- This is consulted for directly-imported modules,
314 -- but not for anything else (hence lazy)
316 -- Usages; kept sorted so that it's easy to decide
317 -- whether to write a new iface file (changing usages
318 -- doesn't affect the version of this module)
319 mi_usages :: [Usage],
320 -- NOT STRICT! we read this field lazily from the interface file
321 -- It is *only* consulted by the recompilation checker
324 -- Kept sorted by (mod,occ), to make version comparisons easier
325 mi_exports :: ![IfaceExport],
326 mi_exp_vers :: !Version, -- Version number of export list
329 mi_fixities :: [(OccName,Fixity)],
330 -- NOT STRICT! we read this field lazily from the interface file
333 mi_deprecs :: IfaceDeprecs,
334 -- NOT STRICT! we read this field lazily from the interface file
336 -- Type, class and variable declarations
337 -- The version of an Id changes if its fixity or deprecations change
338 -- (as well as its type of course)
339 -- Ditto data constructors, class operations, except that
340 -- the version of the parent class/tycon changes
341 mi_decls :: [(Version,IfaceDecl)], -- Sorted
343 mi_globals :: !(Maybe GlobalRdrEnv),
344 -- Binds all the things defined at the top level in
345 -- the *original source* code for this module. which
346 -- is NOT the same as mi_exports, nor mi_decls (which
347 -- may contains declarations for things not actually
348 -- defined by the user). Used for GHCi and for inspecting
349 -- the contents of modules via the GHC API only.
351 -- (We need the source file to figure out the
352 -- top-level environment, if we didn't compile this module
353 -- from source then this field contains Nothing).
355 -- Strictly speaking this field should live in the
356 -- HomeModInfo, but that leads to more plumbing.
358 -- Instance declarations and rules
359 mi_insts :: [IfaceInst], -- Sorted
360 mi_rules :: [IfaceRule], -- Sorted
361 mi_rule_vers :: !Version, -- Version number for rules and instances combined
363 -- Cached environments for easy lookup
364 -- These are computed (lazily) from other fields
365 -- and are not put into the interface file
366 mi_dep_fn :: Name -> Maybe DeprecTxt, -- Cached lookup for mi_deprecs
367 mi_fix_fn :: OccName -> Fixity, -- Cached lookup for mi_fixities
368 mi_ver_fn :: OccName -> Maybe Version -- Cached lookup for mi_decls
369 -- The Nothing in mi_ver_fn means that the thing
370 -- isn't in decls. It's useful to know that when
371 -- seeing if we are up to date wrt the old interface
374 -- Should be able to construct ModDetails from mi_decls in ModIface
377 -- The next three fields are created by the typechecker
378 md_exports :: NameSet,
379 md_types :: !TypeEnv,
380 md_insts :: ![Instance], -- Dfun-ids for the instances in this module
381 md_rules :: ![CoreRule] -- Domain may include Ids from other modules
384 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
385 md_exports = emptyNameSet,
389 -- A ModGuts is carried through the compiler, accumulating stuff as it goes
390 -- There is only one ModGuts at any time, the one for the module
391 -- being compiled right now. Once it is compiled, a ModIface and
392 -- ModDetails are extracted and the ModGuts is dicarded.
396 mg_module :: !Module,
397 mg_boot :: IsBootInterface, -- Whether it's an hs-boot module
398 mg_exports :: !NameSet, -- What it exports
399 mg_deps :: !Dependencies, -- What is below it, directly or otherwise
400 mg_home_mods :: !HomeModules, -- For calling isHomeModule etc.
401 mg_dir_imps :: ![Module], -- Directly-imported modules; used to
402 -- generate initialisation code
403 mg_usages :: ![Usage], -- Version info for what it needed
405 mg_rdr_env :: !GlobalRdrEnv, -- Top-level lexical environment
406 mg_fix_env :: !FixityEnv, -- Fixity env, for things declared in this module
407 mg_deprecs :: !Deprecations, -- Deprecations declared in the module
409 mg_types :: !TypeEnv,
410 mg_insts :: ![Instance], -- Instances
411 mg_rules :: ![CoreRule], -- Rules from this module
412 mg_binds :: ![CoreBind], -- Bindings for this module
413 mg_foreign :: !ForeignStubs
416 -- The ModGuts takes on several slightly different forms:
418 -- After simplification, the following fields change slightly:
419 -- mg_rules Orphan rules only (local ones now attached to binds)
420 -- mg_binds With rules attached
423 ---------------------------------------------------------
424 -- The Tidy pass forks the information about this module:
425 -- * one lot goes to interface file generation (ModIface)
426 -- and later compilations (ModDetails)
427 -- * the other lot goes to code generation (CgGuts)
430 cg_module :: !Module,
432 cg_tycons :: [TyCon],
433 -- Algebraic data types (including ones that started
434 -- life as classes); generate constructors and info
435 -- tables Includes newtypes, just for the benefit of
438 cg_binds :: [CoreBind],
439 -- The tidied main bindings, including
440 -- previously-implicit bindings for record and class
441 -- selectors, and data construtor wrappers. But *not*
442 -- data constructor workers; reason: we we regard them
443 -- as part of the code-gen of tycons
445 cg_dir_imps :: ![Module],
446 -- Directly-imported modules; used to generate
447 -- initialisation code
449 cg_foreign :: !ForeignStubs,
450 cg_home_mods :: !HomeModules, -- for calling isHomeModule etc.
451 cg_dep_pkgs :: ![PackageId] -- Used to generate #includes for C code gen
454 -----------------------------------
457 imp_direct :: ![(Module,Bool)], -- Explicitly-imported modules
458 -- Boolean is true if we imported the whole
459 -- module (apart, perhaps, from hiding some)
460 imp_pkg_mods :: !ModuleSet, -- Non-home-package modules on which we depend,
461 -- directly or indirectly
462 imp_home_names :: !NameSet -- Home package things on which we depend,
463 -- directly or indirectly
466 -----------------------------------
467 data ForeignStubs = NoStubs
469 SDoc -- Header file prototypes for
470 -- "foreign exported" functions
471 SDoc -- C stubs to use when calling
472 -- "foreign exported" functions
473 [FastString] -- Headers that need to be included
474 -- into C code generated for this module
475 [Id] -- Foreign-exported binders
476 -- we have to generate code to register these
481 emptyModIface :: PackageIdH -> Module -> ModIface
482 emptyModIface pkg mod
483 = ModIface { mi_package = pkg,
485 mi_mod_vers = initialVersion,
488 mi_deps = noDependencies,
491 mi_exp_vers = initialVersion,
493 mi_deprecs = NoDeprecs,
497 mi_globals = Nothing,
498 mi_rule_vers = initialVersion,
499 mi_dep_fn = emptyIfaceDepCache,
500 mi_fix_fn = emptyIfaceFixCache,
501 mi_ver_fn = emptyIfaceVerCache
506 %************************************************************************
508 \subsection{The interactive context}
510 %************************************************************************
513 data InteractiveContext
514 = InteractiveContext {
515 ic_toplev_scope :: [Module], -- Include the "top-level" scope of
518 ic_exports :: [Module], -- Include just the exports of these
521 ic_rn_gbl_env :: GlobalRdrEnv, -- The cached GlobalRdrEnv, built from
522 -- ic_toplev_scope and ic_exports
524 ic_rn_local_env :: LocalRdrEnv, -- Lexical context for variables bound
525 -- during interaction
527 ic_type_env :: TypeEnv -- Ditto for types
530 emptyInteractiveContext
531 = InteractiveContext { ic_toplev_scope = [],
533 ic_rn_gbl_env = emptyGlobalRdrEnv,
534 ic_rn_local_env = emptyLocalRdrEnv,
535 ic_type_env = emptyTypeEnv }
537 icPrintUnqual :: InteractiveContext -> PrintUnqualified
538 icPrintUnqual ictxt = unQualInScope (ic_rn_gbl_env ictxt)
541 @unQualInScope@ returns a function that takes a @Name@ and tells whether
542 its unqualified name is in scope. This is put as a boolean flag in
543 the @Name@'s provenance to guide whether or not to print the name qualified
547 unQualInScope :: GlobalRdrEnv -> PrintUnqualified
548 -- True if 'f' is in scope, and has only one binding,
549 -- and the thing it is bound to is the name we are looking for
550 -- (i.e. false if A.f and B.f are both in scope as unqualified 'f')
552 -- [Out of date] Also checks for built-in syntax, which is always 'in scope'
553 unQualInScope env mod occ
554 = case lookupGRE_RdrName (mkRdrUnqual occ) env of
555 [gre] -> nameModule (gre_name gre) == mod
560 %************************************************************************
564 %************************************************************************
567 implicitTyThings :: TyThing -> [TyThing]
568 implicitTyThings (AnId id) = []
570 -- For type constructors, add the data cons (and their extras),
571 -- and the selectors and generic-programming Ids too
573 -- Newtypes don't have a worker Id, so don't generate that?
574 implicitTyThings (ATyCon tc) = map AnId (tyConSelIds tc) ++
575 concatMap (extras_plus . ADataCon) (tyConDataCons tc)
577 -- For classes, add the class TyCon too (and its extras)
578 -- and the class selector Ids
579 implicitTyThings (AClass cl) = map AnId (classSelIds cl) ++
580 extras_plus (ATyCon (classTyCon cl))
583 -- For data cons add the worker and wrapper (if any)
584 implicitTyThings (ADataCon dc) = map AnId (dataConImplicitIds dc)
586 extras_plus thing = thing : implicitTyThings thing
588 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
589 extendTypeEnvWithIds env ids
590 = extendNameEnvList env [(getName id, AnId id) | id <- ids]
593 %************************************************************************
597 %************************************************************************
600 type TypeEnv = NameEnv TyThing
602 emptyTypeEnv :: TypeEnv
603 typeEnvElts :: TypeEnv -> [TyThing]
604 typeEnvClasses :: TypeEnv -> [Class]
605 typeEnvTyCons :: TypeEnv -> [TyCon]
606 typeEnvIds :: TypeEnv -> [Id]
607 lookupTypeEnv :: TypeEnv -> Name -> Maybe TyThing
609 emptyTypeEnv = emptyNameEnv
610 typeEnvElts env = nameEnvElts env
611 typeEnvClasses env = [cl | AClass cl <- typeEnvElts env]
612 typeEnvTyCons env = [tc | ATyCon tc <- typeEnvElts env]
613 typeEnvIds env = [id | AnId id <- typeEnvElts env]
615 mkTypeEnv :: [TyThing] -> TypeEnv
616 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
618 lookupTypeEnv = lookupNameEnv
620 -- Extend the type environment
621 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
622 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
624 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
625 extendTypeEnvList env things = foldl extendTypeEnv env things
629 lookupType :: HomePackageTable -> PackageTypeEnv -> Name -> Maybe TyThing
630 lookupType hpt pte name
631 = case lookupModuleEnv hpt (nameModule name) of
632 Just details -> lookupNameEnv (md_types (hm_details details)) name
633 Nothing -> lookupNameEnv pte name
638 tyThingTyCon (ATyCon tc) = tc
639 tyThingTyCon other = pprPanic "tyThingTyCon" (ppr other)
641 tyThingClass (AClass cls) = cls
642 tyThingClass other = pprPanic "tyThingClass" (ppr other)
644 tyThingDataCon (ADataCon dc) = dc
645 tyThingDataCon other = pprPanic "tyThingDataCon" (ppr other)
647 tyThingId (AnId id) = id
648 tyThingId other = pprPanic "tyThingId" (ppr other)
651 %************************************************************************
653 \subsection{Auxiliary types}
655 %************************************************************************
657 These types are defined here because they are mentioned in ModDetails,
658 but they are mostly elaborated elsewhere
661 mkIfaceVerCache :: [(Version,IfaceDecl)] -> OccName -> Maybe Version
662 mkIfaceVerCache pairs
663 = \occ -> lookupOccEnv env occ
665 env = foldl add emptyOccEnv pairs
666 add env (v,d) = extendOccEnv env (ifName d) v
668 emptyIfaceVerCache :: OccName -> Maybe Version
669 emptyIfaceVerCache occ = Nothing
671 ------------------ Deprecations -------------------------
674 | DeprecAll DeprecTxt -- Whole module deprecated
675 | DeprecSome a -- Some specific things deprecated
678 type IfaceDeprecs = Deprecs [(OccName,DeprecTxt)]
679 type Deprecations = Deprecs (NameEnv (OccName,DeprecTxt))
680 -- Keep the OccName so we can flatten the NameEnv to
681 -- get an IfaceDeprecs from a Deprecations
682 -- Only an OccName is needed, because a deprecation always
683 -- applies to things defined in the module in which the
684 -- deprecation appears.
686 mkIfaceDepCache:: IfaceDeprecs -> Name -> Maybe DeprecTxt
687 mkIfaceDepCache NoDeprecs = \n -> Nothing
688 mkIfaceDepCache (DeprecAll t) = \n -> Just t
689 mkIfaceDepCache (DeprecSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
691 emptyIfaceDepCache :: Name -> Maybe DeprecTxt
692 emptyIfaceDepCache n = Nothing
694 lookupDeprec :: Deprecations -> Name -> Maybe DeprecTxt
695 lookupDeprec NoDeprecs name = Nothing
696 lookupDeprec (DeprecAll txt) name = Just txt
697 lookupDeprec (DeprecSome env) name = case lookupNameEnv env name of
698 Just (_, txt) -> Just txt
701 plusDeprecs :: Deprecations -> Deprecations -> Deprecations
702 plusDeprecs d NoDeprecs = d
703 plusDeprecs NoDeprecs d = d
704 plusDeprecs d (DeprecAll t) = DeprecAll t
705 plusDeprecs (DeprecAll t) d = DeprecAll t
706 plusDeprecs (DeprecSome v1) (DeprecSome v2) = DeprecSome (v1 `plusNameEnv` v2)
711 type Avails = [AvailInfo]
712 type AvailInfo = GenAvailInfo Name
713 type RdrAvailInfo = GenAvailInfo OccName
715 data GenAvailInfo name = Avail name -- An ordinary identifier
716 | AvailTC name -- The name of the type or class
717 [name] -- The available pieces of type/class.
718 -- NB: If the type or class is itself
719 -- to be in scope, it must be in this list.
720 -- Thus, typically: AvailTC Eq [Eq, ==, /=]
722 -- Equality used when deciding if the interface has changed
724 type IfaceExport = (Module, [GenAvailInfo OccName])
726 availsToNameSet :: [AvailInfo] -> NameSet
727 availsToNameSet avails = foldl add emptyNameSet avails
729 add set avail = addListToNameSet set (availNames avail)
731 availName :: GenAvailInfo name -> name
732 availName (Avail n) = n
733 availName (AvailTC n _) = n
735 availNames :: GenAvailInfo name -> [name]
736 availNames (Avail n) = [n]
737 availNames (AvailTC n ns) = ns
739 instance Outputable n => Outputable (GenAvailInfo n) where
742 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
743 pprAvail (AvailTC n ns) = ppr n <> case {- filter (/= n) -} ns of
745 ns' -> braces (hsep (punctuate comma (map ppr ns')))
747 pprAvail (Avail n) = ppr n
751 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
752 mkIfaceFixCache pairs
753 = \n -> lookupOccEnv env n `orElse` defaultFixity
757 emptyIfaceFixCache :: OccName -> Fixity
758 emptyIfaceFixCache n = defaultFixity
760 -- This fixity environment is for source code only
761 type FixityEnv = NameEnv FixItem
763 -- We keep the OccName in the range so that we can generate an interface from it
764 data FixItem = FixItem OccName Fixity SrcSpan
766 instance Outputable FixItem where
767 ppr (FixItem occ fix loc) = ppr fix <+> ppr occ <+> parens (ppr loc)
769 emptyFixityEnv :: FixityEnv
770 emptyFixityEnv = emptyNameEnv
772 lookupFixity :: FixityEnv -> Name -> Fixity
773 lookupFixity env n = case lookupNameEnv env n of
774 Just (FixItem _ fix _) -> fix
775 Nothing -> defaultFixity
779 %************************************************************************
781 \subsection{WhatsImported}
783 %************************************************************************
786 type WhetherHasOrphans = Bool
788 -- * an instance decl in a module other than the defn module for
789 -- one of the tycons or classes in the instance head
790 -- * a transformation rule in a module other than the one defining
791 -- the function in the head of the rule.
793 type IsBootInterface = Bool
795 -- Dependency info about modules and packages below this one
796 -- in the import hierarchy. See TcRnTypes.ImportAvails for details.
798 -- Invariant: the dependencies of a module M never includes M
799 -- Invariant: the lists are unordered, with no duplicates
801 = Deps { dep_mods :: [(Module,IsBootInterface)], -- Home-package module dependencies
802 dep_pkgs :: [PackageId], -- External package dependencies
803 dep_orphs :: [Module] } -- Orphan modules (whether home or external pkg)
805 -- Equality used only for old/new comparison in MkIface.addVersionInfo
807 noDependencies :: Dependencies
808 noDependencies = Deps [] [] []
811 = Usage { usg_name :: Module, -- Name of the module
812 usg_mod :: Version, -- Module version
813 usg_entities :: [(OccName,Version)], -- Sorted by occurrence name
814 usg_exports :: Maybe Version, -- Export-list version, if we depend on it
815 usg_rules :: Version -- Orphan-rules version (for non-orphan
816 -- modules this will always be initialVersion)
818 -- This type doesn't let you say "I imported f but none of the rules in
819 -- the module". If you use anything in the module you get its rule version
820 -- So if the rules change, you'll recompile, even if you don't use them.
821 -- This is easy to implement, and it's safer: you might not have used the rules last
822 -- time round, but if someone has added a new rule you might need it this time
824 -- The export list field is (Just v) if we depend on the export list:
825 -- i.e. we imported the module directly, whether or not we
826 -- enumerated the things we imported, or just imported everything
827 -- We need to recompile if M's exports change, because
828 -- if the import was import M, we might now have a name clash in the
830 -- if the import was import M(x) M might no longer export x
831 -- The only way we don't depend on the export list is if we have
833 -- And of course, for modules that aren't imported directly we don't
834 -- depend on their export lists
838 %************************************************************************
840 The External Package State
842 %************************************************************************
845 type PackageTypeEnv = TypeEnv
846 type PackageRuleBase = RuleBase
847 type PackageInstEnv = InstEnv
849 data ExternalPackageState
851 eps_is_boot :: !(ModuleEnv (Module, IsBootInterface)),
852 -- In OneShot mode (only), home-package modules accumulate in the
853 -- external package state, and are sucked in lazily.
854 -- For these home-pkg modules (only) we need to record which are
855 -- boot modules. We set this field after loading all the
856 -- explicitly-imported interfaces, but before doing anything else
858 -- The Module part is not necessary, but it's useful for
859 -- debug prints, and it's convenient because this field comes
860 -- direct from TcRnTypes.ImportAvails.imp_dep_mods
862 eps_PIT :: !PackageIfaceTable,
863 -- The ModuleIFaces for modules in external packages
864 -- whose interfaces we have opened
865 -- The declarations in these interface files are held in
866 -- eps_decls, eps_inst_env, eps_rules (below), not in the
867 -- mi_decls fields of the iPIT.
868 -- What _is_ in the iPIT is:
875 eps_PTE :: !PackageTypeEnv, -- Domain = external-package modules
877 eps_inst_env :: !PackageInstEnv, -- The total InstEnv accumulated from
878 -- all the external-package modules
879 eps_rule_base :: !PackageRuleBase, -- Ditto RuleEnv
881 eps_stats :: !EpsStats
884 -- "In" means read from iface files
885 -- "Out" means actually sucked in and type-checked
886 data EpsStats = EpsStats { n_ifaces_in
887 , n_decls_in, n_decls_out
888 , n_rules_in, n_rules_out
889 , n_insts_in, n_insts_out :: !Int }
891 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
892 -- Add stats for one newly-read interface
893 addEpsInStats stats n_decls n_insts n_rules
894 = stats { n_ifaces_in = n_ifaces_in stats + 1
895 , n_decls_in = n_decls_in stats + n_decls
896 , n_insts_in = n_insts_in stats + n_insts
897 , n_rules_in = n_rules_in stats + n_rules }
900 The NameCache makes sure that there is just one Unique assigned for
901 each original name; i.e. (module-name, occ-name) pair. The Name is
902 always stored as a Global, and has the SrcLoc of its binding location.
903 Actually that's not quite right. When we first encounter the original
904 name, we might not be at its binding site (e.g. we are reading an
905 interface file); so we give it 'noSrcLoc' then. Later, when we find
906 its binding site, we fix it up.
910 = NameCache { nsUniqs :: UniqSupply,
912 nsNames :: OrigNameCache,
913 -- Ensures that one original name gets one unique
914 nsIPs :: OrigIParamCache
915 -- Ensures that one implicit parameter name gets one unique
918 type OrigNameCache = ModuleEnv (OccEnv Name)
919 type OrigIParamCache = FiniteMap (IPName OccName) (IPName Name)
924 %************************************************************************
926 The module graph and ModSummary type
927 A ModSummary is a node in the compilation manager's
928 dependency graph, and it's also passed to hscMain
930 %************************************************************************
932 A ModuleGraph contains all the nodes from the home package (only).
933 There will be a node for each source module, plus a node for each hi-boot
937 type ModuleGraph = [ModSummary] -- The module graph,
938 -- NOT NECESSARILY IN TOPOLOGICAL ORDER
940 emptyMG :: ModuleGraph
943 -- The nodes of the module graph are
944 -- EITHER a regular Haskell source module
945 -- OR a hi-boot source module
949 ms_mod :: Module, -- Name of the module
950 ms_hsc_src :: HscSource, -- Source is Haskell, hs-boot, external core
951 ms_location :: ModLocation, -- Location
952 ms_hs_date :: ClockTime, -- Timestamp of source file
953 ms_obj_date :: Maybe ClockTime, -- Timestamp of object, maybe
954 ms_srcimps :: [Located Module], -- Source imports
955 ms_imps :: [Located Module], -- Non-source imports
956 ms_hspp_file :: Maybe FilePath, -- Filename of preprocessed source,
957 -- once we have preprocessed it.
958 ms_hspp_buf :: Maybe StringBuffer -- The actual preprocessed source, maybe.
961 -- The ModLocation contains both the original source filename and the
962 -- filename of the cleaned-up source file after all preprocessing has been
963 -- done. The point is that the summariser will have to cpp/unlit/whatever
964 -- all files anyway, and there's no point in doing this twice -- just
965 -- park the result in a temp file, put the name of it in the location,
966 -- and let @compile@ read from that file on the way back up.
968 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
969 -- the ms_hs_date and imports can, of course, change
971 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
972 msHsFilePath ms = expectJust "msHsFilePath" (ml_hs_file (ms_location ms))
973 msHiFilePath ms = ml_hi_file (ms_location ms)
974 msObjFilePath ms = ml_obj_file (ms_location ms)
976 isBootSummary :: ModSummary -> Bool
977 isBootSummary ms = isHsBoot (ms_hsc_src ms)
979 instance Outputable ModSummary where
981 = sep [text "ModSummary {",
982 nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
983 text "ms_mod =" <+> ppr (ms_mod ms)
984 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
985 text "ms_imps =" <+> ppr (ms_imps ms),
986 text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
990 showModMsg :: Bool -> ModSummary -> String
991 showModMsg use_object mod_summary
992 = showSDoc (hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
993 char '(', text (msHsFilePath mod_summary) <> comma,
994 if use_object then text (msObjFilePath mod_summary)
995 else text "interpreted",
998 mod = ms_mod mod_summary
999 mod_str = moduleUserString mod ++ hscSourceString (ms_hsc_src mod_summary)
1003 %************************************************************************
1005 \subsection{Linkable stuff}
1007 %************************************************************************
1009 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
1010 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
1013 data Linkable = LM {
1014 linkableTime :: ClockTime, -- Time at which this linkable was built
1015 -- (i.e. when the bytecodes were produced,
1016 -- or the mod date on the files)
1017 linkableModule :: Module, -- Should be Module, but see below
1018 linkableUnlinked :: [Unlinked]
1021 isObjectLinkable :: Linkable -> Bool
1022 isObjectLinkable l = not (null unlinked) && all isObject unlinked
1023 where unlinked = linkableUnlinked l
1024 -- A linkable with no Unlinked's is treated as a BCO. We can
1025 -- generate a linkable with no Unlinked's as a result of
1026 -- compiling a module in HscNothing mode, and this choice
1027 -- happens to work well with checkStability in module GHC.
1029 instance Outputable Linkable where
1030 ppr (LM when_made mod unlinkeds)
1031 = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
1032 $$ nest 3 (ppr unlinkeds)
1034 -------------------------------------------
1039 | BCOs CompiledByteCode
1042 data CompiledByteCode = NoByteCode
1045 instance Outputable Unlinked where
1046 ppr (DotO path) = text "DotO" <+> text path
1047 ppr (DotA path) = text "DotA" <+> text path
1048 ppr (DotDLL path) = text "DotDLL" <+> text path
1050 ppr (BCOs bcos) = text "BCOs" <+> ppr bcos
1052 ppr (BCOs bcos) = text "No byte code"
1055 isObject (DotO _) = True
1056 isObject (DotA _) = True
1057 isObject (DotDLL _) = True
1060 isInterpretable = not . isObject
1062 nameOfObject (DotO fn) = fn
1063 nameOfObject (DotA fn) = fn
1064 nameOfObject (DotDLL fn) = fn
1066 byteCodeOfObject (BCOs bc) = bc