ghc/compiler/main/HscTypes.lhs

   1 %
   2 % (c) The University of Glasgow, 2000
   3 %
   4 \section[HscTypes]{Types for the per-module compiler}
   5
   6 \begin{code}
   7 module HscTypes (
   8         Finder, ModuleLocation(..),
   9
  10         ModDetails(..), ModIface(..), GlobalSymbolTable,
  11         HomeSymbolTable, PackageSymbolTable,
  12         HomeIfaceTable, PackageIfaceTable,
  13         lookupTable, lookupTableByModName,
  14
  15         IfaceDecls(..),
  16
  17         VersionInfo(..), initialVersionInfo,
  18
  19         TyThing(..), groupTyThings, isTyClThing,
  20
  21         TypeEnv, extendTypeEnv, lookupTypeEnv,
  22
  23         WhetherHasOrphans, ImportVersion, WhatsImported(..),
  24         PersistentRenamerState(..), IsBootInterface, Avails, DeclsMap,
  25         IfaceInsts, IfaceRules, GatedDecl,
  26         OrigNameEnv(..), OrigNameNameEnv, OrigNameIParamEnv,
  27         AvailEnv, AvailInfo, GenAvailInfo(..),
  28         PersistentCompilerState(..),
  29
  30         Deprecations(..), lookupDeprec,
  31
  32         InstEnv, ClsInstEnv, DFunId,
  33         PackageInstEnv, PackageRuleBase,
  34
  35         GlobalRdrEnv, RdrAvailInfo,
  36
  37         -- Provenance
  38         Provenance(..), ImportReason(..), PrintUnqualified,
  39         pprNameProvenance, hasBetterProv
  40
  41     ) where
  42
  43 #include "HsVersions.h"
  44
  45 import RdrName          ( RdrNameEnv, emptyRdrEnv )
  46 import Name             ( Name, NameEnv, NamedThing,
  47                           emptyNameEnv, unitNameEnv, extendNameEnv, plusNameEnv,
  48                           lookupNameEnv, emptyNameEnv, getName, nameModule,
  49                           nameSrcLoc )
  50 import NameSet          ( NameSet )
  51 import OccName          ( OccName )
  52 import Module           ( Module, ModuleName, ModuleEnv,
  53                           lookupModuleEnv, lookupModuleEnvByName
  54                         )
  55 import Rules            ( RuleBase )
  56 import VarSet           ( TyVarSet )
  57 import Id               ( Id )
  58 import Class            ( Class )
  59 import TyCon            ( TyCon )
  60
  61 import BasicTypes       ( Version, initialVersion, Fixity )
  62
  63 import HsSyn            ( DeprecTxt )
  64 import RdrHsSyn         ( RdrNameHsDecl, RdrNameTyClDecl )
  65 import RnHsSyn          ( RenamedTyClDecl, RenamedRuleDecl, RenamedInstDecl )
  66
  67 import CoreSyn          ( CoreRule, IdCoreRule )
  68 import Type             ( Type )
  69
  70 import FiniteMap        ( FiniteMap, emptyFM, addToFM, lookupFM, foldFM )
  71 import Bag              ( Bag )
  72 import Maybes           ( seqMaybe )
  73 import UniqFM           ( UniqFM )
  74 import Outputable
  75 import SrcLoc           ( SrcLoc, isGoodSrcLoc )
  76 import Util             ( thenCmp )
  77 import UniqSupply       ( UniqSupply )
  78 \end{code}
  79
  80 %************************************************************************
  81 %*                                                                      *
  82 \subsection{The Finder type}
  83 %*                                                                      *
  84 %************************************************************************
  85
  86 \begin{code}
  87 type Finder = ModuleName -> IO (Maybe (Module, ModuleLocation))
  88
  89 data ModuleLocation
  90    = ModuleLocation {
  91         hs_file  :: FilePath,
  92         hi_file  :: FilePath,
  93         obj_file :: FilePath
  94       }
  95 \end{code}
  96
  97 For a module in another package, the hs_file and obj_file
  98 components of ModuleLocation are undefined.
  99
 100 The locations specified by a ModuleLocation may or may not
 101 correspond to actual files yet: for example, even if the object
 102 file doesn't exist, the ModuleLocation still contains the path to
 103 where the object file will reside if/when it is created.
 104
 105
 106 %************************************************************************
 107 %*                                                                      *
 108 \subsection{Symbol tables and Module details}
 109 %*                                                                      *
 110 %************************************************************************
 111
 112 A @ModIface@ plus a @ModDetails@ summarises everything we know
 113 about a compiled module.  The @ModIface@ is the stuff *before* linking,
 114 and can be written out to an interface file.  The @ModDetails@ is after
 115 linking; it is the "linked" form of the mi_decls field.
 116
 117 \begin{code}
 118 data ModIface
 119    = ModIface {
 120         mi_module   :: Module,                  -- Complete with package info
 121         mi_version  :: VersionInfo,             -- Module version number
 122         mi_orphan   :: WhetherHasOrphans,       -- Whether this module has orphans
 123
 124         mi_usages   :: [ImportVersion Name],    -- Usages; kept sorted so that it's easy
 125                                                 -- to decide whether to write a new iface file
 126                                                 -- (changing usages doesn't affect the version of
 127                                                 --  this module)
 128
 129         mi_exports  :: Avails,                  -- What it exports
 130                                                 -- Kept sorted by (mod,occ),
 131                                                 -- to make version comparisons easier
 132
 133         mi_globals  :: GlobalRdrEnv,            -- Its top level environment
 134
 135         mi_fixities :: NameEnv Fixity,          -- Fixities
 136         mi_deprecs  :: Deprecations,            -- Deprecations
 137
 138         mi_decls    :: IfaceDecls               -- The RnDecls form of ModDetails
 139      }
 140
 141 data IfaceDecls = IfaceDecls { dcl_tycl  :: [RenamedTyClDecl],  -- Sorted
 142                                dcl_rules :: [RenamedRuleDecl],  -- Sorted
 143                                dcl_insts :: [RenamedInstDecl] } -- Unsorted
 144
 145 -- typechecker should only look at this, not ModIface
 146 -- Should be able to construct ModDetails from mi_decls in ModIface
 147 data ModDetails
 148    = ModDetails {
 149         -- The next three fields are created by the typechecker
 150         md_types    :: TypeEnv,
 151         md_insts    :: [DFunId],        -- Dfun-ids for the instances in this module
 152         md_rules    :: [IdCoreRule]     -- Domain may include Ids from other modules
 153      }
 154 \end{code}
 155
 156 \begin{code}
 157 emptyModDetails :: ModDetails
 158 emptyModDetails
 159   = ModDetails { md_types = emptyTypeEnv,
 160                  md_insts = [],
 161                  md_rules = []
 162     }
 163
 164 emptyModIface :: Module -> ModIface
 165 emptyModIface mod
 166   = ModIface { mi_module   = mod,
 167                mi_exports  = [],
 168                mi_globals  = emptyRdrEnv,
 169                mi_deprecs  = NoDeprecs
 170     }
 171 \end{code}
 172
 173 Symbol tables map modules to ModDetails:
 174
 175 \begin{code}
 176 type SymbolTable        = ModuleEnv ModDetails
 177 type IfaceTable         = ModuleEnv ModIface
 178
 179 type HomeIfaceTable     = IfaceTable
 180 type PackageIfaceTable  = IfaceTable
 181
 182 type HomeSymbolTable    = SymbolTable   -- Domain = modules in the home package
 183 type PackageSymbolTable = SymbolTable   -- Domain = modules in the some other package
 184 type GlobalSymbolTable  = SymbolTable   -- Domain = all modules
 185 \end{code}
 186
 187 Simple lookups in the symbol table.
 188
 189 \begin{code}
 190 lookupTable :: ModuleEnv a -> ModuleEnv a -> Name -> Maybe a
 191 -- We often have two Symbol- or IfaceTables, and want to do a lookup
 192 lookupTable ht pt name
 193   = lookupModuleEnv ht mod `seqMaybe` lookupModuleEnv pt mod
 194   where
 195     mod = nameModule name
 196
 197 lookupTableByModName :: ModuleEnv a -> ModuleEnv a -> ModuleName -> Maybe a
 198 -- We often have two Symbol- or IfaceTables, and want to do a lookup
 199 lookupTableByModName ht pt mod
 200   = lookupModuleEnvByName ht mod `seqMaybe` lookupModuleEnvByName pt mod
 201 \end{code}
 202
 203
 204 %************************************************************************
 205 %*                                                                      *
 206 \subsection{Type environment stuff}
 207 %*                                                                      *
 208 %************************************************************************
 209
 210 \begin{code}
 211 type TypeEnv = NameEnv TyThing
 212 emptyTypeEnv = emptyNameEnv
 213
 214 data TyThing = AnId   Id
 215              | ATyCon TyCon
 216              | AClass Class
 217
 218 isTyClThing :: TyThing -> Bool
 219 isTyClThing (ATyCon _) = True
 220 isTyClThing (AClass _) = True
 221 isTyClThing (AnId   _) = False
 222
 223 instance NamedThing TyThing where
 224   getName (AnId id)   = getName id
 225   getName (ATyCon tc) = getName tc
 226   getName (AClass cl) = getName cl
 227 \end{code}
 228
 229
 230 \begin{code}
 231 lookupTypeEnv :: SymbolTable -> Name -> Maybe TyThing
 232 lookupTypeEnv tbl name
 233   = case lookupModuleEnv tbl (nameModule name) of
 234         Just details -> lookupNameEnv (md_types details) name
 235         Nothing      -> Nothing
 236
 237
 238 groupTyThings :: [TyThing] -> FiniteMap Module TypeEnv
 239   -- Finite map because we want the range too
 240 groupTyThings things
 241   = foldl add emptyFM things
 242   where
 243     add :: FiniteMap Module TypeEnv -> TyThing -> FiniteMap Module TypeEnv
 244     add tbl thing = addToFM tbl mod new_env
 245                   where
 246                     name    = getName thing
 247                     mod     = nameModule name
 248                     new_env = case lookupFM tbl mod of
 249                                 Nothing  -> unitNameEnv name thing
 250                                 Just env -> extendNameEnv env name thing
 251
 252 extendTypeEnv :: SymbolTable -> FiniteMap Module TypeEnv -> SymbolTable
 253 extendTypeEnv tbl things
 254   = foldFM add tbl things
 255   where
 256     add mod type_env tbl
 257         = panic "extendTypeEnv" --extendModuleEnv mod new_details
 258         where
 259           new_details
 260              = case lookupModuleEnv tbl mod of
 261                   Nothing      -> emptyModDetails {md_types = type_env}
 262                   Just details -> details {md_types = md_types details
 263                                                      `plusNameEnv` type_env}
 264 \end{code}
 265
 266
 267 %************************************************************************
 268 %*                                                                      *
 269 \subsection{Auxiliary types}
 270 %*                                                                      *
 271 %************************************************************************
 272
 273 These types are defined here because they are mentioned in ModDetails,
 274 but they are mostly elaborated elsewhere
 275
 276 \begin{code}
 277 data VersionInfo
 278   = VersionInfo {
 279         vers_module  :: Version,        -- Changes when anything changes
 280         vers_exports :: Version,        -- Changes when export list changes
 281         vers_rules   :: Version,        -- Changes when any rule changes
 282         vers_decls   :: NameEnv Version
 283                 -- Versions for "big" names only (not data constructors, class ops)
 284                 -- The version of an Id changes if its fixity changes
 285                 -- Ditto data constructors, class operations, except that the version of
 286                 -- the parent class/tycon changes
 287     }
 288
 289 initialVersionInfo :: VersionInfo
 290 initialVersionInfo = VersionInfo { vers_module  = initialVersion,
 291                                    vers_exports = initialVersion,
 292                                    vers_rules   = initialVersion,
 293                                    vers_decls   = emptyNameEnv }
 294
 295 data Deprecations = NoDeprecs
 296                   | DeprecAll DeprecTxt                 -- Whole module deprecated
 297                   | DeprecSome (NameEnv DeprecTxt)      -- Some things deprecated
 298                                                         -- Just "big" names
 299
 300 lookupDeprec :: ModIface -> Name -> Maybe DeprecTxt
 301 lookupDeprec iface name
 302   = case mi_deprecs iface of
 303         NoDeprecs      -> Nothing
 304         DeprecAll txt  -> Just txt
 305         DeprecSome env -> lookupNameEnv env name
 306
 307 type InstEnv    = UniqFM ClsInstEnv             -- Maps Class to instances for that class
 308
 309 type ClsInstEnv = [(TyVarSet, [Type], DFunId)]  -- The instances for a particular class
 310 type DFunId     = Id
 311 \end{code}
 312
 313
 314 \begin{code}
 315 type Avails       = [AvailInfo]
 316 type AvailInfo    = GenAvailInfo Name
 317 type RdrAvailInfo = GenAvailInfo OccName
 318
 319 data GenAvailInfo name  = Avail name     -- An ordinary identifier
 320                         | AvailTC name   -- The name of the type or class
 321                                   [name] -- The available pieces of type/class.
 322                                          -- NB: If the type or class is itself
 323                                          -- to be in scope, it must be in this list.
 324                                          -- Thus, typically: AvailTC Eq [Eq, ==, /=]
 325                         deriving( Eq )
 326                         -- Equality used when deciding if the interface has changed
 327
 328 type AvailEnv     = NameEnv AvailInfo   -- Maps a Name to the AvailInfo that contains it
 329 \end{code}
 330
 331
 332 %************************************************************************
 333 %*                                                                      *
 334 \subsection{ModIface}
 335 %*                                                                      *
 336 %************************************************************************
 337
 338 \begin{code}
 339 type WhetherHasOrphans   = Bool
 340         -- An "orphan" is
 341         --      * an instance decl in a module other than the defn module for
 342         --              one of the tycons or classes in the instance head
 343         --      * a transformation rule in a module other than the one defining
 344         --              the function in the head of the rule.
 345
 346 type IsBootInterface     = Bool
 347
 348 type ImportVersion name  = (ModuleName, WhetherHasOrphans, IsBootInterface, WhatsImported name)
 349
 350 data WhatsImported name  = NothingAtAll                         -- The module is below us in the
 351                                                                 -- hierarchy, but we import nothing
 352
 353                          | Everything Version           -- Used for modules from other packages;
 354                                                         -- we record only the module's version number
 355
 356                          | Specifically
 357                                 Version                 -- Module version
 358                                 (Maybe Version)         -- Export-list version, if we depend on it
 359                                 [(name,Version)]        -- List guaranteed non-empty
 360                                 Version                 -- Rules version
 361
 362                          deriving( Eq )
 363         -- 'Specifically' doesn't let you say "I imported f but none of the rules in
 364         -- the module". If you use anything in the module you get its rule version
 365         -- So if the rules change, you'll recompile, even if you don't use them.
 366         -- This is easy to implement, and it's safer: you might not have used the rules last
 367         -- time round, but if someone has added a new rule you might need it this time
 368
 369         -- The export list field is (Just v) if we depend on the export list:
 370         --      we imported the module without saying exactly what we imported
 371         -- We need to recompile if the module exports changes, because we might
 372         -- now have a name clash in the importing module.
 373 \end{code}
 374
 375
 376 %************************************************************************
 377 %*                                                                      *
 378 \subsection{The persistent compiler state}
 379 %*                                                                      *
 380 %************************************************************************
 381
 382 \begin{code}
 383 data PersistentCompilerState
 384    = PCS {
 385         pcs_PIT :: PackageIfaceTable,   -- Domain = non-home-package modules
 386                                         --   the mi_decls component is empty
 387
 388         pcs_PST :: PackageSymbolTable,  -- Domain = non-home-package modules
 389                                         --   except that the InstEnv components is empty
 390
 391         pcs_insts :: PackageInstEnv,    -- The total InstEnv accumulated from all
 392                                         --   the non-home-package modules
 393
 394         pcs_rules :: PackageRuleBase,   -- Ditto RuleEnv
 395
 396         pcs_PRS :: PersistentRenamerState
 397      }
 398
 399 \end{code}
 400
 401 The @PersistentRenamerState@ persists across successive calls to the
 402 compiler.
 403
 404 It contains:
 405   * A name supply, which deals with allocating unique names to
 406     (Module,OccName) original names,
 407
 408   * An accumulated InstEnv from all the modules in pcs_PST
 409     The point is that we don't want to keep recreating it whenever
 410     we compile a new module.  The InstEnv component of pcPST is empty.
 411     (This means we might "see" instances that we shouldn't "really" see;
 412     but the Haskell Report is vague on what is meant to be visible,
 413     so we just take the easy road here.)
 414
 415   * Ditto for rules
 416
 417   * A "holding pen" for declarations that have been read out of
 418     interface files but not yet sucked in, renamed, and typechecked
 419
 420 \begin{code}
 421 type PackageRuleBase = RuleBase
 422 type PackageInstEnv  = InstEnv
 423
 424 data PersistentRenamerState
 425   = PRS { prsOrig  :: OrigNameEnv,
 426           prsDecls :: DeclsMap,
 427           prsInsts :: IfaceInsts,
 428           prsRules :: IfaceRules,
 429           prsNS    :: UniqSupply
 430     }
 431 \end{code}
 432
 433 The OrigNameEnv makes sure that there is just one Unique assigned for
 434 each original name; i.e. (module-name, occ-name) pair.  The Name is
 435 always stored as a Global, and has the SrcLoc of its binding location.
 436 Actually that's not quite right.  When we first encounter the original
 437 name, we might not be at its binding site (e.g. we are reading an
 438 interface file); so we give it 'noSrcLoc' then.  Later, when we find
 439 its binding site, we fix it up.
 440
 441 Exactly the same is true of the Module stored in the Name.  When we first
 442 encounter the occurrence, we may not know the details of the module, so
 443 we just store junk.  Then when we find the binding site, we fix it up.
 444
 445 \begin{code}
 446 data OrigNameEnv
 447  = Orig { origNames  :: OrigNameNameEnv,
 448                 -- Ensures that one original name gets one unique
 449           origIParam :: OrigNameIParamEnv
 450                 -- Ensures that one implicit parameter name gets one unique
 451    }
 452
 453 type OrigNameNameEnv   = FiniteMap (ModuleName,OccName) Name
 454 type OrigNameIParamEnv = FiniteMap OccName Name
 455 \end{code}
 456
 457
 458 A DeclsMap contains a binding for each Name in the declaration
 459 including the constructors of a type decl etc.  The Bool is True just
 460 for the 'main' Name.
 461
 462 \begin{code}
 463 type DeclsMap = NameEnv (AvailInfo, Bool, (Module, RdrNameTyClDecl))
 464
 465 type IfaceInsts = Bag GatedDecl
 466 type IfaceRules = Bag GatedDecl
 467
 468 type GatedDecl = (NameSet, (Module, RdrNameHsDecl))
 469 \end{code}
 470
 471
 472 %************************************************************************
 473 %*                                                                      *
 474 \subsection{Provenance and export info}
 475 %*                                                                      *
 476 %************************************************************************
 477
 478 The GlobalRdrEnv gives maps RdrNames to Names.  There is a separate
 479 one for each module, corresponding to that module's top-level scope.
 480
 481 \begin{code}
 482 type GlobalRdrEnv = RdrNameEnv [(Name,Provenance)]      -- The list is because there may be name clashes
 483                                                         -- These only get reported on lookup,
 484                                                         -- not on construction
 485 \end{code}
 486
 487 The "provenance" of something says how it came to be in scope.
 488
 489 \begin{code}
 490 data Provenance
 491   = LocalDef                    -- Defined locally
 492
 493   | NonLocalDef                 -- Defined non-locally
 494         ImportReason
 495         PrintUnqualified
 496
 497 -- Just used for grouping error messages (in RnEnv.warnUnusedBinds)
 498 instance Eq Provenance where
 499   p1 == p2 = case p1 `compare` p2 of EQ -> True; _ -> False
 500
 501 instance Eq ImportReason where
 502   p1 == p2 = case p1 `compare` p2 of EQ -> True; _ -> False
 503
 504 instance Ord Provenance where
 505    compare LocalDef LocalDef = EQ
 506    compare LocalDef (NonLocalDef _ _) = LT
 507    compare (NonLocalDef _ _) LocalDef = GT
 508
 509    compare (NonLocalDef reason1 _) (NonLocalDef reason2 _)
 510       = compare reason1 reason2
 511
 512 instance Ord ImportReason where
 513    compare ImplicitImport ImplicitImport = EQ
 514    compare ImplicitImport (UserImport _ _ _) = LT
 515    compare (UserImport _ _ _) ImplicitImport = GT
 516    compare (UserImport m1 loc1 _) (UserImport m2 loc2 _)
 517       = (m1 `compare` m2) `thenCmp` (loc1 `compare` loc2)
 518
 519
 520 data ImportReason
 521   = UserImport Module SrcLoc Bool       -- Imported from module M on line L
 522                                         -- Note the M may well not be the defining module
 523                                         -- for this thing!
 524         -- The Bool is true iff the thing was named *explicitly* in the import spec,
 525         -- rather than being imported as part of a group; e.g.
 526         --      import B
 527         --      import C( T(..) )
 528         -- Here, everything imported by B, and the constructors of T
 529         -- are not named explicitly; only T is named explicitly.
 530         -- This info is used when warning of unused names.
 531
 532   | ImplicitImport                      -- Imported implicitly for some other reason
 533
 534
 535 type PrintUnqualified = Bool    -- True <=> the unqualified name of this thing is
 536                                 -- in scope in this module, so print it
 537                                 -- unqualified in error messages
 538 \end{code}
 539
 540 \begin{code}
 541 hasBetterProv :: Provenance -> Provenance -> Bool
 542 -- Choose
 543 --      a local thing                 over an   imported thing
 544 --      a user-imported thing         over a    non-user-imported thing
 545 --      an explicitly-imported thing  over an   implicitly imported thing
 546 hasBetterProv LocalDef                              _                              = True
 547 hasBetterProv (NonLocalDef (UserImport _ _ True) _) _                              = True
 548 hasBetterProv (NonLocalDef (UserImport _ _ _   ) _) (NonLocalDef ImplicitImport _) = True
 549 hasBetterProv _                                     _                              = False
 550
 551 pprNameProvenance :: Name -> Provenance -> SDoc
 552 pprNameProvenance name LocalDef            = ptext SLIT("defined at") <+> ppr (nameSrcLoc name)
 553 pprNameProvenance name (NonLocalDef why _) = sep [ppr_reason why,
 554                                               nest 2 (parens (ppr_defn (nameSrcLoc name)))]
 555
 556 ppr_reason ImplicitImport         = ptext SLIT("implicitly imported")
 557 ppr_reason (UserImport mod loc _) = ptext SLIT("imported from") <+> ppr mod <+> ptext SLIT("at") <+> ppr loc
 558
 559 ppr_defn loc | isGoodSrcLoc loc = ptext SLIT("at") <+> ppr loc
 560              | otherwise        = empty
 561 \end{code}