Replace -fshow-source-paths with -fhide-source-paths
[ghc.git] / compiler / main / HscTypes.hs
1 {-
2 (c) The University of Glasgow, 2006
3
4 \section[HscTypes]{Types for the per-module compiler}
5 -}
6
7 {-# LANGUAGE CPP, ScopedTypeVariables #-}
8
9 -- | Types for the per-module compiler
10 module HscTypes (
11 -- * compilation state
12 HscEnv(..), hscEPS,
13 FinderCache, FindResult(..), InstalledFindResult(..),
14 Target(..), TargetId(..), pprTarget, pprTargetId,
15 ModuleGraph, emptyMG,
16 HscStatus(..),
17 #ifdef GHCI
18 IServ(..),
19 #endif
20
21 -- * Hsc monad
22 Hsc(..), runHsc, runInteractiveHsc,
23
24 -- * Information about modules
25 ModDetails(..), emptyModDetails,
26 ModGuts(..), CgGuts(..), ForeignStubs(..), appendStubC,
27 ImportedMods, ImportedModsVal(..),
28
29 ModSummary(..), ms_imps, ms_installed_mod, ms_mod_name, showModMsg, isBootSummary,
30 msHsFilePath, msHiFilePath, msObjFilePath,
31 SourceModified(..),
32
33 -- * Information about the module being compiled
34 -- (re-exported from DriverPhases)
35 HscSource(..), isHsBootOrSig, hscSourceString,
36
37
38 -- * State relating to modules in this package
39 HomePackageTable, HomeModInfo(..), emptyHomePackageTable,
40 lookupHpt, eltsHpt, filterHpt, allHpt, mapHpt, delFromHpt,
41 addToHpt, addListToHpt, lookupHptDirectly, listToHpt,
42 hptInstances, hptRules, hptVectInfo, pprHPT,
43 hptObjs,
44
45 -- * State relating to known packages
46 ExternalPackageState(..), EpsStats(..), addEpsInStats,
47 PackageTypeEnv, PackageIfaceTable, emptyPackageIfaceTable,
48 lookupIfaceByModule, emptyModIface, lookupHptByModule,
49
50 PackageInstEnv, PackageFamInstEnv, PackageRuleBase,
51
52 mkSOName, mkHsSOName, soExt,
53
54 -- * Metaprogramming
55 MetaRequest(..),
56 MetaResult, -- data constructors not exported to ensure correct response type
57 metaRequestE, metaRequestP, metaRequestT, metaRequestD, metaRequestAW,
58 MetaHook,
59
60 -- * Annotations
61 prepareAnnotations,
62
63 -- * Interactive context
64 InteractiveContext(..), emptyInteractiveContext,
65 icPrintUnqual, icInScopeTTs, icExtendGblRdrEnv,
66 extendInteractiveContext, extendInteractiveContextWithIds,
67 substInteractiveContext,
68 setInteractivePrintName, icInteractiveModule,
69 InteractiveImport(..), setInteractivePackage,
70 mkPrintUnqualified, pprModulePrefix,
71 mkQualPackage, mkQualModule, pkgQual,
72
73 -- * Interfaces
74 ModIface(..), mkIfaceWarnCache, mkIfaceHashCache, mkIfaceFixCache,
75 emptyIfaceWarnCache, mi_boot, mi_fix,
76 mi_semantic_module,
77 mi_free_holes,
78 renameFreeHoles,
79
80 -- * Fixity
81 FixityEnv, FixItem(..), lookupFixity, emptyFixityEnv,
82
83 -- * TyThings and type environments
84 TyThing(..), tyThingAvailInfo,
85 tyThingTyCon, tyThingDataCon,
86 tyThingId, tyThingCoAxiom, tyThingParent_maybe, tyThingsTyCoVars,
87 implicitTyThings, implicitTyConThings, implicitClassThings,
88 isImplicitTyThing,
89
90 TypeEnv, lookupType, lookupTypeHscEnv, mkTypeEnv, emptyTypeEnv,
91 typeEnvFromEntities, mkTypeEnvWithImplicits,
92 extendTypeEnv, extendTypeEnvList,
93 extendTypeEnvWithIds, plusTypeEnv,
94 lookupTypeEnv,
95 typeEnvElts, typeEnvTyCons, typeEnvIds, typeEnvPatSyns,
96 typeEnvDataCons, typeEnvCoAxioms, typeEnvClasses,
97
98 -- * MonadThings
99 MonadThings(..),
100
101 -- * Information on imports and exports
102 WhetherHasOrphans, IsBootInterface, Usage(..),
103 Dependencies(..), noDependencies,
104 updNameCacheIO,
105 IfaceExport,
106
107 -- * Warnings
108 Warnings(..), WarningTxt(..), plusWarns,
109
110 -- * Linker stuff
111 Linkable(..), isObjectLinkable, linkableObjs,
112 Unlinked(..), CompiledByteCode,
113 isObject, nameOfObject, isInterpretable, byteCodeOfObject,
114
115 -- * Program coverage
116 HpcInfo(..), emptyHpcInfo, isHpcUsed, AnyHpcUsage,
117
118 -- * Breakpoints
119 ModBreaks (..), emptyModBreaks,
120
121 -- * Vectorisation information
122 VectInfo(..), IfaceVectInfo(..), noVectInfo, plusVectInfo,
123 noIfaceVectInfo, isNoIfaceVectInfo,
124
125 -- * Safe Haskell information
126 IfaceTrustInfo, getSafeMode, setSafeMode, noIfaceTrustInfo,
127 trustInfoToNum, numToTrustInfo, IsSafeImport,
128
129 -- * result of the parser
130 HsParsedModule(..),
131
132 -- * Compilation errors and warnings
133 SourceError, GhcApiError, mkSrcErr, srcErrorMessages, mkApiErr,
134 throwOneError, handleSourceError,
135 handleFlagWarnings, printOrThrowWarnings,
136 ) where
137
138 #include "HsVersions.h"
139
140 #ifdef GHCI
141 import ByteCodeTypes
142 import InteractiveEvalTypes ( Resume )
143 import GHCi.Message ( Pipe )
144 import GHCi.RemoteTypes
145 #endif
146
147 import UniqFM
148 import HsSyn
149 import RdrName
150 import Avail
151 import Module
152 import InstEnv ( InstEnv, ClsInst, identicalClsInstHead )
153 import FamInstEnv
154 import CoreSyn ( CoreProgram, RuleBase, CoreRule, CoreVect )
155 import Name
156 import NameEnv
157 import NameSet
158 import VarEnv
159 import VarSet
160 import Var
161 import Id
162 import IdInfo ( IdDetails(..), RecSelParent(..))
163 import Type
164
165 import ApiAnnotation ( ApiAnns )
166 import Annotations ( Annotation, AnnEnv, mkAnnEnv, plusAnnEnv )
167 import Class
168 import TyCon
169 import CoAxiom
170 import ConLike
171 import DataCon
172 import PatSyn
173 import PrelNames ( gHC_PRIM, ioTyConName, printName, mkInteractiveModule
174 , eqTyConName )
175 import TysWiredIn
176 import Packages hiding ( Version(..) )
177 import DynFlags
178 import DriverPhases ( Phase, HscSource(..), isHsBootOrSig, hscSourceString )
179 import BasicTypes
180 import IfaceSyn
181 import Maybes
182 import Outputable
183 import SrcLoc
184 import Unique
185 import UniqDFM
186 import FastString
187 import StringBuffer ( StringBuffer )
188 import Fingerprint
189 import MonadUtils
190 import Bag
191 import Binary
192 import ErrUtils
193 import NameCache
194 import Platform
195 import Util
196 import UniqDSet
197 import GHC.Serialized ( Serialized )
198
199 import Foreign
200 import Control.Monad ( guard, liftM, when, ap )
201 import Data.IORef
202 import Data.Time
203 import Exception
204 import System.FilePath
205 #ifdef GHCI
206 import Control.Concurrent
207 import System.Process ( ProcessHandle )
208 #endif
209
210 -- -----------------------------------------------------------------------------
211 -- Compilation state
212 -- -----------------------------------------------------------------------------
213
214 -- | Status of a compilation to hard-code
215 data HscStatus
216 = HscNotGeneratingCode
217 | HscUpToDate
218 | HscUpdateBoot
219 | HscUpdateSig
220 | HscRecomp CgGuts ModSummary
221
222 -- -----------------------------------------------------------------------------
223 -- The Hsc monad: Passing an environment and warning state
224
225 newtype Hsc a = Hsc (HscEnv -> WarningMessages -> IO (a, WarningMessages))
226
227 instance Functor Hsc where
228 fmap = liftM
229
230 instance Applicative Hsc where
231 pure a = Hsc $ \_ w -> return (a, w)
232 (<*>) = ap
233
234 instance Monad Hsc where
235 Hsc m >>= k = Hsc $ \e w -> do (a, w1) <- m e w
236 case k a of
237 Hsc k' -> k' e w1
238
239 instance MonadIO Hsc where
240 liftIO io = Hsc $ \_ w -> do a <- io; return (a, w)
241
242 instance HasDynFlags Hsc where
243 getDynFlags = Hsc $ \e w -> return (hsc_dflags e, w)
244
245 runHsc :: HscEnv -> Hsc a -> IO a
246 runHsc hsc_env (Hsc hsc) = do
247 (a, w) <- hsc hsc_env emptyBag
248 printOrThrowWarnings (hsc_dflags hsc_env) w
249 return a
250
251 runInteractiveHsc :: HscEnv -> Hsc a -> IO a
252 -- A variant of runHsc that switches in the DynFlags from the
253 -- InteractiveContext before running the Hsc computation.
254 runInteractiveHsc hsc_env
255 = runHsc (hsc_env { hsc_dflags = interactive_dflags })
256 where
257 interactive_dflags = ic_dflags (hsc_IC hsc_env)
258
259 -- -----------------------------------------------------------------------------
260 -- Source Errors
261
262 -- When the compiler (HscMain) discovers errors, it throws an
263 -- exception in the IO monad.
264
265 mkSrcErr :: ErrorMessages -> SourceError
266 mkSrcErr = SourceError
267
268 srcErrorMessages :: SourceError -> ErrorMessages
269 srcErrorMessages (SourceError msgs) = msgs
270
271 mkApiErr :: DynFlags -> SDoc -> GhcApiError
272 mkApiErr dflags msg = GhcApiError (showSDoc dflags msg)
273
274 throwOneError :: MonadIO m => ErrMsg -> m ab
275 throwOneError err = liftIO $ throwIO $ mkSrcErr $ unitBag err
276
277 -- | A source error is an error that is caused by one or more errors in the
278 -- source code. A 'SourceError' is thrown by many functions in the
279 -- compilation pipeline. Inside GHC these errors are merely printed via
280 -- 'log_action', but API clients may treat them differently, for example,
281 -- insert them into a list box. If you want the default behaviour, use the
282 -- idiom:
283 --
284 -- > handleSourceError printExceptionAndWarnings $ do
285 -- > ... api calls that may fail ...
286 --
287 -- The 'SourceError's error messages can be accessed via 'srcErrorMessages'.
288 -- This list may be empty if the compiler failed due to @-Werror@
289 -- ('Opt_WarnIsError').
290 --
291 -- See 'printExceptionAndWarnings' for more information on what to take care
292 -- of when writing a custom error handler.
293 newtype SourceError = SourceError ErrorMessages
294
295 instance Show SourceError where
296 show (SourceError msgs) = unlines . map show . bagToList $ msgs
297
298 instance Exception SourceError
299
300 -- | Perform the given action and call the exception handler if the action
301 -- throws a 'SourceError'. See 'SourceError' for more information.
302 handleSourceError :: (ExceptionMonad m) =>
303 (SourceError -> m a) -- ^ exception handler
304 -> m a -- ^ action to perform
305 -> m a
306 handleSourceError handler act =
307 gcatch act (\(e :: SourceError) -> handler e)
308
309 -- | An error thrown if the GHC API is used in an incorrect fashion.
310 newtype GhcApiError = GhcApiError String
311
312 instance Show GhcApiError where
313 show (GhcApiError msg) = msg
314
315 instance Exception GhcApiError
316
317 -- | Given a bag of warnings, turn them into an exception if
318 -- -Werror is enabled, or print them out otherwise.
319 printOrThrowWarnings :: DynFlags -> Bag WarnMsg -> IO ()
320 printOrThrowWarnings dflags warns
321 | anyBag (isWarnMsgFatal dflags) warns
322 = throwIO $ mkSrcErr $ warns `snocBag` warnIsErrorMsg dflags
323 | otherwise
324 = printBagOfErrors dflags warns
325
326 handleFlagWarnings :: DynFlags -> [Located String] -> IO ()
327 handleFlagWarnings dflags warns
328 = when (wopt Opt_WarnDeprecatedFlags dflags) $ do
329 -- It would be nicer if warns :: [Located MsgDoc], but that
330 -- has circular import problems.
331 let bag = listToBag [ mkPlainWarnMsg dflags loc (text warn)
332 | L loc warn <- warns ]
333
334 printOrThrowWarnings dflags bag
335
336 {-
337 ************************************************************************
338 * *
339 \subsection{HscEnv}
340 * *
341 ************************************************************************
342 -}
343
344 -- | HscEnv is like 'Session', except that some of the fields are immutable.
345 -- An HscEnv is used to compile a single module from plain Haskell source
346 -- code (after preprocessing) to either C, assembly or C--. Things like
347 -- the module graph don't change during a single compilation.
348 --
349 -- Historical note: \"hsc\" used to be the name of the compiler binary,
350 -- when there was a separate driver and compiler. To compile a single
351 -- module, the driver would invoke hsc on the source code... so nowadays
352 -- we think of hsc as the layer of the compiler that deals with compiling
353 -- a single module.
354 data HscEnv
355 = HscEnv {
356 hsc_dflags :: DynFlags,
357 -- ^ The dynamic flag settings
358
359 hsc_targets :: [Target],
360 -- ^ The targets (or roots) of the current session
361
362 hsc_mod_graph :: ModuleGraph,
363 -- ^ The module graph of the current session
364
365 hsc_IC :: InteractiveContext,
366 -- ^ The context for evaluating interactive statements
367
368 hsc_HPT :: HomePackageTable,
369 -- ^ The home package table describes already-compiled
370 -- home-package modules, /excluding/ the module we
371 -- are compiling right now.
372 -- (In one-shot mode the current module is the only
373 -- home-package module, so hsc_HPT is empty. All other
374 -- modules count as \"external-package\" modules.
375 -- However, even in GHCi mode, hi-boot interfaces are
376 -- demand-loaded into the external-package table.)
377 --
378 -- 'hsc_HPT' is not mutable because we only demand-load
379 -- external packages; the home package is eagerly
380 -- loaded, module by module, by the compilation manager.
381 --
382 -- The HPT may contain modules compiled earlier by @--make@
383 -- but not actually below the current module in the dependency
384 -- graph.
385 --
386 -- (This changes a previous invariant: changed Jan 05.)
387
388 hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
389 -- ^ Information about the currently loaded external packages.
390 -- This is mutable because packages will be demand-loaded during
391 -- a compilation run as required.
392
393 hsc_NC :: {-# UNPACK #-} !(IORef NameCache),
394 -- ^ As with 'hsc_EPS', this is side-effected by compiling to
395 -- reflect sucking in interface files. They cache the state of
396 -- external interface files, in effect.
397
398 hsc_FC :: {-# UNPACK #-} !(IORef FinderCache),
399 -- ^ The cached result of performing finding in the file system
400
401 hsc_type_env_var :: Maybe (Module, IORef TypeEnv)
402 -- ^ Used for one-shot compilation only, to initialise
403 -- the 'IfGblEnv'. See 'TcRnTypes.tcg_type_env_var' for
404 -- 'TcRnTypes.TcGblEnv'. See also Note [hsc_type_env_var hack]
405
406 #ifdef GHCI
407 , hsc_iserv :: MVar (Maybe IServ)
408 -- ^ interactive server process. Created the first
409 -- time it is needed.
410 #endif
411 }
412
413 -- Note [hsc_type_env_var hack]
414 -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
415 -- hsc_type_env_var is used to initialize tcg_type_env_var, and
416 -- eventually it is the mutable variable that is queried from
417 -- if_rec_types to get a TypeEnv. So, clearly, it's something
418 -- related to knot-tying (see Note [Tying the knot]).
419 -- hsc_type_env_var is used in two places: initTcRn (where
420 -- it initializes tcg_type_env_var) and initIfaceCheck
421 -- (where it initializes if_rec_types).
422 --
423 -- But why do we need a way to feed a mutable variable in? Why
424 -- can't we just initialize tcg_type_env_var when we start
425 -- typechecking? The problem is we need to knot-tie the
426 -- EPS, and we may start adding things to the EPS before type
427 -- checking starts.
428 --
429 -- Here is a concrete example. Suppose we are running
430 -- "ghc -c A.hs", and we have this file system state:
431 --
432 -- A.hs-boot A.hi-boot **up to date**
433 -- B.hs B.hi **up to date**
434 -- A.hs A.hi **stale**
435 --
436 -- The first thing we do is run checkOldIface on A.hi.
437 -- checkOldIface will call loadInterface on B.hi so it can
438 -- get its hands on the fingerprints, to find out if A.hi
439 -- needs recompilation. But loadInterface also populates
440 -- the EPS! And so if compilation turns out to be necessary,
441 -- as it is in this case, the thunks we put into the EPS for
442 -- B.hi need to have the correct if_rec_types mutable variable
443 -- to query.
444 --
445 -- If the mutable variable is only allocated WHEN we start
446 -- typechecking, then that's too late: we can't get the
447 -- information to the thunks. So we need to pre-commit
448 -- to a type variable in 'hscIncrementalCompile' BEFORE we
449 -- check the old interface.
450 --
451 -- This is all a massive hack because arguably checkOldIface
452 -- should not populate the EPS. But that's a refactor for
453 -- another day.
454
455
456 #ifdef GHCI
457 data IServ = IServ
458 { iservPipe :: Pipe
459 , iservProcess :: ProcessHandle
460 , iservLookupSymbolCache :: IORef (UniqFM (Ptr ()))
461 , iservPendingFrees :: [HValueRef]
462 }
463 #endif
464
465 -- | Retrieve the ExternalPackageState cache.
466 hscEPS :: HscEnv -> IO ExternalPackageState
467 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
468
469 -- | A compilation target.
470 --
471 -- A target may be supplied with the actual text of the
472 -- module. If so, use this instead of the file contents (this
473 -- is for use in an IDE where the file hasn't been saved by
474 -- the user yet).
475 data Target
476 = Target {
477 targetId :: TargetId, -- ^ module or filename
478 targetAllowObjCode :: Bool, -- ^ object code allowed?
479 targetContents :: Maybe (StringBuffer,UTCTime)
480 -- ^ in-memory text buffer?
481 }
482
483 data TargetId
484 = TargetModule ModuleName
485 -- ^ A module name: search for the file
486 | TargetFile FilePath (Maybe Phase)
487 -- ^ A filename: preprocess & parse it to find the module name.
488 -- If specified, the Phase indicates how to compile this file
489 -- (which phase to start from). Nothing indicates the starting phase
490 -- should be determined from the suffix of the filename.
491 deriving Eq
492
493 pprTarget :: Target -> SDoc
494 pprTarget (Target id obj _) =
495 (if obj then char '*' else empty) <> pprTargetId id
496
497 instance Outputable Target where
498 ppr = pprTarget
499
500 pprTargetId :: TargetId -> SDoc
501 pprTargetId (TargetModule m) = ppr m
502 pprTargetId (TargetFile f _) = text f
503
504 instance Outputable TargetId where
505 ppr = pprTargetId
506
507 {-
508 ************************************************************************
509 * *
510 \subsection{Package and Module Tables}
511 * *
512 ************************************************************************
513 -}
514
515 -- | Helps us find information about modules in the home package
516 type HomePackageTable = DModuleNameEnv HomeModInfo
517 -- Domain = modules in the home package that have been fully compiled
518 -- "home" unit id cached here for convenience
519
520 -- | Helps us find information about modules in the imported packages
521 type PackageIfaceTable = ModuleEnv ModIface
522 -- Domain = modules in the imported packages
523
524 -- | Constructs an empty HomePackageTable
525 emptyHomePackageTable :: HomePackageTable
526 emptyHomePackageTable = emptyUDFM
527
528 -- | Constructs an empty PackageIfaceTable
529 emptyPackageIfaceTable :: PackageIfaceTable
530 emptyPackageIfaceTable = emptyModuleEnv
531
532 pprHPT :: HomePackageTable -> SDoc
533 -- A bit aribitrary for now
534 pprHPT hpt = pprUDFM hpt $ \hms ->
535 vcat [ hang (ppr (mi_module (hm_iface hm)))
536 2 (ppr (md_types (hm_details hm)))
537 | hm <- hms ]
538
539 lookupHpt :: HomePackageTable -> ModuleName -> Maybe HomeModInfo
540 lookupHpt = lookupUDFM
541
542 lookupHptDirectly :: HomePackageTable -> Unique -> Maybe HomeModInfo
543 lookupHptDirectly = lookupUDFM_Directly
544
545 eltsHpt :: HomePackageTable -> [HomeModInfo]
546 eltsHpt = eltsUDFM
547
548 filterHpt :: (HomeModInfo -> Bool) -> HomePackageTable -> HomePackageTable
549 filterHpt = filterUDFM
550
551 allHpt :: (HomeModInfo -> Bool) -> HomePackageTable -> Bool
552 allHpt = allUDFM
553
554 mapHpt :: (HomeModInfo -> HomeModInfo) -> HomePackageTable -> HomePackageTable
555 mapHpt = mapUDFM
556
557 delFromHpt :: HomePackageTable -> ModuleName -> HomePackageTable
558 delFromHpt = delFromUDFM
559
560 addToHpt :: HomePackageTable -> ModuleName -> HomeModInfo -> HomePackageTable
561 addToHpt = addToUDFM
562
563 addListToHpt
564 :: HomePackageTable -> [(ModuleName, HomeModInfo)] -> HomePackageTable
565 addListToHpt = addListToUDFM
566
567 listToHpt :: [(ModuleName, HomeModInfo)] -> HomePackageTable
568 listToHpt = listToUDFM
569
570 lookupHptByModule :: HomePackageTable -> Module -> Maybe HomeModInfo
571 -- The HPT is indexed by ModuleName, not Module,
572 -- we must check for a hit on the right Module
573 lookupHptByModule hpt mod
574 = case lookupHpt hpt (moduleName mod) of
575 Just hm | mi_module (hm_iface hm) == mod -> Just hm
576 _otherwise -> Nothing
577
578 -- | Information about modules in the package being compiled
579 data HomeModInfo
580 = HomeModInfo {
581 hm_iface :: !ModIface,
582 -- ^ The basic loaded interface file: every loaded module has one of
583 -- these, even if it is imported from another package
584 hm_details :: !ModDetails,
585 -- ^ Extra information that has been created from the 'ModIface' for
586 -- the module, typically during typechecking
587 hm_linkable :: !(Maybe Linkable)
588 -- ^ The actual artifact we would like to link to access things in
589 -- this module.
590 --
591 -- 'hm_linkable' might be Nothing:
592 --
593 -- 1. If this is an .hs-boot module
594 --
595 -- 2. Temporarily during compilation if we pruned away
596 -- the old linkable because it was out of date.
597 --
598 -- After a complete compilation ('GHC.load'), all 'hm_linkable' fields
599 -- in the 'HomePackageTable' will be @Just@.
600 --
601 -- When re-linking a module ('HscMain.HscNoRecomp'), we construct the
602 -- 'HomeModInfo' by building a new 'ModDetails' from the old
603 -- 'ModIface' (only).
604 }
605
606 -- | Find the 'ModIface' for a 'Module', searching in both the loaded home
607 -- and external package module information
608 lookupIfaceByModule
609 :: DynFlags
610 -> HomePackageTable
611 -> PackageIfaceTable
612 -> Module
613 -> Maybe ModIface
614 lookupIfaceByModule _dflags hpt pit mod
615 = case lookupHptByModule hpt mod of
616 Just hm -> Just (hm_iface hm)
617 Nothing -> lookupModuleEnv pit mod
618
619 -- If the module does come from the home package, why do we look in the PIT as well?
620 -- (a) In OneShot mode, even home-package modules accumulate in the PIT
621 -- (b) Even in Batch (--make) mode, there is *one* case where a home-package
622 -- module is in the PIT, namely GHC.Prim when compiling the base package.
623 -- We could eliminate (b) if we wanted, by making GHC.Prim belong to a package
624 -- of its own, but it doesn't seem worth the bother.
625
626
627 -- | Find all the instance declarations (of classes and families) from
628 -- the Home Package Table filtered by the provided predicate function.
629 -- Used in @tcRnImports@, to select the instances that are in the
630 -- transitive closure of imports from the currently compiled module.
631 hptInstances :: HscEnv -> (ModuleName -> Bool) -> ([ClsInst], [FamInst])
632 hptInstances hsc_env want_this_module
633 = let (insts, famInsts) = unzip $ flip hptAllThings hsc_env $ \mod_info -> do
634 guard (want_this_module (moduleName (mi_module (hm_iface mod_info))))
635 let details = hm_details mod_info
636 return (md_insts details, md_fam_insts details)
637 in (concat insts, concat famInsts)
638
639 -- | Get the combined VectInfo of all modules in the home package table. In
640 -- contrast to instances and rules, we don't care whether the modules are
641 -- "below" us in the dependency sense. The VectInfo of those modules not "below"
642 -- us does not affect the compilation of the current module.
643 hptVectInfo :: HscEnv -> VectInfo
644 hptVectInfo = concatVectInfo . hptAllThings ((: []) . md_vect_info . hm_details)
645
646 -- | Get rules from modules "below" this one (in the dependency sense)
647 hptRules :: HscEnv -> [(ModuleName, IsBootInterface)] -> [CoreRule]
648 hptRules = hptSomeThingsBelowUs (md_rules . hm_details) False
649
650
651 -- | Get annotations from modules "below" this one (in the dependency sense)
652 hptAnns :: HscEnv -> Maybe [(ModuleName, IsBootInterface)] -> [Annotation]
653 hptAnns hsc_env (Just deps) = hptSomeThingsBelowUs (md_anns . hm_details) False hsc_env deps
654 hptAnns hsc_env Nothing = hptAllThings (md_anns . hm_details) hsc_env
655
656 hptAllThings :: (HomeModInfo -> [a]) -> HscEnv -> [a]
657 hptAllThings extract hsc_env = concatMap extract (eltsHpt (hsc_HPT hsc_env))
658
659 -- | Get things from modules "below" this one (in the dependency sense)
660 -- C.f Inst.hptInstances
661 hptSomeThingsBelowUs :: (HomeModInfo -> [a]) -> Bool -> HscEnv -> [(ModuleName, IsBootInterface)] -> [a]
662 hptSomeThingsBelowUs extract include_hi_boot hsc_env deps
663 | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
664
665 | otherwise
666 = let hpt = hsc_HPT hsc_env
667 in
668 [ thing
669 | -- Find each non-hi-boot module below me
670 (mod, is_boot_mod) <- deps
671 , include_hi_boot || not is_boot_mod
672
673 -- unsavoury: when compiling the base package with --make, we
674 -- sometimes try to look up RULES etc for GHC.Prim. GHC.Prim won't
675 -- be in the HPT, because we never compile it; it's in the EPT
676 -- instead. ToDo: clean up, and remove this slightly bogus filter:
677 , mod /= moduleName gHC_PRIM
678
679 -- Look it up in the HPT
680 , let things = case lookupHpt hpt mod of
681 Just info -> extract info
682 Nothing -> pprTrace "WARNING in hptSomeThingsBelowUs" msg []
683 msg = vcat [text "missing module" <+> ppr mod,
684 text "Probable cause: out-of-date interface files"]
685 -- This really shouldn't happen, but see Trac #962
686
687 -- And get its dfuns
688 , thing <- things ]
689
690 hptObjs :: HomePackageTable -> [FilePath]
691 hptObjs hpt = concat (map (maybe [] linkableObjs . hm_linkable) (eltsHpt hpt))
692
693 {-
694 ************************************************************************
695 * *
696 \subsection{Metaprogramming}
697 * *
698 ************************************************************************
699 -}
700
701 -- | The supported metaprogramming result types
702 data MetaRequest
703 = MetaE (LHsExpr RdrName -> MetaResult)
704 | MetaP (LPat RdrName -> MetaResult)
705 | MetaT (LHsType RdrName -> MetaResult)
706 | MetaD ([LHsDecl RdrName] -> MetaResult)
707 | MetaAW (Serialized -> MetaResult)
708
709 -- | data constructors not exported to ensure correct result type
710 data MetaResult
711 = MetaResE { unMetaResE :: LHsExpr RdrName }
712 | MetaResP { unMetaResP :: LPat RdrName }
713 | MetaResT { unMetaResT :: LHsType RdrName }
714 | MetaResD { unMetaResD :: [LHsDecl RdrName] }
715 | MetaResAW { unMetaResAW :: Serialized }
716
717 type MetaHook f = MetaRequest -> LHsExpr Id -> f MetaResult
718
719 metaRequestE :: Functor f => MetaHook f -> LHsExpr Id -> f (LHsExpr RdrName)
720 metaRequestE h = fmap unMetaResE . h (MetaE MetaResE)
721
722 metaRequestP :: Functor f => MetaHook f -> LHsExpr Id -> f (LPat RdrName)
723 metaRequestP h = fmap unMetaResP . h (MetaP MetaResP)
724
725 metaRequestT :: Functor f => MetaHook f -> LHsExpr Id -> f (LHsType RdrName)
726 metaRequestT h = fmap unMetaResT . h (MetaT MetaResT)
727
728 metaRequestD :: Functor f => MetaHook f -> LHsExpr Id -> f [LHsDecl RdrName]
729 metaRequestD h = fmap unMetaResD . h (MetaD MetaResD)
730
731 metaRequestAW :: Functor f => MetaHook f -> LHsExpr Id -> f Serialized
732 metaRequestAW h = fmap unMetaResAW . h (MetaAW MetaResAW)
733
734 {-
735 ************************************************************************
736 * *
737 \subsection{Dealing with Annotations}
738 * *
739 ************************************************************************
740 -}
741
742 -- | Deal with gathering annotations in from all possible places
743 -- and combining them into a single 'AnnEnv'
744 prepareAnnotations :: HscEnv -> Maybe ModGuts -> IO AnnEnv
745 prepareAnnotations hsc_env mb_guts = do
746 eps <- hscEPS hsc_env
747 let -- Extract annotations from the module being compiled if supplied one
748 mb_this_module_anns = fmap (mkAnnEnv . mg_anns) mb_guts
749 -- Extract dependencies of the module if we are supplied one,
750 -- otherwise load annotations from all home package table
751 -- entries regardless of dependency ordering.
752 home_pkg_anns = (mkAnnEnv . hptAnns hsc_env) $ fmap (dep_mods . mg_deps) mb_guts
753 other_pkg_anns = eps_ann_env eps
754 ann_env = foldl1' plusAnnEnv $ catMaybes [mb_this_module_anns,
755 Just home_pkg_anns,
756 Just other_pkg_anns]
757 return ann_env
758
759 {-
760 ************************************************************************
761 * *
762 \subsection{The Finder cache}
763 * *
764 ************************************************************************
765 -}
766
767 -- | The 'FinderCache' maps modules to the result of
768 -- searching for that module. It records the results of searching for
769 -- modules along the search path. On @:load@, we flush the entire
770 -- contents of this cache.
771 --
772 type FinderCache = InstalledModuleEnv InstalledFindResult
773
774 data InstalledFindResult
775 = InstalledFound ModLocation InstalledModule
776 | InstalledNoPackage InstalledUnitId
777 | InstalledNotFound [FilePath] (Maybe InstalledUnitId)
778
779 -- | The result of searching for an imported module.
780 --
781 -- NB: FindResult manages both user source-import lookups
782 -- (which can result in 'Module') as well as direct imports
783 -- for interfaces (which always result in 'InstalledModule').
784 data FindResult
785 = Found ModLocation Module
786 -- ^ The module was found
787 | NoPackage UnitId
788 -- ^ The requested package was not found
789 | FoundMultiple [(Module, ModuleOrigin)]
790 -- ^ _Error_: both in multiple packages
791
792 -- | Not found
793 | NotFound
794 { fr_paths :: [FilePath] -- Places where I looked
795
796 , fr_pkg :: Maybe UnitId -- Just p => module is in this package's
797 -- manifest, but couldn't find
798 -- the .hi file
799
800 , fr_mods_hidden :: [UnitId] -- Module is in these packages,
801 -- but the *module* is hidden
802
803 , fr_pkgs_hidden :: [UnitId] -- Module is in these packages,
804 -- but the *package* is hidden
805
806 , fr_suggestions :: [ModuleSuggestion] -- Possible mis-spelled modules
807 }
808
809 {-
810 ************************************************************************
811 * *
812 \subsection{Symbol tables and Module details}
813 * *
814 ************************************************************************
815 -}
816
817 -- | A 'ModIface' plus a 'ModDetails' summarises everything we know
818 -- about a compiled module. The 'ModIface' is the stuff *before* linking,
819 -- and can be written out to an interface file. The 'ModDetails is after
820 -- linking and can be completely recovered from just the 'ModIface'.
821 --
822 -- When we read an interface file, we also construct a 'ModIface' from it,
823 -- except that we explicitly make the 'mi_decls' and a few other fields empty;
824 -- as when reading we consolidate the declarations etc. into a number of indexed
825 -- maps and environments in the 'ExternalPackageState'.
826 data ModIface
827 = ModIface {
828 mi_module :: !Module, -- ^ Name of the module we are for
829 mi_sig_of :: !(Maybe Module), -- ^ Are we a sig of another mod?
830 mi_iface_hash :: !Fingerprint, -- ^ Hash of the whole interface
831 mi_mod_hash :: !Fingerprint, -- ^ Hash of the ABI only
832 mi_flag_hash :: !Fingerprint, -- ^ Hash of the important flags
833 -- used when compiling this module
834
835 mi_orphan :: !WhetherHasOrphans, -- ^ Whether this module has orphans
836 mi_finsts :: !WhetherHasFamInst, -- ^ Whether this module has family instances
837 mi_hsc_src :: !HscSource, -- ^ Boot? Signature?
838
839 mi_deps :: Dependencies,
840 -- ^ The dependencies of the module. This is
841 -- consulted for directly-imported modules, but not
842 -- for anything else (hence lazy)
843
844 mi_usages :: [Usage],
845 -- ^ Usages; kept sorted so that it's easy to decide
846 -- whether to write a new iface file (changing usages
847 -- doesn't affect the hash of this module)
848 -- NOT STRICT! we read this field lazily from the interface file
849 -- It is *only* consulted by the recompilation checker
850
851 mi_exports :: ![IfaceExport],
852 -- ^ Exports
853 -- Kept sorted by (mod,occ), to make version comparisons easier
854 -- Records the modules that are the declaration points for things
855 -- exported by this module, and the 'OccName's of those things
856
857 mi_exp_hash :: !Fingerprint,
858 -- ^ Hash of export list
859
860 mi_used_th :: !Bool,
861 -- ^ Module required TH splices when it was compiled.
862 -- This disables recompilation avoidance (see #481).
863
864 mi_fixities :: [(OccName,Fixity)],
865 -- ^ Fixities
866 -- NOT STRICT! we read this field lazily from the interface file
867
868 mi_warns :: Warnings,
869 -- ^ Warnings
870 -- NOT STRICT! we read this field lazily from the interface file
871
872 mi_anns :: [IfaceAnnotation],
873 -- ^ Annotations
874 -- NOT STRICT! we read this field lazily from the interface file
875
876
877 mi_decls :: [(Fingerprint,IfaceDecl)],
878 -- ^ Type, class and variable declarations
879 -- The hash of an Id changes if its fixity or deprecations change
880 -- (as well as its type of course)
881 -- Ditto data constructors, class operations, except that
882 -- the hash of the parent class/tycon changes
883
884 mi_globals :: !(Maybe GlobalRdrEnv),
885 -- ^ Binds all the things defined at the top level in
886 -- the /original source/ code for this module. which
887 -- is NOT the same as mi_exports, nor mi_decls (which
888 -- may contains declarations for things not actually
889 -- defined by the user). Used for GHCi and for inspecting
890 -- the contents of modules via the GHC API only.
891 --
892 -- (We need the source file to figure out the
893 -- top-level environment, if we didn't compile this module
894 -- from source then this field contains @Nothing@).
895 --
896 -- Strictly speaking this field should live in the
897 -- 'HomeModInfo', but that leads to more plumbing.
898
899 -- Instance declarations and rules
900 mi_insts :: [IfaceClsInst], -- ^ Sorted class instance
901 mi_fam_insts :: [IfaceFamInst], -- ^ Sorted family instances
902 mi_rules :: [IfaceRule], -- ^ Sorted rules
903 mi_orphan_hash :: !Fingerprint, -- ^ Hash for orphan rules, class and family
904 -- instances, and vectorise pragmas combined
905
906 mi_vect_info :: !IfaceVectInfo, -- ^ Vectorisation information
907
908 -- Cached environments for easy lookup
909 -- These are computed (lazily) from other fields
910 -- and are not put into the interface file
911 mi_warn_fn :: OccName -> Maybe WarningTxt,
912 -- ^ Cached lookup for 'mi_warns'
913 mi_fix_fn :: OccName -> Maybe Fixity,
914 -- ^ Cached lookup for 'mi_fixities'
915 mi_hash_fn :: OccName -> Maybe (OccName, Fingerprint),
916 -- ^ Cached lookup for 'mi_decls'.
917 -- The @Nothing@ in 'mi_hash_fn' means that the thing
918 -- isn't in decls. It's useful to know that when
919 -- seeing if we are up to date wrt. the old interface.
920 -- The 'OccName' is the parent of the name, if it has one.
921
922 mi_hpc :: !AnyHpcUsage,
923 -- ^ True if this program uses Hpc at any point in the program.
924
925 mi_trust :: !IfaceTrustInfo,
926 -- ^ Safe Haskell Trust information for this module.
927
928 mi_trust_pkg :: !Bool
929 -- ^ Do we require the package this module resides in be trusted
930 -- to trust this module? This is used for the situation where a
931 -- module is Safe (so doesn't require the package be trusted
932 -- itself) but imports some trustworthy modules from its own
933 -- package (which does require its own package be trusted).
934 -- See Note [RnNames . Trust Own Package]
935 }
936
937 -- | Old-style accessor for whether or not the ModIface came from an hs-boot
938 -- file.
939 mi_boot :: ModIface -> Bool
940 mi_boot iface = mi_hsc_src iface == HsBootFile
941
942 -- | Lookups up a (possibly cached) fixity from a 'ModIface'. If one cannot be
943 -- found, 'defaultFixity' is returned instead.
944 mi_fix :: ModIface -> OccName -> Fixity
945 mi_fix iface name = mi_fix_fn iface name `orElse` defaultFixity
946
947 -- | The semantic module for this interface; e.g., if it's a interface
948 -- for a signature, if 'mi_module' is @p[A=<A>]:A@, 'mi_semantic_module'
949 -- will be @<A>@.
950 mi_semantic_module :: ModIface -> Module
951 mi_semantic_module iface = case mi_sig_of iface of
952 Nothing -> mi_module iface
953 Just mod -> mod
954
955 -- | The "precise" free holes, e.g., the signatures that this
956 -- 'ModIface' depends on.
957 mi_free_holes :: ModIface -> UniqDSet ModuleName
958 mi_free_holes iface =
959 case splitModuleInsts (mi_module iface) of
960 (_, Just indef)
961 -- A mini-hack: we rely on the fact that 'renameFreeHoles'
962 -- drops things that aren't holes.
963 -> renameFreeHoles (mkUniqDSet cands) (indefUnitIdInsts (indefModuleUnitId indef))
964 _ -> emptyUniqDSet
965 where
966 cands = map fst (dep_mods (mi_deps iface))
967
968 -- | Given a set of free holes, and a unit identifier, rename
969 -- the free holes according to the instantiation of the unit
970 -- identifier. For example, if we have A and B free, and
971 -- our unit identity is @p[A=<C>,B=impl:B]@, the renamed free
972 -- holes are just C.
973 renameFreeHoles :: UniqDSet ModuleName -> [(ModuleName, Module)] -> UniqDSet ModuleName
974 renameFreeHoles fhs insts =
975 unionManyUniqDSets (map lookup_impl (uniqDSetToList fhs))
976 where
977 hmap = listToUFM insts
978 lookup_impl mod_name
979 | Just mod <- lookupUFM hmap mod_name = moduleFreeHoles mod
980 -- It wasn't actually a hole
981 | otherwise = emptyUniqDSet
982
983 instance Binary ModIface where
984 put_ bh (ModIface {
985 mi_module = mod,
986 mi_sig_of = sig_of,
987 mi_hsc_src = hsc_src,
988 mi_iface_hash= iface_hash,
989 mi_mod_hash = mod_hash,
990 mi_flag_hash = flag_hash,
991 mi_orphan = orphan,
992 mi_finsts = hasFamInsts,
993 mi_deps = deps,
994 mi_usages = usages,
995 mi_exports = exports,
996 mi_exp_hash = exp_hash,
997 mi_used_th = used_th,
998 mi_fixities = fixities,
999 mi_warns = warns,
1000 mi_anns = anns,
1001 mi_decls = decls,
1002 mi_insts = insts,
1003 mi_fam_insts = fam_insts,
1004 mi_rules = rules,
1005 mi_orphan_hash = orphan_hash,
1006 mi_vect_info = vect_info,
1007 mi_hpc = hpc_info,
1008 mi_trust = trust,
1009 mi_trust_pkg = trust_pkg }) = do
1010 put_ bh mod
1011 put_ bh sig_of
1012 put_ bh hsc_src
1013 put_ bh iface_hash
1014 put_ bh mod_hash
1015 put_ bh flag_hash
1016 put_ bh orphan
1017 put_ bh hasFamInsts
1018 lazyPut bh deps
1019 lazyPut bh usages
1020 put_ bh exports
1021 put_ bh exp_hash
1022 put_ bh used_th
1023 put_ bh fixities
1024 lazyPut bh warns
1025 lazyPut bh anns
1026 put_ bh decls
1027 put_ bh insts
1028 put_ bh fam_insts
1029 lazyPut bh rules
1030 put_ bh orphan_hash
1031 put_ bh vect_info
1032 put_ bh hpc_info
1033 put_ bh trust
1034 put_ bh trust_pkg
1035
1036 get bh = do
1037 mod <- get bh
1038 sig_of <- get bh
1039 hsc_src <- get bh
1040 iface_hash <- get bh
1041 mod_hash <- get bh
1042 flag_hash <- get bh
1043 orphan <- get bh
1044 hasFamInsts <- get bh
1045 deps <- lazyGet bh
1046 usages <- {-# SCC "bin_usages" #-} lazyGet bh
1047 exports <- {-# SCC "bin_exports" #-} get bh
1048 exp_hash <- get bh
1049 used_th <- get bh
1050 fixities <- {-# SCC "bin_fixities" #-} get bh
1051 warns <- {-# SCC "bin_warns" #-} lazyGet bh
1052 anns <- {-# SCC "bin_anns" #-} lazyGet bh
1053 decls <- {-# SCC "bin_tycldecls" #-} get bh
1054 insts <- {-# SCC "bin_insts" #-} get bh
1055 fam_insts <- {-# SCC "bin_fam_insts" #-} get bh
1056 rules <- {-# SCC "bin_rules" #-} lazyGet bh
1057 orphan_hash <- get bh
1058 vect_info <- get bh
1059 hpc_info <- get bh
1060 trust <- get bh
1061 trust_pkg <- get bh
1062 return (ModIface {
1063 mi_module = mod,
1064 mi_sig_of = sig_of,
1065 mi_hsc_src = hsc_src,
1066 mi_iface_hash = iface_hash,
1067 mi_mod_hash = mod_hash,
1068 mi_flag_hash = flag_hash,
1069 mi_orphan = orphan,
1070 mi_finsts = hasFamInsts,
1071 mi_deps = deps,
1072 mi_usages = usages,
1073 mi_exports = exports,
1074 mi_exp_hash = exp_hash,
1075 mi_used_th = used_th,
1076 mi_anns = anns,
1077 mi_fixities = fixities,
1078 mi_warns = warns,
1079 mi_decls = decls,
1080 mi_globals = Nothing,
1081 mi_insts = insts,
1082 mi_fam_insts = fam_insts,
1083 mi_rules = rules,
1084 mi_orphan_hash = orphan_hash,
1085 mi_vect_info = vect_info,
1086 mi_hpc = hpc_info,
1087 mi_trust = trust,
1088 mi_trust_pkg = trust_pkg,
1089 -- And build the cached values
1090 mi_warn_fn = mkIfaceWarnCache warns,
1091 mi_fix_fn = mkIfaceFixCache fixities,
1092 mi_hash_fn = mkIfaceHashCache decls })
1093
1094 -- | The original names declared of a certain module that are exported
1095 type IfaceExport = AvailInfo
1096
1097 -- | Constructs an empty ModIface
1098 emptyModIface :: Module -> ModIface
1099 emptyModIface mod
1100 = ModIface { mi_module = mod,
1101 mi_sig_of = Nothing,
1102 mi_iface_hash = fingerprint0,
1103 mi_mod_hash = fingerprint0,
1104 mi_flag_hash = fingerprint0,
1105 mi_orphan = False,
1106 mi_finsts = False,
1107 mi_hsc_src = HsSrcFile,
1108 mi_deps = noDependencies,
1109 mi_usages = [],
1110 mi_exports = [],
1111 mi_exp_hash = fingerprint0,
1112 mi_used_th = False,
1113 mi_fixities = [],
1114 mi_warns = NoWarnings,
1115 mi_anns = [],
1116 mi_insts = [],
1117 mi_fam_insts = [],
1118 mi_rules = [],
1119 mi_decls = [],
1120 mi_globals = Nothing,
1121 mi_orphan_hash = fingerprint0,
1122 mi_vect_info = noIfaceVectInfo,
1123 mi_warn_fn = emptyIfaceWarnCache,
1124 mi_fix_fn = emptyIfaceFixCache,
1125 mi_hash_fn = emptyIfaceHashCache,
1126 mi_hpc = False,
1127 mi_trust = noIfaceTrustInfo,
1128 mi_trust_pkg = False }
1129
1130
1131 -- | Constructs cache for the 'mi_hash_fn' field of a 'ModIface'
1132 mkIfaceHashCache :: [(Fingerprint,IfaceDecl)]
1133 -> (OccName -> Maybe (OccName, Fingerprint))
1134 mkIfaceHashCache pairs
1135 = \occ -> lookupOccEnv env occ
1136 where
1137 env = foldr add_decl emptyOccEnv pairs
1138 add_decl (v,d) env0 = foldr add env0 (ifaceDeclFingerprints v d)
1139 where
1140 add (occ,hash) env0 = extendOccEnv env0 occ (occ,hash)
1141
1142 emptyIfaceHashCache :: OccName -> Maybe (OccName, Fingerprint)
1143 emptyIfaceHashCache _occ = Nothing
1144
1145
1146 -- | The 'ModDetails' is essentially a cache for information in the 'ModIface'
1147 -- for home modules only. Information relating to packages will be loaded into
1148 -- global environments in 'ExternalPackageState'.
1149 data ModDetails
1150 = ModDetails {
1151 -- The next two fields are created by the typechecker
1152 md_exports :: [AvailInfo],
1153 md_types :: !TypeEnv, -- ^ Local type environment for this particular module
1154 -- Includes Ids, TyCons, PatSyns
1155 md_insts :: ![ClsInst], -- ^ 'DFunId's for the instances in this module
1156 md_fam_insts :: ![FamInst],
1157 md_rules :: ![CoreRule], -- ^ Domain may include 'Id's from other modules
1158 md_anns :: ![Annotation], -- ^ Annotations present in this module: currently
1159 -- they only annotate things also declared in this module
1160 md_vect_info :: !VectInfo -- ^ Module vectorisation information
1161 }
1162
1163 -- | Constructs an empty ModDetails
1164 emptyModDetails :: ModDetails
1165 emptyModDetails
1166 = ModDetails { md_types = emptyTypeEnv,
1167 md_exports = [],
1168 md_insts = [],
1169 md_rules = [],
1170 md_fam_insts = [],
1171 md_anns = [],
1172 md_vect_info = noVectInfo }
1173
1174 -- | Records the modules directly imported by a module for extracting e.g.
1175 -- usage information, and also to give better error message
1176 type ImportedMods = ModuleEnv [ImportedModsVal]
1177 data ImportedModsVal
1178 = ImportedModsVal {
1179 imv_name :: ModuleName, -- ^ The name the module is imported with
1180 imv_span :: SrcSpan, -- ^ the source span of the whole import
1181 imv_is_safe :: IsSafeImport, -- ^ whether this is a safe import
1182 imv_is_hiding :: Bool, -- ^ whether this is an "hiding" import
1183 imv_all_exports :: GlobalRdrEnv, -- ^ all the things the module could provide
1184 imv_qualified :: Bool -- ^ whether this is a qualified import
1185 }
1186
1187 -- | A ModGuts is carried through the compiler, accumulating stuff as it goes
1188 -- There is only one ModGuts at any time, the one for the module
1189 -- being compiled right now. Once it is compiled, a 'ModIface' and
1190 -- 'ModDetails' are extracted and the ModGuts is discarded.
1191 data ModGuts
1192 = ModGuts {
1193 mg_module :: !Module, -- ^ Module being compiled
1194 mg_hsc_src :: HscSource, -- ^ Whether it's an hs-boot module
1195 mg_loc :: SrcSpan, -- ^ For error messages from inner passes
1196 mg_exports :: ![AvailInfo], -- ^ What it exports
1197 mg_deps :: !Dependencies, -- ^ What it depends on, directly or
1198 -- otherwise
1199 mg_usages :: ![Usage], -- ^ What was used? Used for interfaces.
1200
1201 mg_used_th :: !Bool, -- ^ Did we run a TH splice?
1202 mg_rdr_env :: !GlobalRdrEnv, -- ^ Top-level lexical environment
1203
1204 -- These fields all describe the things **declared in this module**
1205 mg_fix_env :: !FixityEnv, -- ^ Fixities declared in this module.
1206 -- Used for creating interface files.
1207 mg_tcs :: ![TyCon], -- ^ TyCons declared in this module
1208 -- (includes TyCons for classes)
1209 mg_insts :: ![ClsInst], -- ^ Class instances declared in this module
1210 mg_fam_insts :: ![FamInst],
1211 -- ^ Family instances declared in this module
1212 mg_patsyns :: ![PatSyn], -- ^ Pattern synonyms declared in this module
1213 mg_rules :: ![CoreRule], -- ^ Before the core pipeline starts, contains
1214 -- See Note [Overall plumbing for rules] in Rules.hs
1215 mg_binds :: !CoreProgram, -- ^ Bindings for this module
1216 mg_foreign :: !ForeignStubs, -- ^ Foreign exports declared in this module
1217 mg_warns :: !Warnings, -- ^ Warnings declared in the module
1218 mg_anns :: [Annotation], -- ^ Annotations declared in this module
1219 mg_hpc_info :: !HpcInfo, -- ^ Coverage tick boxes in the module
1220 mg_modBreaks :: !(Maybe ModBreaks), -- ^ Breakpoints for the module
1221 mg_vect_decls:: ![CoreVect], -- ^ Vectorisation declarations in this module
1222 -- (produced by desugarer & consumed by vectoriser)
1223 mg_vect_info :: !VectInfo, -- ^ Pool of vectorised declarations in the module
1224
1225 -- The next two fields are unusual, because they give instance
1226 -- environments for *all* modules in the home package, including
1227 -- this module, rather than for *just* this module.
1228 -- Reason: when looking up an instance we don't want to have to
1229 -- look at each module in the home package in turn
1230 mg_inst_env :: InstEnv, -- ^ Class instance environment for
1231 -- /home-package/ modules (including this
1232 -- one); c.f. 'tcg_inst_env'
1233 mg_fam_inst_env :: FamInstEnv, -- ^ Type-family instance environment for
1234 -- /home-package/ modules (including this
1235 -- one); c.f. 'tcg_fam_inst_env'
1236
1237 mg_safe_haskell :: SafeHaskellMode, -- ^ Safe Haskell mode
1238 mg_trust_pkg :: Bool -- ^ Do we need to trust our
1239 -- own package for Safe Haskell?
1240 -- See Note [RnNames . Trust Own Package]
1241 }
1242
1243 -- The ModGuts takes on several slightly different forms:
1244 --
1245 -- After simplification, the following fields change slightly:
1246 -- mg_rules Orphan rules only (local ones now attached to binds)
1247 -- mg_binds With rules attached
1248
1249 ---------------------------------------------------------
1250 -- The Tidy pass forks the information about this module:
1251 -- * one lot goes to interface file generation (ModIface)
1252 -- and later compilations (ModDetails)
1253 -- * the other lot goes to code generation (CgGuts)
1254
1255 -- | A restricted form of 'ModGuts' for code generation purposes
1256 data CgGuts
1257 = CgGuts {
1258 cg_module :: !Module,
1259 -- ^ Module being compiled
1260
1261 cg_tycons :: [TyCon],
1262 -- ^ Algebraic data types (including ones that started
1263 -- life as classes); generate constructors and info
1264 -- tables. Includes newtypes, just for the benefit of
1265 -- External Core
1266
1267 cg_binds :: CoreProgram,
1268 -- ^ The tidied main bindings, including
1269 -- previously-implicit bindings for record and class
1270 -- selectors, and data constructor wrappers. But *not*
1271 -- data constructor workers; reason: we we regard them
1272 -- as part of the code-gen of tycons
1273
1274 cg_foreign :: !ForeignStubs, -- ^ Foreign export stubs
1275 cg_dep_pkgs :: ![InstalledUnitId], -- ^ Dependent packages, used to
1276 -- generate #includes for C code gen
1277 cg_hpc_info :: !HpcInfo, -- ^ Program coverage tick box information
1278 cg_modBreaks :: !(Maybe ModBreaks) -- ^ Module breakpoints
1279 }
1280
1281 -----------------------------------
1282 -- | Foreign export stubs
1283 data ForeignStubs
1284 = NoStubs
1285 -- ^ We don't have any stubs
1286 | ForeignStubs SDoc SDoc
1287 -- ^ There are some stubs. Parameters:
1288 --
1289 -- 1) Header file prototypes for
1290 -- "foreign exported" functions
1291 --
1292 -- 2) C stubs to use when calling
1293 -- "foreign exported" functions
1294
1295 appendStubC :: ForeignStubs -> SDoc -> ForeignStubs
1296 appendStubC NoStubs c_code = ForeignStubs empty c_code
1297 appendStubC (ForeignStubs h c) c_code = ForeignStubs h (c $$ c_code)
1298
1299 {-
1300 ************************************************************************
1301 * *
1302 The interactive context
1303 * *
1304 ************************************************************************
1305
1306 Note [The interactive package]
1307 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1308 Type, class, and value declarations at the command prompt are treated
1309 as if they were defined in modules
1310 interactive:Ghci1
1311 interactive:Ghci2
1312 ...etc...
1313 with each bunch of declarations using a new module, all sharing a
1314 common package 'interactive' (see Module.interactiveUnitId, and
1315 PrelNames.mkInteractiveModule).
1316
1317 This scheme deals well with shadowing. For example:
1318
1319 ghci> data T = A
1320 ghci> data T = B
1321 ghci> :i A
1322 data Ghci1.T = A -- Defined at <interactive>:2:10
1323
1324 Here we must display info about constructor A, but its type T has been
1325 shadowed by the second declaration. But it has a respectable
1326 qualified name (Ghci1.T), and its source location says where it was
1327 defined.
1328
1329 So the main invariant continues to hold, that in any session an
1330 original name M.T only refers to one unique thing. (In a previous
1331 iteration both the T's above were called :Interactive.T, albeit with
1332 different uniques, which gave rise to all sorts of trouble.)
1333
1334 The details are a bit tricky though:
1335
1336 * The field ic_mod_index counts which Ghci module we've got up to.
1337 It is incremented when extending ic_tythings
1338
1339 * ic_tythings contains only things from the 'interactive' package.
1340
1341 * Module from the 'interactive' package (Ghci1, Ghci2 etc) never go
1342 in the Home Package Table (HPT). When you say :load, that's when we
1343 extend the HPT.
1344
1345 * The 'thisPackage' field of DynFlags is *not* set to 'interactive'.
1346 It stays as 'main' (or whatever -this-unit-id says), and is the
1347 package to which :load'ed modules are added to.
1348
1349 * So how do we arrange that declarations at the command prompt get to
1350 be in the 'interactive' package? Simply by setting the tcg_mod
1351 field of the TcGblEnv to "interactive:Ghci1". This is done by the
1352 call to initTc in initTcInteractive, which in turn get the module
1353 from it 'icInteractiveModule' field of the interactive context.
1354
1355 The 'thisPackage' field stays as 'main' (or whatever -this-unit-id says.
1356
1357 * The main trickiness is that the type environment (tcg_type_env) and
1358 fixity envt (tcg_fix_env), now contain entities from all the
1359 interactive-package modules (Ghci1, Ghci2, ...) together, rather
1360 than just a single module as is usually the case. So you can't use
1361 "nameIsLocalOrFrom" to decide whether to look in the TcGblEnv vs
1362 the HPT/PTE. This is a change, but not a problem provided you
1363 know.
1364
1365 * However, the tcg_binds, tcg_sigs, tcg_insts, tcg_fam_insts, etc fields
1366 of the TcGblEnv, which collect "things defined in this module", all
1367 refer to stuff define in a single GHCi command, *not* all the commands
1368 so far.
1369
1370 In contrast, tcg_inst_env, tcg_fam_inst_env, have instances from
1371 all GhciN modules, which makes sense -- they are all "home package"
1372 modules.
1373
1374
1375 Note [Interactively-bound Ids in GHCi]
1376 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1377 The Ids bound by previous Stmts in GHCi are currently
1378 a) GlobalIds, with
1379 b) An External Name, like Ghci4.foo
1380 See Note [The interactive package] above
1381 c) A tidied type
1382
1383 (a) They must be GlobalIds (not LocalIds) otherwise when we come to
1384 compile an expression using these ids later, the byte code
1385 generator will consider the occurrences to be free rather than
1386 global.
1387
1388 (b) Having an External Name is important because of Note
1389 [GlobalRdrEnv shadowing] in RdrName
1390
1391 (c) Their types are tidied. This is important, because :info may ask
1392 to look at them, and :info expects the things it looks up to have
1393 tidy types
1394
1395 Where do interactively-bound Ids come from?
1396
1397 - GHCi REPL Stmts e.g.
1398 ghci> let foo x = x+1
1399 These start with an Internal Name because a Stmt is a local
1400 construct, so the renamer naturally builds an Internal name for
1401 each of its binders. Then in tcRnStmt they are externalised via
1402 TcRnDriver.externaliseAndTidyId, so they get Names like Ghic4.foo.
1403
1404 - Ids bound by the debugger etc have Names constructed by
1405 IfaceEnv.newInteractiveBinder; at the call sites it is followed by
1406 mkVanillaGlobal or mkVanillaGlobalWithInfo. So again, they are
1407 all Global, External.
1408
1409 - TyCons, Classes, and Ids bound by other top-level declarations in
1410 GHCi (eg foreign import, record selectors) also get External
1411 Names, with Ghci9 (or 8, or 7, etc) as the module name.
1412
1413
1414 Note [ic_tythings]
1415 ~~~~~~~~~~~~~~~~~~
1416 The ic_tythings field contains
1417 * The TyThings declared by the user at the command prompt
1418 (eg Ids, TyCons, Classes)
1419
1420 * The user-visible Ids that arise from such things, which
1421 *don't* come from 'implicitTyThings', notably:
1422 - record selectors
1423 - class ops
1424 The implicitTyThings are readily obtained from the TyThings
1425 but record selectors etc are not
1426
1427 It does *not* contain
1428 * DFunIds (they can be gotten from ic_instances)
1429 * CoAxioms (ditto)
1430
1431 See also Note [Interactively-bound Ids in GHCi]
1432
1433 Note [Override identical instances in GHCi]
1434 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1435 If you declare a new instance in GHCi that is identical to a previous one,
1436 we simply override the previous one; we don't regard it as overlapping.
1437 e.g. Prelude> data T = A | B
1438 Prelude> instance Eq T where ...
1439 Prelude> instance Eq T where ... -- This one overrides
1440
1441 It's exactly the same for type-family instances. See Trac #7102
1442 -}
1443
1444 -- | Interactive context, recording information about the state of the
1445 -- context in which statements are executed in a GHC session.
1446 data InteractiveContext
1447 = InteractiveContext {
1448 ic_dflags :: DynFlags,
1449 -- ^ The 'DynFlags' used to evaluate interative expressions
1450 -- and statements.
1451
1452 ic_mod_index :: Int,
1453 -- ^ Each GHCi stmt or declaration brings some new things into
1454 -- scope. We give them names like interactive:Ghci9.T,
1455 -- where the ic_index is the '9'. The ic_mod_index is
1456 -- incremented whenever we add something to ic_tythings
1457 -- See Note [The interactive package]
1458
1459 ic_imports :: [InteractiveImport],
1460 -- ^ The GHCi top-level scope (ic_rn_gbl_env) is extended with
1461 -- these imports
1462 --
1463 -- This field is only stored here so that the client
1464 -- can retrieve it with GHC.getContext. GHC itself doesn't
1465 -- use it, but does reset it to empty sometimes (such
1466 -- as before a GHC.load). The context is set with GHC.setContext.
1467
1468 ic_tythings :: [TyThing],
1469 -- ^ TyThings defined by the user, in reverse order of
1470 -- definition (ie most recent at the front)
1471 -- See Note [ic_tythings]
1472
1473 ic_rn_gbl_env :: GlobalRdrEnv,
1474 -- ^ The cached 'GlobalRdrEnv', built by
1475 -- 'InteractiveEval.setContext' and updated regularly
1476 -- It contains everything in scope at the command line,
1477 -- including everything in ic_tythings
1478
1479 ic_instances :: ([ClsInst], [FamInst]),
1480 -- ^ All instances and family instances created during
1481 -- this session. These are grabbed en masse after each
1482 -- update to be sure that proper overlapping is retained.
1483 -- That is, rather than re-check the overlapping each
1484 -- time we update the context, we just take the results
1485 -- from the instance code that already does that.
1486
1487 ic_fix_env :: FixityEnv,
1488 -- ^ Fixities declared in let statements
1489
1490 ic_default :: Maybe [Type],
1491 -- ^ The current default types, set by a 'default' declaration
1492
1493 #ifdef GHCI
1494 ic_resume :: [Resume],
1495 -- ^ The stack of breakpoint contexts
1496 #endif
1497
1498 ic_monad :: Name,
1499 -- ^ The monad that GHCi is executing in
1500
1501 ic_int_print :: Name,
1502 -- ^ The function that is used for printing results
1503 -- of expressions in ghci and -e mode.
1504
1505 ic_cwd :: Maybe FilePath
1506 -- virtual CWD of the program
1507 }
1508
1509 data InteractiveImport
1510 = IIDecl (ImportDecl RdrName)
1511 -- ^ Bring the exports of a particular module
1512 -- (filtered by an import decl) into scope
1513
1514 | IIModule ModuleName
1515 -- ^ Bring into scope the entire top-level envt of
1516 -- of this module, including the things imported
1517 -- into it.
1518
1519
1520 -- | Constructs an empty InteractiveContext.
1521 emptyInteractiveContext :: DynFlags -> InteractiveContext
1522 emptyInteractiveContext dflags
1523 = InteractiveContext {
1524 ic_dflags = dflags,
1525 ic_imports = [],
1526 ic_rn_gbl_env = emptyGlobalRdrEnv,
1527 ic_mod_index = 1,
1528 ic_tythings = [],
1529 ic_instances = ([],[]),
1530 ic_fix_env = emptyNameEnv,
1531 ic_monad = ioTyConName, -- IO monad by default
1532 ic_int_print = printName, -- System.IO.print by default
1533 ic_default = Nothing,
1534 #ifdef GHCI
1535 ic_resume = [],
1536 #endif
1537 ic_cwd = Nothing }
1538
1539 icInteractiveModule :: InteractiveContext -> Module
1540 icInteractiveModule (InteractiveContext { ic_mod_index = index })
1541 = mkInteractiveModule index
1542
1543 -- | This function returns the list of visible TyThings (useful for
1544 -- e.g. showBindings)
1545 icInScopeTTs :: InteractiveContext -> [TyThing]
1546 icInScopeTTs = ic_tythings
1547
1548 -- | Get the PrintUnqualified function based on the flags and this InteractiveContext
1549 icPrintUnqual :: DynFlags -> InteractiveContext -> PrintUnqualified
1550 icPrintUnqual dflags InteractiveContext{ ic_rn_gbl_env = grenv } =
1551 mkPrintUnqualified dflags grenv
1552
1553 -- | extendInteractiveContext is called with new TyThings recently defined to update the
1554 -- InteractiveContext to include them. Ids are easily removed when shadowed,
1555 -- but Classes and TyCons are not. Some work could be done to determine
1556 -- whether they are entirely shadowed, but as you could still have references
1557 -- to them (e.g. instances for classes or values of the type for TyCons), it's
1558 -- not clear whether removing them is even the appropriate behavior.
1559 extendInteractiveContext :: InteractiveContext
1560 -> [TyThing]
1561 -> [ClsInst] -> [FamInst]
1562 -> Maybe [Type]
1563 -> FixityEnv
1564 -> InteractiveContext
1565 extendInteractiveContext ictxt new_tythings new_cls_insts new_fam_insts defaults fix_env
1566 = ictxt { ic_mod_index = ic_mod_index ictxt + 1
1567 -- Always bump this; even instances should create
1568 -- a new mod_index (Trac #9426)
1569 , ic_tythings = new_tythings ++ ic_tythings ictxt
1570 , ic_rn_gbl_env = ic_rn_gbl_env ictxt `icExtendGblRdrEnv` new_tythings
1571 , ic_instances = ( new_cls_insts ++ old_cls_insts
1572 , new_fam_insts ++ old_fam_insts )
1573 , ic_default = defaults
1574 , ic_fix_env = fix_env -- See Note [Fixity declarations in GHCi]
1575 }
1576 where
1577
1578 -- Discard old instances that have been fully overrridden
1579 -- See Note [Override identical instances in GHCi]
1580 (cls_insts, fam_insts) = ic_instances ictxt
1581 old_cls_insts = filterOut (\i -> any (identicalClsInstHead i) new_cls_insts) cls_insts
1582 old_fam_insts = filterOut (\i -> any (identicalFamInstHead i) new_fam_insts) fam_insts
1583
1584 extendInteractiveContextWithIds :: InteractiveContext -> [Id] -> InteractiveContext
1585 -- Just a specialised version
1586 extendInteractiveContextWithIds ictxt new_ids
1587 | null new_ids = ictxt
1588 | otherwise = ictxt { ic_mod_index = ic_mod_index ictxt + 1
1589 , ic_tythings = new_tythings ++ ic_tythings ictxt
1590 , ic_rn_gbl_env = ic_rn_gbl_env ictxt `icExtendGblRdrEnv` new_tythings }
1591 where
1592 new_tythings = map AnId new_ids
1593
1594 setInteractivePackage :: HscEnv -> HscEnv
1595 -- Set the 'thisPackage' DynFlag to 'interactive'
1596 setInteractivePackage hsc_env
1597 = hsc_env { hsc_dflags = (hsc_dflags hsc_env)
1598 { thisInstalledUnitId = toInstalledUnitId interactiveUnitId } }
1599
1600 setInteractivePrintName :: InteractiveContext -> Name -> InteractiveContext
1601 setInteractivePrintName ic n = ic{ic_int_print = n}
1602
1603 -- ToDo: should not add Ids to the gbl env here
1604
1605 -- | Add TyThings to the GlobalRdrEnv, earlier ones in the list shadowing
1606 -- later ones, and shadowing existing entries in the GlobalRdrEnv.
1607 icExtendGblRdrEnv :: GlobalRdrEnv -> [TyThing] -> GlobalRdrEnv
1608 icExtendGblRdrEnv env tythings
1609 = foldr add env tythings -- Foldr makes things in the front of
1610 -- the list shadow things at the back
1611 where
1612 -- One at a time, to ensure each shadows the previous ones
1613 add thing env
1614 | is_sub_bndr thing
1615 = env
1616 | otherwise
1617 = foldl extendGlobalRdrEnv env1 (concatMap localGREsFromAvail avail)
1618 where
1619 env1 = shadowNames env (concatMap availNames avail)
1620 avail = tyThingAvailInfo thing
1621
1622 -- Ugh! The new_tythings may include record selectors, since they
1623 -- are not implicit-ids, and must appear in the TypeEnv. But they
1624 -- will also be brought into scope by the corresponding (ATyCon
1625 -- tc). And we want the latter, because that has the correct
1626 -- parent (Trac #10520)
1627 is_sub_bndr (AnId f) = case idDetails f of
1628 RecSelId {} -> True
1629 ClassOpId {} -> True
1630 _ -> False
1631 is_sub_bndr _ = False
1632
1633 substInteractiveContext :: InteractiveContext -> TCvSubst -> InteractiveContext
1634 substInteractiveContext ictxt@InteractiveContext{ ic_tythings = tts } subst
1635 | isEmptyTCvSubst subst = ictxt
1636 | otherwise = ictxt { ic_tythings = map subst_ty tts }
1637 where
1638 subst_ty (AnId id) = AnId $ id `setIdType` substTyUnchecked subst (idType id)
1639 subst_ty tt = tt
1640
1641 instance Outputable InteractiveImport where
1642 ppr (IIModule m) = char '*' <> ppr m
1643 ppr (IIDecl d) = ppr d
1644
1645 {-
1646 ************************************************************************
1647 * *
1648 Building a PrintUnqualified
1649 * *
1650 ************************************************************************
1651
1652 Note [Printing original names]
1653 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1654 Deciding how to print names is pretty tricky. We are given a name
1655 P:M.T, where P is the package name, M is the defining module, and T is
1656 the occurrence name, and we have to decide in which form to display
1657 the name given a GlobalRdrEnv describing the current scope.
1658
1659 Ideally we want to display the name in the form in which it is in
1660 scope. However, the name might not be in scope at all, and that's
1661 where it gets tricky. Here are the cases:
1662
1663 1. T uniquely maps to P:M.T ---> "T" NameUnqual
1664 2. There is an X for which X.T
1665 uniquely maps to P:M.T ---> "X.T" NameQual X
1666 3. There is no binding for "M.T" ---> "M.T" NameNotInScope1
1667 4. Otherwise ---> "P:M.T" NameNotInScope2
1668
1669 (3) and (4) apply when the entity P:M.T is not in the GlobalRdrEnv at
1670 all. In these cases we still want to refer to the name as "M.T", *but*
1671 "M.T" might mean something else in the current scope (e.g. if there's
1672 an "import X as M"), so to avoid confusion we avoid using "M.T" if
1673 there's already a binding for it. Instead we write P:M.T.
1674
1675 There's one further subtlety: in case (3), what if there are two
1676 things around, P1:M.T and P2:M.T? Then we don't want to print both of
1677 them as M.T! However only one of the modules P1:M and P2:M can be
1678 exposed (say P2), so we use M.T for that, and P1:M.T for the other one.
1679 This is handled by the qual_mod component of PrintUnqualified, inside
1680 the (ppr mod) of case (3), in Name.pprModulePrefix
1681
1682 Note [Printing unit ids]
1683 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1684 In the old days, original names were tied to PackageIds, which directly
1685 corresponded to the entities that users wrote in Cabal files, and were perfectly
1686 suitable for printing when we need to disambiguate packages. However, with
1687 UnitId, the situation can be different: if the key is instantiated with
1688 some holes, we should try to give the user some more useful information.
1689 -}
1690
1691 -- | Creates some functions that work out the best ways to format
1692 -- names for the user according to a set of heuristics.
1693 mkPrintUnqualified :: DynFlags -> GlobalRdrEnv -> PrintUnqualified
1694 mkPrintUnqualified dflags env = QueryQualify qual_name
1695 (mkQualModule dflags)
1696 (mkQualPackage dflags)
1697 where
1698 qual_name mod occ
1699 | [gre] <- unqual_gres
1700 , right_name gre
1701 = NameUnqual -- If there's a unique entity that's in scope
1702 -- unqualified with 'occ' AND that entity is
1703 -- the right one, then we can use the unqualified name
1704
1705 | [] <- unqual_gres
1706 , any is_name forceUnqualNames
1707 , not (isDerivedOccName occ)
1708 = NameUnqual -- Don't qualify names that come from modules
1709 -- that come with GHC, often appear in error messages,
1710 -- but aren't typically in scope. Doing this does not
1711 -- cause ambiguity, and it reduces the amount of
1712 -- qualification in error messages thus improving
1713 -- readability.
1714 --
1715 -- A motivating example is 'Constraint'. It's often not
1716 -- in scope, but printing GHC.Prim.Constraint seems
1717 -- overkill.
1718
1719 | [gre] <- qual_gres
1720 = NameQual (greQualModName gre)
1721
1722 | null qual_gres
1723 = if null (lookupGRE_RdrName (mkRdrQual (moduleName mod) occ) env)
1724 then NameNotInScope1
1725 else NameNotInScope2
1726
1727 | otherwise
1728 = NameNotInScope1 -- Can happen if 'f' is bound twice in the module
1729 -- Eg f = True; g = 0; f = False
1730 where
1731 is_name :: Name -> Bool
1732 is_name name = ASSERT2( isExternalName name, ppr name )
1733 nameModule name == mod && nameOccName name == occ
1734
1735 forceUnqualNames :: [Name]
1736 forceUnqualNames =
1737 map tyConName [ constraintKindTyCon, heqTyCon, coercibleTyCon
1738 , starKindTyCon, unicodeStarKindTyCon ]
1739 ++ [ eqTyConName ]
1740
1741 right_name gre = nameModule_maybe (gre_name gre) == Just mod
1742
1743 unqual_gres = lookupGRE_RdrName (mkRdrUnqual occ) env
1744 qual_gres = filter right_name (lookupGlobalRdrEnv env occ)
1745
1746 -- we can mention a module P:M without the P: qualifier iff
1747 -- "import M" would resolve unambiguously to P:M. (if P is the
1748 -- current package we can just assume it is unqualified).
1749
1750 -- | Creates a function for formatting modules based on two heuristics:
1751 -- (1) if the module is the current module, don't qualify, and (2) if there
1752 -- is only one exposed package which exports this module, don't qualify.
1753 mkQualModule :: DynFlags -> QueryQualifyModule
1754 mkQualModule dflags mod
1755 | moduleUnitId mod == thisPackage dflags = False
1756
1757 | [(_, pkgconfig)] <- lookup,
1758 packageConfigId pkgconfig == moduleUnitId mod
1759 -- this says: we are given a module P:M, is there just one exposed package
1760 -- that exposes a module M, and is it package P?
1761 = False
1762
1763 | otherwise = True
1764 where lookup = lookupModuleInAllPackages dflags (moduleName mod)
1765
1766 -- | Creates a function for formatting packages based on two heuristics:
1767 -- (1) don't qualify if the package in question is "main", and (2) only qualify
1768 -- with a unit id if the package ID would be ambiguous.
1769 mkQualPackage :: DynFlags -> QueryQualifyPackage
1770 mkQualPackage dflags pkg_key
1771 | pkg_key == mainUnitId || pkg_key == interactiveUnitId
1772 -- Skip the lookup if it's main, since it won't be in the package
1773 -- database!
1774 = False
1775 | Just pkgid <- mb_pkgid
1776 , searchPackageId dflags pkgid `lengthIs` 1
1777 -- this says: we are given a package pkg-0.1@MMM, are there only one
1778 -- exposed packages whose package ID is pkg-0.1?
1779 = False
1780 | otherwise
1781 = True
1782 where mb_pkgid = fmap sourcePackageId (lookupPackage dflags pkg_key)
1783
1784 -- | A function which only qualifies package names if necessary; but
1785 -- qualifies all other identifiers.
1786 pkgQual :: DynFlags -> PrintUnqualified
1787 pkgQual dflags = alwaysQualify {
1788 queryQualifyPackage = mkQualPackage dflags
1789 }
1790
1791 {-
1792 ************************************************************************
1793 * *
1794 Implicit TyThings
1795 * *
1796 ************************************************************************
1797
1798 Note [Implicit TyThings]
1799 ~~~~~~~~~~~~~~~~~~~~~~~~
1800 DEFINITION: An "implicit" TyThing is one that does not have its own
1801 IfaceDecl in an interface file. Instead, its binding in the type
1802 environment is created as part of typechecking the IfaceDecl for
1803 some other thing.
1804
1805 Examples:
1806 * All DataCons are implicit, because they are generated from the
1807 IfaceDecl for the data/newtype. Ditto class methods.
1808
1809 * Record selectors are *not* implicit, because they get their own
1810 free-standing IfaceDecl.
1811
1812 * Associated data/type families are implicit because they are
1813 included in the IfaceDecl of the parent class. (NB: the
1814 IfaceClass decl happens to use IfaceDecl recursively for the
1815 associated types, but that's irrelevant here.)
1816
1817 * Dictionary function Ids are not implicit.
1818
1819 * Axioms for newtypes are implicit (same as above), but axioms
1820 for data/type family instances are *not* implicit (like DFunIds).
1821 -}
1822
1823 -- | Determine the 'TyThing's brought into scope by another 'TyThing'
1824 -- /other/ than itself. For example, Id's don't have any implicit TyThings
1825 -- as they just bring themselves into scope, but classes bring their
1826 -- dictionary datatype, type constructor and some selector functions into
1827 -- scope, just for a start!
1828
1829 -- N.B. the set of TyThings returned here *must* match the set of
1830 -- names returned by LoadIface.ifaceDeclImplicitBndrs, in the sense that
1831 -- TyThing.getOccName should define a bijection between the two lists.
1832 -- This invariant is used in LoadIface.loadDecl (see note [Tricky iface loop])
1833 -- The order of the list does not matter.
1834 implicitTyThings :: TyThing -> [TyThing]
1835 implicitTyThings (AnId _) = []
1836 implicitTyThings (ACoAxiom _cc) = []
1837 implicitTyThings (ATyCon tc) = implicitTyConThings tc
1838 implicitTyThings (AConLike cl) = implicitConLikeThings cl
1839
1840 implicitConLikeThings :: ConLike -> [TyThing]
1841 implicitConLikeThings (RealDataCon dc)
1842 = dataConImplicitTyThings dc
1843
1844 implicitConLikeThings (PatSynCon {})
1845 = [] -- Pattern synonyms have no implicit Ids; the wrapper and matcher
1846 -- are not "implicit"; they are simply new top-level bindings,
1847 -- and they have their own declaration in an interface file
1848 -- Unless a record pat syn when there are implicit selectors
1849 -- They are still not included here as `implicitConLikeThings` is
1850 -- used by `tcTyClsDecls` whilst pattern synonyms are typed checked
1851 -- by `tcTopValBinds`.
1852
1853 implicitClassThings :: Class -> [TyThing]
1854 implicitClassThings cl
1855 = -- Does not include default methods, because those Ids may have
1856 -- their own pragmas, unfoldings etc, not derived from the Class object
1857
1858 -- associated types
1859 -- No recursive call for the classATs, because they
1860 -- are only the family decls; they have no implicit things
1861 map ATyCon (classATs cl) ++
1862
1863 -- superclass and operation selectors
1864 map AnId (classAllSelIds cl)
1865
1866 implicitTyConThings :: TyCon -> [TyThing]
1867 implicitTyConThings tc
1868 = class_stuff ++
1869 -- fields (names of selectors)
1870
1871 -- (possibly) implicit newtype axioms
1872 -- or type family axioms
1873 implicitCoTyCon tc ++
1874
1875 -- for each data constructor in order,
1876 -- the constructor, worker, and (possibly) wrapper
1877 [ thing | dc <- tyConDataCons tc
1878 , thing <- AConLike (RealDataCon dc) : dataConImplicitTyThings dc ]
1879 -- NB. record selectors are *not* implicit, they have fully-fledged
1880 -- bindings that pass through the compilation pipeline as normal.
1881 where
1882 class_stuff = case tyConClass_maybe tc of
1883 Nothing -> []
1884 Just cl -> implicitClassThings cl
1885
1886 -- For newtypes and closed type families (only) add the implicit coercion tycon
1887 implicitCoTyCon :: TyCon -> [TyThing]
1888 implicitCoTyCon tc
1889 | Just co <- newTyConCo_maybe tc = [ACoAxiom $ toBranchedAxiom co]
1890 | Just co <- isClosedSynFamilyTyConWithAxiom_maybe tc
1891 = [ACoAxiom co]
1892 | otherwise = []
1893
1894 -- | Returns @True@ if there should be no interface-file declaration
1895 -- for this thing on its own: either it is built-in, or it is part
1896 -- of some other declaration, or it is generated implicitly by some
1897 -- other declaration.
1898 isImplicitTyThing :: TyThing -> Bool
1899 isImplicitTyThing (AConLike cl) = case cl of
1900 RealDataCon {} -> True
1901 PatSynCon {} -> False
1902 isImplicitTyThing (AnId id) = isImplicitId id
1903 isImplicitTyThing (ATyCon tc) = isImplicitTyCon tc
1904 isImplicitTyThing (ACoAxiom ax) = isImplicitCoAxiom ax
1905
1906 -- | tyThingParent_maybe x returns (Just p)
1907 -- when pprTyThingInContext sould print a declaration for p
1908 -- (albeit with some "..." in it) when asked to show x
1909 -- It returns the *immediate* parent. So a datacon returns its tycon
1910 -- but the tycon could be the associated type of a class, so it in turn
1911 -- might have a parent.
1912 tyThingParent_maybe :: TyThing -> Maybe TyThing
1913 tyThingParent_maybe (AConLike cl) = case cl of
1914 RealDataCon dc -> Just (ATyCon (dataConTyCon dc))
1915 PatSynCon{} -> Nothing
1916 tyThingParent_maybe (ATyCon tc) = case tyConAssoc_maybe tc of
1917 Just cls -> Just (ATyCon (classTyCon cls))
1918 Nothing -> Nothing
1919 tyThingParent_maybe (AnId id) = case idDetails id of
1920 RecSelId { sel_tycon = RecSelData tc } ->
1921 Just (ATyCon tc)
1922 ClassOpId cls ->
1923 Just (ATyCon (classTyCon cls))
1924 _other -> Nothing
1925 tyThingParent_maybe _other = Nothing
1926
1927 tyThingsTyCoVars :: [TyThing] -> TyCoVarSet
1928 tyThingsTyCoVars tts =
1929 unionVarSets $ map ttToVarSet tts
1930 where
1931 ttToVarSet (AnId id) = tyCoVarsOfType $ idType id
1932 ttToVarSet (AConLike cl) = case cl of
1933 RealDataCon dc -> tyCoVarsOfType $ dataConRepType dc
1934 PatSynCon{} -> emptyVarSet
1935 ttToVarSet (ATyCon tc)
1936 = case tyConClass_maybe tc of
1937 Just cls -> (mkVarSet . fst . classTvsFds) cls
1938 Nothing -> tyCoVarsOfType $ tyConKind tc
1939 ttToVarSet (ACoAxiom _) = emptyVarSet
1940
1941 -- | The Names that a TyThing should bring into scope. Used to build
1942 -- the GlobalRdrEnv for the InteractiveContext.
1943 tyThingAvailInfo :: TyThing -> [AvailInfo]
1944 tyThingAvailInfo (ATyCon t)
1945 = case tyConClass_maybe t of
1946 Just c -> [AvailTC n (n : map getName (classMethods c)
1947 ++ map getName (classATs c))
1948 [] ]
1949 where n = getName c
1950 Nothing -> [AvailTC n (n : map getName dcs) flds]
1951 where n = getName t
1952 dcs = tyConDataCons t
1953 flds = tyConFieldLabels t
1954 tyThingAvailInfo (AConLike (PatSynCon p))
1955 = map avail ((getName p) : map flSelector (patSynFieldLabels p))
1956 tyThingAvailInfo t
1957 = [avail (getName t)]
1958
1959 {-
1960 ************************************************************************
1961 * *
1962 TypeEnv
1963 * *
1964 ************************************************************************
1965 -}
1966
1967 -- | A map from 'Name's to 'TyThing's, constructed by typechecking
1968 -- local declarations or interface files
1969 type TypeEnv = NameEnv TyThing
1970
1971 emptyTypeEnv :: TypeEnv
1972 typeEnvElts :: TypeEnv -> [TyThing]
1973 typeEnvTyCons :: TypeEnv -> [TyCon]
1974 typeEnvCoAxioms :: TypeEnv -> [CoAxiom Branched]
1975 typeEnvIds :: TypeEnv -> [Id]
1976 typeEnvPatSyns :: TypeEnv -> [PatSyn]
1977 typeEnvDataCons :: TypeEnv -> [DataCon]
1978 typeEnvClasses :: TypeEnv -> [Class]
1979 lookupTypeEnv :: TypeEnv -> Name -> Maybe TyThing
1980
1981 emptyTypeEnv = emptyNameEnv
1982 typeEnvElts env = nameEnvElts env
1983 typeEnvTyCons env = [tc | ATyCon tc <- typeEnvElts env]
1984 typeEnvCoAxioms env = [ax | ACoAxiom ax <- typeEnvElts env]
1985 typeEnvIds env = [id | AnId id <- typeEnvElts env]
1986 typeEnvPatSyns env = [ps | AConLike (PatSynCon ps) <- typeEnvElts env]
1987 typeEnvDataCons env = [dc | AConLike (RealDataCon dc) <- typeEnvElts env]
1988 typeEnvClasses env = [cl | tc <- typeEnvTyCons env,
1989 Just cl <- [tyConClass_maybe tc]]
1990
1991 mkTypeEnv :: [TyThing] -> TypeEnv
1992 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
1993
1994 mkTypeEnvWithImplicits :: [TyThing] -> TypeEnv
1995 mkTypeEnvWithImplicits things =
1996 mkTypeEnv things
1997 `plusNameEnv`
1998 mkTypeEnv (concatMap implicitTyThings things)
1999
2000 typeEnvFromEntities :: [Id] -> [TyCon] -> [FamInst] -> TypeEnv
2001 typeEnvFromEntities ids tcs famInsts =
2002 mkTypeEnv ( map AnId ids
2003 ++ map ATyCon all_tcs
2004 ++ concatMap implicitTyConThings all_tcs
2005 ++ map (ACoAxiom . toBranchedAxiom . famInstAxiom) famInsts
2006 )
2007 where
2008 all_tcs = tcs ++ famInstsRepTyCons famInsts
2009
2010 lookupTypeEnv = lookupNameEnv
2011
2012 -- Extend the type environment
2013 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
2014 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
2015
2016 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
2017 extendTypeEnvList env things = foldl extendTypeEnv env things
2018
2019 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
2020 extendTypeEnvWithIds env ids
2021 = extendNameEnvList env [(getName id, AnId id) | id <- ids]
2022
2023 plusTypeEnv :: TypeEnv -> TypeEnv -> TypeEnv
2024 plusTypeEnv env1 env2 = plusNameEnv env1 env2
2025
2026 -- | Find the 'TyThing' for the given 'Name' by using all the resources
2027 -- at our disposal: the compiled modules in the 'HomePackageTable' and the
2028 -- compiled modules in other packages that live in 'PackageTypeEnv'. Note
2029 -- that this does NOT look up the 'TyThing' in the module being compiled: you
2030 -- have to do that yourself, if desired
2031 lookupType :: DynFlags
2032 -> HomePackageTable
2033 -> PackageTypeEnv
2034 -> Name
2035 -> Maybe TyThing
2036
2037 lookupType dflags hpt pte name
2038 | isOneShot (ghcMode dflags) -- in one-shot, we don't use the HPT
2039 = lookupNameEnv pte name
2040 | otherwise
2041 = case lookupHptByModule hpt mod of
2042 Just hm -> lookupNameEnv (md_types (hm_details hm)) name
2043 Nothing -> lookupNameEnv pte name
2044 where
2045 mod = ASSERT2( isExternalName name, ppr name )
2046 if isHoleName name
2047 then mkModule (thisPackage dflags) (moduleName (nameModule name))
2048 else nameModule name
2049
2050 -- | As 'lookupType', but with a marginally easier-to-use interface
2051 -- if you have a 'HscEnv'
2052 lookupTypeHscEnv :: HscEnv -> Name -> IO (Maybe TyThing)
2053 lookupTypeHscEnv hsc_env name = do
2054 eps <- readIORef (hsc_EPS hsc_env)
2055 return $! lookupType dflags hpt (eps_PTE eps) name
2056 where
2057 dflags = hsc_dflags hsc_env
2058 hpt = hsc_HPT hsc_env
2059
2060 -- | Get the 'TyCon' from a 'TyThing' if it is a type constructor thing. Panics otherwise
2061 tyThingTyCon :: TyThing -> TyCon
2062 tyThingTyCon (ATyCon tc) = tc
2063 tyThingTyCon other = pprPanic "tyThingTyCon" (ppr other)
2064
2065 -- | Get the 'CoAxiom' from a 'TyThing' if it is a coercion axiom thing. Panics otherwise
2066 tyThingCoAxiom :: TyThing -> CoAxiom Branched
2067 tyThingCoAxiom (ACoAxiom ax) = ax
2068 tyThingCoAxiom other = pprPanic "tyThingCoAxiom" (ppr other)
2069
2070 -- | Get the 'DataCon' from a 'TyThing' if it is a data constructor thing. Panics otherwise
2071 tyThingDataCon :: TyThing -> DataCon
2072 tyThingDataCon (AConLike (RealDataCon dc)) = dc
2073 tyThingDataCon other = pprPanic "tyThingDataCon" (ppr other)
2074
2075 -- | Get the 'Id' from a 'TyThing' if it is a id *or* data constructor thing. Panics otherwise
2076 tyThingId :: TyThing -> Id
2077 tyThingId (AnId id) = id
2078 tyThingId (AConLike (RealDataCon dc)) = dataConWrapId dc
2079 tyThingId other = pprPanic "tyThingId" (ppr other)
2080
2081 {-
2082 ************************************************************************
2083 * *
2084 \subsection{MonadThings and friends}
2085 * *
2086 ************************************************************************
2087 -}
2088
2089 -- | Class that abstracts out the common ability of the monads in GHC
2090 -- to lookup a 'TyThing' in the monadic environment by 'Name'. Provides
2091 -- a number of related convenience functions for accessing particular
2092 -- kinds of 'TyThing'
2093 class Monad m => MonadThings m where
2094 lookupThing :: Name -> m TyThing
2095
2096 lookupId :: Name -> m Id
2097 lookupId = liftM tyThingId . lookupThing
2098
2099 lookupDataCon :: Name -> m DataCon
2100 lookupDataCon = liftM tyThingDataCon . lookupThing
2101
2102 lookupTyCon :: Name -> m TyCon
2103 lookupTyCon = liftM tyThingTyCon . lookupThing
2104
2105 {-
2106 ************************************************************************
2107 * *
2108 \subsection{Auxiliary types}
2109 * *
2110 ************************************************************************
2111
2112 These types are defined here because they are mentioned in ModDetails,
2113 but they are mostly elaborated elsewhere
2114 -}
2115
2116 ------------------ Warnings -------------------------
2117 -- | Warning information for a module
2118 data Warnings
2119 = NoWarnings -- ^ Nothing deprecated
2120 | WarnAll WarningTxt -- ^ Whole module deprecated
2121 | WarnSome [(OccName,WarningTxt)] -- ^ Some specific things deprecated
2122
2123 -- Only an OccName is needed because
2124 -- (1) a deprecation always applies to a binding
2125 -- defined in the module in which the deprecation appears.
2126 -- (2) deprecations are only reported outside the defining module.
2127 -- this is important because, otherwise, if we saw something like
2128 --
2129 -- {-# DEPRECATED f "" #-}
2130 -- f = ...
2131 -- h = f
2132 -- g = let f = undefined in f
2133 --
2134 -- we'd need more information than an OccName to know to say something
2135 -- about the use of f in h but not the use of the locally bound f in g
2136 --
2137 -- however, because we only report about deprecations from the outside,
2138 -- and a module can only export one value called f,
2139 -- an OccName suffices.
2140 --
2141 -- this is in contrast with fixity declarations, where we need to map
2142 -- a Name to its fixity declaration.
2143 deriving( Eq )
2144
2145 instance Binary Warnings where
2146 put_ bh NoWarnings = putByte bh 0
2147 put_ bh (WarnAll t) = do
2148 putByte bh 1
2149 put_ bh t
2150 put_ bh (WarnSome ts) = do
2151 putByte bh 2
2152 put_ bh ts
2153
2154 get bh = do
2155 h <- getByte bh
2156 case h of
2157 0 -> return NoWarnings
2158 1 -> do aa <- get bh
2159 return (WarnAll aa)
2160 _ -> do aa <- get bh
2161 return (WarnSome aa)
2162
2163 -- | Constructs the cache for the 'mi_warn_fn' field of a 'ModIface'
2164 mkIfaceWarnCache :: Warnings -> OccName -> Maybe WarningTxt
2165 mkIfaceWarnCache NoWarnings = \_ -> Nothing
2166 mkIfaceWarnCache (WarnAll t) = \_ -> Just t
2167 mkIfaceWarnCache (WarnSome pairs) = lookupOccEnv (mkOccEnv pairs)
2168
2169 emptyIfaceWarnCache :: OccName -> Maybe WarningTxt
2170 emptyIfaceWarnCache _ = Nothing
2171
2172 plusWarns :: Warnings -> Warnings -> Warnings
2173 plusWarns d NoWarnings = d
2174 plusWarns NoWarnings d = d
2175 plusWarns _ (WarnAll t) = WarnAll t
2176 plusWarns (WarnAll t) _ = WarnAll t
2177 plusWarns (WarnSome v1) (WarnSome v2) = WarnSome (v1 ++ v2)
2178
2179 -- | Creates cached lookup for the 'mi_fix_fn' field of 'ModIface'
2180 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Maybe Fixity
2181 mkIfaceFixCache pairs
2182 = \n -> lookupOccEnv env n
2183 where
2184 env = mkOccEnv pairs
2185
2186 emptyIfaceFixCache :: OccName -> Maybe Fixity
2187 emptyIfaceFixCache _ = Nothing
2188
2189 -- | Fixity environment mapping names to their fixities
2190 type FixityEnv = NameEnv FixItem
2191
2192 -- | Fixity information for an 'Name'. We keep the OccName in the range
2193 -- so that we can generate an interface from it
2194 data FixItem = FixItem OccName Fixity
2195
2196 instance Outputable FixItem where
2197 ppr (FixItem occ fix) = ppr fix <+> ppr occ
2198
2199 emptyFixityEnv :: FixityEnv
2200 emptyFixityEnv = emptyNameEnv
2201
2202 lookupFixity :: FixityEnv -> Name -> Fixity
2203 lookupFixity env n = case lookupNameEnv env n of
2204 Just (FixItem _ fix) -> fix
2205 Nothing -> defaultFixity
2206
2207 {-
2208 ************************************************************************
2209 * *
2210 \subsection{WhatsImported}
2211 * *
2212 ************************************************************************
2213 -}
2214
2215 -- | Records whether a module has orphans. An \"orphan\" is one of:
2216 --
2217 -- * An instance declaration in a module other than the definition
2218 -- module for one of the type constructors or classes in the instance head
2219 --
2220 -- * A transformation rule in a module other than the one defining
2221 -- the function in the head of the rule
2222 --
2223 -- * A vectorisation pragma
2224 type WhetherHasOrphans = Bool
2225
2226 -- | Does this module define family instances?
2227 type WhetherHasFamInst = Bool
2228
2229 -- | Did this module originate from a *-boot file?
2230 type IsBootInterface = Bool
2231
2232 -- | Dependency information about ALL modules and packages below this one
2233 -- in the import hierarchy.
2234 --
2235 -- Invariant: the dependencies of a module @M@ never includes @M@.
2236 --
2237 -- Invariant: none of the lists contain duplicates.
2238 data Dependencies
2239 = Deps { dep_mods :: [(ModuleName, IsBootInterface)]
2240 -- ^ All home-package modules transitively below this one
2241 -- I.e. modules that this one imports, or that are in the
2242 -- dep_mods of those directly-imported modules
2243
2244 , dep_pkgs :: [(InstalledUnitId, Bool)]
2245 -- ^ All packages transitively below this module
2246 -- I.e. packages to which this module's direct imports belong,
2247 -- or that are in the dep_pkgs of those modules
2248 -- The bool indicates if the package is required to be
2249 -- trusted when the module is imported as a safe import
2250 -- (Safe Haskell). See Note [RnNames . Tracking Trust Transitively]
2251
2252 , dep_orphs :: [Module]
2253 -- ^ Transitive closure of orphan modules (whether
2254 -- home or external pkg).
2255 --
2256 -- (Possible optimization: don't include family
2257 -- instance orphans as they are anyway included in
2258 -- 'dep_finsts'. But then be careful about code
2259 -- which relies on dep_orphs having the complete list!)
2260 -- This does NOT include us, unlike 'imp_orphs'.
2261
2262 , dep_finsts :: [Module]
2263 -- ^ Transitive closure of depended upon modules which
2264 -- contain family instances (whether home or external).
2265 -- This is used by 'checkFamInstConsistency'. This
2266 -- does NOT include us, unlike 'imp_finsts'.
2267 }
2268 deriving( Eq )
2269 -- Equality used only for old/new comparison in MkIface.addFingerprints
2270 -- See 'TcRnTypes.ImportAvails' for details on dependencies.
2271
2272 instance Binary Dependencies where
2273 put_ bh deps = do put_ bh (dep_mods deps)
2274 put_ bh (dep_pkgs deps)
2275 put_ bh (dep_orphs deps)
2276 put_ bh (dep_finsts deps)
2277
2278 get bh = do ms <- get bh
2279 ps <- get bh
2280 os <- get bh
2281 fis <- get bh
2282 return (Deps { dep_mods = ms, dep_pkgs = ps, dep_orphs = os,
2283 dep_finsts = fis })
2284
2285 noDependencies :: Dependencies
2286 noDependencies = Deps [] [] [] []
2287
2288 -- | Records modules for which changes may force recompilation of this module
2289 -- See wiki: http://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/RecompilationAvoidance
2290 --
2291 -- This differs from Dependencies. A module X may be in the dep_mods of this
2292 -- module (via an import chain) but if we don't use anything from X it won't
2293 -- appear in our Usage
2294 data Usage
2295 -- | Module from another package
2296 = UsagePackageModule {
2297 usg_mod :: Module,
2298 -- ^ External package module depended on
2299 usg_mod_hash :: Fingerprint,
2300 -- ^ Cached module fingerprint
2301 usg_safe :: IsSafeImport
2302 -- ^ Was this module imported as a safe import
2303 }
2304 -- | Module from the current package
2305 | UsageHomeModule {
2306 usg_mod_name :: ModuleName,
2307 -- ^ Name of the module
2308 usg_mod_hash :: Fingerprint,
2309 -- ^ Cached module fingerprint
2310 usg_entities :: [(OccName,Fingerprint)],
2311 -- ^ Entities we depend on, sorted by occurrence name and fingerprinted.
2312 -- NB: usages are for parent names only, e.g. type constructors
2313 -- but not the associated data constructors.
2314 usg_exports :: Maybe Fingerprint,
2315 -- ^ Fingerprint for the export list of this module,
2316 -- if we directly imported it (and hence we depend on its export list)
2317 usg_safe :: IsSafeImport
2318 -- ^ Was this module imported as a safe import
2319 } -- ^ Module from the current package
2320 -- | A file upon which the module depends, e.g. a CPP #include, or using TH's
2321 -- 'addDependentFile'
2322 | UsageFile {
2323 usg_file_path :: FilePath,
2324 -- ^ External file dependency. From a CPP #include or TH
2325 -- addDependentFile. Should be absolute.
2326 usg_file_hash :: Fingerprint
2327 -- ^ 'Fingerprint' of the file contents.
2328
2329 -- Note: We don't consider things like modification timestamps
2330 -- here, because there's no reason to recompile if the actual
2331 -- contents don't change. This previously lead to odd
2332 -- recompilation behaviors; see #8114
2333 }
2334 -- | A requirement which was merged into this one.
2335 | UsageMergedRequirement {
2336 usg_mod :: Module,
2337 usg_mod_hash :: Fingerprint
2338 }
2339 deriving( Eq )
2340 -- The export list field is (Just v) if we depend on the export list:
2341 -- i.e. we imported the module directly, whether or not we
2342 -- enumerated the things we imported, or just imported
2343 -- everything
2344 -- We need to recompile if M's exports change, because
2345 -- if the import was import M, we might now have a name clash
2346 -- in the importing module.
2347 -- if the import was import M(x) M might no longer export x
2348 -- The only way we don't depend on the export list is if we have
2349 -- import M()
2350 -- And of course, for modules that aren't imported directly we don't
2351 -- depend on their export lists
2352
2353 instance Binary Usage where
2354 put_ bh usg@UsagePackageModule{} = do
2355 putByte bh 0
2356 put_ bh (usg_mod usg)
2357 put_ bh (usg_mod_hash usg)
2358 put_ bh (usg_safe usg)
2359
2360 put_ bh usg@UsageHomeModule{} = do
2361 putByte bh 1
2362 put_ bh (usg_mod_name usg)
2363 put_ bh (usg_mod_hash usg)
2364 put_ bh (usg_exports usg)
2365 put_ bh (usg_entities usg)
2366 put_ bh (usg_safe usg)
2367
2368 put_ bh usg@UsageFile{} = do
2369 putByte bh 2
2370 put_ bh (usg_file_path usg)
2371 put_ bh (usg_file_hash usg)
2372
2373 put_ bh usg@UsageMergedRequirement{} = do
2374 putByte bh 3
2375 put_ bh (usg_mod usg)
2376 put_ bh (usg_mod_hash usg)
2377
2378 get bh = do
2379 h <- getByte bh
2380 case h of
2381 0 -> do
2382 nm <- get bh
2383 mod <- get bh
2384 safe <- get bh
2385 return UsagePackageModule { usg_mod = nm, usg_mod_hash = mod, usg_safe = safe }
2386 1 -> do
2387 nm <- get bh
2388 mod <- get bh
2389 exps <- get bh
2390 ents <- get bh
2391 safe <- get bh
2392 return UsageHomeModule { usg_mod_name = nm, usg_mod_hash = mod,
2393 usg_exports = exps, usg_entities = ents, usg_safe = safe }
2394 2 -> do
2395 fp <- get bh
2396 hash <- get bh
2397 return UsageFile { usg_file_path = fp, usg_file_hash = hash }
2398 3 -> do
2399 mod <- get bh
2400 hash <- get bh
2401 return UsageMergedRequirement { usg_mod = mod, usg_mod_hash = hash }
2402 i -> error ("Binary.get(Usage): " ++ show i)
2403
2404 {-
2405 ************************************************************************
2406 * *
2407 The External Package State
2408 * *
2409 ************************************************************************
2410 -}
2411
2412 type PackageTypeEnv = TypeEnv
2413 type PackageRuleBase = RuleBase
2414 type PackageInstEnv = InstEnv
2415 type PackageFamInstEnv = FamInstEnv
2416 type PackageVectInfo = VectInfo
2417 type PackageAnnEnv = AnnEnv
2418
2419 -- | Information about other packages that we have slurped in by reading
2420 -- their interface files
2421 data ExternalPackageState
2422 = EPS {
2423 eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
2424 -- ^ In OneShot mode (only), home-package modules
2425 -- accumulate in the external package state, and are
2426 -- sucked in lazily. For these home-pkg modules
2427 -- (only) we need to record which are boot modules.
2428 -- We set this field after loading all the
2429 -- explicitly-imported interfaces, but before doing
2430 -- anything else
2431 --
2432 -- The 'ModuleName' part is not necessary, but it's useful for
2433 -- debug prints, and it's convenient because this field comes
2434 -- direct from 'TcRnTypes.imp_dep_mods'
2435
2436 eps_PIT :: !PackageIfaceTable,
2437 -- ^ The 'ModIface's for modules in external packages
2438 -- whose interfaces we have opened.
2439 -- The declarations in these interface files are held in the
2440 -- 'eps_decls', 'eps_inst_env', 'eps_fam_inst_env' and 'eps_rules'
2441 -- fields of this record, not in the 'mi_decls' fields of the
2442 -- interface we have sucked in.
2443 --
2444 -- What /is/ in the PIT is:
2445 --
2446 -- * The Module
2447 --
2448 -- * Fingerprint info
2449 --
2450 -- * Its exports
2451 --
2452 -- * Fixities
2453 --
2454 -- * Deprecations and warnings
2455
2456 eps_free_holes :: InstalledModuleEnv (UniqDSet ModuleName),
2457 -- ^ Cache for 'mi_free_holes'. Ordinarily, we can rely on
2458 -- the 'eps_PIT' for this information, EXCEPT that when
2459 -- we do dependency analysis, we need to look at the
2460 -- 'Dependencies' of our imports to determine what their
2461 -- precise free holes are ('moduleFreeHolesPrecise'). We
2462 -- don't want to repeatedly reread in the interface
2463 -- for every import, so cache it here. When the PIT
2464 -- gets filled in we can drop these entries.
2465
2466 eps_PTE :: !PackageTypeEnv,
2467 -- ^ Result of typechecking all the external package
2468 -- interface files we have sucked in. The domain of
2469 -- the mapping is external-package modules
2470
2471 eps_inst_env :: !PackageInstEnv, -- ^ The total 'InstEnv' accumulated
2472 -- from all the external-package modules
2473 eps_fam_inst_env :: !PackageFamInstEnv,-- ^ The total 'FamInstEnv' accumulated
2474 -- from all the external-package modules
2475 eps_rule_base :: !PackageRuleBase, -- ^ The total 'RuleEnv' accumulated
2476 -- from all the external-package modules
2477 eps_vect_info :: !PackageVectInfo, -- ^ The total 'VectInfo' accumulated
2478 -- from all the external-package modules
2479 eps_ann_env :: !PackageAnnEnv, -- ^ The total 'AnnEnv' accumulated
2480 -- from all the external-package modules
2481
2482 eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv), -- ^ The family instances accumulated from external
2483 -- packages, keyed off the module that declared them
2484
2485 eps_stats :: !EpsStats -- ^ Stastics about what was loaded from external packages
2486 }
2487
2488 -- | Accumulated statistics about what we are putting into the 'ExternalPackageState'.
2489 -- \"In\" means stuff that is just /read/ from interface files,
2490 -- \"Out\" means actually sucked in and type-checked
2491 data EpsStats = EpsStats { n_ifaces_in
2492 , n_decls_in, n_decls_out
2493 , n_rules_in, n_rules_out
2494 , n_insts_in, n_insts_out :: !Int }
2495
2496 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
2497 -- ^ Add stats for one newly-read interface
2498 addEpsInStats stats n_decls n_insts n_rules
2499 = stats { n_ifaces_in = n_ifaces_in stats + 1
2500 , n_decls_in = n_decls_in stats + n_decls
2501 , n_insts_in = n_insts_in stats + n_insts
2502 , n_rules_in = n_rules_in stats + n_rules }
2503
2504 {-
2505 Names in a NameCache are always stored as a Global, and have the SrcLoc
2506 of their binding locations.
2507
2508 Actually that's not quite right. When we first encounter the original
2509 name, we might not be at its binding site (e.g. we are reading an
2510 interface file); so we give it 'noSrcLoc' then. Later, when we find
2511 its binding site, we fix it up.
2512 -}
2513
2514 updNameCacheIO :: HscEnv
2515 -> (NameCache -> (NameCache, c)) -- The updating function
2516 -> IO c
2517 updNameCacheIO hsc_env upd_fn
2518 = atomicModifyIORef' (hsc_NC hsc_env) upd_fn
2519
2520 mkSOName :: Platform -> FilePath -> FilePath
2521 mkSOName platform root
2522 = case platformOS platform of
2523 OSMinGW32 -> root <.> soExt platform
2524 _ -> ("lib" ++ root) <.> soExt platform
2525
2526 mkHsSOName :: Platform -> FilePath -> FilePath
2527 mkHsSOName platform root = ("lib" ++ root) <.> soExt platform
2528
2529 soExt :: Platform -> FilePath
2530 soExt platform
2531 = case platformOS platform of
2532 OSDarwin -> "dylib"
2533 OSMinGW32 -> "dll"
2534 _ -> "so"
2535
2536 {-
2537 ************************************************************************
2538 * *
2539 The module graph and ModSummary type
2540 A ModSummary is a node in the compilation manager's
2541 dependency graph, and it's also passed to hscMain
2542 * *
2543 ************************************************************************
2544 -}
2545
2546 -- | A ModuleGraph contains all the nodes from the home package (only).
2547 -- There will be a node for each source module, plus a node for each hi-boot
2548 -- module.
2549 --
2550 -- The graph is not necessarily stored in topologically-sorted order. Use
2551 -- 'GHC.topSortModuleGraph' and 'Digraph.flattenSCC' to achieve this.
2552 type ModuleGraph = [ModSummary]
2553
2554 emptyMG :: ModuleGraph
2555 emptyMG = []
2556
2557 -- | A single node in a 'ModuleGraph'. The nodes of the module graph
2558 -- are one of:
2559 --
2560 -- * A regular Haskell source module
2561 -- * A hi-boot source module
2562 --
2563 data ModSummary
2564 = ModSummary {
2565 ms_mod :: Module,
2566 -- ^ Identity of the module
2567 ms_hsc_src :: HscSource,
2568 -- ^ The module source either plain Haskell or hs-boot
2569 ms_location :: ModLocation,
2570 -- ^ Location of the various files belonging to the module
2571 ms_hs_date :: UTCTime,
2572 -- ^ Timestamp of source file
2573 ms_obj_date :: Maybe UTCTime,
2574 -- ^ Timestamp of object, if we have one
2575 ms_iface_date :: Maybe UTCTime,
2576 -- ^ Timestamp of hi file, if we *only* are typechecking (it is
2577 -- 'Nothing' otherwise.
2578 -- See Note [Recompilation checking when typechecking only] and #9243
2579 ms_srcimps :: [(Maybe FastString, Located ModuleName)],
2580 -- ^ Source imports of the module
2581 ms_textual_imps :: [(Maybe FastString, Located ModuleName)],
2582 -- ^ Non-source imports of the module from the module *text*
2583 ms_parsed_mod :: Maybe HsParsedModule,
2584 -- ^ The parsed, nonrenamed source, if we have it. This is also
2585 -- used to support "inline module syntax" in Backpack files.
2586 ms_hspp_file :: FilePath,
2587 -- ^ Filename of preprocessed source file
2588 ms_hspp_opts :: DynFlags,
2589 -- ^ Cached flags from @OPTIONS@, @INCLUDE@ and @LANGUAGE@
2590 -- pragmas in the modules source code
2591 ms_hspp_buf :: Maybe StringBuffer
2592 -- ^ The actual preprocessed source, if we have it
2593 }
2594
2595 ms_installed_mod :: ModSummary -> InstalledModule
2596 ms_installed_mod = fst . splitModuleInsts . ms_mod
2597
2598 ms_mod_name :: ModSummary -> ModuleName
2599 ms_mod_name = moduleName . ms_mod
2600
2601 ms_imps :: ModSummary -> [(Maybe FastString, Located ModuleName)]
2602 ms_imps ms =
2603 ms_textual_imps ms ++
2604 map mk_additional_import (dynFlagDependencies (ms_hspp_opts ms))
2605 where
2606 mk_additional_import mod_nm = (Nothing, noLoc mod_nm)
2607
2608 -- The ModLocation contains both the original source filename and the
2609 -- filename of the cleaned-up source file after all preprocessing has been
2610 -- done. The point is that the summariser will have to cpp/unlit/whatever
2611 -- all files anyway, and there's no point in doing this twice -- just
2612 -- park the result in a temp file, put the name of it in the location,
2613 -- and let @compile@ read from that file on the way back up.
2614
2615 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
2616 -- the ms_hs_date and imports can, of course, change
2617
2618 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
2619 msHsFilePath ms = expectJust "msHsFilePath" (ml_hs_file (ms_location ms))
2620 msHiFilePath ms = ml_hi_file (ms_location ms)
2621 msObjFilePath ms = ml_obj_file (ms_location ms)
2622
2623 -- | Did this 'ModSummary' originate from a hs-boot file?
2624 isBootSummary :: ModSummary -> Bool
2625 isBootSummary ms = ms_hsc_src ms == HsBootFile
2626
2627 instance Outputable ModSummary where
2628 ppr ms
2629 = sep [text "ModSummary {",
2630 nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
2631 text "ms_mod =" <+> ppr (ms_mod ms)
2632 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
2633 text "ms_textual_imps =" <+> ppr (ms_textual_imps ms),
2634 text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
2635 char '}'
2636 ]
2637
2638 showModMsg :: DynFlags -> HscTarget -> Bool -> ModSummary -> String
2639 showModMsg dflags target recomp mod_summary = showSDoc dflags $
2640 if gopt Opt_HideSourcePaths dflags
2641 then text mod_str
2642 else hsep
2643 [ text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' ')
2644 , char '('
2645 , text (op $ msHsFilePath mod_summary) <> char ','
2646 , case target of
2647 HscInterpreted | recomp -> text "interpreted"
2648 HscNothing -> text "nothing"
2649 _ -> text (op $ msObjFilePath mod_summary)
2650 , char ')'
2651 ]
2652 where
2653 op = normalise
2654 mod = moduleName (ms_mod mod_summary)
2655 mod_str = showPpr dflags mod ++ hscSourceString (ms_hsc_src mod_summary)
2656
2657 {-
2658 ************************************************************************
2659 * *
2660 \subsection{Recmpilation}
2661 * *
2662 ************************************************************************
2663 -}
2664
2665 -- | Indicates whether a given module's source has been modified since it
2666 -- was last compiled.
2667 data SourceModified
2668 = SourceModified
2669 -- ^ the source has been modified
2670 | SourceUnmodified
2671 -- ^ the source has not been modified. Compilation may or may
2672 -- not be necessary, depending on whether any dependencies have
2673 -- changed since we last compiled.
2674 | SourceUnmodifiedAndStable
2675 -- ^ the source has not been modified, and furthermore all of
2676 -- its (transitive) dependencies are up to date; it definitely
2677 -- does not need to be recompiled. This is important for two
2678 -- reasons: (a) we can omit the version check in checkOldIface,
2679 -- and (b) if the module used TH splices we don't need to force
2680 -- recompilation.
2681
2682 {-
2683 ************************************************************************
2684 * *
2685 \subsection{Hpc Support}
2686 * *
2687 ************************************************************************
2688 -}
2689
2690 -- | Information about a modules use of Haskell Program Coverage
2691 data HpcInfo
2692 = HpcInfo
2693 { hpcInfoTickCount :: Int
2694 , hpcInfoHash :: Int
2695 }
2696 | NoHpcInfo
2697 { hpcUsed :: AnyHpcUsage -- ^ Is hpc used anywhere on the module \*tree\*?
2698 }
2699
2700 -- | This is used to signal if one of my imports used HPC instrumentation
2701 -- even if there is no module-local HPC usage
2702 type AnyHpcUsage = Bool
2703
2704 emptyHpcInfo :: AnyHpcUsage -> HpcInfo
2705 emptyHpcInfo = NoHpcInfo
2706
2707 -- | Find out if HPC is used by this module or any of the modules
2708 -- it depends upon
2709 isHpcUsed :: HpcInfo -> AnyHpcUsage
2710 isHpcUsed (HpcInfo {}) = True
2711 isHpcUsed (NoHpcInfo { hpcUsed = used }) = used
2712
2713 {-
2714 ************************************************************************
2715 * *
2716 \subsection{Vectorisation Support}
2717 * *
2718 ************************************************************************
2719
2720 The following information is generated and consumed by the vectorisation
2721 subsystem. It communicates the vectorisation status of declarations from one
2722 module to another.
2723
2724 Why do we need both f and f_v in the ModGuts/ModDetails/EPS version VectInfo
2725 below? We need to know `f' when converting to IfaceVectInfo. However, during
2726 vectorisation, we need to know `f_v', whose `Var' we cannot lookup based
2727 on just the OccName easily in a Core pass.
2728 -}
2729
2730 -- |Vectorisation information for 'ModGuts', 'ModDetails' and 'ExternalPackageState'; see also
2731 -- documentation at 'Vectorise.Env.GlobalEnv'.
2732 --
2733 -- NB: The following tables may also include 'Var's, 'TyCon's and 'DataCon's from imported modules,
2734 -- which have been subsequently vectorised in the current module.
2735 --
2736 data VectInfo
2737 = VectInfo
2738 { vectInfoVar :: DVarEnv (Var , Var ) -- ^ @(f, f_v)@ keyed on @f@
2739 , vectInfoTyCon :: NameEnv (TyCon , TyCon) -- ^ @(T, T_v)@ keyed on @T@
2740 , vectInfoDataCon :: NameEnv (DataCon, DataCon) -- ^ @(C, C_v)@ keyed on @C@
2741 , vectInfoParallelVars :: DVarSet -- ^ set of parallel variables
2742 , vectInfoParallelTyCons :: NameSet -- ^ set of parallel type constructors
2743 }
2744
2745 -- |Vectorisation information for 'ModIface'; i.e, the vectorisation information propagated
2746 -- across module boundaries.
2747 --
2748 -- NB: The field 'ifaceVectInfoVar' explicitly contains the workers of data constructors as well as
2749 -- class selectors — i.e., their mappings are /not/ implicitly generated from the data types.
2750 -- Moreover, whether the worker of a data constructor is in 'ifaceVectInfoVar' determines
2751 -- whether that data constructor was vectorised (or is part of an abstractly vectorised type
2752 -- constructor).
2753 --
2754 data IfaceVectInfo
2755 = IfaceVectInfo
2756 { ifaceVectInfoVar :: [Name] -- ^ All variables in here have a vectorised variant
2757 , ifaceVectInfoTyCon :: [Name] -- ^ All 'TyCon's in here have a vectorised variant;
2758 -- the name of the vectorised variant and those of its
2759 -- data constructors are determined by
2760 -- 'OccName.mkVectTyConOcc' and
2761 -- 'OccName.mkVectDataConOcc'; the names of the
2762 -- isomorphisms are determined by 'OccName.mkVectIsoOcc'
2763 , ifaceVectInfoTyConReuse :: [Name] -- ^ The vectorised form of all the 'TyCon's in here
2764 -- coincides with the unconverted form; the name of the
2765 -- isomorphisms is determined by 'OccName.mkVectIsoOcc'
2766 , ifaceVectInfoParallelVars :: [Name] -- iface version of 'vectInfoParallelVar'
2767 , ifaceVectInfoParallelTyCons :: [Name] -- iface version of 'vectInfoParallelTyCon'
2768 }
2769
2770 noVectInfo :: VectInfo
2771 noVectInfo
2772 = VectInfo emptyDVarEnv emptyNameEnv emptyNameEnv emptyDVarSet emptyNameSet
2773
2774 plusVectInfo :: VectInfo -> VectInfo -> VectInfo
2775 plusVectInfo vi1 vi2 =
2776 VectInfo (vectInfoVar vi1 `plusDVarEnv` vectInfoVar vi2)
2777 (vectInfoTyCon vi1 `plusNameEnv` vectInfoTyCon vi2)
2778 (vectInfoDataCon vi1 `plusNameEnv` vectInfoDataCon vi2)
2779 (vectInfoParallelVars vi1 `unionDVarSet` vectInfoParallelVars vi2)
2780 (vectInfoParallelTyCons vi1 `unionNameSet` vectInfoParallelTyCons vi2)
2781
2782 concatVectInfo :: [VectInfo] -> VectInfo
2783 concatVectInfo = foldr plusVectInfo noVectInfo
2784
2785 noIfaceVectInfo :: IfaceVectInfo
2786 noIfaceVectInfo = IfaceVectInfo [] [] [] [] []
2787
2788 isNoIfaceVectInfo :: IfaceVectInfo -> Bool
2789 isNoIfaceVectInfo (IfaceVectInfo l1 l2 l3 l4 l5)
2790 = null l1 && null l2 && null l3 && null l4 && null l5
2791
2792 instance Outputable VectInfo where
2793 ppr info = vcat
2794 [ text "variables :" <+> ppr (vectInfoVar info)
2795 , text "tycons :" <+> ppr (vectInfoTyCon info)
2796 , text "datacons :" <+> ppr (vectInfoDataCon info)
2797 , text "parallel vars :" <+> ppr (vectInfoParallelVars info)
2798 , text "parallel tycons :" <+> ppr (vectInfoParallelTyCons info)
2799 ]
2800
2801 instance Outputable IfaceVectInfo where
2802 ppr info = vcat
2803 [ text "variables :" <+> ppr (ifaceVectInfoVar info)
2804 , text "tycons :" <+> ppr (ifaceVectInfoTyCon info)
2805 , text "tycons reuse :" <+> ppr (ifaceVectInfoTyConReuse info)
2806 , text "parallel vars :" <+> ppr (ifaceVectInfoParallelVars info)
2807 , text "parallel tycons :" <+> ppr (ifaceVectInfoParallelTyCons info)
2808 ]
2809
2810
2811 instance Binary IfaceVectInfo where
2812 put_ bh (IfaceVectInfo a1 a2 a3 a4 a5) = do
2813 put_ bh a1
2814 put_ bh a2
2815 put_ bh a3
2816 put_ bh a4
2817 put_ bh a5
2818 get bh = do
2819 a1 <- get bh
2820 a2 <- get bh
2821 a3 <- get bh
2822 a4 <- get bh
2823 a5 <- get bh
2824 return (IfaceVectInfo a1 a2 a3 a4 a5)
2825
2826 {-
2827 ************************************************************************
2828 * *
2829 \subsection{Safe Haskell Support}
2830 * *
2831 ************************************************************************
2832
2833 This stuff here is related to supporting the Safe Haskell extension,
2834 primarily about storing under what trust type a module has been compiled.
2835 -}
2836
2837 -- | Is an import a safe import?
2838 type IsSafeImport = Bool
2839
2840 -- | Safe Haskell information for 'ModIface'
2841 -- Simply a wrapper around SafeHaskellMode to sepperate iface and flags
2842 newtype IfaceTrustInfo = TrustInfo SafeHaskellMode
2843
2844 getSafeMode :: IfaceTrustInfo -> SafeHaskellMode
2845 getSafeMode (TrustInfo x) = x
2846
2847 setSafeMode :: SafeHaskellMode -> IfaceTrustInfo
2848 setSafeMode = TrustInfo
2849
2850 noIfaceTrustInfo :: IfaceTrustInfo
2851 noIfaceTrustInfo = setSafeMode Sf_None
2852
2853 trustInfoToNum :: IfaceTrustInfo -> Word8
2854 trustInfoToNum it
2855 = case getSafeMode it of
2856 Sf_None -> 0
2857 Sf_Unsafe -> 1
2858 Sf_Trustworthy -> 2
2859 Sf_Safe -> 3
2860
2861 numToTrustInfo :: Word8 -> IfaceTrustInfo
2862 numToTrustInfo 0 = setSafeMode Sf_None
2863 numToTrustInfo 1 = setSafeMode Sf_Unsafe
2864 numToTrustInfo 2 = setSafeMode Sf_Trustworthy
2865 numToTrustInfo 3 = setSafeMode Sf_Safe
2866 numToTrustInfo 4 = setSafeMode Sf_Safe -- retained for backwards compat, used
2867 -- to be Sf_SafeInfered but we no longer
2868 -- differentiate.
2869 numToTrustInfo n = error $ "numToTrustInfo: bad input number! (" ++ show n ++ ")"
2870
2871 instance Outputable IfaceTrustInfo where
2872 ppr (TrustInfo Sf_None) = text "none"
2873 ppr (TrustInfo Sf_Unsafe) = text "unsafe"
2874 ppr (TrustInfo Sf_Trustworthy) = text "trustworthy"
2875 ppr (TrustInfo Sf_Safe) = text "safe"
2876
2877 instance Binary IfaceTrustInfo where
2878 put_ bh iftrust = putByte bh $ trustInfoToNum iftrust
2879 get bh = getByte bh >>= (return . numToTrustInfo)
2880
2881 {-
2882 ************************************************************************
2883 * *
2884 \subsection{Parser result}
2885 * *
2886 ************************************************************************
2887 -}
2888
2889 data HsParsedModule = HsParsedModule {
2890 hpm_module :: Located (HsModule RdrName),
2891 hpm_src_files :: [FilePath],
2892 -- ^ extra source files (e.g. from #includes). The lexer collects
2893 -- these from '# <file> <line>' pragmas, which the C preprocessor
2894 -- leaves behind. These files and their timestamps are stored in
2895 -- the .hi file, so that we can force recompilation if any of
2896 -- them change (#3589)
2897 hpm_annotations :: ApiAnns
2898 -- See note [Api annotations] in ApiAnnotation.hs
2899 }
2900
2901 {-
2902 ************************************************************************
2903 * *
2904 \subsection{Linkable stuff}
2905 * *
2906 ************************************************************************
2907
2908 This stuff is in here, rather than (say) in Linker.hs, because the Linker.hs
2909 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
2910 -}
2911
2912 -- | Information we can use to dynamically link modules into the compiler
2913 data Linkable = LM {
2914 linkableTime :: UTCTime, -- ^ Time at which this linkable was built
2915 -- (i.e. when the bytecodes were produced,
2916 -- or the mod date on the files)
2917 linkableModule :: Module, -- ^ The linkable module itself
2918 linkableUnlinked :: [Unlinked]
2919 -- ^ Those files and chunks of code we have yet to link.
2920 --
2921 -- INVARIANT: A valid linkable always has at least one 'Unlinked' item.
2922 -- If this list is empty, the Linkable represents a fake linkable, which
2923 -- is generated in HscNothing mode to avoid recompiling modules.
2924 --
2925 -- ToDo: Do items get removed from this list when they get linked?
2926 }
2927
2928 isObjectLinkable :: Linkable -> Bool
2929 isObjectLinkable l = not (null unlinked) && all isObject unlinked
2930 where unlinked = linkableUnlinked l
2931 -- A linkable with no Unlinked's is treated as a BCO. We can
2932 -- generate a linkable with no Unlinked's as a result of
2933 -- compiling a module in HscNothing mode, and this choice
2934 -- happens to work well with checkStability in module GHC.
2935
2936 linkableObjs :: Linkable -> [FilePath]
2937 linkableObjs l = [ f | DotO f <- linkableUnlinked l ]
2938
2939 instance Outputable Linkable where
2940 ppr (LM when_made mod unlinkeds)
2941 = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
2942 $$ nest 3 (ppr unlinkeds)
2943
2944 -------------------------------------------
2945
2946 -- | Objects which have yet to be linked by the compiler
2947 data Unlinked
2948 = DotO FilePath -- ^ An object file (.o)
2949 | DotA FilePath -- ^ Static archive file (.a)
2950 | DotDLL FilePath -- ^ Dynamically linked library file (.so, .dll, .dylib)
2951 | BCOs CompiledByteCode -- ^ A byte-code object, lives only in memory
2952
2953 #ifndef GHCI
2954 data CompiledByteCode = CompiledByteCodeUndefined
2955 _unusedCompiledByteCode :: CompiledByteCode
2956 _unusedCompiledByteCode = CompiledByteCodeUndefined
2957
2958 data ModBreaks = ModBreaksUndefined
2959 emptyModBreaks :: ModBreaks
2960 emptyModBreaks = ModBreaksUndefined
2961 #endif
2962
2963 instance Outputable Unlinked where
2964 ppr (DotO path) = text "DotO" <+> text path
2965 ppr (DotA path) = text "DotA" <+> text path
2966 ppr (DotDLL path) = text "DotDLL" <+> text path
2967 #ifdef GHCI
2968 ppr (BCOs bcos) = text "BCOs" <+> ppr bcos
2969 #else
2970 ppr (BCOs _) = text "No byte code"
2971 #endif
2972
2973 -- | Is this an actual file on disk we can link in somehow?
2974 isObject :: Unlinked -> Bool
2975 isObject (DotO _) = True
2976 isObject (DotA _) = True
2977 isObject (DotDLL _) = True
2978 isObject _ = False
2979
2980 -- | Is this a bytecode linkable with no file on disk?
2981 isInterpretable :: Unlinked -> Bool
2982 isInterpretable = not . isObject
2983
2984 -- | Retrieve the filename of the linkable if possible. Panic if it is a byte-code object
2985 nameOfObject :: Unlinked -> FilePath
2986 nameOfObject (DotO fn) = fn
2987 nameOfObject (DotA fn) = fn
2988 nameOfObject (DotDLL fn) = fn
2989 nameOfObject other = pprPanic "nameOfObject" (ppr other)
2990
2991 -- | Retrieve the compiled byte-code if possible. Panic if it is a file-based linkable
2992 byteCodeOfObject :: Unlinked -> CompiledByteCode
2993 byteCodeOfObject (BCOs bc) = bc
2994 byteCodeOfObject other = pprPanic "byteCodeOfObject" (ppr other)
2995