X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FbasicTypes%2FModule.lhs;h=9145b353f329d78f2b8f074b22b02cd1676cd080;hb=22df1e2a699d6eda6d5ada5073bc97c9f35e2947;hp=27d2cf2e942103654a6d8255ee7c2c2713de8973;hpb=fdae8ab9fa3b0e6bca21e395b4f0c8e32c93f451;p=ghc-hetmet.git

diff --git a/ghc/compiler/basicTypes/Module.lhs b/ghc/compiler/basicTypes/Module.lhs
index 27d2cf2..9145b35 100644
--- a/ghc/compiler/basicTypes/Module.lhs
+++ b/ghc/compiler/basicTypes/Module.lhs
@@ -1,207 +1,223 @@
 %
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
+% (c) The University of Glasgow, 2004
 %
-\section[Module]{The @Module@ module.}
 
-Representing modules and their flavours.
+Module
+~~~~~~~~~~
+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.
 
 \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
+    , pprModule			-- :: ModuleName -> SDoc
 
-    , mkBootModule          -- :: Module -> Module
-    , setModuleFlavour	    -- :: IfaceFlavour -> Module -> Module
+    , ModLocation(..)
+    , addBootSuffix, addBootSuffix_maybe, addBootSuffixLocn
 
-    , mkDynamicModule       -- :: Module -> Module
-    , isDynamicModule       -- :: Module -> Bool
+    , moduleString		-- :: ModuleName -> EncodedString
+    , moduleUserString		-- :: ModuleName -> UserString
+    , moduleFS			-- :: ModuleName -> EncodedFS
 
-    , mkSrcModule
-    , mkPrelModule          -- :: UserString -> Module
-
-    , mkSrcModuleFS         -- :: UserFS -> Module
-    , mkSysModuleFS         -- :: EncodedFS -> IfaceFlavour -> Module
-    , mkImportModuleFS      -- :: UserFS -> IfaceFlavour -> Module
-
-    , pprModule
-    , pprModuleSep
-    , pprModuleBoot
+    , mkModule			-- :: UserString -> ModuleName
+    , mkModuleFS		-- :: UserFS    -> ModuleName
+    , mkSysModuleFS		-- :: EncodedFS -> ModuleName
  
-      -- 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, filterModuleEnv
 
-    , bootFlavour           -- :: IfaceFlavour -> Bool
+    , ModuleSet, emptyModuleSet, mkModuleSet, moduleSetElts, extendModuleSet, elemModuleSet
 
     ) where
 
 #include "HsVersions.h"
 import OccName
 import Outputable
-import CmdLineOpts ( opt_Static, opt_CompilingPrelude )
-
+import Unique		( Uniquable(..) )
+import UniqFM
+import UniqSet
+import Binary
+import FastString
 \end{code}
 
-
 %************************************************************************
 %*									*
-\subsection{Interface file flavour}
+\subsection{Module locations}
 %*									*
 %************************************************************************
 
-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.
+\begin{code}
+data ModLocation
+   = ModLocation {
+        ml_hs_file   :: Maybe FilePath,
+		-- The source file, if we have one.  Package modules
+		-- probably don't have source files.
+
+        ml_hi_file   :: FilePath,
+		-- Where the .hi file is, whether or not it exists
+		-- yet.  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 yet.
+		-- (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
+\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
-appropriate code.
+For a module in another package, the hs_file and obj_file
+components of ModLocation are undefined.  
 
-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 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.
 
 \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
+addBootSuffix :: FilePath -> FilePath
+-- Add the "-boot" suffix to .hs, .hi and .o files
+addBootSuffix path = path ++ "-boot"
+
+addBootSuffix_maybe :: Bool -> FilePath -> FilePath
+addBootSuffix_maybe is_boot path
+ | is_boot   = addBootSuffix path
+ | otherwise = path
+
+addBootSuffixLocn :: ModLocation -> ModLocation
+addBootSuffixLocn locn
+  = locn { ml_hs_file  = fmap addBootSuffix (ml_hs_file locn)
+	 , ml_hi_file  = addBootSuffix (ml_hi_file locn)
+	 , ml_obj_file = addBootSuffix (ml_obj_file locn) }
 \end{code}
 
 
 %************************************************************************
 %*									*
-\subsection[Module]{The name of a module}
+\subsection{The name of a module}
 %*									*
 %************************************************************************
 
 \begin{code}
-data Module = Module
-		EncodedFS
-		IfaceFlavour
+newtype Module = Module EncodedFS
 	-- Haskell module names can include the quote character ',
 	-- so the module names have the z-encoding applied to them
-\end{code}
 
-\begin{code}
-instance Outputable Module where
-  ppr = pprModule
+instance Binary Module where
+   put_ bh (Module m) = put_ bh m
+   get bh = do m <- get bh; return (Module m)
+
+instance Uniquable Module where
+  getUnique (Module nm) = getUnique nm
 
--- Ignore the IfaceFlavour when comparing modules
 instance Eq Module where
-  (Module m1 _) == (Module m2 _) = m1 == m2
+  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 Module where
-  (Module m1 _) `compare` (Module m2 _) = m1 `compare` m2
-\end{code}
-
-
-\begin{code}
-pprModule :: Module -> SDoc
-pprModule (Module mod _) = pprEncodedFS mod
+  nm1 `compare` nm2 = getUnique nm1 `compare` getUnique nm2
 
-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 '!'
-\end{code}
-
-
-\begin{code}
-mkSrcModule :: UserString -> Module
-mkSrcModule s = Module (_PK_ (encode s)) HiFile
-
-mkPrelModule :: UserString -> Module
-mkPrelModule s = Module (_PK_ (encode s)) ilk
- where 
-  ilk
-   | opt_Static || opt_CompilingPrelude = HiFile
-   | otherwise				= HiDllFile
+instance Outputable Module where
+  ppr = pprModule
 
-mkSrcModuleFS :: UserFS -> Module
-mkSrcModuleFS s = Module (encodeFS s) HiFile
 
-mkImportModuleFS :: UserFS -> IfaceFlavour -> Module
-mkImportModuleFS s hif = Module (encodeFS s) hif
+pprModule :: Module -> SDoc
+pprModule (Module nm) = pprEncodedFS nm
 
-mkSysModuleFS :: EncodedFS -> IfaceFlavour -> Module
-mkSysModuleFS s hif = Module s hif
+moduleFS :: Module -> EncodedFS
+moduleFS (Module mod) = mod
 
-mkBootModule :: Module -> Module
-mkBootModule (Module s _) = Module s HiBootFile
+moduleString :: Module -> EncodedString
+moduleString (Module mod) = unpackFS mod
 
-mkDynamicModule :: Module -> Module
-mkDynamicModule (Module s HiFile) = Module s HiDllFile
-mkDynamicModule m = m
+moduleUserString :: Module -> UserString
+moduleUserString (Module mod) = decode (unpackFS mod)
 
-setModuleFlavour :: IfaceFlavour -> Module -> Module
-setModuleFlavour hif (Module n _) = Module n hif
+-- used to be called mkSrcModule
+mkModule :: UserString -> Module
+mkModule s = Module (mkFastString (encode s))
 
-moduleString :: Module -> EncodedString
-moduleString (Module mod _) = _UNPK_ mod
+-- used to be called mkSrcModuleFS
+mkModuleFS :: UserFS -> Module
+mkModuleFS s = Module (encodeFS s)
 
-moduleFS :: Module -> EncodedFS
-moduleFS (Module mod _) = mod
+-- used to be called mkSysModuleFS
+mkSysModuleFS :: EncodedFS -> Module
+mkSysModuleFS s = Module s 
+\end{code}
 
-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
+
+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
+filterModuleEnv      :: (a -> Bool) -> ModuleEnv a -> ModuleEnv a
+
+filterModuleEnv	    = filterUFM
+elemModuleEnv       = elemUFM
+extendModuleEnv     = addToUFM
+extendModuleEnv_C   = addToUFM_C
+extendModuleEnvList = addListToUFM
+plusModuleEnv_C     = plusUFM_C
+delModuleEnvList    = delListFromUFM
+delModuleEnv        = delFromUFM
+plusModuleEnv       = plusUFM
+lookupModuleEnv     = lookupUFM
+lookupWithDefaultModuleEnv = lookupWithDefaultUFM
+mapModuleEnv        = mapUFM
+mkModuleEnv         = listToUFM
+emptyModuleEnv      = emptyUFM
+moduleEnvElts       = eltsUFM
+unitModuleEnv       = 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}