\section[RnEnv]{Environment manipulation for the renamer monad}
\begin{code}
-#include "HsVersions.h"
-
module RnEnv where -- Export everything
-IMP_Ubiq()
+#include "HsVersions.h"
-import CmdLineOpts ( opt_WarnNameShadowing, opt_IgnoreIfacePragmas )
+import CmdLineOpts ( opt_WarnNameShadowing, opt_WarnUnusedMatches,
+ opt_WarnUnusedBinds, opt_WarnUnusedImports )
import HsSyn
-import RdrHsSyn ( RdrName(..), SYN_IE(RdrNameIE),
- rdrNameOcc, isQual, qual
+import RdrHsSyn ( RdrName(..), RdrNameIE,
+ rdrNameOcc, isQual, qual, isClassDataConRdrName
)
import HsTypes ( getTyVarName, replaceTyVarName )
+import BasicTypes ( Fixity(..), FixityDirection(..), IfaceFlavour(..) )
import RnMonad
-import Name ( Name, OccName(..), Provenance(..), DefnInfo(..), ExportFlag(..),
- occNameString, occNameFlavour,
- SYN_IE(NameSet), emptyNameSet, addListToNameSet,
+import ErrUtils ( ErrMsg )
+import Name ( Name, OccName(..), Provenance(..), ExportFlag(..), NamedThing(..),
+ occNameFlavour, getSrcLoc, occNameString,
+ NameSet, emptyNameSet, addListToNameSet, nameSetToList,
mkLocalName, mkGlobalName, modAndOcc,
- isLocalName, isWiredInName, nameOccName, setNameProvenance,
- pprProvenance, pprOccName, pprModule, pprNonSymOcc, pprNameProvenance
+ nameOccName, setNameProvenance, isVarOcc, getNameProvenance,
+ pprOccName, isLocalName
)
import TyCon ( TyCon )
-import TysWiredIn ( tupleTyCon, listTyCon, charTyCon, intTyCon )
+import TysWiredIn ( tupleTyCon, listTyCon, charTyCon )
import FiniteMap
-import Unique ( Unique, unboundKey )
-import Maybes ( maybeToBool )
+import Unique ( Unique, Uniquable(..), unboundKey )
+import UniqFM ( listToUFM, plusUFM_C )
import UniqSupply
import SrcLoc ( SrcLoc, noSrcLoc )
-import Pretty
-import PprStyle ( PprStyle(..) )
-import Util ( panic, removeDups, pprTrace, assertPanic )
+import Outputable
+import Util ( removeDups )
+import List ( nub )
+import Char ( isAlphanum )
\end{code}
%*********************************************************
\begin{code}
-newGlobalName :: Module -> OccName -> RnM s d Name
-newGlobalName mod occ
+newImportedGlobalName :: Module -> OccName
+ -> IfaceFlavour
+ -> RnM s d Name
+newImportedGlobalName mod occ hif
= -- First check the cache
getNameSupplyRn `thenRn` \ (us, inst_ns, cache) ->
- case lookupFM cache (mod,occ) of
-
- -- A hit in the cache! Return it, but change the src loc
- -- of the thing we've found if this is a second definition site
- -- (that is, if loc /= NoSrcLoc)
- Just name -> returnRn name
-
- -- Miss in the cache, so build a new original name,
- -- and put it in the cache
- Nothing ->
+ let
+ key = (mod,occ)
+ prov = NonLocalDef noSrcLoc hif False
+ in
+ case lookupFM cache key of
+
+ -- A hit in the cache!
+ -- If it has no provenance at the moment then set its provenance
+ -- so that it has the right HiFlag component.
+ -- (This is necessary
+ -- for known-key things. For example, GHCmain.lhs imports as SOURCE
+ -- Main; but Main.main is a known-key thing.)
+ -- Don't fiddle with the provenance if it already has one
+ Just name -> case getNameProvenance name of
+ NoProvenance -> let
+ new_name = setNameProvenance name prov
+ new_cache = addToFM cache key new_name
+ in
+ setNameSupplyRn (us, inst_ns, new_cache) `thenRn_`
+ returnRn new_name
+ other -> returnRn name
+
+ Nothing -> -- Miss in the cache!
+ -- Build a new original name, and put it in the cache
+ let
+ (us', us1) = splitUniqSupply us
+ uniq = getUnique us1
+ name = mkGlobalName uniq mod occ prov
+ new_cache = addToFM cache key name
+ in
+ setNameSupplyRn (us', inst_ns, new_cache) `thenRn_`
+ returnRn name
+
+{-
let
- (us', us1) = splitUniqSupply us
- uniq = getUnique us1
- name = mkGlobalName uniq mod occ VanillaDefn Implicit
- cache' = addToFM cache (mod,occ) name
+ pprC ((mod,occ),name) = pprModule mod <> text "." <> pprOccName occ <+> text "--->"
+ <+> ppr name
in
- setNameSupplyRn (us', inst_ns, cache') `thenRn_`
- returnRn name
+ pprTrace "ng" (vcat [text "newGlobalName miss" <+> pprModule mod <+> pprOccName occ,
+ brackets (sep (map pprC (fmToList cache))),
+ text ""
+ ]) $
+-}
+
newLocallyDefinedGlobalName :: Module -> OccName
-> (Name -> ExportFlag) -> SrcLoc
newLocallyDefinedGlobalName mod occ rec_exp_fn loc
= -- First check the cache
getNameSupplyRn `thenRn` \ (us, inst_ns, cache) ->
-
- -- We are at the binding site for a locally-defined thing, so
- -- you might think it can't be in the cache, but it can if it's a
- -- wired in thing. In that case we need to use the correct unique etc...
- -- so all we do is replace its provenance.
- -- If it's not in the cache we put it there with the correct provenance.
- -- The idea is that, after all this, the cache
- -- will contain a Name with the correct Provenance (i.e. Local)
- let
- provenance = LocalDef (rec_exp_fn new_name) loc
- (us', us1) = splitUniqSupply us
- uniq = getUnique us1
- new_name = case lookupFM cache (mod,occ) of
- Just name -> setNameProvenance name provenance
- Nothing -> mkGlobalName uniq mod occ VanillaDefn provenance
- cache' = addToFM cache (mod,occ) new_name
+ let
+ key = (mod,occ)
in
- setNameSupplyRn (us', inst_ns, cache') `thenRn_`
- returnRn new_name
-
--- newDfunName is used to allocate a name for the dictionary function for
--- a local instance declaration. No need to put it in the cache (I think!).
-newDfunName :: SrcLoc -> RnMS s Name
-newDfunName src_loc
- = getNameSupplyRn `thenRn` \ (us, inst_ns, cache) ->
- getModuleRn `thenRn` \ mod_name ->
+ case lookupFM cache key of
+
+ -- A hit in the cache!
+ -- Overwrite whatever provenance is in the cache already;
+ -- this updates WiredIn things and known-key things,
+ -- which are there from the start, to LocalDef.
+ Just name -> let
+ new_name = setNameProvenance name (LocalDef loc (rec_exp_fn new_name))
+ new_cache = addToFM cache key new_name
+ in
+ setNameSupplyRn (us, inst_ns, new_cache) `thenRn_`
+ returnRn new_name
+
+ -- Miss in the cache!
+ -- Build a new original name, and put it in the cache
+ Nothing -> let
+ provenance = LocalDef loc (rec_exp_fn new_name)
+ (us', us1) = splitUniqSupply us
+ uniq = getUnique us1
+ new_name = mkGlobalName uniq mod occ provenance
+ new_cache = addToFM cache key new_name
+ in
+ setNameSupplyRn (us', inst_ns, new_cache) `thenRn_`
+ returnRn new_name
+
+
+-- newDfunName is a variant, specially for dfuns.
+-- When renaming derived definitions we are in *interface* mode (because we can trip
+-- over original names), but we still want to make the Dfun locally-defined.
+-- So we can't use whether or not we're in source mode to decide the locally-defined question.
+newDfunName :: OccName -> OccName -> Maybe RdrName -> SrcLoc -> RnMS s Name
+newDfunName _ _ (Just n) src_loc -- Imported ones have "Just n"
+ = getModuleRn `thenRn` \ mod_name ->
+ newImportedGlobalName mod_name (rdrNameOcc n) HiFile {- Correct? -}
+newDfunName cl_nm tycon_nm Nothing src_loc -- Local instance decls have a "Nothing"
+ = getModuleRn `thenRn` \ mod_name ->
+ newInstUniq name `thenRn` \ inst_uniq ->
let
- (us', us1) = splitUniqSupply us
- uniq = getUnique us1
- dfun_name = mkGlobalName uniq mod_name (VarOcc (_PK_ ("df" ++ show inst_ns)))
- VanillaDefn (LocalDef Exported src_loc)
- in
- setNameSupplyRn (us', inst_ns+1, cache) `thenRn_`
- returnRn dfun_name
+ dfun_occ = VarOcc (_PK_ ("$d" ++ (_UNPK_ name) ++ show inst_uniq))
+ in
+ newLocallyDefinedGlobalName mod_name dfun_occ
+ (\_ -> Exported) src_loc
+ where
+ {-
+ Dictionary names have the following form
+
+ $d<class><tycon><n>
+
+ where "n" is a positive number, and "tycon" is the
+ name of the type constructor for which a "class"
+ instance is derived.
+
+ Prefixing dictionary names with their class and instance
+ types improves the behaviour of the recompilation checker.
+ (fewer recompilations required should an instance or type
+ declaration be added to a module.)
+ -}
+ -- We're dropping the modids on purpose.
+ tycon_nm_str = occNameString tycon_nm
+ cl_nm_str = occNameString cl_nm
+
+ -- give up on any type constructor that starts with a
+ -- non-alphanumeric char (e.g., [] (,*)
+ name
+ | (_NULL_ tycon_nm_str) || not (isAlphanum (_HEAD_ (tycon_nm_str))) = cl_nm_str
+ | otherwise = cl_nm_str _APPEND_ tycon_nm_str
newLocalNames :: [(RdrName,SrcLoc)] -> RnM s d [Name]
\end{code}
\begin{code}
-bindLocatedLocalsRn :: String -- Documentation string for error message
+bindLocatedLocalsRn :: SDoc -- Documentation string for error message
-> [(RdrName,SrcLoc)]
-> ([Name] -> RnMS s a)
-> RnMS s a
bindLocatedLocalsRn doc_str rdr_names_w_loc enclosed_scope
- = -- Check for use of qualified names
- mapRn (qualNameErr doc_str) quals `thenRn_`
- -- Check for dupicated names in a binding group
- mapRn (dupNamesErr doc_str) dups `thenRn_`
+ = checkDupOrQualNames doc_str rdr_names_w_loc `thenRn_`
- getNameEnv `thenRn` \ name_env ->
+ getLocalNameEnv `thenRn` \ name_env ->
(if opt_WarnNameShadowing
then
mapRn (check_shadow name_env) rdr_names_w_loc
let
new_name_env = addListToFM name_env (map fst rdr_names_w_loc `zip` names)
in
- setNameEnv new_name_env (enclosed_scope names)
+ setLocalNameEnv new_name_env (enclosed_scope names)
where
- quals = filter (isQual.fst) rdr_names_w_loc
- (these, dups) = removeDups (\(n1,l1) (n2,l2) -> n1 `cmp` n2) rdr_names_w_loc
check_shadow name_env (rdr_name,loc)
= case lookupFM name_env rdr_name of
Nothing -> returnRn ()
bindLocalsRn doc_str rdr_names enclosed_scope
= getSrcLocRn `thenRn` \ loc ->
- bindLocatedLocalsRn doc_str (rdr_names `zip` repeat loc) enclosed_scope
+ bindLocatedLocalsRn (text doc_str)
+ (rdr_names `zip` repeat loc)
+ enclosed_scope
bindTyVarsRn doc_str tyvar_names enclosed_scope
= getSrcLocRn `thenRn` \ loc ->
in
bindLocatedLocalsRn doc_str located_tyvars $ \ names ->
enclosed_scope (zipWith replaceTyVarName tyvar_names names)
+
+ -- Works in any variant of the renamer monad
+checkDupOrQualNames, checkDupNames :: SDoc
+ -> [(RdrName, SrcLoc)]
+ -> RnM s d ()
+
+checkDupOrQualNames doc_str rdr_names_w_loc
+ = -- Check for use of qualified names
+ mapRn (qualNameErr doc_str) quals `thenRn_`
+ checkDupNames doc_str rdr_names_w_loc
+ where
+ quals = filter (isQual.fst) rdr_names_w_loc
+
+checkDupNames doc_str rdr_names_w_loc
+ = -- Check for dupicated names in a binding group
+ mapRn (dupNamesErr doc_str) dups `thenRn_`
+ returnRn ()
+ where
+ (_, dups) = removeDups (\(n1,l1) (n2,l2) -> n1 `compare` n2) rdr_names_w_loc
+
+
+-- Yuk!
+ifaceFlavour name = case getNameProvenance name of
+ NonLocalDef _ hif _ -> hif
+ other -> HiFile -- Shouldn't happen
\end{code}
Looking up a name in the RnEnv.
\begin{code}
-lookupRn :: RdrName -> RnMS s Name
-lookupRn rdr_name
- = getNameEnv `thenRn` \ name_env ->
- case lookupFM name_env rdr_name of
-
- -- Found it!
- Just name -> returnRn name
-
- -- Not found
- Nothing -> getModeRn `thenRn` \ mode ->
- case mode of
- -- Not found when processing source code; so fail
- SourceMode -> failWithRn (mkUnboundName rdr_name)
- (unknownNameErr rdr_name)
+checkUnboundRn :: RdrName -> Maybe Name -> RnMS s Name
+checkUnboundRn rdr_name (Just name)
+ = -- Found it!
+ returnRn name
+
+checkUnboundRn rdr_name Nothing
+ = -- Not found by lookup
+ getModeRn `thenRn` \ mode ->
+ case mode of
+ -- Not found when processing source code; so fail
+ SourceMode -> failWithRn (mkUnboundName rdr_name)
+ (unknownNameErr rdr_name)
- -- Not found when processing an imported declaration,
- -- so we create a new name for the purpose
- InterfaceMode ->
- case rdr_name of
+ -- Not found when processing an imported declaration,
+ -- so we create a new name for the purpose
+ InterfaceMode _ _ ->
+ case rdr_name of
+ Qual mod_name occ hif -> newImportedGlobalName mod_name occ hif
- Qual mod_name occ -> newGlobalName mod_name occ
+ -- An Unqual is allowed; interface files contain
+ -- unqualified names for locally-defined things, such as
+ -- constructors of a data type.
+ Unqual occ -> getModuleRn `thenRn ` \ mod_name ->
+ newImportedGlobalName mod_name occ HiFile
- -- An Unqual is allowed; interface files contain
- -- unqualified names for locally-defined things, such as
- -- constructors of a data type.
- Unqual occ -> getModuleRn `thenRn ` \ mod_name ->
- newGlobalName mod_name occ
+lookupBndrRn rdr_name
+ = lookupNameRn rdr_name `thenRn` \ maybe_name ->
+ checkUnboundRn rdr_name maybe_name `thenRn` \ name ->
+
+ if isLocalName name then
+ returnRn name
+ else
+
+ ----------------------------------------------------
+ -- OK, so we're at the binding site of a top-level defn
+ -- Check to see whether its an imported decl
+ getModeRn `thenRn` \ mode ->
+ case mode of {
+ SourceMode -> returnRn name ;
+
+ InterfaceMode _ print_unqual_fn ->
+
+ ----------------------------------------------------
+ -- OK, the binding site of an *imported* defn
+ -- so we can make the provenance more informative
+ getSrcLocRn `thenRn` \ src_loc ->
+ let
+ name' = case getNameProvenance name of
+ NonLocalDef _ hif _ -> setNameProvenance name
+ (NonLocalDef src_loc hif (print_unqual_fn name'))
+ other -> name
+ in
+ returnRn name'
+ }
-- Just like lookupRn except that we record the occurrence too
-- Perhaps surprisingly, even wired-in names are recorded.
-- deciding which instance declarations to import.
lookupOccRn :: RdrName -> RnMS s Name
lookupOccRn rdr_name
- = lookupRn rdr_name `thenRn` \ name ->
- if isLocalName name then
- returnRn name
- else
- addOccurrenceName Compulsory name `thenRn_`
- returnRn name
-
--- lookupOptionalOccRn is similar, but it's used in places where
--- we don't *have* to find a definition for the thing.
-lookupOptionalOccRn :: RdrName -> RnMS s Name
-lookupOptionalOccRn rdr_name
- = lookupRn rdr_name `thenRn` \ name ->
- if opt_IgnoreIfacePragmas || isLocalName name then
- -- Never look for optional things if we're
- -- ignoring optional input interface information
- returnRn name
- else
- addOccurrenceName Optional name `thenRn_`
- returnRn name
+ = lookupNameRn rdr_name `thenRn` \ maybe_name ->
+ checkUnboundRn rdr_name maybe_name `thenRn` \ name ->
+ let
+ name' = mungePrintUnqual rdr_name name
+ in
+ addOccurrenceName name'
+
+-- lookupGlobalOccRn is like lookupOccRn, except that it looks in the global
+-- environment. It's used only for
+-- record field names
+-- class op names in class and instance decls
+lookupGlobalOccRn :: RdrName -> RnMS s Name
+lookupGlobalOccRn rdr_name
+ = lookupGlobalNameRn rdr_name `thenRn` \ maybe_name ->
+ checkUnboundRn rdr_name maybe_name `thenRn` \ name ->
+ let
+ name' = mungePrintUnqual rdr_name name
+ in
+ addOccurrenceName name'
+
+
+-- mungePrintUnqual is used to make *imported* *occurrences* print unqualified
+-- if they were mentioned unqualified in the source code.
+-- This improves error messages from the type checker.
+-- NB: the binding site is treated differently; see lookupBndrRn
+-- After the type checker all occurrences are replaced by the one
+-- at the binding site.
+mungePrintUnqual (Qual _ _ _) name = name
+mungePrintUnqual (Unqual _) name = case new_prov of
+ Nothing -> name
+ Just prov' -> setNameProvenance name prov'
+ where
+ new_prov = case getNameProvenance name of
+ NonLocalDef loc hif False -> Just (NonLocalDef loc hif True)
+ other -> Nothing
-- lookupImplicitOccRn takes an RdrName representing an *original* name, and
-- adds it to the occurrence pool so that it'll be loaded later. This is
-- This doesn't apply in interface mode, where everything is explicit, but
-- we don't check for this case: it does no harm to record an "extra" occurrence
-- and lookupImplicitOccRn isn't used much in interface mode (it's only the
--- Nothing clause of rnDerivs that calls it at all I think.
+-- Nothing clause of rnDerivs that calls it at all I think).
+-- [Jan 98: this comment is wrong: rnHsType uses it quite a bit.]
--
-- For List and Tuple types it's important to get the correct
-- isLocallyDefined flag, which is used in turn when deciding
-- The name cache should have the correct provenance, though.
lookupImplicitOccRn :: RdrName -> RnMS s Name
-lookupImplicitOccRn (Qual mod occ)
- = newGlobalName mod occ `thenRn` \ name ->
- addOccurrenceName Compulsory name `thenRn_`
- returnRn name
+lookupImplicitOccRn (Qual mod occ hif)
+ = newImportedGlobalName mod occ hif `thenRn` \ name ->
+ addOccurrenceName name
-addImplicitOccRn :: Name -> RnM s d ()
-addImplicitOccRn name = addOccurrenceName Compulsory name
+addImplicitOccRn :: Name -> RnMS s Name
+addImplicitOccRn name = addOccurrenceName name
-addImplicitOccsRn :: [Name] -> RnM s d ()
-addImplicitOccsRn names = addOccurrenceNames Compulsory names
+addImplicitOccsRn :: [Name] -> RnMS s ()
+addImplicitOccsRn names = addOccurrenceNames names
-intType_RDR = qual (modAndOcc (getName intTyCon))
listType_RDR = qual (modAndOcc listType_name)
tupleType_RDR n = qual (modAndOcc (tupleType_name n))
returnRn (lookupFixityEnv fixity_env rdr_name)
\end{code}
+mkImportFn returns a function that takes a Name and tells whether
+its unqualified name is in scope. This is put as a boolean flag in
+the Name's provenance to guide whether or not to print the name qualified
+in error messages.
+\begin{code}
+mkImportFn :: RnEnv -> Name -> Bool
+mkImportFn (RnEnv env _)
+ = lookup
+ where
+ lookup name = case lookupFM env (Unqual (nameOccName name)) of
+ Just (name', _) -> name == name'
+ Nothing -> False
+\end{code}
%************************************************************************
%* *
=============== RnEnv ================
\begin{code}
plusRnEnv (RnEnv n1 f1) (RnEnv n2 f2)
- = plusNameEnvRn n1 n2 `thenRn` \ n ->
- plusFixityEnvRn f1 f2 `thenRn` \ f ->
+ = plusGlobalNameEnvRn n1 n2 `thenRn` \ n ->
+ plusFixityEnvRn f1 f2 `thenRn` \ f ->
returnRn (RnEnv n f)
\end{code}
+
=============== NameEnv ================
\begin{code}
-plusNameEnvRn :: NameEnv -> NameEnv -> RnM s d NameEnv
-plusNameEnvRn n1 n2
- = mapRn (addErrRn.nameClashErr) (conflictsFM (/=) n1 n2) `thenRn_`
- returnRn (n1 `plusFM` n2)
-
-addOneToNameEnvRn :: NameEnv -> RdrName -> Name -> RnM s d NameEnv
-addOneToNameEnvRn env rdr_name name
- = mapRn (addErrRn.nameClashErr) (conflictFM (/=) env rdr_name name) `thenRn_`
- returnRn (addToFM env rdr_name name)
+plusGlobalNameEnvRn :: GlobalNameEnv -> GlobalNameEnv -> RnM s d GlobalNameEnv
+plusGlobalNameEnvRn env1 env2
+ = mapRn addNameClashErrRn (conflictsFM conflicting_name env1 env2) `thenRn_`
+ returnRn (env1 `plusFM` env2)
+
+addOneToGlobalNameEnv :: GlobalNameEnv -> RdrName -> (Name, HowInScope) -> RnM s d GlobalNameEnv
+addOneToGlobalNameEnv env rdr_name name
+ = case lookupFM env rdr_name of
+ Just name2 | conflicting_name name name2
+ -> addNameClashErrRn (rdr_name, (name, name2)) `thenRn_`
+ returnRn env
+
+ other -> returnRn (addToFM env rdr_name name)
+
+delOneFromGlobalNameEnv :: GlobalNameEnv -> RdrName -> GlobalNameEnv
+delOneFromGlobalNameEnv env rdr_name = delFromFM env rdr_name
+
+conflicting_name :: (Name, HowInScope) -> (Name, HowInScope) -> Bool
+conflicting_name (n1, FromLocalDefn _) (n2, FromLocalDefn _) = True
+conflicting_name (n1,h1) (n2,h2) = n1 /= n2
+ -- We complain of a conflict if one RdrName maps to two different Names,
+ -- OR if one RdrName maps to the same *locally-defined* Name. The latter
+ -- case is to catch two separate, local definitions of the same thing.
+ --
+ -- If a module imports itself then there might be a local defn and an imported
+ -- defn of the same name; in this case the names will compare as equal, but
+ -- will still have different HowInScope fields
lookupNameEnv :: NameEnv -> RdrName -> Maybe Name
lookupNameEnv = lookupFM
= mapRn (addErrRn.fixityClashErr) (conflictsFM bad_fix f1 f2) `thenRn_`
returnRn (f1 `plusFM` f2)
-addOneToFixityEnvRn env rdr_name fixity
- = mapRn (addErrRn.fixityClashErr) (conflictFM bad_fix env rdr_name fixity) `thenRn_`
- returnRn (addToFM env rdr_name fixity)
+addOneToFixityEnv env rdr_name fixity = addToFM env rdr_name fixity
lookupFixityEnv env rdr_name
= case lookupFM env rdr_name of
Just (fixity,_) -> fixity
Nothing -> Fixity 9 InfixL -- Default case
-bad_fix :: (Fixity, Provenance) -> (Fixity, Provenance) -> Bool
+bad_fix :: (Fixity, HowInScope) -> (Fixity, HowInScope) -> Bool
bad_fix (f1,_) (f2,_) = f1 /= f2
-pprFixityProvenance :: PprStyle -> (Fixity,Provenance) -> Pretty
-pprFixityProvenance sty (fixity, prov) = pprProvenance sty prov
+pprFixityProvenance :: (Fixity, HowInScope) -> SDoc
+pprFixityProvenance (fixity, how_in_scope) = ppr how_in_scope
\end{code}
-=============== Avails ================
+=============== ExportAvails ================
\begin{code}
-emptyModuleAvails :: ModuleAvails
-plusModuleAvails :: ModuleAvails -> ModuleAvails -> ModuleAvails
-lookupModuleAvails :: ModuleAvails -> Module -> Maybe [AvailInfo]
+mkExportAvails :: Module -> Bool -> GlobalNameEnv -> [AvailInfo] -> ExportAvails
+mkExportAvails mod_name unqual_imp name_env avails
+ = (mod_avail_env, entity_avail_env)
+ where
+ mod_avail_env = unitFM mod_name unqual_avails
+
+ -- unqual_avails is the Avails that are visible in *unqualfied* form
+ -- (1.4 Report, Section 5.1.1)
+ -- For example, in
+ -- import T hiding( f )
+ -- we delete f from avails
+
+ unqual_avails | not unqual_imp = [] -- Short cut when no unqualified imports
+ | otherwise = [prune avail | avail <- avails]
+
+ prune (Avail n) | unqual_in_scope n = Avail n
+ prune (Avail n) | otherwise = NotAvailable
+ prune (AvailTC n ns) = AvailTC n (filter unqual_in_scope ns)
-emptyModuleAvails = emptyFM
-plusModuleAvails = plusFM_C (++)
-lookupModuleAvails = lookupFM
+ unqual_in_scope n = Unqual (nameOccName n) `elemFM` name_env
+
+ entity_avail_env = listToUFM [ (name,avail) | avail <- avails,
+ name <- availEntityNames avail]
+
+plusExportAvails :: ExportAvails -> ExportAvails -> ExportAvails
+plusExportAvails (m1, e1) (m2, e2)
+ = (plusFM_C (++) m1 m2, plusUFM_C plusAvail e1 e2)
\end{code}
=============== AvailInfo ================
\begin{code}
-plusAvail (Avail n1 ns1) (Avail n2 ns2) = Avail n1 (nub (ns1 ++ ns2))
+plusAvail (Avail n1) (Avail n2) = Avail n1
+plusAvail (AvailTC n1 ns1) (AvailTC n2 ns2) = AvailTC n1 (nub (ns1 ++ ns2))
plusAvail a NotAvailable = a
plusAvail NotAvailable a = a
+-- Added SOF 4/97
+#ifdef DEBUG
+plusAvail a1 a2 = pprPanic "RnEnv.plusAvail" (hsep [pprAvail a1,pprAvail a2])
+#endif
addAvailToNameSet :: NameSet -> AvailInfo -> NameSet
-addAvailToNameSet names NotAvailable = names
-addAvailToNameSet names (Avail n ns) = addListToNameSet names (n:ns)
+addAvailToNameSet names avail = addListToNameSet names (availNames avail)
availsToNameSet :: [AvailInfo] -> NameSet
availsToNameSet avails = foldl addAvailToNameSet emptyNameSet avails
+availName :: AvailInfo -> Name
+availName (Avail n) = n
+availName (AvailTC n _) = n
+
availNames :: AvailInfo -> [Name]
-availNames NotAvailable = []
-availNames (Avail n ns) = n:ns
-
-filterAvail :: RdrNameIE -> AvailInfo -> AvailInfo
-filterAvail (IEThingWith _ wanted) NotAvailable = NotAvailable
-filterAvail (IEThingWith _ wanted) (Avail n ns)
- | sub_names_ok = Avail n (filter is_wanted ns)
- | otherwise = NotAvailable
+availNames NotAvailable = []
+availNames (Avail n) = [n]
+availNames (AvailTC n ns) = ns
+
+-- availEntityNames is used to extract the names that can appear on their own in
+-- an export or import list. For class decls, class methods can appear on their
+-- own, thus import A( op )
+-- but constructors cannot; thus
+-- import B( T )
+-- means import type T from B, not constructor T.
+
+availEntityNames :: AvailInfo -> [Name]
+availEntityNames NotAvailable = []
+availEntityNames (Avail n) = [n]
+availEntityNames (AvailTC n ns) = n : filter (isVarOcc . nameOccName) ns
+
+filterAvail :: RdrNameIE -- Wanted
+ -> AvailInfo -- Available
+ -> AvailInfo -- Resulting available;
+ -- NotAvailable if wanted stuff isn't there
+
+filterAvail ie@(IEThingWith want wants) avail@(AvailTC n ns)
+ | sub_names_ok = AvailTC n (filter is_wanted ns)
+ | otherwise =
+#ifdef DEBUG
+ pprTrace "filterAvail" (hsep [ppr ie, pprAvail avail]) $
+#endif
+ NotAvailable
where
is_wanted name = nameOccName name `elem` wanted_occs
sub_names_ok = all (`elem` avail_occs) wanted_occs
- wanted_occs = map rdrNameOcc wanted
avail_occs = map nameOccName ns
+ wanted_occs = map rdrNameOcc (want:wants)
+filterAvail (IEThingAbs _) (AvailTC n ns) = ASSERT( n `elem` ns )
+ AvailTC n [n]
-filterAvail (IEThingAll _) avail = avail
-filterAvail ie (Avail n ns) = Avail n [] -- IEThingAbs and IEVar
+filterAvail (IEThingAbs _) avail@(Avail n) = avail -- Type synonyms
--- pprAvail gets given the OccName of the "host" thing
-pprAvail sty NotAvailable = ppStr "NotAvailable"
-pprAvail sty (Avail n ns) = ppCat [pprOccName sty (nameOccName n),
- ppStr "(",
- ppInterleave ppComma (map (pprOccName sty.nameOccName) ns),
- ppStr ")"]
+filterAvail (IEVar _) avail@(Avail n) = avail
+filterAvail (IEVar v) avail@(AvailTC n ns) = AvailTC n (filter wanted ns)
+ where
+ wanted n = nameOccName n == occ
+ occ = rdrNameOcc v
+ -- The second equation happens if we import a class op, thus
+ -- import A( op )
+ -- where op is a class operation
+
+filterAvail (IEThingAll _) avail@(AvailTC _ _) = avail
+
+filterAvail ie avail = NotAvailable
+
+
+-- In interfaces, pprAvail gets given the OccName of the "host" thing
+pprAvail avail = getPprStyle $ \ sty ->
+ if ifaceStyle sty then
+ ppr_avail (pprOccName . nameOccName) avail
+ else
+ ppr_avail ppr avail
+
+ppr_avail pp_name NotAvailable = ptext SLIT("NotAvailable")
+ppr_avail pp_name (AvailTC n ns) = hsep [
+ pp_name n,
+ parens $ hsep $ punctuate comma $
+ map pp_name ns
+ ]
+ppr_avail pp_name (Avail n) = pp_name n
\end{code}
conflictFM :: Ord a
=> (b->b->Bool)
-> FiniteMap a b -> a -> b
- -> [(a,(b,b))]
+ -> Maybe (a,(b,b))
conflictFM bad fm key elt
= case lookupFM fm key of
- Just elt' | bad elt elt' -> [(key,(elt,elt'))]
- other -> []
+ Just elt' | bad elt elt' -> Just (key,(elt,elt'))
+ other -> Nothing
\end{code}
\begin{code}
-nameClashErr (rdr_name, (name1,name2)) sty
- = ppHang (ppCat [ppStr "Conflicting definitions for: ", ppr sty rdr_name])
- 4 (ppAboves [pprNameProvenance sty name1,
- pprNameProvenance sty name2])
+warnUnusedBinds, warnUnusedMatches, warnUnusedImports :: NameSet -> RnM s d ()
+
+warnUnusedBinds names
+ | opt_WarnUnusedBinds = warnUnusedNames names
+ | otherwise = returnRn ()
-fixityClashErr (rdr_name, (fp1,fp2)) sty
- = ppHang (ppCat [ppStr "Conflicting fixities for: ", ppr sty rdr_name])
- 4 (ppAboves [pprFixityProvenance sty fp1,
- pprFixityProvenance sty fp2])
+warnUnusedMatches names
+ | opt_WarnUnusedMatches = warnUnusedNames names
+ | otherwise = returnRn ()
-shadowedNameWarn shadow sty
- = ppBesides [ppStr "More than one value with the same name (shadowing): ", ppr sty shadow]
+warnUnusedImports names
+ | opt_WarnUnusedImports = warnUnusedNames names
+ | otherwise = returnRn ()
-unknownNameErr name sty
- = ppSep [ppStr flavour, ppStr "not in scope:", ppr sty name]
+warnUnusedNames :: NameSet -> RnM s d ()
+warnUnusedNames names
+ = mapRn warn (nameSetToList names) `thenRn_`
+ returnRn ()
+ where
+ warn name = pushSrcLocRn (getSrcLoc name) $
+ addWarnRn (unusedNameWarn name)
+
+unusedNameWarn name = quotes (ppr name) <+> ptext SLIT("is bound but not used")
+
+addNameClashErrRn (rdr_name, ((_,how_in_scope1), (_, how_in_scope2)))
+ | isClassDataConRdrName rdr_name
+ -- Nasty hack to prevent error messages complain about conflicts for ":C",
+ -- where "C" is a class. There'll be a message about C, and :C isn't
+ -- the programmer's business. There may be a better way to filter this
+ -- out, but I couldn't get up the energy to find it.
+ = returnRn ()
+
+ | otherwise
+ = addErrRn (hang (hsep [ptext SLIT("Conflicting definitions for"), quotes (ppr rdr_name)])
+ 4 (vcat [ppr how_in_scope1,
+ ppr how_in_scope2]))
+
+fixityClashErr (rdr_name, ((_,how_in_scope1), (_, how_in_scope2)))
+ = hang (hsep [ptext SLIT("Conflicting fixities for"), quotes (ppr rdr_name)])
+ 4 (vcat [ppr how_in_scope1,
+ ppr how_in_scope2])
+
+shadowedNameWarn shadow
+ = hsep [ptext SLIT("This binding for"),
+ quotes (ppr shadow),
+ ptext SLIT("shadows an existing binding")]
+
+unknownNameErr name
+ = sep [text flavour, ptext SLIT("not in scope:"), quotes (ppr name)]
where
flavour = occNameFlavour (rdrNameOcc name)
qualNameErr descriptor (name,loc)
= pushSrcLocRn loc $
- addErrRn (\sty -> ppBesides [ppStr "invalid use of qualified ",
- ppStr descriptor, ppStr ": ",
- pprNonSymOcc sty (rdrNameOcc name) ])
+ addErrRn (hsep [ ptext SLIT("Invalid use of qualified name"),
+ quotes (ppr name),
+ ptext SLIT("in"),
+ descriptor])
dupNamesErr descriptor ((name,loc) : dup_things)
= pushSrcLocRn loc $
- addErrRn (\sty -> ppBesides [ppStr "duplicate bindings of `",
- ppr sty name, ppStr "' in ",
- ppStr descriptor])
+ addErrRn (hsep [ptext SLIT("Conflicting definitions for"),
+ quotes (ppr name),
+ ptext SLIT("in"), descriptor])
\end{code}