\begin{code}
module Module
(
- Module -- abstract, instance of Eq, Ord, Outputable
+ Module, moduleName, packageOfModule,
+ -- abstract, instance of Eq, Ord, Outputable
, ModuleName
+ , isModuleInThisPackage, mkModuleInThisPackage,
+ , printModulePrefix
, moduleNameString -- :: ModuleName -> EncodedString
, moduleNameUserString -- :: ModuleName -> UserString
+ , moduleNameFS -- :: ModuleName -> EncodedFS
- , moduleString -- :: Module -> EncodedString
- , moduleUserString -- :: Module -> UserString
- , moduleName -- :: Module -> ModuleName
+ , moduleString -- :: Module -> EncodedString
+ , moduleUserString -- :: Module -> UserString
- , mkVanillaModule -- :: ModuleName -> Module
- , mkThisModule -- :: ModuleName -> Module
- , mkPrelModule -- :: UserString -> Module
- , mkModule -- :: ModuleName -> PackageName -> Module
-
- , isLocalModule -- :: Module -> Bool
+ , mkVanillaModule -- :: ModuleName -> Module
+ , mkPrelModule -- :: UserString -> Module
+ , mkModule -- :: ModuleName -> PackageName -> Module
+ , mkHomeModule -- :: ModuleName -> Module
- , mkSrcModule
+-- , mkSrcModule
- , mkSrcModuleFS -- :: UserFS -> ModuleName
- , mkSysModuleFS -- :: EncodedFS -> ModuleName
+ , mkModuleName -- :: UserString -> ModuleName
+ , mkModuleNameFS -- :: UserFS -> ModuleName
+ , mkSysModuleNameFS -- :: EncodedFS -> ModuleName
- , pprModule, pprModuleName
+ , pprModule,
, PackageName
-- Where to find a .hi file
, WhereFrom(..)
+ , ModuleEnv,
+ , elemModuleEnv, extendModuleEnv, extendModuleEnvList, plusModuleEnv_C
+ , delModuleEnvList, delModuleEnv, plusModuleEnv, lookupModuleEnv
+ , lookupWithDefaultModuleEnv, mapModuleEnv, mkModuleEnv, emptyModuleEnv
+ , 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 )
+import FastString ( FastString, uniqueOfFS )
+import Unique ( Uniquable(..), mkUniqueGrimily )
+import UniqFM
+import UniqSet
\end{code}
%* *
%************************************************************************
-A further twist to the tale is the support for dynamically linked libraries under
-Win32. Here, dealing with the use of global variables that's residing in a DLL
-requires special handling at the point of use (there's an extra level of indirection,
-i.e., (**v) to get at v's value, rather than just (*v) .) When slurping in an
-interface file we then record whether it's coming from a .hi corresponding to a
-module that's packaged up in a DLL or not, so that we later can emit the
+A further twist to the tale is the support for dynamically linked
+libraries under Win32. Here, dealing with the use of global variables
+that's residing in a DLL requires special handling at the point of use
+(there's an extra level of indirection, i.e., (**v) to get at v's
+value, rather than just (*v) .) When slurping in an interface file we
+then record whether it's coming from a .hi corresponding to a module
+that's packaged up in a DLL or not, so that we later can emit the
appropriate code.
-The logic for how an interface file is marked as corresponding to a module that's
-hiding in a DLL is explained elsewhere (ToDo: give renamer href here.)
+The logic for how an interface file is marked as corresponding to a
+module that's hiding in a DLL is explained elsewhere (ToDo: give
+renamer href here.)
\begin{code}
-data PackageInfo = ThisPackage -- A module from the same package
- -- as the one being compiled
- | AnotherPackage PackageName -- A module from a different package
+data Module = Module ModuleName PackageInfo
+
+data PackageInfo
+ = ThisPackage -- A module from the same package
+ -- as the one being compiled
+ | AnotherPackage PackageName -- 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 PackageInfo
type PackageName = FastString -- No encoding at all
preludePackage :: PackageName
preludePackage = SLIT("std")
-instance Show PackageInfo where -- Just used in debug prints of lex tokens
- -- and in debug modde
- showsPrec n ThisPackage s = "<THIS>" ++ s
- showsPrec n (AnotherPackage p) s = (_UNPK_ p) ++ s
+instance Outputable PackageInfo where
+ -- Just used in debug prints of lex tokens and in debug modde
+ ppr ThisPackage = ptext SLIT("<THIS>")
+ ppr DunnoYet = ptext SLIT("<?>")
+ ppr (AnotherPackage p) = ptext p
\end{code}
%************************************************************************
\begin{code}
-type ModuleName = EncodedFS
+newtype ModuleName = ModuleName EncodedFS
-- Haskell module names can include the quote character ',
-- so the module names have the z-encoding applied to them
+instance Uniquable ModuleName where
+ getUnique (ModuleName nm) = mkUniqueGrimily (uniqueOfFS nm)
+
+instance Eq ModuleName where
+ nm1 == nm2 = getUnique nm1 == getUnique nm2
+
+-- Warning: gives an ordering relation based on the uniques of the
+-- FastStrings which are the (encoded) module names. This is _not_
+-- a lexicographical ordering.
+instance Ord ModuleName where
+ nm1 `compare` nm2 = getUnique nm1 `compare` getUnique nm2
+
+instance Outputable ModuleName where
+ ppr = pprModuleName
+
+
pprModuleName :: ModuleName -> SDoc
-pprModuleName nm = pprEncodedFS nm
+pprModuleName (ModuleName nm) = pprEncodedFS nm
+
+moduleNameFS :: ModuleName -> EncodedFS
+moduleNameFS (ModuleName mod) = mod
moduleNameString :: ModuleName -> EncodedString
-moduleNameString mod = _UNPK_ mod
+moduleNameString (ModuleName mod) = _UNPK_ mod
moduleNameUserString :: ModuleName -> UserString
-moduleNameUserString mod = decode (_UNPK_ mod)
+moduleNameUserString (ModuleName mod) = decode (_UNPK_ mod)
-mkSrcModule :: UserString -> ModuleName
-mkSrcModule s = _PK_ (encode s)
+-- used to be called mkSrcModule
+mkModuleName :: UserString -> ModuleName
+mkModuleName s = ModuleName (_PK_ (encode s))
-mkSrcModuleFS :: UserFS -> ModuleName
-mkSrcModuleFS s = encodeFS s
+-- used to be called mkSrcModuleFS
+mkModuleNameFS :: UserFS -> ModuleName
+mkModuleNameFS s = ModuleName (encodeFS s)
-mkSysModuleFS :: EncodedFS -> ModuleName
-mkSysModuleFS s = s
-\end{code}
+-- used to be called mkSysModuleFS
+mkSysModuleNameFS :: EncodedFS -> ModuleName
+mkSysModuleNameFS s = ModuleName s
-\begin{code}
-data Module = Module ModuleName PackageInfo
+-- Make a module in this package
+mkModuleInThisPackage :: ModuleName -> Module
+mkModuleInThisPackage nm = Module nm ThisPackage
\end{code}
\begin{code}
instance Outputable Module where
ppr = pprModule
+instance Uniquable Module where
+ getUnique (Module nm _) = getUnique nm
+
+-- Same if they have the same name.
instance Eq Module where
- (Module m1 _) == (Module m2 _) = m1 == m2
+ m1 == m2 = getUnique m1 == getUnique m2
+-- Warning: gives an ordering relation based on the uniques of the
+-- FastStrings which are the (encoded) module names. This is _not_
+-- a lexicographical ordering.
instance Ord Module where
- (Module m1 _) `compare` (Module m2 _) = m1 `compare` m2
+ m1 `compare` m2 = getUnique m1 `compare` getUnique m2
\end{code}
pprModule (Module mod p) = getPprStyle $ \ sty ->
if debugStyle sty then
-- Print the package too
- text (show p) <> dot <> pprModuleName mod
+ ppr p <> dot <> pprModuleName mod
else
pprModuleName mod
\end{code}
pack_info | pack_name == opt_InPackage = ThisPackage
| otherwise = AnotherPackage pack_name
+mkHomeModule :: ModuleName -> Module
+mkHomeModule mod_nm = Module mod_nm ThisPackage
+-- 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.)
mkVanillaModule :: ModuleName -> Module
-mkVanillaModule name = Module name ThisPackage
- -- 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.)
-
-mkThisModule :: ModuleName -> Module -- The module being compiled
-mkThisModule name = Module name ThisPackage
+mkVanillaModule name = Module name DunnoYet
mkPrelModule :: ModuleName -> Module
mkPrelModule name = mkModule name preludePackage
moduleString :: Module -> EncodedString
-moduleString (Module mod _) = _UNPK_ mod
+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
+
+packageOfModule :: Module -> Maybe PackageName
+packageOfModule (Module nm (AnotherPackage pn)) = Just pn
+packageOfModule _ = Nothing
+
+printModulePrefix :: Module -> Bool
+ -- When printing, say M.x
+printModulePrefix (Module nm ThisPackage) = False
+printModulePrefix _ = True
+\end{code}
+
+
+%************************************************************************
+%* *
+\subsection{@ModuleEnv@s}
+%* *
+%************************************************************************
+
+\begin{code}
+type ModuleEnv elt = UniqFM elt
+
+emptyModuleEnv :: ModuleEnv a
+mkModuleEnv :: [(Module, a)] -> ModuleEnv a
+unitModuleEnv :: Module -> a -> ModuleEnv a
+extendModuleEnv :: ModuleEnv a -> Module -> a -> ModuleEnv a
+extendModuleEnv_C :: (a->a->a) -> ModuleEnv a -> Module -> a -> ModuleEnv a
+plusModuleEnv :: ModuleEnv a -> ModuleEnv a -> ModuleEnv a
+extendModuleEnvList :: ModuleEnv a -> [(Module, a)] -> ModuleEnv a
+
+delModuleEnvList :: ModuleEnv a -> [Module] -> ModuleEnv a
+delModuleEnv :: ModuleEnv a -> Module -> ModuleEnv a
+plusModuleEnv_C :: (a -> a -> a) -> ModuleEnv a -> ModuleEnv a -> ModuleEnv a
+mapModuleEnv :: (a -> b) -> ModuleEnv a -> ModuleEnv b
+moduleEnvElts :: ModuleEnv a -> [a]
+
+isEmptyModuleEnv :: ModuleEnv a -> Bool
+lookupModuleEnv :: ModuleEnv a -> Module -> Maybe a
+lookupModuleEnvByName:: ModuleEnv a -> ModuleName -> Maybe a
+lookupWithDefaultModuleEnv :: ModuleEnv a -> a -> Module -> a
+elemModuleEnv :: Module -> ModuleEnv a -> Bool
+foldModuleEnv :: (a -> b -> b) -> b -> ModuleEnv a -> b
+
+elemModuleEnv = elemUFM
+extendModuleEnv = addToUFM
+extendModuleEnv_C = addToUFM_C
+extendModuleEnvList = addListToUFM
+plusModuleEnv_C = plusUFM_C
+delModuleEnvList = delListFromUFM
+delModuleEnv = delFromUFM
+plusModuleEnv = plusUFM
+lookupModuleEnv = lookupUFM
+lookupModuleEnvByName = lookupUFM
+lookupWithDefaultModuleEnv = lookupWithDefaultUFM
+mapModuleEnv = mapUFM
+mkModuleEnv = listToUFM
+emptyModuleEnv = emptyUFM
+moduleEnvElts = eltsUFM
+unitModuleEnv = unitUFM
+isEmptyModuleEnv = isNullUFM
+foldModuleEnv = foldUFM
\end{code}
\begin{code}
-isLocalModule :: Module -> Bool
-isLocalModule (Module _ ThisPackage) = True
-isLocalModule _ = False
+
+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}