Fix #481: use a safe recompilation check when Template Haskell is
[ghc.git] / compiler / main / HscTypes.lhs
1 %
2 % (c) The University of Glasgow, 2006
3 %
4 \section[HscTypes]{Types for the per-module compiler}
5
6 \begin{code}
7 -- | Types for the per-module compiler
8 module HscTypes ( 
9         -- * compilation state
10         HscEnv(..), hscEPS,
11         FinderCache, FindResult(..), ModLocationCache,
12         Target(..), TargetId(..), pprTarget, pprTargetId,
13         ModuleGraph, emptyMG,
14
15         -- * Information about modules
16         ModDetails(..), emptyModDetails,
17         ModGuts(..), CgGuts(..), ForeignStubs(..), appendStubC,
18         ImportedMods, ImportedModsVal,
19
20         ModSummary(..), ms_imps, ms_mod_name, showModMsg, isBootSummary,
21         msHsFilePath, msHiFilePath, msObjFilePath,
22         SourceModified(..),
23
24         -- * Information about the module being compiled
25         HscSource(..), isHsBoot, hscSourceString,       -- Re-exported from DriverPhases
26         
27         -- * State relating to modules in this package
28         HomePackageTable, HomeModInfo(..), emptyHomePackageTable,
29         hptInstances, hptRules, hptVectInfo,
30         hptObjs,
31
32         -- * State relating to known packages
33         ExternalPackageState(..), EpsStats(..), addEpsInStats,
34         PackageTypeEnv, PackageIfaceTable, emptyPackageIfaceTable,
35         lookupIfaceByModule, emptyModIface,
36         
37         PackageInstEnv, PackageRuleBase,
38
39
40         -- * Annotations
41         prepareAnnotations,
42
43         -- * Interactive context
44         InteractiveContext(..), emptyInteractiveContext, 
45         icPrintUnqual, extendInteractiveContext,
46         substInteractiveContext,
47         mkPrintUnqualified, pprModulePrefix,
48
49         -- * Interfaces
50         ModIface(..), mkIfaceWarnCache, mkIfaceHashCache, mkIfaceFixCache,
51         emptyIfaceWarnCache,
52
53         -- * Fixity
54         FixityEnv, FixItem(..), lookupFixity, emptyFixityEnv,
55
56         -- * TyThings and type environments
57         TyThing(..),
58         tyThingClass, tyThingTyCon, tyThingDataCon, tyThingId, tyThingCoAxiom,
59         implicitTyThings, implicitTyConThings, implicitClassThings, isImplicitTyThing,
60         
61         TypeEnv, lookupType, lookupTypeHscEnv, mkTypeEnv, emptyTypeEnv,
62         extendTypeEnv, extendTypeEnvList, extendTypeEnvWithIds, lookupTypeEnv,
63         typeEnvElts, typeEnvClasses, typeEnvTyCons, typeEnvIds,
64         typeEnvDataCons, typeEnvCoAxioms,
65
66         -- * MonadThings
67         MonadThings(..),
68
69         -- * Information on imports and exports
70         WhetherHasOrphans, IsBootInterface, Usage(..), 
71         Dependencies(..), noDependencies,
72         NameCache(..), OrigNameCache, OrigIParamCache,
73         Avails, availsToNameSet, availsToNameEnv, availName, availNames,
74         GenAvailInfo(..), AvailInfo, RdrAvailInfo, 
75         IfaceExport,
76
77         -- * Warnings
78         Warnings(..), WarningTxt(..), plusWarns,
79
80         -- * Linker stuff
81         Linkable(..), isObjectLinkable, linkableObjs,
82         Unlinked(..), CompiledByteCode,
83         isObject, nameOfObject, isInterpretable, byteCodeOfObject,
84         
85         -- * Program coverage
86         HpcInfo(..), emptyHpcInfo, isHpcUsed, AnyHpcUsage,
87
88         -- * Breakpoints
89         ModBreaks (..), BreakIndex, emptyModBreaks,
90
91         -- * Vectorisation information
92         VectInfo(..), IfaceVectInfo(..), noVectInfo, plusVectInfo, 
93         noIfaceVectInfo,
94
95         -- * Safe Haskell information
96         IfaceTrustInfo, getSafeMode, setSafeMode, noIfaceTrustInfo,
97         trustInfoToNum, numToTrustInfo, IsSafeImport,
98
99         -- * Compilation errors and warnings
100         SourceError, GhcApiError, mkSrcErr, srcErrorMessages, mkApiErr,
101         throwOneError, handleSourceError,
102         handleFlagWarnings, printOrThrowWarnings,
103     ) where
104
105 #include "HsVersions.h"
106
107 #ifdef GHCI
108 import ByteCodeAsm      ( CompiledByteCode )
109 import {-# SOURCE #-}  InteractiveEval ( Resume )
110 #endif
111
112 import HsSyn
113 import RdrName
114 import Name
115 import NameEnv
116 import NameSet  
117 import Module
118 import InstEnv          ( InstEnv, Instance )
119 import FamInstEnv       ( FamInstEnv, FamInst )
120 import Rules            ( RuleBase )
121 import CoreSyn          ( CoreBind )
122 import VarEnv
123 import VarSet
124 import Var
125 import Id
126 import Type             
127
128 import Annotations
129 import Class            ( Class, classAllSelIds, classATs, classTyCon )
130 import TyCon
131 import DataCon          ( DataCon, dataConImplicitIds, dataConWrapId )
132 import PrelNames        ( gHC_PRIM )
133 import Packages hiding ( Version(..) )
134 import DynFlags
135 import DriverPhases     ( HscSource(..), isHsBoot, hscSourceString, Phase )
136 import BasicTypes       ( IPName, defaultFixity, WarningTxt(..) )
137 import OptimizationFuel ( OptFuelState )
138 import IfaceSyn
139 import CoreSyn          ( CoreRule, CoreVect )
140 import Maybes           ( orElse, expectJust, catMaybes )
141 import Outputable
142 import BreakArray
143 import SrcLoc
144 import UniqFM           ( lookupUFM, eltsUFM, emptyUFM )
145 import UniqSupply       ( UniqSupply )
146 import FastString
147 import StringBuffer     ( StringBuffer )
148 import Fingerprint
149 import MonadUtils
150 import Bag
151 import ErrUtils
152
153 import System.FilePath
154 import System.Time      ( ClockTime )
155 import Data.IORef
156 import Data.Array       ( Array, array )
157 import Data.List
158 import Data.Map (Map)
159 import Data.Word
160 import Control.Monad    ( mplus, guard, liftM, when )
161 import Exception
162 import Data.Typeable    ( Typeable )
163
164 -- -----------------------------------------------------------------------------
165 -- Source Errors
166
167 -- When the compiler (HscMain) discovers errors, it throws an
168 -- exception in the IO monad.
169
170 mkSrcErr :: ErrorMessages -> SourceError
171 srcErrorMessages :: SourceError -> ErrorMessages
172 mkApiErr :: SDoc -> GhcApiError
173
174 throwOneError :: MonadIO m => ErrMsg -> m ab
175 throwOneError err = liftIO $ throwIO $ mkSrcErr $ unitBag err
176
177 -- | A source error is an error that is caused by one or more errors in the
178 -- source code.  A 'SourceError' is thrown by many functions in the
179 -- compilation pipeline.  Inside GHC these errors are merely printed via
180 -- 'log_action', but API clients may treat them differently, for example,
181 -- insert them into a list box.  If you want the default behaviour, use the
182 -- idiom:
183 --
184 -- > handleSourceError printExceptionAndWarnings $ do
185 -- >   ... api calls that may fail ...
186 --
187 -- The 'SourceError's error messages can be accessed via 'srcErrorMessages'.
188 -- This list may be empty if the compiler failed due to @-Werror@
189 -- ('Opt_WarnIsError').
190 --
191 -- See 'printExceptionAndWarnings' for more information on what to take care
192 -- of when writing a custom error handler.
193 newtype SourceError = SourceError ErrorMessages
194   deriving Typeable
195
196 instance Show SourceError where
197   show (SourceError msgs) = unlines . map show . bagToList $ msgs
198     -- ToDo: is there some nicer way to print this?
199
200 instance Exception SourceError
201
202 mkSrcErr = SourceError
203
204 -- | Perform the given action and call the exception handler if the action
205 -- throws a 'SourceError'.  See 'SourceError' for more information.
206 handleSourceError :: (ExceptionMonad m) =>
207                      (SourceError -> m a) -- ^ exception handler
208                   -> m a -- ^ action to perform
209                   -> m a
210 handleSourceError handler act =
211   gcatch act (\(e :: SourceError) -> handler e)
212
213 srcErrorMessages (SourceError msgs) = msgs
214
215 -- | XXX: what exactly is an API error?
216 newtype GhcApiError = GhcApiError SDoc
217  deriving Typeable
218
219 instance Show GhcApiError where
220   show (GhcApiError msg) = showSDoc msg
221
222 instance Exception GhcApiError
223
224 mkApiErr = GhcApiError
225
226 -- | Given a bag of warnings, turn them into an exception if
227 -- -Werror is enabled, or print them out otherwise.
228 printOrThrowWarnings :: DynFlags -> Bag WarnMsg -> IO ()
229 printOrThrowWarnings dflags warns
230   | dopt Opt_WarnIsError dflags
231   = when (not (isEmptyBag warns)) $ do
232       throwIO $ mkSrcErr $ warns `snocBag` warnIsErrorMsg
233   | otherwise
234   = printBagOfWarnings dflags warns
235
236 handleFlagWarnings :: DynFlags -> [Located String] -> IO ()
237 handleFlagWarnings dflags warns
238  = when (wopt Opt_WarnDeprecatedFlags dflags) $ do
239         -- It would be nicer if warns :: [Located Message], but that
240         -- has circular import problems.
241       let bag = listToBag [ mkPlainWarnMsg loc (text warn) 
242                           | L loc warn <- warns ]
243
244       printOrThrowWarnings dflags bag
245 \end{code}
246
247 \begin{code}
248 -- | Hscenv is like 'Session', except that some of the fields are immutable.
249 -- An HscEnv is used to compile a single module from plain Haskell source
250 -- code (after preprocessing) to either C, assembly or C--.  Things like
251 -- the module graph don't change during a single compilation.
252 --
253 -- Historical note: \"hsc\" used to be the name of the compiler binary,
254 -- when there was a separate driver and compiler.  To compile a single
255 -- module, the driver would invoke hsc on the source code... so nowadays
256 -- we think of hsc as the layer of the compiler that deals with compiling
257 -- a single module.
258 data HscEnv 
259   = HscEnv { 
260         hsc_dflags :: DynFlags,
261                 -- ^ The dynamic flag settings
262
263         hsc_targets :: [Target],
264                 -- ^ The targets (or roots) of the current session
265
266         hsc_mod_graph :: ModuleGraph,
267                 -- ^ The module graph of the current session
268
269         hsc_IC :: InteractiveContext,
270                 -- ^ The context for evaluating interactive statements
271
272         hsc_HPT    :: HomePackageTable,
273                 -- ^ The home package table describes already-compiled
274                 -- home-package modules, /excluding/ the module we 
275                 -- are compiling right now.
276                 -- (In one-shot mode the current module is the only
277                 --  home-package module, so hsc_HPT is empty.  All other
278                 --  modules count as \"external-package\" modules.
279                 --  However, even in GHCi mode, hi-boot interfaces are
280                 --  demand-loaded into the external-package table.)
281                 --
282                 -- 'hsc_HPT' is not mutable because we only demand-load 
283                 -- external packages; the home package is eagerly 
284                 -- loaded, module by module, by the compilation manager.
285                 --      
286                 -- The HPT may contain modules compiled earlier by @--make@
287                 -- but not actually below the current module in the dependency
288                 -- graph.
289
290                 -- (This changes a previous invariant: changed Jan 05.)
291         
292         hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
293                 -- ^ Information about the currently loaded external packages.
294                 -- This is mutable because packages will be demand-loaded during
295                 -- a compilation run as required.
296         
297         hsc_NC  :: {-# UNPACK #-} !(IORef NameCache),
298                 -- ^ As with 'hsc_EPS', this is side-effected by compiling to
299                 -- reflect sucking in interface files.  They cache the state of
300                 -- external interface files, in effect.
301
302         hsc_FC   :: {-# UNPACK #-} !(IORef FinderCache),
303                 -- ^ The cached result of performing finding in the file system
304         hsc_MLC  :: {-# UNPACK #-} !(IORef ModLocationCache),
305                 -- ^ This caches the location of modules, so we don't have to 
306                 -- search the filesystem multiple times. See also 'hsc_FC'.
307
308         hsc_OptFuel :: OptFuelState,
309                 -- ^ Settings to control the use of \"optimization fuel\":
310                 -- by limiting the number of transformations,
311                 -- we can use binary search to help find compiler bugs.
312
313         hsc_type_env_var :: Maybe (Module, IORef TypeEnv)
314                 -- ^ Used for one-shot compilation only, to initialise
315                 -- the 'IfGblEnv'. See 'TcRnTypes.tcg_type_env_var' for 
316                 -- 'TcRunTypes.TcGblEnv'
317  }
318
319 hscEPS :: HscEnv -> IO ExternalPackageState
320 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
321
322 -- | A compilation target.
323 --
324 -- A target may be supplied with the actual text of the
325 -- module.  If so, use this instead of the file contents (this
326 -- is for use in an IDE where the file hasn't been saved by
327 -- the user yet).
328 data Target = Target
329       { targetId           :: TargetId  -- ^ module or filename
330       , targetAllowObjCode :: Bool      -- ^ object code allowed?
331       , targetContents     :: Maybe (StringBuffer,ClockTime)
332                                         -- ^ in-memory text buffer?
333       }
334
335 data TargetId
336   = TargetModule ModuleName
337         -- ^ A module name: search for the file
338   | TargetFile FilePath (Maybe Phase)
339         -- ^ A filename: preprocess & parse it to find the module name.
340         -- If specified, the Phase indicates how to compile this file
341         -- (which phase to start from).  Nothing indicates the starting phase
342         -- should be determined from the suffix of the filename.
343   deriving Eq
344
345 pprTarget :: Target -> SDoc
346 pprTarget (Target id obj _) = 
347    (if obj then char '*' else empty) <> pprTargetId id
348
349 instance Outputable Target where
350     ppr = pprTarget
351
352 pprTargetId :: TargetId -> SDoc
353 pprTargetId (TargetModule m) = ppr m
354 pprTargetId (TargetFile f _) = text f
355
356 instance Outputable TargetId where
357     ppr = pprTargetId
358
359 -- | Helps us find information about modules in the home package
360 type HomePackageTable  = ModuleNameEnv HomeModInfo
361         -- Domain = modules in the home package that have been fully compiled
362         -- "home" package name cached here for convenience
363
364 -- | Helps us find information about modules in the imported packages
365 type PackageIfaceTable = ModuleEnv ModIface
366         -- Domain = modules in the imported packages
367
368 emptyHomePackageTable :: HomePackageTable
369 emptyHomePackageTable  = emptyUFM
370
371 emptyPackageIfaceTable :: PackageIfaceTable
372 emptyPackageIfaceTable = emptyModuleEnv
373
374 -- | Information about modules in the package being compiled
375 data HomeModInfo 
376   = HomeModInfo {
377       hm_iface    :: !ModIface,
378         -- ^ The basic loaded interface file: every loaded module has one of
379         -- these, even if it is imported from another package
380       hm_details  :: !ModDetails,
381         -- ^ Extra information that has been created from the 'ModIface' for
382         -- the module, typically during typechecking
383       hm_linkable :: !(Maybe Linkable)
384         -- ^ The actual artifact we would like to link to access things in
385         -- this module.
386         --
387         -- 'hm_linkable' might be Nothing:
388         --
389         --   1. If this is an .hs-boot module
390         --
391         --   2. Temporarily during compilation if we pruned away
392         --      the old linkable because it was out of date.
393         --
394         -- After a complete compilation ('GHC.load'), all 'hm_linkable' fields
395         -- in the 'HomePackageTable' will be @Just@.
396         --
397         -- When re-linking a module ('HscMain.HscNoRecomp'), we construct the
398         -- 'HomeModInfo' by building a new 'ModDetails' from the old
399         -- 'ModIface' (only).
400     }
401
402 -- | Find the 'ModIface' for a 'Module', searching in both the loaded home
403 -- and external package module information
404 lookupIfaceByModule
405         :: DynFlags
406         -> HomePackageTable
407         -> PackageIfaceTable
408         -> Module
409         -> Maybe ModIface
410 lookupIfaceByModule dflags hpt pit mod
411   | modulePackageId mod == thisPackage dflags
412   =     -- The module comes from the home package, so look first
413         -- in the HPT.  If it's not from the home package it's wrong to look
414         -- in the HPT, because the HPT is indexed by *ModuleName* not Module
415     fmap hm_iface (lookupUFM hpt (moduleName mod)) 
416     `mplus` lookupModuleEnv pit mod
417
418   | otherwise = lookupModuleEnv pit mod         -- Look in PIT only 
419
420 -- If the module does come from the home package, why do we look in the PIT as well?
421 -- (a) In OneShot mode, even home-package modules accumulate in the PIT
422 -- (b) Even in Batch (--make) mode, there is *one* case where a home-package
423 --     module is in the PIT, namely GHC.Prim when compiling the base package.
424 -- We could eliminate (b) if we wanted, by making GHC.Prim belong to a package
425 -- of its own, but it doesn't seem worth the bother.
426 \end{code}
427
428
429 \begin{code}
430 hptInstances :: HscEnv -> (ModuleName -> Bool) -> ([Instance], [FamInst])
431 -- ^ Find all the instance declarations (of classes and families) that are in
432 -- modules imported by this one, directly or indirectly, and are in the Home
433 -- Package Table.  This ensures that we don't see instances from modules @--make@
434 -- compiled before this one, but which are not below this one.
435 hptInstances hsc_env want_this_module
436   = let (insts, famInsts) = unzip $ flip hptAllThings hsc_env $ \mod_info -> do
437                 guard (want_this_module (moduleName (mi_module (hm_iface mod_info))))
438                 let details = hm_details mod_info
439                 return (md_insts details, md_fam_insts details)
440     in (concat insts, concat famInsts)
441
442 hptVectInfo :: HscEnv -> VectInfo
443 -- ^ Get the combined VectInfo of all modules in the home package table.  In
444 -- contrast to instances and rules, we don't care whether the modules are
445 -- \"below\" us in the dependency sense.  The VectInfo of those modules not \"below\" 
446 -- us does not affect the compilation of the current module.
447 hptVectInfo = concatVectInfo . hptAllThings ((: []) . md_vect_info . hm_details)
448
449 hptRules :: HscEnv -> [(ModuleName, IsBootInterface)] -> [CoreRule]
450 -- ^ Get rules from modules \"below\" this one (in the dependency sense)
451 hptRules = hptSomeThingsBelowUs (md_rules . hm_details) False
452
453
454 hptAnns :: HscEnv -> Maybe [(ModuleName, IsBootInterface)] -> [Annotation]
455 -- ^ Get annotations from modules \"below\" this one (in the dependency sense)
456 hptAnns hsc_env (Just deps) = hptSomeThingsBelowUs (md_anns . hm_details) False hsc_env deps
457 hptAnns hsc_env Nothing = hptAllThings (md_anns . hm_details) hsc_env
458
459 hptAllThings :: (HomeModInfo -> [a]) -> HscEnv -> [a]
460 hptAllThings extract hsc_env = concatMap extract (eltsUFM (hsc_HPT hsc_env))
461
462 hptSomeThingsBelowUs :: (HomeModInfo -> [a]) -> Bool -> HscEnv -> [(ModuleName, IsBootInterface)] -> [a]
463 -- Get things from modules \"below\" this one (in the dependency sense)
464 -- C.f Inst.hptInstances
465 hptSomeThingsBelowUs extract include_hi_boot hsc_env deps
466  | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
467   | otherwise
468   = let 
469         hpt = hsc_HPT hsc_env
470     in
471     [ thing
472     |   -- Find each non-hi-boot module below me
473       (mod, is_boot_mod) <- deps
474     , include_hi_boot || not is_boot_mod
475
476         -- unsavoury: when compiling the base package with --make, we
477         -- sometimes try to look up RULES etc for GHC.Prim.  GHC.Prim won't
478         -- be in the HPT, because we never compile it; it's in the EPT
479         -- instead.  ToDo: clean up, and remove this slightly bogus
480         -- filter:
481     , mod /= moduleName gHC_PRIM
482
483         -- Look it up in the HPT
484     , let things = case lookupUFM hpt mod of
485                     Just info -> extract info
486                     Nothing -> pprTrace "WARNING in hptSomeThingsBelowUs" msg [] 
487           msg = vcat [ptext (sLit "missing module") <+> ppr mod,
488                       ptext (sLit "Probable cause: out-of-date interface files")]
489                         -- This really shouldn't happen, but see Trac #962
490
491         -- And get its dfuns
492     , thing <- things ]
493
494 hptObjs :: HomePackageTable -> [FilePath]
495 hptObjs hpt = concat (map (maybe [] linkableObjs . hm_linkable) (eltsUFM hpt))
496 \end{code}
497
498 %************************************************************************
499 %*                                                                      *
500 \subsection{Dealing with Annotations}
501 %*                                                                      *
502 %************************************************************************
503
504 \begin{code}
505 prepareAnnotations :: HscEnv -> Maybe ModGuts -> IO AnnEnv
506 -- ^ Deal with gathering annotations in from all possible places 
507 --   and combining them into a single 'AnnEnv'
508 prepareAnnotations hsc_env mb_guts
509   = do { eps <- hscEPS hsc_env
510        ; let -- Extract annotations from the module being compiled if supplied one
511             mb_this_module_anns = fmap (mkAnnEnv . mg_anns) mb_guts
512         -- Extract dependencies of the module if we are supplied one,
513         -- otherwise load annotations from all home package table
514         -- entries regardless of dependency ordering.
515             home_pkg_anns  = (mkAnnEnv . hptAnns hsc_env) $ fmap (dep_mods . mg_deps) mb_guts
516             other_pkg_anns = eps_ann_env eps
517             ann_env        = foldl1' plusAnnEnv $ catMaybes [mb_this_module_anns, 
518                                                              Just home_pkg_anns, 
519                                                              Just other_pkg_anns]
520
521        ; return ann_env }
522 \end{code}
523
524 %************************************************************************
525 %*                                                                      *
526 \subsection{The Finder cache}
527 %*                                                                      *
528 %************************************************************************
529
530 \begin{code}
531 -- | The 'FinderCache' maps home module names to the result of
532 -- searching for that module.  It records the results of searching for
533 -- modules along the search path.  On @:load@, we flush the entire
534 -- contents of this cache.
535 --
536 -- Although the @FinderCache@ range is 'FindResult' for convenience ,
537 -- in fact it will only ever contain 'Found' or 'NotFound' entries.
538 --
539 type FinderCache = ModuleNameEnv FindResult
540
541 -- | The result of searching for an imported module.
542 data FindResult
543   = Found ModLocation Module
544         -- ^ The module was found
545   | NoPackage PackageId
546         -- ^ The requested package was not found
547   | FoundMultiple [PackageId]
548         -- ^ _Error_: both in multiple packages
549
550   | NotFound          -- Not found
551       { fr_paths       :: [FilePath]       -- Places where I looked
552
553       , fr_pkg         :: Maybe PackageId  -- Just p => module is in this package's
554                                            --           manifest, but couldn't find
555                                            --           the .hi file
556
557       , fr_mods_hidden :: [PackageId]      -- Module is in these packages,
558                                            --   but the *module* is hidden
559
560       , fr_pkgs_hidden :: [PackageId]      -- Module is in these packages,
561                                            --   but the *package* is hidden
562
563       , fr_suggestions :: [Module]         -- Possible mis-spelled modules
564       }
565
566 -- | Cache that remembers where we found a particular module.  Contains both
567 -- home modules and package modules.  On @:load@, only home modules are
568 -- purged from this cache.
569 type ModLocationCache = ModuleEnv ModLocation
570 \end{code}
571
572 %************************************************************************
573 %*                                                                      *
574 \subsection{Symbol tables and Module details}
575 %*                                                                      *
576 %************************************************************************
577
578 \begin{code}
579 -- | A 'ModIface' plus a 'ModDetails' summarises everything we know 
580 -- about a compiled module.  The 'ModIface' is the stuff *before* linking,
581 -- and can be written out to an interface file. The 'ModDetails is after 
582 -- linking and can be completely recovered from just the 'ModIface'.
583 -- 
584 -- When we read an interface file, we also construct a 'ModIface' from it,
585 -- except that we explicitly make the 'mi_decls' and a few other fields empty;
586 -- as when reading we consolidate the declarations etc. into a number of indexed
587 -- maps and environments in the 'ExternalPackageState'.
588 data ModIface 
589    = ModIface {
590         mi_module   :: !Module,             -- ^ Name of the module we are for
591         mi_iface_hash :: !Fingerprint,      -- ^ Hash of the whole interface
592         mi_mod_hash :: !Fingerprint,        -- ^ Hash of the ABI only
593
594         mi_orphan   :: !WhetherHasOrphans,  -- ^ Whether this module has orphans
595         mi_finsts   :: !WhetherHasFamInst,  -- ^ Whether this module has family instances
596         mi_boot     :: !IsBootInterface,    -- ^ Read from an hi-boot file?
597
598         mi_deps     :: Dependencies,
599                 -- ^ The dependencies of the module.  This is
600                 -- consulted for directly-imported modules, but not
601                 -- for anything else (hence lazy)
602
603         mi_usages   :: [Usage],
604                 -- ^ Usages; kept sorted so that it's easy to decide
605                 -- whether to write a new iface file (changing usages
606                 -- doesn't affect the hash of this module)
607         
608                 -- NOT STRICT!  we read this field lazily from the interface file
609                 -- It is *only* consulted by the recompilation checker
610
611                 -- Exports
612                 -- Kept sorted by (mod,occ), to make version comparisons easier
613         mi_exports  :: ![IfaceExport],
614                 -- ^ Records the modules that are the declaration points for things
615                 -- exported by this module, and the 'OccName's of those things
616         
617         mi_exp_hash :: !Fingerprint,    -- ^ Hash of export list
618
619         mi_used_th :: !Bool,  -- ^ Module required TH splices when it was compiled.  This disables recompilation avoidance (see #481).
620
621         mi_fixities :: [(OccName,Fixity)],
622                 -- ^ Fixities
623         
624                 -- NOT STRICT!  we read this field lazily from the interface file
625
626         mi_warns  :: Warnings,
627                 -- ^ Warnings
628                 
629                 -- NOT STRICT!  we read this field lazily from the interface file
630
631         mi_anns  :: [IfaceAnnotation],
632                 -- ^ Annotations
633         
634                 -- NOT STRICT!  we read this field lazily from the interface file
635
636                 -- Type, class and variable declarations
637                 -- The hash of an Id changes if its fixity or deprecations change
638                 --      (as well as its type of course)
639                 -- Ditto data constructors, class operations, except that 
640                 -- the hash of the parent class/tycon changes
641         mi_decls :: [(Fingerprint,IfaceDecl)],  -- ^ Sorted type, variable, class etc. declarations
642
643         mi_globals  :: !(Maybe GlobalRdrEnv),
644                 -- ^ Binds all the things defined at the top level in
645                 -- the /original source/ code for this module. which
646                 -- is NOT the same as mi_exports, nor mi_decls (which
647                 -- may contains declarations for things not actually
648                 -- defined by the user).  Used for GHCi and for inspecting
649                 -- the contents of modules via the GHC API only.
650                 --
651                 -- (We need the source file to figure out the
652                 -- top-level environment, if we didn't compile this module
653                 -- from source then this field contains @Nothing@).
654                 --
655                 -- Strictly speaking this field should live in the
656                 -- 'HomeModInfo', but that leads to more plumbing.
657
658                 -- Instance declarations and rules
659         mi_insts     :: [IfaceInst],                    -- ^ Sorted class instance
660         mi_fam_insts :: [IfaceFamInst],                 -- ^ Sorted family instances
661         mi_rules     :: [IfaceRule],                    -- ^ Sorted rules
662         mi_orphan_hash :: !Fingerprint, -- ^ Hash for orphan rules and 
663                                         -- class and family instances
664                                         -- combined
665
666         mi_vect_info :: !IfaceVectInfo, -- ^ Vectorisation information
667
668                 -- Cached environments for easy lookup
669                 -- These are computed (lazily) from other fields
670                 -- and are not put into the interface file
671         mi_warn_fn  :: Name -> Maybe WarningTxt,        -- ^ Cached lookup for 'mi_warns'
672         mi_fix_fn  :: OccName -> Fixity,                -- ^ Cached lookup for 'mi_fixities'
673         mi_hash_fn :: OccName -> Maybe (OccName, Fingerprint),
674                         -- ^ Cached lookup for 'mi_decls'.
675                         -- The @Nothing@ in 'mi_hash_fn' means that the thing
676                         -- isn't in decls. It's useful to know that when
677                         -- seeing if we are up to date wrt. the old interface.
678                         -- The 'OccName' is the parent of the name, if it has one.
679         mi_hpc    :: !AnyHpcUsage,
680                 -- ^ True if this program uses Hpc at any point in the program.
681         mi_trust  :: !IfaceTrustInfo,
682                 -- ^ Safe Haskell Trust information for this module.
683         mi_trust_pkg :: !Bool
684                 -- ^ Do we require the package this module resides in be trusted
685                 -- to trust this module? This is used for the situation where a
686                 -- module is Safe (so doesn't require the package be trusted
687                 -- itself) but imports some trustworthy modules from its own
688                 -- package (which does require its own package be trusted).
689                 -- See Note [RnNames . Trust Own Package]
690      }
691
692 -- | The 'ModDetails' is essentially a cache for information in the 'ModIface'
693 -- for home modules only. Information relating to packages will be loaded into
694 -- global environments in 'ExternalPackageState'.
695 data ModDetails
696    = ModDetails {
697         -- The next two fields are created by the typechecker
698         md_exports   :: [AvailInfo],
699         md_types     :: !TypeEnv,       -- ^ Local type environment for this particular module
700         md_insts     :: ![Instance],    -- ^ 'DFunId's for the instances in this module
701         md_fam_insts :: ![FamInst],
702         md_rules     :: ![CoreRule],    -- ^ Domain may include 'Id's from other modules
703         md_anns      :: ![Annotation],  -- ^ Annotations present in this module: currently 
704                                         -- they only annotate things also declared in this module
705         md_vect_info :: !VectInfo       -- ^ Module vectorisation information
706      }
707
708 emptyModDetails :: ModDetails
709 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
710                                md_exports = [],
711                                md_insts     = [],
712                                md_rules     = [],
713                                md_fam_insts = [],
714                                md_anns      = [],
715                                md_vect_info = noVectInfo
716                              } 
717
718 -- | Records the modules directly imported by a module for extracting e.g. usage information
719 type ImportedMods = ModuleEnv [ImportedModsVal]
720 type ImportedModsVal = (ModuleName, Bool, SrcSpan, IsSafeImport)
721
722 -- TODO: we are not actually using the codomain of this type at all, so it can be
723 -- replaced with ModuleEnv ()
724
725 -- | A ModGuts is carried through the compiler, accumulating stuff as it goes
726 -- There is only one ModGuts at any time, the one for the module
727 -- being compiled right now.  Once it is compiled, a 'ModIface' and 
728 -- 'ModDetails' are extracted and the ModGuts is discarded.
729 data ModGuts
730   = ModGuts {
731         mg_module    :: !Module,         -- ^ Module being compiled
732         mg_boot      :: IsBootInterface, -- ^ Whether it's an hs-boot module
733         mg_exports   :: ![AvailInfo],    -- ^ What it exports
734         mg_deps      :: !Dependencies,   -- ^ What it depends on, directly or
735                                          -- otherwise
736         mg_dir_imps  :: !ImportedMods,   -- ^ Directly-imported modules; used to
737                                          -- generate initialisation code
738         mg_used_names:: !NameSet,        -- ^ What the module needed (used in 'MkIface.mkIface')
739
740         mg_used_th   :: !Bool,           -- ^ Did we run a TH splice?
741         mg_rdr_env   :: !GlobalRdrEnv,   -- ^ Top-level lexical environment
742
743         -- These fields all describe the things **declared in this module**
744         mg_fix_env   :: !FixityEnv,      -- ^ Fixities declared in this module
745                                          -- TODO: I'm unconvinced this is actually used anywhere
746         mg_types     :: !TypeEnv,        -- ^ Types declared in this module
747         mg_insts     :: ![Instance],     -- ^ Class instances declared in this module
748         mg_fam_insts :: ![FamInst],      -- ^ Family instances declared in this module
749         mg_rules     :: ![CoreRule],     -- ^ Before the core pipeline starts, contains 
750                                          -- See Note [Overall plumbing for rules] in Rules.lhs
751         mg_binds     :: ![CoreBind],     -- ^ Bindings for this module
752         mg_foreign   :: !ForeignStubs,   -- ^ Foreign exports declared in this module
753         mg_warns     :: !Warnings,       -- ^ Warnings declared in the module
754         mg_anns      :: [Annotation],    -- ^ Annotations declared in this module
755         mg_hpc_info  :: !HpcInfo,        -- ^ Coverage tick boxes in the module
756         mg_modBreaks :: !ModBreaks,      -- ^ Breakpoints for the module
757         mg_vect_decls:: ![CoreVect],     -- ^ Vectorisation declarations in this module
758                                          --   (produced by desugarer & consumed by vectoriser)
759         mg_vect_info :: !VectInfo,       -- ^ Pool of vectorised declarations in the module
760
761         -- The next two fields are unusual, because they give instance
762         -- environments for *all* modules in the home package, including
763         -- this module, rather than for *just* this module.  
764         -- Reason: when looking up an instance we don't want to have to
765         --        look at each module in the home package in turn
766         mg_inst_env     :: InstEnv,
767         -- ^ Class instance environment from /home-package/ modules (including
768         -- this one); c.f. 'tcg_inst_env'
769         mg_fam_inst_env :: FamInstEnv,
770         -- ^ Type-family instance enviroment for /home-package/ modules
771         -- (including this one); c.f. 'tcg_fam_inst_env'
772         mg_trust_pkg :: Bool
773         -- ^ Do we need to trust our own package for Safe Haskell?
774         -- See Note [RnNames . Trust Own Package]
775     }
776
777 -- The ModGuts takes on several slightly different forms:
778 --
779 -- After simplification, the following fields change slightly:
780 --      mg_rules        Orphan rules only (local ones now attached to binds)
781 --      mg_binds        With rules attached
782
783 -- The ModGuts takes on several slightly different forms:
784 --
785 -- After simplification, the following fields change slightly:
786 --      mg_rules        Orphan rules only (local ones now attached to binds)
787 --      mg_binds        With rules attached
788
789
790 ---------------------------------------------------------
791 -- The Tidy pass forks the information about this module: 
792 --      * one lot goes to interface file generation (ModIface)
793 --        and later compilations (ModDetails)
794 --      * the other lot goes to code generation (CgGuts)
795
796 -- | A restricted form of 'ModGuts' for code generation purposes
797 data CgGuts 
798   = CgGuts {
799         cg_module   :: !Module, -- ^ Module being compiled
800
801         cg_tycons   :: [TyCon],
802                 -- ^ Algebraic data types (including ones that started
803                 -- life as classes); generate constructors and info
804                 -- tables. Includes newtypes, just for the benefit of
805                 -- External Core
806
807         cg_binds    :: [CoreBind],
808                 -- ^ The tidied main bindings, including
809                 -- previously-implicit bindings for record and class
810                 -- selectors, and data construtor wrappers.  But *not*
811                 -- data constructor workers; reason: we we regard them
812                 -- as part of the code-gen of tycons
813
814         cg_foreign  :: !ForeignStubs,   -- ^ Foreign export stubs
815         cg_dep_pkgs :: ![PackageId],    -- ^ Dependent packages, used to 
816                                         -- generate #includes for C code gen
817         cg_hpc_info :: !HpcInfo,        -- ^ Program coverage tick box information
818         cg_modBreaks :: !ModBreaks      -- ^ Module breakpoints
819     }
820
821 -----------------------------------
822 -- | Foreign export stubs
823 data ForeignStubs = NoStubs             -- ^ We don't have any stubs
824                   | ForeignStubs
825                         SDoc            
826                         SDoc            
827                    -- ^ There are some stubs. Parameters:
828                    --
829                    --  1) Header file prototypes for
830                    --     "foreign exported" functions
831                    --
832                    --  2) C stubs to use when calling
833                    --     "foreign exported" functions
834
835 appendStubC :: ForeignStubs -> SDoc -> ForeignStubs
836 appendStubC NoStubs            c_code = ForeignStubs empty c_code
837 appendStubC (ForeignStubs h c) c_code = ForeignStubs h (c $$ c_code)
838 \end{code}
839
840 \begin{code}
841 emptyModIface :: Module -> ModIface
842 emptyModIface mod
843   = ModIface { mi_module   = mod,
844                mi_iface_hash = fingerprint0,
845                mi_mod_hash = fingerprint0,
846                mi_orphan   = False,
847                mi_finsts   = False,
848                mi_boot     = False,
849                mi_deps     = noDependencies,
850                mi_usages   = [],
851                mi_exports  = [],
852                mi_exp_hash = fingerprint0,
853                mi_used_th  = False,
854                mi_fixities = [],
855                mi_warns    = NoWarnings,
856                mi_anns     = [],
857                mi_insts     = [],
858                mi_fam_insts = [],
859                mi_rules     = [],
860                mi_decls     = [],
861                mi_globals   = Nothing,
862                mi_orphan_hash = fingerprint0,
863                mi_vect_info = noIfaceVectInfo,
864                mi_warn_fn    = emptyIfaceWarnCache,
865                mi_fix_fn    = emptyIfaceFixCache,
866                mi_hash_fn   = emptyIfaceHashCache,
867                mi_hpc       = False,
868                mi_trust     = noIfaceTrustInfo,
869                mi_trust_pkg = False
870     }           
871 \end{code}
872
873
874 %************************************************************************
875 %*                                                                      *
876 \subsection{The interactive context}
877 %*                                                                      *
878 %************************************************************************
879
880 \begin{code}
881 -- | Interactive context, recording information about the state of the
882 -- context in which statements are executed in a GHC session.
883 --
884 data InteractiveContext 
885   = InteractiveContext { 
886          -- These two fields are only stored here so that the client
887          -- can retrieve them with GHC.getContext.  GHC itself doesn't
888          -- use them, but it does reset them to empty sometimes (such
889          -- as before a GHC.load).  The context is set with GHC.setContext.
890          ic_toplev_scope :: [Module],
891              -- ^ The context includes the "top-level" scope of
892              -- these modules
893          ic_imports :: [ImportDecl RdrName],
894              -- ^ The context is extended with these import declarations
895
896          ic_rn_gbl_env :: GlobalRdrEnv,
897              -- ^ The contexts' cached 'GlobalRdrEnv', built by
898              -- 'InteractiveEval.setContext'
899
900          ic_tmp_ids :: [Id],
901              -- ^ Names bound during interaction with the user.  Later
902              -- Ids shadow earlier ones with the same OccName
903              -- Expressions are typed with these Ids in the envt For
904              -- runtime-debugging, these Ids may have free TcTyVars of
905              -- RuntimUnkSkol flavour, but no free TyVars (because the
906              -- typechecker doesn't expect that)
907
908 #ifdef GHCI
909          ic_resume :: [Resume],
910              -- ^ The stack of breakpoint contexts
911 #endif
912
913          ic_cwd :: Maybe FilePath
914              -- virtual CWD of the program
915     }
916
917
918 emptyInteractiveContext :: InteractiveContext
919 emptyInteractiveContext
920   = InteractiveContext { ic_toplev_scope = [],
921                          ic_imports = [],
922                          ic_rn_gbl_env = emptyGlobalRdrEnv,
923                          ic_tmp_ids = []
924 #ifdef GHCI
925                          , ic_resume = []
926 #endif
927                          , ic_cwd = Nothing
928                        }
929
930 icPrintUnqual :: DynFlags -> InteractiveContext -> PrintUnqualified
931 icPrintUnqual dflags ictxt = mkPrintUnqualified dflags (ic_rn_gbl_env ictxt)
932
933
934 extendInteractiveContext
935         :: InteractiveContext
936         -> [Id]
937         -> InteractiveContext
938 extendInteractiveContext ictxt ids
939   = ictxt { ic_tmp_ids =  snub ((ic_tmp_ids ictxt \\ ids) ++ ids)
940                           -- NB. must be this way around, because we want
941                           -- new ids to shadow existing bindings.
942           }
943     where snub = map head . group . sort
944
945 substInteractiveContext :: InteractiveContext -> TvSubst -> InteractiveContext
946 substInteractiveContext ictxt subst | isEmptyTvSubst subst = ictxt
947 substInteractiveContext ictxt@InteractiveContext{ic_tmp_ids=ids} subst 
948   = ictxt { ic_tmp_ids = map subst_ty ids }
949   where
950    subst_ty id = id `setIdType` substTy subst (idType id)
951 \end{code}
952
953 %************************************************************************
954 %*                                                                      *
955         Building a PrintUnqualified             
956 %*                                                                      *
957 %************************************************************************
958
959 Note [Printing original names]
960 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
961 Deciding how to print names is pretty tricky.  We are given a name
962 P:M.T, where P is the package name, M is the defining module, and T is
963 the occurrence name, and we have to decide in which form to display
964 the name given a GlobalRdrEnv describing the current scope.
965
966 Ideally we want to display the name in the form in which it is in
967 scope.  However, the name might not be in scope at all, and that's
968 where it gets tricky.  Here are the cases:
969
970  1. T uniquely maps to  P:M.T      --->  "T"      NameUnqual
971  2. There is an X for which X.T 
972        uniquely maps to  P:M.T     --->  "X.T"    NameQual X
973  3. There is no binding for "M.T"  --->  "M.T"    NameNotInScope1
974  4. Otherwise                      --->  "P:M.T"  NameNotInScope2
975
976 (3) and (4) apply when the entity P:M.T is not in the GlobalRdrEnv at
977 all. In these cases we still want to refer to the name as "M.T", *but*
978 "M.T" might mean something else in the current scope (e.g. if there's
979 an "import X as M"), so to avoid confusion we avoid using "M.T" if
980 there's already a binding for it.  Instead we write P:M.T.
981
982 There's one further subtlety: in case (3), what if there are two
983 things around, P1:M.T and P2:M.T?  Then we don't want to print both of
984 them as M.T!  However only one of the modules P1:M and P2:M can be
985 exposed (say P2), so we use M.T for that, and P1:M.T for the other one.
986 This is handled by the qual_mod component of PrintUnqualified, inside
987 the (ppr mod) of case (3), in Name.pprModulePrefix
988
989 \begin{code}
990 -- | Creates some functions that work out the best ways to format
991 -- names for the user according to a set of heuristics
992 mkPrintUnqualified :: DynFlags -> GlobalRdrEnv -> PrintUnqualified
993 mkPrintUnqualified dflags env = (qual_name, qual_mod)
994   where
995   qual_name mod occ     -- The (mod,occ) pair is the original name of the thing
996         | [gre] <- unqual_gres, right_name gre = NameUnqual
997                 -- If there's a unique entity that's in scope unqualified with 'occ'
998                 -- AND that entity is the right one, then we can use the unqualified name
999
1000         | [gre] <- qual_gres = NameQual (get_qual_mod (gre_prov gre))
1001
1002         | null qual_gres = 
1003               if null (lookupGRE_RdrName (mkRdrQual (moduleName mod) occ) env)
1004                    then NameNotInScope1
1005                    else NameNotInScope2
1006
1007         | otherwise = panic "mkPrintUnqualified"
1008       where
1009         right_name gre = nameModule_maybe (gre_name gre) == Just mod
1010
1011         unqual_gres = lookupGRE_RdrName (mkRdrUnqual occ) env
1012         qual_gres   = filter right_name (lookupGlobalRdrEnv env occ)
1013
1014         get_qual_mod LocalDef      = moduleName mod
1015         get_qual_mod (Imported is) = ASSERT( not (null is) ) is_as (is_decl (head is))
1016
1017     -- we can mention a module P:M without the P: qualifier iff
1018     -- "import M" would resolve unambiguously to P:M.  (if P is the
1019     -- current package we can just assume it is unqualified).
1020
1021   qual_mod mod
1022      | modulePackageId mod == thisPackage dflags = False
1023
1024      | [pkgconfig] <- [pkg | (pkg,exposed_module) <- lookup, 
1025                              exposed pkg && exposed_module],
1026        packageConfigId pkgconfig == modulePackageId mod
1027         -- this says: we are given a module P:M, is there just one exposed package
1028         -- that exposes a module M, and is it package P?
1029      = False
1030
1031      | otherwise = True
1032      where lookup = lookupModuleInAllPackages dflags (moduleName mod)
1033 \end{code}
1034
1035
1036 %************************************************************************
1037 %*                                                                      *
1038                 TyThing
1039 %*                                                                      *
1040 %************************************************************************
1041
1042 \begin{code}
1043 -- | Determine the 'TyThing's brought into scope by another 'TyThing'
1044 -- /other/ than itself. For example, Id's don't have any implicit TyThings
1045 -- as they just bring themselves into scope, but classes bring their
1046 -- dictionary datatype, type constructor and some selector functions into
1047 -- scope, just for a start!
1048
1049 -- N.B. the set of TyThings returned here *must* match the set of
1050 -- names returned by LoadIface.ifaceDeclSubBndrs, in the sense that
1051 -- TyThing.getOccName should define a bijection between the two lists.
1052 -- This invariant is used in LoadIface.loadDecl (see note [Tricky iface loop])
1053 -- The order of the list does not matter.
1054 implicitTyThings :: TyThing -> [TyThing]
1055 implicitTyThings (AnId _)       = []
1056 implicitTyThings (ACoAxiom _cc) = []
1057 implicitTyThings (ATyCon tc)    = implicitTyConThings tc
1058 implicitTyThings (AClass cl)    = implicitClassThings cl
1059 implicitTyThings (ADataCon dc)  = map AnId (dataConImplicitIds dc)
1060     -- For data cons add the worker and (possibly) wrapper
1061     
1062 implicitClassThings :: Class -> [TyThing]
1063 implicitClassThings cl 
1064   = -- Does not include default methods, because those Ids may have
1065     --    their own pragmas, unfoldings etc, not derived from the Class object
1066     -- Dictionary datatype:
1067     --    [extras_plus:]
1068     --      type constructor 
1069     --    [recursive call:]
1070     --      (possibly) newtype coercion; definitely no family coercion here
1071     --      data constructor
1072     --      worker
1073     --      (no wrapper by invariant)
1074     extras_plus (ATyCon (classTyCon cl)) ++
1075     -- associated types 
1076     --    No extras_plus (recursive call) for the classATs, because they
1077     --    are only the family decls; they have no implicit things
1078     map ATyCon (classATs cl) ++
1079     -- superclass and operation selectors
1080     map AnId (classAllSelIds cl)
1081
1082 implicitTyConThings :: TyCon -> [TyThing]
1083 implicitTyConThings tc 
1084   =   -- fields (names of selectors)
1085       -- (possibly) implicit coercion and family coercion
1086       --   depending on whether it's a newtype or a family instance or both
1087     implicitCoTyCon tc ++
1088       -- for each data constructor in order,
1089       --   the contructor, worker, and (possibly) wrapper
1090     concatMap (extras_plus . ADataCon) (tyConDataCons tc)
1091
1092
1093 -- add a thing and recursive call
1094 extras_plus :: TyThing -> [TyThing]
1095 extras_plus thing = thing : implicitTyThings thing
1096
1097 -- For newtypes and indexed data types (and both),
1098 -- add the implicit coercion tycon
1099 implicitCoTyCon :: TyCon -> [TyThing]
1100 implicitCoTyCon tc 
1101   = map ACoAxiom . catMaybes $ [-- Just if newtype, Nothing if not
1102                               newTyConCo_maybe tc,
1103                               -- Just if family instance, Nothing if not
1104                               tyConFamilyCoercion_maybe tc] 
1105
1106 -- sortByOcc = sortBy (\ x -> \ y -> getOccName x < getOccName y)
1107
1108
1109 -- | Returns @True@ if there should be no interface-file declaration
1110 -- for this thing on its own: either it is built-in, or it is part
1111 -- of some other declaration, or it is generated implicitly by some
1112 -- other declaration.
1113 isImplicitTyThing :: TyThing -> Bool
1114 isImplicitTyThing (ADataCon {}) = True
1115 isImplicitTyThing (AnId id)     = isImplicitId id
1116 isImplicitTyThing (AClass {})   = False
1117 isImplicitTyThing (ATyCon tc)   = isImplicitTyCon tc
1118 isImplicitTyThing (ACoAxiom {}) = True
1119
1120 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
1121 extendTypeEnvWithIds env ids
1122   = extendNameEnvList env [(getName id, AnId id) | id <- ids]
1123 \end{code}
1124
1125 %************************************************************************
1126 %*                                                                      *
1127                 TypeEnv
1128 %*                                                                      *
1129 %************************************************************************
1130
1131 \begin{code}
1132 -- | A map from 'Name's to 'TyThing's, constructed by typechecking
1133 -- local declarations or interface files
1134 type TypeEnv = NameEnv TyThing
1135
1136 emptyTypeEnv    :: TypeEnv
1137 typeEnvElts     :: TypeEnv -> [TyThing]
1138 typeEnvClasses  :: TypeEnv -> [Class]
1139 typeEnvTyCons   :: TypeEnv -> [TyCon]
1140 typeEnvCoAxioms :: TypeEnv -> [CoAxiom]
1141 typeEnvIds      :: TypeEnv -> [Id]
1142 typeEnvDataCons :: TypeEnv -> [DataCon]
1143 lookupTypeEnv   :: TypeEnv -> Name -> Maybe TyThing
1144
1145 emptyTypeEnv        = emptyNameEnv
1146 typeEnvElts     env = nameEnvElts env
1147 typeEnvClasses  env = [cl | AClass cl   <- typeEnvElts env]
1148 typeEnvTyCons   env = [tc | ATyCon tc   <- typeEnvElts env] 
1149 typeEnvCoAxioms env = [ax | ACoAxiom ax <- typeEnvElts env] 
1150 typeEnvIds      env = [id | AnId id     <- typeEnvElts env] 
1151 typeEnvDataCons env = [dc | ADataCon dc <- typeEnvElts env] 
1152
1153 mkTypeEnv :: [TyThing] -> TypeEnv
1154 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
1155                 
1156 lookupTypeEnv = lookupNameEnv
1157
1158 -- Extend the type environment
1159 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
1160 extendTypeEnv env thing = extendNameEnv env (getName thing) thing 
1161
1162 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
1163 extendTypeEnvList env things = foldl extendTypeEnv env things
1164 \end{code}
1165
1166 \begin{code}
1167 -- | Find the 'TyThing' for the given 'Name' by using all the resources
1168 -- at our disposal: the compiled modules in the 'HomePackageTable' and the
1169 -- compiled modules in other packages that live in 'PackageTypeEnv'. Note
1170 -- that this does NOT look up the 'TyThing' in the module being compiled: you
1171 -- have to do that yourself, if desired
1172 lookupType :: DynFlags
1173            -> HomePackageTable
1174            -> PackageTypeEnv
1175            -> Name
1176            -> Maybe TyThing
1177
1178 lookupType dflags hpt pte name
1179   -- in one-shot, we don't use the HPT
1180   | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg 
1181   = do hm <- lookupUFM hpt (moduleName mod) -- Maybe monad
1182        lookupNameEnv (md_types (hm_details hm)) name
1183   | otherwise
1184   = lookupNameEnv pte name
1185   where mod = ASSERT( isExternalName name ) nameModule name
1186         this_pkg = thisPackage dflags
1187
1188 -- | As 'lookupType', but with a marginally easier-to-use interface
1189 -- if you have a 'HscEnv'
1190 lookupTypeHscEnv :: HscEnv -> Name -> IO (Maybe TyThing)
1191 lookupTypeHscEnv hsc_env name = do
1192     eps <- readIORef (hsc_EPS hsc_env)
1193     return $! lookupType dflags hpt (eps_PTE eps) name
1194   where 
1195     dflags = hsc_dflags hsc_env
1196     hpt = hsc_HPT hsc_env
1197 \end{code}
1198
1199 \begin{code}
1200 -- | Get the 'TyCon' from a 'TyThing' if it is a type constructor thing. Panics otherwise
1201 tyThingTyCon :: TyThing -> TyCon
1202 tyThingTyCon (ATyCon tc) = tc
1203 tyThingTyCon other       = pprPanic "tyThingTyCon" (pprTyThing other)
1204
1205 -- | Get the 'CoAxiom' from a 'TyThing' if it is a coercion axiom thing. Panics otherwise
1206 tyThingCoAxiom :: TyThing -> CoAxiom
1207 tyThingCoAxiom (ACoAxiom ax) = ax
1208 tyThingCoAxiom other         = pprPanic "tyThingCoAxiom" (pprTyThing other)
1209
1210 -- | Get the 'Class' from a 'TyThing' if it is a class thing. Panics otherwise
1211 tyThingClass :: TyThing -> Class
1212 tyThingClass (AClass cls) = cls
1213 tyThingClass other        = pprPanic "tyThingClass" (pprTyThing other)
1214
1215 -- | Get the 'DataCon' from a 'TyThing' if it is a data constructor thing. Panics otherwise
1216 tyThingDataCon :: TyThing -> DataCon
1217 tyThingDataCon (ADataCon dc) = dc
1218 tyThingDataCon other         = pprPanic "tyThingDataCon" (pprTyThing other)
1219
1220 -- | Get the 'Id' from a 'TyThing' if it is a id *or* data constructor thing. Panics otherwise
1221 tyThingId :: TyThing -> Id
1222 tyThingId (AnId id)     = id
1223 tyThingId (ADataCon dc) = dataConWrapId dc
1224 tyThingId other         = pprPanic "tyThingId" (pprTyThing other)
1225 \end{code}
1226
1227 %************************************************************************
1228 %*                                                                      *
1229 \subsection{MonadThings and friends}
1230 %*                                                                      *
1231 %************************************************************************
1232
1233 \begin{code}
1234 -- | Class that abstracts out the common ability of the monads in GHC
1235 -- to lookup a 'TyThing' in the monadic environment by 'Name'. Provides
1236 -- a number of related convenience functions for accessing particular
1237 -- kinds of 'TyThing'
1238 class Monad m => MonadThings m where
1239         lookupThing :: Name -> m TyThing
1240
1241         lookupId :: Name -> m Id
1242         lookupId = liftM tyThingId . lookupThing
1243
1244         lookupDataCon :: Name -> m DataCon
1245         lookupDataCon = liftM tyThingDataCon . lookupThing
1246
1247         lookupTyCon :: Name -> m TyCon
1248         lookupTyCon = liftM tyThingTyCon . lookupThing
1249
1250         lookupClass :: Name -> m Class
1251         lookupClass = liftM tyThingClass . lookupThing
1252 \end{code}
1253
1254 \begin{code}
1255 -- | Constructs cache for the 'mi_hash_fn' field of a 'ModIface'
1256 mkIfaceHashCache :: [(Fingerprint,IfaceDecl)]
1257                  -> (OccName -> Maybe (OccName, Fingerprint))
1258 mkIfaceHashCache pairs 
1259   = \occ -> lookupOccEnv env occ
1260   where
1261     env = foldr add_decl emptyOccEnv pairs
1262     add_decl (v,d) env0 = foldr add_imp env1 (ifaceDeclSubBndrs d)
1263       where
1264           decl_name = ifName d
1265           env1 = extendOccEnv env0 decl_name (decl_name, v)
1266           add_imp bndr env = extendOccEnv env bndr (decl_name, v)
1267
1268 emptyIfaceHashCache :: OccName -> Maybe (OccName, Fingerprint)
1269 emptyIfaceHashCache _occ = Nothing
1270 \end{code}
1271
1272 %************************************************************************
1273 %*                                                                      *
1274 \subsection{Auxiliary types}
1275 %*                                                                      *
1276 %************************************************************************
1277
1278 These types are defined here because they are mentioned in ModDetails,
1279 but they are mostly elaborated elsewhere
1280
1281 \begin{code}
1282 ------------------ Warnings -------------------------
1283 -- | Warning information for a module
1284 data Warnings
1285   = NoWarnings                          -- ^ Nothing deprecated
1286   | WarnAll WarningTxt                  -- ^ Whole module deprecated
1287   | WarnSome [(OccName,WarningTxt)]     -- ^ Some specific things deprecated
1288
1289      -- Only an OccName is needed because
1290      --    (1) a deprecation always applies to a binding
1291      --        defined in the module in which the deprecation appears.
1292      --    (2) deprecations are only reported outside the defining module.
1293      --        this is important because, otherwise, if we saw something like
1294      --
1295      --        {-# DEPRECATED f "" #-}
1296      --        f = ...
1297      --        h = f
1298      --        g = let f = undefined in f
1299      --
1300      --        we'd need more information than an OccName to know to say something
1301      --        about the use of f in h but not the use of the locally bound f in g
1302      --
1303      --        however, because we only report about deprecations from the outside,
1304      --        and a module can only export one value called f,
1305      --        an OccName suffices.
1306      --
1307      --        this is in contrast with fixity declarations, where we need to map
1308      --        a Name to its fixity declaration.
1309   deriving( Eq )
1310
1311 -- | Constructs the cache for the 'mi_warn_fn' field of a 'ModIface'
1312 mkIfaceWarnCache :: Warnings -> Name -> Maybe WarningTxt
1313 mkIfaceWarnCache NoWarnings  = \_ -> Nothing
1314 mkIfaceWarnCache (WarnAll t) = \_ -> Just t
1315 mkIfaceWarnCache (WarnSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
1316
1317 emptyIfaceWarnCache :: Name -> Maybe WarningTxt
1318 emptyIfaceWarnCache _ = Nothing
1319
1320 plusWarns :: Warnings -> Warnings -> Warnings
1321 plusWarns d NoWarnings = d
1322 plusWarns NoWarnings d = d
1323 plusWarns _ (WarnAll t) = WarnAll t
1324 plusWarns (WarnAll t) _ = WarnAll t
1325 plusWarns (WarnSome v1) (WarnSome v2) = WarnSome (v1 ++ v2)
1326 \end{code}
1327 \begin{code}
1328 -- | A collection of 'AvailInfo' - several things that are \"available\"
1329 type Avails       = [AvailInfo]
1330 -- | 'Name'd things that are available
1331 type AvailInfo    = GenAvailInfo Name
1332 -- | 'RdrName'd things that are available
1333 type RdrAvailInfo = GenAvailInfo OccName
1334
1335 -- | Records what things are "available", i.e. in scope
1336 data GenAvailInfo name  = Avail name     -- ^ An ordinary identifier in scope
1337                         | AvailTC name
1338                                   [name] -- ^ A type or class in scope. Parameters:
1339                                          --
1340                                          --  1) The name of the type or class
1341                                          --
1342                                          --  2) The available pieces of type or class.
1343                                          --     NB: If the type or class is itself
1344                                          --     to be in scope, it must be in this list.
1345                                          --     Thus, typically: @AvailTC Eq [Eq, ==, \/=]@
1346                         deriving( Eq )
1347                         -- Equality used when deciding if the interface has changed
1348
1349 -- | The original names declared of a certain module that are exported
1350 type IfaceExport = (Module, [GenAvailInfo OccName])
1351
1352 availsToNameSet :: [AvailInfo] -> NameSet
1353 availsToNameSet avails = foldr add emptyNameSet avails
1354       where add avail set = addListToNameSet set (availNames avail)
1355
1356 availsToNameEnv :: [AvailInfo] -> NameEnv AvailInfo
1357 availsToNameEnv avails = foldr add emptyNameEnv avails
1358      where add avail env = extendNameEnvList env
1359                                 (zip (availNames avail) (repeat avail))
1360
1361 -- | Just the main name made available, i.e. not the available pieces
1362 -- of type or class brought into scope by the 'GenAvailInfo'
1363 availName :: GenAvailInfo name -> name
1364 availName (Avail n)     = n
1365 availName (AvailTC n _) = n
1366
1367 -- | All names made available by the availability information
1368 availNames :: GenAvailInfo name -> [name]
1369 availNames (Avail n)      = [n]
1370 availNames (AvailTC _ ns) = ns
1371
1372 instance Outputable n => Outputable (GenAvailInfo n) where
1373    ppr = pprAvail
1374
1375 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
1376 pprAvail (Avail n)      = ppr n
1377 pprAvail (AvailTC n ns) = ppr n <> braces (hsep (punctuate comma (map ppr ns)))
1378 \end{code}
1379
1380 \begin{code}
1381 -- | Creates cached lookup for the 'mi_fix_fn' field of 'ModIface'
1382 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
1383 mkIfaceFixCache pairs 
1384   = \n -> lookupOccEnv env n `orElse` defaultFixity
1385   where
1386    env = mkOccEnv pairs
1387
1388 emptyIfaceFixCache :: OccName -> Fixity
1389 emptyIfaceFixCache _ = defaultFixity
1390
1391 -- | Fixity environment mapping names to their fixities
1392 type FixityEnv = NameEnv FixItem
1393
1394 -- | Fixity information for an 'Name'. We keep the OccName in the range 
1395 -- so that we can generate an interface from it
1396 data FixItem = FixItem OccName Fixity
1397
1398 instance Outputable FixItem where
1399   ppr (FixItem occ fix) = ppr fix <+> ppr occ
1400
1401 emptyFixityEnv :: FixityEnv
1402 emptyFixityEnv = emptyNameEnv
1403
1404 lookupFixity :: FixityEnv -> Name -> Fixity
1405 lookupFixity env n = case lookupNameEnv env n of
1406                         Just (FixItem _ fix) -> fix
1407                         Nothing         -> defaultFixity
1408 \end{code}
1409
1410
1411 %************************************************************************
1412 %*                                                                      *
1413 \subsection{WhatsImported}
1414 %*                                                                      *
1415 %************************************************************************
1416
1417 \begin{code}
1418 -- | Records whether a module has orphans. An \"orphan\" is one of:
1419 --
1420 -- * An instance declaration in a module other than the definition
1421 --   module for one of the type constructors or classes in the instance head
1422 --
1423 -- * A transformation rule in a module other than the one defining
1424 --   the function in the head of the rule
1425 type WhetherHasOrphans   = Bool
1426
1427 -- | Does this module define family instances?
1428 type WhetherHasFamInst = Bool
1429
1430 -- | Did this module originate from a *-boot file?
1431 type IsBootInterface = Bool
1432
1433 -- | Dependency information about modules and packages below this one
1434 -- in the import hierarchy.
1435 --
1436 -- Invariant: the dependencies of a module @M@ never includes @M@.
1437 --
1438 -- Invariant: none of the lists contain duplicates.
1439 data Dependencies
1440   = Deps { dep_mods   :: [(ModuleName, IsBootInterface)]
1441                         -- ^ Home-package module dependencies
1442          , dep_pkgs   :: [(PackageId, Bool)]
1443                        -- ^ External package dependencies. The bool indicates
1444                         -- if the package is required to be trusted when the
1445                         -- module is imported as a safe import (Safe Haskell).
1446                         -- See Note [RnNames . Tracking Trust Transitively]
1447          , dep_orphs  :: [Module]
1448                         -- ^ Orphan modules (whether home or external pkg),
1449                         -- *not* including family instance orphans as they
1450                         -- are anyway included in 'dep_finsts'
1451          , dep_finsts :: [Module]
1452                         -- ^ Modules that contain family instances (whether the
1453                         -- instances are from the home or an external package)
1454          }
1455   deriving( Eq )
1456         -- Equality used only for old/new comparison in MkIface.addVersionInfo
1457         -- See 'TcRnTypes.ImportAvails' for details on dependencies.
1458
1459 noDependencies :: Dependencies
1460 noDependencies = Deps [] [] [] []
1461
1462 -- | Records modules that we depend on by making a direct import from
1463 data Usage
1464   = UsagePackageModule {
1465         usg_mod      :: Module,
1466            -- ^ External package module depended on
1467         usg_mod_hash :: Fingerprint,
1468             -- ^ Cached module fingerprint
1469         usg_safe :: IsSafeImport
1470             -- ^ Was this module imported as a safe import
1471     }                                           -- ^ Module from another package
1472   | UsageHomeModule {
1473         usg_mod_name :: ModuleName,
1474             -- ^ Name of the module
1475         usg_mod_hash :: Fingerprint,
1476             -- ^ Cached module fingerprint
1477         usg_entities :: [(OccName,Fingerprint)],
1478             -- ^ Entities we depend on, sorted by occurrence name and fingerprinted.
1479             -- NB: usages are for parent names only, e.g. type constructors 
1480             -- but not the associated data constructors.
1481         usg_exports  :: Maybe Fingerprint,
1482             -- ^ Fingerprint for the export list we used to depend on this module,
1483             -- if we depend on the export list
1484         usg_safe :: IsSafeImport
1485             -- ^ Was this module imported as a safe import
1486     }                                           -- ^ Module from the current package
1487     deriving( Eq )
1488         -- The export list field is (Just v) if we depend on the export list:
1489         --      i.e. we imported the module directly, whether or not we
1490         --           enumerated the things we imported, or just imported 
1491         --           everything
1492         -- We need to recompile if M's exports change, because 
1493         -- if the import was    import M,       we might now have a name clash
1494         --                                      in the importing module.
1495         -- if the import was    import M(x)     M might no longer export x
1496         -- The only way we don't depend on the export list is if we have
1497         --                      import M()
1498         -- And of course, for modules that aren't imported directly we don't
1499         -- depend on their export lists
1500 \end{code}
1501
1502
1503 %************************************************************************
1504 %*                                                                      *
1505                 The External Package State
1506 %*                                                                      *
1507 %************************************************************************
1508
1509 \begin{code}
1510 type PackageTypeEnv    = TypeEnv
1511 type PackageRuleBase   = RuleBase
1512 type PackageInstEnv    = InstEnv
1513 type PackageFamInstEnv = FamInstEnv
1514 type PackageVectInfo   = VectInfo
1515 type PackageAnnEnv     = AnnEnv
1516
1517 -- | Information about other packages that we have slurped in by reading
1518 -- their interface files
1519 data ExternalPackageState
1520   = EPS {
1521         eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
1522                 -- ^ In OneShot mode (only), home-package modules
1523                 -- accumulate in the external package state, and are
1524                 -- sucked in lazily.  For these home-pkg modules
1525                 -- (only) we need to record which are boot modules.
1526                 -- We set this field after loading all the
1527                 -- explicitly-imported interfaces, but before doing
1528                 -- anything else
1529                 --
1530                 -- The 'ModuleName' part is not necessary, but it's useful for
1531                 -- debug prints, and it's convenient because this field comes
1532                 -- direct from 'TcRnTypes.imp_dep_mods'
1533
1534         eps_PIT :: !PackageIfaceTable,
1535                 -- ^ The 'ModIface's for modules in external packages
1536                 -- whose interfaces we have opened.
1537                 -- The declarations in these interface files are held in the
1538                 -- 'eps_decls', 'eps_inst_env', 'eps_fam_inst_env' and 'eps_rules'
1539                 -- fields of this record, not in the 'mi_decls' fields of the 
1540                 -- interface we have sucked in.
1541                 --
1542                 -- What /is/ in the PIT is:
1543                 --
1544                 -- * The Module
1545                 --
1546                 -- * Fingerprint info
1547                 --
1548                 -- * Its exports
1549                 --
1550                 -- * Fixities
1551                 --
1552                 -- * Deprecations and warnings
1553
1554         eps_PTE :: !PackageTypeEnv,        
1555                 -- ^ Result of typechecking all the external package
1556                 -- interface files we have sucked in. The domain of
1557                 -- the mapping is external-package modules
1558                 
1559         eps_inst_env     :: !PackageInstEnv,   -- ^ The total 'InstEnv' accumulated
1560                                                -- from all the external-package modules
1561         eps_fam_inst_env :: !PackageFamInstEnv,-- ^ The total 'FamInstEnv' accumulated
1562                                                -- from all the external-package modules
1563         eps_rule_base    :: !PackageRuleBase,  -- ^ The total 'RuleEnv' accumulated
1564                                                -- from all the external-package modules
1565         eps_vect_info    :: !PackageVectInfo,  -- ^ The total 'VectInfo' accumulated
1566                                                -- from all the external-package modules
1567         eps_ann_env      :: !PackageAnnEnv,    -- ^ The total 'AnnEnv' accumulated
1568                                                -- from all the external-package modules
1569
1570         eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv), -- ^ The family instances accumulated from external
1571                                                          -- packages, keyed off the module that declared them
1572
1573         eps_stats :: !EpsStats                 -- ^ Stastics about what was loaded from external packages
1574   }
1575
1576 -- | Accumulated statistics about what we are putting into the 'ExternalPackageState'.
1577 -- \"In\" means stuff that is just /read/ from interface files,
1578 -- \"Out\" means actually sucked in and type-checked
1579 data EpsStats = EpsStats { n_ifaces_in
1580                          , n_decls_in, n_decls_out 
1581                          , n_rules_in, n_rules_out
1582                          , n_insts_in, n_insts_out :: !Int }
1583
1584 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
1585 -- ^ Add stats for one newly-read interface
1586 addEpsInStats stats n_decls n_insts n_rules
1587   = stats { n_ifaces_in = n_ifaces_in stats + 1
1588           , n_decls_in  = n_decls_in stats + n_decls
1589           , n_insts_in  = n_insts_in stats + n_insts
1590           , n_rules_in  = n_rules_in stats + n_rules }
1591 \end{code}
1592
1593 Names in a NameCache are always stored as a Global, and have the SrcLoc 
1594 of their binding locations.
1595
1596 Actually that's not quite right.  When we first encounter the original
1597 name, we might not be at its binding site (e.g. we are reading an
1598 interface file); so we give it 'noSrcLoc' then.  Later, when we find
1599 its binding site, we fix it up.
1600
1601 \begin{code}
1602 -- | The NameCache makes sure that there is just one Unique assigned for
1603 -- each original name; i.e. (module-name, occ-name) pair and provides
1604 -- something of a lookup mechanism for those names.
1605 data NameCache
1606  = NameCache {  nsUniqs :: UniqSupply,
1607                 -- ^ Supply of uniques
1608                 nsNames :: OrigNameCache,
1609                 -- ^ Ensures that one original name gets one unique
1610                 nsIPs   :: OrigIParamCache
1611                 -- ^ Ensures that one implicit parameter name gets one unique
1612    }
1613
1614 -- | Per-module cache of original 'OccName's given 'Name's
1615 type OrigNameCache   = ModuleEnv (OccEnv Name)
1616
1617 -- | Module-local cache of implicit parameter 'OccName's given 'Name's
1618 type OrigIParamCache = Map (IPName OccName) (IPName Name)
1619 \end{code}
1620
1621
1622
1623 %************************************************************************
1624 %*                                                                      *
1625                 The module graph and ModSummary type
1626         A ModSummary is a node in the compilation manager's
1627         dependency graph, and it's also passed to hscMain
1628 %*                                                                      *
1629 %************************************************************************
1630
1631 \begin{code}
1632 -- | A ModuleGraph contains all the nodes from the home package (only).
1633 -- There will be a node for each source module, plus a node for each hi-boot
1634 -- module.
1635 --
1636 -- The graph is not necessarily stored in topologically-sorted order.  Use
1637 -- 'GHC.topSortModuleGraph' and 'Digraph.flattenSCC' to achieve this.
1638 type ModuleGraph = [ModSummary]
1639
1640 emptyMG :: ModuleGraph
1641 emptyMG = []
1642
1643 -- | A single node in a 'ModuleGraph. The nodes of the module graph are one of:
1644 --
1645 -- * A regular Haskell source module
1646 --
1647 -- * A hi-boot source module
1648 --
1649 -- * An external-core source module
1650 data ModSummary
1651    = ModSummary {
1652         ms_mod          :: Module,              -- ^ Identity of the module
1653         ms_hsc_src      :: HscSource,           -- ^ The module source either plain Haskell, hs-boot or external core
1654         ms_location     :: ModLocation,         -- ^ Location of the various files belonging to the module
1655         ms_hs_date      :: ClockTime,           -- ^ Timestamp of source file
1656         ms_obj_date     :: Maybe ClockTime,     -- ^ Timestamp of object, if we have one
1657         ms_srcimps      :: [Located (ImportDecl RdrName)],      -- ^ Source imports of the module
1658         ms_textual_imps :: [Located (ImportDecl RdrName)],      -- ^ Non-source imports of the module from the module *text*
1659         ms_hspp_file    :: FilePath,            -- ^ Filename of preprocessed source file
1660         ms_hspp_opts    :: DynFlags,            -- ^ Cached flags from @OPTIONS@, @INCLUDE@
1661                                                 -- and @LANGUAGE@ pragmas in the modules source code
1662         ms_hspp_buf     :: Maybe StringBuffer   -- ^ The actual preprocessed source, if we have it
1663      }
1664
1665 ms_mod_name :: ModSummary -> ModuleName
1666 ms_mod_name = moduleName . ms_mod
1667
1668 ms_imps :: ModSummary -> [Located (ImportDecl RdrName)]
1669 ms_imps ms = ms_textual_imps ms ++ map mk_additional_import (dynFlagDependencies (ms_hspp_opts ms))
1670   where
1671     -- This is a not-entirely-satisfactory means of creating an import that corresponds to an
1672     -- import that did not occur in the program text, such as those induced by the use of
1673     -- plugins (the -plgFoo flag)
1674     mk_additional_import mod_nm = noLoc $ ImportDecl {
1675       ideclName = noLoc mod_nm,
1676       ideclPkgQual = Nothing,
1677       ideclSource = False,
1678       ideclQualified = False,
1679       ideclAs = Nothing,
1680       ideclHiding = Nothing,
1681       ideclSafe = False
1682     }
1683
1684 -- The ModLocation contains both the original source filename and the
1685 -- filename of the cleaned-up source file after all preprocessing has been
1686 -- done.  The point is that the summariser will have to cpp/unlit/whatever
1687 -- all files anyway, and there's no point in doing this twice -- just 
1688 -- park the result in a temp file, put the name of it in the location,
1689 -- and let @compile@ read from that file on the way back up.
1690
1691 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
1692 -- the ms_hs_date and imports can, of course, change
1693
1694 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
1695 msHsFilePath  ms = expectJust "msHsFilePath" (ml_hs_file  (ms_location ms))
1696 msHiFilePath  ms = ml_hi_file  (ms_location ms)
1697 msObjFilePath ms = ml_obj_file (ms_location ms)
1698
1699 -- | Did this 'ModSummary' originate from a hs-boot file?
1700 isBootSummary :: ModSummary -> Bool
1701 isBootSummary ms = isHsBoot (ms_hsc_src ms)
1702
1703 instance Outputable ModSummary where
1704    ppr ms
1705       = sep [text "ModSummary {",
1706              nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
1707                           text "ms_mod =" <+> ppr (ms_mod ms) 
1708                                 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
1709                           text "ms_textual_imps =" <+> ppr (ms_textual_imps ms),
1710                           text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
1711              char '}'
1712             ]
1713
1714 showModMsg :: HscTarget -> Bool -> ModSummary -> String
1715 showModMsg target recomp mod_summary
1716   = showSDoc $
1717         hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
1718               char '(', text (normalise $ msHsFilePath mod_summary) <> comma,
1719               case target of
1720                   HscInterpreted | recomp 
1721                              -> text "interpreted"
1722                   HscNothing -> text "nothing"
1723                   _          -> text (normalise $ msObjFilePath mod_summary),
1724               char ')']
1725  where 
1726     mod     = moduleName (ms_mod mod_summary)
1727     mod_str = showSDoc (ppr mod) ++ hscSourceString (ms_hsc_src mod_summary)
1728 \end{code}
1729
1730 %************************************************************************
1731 %*                                                                      *
1732 \subsection{Recmpilation}
1733 %*                                                                      *
1734 %************************************************************************
1735
1736 \begin{code}
1737 -- | Indicates whether a given module's source has been modified since it
1738 -- was last compiled.
1739 data SourceModified
1740   = SourceModified
1741        -- ^ the source has been modified
1742   | SourceUnmodified
1743        -- ^ the source has not been modified.  Compilation may or may
1744        -- not be necessary, depending on whether any dependencies have
1745        -- changed since we last compiled.
1746   | SourceUnmodifiedAndStable
1747        -- ^ the source has not been modified, and furthermore all of
1748        -- its (transitive) dependencies are up to date; it definitely
1749        -- does not need to be recompiled.  This is important for two
1750        -- reasons: (a) we can omit the version check in checkOldIface,
1751        -- and (b) if the module used TH splices we don't need to force
1752        -- recompilation.
1753 \end{code}
1754
1755 %************************************************************************
1756 %*                                                                      *
1757 \subsection{Hpc Support}
1758 %*                                                                      *
1759 %************************************************************************
1760
1761 \begin{code}
1762 -- | Information about a modules use of Haskell Program Coverage
1763 data HpcInfo
1764   = HpcInfo 
1765      { hpcInfoTickCount :: Int
1766      , hpcInfoHash      :: Int
1767      }
1768   | NoHpcInfo 
1769      { hpcUsed          :: AnyHpcUsage  -- ^ Is hpc used anywhere on the module \*tree\*?
1770      }
1771
1772 -- | This is used to signal if one of my imports used HPC instrumentation
1773 -- even if there is no module-local HPC usage
1774 type AnyHpcUsage = Bool
1775
1776 emptyHpcInfo :: AnyHpcUsage -> HpcInfo
1777 emptyHpcInfo = NoHpcInfo 
1778
1779 -- | Find out if HPC is used by this module or any of the modules
1780 -- it depends upon
1781 isHpcUsed :: HpcInfo -> AnyHpcUsage
1782 isHpcUsed (HpcInfo {})                   = True
1783 isHpcUsed (NoHpcInfo { hpcUsed = used }) = used
1784 \end{code}
1785
1786 %************************************************************************
1787 %*                                                                      *
1788 \subsection{Vectorisation Support}
1789 %*                                                                      *
1790 %************************************************************************
1791
1792 The following information is generated and consumed by the vectorisation
1793 subsystem.  It communicates the vectorisation status of declarations from one
1794 module to another.
1795
1796 Why do we need both f and f_v in the ModGuts/ModDetails/EPS version VectInfo
1797 below?  We need to know `f' when converting to IfaceVectInfo.  However, during
1798 vectorisation, we need to know `f_v', whose `Var' we cannot lookup based
1799 on just the OccName easily in a Core pass.
1800
1801 \begin{code}
1802 -- |Vectorisation information for 'ModGuts', 'ModDetails' and 'ExternalPackageState'; see also
1803 -- documentation at 'Vectorise.Env.GlobalEnv'.
1804 data VectInfo      
1805   = VectInfo
1806     { vectInfoVar          :: VarEnv  (Var    , Var  )    -- ^ @(f, f_v)@ keyed on @f@
1807     , vectInfoTyCon        :: NameEnv (TyCon  , TyCon)    -- ^ @(T, T_v)@ keyed on @T@
1808     , vectInfoDataCon      :: NameEnv (DataCon, DataCon)  -- ^ @(C, C_v)@ keyed on @C@
1809     , vectInfoPADFun       :: NameEnv (TyCon  , Var)      -- ^ @(T_v, paT)@ keyed on @T_v@
1810     , vectInfoIso          :: NameEnv (TyCon  , Var)      -- ^ @(T, isoT)@ keyed on @T@
1811     , vectInfoScalarVars   :: VarSet                      -- ^ set of purely scalar variables
1812     , vectInfoScalarTyCons :: NameSet                     -- ^ set of scalar type constructors
1813     }
1814
1815 -- |Vectorisation information for 'ModIface'; i.e, the vectorisation information propagated 
1816 -- across module boundaries.
1817 --
1818 data IfaceVectInfo 
1819   = IfaceVectInfo 
1820     { ifaceVectInfoVar          :: [Name]  -- ^ All variables in here have a vectorised variant
1821     , ifaceVectInfoTyCon        :: [Name]  -- ^ All 'TyCon's in here have a vectorised variant;
1822                                            -- the name of the vectorised variant and those of its
1823                                            -- data constructors are determined by
1824                                            -- 'OccName.mkVectTyConOcc' and 
1825                                            -- 'OccName.mkVectDataConOcc'; the names of the
1826                                            -- isomorphisms are determined by 'OccName.mkVectIsoOcc'
1827     , ifaceVectInfoTyConReuse   :: [Name]  -- ^ The vectorised form of all the 'TyCon's in here
1828                                            -- coincides with the unconverted form; the name of the
1829                                            -- isomorphisms is determined by 'OccName.mkVectIsoOcc'
1830     , ifaceVectInfoScalarVars   :: [Name]  -- iface version of 'vectInfoScalarVar'
1831     , ifaceVectInfoScalarTyCons :: [Name]  -- iface version of 'vectInfoScalarTyCon'
1832     }
1833
1834 noVectInfo :: VectInfo
1835 noVectInfo 
1836   = VectInfo emptyVarEnv emptyNameEnv emptyNameEnv emptyNameEnv emptyNameEnv emptyVarSet
1837              emptyNameSet
1838
1839 plusVectInfo :: VectInfo -> VectInfo -> VectInfo
1840 plusVectInfo vi1 vi2 = 
1841   VectInfo (vectInfoVar          vi1 `plusVarEnv`    vectInfoVar          vi2)
1842            (vectInfoTyCon        vi1 `plusNameEnv`   vectInfoTyCon        vi2)
1843            (vectInfoDataCon      vi1 `plusNameEnv`   vectInfoDataCon      vi2)
1844            (vectInfoPADFun       vi1 `plusNameEnv`   vectInfoPADFun       vi2)
1845            (vectInfoIso          vi1 `plusNameEnv`   vectInfoIso          vi2)
1846            (vectInfoScalarVars   vi1 `unionVarSet`   vectInfoScalarVars   vi2)
1847            (vectInfoScalarTyCons vi1 `unionNameSets` vectInfoScalarTyCons vi2)
1848
1849 concatVectInfo :: [VectInfo] -> VectInfo
1850 concatVectInfo = foldr plusVectInfo noVectInfo
1851
1852 noIfaceVectInfo :: IfaceVectInfo
1853 noIfaceVectInfo = IfaceVectInfo [] [] [] [] []
1854 \end{code}
1855
1856 %************************************************************************
1857 %*                                                                      *
1858 \subsection{Safe Haskell Support}
1859 %*                                                                      *
1860 %************************************************************************
1861
1862 This stuff here is related to supporting the Safe Haskell extension,
1863 primarily about storing under what trust type a module has been compiled.
1864
1865 \begin{code}
1866 -- | Is an import a safe import?
1867 type IsSafeImport = Bool
1868
1869 -- | Safe Haskell information for 'ModIface'
1870 -- Simply a wrapper around SafeHaskellMode to sepperate iface and flags
1871 newtype IfaceTrustInfo = TrustInfo SafeHaskellMode
1872
1873 getSafeMode :: IfaceTrustInfo -> SafeHaskellMode
1874 getSafeMode (TrustInfo x) = x
1875
1876 setSafeMode :: SafeHaskellMode -> IfaceTrustInfo
1877 setSafeMode = TrustInfo
1878
1879 noIfaceTrustInfo :: IfaceTrustInfo
1880 noIfaceTrustInfo = setSafeMode Sf_None
1881
1882 trustInfoToNum :: IfaceTrustInfo -> Word8
1883 trustInfoToNum it
1884   = case getSafeMode it of
1885             Sf_None -> 0
1886             Sf_SafeImports -> 1
1887             Sf_Trustworthy -> 2
1888             Sf_Safe -> 3
1889
1890 numToTrustInfo :: Word8 -> IfaceTrustInfo
1891 numToTrustInfo 0 = setSafeMode Sf_None
1892 numToTrustInfo 1 = setSafeMode Sf_SafeImports
1893 numToTrustInfo 2 = setSafeMode Sf_Trustworthy
1894 numToTrustInfo 3 = setSafeMode Sf_Safe
1895 numToTrustInfo n = error $ "numToTrustInfo: bad input number! (" ++ show n ++ ")"
1896
1897 instance Outputable IfaceTrustInfo where
1898     ppr (TrustInfo Sf_None)         = ptext $ sLit "none"
1899     ppr (TrustInfo Sf_SafeImports)  = ptext $ sLit "safe-imports"
1900     ppr (TrustInfo Sf_Trustworthy)  = ptext $ sLit "trustworthy"
1901     ppr (TrustInfo Sf_Safe)         = ptext $ sLit "safe"
1902 \end{code}
1903
1904 %************************************************************************
1905 %*                                                                      *
1906 \subsection{Linkable stuff}
1907 %*                                                                      *
1908 %************************************************************************
1909
1910 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
1911 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
1912
1913 \begin{code}
1914 -- | Information we can use to dynamically link modules into the compiler
1915 data Linkable = LM {
1916   linkableTime     :: ClockTime,        -- ^ Time at which this linkable was built
1917                                         -- (i.e. when the bytecodes were produced,
1918                                         --       or the mod date on the files)
1919   linkableModule   :: Module,           -- ^ The linkable module itself
1920   linkableUnlinked :: [Unlinked]
1921     -- ^ Those files and chunks of code we have yet to link.
1922     --
1923     -- INVARIANT: A valid linkable always has at least one 'Unlinked' item.
1924     -- If this list is empty, the Linkable represents a fake linkable, which
1925     -- is generated in HscNothing mode to avoid recompiling modules.
1926     --
1927     -- XXX: Do items get removed from this list when they get linked?
1928  }
1929
1930 isObjectLinkable :: Linkable -> Bool
1931 isObjectLinkable l = not (null unlinked) && all isObject unlinked
1932   where unlinked = linkableUnlinked l
1933         -- A linkable with no Unlinked's is treated as a BCO.  We can
1934         -- generate a linkable with no Unlinked's as a result of
1935         -- compiling a module in HscNothing mode, and this choice
1936         -- happens to work well with checkStability in module GHC.
1937
1938 linkableObjs :: Linkable -> [FilePath]
1939 linkableObjs l = [ f | DotO f <- linkableUnlinked l ]
1940
1941 instance Outputable Linkable where
1942    ppr (LM when_made mod unlinkeds)
1943       = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
1944         $$ nest 3 (ppr unlinkeds)
1945
1946 -------------------------------------------
1947
1948 -- | Objects which have yet to be linked by the compiler
1949 data Unlinked
1950    = DotO FilePath      -- ^ An object file (.o)
1951    | DotA FilePath      -- ^ Static archive file (.a)
1952    | DotDLL FilePath    -- ^ Dynamically linked library file (.so, .dll, .dylib)
1953    | BCOs CompiledByteCode ModBreaks    -- ^ A byte-code object, lives only in memory
1954
1955 #ifndef GHCI
1956 data CompiledByteCode = CompiledByteCodeUndefined
1957 _unused :: CompiledByteCode
1958 _unused = CompiledByteCodeUndefined
1959 #endif
1960
1961 instance Outputable Unlinked where
1962    ppr (DotO path)   = text "DotO" <+> text path
1963    ppr (DotA path)   = text "DotA" <+> text path
1964    ppr (DotDLL path) = text "DotDLL" <+> text path
1965 #ifdef GHCI
1966    ppr (BCOs bcos _) = text "BCOs" <+> ppr bcos
1967 #else
1968    ppr (BCOs _ _)    = text "No byte code"
1969 #endif
1970
1971 -- | Is this an actual file on disk we can link in somehow?
1972 isObject :: Unlinked -> Bool
1973 isObject (DotO _)   = True
1974 isObject (DotA _)   = True
1975 isObject (DotDLL _) = True
1976 isObject _          = False
1977
1978 -- | Is this a bytecode linkable with no file on disk?
1979 isInterpretable :: Unlinked -> Bool
1980 isInterpretable = not . isObject
1981
1982 -- | Retrieve the filename of the linkable if possible. Panic if it is a byte-code object
1983 nameOfObject :: Unlinked -> FilePath
1984 nameOfObject (DotO fn)   = fn
1985 nameOfObject (DotA fn)   = fn
1986 nameOfObject (DotDLL fn) = fn
1987 nameOfObject other       = pprPanic "nameOfObject" (ppr other)
1988
1989 -- | Retrieve the compiled byte-code if possible. Panic if it is a file-based linkable
1990 byteCodeOfObject :: Unlinked -> CompiledByteCode
1991 byteCodeOfObject (BCOs bc _) = bc
1992 byteCodeOfObject other       = pprPanic "byteCodeOfObject" (ppr other)
1993 \end{code}
1994
1995 %************************************************************************
1996 %*                                                                      *
1997 \subsection{Breakpoint Support}
1998 %*                                                                      *
1999 %************************************************************************
2000
2001 \begin{code}
2002 -- | Breakpoint index
2003 type BreakIndex = Int
2004
2005 -- | All the information about the breakpoints for a given module
2006 data ModBreaks
2007    = ModBreaks
2008    { modBreaks_flags :: BreakArray
2009         -- ^ The array of flags, one per breakpoint, 
2010         -- indicating which breakpoints are enabled.
2011    , modBreaks_locs :: !(Array BreakIndex SrcSpan)
2012         -- ^ An array giving the source span of each breakpoint.
2013    , modBreaks_vars :: !(Array BreakIndex [OccName])
2014         -- ^ An array giving the names of the free variables at each breakpoint.
2015    , modBreaks_decls :: !(Array BreakIndex [String])
2016         -- ^ An array giving the names of the declarations enclosing each breakpoint.
2017    }
2018
2019 emptyModBreaks :: ModBreaks
2020 emptyModBreaks = ModBreaks
2021    { modBreaks_flags = error "ModBreaks.modBreaks_array not initialised"
2022          -- Todo: can we avoid this? 
2023    , modBreaks_locs  = array (0,-1) []
2024    , modBreaks_vars  = array (0,-1) []
2025    , modBreaks_decls = array (0,-1) []
2026    }
2027 \end{code}