Representing modules and their flavours.
+
+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
, ModuleName
+ , ModuleKind(..)
+ , isPackageKind
, moduleNameString -- :: ModuleName -> EncodedString
, moduleNameUserString -- :: ModuleName -> UserString
, moduleUserString -- :: Module -> UserString
, moduleName -- :: Module -> ModuleName
- , mkVanillaModule -- :: ModuleName -> Module
- , mkThisModule -- :: ModuleName -> Module
- , mkPrelModule -- :: UserString -> Module
+-- , mkVanillaModule -- :: ModuleName -> Module
+-- , mkThisModule -- :: ModuleName -> Module
+-- , mkPrelModule -- :: UserString -> Module
+ , mkModule -- :: ModuleName -> ModuleKind -> Module
- , isDynamicModule -- :: Module -> Bool
- , isPrelModule
+-- , isLocalModule -- :: Module -> Bool
, mkSrcModule
, pprModule, pprModuleName
- -- DllFlavour
- , DllFlavour, dll, notDll
-
- -- ModFlavour
- , ModFlavour,
+ , PackageName
-- Where to find a .hi file
- , WhereFrom(..), SearchPath, mkSearchPath
- , ModuleHiMap, mkModuleHiMaps
+ , WhereFrom(..)
) where
#include "HsVersions.h"
import OccName
import Outputable
-import FiniteMap
-import CmdLineOpts ( opt_Static, opt_CompilingPrelude, opt_WarnHiShadows, opt_HiMapSep )
-import Constants ( interfaceFileFormatVersion )
-import Maybes ( seqMaybe )
-import Maybe ( fromMaybe )
-import Directory ( doesFileExist )
-import DirUtils ( getDirectoryContents )
-import List ( intersperse )
-import Monad ( foldM )
-import IO ( hPutStrLn, stderr, isDoesNotExistError )
+import CmdLineOpts ( opt_InPackage )
+import FastString ( FastString, uniqueOfFS )
+import Unique ( Uniquable(..), mkUniqueGrimily )
\end{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.)
-\begin{code}
-data DllFlavour = NotDll -- Ordinary module
- | Dll -- The module's object code lives in a DLL.
- deriving( Eq )
-
-dll = Dll
-notDll = NotDll
-
-instance Text DllFlavour where -- Just used in debug prints of lex tokens
- showsPrec n NotDll s = s
- showsPrec n Dll s = "dll " ++ s
-\end{code}
-
-
-%************************************************************************
-%* *
-\subsection{System/user module}
-%* *
-%************************************************************************
-
-We also track whether an imported module is from a 'system-ish' place. In this case
-we don't record the fact that this module depends on it, nor usages of things
-inside it.
-
-Apr 00: We want to record dependencies on all modules other than
-prelude modules else STG Hugs gets confused because it uses this
-info to know what modules to link. (Compiled GHC uses command line
-options to specify this.)
+@SourceOnly@ and @ObjectCode@ indicate a module from the same package
+as the one being compiled, i.e. a home module. @InPackage@ means one
+from a different package.
\begin{code}
-data ModFlavour = PrelMod -- A Prelude module
- | UserMod -- Not library-ish
+data ModuleKind
+ = SourceOnly FilePath -- .hs
+ | ObjectCode FilePath FilePath -- .o, .hi
+ | InPackage PackageName
+
+isPackageKind (InPackage _) = True
+isPackageKind _ = False
+
+type PackageName = FastString -- No encoding at all
+
+preludePackage :: PackageName
+preludePackage = SLIT("std")
+
+instance Outputable ModuleKind where
+ ppr (SourceOnly path_hs)
+ = text "SourceOnly" <+> text (show path_hs)
+ ppr (ObjectCode path_o path_hi)
+ = text "ObjectCode" <+> text (show path_o) <+> text (show path_hi)
+ ppr (InPackage pkgname)
+ = text "InPackage" <+> text (show pkgname)
\end{code}
-- Haskell module names can include the quote character ',
-- so the module names have the z-encoding applied to them
-isPrelModuleName :: ModuleName -> Bool
- -- True for names of prelude modules
-isPrelModuleName m = take 4 (_UNPK_ m) == "Prel"
-
pprModuleName :: ModuleName -> SDoc
pprModuleName nm = pprEncodedFS nm
\end{code}
\begin{code}
-data Module = Module
- ModuleName
- ModFlavour
- DllFlavour
+data Module
+ = Module {
+ mod_name :: ModuleName,
+ mod_kind :: ModuleKind
+ }
\end{code}
\begin{code}
instance Outputable Module where
ppr = pprModule
+instance Uniquable Module where
+ getUnique (Module nm _) = mkUniqueGrimily (uniqueOfFS 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 _ _) = getPprStyle $ \ sty ->
- if userStyle sty then
- text (moduleNameUserString mod)
- else
+pprModule (Module mod p) = getPprStyle $ \ sty ->
+ if debugStyle sty then
+ -- Print the package too
+ ppr p <> dot <> pprModuleName mod
+ else
pprModuleName mod
\end{code}
\begin{code}
-mkModule :: FilePath -- Directory in which this module is
- -> ModuleName -- Name of the module
- -> DllFlavour
- -> Module
-mkModule dir_path mod_nm is_dll
- | isPrelModuleName mod_nm = mkPrelModule mod_nm
- | otherwise = Module mod_nm UserMod is_dll
- -- Make every module into a 'user module'
- -- except those constructed by mkPrelModule
-
-
-mkVanillaModule :: ModuleName -> Module
-mkVanillaModule name = Module name UserMod dell
- where
- main_mod = mkSrcModuleFS SLIT("Main")
-
- -- Main can never be in a DLL - need this
- -- special case in order to correctly
- -- compile PrelMain
- dell | opt_Static || opt_CompilingPrelude ||
- name == main_mod = NotDll
- | otherwise = Dll
-
-
-mkThisModule :: ModuleName -> Module -- The module being comiled
-mkThisModule name =
- Module name UserMod NotDll -- This is fine, a Dll flag is only
- -- pinned on imported modules.
-
-mkPrelModule :: ModuleName -> Module
-mkPrelModule name = Module name sys dll
- where
- sys | opt_CompilingPrelude = UserMod
- | otherwise = PrelMod
-
- dll | opt_Static || opt_CompilingPrelude = NotDll
- | otherwise = Dll
+mkModule :: ModuleName -> ModuleKind -> Module
+mkModule = Module
+-- I don't think anybody except the Finder should ever try to create a
+-- Module now, so this lot commented out pro tem (JRS)
+--mkModule :: ModuleName -- Name of the module
+-- -> PackageName
+-- -> Module
+--mkModule mod_nm pack_name
+-- = Module mod_nm pack_info
+-- where
+-- pack_info | pack_name == opt_InPackage = ThisPackage
+-- | otherwise = AnotherPackage pack_name
+
+
+--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
+
+--mkPrelModule :: ModuleName -> Module
+--mkPrelModule name = mkModule name preludePackage
moduleString :: Module -> EncodedString
-moduleString (Module mod _ _) = _UNPK_ mod
+moduleString (Module mod _) = _UNPK_ mod
moduleName :: Module -> ModuleName
-moduleName (Module mod _ _) = mod
+moduleName (Module mod _) = mod
moduleUserString :: Module -> UserString
-moduleUserString (Module mod _ _) = moduleNameUserString mod
-\end{code}
-
-\begin{code}
-isDynamicModule :: Module -> Bool
-isDynamicModule (Module _ _ Dll) = True
-isDynamicModule _ = False
-
-isPrelModule :: Module -> Bool
-isPrelModule (Module _ PrelMod _) = True
-isPrelModule _ = False
+moduleUserString (Module mod _) = moduleNameUserString mod
\end{code}
-
-%************************************************************************
-%* *
-\subsection{Finding modules in the file system
-%* *
-%************************************************************************
-
\begin{code}
-type ModuleHiMap = FiniteMap ModuleName (String, Module)
- -- Mapping from module name to
- -- * the file path of its corresponding interface file,
- -- * the Module, decorated with it's properties
+--isLocalModule :: Module -> Bool
+--isLocalModule (Module _ ThisPackage) = True
+--isLocalModule _ = False
\end{code}
-
-(We allege that) it is quicker to build up a mapping from module names
-to the paths to their corresponding interface files once, than to search
-along the import part every time we slurp in a new module (which we
-do quite a lot of.)
-
-\begin{code}
-type SearchPath = [(String,String)] -- List of (directory,suffix) pairs to search
- -- for interface files.
-
-mkModuleHiMaps :: SearchPath -> IO (ModuleHiMap, ModuleHiMap)
-mkModuleHiMaps dirs = foldM (getAllFilesMatching dirs) (env,env) dirs
- where
- env = emptyFM
-
-{- A pseudo file, currently "dLL_ifs.hi",
- signals that the interface files
- contained in a particular directory have got their
- corresponding object codes stashed away in a DLL
-
- This stuff is only needed to deal with Win32 DLLs,
- and conceivably we conditionally compile in support
- for handling it. (ToDo?)
--}
-dir_contain_dll_his = "dLL_ifs.hi"
-
-getAllFilesMatching :: SearchPath
- -> (ModuleHiMap, ModuleHiMap)
- -> (FilePath, String)
- -> IO (ModuleHiMap, ModuleHiMap)
-getAllFilesMatching dirs hims (dir_path, suffix) = ( do
- -- fpaths entries do not have dir_path prepended
- fpaths <- getDirectoryContents dir_path
- is_dll <- catch
- (if opt_Static || dir_path == "." then
- return NotDll
- else
- do exists <- doesFileExist (dir_path ++ '/': dir_contain_dll_his)
- return (if exists then Dll else NotDll)
- )
- (\ _ {-don't care-} -> return NotDll)
- return (foldl (addModules is_dll) hims fpaths))
- -- soft failure
- `catch`
- (\ err -> do
- hPutStrLn stderr
- ("Import path element `" ++ dir_path ++
- if (isDoesNotExistError err) then
- "' does not exist, ignoring."
- else
- "' couldn't read, ignoring.")
-
- return hims
- )
- where
- xiffus = reverse dotted_suffix
- dotted_suffix = case suffix of
- [] -> []
- ('.':xs) -> suffix
- ls -> '.':ls
-
- hi_boot_version_xiffus =
- reverse (show interfaceFileFormatVersion) ++ '-':hi_boot_xiffus
- hi_boot_xiffus = "toob-ih." -- .hi-boot reversed!
-
- addModules is_dll his@(hi_env, hib_env) filename = fromMaybe his $
- FMAP add_hi (go xiffus rev_fname) `seqMaybe`
-
- FMAP add_vhib (go hi_boot_version_xiffus rev_fname) `seqMaybe`
- -- If there's a Foo.hi-boot-N file then override any Foo.hi-boot
-
- FMAP add_hib (go hi_boot_xiffus rev_fname)
- where
- rev_fname = reverse filename
- path = dir_path ++ '/':filename
-
- -- In these functions file_nm is the base of the filename,
- -- with the path and suffix both stripped off. The filename
- -- is the *unencoded* module name (else 'make' gets confused).
- -- But the domain of the HiMaps is ModuleName which is encoded.
- add_hi file_nm = (add_to_map addNewOne hi_env file_nm, hib_env)
- add_vhib file_nm = (hi_env, add_to_map overrideNew hib_env file_nm)
- add_hib file_nm = (hi_env, add_to_map addNewOne hib_env file_nm)
-
- add_to_map combiner env file_nm
- = addToFM_C combiner env mod_nm (path, mkModule dir_path mod_nm is_dll)
- where
- mod_nm = mkSrcModuleFS file_nm
-
- -- go prefix (prefix ++ stuff) == Just (reverse stuff)
- go [] xs = Just (_PK_ (reverse xs))
- go _ [] = Nothing
- go (x:xs) (y:ys) | x == y = go xs ys
- | otherwise = Nothing
-
- addNewOne | opt_WarnHiShadows = conflict
- | otherwise = stickWithOld
-
- stickWithOld old new = old
- overrideNew old new = new
-
- conflict (old_path,mod) (new_path,_)
- | old_path /= new_path =
- pprTrace "Warning: " (text "Identically named interface files present on the import path, " $$
- text (show old_path) <+> text "shadows" $$
- text (show new_path) $$
- text "on the import path: " <+>
- text (concat (intersperse ":" (map fst dirs))))
- (old_path,mod)
- | otherwise = (old_path,mod) -- don't warn about innocous shadowings.
-\end{code}
-
-
-%*********************************************************
-%* *
-\subsection{Making a search path}
-%* *
-%*********************************************************
-
-@mkSearchPath@ takes a string consisting of a colon-separated list
-of directories and corresponding suffixes, and turns it into a list
-of (directory, suffix) pairs. For example:
-
-\begin{verbatim}
- mkSearchPath "foo%.hi:.%.p_hi:baz%.mc_hi"
- = [("foo",".hi"),( ".", ".p_hi"), ("baz",".mc_hi")]
-\begin{verbatim}
-
-\begin{code}
-mkSearchPath :: Maybe String -> SearchPath
-mkSearchPath Nothing = [(".",".hi")] -- ToDo: default should be to look in
- -- the directory the module we're compiling
- -- lives.
-mkSearchPath (Just s) = go s
- where
- go "" = []
- go s =
- case span (/= '%') s of
- (dir,'%':rs) ->
- case span (/= opt_HiMapSep) rs of
- (hisuf,_:rest) -> (dir,hisuf):go rest
- (hisuf,[]) -> [(dir,hisuf)]
-\end{code}
-
projects / ghc-hetmet.git / blobdiff