compiler/main/HscTypes.lhs

   1 %
   2 % (c) The University of Glasgow, 2006
   3 %
   4 \section[HscTypes]{Types for the per-module compiler}
   5
   6 \begin{code}
   7 -- | Types for the per-module compiler
   8 module HscTypes (
   9         -- * 'Ghc' monad stuff
  10         Ghc(..), GhcT(..), liftGhcT,
  11         GhcMonad(..), WarnLogMonad(..),
  12         liftIO,
  13         ioMsgMaybe, ioMsg,
  14         logWarnings, clearWarnings, hasWarnings,
  15         SourceError, GhcApiError, mkSrcErr, srcErrorMessages, mkApiErr,
  16         throwOneError, handleSourceError,
  17         reflectGhc, reifyGhc,
  18         handleFlagWarnings,
  19
  20         -- * Sessions and compilation state
  21         Session(..), withSession, modifySession, withTempSession,
  22         HscEnv(..), hscEPS,
  23         FinderCache, FindResult(..), ModLocationCache,
  24         Target(..), TargetId(..), pprTarget, pprTargetId,
  25         ModuleGraph, emptyMG,
  26         -- ** Callbacks
  27         GhcApiCallbacks(..), withLocalCallbacks,
  28
  29         -- * Information about modules
  30         ModDetails(..), emptyModDetails,
  31         ModGuts(..), CoreModule(..), CgGuts(..), ForeignStubs(..),
  32         ImportedMods,
  33
  34         ModSummary(..), ms_mod_name, showModMsg, isBootSummary,
  35         msHsFilePath, msHiFilePath, msObjFilePath,
  36
  37         -- * Information about the module being compiled
  38         HscSource(..), isHsBoot, hscSourceString,       -- Re-exported from DriverPhases
  39
  40         -- * State relating to modules in this package
  41         HomePackageTable, HomeModInfo(..), emptyHomePackageTable,
  42         hptInstances, hptRules, hptVectInfo,
  43
  44         -- * State relating to known packages
  45         ExternalPackageState(..), EpsStats(..), addEpsInStats,
  46         PackageTypeEnv, PackageIfaceTable, emptyPackageIfaceTable,
  47         lookupIfaceByModule, emptyModIface,
  48
  49         PackageInstEnv, PackageRuleBase,
  50
  51
  52         -- * Annotations
  53         prepareAnnotations,
  54
  55         -- * Interactive context
  56         InteractiveContext(..), emptyInteractiveContext,
  57         icPrintUnqual, mkPrintUnqualified, extendInteractiveContext,
  58         substInteractiveContext,
  59
  60         -- * Interfaces
  61         ModIface(..), mkIfaceWarnCache, mkIfaceHashCache, mkIfaceFixCache,
  62         emptyIfaceWarnCache,
  63
  64         -- * Fixity
  65         FixityEnv, FixItem(..), lookupFixity, emptyFixityEnv,
  66
  67         -- * TyThings and type environments
  68         TyThing(..),
  69         tyThingClass, tyThingTyCon, tyThingDataCon, tyThingId,
  70         implicitTyThings, isImplicitTyThing,
  71
  72         TypeEnv, lookupType, lookupTypeHscEnv, mkTypeEnv, emptyTypeEnv,
  73         extendTypeEnv, extendTypeEnvList, extendTypeEnvWithIds, lookupTypeEnv,
  74         typeEnvElts, typeEnvClasses, typeEnvTyCons, typeEnvIds,
  75         typeEnvDataCons,
  76
  77         -- * MonadThings
  78         MonadThings(..),
  79
  80         -- * Information on imports and exports
  81         WhetherHasOrphans, IsBootInterface, Usage(..),
  82         Dependencies(..), noDependencies,
  83         NameCache(..), OrigNameCache, OrigIParamCache,
  84         Avails, availsToNameSet, availsToNameEnv, availName, availNames,
  85         GenAvailInfo(..), AvailInfo, RdrAvailInfo,
  86         IfaceExport,
  87
  88         -- * Warnings
  89         Warnings(..), WarningTxt(..), plusWarns,
  90
  91         -- * Linker stuff
  92         Linkable(..), isObjectLinkable,
  93         Unlinked(..), CompiledByteCode,
  94         isObject, nameOfObject, isInterpretable, byteCodeOfObject,
  95
  96         -- * Program coverage
  97         HpcInfo(..), emptyHpcInfo, isHpcUsed, AnyHpcUsage,
  98
  99         -- * Breakpoints
 100         ModBreaks (..), BreakIndex, emptyModBreaks,
 101
 102         -- * Vectorisation information
 103         VectInfo(..), IfaceVectInfo(..), noVectInfo, plusVectInfo,
 104         noIfaceVectInfo
 105     ) where
 106
 107 #include "HsVersions.h"
 108
 109 #ifdef GHCI
 110 import ByteCodeAsm      ( CompiledByteCode )
 111 import {-# SOURCE #-}  InteractiveEval ( Resume )
 112 #endif
 113
 114 import RdrName
 115 import Name
 116 import NameEnv
 117 import NameSet
 118 import OccName          ( OccName, OccEnv, lookupOccEnv, mkOccEnv, emptyOccEnv,
 119                           extendOccEnv )
 120 import Module
 121 import InstEnv          ( InstEnv, Instance )
 122 import FamInstEnv       ( FamInstEnv, FamInst )
 123 import Rules            ( RuleBase )
 124 import CoreSyn          ( CoreBind )
 125 import VarEnv
 126 import VarSet
 127 import Var
 128 import Id
 129 import Type
 130
 131 import Annotations
 132 import Class            ( Class, classSelIds, classATs, classTyCon )
 133 import TyCon
 134 import DataCon          ( DataCon, dataConImplicitIds, dataConWrapId )
 135 import PrelNames        ( gHC_PRIM )
 136 import Packages hiding ( Version(..) )
 137 import DynFlags         ( DynFlags(..), isOneShot, HscTarget (..), dopt,
 138                           DynFlag(..) )
 139 import DriverPhases     ( HscSource(..), isHsBoot, hscSourceString, Phase )
 140 import BasicTypes       ( IPName, Fixity, defaultFixity, WarningTxt(..) )
 141 import OptimizationFuel ( OptFuelState )
 142 import IfaceSyn
 143 import FiniteMap        ( FiniteMap )
 144 import CoreSyn          ( CoreRule )
 145 import Maybes           ( orElse, expectJust, catMaybes )
 146 import Outputable
 147 import BreakArray
 148 import SrcLoc           ( SrcSpan, Located(..) )
 149 import LazyUniqFM               ( lookupUFM, eltsUFM, emptyUFM )
 150 import UniqSupply       ( UniqSupply )
 151 import FastString
 152 import StringBuffer     ( StringBuffer )
 153 import Fingerprint
 154 import MonadUtils
 155 import Data.Dynamic     ( Typeable )
 156 import qualified Data.Dynamic as Dyn
 157 import Bag
 158 import ErrUtils
 159
 160 import System.FilePath
 161 import System.Time      ( ClockTime )
 162 import Data.IORef
 163 import Data.Array       ( Array, array )
 164 import Data.List
 165 import Control.Monad    ( mplus, guard, liftM, when )
 166 import Exception
 167 \end{code}
 168
 169
 170 %************************************************************************
 171 %*                                                                      *
 172 \subsection{Compilation environment}
 173 %*                                                                      *
 174 %************************************************************************
 175
 176
 177 \begin{code}
 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)
 183
 184 mkSrcErr :: ErrorMessages -> SourceError
 185 srcErrorMessages :: SourceError -> ErrorMessages
 186 mkApiErr :: SDoc -> GhcApiError
 187
 188 throwOneError :: MonadIO m => ErrMsg -> m ab
 189 throwOneError err = liftIO $ throwIO $ mkSrcErr $ unitBag err
 190
 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
 196 -- idiom:
 197 --
 198 -- > handleSourceError printExceptionAndWarnings $ do
 199 -- >   ... api calls that may fail ...
 200 --
 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').
 204 --
 205 -- See 'printExceptionAndWarnings' for more information on what to take care
 206 -- of when writing a custom error handler.
 207 data SourceError = SourceError ErrorMessages
 208
 209 instance Show SourceError where
 210   show (SourceError msgs) = unlines . map show . bagToList $ msgs
 211     -- ToDo: is there some nicer way to print this?
 212
 213 sourceErrorTc :: Dyn.TyCon
 214 sourceErrorTc = Dyn.mkTyCon "SourceError"
 215 {-# NOINLINE sourceErrorTc #-}
 216 instance Typeable SourceError where
 217   typeOf _ = Dyn.mkTyConApp sourceErrorTc []
 218
 219 instance Exception SourceError
 220
 221 mkSrcErr = SourceError
 222
 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
 228                   -> m a
 229 handleSourceError handler act =
 230   gcatch act (\(e :: SourceError) -> handler e)
 231
 232 srcErrorMessages (SourceError msgs) = msgs
 233
 234 -- | XXX: what exactly is an API error?
 235 data GhcApiError = GhcApiError SDoc
 236
 237 instance Show GhcApiError where
 238   show (GhcApiError msg) = showSDoc msg
 239
 240 ghcApiErrorTc :: Dyn.TyCon
 241 ghcApiErrorTc = Dyn.mkTyCon "GhcApiError"
 242 {-# NOINLINE ghcApiErrorTc #-}
 243 instance Typeable GhcApiError where
 244   typeOf _ = Dyn.mkTyConApp ghcApiErrorTc []
 245
 246 instance Exception GhcApiError
 247
 248 mkApiErr = GhcApiError
 249
 250 -- | A monad that allows logging of warnings.
 251 class Monad m => WarnLogMonad m where
 252   setWarnings  :: WarningMessages -> m ()
 253   getWarnings :: m WarningMessages
 254
 255 logWarnings :: WarnLogMonad m => WarningMessages -> m ()
 256 logWarnings warns = do
 257     warns0 <- getWarnings
 258     setWarnings (unionBags warns warns0)
 259
 260 -- | Clear the log of 'Warnings'.
 261 clearWarnings :: WarnLogMonad m => m ()
 262 clearWarnings = setWarnings emptyBag
 263
 264 -- | Returns true if there were any warnings.
 265 hasWarnings :: WarnLogMonad m => m Bool
 266 hasWarnings = getWarnings >>= return . not . isEmptyBag
 267
 268 -- | A monad that has all the features needed by GHC API calls.
 269 --
 270 -- In short, a GHC monad
 271 --
 272 --   - allows embedding of IO actions,
 273 --
 274 --   - can log warnings,
 275 --
 276 --   - allows handling of (extensible) exceptions, and
 277 --
 278 --   - maintains a current session.
 279 --
 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.
 282 --
 283 class (Functor m, MonadIO m, WarnLogMonad m, ExceptionMonad m)
 284     => GhcMonad m where
 285   getSession :: m HscEnv
 286   setSession :: HscEnv -> m ()
 287
 288 -- | Call the argument with the current session.
 289 withSession :: GhcMonad m => (HscEnv -> m a) -> m a
 290 withSession f = getSession >>= f
 291
 292 -- | Set the current session to the result of applying the current session to
 293 -- the argument.
 294 modifySession :: GhcMonad m => (HscEnv -> HscEnv) -> m ()
 295 modifySession f = do h <- getSession
 296                      setSession $! f h
 297
 298 withSavedSession :: GhcMonad m => m a -> m a
 299 withSavedSession m = do
 300   saved_session <- getSession
 301   m `gfinally` setSession saved_session
 302
 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
 307
 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
 310 -- 'GhcT'.
 311 newtype Ghc a = Ghc { unGhc :: Session -> IO a }
 312
 313 instance Functor Ghc where
 314   fmap f m = Ghc $ \s -> f `fmap` unGhc m s
 315
 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
 319
 320 instance MonadIO Ghc where
 321   liftIO ioA = Ghc $ \_ -> ioA
 322
 323 instance ExceptionMonad Ghc where
 324   gcatch act handle =
 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)
 328
 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
 333
 334 instance GhcMonad Ghc where
 335   getSession = Ghc $ \(Session r _) -> readIORef r
 336   setSession s' = Ghc $ \(Session r _) -> writeIORef r s'
 337
 338 -- | A monad transformer to add GHC specific features to another monad.
 339 --
 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
 344
 345 instance Functor m => Functor (GhcT m) where
 346   fmap f m = GhcT $ \s -> f `fmap` unGhcT m s
 347
 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
 351
 352 instance MonadIO m => MonadIO (GhcT m) where
 353   liftIO ioA = GhcT $ \_ -> liftIO ioA
 354
 355 instance ExceptionMonad m => ExceptionMonad (GhcT m) where
 356   gcatch act handle =
 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)
 360
 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
 365
 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'
 369
 370 -- | Lift an IO action returning errors messages into a 'GhcMonad'.
 371 --
 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').
 377 --
 378 -- This function assumes the following invariants:
 379 --
 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.
 382 --
 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
 388 ioMsgMaybe ioA = do
 389   ((warns,errs), mb_r) <- liftIO ioA
 390   logWarnings warns
 391   case mb_r of
 392     Nothing -> liftIO $ throwIO (mkSrcErr errs)
 393     Just r  -> ASSERT( isEmptyBag errs ) return r
 394
 395 -- | Lift a non-failing IO action into a 'GhcMonad'.
 396 --
 397 -- Like 'ioMsgMaybe', but assumes that the action will never return any error
 398 -- messages.
 399 ioMsg :: GhcMonad m => IO (Messages, a) -> m a
 400 ioMsg ioA = do
 401     ((warns,errs), r) <- liftIO ioA
 402     logWarnings warns
 403     ASSERT( isEmptyBag errs ) return r
 404
 405 -- | Reflect a computation in the 'Ghc' monad into the 'IO' monad.
 406 --
 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:
 410 --
 411 -- > libFunc :: String -> (Int -> IO a) -> IO a
 412 -- > ghcFunc :: Int -> Ghc a
 413 -- >
 414 -- > ghcFuncUsingLibFunc :: String -> Ghc a -> Ghc a
 415 -- > ghcFuncUsingLibFunc str =
 416 -- >   reifyGhc $ \s ->
 417 -- >     libFunc $ \i -> do
 418 -- >       reflectGhc (ghcFunc i) s
 419 --
 420 reflectGhc :: Ghc a -> Session -> IO a
 421 reflectGhc m = unGhc m
 422
 423 -- > Dual to 'reflectGhc'.  See its documentation.
 424 reifyGhc :: (Session -> IO a) -> Ghc a
 425 reifyGhc act = Ghc $ act
 426
 427 handleFlagWarnings :: GhcMonad m => DynFlags -> [Located String] -> m ()
 428 handleFlagWarnings dflags warns
 429  = when (dopt Opt_WarnDeprecatedFlags dflags)
 430         (handleFlagWarnings' dflags warns)
 431
 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
 436       -- import problems.
 437       logWarnings $ listToBag (map mkFlagWarning warns)
 438       when (dopt Opt_WarnIsError dflags) $
 439         liftIO $ throwIO $ mkSrcErr emptyBag
 440
 441 mkFlagWarning :: Located String -> WarnMsg
 442 mkFlagWarning (L loc warn)
 443  = mkPlainWarnMsg loc (text warn)
 444 \end{code}
 445
 446 \begin{code}
 447 -- | These functions are called in various places of the GHC API.
 448 --
 449 -- API clients can override any of these callbacks to change GHC's default
 450 -- behaviour.
 451 data GhcApiCallbacks
 452   = GhcApiCallbacks {
 453
 454     -- | Called by 'load' after the compilating of each module.
 455     --
 456     -- The default implementation simply prints all warnings and errors to
 457     -- @stderr@.  Don't forget to call 'clearWarnings' when implementing your
 458     -- own call.
 459     --
 460     -- The first argument is the module that was compiled.
 461     --
 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
 465     -- @-Werror@.
 466     reportModuleCompilationResult :: GhcMonad m =>
 467                                      ModSummary -> Maybe SourceError
 468                                   -> m ()
 469   }
 470
 471 -- | Temporarily modify the callbacks.  After the action is executed all
 472 -- callbacks are reset (not, however, any other modifications to the session
 473 -- state.)
 474 withLocalCallbacks :: GhcMonad m =>
 475                       (GhcApiCallbacks -> GhcApiCallbacks)
 476                    -> m a -> m a
 477 withLocalCallbacks f m = do
 478   hsc_env <- getSession
 479   let cb0 = hsc_callbacks hsc_env
 480   let cb' = f cb0
 481   setSession (hsc_env { hsc_callbacks = cb' `seq` cb' })
 482   r <- m
 483   hsc_env' <- getSession
 484   setSession (hsc_env' { hsc_callbacks = cb0 })
 485   return r
 486
 487 \end{code}
 488
 489 \begin{code}
 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.
 494 --
 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
 499 -- a single module.
 500 data HscEnv
 501   = HscEnv {
 502         hsc_dflags :: DynFlags,
 503                 -- ^ The dynamic flag settings
 504
 505         hsc_callbacks :: GhcApiCallbacks,
 506                 -- ^ Callbacks for the GHC API.
 507
 508         hsc_targets :: [Target],
 509                 -- ^ The targets (or roots) of the current session
 510
 511         hsc_mod_graph :: ModuleGraph,
 512                 -- ^ The module graph of the current session
 513
 514         hsc_IC :: InteractiveContext,
 515                 -- ^ The context for evaluating interactive statements
 516
 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.)
 526                 --
 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.
 530                 --
 531                 -- The HPT may contain modules compiled earlier by @--make@
 532                 -- but not actually below the current module in the dependency
 533                 -- graph.
 534
 535                 -- (This changes a previous invariant: changed Jan 05.)
 536
 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.
 541
 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.
 546
 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'.
 552
 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.
 557
 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'
 562
 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!
 568
 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
 572                 -- being compiled!
 573  }
 574
 575 hscEPS :: HscEnv -> IO ExternalPackageState
 576 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
 577
 578 -- | A compilation target.
 579 --
 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
 583 -- the user yet).
 584 data Target = Target
 585       { targetId           :: TargetId  -- ^ module or filename
 586       , targetAllowObjCode :: Bool      -- ^ object code allowed?
 587       , targetContents     :: Maybe (StringBuffer,ClockTime)
 588                                         -- ^ in-memory text buffer?
 589       }
 590
 591 data TargetId
 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.
 599   deriving Eq
 600
 601 pprTarget :: Target -> SDoc
 602 pprTarget (Target id obj _) =
 603    (if obj then char '*' else empty) <> pprTargetId id
 604
 605 instance Outputable Target where
 606     ppr = pprTarget
 607
 608 pprTargetId :: TargetId -> SDoc
 609 pprTargetId (TargetModule m) = ppr m
 610 pprTargetId (TargetFile f _) = text f
 611
 612 instance Outputable TargetId where
 613     ppr = pprTargetId
 614
 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
 619
 620 -- | Helps us find information about modules in the imported packages
 621 type PackageIfaceTable = ModuleEnv ModIface
 622         -- Domain = modules in the imported packages
 623
 624 emptyHomePackageTable :: HomePackageTable
 625 emptyHomePackageTable  = emptyUFM
 626
 627 emptyPackageIfaceTable :: PackageIfaceTable
 628 emptyPackageIfaceTable = emptyModuleEnv
 629
 630 -- | Information about modules in the package being compiled
 631 data HomeModInfo
 632   = HomeModInfo {
 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
 641         -- this module.
 642         --
 643         -- 'hm_linkable' might be Nothing:
 644         --
 645         --   1. If this is an .hs-boot module
 646         --
 647         --   2. Temporarily during compilation if we pruned away
 648         --      the old linkable because it was out of date.
 649         --
 650         -- After a complete compilation ('GHC.load'), all 'hm_linkable' fields
 651         -- in the 'HomePackageTable' will be @Just@.
 652         --
 653         -- When re-linking a module ('HscMain.HscNoRecomp'), we construct the
 654         -- 'HomeModInfo' by building a new 'ModDetails' from the old
 655         -- 'ModIface' (only).
 656     }
 657
 658 -- | Find the 'ModIface' for a 'Module', searching in both the loaded home
 659 -- and external package module information
 660 lookupIfaceByModule
 661         :: DynFlags
 662         -> HomePackageTable
 663         -> PackageIfaceTable
 664         -> Module
 665         -> Maybe ModIface
 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
 673
 674   | otherwise = lookupModuleEnv pit mod         -- Look in PIT only
 675
 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.
 682 \end{code}
 683
 684
 685 \begin{code}
 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)
 697
 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)
 704
 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
 708
 709
 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
 714
 715 hptAllThings :: (HomeModInfo -> [a]) -> HscEnv -> [a]
 716 hptAllThings extract hsc_env = concatMap extract (eltsUFM (hsc_HPT hsc_env))
 717
 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)) = []
 723   | otherwise
 724   = let
 725         hpt = hsc_HPT hsc_env
 726     in
 727     [ thing
 728     |   -- Find each non-hi-boot module below me
 729       (mod, is_boot_mod) <- deps
 730     , include_hi_boot || not is_boot_mod
 731
 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
 736         -- filter:
 737     , mod /= moduleName gHC_PRIM
 738
 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
 746
 747         -- And get its dfuns
 748     , thing <- things ]
 749 \end{code}
 750
 751 %************************************************************************
 752 %*                                                                      *
 753 \subsection{Dealing with Annotations}
 754 %*                                                                      *
 755 %************************************************************************
 756
 757 \begin{code}
 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,
 771                                                              Just home_pkg_anns,
 772                                                              Just other_pkg_anns]
 773
 774        ; return ann_env }
 775 \end{code}
 776
 777 %************************************************************************
 778 %*                                                                      *
 779 \subsection{The Finder cache}
 780 %*                                                                      *
 781 %************************************************************************
 782
 783 \begin{code}
 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.
 788 --
 789 -- Although the @FinderCache@ range is 'FindResult' for convenience ,
 790 -- in fact it will only ever contain 'Found' or 'NotFound' entries.
 791 --
 792 type FinderCache = ModuleNameEnv FindResult
 793
 794 -- | The result of searching for an imported module.
 795 data FindResult
 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   | PackageHidden PackageId
 803         -- ^ For an explicit source import, the package containing the module is
 804         -- not exposed.
 805   | ModuleHidden  PackageId
 806         -- ^ For an explicit source import, the package containing the module is
 807         -- exposed, but the module itself is hidden.
 808   | NotFound [FilePath] (Maybe PackageId)
 809         -- ^ The module was not found, the specified places were searched
 810   | NotFoundInPackage PackageId
 811         -- ^ The module was not found in this package
 812
 813 -- | Cache that remembers where we found a particular module.  Contains both
 814 -- home modules and package modules.  On @:load@, only home modules are
 815 -- purged from this cache.
 816 type ModLocationCache = ModuleEnv ModLocation
 817 \end{code}
 818
 819 %************************************************************************
 820 %*                                                                      *
 821 \subsection{Symbol tables and Module details}
 822 %*                                                                      *
 823 %************************************************************************
 824
 825 \begin{code}
 826 -- | A 'ModIface' plus a 'ModDetails' summarises everything we know
 827 -- about a compiled module.  The 'ModIface' is the stuff *before* linking,
 828 -- and can be written out to an interface file. The 'ModDetails is after
 829 -- linking and can be completely recovered from just the 'ModIface'.
 830 --
 831 -- When we read an interface file, we also construct a 'ModIface' from it,
 832 -- except that we explicitly make the 'mi_decls' and a few other fields empty;
 833 -- as when reading we consolidate the declarations etc. into a number of indexed
 834 -- maps and environments in the 'ExternalPackageState'.
 835 data ModIface
 836    = ModIface {
 837         mi_module   :: !Module,             -- ^ Name of the module we are for
 838         mi_iface_hash :: !Fingerprint,      -- ^ Hash of the whole interface
 839         mi_mod_hash :: !Fingerprint,        -- ^ Hash of the ABI only
 840
 841         mi_orphan   :: !WhetherHasOrphans,  -- ^ Whether this module has orphans
 842         mi_finsts   :: !WhetherHasFamInst,  -- ^ Whether this module has family instances
 843         mi_boot     :: !IsBootInterface,    -- ^ Read from an hi-boot file?
 844
 845         mi_deps     :: Dependencies,
 846                 -- ^ The dependencies of the module, consulted for directly
 847                 -- imported modules only
 848
 849                 -- This is consulted for directly-imported modules,
 850                 -- but not for anything else (hence lazy)
 851         mi_usages   :: [Usage],
 852                 -- ^ Usages; kept sorted so that it's easy to decide
 853                 -- whether to write a new iface file (changing usages
 854                 -- doesn't affect the hash of this module)
 855
 856                 -- NOT STRICT!  we read this field lazily from the interface file
 857                 -- It is *only* consulted by the recompilation checker
 858
 859                 -- Exports
 860                 -- Kept sorted by (mod,occ), to make version comparisons easier
 861         mi_exports  :: ![IfaceExport],
 862                 -- ^ Records the modules that are the declaration points for things
 863                 -- exported by this module, and the 'OccName's of those things
 864
 865         mi_exp_hash :: !Fingerprint,    -- ^ Hash of export list
 866
 867         mi_fixities :: [(OccName,Fixity)],
 868                 -- ^ Fixities
 869
 870                 -- NOT STRICT!  we read this field lazily from the interface file
 871
 872         mi_warns  :: Warnings,
 873                 -- ^ Warnings
 874
 875                 -- NOT STRICT!  we read this field lazily from the interface file
 876
 877         mi_anns  :: [IfaceAnnotation],
 878                 -- ^ Annotations
 879
 880                 -- NOT STRICT!  we read this field lazily from the interface file
 881
 882                 -- Type, class and variable declarations
 883                 -- The hash of an Id changes if its fixity or deprecations change
 884                 --      (as well as its type of course)
 885                 -- Ditto data constructors, class operations, except that
 886                 -- the hash of the parent class/tycon changes
 887         mi_decls :: [(Fingerprint,IfaceDecl)],  -- ^ Sorted type, variable, class etc. declarations
 888
 889         mi_globals  :: !(Maybe GlobalRdrEnv),
 890                 -- ^ Binds all the things defined at the top level in
 891                 -- the /original source/ code for this module. which
 892                 -- is NOT the same as mi_exports, nor mi_decls (which
 893                 -- may contains declarations for things not actually
 894                 -- defined by the user).  Used for GHCi and for inspecting
 895                 -- the contents of modules via the GHC API only.
 896                 --
 897                 -- (We need the source file to figure out the
 898                 -- top-level environment, if we didn't compile this module
 899                 -- from source then this field contains @Nothing@).
 900                 --
 901                 -- Strictly speaking this field should live in the
 902                 -- 'HomeModInfo', but that leads to more plumbing.
 903
 904                 -- Instance declarations and rules
 905         mi_insts     :: [IfaceInst],                    -- ^ Sorted class instance
 906         mi_fam_insts :: [IfaceFamInst],                 -- ^ Sorted family instances
 907         mi_rules     :: [IfaceRule],                    -- ^ Sorted rules
 908         mi_orphan_hash :: !Fingerprint, -- ^ Hash for orphan rules and
 909                                         -- class and family instances
 910                                         -- combined
 911
 912         mi_vect_info :: !IfaceVectInfo, -- ^ Vectorisation information
 913
 914                 -- Cached environments for easy lookup
 915                 -- These are computed (lazily) from other fields
 916                 -- and are not put into the interface file
 917         mi_warn_fn  :: Name -> Maybe WarningTxt,        -- ^ Cached lookup for 'mi_warns'
 918         mi_fix_fn  :: OccName -> Fixity,                -- ^ Cached lookup for 'mi_fixities'
 919         mi_hash_fn :: OccName -> Maybe (OccName, Fingerprint),
 920                         -- ^ Cached lookup for 'mi_decls'.
 921                         -- The @Nothing@ in 'mi_hash_fn' means that the thing
 922                         -- isn't in decls. It's useful to know that when
 923                         -- seeing if we are up to date wrt. the old interface.
 924                         -- The 'OccName' is the parent of the name, if it has one.
 925         mi_hpc    :: !AnyHpcUsage
 926                 -- ^ True if this program uses Hpc at any point in the program.
 927      }
 928
 929 -- | The 'ModDetails' is essentially a cache for information in the 'ModIface'
 930 -- for home modules only. Information relating to packages will be loaded into
 931 -- global environments in 'ExternalPackageState'.
 932 data ModDetails
 933    = ModDetails {
 934         -- The next two fields are created by the typechecker
 935         md_exports   :: [AvailInfo],
 936         md_types     :: !TypeEnv,       -- ^ Local type environment for this particular module
 937         md_insts     :: ![Instance],    -- ^ 'DFunId's for the instances in this module
 938         md_fam_insts :: ![FamInst],
 939         md_rules     :: ![CoreRule],    -- ^ Domain may include 'Id's from other modules
 940         md_anns      :: ![Annotation],  -- ^ Annotations present in this module: currently
 941                                         -- they only annotate things also declared in this module
 942         md_vect_info :: !VectInfo       -- ^ Module vectorisation information
 943      }
 944
 945 emptyModDetails :: ModDetails
 946 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
 947                                md_exports = [],
 948                                md_insts     = [],
 949                                md_rules     = [],
 950                                md_fam_insts = [],
 951                                md_anns      = [],
 952                                md_vect_info = noVectInfo
 953                              }
 954
 955 -- | Records the modules directly imported by a module for extracting e.g. usage information
 956 type ImportedMods = ModuleEnv [(ModuleName, Bool, SrcSpan)]
 957 -- TODO: we are not actually using the codomain of this type at all, so it can be
 958 -- replaced with ModuleEnv ()
 959
 960 -- | A ModGuts is carried through the compiler, accumulating stuff as it goes
 961 -- There is only one ModGuts at any time, the one for the module
 962 -- being compiled right now.  Once it is compiled, a 'ModIface' and
 963 -- 'ModDetails' are extracted and the ModGuts is dicarded.
 964 data ModGuts
 965   = ModGuts {
 966         mg_module    :: !Module,         -- ^ Module being compiled
 967         mg_boot      :: IsBootInterface, -- ^ Whether it's an hs-boot module
 968         mg_exports   :: ![AvailInfo],    -- ^ What it exports
 969         mg_deps      :: !Dependencies,   -- ^ What it depends on, directly or
 970                                          -- otherwise
 971         mg_dir_imps  :: !ImportedMods,   -- ^ Directly-imported modules; used to
 972                                          -- generate initialisation code
 973         mg_used_names:: !NameSet,        -- ^ What the module needed (used in 'MkIface.mkIface')
 974
 975         mg_rdr_env   :: !GlobalRdrEnv,   -- ^ Top-level lexical environment
 976
 977         -- These fields all describe the things **declared in this module**
 978         mg_fix_env   :: !FixityEnv,      -- ^ Fixities declared in this module
 979                                          -- TODO: I'm unconvinced this is actually used anywhere
 980         mg_types     :: !TypeEnv,        -- ^ Types declared in this module
 981         mg_insts     :: ![Instance],     -- ^ Class instances declared in this module
 982         mg_fam_insts :: ![FamInst],      -- ^ Family instances declared in this module
 983         mg_rules     :: ![CoreRule],     -- ^ Before the core pipeline starts, contains
 984                                          -- rules declared in this module. After the core
 985                                          -- pipeline starts, it is changed to contain all
 986                                          -- known rules for those things imported
 987         mg_binds     :: ![CoreBind],     -- ^ Bindings for this module
 988         mg_foreign   :: !ForeignStubs,   -- ^ Foreign exports declared in this module
 989         mg_warns     :: !Warnings,       -- ^ Warnings declared in the module
 990         mg_anns      :: [Annotation],    -- ^ Annotations declared in this module
 991         mg_hpc_info  :: !HpcInfo,        -- ^ Coverage tick boxes in the module
 992         mg_modBreaks :: !ModBreaks,      -- ^ Breakpoints for the module
 993         mg_vect_info :: !VectInfo,       -- ^ Pool of vectorised declarations in the module
 994
 995         -- The next two fields are unusual, because they give instance
 996         -- environments for *all* modules in the home package, including
 997         -- this module, rather than for *just* this module.
 998         -- Reason: when looking up an instance we don't want to have to
 999         --        look at each module in the home package in turn
1000         mg_inst_env     :: InstEnv,
1001         -- ^ Class instance environment from /home-package/ modules (including
1002         -- this one); c.f. 'tcg_inst_env'
1003         mg_fam_inst_env :: FamInstEnv
1004         -- ^ Type-family instance enviroment for /home-package/ modules
1005         -- (including this one); c.f. 'tcg_fam_inst_env'
1006     }
1007
1008 -- The ModGuts takes on several slightly different forms:
1009 --
1010 -- After simplification, the following fields change slightly:
1011 --      mg_rules        Orphan rules only (local ones now attached to binds)
1012 --      mg_binds        With rules attached
1013
1014 -- | A CoreModule consists of just the fields of a 'ModGuts' that are needed for
1015 -- the 'GHC.compileToCoreModule' interface.
1016 data CoreModule
1017   = CoreModule {
1018       -- | Module name
1019       cm_module   :: !Module,
1020       -- | Type environment for types declared in this module
1021       cm_types    :: !TypeEnv,
1022       -- | Declarations
1023       cm_binds    :: [CoreBind],
1024       -- | Imports
1025       cm_imports  :: ![Module]
1026     }
1027
1028 instance Outputable CoreModule where
1029    ppr (CoreModule {cm_module = mn, cm_types = te, cm_binds = cb}) =
1030       text "%module" <+> ppr mn <+> ppr te $$ vcat (map ppr cb)
1031
1032 -- The ModGuts takes on several slightly different forms:
1033 --
1034 -- After simplification, the following fields change slightly:
1035 --      mg_rules        Orphan rules only (local ones now attached to binds)
1036 --      mg_binds        With rules attached
1037
1038
1039 ---------------------------------------------------------
1040 -- The Tidy pass forks the information about this module:
1041 --      * one lot goes to interface file generation (ModIface)
1042 --        and later compilations (ModDetails)
1043 --      * the other lot goes to code generation (CgGuts)
1044
1045 -- | A restricted form of 'ModGuts' for code generation purposes
1046 data CgGuts
1047   = CgGuts {
1048         cg_module   :: !Module, -- ^ Module being compiled
1049
1050         cg_tycons   :: [TyCon],
1051                 -- ^ Algebraic data types (including ones that started
1052                 -- life as classes); generate constructors and info
1053                 -- tables. Includes newtypes, just for the benefit of
1054                 -- External Core
1055
1056         cg_binds    :: [CoreBind],
1057                 -- ^ The tidied main bindings, including
1058                 -- previously-implicit bindings for record and class
1059                 -- selectors, and data construtor wrappers.  But *not*
1060                 -- data constructor workers; reason: we we regard them
1061                 -- as part of the code-gen of tycons
1062
1063         cg_dir_imps :: ![Module],
1064                 -- ^ Directly-imported modules; used to generate
1065                 -- initialisation code
1066
1067         cg_foreign  :: !ForeignStubs,   -- ^ Foreign export stubs
1068         cg_dep_pkgs :: ![PackageId],    -- ^ Dependent packages, used to
1069                                         -- generate #includes for C code gen
1070         cg_hpc_info :: !HpcInfo,        -- ^ Program coverage tick box information
1071         cg_modBreaks :: !ModBreaks      -- ^ Module breakpoints
1072     }
1073
1074 -----------------------------------
1075 -- | Foreign export stubs
1076 data ForeignStubs = NoStubs             -- ^ We don't have any stubs
1077                   | ForeignStubs
1078                         SDoc
1079                         SDoc
1080                    -- ^ There are some stubs. Parameters:
1081                    --
1082                    --  1) Header file prototypes for
1083                    --     "foreign exported" functions
1084                    --
1085                    --  2) C stubs to use when calling
1086                    --     "foreign exported" functions
1087 \end{code}
1088
1089 \begin{code}
1090 emptyModIface :: Module -> ModIface
1091 emptyModIface mod
1092   = ModIface { mi_module   = mod,
1093                mi_iface_hash = fingerprint0,
1094                mi_mod_hash = fingerprint0,
1095                mi_orphan   = False,
1096                mi_finsts   = False,
1097                mi_boot     = False,
1098                mi_deps     = noDependencies,
1099                mi_usages   = [],
1100                mi_exports  = [],
1101                mi_exp_hash = fingerprint0,
1102                mi_fixities = [],
1103                mi_warns    = NoWarnings,
1104                mi_anns     = [],
1105                mi_insts     = [],
1106                mi_fam_insts = [],
1107                mi_rules     = [],
1108                mi_decls     = [],
1109                mi_globals   = Nothing,
1110                mi_orphan_hash = fingerprint0,
1111                mi_vect_info = noIfaceVectInfo,
1112                mi_warn_fn    = emptyIfaceWarnCache,
1113                mi_fix_fn    = emptyIfaceFixCache,
1114                mi_hash_fn   = emptyIfaceHashCache,
1115                mi_hpc       = False
1116     }
1117 \end{code}
1118
1119
1120 %************************************************************************
1121 %*                                                                      *
1122 \subsection{The interactive context}
1123 %*                                                                      *
1124 %************************************************************************
1125
1126 \begin{code}
1127 -- | Interactive context, recording information relevant to GHCi
1128 data InteractiveContext
1129   = InteractiveContext {
1130         ic_toplev_scope :: [Module],    -- ^ The context includes the "top-level" scope of
1131                                         -- these modules
1132
1133         ic_exports :: [Module],         -- ^ The context includes just the exports of these
1134                                         -- modules
1135
1136         ic_rn_gbl_env :: GlobalRdrEnv,  -- ^ The contexts' cached 'GlobalRdrEnv', built from
1137                                         -- 'ic_toplev_scope' and 'ic_exports'
1138
1139         ic_tmp_ids :: [Id],             -- ^ Names bound during interaction with the user.
1140                                         -- Later Ids shadow earlier ones with the same OccName.
1141
1142         ic_tyvars :: TyVarSet           -- ^ Skolem type variables free in
1143                                         -- 'ic_tmp_ids'.  These arise at
1144                                         -- breakpoints in a polymorphic
1145                                         -- context, where we have only partial
1146                                         -- type information.
1147
1148 #ifdef GHCI
1149         , ic_resume :: [Resume]         -- ^ The stack of breakpoint contexts
1150 #endif
1151     }
1152
1153
1154 emptyInteractiveContext :: InteractiveContext
1155 emptyInteractiveContext
1156   = InteractiveContext { ic_toplev_scope = [],
1157                          ic_exports = [],
1158                          ic_rn_gbl_env = emptyGlobalRdrEnv,
1159                          ic_tmp_ids = [],
1160                          ic_tyvars = emptyVarSet
1161 #ifdef GHCI
1162                          , ic_resume = []
1163 #endif
1164                        }
1165
1166 icPrintUnqual :: DynFlags -> InteractiveContext -> PrintUnqualified
1167 icPrintUnqual dflags ictxt = mkPrintUnqualified dflags (ic_rn_gbl_env ictxt)
1168
1169
1170 extendInteractiveContext
1171         :: InteractiveContext
1172         -> [Id]
1173         -> TyVarSet
1174         -> InteractiveContext
1175 extendInteractiveContext ictxt ids tyvars
1176   = ictxt { ic_tmp_ids =  snub((ic_tmp_ids ictxt \\ ids) ++ ids),
1177                           -- NB. must be this way around, because we want
1178                           -- new ids to shadow existing bindings.
1179             ic_tyvars   = ic_tyvars ictxt `unionVarSet` tyvars }
1180     where snub = map head . group . sort
1181
1182 substInteractiveContext :: InteractiveContext -> TvSubst -> InteractiveContext
1183 substInteractiveContext ictxt subst | isEmptyTvSubst subst = ictxt
1184 substInteractiveContext ictxt@InteractiveContext{ic_tmp_ids=ids} subst =
1185    let ids'     = map (\id -> id `setIdType` substTy subst (idType id)) ids
1186        subst_dom= varEnvKeys$ getTvSubstEnv subst
1187        subst_ran= varEnvElts$ getTvSubstEnv subst
1188        new_tvs  = [ tv | Just tv <- map getTyVar_maybe subst_ran]
1189        ic_tyvars'= (`delVarSetListByKey` subst_dom)
1190                  . (`extendVarSetList`   new_tvs)
1191                    $ ic_tyvars ictxt
1192     in ictxt { ic_tmp_ids = ids'
1193              , ic_tyvars   = ic_tyvars' }
1194
1195           where delVarSetListByKey = foldl' delVarSetByKey
1196 \end{code}
1197
1198 %************************************************************************
1199 %*                                                                      *
1200         Building a PrintUnqualified
1201 %*                                                                      *
1202 %************************************************************************
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.
1208
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:
1212
1213  1. T   uniquely maps to  P:M.T                         --->  "T"
1214  2. there is an X for which X.T uniquely maps to  P:M.T --->  "X.T"
1215  3. there is no binding for "M.T"                       --->  "M.T"
1216  4. otherwise                                           --->  "P:M.T"
1217
1218 3 and 4 apply when P:M.T is not in scope.  In these cases we want to
1219 refer to the name as "M.T", but "M.T" might mean something else in the
1220 current scope (e.g. if there's an "import X as M"), so to avoid
1221 confusion we avoid using "M.T" if there's already a binding for it.
1222
1223 There's one further subtlety: if the module M cannot be imported
1224 because it is not exposed by any package, then we must refer to it as
1225 "P:M".  This is handled by the qual_mod component of PrintUnqualified.
1226
1227 \begin{code}
1228 -- | Creates some functions that work out the best ways to format
1229 -- names for the user according to a set of heuristics
1230 mkPrintUnqualified :: DynFlags -> GlobalRdrEnv -> PrintUnqualified
1231 mkPrintUnqualified dflags env = (qual_name, qual_mod)
1232   where
1233   qual_name mod occ     -- The (mod,occ) pair is the original name of the thing
1234         | [gre] <- unqual_gres, right_name gre = NameUnqual
1235                 -- If there's a unique entity that's in scope unqualified with 'occ'
1236                 -- AND that entity is the right one, then we can use the unqualified name
1237
1238         | [gre] <- qual_gres = NameQual (get_qual_mod (gre_prov gre))
1239
1240         | null qual_gres =
1241               if null (lookupGRE_RdrName (mkRdrQual (moduleName mod) occ) env)
1242                    then NameNotInScope1
1243                    else NameNotInScope2
1244
1245         | otherwise = panic "mkPrintUnqualified"
1246       where
1247         right_name gre = nameModule_maybe (gre_name gre) == Just mod
1248
1249         unqual_gres = lookupGRE_RdrName (mkRdrUnqual occ) env
1250         qual_gres   = filter right_name (lookupGlobalRdrEnv env occ)
1251
1252         get_qual_mod LocalDef      = moduleName mod
1253         get_qual_mod (Imported is) = ASSERT( not (null is) ) is_as (is_decl (head is))
1254
1255     -- we can mention a module P:M without the P: qualifier iff
1256     -- "import M" would resolve unambiguously to P:M.  (if P is the
1257     -- current package we can just assume it is unqualified).
1258
1259   qual_mod mod
1260      | modulePackageId mod == thisPackage dflags = False
1261
1262      | [pkgconfig] <- [pkg | (pkg,exposed_module) <- lookup,
1263                              exposed pkg && exposed_module],
1264        packageConfigId pkgconfig == modulePackageId mod
1265         -- this says: we are given a module P:M, is there just one exposed package
1266         -- that exposes a module M, and is it package P?
1267      = False
1268
1269      | otherwise = True
1270      where lookup = lookupModuleInAllPackages dflags (moduleName mod)
1271 \end{code}
1272
1273
1274 %************************************************************************
1275 %*                                                                      *
1276                 TyThing
1277 %*                                                                      *
1278 %************************************************************************
1279
1280 \begin{code}
1281 -- | Determine the 'TyThing's brought into scope by another 'TyThing'
1282 -- /other/ than itself. For example, Id's don't have any implicit TyThings
1283 -- as they just bring themselves into scope, but classes bring their
1284 -- dictionary datatype, type constructor and some selector functions into
1285 -- scope, just for a start!
1286
1287 -- N.B. the set of TyThings returned here *must* match the set of
1288 -- names returned by LoadIface.ifaceDeclSubBndrs, in the sense that
1289 -- TyThing.getOccName should define a bijection between the two lists.
1290 -- This invariant is used in LoadIface.loadDecl (see note [Tricky iface loop])
1291 -- The order of the list does not matter.
1292 implicitTyThings :: TyThing -> [TyThing]
1293
1294 -- For data and newtype declarations:
1295 implicitTyThings (ATyCon tc) =
1296     -- fields (names of selectors)
1297     map AnId (tyConSelIds tc) ++
1298     -- (possibly) implicit coercion and family coercion
1299     --   depending on whether it's a newtype or a family instance or both
1300     implicitCoTyCon tc ++
1301     -- for each data constructor in order,
1302     --   the contructor, worker, and (possibly) wrapper
1303     concatMap (extras_plus . ADataCon) (tyConDataCons tc)
1304
1305 implicitTyThings (AClass cl)
1306   = -- dictionary datatype:
1307     --    [extras_plus:]
1308     --      type constructor
1309     --    [recursive call:]
1310     --      (possibly) newtype coercion; definitely no family coercion here
1311     --      data constructor
1312     --      worker
1313     --      (no wrapper by invariant)
1314     extras_plus (ATyCon (classTyCon cl)) ++
1315     -- associated types
1316     --    No extras_plus (recursive call) for the classATs, because they
1317     --    are only the family decls; they have no implicit things
1318     map ATyCon (classATs cl) ++
1319     -- superclass and operation selectors
1320     map AnId (classSelIds cl)
1321
1322 implicitTyThings (ADataCon dc) =
1323     -- For data cons add the worker and (possibly) wrapper
1324     map AnId (dataConImplicitIds dc)
1325
1326 implicitTyThings (AnId _)   = []
1327
1328 -- add a thing and recursive call
1329 extras_plus :: TyThing -> [TyThing]
1330 extras_plus thing = thing : implicitTyThings thing
1331
1332 -- For newtypes and indexed data types (and both),
1333 -- add the implicit coercion tycon
1334 implicitCoTyCon :: TyCon -> [TyThing]
1335 implicitCoTyCon tc
1336   = map ATyCon . catMaybes $ [-- Just if newtype, Nothing if not
1337                               newTyConCo_maybe tc,
1338                               -- Just if family instance, Nothing if not
1339                                 tyConFamilyCoercion_maybe tc]
1340
1341 -- sortByOcc = sortBy (\ x -> \ y -> getOccName x < getOccName y)
1342
1343
1344 -- | Returns @True@ if there should be no interface-file declaration
1345 -- for this thing on its own: either it is built-in, or it is part
1346 -- of some other declaration, or it is generated implicitly by some
1347 -- other declaration.
1348 isImplicitTyThing :: TyThing -> Bool
1349 isImplicitTyThing (ADataCon _)  = True
1350 isImplicitTyThing (AnId     id) = isImplicitId id
1351 isImplicitTyThing (AClass   _)  = False
1352 isImplicitTyThing (ATyCon   tc) = isImplicitTyCon tc
1353
1354 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
1355 extendTypeEnvWithIds env ids
1356   = extendNameEnvList env [(getName id, AnId id) | id <- ids]
1357 \end{code}
1358
1359 %************************************************************************
1360 %*                                                                      *
1361                 TypeEnv
1362 %*                                                                      *
1363 %************************************************************************
1364
1365 \begin{code}
1366 -- | A map from 'Name's to 'TyThing's, constructed by typechecking
1367 -- local declarations or interface files
1368 type TypeEnv = NameEnv TyThing
1369
1370 emptyTypeEnv    :: TypeEnv
1371 typeEnvElts     :: TypeEnv -> [TyThing]
1372 typeEnvClasses  :: TypeEnv -> [Class]
1373 typeEnvTyCons   :: TypeEnv -> [TyCon]
1374 typeEnvIds      :: TypeEnv -> [Id]
1375 typeEnvDataCons :: TypeEnv -> [DataCon]
1376 lookupTypeEnv   :: TypeEnv -> Name -> Maybe TyThing
1377
1378 emptyTypeEnv        = emptyNameEnv
1379 typeEnvElts     env = nameEnvElts env
1380 typeEnvClasses  env = [cl | AClass cl   <- typeEnvElts env]
1381 typeEnvTyCons   env = [tc | ATyCon tc   <- typeEnvElts env]
1382 typeEnvIds      env = [id | AnId id     <- typeEnvElts env]
1383 typeEnvDataCons env = [dc | ADataCon dc <- typeEnvElts env]
1384
1385 mkTypeEnv :: [TyThing] -> TypeEnv
1386 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
1387
1388 lookupTypeEnv = lookupNameEnv
1389
1390 -- Extend the type environment
1391 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
1392 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
1393
1394 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
1395 extendTypeEnvList env things = foldl extendTypeEnv env things
1396 \end{code}
1397
1398 \begin{code}
1399 -- | Find the 'TyThing' for the given 'Name' by using all the resources
1400 -- at our disposal: the compiled modules in the 'HomePackageTable' and the
1401 -- compiled modules in other packages that live in 'PackageTypeEnv'. Note
1402 -- that this does NOT look up the 'TyThing' in the module being compiled: you
1403 -- have to do that yourself, if desired
1404 lookupType :: DynFlags
1405            -> HomePackageTable
1406            -> PackageTypeEnv
1407            -> Name
1408            -> Maybe TyThing
1409
1410 lookupType dflags hpt pte name
1411   -- in one-shot, we don't use the HPT
1412   | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg
1413   = do hm <- lookupUFM hpt (moduleName mod) -- Maybe monad
1414        lookupNameEnv (md_types (hm_details hm)) name
1415   | otherwise
1416   = lookupNameEnv pte name
1417   where mod = ASSERT( isExternalName name ) nameModule name
1418         this_pkg = thisPackage dflags
1419
1420 -- | As 'lookupType', but with a marginally easier-to-use interface
1421 -- if you have a 'HscEnv'
1422 lookupTypeHscEnv :: HscEnv -> Name -> IO (Maybe TyThing)
1423 lookupTypeHscEnv hsc_env name = do
1424     eps <- readIORef (hsc_EPS hsc_env)
1425     return $! lookupType dflags hpt (eps_PTE eps) name
1426   where
1427     dflags = hsc_dflags hsc_env
1428     hpt = hsc_HPT hsc_env
1429 \end{code}
1430
1431 \begin{code}
1432 -- | Get the 'TyCon' from a 'TyThing' if it is a type constructor thing. Panics otherwise
1433 tyThingTyCon :: TyThing -> TyCon
1434 tyThingTyCon (ATyCon tc) = tc
1435 tyThingTyCon other       = pprPanic "tyThingTyCon" (pprTyThing other)
1436
1437 -- | Get the 'Class' from a 'TyThing' if it is a class thing. Panics otherwise
1438 tyThingClass :: TyThing -> Class
1439 tyThingClass (AClass cls) = cls
1440 tyThingClass other        = pprPanic "tyThingClass" (pprTyThing other)
1441
1442 -- | Get the 'DataCon' from a 'TyThing' if it is a data constructor thing. Panics otherwise
1443 tyThingDataCon :: TyThing -> DataCon
1444 tyThingDataCon (ADataCon dc) = dc
1445 tyThingDataCon other         = pprPanic "tyThingDataCon" (pprTyThing other)
1446
1447 -- | Get the 'Id' from a 'TyThing' if it is a id *or* data constructor thing. Panics otherwise
1448 tyThingId :: TyThing -> Id
1449 tyThingId (AnId id)     = id
1450 tyThingId (ADataCon dc) = dataConWrapId dc
1451 tyThingId other         = pprPanic "tyThingId" (pprTyThing other)
1452 \end{code}
1453
1454 %************************************************************************
1455 %*                                                                      *
1456 \subsection{MonadThings and friends}
1457 %*                                                                      *
1458 %************************************************************************
1459
1460 \begin{code}
1461 -- | Class that abstracts out the common ability of the monads in GHC
1462 -- to lookup a 'TyThing' in the monadic environment by 'Name'. Provides
1463 -- a number of related convenience functions for accessing particular
1464 -- kinds of 'TyThing'
1465 class Monad m => MonadThings m where
1466         lookupThing :: Name -> m TyThing
1467
1468         lookupId :: Name -> m Id
1469         lookupId = liftM tyThingId . lookupThing
1470
1471         lookupDataCon :: Name -> m DataCon
1472         lookupDataCon = liftM tyThingDataCon . lookupThing
1473
1474         lookupTyCon :: Name -> m TyCon
1475         lookupTyCon = liftM tyThingTyCon . lookupThing
1476
1477         lookupClass :: Name -> m Class
1478         lookupClass = liftM tyThingClass . lookupThing
1479 \end{code}
1480
1481 \begin{code}
1482 -- | Constructs cache for the 'mi_hash_fn' field of a 'ModIface'
1483 mkIfaceHashCache :: [(Fingerprint,IfaceDecl)]
1484                  -> (OccName -> Maybe (OccName, Fingerprint))
1485 mkIfaceHashCache pairs
1486   = \occ -> lookupOccEnv env occ
1487   where
1488     env = foldr add_decl emptyOccEnv pairs
1489     add_decl (v,d) env0 = foldr add_imp env1 (ifaceDeclSubBndrs d)
1490       where
1491           decl_name = ifName d
1492           env1 = extendOccEnv env0 decl_name (decl_name, v)
1493           add_imp bndr env = extendOccEnv env bndr (decl_name, v)
1494
1495 emptyIfaceHashCache :: OccName -> Maybe (OccName, Fingerprint)
1496 emptyIfaceHashCache _occ = Nothing
1497 \end{code}
1498
1499 %************************************************************************
1500 %*                                                                      *
1501 \subsection{Auxiliary types}
1502 %*                                                                      *
1503 %************************************************************************
1504
1505 These types are defined here because they are mentioned in ModDetails,
1506 but they are mostly elaborated elsewhere
1507
1508 \begin{code}
1509 ------------------ Warnings -------------------------
1510 -- | Warning information for a module
1511 data Warnings
1512   = NoWarnings                          -- ^ Nothing deprecated
1513   | WarnAll WarningTxt                  -- ^ Whole module deprecated
1514   | WarnSome [(OccName,WarningTxt)]     -- ^ Some specific things deprecated
1515
1516      -- Only an OccName is needed because
1517      --    (1) a deprecation always applies to a binding
1518      --        defined in the module in which the deprecation appears.
1519      --    (2) deprecations are only reported outside the defining module.
1520      --        this is important because, otherwise, if we saw something like
1521      --
1522      --        {-# DEPRECATED f "" #-}
1523      --        f = ...
1524      --        h = f
1525      --        g = let f = undefined in f
1526      --
1527      --        we'd need more information than an OccName to know to say something
1528      --        about the use of f in h but not the use of the locally bound f in g
1529      --
1530      --        however, because we only report about deprecations from the outside,
1531      --        and a module can only export one value called f,
1532      --        an OccName suffices.
1533      --
1534      --        this is in contrast with fixity declarations, where we need to map
1535      --        a Name to its fixity declaration.
1536   deriving( Eq )
1537
1538 -- | Constructs the cache for the 'mi_warn_fn' field of a 'ModIface'
1539 mkIfaceWarnCache :: Warnings -> Name -> Maybe WarningTxt
1540 mkIfaceWarnCache NoWarnings  = \_ -> Nothing
1541 mkIfaceWarnCache (WarnAll t) = \_ -> Just t
1542 mkIfaceWarnCache (WarnSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
1543
1544 emptyIfaceWarnCache :: Name -> Maybe WarningTxt
1545 emptyIfaceWarnCache _ = Nothing
1546
1547 plusWarns :: Warnings -> Warnings -> Warnings
1548 plusWarns d NoWarnings = d
1549 plusWarns NoWarnings d = d
1550 plusWarns _ (WarnAll t) = WarnAll t
1551 plusWarns (WarnAll t) _ = WarnAll t
1552 plusWarns (WarnSome v1) (WarnSome v2) = WarnSome (v1 ++ v2)
1553 \end{code}
1554 \begin{code}
1555 -- | A collection of 'AvailInfo' - several things that are \"available\"
1556 type Avails       = [AvailInfo]
1557 -- | 'Name'd things that are available
1558 type AvailInfo    = GenAvailInfo Name
1559 -- | 'RdrName'd things that are available
1560 type RdrAvailInfo = GenAvailInfo OccName
1561
1562 -- | Records what things are "available", i.e. in scope
1563 data GenAvailInfo name  = Avail name     -- ^ An ordinary identifier in scope
1564                         | AvailTC name
1565                                   [name] -- ^ A type or class in scope. Parameters:
1566                                          --
1567                                          --  1) The name of the type or class
1568                                          --
1569                                          --  2) The available pieces of type or class.
1570                                          --     NB: If the type or class is itself
1571                                          --     to be in scope, it must be in this list.
1572                                          --     Thus, typically: @AvailTC Eq [Eq, ==, \/=]@
1573                         deriving( Eq )
1574                         -- Equality used when deciding if the interface has changed
1575
1576 -- | The original names declared of a certain module that are exported
1577 type IfaceExport = (Module, [GenAvailInfo OccName])
1578
1579 availsToNameSet :: [AvailInfo] -> NameSet
1580 availsToNameSet avails = foldr add emptyNameSet avails
1581       where add avail set = addListToNameSet set (availNames avail)
1582
1583 availsToNameEnv :: [AvailInfo] -> NameEnv AvailInfo
1584 availsToNameEnv avails = foldr add emptyNameEnv avails
1585      where add avail env = extendNameEnvList env
1586                                 (zip (availNames avail) (repeat avail))
1587
1588 -- | Just the main name made available, i.e. not the available pieces
1589 -- of type or class brought into scope by the 'GenAvailInfo'
1590 availName :: GenAvailInfo name -> name
1591 availName (Avail n)     = n
1592 availName (AvailTC n _) = n
1593
1594 -- | All names made available by the availability information
1595 availNames :: GenAvailInfo name -> [name]
1596 availNames (Avail n)      = [n]
1597 availNames (AvailTC _ ns) = ns
1598
1599 instance Outputable n => Outputable (GenAvailInfo n) where
1600    ppr = pprAvail
1601
1602 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
1603 pprAvail (Avail n)      = ppr n
1604 pprAvail (AvailTC n ns) = ppr n <> braces (hsep (punctuate comma (map ppr ns)))
1605 \end{code}
1606
1607 \begin{code}
1608 -- | Creates cached lookup for the 'mi_fix_fn' field of 'ModIface'
1609 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
1610 mkIfaceFixCache pairs
1611   = \n -> lookupOccEnv env n `orElse` defaultFixity
1612   where
1613    env = mkOccEnv pairs
1614
1615 emptyIfaceFixCache :: OccName -> Fixity
1616 emptyIfaceFixCache _ = defaultFixity
1617
1618 -- | Fixity environment mapping names to their fixities
1619 type FixityEnv = NameEnv FixItem
1620
1621 -- | Fixity information for an 'Name'. We keep the OccName in the range
1622 -- so that we can generate an interface from it
1623 data FixItem = FixItem OccName Fixity
1624
1625 instance Outputable FixItem where
1626   ppr (FixItem occ fix) = ppr fix <+> ppr occ
1627
1628 emptyFixityEnv :: FixityEnv
1629 emptyFixityEnv = emptyNameEnv
1630
1631 lookupFixity :: FixityEnv -> Name -> Fixity
1632 lookupFixity env n = case lookupNameEnv env n of
1633                         Just (FixItem _ fix) -> fix
1634                         Nothing         -> defaultFixity
1635 \end{code}
1636
1637
1638 %************************************************************************
1639 %*                                                                      *
1640 \subsection{WhatsImported}
1641 %*                                                                      *
1642 %************************************************************************
1643
1644 \begin{code}
1645 -- | Records whether a module has orphans. An \"orphan\" is one of:
1646 --
1647 -- * An instance declaration in a module other than the definition
1648 --   module for one of the type constructors or classes in the instance head
1649 --
1650 -- * A transformation rule in a module other than the one defining
1651 --   the function in the head of the rule
1652 type WhetherHasOrphans   = Bool
1653
1654 -- | Does this module define family instances?
1655 type WhetherHasFamInst = Bool
1656
1657 -- | Did this module originate from a *-boot file?
1658 type IsBootInterface = Bool
1659
1660 -- | Dependency information about modules and packages below this one
1661 -- in the import hierarchy.
1662 --
1663 -- Invariant: the dependencies of a module @M@ never includes @M@.
1664 --
1665 -- Invariant: none of the lists contain duplicates.
1666 data Dependencies
1667   = Deps { dep_mods   :: [(ModuleName, IsBootInterface)]
1668                         -- ^ Home-package module dependencies
1669          , dep_pkgs   :: [PackageId]
1670                         -- ^ External package dependencies
1671          , dep_orphs  :: [Module]
1672                         -- ^ Orphan modules (whether home or external pkg),
1673                         -- *not* including family instance orphans as they
1674                         -- are anyway included in 'dep_finsts'
1675          , dep_finsts :: [Module]
1676                         -- ^ Modules that contain family instances (whether the
1677                         -- instances are from the home or an external package)
1678          }
1679   deriving( Eq )
1680         -- Equality used only for old/new comparison in MkIface.addVersionInfo
1681
1682         -- See 'TcRnTypes.ImportAvails' for details on dependencies.
1683
1684 noDependencies :: Dependencies
1685 noDependencies = Deps [] [] [] []
1686
1687 -- | Records modules that we depend on by making a direct import from
1688 data Usage
1689   = UsagePackageModule {
1690         usg_mod      :: Module,
1691            -- ^ External package module depended on
1692         usg_mod_hash :: Fingerprint
1693     }                                           -- ^ Module from another package
1694   | UsageHomeModule {
1695         usg_mod_name :: ModuleName,
1696             -- ^ Name of the module
1697         usg_mod_hash :: Fingerprint,
1698             -- ^ Cached module fingerprint
1699         usg_entities :: [(OccName,Fingerprint)],
1700             -- ^ Entities we depend on, sorted by occurrence name and fingerprinted.
1701             -- NB: usages are for parent names only, e.g. type constructors
1702             -- but not the associated data constructors.
1703         usg_exports  :: Maybe Fingerprint
1704             -- ^ Fingerprint for the export list we used to depend on this module,
1705             -- if we depend on the export list
1706     }                                           -- ^ Module from the current package
1707     deriving( Eq )
1708         -- The export list field is (Just v) if we depend on the export list:
1709         --      i.e. we imported the module directly, whether or not we
1710         --           enumerated the things we imported, or just imported
1711         --           everything
1712         -- We need to recompile if M's exports change, because
1713         -- if the import was    import M,       we might now have a name clash
1714         --                                      in the importing module.
1715         -- if the import was    import M(x)     M might no longer export x
1716         -- The only way we don't depend on the export list is if we have
1717         --                      import M()
1718         -- And of course, for modules that aren't imported directly we don't
1719         -- depend on their export lists
1720 \end{code}
1721
1722
1723 %************************************************************************
1724 %*                                                                      *
1725                 The External Package State
1726 %*                                                                      *
1727 %************************************************************************
1728
1729 \begin{code}
1730 type PackageTypeEnv    = TypeEnv
1731 type PackageRuleBase   = RuleBase
1732 type PackageInstEnv    = InstEnv
1733 type PackageFamInstEnv = FamInstEnv
1734 type PackageVectInfo   = VectInfo
1735 type PackageAnnEnv     = AnnEnv
1736
1737 -- | Information about other packages that we have slurped in by reading
1738 -- their interface files
1739 data ExternalPackageState
1740   = EPS {
1741         eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
1742                 -- ^ In OneShot mode (only), home-package modules
1743                 -- accumulate in the external package state, and are
1744                 -- sucked in lazily.  For these home-pkg modules
1745                 -- (only) we need to record which are boot modules.
1746                 -- We set this field after loading all the
1747                 -- explicitly-imported interfaces, but before doing
1748                 -- anything else
1749                 --
1750                 -- The 'ModuleName' part is not necessary, but it's useful for
1751                 -- debug prints, and it's convenient because this field comes
1752                 -- direct from 'TcRnTypes.imp_dep_mods'
1753
1754         eps_PIT :: !PackageIfaceTable,
1755                 -- ^ The 'ModIface's for modules in external packages
1756                 -- whose interfaces we have opened.
1757                 -- The declarations in these interface files are held in the
1758                 -- 'eps_decls', 'eps_inst_env', 'eps_fam_inst_env' and 'eps_rules'
1759                 -- fields of this record, not in the 'mi_decls' fields of the
1760                 -- interface we have sucked in.
1761                 --
1762                 -- What /is/ in the PIT is:
1763                 --
1764                 -- * The Module
1765                 --
1766                 -- * Fingerprint info
1767                 --
1768                 -- * Its exports
1769                 --
1770                 -- * Fixities
1771                 --
1772                 -- * Deprecations and warnings
1773
1774         eps_PTE :: !PackageTypeEnv,
1775                 -- ^ Result of typechecking all the external package
1776                 -- interface files we have sucked in. The domain of
1777                 -- the mapping is external-package modules
1778
1779         eps_inst_env     :: !PackageInstEnv,   -- ^ The total 'InstEnv' accumulated
1780                                                -- from all the external-package modules
1781         eps_fam_inst_env :: !PackageFamInstEnv,-- ^ The total 'FamInstEnv' accumulated
1782                                                -- from all the external-package modules
1783         eps_rule_base    :: !PackageRuleBase,  -- ^ The total 'RuleEnv' accumulated
1784                                                -- from all the external-package modules
1785         eps_vect_info    :: !PackageVectInfo,  -- ^ The total 'VectInfo' accumulated
1786                                                -- from all the external-package modules
1787         eps_ann_env      :: !PackageAnnEnv,    -- ^ The total 'AnnEnv' accumulated
1788                                                -- from all the external-package modules
1789
1790         eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv), -- ^ The family instances accumulated from external
1791                                                          -- packages, keyed off the module that declared them
1792
1793         eps_stats :: !EpsStats                 -- ^ Stastics about what was loaded from external packages
1794   }
1795
1796 -- | Accumulated statistics about what we are putting into the 'ExternalPackageState'.
1797 -- \"In\" means stuff that is just /read/ from interface files,
1798 -- \"Out\" means actually sucked in and type-checked
1799 data EpsStats = EpsStats { n_ifaces_in
1800                          , n_decls_in, n_decls_out
1801                          , n_rules_in, n_rules_out
1802                          , n_insts_in, n_insts_out :: !Int }
1803
1804 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
1805 -- ^ Add stats for one newly-read interface
1806 addEpsInStats stats n_decls n_insts n_rules
1807   = stats { n_ifaces_in = n_ifaces_in stats + 1
1808           , n_decls_in  = n_decls_in stats + n_decls
1809           , n_insts_in  = n_insts_in stats + n_insts
1810           , n_rules_in  = n_rules_in stats + n_rules }
1811 \end{code}
1812
1813 Names in a NameCache are always stored as a Global, and have the SrcLoc
1814 of their binding locations.
1815
1816 Actually that's not quite right.  When we first encounter the original
1817 name, we might not be at its binding site (e.g. we are reading an
1818 interface file); so we give it 'noSrcLoc' then.  Later, when we find
1819 its binding site, we fix it up.
1820
1821 \begin{code}
1822 -- | The NameCache makes sure that there is just one Unique assigned for
1823 -- each original name; i.e. (module-name, occ-name) pair and provides
1824 -- something of a lookup mechanism for those names.
1825 data NameCache
1826  = NameCache {  nsUniqs :: UniqSupply,
1827                 -- ^ Supply of uniques
1828                 nsNames :: OrigNameCache,
1829                 -- ^ Ensures that one original name gets one unique
1830                 nsIPs   :: OrigIParamCache
1831                 -- ^ Ensures that one implicit parameter name gets one unique
1832    }
1833
1834 -- | Per-module cache of original 'OccName's given 'Name's
1835 type OrigNameCache   = ModuleEnv (OccEnv Name)
1836
1837 -- | Module-local cache of implicit parameter 'OccName's given 'Name's
1838 type OrigIParamCache = FiniteMap (IPName OccName) (IPName Name)
1839 \end{code}
1840
1841
1842
1843 %************************************************************************
1844 %*                                                                      *
1845                 The module graph and ModSummary type
1846         A ModSummary is a node in the compilation manager's
1847         dependency graph, and it's also passed to hscMain
1848 %*                                                                      *
1849 %************************************************************************
1850
1851 \begin{code}
1852 -- | A ModuleGraph contains all the nodes from the home package (only).
1853 -- There will be a node for each source module, plus a node for each hi-boot
1854 -- module.
1855 --
1856 -- The graph is not necessarily stored in topologically-sorted order.
1857 type ModuleGraph = [ModSummary]
1858
1859 emptyMG :: ModuleGraph
1860 emptyMG = []
1861
1862 -- | A single node in a 'ModuleGraph. The nodes of the module graph are one of:
1863 --
1864 -- * A regular Haskell source module
1865 --
1866 -- * A hi-boot source module
1867 --
1868 -- * An external-core source module
1869 data ModSummary
1870    = ModSummary {
1871         ms_mod       :: Module,                 -- ^ Identity of the module
1872         ms_hsc_src   :: HscSource,              -- ^ The module source either plain Haskell, hs-boot or external core
1873         ms_location  :: ModLocation,            -- ^ Location of the various files belonging to the module
1874         ms_hs_date   :: ClockTime,              -- ^ Timestamp of source file
1875         ms_obj_date  :: Maybe ClockTime,        -- ^ Timestamp of object, if we have one
1876         ms_srcimps   :: [Located ModuleName],   -- ^ Source imports of the module
1877         ms_imps      :: [Located ModuleName],   -- ^ Non-source imports of the module
1878         ms_hspp_file :: FilePath,               -- ^ Filename of preprocessed source file
1879         ms_hspp_opts :: DynFlags,               -- ^ Cached flags from @OPTIONS@, @INCLUDE@
1880                                                 -- and @LANGUAGE@ pragmas in the modules source code
1881         ms_hspp_buf  :: Maybe StringBuffer      -- ^ The actual preprocessed source, if we have it
1882      }
1883
1884 ms_mod_name :: ModSummary -> ModuleName
1885 ms_mod_name = moduleName . ms_mod
1886
1887 -- The ModLocation contains both the original source filename and the
1888 -- filename of the cleaned-up source file after all preprocessing has been
1889 -- done.  The point is that the summariser will have to cpp/unlit/whatever
1890 -- all files anyway, and there's no point in doing this twice -- just
1891 -- park the result in a temp file, put the name of it in the location,
1892 -- and let @compile@ read from that file on the way back up.
1893
1894 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
1895 -- the ms_hs_date and imports can, of course, change
1896
1897 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
1898 msHsFilePath  ms = expectJust "msHsFilePath" (ml_hs_file  (ms_location ms))
1899 msHiFilePath  ms = ml_hi_file  (ms_location ms)
1900 msObjFilePath ms = ml_obj_file (ms_location ms)
1901
1902 -- | Did this 'ModSummary' originate from a hs-boot file?
1903 isBootSummary :: ModSummary -> Bool
1904 isBootSummary ms = isHsBoot (ms_hsc_src ms)
1905
1906 instance Outputable ModSummary where
1907    ppr ms
1908       = sep [text "ModSummary {",
1909              nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
1910                           text "ms_mod =" <+> ppr (ms_mod ms)
1911                                 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
1912                           text "ms_imps =" <+> ppr (ms_imps ms),
1913                           text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
1914              char '}'
1915             ]
1916
1917 showModMsg :: HscTarget -> Bool -> ModSummary -> String
1918 showModMsg target recomp mod_summary
1919   = showSDoc $
1920         hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
1921               char '(', text (normalise $ msHsFilePath mod_summary) <> comma,
1922               case target of
1923                   HscInterpreted | recomp
1924                              -> text "interpreted"
1925                   HscNothing -> text "nothing"
1926                   _          -> text (normalise $ msObjFilePath mod_summary),
1927               char ')']
1928  where
1929     mod     = moduleName (ms_mod mod_summary)
1930     mod_str = showSDoc (ppr mod) ++ hscSourceString (ms_hsc_src mod_summary)
1931 \end{code}
1932
1933
1934 %************************************************************************
1935 %*                                                                      *
1936 \subsection{Hpc Support}
1937 %*                                                                      *
1938 %************************************************************************
1939
1940 \begin{code}
1941 -- | Information about a modules use of Haskell Program Coverage
1942 data HpcInfo
1943   = HpcInfo
1944      { hpcInfoTickCount :: Int
1945      , hpcInfoHash      :: Int
1946      }
1947   | NoHpcInfo
1948      { hpcUsed          :: AnyHpcUsage  -- ^ Is hpc used anywhere on the module \*tree\*?
1949      }
1950
1951 -- | This is used to signal if one of my imports used HPC instrumentation
1952 -- even if there is no module-local HPC usage
1953 type AnyHpcUsage = Bool
1954
1955 emptyHpcInfo :: AnyHpcUsage -> HpcInfo
1956 emptyHpcInfo = NoHpcInfo
1957
1958 -- | Find out if HPC is used by this module or any of the modules
1959 -- it depends upon
1960 isHpcUsed :: HpcInfo -> AnyHpcUsage
1961 isHpcUsed (HpcInfo {})                   = True
1962 isHpcUsed (NoHpcInfo { hpcUsed = used }) = used
1963 \end{code}
1964
1965 %************************************************************************
1966 %*                                                                      *
1967 \subsection{Vectorisation Support}
1968 %*                                                                      *
1969 %************************************************************************
1970
1971 The following information is generated and consumed by the vectorisation
1972 subsystem.  It communicates the vectorisation status of declarations from one
1973 module to another.
1974
1975 Why do we need both f and f_v in the ModGuts/ModDetails/EPS version VectInfo
1976 below?  We need to know `f' when converting to IfaceVectInfo.  However, during
1977 vectorisation, we need to know `f_v', whose `Var' we cannot lookup based
1978 on just the OccName easily in a Core pass.
1979
1980 \begin{code}
1981 -- | Vectorisation information for 'ModGuts', 'ModDetails' and 'ExternalPackageState'.
1982 -- All of this information is always tidy, even in ModGuts.
1983 data VectInfo
1984   = VectInfo {
1985       vectInfoVar     :: VarEnv  (Var    , Var  ),   -- ^ @(f, f_v)@ keyed on @f@
1986       vectInfoTyCon   :: NameEnv (TyCon  , TyCon),   -- ^ @(T, T_v)@ keyed on @T@
1987       vectInfoDataCon :: NameEnv (DataCon, DataCon), -- ^ @(C, C_v)@ keyed on @C@
1988       vectInfoPADFun  :: NameEnv (TyCon  , Var),     -- ^ @(T_v, paT)@ keyed on @T_v@
1989       vectInfoIso     :: NameEnv (TyCon  , Var)      -- ^ @(T, isoT)@ keyed on @T@
1990     }
1991
1992 -- | Vectorisation information for 'ModIface': a slightly less low-level view
1993 data IfaceVectInfo
1994   = IfaceVectInfo {
1995       ifaceVectInfoVar        :: [Name],
1996         -- ^ All variables in here have a vectorised variant
1997       ifaceVectInfoTyCon      :: [Name],
1998         -- ^ All 'TyCon's in here have a vectorised variant;
1999         -- the name of the vectorised variant and those of its
2000         -- data constructors are determined by 'OccName.mkVectTyConOcc'
2001         -- and 'OccName.mkVectDataConOcc'; the names of
2002         -- the isomorphisms are determined by 'OccName.mkVectIsoOcc'
2003       ifaceVectInfoTyConReuse :: [Name]
2004         -- ^ The vectorised form of all the 'TyCon's in here coincides with
2005         -- the unconverted form; the name of the isomorphisms is determined
2006         -- by 'OccName.mkVectIsoOcc'
2007     }
2008
2009 noVectInfo :: VectInfo
2010 noVectInfo = VectInfo emptyVarEnv emptyNameEnv emptyNameEnv emptyNameEnv emptyNameEnv
2011
2012 plusVectInfo :: VectInfo -> VectInfo -> VectInfo
2013 plusVectInfo vi1 vi2 =
2014   VectInfo (vectInfoVar     vi1 `plusVarEnv`  vectInfoVar     vi2)
2015            (vectInfoTyCon   vi1 `plusNameEnv` vectInfoTyCon   vi2)
2016            (vectInfoDataCon vi1 `plusNameEnv` vectInfoDataCon vi2)
2017            (vectInfoPADFun  vi1 `plusNameEnv` vectInfoPADFun  vi2)
2018            (vectInfoIso     vi1 `plusNameEnv` vectInfoIso     vi2)
2019
2020 concatVectInfo :: [VectInfo] -> VectInfo
2021 concatVectInfo = foldr plusVectInfo noVectInfo
2022
2023 noIfaceVectInfo :: IfaceVectInfo
2024 noIfaceVectInfo = IfaceVectInfo [] [] []
2025 \end{code}
2026
2027 %************************************************************************
2028 %*                                                                      *
2029 \subsection{Linkable stuff}
2030 %*                                                                      *
2031 %************************************************************************
2032
2033 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
2034 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
2035
2036 \begin{code}
2037 -- | Information we can use to dynamically link modules into the compiler
2038 data Linkable = LM {
2039   linkableTime     :: ClockTime,        -- ^ Time at which this linkable was built
2040                                         -- (i.e. when the bytecodes were produced,
2041                                         --       or the mod date on the files)
2042   linkableModule   :: Module,           -- ^ The linkable module itself
2043   linkableUnlinked :: [Unlinked]
2044     -- ^ Those files and chunks of code we have yet to link.
2045     --
2046     -- INVARIANT: A valid linkable always has at least one 'Unlinked' item.
2047     -- If this list is empty, the Linkable represents a fake linkable, which
2048     -- is generated in HscNothing mode to avoid recompiling modules.
2049     --
2050     -- XXX: Do items get removed from this list when they get linked?
2051  }
2052
2053 isObjectLinkable :: Linkable -> Bool
2054 isObjectLinkable l = not (null unlinked) && all isObject unlinked
2055   where unlinked = linkableUnlinked l
2056         -- A linkable with no Unlinked's is treated as a BCO.  We can
2057         -- generate a linkable with no Unlinked's as a result of
2058         -- compiling a module in HscNothing mode, and this choice
2059         -- happens to work well with checkStability in module GHC.
2060
2061 instance Outputable Linkable where
2062    ppr (LM when_made mod unlinkeds)
2063       = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
2064         $$ nest 3 (ppr unlinkeds)
2065
2066 -------------------------------------------
2067
2068 -- | Objects which have yet to be linked by the compiler
2069 data Unlinked
2070    = DotO FilePath      -- ^ An object file (.o)
2071    | DotA FilePath      -- ^ Static archive file (.a)
2072    | DotDLL FilePath    -- ^ Dynamically linked library file (.so, .dll, .dylib)
2073    | BCOs CompiledByteCode ModBreaks    -- ^ A byte-code object, lives only in memory
2074
2075 #ifndef GHCI
2076 data CompiledByteCode = CompiledByteCodeUndefined
2077 _unused :: CompiledByteCode
2078 _unused = CompiledByteCodeUndefined
2079 #endif
2080
2081 instance Outputable Unlinked where
2082    ppr (DotO path)   = text "DotO" <+> text path
2083    ppr (DotA path)   = text "DotA" <+> text path
2084    ppr (DotDLL path) = text "DotDLL" <+> text path
2085 #ifdef GHCI
2086    ppr (BCOs bcos _) = text "BCOs" <+> ppr bcos
2087 #else
2088    ppr (BCOs _ _)    = text "No byte code"
2089 #endif
2090
2091 -- | Is this an actual file on disk we can link in somehow?
2092 isObject :: Unlinked -> Bool
2093 isObject (DotO _)   = True
2094 isObject (DotA _)   = True
2095 isObject (DotDLL _) = True
2096 isObject _          = False
2097
2098 -- | Is this a bytecode linkable with no file on disk?
2099 isInterpretable :: Unlinked -> Bool
2100 isInterpretable = not . isObject
2101
2102 -- | Retrieve the filename of the linkable if possible. Panic if it is a byte-code object
2103 nameOfObject :: Unlinked -> FilePath
2104 nameOfObject (DotO fn)   = fn
2105 nameOfObject (DotA fn)   = fn
2106 nameOfObject (DotDLL fn) = fn
2107 nameOfObject other       = pprPanic "nameOfObject" (ppr other)
2108
2109 -- | Retrieve the compiled byte-code if possible. Panic if it is a file-based linkable
2110 byteCodeOfObject :: Unlinked -> CompiledByteCode
2111 byteCodeOfObject (BCOs bc _) = bc
2112 byteCodeOfObject other       = pprPanic "byteCodeOfObject" (ppr other)
2113 \end{code}
2114
2115 %************************************************************************
2116 %*                                                                      *
2117 \subsection{Breakpoint Support}
2118 %*                                                                      *
2119 %************************************************************************
2120
2121 \begin{code}
2122 -- | Breakpoint index
2123 type BreakIndex = Int
2124
2125 -- | All the information about the breakpoints for a given module
2126 data ModBreaks
2127    = ModBreaks
2128    { modBreaks_flags :: BreakArray
2129         -- ^ The array of flags, one per breakpoint,
2130         -- indicating which breakpoints are enabled.
2131    , modBreaks_locs :: !(Array BreakIndex SrcSpan)
2132         -- ^ An array giving the source span of each breakpoint.
2133    , modBreaks_vars :: !(Array BreakIndex [OccName])
2134         -- ^ An array giving the names of the free variables at each breakpoint.
2135    }
2136
2137 emptyModBreaks :: ModBreaks
2138 emptyModBreaks = ModBreaks
2139    { modBreaks_flags = error "ModBreaks.modBreaks_array not initialised"
2140          -- Todo: can we avoid this?
2141    , modBreaks_locs = array (0,-1) []
2142    , modBreaks_vars = array (0,-1) []
2143    }
2144 \end{code}