2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[RnNames]{Extracting imported and top-level names in scope}
8 rnImports, importsFromLocalDecls, exportsFromAvail,
12 #include "HsVersions.h"
14 import {-# SOURCE #-} RnHiFiles ( loadInterface )
16 import CmdLineOpts ( DynFlag(..) )
18 import HsSyn ( IE(..), ieName, ImportDecl(..),
19 ForeignDecl(..), HsGroup(..),
20 collectLocatedHsBinders, tyClDeclNames
22 import RdrHsSyn ( RdrNameIE, RdrNameImportDecl )
27 import PrelNames ( pRELUDE_Name, mAIN_Name, isBuiltInSyntaxName )
28 import Module ( Module, ModuleName, moduleName,
30 unitModuleEnvByName, lookupModuleEnvByName,
32 import Name ( Name, nameSrcLoc, nameOccName, nameModule, isExternalName )
35 import OccName ( OccName, dataName, isTcOcc )
36 import HscTypes ( Provenance(..), ImportReason(..), GlobalRdrEnv,
37 GenAvailInfo(..), AvailInfo, Avails, IsBootInterface,
38 availName, availNames, availsToNameSet,
39 Deprecations(..), ModIface(..),
40 GlobalRdrElt(..), unQualInScope, isLocalGRE
42 import RdrName ( RdrName, rdrNameOcc, setRdrNameSpace,
43 emptyRdrEnv, foldRdrEnv, isQual )
45 import Maybes ( maybeToBool, catMaybes )
46 import ListSetOps ( removeDups )
47 import Util ( sortLt, notNull )
48 import List ( partition )
49 import IO ( openFile, IOMode(..) )
54 %************************************************************************
58 %************************************************************************
61 rnImports :: [RdrNameImportDecl]
62 -> TcRn m (GlobalRdrEnv, ImportAvails)
65 = -- PROCESS IMPORT DECLS
66 -- Do the non {- SOURCE -} ones first, so that we get a helpful
67 -- warning for {- SOURCE -} ones that are unnecessary
68 getModule `thenM` \ this_mod ->
69 getSrcLocM `thenM` \ loc ->
70 doptM Opt_NoImplicitPrelude `thenM` \ opt_no_prelude ->
72 all_imports = mk_prel_imports this_mod loc opt_no_prelude ++ imports
73 (source, ordinary) = partition is_source_import all_imports
74 is_source_import (ImportDecl _ is_boot _ _ _ _) = is_boot
76 get_imports = importsFromImportDecl (moduleName this_mod)
78 mappM get_imports ordinary `thenM` \ stuff1 ->
79 mappM get_imports source `thenM` \ stuff2 ->
83 (imp_gbl_envs, imp_avails) = unzip (stuff1 ++ stuff2)
84 gbl_env :: GlobalRdrEnv
85 gbl_env = foldr plusGlobalRdrEnv emptyRdrEnv imp_gbl_envs
87 all_avails :: ImportAvails
88 all_avails = foldr plusImportAvails emptyImportAvails imp_avails
91 returnM (gbl_env, all_avails)
93 -- NB: opt_NoImplicitPrelude is slightly different to import Prelude ();
94 -- because the former doesn't even look at Prelude.hi for instance
95 -- declarations, whereas the latter does.
96 mk_prel_imports this_mod loc no_prelude
97 | moduleName this_mod == pRELUDE_Name
98 || explicit_prelude_import
102 | otherwise = [preludeImportDecl loc]
104 explicit_prelude_import
105 = notNull [ () | (ImportDecl mod _ _ _ _ _) <- imports,
106 mod == pRELUDE_Name ]
108 preludeImportDecl loc
109 = ImportDecl pRELUDE_Name
110 False {- Not a boot interface -}
111 False {- Not qualified -}
112 Nothing {- No "as" -}
113 Nothing {- No import list -}
118 importsFromImportDecl :: ModuleName
120 -> TcRn m (GlobalRdrEnv, ImportAvails)
122 importsFromImportDecl this_mod_name
123 (ImportDecl imp_mod_name is_boot qual_only as_mod import_spec iloc)
126 doc = ppr imp_mod_name <+> ptext SLIT("is directly imported")
129 -- If there's an error in loadInterface, (e.g. interface
130 -- file not found) we get lots of spurious errors from 'filterImports'
131 tryM (loadInterface doc imp_mod_name (ImportByUser is_boot)) `thenM` \ mb_iface ->
134 Left exn -> returnM (emptyRdrEnv, emptyImportAvails ) ;
138 imp_mod = mi_module iface
139 avails_by_module = mi_exports iface
140 deprecs = mi_deprecs iface
141 dir_imp = unitModuleEnvByName imp_mod_name (imp_mod, import_all import_spec)
144 avails = [ avail | (mod_name, avails) <- avails_by_module,
145 mod_name /= this_mod_name,
147 -- If the module exports anything defined in this module, just ignore it.
148 -- Reason: otherwise it looks as if there are two local definition sites
149 -- for the thing, and an error gets reported. Easiest thing is just to
150 -- filter them out up front. This situation only arises if a module
151 -- imports itself, or another module that imported it. (Necessarily,
152 -- this invoves a loop.)
154 -- Tiresome consequence: if you say
159 -- module B( AType ) where
160 -- import {-# SOURCE #-} A( AType )
162 -- then you'll get a 'B does not export AType' message. Oh well.
165 -- Complain if we import a deprecated module
166 ifOptM Opt_WarnDeprecations (
168 DeprecAll txt -> addWarn (moduleDeprec imp_mod_name txt)
172 -- Filter the imports according to the import list
173 filterImports imp_mod_name is_boot import_spec avails `thenM` \ (filtered_avails, explicits) ->
176 unqual_imp = not qual_only -- Maybe want unqualified names
177 qual_mod = case as_mod of
178 Nothing -> imp_mod_name
179 Just another_name -> another_name
181 mk_prov name = NonLocalDef (UserImport imp_mod iloc (name `elemNameSet` explicits))
182 gbl_env = mkGlobalRdrEnv qual_mod unqual_imp mk_prov filtered_avails deprecs
183 imports = mkImportAvails qual_mod unqual_imp filtered_avails
185 returnM (gbl_env, imports { imp_mods = dir_imp})
188 import_all (Just (False, _)) = False -- Imports are spec'd explicitly
189 import_all other = True -- Everything is imported
193 %************************************************************************
195 importsFromLocalDecls
197 %************************************************************************
199 From the top-level declarations of this module produce
200 * the lexical environment
202 created by its bindings.
204 Complain about duplicate bindings
207 importsFromLocalDecls :: HsGroup RdrName
208 -> TcRn m (GlobalRdrEnv, ImportAvails)
209 importsFromLocalDecls group
210 = getModule `thenM` \ this_mod ->
211 getLocalDeclBinders this_mod group `thenM` \ avails ->
212 -- The avails that are returned don't include the "system" names
214 all_names :: [Name] -- All the defns; no dups eliminated
215 all_names = [name | avail <- avails, name <- availNames avail]
218 (_, dups) = removeDups compare all_names
220 -- Check for duplicate definitions
221 -- The complaint will come out as "Multiple declarations of Foo.f" because
222 -- since 'f' is in the env twice, the unQualInScope used by the error-msg
223 -- printer returns False. It seems awkward to fix, unfortunately.
224 mappM_ (addErr . dupDeclErr) dups `thenM_`
226 doptM Opt_NoImplicitPrelude `thenM` \ implicit_prelude ->
228 mod_name = moduleName this_mod
229 unqual_imp = True -- Want unqualified names
230 mk_prov n = LocalDef -- Provenance is local
232 gbl_env = mkGlobalRdrEnv mod_name unqual_imp mk_prov avails NoDeprecs
233 -- NoDeprecs: don't complain about locally defined names
234 -- For a start, we may be exporting a deprecated thing
235 -- Also we may use a deprecated thing in the defn of another
236 -- deprecated things. We may even use a deprecated thing in
237 -- the defn of a non-deprecated thing, when changing a module's
241 -- Optimisation: filter out names for built-in syntax
242 -- They just clutter up the environment (esp tuples), and the parser
243 -- will generate Exact RdrNames for them, so the cluttered
244 -- envt is no use. To avoid doing this filter all the time,
245 -- we use -fno-implicit-prelude as a clue that the filter is
246 -- worth while. Really, it's only useful for GHC.Base and GHC.Tuple.
248 -- It's worth doing because it makes the environment smaller for
249 -- every module that imports the Prelude
251 -- Note: don't filter the gbl_env (hence avails, not avails' in
252 -- defn of gbl_env above). Stupid reason: when parsing
253 -- data type decls, the constructors start as Exact tycon-names,
254 -- and then get turned into data con names by zapping the name space;
255 -- but that stops them being Exact, so they get looked up. Sigh.
256 -- It doesn't matter because it only affects the Data.Tuple really.
257 -- The important thing is to trim down the exports.
258 imports = mkImportAvails mod_name unqual_imp avails'
259 avails' | implicit_prelude = filter not_built_in_syntax avails
261 not_built_in_syntax a = not (all isBuiltInSyntaxName (availNames a))
262 -- Only filter it if all the names of the avail are built-in
263 -- In particular, lists have (:) which is not built in syntax
264 -- so we don't filter it out.
266 returnM (gbl_env, imports)
270 %*********************************************************
272 \subsection{Getting binders out of a declaration}
274 %*********************************************************
276 @getLocalDeclBinders@ returns the names for a @RdrNameHsDecl@. It's
277 used for both source code (from @importsFromLocalDecls@) and interface
278 files (@loadDecl@ calls @getTyClDeclBinders@).
280 *** See "THE NAMING STORY" in HsDecls ****
283 getLocalDeclBinders :: Module -> HsGroup RdrName -> TcRn m [AvailInfo]
284 getLocalDeclBinders mod (HsGroup {hs_valds = val_decls,
285 hs_tyclds = tycl_decls,
286 hs_fords = foreign_decls })
287 = -- For type and class decls, we generate Global names, with
288 -- no export indicator. They need to be global because they get
289 -- permanently bound into the TyCons and Classes. They don't need
290 -- an export indicator because they are all implicitly exported.
292 mappM new_tc tycl_decls `thenM` \ tc_avails ->
293 mappM new_bndr (for_hs_bndrs ++ val_hs_bndrs) `thenM` \ simple_bndrs ->
295 returnM (tc_avails ++ map Avail simple_bndrs)
297 new_bndr (rdr_name,loc) = newTopBinder mod rdr_name loc
299 val_hs_bndrs = collectLocatedHsBinders val_decls
300 for_hs_bndrs = [(nm,loc) | ForeignImport nm _ _ _ loc <- foreign_decls]
302 new_tc tc_decl = mappM new_bndr (tyClDeclNames tc_decl) `thenM` \ names@(main_name:_) ->
303 returnM (AvailTC main_name names)
307 %************************************************************************
309 \subsection{Filtering imports}
311 %************************************************************************
313 @filterImports@ takes the @ExportEnv@ telling what the imported module makes
314 available, and filters it through the import spec (if any).
317 filterImports :: ModuleName -- The module being imported
318 -> IsBootInterface -- Tells whether it's a {-# SOURCE #-} import
319 -> Maybe (Bool, [RdrNameIE]) -- Import spec; True => hiding
320 -> [AvailInfo] -- What's available
321 -> TcRn m ([AvailInfo], -- What's imported
322 NameSet) -- What was imported explicitly
324 -- Complains if import spec mentions things that the module doesn't export
325 -- Warns/informs if import spec contains duplicates.
326 filterImports mod from Nothing imports
327 = returnM (imports, emptyNameSet)
329 filterImports mod from (Just (want_hiding, import_items)) total_avails
330 = mappM get_item import_items `thenM` \ avails_w_explicits_s ->
332 (item_avails, explicits_s) = unzip (concat avails_w_explicits_s)
333 explicits = foldl addListToNameSet emptyNameSet explicits_s
336 let -- All imported; item_avails to be hidden
337 hidden = availsToNameSet item_avails
338 keep n = not (n `elemNameSet` hidden)
340 returnM (pruneAvails keep total_avails, emptyNameSet)
342 -- Just item_avails imported; nothing to be hidden
343 returnM (item_avails, explicits)
345 import_fm :: FiniteMap OccName AvailInfo
346 import_fm = listToFM [ (nameOccName name, avail)
347 | avail <- total_avails,
348 name <- availNames avail]
349 -- Even though availNames returns data constructors too,
350 -- they won't make any difference because naked entities like T
351 -- in an import list map to TcOccs, not VarOccs.
353 bale_out item = addErr (badImportItemErr mod from item) `thenM_`
356 get_item :: RdrNameIE -> TcRn m [(AvailInfo, [Name])]
357 -- Empty list for a bad item.
358 -- Singleton is typical case.
359 -- Can have two when we are hiding, and mention C which might be
360 -- both a class and a data constructor.
361 -- The [Name] is the list of explicitly-mentioned names
362 get_item item@(IEModuleContents _) = bale_out item
364 get_item item@(IEThingAll _)
365 = case check_item item of
366 Nothing -> bale_out item
367 Just avail@(AvailTC _ [n]) -> -- This occurs when you import T(..), but
368 -- only export T abstractly. The single [n]
369 -- in the AvailTC is the type or class itself
370 ifOptM Opt_WarnMisc (addWarn (dodgyImportWarn mod item)) `thenM_`
371 returnM [(avail, [availName avail])]
372 Just avail -> returnM [(avail, [availName avail])]
374 get_item item@(IEThingAbs n)
375 | want_hiding -- hiding( C )
376 -- Here the 'C' can be a data constructor *or* a type/class
377 = case catMaybes [check_item item, check_item (IEVar data_n)] of
379 avails -> returnM [(a, []) | a <- avails]
380 -- The 'explicits' list is irrelevant when hiding
382 data_n = setRdrNameSpace n dataName
385 = case check_item item of
386 Nothing -> bale_out item
387 Just avail -> returnM [(avail, availNames avail)]
390 | not (maybeToBool maybe_in_import_avails) ||
391 not (maybeToBool maybe_filtered_avail)
395 = Just filtered_avail
398 wanted_occ = rdrNameOcc (ieName item)
399 maybe_in_import_avails = lookupFM import_fm wanted_occ
401 Just avail = maybe_in_import_avails
402 maybe_filtered_avail = filterAvail item avail
403 Just filtered_avail = maybe_filtered_avail
407 filterAvail :: RdrNameIE -- Wanted
408 -> AvailInfo -- Available
409 -> Maybe AvailInfo -- Resulting available;
410 -- Nothing if (any of the) wanted stuff isn't there
412 filterAvail ie@(IEThingWith want wants) avail@(AvailTC n ns)
413 | sub_names_ok = Just (AvailTC n (filter is_wanted ns))
414 | otherwise = Nothing
416 is_wanted name = nameOccName name `elem` wanted_occs
417 sub_names_ok = all (`elem` avail_occs) wanted_occs
418 avail_occs = map nameOccName ns
419 wanted_occs = map rdrNameOcc (want:wants)
421 filterAvail (IEThingAbs _) (AvailTC n ns) = ASSERT( n `elem` ns )
424 filterAvail (IEThingAbs _) avail@(Avail n) = Just avail -- Type synonyms
426 filterAvail (IEVar _) avail@(Avail n) = Just avail
427 filterAvail (IEVar v) avail@(AvailTC n ns) = Just (AvailTC n (filter wanted ns))
429 wanted n = nameOccName n == occ
431 -- The second equation happens if we import a class op, thus
433 -- where op is a class operation
435 filterAvail (IEThingAll _) avail@(AvailTC _ _) = Just avail
436 -- We don't complain even if the IE says T(..), but
437 -- no constrs/class ops of T are available
438 -- Instead that's caught with a warning by the caller
440 filterAvail ie avail = Nothing
444 %************************************************************************
446 \subsection{Export list processing}
448 %************************************************************************
450 Processing the export list.
452 You might think that we should record things that appear in the export
453 list as ``occurrences'' (using @addOccurrenceName@), but you'd be
454 wrong. We do check (here) that they are in scope, but there is no
455 need to slurp in their actual declaration (which is what
456 @addOccurrenceName@ forces).
458 Indeed, doing so would big trouble when compiling @PrelBase@, because
459 it re-exports @GHC@, which includes @takeMVar#@, whose type includes
460 @ConcBase.StateAndSynchVar#@, and so on...
463 type ExportAccum -- The type of the accumulating parameter of
464 -- the main worker function in exportsFromAvail
465 = ([ModuleName], -- 'module M's seen so far
466 ExportOccMap, -- Tracks exported occurrence names
467 AvailEnv) -- The accumulated exported stuff, kept in an env
468 -- so we can common-up related AvailInfos
469 emptyExportAccum = ([], emptyFM, emptyAvailEnv)
471 type ExportOccMap = FiniteMap OccName (Name, RdrNameIE)
472 -- Tracks what a particular exported OccName
473 -- in an export list refers to, and which item
474 -- it came from. It's illegal to export two distinct things
475 -- that have the same occurrence name
478 exportsFromAvail :: Maybe [RdrNameIE] -> TcRn m Avails
479 -- Complains if two distinct exports have same OccName
480 -- Warns about identical exports.
481 -- Complains about exports items not in scope
482 exportsFromAvail Nothing
483 = do { this_mod <- getModule ;
484 if moduleName this_mod == mAIN_Name then
486 -- Export nothing; Main.$main is automatically exported
488 exportsFromAvail (Just [IEModuleContents (moduleName this_mod)])
489 -- but for all other modules export everything.
492 exportsFromAvail (Just exports)
493 = do { TcGblEnv { tcg_imports = imports } <- getGblEnv ;
494 warn_dup_exports <- doptM Opt_WarnDuplicateExports ;
495 exports_from_avail exports warn_dup_exports imports }
497 exports_from_avail export_items warn_dup_exports
498 (ImportAvails { imp_unqual = mod_avail_env,
499 imp_env = entity_avail_env })
500 = foldlM exports_from_item emptyExportAccum
501 export_items `thenM` \ (_, _, export_avail_map) ->
502 returnM (nameEnvElts export_avail_map)
505 exports_from_item :: ExportAccum -> RdrNameIE -> TcRn m ExportAccum
507 exports_from_item acc@(mods, occs, avails) ie@(IEModuleContents mod)
508 | mod `elem` mods -- Duplicate export of M
509 = warnIf warn_dup_exports (dupModuleExport mod) `thenM_`
513 = case lookupModuleEnvByName mod_avail_env mod of
514 Nothing -> addErr (modExportErr mod) `thenM_`
518 mod_avails = availEnvElts avail_env
519 avails' = foldl addAvail avails mod_avails
521 foldlM (check_occs warn_dup_exports ie)
522 occs mod_avails `thenM` \ occs' ->
524 returnM (mod:mods, occs', avails')
526 exports_from_item acc@(mods, occs, avails) ie
527 = lookupGRE (ieName ie) `thenM` \ mb_gre ->
529 Nothing -> addErr (unknownNameErr (ieName ie)) `thenM_`
533 -- Get the AvailInfo for the parent of the specified name
534 case lookupAvailEnv entity_avail_env (gre_parent gre) of {
535 Nothing -> pprPanic "exportsFromAvail"
536 ((ppr (ieName ie)) <+> ppr gre) ;
539 -- Filter out the bits we want
540 case filterAvail ie avail of {
541 Nothing -> -- Not enough availability
542 addErr (exportItemErr ie) `thenM_`
547 -- Phew! It's OK! Now to check the occurrence stuff!
548 warnIf (not (ok_item ie avail)) (dodgyExportWarn ie) `thenM_`
549 check_occs warn_dup_exports ie occs export_avail `thenM` \ occs' ->
550 returnM (mods, occs', addAvail avails export_avail)
555 ok_item (IEThingAll _) (AvailTC _ [n]) = False
556 -- This occurs when you import T(..), but
557 -- only export T abstractly. The single [n]
558 -- in the AvailTC is the type or class itself
561 check_occs :: Bool -> RdrNameIE -> ExportOccMap -> AvailInfo -> TcRn m ExportOccMap
562 check_occs warn_dup_exports ie occs avail
563 = foldlM check occs (availNames avail)
566 = case lookupFM occs name_occ of
567 Nothing -> returnM (addToFM occs name_occ (name, ie))
569 | name == name' -> -- Duplicate export
570 warnIf warn_dup_exports
571 (dupExportWarn name_occ ie ie')
572 `thenM_` returnM occs
574 | otherwise -> -- Same occ name but different names: an error
575 addErr (exportClashErr name_occ ie ie') `thenM_`
578 name_occ = nameOccName name
581 %*********************************************************
583 \subsection{Unused names}
585 %*********************************************************
588 reportUnusedNames :: TcGblEnv
589 -> NameSet -- Used in this module
591 reportUnusedNames gbl_env used_names
592 = warnUnusedModules unused_imp_mods `thenM_`
593 warnUnusedTopBinds bad_locals `thenM_`
594 warnUnusedImports bad_imports `thenM_`
595 printMinimalImports minimal_imports
597 direct_import_mods :: [ModuleName]
598 direct_import_mods = map (moduleName . fst)
599 (moduleEnvElts (imp_mods (tcg_imports gbl_env)))
601 -- Now, a use of C implies a use of T,
602 -- if C was brought into scope by T(..) or T(C)
603 really_used_names :: NameSet
604 really_used_names = used_names `unionNameSets`
605 mkNameSet [ gre_parent gre
606 | gre <- defined_names,
607 gre_name gre `elemNameSet` used_names]
609 -- Collect the defined names from the in-scope environment
610 -- Look for the qualified ones only, else get duplicates
611 defined_names :: [GlobalRdrElt]
612 defined_names = foldRdrEnv add [] (tcg_rdr_env gbl_env)
613 add rdr_name ns acc | isQual rdr_name = ns ++ acc
616 defined_and_used, defined_but_not_used :: [GlobalRdrElt]
617 (defined_and_used, defined_but_not_used) = partition used defined_names
618 used gre = gre_name gre `elemNameSet` really_used_names
620 -- Filter out the ones that are
621 -- (a) defined in this module, and
622 -- (b) not defined by a 'deriving' clause
623 -- The latter have an Internal Name, so we can filter them out easily
624 bad_locals :: [GlobalRdrElt]
625 bad_locals = filter is_bad defined_but_not_used
627 is_bad :: GlobalRdrElt -> Bool
628 is_bad gre = isLocalGRE gre && isExternalName (gre_name gre)
630 bad_imports :: [GlobalRdrElt]
631 bad_imports = filter bad_imp defined_but_not_used
632 bad_imp (GRE {gre_prov = NonLocalDef (UserImport mod _ True)}) = not (module_unused mod)
633 bad_imp other = False
635 -- To figure out the minimal set of imports, start with the things
636 -- that are in scope (i.e. in gbl_env). Then just combine them
637 -- into a bunch of avails, so they are properly grouped
638 minimal_imports :: FiniteMap ModuleName AvailEnv
639 minimal_imports0 = emptyFM
640 minimal_imports1 = foldr add_name minimal_imports0 defined_and_used
641 minimal_imports = foldr add_inst_mod minimal_imports1 direct_import_mods
642 -- The last line makes sure that we retain all direct imports
643 -- even if we import nothing explicitly.
644 -- It's not necessarily redundant to import such modules. Consider
648 -- The import M() is not *necessarily* redundant, even if
649 -- we suck in no instance decls from M (e.g. it contains
650 -- no instance decls, or This contains no code). It may be
651 -- that we import M solely to ensure that M's orphan instance
652 -- decls (or those in its imports) are visible to people who
653 -- import This. Sigh.
654 -- There's really no good way to detect this, so the error message
655 -- in RnEnv.warnUnusedModules is weakened instead
658 -- We've carefully preserved the provenance so that we can
659 -- construct minimal imports that import the name by (one of)
660 -- the same route(s) as the programmer originally did.
661 add_name (GRE {gre_name = n, gre_parent = p,
662 gre_prov = NonLocalDef (UserImport m _ _)}) acc
663 = addToFM_C plusAvailEnv acc (moduleName m)
664 (unitAvailEnv (mk_avail n p))
668 -- n is the name of the thing, p is the name of its parent
669 mk_avail n p | n/=p = AvailTC p [p,n]
670 | isTcOcc (nameOccName p) = AvailTC n [n]
671 | otherwise = Avail n
674 | m `elemFM` acc = acc -- We import something already
675 | otherwise = addToFM acc m emptyAvailEnv
676 -- Add an empty collection of imports for a module
677 -- from which we have sucked only instance decls
679 -- unused_imp_mods are the directly-imported modules
680 -- that are not mentioned in minimal_imports1
681 -- [Note: not 'minimal_imports', because that includes direcly-imported
682 -- modules even if we use nothing from them; see notes above]
683 unused_imp_mods = [m | m <- direct_import_mods,
684 not (maybeToBool (lookupFM minimal_imports1 m)),
687 module_unused :: Module -> Bool
688 module_unused mod = moduleName mod `elem` unused_imp_mods
691 -- ToDo: deal with original imports with 'qualified' and 'as M' clauses
692 printMinimalImports :: FiniteMap ModuleName AvailEnv -- Minimal imports
694 printMinimalImports imps
695 = ifOptM Opt_D_dump_minimal_imports $ do {
697 mod_ies <- mappM to_ies (fmToList imps) ;
698 this_mod <- getModule ;
699 rdr_env <- getGlobalRdrEnv ;
700 ioToTcRn (do { h <- openFile (mkFilename this_mod) WriteMode ;
701 printForUser h (unQualInScope rdr_env)
702 (vcat (map ppr_mod_ie mod_ies)) })
705 mkFilename this_mod = moduleNameUserString (moduleName this_mod) ++ ".imports"
706 ppr_mod_ie (mod_name, ies)
707 | mod_name == pRELUDE_Name
709 | null ies -- Nothing except instances comes from here
710 = ptext SLIT("import") <+> ppr mod_name <> ptext SLIT("() -- Instances only")
712 = ptext SLIT("import") <+> ppr mod_name <>
713 parens (fsep (punctuate comma (map ppr ies)))
715 to_ies (mod, avail_env) = mappM to_ie (availEnvElts avail_env) `thenM` \ ies ->
718 to_ie :: AvailInfo -> TcRn m (IE Name)
719 -- The main trick here is that if we're importing all the constructors
720 -- we want to say "T(..)", but if we're importing only a subset we want
721 -- to say "T(A,B,C)". So we have to find out what the module exports.
722 to_ie (Avail n) = returnM (IEVar n)
723 to_ie (AvailTC n [m]) = ASSERT( n==m )
724 returnM (IEThingAbs n)
726 = loadInterface (text "Compute minimal imports from" <+> ppr n_mod)
727 n_mod ImportBySystem `thenM` \ iface ->
728 case [xs | (m,as) <- mi_exports iface,
732 [xs] | all (`elem` ns) xs -> returnM (IEThingAll n)
733 | otherwise -> returnM (IEThingWith n (filter (/= n) ns))
734 other -> pprTrace "to_ie" (ppr n <+> ppr (nameModule n) <+> ppr other) $
737 n_mod = moduleName (nameModule n)
741 %************************************************************************
745 %************************************************************************
748 badImportItemErr mod from ie
749 = sep [ptext SLIT("Module"), quotes (ppr mod), source_import,
750 ptext SLIT("does not export"), quotes (ppr ie)]
752 source_import = case from of
753 True -> ptext SLIT("(hi-boot interface)")
756 dodgyImportWarn mod item = dodgyMsg (ptext SLIT("import")) item
757 dodgyExportWarn item = dodgyMsg (ptext SLIT("export")) item
759 dodgyMsg kind item@(IEThingAll tc)
760 = sep [ ptext SLIT("The") <+> kind <+> ptext SLIT("item") <+> quotes (ppr item),
761 ptext SLIT("suggests that") <+> quotes (ppr tc) <+> ptext SLIT("has constructor or class methods"),
762 ptext SLIT("but it has none; it is a type synonym or abstract type or class") ]
765 = hsep [ ptext SLIT("Unknown module in export list: module"), quotes (ppr mod)]
767 exportItemErr export_item
768 = sep [ ptext SLIT("The export item") <+> quotes (ppr export_item),
769 ptext SLIT("attempts to export constructors or class methods that are not visible here") ]
771 exportClashErr occ_name ie1 ie2
772 = hsep [ptext SLIT("The export items"), quotes (ppr ie1)
773 ,ptext SLIT("and"), quotes (ppr ie2)
774 ,ptext SLIT("create conflicting exports for"), quotes (ppr occ_name)]
777 = vcat [ptext SLIT("Multiple declarations of") <+> quotes (ppr n),
778 nest 4 (vcat (map ppr sorted_locs))]
780 sorted_locs = sortLt occ'ed_before (map nameSrcLoc (n:ns))
781 occ'ed_before a b = LT == compare a b
783 dupExportWarn occ_name ie1 ie2
784 = hsep [quotes (ppr occ_name),
785 ptext SLIT("is exported by"), quotes (ppr ie1),
786 ptext SLIT("and"), quotes (ppr ie2)]
789 = hsep [ptext SLIT("Duplicate"),
790 quotes (ptext SLIT("Module") <+> ppr mod),
791 ptext SLIT("in export list")]
794 = sep [ ptext SLIT("Module") <+> quotes (ppr mod) <+> ptext SLIT("is deprecated:"),