X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Frename%2FRnMonad.lhs;h=1b3bcfc8ef078590babc7102b04b13e490a3e63d;hb=d2cca44eae15bbbd3b86889448e796bc785dfa52;hp=574ce864cfa81f2134c7dc6af87b37b24ef694d8;hpb=9597206bf59bbb169c4b9085ea0821bee4a7da7f;p=ghc-hetmet.git diff --git a/ghc/compiler/rename/RnMonad.lhs b/ghc/compiler/rename/RnMonad.lhs index 574ce86..1b3bcfc 100644 --- a/ghc/compiler/rename/RnMonad.lhs +++ b/ghc/compiler/rename/RnMonad.lhs @@ -1,15 +1,18 @@ % -% (c) The GRASP/AQUA Project, Glasgow University, 1992-1997 +% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998 % \section[RnMonad]{The monad used by the renamer} \begin{code} module RnMonad( module RnMonad, + + module RdrName, -- Re-exports + module Name, -- from these two + Module, FiniteMap, Bag, - Name, RdrNameHsDecl, RdrNameInstDecl, Version, @@ -20,35 +23,53 @@ module RnMonad( #include "HsVersions.h" -import SST -import GlaExts ( RealWorld, stToIO ) -import List ( intersperse ) - +#if defined(__GLASGOW_HASKELL__) && __GLASGOW_HASKELL__ >= 405 +import IOExts ( fixIO ) +#elif defined(__GLASGOW_HASKELL__) && __GLASGOW_HASKELL__ >= 302 +import PrelIOBase ( fixIO ) -- Should be in GlaExts +#else +import IOBase ( fixIO ) +#endif +import IOExts ( IORef, newIORef, readIORef, writeIORef, unsafePerformIO ) + import HsSyn import RdrHsSyn -import BasicTypes ( Version, NewOrData, pprModule ) -import SrcLoc ( noSrcLoc ) +import RnHsSyn ( RenamedFixitySig ) +import HscTypes ( Finder, + AvailEnv, lookupTypeEnv, + OrigNameEnv(..), OrigNameNameEnv, OrigNameIParamEnv, + WhetherHasOrphans, ImportVersion, + PersistentRenamerState(..), IsBootInterface, Avails, + DeclsMap, IfaceInsts, IfaceRules, + HomeSymbolTable, PackageSymbolTable, + PersistentCompilerState(..), GlobalRdrEnv, + HomeIfaceTable, PackageIfaceTable, + RdrAvailInfo, ModIface ) +import BasicTypes ( Version, defaultFixity ) import ErrUtils ( addShortErrLocLine, addShortWarnLocLine, - pprBagOfErrors, ErrMsg, WarnMsg + pprBagOfErrors, ErrMsg, WarnMsg, Message ) -import Maybes ( seqMaybe, mapMaybe ) -import Name ( Module, Name, OccName, PrintUnqualified, NameSet, emptyNameSet, - isLocallyDefinedName, - modAndOcc, NamedThing(..) +import RdrName ( RdrName, dummyRdrVarName, rdrNameModule, rdrNameOcc, + RdrNameEnv, emptyRdrEnv, extendRdrEnv, + lookupRdrEnv, addListToRdrEnv, rdrEnvToList, rdrEnvElts ) -import CmdLineOpts ( opt_D_show_rn_trace, opt_IgnoreIfacePragmas, opt_WarnHiShadows ) -import PrelInfo ( builtinNames ) -import TysWiredIn ( boolTyCon ) -import SrcLoc ( SrcLoc, mkGeneratedSrcLoc ) +import Name ( Name, OccName, NamedThing(..), getSrcLoc, + isLocallyDefinedName, nameModule, nameOccName, + decode, mkLocalName, mkKnownKeyGlobal, + NameEnv, lookupNameEnv, emptyNameEnv, unitNameEnv, + extendNameEnvList + ) +import Module ( Module, ModuleName, lookupModuleEnvByName ) +import NameSet +import CmdLineOpts ( DynFlags, DynFlag(..), dopt ) +import SrcLoc ( SrcLoc, generatedSrcLoc ) import Unique ( Unique ) -import UniqFM ( UniqFM ) -import FiniteMap ( FiniteMap, emptyFM, bagToFM, lookupFM, addToFM, addListToFM_C ) -import Bag ( Bag, mapBag, emptyBag, isEmptyBag, snocBag ) -import UniqSet +import FiniteMap ( FiniteMap, emptyFM ) +import Bag ( Bag, emptyBag, isEmptyBag, snocBag ) import UniqSupply -import Util import Outputable -import DirUtils ( getDirectoryContents ) +import PrelNames ( mkUnboundName ) +import Maybes ( maybeToBool, seqMaybe, orElse ) infixr 9 `thenRn`, `thenRn_` \end{code} @@ -61,18 +82,18 @@ infixr 9 `thenRn`, `thenRn_` %************************************************************************ \begin{code} -sstToIO :: SST RealWorld r -> IO r -sstToIO sst = stToIO (sstToST sst) - -ioToRnMG :: IO r -> RnMG (Either IOError r) -ioToRnMG io rn_down g_down = ioToSST io +ioToRnM :: IO r -> RnM d (Either IOError r) +ioToRnM io rn_down g_down = (io >>= \ ok -> return (Right ok)) + `catch` + (\ err -> return (Left err)) -traceRn :: SDoc -> RnMG () -traceRn msg | opt_D_show_rn_trace = putDocRn msg - | otherwise = returnRn () +traceRn :: SDoc -> RnM d () +traceRn msg + = doptRn Opt_D_dump_rn_trace `thenRn` \b -> + if b then putDocRn msg else returnRn () -putDocRn :: SDoc -> RnMG () -putDocRn msg = ioToRnMG (printErrs msg) `thenRn_` +putDocRn :: SDoc -> RnM d () +putDocRn msg = ioToRnM (printErrs msg) `thenRn_` returnRn () \end{code} @@ -83,200 +104,173 @@ putDocRn msg = ioToRnMG (printErrs msg) `thenRn_` %* * %************************************************************************ -=================================================== - MONAD TYPES -=================================================== +%=================================================== +\subsubsection{ MONAD TYPES} +%=================================================== \begin{code} -type RnM s d r = RnDown s -> d -> SST s r -type RnMS s r = RnM s (SDown s) r -- Renaming source -type RnMG r = RnM RealWorld GDown r -- Getting global names etc -type SSTRWRef a = SSTRef RealWorld a -- ToDo: there ought to be a standard defn of this +type RnM d r = RnDown -> d -> IO r +type RnMS r = RnM SDown r -- Renaming source +type RnMG r = RnM () r -- Getting global names etc -- Common part -data RnDown s = RnDown - SrcLoc - (SSTRef s (GenRnNameSupply s)) - (SSTRef s (Bag WarnMsg, Bag ErrMsg)) - (SSTRef s ([Occurrence],[Occurrence])) -- Occurrences: compulsory and optional resp +data RnDown + = RnDown { + rn_mod :: Module, -- This module + rn_loc :: SrcLoc, -- Current locn -type Occurrence = (Name, SrcLoc) -- The srcloc is the occurrence site + rn_finder :: Finder, + rn_dflags :: DynFlags, -data Necessity = Compulsory | Optional -- We *must* find definitions for - -- compulsory occurrences; we *may* find them - -- for optional ones. + rn_hit :: HomeIfaceTable, + rn_done :: Name -> Bool, -- Tells what things (both in the + -- home package and other packages) + -- were already available (i.e. in + -- the relevant SymbolTable) before + -- compiling this module - -- For getting global names -data GDown = GDown - ModuleHiMap - (SSTRWRef Ifaces) - - -- For renaming source code -data SDown s = SDown - RnEnv -- Global envt - NameEnv -- Local name envt (includes global name envt, - -- but may shadow it) - Module - RnSMode + rn_errs :: IORef (Bag WarnMsg, Bag ErrMsg), + -- The second and third components are a flattened-out OrigNameEnv + rn_ns :: IORef (UniqSupply, OrigNameNameEnv, OrigNameIParamEnv), + rn_ifaces :: IORef Ifaces + } -data RnSMode = SourceMode -- Renaming source code + -- For renaming source code +data SDown = SDown { + rn_mode :: RnMode, + + rn_genv :: GlobalRdrEnv, -- Global envt + + rn_lenv :: LocalRdrEnv, -- Local name envt + -- Does *not* include global name envt; may shadow it + -- Includes both ordinary variables and type variables; + -- they are kept distinct because tyvar have a different + -- occurrence contructor (Name.TvOcc) + -- We still need the unsullied global name env so that + -- we can look up record field names + + rn_fixenv :: LocalFixityEnv -- Local fixities + -- The global fixities are held in the + -- rn_ifaces field. Why? See the comments + -- with RnIfaces.lookupLocalFixity + } + +data RnMode = SourceMode -- Renaming source code | InterfaceMode -- Renaming interface declarations. - Necessity -- The "necessity" - -- flag says free variables *must* be found and slurped - -- or whether they need not be. For value signatures of - -- things that are themselves compulsorily imported - -- we arrange that the type signature is read - -- in compulsory mode, - -- but the pragmas in optional mode. - (Name -> PrintUnqualified) -- Tells whether the thing can be printed unqualified - -type SearchPath = [(String,String)] -- List of (directory,suffix) pairs to search - -- for interface files. - -type ModuleHiMap = FiniteMap String String - -- mapping from module name to the file path of its corresponding - -- interface file. - -type FreeVars = NameSet \end{code} -=================================================== - ENVIRONMENTS -=================================================== +%=================================================== +\subsubsection{ ENVIRONMENTS} +%=================================================== \begin{code} -type RnNameSupply = GenRnNameSupply RealWorld - -type GenRnNameSupply s - = ( UniqSupply - , FiniteMap FAST_STRING (SSTRef s Int) - , FiniteMap (Module,OccName) Name - ) - -- Ensures that one (m,n) pair gets one unique - -- The finite map on FAST_STRINGS is used to give a per-class unique to each - -- instance declaration; it's really a separate name supply. - -data RnEnv = RnEnv GlobalNameEnv FixityEnv -emptyRnEnv = RnEnv emptyNameEnv emptyFixityEnv - -type GlobalNameEnv = FiniteMap RdrName (Name, HowInScope) -emptyGlobalNameEnv = emptyFM - -data HowInScope -- Used for error messages only - = FromLocalDefn SrcLoc - | FromImportDecl Module SrcLoc - -type NameEnv = FiniteMap RdrName Name -emptyNameEnv = emptyFM - -type FixityEnv = FiniteMap RdrName (Fixity, HowInScope) -emptyFixityEnv = emptyFM - -- It's possible to have a different fixity for B.op than for op: - -- - -- module A( op ) where module B where - -- import qualified B( op ) infixr 2 op - -- infixl 9 `op` op = ... - -- op a b = a `B.op` b - -data ExportEnv = ExportEnv Avails Fixities -type Avails = [AvailInfo] -type Fixities = [(OccName, Fixity)] - -type ExportAvails = (FiniteMap Module Avails, -- Used to figure out "module M" export specifiers - -- Includes avails only from *unqualified* imports - -- (see 1.4 Report Section 5.1.1) - - UniqFM AvailInfo) -- Used to figure out all other export specifiers. - -- Maps a Name to the AvailInfo that contains it - -- NB: Contain bindings for class ops but - -- not constructors (see defn of availEntityNames) - - -data GenAvailInfo name = NotAvailable - | Avail name -- An ordinary identifier - | AvailTC name -- The name of the type or class - [name] -- The available pieces of type/class. NB: If the type or - -- class is itself to be in scope, it must be in this list. - -- Thus, typically: AvailTC Eq [Eq, ==, /=] -type AvailInfo = GenAvailInfo Name -type RdrAvailInfo = GenAvailInfo OccName +-------------------------------- +type LocalRdrEnv = RdrNameEnv Name +type LocalFixityEnv = NameEnv RenamedFixitySig + -- We keep the whole fixity sig so that we + -- can report line-number info when there is a duplicate + -- fixity declaration + +lookupLocalFixity :: LocalFixityEnv -> Name -> Fixity +lookupLocalFixity env name + = case lookupNameEnv env name of + Just (FixitySig _ fix _) -> fix + Nothing -> defaultFixity \end{code} -=================================================== - INTERFACE FILE STUFF -=================================================== - \begin{code} -type ExportItem = (Module, IfaceFlavour, [RdrAvailInfo]) -type VersionInfo name = [ImportVersion name] - -type ImportVersion name = (Module, IfaceFlavour, Version, WhatsImported name) -data WhatsImported name = Everything - | Specifically [LocalVersion name] -- List guaranteed non-empty +type ExportAvails = (FiniteMap ModuleName Avails, + -- Used to figure out "module M" export specifiers + -- Includes avails only from *unqualified* imports + -- (see 1.4 Report Section 5.1.1) - -- ("M", hif, ver, Everything) means there was a "module M" in - -- this module's export list, so we just have to go by M's version, "ver", - -- not the list of LocalVersions. + AvailEnv) -- Used to figure out all other export specifiers. +\end{code} +%=================================================== +\subsubsection{ INTERFACE FILE STUFF} +%=================================================== -type LocalVersion name = (name, Version) +\begin{code} +type ExportItem = (ModuleName, [RdrAvailInfo]) data ParsedIface - = ParsedIface - Module -- Module name - Version -- Module version number - [ImportVersion OccName] -- Usages - [ExportItem] -- Exports - [Module] -- Special instance modules - [(OccName,Fixity)] -- Fixities - [(Version, RdrNameHsDecl)] -- Local definitions - [RdrNameInstDecl] -- Local instance declarations - -type InterfaceDetails = (VersionInfo Name, -- Version information for what this module imports - ExportEnv, -- What this module exports - [Module]) -- Instance modules - -type RdrNamePragma = () -- Fudge for now -------------------- - -data Ifaces = Ifaces - Module -- Name of this module - (FiniteMap Module (IfaceFlavour, -- Exports - Version, - Avails, - [(OccName,Fixity)])) - DeclsMap - - NameSet -- All the names (whether "big" or "small", whether wired-in or not, - -- whether locally defined or not) that have been slurped in so far. - - [(Name,Version)] -- All the (a) non-wired-in (b) "big" (c) non-locally-defined names that - -- have been slurped in so far, with their versions. - -- This is used to generate the "usage" information for this module. - -- Subset of the previous field. - - (Bag IfaceInst, NameSet) -- The as-yet un-slurped instance decls; this bag is depleted when we - -- slurp an instance decl so that we don't slurp the same one twice. - -- Together with them is the set of tycons/classes that may allow - -- the instance decls in. - - (FiniteMap Name RdrNameTyDecl) - -- Deferred data type declarations; each has the following properties - -- * it's a data type decl - -- * its TyCon is needed - -- * the decl may or may not have been slurped, depending on whether any - -- of the constrs are needed. - - [Module] -- Set of modules with "special" instance declarations - -- Excludes this module - - -type DeclsMap = FiniteMap Name (Version, AvailInfo, RdrNameHsDecl) -type IfaceInst = ((Module, RdrNameInstDecl), -- Instance decl - [Name]) -- "Gate" names. Slurp this instance decl when this - -- list becomes empty. It's depleted whenever we - -- slurp another type or class decl. + = ParsedIface { + pi_mod :: Module, -- Complete with package info + pi_vers :: Version, -- Module version number + pi_orphan :: WhetherHasOrphans, -- Whether this module has orphans + pi_usages :: [ImportVersion OccName], -- Usages + pi_exports :: (Version, [ExportItem]), -- Exports + pi_insts :: [RdrNameInstDecl], -- Local instance declarations + pi_decls :: [(Version, RdrNameHsDecl)], -- Local definitions + pi_fixity :: [RdrNameFixitySig], -- Local fixity declarations, + pi_rules :: (Version, [RdrNameRuleDecl]), -- Rules, with their version + pi_deprecs :: [RdrNameDeprecation] -- Deprecations + } +\end{code} + +%************************************************************************ +%* * +\subsection{The renamer state} +%* * +%************************************************************************ + +\begin{code} +data Ifaces = Ifaces { + -- PERSISTENT FIELDS + iPIT :: PackageIfaceTable, + -- The ModuleIFaces for modules in other packages + -- whose interfaces we have opened + -- The declarations in these interface files are held in + -- iDecls, iInsts, iRules (below), not in the mi_decls fields + -- of the iPIT. What _is_ in the iPIT is: + -- * The Module + -- * Version info + -- * Its exports + -- * Fixities + -- * Deprecations + -- The iPIT field is initialised from the compiler's persistent + -- package symbol table, and the renamer incrementally adds + -- to it. + + iDecls :: DeclsMap, + -- A single, global map of Names to unslurped decls + + iInsts :: IfaceInsts, + -- The as-yet un-slurped instance decls; this bag is depleted when we + -- slurp an instance decl so that we don't slurp the same one twice. + -- Each is 'gated' by the names that must be available before + -- this instance decl is needed. + + iRules :: IfaceRules, + -- Similar to instance decls, only for rules + + -- EPHEMERAL FIELDS + -- These fields persist during the compilation of a single module only + iImpModInfo :: ImportedModuleInfo, + -- Modules this one depends on: that is, the union + -- of the modules its *direct* imports depend on. + -- NB: The direct imports have .hi files that enumerate *all* the + -- dependencies (direct or not) of the imported module. + + iSlurp :: NameSet, + -- All the names (whether "big" or "small", whether wired-in or not, + -- whether locally defined or not) that have been slurped in so far. + + iVSlurp :: [Name] + -- All the (a) non-wired-in (b) "big" (c) non-locally-defined + -- names that have been slurped in so far, with their versions. + -- This is used to generate the "usage" information for this module. + -- Subset of the previous field. + -- It's worth keeping separately, because there's no very easy + -- way to distinguish the "big" names from the "non-big" ones. + -- But this is a decision we might want to revisit. + } + +type ImportedModuleInfo = FiniteMap ModuleName + (WhetherHasOrphans, IsBootInterface, IsLoaded) +type IsLoaded = Bool \end{code} @@ -287,179 +281,180 @@ type IfaceInst = ((Module, RdrNameInstDecl), -- Instance decl %************************************************************************ \begin{code} -initRn :: Module -> UniqSupply -> SearchPath -> SrcLoc - -> RnMG r - -> IO (r, Bag ErrMsg, Bag WarnMsg) - -initRn mod us dirs loc do_rn = do - names_var <- sstToIO (newMutVarSST (us, emptyFM, builtins)) - errs_var <- sstToIO (newMutVarSST (emptyBag,emptyBag)) - iface_var <- sstToIO (newMutVarSST (emptyIfaces mod)) - occs_var <- sstToIO (newMutVarSST initOccs) - himap <- mkModuleHiMap dirs - let - rn_down = RnDown loc names_var errs_var occs_var - g_down = GDown himap iface_var - - -- do the buisness - res <- sstToIO (do_rn rn_down g_down) - - -- grab errors and return - (warns, errs) <- sstToIO (readMutVarSST errs_var) - return (res, errs, warns) - - -initRnMS :: RnEnv -> Module -> RnSMode -> RnMS RealWorld r -> RnMG r -initRnMS rn_env@(RnEnv name_env _) mod_name mode m rn_down g_down +initRn :: DynFlags + -> Finder + -> HomeIfaceTable + -> HomeSymbolTable + -> PersistentCompilerState + -> Module + -> SrcLoc + -> RnMG t + -> IO (t, (Bag WarnMsg, Bag ErrMsg), PersistentCompilerState) + +initRn dflags finder hit hst pcs mod loc do_rn + = do + let prs = pcs_PRS pcs + let pst = pcs_PST pcs + + uniqs <- mkSplitUniqSupply 'r' + names_var <- newIORef (uniqs, origNames (prsOrig prs), + origIParam (prsOrig prs)) + errs_var <- newIORef (emptyBag,emptyBag) + iface_var <- newIORef (initIfaces pcs) + let rn_down = RnDown { rn_mod = mod, + rn_loc = loc, + + rn_finder = finder, + rn_dflags = dflags, + rn_hit = hit, + rn_done = is_done hst pst, + + rn_ns = names_var, + rn_errs = errs_var, + rn_ifaces = iface_var, + } + + -- do the business + res <- do_rn rn_down () + + -- Grab state and record it + (warns, errs) <- readIORef errs_var + new_ifaces <- readIORef iface_var + (_, new_origN, new_origIP) <- readIORef names_var + let new_orig = Orig { origNames = new_origN, origIParam = new_origIP } + let new_prs = prs { prsOrig = new_orig, + prsDecls = iDecls new_ifaces, + prsInsts = iInsts new_ifaces, + prsRules = iRules new_ifaces } + let new_pcs = pcs { pcs_PIT = iPIT new_ifaces, + pcs_PRS = new_prs } + + return (res, (warns, errs), new_pcs) + +is_done :: HomeSymbolTable -> PackageSymbolTable -> Name -> Bool +-- Returns True iff the name is in either symbol table +is_done hst pst n = maybeToBool (lookupTypeEnv pst n `seqMaybe` lookupTypeEnv hst n) + +lookupIface :: HomeIfaceTable -> PackageIfaceTable -> ModuleName -> ModIface +lookupIface hit pit mod = lookupModuleEnvByName hit mod `orElse` + lookupModuleEnvByName pit mod `orElse` + pprPanic "lookupIface" (ppr mod) + +initIfaces :: PersistentCompilerState -> Ifaces +initIfaces (PCS { pcs_PIT = pit, pcs_PRS = prs }) + = Ifaces { iPIT = pit, + iDecls = prsDecls prs, + iInsts = prsInsts prs, + iRules = prsRules prs, + + iImpModInfo = emptyFM, + iSlurp = unitNameSet (mkUnboundName dummyRdrVarName), + -- Pretend that the dummy unbound name has already been + -- slurped. This is what's returned for an out-of-scope name, + -- and we don't want thereby to try to suck it in! + iVSlurp = [] + } + + +initRnMS :: GlobalRdrEnv -> LocalFixityEnv -> RnMode -> RnMS r -> RnM d r +initRnMS rn_env fixity_env mode thing_inside rn_down g_down = let - s_down = SDown rn_env emptyNameEnv mod_name mode + s_down = SDown { rn_genv = rn_env, rn_lenv = emptyRdrEnv, + rn_fixenv = fixity_env, rn_mode = mode } in - m rn_down s_down - + thing_inside rn_down s_down -emptyIfaces :: Module -> Ifaces -emptyIfaces mod = Ifaces mod emptyFM emptyFM emptyNameSet [] (emptyBag, emptyNameSet) emptyFM [] +initIfaceRnMS :: Module -> RnMS r -> RnM d r +initIfaceRnMS mod thing_inside + = initRnMS emptyRdrEnv emptyNameEnv InterfaceMode $ + setModuleRn mod thing_inside -builtins :: FiniteMap (Module,OccName) Name -builtins = bagToFM (mapBag (\ name -> (modAndOcc name, name)) builtinNames) - - -- Initial value for the occurrence pool. -initOccs :: ([Occurrence],[Occurrence]) -- Compulsory and optional respectively -initOccs = ([(getName boolTyCon, noSrcLoc)], []) - -- Booleans occur implicitly a lot, so it's tiresome to keep recording the fact, and - -- rather implausible that not one will be used in the module. - -- We could add some other common types, notably lists, but the general idea is - -- to do as much as possible explicitly. -\end{code} - -\begin{code} -mkModuleHiMap :: SearchPath -> IO ModuleHiMap -mkModuleHiMap dirs = do - lss <- mapM (uncurry getAllFilesMatching) dirs - let ls = concat lss - if opt_WarnHiShadows - then return (addListToFM_C conflict env ls) - else return (addListToFM_C (\ old new -> old) env ls) - where - env = emptyFM - - conflict old_path new_path - | old_path /= new_path = - pprTrace "Warning: " (text "Identically named interface files present on import path, " $$ - text (show old_path) <+> text "shadows" $$ - text (show new_path) $$ - text "on the import path: " <+> - text (concat (intersperse ":" (map fst dirs)))) - old_path - | otherwise = old_path -- don't warn about innocous shadowings. - -getAllFilesMatching :: FilePath -> String -> IO [(String, FilePath)] -getAllFilesMatching dir_path suffix = do - fpaths <- getDirectoryContents dir_path - -- fpaths entries do not have dir_path prepended - return (mapMaybe withSuffix fpaths) - where - xiffus = reverse dotted_suffix - - dotted_suffix = - case suffix of - [] -> [] - ('.':xs) -> suffix - ls -> '.':ls - - -- filter out files that have the desired suffix - withSuffix nm = go "" xiffus rev_nm `seqMaybe` - go "b" "toob-ih." rev_nm - where - rev_nm = reverse nm - - -- the prefix is needed to distinguish between a .hi-boot - -- file and a normal interface file, i.e., I'm not willing - -- to guarantee that the presence of the SOURCE pragma - -- - -- import {-# SOURCE #-} Foo (x) - -- import Bar - -- - -- will not cause Foo.hi to somehow be looked at when - -- slurping in Bar. - -- - go pre [] xs = Just (pre ++ reverse xs, dir_path ++'/':nm) - go _ _ [] = Nothing - go pre (x:xs) (y:ys) - | x == y = go pre xs ys - | otherwise = Nothing \end{code} +@renameSourceCode@ is used to rename stuff ``out-of-line''; +that is, not as part of the main renamer. +Sole examples: derived definitions, +which are only generated in the type checker. -@renameSourceCode@ is used to rename stuff "out-of-line"; that is, not as part of -the main renamer. Examples: pragmas (which we don't want to rename unless -we actually explore them); and derived definitions, which are only generated -in the type checker. - -The @RnNameSupply@ includes a @UniqueSupply@, so if you call it more than +The @NameSupply@ includes a @UniqueSupply@, so if you call it more than once you must either split it, or install a fresh unique supply. \begin{code} -renameSourceCode :: Module - -> RnNameSupply - -> RnMS RealWorld r +renameSourceCode :: DynFlags + -> Module + -> PersistentRenamerState + -> RnMS r -> r --- Alas, we can't use the real runST, with the desired signature: --- renameSourceCode :: RnNameSupply -> RnMS s r -> r --- because we can't manufacture "new versions of runST". +renameSourceCode dflags mod prs m + = unsafePerformIO ( + -- It's not really unsafe! When renaming source code we + -- only do any I/O if we need to read in a fixity declaration; + -- and that doesn't happen in pragmas etc -renameSourceCode mod_name name_supply m - = runSST ( - newMutVarSST name_supply `thenSST` \ names_var -> - newMutVarSST (emptyBag,emptyBag) `thenSST` \ errs_var -> - newMutVarSST ([],[]) `thenSST` \ occs_var -> + mkSplitUniqSupply 'r' >>= \ new_us -> + newIORef (new_us, origNames (prsOrig prs), + origIParam (prsOrig prs)) >>= \ names_var -> + newIORef (emptyBag,emptyBag) >>= \ errs_var -> let - rn_down = RnDown mkGeneratedSrcLoc names_var errs_var occs_var - s_down = SDown emptyRnEnv emptyNameEnv mod_name (InterfaceMode Compulsory (\_ -> False)) + rn_down = RnDown { rn_dflags = dflags, + rn_loc = generatedSrcLoc, rn_ns = names_var, + rn_errs = errs_var, + rn_mod = mod, + rn_done = bogus "rn_done", rn_hit = bogus "rn_hit", + rn_ifaces = bogus "rn_ifaces", rn_finder = bogus "rn_finder" + } + s_down = SDown { rn_mode = InterfaceMode, + -- So that we can refer to PrelBase.True etc + rn_genv = emptyRdrEnv, rn_lenv = emptyRdrEnv, + rn_fixenv = emptyNameEnv } in - m rn_down s_down `thenSST` \ result -> + m rn_down s_down >>= \ result -> - readMutVarSST errs_var `thenSST` \ (warns,errs) -> + readIORef errs_var >>= \ (warns,errs) -> (if not (isEmptyBag errs) then pprTrace "Urk! renameSourceCode found errors" (display errs) #ifdef DEBUG else if not (isEmptyBag warns) then - pprTrace "Urk! renameSourceCode found warnings" (display warns) + pprTrace "Note: renameSourceCode found warnings" (display warns) #endif else id) $ - returnSST result + return result ) where display errs = pprBagOfErrors errs +bogus s = panic ("rnameSourceCode: " ++ s) -- Used for unused record fields + {-# INLINE thenRn #-} {-# INLINE thenRn_ #-} {-# INLINE returnRn #-} {-# INLINE andRn #-} -returnRn :: a -> RnM s d a -thenRn :: RnM s d a -> (a -> RnM s d b) -> RnM s d b -thenRn_ :: RnM s d a -> RnM s d b -> RnM s d b -andRn :: (a -> a -> a) -> RnM s d a -> RnM s d a -> RnM s d a -mapRn :: (a -> RnM s d b) -> [a] -> RnM s d [b] -mapMaybeRn :: (a -> RnM s d b) -> b -> Maybe a -> RnM s d b -sequenceRn :: [RnM s d a] -> RnM s d [a] -foldlRn :: (b -> a -> RnM s d b) -> b -> [a] -> RnM s d b -mapAndUnzipRn :: (a -> RnM s d (b,c)) -> [a] -> RnM s d ([b],[c]) -fixRn :: (a -> RnM s d a) -> RnM s d a - -returnRn v gdown ldown = returnSST v -thenRn m k gdown ldown = m gdown ldown `thenSST` \ r -> k r gdown ldown -thenRn_ m k gdown ldown = m gdown ldown `thenSST_` k gdown ldown -fixRn m gdown ldown = fixSST (\r -> m r gdown ldown) +returnRn :: a -> RnM d a +thenRn :: RnM d a -> (a -> RnM d b) -> RnM d b +thenRn_ :: RnM d a -> RnM d b -> RnM d b +andRn :: (a -> a -> a) -> RnM d a -> RnM d a -> RnM d a +mapRn :: (a -> RnM d b) -> [a] -> RnM d [b] +mapRn_ :: (a -> RnM d b) -> [a] -> RnM d () +mapMaybeRn :: (a -> RnM d (Maybe b)) -> [a] -> RnM d [b] +flatMapRn :: (a -> RnM d [b]) -> [a] -> RnM d [b] +sequenceRn :: [RnM d a] -> RnM d [a] +foldlRn :: (b -> a -> RnM d b) -> b -> [a] -> RnM d b +mapAndUnzipRn :: (a -> RnM d (b,c)) -> [a] -> RnM d ([b],[c]) +fixRn :: (a -> RnM d a) -> RnM d a + +returnRn v gdown ldown = return v +thenRn m k gdown ldown = m gdown ldown >>= \ r -> k r gdown ldown +thenRn_ m k gdown ldown = m gdown ldown >> k gdown ldown +fixRn m gdown ldown = fixIO (\r -> m r gdown ldown) andRn combiner m1 m2 gdown ldown - = m1 gdown ldown `thenSST` \ res1 -> - m2 gdown ldown `thenSST` \ res2 -> - returnSST (combiner res1 res2) + = m1 gdown ldown >>= \ res1 -> + m2 gdown ldown >>= \ res2 -> + return (combiner res1 res2) sequenceRn [] = returnRn [] sequenceRn (m:ms) = m `thenRn` \ r -> @@ -472,6 +467,11 @@ mapRn f (x:xs) mapRn f xs `thenRn` \ rs -> returnRn (r:rs) +mapRn_ f [] = returnRn () +mapRn_ f (x:xs) = + f x `thenRn_` + mapRn_ f xs + foldlRn k z [] = returnRn z foldlRn k z (x:xs) = k z x `thenRn` \ z' -> foldlRn k z' xs @@ -488,8 +488,17 @@ mapAndUnzip3Rn f (x:xs) mapAndUnzip3Rn f xs `thenRn` \ (rs1, rs2, rs3) -> returnRn (r1:rs1, r2:rs2, r3:rs3) -mapMaybeRn f def Nothing = returnRn def -mapMaybeRn f def (Just v) = f v +mapMaybeRn f [] = returnRn [] +mapMaybeRn f (x:xs) = f x `thenRn` \ maybe_r -> + mapMaybeRn f xs `thenRn` \ rs -> + case maybe_r of + Nothing -> returnRn rs + Just r -> returnRn (r:rs) + +flatMapRn f [] = returnRn [] +flatMapRn f (x:xs) = f x `thenRn` \ r -> + flatMapRn f xs `thenRn` \ rs -> + returnRn (r ++ rs) \end{code} @@ -501,187 +510,120 @@ mapMaybeRn f def (Just v) = f v %************************************************************************ -================ Errors and warnings ===================== +%================ +\subsubsection{ Errors and warnings} +%===================== \begin{code} -failWithRn :: a -> ErrMsg -> RnM s d a -failWithRn res msg (RnDown loc names_var errs_var occs_var) l_down - = readMutVarSST errs_var `thenSST` \ (warns,errs) -> - writeMutVarSST errs_var (warns, errs `snocBag` err) `thenSST_` - returnSST res +failWithRn :: a -> Message -> RnM d a +failWithRn res msg (RnDown {rn_errs = errs_var, rn_loc = loc}) l_down + = readIORef errs_var >>= \ (warns,errs) -> + writeIORef errs_var (warns, errs `snocBag` err) >> + return res where err = addShortErrLocLine loc msg -warnWithRn :: a -> WarnMsg -> RnM s d a -warnWithRn res msg (RnDown loc names_var errs_var occs_var) l_down - = readMutVarSST errs_var `thenSST` \ (warns,errs) -> - writeMutVarSST errs_var (warns `snocBag` warn, errs) `thenSST_` - returnSST res +warnWithRn :: a -> Message -> RnM d a +warnWithRn res msg (RnDown {rn_errs = errs_var, rn_loc = loc}) l_down + = readIORef errs_var >>= \ (warns,errs) -> + writeIORef errs_var (warns `snocBag` warn, errs) >> + return res where warn = addShortWarnLocLine loc msg -addErrRn :: ErrMsg -> RnM s d () +addErrRn :: Message -> RnM d () addErrRn err = failWithRn () err -checkRn :: Bool -> ErrMsg -> RnM s d () -- Check that a condition is true -checkRn False err = addErrRn err -checkRn True err = returnRn () - -addWarnRn :: WarnMsg -> RnM s d () -addWarnRn warn = warnWithRn () warn +checkRn :: Bool -> Message -> RnM d () -- Check that a condition is true +checkRn False err = addErrRn err +checkRn True err = returnRn () -checkErrsRn :: RnM s d Bool -- True <=> no errors so far -checkErrsRn (RnDown loc names_var errs_var occs_var) l_down - = readMutVarSST errs_var `thenSST` \ (warns,errs) -> - returnSST (isEmptyBag errs) -\end{code} +warnCheckRn :: Bool -> Message -> RnM d () -- Check that a condition is true +warnCheckRn False err = addWarnRn err +warnCheckRn True err = returnRn () +addWarnRn :: Message -> RnM d () +addWarnRn warn = warnWithRn () warn -================ Source location ===================== +checkErrsRn :: RnM d Bool -- True <=> no errors so far +checkErrsRn (RnDown {rn_errs = errs_var}) l_down + = readIORef errs_var >>= \ (warns,errs) -> + return (isEmptyBag errs) -\begin{code} -pushSrcLocRn :: SrcLoc -> RnM s d a -> RnM s d a -pushSrcLocRn loc' m (RnDown loc names_var errs_var occs_var) l_down - = m (RnDown loc' names_var errs_var occs_var) l_down +doptRn :: DynFlag -> RnM d Bool +doptRn dflag (RnDown { rn_dflags = dflags}) l_down + = return (dopt dflag dflags) -getSrcLocRn :: RnM s d SrcLoc -getSrcLocRn (RnDown loc names_var errs_var occs_var) l_down - = returnSST loc +getDOptsRn :: RnM d DynFlags +getDOptsRn (RnDown { rn_dflags = dflags}) l_down + = return dflags \end{code} -================ Name supply ===================== + +%================ +\subsubsection{Source location} +%===================== \begin{code} -getNameSupplyRn :: RnM s d (GenRnNameSupply s) -getNameSupplyRn (RnDown loc names_var errs_var occs_var) l_down - = readMutVarSST names_var - -setNameSupplyRn :: GenRnNameSupply s -> RnM s d () -setNameSupplyRn names' (RnDown loc names_var errs_var occs_var) l_down - = writeMutVarSST names_var names' - --- The "instance-decl unique supply", inst, is really a map from class names --- to unique supplies. Having per-class unique numbers for instance decls helps --- the recompilation checker. -newInstUniq :: FAST_STRING -> RnM s d Int -newInstUniq cname (RnDown loc names_var errs_var occs_var) l_down - = readMutVarSST names_var `thenSST` \ (us, mapInst, cache) -> - case lookupFM mapInst cname of - Just class_us -> - readMutVarSST class_us `thenSST` \ v -> - writeMutVarSST class_us (v+1) `thenSST_` - returnSST v - Nothing -> -- first time caller gets to add a unique supply - -- to the finite map for that class. - newMutVarSST 1 `thenSST` \ class_us -> - let - mapInst' = addToFM mapInst cname class_us - in - writeMutVarSST names_var (us, mapInst', cache) `thenSST_` - returnSST 0 +pushSrcLocRn :: SrcLoc -> RnM d a -> RnM d a +pushSrcLocRn loc' m down l_down + = m (down {rn_loc = loc'}) l_down +getSrcLocRn :: RnM d SrcLoc +getSrcLocRn down l_down + = return (rn_loc down) \end{code} -================ Occurrences ===================== - -Every time we get an occurrence of a name we put it in one of two lists: - one for "compulsory" occurrences - one for "optional" occurrences +%================ +\subsubsection{The finder and home symbol table} +%===================== -The significance of "compulsory" is - (a) we *must* find the declaration - (b) in the case of type or class names, the name is part of the - source level program, and we must slurp in any instance decls - involving it. +\begin{code} +getFinderRn :: RnM d Finder +getFinderRn down l_down = return (rn_finder down) -We don't need instance decls "optional" names, because the type inference -process will never come across them. Optional names are buried inside -type checked (but not renamed) cross-module unfoldings and such. +getHomeIfaceTableRn :: RnM d HomeIfaceTable +getHomeIfaceTableRn down l_down = return (rn_hit down) -The pair of lists is held in a mutable variable in RnDown. +checkAlreadyAvailable :: Name -> RnM d Bool +checkAlreadyAvailable name down l_down = return (rn_done down name) +\end{code} -The lists are kept separate so that we can process all the compulsory occurrences -before any of the optional ones. Why? Because suppose we processed an optional -"g", and slurped an interface decl of g::T->T. Then we'd rename the type T->T in -optional mode. But if we later need g compulsorily we'll find that it's already -been slurped and will do nothing. We could, I suppose, rename it a second time, -but it seems simpler just to do all the compulsory ones first. +%================ +\subsubsection{Name supply} +%===================== \begin{code} -addOccurrenceName :: Name -> RnMS s Name -- Same name returned as passed -addOccurrenceName name (RnDown loc names_var errs_var occs_var) - (SDown rn_env local_env mod_name mode) - | isLocallyDefinedName name || - not_necessary necessity - = returnSST name - - | otherwise - = readMutVarSST occs_var `thenSST` \ (comp_occs, opt_occs) -> - let - new_occ_pair = case necessity of - Optional -> (comp_occs, (name,loc):opt_occs) - Compulsory -> ((name,loc):comp_occs, opt_occs) - in - writeMutVarSST occs_var new_occ_pair `thenSST_` - returnSST name - where - necessity = modeToNecessity mode +getNameSupplyRn :: RnM d (UniqSupply, OrigNameNameEnv, OrigNameIParamEnv) +getNameSupplyRn rn_down l_down + = readIORef (rn_ns rn_down) + +setNameSupplyRn :: (UniqSupply, OrigNameNameEnv, OrigNameIParamEnv) -> RnM d () +setNameSupplyRn names' (RnDown {rn_ns = names_var}) l_down + = writeIORef names_var names' + +getUniqRn :: RnM d Unique +getUniqRn (RnDown {rn_ns = names_var}) l_down + = readIORef names_var >>= \ (us, cache, ipcache) -> + let + (us1,us') = splitUniqSupply us + in + writeIORef names_var (us', cache, ipcache) >> + return (uniqFromSupply us1) +\end{code} +%================ +\subsubsection{ Module} +%===================== -addOccurrenceNames :: [Name] -> RnMS s () -addOccurrenceNames names (RnDown loc names_var errs_var occs_var) - (SDown rn_env local_env mod_name mode) - | not_necessary necessity - = returnSST () +\begin{code} +getModuleRn :: RnM d Module +getModuleRn (RnDown {rn_mod = mod}) l_down + = return mod - | otherwise - = readMutVarSST occs_var `thenSST` \ (comp_occs, opt_occs) -> - let - new_occ_pair = case necessity of - Optional -> (comp_occs, non_local_occs ++ opt_occs) - Compulsory -> (non_local_occs ++ comp_occs, opt_occs) - in - writeMutVarSST occs_var new_occ_pair - where - non_local_occs = [(name, loc) | name <- names, not (isLocallyDefinedName name)] - necessity = modeToNecessity mode - - -- Never look for optional things if we're - -- ignoring optional input interface information -not_necessary Compulsory = False -not_necessary Optional = opt_IgnoreIfacePragmas - -popOccurrenceName :: RnSMode -> RnM s d (Maybe Occurrence) -popOccurrenceName mode (RnDown loc names_var errs_var occs_var) l_down - = readMutVarSST occs_var `thenSST` \ occs -> - case (mode, occs) of - -- Find a compulsory occurrence - (InterfaceMode Compulsory _, (comp:comps, opts)) - -> writeMutVarSST occs_var (comps, opts) `thenSST_` - returnSST (Just comp) - - -- Find an optional occurrence - -- We shouldn't be looking unless we've done all the compulsories - (InterfaceMode Optional _, (comps, opt:opts)) - -> ASSERT( null comps ) - writeMutVarSST occs_var (comps, opts) `thenSST_` - returnSST (Just opt) - - -- No suitable occurrence - other -> returnSST Nothing - --- findOccurrencesRn does the enclosed thing with a *fresh* occurrences --- variable, and returns the list of occurrences thus found. It's useful --- when loading instance decls and specialisation signatures, when we want to --- know the names of the things in the types, but we don't want to treat them --- as occurrences. - -findOccurrencesRn :: RnM s d a -> RnM s d [Name] -findOccurrencesRn enclosed_thing (RnDown loc names_var errs_var occs_var) l_down - = newMutVarSST ([],[]) `thenSST` \ new_occs_var -> - enclosed_thing (RnDown loc names_var errs_var new_occs_var) l_down `thenSST_` - readMutVarSST new_occs_var `thenSST` \ (occs,_) -> - returnSST (map fst occs) +setModuleRn :: Module -> RnM d a -> RnM d a +setModuleRn new_mod enclosed_thing rn_down l_down + = enclosed_thing (rn_down {rn_mod = new_mod}) l_down \end{code} @@ -691,103 +633,63 @@ findOccurrencesRn enclosed_thing (RnDown loc names_var errs_var occs_var) l_down %* * %************************************************************************ -================ RnEnv ===================== +%================ +\subsubsection{ RnEnv} +%===================== \begin{code} --- Look in global env only -lookupGlobalNameRn :: RdrName -> RnMS s (Maybe Name) -lookupGlobalNameRn rdr_name rn_down (SDown (RnEnv global_env fixity_env) local_env mod_name mode) - = case lookupFM global_env rdr_name of - Just (name, _) -> returnSST (Just name) - Nothing -> returnSST Nothing - --- Look in both local and global env -lookupNameRn :: RdrName -> RnMS s (Maybe Name) -lookupNameRn rdr_name rn_down (SDown (RnEnv global_env fixity_env) local_env mod_name mode) - = case lookupFM local_env rdr_name of - Just name -> returnSST (Just name) - Nothing -> case lookupFM global_env rdr_name of - Just (name, _) -> returnSST (Just name) - Nothing -> returnSST Nothing - -getNameEnvs :: RnMS s (GlobalNameEnv, NameEnv) -getNameEnvs rn_down (SDown (RnEnv global_env fixity_env) local_env mod_name mode) - = returnSST (global_env, local_env) - -getLocalNameEnv :: RnMS s NameEnv -getLocalNameEnv rn_down (SDown rn_env local_env mod_name mode) - = returnSST local_env - -setLocalNameEnv :: NameEnv -> RnMS s a -> RnMS s a -setLocalNameEnv local_env' m rn_down (SDown rn_env local_env mod_name mode) - = m rn_down (SDown rn_env local_env' mod_name mode) - -getFixityEnv :: RnMS s FixityEnv -getFixityEnv rn_down (SDown (RnEnv name_env fixity_env) local_env mod_name mode) - = returnSST fixity_env -\end{code} +getLocalNameEnv :: RnMS LocalRdrEnv +getLocalNameEnv rn_down (SDown {rn_lenv = local_env}) + = return local_env -================ Module and Mode ===================== +getGlobalNameEnv :: RnMS GlobalRdrEnv +getGlobalNameEnv rn_down (SDown {rn_genv = global_env}) + = return global_env -\begin{code} -getModuleRn :: RnMS s Module -getModuleRn rn_down (SDown rn_env local_env mod_name mode) - = returnSST mod_name -\end{code} +setLocalNameEnv :: LocalRdrEnv -> RnMS a -> RnMS a +setLocalNameEnv local_env' m rn_down l_down + = m rn_down (l_down {rn_lenv = local_env'}) -\begin{code} -getModeRn :: RnMS s RnSMode -getModeRn rn_down (SDown rn_env local_env mod_name mode) - = returnSST mode +getFixityEnv :: RnMS LocalFixityEnv +getFixityEnv rn_down (SDown {rn_fixenv = fixity_env}) + = return fixity_env -setModeRn :: RnSMode -> RnMS s a -> RnMS s a -setModeRn new_mode thing_inside rn_down (SDown rn_env local_env mod_name mode) - = thing_inside rn_down (SDown rn_env local_env mod_name new_mode) +extendFixityEnv :: [(Name, RenamedFixitySig)] -> RnMS a -> RnMS a +extendFixityEnv fixes enclosed_scope + rn_down l_down@(SDown {rn_fixenv = fixity_env}) + = let + new_fixity_env = extendNameEnvList fixity_env fixes + in + enclosed_scope rn_down (l_down {rn_fixenv = new_fixity_env}) \end{code} - -%************************************************************************ -%* * -\subsection{Plumbing for rename-globals part} -%* * -%************************************************************************ +%================ +\subsubsection{ Mode} +%===================== \begin{code} -getIfacesRn :: RnMG Ifaces -getIfacesRn rn_down (GDown dirs iface_var) - = readMutVarSST iface_var - -setIfacesRn :: Ifaces -> RnMG () -setIfacesRn ifaces rn_down (GDown dirs iface_var) - = writeMutVarSST iface_var ifaces - -{- -getSearchPathRn :: RnMG SearchPath -getSearchPathRn rn_down (GDown dirs iface_var) - = returnSST dirs --} - -getModuleHiMap :: RnMG ModuleHiMap -getModuleHiMap rn_down (GDown himap iface_var) - = returnSST himap +getModeRn :: RnMS RnMode +getModeRn rn_down (SDown {rn_mode = mode}) + = return mode +setModeRn :: RnMode -> RnMS a -> RnMS a +setModeRn new_mode thing_inside rn_down l_down + = thing_inside rn_down (l_down {rn_mode = new_mode}) \end{code} + %************************************************************************ %* * -\subsection{HowInScope} +\subsection{Plumbing for rename-globals part} %* * %************************************************************************ \begin{code} -instance Outputable HowInScope where - ppr (FromLocalDefn loc) = ptext SLIT("Defined at") <+> ppr loc - ppr (FromImportDecl mod loc) = ptext SLIT("Imported from") <+> quotes (pprModule mod) <+> - ptext SLIT("at") <+> ppr loc -\end{code} +getIfacesRn :: RnM d Ifaces +getIfacesRn (RnDown {rn_ifaces = iface_var}) _ + = readIORef iface_var - -\begin{code} -modeToNecessity SourceMode = Compulsory -modeToNecessity (InterfaceMode necessity _) = necessity +setIfacesRn :: Ifaces -> RnM d () +setIfacesRn ifaces (RnDown {rn_ifaces = iface_var}) _ + = writeIORef iface_var ifaces \end{code}