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