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