\section[Rename]{Renaming and dependency analysis passes}
\begin{code}
-module Rename (
- renameModule, renameStmt, renameRdrName, mkGlobalContext,
- closeIfaceDecls, checkOldIface
- ) where
+module Rename
+ ( renameModule
+ , RnResult(..)
+ , renameStmt
+ , renameRdrName
+ , renameExtCore
+ , mkGlobalContext
+ , closeIfaceDecls
+ , checkOldIface
+ , slurpIface
+ ) where
#include "HsVersions.h"
instDeclFVs, tyClDeclFVs, ruleDeclFVs
)
-import CmdLineOpts ( DynFlags, DynFlag(..) )
+import CmdLineOpts ( DynFlags, DynFlag(..), opt_InPackage )
import RnMonad
import RnExpr ( rnStmt )
import RnNames ( getGlobalNames, exportsFromAvail )
unitAvailEnv, availEnvElts, availNames,
plusAvailEnv, groupAvails, warnUnusedImports,
warnUnusedLocalBinds, warnUnusedModules,
- lookupSrcName, getImplicitStmtFVs,
+ lookupSrcName, getImplicitStmtFVs, mkTopFixityEnv,
getImplicitModuleFVs, newGlobalName, unQualInScope,
- ubiquitousNames, lookupOccRn,
+ ubiquitousNames, lookupOccRn, checkMain,
plusGlobalRdrEnv, mkGlobalRdrEnv
)
import Module ( Module, ModuleName, WhereFrom(..),
moduleNameUserString, moduleName,
moduleEnvElts
)
-import Name ( Name, nameModule )
+import Name ( Name, nameModule, isExternalName )
import NameEnv
import NameSet
-import RdrName ( foldRdrEnv, isQual )
+import RdrName ( foldRdrEnv, isQual, emptyRdrEnv )
import PrelNames ( iNTERACTIVE, pRELUDE_Name )
import ErrUtils ( dumpIfSet, dumpIfSet_dyn, showPass,
printErrorsAndWarnings, errorsFound )
%*********************************************************
\begin{code}
-renameModule :: DynFlags
+renameModule :: DynFlags -> GhciMode
-> HomeIfaceTable -> HomeSymbolTable
-> PersistentCompilerState
-> Module -> RdrNameHsModule
-> IO (PersistentCompilerState, PrintUnqualified,
- Maybe (IsExported, ModIface, [RenamedHsDecl]))
+ Maybe (IsExported, ModIface, RnResult))
-- Nothing => some error occurred in the renamer
-renameModule dflags hit hst pcs this_module rdr_module
+renameModule dflags ghci_mode hit hst pcs this_module rdr_module
= renameSource dflags hit hst pcs this_module $
- rename this_module rdr_module
+ rename ghci_mode this_module rdr_module
\end{code}
\begin{code}
vcat (map ppr decls)]))
\end{code}
+\begin{code}
+renameExtCore :: DynFlags
+ -> HomeIfaceTable -> HomeSymbolTable
+ -> PersistentCompilerState
+ -> Module
+ -> RdrNameHsModule
+ -> IO (PersistentCompilerState, PrintUnqualified,
+ Maybe (IsExported, ModIface, [RenamedHsDecl]))
+
+ -- Nothing => some error occurred in the renamer
+renameExtCore dflags hit hst pcs this_module
+ rdr_module@(HsModule _ _ _ _ local_decls _ loc)
+ -- Rename the (Core) module
+ = renameSource dflags hit hst pcs this_module $
+ pushSrcLocRn loc $
+
+ -- Rename the source
+ initIfaceRnMS this_module (rnExtCoreDecls local_decls) `thenRn` \ (rn_local_decls, binders, fvs) ->
+ recordLocalSlurps binders `thenRn_`
+ closeDecls rn_local_decls fvs `thenRn` \ final_decls ->
+
+ -- Bail out if we fail (but dump debug output anyway for debugging)
+ rnDump final_decls `thenRn_`
+ checkErrsRn `thenRn` \ no_errs_so_far ->
+ if not no_errs_so_far then
+ returnRn (print_unqualified, Nothing)
+ else
+ let
+ mod_iface = ModIface { mi_module = this_module,
+ mi_package = opt_InPackage,
+ mi_version = initialVersionInfo,
+ mi_usages = [],
+ mi_boot = False,
+ mi_orphan = panic "is_orphan",
+ -- ToDo: export the data types also.
+ mi_exports = [(moduleName this_module,
+ map Avail (nameSetToList binders))],
+ mi_globals = Nothing,
+ mi_fixities = mkNameEnv [],
+ mi_deprecs = NoDeprecs,
+ mi_decls = panic "mi_decls"
+ }
+
+ is_exported _ = True
+ in
+ returnRn (print_unqualified, Just (is_exported, mod_iface, final_decls))
+
+ where
+ print_unqualified = const False -- print everything qualified.
+
+
+rnExtCoreDecls :: [RdrNameHsDecl]
+ -> RnMS ([RenamedHsDecl],
+ NameSet, -- Binders
+ FreeVars) -- Free variables
+
+rnExtCoreDecls decls
+ -- Renaming external-core decls is rather like renaming an interface file
+ -- All the decls are TyClDecls, and all the names are original names
+ = go [] emptyNameSet emptyNameSet decls
+ where
+ go rn_decls bndrs fvs [] = returnRn (rn_decls, bndrs, fvs)
+
+ go rn_decls bndrs fvs (TyClD decl : decls)
+ = rnTyClDecl decl `thenRn` \ rn_decl ->
+ go (TyClD rn_decl : rn_decls)
+ (addListToNameSet bndrs (map fst (tyClDeclSysNames rn_decl ++ tyClDeclNames rn_decl)))
+ (fvs `plusFV` tyClDeclFVs rn_decl)
+ decls
+
+ go rn_decls bndrs fvs (decl : decls)
+ = addErrRn (text "Unexpected decl in ExtCore file" $$ ppr decl) `thenRn_`
+ go rn_decls bndrs fvs decls
+\end{code}
+
+
%*********************************************************
%* *
\subsection{Make up an interactive context}
%*********************************************************
%* *
+\subsection{Slurp in a whole module eagerly}
+%* *
+%*********************************************************
+
+\begin{code}
+slurpIface
+ :: DynFlags -> HomeIfaceTable -> HomeSymbolTable
+ -> PersistentCompilerState -> Module
+ -> IO (PersistentCompilerState, PrintUnqualified,
+ Maybe ([Name], [RenamedHsDecl]))
+slurpIface dflags hit hst pcs mod =
+ renameSource dflags hit hst pcs iNTERACTIVE $
+
+ let mod_name = moduleName mod
+ in
+ loadInterface contextDoc mod_name ImportByUser `thenRn` \ iface ->
+ let fvs = availsToNameSet [ avail | (mn,avails) <- mi_exports iface,
+ avail <- avails ]
+ in
+ slurpImpDecls fvs `thenRn` \ rn_imp_decls ->
+ returnRn (alwaysQualify, Just (nameSetToList fvs, rn_imp_decls))
+\end{code}
+
+%*********************************************************
+%* *
\subsection{The main function: rename}
%* *
%*********************************************************
\end{code}
\begin{code}
-rename :: Module -> RdrNameHsModule
- -> RnMG (PrintUnqualified, Maybe (IsExported, ModIface, [RenamedHsDecl]))
-rename this_module contents@(HsModule _ _ exports imports local_decls mod_deprec loc)
+data RnResult -- A RenamedModule ia passed from renamer to typechecker
+ = RnResult { rr_mod :: Module, -- Same as in the ModIface,
+ rr_fixities :: FixityEnv, -- but convenient to have it here
+
+ rr_main :: Maybe Name, -- Just main, for module Main,
+ -- Nothing for other modules
+
+ rr_decls :: [RenamedHsDecl]
+ -- The other declarations of the module
+ -- Fixity and deprecations have already been slurped out
+ } -- and are now in the ModIface for the module
+
+rename :: GhciMode -> Module -> RdrNameHsModule
+ -> RnMG (PrintUnqualified, Maybe (IsExported, ModIface, RnResult))
+rename ghci_mode this_module
+ contents@(HsModule _ _ exports imports local_decls mod_deprec loc)
= pushSrcLocRn loc $
-- FIND THE GLOBAL NAME ENVIRONMENT
checkErrsRn `thenRn` \ no_errs_so_far ->
if not no_errs_so_far then
-- Found errors already, so exit now
- rnDump [] [] `thenRn_`
returnRn (print_unqualified, Nothing)
else
-- RENAME THE SOURCE
rnSourceDecls gbl_env global_avail_env
- local_fixity_env local_decls `thenRn` \ (rn_local_decls, source_fvs) ->
+ local_fixity_env SourceMode local_decls `thenRn` \ (rn_local_decls, source_fvs) ->
- -- EXIT IF ERRORS FOUND
- -- We exit here if there are any errors in the source, *before*
- -- we attempt to slurp the decls from the interfaces, otherwise
- -- the slurped decls may get lost when we return up the stack
- -- to hscMain/hscExpr.
- checkErrsRn `thenRn` \ no_errs_so_far ->
- if not no_errs_so_far then
- -- Found errors already, so exit now
- rnDump [] rn_local_decls `thenRn_`
- returnRn (print_unqualified, Nothing)
- else
-
- -- SLURP IN ALL THE NEEDED DECLARATIONS
- -- Find out what re-bindable names to use for desugaring
- getImplicitModuleFVs mod_name rn_local_decls `thenRn` \ implicit_fvs ->
+ -- GET ANY IMPLICIT FREE VARIALBES
+ getImplicitModuleFVs rn_local_decls `thenRn` \ implicit_fvs ->
+ checkMain ghci_mode mod_name gbl_env `thenRn` \ (maybe_main_name, main_fvs, implicit_main_fvs) ->
let
- export_fvs = availsToNameSet export_avails
- source_fvs2 = source_fvs `plusFV` export_fvs
+ export_fvs = availsToNameSet export_avails
+ used_fvs = source_fvs `plusFV` export_fvs `plusFV` main_fvs
-- The export_fvs make the exported names look just as if they
-- occurred in the source program. For the reasoning, see the
-- comments with RnIfaces.mkImportInfo
-- It also helps reportUnusedNames, which of course must not complain
-- that 'f' isn't mentioned if it is mentioned in the export list
- source_fvs3 = implicit_fvs `plusFV` source_fvs2
+ needed_fvs = implicit_fvs `plusFV` implicit_main_fvs `plusFV` used_fvs
-- It's important to do the "plus" this way round, so that
-- when compiling the prelude, locally-defined (), Bool, etc
-- override the implicit ones.
in
- traceRn (text "Source FVs:" <+> fsep (map ppr (nameSetToList source_fvs3))) `thenRn_`
- slurpImpDecls source_fvs3 `thenRn` \ rn_imp_decls ->
- rnDump rn_imp_decls rn_local_decls `thenRn_`
+ traceRn (text "Needed FVs:" <+> fsep (map ppr (nameSetToList needed_fvs))) `thenRn_`
+
+ -- EXIT IF ERRORS FOUND
+ -- We exit here if there are any errors in the source, *before*
+ -- we attempt to slurp the decls from the interfaces, otherwise
+ -- the slurped decls may get lost when we return up the stack
+ -- to hscMain/hscExpr.
+ checkErrsRn `thenRn` \ no_errs_so_far ->
+ if not no_errs_so_far then
+ -- Found errors already, so exit now
+ rnDump rn_local_decls `thenRn_`
+ returnRn (print_unqualified, Nothing)
+ else
+
+ -- SLURP IN ALL THE NEEDED DECLARATIONS
+ slurpImpDecls needed_fvs `thenRn` \ rn_imp_decls ->
-- GENERATE THE VERSION/USAGE INFO
mkImportInfo mod_name imports `thenRn` \ my_usages ->
final_decls = rn_local_decls ++ rn_imp_decls
+ -- In interactive mode, we don't want to discard any top-level
+ -- entities at all (eg. do not inline them away during
+ -- simplification), and retain them all in the TypeEnv so they are
+ -- available from the command line.
+ --
+ -- isExternalName separates the user-defined top-level names from those
+ -- introduced by the type checker.
+ dont_discard :: Name -> Bool
+ dont_discard | ghci_mode == Interactive = isExternalName
+ | otherwise = (`elemNameSet` export_fvs)
+
mod_iface = ModIface { mi_module = this_module,
+ mi_package = opt_InPackage,
mi_version = initialVersionInfo,
mi_usages = my_usages,
mi_boot = False,
mi_decls = panic "mi_decls"
}
- is_exported name = name `elemNameSet` exported_names
- exported_names = availsToNameSet export_avails
+ rn_result = RnResult { rr_mod = this_module,
+ rr_fixities = fixities,
+ rr_decls = final_decls,
+ rr_main = maybe_main_name }
in
+ rnDump final_decls `thenRn_`
+ rnStats rn_imp_decls `thenRn_`
+
-- REPORT UNUSED NAMES, AND DEBUG DUMP
reportUnusedNames mod_iface print_unqualified
imports full_avail_env gbl_env
- source_fvs2 rn_imp_decls `thenRn_`
- -- NB: source_fvs2: include exports (else we get bogus
+ used_fvs rn_imp_decls `thenRn_`
+ -- NB: used_fvs: include exports (else we get bogus
-- warnings of unused things) but not implicit FVs.
- returnRn (print_unqualified, Just (is_exported, mod_iface, final_decls))
+ returnRn (print_unqualified, Just (dont_discard, mod_iface, rn_result))
where
mod_name = moduleName this_module
\end{code}
\begin{code}
fixitiesFromLocalDecls :: GlobalRdrEnv -> [RdrNameHsDecl] -> RnMG LocalFixityEnv
fixitiesFromLocalDecls gbl_env decls
- = foldlRn getFixities emptyNameEnv decls `thenRn` \ env ->
+ = mkTopFixityEnv gbl_env (foldr get_fix_sigs [] decls) `thenRn` \ env ->
traceRn (text "fixity env" <+> vcat (map ppr (nameEnvElts env))) `thenRn_`
returnRn env
where
- getFixities :: LocalFixityEnv -> RdrNameHsDecl -> RnMG LocalFixityEnv
- getFixities acc (FixD fix)
- = fix_decl acc fix
-
- getFixities acc (TyClD (ClassDecl { tcdSigs = sigs}))
- = foldlRn fix_decl acc [sig | FixSig sig <- sigs]
- -- Get fixities from class decl sigs too.
- getFixities acc other_decl
- = returnRn acc
-
- fix_decl acc sig@(FixitySig rdr_name fixity loc)
- = -- Check for fixity decl for something not declared
- pushSrcLocRn loc $
- lookupSrcName gbl_env rdr_name `thenRn` \ name ->
-
- -- Check for duplicate fixity decl
- case lookupNameEnv acc name of
- Just (FixitySig _ _ loc') -> addErrRn (dupFixityDecl rdr_name loc loc') `thenRn_`
- returnRn acc ;
-
- Nothing -> returnRn (extendNameEnv acc name (FixitySig name fixity loc))
+ get_fix_sigs (FixD fix) acc = fix:acc
+ get_fix_sigs (TyClD (ClassDecl { tcdSigs = sigs})) acc
+ = [sig | FixSig sig <- sigs] ++ acc -- Get fixities from class decl sigs too.
+ get_fix_sigs other_decl acc = acc
\end{code}
-> DynFlags
-> HomeIfaceTable -> HomeSymbolTable
-> PersistentCompilerState
+ -> Module
-> FilePath
-> Bool -- Source unchanged
-> Maybe ModIface -- Old interface from compilation manager, if any
-> IO (PersistentCompilerState, Bool, (RecompileRequired, Maybe ModIface))
-- True <=> errors happened
-checkOldIface ghci_mode dflags hit hst pcs iface_path source_unchanged maybe_iface
+checkOldIface ghci_mode dflags hit hst pcs mod iface_path source_unchanged maybe_iface
= runRn dflags hit hst pcs (panic "Bogus module") $
-- CHECK WHETHER THE SOURCE HAS CHANGED
returnRn (outOfDate, maybe_iface)
else
+ setModuleRn mod $
case maybe_iface of
Just old_iface -> -- Use the one we already have
- setModuleRn (mi_module old_iface) (check_versions old_iface)
+ check_versions old_iface
Nothing -- try and read it from a file
-> readIface iface_path `thenRn` \ read_result ->
$$ nest 4 err) `thenRn_`
returnRn (outOfDate, Nothing)
- Right parsed_iface
- -> setModuleRn (pi_mod parsed_iface) $
- loadOldIface parsed_iface `thenRn` \ m_iface ->
+ Right parsed_iface ->
+ let read_mod_name = pi_mod parsed_iface
+ wanted_mod_name = moduleName mod
+ in
+ if (wanted_mod_name /= read_mod_name) then
+ traceHiDiffsRn (
+ text "Existing interface file has wrong module name: "
+ <> quotes (ppr read_mod_name)
+ ) `thenRn_`
+ returnRn (outOfDate, Nothing)
+ else
+ loadOldIface mod parsed_iface `thenRn` \ m_iface ->
check_versions m_iface
where
check_versions :: ModIface -> RnMG (RecompileRequired, Maybe ModIface)
but what?
\begin{code}
-loadOldIface :: ParsedIface -> RnMG ModIface
+loadOldIface :: Module -> ParsedIface -> RnMG ModIface
-loadOldIface parsed_iface
+loadOldIface mod parsed_iface
= let iface = parsed_iface
- mod = pi_mod iface
in
initIfaceRnMS mod (
loadHomeDecls (pi_decls iface) `thenRn` \ decls ->
decls = mkIfaceDecls new_decls new_rules new_insts
- mod_iface = ModIface { mi_module = mod, mi_version = version,
+ mod_iface = ModIface { mi_module = mod, mi_package = pi_pkg parsed_iface,
+ mi_version = version,
mi_exports = avails, mi_usages = usages,
mi_boot = False, mi_orphan = pi_orphan iface,
mi_fixities = fix_env, mi_deprecs = deprec_env,
map TyClD tycl_decls
needed = unionManyNameSets (map ruleDeclFVs rule_decls) `unionNameSets`
unionManyNameSets (map instDeclFVs inst_decls) `unionNameSets`
- unionManyNameSets (map tyClDeclFVs tycl_decls)
+ unionManyNameSets (map tyClDeclFVs tycl_decls) `unionNameSets`
+ ubiquitousNames
+ -- Data type decls with record selectors,
+ -- which may appear in the decls, need unpackCString
+ -- and friends. It's easier to just grab them right now.
+
local_names = foldl add emptyNameSet tycl_decls
add names decl = addListToNameSet names (map fst (tyClDeclSysNames decl ++ tyClDeclNames decl))
in
-
recordLocalSlurps local_names `thenRn_`
-- Do the transitive closure
- closeDecls decls (needed `plusFV` implicit_fvs) `thenRn` \closed_decls ->
- rnDump [] closed_decls `thenRn_`
+ closeDecls decls needed `thenRn` \closed_decls ->
+ rnDump closed_decls `thenRn_`
returnRn closed_decls
- where
- implicit_fvs = ubiquitousNames -- Data type decls with record selectors,
- -- which may appear in the decls, need unpackCString
- -- and friends. It's easier to just grab them right now.
\end{code}
%*********************************************************
where
n_mod = moduleName (nameModule n)
-rnDump :: [RenamedHsDecl] -- Renamed imported decls
- -> [RenamedHsDecl] -- Renamed local decls
+rnDump :: [RenamedHsDecl] -- Renamed decls
-> RnMG ()
-rnDump imp_decls local_decls
+rnDump decls
= doptRn Opt_D_dump_rn_trace `thenRn` \ dump_rn_trace ->
doptRn Opt_D_dump_rn_stats `thenRn` \ dump_rn_stats ->
doptRn Opt_D_dump_rn `thenRn` \ dump_rn ->
getIfacesRn `thenRn` \ ifaces ->
- ioToRnM (do { dumpIfSet (dump_rn_trace || dump_rn_stats || dump_rn)
- "Renamer statistics"
- (getRnStats imp_decls ifaces) ;
+ ioToRnM ( dumpIfSet dump_rn "Renamer:"
+ (vcat (map ppr decls)) )
+ `thenRn_`
- dumpIfSet dump_rn "Renamer:"
- (vcat (map ppr (local_decls ++ imp_decls)))
- }) `thenRn_`
+ returnRn ()
+rnStats :: [RenamedHsDecl] -- Imported decls
+ -> RnMG ()
+rnStats imp_decls
+ = doptRn Opt_D_dump_rn_trace `thenRn` \ dump_rn_trace ->
+ doptRn Opt_D_dump_rn_stats `thenRn` \ dump_rn_stats ->
+ doptRn Opt_D_dump_rn `thenRn` \ dump_rn ->
+ getIfacesRn `thenRn` \ ifaces ->
+
+ ioToRnM (dumpIfSet (dump_rn_trace || dump_rn_stats || dump_rn)
+ "Renamer statistics"
+ (getRnStats imp_decls ifaces)) `thenRn_`
returnRn ()
\end{code}
%************************************************************************
\begin{code}
-dupFixityDecl rdr_name loc1 loc2
- = vcat [ptext SLIT("Multiple fixity declarations for") <+> quotes (ppr rdr_name),
- ptext SLIT("at ") <+> ppr loc1,
- ptext SLIT("and") <+> ppr loc2]
-
badDeprec d
= sep [ptext SLIT("Illegal deprecation when whole module is deprecated"),
nest 4 (ppr d)]
projects / ghc-hetmet.git / blobdiff