[project @ 2001-06-27 16:38:17 by simonmar]
[ghc-hetmet.git] / ghc / compiler / rename / Rename.lhs
index 90027bb..c46b48e 100644 (file)
@@ -4,49 +4,48 @@
 \section[Rename]{Renaming and dependency analysis passes}
 
 \begin{code}
-module Rename ( renameModule, renameExpr, closeIfaceDecls, checkOldIface ) where
+module Rename ( renameModule, renameStmt, closeIfaceDecls, checkOldIface ) where
 
 #include "HsVersions.h"
 
 import HsSyn
-import RdrHsSyn                ( RdrNameHsModule, RdrNameHsDecl, RdrNameDeprecation, RdrNameHsExpr,
-                         RdrNameTyClDecl, RdrNameRuleDecl, RdrNameInstDecl, RdrNameImportDecl
+import RdrHsSyn                ( RdrNameHsModule, RdrNameHsDecl, RdrNameDeprecation, 
+                         RdrNameTyClDecl, RdrNameRuleDecl, RdrNameInstDecl, RdrNameImportDecl,
+                         RdrNameStmt
                        )
 import RnHsSyn         ( RenamedHsDecl, RenamedTyClDecl, RenamedRuleDecl, RenamedInstDecl,
-                         extractHsTyNames, RenamedHsExpr,
+                         RenamedStmt,
                          instDeclFVs, tyClDeclFVs, ruleDeclFVs
                        )
 
 import CmdLineOpts     ( DynFlags, DynFlag(..) )
 import RnMonad
-import RnExpr          ( rnExpr )
+import RnExpr          ( rnStmt )
 import RnNames         ( getGlobalNames, exportsFromAvail )
 import RnSource                ( rnSourceDecls, rnTyClDecl, rnIfaceRuleDecl, rnInstDecl )
 import RnIfaces                ( slurpImpDecls, mkImportInfo, recordLocalSlurps,
                          closeDecls,
                          RecompileRequired, outOfDate, recompileRequired
                        )
-import RnHiFiles       ( readIface, removeContext, loadInterface,
+import RnHiFiles       ( readIface, loadInterface,
                          loadExports, loadFixDecls, loadDeprecs,
-                         tryLoadInterface )
+                       )
 import RnEnv           ( availsToNameSet, mkIfaceGlobalRdrEnv,
                          emptyAvailEnv, unitAvailEnv, availEnvElts, 
                          plusAvailEnv, groupAvails, warnUnusedImports, 
                          warnUnusedLocalBinds, warnUnusedModules, 
-                         lookupSrcName, addImplicitFVs,
+                         lookupSrcName, getImplicitStmtFVs, getImplicitModuleFVs, rnSyntaxNames,
                          newGlobalName, unQualInScope,, ubiquitousNames
                        )
 import Module           ( Module, ModuleName, WhereFrom(..),
                          moduleNameUserString, moduleName,
                          moduleEnvElts
                        )
-import Name            ( Name, NamedThing(..), 
-                         nameIsLocalOrFrom, nameOccName, nameModule,
-                       )
-import Name            ( mkNameEnv, nameEnvElts, extendNameEnv )
-import RdrName         ( foldRdrEnv, isQual )
+import Name            ( Name, nameModule )
+import NameEnv
 import NameSet
-import PrelNames       ( SyntaxMap, pRELUDE_Name )
+import RdrName         ( foldRdrEnv, isQual )
+import PrelNames       ( SyntaxMap, vanillaSyntaxMap, pRELUDE_Name )
 import ErrUtils                ( dumpIfSet, dumpIfSet_dyn, showPass, 
                          printErrorsAndWarnings, errorsFound )
 import Bag             ( bagToList )
@@ -61,11 +60,11 @@ import HscTypes             ( PersistentCompilerState, HomeIfaceTable, HomeSymbolTable,
                          VersionInfo(..), ImportVersion, IsExported,
                          IfaceDecls, mkIfaceDecls, dcl_tycl, dcl_rules, dcl_insts,
                          GlobalRdrEnv, GlobalRdrElt(..), pprGlobalRdrEnv,
-                         AvailEnv, GenAvailInfo(..), AvailInfo, Avails,
+                         AvailEnv, GenAvailInfo(..), AvailInfo, 
                          Provenance(..), ImportReason(..), initialVersionInfo,
-                         Deprecations(..) 
+                         Deprecations(..), GhciMode(..),
+                         LocalRdrEnv
                         )
-import CmStaticInfo    ( GhciMode(..) )
 import List            ( partition, nub )
 \end{code}
 
@@ -83,8 +82,8 @@ renameModule :: DynFlags
             -> HomeIfaceTable -> HomeSymbolTable
             -> PersistentCompilerState 
             -> Module -> RdrNameHsModule 
-            -> IO (PersistentCompilerState, 
-                   Maybe (PrintUnqualified, (IsExported, ModIface, (SyntaxMap, [RenamedHsDecl]))))
+            -> IO (PersistentCompilerState, PrintUnqualified,
+                   Maybe (IsExported, ModIface, (SyntaxMap, [RenamedHsDecl])))
        -- Nothing => some error occurred in the renamer
 
 renameModule dflags hit hst pcs this_module rdr_module
@@ -94,54 +93,66 @@ renameModule dflags hit hst pcs this_module rdr_module
 
 
 \begin{code}
-renameExpr :: DynFlags
+renameStmt :: DynFlags
           -> HomeIfaceTable -> HomeSymbolTable
           -> PersistentCompilerState 
-          -> Module -> RdrNameHsExpr
+          -> Module                    -- current context (scope to compile in)
+          -> Module                    -- current module
+          -> LocalRdrEnv               -- current context (temp bindings)
+          -> RdrNameStmt               -- parsed stmt
           -> IO ( PersistentCompilerState, 
-                  Maybe (PrintUnqualified, (SyntaxMap, RenamedHsExpr, [RenamedHsDecl]))
+                  PrintUnqualified,
+                  Maybe ([Name], (SyntaxMap, RenamedStmt, [RenamedHsDecl]))
                  )
 
-renameExpr dflags hit hst pcs this_module expr
+renameStmt dflags hit hst pcs scope_module this_module local_env stmt
   = renameSource dflags hit hst pcs this_module $
-         tryLoadInterface doc (moduleName this_module) ImportByUser 
-                                               `thenRn` \ (iface, maybe_err) ->
-         case maybe_err of {
-           Just msg -> ioToRnM (printErrs alwaysQualify 
-                                (ptext SLIT("failed to load interface for") 
-                                 <+> quotes (ppr this_module) 
-                                 <>  char ':' <+> msg)) `thenRn_`
-                       returnRn Nothing;
-           Nothing -> 
-
-         let rdr_env      = mi_globals iface
-             print_unqual = unQualInScope rdr_env
-         in 
-         initRnMS rdr_env emptyLocalFixityEnv CmdLineMode (rnExpr expr)        
-                                               `thenRn` \ (e,fvs) -> 
-
-         checkErrsRn                           `thenRn` \ no_errs_so_far ->
-         if not no_errs_so_far then
-               -- Found errors already, so exit now
-               doDump e [] `thenRn_` 
-               returnRn Nothing
-         else
-
-         addImplicitFVs rdr_env Nothing fvs            `thenRn` \ (slurp_fvs, syntax_map) ->
-         slurpImpDecls slurp_fvs                       `thenRn` \ decls ->
-
-         doDump e decls  `thenRn_`
-         returnRn (Just (print_unqual, (syntax_map, e, decls)))
-       }
+
+       -- Load the interface for the context module, so 
+       -- that we can get its top-level lexical environment
+       -- Bale out if we fail to do this
+    loadInterface doc (moduleName scope_module) ImportByUser `thenRn` \ iface ->
+    let rdr_env       = mi_globals iface
+       print_unqual  = unQualInScope rdr_env
+    in 
+    checkErrsRn                                `thenRn` \ no_errs_so_far ->
+    if not no_errs_so_far then
+       returnRn (print_unqual, Nothing)
+    else
+
+       -- Rename it
+    initRnMS rdr_env local_env emptyLocalFixityEnv CmdLineMode (
+       rnStmt stmt     $ \ stmt' ->
+       returnRn (([], stmt'), emptyFVs)
+    )                                          `thenRn` \ ((binders, stmt), fvs) -> 
+
+       -- Bale out if we fail
+    checkErrsRn                                        `thenRn` \ no_errs_so_far ->
+    if not no_errs_so_far then
+        doDump [] stmt [] `thenRn_` returnRn (print_unqual, Nothing)
+    else
+
+       -- Add implicit free vars, and close decls
+    getImplicitStmtFVs                                 `thenRn` \ implicit_fvs ->
+    let
+       filtered_fvs = fvs `delListFromNameSet` rdrEnvElts local_env 
+       source_fvs   = implicit_fvs `plusFV` filtered_fvs
+    in
+    slurpImpDecls source_fvs                   `thenRn` \ decls ->
+
+    doDump binders stmt decls  `thenRn_`
+    returnRn (print_unqual, Just (binders, (vanillaSyntaxMap, stmt, decls)))
+
   where
      doc = text "context for compiling expression"
 
-     doDump :: RenamedHsExpr -> [RenamedHsDecl] -> RnMG (Either IOError ())
-     doDump e decls = 
-       getDOptsRn  `thenRn` \ dflags ->
-       ioToRnM (dumpIfSet_dyn dflags Opt_D_dump_rn "Renamer:" 
-                       (vcat (ppr e : map ppr decls)))
+     doDump :: [Name] -> RenamedStmt -> [RenamedHsDecl] -> RnMG (Either IOError ())
+     doDump bndrs stmt decls
+       = getDOptsRn  `thenRn` \ dflags ->
+         ioToRnM (dumpIfSet_dyn dflags Opt_D_dump_rn "Renamer:" 
+                       (vcat [text "Binders:" <+> ppr bndrs,
+                              ppr stmt, text "",
+                              vcat (map ppr decls)]))
 \end{code}
 
 
@@ -156,46 +167,45 @@ renameSource :: DynFlags
             -> HomeIfaceTable -> HomeSymbolTable
             -> PersistentCompilerState 
             -> Module 
-            -> RnMG (Maybe (PrintUnqualified, r))
-            -> IO (PersistentCompilerState, Maybe (PrintUnqualified, r))
+            -> RnMG (PrintUnqualified, Maybe r)
+            -> IO (PersistentCompilerState, PrintUnqualified, Maybe r)
        -- Nothing => some error occurred in the renamer
 
 renameSource dflags hit hst old_pcs this_module thing_inside
   = do { showPass dflags "Renamer"
 
                -- Initialise the renamer monad
-       ; (new_pcs, msgs, maybe_rn_stuff) <- initRn dflags hit hst old_pcs this_module thing_inside
+       ; (new_pcs, msgs, (print_unqual, maybe_rn_stuff)) 
+               <- initRn dflags hit hst old_pcs this_module thing_inside
 
                -- Print errors from renaming
-       ;  let print_unqual = case maybe_rn_stuff of
-                               Just (unqual, _) -> unqual
-                               Nothing          -> alwaysQualify
-
        ;  printErrorsAndWarnings print_unqual msgs ;
 
                -- Return results.  No harm in updating the PCS
        ; if errorsFound msgs then
-           return (new_pcs, Nothing)
+           return (new_pcs, print_unqual, Nothing)
           else     
-           return (new_pcs, maybe_rn_stuff)
+           return (new_pcs, print_unqual, maybe_rn_stuff)
     }
 \end{code}
 
 \begin{code}
 rename :: Module -> RdrNameHsModule 
-       -> RnMG (Maybe (PrintUnqualified, (IsExported, ModIface, (SyntaxMap, [RenamedHsDecl]))))
+       -> RnMG (PrintUnqualified, Maybe (IsExported, ModIface, (SyntaxMap, [RenamedHsDecl])))
 rename this_module contents@(HsModule _ _ exports imports local_decls mod_deprec loc)
   = pushSrcLocRn loc           $
 
        -- FIND THE GLOBAL NAME ENVIRONMENT
     getGlobalNames this_module contents        `thenRn` \ (gbl_env, local_gbl_env, all_avails@(_, global_avail_env)) ->
-
+    let
+       print_unqualified = unQualInScope gbl_env
+    in
        -- Exit if we've found any errors
     checkErrsRn                                `thenRn` \ no_errs_so_far ->
     if not no_errs_so_far then
        -- Found errors already, so exit now
        rnDump [] []            `thenRn_`
-       returnRn Nothing 
+       returnRn (print_unqualified, Nothing)
     else
        
        -- PROCESS EXPORT LIST 
@@ -223,19 +233,34 @@ rename this_module contents@(HsModule _ _ exports imports local_decls mod_deprec
     if not no_errs_so_far then
        -- Found errors already, so exit now
         rnDump [] rn_local_decls               `thenRn_` 
-       returnRn Nothing
+       returnRn (print_unqualified, Nothing)
     else
 
        -- SLURP IN ALL THE NEEDED DECLARATIONS
-    addImplicitFVs gbl_env (Just (mod_name, rn_local_decls)) 
-                  source_fvs                                                   `thenRn` \ (slurp_fvs, sugar_map) -> 
-    traceRn (text "Source FVs:" <+> fsep (map ppr (nameSetToList slurp_fvs)))  `thenRn_`
-    slurpImpDecls slurp_fvs            `thenRn` \ rn_imp_decls ->
+       -- Find out what re-bindable names to use for desugaring
+    getImplicitModuleFVs mod_name rn_local_decls       `thenRn` \ implicit_fvs ->
+    rnSyntaxNames gbl_env source_fvs                   `thenRn` \ (source_fvs1, sugar_map) ->
+    let
+       export_fvs  = availsToNameSet export_avails
+       source_fvs2 = source_fvs1 `plusFV` export_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
+               -- 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_` 
 
        -- GENERATE THE VERSION/USAGE INFO
-    mkImportInfo mod_name imports                      `thenRn` \ my_usages ->
+    mkImportInfo mod_name imports              `thenRn` \ my_usages ->
 
        -- BUILD THE MODULE INTERFACE
     let
@@ -249,13 +274,12 @@ rename this_module contents@(HsModule _ _ exports imports local_decls mod_deprec
        my_exports = groupAvails this_module export_avails
        
        final_decls = rn_local_decls ++ rn_imp_decls
-       is_orphan   = any (isOrphanDecl this_module) rn_local_decls
 
        mod_iface = ModIface {  mi_module   = this_module,
                                mi_version  = initialVersionInfo,
                                mi_usages   = my_usages,
                                mi_boot     = False,
-                               mi_orphan   = is_orphan,
+                               mi_orphan   = panic "is_orphan",
                                mi_exports  = my_exports,
                                mi_globals  = gbl_env,
                                mi_fixities = fixities,
@@ -263,7 +287,6 @@ rename this_module contents@(HsModule _ _ exports imports local_decls mod_deprec
                                mi_decls    = panic "mi_decls"
                    }
 
-       print_unqualified = unQualInScope gbl_env
        is_exported name  = name `elemNameSet` exported_names
        exported_names    = availsToNameSet export_avails
     in
@@ -271,42 +294,15 @@ rename this_module contents@(HsModule _ _ exports imports local_decls mod_deprec
        -- REPORT UNUSED NAMES, AND DEBUG DUMP 
     reportUnusedNames mod_iface print_unqualified 
                      imports global_avail_env
-                     source_fvs export_avails rn_imp_decls     `thenRn_`
+                     source_fvs2 rn_imp_decls          `thenRn_`
+               -- NB: source_fvs2: include exports (else we get bogus 
+               --     warnings of unused things) but not implicit FVs.
 
-    returnRn (Just (print_unqualified, (is_exported, mod_iface, (sugar_map, final_decls))))
+    returnRn (print_unqualified, Just (is_exported, mod_iface, (sugar_map, final_decls)))
   where
     mod_name = moduleName this_module
 \end{code}
 
-\begin{code}
-isOrphanDecl this_mod (InstD (InstDecl inst_ty _ _ _ _))
-  = not (foldNameSet ((||) . nameIsLocalOrFrom this_mod) False 
-                    (extractHsTyNames (removeContext inst_ty)))
-       -- The 'removeContext' is because of
-       --      instance Foo a => Baz T where ...
-       -- The decl is an orphan if Baz and T are both not locally defined,
-       --      even if Foo *is* locally defined
-
-isOrphanDecl this_mod (RuleD (HsRule _ _ _ lhs _ _))
-  = check lhs
-  where
-       -- At the moment we just check for common LHS forms
-       -- Expand as necessary.  Getting it wrong just means
-       -- more orphans than necessary
-    check (HsVar v)      = not (nameIsLocalOrFrom this_mod v)
-    check (HsApp f a)    = check f && check a
-    check (HsLit _)      = False
-    check (HsOverLit _)          = False
-    check (OpApp l o _ r) = check l && check o && check r
-    check (NegApp e)      = check e
-    check (HsPar e)      = check e
-    check (SectionL e o)  = check e && check o
-    check (SectionR o e)  = check e && check o
-
-    check other                  = True        -- Safe fall through
-
-isOrphanDecl _ _  = False
-\end{code}
 
 
 %*********************************************************
@@ -416,7 +412,9 @@ checkOldIface ghci_mode dflags hit hst pcs iface_path source_unchanged maybe_ifa
           -> readIface iface_path      `thenRn` \ read_result ->
              case read_result of
                Left err -> -- Old interface file not found, or garbled; give up
-                          traceRn (text "Bad old interface file" $$ nest 4 err) `thenRn_`
+                          traceHiDiffsRn (
+                               text "Cannot read old interface file:"
+                                  $$ nest 4 err) `thenRn_`
                           returnRn (outOfDate, Nothing)
 
                Right parsed_iface
@@ -573,11 +571,10 @@ reportUnusedNames :: ModIface -> PrintUnqualified
                  -> [RdrNameImportDecl] 
                  -> AvailEnv
                  -> NameSet            -- Used in this module
-                 -> Avails             -- Exported by this module
                  -> [RenamedHsDecl] 
                  -> RnMG ()
 reportUnusedNames my_mod_iface unqual imports avail_env 
-                 source_fvs export_avails imported_decls
+                 used_names imported_decls
   = warnUnusedModules unused_imp_mods                          `thenRn_`
     warnUnusedLocalBinds bad_locals                            `thenRn_`
     warnUnusedImports bad_imp_names                            `thenRn_`
@@ -586,11 +583,6 @@ reportUnusedNames my_mod_iface unqual imports avail_env
     this_mod   = mi_module my_mod_iface
     gbl_env    = mi_globals my_mod_iface
     
-       -- The export_fvs make the exported names look just as if they
-       -- occurred in the source program.  
-    export_fvs = availsToNameSet export_avails
-    used_names = source_fvs `plusFV` export_fvs
-
     -- Now, a use of C implies a use of T,
     -- if C was brought into scope by T(..) or T(C)
     really_used_names = used_names `unionNameSets`
@@ -697,8 +689,7 @@ printMinimalImports :: Module       -- This module
                    -> FiniteMap ModuleName AvailEnv    -- Minimal imports
                    -> RnMG ()
 printMinimalImports this_mod unqual imps
-  = doptRn Opt_D_dump_minimal_imports          `thenRn` \ dump_minimal ->
-    if not dump_minimal then returnRn () else
+  = ifOptRn Opt_D_dump_minimal_imports                 $
 
     mapRn to_ies (fmToList imps)               `thenRn` \ mod_ies ->
     ioToRnM (do { h <- openFile filename WriteMode ;