Skip to content
Snippets Groups Projects
Commit 4a5b2787 authored by Simon Peyton Jones's avatar Simon Peyton Jones
Browse files

[project @ 1999-05-28 08:08:44 by simonpj] 

Minor wibble to do with module names that contain a Z
parent 00eefb90
No related merge requests found
Hide whitespace changes
Inline Side-by-side
ghc/compiler/basicTypes/Module.lhs
+ 391
− 381
View file @ 4a5b2787
%
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section[Module]{The @Module@ module.}
Representing modules and their flavours.
\begin{code}
module Module
(
Module -- abstract, instance of Eq, Ord, Outputable
, ModuleName
, moduleNameString -- :: ModuleName -> EncodedString
, moduleNameUserString -- :: ModuleName -> UserString
, moduleString -- :: Module -> EncodedString
, moduleUserString -- :: Module -> UserString
, moduleName -- :: Module -> ModuleName
, mkVanillaModule -- :: ModuleName -> Module
, mkThisModule -- :: ModuleName -> Module
, mkPrelModule -- :: UserString -> Module
, isDynamicModule -- :: Module -> Bool
, isLibModule
, mkSrcModule
, mkSrcModuleFS -- :: UserFS -> ModuleName
, mkSysModuleFS -- :: EncodedFS -> ModuleName
, pprModule, pprModuleName
-- DllFlavour
, DllFlavour, dll, notDll
-- ModFlavour
, ModFlavour, libMod, userMod
-- Where to find a .hi file
, WhereFrom(..), SearchPath, mkSearchPath
, ModuleHiMap, mkModuleHiMaps
) where
#include "HsVersions.h"
import OccName
import Outputable
import FiniteMap
import CmdLineOpts ( opt_Static, opt_CompilingPrelude, opt_WarnHiShadows )
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 )
\end{code}
%************************************************************************
%* *
\subsection{Interface file flavour}
%* *
%************************************************************************
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.)
\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.
\begin{code}
data ModFlavour = LibMod -- A library-ish module
| UserMod -- Not library-ish
libMod = LibMod
userMod = UserMod
\end{code}
%************************************************************************
%* *
\subsection{Where from}
%* *
%************************************************************************
The @WhereFrom@ type controls where the renamer looks for an interface file
\begin{code}
data WhereFrom = ImportByUser -- Ordinary user import: look for M.hi
| ImportByUserSource -- User {- SOURCE -}: look for M.hi-boot
| 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
instance Outputable WhereFrom where
ppr ImportByUser = empty
ppr ImportByUserSource = ptext SLIT("{- SOURCE -}")
ppr ImportBySystem = ptext SLIT("{- SYSTEM IMPORT -}")
\end{code}
%************************************************************************
%* *
\subsection{The name of a module}
%* *
%************************************************************************
\begin{code}
type ModuleName = EncodedFS
-- Haskell module names can include the quote character ',
-- so the module names have the z-encoding applied to them
pprModuleName :: ModuleName -> SDoc
pprModuleName nm = pprEncodedFS nm
moduleNameString :: ModuleName -> EncodedString
moduleNameString mod = _UNPK_ mod
moduleNameUserString :: ModuleName -> UserString
moduleNameUserString mod = decode (_UNPK_ mod)
mkSrcModule :: UserString -> ModuleName
mkSrcModule s = _PK_ (encode s)
mkSrcModuleFS :: UserFS -> ModuleName
mkSrcModuleFS s = encodeFS s
mkSysModuleFS :: EncodedFS -> ModuleName
mkSysModuleFS s = s
\end{code}
\begin{code}
data Module = Module
ModuleName
ModFlavour
DllFlavour
\end{code}
\begin{code}
instance Outputable Module where
ppr = pprModule
instance Eq Module where
(Module m1 _ _) == (Module m2 _ _) = m1 == m2
instance Ord Module where
(Module m1 _ _) `compare` (Module m2 _ _) = m1 `compare` m2
\end{code}
\begin{code}
pprModule :: Module -> SDoc
pprModule (Module mod _ _) = pprEncodedFS mod
\end{code}
\begin{code}
mkModule = Module
mkVanillaModule :: ModuleName -> Module
mkVanillaModule name = Module name UserMod NotDll
mkThisModule :: ModuleName -> Module -- The module being comiled
mkThisModule name = Module name UserMod NotDll -- ToDo: correct Dll flag?
mkPrelModule :: ModuleName -> Module
mkPrelModule name = Module name sys dll
where
sys | opt_CompilingPrelude = UserMod
| otherwise = LibMod
dll | opt_Static || opt_CompilingPrelude = NotDll
| otherwise = Dll
moduleString :: Module -> EncodedString
moduleString (Module mod _ _) = _UNPK_ mod
moduleName :: Module -> ModuleName
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
isLibModule :: Module -> Bool
isLibModule (Module _ LibMod _) = True
isLibModule _ = False
\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
\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
-- Dreadfully crude. We want a better way to distinguish
-- "library-ish" modules.
is_sys | head dir_path == '/' = LibMod
| otherwise = UserMod
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`
FMAP add_hib (go hi_boot_xiffus rev_fname)
where
rev_fname = reverse filename
path = dir_path ++ '/':filename
mk_module mod_nm = Module mod_nm is_sys is_dll
add_hi mod_nm = (addToFM_C addNewOne hi_env mod_nm (path, mk_module mod_nm), hib_env)
add_vhib mod_nm = (hi_env, addToFM_C overrideNew hib_env mod_nm (path, mk_module mod_nm))
add_hib mod_nm = (hi_env, addToFM_C addNewOne hib_env mod_nm (path, mk_module mod_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 (/= ':') rs of
(hisuf,_:rest) -> (dir,hisuf):go rest
(hisuf,[]) -> [(dir,hisuf)]
\end{code}
%
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section[Module]{The @Module@ module.}
Representing modules and their flavours.
\begin{code}
module Module
(
Module -- abstract, instance of Eq, Ord, Outputable
, ModuleName
, moduleNameString -- :: ModuleName -> EncodedString
, moduleNameUserString -- :: ModuleName -> UserString
, moduleString -- :: Module -> EncodedString
, moduleUserString -- :: Module -> UserString
, moduleName -- :: Module -> ModuleName
, mkVanillaModule -- :: ModuleName -> Module
, mkThisModule -- :: ModuleName -> Module
, mkPrelModule -- :: UserString -> Module
, isDynamicModule -- :: Module -> Bool
, isLibModule
, mkSrcModule
, mkSrcModuleFS -- :: UserFS -> ModuleName
, mkSysModuleFS -- :: EncodedFS -> ModuleName
, pprModule, pprModuleName
-- DllFlavour
, DllFlavour, dll, notDll
-- ModFlavour
, ModFlavour, libMod, userMod
-- Where to find a .hi file
, WhereFrom(..), SearchPath, mkSearchPath
, ModuleHiMap, mkModuleHiMaps
) where
#include "HsVersions.h"
import OccName
import Outputable
import FiniteMap
import CmdLineOpts ( opt_Static, opt_CompilingPrelude, opt_WarnHiShadows )
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 )
\end{code}
%************************************************************************
%* *
\subsection{Interface file flavour}
%* *
%************************************************************************
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.)
\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.
\begin{code}
data ModFlavour = LibMod -- A library-ish module
| UserMod -- Not library-ish
libMod = LibMod
userMod = UserMod
\end{code}
%************************************************************************
%* *
\subsection{Where from}
%* *
%************************************************************************
The @WhereFrom@ type controls where the renamer looks for an interface file
\begin{code}
data WhereFrom = ImportByUser -- Ordinary user import: look for M.hi
| ImportByUserSource -- User {- SOURCE -}: look for M.hi-boot
| 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
instance Outputable WhereFrom where
ppr ImportByUser = empty
ppr ImportByUserSource = ptext SLIT("{- SOURCE -}")
ppr ImportBySystem = ptext SLIT("{- SYSTEM IMPORT -}")
\end{code}
%************************************************************************
%* *
\subsection{The name of a module}
%* *
%************************************************************************
\begin{code}
type ModuleName = EncodedFS
-- Haskell module names can include the quote character ',
-- so the module names have the z-encoding applied to them
pprModuleName :: ModuleName -> SDoc
pprModuleName nm = pprEncodedFS nm
moduleNameString :: ModuleName -> EncodedString
moduleNameString mod = _UNPK_ mod
moduleNameUserString :: ModuleName -> UserString
moduleNameUserString mod = decode (_UNPK_ mod)
mkSrcModule :: UserString -> ModuleName
mkSrcModule s = _PK_ (encode s)
mkSrcModuleFS :: UserFS -> ModuleName
mkSrcModuleFS s = encodeFS s
mkSysModuleFS :: EncodedFS -> ModuleName
mkSysModuleFS s = s
\end{code}
\begin{code}
data Module = Module
ModuleName
ModFlavour
DllFlavour
\end{code}
\begin{code}
instance Outputable Module where
ppr = pprModule
instance Eq Module where
(Module m1 _ _) == (Module m2 _ _) = m1 == m2
instance Ord Module where
(Module m1 _ _) `compare` (Module m2 _ _) = m1 `compare` m2
\end{code}
\begin{code}
pprModule :: Module -> SDoc
pprModule (Module mod _ _) = pprEncodedFS mod
\end{code}
\begin{code}
mkModule = Module
mkVanillaModule :: ModuleName -> Module
mkVanillaModule name = Module name UserMod NotDll
mkThisModule :: ModuleName -> Module -- The module being comiled
mkThisModule name = Module name UserMod NotDll -- ToDo: correct Dll flag?
mkPrelModule :: ModuleName -> Module
mkPrelModule name = Module name sys dll
where
sys | opt_CompilingPrelude = UserMod
| otherwise = LibMod
dll | opt_Static || opt_CompilingPrelude = NotDll
| otherwise = Dll
moduleString :: Module -> EncodedString
moduleString (Module mod _ _) = _UNPK_ mod
moduleName :: Module -> ModuleName
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
isLibModule :: Module -> Bool
isLibModule (Module _ LibMod _) = True
isLibModule _ = False
\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
\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
-- Dreadfully crude. We want a better way to distinguish
-- "library-ish" modules.
is_sys | head dir_path == '/' = LibMod
| otherwise = UserMod
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 mod_nm is_sys 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 (/= ':') rs of
(hisuf,_:rest) -> (dir,hisuf):go rest
(hisuf,[]) -> [(dir,hisuf)]
\end{code}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment