[project @ 2000-10-30 17:18:26 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcEnv.lhs
index 7702e31..88d0159 100644 (file)
 \begin{code}
-#include "HsVersions.h"
-
 module TcEnv(
-       TcEnv, 
+       TcId, TcIdSet, 
+       TyThing(..), TyThingDetails(..), TcTyThing(..),
 
-       initEnv, getEnv_LocalIds, getEnv_TyCons, getEnv_Classes,
+       -- Getting stuff from the environment
+       TcEnv, initTcEnv, 
+       tcEnvTyCons, tcEnvClasses, tcEnvIds, tcEnvTcIds, tcEnvTyVars,
+       getTcGEnv,
        
-       tcTyVarScope, tcTyVarScopeGivenKinds, tcLookupTyVar, 
+       -- Instance environment, and InstInfo type
+       tcGetInstEnv, tcSetInstEnv, 
+       InstInfo(..), pprInstInfo,
+       simpleInstInfoTy, simpleInstInfoTyCon, isLocalInst,
+
+       -- Global environment
+       tcExtendGlobalEnv, tcExtendGlobalValEnv, 
+       tcLookupTyCon, tcLookupClass, tcLookupGlobalId, tcLookupDataCon,
+       tcLookupGlobal_maybe, tcLookupGlobal,
 
-       tcExtendTyConEnv, tcLookupTyCon, tcLookupTyConByKey, 
-       tcExtendClassEnv, tcLookupClass, tcLookupClassByKey,
-       tcGetTyConsAndClasses,
+       -- Local environment
+       tcExtendKindEnv, 
+       tcExtendTyVarEnv, tcExtendTyVarEnvForMeths, 
+       tcExtendLocalValEnv, tcLookup,
 
-       tcExtendGlobalValEnv, tcExtendLocalValEnv,
-       tcLookupLocalValue, tcLookupLocalValueOK, tcLookupLocalValueByKey, 
-       tcLookupGlobalValue, tcLookupGlobalValueByKey,
+       -- Global type variables
+       tcGetGlobalTyVars, tcExtendGlobalTyVars,
 
-       newMonoIds, newLocalIds, newLocalId,
-       tcGetGlobalTyVars
+       -- Random useful things
+       tcAddImportedIdInfo, tcInstId,
+
+       -- New Ids
+       newLocalId, newSpecPragmaId,
+       newDefaultMethodName, newDFunName,
+
+       -- Misc
+       isLocalThing, tcSetEnv, explicitLookupId
   ) where
 
+#include "HsVersions.h"
 
-import Ubiq
-import TcMLoop  -- for paranoia checking
-
-import Id      ( Id(..), GenId, idType, mkUserLocal )
-import TcHsSyn ( TcIdBndr(..), TcIdOcc(..) )
-import TcKind  ( TcKind, newKindVars, tcDefaultKind, kindToTcKind )
-import TcType  ( TcType(..), TcMaybe, TcTyVar(..), TcTyVarSet(..),
-                 newTyVarTys, tcInstTyVars, tcInstType, zonkTcTyVars
-               )
-import TyVar   ( mkTyVar, tyVarKind, unionTyVarSets, emptyTyVarSet )
-import Type    ( tyVarsOfTypes )
-import TyCon   ( TyCon, Arity(..), tyConKind, synTyConArity )
-import Class   ( Class(..), GenClass, classSig )
-
-import TcMonad         hiding ( rnMtoTcM )
-
-import Name            ( getOccName, getSrcLoc, Name{-instance NamedThing-} )
-import PprStyle
-import Pretty
-import RnHsSyn         ( RnName(..) )
-import Type            ( splitForAllTy )
-import Unique          ( pprUnique10, pprUnique{-ToDo:rm-} )
-import UniqFM       
-import Util            ( zipEqual, zipWithEqual, zipWith3Equal, zipLazy,
-                         panic, pprPanic, pprTrace{-ToDo:rm-}
+import RnHsSyn         ( RenamedMonoBinds, RenamedSig )
+import TcMonad
+import TcType          ( TcKind,  TcType, TcTyVar, TcTyVarSet, TcThetaType,
+                         tcInstTyVars, zonkTcTyVars,
                        )
+import Id              ( mkUserLocal, isDataConWrapId_maybe )
+import IdInfo          ( vanillaIdInfo )
+import MkId            ( mkSpecPragmaId )
+import Var             ( TyVar, Id, idType, lazySetIdInfo, idInfo )
+import VarSet
+import Type            ( Type, ThetaType,
+                         tyVarsOfTypes,
+                         splitForAllTys, splitRhoTy,
+                         getDFunTyKey, splitTyConApp_maybe
+                       )
+import DataCon         ( DataCon )
+import TyCon           ( TyCon )
+import Class           ( Class, ClassOpItem, ClassContext )
+import Subst           ( substTy )
+import Name            ( Name, OccName, NamedThing(..), 
+                         nameOccName, nameModule, getSrcLoc, mkGlobalName,
+                         isLocallyDefined, nameModule_maybe,
+                         NameEnv, lookupNameEnv, nameEnvElts, 
+                         extendNameEnvList, emptyNameEnv
+                       )
+import OccName         ( mkDFunOcc, mkDefaultMethodOcc, occNameString )
+import HscTypes                ( DFunId, TypeEnv, HomeSymbolTable, PackageTypeEnv )
+import Module          ( Module )
+import InstEnv         ( InstEnv, emptyInstEnv )
+import HscTypes                ( lookupType, TyThing(..) )
+import Util            ( zipEqual )
+import SrcLoc          ( SrcLoc )
+import Outputable
+
+import IOExts          ( newIORef )
 \end{code}
 
-Data type declarations
-~~~~~~~~~~~~~~~~~~~~~
+%************************************************************************
+%*                                                                     *
+\subsection{TcEnv}
+%*                                                                     *
+%************************************************************************
 
 \begin{code}
-data TcEnv s = TcEnv
-                 (TyVarEnv s)
-                 (TyConEnv s)
-                 (ClassEnv s)
-                 (ValueEnv Id)                 -- Globals
-                 (ValueEnv (TcIdBndr s))       -- Locals
-                 (MutableVar s (TcTyVarSet s)) -- Free type variables of locals
-                                               -- ...why mutable? see notes with tcGetGlobalTyVars
-
-type TyVarEnv s  = UniqFM (TcKind s, TyVar)
-type TyConEnv s  = UniqFM (TcKind s, Maybe Arity, TyCon)       -- Arity present for Synonyms only
-type ClassEnv s  = UniqFM (TcKind s, Class)
-type ValueEnv id = UniqFM id
-
-initEnv :: MutableVar s (TcTyVarSet s) -> TcEnv s
-initEnv mut = TcEnv emptyUFM emptyUFM emptyUFM emptyUFM emptyUFM mut 
-
-getEnv_LocalIds (TcEnv _ _ _ _ ls _) = eltsUFM ls
-getEnv_TyCons   (TcEnv _ ts _ _ _ _) = [tycon | (_, _, tycon) <- eltsUFM ts]
-getEnv_Classes  (TcEnv _ _ cs _ _ _) = [clas  | (_, clas)     <- eltsUFM cs]
+type TcId    = Id                      -- Type may be a TcType
+type TcIdSet = IdSet
+
+data TcEnv
+  = TcEnv {
+       tcGST    :: Name -> Maybe TyThing,      -- The type environment at the moment we began this compilation
+
+       tcInsts  :: InstEnv,            -- All instances (both imported and in this module)
+
+       tcGEnv   :: TypeEnv,            -- The global type environment we've accumulated while
+                {- NameEnv TyThing-}   -- compiling this module:
+                                       --      types and classes (both imported and local)
+                                       --      imported Ids
+                                       -- (Ids defined in this module are in the local envt)
+
+       tcLEnv   :: NameEnv TcTyThing,  -- The local type environment: Ids and TyVars
+                                       -- defined in this module
+
+       tcTyVars :: TcRef TcTyVarSet    -- The "global tyvars"
+                                       -- Namely, the in-scope TyVars bound in tcLEnv, plus the tyvars
+                                       -- mentioned in the types of Ids bound in tcLEnv
+                                       -- Why mutable? see notes with tcGetGlobalTyVars
+    }
+
 \end{code}
 
-Making new TcTyVars, with knot tying!
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The Global-Env/Local-Env story
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+During type checking, we keep in the GlobalEnv
+       * All types and classes
+       * All Ids derived from types and classes (constructors, selectors)
+       * Imported Ids
+
+At the end of type checking, we zonk the local bindings,
+and as we do so we add to the GlobalEnv
+       * Locally defined top-level Ids
+
+Why?  Because they are now Ids not TcIds.  This final GlobalEnv is
+used thus:
+       a) fed back (via the knot) to typechecking the 
+          unfoldings of interface signatures
+
+       b) used to augment the GlobalSymbolTable
+
+
 \begin{code}
-tcTyVarScopeGivenKinds 
-       :: [Name]               -- Names of some type variables
-       -> [TcKind s]
-       -> ([TyVar] -> TcM s a) -- Thing to type check in their scope
-       -> TcM s a              -- Result
-
-tcTyVarScopeGivenKinds names kinds thing_inside
-  = fixTc (\ ~(rec_tyvars, _) ->
-               -- Ok to look at names, kinds, but not tyvars!
-
-       tcGetEnv                                `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-       let
-           tve' = addListToUFM tve (zipEqual "tcTyVarScopeGivenKinds" names (kinds `zipLazy` rec_tyvars))
-       in
-       tcSetEnv (TcEnv tve' tce ce gve lve gtvs) 
-                (thing_inside rec_tyvars)      `thenTc` \ result ->
-               -- Get the tyvar's Kinds from their TcKinds
-       mapNF_Tc tcDefaultKind kinds            `thenNF_Tc` \ kinds' ->
-
-               -- Construct the real TyVars
-       let
-         tyvars             = zipWithEqual "tcTyVarScopeGivenKinds" mk_tyvar names kinds'
-         mk_tyvar name kind = mkTyVar name (uniqueOf name) kind
-       in
-       returnTc (tyvars, result)
-    )                                  `thenTc` \ (_,result) ->
-    returnTc result
-
-tcTyVarScope names thing_inside
-  = newKindVars (length names)         `thenNF_Tc` \ kinds ->
-    tcTyVarScopeGivenKinds names kinds thing_inside
-\end{code}
+data TcTyThing
+  = AGlobal TyThing    -- Used only in the return type of a lookup
+  | ATcId  TcId                -- Ids defined in this module
+  | ATyVar TyVar       -- Type variables
+  | AThing TcKind      -- Used temporarily, during kind checking
+-- Here's an example of how the AThing guy is used
+-- Suppose we are checking (forall a. T a Int):
+--     1. We first bind (a -> AThink kv), where kv is a kind variable. 
+--     2. Then we kind-check the (T a Int) part.
+--     3. Then we zonk the kind variable.
+--     4. Now we know the kind for 'a', and we add (a -> ATyVar a::K) to the environment
+
+initTcEnv :: HomeSymbolTable -> PackageTypeEnv -> IO TcEnv
+initTcEnv hst pte 
+  = do { gtv_var <- newIORef emptyVarSet ;
+        return (TcEnv { tcGST    = lookup,
+                        tcGEnv   = emptyNameEnv,
+                        tcInsts  = emptyInstEnv,
+                        tcLEnv   = emptyNameEnv,
+                        tcTyVars = gtv_var
+        })}
+  where
+    lookup name = lookupType hst pte name
 
 
-The Kind, TyVar, Class and TyCon envs
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+tcEnvClasses env = [cl | AClass cl <- nameEnvElts (tcGEnv env)]
+tcEnvTyCons  env = [tc | ATyCon tc <- nameEnvElts (tcGEnv env)] 
+tcEnvIds     env = [id | AnId   id <- nameEnvElts (tcGEnv env)] 
+tcEnvTyVars  env = [tv | ATyVar tv <- nameEnvElts (tcLEnv env)]
+tcEnvTcIds   env = [id | ATcId  id <- nameEnvElts (tcLEnv env)]
 
-Extending the environments.  Notice the uses of @zipLazy@, which makes sure
-that the knot-tied TyVars, TyCons and Classes aren't looked at too early.
+getTcGEnv (TcEnv { tcGEnv = genv }) = genv
+
+-- This data type is used to help tie the knot
+-- when type checking type and class declarations
+data TyThingDetails = SynTyDetails Type
+                   | DataTyDetails ClassContext [DataCon] [Class]
+                   | ClassDetails ClassContext [Id] [ClassOpItem] DataCon
+\end{code}
+
+
+%************************************************************************
+%*                                                                     *
+\subsection{Basic lookups}
+%*                                                                     *
+%************************************************************************
 
 \begin{code}
-tcExtendTyConEnv :: [(RnName,Maybe Arity)] -> [TyCon] -> TcM s r -> TcM s r
+lookup_global :: TcEnv -> Name -> Maybe TyThing
+       -- Try the global envt and then the global symbol table
+lookup_global env name 
+  = case lookupNameEnv (tcGEnv env) name of
+       Just thing -> Just thing
+       Nothing    -> tcGST env name
+
+lookup_local :: TcEnv -> Name -> Maybe TcTyThing
+       -- Try the local envt and then try the global
+lookup_local env name
+  = case lookupNameEnv (tcLEnv env) name of
+       Just thing -> Just thing
+       Nothing    -> case lookup_global env name of
+                       Just thing -> Just (AGlobal thing)
+                       Nothing    -> Nothing
+
+explicitLookupId :: TcEnv -> Name -> Maybe Id
+explicitLookupId env name = case lookup_global env name of
+                               Just (AnId id) -> Just id
+                               other          -> Nothing
+\end{code}
 
-tcExtendTyConEnv names_w_arities tycons scope
-  = newKindVars (length names_w_arities)       `thenNF_Tc` \ kinds ->
-    tcGetEnv                                   `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    let
-       tce' = addListToUFM tce [ (name, (kind, arity, tycon)) 
-                               | ((name,arity), (kind,tycon))
-                                 <- zipEqual "tcExtendTyConEnv" names_w_arities (kinds `zipLazy` tycons)
-                               ]
-    in
-    tcSetEnv (TcEnv tve tce' ce gve lve gtvs) scope    `thenTc` \ result ->
-    mapNF_Tc tcDefaultKind kinds                       `thenNF_Tc_`
-    returnTc result 
+
+%************************************************************************
+%*                                                                     *
+\subsection{Random useful functions}
+%*                                                                     *
+%************************************************************************
 
 
-tcExtendClassEnv :: [RnName] -> [Class] -> TcM s r -> TcM s r
-tcExtendClassEnv names classes scope
-  = newKindVars (length names) `thenNF_Tc` \ kinds ->
-    tcGetEnv                   `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
+\begin{code}
+-- A useful function that takes an occurrence of a global thing
+-- and instantiates its type with fresh type variables
+tcInstId :: Id
+        -> NF_TcM ([TcTyVar],  -- It's instantiated type
+                     TcThetaType,      --
+                     TcType)           --
+tcInstId id
+  = let
+      (tyvars, rho) = splitForAllTys (idType id)
+    in
+    tcInstTyVars tyvars                `thenNF_Tc` \ (tyvars', arg_tys, tenv) ->
     let
-       ce' = addListToUFM ce (zipEqual "tcExtendClassEnv" names (kinds `zipLazy` classes))
+       rho'           = substTy tenv rho
+       (theta', tau') = splitRhoTy rho' 
     in
-    tcSetEnv (TcEnv tve tce ce' gve lve gtvs) scope    `thenTc` \ result ->
-    mapNF_Tc tcDefaultKind kinds                       `thenNF_Tc_`
-    returnTc result 
+    returnNF_Tc (tyvars', theta', tau')
+
+tcAddImportedIdInfo :: TcEnv -> Id -> Id
+tcAddImportedIdInfo unf_env id
+  | isLocallyDefined id                -- Don't look up locally defined Ids, because they
+                               -- have explicit local definitions, so we get a black hole!
+  = id
+  | otherwise
+  = id `lazySetIdInfo` new_info
+       -- The Id must be returned without a data dependency on maybe_id
+  where
+    new_info = case explicitLookupId unf_env (getName id) of
+                    Nothing          -> vanillaIdInfo
+                    Just imported_id -> idInfo imported_id
+               -- ToDo: could check that types are the same
 \end{code}
 
 
-Looking up in the environments.
+%************************************************************************
+%*                                                                     *
+\subsection{Making new Ids}
+%*                                                                     *
+%************************************************************************
+
+Constructing new Ids
 
 \begin{code}
-tcLookupTyVar name
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    returnNF_Tc (lookupWithDefaultUFM tve (pprPanic "tcLookupTyVar:" (ppr PprShowAll name)) name)
+newLocalId :: OccName -> TcType -> SrcLoc -> NF_TcM TcId
+newLocalId name ty loc
+  = tcGetUnique                `thenNF_Tc` \ uniq ->
+    returnNF_Tc (mkUserLocal name uniq ty loc)
+
+newSpecPragmaId :: Name -> TcType -> NF_TcM TcId
+newSpecPragmaId name ty 
+  = tcGetUnique                `thenNF_Tc` \ uniq ->
+    returnNF_Tc (mkSpecPragmaId (nameOccName name) uniq ty (getSrcLoc name))
+\end{code}
 
+Make a name for the dict fun for an instance decl
 
-tcLookupTyCon (WiredInTyCon tc)                -- wired in tycons
-  = returnNF_Tc (kindToTcKind (tyConKind tc), synTyConArity tc, tc)
+\begin{code}
+newDFunName :: Module -> Class -> [Type] -> SrcLoc -> NF_TcM Name
+newDFunName mod clas (ty:_) loc
+  = tcGetDFunUniq dfun_string  `thenNF_Tc` \ inst_uniq ->
+    tcGetUnique                        `thenNF_Tc` \ uniq ->
+    returnNF_Tc (mkGlobalName uniq mod
+                             (mkDFunOcc dfun_string inst_uniq) 
+                             loc)
+  where
+       -- Any string that is somewhat unique will do
+    dfun_string = occNameString (getOccName clas) ++ occNameString (getDFunTyKey ty)
+
+newDefaultMethodName :: Name -> SrcLoc -> NF_TcM Name
+newDefaultMethodName op_name loc
+  = tcGetUnique                        `thenNF_Tc` \ uniq ->
+    returnNF_Tc (mkGlobalName uniq (nameModule op_name)
+                             (mkDefaultMethodOcc (getOccName op_name))
+                             loc)
+\end{code}
 
-tcLookupTyCon name
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    returnNF_Tc (lookupWithDefaultUFM tce (pprPanic "tcLookupTyCon:" (ppr PprShowAll name)) name)
-
-tcLookupTyConByKey uniq
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    let 
-       (kind, arity, tycon) =  lookupWithDefaultUFM_Directly tce 
-                                       (pprPanic "tcLookupTyCon:" (pprUnique10 uniq)) 
-                                       uniq
-    in
-    returnNF_Tc tycon
+\begin{code}
+isLocalThing :: NamedThing a => Module -> a -> Bool
+  -- True if the thing has a Local name, 
+  -- or a Global name from the specified module
+isLocalThing mod thing = case nameModule_maybe (getName thing) of
+                          Nothing -> True      -- A local name
+                          Just m  -> m == mod  -- A global thing
+\end{code}
 
-tcLookupClass name
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
---  pprTrace "tcLookupClass:" (ppCat [ppStr "Uniq:", pprUnique10 (uniqueOf name), ppStr "; avail:", ppCat (map (pprUnique10 . fst) (ufmToList ce))]) $
---  pprTrace "tcLookupClass:" (ppCat [ppStr "Uniq:", pprUnique (uniqueOf name), ppStr "; avail:", ppCat (map (pprUnique . fst) (ufmToList ce))]) $
-    returnNF_Tc (lookupWithDefaultUFM ce (pprPanic "tcLookupClass:" (ppr PprShowAll name)) name)
+%************************************************************************
+%*                                                                     *
+\subsection{The global environment}
+%*                                                                     *
+%************************************************************************
 
-tcLookupClassByKey uniq
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
+\begin{code}
+tcExtendGlobalEnv :: [(Name, TyThing)] -> TcM r -> TcM r
+tcExtendGlobalEnv bindings thing_inside
+  = tcGetEnv                           `thenNF_Tc` \ env ->
     let
-       (kind, clas) = lookupWithDefaultUFM_Directly ce 
-                               (pprPanic "tcLookupClassByKey:" (pprUnique10 uniq))
-                               uniq
+       ge' = extendNameEnvList (tcGEnv env) bindings
     in
-    returnNF_Tc clas
+    tcSetEnv (env {tcGEnv = ge'}) thing_inside
+
+tcExtendGlobalValEnv :: [Id] -> TcM a -> TcM a
+tcExtendGlobalValEnv ids thing_inside
+  = tcExtendGlobalEnv [(getName id, AnId id) | id <- ids] thing_inside
+\end{code}
+
 
-tcGetTyConsAndClasses :: NF_TcM s ([TyCon], [Class])
-tcGetTyConsAndClasses
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    returnNF_Tc ([tc | (_, _, tc) <- eltsUFM tce],
-                [c  | (_, c)     <- eltsUFM ce])
+\begin{code}
+tcLookupGlobal_maybe :: Name -> NF_TcM (Maybe TyThing)
+tcLookupGlobal_maybe name
+  = tcGetEnv           `thenNF_Tc` \ env ->
+    returnNF_Tc (lookup_global env name)
 \end{code}
 
+A variety of global lookups, when we know what we are looking for.
+
+\begin{code}
+tcLookupGlobal :: Name -> NF_TcM TyThing
+tcLookupGlobal name
+  = tcLookupGlobal_maybe name  `thenNF_Tc` \ maybe_thing ->
+    case maybe_thing of
+       Just thing -> returnNF_Tc thing
+       other      -> notFound "tcLookupGlobal" name
+
+tcLookupGlobalId :: Name -> NF_TcM Id
+tcLookupGlobalId name
+  = tcLookupGlobal_maybe name  `thenNF_Tc` \ maybe_id ->
+    case maybe_id of
+       Just (AnId clas) -> returnNF_Tc clas
+       other            -> notFound "tcLookupGlobalId" name
+       
+tcLookupDataCon :: Name -> TcM DataCon
+tcLookupDataCon con_name
+  = tcLookupGlobalId con_name          `thenNF_Tc` \ con_id ->
+    case isDataConWrapId_maybe con_id of
+       Just data_con -> returnTc data_con
+       Nothing       -> failWithTc (badCon con_id)
+
+
+tcLookupClass :: Name -> NF_TcM Class
+tcLookupClass name
+  = tcLookupGlobal_maybe name  `thenNF_Tc` \ maybe_clas ->
+    case maybe_clas of
+       Just (AClass clas) -> returnNF_Tc clas
+       other              -> notFound "tcLookupClass" name
+       
+tcLookupTyCon :: Name -> NF_TcM TyCon
+tcLookupTyCon name
+  = tcLookupGlobal_maybe name  `thenNF_Tc` \ maybe_tc ->
+    case maybe_tc of
+       Just (ATyCon tc) -> returnNF_Tc tc
+       other            -> notFound "tcLookupTyCon" name
+\end{code}
+
+
+%************************************************************************
+%*                                                                     *
+\subsection{The local environment}
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+tcLookup_maybe :: Name -> NF_TcM (Maybe TcTyThing)
+tcLookup_maybe name
+  = tcGetEnv           `thenNF_Tc` \ env ->
+    returnNF_Tc (lookup_local env name)
+
+tcLookup :: Name -> NF_TcM TcTyThing
+tcLookup name
+  = tcLookup_maybe name                `thenNF_Tc` \ maybe_thing ->
+    case maybe_thing of
+       Just thing -> returnNF_Tc thing
+       other      -> notFound "tcLookup" name
+       -- Extract the IdInfo from an IfaceSig imported from an interface file
+\end{code}
 
 
-Extending and consulting the value environment
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 \begin{code}
-tcExtendGlobalValEnv ids scope
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
+tcExtendKindEnv :: [(Name,TcKind)] -> TcM r -> TcM r
+tcExtendKindEnv pairs thing_inside
+  = tcGetEnv                           `thenNF_Tc` \ env ->
     let
-       gve' = addListToUFM_Directly gve [(uniqueOf id, id) | id <- ids]
+       le' = extendNameEnvList (tcLEnv env) [(n, AThing k) | (n,k) <- pairs]
+       -- No need to extend global tyvars for kind checking
     in
-    tcSetEnv (TcEnv tve tce ce gve' lve gtvs) scope
+    tcSetEnv (env {tcLEnv = le'}) thing_inside
+    
+tcExtendTyVarEnv :: [TyVar] -> TcM r -> TcM r
+tcExtendTyVarEnv tyvars thing_inside
+  = tcGetEnv                   `thenNF_Tc` \ env@(TcEnv {tcLEnv = le, tcTyVars = gtvs}) ->
+    let
+       le'        = extendNameEnvList le [ (getName tv, ATyVar tv) | tv <- tyvars]
+       new_tv_set = mkVarSet tyvars
+    in
+       -- It's important to add the in-scope tyvars to the global tyvar set
+       -- as well.  Consider
+       --      f (x::r) = let g y = y::r in ...
+       -- Here, g mustn't be generalised.  This is also important during
+       -- class and instance decls, when we mustn't generalise the class tyvars
+       -- when typechecking the methods.
+    tc_extend_gtvs gtvs new_tv_set             `thenNF_Tc` \ gtvs' ->
+    tcSetEnv (env {tcLEnv = le', tcTyVars = gtvs'}) thing_inside
+
+-- This variant, tcExtendTyVarEnvForMeths, takes *two* bunches of tyvars:
+--     the signature tyvars contain the original names
+--     the instance  tyvars are what those names should be mapped to
+-- It's needed when typechecking the method bindings of class and instance decls
+-- It does *not* extend the global tyvars; tcMethodBind does that for itself
+
+tcExtendTyVarEnvForMeths :: [TyVar] -> [TcTyVar] -> TcM r -> TcM r
+tcExtendTyVarEnvForMeths sig_tyvars inst_tyvars thing_inside
+  = tcGetEnv                                   `thenNF_Tc` \ env ->
+    let
+       le'   = extendNameEnvList (tcLEnv env) stuff
+       stuff = [ (getName sig_tv, ATyVar inst_tv)
+               | (sig_tv, inst_tv) <- zipEqual "tcMeth" sig_tyvars inst_tyvars
+               ]
+    in
+    tcSetEnv (env {tcLEnv = le'}) thing_inside
+\end{code}
+
 
-tcExtendLocalValEnv names ids scope
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    tcReadMutVar gtvs  `thenNF_Tc` \ global_tvs ->
+\begin{code}
+tcExtendLocalValEnv :: [(Name,TcId)] -> TcM a -> TcM a
+tcExtendLocalValEnv names_w_ids thing_inside
+  = tcGetEnv           `thenNF_Tc` \ env ->
     let
-       lve' = addListToUFM lve (zipEqual "tcExtendLocalValEnv" names ids)
-       extra_global_tyvars = tyVarsOfTypes (map idType ids)
-       new_global_tyvars   = global_tvs `unionTyVarSets` extra_global_tyvars
+       extra_global_tyvars = tyVarsOfTypes [idType id | (name,id) <- names_w_ids]
+       extra_env           = [(name, ATcId id) | (name,id) <- names_w_ids]
+       le'                 = extendNameEnvList (tcLEnv env) extra_env
     in
-    tcNewMutVar new_global_tyvars      `thenNF_Tc` \ gtvs' ->
+    tc_extend_gtvs (tcTyVars env) extra_global_tyvars  `thenNF_Tc` \ gtvs' ->
+    tcSetEnv (env {tcLEnv = le', tcTyVars = gtvs'}) thing_inside
+\end{code}
+
 
-    tcSetEnv (TcEnv tve tce ce gve lve' gtvs') scope
+%************************************************************************
+%*                                                                     *
+\subsection{The global tyvars}
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+tcExtendGlobalTyVars extra_global_tvs thing_inside
+  = tcGetEnv                                           `thenNF_Tc` \ env ->
+    tc_extend_gtvs (tcTyVars env) extra_global_tvs     `thenNF_Tc` \ gtvs' ->
+    tcSetEnv (env {tcTyVars = gtvs'}) thing_inside
+
+tc_extend_gtvs gtvs extra_global_tvs
+  = tcReadMutVar gtvs                  `thenNF_Tc` \ global_tvs ->
+    tcNewMutVar (global_tvs `unionVarSet` extra_global_tvs)
 \end{code}
 
 @tcGetGlobalTyVars@ returns a fully-zonked set of tyvars free in the environment.
@@ -225,98 +464,90 @@ To improve subsequent calls to the same function it writes the zonked set back i
 the environment.
 
 \begin{code}
-tcGetGlobalTyVars :: NF_TcM s (TcTyVarSet s)
+tcGetGlobalTyVars :: NF_TcM TcTyVarSet
 tcGetGlobalTyVars
-  = tcGetEnv                           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    tcReadMutVar gtvs                  `thenNF_Tc` \ global_tvs ->
-    zonkTcTyVars global_tvs            `thenNF_Tc` \ global_tvs' ->
-    tcWriteMutVar gtvs global_tvs'     `thenNF_Tc_`
+  = tcGetEnv                                   `thenNF_Tc` \ (TcEnv {tcTyVars = gtv_var}) ->
+    tcReadMutVar gtv_var                       `thenNF_Tc` \ global_tvs ->
+    zonkTcTyVars (varSetElems global_tvs)      `thenNF_Tc` \ global_tys' ->
+    let
+       global_tvs' = (tyVarsOfTypes global_tys')
+    in
+    tcWriteMutVar gtv_var global_tvs'          `thenNF_Tc_` 
     returnNF_Tc global_tvs'
 \end{code}
 
-\begin{code}
-tcLookupLocalValue :: RnName -> NF_TcM s (Maybe (TcIdBndr s))
-tcLookupLocalValue name
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    returnNF_Tc (lookupUFM lve name)
 
-tcLookupLocalValueByKey :: Unique -> NF_TcM s (Maybe (TcIdBndr s))
-tcLookupLocalValueByKey uniq
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    returnNF_Tc (lookupUFM_Directly lve uniq)
+%************************************************************************
+%*                                                                     *
+\subsection{The instance environment}
+%*                                                                     *
+%************************************************************************
 
-tcLookupLocalValueOK :: String -> RnName -> NF_TcM s (TcIdBndr s)
-tcLookupLocalValueOK err name
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    returnNF_Tc (lookupWithDefaultUFM lve (panic err) name)
+\begin{code}
+tcGetInstEnv :: NF_TcM InstEnv
+tcGetInstEnv = tcGetEnv        `thenNF_Tc` \ env -> 
+              returnNF_Tc (tcInsts env)
 
+tcSetInstEnv :: InstEnv -> TcM a -> TcM a
+tcSetInstEnv ie thing_inside
+  = tcGetEnv   `thenNF_Tc` \ env ->
+    tcSetEnv (env {tcInsts = ie}) thing_inside
+\end{code}    
 
-tcLookupGlobalValue :: RnName -> NF_TcM s Id
 
-tcLookupGlobalValue (WiredInId id)     -- wired in ids
-  = returnNF_Tc id
+%************************************************************************
+%*                                                                     *
+\subsection{The InstInfo type}
+%*                                                                     *
+%************************************************************************
 
-tcLookupGlobalValue name
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    returnNF_Tc (lookupWithDefaultUFM gve def name)
-  where
-#ifdef DEBUG
-    def = pprPanic "tcLookupGlobalValue:" (ppr PprDebug name)
-#else
-    def = panic "tcLookupGlobalValue"
-#endif
-
-tcLookupGlobalValueByKey :: Unique -> NF_TcM s Id
-tcLookupGlobalValueByKey uniq
-  = tcGetEnv           `thenNF_Tc` \ (TcEnv tve tce ce gve lve gtvs) ->
-    returnNF_Tc (lookupWithDefaultUFM_Directly gve def uniq)
-  where
-#ifdef DEBUG
-    def = pprPanic "tcLookupGlobalValueByKey:" (pprUnique10 uniq)
-#else
-    def = panic "tcLookupGlobalValueByKey"
-#endif
+The InstInfo type summarises the information in an instance declaration
 
+    instance c => k (t tvs) where b
+
+\begin{code}
+data InstInfo
+  = InstInfo {
+      iClass :: Class,         -- Class, k
+      iTyVars :: [TyVar],      -- Type variables, tvs
+      iTys    :: [Type],       -- The types at which the class is being instantiated
+      iTheta  :: ThetaType,    -- inst_decl_theta: the original context, c, from the
+                               --   instance declaration.  It constrains (some of)
+                               --   the TyVars above
+      iLocal  :: Bool,         -- True <=> it's defined in this module
+      iDFunId :: DFunId,               -- The dfun id
+      iBinds  :: RenamedMonoBinds,     -- Bindings, b
+      iLoc    :: SrcLoc,               -- Source location assoc'd with this instance's defn
+      iPrags  :: [RenamedSig]          -- User pragmas recorded for generating specialised instances
+    }
+
+pprInstInfo info = vcat [ptext SLIT("InstInfo:") <+> ppr (idType (iDFunId info)),
+                        nest 4 (ppr (iBinds info))]
+
+simpleInstInfoTy :: InstInfo -> Type
+simpleInstInfoTy (InstInfo {iTys = [ty]}) = ty
+
+simpleInstInfoTyCon :: InstInfo -> TyCon
+  -- Gets the type constructor for a simple instance declaration,
+  -- i.e. one of the form      instance (...) => C (T a b c) where ...
+simpleInstInfoTyCon inst
+   = case splitTyConApp_maybe (simpleInstInfoTy inst) of 
+       Just (tycon, _) -> tycon
+
+isLocalInst :: Module -> InstInfo -> Bool
+isLocalInst mod info = isLocalThing mod (iDFunId info)
 \end{code}
 
 
-Constructing new Ids
-~~~~~~~~~~~~~~~~~~~~
+%************************************************************************
+%*                                                                     *
+\subsection{Errors}
+%*                                                                     *
+%************************************************************************
 
 \begin{code}
-newMonoIds :: [RnName] -> Kind -> ([TcIdBndr s] -> TcM s a) -> TcM s a
+badCon con_id = quotes (ppr con_id) <+> ptext SLIT("is not a data constructor")
 
-newMonoIds names kind m
-  = newTyVarTys no_of_names kind       `thenNF_Tc` \ tys ->
-    tcGetUniques no_of_names           `thenNF_Tc` \ uniqs ->
-    let
-       new_ids = zipWith3Equal "newMonoIds" mk_id names uniqs tys
-
-       mk_id name uniq ty
-         = let
-               name_str = case (getOccName name) of { Unqual n -> n }
-           in
-           mkUserLocal name_str uniq ty (getSrcLoc name)
-    in
-    tcExtendLocalValEnv names new_ids (m new_ids)
-  where
-    no_of_names = length names
-
-newLocalId :: FAST_STRING -> TcType s -> NF_TcM s (TcIdOcc s)
-newLocalId name ty
-  = tcGetSrcLoc                `thenNF_Tc` \ loc ->
-    tcGetUnique                `thenNF_Tc` \ uniq ->
-    returnNF_Tc (TcId (mkUserLocal name uniq ty loc))
-
-newLocalIds :: [FAST_STRING] -> [TcType s] -> NF_TcM s [TcIdOcc s]
-newLocalIds names tys
-  = tcGetSrcLoc                        `thenNF_Tc` \ loc ->
-    tcGetUniques (length names) `thenNF_Tc` \ uniqs ->
-    let
-       new_ids            = zipWith3Equal "newLocalIds" mk_id names uniqs tys
-       mk_id name uniq ty = TcId (mkUserLocal name uniq ty loc)
-    in
-    returnNF_Tc new_ids
+notFound wheRe name = failWithTc (text wheRe <> colon <+> quotes (ppr name) <+> 
+                                 ptext SLIT("is not in scope"))
 \end{code}
-
-