ghc/compiler/rename/RnMonad.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[RnMonad]{The monad used by the renamer}
   5
   6 \begin{code}
   7 module RnMonad(
   8         module RnMonad,
   9
  10         module RdrName,         -- Re-exports
  11         module Name,            -- from these two
  12
  13         Module,
  14         FiniteMap,
  15         Bag,
  16         RdrNameHsDecl,
  17         RdrNameInstDecl,
  18         Version,
  19         NameSet,
  20         OccName,
  21         Fixity
  22     ) where
  23
  24 #include "HsVersions.h"
  25
  26 #if   defined(__GLASGOW_HASKELL__) && __GLASGOW_HASKELL__ >= 405
  27 import IOExts           ( fixIO )
  28 #elif defined(__GLASGOW_HASKELL__) && __GLASGOW_HASKELL__ >= 302
  29 import PrelIOBase       ( fixIO )       -- Should be in GlaExts
  30 #else
  31 import IOBase           ( fixIO )
  32 #endif
  33 import IOExts           ( IORef, newIORef, readIORef, writeIORef, unsafePerformIO )
  34
  35 import HsSyn
  36 import RdrHsSyn
  37 import RnHsSyn          ( RenamedFixitySig )
  38 import HscTypes         ( AvailEnv, lookupType,
  39                           OrigNameEnv(..), OrigNameNameEnv, OrigNameIParamEnv,
  40                           WhetherHasOrphans, ImportVersion,
  41                           PersistentRenamerState(..), IsBootInterface, Avails,
  42                           DeclsMap, IfaceInsts, IfaceRules,
  43                           HomeSymbolTable, PackageTypeEnv,
  44                           PersistentCompilerState(..), GlobalRdrEnv,
  45                           HomeIfaceTable, PackageIfaceTable,
  46                           RdrAvailInfo )
  47 import BasicTypes       ( Version, defaultFixity )
  48 import ErrUtils         ( addShortErrLocLine, addShortWarnLocLine,
  49                           pprBagOfErrors, ErrMsg, WarnMsg, Message
  50                         )
  51 import RdrName          ( RdrName, dummyRdrVarName, rdrNameModule, rdrNameOcc,
  52                           RdrNameEnv, emptyRdrEnv, extendRdrEnv,
  53                           addListToRdrEnv, rdrEnvToList, rdrEnvElts
  54                         )
  55 import Name             ( Name, OccName, NamedThing(..), getSrcLoc,
  56                           nameOccName,
  57                           decode, mkLocalName, mkKnownKeyGlobal,
  58                           NameEnv, lookupNameEnv, emptyNameEnv, unitNameEnv,
  59                           extendNameEnvList
  60                         )
  61 import Module           ( Module, ModuleName, ModuleSet, emptyModuleSet )
  62 import NameSet
  63 import CmdLineOpts      ( DynFlags, DynFlag(..), dopt )
  64 import SrcLoc           ( SrcLoc, generatedSrcLoc, noSrcLoc )
  65 import Unique           ( Unique )
  66 import FiniteMap        ( FiniteMap, emptyFM )
  67 import Bag              ( Bag, emptyBag, isEmptyBag, snocBag )
  68 import UniqSupply
  69 import Outputable
  70 import PrelNames        ( mkUnboundName )
  71 import Maybes           ( maybeToBool )
  72 import ErrUtils         ( printErrorsAndWarnings )
  73
  74 infixr 9 `thenRn`, `thenRn_`
  75 \end{code}
  76
  77
  78 %************************************************************************
  79 %*                                                                      *
  80 \subsection{Somewhat magical interface to other monads}
  81 %*                                                                      *
  82 %************************************************************************
  83
  84 \begin{code}
  85 ioToRnM :: IO r -> RnM d (Either IOError r)
  86 ioToRnM io rn_down g_down = (io >>= \ ok -> return (Right ok))
  87                             `catch`
  88                             (\ err -> return (Left err))
  89
  90 ioToRnM_no_fail :: IO r -> RnM d r
  91 ioToRnM_no_fail io rn_down g_down
  92    = (io >>= \ ok -> return ok)
  93      `catch`
  94      (\ err -> panic "ioToRnM_no_fail: the I/O operation failed!")
  95
  96 traceRn :: SDoc -> RnM d ()
  97 traceRn msg
  98    = doptRn Opt_D_dump_rn_trace `thenRn` \b ->
  99      if b then putDocRn msg else returnRn ()
 100
 101 putDocRn :: SDoc -> RnM d ()
 102 putDocRn msg = ioToRnM (printErrs msg)  `thenRn_`
 103                returnRn ()
 104 \end{code}
 105
 106
 107 %************************************************************************
 108 %*                                                                      *
 109 \subsection{Data types}
 110 %*                                                                      *
 111 %************************************************************************
 112
 113 %===================================================
 114 \subsubsection{         MONAD TYPES}
 115 %===================================================
 116
 117 \begin{code}
 118 type RnM d r = RnDown -> d -> IO r
 119 type RnMS r  = RnM SDown r              -- Renaming source
 120 type RnMG r  = RnM ()    r              -- Getting global names etc
 121
 122         -- Common part
 123 data RnDown
 124   = RnDown {
 125         rn_mod     :: Module,           -- This module
 126         rn_loc     :: SrcLoc,           -- Current locn
 127
 128         rn_dflags  :: DynFlags,
 129
 130         rn_hit     :: HomeIfaceTable,
 131         rn_done    :: Name -> Bool,     -- Tells what things (both in the
 132                                         -- home package and other packages)
 133                                         -- were already available (i.e. in
 134                                         -- the relevant SymbolTable) before
 135                                         -- compiling this module
 136
 137         rn_errs    :: IORef (Bag WarnMsg, Bag ErrMsg),
 138
 139         -- The second and third components are a flattened-out OrigNameEnv
 140         rn_ns      :: IORef (UniqSupply, OrigNameNameEnv, OrigNameIParamEnv),
 141         rn_ifaces  :: IORef Ifaces
 142     }
 143
 144         -- For renaming source code
 145 data SDown = SDown {
 146                   rn_mode :: RnMode,
 147
 148                   rn_genv :: GlobalRdrEnv,      -- Top level environment
 149
 150                   rn_lenv :: LocalRdrEnv,       -- Local name envt
 151                         --   Does *not* include global name envt; may shadow it
 152                         --   Includes both ordinary variables and type variables;
 153                         --   they are kept distinct because tyvar have a different
 154                         --   occurrence contructor (Name.TvOcc)
 155                         -- We still need the unsullied global name env so that
 156                         --   we can look up record field names
 157
 158                   rn_fixenv :: LocalFixityEnv   -- Local fixities (for non-top-level
 159                                                 -- declarations)
 160                         -- The global fixities are held in the
 161                         -- HIT or PIT.  Why?  See the comments
 162                         -- with RnIfaces.lookupLocalFixity
 163                 }
 164
 165 data RnMode     = SourceMode                    -- Renaming source code
 166                 | InterfaceMode                 -- Renaming interface declarations.
 167 \end{code}
 168
 169 %===================================================
 170 \subsubsection{         ENVIRONMENTS}
 171 %===================================================
 172
 173 \begin{code}
 174 --------------------------------
 175 type LocalRdrEnv    = RdrNameEnv Name
 176 type LocalFixityEnv = NameEnv RenamedFixitySig
 177         -- We keep the whole fixity sig so that we
 178         -- can report line-number info when there is a duplicate
 179         -- fixity declaration
 180
 181 lookupLocalFixity :: LocalFixityEnv -> Name -> Fixity
 182 lookupLocalFixity env name
 183   = case lookupNameEnv env name of
 184         Just (FixitySig _ fix _) -> fix
 185         Nothing                  -> defaultFixity
 186 \end{code}
 187
 188 \begin{code}
 189 type ExportAvails = (FiniteMap ModuleName Avails,
 190         -- Used to figure out "module M" export specifiers
 191         -- Includes avails only from *unqualified* imports
 192         -- (see 1.4 Report Section 5.1.1)
 193
 194                      AvailEnv)  -- Used to figure out all other export specifiers.
 195 \end{code}
 196
 197 %===================================================
 198 \subsubsection{         INTERFACE FILE STUFF}
 199 %===================================================
 200
 201 \begin{code}
 202 type ExportItem   = (ModuleName, [RdrAvailInfo])
 203 type IfaceDeprecs = Maybe (Either DeprecTxt [(RdrName,DeprecTxt)])
 204         -- Nothing        => NoDeprecs
 205         -- Just (Left t)  => DeprecAll
 206         -- Just (Right p) => DeprecSome
 207
 208 data ParsedIface
 209   = ParsedIface {
 210       pi_mod       :: Module,                           -- Complete with package info
 211       pi_vers      :: Version,                          -- Module version number
 212       pi_orphan    :: WhetherHasOrphans,                -- Whether this module has orphans
 213       pi_usages    :: [ImportVersion OccName],          -- Usages
 214       pi_exports   :: (Version, [ExportItem]),          -- Exports
 215       pi_decls     :: [(Version, RdrNameTyClDecl)],     -- Local definitions
 216       pi_fixity    :: [RdrNameFixitySig],               -- Local fixity declarations,
 217       pi_insts     :: [RdrNameInstDecl],                -- Local instance declarations
 218       pi_rules     :: (Version, [RdrNameRuleDecl]),     -- Rules, with their version
 219       pi_deprecs   :: IfaceDeprecs                      -- Deprecations
 220     }
 221 \end{code}
 222
 223 %************************************************************************
 224 %*                                                                      *
 225 \subsection{The renamer state}
 226 %*                                                                      *
 227 %************************************************************************
 228
 229 \begin{code}
 230 data Ifaces = Ifaces {
 231     -- PERSISTENT FIELDS
 232         iPIT :: PackageIfaceTable,
 233                 -- The ModuleIFaces for modules in other packages
 234                 -- whose interfaces we have opened
 235                 -- The declarations in these interface files are held in
 236                 -- iDecls, iInsts, iRules (below), not in the mi_decls fields
 237                 -- of the iPIT.  What _is_ in the iPIT is:
 238                 --      * The Module
 239                 --      * Version info
 240                 --      * Its exports
 241                 --      * Fixities
 242                 --      * Deprecations
 243                 -- The iPIT field is initialised from the compiler's persistent
 244                 -- package symbol table, and the renamer incrementally adds
 245                 -- to it.
 246
 247         iDecls :: DeclsMap,
 248                 -- A single, global map of Names to unslurped decls
 249
 250         iInsts :: IfaceInsts,
 251                 -- The as-yet un-slurped instance decls; this bag is depleted when we
 252                 -- slurp an instance decl so that we don't slurp the same one twice.
 253                 -- Each is 'gated' by the names that must be available before
 254                 -- this instance decl is needed.
 255
 256         iRules :: IfaceRules,
 257                 -- Similar to instance decls, only for rules
 258
 259     -- EPHEMERAL FIELDS
 260     -- These fields persist during the compilation of a single module only
 261         iImpModInfo :: ImportedModuleInfo,
 262                         -- Modules this one depends on: that is, the union
 263                         -- of the modules its *direct* imports depend on.
 264                         -- NB: The direct imports have .hi files that enumerate *all* the
 265                         -- dependencies (direct or not) of the imported module.
 266
 267         iSlurp :: NameSet,
 268                 -- All the names (whether "big" or "small", whether wired-in or not,
 269                 -- whether locally defined or not) that have been slurped in so far.
 270
 271         iVSlurp :: (ModuleSet, NameSet)
 272                 -- The Names are all the (a) non-wired-in
 273                 --                       (b) "big"
 274                 --                       (c) non-locally-defined
 275                 --                       (d) home-package
 276                 -- names that have been slurped in so far, with their versions.
 277                 -- This is used to generate the "usage" information for this module.
 278                 -- Subset of the previous field.
 279                 -- The module set is the non-home-package modules from which we have
 280                 -- slurped at least one name.
 281                 -- It's worth keeping separately, because there's no very easy
 282                 -- way to distinguish the "big" names from the "non-big" ones.
 283                 -- But this is a decision we might want to revisit.
 284     }
 285
 286 type ImportedModuleInfo = FiniteMap ModuleName (WhetherHasOrphans, IsBootInterface)
 287         -- Contains info ONLY about modules that have not yet
 288         --- been loaded into the iPIT
 289 \end{code}
 290
 291
 292 %************************************************************************
 293 %*                                                                      *
 294 \subsection{Main monad code}
 295 %*                                                                      *
 296 %************************************************************************
 297
 298 \begin{code}
 299 initRn :: DynFlags
 300        -> HomeIfaceTable -> HomeSymbolTable
 301        -> PersistentCompilerState
 302        -> Module
 303        -> RnMG t
 304        -> IO (PersistentCompilerState, Bool, t)
 305                 -- True <=> found errors
 306
 307 initRn dflags hit hst pcs mod do_rn
 308   = do
 309         let prs = pcs_PRS pcs
 310         let pte = pcs_PTE pcs
 311         let ifaces = Ifaces { iPIT   = pcs_PIT pcs,
 312                               iDecls = prsDecls prs,
 313                               iInsts = prsInsts prs,
 314                               iRules = prsRules prs,
 315
 316                               iImpModInfo = emptyFM,
 317                               iSlurp      = unitNameSet (mkUnboundName dummyRdrVarName),
 318                                 -- Pretend that the dummy unbound name has already been
 319                                 -- slurped.  This is what's returned for an out-of-scope name,
 320                                 -- and we don't want thereby to try to suck it in!
 321                               iVSlurp = (emptyModuleSet, emptyNameSet)
 322                       }
 323         let uniqs = prsNS prs
 324
 325         names_var <- newIORef (uniqs, origNames (prsOrig prs),
 326                                       origIParam (prsOrig prs))
 327         errs_var  <- newIORef (emptyBag,emptyBag)
 328         iface_var <- newIORef ifaces
 329         let rn_down = RnDown { rn_mod = mod,
 330                                rn_loc = noSrcLoc,
 331
 332                                rn_dflags = dflags,
 333                                rn_hit    = hit,
 334                                rn_done   = is_done hst pte,
 335
 336                                rn_ns     = names_var,
 337                                rn_errs   = errs_var,
 338                                rn_ifaces = iface_var,
 339                              }
 340
 341         -- do the business
 342         res <- do_rn rn_down ()
 343
 344         -- Grab state and record it
 345         (warns, errs)                   <- readIORef errs_var
 346         new_ifaces                      <- readIORef iface_var
 347         (new_NS, new_origN, new_origIP) <- readIORef names_var
 348         let new_orig = Orig { origNames = new_origN, origIParam = new_origIP }
 349         let new_prs = prs { prsOrig = new_orig,
 350                             prsDecls = iDecls new_ifaces,
 351                             prsInsts = iInsts new_ifaces,
 352                             prsRules = iRules new_ifaces,
 353                             prsNS    = new_NS }
 354         let new_pcs = pcs { pcs_PIT = iPIT new_ifaces,
 355                             pcs_PRS = new_prs }
 356
 357         -- Check for warnings
 358         printErrorsAndWarnings (warns, errs) ;
 359
 360         return (new_pcs, not (isEmptyBag errs), res)
 361
 362 is_done :: HomeSymbolTable -> PackageTypeEnv -> Name -> Bool
 363 -- Returns True iff the name is in either symbol table
 364 -- The name is a Global, so it has a Module
 365 is_done hst pte n = maybeToBool (lookupType hst pte n)
 366
 367 initRnMS rn_env fixity_env mode thing_inside rn_down g_down
 368         -- The fixity_env appears in both the rn_fixenv field
 369         -- and in the HIT.  See comments with RnHiFiles.lookupFixityRn
 370   = let
 371         s_down = SDown { rn_genv = rn_env, rn_lenv = emptyRdrEnv,
 372                          rn_fixenv = fixity_env, rn_mode = mode }
 373     in
 374     thing_inside rn_down s_down
 375
 376 initIfaceRnMS :: Module -> RnMS r -> RnM d r
 377 initIfaceRnMS mod thing_inside
 378   = initRnMS emptyRdrEnv emptyNameEnv InterfaceMode $
 379     setModuleRn mod thing_inside
 380 \end{code}
 381
 382 @renameSourceCode@ is used to rename stuff ``out-of-line'';
 383 that is, not as part of the main renamer.
 384 Sole examples: derived definitions,
 385 which are only generated in the type checker.
 386
 387 The @NameSupply@ includes a @UniqueSupply@, so if you call it more than
 388 once you must either split it, or install a fresh unique supply.
 389
 390 \begin{code}
 391 renameSourceCode :: DynFlags
 392                  -> Module
 393                  -> PersistentRenamerState
 394                  -> RnMS r
 395                  -> r
 396
 397 renameSourceCode dflags mod prs m
 398   = unsafePerformIO (
 399         -- It's not really unsafe!  When renaming source code we
 400         -- only do any I/O if we need to read in a fixity declaration;
 401         -- and that doesn't happen in pragmas etc
 402
 403         mkSplitUniqSupply 'r'                           >>= \ new_us ->
 404         newIORef (new_us, origNames (prsOrig prs),
 405                           origIParam (prsOrig prs))     >>= \ names_var ->
 406         newIORef (emptyBag,emptyBag)                    >>= \ errs_var ->
 407         let
 408             rn_down = RnDown { rn_dflags = dflags,
 409                                rn_loc = generatedSrcLoc, rn_ns = names_var,
 410                                rn_errs = errs_var,
 411                                rn_mod = mod,
 412                                rn_done   = bogus "rn_done",     rn_hit    = bogus "rn_hit",
 413                                rn_ifaces = bogus "rn_ifaces"
 414                              }
 415             s_down = SDown { rn_mode = InterfaceMode,
 416                                -- So that we can refer to PrelBase.True etc
 417                              rn_genv = emptyRdrEnv, rn_lenv = emptyRdrEnv,
 418                              rn_fixenv = emptyNameEnv }
 419         in
 420         m rn_down s_down                        >>= \ result ->
 421
 422         readIORef errs_var                      >>= \ (warns,errs) ->
 423
 424         (if not (isEmptyBag errs) then
 425                 pprTrace "Urk! renameSourceCode found errors" (display errs)
 426 #ifdef DEBUG
 427          else if not (isEmptyBag warns) then
 428                 pprTrace "Note: renameSourceCode found warnings" (display warns)
 429 #endif
 430          else
 431                 id) $
 432
 433         return result
 434     )
 435   where
 436     display errs = pprBagOfErrors errs
 437
 438 bogus s = panic ("rnameSourceCode: " ++ s)  -- Used for unused record fields
 439
 440 {-# INLINE thenRn #-}
 441 {-# INLINE thenRn_ #-}
 442 {-# INLINE returnRn #-}
 443 {-# INLINE andRn #-}
 444
 445 returnRn :: a -> RnM d a
 446 thenRn   :: RnM d a -> (a -> RnM d b) -> RnM d b
 447 thenRn_  :: RnM d a -> RnM d b -> RnM d b
 448 andRn    :: (a -> a -> a) -> RnM d a -> RnM d a -> RnM d a
 449 mapRn    :: (a -> RnM d b) -> [a] -> RnM d [b]
 450 mapRn_   :: (a -> RnM d b) -> [a] -> RnM d ()
 451 mapMaybeRn :: (a -> RnM d (Maybe b)) -> [a] -> RnM d [b]
 452 flatMapRn  :: (a -> RnM d [b])       -> [a] -> RnM d [b]
 453 sequenceRn :: [RnM d a] -> RnM d [a]
 454 foldlRn :: (b  -> a -> RnM d b) -> b -> [a] -> RnM d b
 455 mapAndUnzipRn :: (a -> RnM d (b,c)) -> [a] -> RnM d ([b],[c])
 456 fixRn    :: (a -> RnM d a) -> RnM d a
 457
 458 returnRn v gdown ldown  = return v
 459 thenRn m k gdown ldown  = m gdown ldown >>= \ r -> k r gdown ldown
 460 thenRn_ m k gdown ldown = m gdown ldown >> k gdown ldown
 461 fixRn m gdown ldown = fixIO (\r -> m r gdown ldown)
 462 andRn combiner m1 m2 gdown ldown
 463   = m1 gdown ldown >>= \ res1 ->
 464     m2 gdown ldown >>= \ res2 ->
 465     return (combiner res1 res2)
 466
 467 sequenceRn []     = returnRn []
 468 sequenceRn (m:ms) =  m                  `thenRn` \ r ->
 469                      sequenceRn ms      `thenRn` \ rs ->
 470                      returnRn (r:rs)
 471
 472 mapRn f []     = returnRn []
 473 mapRn f (x:xs)
 474   = f x         `thenRn` \ r ->
 475     mapRn f xs  `thenRn` \ rs ->
 476     returnRn (r:rs)
 477
 478 mapRn_ f []     = returnRn ()
 479 mapRn_ f (x:xs) =
 480     f x         `thenRn_`
 481     mapRn_ f xs
 482
 483 foldlRn k z [] = returnRn z
 484 foldlRn k z (x:xs) = k z x      `thenRn` \ z' ->
 485                      foldlRn k z' xs
 486
 487 mapAndUnzipRn f [] = returnRn ([],[])
 488 mapAndUnzipRn f (x:xs)
 489   = f x                 `thenRn` \ (r1,  r2)  ->
 490     mapAndUnzipRn f xs  `thenRn` \ (rs1, rs2) ->
 491     returnRn (r1:rs1, r2:rs2)
 492
 493 mapAndUnzip3Rn f [] = returnRn ([],[],[])
 494 mapAndUnzip3Rn f (x:xs)
 495   = f x                 `thenRn` \ (r1,  r2,  r3)  ->
 496     mapAndUnzip3Rn f xs `thenRn` \ (rs1, rs2, rs3) ->
 497     returnRn (r1:rs1, r2:rs2, r3:rs3)
 498
 499 mapMaybeRn f []     = returnRn []
 500 mapMaybeRn f (x:xs) = f x               `thenRn` \ maybe_r ->
 501                       mapMaybeRn f xs   `thenRn` \ rs ->
 502                       case maybe_r of
 503                         Nothing -> returnRn rs
 504                         Just r  -> returnRn (r:rs)
 505
 506 flatMapRn f []     = returnRn []
 507 flatMapRn f (x:xs) = f x                `thenRn` \ r ->
 508                      flatMapRn f xs     `thenRn` \ rs ->
 509                      returnRn (r ++ rs)
 510 \end{code}
 511
 512
 513
 514 %************************************************************************
 515 %*                                                                      *
 516 \subsection{Boring plumbing for common part}
 517 %*                                                                      *
 518 %************************************************************************
 519
 520
 521 %================
 522 \subsubsection{  Errors and warnings}
 523 %=====================
 524
 525 \begin{code}
 526 failWithRn :: a -> Message -> RnM d a
 527 failWithRn res msg (RnDown {rn_errs = errs_var, rn_loc = loc}) l_down
 528   = readIORef  errs_var                                         >>=  \ (warns,errs) ->
 529     writeIORef errs_var (warns, errs `snocBag` err)             >>
 530     return res
 531   where
 532     err = addShortErrLocLine loc msg
 533
 534 warnWithRn :: a -> Message -> RnM d a
 535 warnWithRn res msg (RnDown {rn_errs = errs_var, rn_loc = loc}) l_down
 536   = readIORef  errs_var                                         >>=  \ (warns,errs) ->
 537     writeIORef errs_var (warns `snocBag` warn, errs)    >>
 538     return res
 539   where
 540     warn = addShortWarnLocLine loc msg
 541
 542 addErrRn :: Message -> RnM d ()
 543 addErrRn err = failWithRn () err
 544
 545 checkRn :: Bool -> Message -> RnM d ()  -- Check that a condition is true
 546 checkRn False err = addErrRn err
 547 checkRn True  err = returnRn ()
 548
 549 warnCheckRn :: Bool -> Message -> RnM d ()      -- Check that a condition is true
 550 warnCheckRn False err = addWarnRn err
 551 warnCheckRn True  err = returnRn ()
 552
 553 addWarnRn :: Message -> RnM d ()
 554 addWarnRn warn = warnWithRn () warn
 555
 556 checkErrsRn :: RnM d Bool               -- True <=> no errors so far
 557 checkErrsRn (RnDown {rn_errs = errs_var}) l_down
 558   = readIORef  errs_var                                         >>=  \ (warns,errs) ->
 559     return (isEmptyBag errs)
 560
 561 doptRn :: DynFlag -> RnM d Bool
 562 doptRn dflag (RnDown { rn_dflags = dflags}) l_down
 563    = return (dopt dflag dflags)
 564
 565 getDOptsRn :: RnM d DynFlags
 566 getDOptsRn (RnDown { rn_dflags = dflags}) l_down
 567    = return dflags
 568 \end{code}
 569
 570
 571 %================
 572 \subsubsection{Source location}
 573 %=====================
 574
 575 \begin{code}
 576 pushSrcLocRn :: SrcLoc -> RnM d a -> RnM d a
 577 pushSrcLocRn loc' m down l_down
 578   = m (down {rn_loc = loc'}) l_down
 579
 580 getSrcLocRn :: RnM d SrcLoc
 581 getSrcLocRn down l_down
 582   = return (rn_loc down)
 583 \end{code}
 584
 585 %================
 586 \subsubsection{The finder and home symbol table}
 587 %=====================
 588
 589 \begin{code}
 590 getHomeIfaceTableRn :: RnM d HomeIfaceTable
 591 getHomeIfaceTableRn down l_down = return (rn_hit down)
 592
 593 checkAlreadyAvailable :: Name -> RnM d Bool
 594         -- Name is a Global name
 595 checkAlreadyAvailable name down l_down = return (rn_done down name)
 596 \end{code}
 597
 598 %================
 599 \subsubsection{Name supply}
 600 %=====================
 601
 602 \begin{code}
 603 getNameSupplyRn :: RnM d (UniqSupply, OrigNameNameEnv, OrigNameIParamEnv)
 604 getNameSupplyRn rn_down l_down
 605   = readIORef (rn_ns rn_down)
 606
 607 setNameSupplyRn :: (UniqSupply, OrigNameNameEnv, OrigNameIParamEnv) -> RnM d ()
 608 setNameSupplyRn names' (RnDown {rn_ns = names_var}) l_down
 609   = writeIORef names_var names'
 610
 611 getUniqRn :: RnM d Unique
 612 getUniqRn (RnDown {rn_ns = names_var}) l_down
 613  = readIORef names_var >>= \ (us, cache, ipcache) ->
 614    let
 615      (us1,us') = splitUniqSupply us
 616    in
 617    writeIORef names_var (us', cache, ipcache)  >>
 618    return (uniqFromSupply us1)
 619 \end{code}
 620
 621 %================
 622 \subsubsection{  Module}
 623 %=====================
 624
 625 \begin{code}
 626 getModuleRn :: RnM d Module
 627 getModuleRn (RnDown {rn_mod = mod}) l_down
 628   = return mod
 629
 630 setModuleRn :: Module -> RnM d a -> RnM d a
 631 setModuleRn new_mod enclosed_thing rn_down l_down
 632   = enclosed_thing (rn_down {rn_mod = new_mod}) l_down
 633 \end{code}
 634
 635
 636 %************************************************************************
 637 %*                                                                      *
 638 \subsection{Plumbing for rename-source part}
 639 %*                                                                      *
 640 %************************************************************************
 641
 642 %================
 643 \subsubsection{  RnEnv}
 644 %=====================
 645
 646 \begin{code}
 647 getLocalNameEnv :: RnMS LocalRdrEnv
 648 getLocalNameEnv rn_down (SDown {rn_lenv = local_env})
 649   = return local_env
 650
 651 getGlobalNameEnv :: RnMS GlobalRdrEnv
 652 getGlobalNameEnv rn_down (SDown {rn_genv = global_env})
 653   = return global_env
 654
 655 setLocalNameEnv :: LocalRdrEnv -> RnMS a -> RnMS a
 656 setLocalNameEnv local_env' m rn_down l_down
 657   = m rn_down (l_down {rn_lenv = local_env'})
 658
 659 getFixityEnv :: RnMS LocalFixityEnv
 660 getFixityEnv rn_down (SDown {rn_fixenv = fixity_env})
 661   = return fixity_env
 662
 663 extendFixityEnv :: [(Name, RenamedFixitySig)] -> RnMS a -> RnMS a
 664 extendFixityEnv fixes enclosed_scope
 665                 rn_down l_down@(SDown {rn_fixenv = fixity_env})
 666   = let
 667         new_fixity_env = extendNameEnvList fixity_env fixes
 668     in
 669     enclosed_scope rn_down (l_down {rn_fixenv = new_fixity_env})
 670 \end{code}
 671
 672 %================
 673 \subsubsection{  Mode}
 674 %=====================
 675
 676 \begin{code}
 677 getModeRn :: RnMS RnMode
 678 getModeRn rn_down (SDown {rn_mode = mode})
 679   = return mode
 680
 681 setModeRn :: RnMode -> RnMS a -> RnMS a
 682 setModeRn new_mode thing_inside rn_down l_down
 683   = thing_inside rn_down (l_down {rn_mode = new_mode})
 684 \end{code}
 685
 686
 687 %************************************************************************
 688 %*                                                                      *
 689 \subsection{Plumbing for rename-globals part}
 690 %*                                                                      *
 691 %************************************************************************
 692
 693 \begin{code}
 694 getIfacesRn :: RnM d Ifaces
 695 getIfacesRn (RnDown {rn_ifaces = iface_var}) _
 696   = readIORef iface_var
 697
 698 setIfacesRn :: Ifaces -> RnM d ()
 699 setIfacesRn ifaces (RnDown {rn_ifaces = iface_var}) _
 700   = writeIORef iface_var ifaces
 701 \end{code}