Fix Trac #2188: scoping in TH declarations quotes
[ghc-hetmet.git] / compiler / rename / RnNames.lhs
index 3048efd..591d234 100644 (file)
@@ -8,21 +8,20 @@
 -- The above warning supression flag is a temporary kludge.
 -- While working on this module you are encouraged to remove it and fix
 -- any warnings in the module. See
---     http://hackage.haskell.org/trac/ghc/wiki/CodingStyle#Warnings
+--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
 -- for details
 
 module RnNames (
-       rnImports, importsFromLocalDecls,
-       rnExports,
-       getLocalDeclBinders, extendRdrEnvRn,
-       reportUnusedNames, finishDeprecations
+       rnImports, getLocalNonValBinders,
+       rnExports, extendGlobalRdrEnvRn,
+       reportUnusedNames, finishDeprecations,
     ) where
 
 #include "HsVersions.h"
 
 import DynFlags
 import HsSyn           ( IE(..), ieName, ImportDecl(..), LImportDecl,
-                         ForeignDecl(..), HsGroup(..), HsValBinds(..),
+                         ForeignDecl(..), HsGroup(..), HsValBindsLR(..),
                          Sig(..), collectHsBindLocatedBinders, tyClDeclNames,
                          instDeclATs, isFamInstDecl,
                          LIE )
@@ -36,6 +35,7 @@ import PrelNames
 import Module
 import Name
 import NameEnv
+import LazyUniqFM
 import NameSet
 import OccName
 import HscTypes
@@ -45,13 +45,14 @@ import Maybes
 import SrcLoc
 import FiniteMap
 import ErrUtils
-import BasicTypes      ( DeprecTxt )
+import BasicTypes      ( DeprecTxt, Fixity )
 import DriverPhases    ( isHsBoot )
 import Util
+import FastString
 import ListSetOps
 import Data.List        ( partition, concatMap, (\\), delete )
 import IO              ( openFile, IOMode(..) )
-import Monad           ( when )
+import Monad           ( when, mplus )
 \end{code}
 
 
@@ -247,13 +248,13 @@ rnImportDecl this_mod (L loc (ImportDecl loc_imp_mod_name want_boot
     ifOptM Opt_WarnDeprecations        (
        case deprecs of 
          DeprecAll txt -> addWarn (moduleDeprec imp_mod_name txt)
-         other         -> returnM ()
+         other         -> return ()
      )
 
     let new_imp_decl = L loc (ImportDecl loc_imp_mod_name want_boot
                                          qual_only as_mod new_imp_details)
 
-    returnM (new_imp_decl, gbl_env, imports, mi_hpc iface)
+    return (new_imp_decl, gbl_env, imports, mi_hpc iface)
     )
 
 warnRedundantSourceImport mod_name
@@ -273,36 +274,70 @@ From the top-level declarations of this module produce
        * the ImportAvails
 created by its bindings.  
        
-Complain about duplicate bindings
+Note [Shadowing in extendRdrEnvRn]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Usually when etending the GlobalRdrEnv we complain if a new binding
+duplicates an existing one.  By adding the bindings one at a time, 
+this check also complains if we add two new bindings for the same name.
+(Remember that in Template Haskell the duplicates might *already be* 
+in the GlobalRdrEnv from higher up the module.)
+
+But with a Template Haskell quotation we want to *shadow*:
+       f x = h [d| f = 3 |]
+Here the inner binding for 'f' simply shadows the outer one.
+And that applies even if the binding for 'f' is in a where-clause,
+and hence is in the *local* RdrEnv not the *global* RdrEnv.
+
+Hence the shadowP boolean passed in. 
 
 \begin{code}
-importsFromLocalDecls :: HsGroup RdrName -> RnM TcGblEnv
-importsFromLocalDecls group
-  = do { gbl_env  <- getGblEnv
-
-       ; avails <- getLocalDeclBinders gbl_env group
-
-       ; rdr_env' <- extendRdrEnvRn (tcg_rdr_env gbl_env) avails
+extendGlobalRdrEnvRn :: Bool   -- Note [Shadowing in extendGlobalRdrEnvRn]
+                            -> [AvailInfo]
+                    -> MiniFixityEnv
+                    -> RnM (TcGblEnv, TcLclEnv)
+  -- Updates both the GlobalRdrEnv and the FixityEnv
+  -- We return a new TcLclEnv only becuase we might have to
+  -- delete some bindings from it; see Note [Shadowing in extendGlobalRdrEnvRn]
+
+extendGlobalRdrEnvRn shadowP avails new_fixities
+  = do { (gbl_env, lcl_env) <- getEnvs
+       ; let rdr_env = tcg_rdr_env gbl_env
+             fix_env = tcg_fix_env gbl_env
+
+               -- Delete new_occs from global and local envs
+               -- We are going to shadow them
+             new_occs = map (nameOccName . gre_name) gres
+             rdr_env1 = hideSomeUnquals rdr_env new_occs
+             lcl_env1 = lcl_env { tcl_rdr = delListFromOccEnv (tcl_rdr lcl_env) new_occs }
+       
+               -- Note [Shadowing in extendGlobalRdrEnvRn]
+             (rdr_env2, lcl_env2) | shadowP   = (rdr_env1, lcl_env1)
+                                  | otherwise = (rdr_env,  lcl_env)
 
-        ; traceRn (text "local avails: " <> ppr avails)
+       ; (rdr_env', fix_env') <- foldlM extend (rdr_env2, fix_env) gres
+       
+       ; let gbl_env' = gbl_env { tcg_rdr_env = rdr_env', tcg_fix_env = fix_env' }
+       ; return (gbl_env', lcl_env2) }
+  where
+    gres = gresFromAvails LocalDef avails
 
-       ; returnM (gbl_env { tcg_rdr_env = rdr_env' })
-       }
+    extend envs@(cur_rdr_env, cur_fix_env) gre
+       = let gres = lookupGlobalRdrEnv cur_rdr_env (nameOccName (gre_name gre)) 
+          in case filter isLocalGRE gres of -- Check for existing *local* defns 
+                  dup_gre:_ -> do { addDupDeclErr (gre_name dup_gre) (gre_name gre)
+                                 ; return envs }
+                  [] -> return (simple_extend envs gre)
 
-extendRdrEnvRn :: GlobalRdrEnv -> [AvailInfo] -> RnM GlobalRdrEnv
--- Add the new locally-bound names one by one, checking for duplicates as
--- we do so.  Remember that in Template Haskell the duplicates
--- might *already be* in the GlobalRdrEnv from higher up the module
-extendRdrEnvRn rdr_env avails
-  = foldlM add_local rdr_env (gresFromAvails LocalDef avails)
-  where
-    add_local rdr_env gre
-       | gres <- lookupGlobalRdrEnv rdr_env (nameOccName (gre_name gre))
-       , (dup_gre:_) <- filter isLocalGRE gres -- Check for existing *local* defns
-       = do { addDupDeclErr (gre_name dup_gre) (gre_name gre)
-            ; return rdr_env }
-       | otherwise
-       = return (extendGlobalRdrEnv rdr_env gre)
+    simple_extend (rdr_env, fix_env) gre 
+      = (extendGlobalRdrEnv rdr_env gre, fix_env')
+      where
+       --  If there is a fixity decl for the gre,
+        --  add it to the fixity env
+       name = gre_name gre
+        occ = nameOccName name
+        fix_env' = case lookupOccEnv new_fixities occ of
+                     Nothing       -> fix_env
+                     Just (L _ fi) -> extendNameEnv fix_env name (FixItem occ fi)
 \end{code}
 
 @getLocalDeclBinders@ returns the names for an @HsDecl@.  It's
@@ -322,46 +357,58 @@ raising a duplicate declaration error.  So, we make a new name for it, but
 don't return it in the 'AvailInfo'.
 
 \begin{code}
-getLocalDeclBinders :: TcGblEnv -> HsGroup RdrName -> RnM [AvailInfo]
-getLocalDeclBinders gbl_env (HsGroup {hs_valds = ValBindsIn val_decls val_sigs,
-                                     hs_tyclds = tycl_decls, 
-                                     hs_instds = inst_decls,
-                                     hs_fords = foreign_decls })
-  = do { tc_names_s <- mappM new_tc tycl_decls
-       ; at_names_s <- mappM inst_ats inst_decls
-       ; val_names  <- mappM new_simple val_bndrs
+getLocalNonValBinders :: HsGroup RdrName -> RnM [AvailInfo]
+-- Get all the top-level binders bound the group *except* 
+-- for value bindings, which are treated separately
+-- Specificaly we return AvailInfo for
+--     type decls
+--     class decls
+--     associated types
+--     foreign imports
+--     (in hs-boot files) value signatures
+
+getLocalNonValBinders group
+  = do         { gbl_env <- getGblEnv
+       ; get_local_binders gbl_env group }
+
+get_local_binders gbl_env (HsGroup {hs_valds  = ValBindsIn _ val_sigs,
+                                   hs_tyclds = tycl_decls, 
+                                   hs_instds = inst_decls,
+                                   hs_fords  = foreign_decls })
+  = do { tc_names_s <- mapM new_tc tycl_decls
+       ; at_names_s <- mapM inst_ats inst_decls
+       ; val_names  <- mapM new_simple val_bndrs
        ; return (val_names ++ tc_names_s ++ concat at_names_s) }
   where
     mod        = tcg_mod gbl_env
     is_hs_boot = isHsBoot (tcg_src gbl_env) ;
-    val_bndrs | is_hs_boot = sig_hs_bndrs
-             | otherwise  = for_hs_bndrs ++ val_hs_bndrs
-       -- In a hs-boot file, the value binders come from the
-       --  *signatures*, and there should be no foreign binders 
+
+    for_hs_bndrs = [nm | L _ (ForeignImport nm _ _) <- foreign_decls]
+
+    -- In a hs-boot file, the value binders come from the
+    --  *signatures*, and there should be no foreign binders 
+    val_bndrs | is_hs_boot = [nm | L _ (TypeSig nm _) <- val_sigs]
+              | otherwise  = for_hs_bndrs
 
     new_simple rdr_name = do
         nm <- newTopSrcBinder mod rdr_name
         return (Avail nm)
 
-    sig_hs_bndrs = [nm | L _ (TypeSig nm _) <- val_sigs]
-    val_hs_bndrs = collectHsBindLocatedBinders val_decls
-    for_hs_bndrs = [nm | L _ (ForeignImport nm _ _) <- foreign_decls]
-
     new_tc tc_decl 
       | isFamInstDecl (unLoc tc_decl)
        = do { main_name <- lookupFamInstDeclBndr mod main_rdr
-            ; sub_names <- mappM (newTopSrcBinder mod) sub_rdrs
+            ; sub_names <- mapM (newTopSrcBinder mod) sub_rdrs
             ; return (AvailTC main_name sub_names) }
                        -- main_name is not bound here!
       | otherwise
        = do { main_name <- newTopSrcBinder mod main_rdr
-            ; sub_names <- mappM (newTopSrcBinder mod) sub_rdrs
+            ; sub_names <- mapM (newTopSrcBinder mod) sub_rdrs
             ; return (AvailTC main_name (main_name : sub_names)) }
       where
        (main_rdr : sub_rdrs) = tyClDeclNames (unLoc tc_decl)
 
     inst_ats inst_decl 
-       = mappM new_tc (instDeclATs (unLoc inst_decl))
+       = mapM new_tc (instDeclATs (unLoc inst_decl))
 
 getLocalDeclBinders _ _ = panic "getLocalDeclBinders"  -- ValBindsOut can't happen
 \end{code}
@@ -777,7 +824,7 @@ exports_from_avail (Just rdr_items) rdr_env imports this_mod
        , mod `elem` earlier_mods       -- Duplicate export of M
        = do { warn_dup_exports <- doptM Opt_WarnDuplicateExports ;
               warnIf warn_dup_exports (dupModuleExport mod) ;
-              returnM acc }
+              return acc }
 
        | otherwise
        = do { implicit_prelude <- doptM Opt_ImplicitPrelude
@@ -904,18 +951,18 @@ check_occs ie occs names
   where
     check occs name
       = case lookupOccEnv occs name_occ of
-         Nothing -> returnM (extendOccEnv occs name_occ (name, ie))
+         Nothing -> return (extendOccEnv occs name_occ (name, ie))
 
          Just (name', ie') 
            | name == name'     -- Duplicate export
            ->  do { warn_dup_exports <- doptM Opt_WarnDuplicateExports ;
                     warnIf warn_dup_exports (dupExportWarn name_occ ie ie') ;
-                    returnM occs }
+                    return occs }
 
            | otherwise         -- Same occ name but different names: an error
            ->  do { global_env <- getGlobalRdrEnv ;
                     addErr (exportClashErr global_env name' name ie' ie) ;
-                    returnM occs }
+                    return occs }
       where
        name_occ = nameOccName name
 \end{code}
@@ -965,7 +1012,7 @@ finishDeprecations dflags mod_deprec tcg_env
          extra | imp_mod == moduleName name_mod = empty
                | otherwise = ptext SLIT(", but defined in") <+> ppr name_mod
 
-    check hpt pit ok_gre = returnM ()  -- Local, or not used, or not deprectated
+    check hpt pit ok_gre = return ()   -- Local, or not used, or not deprectated
            -- The Imported pattern-match: don't deprecate locally defined names
            -- For a start, we may be exporting a deprecated thing
            -- Also we may use a deprecated thing in the defn of another
@@ -978,7 +1025,7 @@ lookupImpDeprec :: DynFlags -> HomePackageTable -> PackageIfaceTable
 -- The name is definitely imported, so look in HPT, PIT
 lookupImpDeprec dflags hpt pit gre
   = case lookupIfaceByModule dflags hpt pit (nameModule name) of
-       Just iface -> mi_dep_fn iface name `seqMaybe`   -- Bleat if the thing, *or
+       Just iface -> mi_dep_fn iface name `mplus`      -- Bleat if the thing, *or
                      case gre_par gre of       
                        ParentIs p -> mi_dep_fn iface p -- its parent*, is deprec'd
                        NoParent   -> Nothing
@@ -1183,7 +1230,7 @@ warnDuplicateImports :: [GlobalRdrElt] -> RnM ()
 
 warnDuplicateImports gres
   = ifOptM Opt_WarnUnusedImports $ 
-    sequenceM_ [ warn name pr
+    sequence_  [ warn name pr
                | GRE { gre_name = name, gre_prov = Imported imps } <- gres
                , pr <- redundants imps ]
   where
@@ -1215,7 +1262,7 @@ warnDuplicateImports gres
        --
        -- NOTE: currently the test does not warn about
        --              import M( x )
-       --              imoprt N( x )
+       --              import N( x )
        -- even if the same underlying 'x' is involved, because dropping
        -- either import would change the qualified names in scope (M.x, N.x)
        -- But if the qualified names aren't used, the import is indeed redundant
@@ -1251,12 +1298,13 @@ printMinimalImports :: FiniteMap ModuleName AvailEnv    -- Minimal imports
 printMinimalImports imps
  = ifOptM Opt_D_dump_minimal_imports $ do {
 
-   mod_ies  <-  initIfaceTcRn $ mappM to_ies (fmToList imps) ;
+   mod_ies  <-  initIfaceTcRn $ mapM to_ies (fmToList imps) ;
    this_mod <- getModule ;
    rdr_env  <- getGlobalRdrEnv ;
-   ioToTcRn (do { h <- openFile (mkFilename this_mod) WriteMode ;
-                 printForUser h (mkPrintUnqualified rdr_env) 
-                                (vcat (map ppr_mod_ie mod_ies)) })
+   dflags   <- getDOpts ;
+   liftIO $ do h <- openFile (mkFilename this_mod) WriteMode
+               printForUser h (mkPrintUnqualified dflags rdr_env)
+                              (vcat (map ppr_mod_ie mod_ies))
    }
   where
     mkFilename this_mod = moduleNameString (moduleName this_mod) ++ ".imports"
@@ -1270,25 +1318,25 @@ printMinimalImports imps
                    parens (fsep (punctuate comma (map ppr ies)))
 
     to_ies (mod, avail_env) = do ies <- mapM to_ie (availEnvElts avail_env)
-                                 returnM (mod, ies)
+                                 return (mod, ies)
 
     to_ie :: AvailInfo -> IfG (IE Name)
        -- The main trick here is that if we're importing all the constructors
        -- we want to say "T(..)", but if we're importing only a subset we want
        -- to say "T(A,B,C)".  So we have to find out what the module exports.
-    to_ie (Avail n)       = returnM (IEVar n)
+    to_ie (Avail n)       = return (IEVar n)
     to_ie (AvailTC n [m]) = ASSERT( n==m ) 
-                           returnM (IEThingAbs n)
-    to_ie (AvailTC n ns)  
-       = loadSysInterface doc n_mod                    `thenM` \ iface ->
+                           return (IEThingAbs n)
+    to_ie (AvailTC n ns)  = do
+          iface <- loadSysInterface doc n_mod
          case [xs | (m,as) <- mi_exports iface,
                     m == n_mod,
                     AvailTC x xs <- as, 
                     x == nameOccName n] of
-             [xs] | all_used xs -> returnM (IEThingAll n)
-                  | otherwise   -> returnM (IEThingWith n (filter (/= n) ns))
+             [xs] | all_used xs -> return (IEThingAll n)
+                  | otherwise   -> return (IEThingWith n (filter (/= n) ns))
              other              -> pprTrace "to_ie" (ppr n <+> ppr n_mod <+> ppr other) $
-                                   returnM (IEVar n)
+                                   return (IEVar n)
        where
          all_used avail_occs = all (`elem` map nameOccName ns) avail_occs
          doc = text "Compute minimal imports from" <+> ppr n
@@ -1326,7 +1374,7 @@ exportItemErr export_item
 
 typeItemErr name wherestr
   = sep [ ptext SLIT("Using 'type' tag on") <+> quotes (ppr name) <+> wherestr,
-         ptext SLIT("Use -ftype-families to enable this extension") ]
+         ptext SLIT("Use -XTypeFamilies to enable this extension") ]
 
 exportClashErr :: GlobalRdrEnv -> Name -> Name -> IE RdrName -> IE RdrName
                -> Message