2 % (c) The University of Glasgow, 2006
4 \section[HscTypes]{Types for the per-module compiler}
7 -- | Types for the per-module compiler
10 Ghc(..), GhcT(..), liftGhcT,
11 GhcMonad(..), WarnLogMonad(..),
14 logWarnings, clearWarnings, hasWarnings,
15 SourceError, GhcApiError, mkSrcErr, srcErrorMessages, mkApiErr,
16 throwOneError, handleSourceError,
20 -- * Sessions and compilation state
21 Session(..), withSession, modifySession, withTempSession,
23 FinderCache, FindResult(..), ModLocationCache,
24 Target(..), TargetId(..), pprTarget, pprTargetId,
27 GhcApiCallbacks(..), withLocalCallbacks,
29 -- * Information about modules
30 ModDetails(..), emptyModDetails,
31 ModGuts(..), CoreModule(..), CgGuts(..), ForeignStubs(..),
34 ModSummary(..), ms_mod_name, showModMsg, isBootSummary,
35 msHsFilePath, msHiFilePath, msObjFilePath,
37 -- * Information about the module being compiled
38 HscSource(..), isHsBoot, hscSourceString, -- Re-exported from DriverPhases
40 -- * State relating to modules in this package
41 HomePackageTable, HomeModInfo(..), emptyHomePackageTable,
42 hptInstances, hptRules, hptVectInfo,
44 -- * State relating to known packages
45 ExternalPackageState(..), EpsStats(..), addEpsInStats,
46 PackageTypeEnv, PackageIfaceTable, emptyPackageIfaceTable,
47 lookupIfaceByModule, emptyModIface,
49 PackageInstEnv, PackageRuleBase,
55 -- * Interactive context
56 InteractiveContext(..), emptyInteractiveContext,
57 icPrintUnqual, extendInteractiveContext,
58 substInteractiveContext,
59 mkPrintUnqualified, pprModulePrefix,
62 ModIface(..), mkIfaceWarnCache, mkIfaceHashCache, mkIfaceFixCache,
66 FixityEnv, FixItem(..), lookupFixity, emptyFixityEnv,
68 -- * TyThings and type environments
70 tyThingClass, tyThingTyCon, tyThingDataCon, tyThingId,
71 implicitTyThings, isImplicitTyThing,
73 TypeEnv, lookupType, lookupTypeHscEnv, mkTypeEnv, emptyTypeEnv,
74 extendTypeEnv, extendTypeEnvList, extendTypeEnvWithIds, lookupTypeEnv,
75 typeEnvElts, typeEnvClasses, typeEnvTyCons, typeEnvIds,
81 -- * Information on imports and exports
82 WhetherHasOrphans, IsBootInterface, Usage(..),
83 Dependencies(..), noDependencies,
84 NameCache(..), OrigNameCache, OrigIParamCache,
85 Avails, availsToNameSet, availsToNameEnv, availName, availNames,
86 GenAvailInfo(..), AvailInfo, RdrAvailInfo,
90 Warnings(..), WarningTxt(..), plusWarns,
93 Linkable(..), isObjectLinkable,
94 Unlinked(..), CompiledByteCode,
95 isObject, nameOfObject, isInterpretable, byteCodeOfObject,
98 HpcInfo(..), emptyHpcInfo, isHpcUsed, AnyHpcUsage,
101 ModBreaks (..), BreakIndex, emptyModBreaks,
103 -- * Vectorisation information
104 VectInfo(..), IfaceVectInfo(..), noVectInfo, plusVectInfo,
108 #include "HsVersions.h"
111 import ByteCodeAsm ( CompiledByteCode )
112 import {-# SOURCE #-} InteractiveEval ( Resume )
121 import InstEnv ( InstEnv, Instance )
122 import FamInstEnv ( FamInstEnv, FamInst )
123 import Rules ( RuleBase )
124 import CoreSyn ( CoreBind )
132 import Class ( Class, classSelIds, classATs, classTyCon )
134 import DataCon ( DataCon, dataConImplicitIds, dataConWrapId )
135 import PrelNames ( gHC_PRIM )
136 import Packages hiding ( Version(..) )
137 import DynFlags ( DynFlags(..), isOneShot, HscTarget (..), dopt,
139 import DriverPhases ( HscSource(..), isHsBoot, hscSourceString, Phase )
140 import BasicTypes ( IPName, defaultFixity, WarningTxt(..) )
141 import OptimizationFuel ( OptFuelState )
143 import FiniteMap ( FiniteMap )
144 import CoreSyn ( CoreRule )
145 import Maybes ( orElse, expectJust, catMaybes )
148 import SrcLoc ( SrcSpan, Located(..) )
149 import UniqFM ( lookupUFM, eltsUFM, emptyUFM )
150 import UniqSupply ( UniqSupply )
152 import StringBuffer ( StringBuffer )
155 import Data.Dynamic ( Typeable )
156 import qualified Data.Dynamic as Dyn
160 import System.FilePath
161 import System.Time ( ClockTime )
163 import Data.Array ( Array, array )
165 import Control.Monad ( mplus, guard, liftM, when )
170 %************************************************************************
172 \subsection{Compilation environment}
174 %************************************************************************
178 -- | The Session is a handle to the complete state of a compilation
179 -- session. A compilation session consists of a set of modules
180 -- constituting the current program or library, the context for
181 -- interactive evaluation, and various caches.
182 data Session = Session !(IORef HscEnv) !(IORef WarningMessages)
184 mkSrcErr :: ErrorMessages -> SourceError
185 srcErrorMessages :: SourceError -> ErrorMessages
186 mkApiErr :: SDoc -> GhcApiError
188 throwOneError :: MonadIO m => ErrMsg -> m ab
189 throwOneError err = liftIO $ throwIO $ mkSrcErr $ unitBag err
191 -- | A source error is an error that is caused by one or more errors in the
192 -- source code. A 'SourceError' is thrown by many functions in the
193 -- compilation pipeline. Inside GHC these errors are merely printed via
194 -- 'log_action', but API clients may treat them differently, for example,
195 -- insert them into a list box. If you want the default behaviour, use the
198 -- > handleSourceError printExceptionAndWarnings $ do
199 -- > ... api calls that may fail ...
201 -- The 'SourceError's error messages can be accessed via 'srcErrorMessages'.
202 -- This list may be empty if the compiler failed due to @-Werror@
203 -- ('Opt_WarnIsError').
205 -- See 'printExceptionAndWarnings' for more information on what to take care
206 -- of when writing a custom error handler.
207 data SourceError = SourceError ErrorMessages
209 instance Show SourceError where
210 show (SourceError msgs) = unlines . map show . bagToList $ msgs
211 -- ToDo: is there some nicer way to print this?
213 sourceErrorTc :: Dyn.TyCon
214 sourceErrorTc = Dyn.mkTyCon "SourceError"
215 {-# NOINLINE sourceErrorTc #-}
216 instance Typeable SourceError where
217 typeOf _ = Dyn.mkTyConApp sourceErrorTc []
219 instance Exception SourceError
221 mkSrcErr = SourceError
223 -- | Perform the given action and call the exception handler if the action
224 -- throws a 'SourceError'. See 'SourceError' for more information.
225 handleSourceError :: (ExceptionMonad m) =>
226 (SourceError -> m a) -- ^ exception handler
227 -> m a -- ^ action to perform
229 handleSourceError handler act =
230 gcatch act (\(e :: SourceError) -> handler e)
232 srcErrorMessages (SourceError msgs) = msgs
234 -- | XXX: what exactly is an API error?
235 data GhcApiError = GhcApiError SDoc
237 instance Show GhcApiError where
238 show (GhcApiError msg) = showSDoc msg
240 ghcApiErrorTc :: Dyn.TyCon
241 ghcApiErrorTc = Dyn.mkTyCon "GhcApiError"
242 {-# NOINLINE ghcApiErrorTc #-}
243 instance Typeable GhcApiError where
244 typeOf _ = Dyn.mkTyConApp ghcApiErrorTc []
246 instance Exception GhcApiError
248 mkApiErr = GhcApiError
250 -- | A monad that allows logging of warnings.
251 class Monad m => WarnLogMonad m where
252 setWarnings :: WarningMessages -> m ()
253 getWarnings :: m WarningMessages
255 logWarnings :: WarnLogMonad m => WarningMessages -> m ()
256 logWarnings warns = do
257 warns0 <- getWarnings
258 setWarnings (unionBags warns warns0)
260 -- | Clear the log of 'Warnings'.
261 clearWarnings :: WarnLogMonad m => m ()
262 clearWarnings = setWarnings emptyBag
264 -- | Returns true if there were any warnings.
265 hasWarnings :: WarnLogMonad m => m Bool
266 hasWarnings = getWarnings >>= return . not . isEmptyBag
268 -- | A monad that has all the features needed by GHC API calls.
270 -- In short, a GHC monad
272 -- - allows embedding of IO actions,
274 -- - can log warnings,
276 -- - allows handling of (extensible) exceptions, and
278 -- - maintains a current session.
280 -- If you do not use 'Ghc' or 'GhcT', make sure to call 'GHC.initGhcMonad'
281 -- before any call to the GHC API functions can occur.
283 class (Functor m, MonadIO m, WarnLogMonad m, ExceptionMonad m)
285 getSession :: m HscEnv
286 setSession :: HscEnv -> m ()
288 -- | Call the argument with the current session.
289 withSession :: GhcMonad m => (HscEnv -> m a) -> m a
290 withSession f = getSession >>= f
292 -- | Set the current session to the result of applying the current session to
294 modifySession :: GhcMonad m => (HscEnv -> HscEnv) -> m ()
295 modifySession f = do h <- getSession
298 withSavedSession :: GhcMonad m => m a -> m a
299 withSavedSession m = do
300 saved_session <- getSession
301 m `gfinally` setSession saved_session
303 -- | Call an action with a temporarily modified Session.
304 withTempSession :: GhcMonad m => (HscEnv -> HscEnv) -> m a -> m a
305 withTempSession f m =
306 withSavedSession $ modifySession f >> m
308 -- | A minimal implementation of a 'GhcMonad'. If you need a custom monad,
309 -- e.g., to maintain additional state consider wrapping this monad or using
311 newtype Ghc a = Ghc { unGhc :: Session -> IO a }
313 instance Functor Ghc where
314 fmap f m = Ghc $ \s -> f `fmap` unGhc m s
316 instance Monad Ghc where
317 return a = Ghc $ \_ -> return a
318 m >>= g = Ghc $ \s -> do a <- unGhc m s; unGhc (g a) s
320 instance MonadIO Ghc where
321 liftIO ioA = Ghc $ \_ -> ioA
323 instance ExceptionMonad Ghc where
325 Ghc $ \s -> unGhc act s `gcatch` \e -> unGhc (handle e) s
326 gblock (Ghc m) = Ghc $ \s -> gblock (m s)
327 gunblock (Ghc m) = Ghc $ \s -> gunblock (m s)
329 instance WarnLogMonad Ghc where
330 setWarnings warns = Ghc $ \(Session _ wref) -> writeIORef wref warns
331 -- | Return 'Warnings' accumulated so far.
332 getWarnings = Ghc $ \(Session _ wref) -> readIORef wref
334 instance GhcMonad Ghc where
335 getSession = Ghc $ \(Session r _) -> readIORef r
336 setSession s' = Ghc $ \(Session r _) -> writeIORef r s'
338 -- | A monad transformer to add GHC specific features to another monad.
340 -- Note that the wrapped monad must support IO and handling of exceptions.
341 newtype GhcT m a = GhcT { unGhcT :: Session -> m a }
342 liftGhcT :: Monad m => m a -> GhcT m a
343 liftGhcT m = GhcT $ \_ -> m
345 instance Functor m => Functor (GhcT m) where
346 fmap f m = GhcT $ \s -> f `fmap` unGhcT m s
348 instance Monad m => Monad (GhcT m) where
349 return x = GhcT $ \_ -> return x
350 m >>= k = GhcT $ \s -> do a <- unGhcT m s; unGhcT (k a) s
352 instance MonadIO m => MonadIO (GhcT m) where
353 liftIO ioA = GhcT $ \_ -> liftIO ioA
355 instance ExceptionMonad m => ExceptionMonad (GhcT m) where
357 GhcT $ \s -> unGhcT act s `gcatch` \e -> unGhcT (handle e) s
358 gblock (GhcT m) = GhcT $ \s -> gblock (m s)
359 gunblock (GhcT m) = GhcT $ \s -> gunblock (m s)
361 instance MonadIO m => WarnLogMonad (GhcT m) where
362 setWarnings warns = GhcT $ \(Session _ wref) -> liftIO $ writeIORef wref warns
363 -- | Return 'Warnings' accumulated so far.
364 getWarnings = GhcT $ \(Session _ wref) -> liftIO $ readIORef wref
366 instance (Functor m, ExceptionMonad m, MonadIO m) => GhcMonad (GhcT m) where
367 getSession = GhcT $ \(Session r _) -> liftIO $ readIORef r
368 setSession s' = GhcT $ \(Session r _) -> liftIO $ writeIORef r s'
370 -- | Lift an IO action returning errors messages into a 'GhcMonad'.
372 -- In order to reduce dependencies to other parts of the compiler, functions
373 -- outside the "main" parts of GHC return warnings and errors as a parameter
374 -- and signal success via by wrapping the result in a 'Maybe' type. This
375 -- function logs the returned warnings and propagates errors as exceptions
376 -- (of type 'SourceError').
378 -- This function assumes the following invariants:
380 -- 1. If the second result indicates success (is of the form 'Just x'),
381 -- there must be no error messages in the first result.
383 -- 2. If there are no error messages, but the second result indicates failure
384 -- there should be warnings in the first result. That is, if the action
385 -- failed, it must have been due to the warnings (i.e., @-Werror@).
386 ioMsgMaybe :: GhcMonad m =>
387 IO (Messages, Maybe a) -> m a
389 ((warns,errs), mb_r) <- liftIO ioA
392 Nothing -> liftIO $ throwIO (mkSrcErr errs)
393 Just r -> ASSERT( isEmptyBag errs ) return r
395 -- | Lift a non-failing IO action into a 'GhcMonad'.
397 -- Like 'ioMsgMaybe', but assumes that the action will never return any error
399 ioMsg :: GhcMonad m => IO (Messages, a) -> m a
401 ((warns,errs), r) <- liftIO ioA
403 ASSERT( isEmptyBag errs ) return r
405 -- | Reflect a computation in the 'Ghc' monad into the 'IO' monad.
407 -- You can use this to call functions returning an action in the 'Ghc' monad
408 -- inside an 'IO' action. This is needed for some (too restrictive) callback
409 -- arguments of some library functions:
411 -- > libFunc :: String -> (Int -> IO a) -> IO a
412 -- > ghcFunc :: Int -> Ghc a
414 -- > ghcFuncUsingLibFunc :: String -> Ghc a -> Ghc a
415 -- > ghcFuncUsingLibFunc str =
416 -- > reifyGhc $ \s ->
417 -- > libFunc $ \i -> do
418 -- > reflectGhc (ghcFunc i) s
420 reflectGhc :: Ghc a -> Session -> IO a
421 reflectGhc m = unGhc m
423 -- > Dual to 'reflectGhc'. See its documentation.
424 reifyGhc :: (Session -> IO a) -> Ghc a
425 reifyGhc act = Ghc $ act
427 handleFlagWarnings :: GhcMonad m => DynFlags -> [Located String] -> m ()
428 handleFlagWarnings dflags warns
429 = when (dopt Opt_WarnDeprecatedFlags dflags)
430 (handleFlagWarnings' dflags warns)
432 handleFlagWarnings' :: GhcMonad m => DynFlags -> [Located String] -> m ()
433 handleFlagWarnings' _ [] = return ()
434 handleFlagWarnings' dflags warns
435 = do -- It would be nicer if warns :: [Located Message], but that has circular
437 logWarnings $ listToBag (map mkFlagWarning warns)
438 when (dopt Opt_WarnIsError dflags) $
439 liftIO $ throwIO $ mkSrcErr emptyBag
441 mkFlagWarning :: Located String -> WarnMsg
442 mkFlagWarning (L loc warn)
443 = mkPlainWarnMsg loc (text warn)
447 -- | These functions are called in various places of the GHC API.
449 -- API clients can override any of these callbacks to change GHC's default
454 -- | Called by 'load' after the compilating of each module.
456 -- The default implementation simply prints all warnings and errors to
457 -- @stderr@. Don't forget to call 'clearWarnings' when implementing your
460 -- The first argument is the module that was compiled.
462 -- The second argument is @Nothing@ if no errors occured, but there may
463 -- have been warnings. If it is @Just err@ at least one error has
464 -- occured. If 'srcErrorMessages' is empty, compilation failed due to
466 reportModuleCompilationResult :: GhcMonad m =>
467 ModSummary -> Maybe SourceError
471 -- | Temporarily modify the callbacks. After the action is executed all
472 -- callbacks are reset (not, however, any other modifications to the session
474 withLocalCallbacks :: GhcMonad m =>
475 (GhcApiCallbacks -> GhcApiCallbacks)
477 withLocalCallbacks f m = do
478 hsc_env <- getSession
479 let cb0 = hsc_callbacks hsc_env
481 setSession (hsc_env { hsc_callbacks = cb' `seq` cb' })
483 hsc_env' <- getSession
484 setSession (hsc_env' { hsc_callbacks = cb0 })
490 -- | Hscenv is like 'Session', except that some of the fields are immutable.
491 -- An HscEnv is used to compile a single module from plain Haskell source
492 -- code (after preprocessing) to either C, assembly or C--. Things like
493 -- the module graph don't change during a single compilation.
495 -- Historical note: \"hsc\" used to be the name of the compiler binary,
496 -- when there was a separate driver and compiler. To compile a single
497 -- module, the driver would invoke hsc on the source code... so nowadays
498 -- we think of hsc as the layer of the compiler that deals with compiling
502 hsc_dflags :: DynFlags,
503 -- ^ The dynamic flag settings
505 hsc_callbacks :: GhcApiCallbacks,
506 -- ^ Callbacks for the GHC API.
508 hsc_targets :: [Target],
509 -- ^ The targets (or roots) of the current session
511 hsc_mod_graph :: ModuleGraph,
512 -- ^ The module graph of the current session
514 hsc_IC :: InteractiveContext,
515 -- ^ The context for evaluating interactive statements
517 hsc_HPT :: HomePackageTable,
518 -- ^ The home package table describes already-compiled
519 -- home-package modules, /excluding/ the module we
520 -- are compiling right now.
521 -- (In one-shot mode the current module is the only
522 -- home-package module, so hsc_HPT is empty. All other
523 -- modules count as \"external-package\" modules.
524 -- However, even in GHCi mode, hi-boot interfaces are
525 -- demand-loaded into the external-package table.)
527 -- 'hsc_HPT' is not mutable because we only demand-load
528 -- external packages; the home package is eagerly
529 -- loaded, module by module, by the compilation manager.
531 -- The HPT may contain modules compiled earlier by @--make@
532 -- but not actually below the current module in the dependency
535 -- (This changes a previous invariant: changed Jan 05.)
537 hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
538 -- ^ Information about the currently loaded external packages.
539 -- This is mutable because packages will be demand-loaded during
540 -- a compilation run as required.
542 hsc_NC :: {-# UNPACK #-} !(IORef NameCache),
543 -- ^ As with 'hsc_EPS', this is side-effected by compiling to
544 -- reflect sucking in interface files. They cache the state of
545 -- external interface files, in effect.
547 hsc_FC :: {-# UNPACK #-} !(IORef FinderCache),
548 -- ^ The cached result of performing finding in the file system
549 hsc_MLC :: {-# UNPACK #-} !(IORef ModLocationCache),
550 -- ^ This caches the location of modules, so we don't have to
551 -- search the filesystem multiple times. See also 'hsc_FC'.
553 hsc_OptFuel :: OptFuelState,
554 -- ^ Settings to control the use of \"optimization fuel\":
555 -- by limiting the number of transformations,
556 -- we can use binary search to help find compiler bugs.
558 hsc_type_env_var :: Maybe (Module, IORef TypeEnv),
559 -- ^ Used for one-shot compilation only, to initialise
560 -- the 'IfGblEnv'. See 'TcRnTypes.tcg_type_env_var' for
561 -- 'TcRunTypes.TcGblEnv'
563 hsc_global_rdr_env :: GlobalRdrEnv,
564 -- ^ A mapping from 'RdrName's that are in global scope during
565 -- the compilation of the current file to more detailed
566 -- information about those names. Not necessarily just the
567 -- names directly imported by the module being compiled!
569 hsc_global_type_env :: TypeEnv
570 -- ^ Typing information about all those things in global scope.
571 -- Not necessarily just the things directly imported by the module
575 hscEPS :: HscEnv -> IO ExternalPackageState
576 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
578 -- | A compilation target.
580 -- A target may be supplied with the actual text of the
581 -- module. If so, use this instead of the file contents (this
582 -- is for use in an IDE where the file hasn't been saved by
585 { targetId :: TargetId -- ^ module or filename
586 , targetAllowObjCode :: Bool -- ^ object code allowed?
587 , targetContents :: Maybe (StringBuffer,ClockTime)
588 -- ^ in-memory text buffer?
592 = TargetModule ModuleName
593 -- ^ A module name: search for the file
594 | TargetFile FilePath (Maybe Phase)
595 -- ^ A filename: preprocess & parse it to find the module name.
596 -- If specified, the Phase indicates how to compile this file
597 -- (which phase to start from). Nothing indicates the starting phase
598 -- should be determined from the suffix of the filename.
601 pprTarget :: Target -> SDoc
602 pprTarget (Target id obj _) =
603 (if obj then char '*' else empty) <> pprTargetId id
605 instance Outputable Target where
608 pprTargetId :: TargetId -> SDoc
609 pprTargetId (TargetModule m) = ppr m
610 pprTargetId (TargetFile f _) = text f
612 instance Outputable TargetId where
615 -- | Helps us find information about modules in the home package
616 type HomePackageTable = ModuleNameEnv HomeModInfo
617 -- Domain = modules in the home package that have been fully compiled
618 -- "home" package name cached here for convenience
620 -- | Helps us find information about modules in the imported packages
621 type PackageIfaceTable = ModuleEnv ModIface
622 -- Domain = modules in the imported packages
624 emptyHomePackageTable :: HomePackageTable
625 emptyHomePackageTable = emptyUFM
627 emptyPackageIfaceTable :: PackageIfaceTable
628 emptyPackageIfaceTable = emptyModuleEnv
630 -- | Information about modules in the package being compiled
633 hm_iface :: !ModIface,
634 -- ^ The basic loaded interface file: every loaded module has one of
635 -- these, even if it is imported from another package
636 hm_details :: !ModDetails,
637 -- ^ Extra information that has been created from the 'ModIface' for
638 -- the module, typically during typechecking
639 hm_linkable :: !(Maybe Linkable)
640 -- ^ The actual artifact we would like to link to access things in
643 -- 'hm_linkable' might be Nothing:
645 -- 1. If this is an .hs-boot module
647 -- 2. Temporarily during compilation if we pruned away
648 -- the old linkable because it was out of date.
650 -- After a complete compilation ('GHC.load'), all 'hm_linkable' fields
651 -- in the 'HomePackageTable' will be @Just@.
653 -- When re-linking a module ('HscMain.HscNoRecomp'), we construct the
654 -- 'HomeModInfo' by building a new 'ModDetails' from the old
655 -- 'ModIface' (only).
658 -- | Find the 'ModIface' for a 'Module', searching in both the loaded home
659 -- and external package module information
666 lookupIfaceByModule dflags hpt pit mod
667 | modulePackageId mod == thisPackage dflags
668 = -- The module comes from the home package, so look first
669 -- in the HPT. If it's not from the home package it's wrong to look
670 -- in the HPT, because the HPT is indexed by *ModuleName* not Module
671 fmap hm_iface (lookupUFM hpt (moduleName mod))
672 `mplus` lookupModuleEnv pit mod
674 | otherwise = lookupModuleEnv pit mod -- Look in PIT only
676 -- If the module does come from the home package, why do we look in the PIT as well?
677 -- (a) In OneShot mode, even home-package modules accumulate in the PIT
678 -- (b) Even in Batch (--make) mode, there is *one* case where a home-package
679 -- module is in the PIT, namely GHC.Prim when compiling the base package.
680 -- We could eliminate (b) if we wanted, by making GHC.Prim belong to a package
681 -- of its own, but it doesn't seem worth the bother.
686 hptInstances :: HscEnv -> (ModuleName -> Bool) -> ([Instance], [FamInst])
687 -- ^ Find all the instance declarations (of classes and families) that are in
688 -- modules imported by this one, directly or indirectly, and are in the Home
689 -- Package Table. This ensures that we don't see instances from modules @--make@
690 -- compiled before this one, but which are not below this one.
691 hptInstances hsc_env want_this_module
692 = let (insts, famInsts) = unzip $ flip hptAllThings hsc_env $ \mod_info -> do
693 guard (want_this_module (moduleName (mi_module (hm_iface mod_info))))
694 let details = hm_details mod_info
695 return (md_insts details, md_fam_insts details)
696 in (concat insts, concat famInsts)
698 hptVectInfo :: HscEnv -> VectInfo
699 -- ^ Get the combined VectInfo of all modules in the home package table. In
700 -- contrast to instances and rules, we don't care whether the modules are
701 -- \"below\" us in the dependency sense. The VectInfo of those modules not \"below\"
702 -- us does not affect the compilation of the current module.
703 hptVectInfo = concatVectInfo . hptAllThings ((: []) . md_vect_info . hm_details)
705 hptRules :: HscEnv -> [(ModuleName, IsBootInterface)] -> [CoreRule]
706 -- ^ Get rules from modules \"below\" this one (in the dependency sense)
707 hptRules = hptSomeThingsBelowUs (md_rules . hm_details) False
710 hptAnns :: HscEnv -> Maybe [(ModuleName, IsBootInterface)] -> [Annotation]
711 -- ^ Get annotations from modules \"below\" this one (in the dependency sense)
712 hptAnns hsc_env (Just deps) = hptSomeThingsBelowUs (md_anns . hm_details) False hsc_env deps
713 hptAnns hsc_env Nothing = hptAllThings (md_anns . hm_details) hsc_env
715 hptAllThings :: (HomeModInfo -> [a]) -> HscEnv -> [a]
716 hptAllThings extract hsc_env = concatMap extract (eltsUFM (hsc_HPT hsc_env))
718 hptSomeThingsBelowUs :: (HomeModInfo -> [a]) -> Bool -> HscEnv -> [(ModuleName, IsBootInterface)] -> [a]
719 -- Get things from modules \"below\" this one (in the dependency sense)
720 -- C.f Inst.hptInstances
721 hptSomeThingsBelowUs extract include_hi_boot hsc_env deps
722 | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
725 hpt = hsc_HPT hsc_env
728 | -- Find each non-hi-boot module below me
729 (mod, is_boot_mod) <- deps
730 , include_hi_boot || not is_boot_mod
732 -- unsavoury: when compiling the base package with --make, we
733 -- sometimes try to look up RULES etc for GHC.Prim. GHC.Prim won't
734 -- be in the HPT, because we never compile it; it's in the EPT
735 -- instead. ToDo: clean up, and remove this slightly bogus
737 , mod /= moduleName gHC_PRIM
739 -- Look it up in the HPT
740 , let things = case lookupUFM hpt mod of
741 Just info -> extract info
742 Nothing -> pprTrace "WARNING in hptSomeThingsBelowUs" msg []
743 msg = vcat [ptext (sLit "missing module") <+> ppr mod,
744 ptext (sLit "Probable cause: out-of-date interface files")]
745 -- This really shouldn't happen, but see Trac #962
751 %************************************************************************
753 \subsection{Dealing with Annotations}
755 %************************************************************************
758 prepareAnnotations :: HscEnv -> Maybe ModGuts -> IO AnnEnv
759 -- ^ Deal with gathering annotations in from all possible places
760 -- and combining them into a single 'AnnEnv'
761 prepareAnnotations hsc_env mb_guts
762 = do { eps <- hscEPS hsc_env
763 ; let -- Extract annotations from the module being compiled if supplied one
764 mb_this_module_anns = fmap (mkAnnEnv . mg_anns) mb_guts
765 -- Extract dependencies of the module if we are supplied one,
766 -- otherwise load annotations from all home package table
767 -- entries regardless of dependency ordering.
768 home_pkg_anns = (mkAnnEnv . hptAnns hsc_env) $ fmap (dep_mods . mg_deps) mb_guts
769 other_pkg_anns = eps_ann_env eps
770 ann_env = foldl1' plusAnnEnv $ catMaybes [mb_this_module_anns,
777 %************************************************************************
779 \subsection{The Finder cache}
781 %************************************************************************
784 -- | The 'FinderCache' maps home module names to the result of
785 -- searching for that module. It records the results of searching for
786 -- modules along the search path. On @:load@, we flush the entire
787 -- contents of this cache.
789 -- Although the @FinderCache@ range is 'FindResult' for convenience ,
790 -- in fact it will only ever contain 'Found' or 'NotFound' entries.
792 type FinderCache = ModuleNameEnv FindResult
794 -- | The result of searching for an imported module.
796 = Found ModLocation Module
797 -- ^ The module was found
798 | NoPackage PackageId
799 -- ^ The requested package was not found
800 | FoundMultiple [PackageId]
801 -- ^ _Error_: both in multiple packages
802 | NotFound [FilePath] (Maybe PackageId) [PackageId] [PackageId]
803 -- ^ The module was not found, including either
804 -- * the specified places were searched
805 -- * the package that this module should have been in
806 -- * list of packages in which the module was hidden,
807 -- * list of hidden packages containing this module
808 | NotFoundInPackage PackageId
809 -- ^ The module was not found in this package
811 -- | Cache that remembers where we found a particular module. Contains both
812 -- home modules and package modules. On @:load@, only home modules are
813 -- purged from this cache.
814 type ModLocationCache = ModuleEnv ModLocation
817 %************************************************************************
819 \subsection{Symbol tables and Module details}
821 %************************************************************************
824 -- | A 'ModIface' plus a 'ModDetails' summarises everything we know
825 -- about a compiled module. The 'ModIface' is the stuff *before* linking,
826 -- and can be written out to an interface file. The 'ModDetails is after
827 -- linking and can be completely recovered from just the 'ModIface'.
829 -- When we read an interface file, we also construct a 'ModIface' from it,
830 -- except that we explicitly make the 'mi_decls' and a few other fields empty;
831 -- as when reading we consolidate the declarations etc. into a number of indexed
832 -- maps and environments in the 'ExternalPackageState'.
835 mi_module :: !Module, -- ^ Name of the module we are for
836 mi_iface_hash :: !Fingerprint, -- ^ Hash of the whole interface
837 mi_mod_hash :: !Fingerprint, -- ^ Hash of the ABI only
839 mi_orphan :: !WhetherHasOrphans, -- ^ Whether this module has orphans
840 mi_finsts :: !WhetherHasFamInst, -- ^ Whether this module has family instances
841 mi_boot :: !IsBootInterface, -- ^ Read from an hi-boot file?
843 mi_deps :: Dependencies,
844 -- ^ The dependencies of the module. This is
845 -- consulted for directly-imported modules, but not
846 -- for anything else (hence lazy)
848 mi_usages :: [Usage],
849 -- ^ Usages; kept sorted so that it's easy to decide
850 -- whether to write a new iface file (changing usages
851 -- doesn't affect the hash of this module)
853 -- NOT STRICT! we read this field lazily from the interface file
854 -- It is *only* consulted by the recompilation checker
857 -- Kept sorted by (mod,occ), to make version comparisons easier
858 mi_exports :: ![IfaceExport],
859 -- ^ Records the modules that are the declaration points for things
860 -- exported by this module, and the 'OccName's of those things
862 mi_exp_hash :: !Fingerprint, -- ^ Hash of export list
864 mi_fixities :: [(OccName,Fixity)],
867 -- NOT STRICT! we read this field lazily from the interface file
869 mi_warns :: Warnings,
872 -- NOT STRICT! we read this field lazily from the interface file
874 mi_anns :: [IfaceAnnotation],
877 -- NOT STRICT! we read this field lazily from the interface file
879 -- Type, class and variable declarations
880 -- The hash of an Id changes if its fixity or deprecations change
881 -- (as well as its type of course)
882 -- Ditto data constructors, class operations, except that
883 -- the hash of the parent class/tycon changes
884 mi_decls :: [(Fingerprint,IfaceDecl)], -- ^ Sorted type, variable, class etc. declarations
886 mi_globals :: !(Maybe GlobalRdrEnv),
887 -- ^ Binds all the things defined at the top level in
888 -- the /original source/ code for this module. which
889 -- is NOT the same as mi_exports, nor mi_decls (which
890 -- may contains declarations for things not actually
891 -- defined by the user). Used for GHCi and for inspecting
892 -- the contents of modules via the GHC API only.
894 -- (We need the source file to figure out the
895 -- top-level environment, if we didn't compile this module
896 -- from source then this field contains @Nothing@).
898 -- Strictly speaking this field should live in the
899 -- 'HomeModInfo', but that leads to more plumbing.
901 -- Instance declarations and rules
902 mi_insts :: [IfaceInst], -- ^ Sorted class instance
903 mi_fam_insts :: [IfaceFamInst], -- ^ Sorted family instances
904 mi_rules :: [IfaceRule], -- ^ Sorted rules
905 mi_orphan_hash :: !Fingerprint, -- ^ Hash for orphan rules and
906 -- class and family instances
909 mi_vect_info :: !IfaceVectInfo, -- ^ Vectorisation information
911 -- Cached environments for easy lookup
912 -- These are computed (lazily) from other fields
913 -- and are not put into the interface file
914 mi_warn_fn :: Name -> Maybe WarningTxt, -- ^ Cached lookup for 'mi_warns'
915 mi_fix_fn :: OccName -> Fixity, -- ^ Cached lookup for 'mi_fixities'
916 mi_hash_fn :: OccName -> Maybe (OccName, Fingerprint),
917 -- ^ Cached lookup for 'mi_decls'.
918 -- The @Nothing@ in 'mi_hash_fn' means that the thing
919 -- isn't in decls. It's useful to know that when
920 -- seeing if we are up to date wrt. the old interface.
921 -- The 'OccName' is the parent of the name, if it has one.
922 mi_hpc :: !AnyHpcUsage
923 -- ^ True if this program uses Hpc at any point in the program.
926 -- | The 'ModDetails' is essentially a cache for information in the 'ModIface'
927 -- for home modules only. Information relating to packages will be loaded into
928 -- global environments in 'ExternalPackageState'.
931 -- The next two fields are created by the typechecker
932 md_exports :: [AvailInfo],
933 md_types :: !TypeEnv, -- ^ Local type environment for this particular module
934 md_insts :: ![Instance], -- ^ 'DFunId's for the instances in this module
935 md_fam_insts :: ![FamInst],
936 md_rules :: ![CoreRule], -- ^ Domain may include 'Id's from other modules
937 md_anns :: ![Annotation], -- ^ Annotations present in this module: currently
938 -- they only annotate things also declared in this module
939 md_vect_info :: !VectInfo -- ^ Module vectorisation information
942 emptyModDetails :: ModDetails
943 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
949 md_vect_info = noVectInfo
952 -- | Records the modules directly imported by a module for extracting e.g. usage information
953 type ImportedMods = ModuleEnv [(ModuleName, Bool, SrcSpan)]
954 -- TODO: we are not actually using the codomain of this type at all, so it can be
955 -- replaced with ModuleEnv ()
957 -- | A ModGuts is carried through the compiler, accumulating stuff as it goes
958 -- There is only one ModGuts at any time, the one for the module
959 -- being compiled right now. Once it is compiled, a 'ModIface' and
960 -- 'ModDetails' are extracted and the ModGuts is dicarded.
963 mg_module :: !Module, -- ^ Module being compiled
964 mg_boot :: IsBootInterface, -- ^ Whether it's an hs-boot module
965 mg_exports :: ![AvailInfo], -- ^ What it exports
966 mg_deps :: !Dependencies, -- ^ What it depends on, directly or
968 mg_dir_imps :: !ImportedMods, -- ^ Directly-imported modules; used to
969 -- generate initialisation code
970 mg_used_names:: !NameSet, -- ^ What the module needed (used in 'MkIface.mkIface')
972 mg_rdr_env :: !GlobalRdrEnv, -- ^ Top-level lexical environment
974 -- These fields all describe the things **declared in this module**
975 mg_fix_env :: !FixityEnv, -- ^ Fixities declared in this module
976 -- TODO: I'm unconvinced this is actually used anywhere
977 mg_types :: !TypeEnv, -- ^ Types declared in this module
978 mg_insts :: ![Instance], -- ^ Class instances declared in this module
979 mg_fam_insts :: ![FamInst], -- ^ Family instances declared in this module
980 mg_rules :: ![CoreRule], -- ^ Before the core pipeline starts, contains
981 -- See Note [Overall plumbing for rules] in Rules.lhs
982 mg_binds :: ![CoreBind], -- ^ Bindings for this module
983 mg_foreign :: !ForeignStubs, -- ^ Foreign exports declared in this module
984 mg_warns :: !Warnings, -- ^ Warnings declared in the module
985 mg_anns :: [Annotation], -- ^ Annotations declared in this module
986 mg_hpc_info :: !HpcInfo, -- ^ Coverage tick boxes in the module
987 mg_modBreaks :: !ModBreaks, -- ^ Breakpoints for the module
988 mg_vect_info :: !VectInfo, -- ^ Pool of vectorised declarations in the module
990 -- The next two fields are unusual, because they give instance
991 -- environments for *all* modules in the home package, including
992 -- this module, rather than for *just* this module.
993 -- Reason: when looking up an instance we don't want to have to
994 -- look at each module in the home package in turn
995 mg_inst_env :: InstEnv,
996 -- ^ Class instance environment from /home-package/ modules (including
997 -- this one); c.f. 'tcg_inst_env'
998 mg_fam_inst_env :: FamInstEnv
999 -- ^ Type-family instance enviroment for /home-package/ modules
1000 -- (including this one); c.f. 'tcg_fam_inst_env'
1003 -- The ModGuts takes on several slightly different forms:
1005 -- After simplification, the following fields change slightly:
1006 -- mg_rules Orphan rules only (local ones now attached to binds)
1007 -- mg_binds With rules attached
1009 -- | A CoreModule consists of just the fields of a 'ModGuts' that are needed for
1010 -- the 'GHC.compileToCoreModule' interface.
1014 cm_module :: !Module,
1015 -- | Type environment for types declared in this module
1016 cm_types :: !TypeEnv,
1018 cm_binds :: [CoreBind],
1020 cm_imports :: ![Module]
1023 instance Outputable CoreModule where
1024 ppr (CoreModule {cm_module = mn, cm_types = te, cm_binds = cb}) =
1025 text "%module" <+> ppr mn <+> ppr te $$ vcat (map ppr cb)
1027 -- The ModGuts takes on several slightly different forms:
1029 -- After simplification, the following fields change slightly:
1030 -- mg_rules Orphan rules only (local ones now attached to binds)
1031 -- mg_binds With rules attached
1034 ---------------------------------------------------------
1035 -- The Tidy pass forks the information about this module:
1036 -- * one lot goes to interface file generation (ModIface)
1037 -- and later compilations (ModDetails)
1038 -- * the other lot goes to code generation (CgGuts)
1040 -- | A restricted form of 'ModGuts' for code generation purposes
1043 cg_module :: !Module, -- ^ Module being compiled
1045 cg_tycons :: [TyCon],
1046 -- ^ Algebraic data types (including ones that started
1047 -- life as classes); generate constructors and info
1048 -- tables. Includes newtypes, just for the benefit of
1051 cg_binds :: [CoreBind],
1052 -- ^ The tidied main bindings, including
1053 -- previously-implicit bindings for record and class
1054 -- selectors, and data construtor wrappers. But *not*
1055 -- data constructor workers; reason: we we regard them
1056 -- as part of the code-gen of tycons
1058 cg_dir_imps :: ![Module],
1059 -- ^ Directly-imported modules; used to generate
1060 -- initialisation code
1062 cg_foreign :: !ForeignStubs, -- ^ Foreign export stubs
1063 cg_dep_pkgs :: ![PackageId], -- ^ Dependent packages, used to
1064 -- generate #includes for C code gen
1065 cg_hpc_info :: !HpcInfo, -- ^ Program coverage tick box information
1066 cg_modBreaks :: !ModBreaks -- ^ Module breakpoints
1069 -----------------------------------
1070 -- | Foreign export stubs
1071 data ForeignStubs = NoStubs -- ^ We don't have any stubs
1075 -- ^ There are some stubs. Parameters:
1077 -- 1) Header file prototypes for
1078 -- "foreign exported" functions
1080 -- 2) C stubs to use when calling
1081 -- "foreign exported" functions
1085 emptyModIface :: Module -> ModIface
1087 = ModIface { mi_module = mod,
1088 mi_iface_hash = fingerprint0,
1089 mi_mod_hash = fingerprint0,
1093 mi_deps = noDependencies,
1096 mi_exp_hash = fingerprint0,
1098 mi_warns = NoWarnings,
1104 mi_globals = Nothing,
1105 mi_orphan_hash = fingerprint0,
1106 mi_vect_info = noIfaceVectInfo,
1107 mi_warn_fn = emptyIfaceWarnCache,
1108 mi_fix_fn = emptyIfaceFixCache,
1109 mi_hash_fn = emptyIfaceHashCache,
1115 %************************************************************************
1117 \subsection{The interactive context}
1119 %************************************************************************
1122 -- | Interactive context, recording information relevant to GHCi
1123 data InteractiveContext
1124 = InteractiveContext {
1125 ic_toplev_scope :: [Module], -- ^ The context includes the "top-level" scope of
1128 ic_exports :: [Module], -- ^ The context includes just the exports of these
1131 ic_rn_gbl_env :: GlobalRdrEnv, -- ^ The contexts' cached 'GlobalRdrEnv', built from
1132 -- 'ic_toplev_scope' and 'ic_exports'
1134 ic_tmp_ids :: [Id], -- ^ Names bound during interaction with the user.
1135 -- Later Ids shadow earlier ones with the same OccName.
1137 ic_tyvars :: TyVarSet -- ^ Skolem type variables free in
1138 -- 'ic_tmp_ids'. These arise at
1139 -- breakpoints in a polymorphic
1140 -- context, where we have only partial
1141 -- type information.
1144 , ic_resume :: [Resume] -- ^ The stack of breakpoint contexts
1147 , ic_cwd :: Maybe FilePath -- virtual CWD of the program
1151 emptyInteractiveContext :: InteractiveContext
1152 emptyInteractiveContext
1153 = InteractiveContext { ic_toplev_scope = [],
1155 ic_rn_gbl_env = emptyGlobalRdrEnv,
1157 ic_tyvars = emptyVarSet
1164 icPrintUnqual :: DynFlags -> InteractiveContext -> PrintUnqualified
1165 icPrintUnqual dflags ictxt = mkPrintUnqualified dflags (ic_rn_gbl_env ictxt)
1168 extendInteractiveContext
1169 :: InteractiveContext
1172 -> InteractiveContext
1173 extendInteractiveContext ictxt ids tyvars
1174 = ictxt { ic_tmp_ids = snub((ic_tmp_ids ictxt \\ ids) ++ ids),
1175 -- NB. must be this way around, because we want
1176 -- new ids to shadow existing bindings.
1177 ic_tyvars = ic_tyvars ictxt `unionVarSet` tyvars }
1178 where snub = map head . group . sort
1180 substInteractiveContext :: InteractiveContext -> TvSubst -> InteractiveContext
1181 substInteractiveContext ictxt subst | isEmptyTvSubst subst = ictxt
1182 substInteractiveContext ictxt@InteractiveContext{ic_tmp_ids=ids} subst =
1183 let ids' = map (\id -> id `setIdType` substTy subst (idType id)) ids
1184 subst_dom= varEnvKeys$ getTvSubstEnv subst
1185 subst_ran= varEnvElts$ getTvSubstEnv subst
1186 new_tvs = [ tv | Just tv <- map getTyVar_maybe subst_ran]
1187 ic_tyvars'= (`delVarSetListByKey` subst_dom)
1188 . (`extendVarSetList` new_tvs)
1190 in ictxt { ic_tmp_ids = ids'
1191 , ic_tyvars = ic_tyvars' }
1193 where delVarSetListByKey = foldl' delVarSetByKey
1196 %************************************************************************
1198 Building a PrintUnqualified
1200 %************************************************************************
1202 Note [Printing original names]
1203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1204 Deciding how to print names is pretty tricky. We are given a name
1205 P:M.T, where P is the package name, M is the defining module, and T is
1206 the occurrence name, and we have to decide in which form to display
1207 the name given a GlobalRdrEnv describing the current scope.
1209 Ideally we want to display the name in the form in which it is in
1210 scope. However, the name might not be in scope at all, and that's
1211 where it gets tricky. Here are the cases:
1213 1. T uniquely maps to P:M.T ---> "T" NameUnqual
1214 2. There is an X for which X.T
1215 uniquely maps to P:M.T ---> "X.T" NameQual X
1216 3. There is no binding for "M.T" ---> "M.T" NameNotInScope1
1217 4. Otherwise ---> "P:M.T" NameNotInScope2
1219 (3) and (4) apply when the entity P:M.T is not in the GlobalRdrEnv at
1220 all. In these cases we still want to refer to the name as "M.T", *but*
1221 "M.T" might mean something else in the current scope (e.g. if there's
1222 an "import X as M"), so to avoid confusion we avoid using "M.T" if
1223 there's already a binding for it. Instead we write P:M.T.
1225 There's one further subtlety: in case (3), what if there are two
1226 things around, P1:M.T and P2:M.T? Then we don't want to print both of
1227 them as M.T! However only one of the modules P1:M and P2:M can be
1228 exposed (say P2), so we use M.T for that, and P1:M.T for the other one.
1229 This is handled by the qual_mod component of PrintUnqualified, inside
1230 the (ppr mod) of case (3), in Name.pprModulePrefix
1233 -- | Creates some functions that work out the best ways to format
1234 -- names for the user according to a set of heuristics
1235 mkPrintUnqualified :: DynFlags -> GlobalRdrEnv -> PrintUnqualified
1236 mkPrintUnqualified dflags env = (qual_name, qual_mod)
1238 qual_name mod occ -- The (mod,occ) pair is the original name of the thing
1239 | [gre] <- unqual_gres, right_name gre = NameUnqual
1240 -- If there's a unique entity that's in scope unqualified with 'occ'
1241 -- AND that entity is the right one, then we can use the unqualified name
1243 | [gre] <- qual_gres = NameQual (get_qual_mod (gre_prov gre))
1246 if null (lookupGRE_RdrName (mkRdrQual (moduleName mod) occ) env)
1247 then NameNotInScope1
1248 else NameNotInScope2
1250 | otherwise = panic "mkPrintUnqualified"
1252 right_name gre = nameModule_maybe (gre_name gre) == Just mod
1254 unqual_gres = lookupGRE_RdrName (mkRdrUnqual occ) env
1255 qual_gres = filter right_name (lookupGlobalRdrEnv env occ)
1257 get_qual_mod LocalDef = moduleName mod
1258 get_qual_mod (Imported is) = ASSERT( not (null is) ) is_as (is_decl (head is))
1260 -- we can mention a module P:M without the P: qualifier iff
1261 -- "import M" would resolve unambiguously to P:M. (if P is the
1262 -- current package we can just assume it is unqualified).
1265 | modulePackageId mod == thisPackage dflags = False
1267 | [pkgconfig] <- [pkg | (pkg,exposed_module) <- lookup,
1268 exposed pkg && exposed_module],
1269 packageConfigId pkgconfig == modulePackageId mod
1270 -- this says: we are given a module P:M, is there just one exposed package
1271 -- that exposes a module M, and is it package P?
1275 where lookup = lookupModuleInAllPackages dflags (moduleName mod)
1279 %************************************************************************
1283 %************************************************************************
1286 -- | Determine the 'TyThing's brought into scope by another 'TyThing'
1287 -- /other/ than itself. For example, Id's don't have any implicit TyThings
1288 -- as they just bring themselves into scope, but classes bring their
1289 -- dictionary datatype, type constructor and some selector functions into
1290 -- scope, just for a start!
1292 -- N.B. the set of TyThings returned here *must* match the set of
1293 -- names returned by LoadIface.ifaceDeclSubBndrs, in the sense that
1294 -- TyThing.getOccName should define a bijection between the two lists.
1295 -- This invariant is used in LoadIface.loadDecl (see note [Tricky iface loop])
1296 -- The order of the list does not matter.
1297 implicitTyThings :: TyThing -> [TyThing]
1299 -- For data and newtype declarations:
1300 implicitTyThings (ATyCon tc)
1301 = -- fields (names of selectors)
1302 -- (possibly) implicit coercion and family coercion
1303 -- depending on whether it's a newtype or a family instance or both
1304 implicitCoTyCon tc ++
1305 -- for each data constructor in order,
1306 -- the contructor, worker, and (possibly) wrapper
1307 concatMap (extras_plus . ADataCon) (tyConDataCons tc)
1309 implicitTyThings (AClass cl)
1310 = -- dictionary datatype:
1313 -- [recursive call:]
1314 -- (possibly) newtype coercion; definitely no family coercion here
1317 -- (no wrapper by invariant)
1318 extras_plus (ATyCon (classTyCon cl)) ++
1320 -- No extras_plus (recursive call) for the classATs, because they
1321 -- are only the family decls; they have no implicit things
1322 map ATyCon (classATs cl) ++
1323 -- superclass and operation selectors
1324 map AnId (classSelIds cl)
1326 implicitTyThings (ADataCon dc) =
1327 -- For data cons add the worker and (possibly) wrapper
1328 map AnId (dataConImplicitIds dc)
1330 implicitTyThings (AnId _) = []
1332 -- add a thing and recursive call
1333 extras_plus :: TyThing -> [TyThing]
1334 extras_plus thing = thing : implicitTyThings thing
1336 -- For newtypes and indexed data types (and both),
1337 -- add the implicit coercion tycon
1338 implicitCoTyCon :: TyCon -> [TyThing]
1340 = map ATyCon . catMaybes $ [-- Just if newtype, Nothing if not
1341 newTyConCo_maybe tc,
1342 -- Just if family instance, Nothing if not
1343 tyConFamilyCoercion_maybe tc]
1345 -- sortByOcc = sortBy (\ x -> \ y -> getOccName x < getOccName y)
1348 -- | Returns @True@ if there should be no interface-file declaration
1349 -- for this thing on its own: either it is built-in, or it is part
1350 -- of some other declaration, or it is generated implicitly by some
1351 -- other declaration.
1352 isImplicitTyThing :: TyThing -> Bool
1353 isImplicitTyThing (ADataCon _) = True
1354 isImplicitTyThing (AnId id) = isImplicitId id
1355 isImplicitTyThing (AClass _) = False
1356 isImplicitTyThing (ATyCon tc) = isImplicitTyCon tc
1358 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
1359 extendTypeEnvWithIds env ids
1360 = extendNameEnvList env [(getName id, AnId id) | id <- ids]
1363 %************************************************************************
1367 %************************************************************************
1370 -- | A map from 'Name's to 'TyThing's, constructed by typechecking
1371 -- local declarations or interface files
1372 type TypeEnv = NameEnv TyThing
1374 emptyTypeEnv :: TypeEnv
1375 typeEnvElts :: TypeEnv -> [TyThing]
1376 typeEnvClasses :: TypeEnv -> [Class]
1377 typeEnvTyCons :: TypeEnv -> [TyCon]
1378 typeEnvIds :: TypeEnv -> [Id]
1379 typeEnvDataCons :: TypeEnv -> [DataCon]
1380 lookupTypeEnv :: TypeEnv -> Name -> Maybe TyThing
1382 emptyTypeEnv = emptyNameEnv
1383 typeEnvElts env = nameEnvElts env
1384 typeEnvClasses env = [cl | AClass cl <- typeEnvElts env]
1385 typeEnvTyCons env = [tc | ATyCon tc <- typeEnvElts env]
1386 typeEnvIds env = [id | AnId id <- typeEnvElts env]
1387 typeEnvDataCons env = [dc | ADataCon dc <- typeEnvElts env]
1389 mkTypeEnv :: [TyThing] -> TypeEnv
1390 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
1392 lookupTypeEnv = lookupNameEnv
1394 -- Extend the type environment
1395 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
1396 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
1398 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
1399 extendTypeEnvList env things = foldl extendTypeEnv env things
1403 -- | Find the 'TyThing' for the given 'Name' by using all the resources
1404 -- at our disposal: the compiled modules in the 'HomePackageTable' and the
1405 -- compiled modules in other packages that live in 'PackageTypeEnv'. Note
1406 -- that this does NOT look up the 'TyThing' in the module being compiled: you
1407 -- have to do that yourself, if desired
1408 lookupType :: DynFlags
1414 lookupType dflags hpt pte name
1415 -- in one-shot, we don't use the HPT
1416 | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg
1417 = do hm <- lookupUFM hpt (moduleName mod) -- Maybe monad
1418 lookupNameEnv (md_types (hm_details hm)) name
1420 = lookupNameEnv pte name
1421 where mod = ASSERT( isExternalName name ) nameModule name
1422 this_pkg = thisPackage dflags
1424 -- | As 'lookupType', but with a marginally easier-to-use interface
1425 -- if you have a 'HscEnv'
1426 lookupTypeHscEnv :: HscEnv -> Name -> IO (Maybe TyThing)
1427 lookupTypeHscEnv hsc_env name = do
1428 eps <- readIORef (hsc_EPS hsc_env)
1429 return $! lookupType dflags hpt (eps_PTE eps) name
1431 dflags = hsc_dflags hsc_env
1432 hpt = hsc_HPT hsc_env
1436 -- | Get the 'TyCon' from a 'TyThing' if it is a type constructor thing. Panics otherwise
1437 tyThingTyCon :: TyThing -> TyCon
1438 tyThingTyCon (ATyCon tc) = tc
1439 tyThingTyCon other = pprPanic "tyThingTyCon" (pprTyThing other)
1441 -- | Get the 'Class' from a 'TyThing' if it is a class thing. Panics otherwise
1442 tyThingClass :: TyThing -> Class
1443 tyThingClass (AClass cls) = cls
1444 tyThingClass other = pprPanic "tyThingClass" (pprTyThing other)
1446 -- | Get the 'DataCon' from a 'TyThing' if it is a data constructor thing. Panics otherwise
1447 tyThingDataCon :: TyThing -> DataCon
1448 tyThingDataCon (ADataCon dc) = dc
1449 tyThingDataCon other = pprPanic "tyThingDataCon" (pprTyThing other)
1451 -- | Get the 'Id' from a 'TyThing' if it is a id *or* data constructor thing. Panics otherwise
1452 tyThingId :: TyThing -> Id
1453 tyThingId (AnId id) = id
1454 tyThingId (ADataCon dc) = dataConWrapId dc
1455 tyThingId other = pprPanic "tyThingId" (pprTyThing other)
1458 %************************************************************************
1460 \subsection{MonadThings and friends}
1462 %************************************************************************
1465 -- | Class that abstracts out the common ability of the monads in GHC
1466 -- to lookup a 'TyThing' in the monadic environment by 'Name'. Provides
1467 -- a number of related convenience functions for accessing particular
1468 -- kinds of 'TyThing'
1469 class Monad m => MonadThings m where
1470 lookupThing :: Name -> m TyThing
1472 lookupId :: Name -> m Id
1473 lookupId = liftM tyThingId . lookupThing
1475 lookupDataCon :: Name -> m DataCon
1476 lookupDataCon = liftM tyThingDataCon . lookupThing
1478 lookupTyCon :: Name -> m TyCon
1479 lookupTyCon = liftM tyThingTyCon . lookupThing
1481 lookupClass :: Name -> m Class
1482 lookupClass = liftM tyThingClass . lookupThing
1486 -- | Constructs cache for the 'mi_hash_fn' field of a 'ModIface'
1487 mkIfaceHashCache :: [(Fingerprint,IfaceDecl)]
1488 -> (OccName -> Maybe (OccName, Fingerprint))
1489 mkIfaceHashCache pairs
1490 = \occ -> lookupOccEnv env occ
1492 env = foldr add_decl emptyOccEnv pairs
1493 add_decl (v,d) env0 = foldr add_imp env1 (ifaceDeclSubBndrs d)
1495 decl_name = ifName d
1496 env1 = extendOccEnv env0 decl_name (decl_name, v)
1497 add_imp bndr env = extendOccEnv env bndr (decl_name, v)
1499 emptyIfaceHashCache :: OccName -> Maybe (OccName, Fingerprint)
1500 emptyIfaceHashCache _occ = Nothing
1503 %************************************************************************
1505 \subsection{Auxiliary types}
1507 %************************************************************************
1509 These types are defined here because they are mentioned in ModDetails,
1510 but they are mostly elaborated elsewhere
1513 ------------------ Warnings -------------------------
1514 -- | Warning information for a module
1516 = NoWarnings -- ^ Nothing deprecated
1517 | WarnAll WarningTxt -- ^ Whole module deprecated
1518 | WarnSome [(OccName,WarningTxt)] -- ^ Some specific things deprecated
1520 -- Only an OccName is needed because
1521 -- (1) a deprecation always applies to a binding
1522 -- defined in the module in which the deprecation appears.
1523 -- (2) deprecations are only reported outside the defining module.
1524 -- this is important because, otherwise, if we saw something like
1526 -- {-# DEPRECATED f "" #-}
1529 -- g = let f = undefined in f
1531 -- we'd need more information than an OccName to know to say something
1532 -- about the use of f in h but not the use of the locally bound f in g
1534 -- however, because we only report about deprecations from the outside,
1535 -- and a module can only export one value called f,
1536 -- an OccName suffices.
1538 -- this is in contrast with fixity declarations, where we need to map
1539 -- a Name to its fixity declaration.
1542 -- | Constructs the cache for the 'mi_warn_fn' field of a 'ModIface'
1543 mkIfaceWarnCache :: Warnings -> Name -> Maybe WarningTxt
1544 mkIfaceWarnCache NoWarnings = \_ -> Nothing
1545 mkIfaceWarnCache (WarnAll t) = \_ -> Just t
1546 mkIfaceWarnCache (WarnSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
1548 emptyIfaceWarnCache :: Name -> Maybe WarningTxt
1549 emptyIfaceWarnCache _ = Nothing
1551 plusWarns :: Warnings -> Warnings -> Warnings
1552 plusWarns d NoWarnings = d
1553 plusWarns NoWarnings d = d
1554 plusWarns _ (WarnAll t) = WarnAll t
1555 plusWarns (WarnAll t) _ = WarnAll t
1556 plusWarns (WarnSome v1) (WarnSome v2) = WarnSome (v1 ++ v2)
1559 -- | A collection of 'AvailInfo' - several things that are \"available\"
1560 type Avails = [AvailInfo]
1561 -- | 'Name'd things that are available
1562 type AvailInfo = GenAvailInfo Name
1563 -- | 'RdrName'd things that are available
1564 type RdrAvailInfo = GenAvailInfo OccName
1566 -- | Records what things are "available", i.e. in scope
1567 data GenAvailInfo name = Avail name -- ^ An ordinary identifier in scope
1569 [name] -- ^ A type or class in scope. Parameters:
1571 -- 1) The name of the type or class
1573 -- 2) The available pieces of type or class.
1574 -- NB: If the type or class is itself
1575 -- to be in scope, it must be in this list.
1576 -- Thus, typically: @AvailTC Eq [Eq, ==, \/=]@
1578 -- Equality used when deciding if the interface has changed
1580 -- | The original names declared of a certain module that are exported
1581 type IfaceExport = (Module, [GenAvailInfo OccName])
1583 availsToNameSet :: [AvailInfo] -> NameSet
1584 availsToNameSet avails = foldr add emptyNameSet avails
1585 where add avail set = addListToNameSet set (availNames avail)
1587 availsToNameEnv :: [AvailInfo] -> NameEnv AvailInfo
1588 availsToNameEnv avails = foldr add emptyNameEnv avails
1589 where add avail env = extendNameEnvList env
1590 (zip (availNames avail) (repeat avail))
1592 -- | Just the main name made available, i.e. not the available pieces
1593 -- of type or class brought into scope by the 'GenAvailInfo'
1594 availName :: GenAvailInfo name -> name
1595 availName (Avail n) = n
1596 availName (AvailTC n _) = n
1598 -- | All names made available by the availability information
1599 availNames :: GenAvailInfo name -> [name]
1600 availNames (Avail n) = [n]
1601 availNames (AvailTC _ ns) = ns
1603 instance Outputable n => Outputable (GenAvailInfo n) where
1606 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
1607 pprAvail (Avail n) = ppr n
1608 pprAvail (AvailTC n ns) = ppr n <> braces (hsep (punctuate comma (map ppr ns)))
1612 -- | Creates cached lookup for the 'mi_fix_fn' field of 'ModIface'
1613 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
1614 mkIfaceFixCache pairs
1615 = \n -> lookupOccEnv env n `orElse` defaultFixity
1617 env = mkOccEnv pairs
1619 emptyIfaceFixCache :: OccName -> Fixity
1620 emptyIfaceFixCache _ = defaultFixity
1622 -- | Fixity environment mapping names to their fixities
1623 type FixityEnv = NameEnv FixItem
1625 -- | Fixity information for an 'Name'. We keep the OccName in the range
1626 -- so that we can generate an interface from it
1627 data FixItem = FixItem OccName Fixity
1629 instance Outputable FixItem where
1630 ppr (FixItem occ fix) = ppr fix <+> ppr occ
1632 emptyFixityEnv :: FixityEnv
1633 emptyFixityEnv = emptyNameEnv
1635 lookupFixity :: FixityEnv -> Name -> Fixity
1636 lookupFixity env n = case lookupNameEnv env n of
1637 Just (FixItem _ fix) -> fix
1638 Nothing -> defaultFixity
1642 %************************************************************************
1644 \subsection{WhatsImported}
1646 %************************************************************************
1649 -- | Records whether a module has orphans. An \"orphan\" is one of:
1651 -- * An instance declaration in a module other than the definition
1652 -- module for one of the type constructors or classes in the instance head
1654 -- * A transformation rule in a module other than the one defining
1655 -- the function in the head of the rule
1656 type WhetherHasOrphans = Bool
1658 -- | Does this module define family instances?
1659 type WhetherHasFamInst = Bool
1661 -- | Did this module originate from a *-boot file?
1662 type IsBootInterface = Bool
1664 -- | Dependency information about modules and packages below this one
1665 -- in the import hierarchy.
1667 -- Invariant: the dependencies of a module @M@ never includes @M@.
1669 -- Invariant: none of the lists contain duplicates.
1671 = Deps { dep_mods :: [(ModuleName, IsBootInterface)]
1672 -- ^ Home-package module dependencies
1673 , dep_pkgs :: [PackageId]
1674 -- ^ External package dependencies
1675 , dep_orphs :: [Module]
1676 -- ^ Orphan modules (whether home or external pkg),
1677 -- *not* including family instance orphans as they
1678 -- are anyway included in 'dep_finsts'
1679 , dep_finsts :: [Module]
1680 -- ^ Modules that contain family instances (whether the
1681 -- instances are from the home or an external package)
1684 -- Equality used only for old/new comparison in MkIface.addVersionInfo
1686 -- See 'TcRnTypes.ImportAvails' for details on dependencies.
1688 noDependencies :: Dependencies
1689 noDependencies = Deps [] [] [] []
1691 -- | Records modules that we depend on by making a direct import from
1693 = UsagePackageModule {
1695 -- ^ External package module depended on
1696 usg_mod_hash :: Fingerprint
1697 } -- ^ Module from another package
1699 usg_mod_name :: ModuleName,
1700 -- ^ Name of the module
1701 usg_mod_hash :: Fingerprint,
1702 -- ^ Cached module fingerprint
1703 usg_entities :: [(OccName,Fingerprint)],
1704 -- ^ Entities we depend on, sorted by occurrence name and fingerprinted.
1705 -- NB: usages are for parent names only, e.g. type constructors
1706 -- but not the associated data constructors.
1707 usg_exports :: Maybe Fingerprint
1708 -- ^ Fingerprint for the export list we used to depend on this module,
1709 -- if we depend on the export list
1710 } -- ^ Module from the current package
1712 -- The export list field is (Just v) if we depend on the export list:
1713 -- i.e. we imported the module directly, whether or not we
1714 -- enumerated the things we imported, or just imported
1716 -- We need to recompile if M's exports change, because
1717 -- if the import was import M, we might now have a name clash
1718 -- in the importing module.
1719 -- if the import was import M(x) M might no longer export x
1720 -- The only way we don't depend on the export list is if we have
1722 -- And of course, for modules that aren't imported directly we don't
1723 -- depend on their export lists
1727 %************************************************************************
1729 The External Package State
1731 %************************************************************************
1734 type PackageTypeEnv = TypeEnv
1735 type PackageRuleBase = RuleBase
1736 type PackageInstEnv = InstEnv
1737 type PackageFamInstEnv = FamInstEnv
1738 type PackageVectInfo = VectInfo
1739 type PackageAnnEnv = AnnEnv
1741 -- | Information about other packages that we have slurped in by reading
1742 -- their interface files
1743 data ExternalPackageState
1745 eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
1746 -- ^ In OneShot mode (only), home-package modules
1747 -- accumulate in the external package state, and are
1748 -- sucked in lazily. For these home-pkg modules
1749 -- (only) we need to record which are boot modules.
1750 -- We set this field after loading all the
1751 -- explicitly-imported interfaces, but before doing
1754 -- The 'ModuleName' part is not necessary, but it's useful for
1755 -- debug prints, and it's convenient because this field comes
1756 -- direct from 'TcRnTypes.imp_dep_mods'
1758 eps_PIT :: !PackageIfaceTable,
1759 -- ^ The 'ModIface's for modules in external packages
1760 -- whose interfaces we have opened.
1761 -- The declarations in these interface files are held in the
1762 -- 'eps_decls', 'eps_inst_env', 'eps_fam_inst_env' and 'eps_rules'
1763 -- fields of this record, not in the 'mi_decls' fields of the
1764 -- interface we have sucked in.
1766 -- What /is/ in the PIT is:
1770 -- * Fingerprint info
1776 -- * Deprecations and warnings
1778 eps_PTE :: !PackageTypeEnv,
1779 -- ^ Result of typechecking all the external package
1780 -- interface files we have sucked in. The domain of
1781 -- the mapping is external-package modules
1783 eps_inst_env :: !PackageInstEnv, -- ^ The total 'InstEnv' accumulated
1784 -- from all the external-package modules
1785 eps_fam_inst_env :: !PackageFamInstEnv,-- ^ The total 'FamInstEnv' accumulated
1786 -- from all the external-package modules
1787 eps_rule_base :: !PackageRuleBase, -- ^ The total 'RuleEnv' accumulated
1788 -- from all the external-package modules
1789 eps_vect_info :: !PackageVectInfo, -- ^ The total 'VectInfo' accumulated
1790 -- from all the external-package modules
1791 eps_ann_env :: !PackageAnnEnv, -- ^ The total 'AnnEnv' accumulated
1792 -- from all the external-package modules
1794 eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv), -- ^ The family instances accumulated from external
1795 -- packages, keyed off the module that declared them
1797 eps_stats :: !EpsStats -- ^ Stastics about what was loaded from external packages
1800 -- | Accumulated statistics about what we are putting into the 'ExternalPackageState'.
1801 -- \"In\" means stuff that is just /read/ from interface files,
1802 -- \"Out\" means actually sucked in and type-checked
1803 data EpsStats = EpsStats { n_ifaces_in
1804 , n_decls_in, n_decls_out
1805 , n_rules_in, n_rules_out
1806 , n_insts_in, n_insts_out :: !Int }
1808 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
1809 -- ^ Add stats for one newly-read interface
1810 addEpsInStats stats n_decls n_insts n_rules
1811 = stats { n_ifaces_in = n_ifaces_in stats + 1
1812 , n_decls_in = n_decls_in stats + n_decls
1813 , n_insts_in = n_insts_in stats + n_insts
1814 , n_rules_in = n_rules_in stats + n_rules }
1817 Names in a NameCache are always stored as a Global, and have the SrcLoc
1818 of their binding locations.
1820 Actually that's not quite right. When we first encounter the original
1821 name, we might not be at its binding site (e.g. we are reading an
1822 interface file); so we give it 'noSrcLoc' then. Later, when we find
1823 its binding site, we fix it up.
1826 -- | The NameCache makes sure that there is just one Unique assigned for
1827 -- each original name; i.e. (module-name, occ-name) pair and provides
1828 -- something of a lookup mechanism for those names.
1830 = NameCache { nsUniqs :: UniqSupply,
1831 -- ^ Supply of uniques
1832 nsNames :: OrigNameCache,
1833 -- ^ Ensures that one original name gets one unique
1834 nsIPs :: OrigIParamCache
1835 -- ^ Ensures that one implicit parameter name gets one unique
1838 -- | Per-module cache of original 'OccName's given 'Name's
1839 type OrigNameCache = ModuleEnv (OccEnv Name)
1841 -- | Module-local cache of implicit parameter 'OccName's given 'Name's
1842 type OrigIParamCache = FiniteMap (IPName OccName) (IPName Name)
1847 %************************************************************************
1849 The module graph and ModSummary type
1850 A ModSummary is a node in the compilation manager's
1851 dependency graph, and it's also passed to hscMain
1853 %************************************************************************
1856 -- | A ModuleGraph contains all the nodes from the home package (only).
1857 -- There will be a node for each source module, plus a node for each hi-boot
1860 -- The graph is not necessarily stored in topologically-sorted order. Use
1861 -- 'GHC.topSortModuleGraph' and 'Digraph.flattenSCC' to achieve this.
1862 type ModuleGraph = [ModSummary]
1864 emptyMG :: ModuleGraph
1867 -- | A single node in a 'ModuleGraph. The nodes of the module graph are one of:
1869 -- * A regular Haskell source module
1871 -- * A hi-boot source module
1873 -- * An external-core source module
1876 ms_mod :: Module, -- ^ Identity of the module
1877 ms_hsc_src :: HscSource, -- ^ The module source either plain Haskell, hs-boot or external core
1878 ms_location :: ModLocation, -- ^ Location of the various files belonging to the module
1879 ms_hs_date :: ClockTime, -- ^ Timestamp of source file
1880 ms_obj_date :: Maybe ClockTime, -- ^ Timestamp of object, if we have one
1881 ms_srcimps :: [Located (ImportDecl RdrName)], -- ^ Source imports of the module
1882 ms_imps :: [Located (ImportDecl RdrName)], -- ^ Non-source imports of the module
1883 ms_hspp_file :: FilePath, -- ^ Filename of preprocessed source file
1884 ms_hspp_opts :: DynFlags, -- ^ Cached flags from @OPTIONS@, @INCLUDE@
1885 -- and @LANGUAGE@ pragmas in the modules source code
1886 ms_hspp_buf :: Maybe StringBuffer -- ^ The actual preprocessed source, if we have it
1889 ms_mod_name :: ModSummary -> ModuleName
1890 ms_mod_name = moduleName . ms_mod
1892 -- The ModLocation contains both the original source filename and the
1893 -- filename of the cleaned-up source file after all preprocessing has been
1894 -- done. The point is that the summariser will have to cpp/unlit/whatever
1895 -- all files anyway, and there's no point in doing this twice -- just
1896 -- park the result in a temp file, put the name of it in the location,
1897 -- and let @compile@ read from that file on the way back up.
1899 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
1900 -- the ms_hs_date and imports can, of course, change
1902 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
1903 msHsFilePath ms = expectJust "msHsFilePath" (ml_hs_file (ms_location ms))
1904 msHiFilePath ms = ml_hi_file (ms_location ms)
1905 msObjFilePath ms = ml_obj_file (ms_location ms)
1907 -- | Did this 'ModSummary' originate from a hs-boot file?
1908 isBootSummary :: ModSummary -> Bool
1909 isBootSummary ms = isHsBoot (ms_hsc_src ms)
1911 instance Outputable ModSummary where
1913 = sep [text "ModSummary {",
1914 nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
1915 text "ms_mod =" <+> ppr (ms_mod ms)
1916 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
1917 text "ms_imps =" <+> ppr (ms_imps ms),
1918 text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
1922 showModMsg :: HscTarget -> Bool -> ModSummary -> String
1923 showModMsg target recomp mod_summary
1925 hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
1926 char '(', text (normalise $ msHsFilePath mod_summary) <> comma,
1928 HscInterpreted | recomp
1929 -> text "interpreted"
1930 HscNothing -> text "nothing"
1931 _ -> text (normalise $ msObjFilePath mod_summary),
1934 mod = moduleName (ms_mod mod_summary)
1935 mod_str = showSDoc (ppr mod) ++ hscSourceString (ms_hsc_src mod_summary)
1939 %************************************************************************
1941 \subsection{Hpc Support}
1943 %************************************************************************
1946 -- | Information about a modules use of Haskell Program Coverage
1949 { hpcInfoTickCount :: Int
1950 , hpcInfoHash :: Int
1953 { hpcUsed :: AnyHpcUsage -- ^ Is hpc used anywhere on the module \*tree\*?
1956 -- | This is used to signal if one of my imports used HPC instrumentation
1957 -- even if there is no module-local HPC usage
1958 type AnyHpcUsage = Bool
1960 emptyHpcInfo :: AnyHpcUsage -> HpcInfo
1961 emptyHpcInfo = NoHpcInfo
1963 -- | Find out if HPC is used by this module or any of the modules
1965 isHpcUsed :: HpcInfo -> AnyHpcUsage
1966 isHpcUsed (HpcInfo {}) = True
1967 isHpcUsed (NoHpcInfo { hpcUsed = used }) = used
1970 %************************************************************************
1972 \subsection{Vectorisation Support}
1974 %************************************************************************
1976 The following information is generated and consumed by the vectorisation
1977 subsystem. It communicates the vectorisation status of declarations from one
1980 Why do we need both f and f_v in the ModGuts/ModDetails/EPS version VectInfo
1981 below? We need to know `f' when converting to IfaceVectInfo. However, during
1982 vectorisation, we need to know `f_v', whose `Var' we cannot lookup based
1983 on just the OccName easily in a Core pass.
1986 -- | Vectorisation information for 'ModGuts', 'ModDetails' and 'ExternalPackageState'.
1989 vectInfoVar :: VarEnv (Var , Var ), -- ^ @(f, f_v)@ keyed on @f@
1990 vectInfoTyCon :: NameEnv (TyCon , TyCon), -- ^ @(T, T_v)@ keyed on @T@
1991 vectInfoDataCon :: NameEnv (DataCon, DataCon), -- ^ @(C, C_v)@ keyed on @C@
1992 vectInfoPADFun :: NameEnv (TyCon , Var), -- ^ @(T_v, paT)@ keyed on @T_v@
1993 vectInfoIso :: NameEnv (TyCon , Var) -- ^ @(T, isoT)@ keyed on @T@
1996 -- | Vectorisation information for 'ModIface': a slightly less low-level view
1999 ifaceVectInfoVar :: [Name],
2000 -- ^ All variables in here have a vectorised variant
2001 ifaceVectInfoTyCon :: [Name],
2002 -- ^ All 'TyCon's in here have a vectorised variant;
2003 -- the name of the vectorised variant and those of its
2004 -- data constructors are determined by 'OccName.mkVectTyConOcc'
2005 -- and 'OccName.mkVectDataConOcc'; the names of
2006 -- the isomorphisms are determined by 'OccName.mkVectIsoOcc'
2007 ifaceVectInfoTyConReuse :: [Name]
2008 -- ^ The vectorised form of all the 'TyCon's in here coincides with
2009 -- the unconverted form; the name of the isomorphisms is determined
2010 -- by 'OccName.mkVectIsoOcc'
2013 noVectInfo :: VectInfo
2014 noVectInfo = VectInfo emptyVarEnv emptyNameEnv emptyNameEnv emptyNameEnv emptyNameEnv
2016 plusVectInfo :: VectInfo -> VectInfo -> VectInfo
2017 plusVectInfo vi1 vi2 =
2018 VectInfo (vectInfoVar vi1 `plusVarEnv` vectInfoVar vi2)
2019 (vectInfoTyCon vi1 `plusNameEnv` vectInfoTyCon vi2)
2020 (vectInfoDataCon vi1 `plusNameEnv` vectInfoDataCon vi2)
2021 (vectInfoPADFun vi1 `plusNameEnv` vectInfoPADFun vi2)
2022 (vectInfoIso vi1 `plusNameEnv` vectInfoIso vi2)
2024 concatVectInfo :: [VectInfo] -> VectInfo
2025 concatVectInfo = foldr plusVectInfo noVectInfo
2027 noIfaceVectInfo :: IfaceVectInfo
2028 noIfaceVectInfo = IfaceVectInfo [] [] []
2031 %************************************************************************
2033 \subsection{Linkable stuff}
2035 %************************************************************************
2037 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
2038 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
2041 -- | Information we can use to dynamically link modules into the compiler
2042 data Linkable = LM {
2043 linkableTime :: ClockTime, -- ^ Time at which this linkable was built
2044 -- (i.e. when the bytecodes were produced,
2045 -- or the mod date on the files)
2046 linkableModule :: Module, -- ^ The linkable module itself
2047 linkableUnlinked :: [Unlinked]
2048 -- ^ Those files and chunks of code we have yet to link.
2050 -- INVARIANT: A valid linkable always has at least one 'Unlinked' item.
2051 -- If this list is empty, the Linkable represents a fake linkable, which
2052 -- is generated in HscNothing mode to avoid recompiling modules.
2054 -- XXX: Do items get removed from this list when they get linked?
2057 isObjectLinkable :: Linkable -> Bool
2058 isObjectLinkable l = not (null unlinked) && all isObject unlinked
2059 where unlinked = linkableUnlinked l
2060 -- A linkable with no Unlinked's is treated as a BCO. We can
2061 -- generate a linkable with no Unlinked's as a result of
2062 -- compiling a module in HscNothing mode, and this choice
2063 -- happens to work well with checkStability in module GHC.
2065 instance Outputable Linkable where
2066 ppr (LM when_made mod unlinkeds)
2067 = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
2068 $$ nest 3 (ppr unlinkeds)
2070 -------------------------------------------
2072 -- | Objects which have yet to be linked by the compiler
2074 = DotO FilePath -- ^ An object file (.o)
2075 | DotA FilePath -- ^ Static archive file (.a)
2076 | DotDLL FilePath -- ^ Dynamically linked library file (.so, .dll, .dylib)
2077 | BCOs CompiledByteCode ModBreaks -- ^ A byte-code object, lives only in memory
2080 data CompiledByteCode = CompiledByteCodeUndefined
2081 _unused :: CompiledByteCode
2082 _unused = CompiledByteCodeUndefined
2085 instance Outputable Unlinked where
2086 ppr (DotO path) = text "DotO" <+> text path
2087 ppr (DotA path) = text "DotA" <+> text path
2088 ppr (DotDLL path) = text "DotDLL" <+> text path
2090 ppr (BCOs bcos _) = text "BCOs" <+> ppr bcos
2092 ppr (BCOs _ _) = text "No byte code"
2095 -- | Is this an actual file on disk we can link in somehow?
2096 isObject :: Unlinked -> Bool
2097 isObject (DotO _) = True
2098 isObject (DotA _) = True
2099 isObject (DotDLL _) = True
2102 -- | Is this a bytecode linkable with no file on disk?
2103 isInterpretable :: Unlinked -> Bool
2104 isInterpretable = not . isObject
2106 -- | Retrieve the filename of the linkable if possible. Panic if it is a byte-code object
2107 nameOfObject :: Unlinked -> FilePath
2108 nameOfObject (DotO fn) = fn
2109 nameOfObject (DotA fn) = fn
2110 nameOfObject (DotDLL fn) = fn
2111 nameOfObject other = pprPanic "nameOfObject" (ppr other)
2113 -- | Retrieve the compiled byte-code if possible. Panic if it is a file-based linkable
2114 byteCodeOfObject :: Unlinked -> CompiledByteCode
2115 byteCodeOfObject (BCOs bc _) = bc
2116 byteCodeOfObject other = pprPanic "byteCodeOfObject" (ppr other)
2119 %************************************************************************
2121 \subsection{Breakpoint Support}
2123 %************************************************************************
2126 -- | Breakpoint index
2127 type BreakIndex = Int
2129 -- | All the information about the breakpoints for a given module
2132 { modBreaks_flags :: BreakArray
2133 -- ^ The array of flags, one per breakpoint,
2134 -- indicating which breakpoints are enabled.
2135 , modBreaks_locs :: !(Array BreakIndex SrcSpan)
2136 -- ^ An array giving the source span of each breakpoint.
2137 , modBreaks_vars :: !(Array BreakIndex [OccName])
2138 -- ^ An array giving the names of the free variables at each breakpoint.
2141 emptyModBreaks :: ModBreaks
2142 emptyModBreaks = ModBreaks
2143 { modBreaks_flags = error "ModBreaks.modBreaks_array not initialised"
2144 -- Todo: can we avoid this?
2145 , modBreaks_locs = array (0,-1) []
2146 , modBreaks_vars = array (0,-1) []