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, mod_name, mod_kind
  25                             -- abstract, instance of Eq, Ord, Outputable
  26     , ModuleName
  27     , ModuleKind(..)
  28     , isPackageKind
  29
  30     , moduleNameString          -- :: ModuleName -> EncodedString
  31     , moduleNameUserString      -- :: ModuleName -> UserString
  32
  33     , moduleString          -- :: Module -> EncodedString
  34     , moduleUserString      -- :: Module -> UserString
  35     , moduleName            -- :: Module -> ModuleName
  36
  37 --    , mkVanillaModule     -- :: ModuleName -> Module
  38 --    , mkThisModule        -- :: ModuleName -> Module
  39 --    , mkPrelModule          -- :: UserString -> Module
  40     , mkModule              -- :: ModuleName -> ModuleKind -> Module
  41
  42 --    , isLocalModule       -- :: Module -> Bool
  43
  44 --    , mkSrcModule
  45
  46     , mkModuleName              -- :: UserString -> ModuleName
  47     , mkModuleNameFS            -- :: UserFS    -> ModuleName
  48     , mkSysModuleNameFS         -- :: EncodedFS -> ModuleName
  49
  50     , pprModule,
  51
  52     , PackageName
  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     , rngModuleEnv, unitModuleEnv, isEmptyModuleEnv, foldModuleEnv
  62
  63     ) where
  64
  65 #include "HsVersions.h"
  66 import OccName
  67 import Outputable
  68 import CmdLineOpts      ( opt_InPackage )
  69 import FastString       ( FastString, uniqueOfFS )
  70 import Unique           ( Uniquable(..), mkUniqueGrimily )
  71 import UniqFM
  72 \end{code}
  73
  74
  75 %************************************************************************
  76 %*                                                                      *
  77 \subsection{Interface file flavour}
  78 %*                                                                      *
  79 %************************************************************************
  80
  81 A further twist to the tale is the support for dynamically linked libraries under
  82 Win32. Here, dealing with the use of global variables that's residing in a DLL
  83 requires special handling at the point of use (there's an extra level of indirection,
  84 i.e., (**v) to get at v's value, rather than just (*v) .) When slurping in an
  85 interface file we then record whether it's coming from a .hi corresponding to a
  86 module that's packaged up in a DLL or not, so that we later can emit the
  87 appropriate code.
  88
  89 The logic for how an interface file is marked as corresponding to a module that's
  90 hiding in a DLL is explained elsewhere (ToDo: give renamer href here.)
  91
  92 @SourceOnly@ and @ObjectCode@ indicate a module from the same package
  93 as the one being compiled, i.e. a home module.  @InPackage@ means one
  94 from a different package.
  95
  96 \begin{code}
  97 data ModuleKind
  98    = SourceOnly FilePath            -- .hs
  99    | ObjectCode FilePath FilePath   -- .o, .hi
 100    | InPackage  PackageName
 101
 102 isPackageKind (InPackage _) = True
 103 isPackageKind _             = False
 104
 105 type PackageName = FastString           -- No encoding at all
 106
 107 preludePackage :: PackageName
 108 preludePackage = SLIT("std")
 109
 110 instance Outputable ModuleKind where
 111    ppr (SourceOnly path_hs)
 112       = text "SourceOnly" <+> text (show path_hs)
 113    ppr (ObjectCode path_o path_hi)
 114       = text "ObjectCode" <+> text (show path_o) <+> text (show path_hi)
 115    ppr (InPackage pkgname)
 116       = text "InPackage" <+> text (show pkgname)
 117 \end{code}
 118
 119
 120 %************************************************************************
 121 %*                                                                      *
 122 \subsection{Where from}
 123 %*                                                                      *
 124 %************************************************************************
 125
 126 The @WhereFrom@ type controls where the renamer looks for an interface file
 127
 128 \begin{code}
 129 data WhereFrom = ImportByUser           -- Ordinary user import: look for M.hi
 130                | ImportByUserSource     -- User {- SOURCE -}: look for M.hi-boot
 131                | ImportBySystem         -- Non user import.  Look for M.hi if M is in
 132                                         -- the module this module depends on, or is a system-ish module;
 133                                         -- M.hi-boot otherwise
 134
 135 instance Outputable WhereFrom where
 136   ppr ImportByUser       = empty
 137   ppr ImportByUserSource = ptext SLIT("{- SOURCE -}")
 138   ppr ImportBySystem     = ptext SLIT("{- SYSTEM IMPORT -}")
 139 \end{code}
 140
 141
 142 %************************************************************************
 143 %*                                                                      *
 144 \subsection{The name of a module}
 145 %*                                                                      *
 146 %************************************************************************
 147
 148 \begin{code}
 149 newtype ModuleName = ModuleName EncodedFS
 150         -- Haskell module names can include the quote character ',
 151         -- so the module names have the z-encoding applied to them
 152
 153 instance Uniquable ModuleName where
 154   getUnique (ModuleName nm) = mkUniqueGrimily (uniqueOfFS nm)
 155
 156 instance Eq ModuleName where
 157   nm1 == nm2 = getUnique nm1 == getUnique nm2
 158
 159 -- Warning: gives an ordering relation based on the uniques of the
 160 -- FastStrings which are the (encoded) module names.  This is _not_
 161 -- a lexicographical ordering.
 162 instance Ord ModuleName where
 163   nm1 `compare` nm2 = getUnique nm1 `compare` getUnique nm2
 164
 165 instance Outputable ModuleName where
 166   ppr = pprModuleName
 167
 168
 169 pprModuleName :: ModuleName -> SDoc
 170 pprModuleName (ModuleName nm) = pprEncodedFS nm
 171
 172 moduleNameString :: ModuleName -> EncodedString
 173 moduleNameString (ModuleName mod) = _UNPK_ mod
 174
 175 moduleNameUserString :: ModuleName -> UserString
 176 moduleNameUserString (ModuleName mod) = decode (_UNPK_ mod)
 177
 178 -- used to be called mkSrcModule
 179 mkModuleName :: UserString -> ModuleName
 180 mkModuleName s = ModuleName (_PK_ (encode s))
 181
 182 -- used to be called mkSrcModuleFS
 183 mkModuleNameFS :: UserFS -> ModuleName
 184 mkModuleNameFS s = ModuleName (encodeFS s)
 185
 186 -- used to be called mkSysModuleFS
 187 mkSysModuleNameFS :: EncodedFS -> ModuleName
 188 mkSysModuleNameFS s = ModuleName s
 189 \end{code}
 190
 191 \begin{code}
 192 data Module = Module ModuleName ModuleKind
 193
 194 mod_name (Module nm kind) = nm
 195 mod_kind (Module nm kind) = kind
 196 \end{code}
 197
 198 \begin{code}
 199 instance Outputable Module where
 200   ppr = pprModule
 201
 202 instance Uniquable Module where
 203   getUnique (Module nm _) = getUnique nm
 204
 205 -- Same if they have the same name.
 206 instance Eq Module where
 207   m1 == m2 = getUnique m1 == getUnique m2
 208
 209 -- Warning: gives an ordering relation based on the uniques of the
 210 -- FastStrings which are the (encoded) module names.  This is _not_
 211 -- a lexicographical ordering.
 212 instance Ord Module where
 213   m1 `compare` m2 = getUnique m1 `compare` getUnique m2
 214 \end{code}
 215
 216
 217 \begin{code}
 218 pprModule :: Module -> SDoc
 219 pprModule (Module mod p) = getPprStyle $ \ sty ->
 220                            if debugStyle sty then
 221                                 -- Print the package too
 222                                 ppr p <> dot <> pprModuleName mod
 223                            else
 224                                 pprModuleName mod
 225 \end{code}
 226
 227
 228 \begin{code}
 229 mkModule :: ModuleName -> ModuleKind -> Module
 230 mkModule = Module
 231 -- I don't think anybody except the Finder should ever try to create a
 232 -- Module now, so this lot commented out pro tem (JRS)
 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
 243 --mkVanillaModule :: ModuleName -> Module
 244 --mkVanillaModule name = Module name ThisPackage
 245         -- Used temporarily when we first come across Foo.x in an interface
 246         -- file, but before we've opened Foo.hi.
 247         -- (Until we've opened Foo.hi we don't know what the PackageInfo is.)
 248
 249 --mkThisModule :: ModuleName -> Module  -- The module being compiled
 250 --mkThisModule name = Module name ThisPackage
 251
 252 --mkPrelModule :: ModuleName -> Module
 253 --mkPrelModule name = mkModule name preludePackage
 254
 255 moduleString :: Module -> EncodedString
 256 moduleString (Module (ModuleName fs) _) = _UNPK_ fs
 257
 258 moduleName :: Module -> ModuleName
 259 moduleName (Module mod _) = mod
 260
 261 moduleUserString :: Module -> UserString
 262 moduleUserString (Module mod _) = moduleNameUserString mod
 263 \end{code}
 264
 265 \begin{code}
 266 --isLocalModule :: Module -> Bool
 267 --isLocalModule (Module _ ThisPackage) = True
 268 --isLocalModule _                            = False
 269 \end{code}
 270
 271 %************************************************************************
 272 %*                                                                      *
 273 \subsection{@ModuleEnv@s}
 274 %*                                                                      *
 275 %************************************************************************
 276
 277 \begin{code}
 278 type ModuleEnv elt = UniqFM elt
 279
 280 emptyModuleEnv       :: ModuleEnv a
 281 mkModuleEnv          :: [(Module, a)] -> ModuleEnv a
 282 unitModuleEnv        :: Module -> a -> ModuleEnv a
 283 extendModuleEnv      :: ModuleEnv a -> Module -> a -> ModuleEnv a
 284 plusModuleEnv        :: ModuleEnv a -> ModuleEnv a -> ModuleEnv a
 285 extendModuleEnvList  :: ModuleEnv a -> [(Module, a)] -> ModuleEnv a
 286
 287 delModuleEnvList     :: ModuleEnv a -> [Module] -> ModuleEnv a
 288 delModuleEnv         :: ModuleEnv a -> Module -> ModuleEnv a
 289 plusModuleEnv_C      :: (a -> a -> a) -> ModuleEnv a -> ModuleEnv a -> ModuleEnv a
 290 mapModuleEnv         :: (a -> b) -> ModuleEnv a -> ModuleEnv b
 291 rngModuleEnv         :: ModuleEnv a -> [a]
 292
 293 isEmptyModuleEnv     :: ModuleEnv a -> Bool
 294 lookupModuleEnv      :: ModuleEnv a -> Module -> Maybe a
 295 lookupWithDefaultModuleEnv :: ModuleEnv a -> a -> Module -> a
 296 elemModuleEnv        :: Module -> ModuleEnv a -> Bool
 297 foldModuleEnv        :: (a -> b -> b) -> b -> ModuleEnv a -> b
 298
 299 elemModuleEnv       = elemUFM
 300 extendModuleEnv     = addToUFM
 301 extendModuleEnvList = addListToUFM
 302 plusModuleEnv_C     = plusUFM_C
 303 delModuleEnvList    = delListFromUFM
 304 delModuleEnv        = delFromUFM
 305 plusModuleEnv       = plusUFM
 306 lookupModuleEnv     = lookupUFM
 307 lookupWithDefaultModuleEnv = lookupWithDefaultUFM
 308 mapModuleEnv        = mapUFM
 309 mkModuleEnv         = listToUFM
 310 emptyModuleEnv      = emptyUFM
 311 rngModuleEnv        = eltsUFM
 312 unitModuleEnv       = unitUFM
 313 isEmptyModuleEnv    = isNullUFM
 314 foldModuleEnv       = foldUFM
 315 \end{code}