[project @ 2003-02-04 12:33:05 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcEnv.lhs
index 23eba50..edec045 100644 (file)
@@ -33,11 +33,9 @@ module TcEnv(
        -- Global type variables
        tcGetGlobalTyVars,
 
-       -- Random useful things
-       RecTcGblEnv, tcLookupRecId_maybe, 
-
        -- Template Haskell stuff
-       wellStaged, spliceOK, bracketOK, tcMetaTy, metaLevel,
+       checkWellStaged, spliceOK, bracketOK, tcMetaTy, metaLevel, 
+       topIdLvl, 
 
        -- New Ids
        newLocalName, newDFunName,
@@ -72,7 +70,7 @@ import Name           ( Name, NamedThing(..),
                        )
 import NameEnv
 import OccName         ( mkDFunOcc, occNameString )
-import HscTypes                ( DFunId, TypeEnv, extendTypeEnvList, 
+import HscTypes                ( DFunId, TypeEnv, extendTypeEnvList, lookupType,
                          TyThing(..), ExternalPackageState(..) )
 import Rules           ( RuleBase )
 import BasicTypes      ( EP )
@@ -104,11 +102,41 @@ metaLevel Comp            = topLevel
 metaLevel (Splice l)    = l
 metaLevel (Brack l _ _) = l
 
-wellStaged :: Level    -- Binding level
-          -> Level     -- Use level
-          -> Bool
-wellStaged bind_stage use_stage 
-  = bind_stage <= use_stage
+
+checkWellStaged :: SDoc                -- What the stage check is for
+               -> Level        -- Binding level
+               -> Stage        -- Use stage
+               -> TcM ()       -- Fail if badly staged, adding an error
+checkWellStaged pp_thing bind_lvl use_stage
+  | bind_lvl <= use_lvl        -- OK!
+  = returnM () 
+
+  | bind_lvl == topLevel       -- GHC restriction on top level splices
+  = failWithTc $ 
+    sep [ptext SLIT("GHC stage restriction:") <+>  pp_thing,
+        nest 2 (ptext SLIT("is used in a top-level splice, and must be imported, not defined locally"))]
+
+  | otherwise                  -- Badly staged
+  = failWithTc $ 
+    ptext SLIT("Stage error:") <+> pp_thing <+> 
+       hsep   [ptext SLIT("is bound at stage") <+> ppr bind_lvl,
+               ptext SLIT("but used at stage") <+> ppr use_lvl]
+  where
+    use_lvl = metaLevel use_stage
+
+
+topIdLvl :: Id -> Level
+-- Globals may either be imported, or may be from an earlier "chunk" 
+-- (separated by declaration splices) of this module.  The former
+-- *can* be used inside a top-level splice, but the latter cannot.
+-- Hence we give the former impLevel, but the latter topLevel
+-- E.g. this is bad:
+--     x = [| foo |]
+--     $( f x )
+-- By the time we are prcessing the $(f x), the binding for "x" 
+-- will be in the global env, not the local one.
+topIdLvl id | isLocalId id = topLevel
+           | otherwise    = impLevel
 
 -- Indicates the legal transitions on bracket( [| |] ).
 bracketOK :: Stage -> Maybe Level
@@ -151,24 +179,6 @@ data TyThingDetails = SynTyDetails  Type
 
 %************************************************************************
 %*                                                                     *
-\subsection{Basic lookups}
-%*                                                                     *
-%************************************************************************
-
-\begin{code}
-type RecTcGblEnv = TcGblEnv
--- This environment is used for getting the 'right' IdInfo 
--- on imported things and for looking up Ids in unfoldings
--- The environment doesn't have any local Ids in it
-
-tcLookupRecId_maybe :: RecTcGblEnv -> Name -> Maybe Id
-tcLookupRecId_maybe env name = case lookup_global env name of
-                                  Just (AnId id) -> Just id
-                                  other          -> Nothing
-\end{code}
-
-%************************************************************************
-%*                                                                     *
 \subsection{Making new Ids}
 %*                                                                     *
 %************************************************************************
@@ -182,9 +192,11 @@ newLocalName name  -- Make a clone
     returnM (mkInternalName uniq (getOccName name) (getSrcLoc name))
 \end{code}
 
-Make a name for the dict fun for an instance decl.
-It's a *local* name for the moment.  The CoreTidy pass
-will externalise it.
+Make a name for the dict fun for an instance decl.  It's a *local*
+name for the moment.  The CoreTidy pass will externalise it.  Even in
+--make and ghci stuff, we rebuild the instance environment each time,
+so the dfun id is internal to begin with, and external when compiling
+other modules
 
 \begin{code}
 newDFunName :: Class -> [Type] -> SrcLoc -> TcM Name
@@ -222,9 +234,8 @@ tcExtendGlobalEnv things thing_inside
              (lcl_things, pkg_things) = partition (isLocalThing mod) things
              ge'  = extendTypeEnvList (tcg_type_env env) lcl_things
              eps' = eps { eps_PTE = extendTypeEnvList (eps_PTE eps) pkg_things }
-             ist' = mkImpTypeEnv eps' hpt
        ; setEps eps'
-       ; setGblEnv (env {tcg_type_env = ge', tcg_ist = ist'}) thing_inside }
+       ; setGblEnv (env {tcg_type_env = ge'}) thing_inside }
 
 tcExtendGlobalValEnv :: [Id] -> TcM a -> TcM a
   -- Same deal as tcExtendGlobalEnv, but for Ids
@@ -242,17 +253,22 @@ tcExtendGlobalTypeEnv extra_env thing_inside
 
 
 \begin{code}
-lookup_global :: TcGblEnv -> Name -> Maybe TyThing
-       -- Try the global envt and then the global symbol table
-lookup_global env name 
-  = lookupNameEnv (tcg_type_env env) name 
-       `seqMaybe`
-    tcg_ist env name
-
 tcLookupGlobal_maybe :: Name -> TcRn m (Maybe TyThing)
+-- This is a rather heavily-used function, so I've inlined a few things        (e.g. getEps)
+-- Notice that for imported things we read the current version from the EPS
+-- mutable variable.  This is important in situations like
+--     ...$(e1)...$(e2)...
+-- where the code that e1 expands to might import some defns that 
+-- also turn out to be needed by the code that e2 expands to.
 tcLookupGlobal_maybe name
-  = getGblEnv          `thenM` \ env ->
-    returnM (lookup_global env name)
+  = do { env <- getGblEnv
+       ; if nameIsLocalOrFrom (tcg_mod env) name then
+               -- Defined in this module
+             return (lookupNameEnv (tcg_type_env env) name)
+        else 
+        do { env <- getTopEnv
+           ; eps <- readMutVar (top_eps env)
+           ; return (lookupType (top_hpt env) (eps_PTE eps) name) }}
 \end{code}
 
 A variety of global lookups, when we know what we are looking for.
@@ -295,8 +311,15 @@ tcLookupTyCon name
 
 
 getInGlobalScope :: TcRn m (Name -> Bool)
-getInGlobalScope = do { gbl_env <- getGblEnv ;
-                       return (\n -> isJust (lookup_global gbl_env n)) }
+-- Get all things in the global environment; used for deciding what 
+-- rules to suck in.  Anything defined in this module (nameIsLocalOrFrom)
+-- is certainly in the envt, so we don't bother to look.
+getInGlobalScope 
+  = do { mod <- getModule
+       ; eps <- getEps
+       ; hpt <- getHpt
+       ; return (\n -> nameIsLocalOrFrom mod n || 
+                      isJust (lookupType hpt (eps_PTE eps) n)) }
 \end{code}
 
 
@@ -339,22 +362,9 @@ tcLookupIdLvl name
   = tcLookup name      `thenM` \ thing -> 
     case thing of
        ATcId tc_id lvl   -> returnM (tc_id, lvl)
-       AGlobal (AnId id)       -- See [Note: Levels]
-         | isLocalId id  -> returnM (id, topLevel)
-         | otherwise     -> returnM (id, impLevel)
+       AGlobal (AnId id) -> returnM (id, topIdLvl id)
        other             -> pprPanic "tcLookupIdLvl" (ppr name)
 
---             [Note: Levels]
--- Globals may either be imported, or may be from an earlier "chunk" 
--- (separated by declaration splices) of this module.  The former
--- *can* be used inside a top-level splice, but the latter cannot.
--- Hence we give the former impLevel, but the latter topLevel
--- E.g. this is bad:
---     x = [| foo |]
---     $( f x )
--- By the time we are prcessing the $(f x), the binding for "x" 
--- will be in the global env, not the local one.
-
 tcLookupLocalIds :: [Name] -> TcM [TcId]
 -- We expect the variables to all be bound, and all at
 -- the same level as the lookup.  Only used in one place...
@@ -531,15 +541,31 @@ tcGetGlobalTyVars
 %*                                                                     *
 %************************************************************************
 
+The TcGblEnv holds a mutable variable containing the current full, instance environment.
+The ExtendInstEnv functions extend this environment by side effect, in case we are
+sucking in new instance declarations deep in the body of a TH splice, which are needed
+in another TH splice.  The tcg_insts field of the TcGblEnv contains just the dfuns
+from this module
+
 \begin{code}
 tcGetInstEnv :: TcM InstEnv
 tcGetInstEnv = getGblEnv       `thenM` \ env -> 
-              returnM (tcg_inst_env env)
+              readMutVar (tcg_inst_env env)
 
 tcSetInstEnv :: InstEnv -> TcM a -> TcM a
+-- Horribly imperative; 
+-- but used only when temporarily enhancing the instance
+-- envt during 'deriving' context inference
 tcSetInstEnv ie thing_inside
   = getGblEnv  `thenM` \ env ->
-    setGblEnv (env {tcg_inst_env = ie}) thing_inside
+    let 
+       ie_var = tcg_inst_env env
+    in
+    readMutVar  ie_var         `thenM` \ old_ie ->
+    writeMutVar ie_var ie      `thenM_`
+    thing_inside               `thenM` \ result ->
+    writeMutVar ie_var old_ie  `thenM_`    
+    returnM result
 
 tcExtendInstEnv :: [DFunId] -> TcM a -> TcM a
        -- Add instances from local or imported
@@ -548,9 +574,11 @@ tcExtendInstEnv dfuns thing_inside
  = do { dflags <- getDOpts
       ; eps <- getEps
       ; env <- getGblEnv
+      ; let ie_var = tcg_inst_env env
+      ; inst_env <- readMutVar ie_var
       ; let
          -- Extend the total inst-env with the new dfuns
-         (inst_env', errs) = extendInstEnv dflags (tcg_inst_env env) dfuns
+         (inst_env', errs) = extendInstEnv dflags inst_env dfuns
   
          -- Sort the ones from this module from the others
          (lcl_dfuns, pkg_dfuns) = partition (isLocalThing mod) dfuns
@@ -560,11 +588,11 @@ tcExtendInstEnv dfuns thing_inside
                  (eps_inst_env', _) = extendInstEnv dflags (eps_inst_env eps) pkg_dfuns
          eps'               = eps { eps_inst_env = eps_inst_env' }
   
-         env'  = env { tcg_inst_env = inst_env', 
-                       tcg_insts = lcl_dfuns ++ tcg_insts env }
+         env'  = env { tcg_insts = lcl_dfuns ++ tcg_insts env }
 
       ; traceDFuns dfuns
       ; addErrs errs
+      ; writeMutVar ie_var inst_env'
       ; setEps eps'
       ; setGblEnv env' thing_inside }
 
@@ -573,13 +601,15 @@ tcExtendLocalInstEnv :: [InstInfo] -> TcM a -> TcM a
 tcExtendLocalInstEnv infos thing_inside
  = do { dflags <- getDOpts
       ; env <- getGblEnv
+      ; let ie_var = tcg_inst_env env
+      ; inst_env <- readMutVar ie_var
       ; let
          dfuns             = map iDFunId infos
-         (inst_env', errs) = extendInstEnv dflags (tcg_inst_env env) dfuns
-         env'              = env { tcg_inst_env = inst_env', 
-                                   tcg_insts = dfuns ++ tcg_insts env }
+         (inst_env', errs) = extendInstEnv dflags inst_env dfuns
+         env'              = env { tcg_insts = dfuns ++ tcg_insts env }
       ; traceDFuns dfuns
       ; addErrs errs
+      ; writeMutVar ie_var inst_env'
       ; setGblEnv env' thing_inside }
 
 traceDFuns dfuns