2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[Module]{The @Module@ module.}
6 Representing modules and their flavours.
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.
25 -- abstract, instance of Eq, Ord, Outputable
27 , isModuleInThisPackage, mkModuleInThisPackage
29 , moduleNameString -- :: ModuleName -> EncodedString
30 , moduleNameUserString -- :: ModuleName -> UserString
31 , moduleNameFS -- :: ModuleName -> EncodedFS
33 , moduleString -- :: Module -> EncodedString
34 , moduleUserString -- :: Module -> UserString
35 , moduleName -- :: Module -> ModuleName
37 , mkVanillaModule -- :: ModuleName -> Module
38 , mkPrelModule -- :: UserString -> Module
39 , mkModule -- :: ModuleName -> PackageName -> Module
40 , mkHomeModule -- :: ModuleName -> Module
44 , mkModuleName -- :: UserString -> ModuleName
45 , mkModuleNameFS -- :: UserFS -> ModuleName
46 , mkSysModuleNameFS -- :: EncodedFS -> ModuleName
52 -- Where to find a .hi file
56 , elemModuleEnv, extendModuleEnv, extendModuleEnvList, plusModuleEnv_C
57 , delModuleEnvList, delModuleEnv, plusModuleEnv, lookupModuleEnv
58 , lookupWithDefaultModuleEnv, mapModuleEnv, mkModuleEnv, emptyModuleEnv
59 , rngModuleEnv, unitModuleEnv, isEmptyModuleEnv, foldModuleEnv
60 , lookupModuleEnvByName, extendModuleEnv_C
64 #include "HsVersions.h"
67 import CmdLineOpts ( opt_InPackage )
68 import FastString ( FastString, uniqueOfFS )
69 import Unique ( Uniquable(..), mkUniqueGrimily )
74 %************************************************************************
76 \subsection{Interface file flavour}
78 %************************************************************************
80 A further twist to the tale is the support for dynamically linked
81 libraries under Win32. Here, dealing with the use of global variables
82 that's residing in a DLL requires special handling at the point of use
83 (there's an extra level of indirection, i.e., (**v) to get at v's
84 value, rather than just (*v) .) When slurping in an interface file we
85 then record whether it's coming from a .hi corresponding to a module
86 that's packaged up in a DLL or not, so that we later can emit the
89 The logic for how an interface file is marked as corresponding to a
90 module that's hiding in a DLL is explained elsewhere (ToDo: give
94 data Module = Module ModuleName PackageInfo
97 = ThisPackage -- A module from the same package
98 -- as the one being compiled
99 | AnotherPackage PackageName -- A module from a different package
101 type PackageName = FastString -- No encoding at all
103 preludePackage :: PackageName
104 preludePackage = SLIT("std")
106 instance Outputable PackageInfo where
107 -- Just used in debug prints of lex tokens and in debug modde
108 ppr ThisPackage = ptext SLIT("<THIS>")
109 ppr (AnotherPackage p) = ptext p
113 %************************************************************************
115 \subsection{Where from}
117 %************************************************************************
119 The @WhereFrom@ type controls where the renamer looks for an interface file
122 data WhereFrom = ImportByUser -- Ordinary user import: look for M.hi
123 | ImportByUserSource -- User {- SOURCE -}: look for M.hi-boot
124 | ImportBySystem -- Non user import. Look for M.hi if M is in
125 -- the module this module depends on, or is a system-ish module;
126 -- M.hi-boot otherwise
128 instance Outputable WhereFrom where
129 ppr ImportByUser = empty
130 ppr ImportByUserSource = ptext SLIT("{- SOURCE -}")
131 ppr ImportBySystem = ptext SLIT("{- SYSTEM IMPORT -}")
135 %************************************************************************
137 \subsection{The name of a module}
139 %************************************************************************
142 newtype ModuleName = ModuleName EncodedFS
143 -- Haskell module names can include the quote character ',
144 -- so the module names have the z-encoding applied to them
146 instance Uniquable ModuleName where
147 getUnique (ModuleName nm) = mkUniqueGrimily (uniqueOfFS nm)
149 instance Eq ModuleName where
150 nm1 == nm2 = getUnique nm1 == getUnique nm2
152 -- Warning: gives an ordering relation based on the uniques of the
153 -- FastStrings which are the (encoded) module names. This is _not_
154 -- a lexicographical ordering.
155 instance Ord ModuleName where
156 nm1 `compare` nm2 = getUnique nm1 `compare` getUnique nm2
158 instance Outputable ModuleName where
162 pprModuleName :: ModuleName -> SDoc
163 pprModuleName (ModuleName nm) = pprEncodedFS nm
165 moduleNameFS :: ModuleName -> EncodedFS
166 moduleNameFS (ModuleName mod) = mod
168 moduleNameString :: ModuleName -> EncodedString
169 moduleNameString (ModuleName mod) = _UNPK_ mod
171 moduleNameUserString :: ModuleName -> UserString
172 moduleNameUserString (ModuleName mod) = decode (_UNPK_ mod)
174 -- used to be called mkSrcModule
175 mkModuleName :: UserString -> ModuleName
176 mkModuleName s = ModuleName (_PK_ (encode s))
178 -- used to be called mkSrcModuleFS
179 mkModuleNameFS :: UserFS -> ModuleName
180 mkModuleNameFS s = ModuleName (encodeFS s)
182 -- used to be called mkSysModuleFS
183 mkSysModuleNameFS :: EncodedFS -> ModuleName
184 mkSysModuleNameFS s = ModuleName s
186 -- Make a module in this package
187 mkModuleInThisPackage :: ModuleName -> Module
188 mkModuleInThisPackage nm = Module nm ThisPackage
192 instance Outputable Module where
195 instance Uniquable Module where
196 getUnique (Module nm _) = getUnique nm
198 -- Same if they have the same name.
199 instance Eq Module where
200 m1 == m2 = getUnique m1 == getUnique m2
202 -- Warning: gives an ordering relation based on the uniques of the
203 -- FastStrings which are the (encoded) module names. This is _not_
204 -- a lexicographical ordering.
205 instance Ord Module where
206 m1 `compare` m2 = getUnique m1 `compare` getUnique m2
211 pprModule :: Module -> SDoc
212 pprModule (Module mod p) = getPprStyle $ \ sty ->
213 if debugStyle sty then
214 -- Print the package too
215 ppr p <> dot <> pprModuleName mod
222 mkModule :: ModuleName -- Name of the module
225 mkModule mod_nm pack_name
226 = Module mod_nm pack_info
228 pack_info | pack_name == opt_InPackage = ThisPackage
229 | otherwise = AnotherPackage pack_name
231 mkHomeModule :: ModuleName -> Module
232 mkHomeModule mod_nm = Module mod_nm ThisPackage
234 -- Used temporarily when we first come across Foo.x in an interface
235 -- file, but before we've opened Foo.hi.
236 -- (Until we've opened Foo.hi we don't know what the PackageInfo is.)
237 mkVanillaModule :: ModuleName -> Module
238 mkVanillaModule name = mkModule name (panic "mkVanillaModule:unknown mod_kind field")
240 mkPrelModule :: ModuleName -> Module
241 mkPrelModule name = mkModule name preludePackage
243 moduleString :: Module -> EncodedString
244 moduleString (Module (ModuleName fs) _) = _UNPK_ fs
246 moduleName :: Module -> ModuleName
247 moduleName (Module mod _) = mod
249 moduleUserString :: Module -> UserString
250 moduleUserString (Module mod _) = moduleNameUserString mod
252 isModuleInThisPackage :: Module -> Bool
253 isModuleInThisPackage (Module nm ThisPackage) = True
254 isModuleInThisPackage _ = False
257 %************************************************************************
259 \subsection{@ModuleEnv@s}
261 %************************************************************************
264 type ModuleEnv elt = UniqFM elt
266 emptyModuleEnv :: ModuleEnv a
267 mkModuleEnv :: [(Module, a)] -> ModuleEnv a
268 unitModuleEnv :: Module -> a -> ModuleEnv a
269 extendModuleEnv :: ModuleEnv a -> Module -> a -> ModuleEnv a
270 extendModuleEnv_C :: (a->a->a) -> ModuleEnv a -> Module -> a -> ModuleEnv a
271 plusModuleEnv :: ModuleEnv a -> ModuleEnv a -> ModuleEnv a
272 extendModuleEnvList :: ModuleEnv a -> [(Module, a)] -> ModuleEnv a
274 delModuleEnvList :: ModuleEnv a -> [Module] -> ModuleEnv a
275 delModuleEnv :: ModuleEnv a -> Module -> ModuleEnv a
276 plusModuleEnv_C :: (a -> a -> a) -> ModuleEnv a -> ModuleEnv a -> ModuleEnv a
277 mapModuleEnv :: (a -> b) -> ModuleEnv a -> ModuleEnv b
278 rngModuleEnv :: ModuleEnv a -> [a]
280 isEmptyModuleEnv :: ModuleEnv a -> Bool
281 lookupModuleEnv :: ModuleEnv a -> Module -> Maybe a
282 lookupModuleEnvByName:: ModuleEnv a -> ModuleName -> Maybe a
283 lookupWithDefaultModuleEnv :: ModuleEnv a -> a -> Module -> a
284 elemModuleEnv :: Module -> ModuleEnv a -> Bool
285 foldModuleEnv :: (a -> b -> b) -> b -> ModuleEnv a -> b
287 elemModuleEnv = elemUFM
288 extendModuleEnv = addToUFM
289 extendModuleEnv_C = addToUFM_C
290 extendModuleEnvList = addListToUFM
291 plusModuleEnv_C = plusUFM_C
292 delModuleEnvList = delListFromUFM
293 delModuleEnv = delFromUFM
294 plusModuleEnv = plusUFM
295 lookupModuleEnv = lookupUFM
296 lookupModuleEnvByName = lookupUFM
297 lookupWithDefaultModuleEnv = lookupWithDefaultUFM
298 mapModuleEnv = mapUFM
299 mkModuleEnv = listToUFM
300 emptyModuleEnv = emptyUFM
301 rngModuleEnv = eltsUFM
302 unitModuleEnv = unitUFM
303 isEmptyModuleEnv = isNullUFM
304 foldModuleEnv = foldUFM