X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FbasicTypes%2FModule.lhs;h=4b59757c6a286c560a621611a80518859d2ffed7;hb=cb51a09231da94d729bcd62177cbdec1a888a180;hp=deeefe12b0f213ad0db7422d8b00b79d69e3128b;hpb=5cea3b9d44c866978ff97151bd738cd061d3bc3c;p=ghc-hetmet.git

diff --git a/ghc/compiler/basicTypes/Module.lhs b/ghc/compiler/basicTypes/Module.lhs
index deeefe1..4b59757 100644
--- a/ghc/compiler/basicTypes/Module.lhs
+++ b/ghc/compiler/basicTypes/Module.lhs
@@ -1,51 +1,97 @@
 %
-% (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
+~~~~~~~~~~~~~
+When compiling module A, which imports module B, we need to 
+know whether B will be in the same DLL as A.  
+	If it's in the same DLL, we refer to B_f_closure
+	If it isn't, we refer to _imp__B_f_closure
+When compiling A, we record in B's Module value whether it's
+in a different DLL, by setting the DLL flag.
+
+
+
 
 \begin{code}
 module Module 
     (
-      Module		    -- abstract, instance of Eq, Ord, Outputable
-    , moduleString          -- :: Module -> EncodedString
-    , moduleUserString      -- :: Module -> UserString
-    , moduleIfaceFlavour    -- :: Module -> IfaceFlavour
-    , moduleFS		    -- :: Module -> EncodedFS
+      Module, 		   	-- Abstract, instance of Eq, Ord, Outputable
 
-    , mkBootModule          -- :: Module -> Module
-    , setModuleFlavour	    -- :: IfaceFlavour -> Module -> Module
+    , ModLocation(..),
+    , showModMsg
 
-    , mkDynamicModule       -- :: Module -> Module
-    , isDynamicModule       -- :: Module -> Bool
+    , ModuleName
+    , pprModuleName		-- :: ModuleName -> SDoc
+    , printModulePrefix
 
-    , mkSrcModule
-    , mkPrelModule          -- :: UserString -> Module
+    , moduleName		-- :: Module -> ModuleName 
+    , moduleNameString		-- :: ModuleName -> EncodedString
+    , moduleNameUserString	-- :: ModuleName -> UserString
+    , moduleNameFS		-- :: ModuleName -> EncodedFS
 
-    , mkSrcModuleFS         -- :: UserFS -> Module
-    , mkSysModuleFS         -- :: EncodedFS -> IfaceFlavour -> Module
-    , mkImportModuleFS      -- :: UserFS -> IfaceFlavour -> Module
+    , moduleString		-- :: Module -> EncodedString
+    , moduleUserString		-- :: Module -> UserString
 
-    , pprModule
-    , pprModuleSep
-    , pprModuleBoot
+    , mkBasePkgModule		-- :: UserString -> Module
+    , mkThPkgModule		-- :: UserString -> Module
+    , mkHomeModule		-- :: ModuleName -> Module
+    , isHomeModule		-- :: Module -> Bool
+    , mkPackageModule		-- :: ModuleName -> Module
+
+    , mkModuleName		-- :: UserString -> ModuleName
+    , mkModuleNameFS		-- :: UserFS    -> ModuleName
+    , mkSysModuleNameFS		-- :: EncodedFS -> ModuleName
+
+    , pprModule,
  
-      -- IfaceFlavour
-    , IfaceFlavour
-    , hiFile
-    , hiBootFile	    -- :: IfaceFlavour
-    , mkDynFlavour	    -- :: Bool -> IfaceFlavour -> IfaceFlavour
+    , ModuleEnv,
+    , elemModuleEnv, extendModuleEnv, extendModuleEnvList, plusModuleEnv_C
+    , delModuleEnvList, delModuleEnv, plusModuleEnv, lookupModuleEnv
+    , lookupWithDefaultModuleEnv, mapModuleEnv, mkModuleEnv, emptyModuleEnv
+    , moduleEnvElts, unitModuleEnv, isEmptyModuleEnv, foldModuleEnv
+    , extendModuleEnv_C
+    , lookupModuleEnvByName, extendModuleEnvByName, unitModuleEnvByName
 
-    , bootFlavour           -- :: IfaceFlavour -> Bool
+    , ModuleSet, emptyModuleSet, mkModuleSet, moduleSetElts, extendModuleSet, elemModuleSet
 
     ) where
 
 #include "HsVersions.h"
 import OccName
 import Outputable
-import CmdLineOpts ( opt_Static )
-
+import Packages		( PackageName, basePackage, thPackage )
+import CmdLineOpts	( opt_InPackage )
+import FastString	( FastString )
+import Unique		( Uniquable(..) )
+import Maybes		( expectJust )
+import UniqFM
+import UniqSet
+import Binary
+import FastString
 \end{code}
 
 
@@ -55,153 +101,288 @@ import CmdLineOpts ( opt_Static )
 %*									*
 %************************************************************************
 
-The IfaceFlavour type is used mainly in an imported Name's Provenance
-to say whether the name comes from a regular .hi file, or whether it comes
-from a hand-written .hi-boot file.  This is important, because it has to be 
-propagated.  Suppose
-
-	C.hs imports B
-	B.hs imports A
-	A.hs imports C {-# SOURCE -#} ( f )
-
-Then in A.hi we may mention C.f, in an inlining.  When compiling B we *must not* 
-read C.f's details from C.hi, even if the latter happens to exist from an earlier
-compilation run.  So we use the name "C!f" in A.hi, and when looking for an interface
-file with details of C!f we look in C.hi-boot.  The "!" stuff is recorded in the
-IfaceFlavour in the Module of C.f in A. 
-
-Not particularly beautiful, but it works.
-
-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 IfaceFlavour = HiFile		-- The thing comes from a standard interface file
-					-- or from the source file itself
-		  | HiBootFile		-- ... or from a handwritten "hi-boot" interface file
-
-		  | HiDllFile           -- The thing comes from a standard interface file, but
-		                        -- it's corresponding object code is residing in a DLL.
-					-- (see above.)
-		  deriving( Eq )
-
-hiFile     = HiFile
-hiDllFile  = HiDllFile
-hiBootFile = HiBootFile
-
--- badly named, isn't clear whether the boolean deals with
--- the 'bootedness' or the 'DLLedness'. ToDo: improve.
-mkDynFlavour :: Bool{-is really dyn?-} -> IfaceFlavour -> IfaceFlavour
-mkDynFlavour True HiFile = HiDllFile
-mkDynFlavour _	  x      = x
-
-instance Text IfaceFlavour where	-- Just used in debug prints of lex tokens
-  showsPrec n HiBootFile s = "!" ++ s
-  showsPrec n HiFile     s = s
-  showsPrec n HiDllFile  s = s
-
-bootFlavour :: IfaceFlavour -> Bool
-bootFlavour HiBootFile = True
-bootFlavour HiFile     = False
-bootFlavour HiDllFile  = False
+data Module = Module ModuleName !PackageInfo
+
+data PackageInfo
+  = ThisPackage				-- A module from the same package 
+					-- as the one being compiled
+  | AnotherPackage			-- A module from a different package
+
+packageInfoPackage :: PackageInfo -> PackageName
+packageInfoPackage ThisPackage        = opt_InPackage
+packageInfoPackage AnotherPackage     = FSLIT("<pkg>")
+
+instance Outputable PackageInfo where
+	-- Just used in debug prints of lex tokens and in debug modde
+   ppr pkg_info = ppr (packageInfoPackage pkg_info)
 \end{code}
 
 
 %************************************************************************
 %*									*
-\subsection[Module]{The name of a module}
+\subsection{Module locations}
 %*									*
 %************************************************************************
 
 \begin{code}
-data Module = Module
-		EncodedFS
-		IfaceFlavour
+data ModLocation
+   = ModLocation {
+        ml_hs_file   :: Maybe FilePath,
+
+        ml_hspp_file :: Maybe FilePath, -- Path of preprocessed source
+
+        ml_hi_file   :: FilePath,	-- Where the .hi file is, whether or not it exists
+					-- Always of form foo.hi, even if there is an hi-boot
+					-- file (we add the -boot suffix later)
+
+        ml_obj_file  :: FilePath	-- Where the .o file is, whether or not it exists
+					-- (might not exist either because the module
+					--  hasn't been compiled yet, or because
+					--  it is part of a package with a .a file)
+     }
+     deriving Show
+
+instance Outputable ModLocation where
+   ppr = text . show
+
+-- Rather a gruesome function to have in Module
+
+showModMsg :: Bool -> Module -> ModLocation -> String
+showModMsg use_object mod location =
+    mod_str ++ replicate (max 0 (16 - length mod_str)) ' '
+    ++" ( " ++ expectJust "showModMsg" (ml_hs_file location) ++ ", "
+    ++ (if use_object
+	  then ml_obj_file location
+	  else "interpreted")
+    ++ " )"
+ where mod_str = moduleUserString mod
+\end{code}
+
+For a module in another package, the hs_file and obj_file
+components of ModLocation are undefined.  
+
+The locations specified by a ModLocation may or may not
+correspond to actual files yet: for example, even if the object
+file doesn't exist, the ModLocation still contains the path to
+where the object file will reside if/when it is created.
+
+
+%************************************************************************
+%*									*
+\subsection{The name of a module}
+%*									*
+%************************************************************************
+
+\begin{code}
+newtype ModuleName = ModuleName EncodedFS
 	-- 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) = getUnique 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 (ModuleName nm) = pprEncodedFS nm
+
+moduleNameFS :: ModuleName -> EncodedFS
+moduleNameFS (ModuleName mod) = mod
+
+moduleNameString :: ModuleName -> EncodedString
+moduleNameString (ModuleName mod) = unpackFS mod
+
+moduleNameUserString :: ModuleName -> UserString
+moduleNameUserString (ModuleName mod) = decode (unpackFS mod)
+
+-- used to be called mkSrcModule
+mkModuleName :: UserString -> ModuleName
+mkModuleName s = ModuleName (mkFastString (encode s))
+
+-- used to be called mkSrcModuleFS
+mkModuleNameFS :: UserFS -> ModuleName
+mkModuleNameFS s = ModuleName (encodeFS s)
+
+-- used to be called mkSysModuleFS
+mkSysModuleNameFS :: EncodedFS -> ModuleName
+mkSysModuleNameFS s = ModuleName s 
 \end{code}
 
 \begin{code}
 instance Outputable Module where
   ppr = pprModule
 
--- Ignore the IfaceFlavour when comparing modules
+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}
 
 
 \begin{code}
 pprModule :: Module -> SDoc
-pprModule (Module mod _) = pprEncodedFS mod
-
-pprModuleSep, pprModuleBoot :: Module -> SDoc
-pprModuleSep (Module mod HiFile)     = dot
-pprModuleSep (Module mod HiDllFile)  = dot
-pprModuleSep (Module mod HiBootFile) = char '!'
-
-pprModuleBoot (Module mod HiFile)     = empty
-pprModuleBoot (Module mod HiDllFile)  = empty
-pprModuleBoot (Module mod HiBootFile) = char '!'
+pprModule (Module mod p) = getPprStyle $ \ sty ->
+			   if debugStyle sty then
+				-- Print the package too
+				-- Don't use '.' because it gets confused
+				-- 	with module names
+				brackets (ppr p) <> pprModuleName mod
+			   else
+				pprModuleName mod
 \end{code}
 
 
 \begin{code}
-mkSrcModule :: UserString -> Module
-mkSrcModule s = Module (_PK_ (encode s)) HiFile
+mkBasePkgModule :: ModuleName -> Module
+mkBasePkgModule mod_nm
+  = Module mod_nm pack_info
+  where
+    pack_info
+      | opt_InPackage == basePackage = ThisPackage
+      | otherwise		     = AnotherPackage
+
+mkThPkgModule :: ModuleName -> Module
+mkThPkgModule mod_nm
+  = Module mod_nm pack_info
+  where
+    pack_info
+      | opt_InPackage == thPackage = ThisPackage
+      | 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
 
-mkPrelModule :: UserString -> Module
-mkPrelModule s = Module (_PK_ (encode s)) ilk
- where 
-  ilk
-   | opt_Static = HiFile
-   | otherwise	= HiDllFile
-
-mkSrcModuleFS :: UserFS -> Module
-mkSrcModuleFS s = Module (encodeFS s) HiFile
-
-mkImportModuleFS :: UserFS -> IfaceFlavour -> Module
-mkImportModuleFS s hif = Module (encodeFS s) hif
-
-mkSysModuleFS :: EncodedFS -> IfaceFlavour -> Module
-mkSysModuleFS s hif = Module s hif
-
-mkBootModule :: Module -> Module
-mkBootModule (Module s _) = Module s HiBootFile
+moduleString :: Module -> EncodedString
+moduleString (Module (ModuleName fs) _) = unpackFS fs
 
-mkDynamicModule :: Module -> Module
-mkDynamicModule (Module s HiFile) = Module s HiDllFile
-mkDynamicModule m = m
+moduleName :: Module -> ModuleName
+moduleName (Module mod pkg_info) = mod
 
-setModuleFlavour :: IfaceFlavour -> Module -> Module
-setModuleFlavour hif (Module n _) = Module n hif
+moduleUserString :: Module -> UserString
+moduleUserString (Module mod _) = moduleNameUserString mod
 
-moduleString :: Module -> EncodedString
-moduleString (Module mod _) = _UNPK_ mod
+printModulePrefix :: Module -> Bool
+  -- When printing, say M.x
+printModulePrefix (Module nm ThisPackage) = False
+printModulePrefix _                       = True
+\end{code}
 
-moduleFS :: Module -> EncodedFS
-moduleFS (Module mod _) = mod
 
-moduleUserString :: Module -> UserString
-moduleUserString (Module mod _) = decode (_UNPK_ mod)
+%************************************************************************
+%*                                                                      *
+\subsection{@ModuleEnv@s}
+%*                                                                      *
+%************************************************************************
 
-moduleIfaceFlavour :: Module -> IfaceFlavour
-moduleIfaceFlavour (Module _ hif) = hif
+\begin{code}
+type ModuleEnv elt = UniqFM elt
+-- A ModuleName and Module have the same Unique,
+-- so both will work as keys.  
+-- The 'ByName' variants work on ModuleNames
+
+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
+lookupWithDefaultModuleEnv :: ModuleEnv a -> a -> Module -> a
+elemModuleEnv        :: Module -> ModuleEnv a -> Bool
+foldModuleEnv        :: (a -> b -> b) -> b -> ModuleEnv a -> b
+
+-- The ByName variants
+lookupModuleEnvByName :: ModuleEnv a -> ModuleName -> Maybe a
+unitModuleEnvByName   :: ModuleName -> a -> ModuleEnv a
+extendModuleEnvByName :: ModuleEnv a -> ModuleName -> a -> ModuleEnv a
+
+elemModuleEnv       = elemUFM
+extendModuleEnv     = addToUFM
+extendModuleEnvByName = 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
+unitModuleEnvByName = unitUFM
+isEmptyModuleEnv    = isNullUFM
+foldModuleEnv       = foldUFM
 \end{code}
 
 \begin{code}
-isDynamicModule :: Module -> Bool
-isDynamicModule (Module _ HiDllFile)  = True
-isDynamicModule _		      = 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}