ghc/compiler/basicTypes/Module.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[Module]{The @Module@ module.}
   5
   6 Representing modules and their flavours.
   7
   8
   9 Notes on DLLs
  10 ~~~~~~~~~~~~~
  11 When compiling module A, which imports module B, we need to
  12 know whether B will be in the same DLL as A.
  13         If it's in the same DLL, we refer to B_f_closure
  14         If it isn't, we refer to _imp__B_f_closure
  15 When compiling A, we record in B's Module value whether it's
  16 in a different DLL, by setting the DLL flag.
  17
  18
  19
  20
  21 \begin{code}
  22 module Module
  23     (
  24       Module,                   -- Abstract, instance of Eq, Ord, Outputable
  25
  26     , PackageName               -- = FastString; instance of Outputable, Uniquable
  27     , modulePackage             -- :: Module -> PackageName
  28     , preludePackage            -- :: PackageName       name of Standard Prelude package
  29
  30     , ModuleName
  31     , pprModuleName             -- :: ModuleName -> SDoc
  32     , printModulePrefix
  33
  34     , moduleName                -- :: Module -> ModuleName
  35     , moduleNameString          -- :: ModuleName -> EncodedString
  36     , moduleNameUserString      -- :: ModuleName -> UserString
  37     , moduleNameFS              -- :: ModuleName -> EncodedFS
  38
  39     , moduleString              -- :: Module -> EncodedString
  40     , moduleUserString          -- :: Module -> UserString
  41
  42     , mkVanillaModule           -- :: ModuleName -> Module
  43     , mkPrelModule              -- :: UserString -> Module
  44     , mkModule                  -- :: ModuleName -> PackageName -> Module
  45     , mkHomeModule              -- :: ModuleName -> Module
  46     , isHomeModule              -- :: Module -> Bool
  47
  48     , mkModuleName              -- :: UserString -> ModuleName
  49     , mkModuleNameFS            -- :: UserFS    -> ModuleName
  50     , mkSysModuleNameFS         -- :: EncodedFS -> ModuleName
  51
  52     , pprModule,
  53
  54         -- Where to find a .hi file
  55     , WhereFrom(..)
  56
  57     , ModuleEnv,
  58     , elemModuleEnv, extendModuleEnv, extendModuleEnvList, plusModuleEnv_C
  59     , delModuleEnvList, delModuleEnv, plusModuleEnv, lookupModuleEnv
  60     , lookupWithDefaultModuleEnv, mapModuleEnv, mkModuleEnv, emptyModuleEnv
  61     , moduleEnvElts, unitModuleEnv, isEmptyModuleEnv, foldModuleEnv
  62     , lookupModuleEnvByName, extendModuleEnv_C
  63
  64     , ModuleSet, emptyModuleSet, mkModuleSet, moduleSetElts, extendModuleSet, elemModuleSet
  65
  66     ) where
  67
  68 #include "HsVersions.h"
  69 import OccName
  70 import Outputable
  71 import CmdLineOpts      ( opt_InPackage )
  72 import FastString       ( FastString )
  73 import Unique           ( Uniquable(..) )
  74 import UniqFM
  75 import UniqSet
  76 \end{code}
  77
  78
  79 %************************************************************************
  80 %*                                                                      *
  81 \subsection{Interface file flavour}
  82 %*                                                                      *
  83 %************************************************************************
  84
  85 A further twist to the tale is the support for dynamically linked
  86 libraries under Win32. Here, dealing with the use of global variables
  87 that's residing in a DLL requires special handling at the point of use
  88 (there's an extra level of indirection, i.e., (**v) to get at v's
  89 value, rather than just (*v) .) When slurping in an interface file we
  90 then record whether it's coming from a .hi corresponding to a module
  91 that's packaged up in a DLL or not, so that we later can emit the
  92 appropriate code.
  93
  94 The logic for how an interface file is marked as corresponding to a
  95 module that's hiding in a DLL is explained elsewhere (ToDo: give
  96 renamer href here.)
  97
  98 \begin{code}
  99 data Module = Module ModuleName PackageInfo
 100
 101 data PackageInfo
 102   = ThisPackage                         -- A module from the same package
 103                                         -- as the one being compiled
 104   | AnotherPackage PackageName          -- A module from a different package
 105
 106   | DunnoYet    -- This is used when we don't yet know
 107                 -- Main case: we've come across Foo.x in an interface file
 108                 -- but we havn't yet opened Foo.hi.  We need a Name for Foo.x
 109                 -- Later on (in RnEnv.newTopBinder) we'll update the cache
 110                 -- to have the right PackageName
 111
 112 type PackageName = FastString           -- No encoding at all
 113
 114 preludePackage :: PackageName
 115 preludePackage = SLIT("std")
 116
 117 packageInfoPackage :: PackageInfo -> PackageName
 118 packageInfoPackage ThisPackage        = SLIT("<THIS>")
 119 packageInfoPackage DunnoYet           = SLIT("<?>")
 120 packageInfoPackage (AnotherPackage p) = p
 121
 122 instance Outputable PackageInfo where
 123         -- Just used in debug prints of lex tokens and in debug modde
 124    ppr pkg_info = ppr (packageInfoPackage pkg_info)
 125 \end{code}
 126
 127
 128 %************************************************************************
 129 %*                                                                      *
 130 \subsection{Where from}
 131 %*                                                                      *
 132 %************************************************************************
 133
 134 The @WhereFrom@ type controls where the renamer looks for an interface file
 135
 136 \begin{code}
 137 data WhereFrom = ImportByUser           -- Ordinary user import: look for M.hi
 138                | ImportByUserSource     -- User {- SOURCE -}: look for M.hi-boot
 139                | ImportBySystem         -- Non user import.  Look for M.hi if M is in
 140                                         -- the module this module depends on, or is a system-ish module;
 141                                         -- M.hi-boot otherwise
 142
 143 instance Outputable WhereFrom where
 144   ppr ImportByUser       = empty
 145   ppr ImportByUserSource = ptext SLIT("{- SOURCE -}")
 146   ppr ImportBySystem     = ptext SLIT("{- SYSTEM IMPORT -}")
 147 \end{code}
 148
 149
 150 %************************************************************************
 151 %*                                                                      *
 152 \subsection{The name of a module}
 153 %*                                                                      *
 154 %************************************************************************
 155
 156 \begin{code}
 157 newtype ModuleName = ModuleName EncodedFS
 158         -- Haskell module names can include the quote character ',
 159         -- so the module names have the z-encoding applied to them
 160
 161 instance Uniquable ModuleName where
 162   getUnique (ModuleName nm) = getUnique nm
 163
 164 instance Eq ModuleName where
 165   nm1 == nm2 = getUnique nm1 == getUnique nm2
 166
 167 -- Warning: gives an ordering relation based on the uniques of the
 168 -- FastStrings which are the (encoded) module names.  This is _not_
 169 -- a lexicographical ordering.
 170 instance Ord ModuleName where
 171   nm1 `compare` nm2 = getUnique nm1 `compare` getUnique nm2
 172
 173 instance Outputable ModuleName where
 174   ppr = pprModuleName
 175
 176
 177 pprModuleName :: ModuleName -> SDoc
 178 pprModuleName (ModuleName nm) = pprEncodedFS nm
 179
 180 moduleNameFS :: ModuleName -> EncodedFS
 181 moduleNameFS (ModuleName mod) = mod
 182
 183 moduleNameString :: ModuleName -> EncodedString
 184 moduleNameString (ModuleName mod) = _UNPK_ mod
 185
 186 moduleNameUserString :: ModuleName -> UserString
 187 moduleNameUserString (ModuleName mod) = decode (_UNPK_ mod)
 188
 189 -- used to be called mkSrcModule
 190 mkModuleName :: UserString -> ModuleName
 191 mkModuleName s = ModuleName (_PK_ (encode s))
 192
 193 -- used to be called mkSrcModuleFS
 194 mkModuleNameFS :: UserFS -> ModuleName
 195 mkModuleNameFS s = ModuleName (encodeFS s)
 196
 197 -- used to be called mkSysModuleFS
 198 mkSysModuleNameFS :: EncodedFS -> ModuleName
 199 mkSysModuleNameFS s = ModuleName s
 200 \end{code}
 201
 202 \begin{code}
 203 instance Outputable Module where
 204   ppr = pprModule
 205
 206 instance Uniquable Module where
 207   getUnique (Module nm _) = getUnique nm
 208
 209 -- Same if they have the same name.
 210 instance Eq Module where
 211   m1 == m2 = getUnique m1 == getUnique m2
 212
 213 -- Warning: gives an ordering relation based on the uniques of the
 214 -- FastStrings which are the (encoded) module names.  This is _not_
 215 -- a lexicographical ordering.
 216 instance Ord Module where
 217   m1 `compare` m2 = getUnique m1 `compare` getUnique m2
 218 \end{code}
 219
 220
 221 \begin{code}
 222 pprModule :: Module -> SDoc
 223 pprModule (Module mod p) = getPprStyle $ \ sty ->
 224                            if debugStyle sty then
 225                                 -- Print the package too
 226                                 ppr p <> dot <> pprModuleName mod
 227                            else
 228                                 pprModuleName mod
 229 \end{code}
 230
 231
 232 \begin{code}
 233 mkModule :: ModuleName  -- Name of the module
 234          -> PackageName
 235          -> Module
 236 mkModule mod_nm pack_name
 237   = Module mod_nm pack_info
 238   where
 239     pack_info | pack_name == opt_InPackage = ThisPackage
 240               | otherwise                  = AnotherPackage pack_name
 241
 242 mkHomeModule :: ModuleName -> Module
 243 mkHomeModule mod_nm = Module mod_nm ThisPackage
 244
 245 isHomeModule :: Module -> Bool
 246 isHomeModule (Module nm ThisPackage) = True
 247 isHomeModule _                       = False
 248
 249 -- Used temporarily when we first come across Foo.x in an interface
 250 -- file, but before we've opened Foo.hi.
 251 -- (Until we've opened Foo.hi we don't know what the Package is.)
 252 mkVanillaModule :: ModuleName -> Module
 253 mkVanillaModule name = Module name DunnoYet
 254
 255 mkPrelModule :: ModuleName -> Module
 256 mkPrelModule name = mkModule name preludePackage
 257
 258 moduleString :: Module -> EncodedString
 259 moduleString (Module (ModuleName fs) _) = _UNPK_ fs
 260
 261 moduleName :: Module -> ModuleName
 262 moduleName (Module mod pkg_info) = mod
 263
 264 modulePackage :: Module -> PackageName
 265 modulePackage (Module mod pkg_info) = packageInfoPackage pkg_info
 266
 267 moduleUserString :: Module -> UserString
 268 moduleUserString (Module mod _) = moduleNameUserString mod
 269
 270 printModulePrefix :: Module -> Bool
 271   -- When printing, say M.x
 272 printModulePrefix (Module nm ThisPackage) = False
 273 printModulePrefix _                       = True
 274 \end{code}
 275
 276
 277 %************************************************************************
 278 %*                                                                      *
 279 \subsection{@ModuleEnv@s}
 280 %*                                                                      *
 281 %************************************************************************
 282
 283 \begin{code}
 284 type ModuleEnv elt = UniqFM elt
 285
 286 emptyModuleEnv       :: ModuleEnv a
 287 mkModuleEnv          :: [(Module, a)] -> ModuleEnv a
 288 unitModuleEnv        :: Module -> a -> ModuleEnv a
 289 extendModuleEnv      :: ModuleEnv a -> Module -> a -> ModuleEnv a
 290 extendModuleEnv_C    :: (a->a->a) -> ModuleEnv a -> Module -> a -> ModuleEnv a
 291 plusModuleEnv        :: ModuleEnv a -> ModuleEnv a -> ModuleEnv a
 292 extendModuleEnvList  :: ModuleEnv a -> [(Module, a)] -> ModuleEnv a
 293
 294 delModuleEnvList     :: ModuleEnv a -> [Module] -> ModuleEnv a
 295 delModuleEnv         :: ModuleEnv a -> Module -> ModuleEnv a
 296 plusModuleEnv_C      :: (a -> a -> a) -> ModuleEnv a -> ModuleEnv a -> ModuleEnv a
 297 mapModuleEnv         :: (a -> b) -> ModuleEnv a -> ModuleEnv b
 298 moduleEnvElts        :: ModuleEnv a -> [a]
 299
 300 isEmptyModuleEnv     :: ModuleEnv a -> Bool
 301 lookupModuleEnv      :: ModuleEnv a -> Module     -> Maybe a
 302 lookupModuleEnvByName:: ModuleEnv a -> ModuleName -> Maybe a
 303 lookupWithDefaultModuleEnv :: ModuleEnv a -> a -> Module -> a
 304 elemModuleEnv        :: Module -> ModuleEnv a -> Bool
 305 foldModuleEnv        :: (a -> b -> b) -> b -> ModuleEnv a -> b
 306
 307 elemModuleEnv       = elemUFM
 308 extendModuleEnv     = addToUFM
 309 extendModuleEnv_C   = addToUFM_C
 310 extendModuleEnvList = addListToUFM
 311 plusModuleEnv_C     = plusUFM_C
 312 delModuleEnvList    = delListFromUFM
 313 delModuleEnv        = delFromUFM
 314 plusModuleEnv       = plusUFM
 315 lookupModuleEnv     = lookupUFM
 316 lookupModuleEnvByName = lookupUFM
 317 lookupWithDefaultModuleEnv = lookupWithDefaultUFM
 318 mapModuleEnv        = mapUFM
 319 mkModuleEnv         = listToUFM
 320 emptyModuleEnv      = emptyUFM
 321 moduleEnvElts       = eltsUFM
 322 unitModuleEnv       = unitUFM
 323 isEmptyModuleEnv    = isNullUFM
 324 foldModuleEnv       = foldUFM
 325 \end{code}
 326
 327 \begin{code}
 328
 329 type ModuleSet = UniqSet Module
 330 mkModuleSet     :: [Module] -> ModuleSet
 331 extendModuleSet :: ModuleSet -> Module -> ModuleSet
 332 emptyModuleSet  :: ModuleSet
 333 moduleSetElts   :: ModuleSet -> [Module]
 334 elemModuleSet   :: Module -> ModuleSet -> Bool
 335
 336 emptyModuleSet  = emptyUniqSet
 337 mkModuleSet     = mkUniqSet
 338 extendModuleSet = addOneToUniqSet
 339 moduleSetElts   = uniqSetToList
 340 elemModuleSet   = elementOfUniqSet
 341 \end{code}