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
+
+ , moduleNameString -- :: ModuleName -> EncodedString
+ , moduleNameUserString -- :: ModuleName -> UserString
+
, moduleString -- :: Module -> EncodedString
, moduleUserString -- :: Module -> UserString
- , moduleIfaceFlavour -- :: Module -> IfaceFlavour
- , moduleFS -- :: Module -> EncodedFS
-
- , mkBootModule -- :: Module -> Module
- , setModuleFlavour -- :: IfaceFlavour -> Module -> Module
+ , moduleName -- :: Module -> ModuleName
- , mkDynamicModule -- :: Module -> Module
- , isDynamicModule -- :: Module -> Bool
+ , mkVanillaModule -- :: ModuleName -> Module
+ , mkThisModule -- :: ModuleName -> Module
+ , mkPrelModule -- :: UserString -> Module
+ , mkModule -- :: ModuleName -> PackageName -> Module
+
+ , isLocalModule -- :: Module -> Bool
, mkSrcModule
- , mkPrelModule -- :: UserString -> Module
- , mkSrcModuleFS -- :: UserFS -> Module
- , mkSysModuleFS -- :: EncodedFS -> IfaceFlavour -> Module
- , mkImportModuleFS -- :: UserFS -> IfaceFlavour -> Module
+ , mkSrcModuleFS -- :: UserFS -> ModuleName
+ , mkSysModuleFS -- :: EncodedFS -> ModuleName
- , pprModule
- , pprModuleSep
- , pprModuleBoot
+ , pprModule, pprModuleName
- -- IfaceFlavour
- , IfaceFlavour
- , hiFile
- , hiBootFile -- :: IfaceFlavour
- , mkDynFlavour -- :: Bool -> IfaceFlavour -> IfaceFlavour
+ , PackageName
- , bootFlavour -- :: IfaceFlavour -> Bool
+ -- Where to find a .hi file
+ , WhereFrom(..)
) where
#include "HsVersions.h"
import OccName
import Outputable
-import CmdLineOpts ( opt_Static, opt_CompilingPrelude )
-
+import CmdLineOpts ( opt_InPackage )
+import FastString ( FastString )
\end{code}
%* *
%************************************************************************
-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,
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 PackageInfo = ThisPackage -- A module from the same package
+ -- as the one being compiled
+ | AnotherPackage PackageName -- A module from a different package
+
+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
\end{code}
%************************************************************************
%* *
-\subsection[Module]{The name of a module}
+\subsection{Where from}
%* *
%************************************************************************
+The @WhereFrom@ type controls where the renamer looks for an interface file
+
\begin{code}
-data Module = Module
- EncodedFS
- IfaceFlavour
+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 PackageInfo
\end{code}
\begin{code}
instance Outputable Module where
ppr = pprModule
--- Ignore the IfaceFlavour when comparing modules
instance Eq Module where
(Module m1 _) == (Module m2 _) = m1 == m2
\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
+ text (show p) <> dot <> pprModuleName mod
+ else
+ pprModuleName mod
\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
-
-mkSrcModuleFS :: UserFS -> Module
-mkSrcModuleFS s = Module (encodeFS s) HiFile
+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
-mkImportModuleFS :: UserFS -> IfaceFlavour -> Module
-mkImportModuleFS s hif = Module (encodeFS s) hif
-mkSysModuleFS :: EncodedFS -> IfaceFlavour -> Module
-mkSysModuleFS s hif = Module s hif
+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.)
-mkBootModule :: Module -> Module
-mkBootModule (Module s _) = Module s HiBootFile
+mkThisModule :: ModuleName -> Module -- The module being compiled
+mkThisModule name = Module name ThisPackage
-mkDynamicModule :: Module -> Module
-mkDynamicModule (Module s HiFile) = Module s HiDllFile
-mkDynamicModule m = m
-
-setModuleFlavour :: IfaceFlavour -> Module -> Module
-setModuleFlavour hif (Module n _) = Module n hif
+mkPrelModule :: ModuleName -> Module
+mkPrelModule name = mkModule name preludePackage
moduleString :: Module -> EncodedString
moduleString (Module mod _) = _UNPK_ mod
-moduleFS :: Module -> EncodedFS
-moduleFS (Module mod _) = mod
+moduleName :: Module -> ModuleName
+moduleName (Module mod _) = mod
moduleUserString :: Module -> UserString
-moduleUserString (Module mod _) = decode (_UNPK_ mod)
-
-moduleIfaceFlavour :: Module -> IfaceFlavour
-moduleIfaceFlavour (Module _ hif) = hif
+moduleUserString (Module mod _) = moduleNameUserString mod
\end{code}
\begin{code}
-isDynamicModule :: Module -> Bool
-isDynamicModule (Module _ HiDllFile) = True
-isDynamicModule _ = False
+isLocalModule :: Module -> Bool
+isLocalModule (Module _ ThisPackage) = True
+isLocalModule _ = False
\end{code}
projects / ghc-hetmet.git / blobdiff