%
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-2002
%
-\section[Module]{The @Module@ module.}
-Representing modules and their flavours.
+ModuleName
+~~~~~~~~~~
+Simply the name of a module, represented as a Z-encoded FastString.
+These are Uniquable, hence we can build FiniteMaps with ModuleNames as
+the keys.
+Module
+~~~~~~
+
+A ModuleName with some additional information, namely whether the
+module resides in the Home package or in a different package. We need
+to know this for two reasons:
+
+ * generating cross-DLL calls is different from intra-DLL calls
+ (see below).
+ * we don't record version information in interface files for entities
+ in a different package.
+
+The unique of a Module is identical to the unique of a ModuleName, so
+it is safe to look up in a Module map using a ModuleName and vice
+versa.
Notes on DLLs
~~~~~~~~~~~~~
\begin{code}
module Module
(
- Module, moduleName
- -- abstract, instance of Eq, Ord, Outputable
+ Module, -- Abstract, instance of Eq, Ord, Outputable
+
+ , PackageName -- = FastString; instance of Outputable, Uniquable
+ , preludePackage -- :: PackageName
+
, ModuleName
- , isModuleInThisPackage, mkModuleInThisPackage
+ , pprModuleName -- :: ModuleName -> SDoc
+ , printModulePrefix
+ , moduleName -- :: Module -> ModuleName
, moduleNameString -- :: ModuleName -> EncodedString
, moduleNameUserString -- :: ModuleName -> UserString
, moduleNameFS -- :: ModuleName -> EncodedFS
, moduleString -- :: Module -> EncodedString
, moduleUserString -- :: Module -> UserString
- , moduleName -- :: Module -> ModuleName
, mkVanillaModule -- :: ModuleName -> Module
+ , isVanillaModule -- :: Module -> Bool
, mkPrelModule -- :: UserString -> Module
, mkModule -- :: ModuleName -> PackageName -> Module
, mkHomeModule -- :: ModuleName -> Module
-
--- , mkSrcModule
+ , isHomeModule -- :: Module -> Bool
+ , mkPackageModule -- :: ModuleName -> Module
, mkModuleName -- :: UserString -> ModuleName
, mkModuleNameFS -- :: UserFS -> ModuleName
, pprModule,
- , PackageName
-
-- Where to find a .hi file
, WhereFrom(..)
, moduleEnvElts, unitModuleEnv, isEmptyModuleEnv, foldModuleEnv
, lookupModuleEnvByName, extendModuleEnv_C
+ , ModuleSet, emptyModuleSet, mkModuleSet, moduleSetElts, extendModuleSet, elemModuleSet
+
) where
#include "HsVersions.h"
import OccName
import Outputable
import CmdLineOpts ( opt_InPackage )
-import FastString ( FastString, uniqueOfFS )
-import Unique ( Uniquable(..), mkUniqueGrimily )
+import FastString ( FastString )
+import Unique ( Uniquable(..) )
import UniqFM
+import UniqSet
+import Binary
\end{code}
renamer href here.)
\begin{code}
-data Module = Module ModuleName PackageInfo
+data Module = Module ModuleName !PackageInfo
+
+instance Binary Module where
+ put_ bh (Module m p) = put_ bh m
+ get bh = do m <- get bh; return (Module m DunnoYet)
-data PackageInfo
+data PackageInfo
= ThisPackage -- A module from the same package
-- as the one being compiled
- | AnotherPackage PackageName -- A module from a different package
+ | AnotherPackage -- A module from a different package
+
+ | DunnoYet -- This is used when we don't yet know
+ -- Main case: we've come across Foo.x in an interface file
+ -- but we havn't yet opened Foo.hi. We need a Name for Foo.x
+ -- Later on (in RnEnv.newTopBinder) we'll update the cache
+ -- to have the right PackageName
type PackageName = FastString -- No encoding at all
preludePackage :: PackageName
-preludePackage = SLIT("std")
+preludePackage = FSLIT("base")
+
+packageInfoPackage :: PackageInfo -> PackageName
+packageInfoPackage ThisPackage = opt_InPackage
+packageInfoPackage DunnoYet = FSLIT("<?>")
+packageInfoPackage AnotherPackage = FSLIT("<pkg>")
instance Outputable PackageInfo where
-- Just used in debug prints of lex tokens and in debug modde
- ppr ThisPackage = ptext SLIT("<THIS>")
- ppr (AnotherPackage p) = ptext p
+ ppr pkg_info = ppr (packageInfoPackage pkg_info)
\end{code}
| ImportBySystem -- Non user import. Look for M.hi if M is in
-- the module this module depends on, or is a system-ish module;
-- M.hi-boot otherwise
+ | ImportByCmdLine -- The user typed a qualified name at
+ -- the GHCi prompt, try to demand-load
+ -- the interface.
instance Outputable WhereFrom where
ppr ImportByUser = empty
-- Haskell module names can include the quote character ',
-- so the module names have the z-encoding applied to them
+instance Binary ModuleName where
+ put_ bh (ModuleName m) = put_ bh m
+ get bh = do m <- get bh; return (ModuleName m)
+
instance Uniquable ModuleName where
- getUnique (ModuleName nm) = mkUniqueGrimily (uniqueOfFS nm)
+ getUnique (ModuleName nm) = getUnique nm
instance Eq ModuleName where
nm1 == nm2 = getUnique nm1 == getUnique nm2
-- used to be called mkSysModuleFS
mkSysModuleNameFS :: EncodedFS -> ModuleName
mkSysModuleNameFS s = ModuleName s
-
--- Make a module in this package
-mkModuleInThisPackage :: ModuleName -> Module
-mkModuleInThisPackage nm = Module nm ThisPackage
\end{code}
\begin{code}
= Module mod_nm pack_info
where
pack_info | pack_name == opt_InPackage = ThisPackage
- | otherwise = AnotherPackage pack_name
+ | otherwise = AnotherPackage
mkHomeModule :: ModuleName -> Module
mkHomeModule mod_nm = Module mod_nm ThisPackage
+isHomeModule :: Module -> Bool
+isHomeModule (Module nm ThisPackage) = True
+isHomeModule _ = False
+
+mkPackageModule :: ModuleName -> Module
+mkPackageModule mod_nm = Module mod_nm AnotherPackage
+
-- Used temporarily when we first come across Foo.x in an interface
-- file, but before we've opened Foo.hi.
--- (Until we've opened Foo.hi we don't know what the PackageInfo is.)
+-- (Until we've opened Foo.hi we don't know what the Package is.)
mkVanillaModule :: ModuleName -> Module
-mkVanillaModule name = mkModule name (panic "mkVanillaModule:unknown mod_kind field")
+mkVanillaModule name = Module name DunnoYet
+
+isVanillaModule :: Module -> Bool
+isVanillaModule (Module nm DunnoYet) = True
+isVanillaModule _ = False
mkPrelModule :: ModuleName -> Module
mkPrelModule name = mkModule name preludePackage
moduleString (Module (ModuleName fs) _) = _UNPK_ fs
moduleName :: Module -> ModuleName
-moduleName (Module mod _) = mod
+moduleName (Module mod pkg_info) = mod
moduleUserString :: Module -> UserString
moduleUserString (Module mod _) = moduleNameUserString mod
-isModuleInThisPackage :: Module -> Bool
-isModuleInThisPackage (Module nm ThisPackage) = True
-isModuleInThisPackage _ = False
+printModulePrefix :: Module -> Bool
+ -- When printing, say M.x
+printModulePrefix (Module nm ThisPackage) = False
+printModulePrefix _ = True
\end{code}
+
%************************************************************************
%* *
\subsection{@ModuleEnv@s}
isEmptyModuleEnv = isNullUFM
foldModuleEnv = foldUFM
\end{code}
+
+\begin{code}
+
+type ModuleSet = UniqSet Module
+mkModuleSet :: [Module] -> ModuleSet
+extendModuleSet :: ModuleSet -> Module -> ModuleSet
+emptyModuleSet :: ModuleSet
+moduleSetElts :: ModuleSet -> [Module]
+elemModuleSet :: Module -> ModuleSet -> Bool
+
+emptyModuleSet = emptyUniqSet
+mkModuleSet = mkUniqSet
+extendModuleSet = addOneToUniqSet
+moduleSetElts = uniqSetToList
+elemModuleSet = elementOfUniqSet
+\end{code}
projects / ghc-hetmet.git / blobdiff