Re-work the naming story for the GHCi prompt (Trac #8649)
authorSimon Peyton Jones <simonpj@microsoft.com>
Thu, 9 Jan 2014 17:58:18 +0000 (17:58 +0000)
committerSimon Peyton Jones <simonpj@microsoft.com>
Thu, 9 Jan 2014 17:58:48 +0000 (17:58 +0000)
commit73c08ab10e4077e18e459a1325996bff110360c3
tree779ba96f15da23ff993ff7a15f05ec5adb01436e
parent322b48b92b93e1250b360d21873fa9f31c142403
Re-work the naming story for the GHCi prompt (Trac #8649)

The basic idea here is simple, and described in Note [The interactive package]
in HscTypes, which starts thus:

    Note [The interactive package]
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    Type and class declarations at the command prompt are treated as if
    they were defined in modules
       interactive:Ghci1
       interactive:Ghci2
       ...etc...
    with each bunch of declarations using a new module, all sharing a
    common package 'interactive' (see Module.interactivePackageId, and
    PrelNames.mkInteractiveModule).

    This scheme deals well with shadowing.  For example:

       ghci> data T = A
       ghci> data T = B
       ghci> :i A
       data Ghci1.T = A  -- Defined at <interactive>:2:10

    Here we must display info about constructor A, but its type T has been
    shadowed by the second declaration.  But it has a respectable
    qualified name (Ghci1.T), and its source location says where it was
    defined.

    So the main invariant continues to hold, that in any session an original
    name M.T only refers to oe unique thing.  (In a previous iteration both
    the T's above were called :Interactive.T, albeit with different uniques,
    which gave rise to all sorts of trouble.)

This scheme deals nicely with the original problem.  It allows us to
eliminate a couple of grotseque hacks
  - Note [Outputable Orig RdrName] in HscTypes
  - Note [interactive name cache] in IfaceEnv
(both these comments have gone, because the hacks they describe are no
longer necessary). I was also able to simplify Outputable.QueryQualifyName,
so that it takes a Module/OccName as args rather than a Name.

However, matters are never simple, and this change took me an
unreasonably long time to get right.  There are some details in
Note [The interactive package] in HscTypes.
23 files changed:
compiler/basicTypes/Module.lhs
compiler/basicTypes/Name.lhs
compiler/basicTypes/RdrName.lhs
compiler/deSugar/Desugar.lhs
compiler/ghci/Linker.lhs
compiler/ghci/RtClosureInspect.hs
compiler/iface/IfaceEnv.lhs
compiler/llvmGen/LlvmCodeGen/Base.hs
compiler/main/DynamicLoading.hs
compiler/main/HscMain.hs
compiler/main/HscTypes.lhs
compiler/prelude/PrelNames.lhs
compiler/rename/RnEnv.lhs
compiler/rename/RnNames.lhs
compiler/simplCore/CoreMonad.lhs
compiler/typecheck/FamInst.lhs
compiler/typecheck/TcEnv.lhs
compiler/typecheck/TcRnDriver.lhs
compiler/typecheck/TcRnMonad.lhs
compiler/typecheck/TcRnTypes.lhs
compiler/typecheck/TcSplice.lhs
compiler/types/FamInstEnv.lhs
compiler/utils/Outputable.lhs