[project @ 2004-09-30 10:35:15 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcInstDcls.lhs
index 8bb4754..4a22f9c 100644 (file)
@@ -8,47 +8,39 @@ module TcInstDcls ( tcInstDecls1, tcInstDecls2 ) where
 
 #include "HsVersions.h"
 
-import HsSyn           ( InstDecl(..), HsType(..),
-                         MonoBinds(..), HsExpr(..),  HsLit(..), Sig(..), 
-                         andMonoBindList, collectMonoBinders, 
-                         isClassDecl 
-                       )
-import RnHsSyn         ( RenamedHsBinds, RenamedInstDecl, RenamedTyClDecl )
-import TcHsSyn         ( TcMonoBinds, mkHsConApp )
+import HsSyn
 import TcBinds         ( tcSpecSigs )
 import TcClassDcl      ( tcMethodBind, mkMethodBind, badMethodErr, 
                          tcClassDecl2, getGenericInstances )
 import TcRnMonad       
-import TcMType         ( tcInstType, checkValidTheta, checkValidInstHead, instTypeErr, 
+import TcMType         ( tcSkolType, checkValidTheta, checkValidInstHead, instTypeErr, 
                          checkAmbiguity, SourceTyCtxt(..) )
-import TcType          ( mkClassPred, tcSplitForAllTys, tyVarsOfType,
+import TcType          ( mkClassPred, tcSplitForAllTys, tyVarsOfType, 
                          tcSplitSigmaTy, getClassPredTys, tcSplitPredTy_maybe, mkTyVarTys,
-                         TyVarDetails(..), tcSplitDFunTy
-                       )
-import Inst            ( InstOrigin(..), tcInstClassOp, newDicts, instToId, 
-                         showLIE, tcExtendLocalInstEnv )
+                         SkolemInfo(InstSkol), tcSplitDFunTy, pprClassPred )
+import Inst            ( tcInstClassOp, newDicts, instToId, showLIE, tcExtendLocalInstEnv )
 import TcDeriv         ( tcDeriving )
 import TcEnv           ( tcExtendGlobalValEnv, tcExtendTyVarEnv2,
                          InstInfo(..), InstBindings(..), 
-                         newDFunName, tcExtendLocalValEnv
+                         newDFunName, tcExtendIdEnv
                        )
-import PprType         ( pprClassPred )
 import TcHsType                ( kcHsSigType, tcHsKindedType )
 import TcUnify         ( checkSigTyVars )
 import TcSimplify      ( tcSimplifyCheck, tcSimplifyTop )
-import Subst           ( mkTyVarSubst, substTheta, substTy )
+import Type            ( zipTvSubst, substTheta, substTys )
 import DataCon         ( classDataCon )
 import Class           ( classBigSig )
-import Var             ( idName, idType )
-import NameSet         
+import Var             ( Id, idName, idType )
 import MkId            ( mkDictFunId, rUNTIME_ERROR_ID )
 import FunDeps         ( checkInstFDs )
-import Name            ( getSrcLoc )
-import NameSet         ( unitNameSet, emptyNameSet, nameSetToList )
+import Name            ( Name, getSrcLoc )
+import NameSet         ( unitNameSet, emptyNameSet, unionNameSets )
 import UnicodeUtil     ( stringToUtf8 )
 import Maybe           ( catMaybes )
+import SrcLoc          ( srcLocSpan, unLoc, noLoc, Located(..), srcSpanStart )
 import ListSetOps      ( minusList )
 import Outputable
+import Bag
 import FastString
 \end{code}
 
@@ -136,12 +128,12 @@ Gather up the instance declarations from their various sources
 
 \begin{code}
 tcInstDecls1   -- Deal with both source-code and imported instance decls
-   :: [RenamedTyClDecl]                -- For deriving stuff
-   -> [RenamedInstDecl]                -- Source code instance decls
+   :: [LTyClDecl Name]         -- For deriving stuff
+   -> [LInstDecl Name]         -- Source code instance decls
    -> TcM (TcGblEnv,           -- The full inst env
           [InstInfo],          -- Source-code instance decls to process; 
                                -- contains all dfuns for this module
-          RenamedHsBinds)      -- Supporting bindings for derived instances
+          [HsBindGroup Name])  -- Supporting bindings for derived instances
 
 tcInstDecls1 tycl_decls inst_decls
   = checkNoErrs $
@@ -153,26 +145,25 @@ tcInstDecls1 tycl_decls inst_decls
 
     let
        local_inst_info = catMaybes local_inst_infos
-       clas_decls      = filter isClassDecl tycl_decls
+       clas_decls      = filter (isClassDecl.unLoc) tycl_decls
     in
        -- (2) Instances from generic class declarations
     getGenericInstances clas_decls             `thenM` \ generic_inst_info -> 
 
        -- Next, construct the instance environment so far, consisting of
-       --      a) imported instance decls (from this module)
-       --      b) local instance decls
-       --      c) generic instances
+       --      a) local instance decls
+       --      b) generic instances
     addInsts local_inst_info   $
     addInsts generic_inst_info $
 
        -- (3) Compute instances from "deriving" clauses; 
        -- This stuff computes a context for the derived instance decl, so it
        -- needs to know about all the instances possible; hence inst_env4
-    tcDeriving tycl_decls      `thenM` \ (deriv_inst_info, deriv_binds) ->
+    tcDeriving tycl_decls      `thenM` \ (deriv_inst_info, deriv_binds, keep_alive) ->
     addInsts deriv_inst_info   $
 
     getGblEnv                  `thenM` \ gbl_env ->
-    returnM (gbl_env, 
+    returnM (gbl_env { tcg_keep = tcg_keep gbl_env `unionNameSets` keep_alive }, 
             generic_inst_info ++ deriv_inst_info ++ local_inst_info,
             deriv_binds)
 
@@ -182,7 +173,7 @@ addInsts infos thing_inside
 \end{code} 
 
 \begin{code}
-tcLocalInstDecl1 :: RenamedInstDecl 
+tcLocalInstDecl1 :: LInstDecl Name 
                 -> TcM (Maybe InstInfo)        -- Nothing if there was an error
        -- A source-file instance declaration
        -- Type-check all the stuff before the "where"
@@ -192,10 +183,10 @@ tcLocalInstDecl1 :: RenamedInstDecl
        -- Imported ones should have been checked already, and may indeed
        -- contain something illegal in normal Haskell, notably
        --      instance CCallable [Char] 
-tcLocalInstDecl1 decl@(InstDecl poly_ty binds uprags src_loc)
+tcLocalInstDecl1 decl@(L loc (InstDecl poly_ty binds uprags))
   =    -- Prime error recovery, set source location
     recoverM (returnM Nothing)         $
-    addSrcLoc src_loc                  $
+    setSrcSpan loc                     $
     addErrCtxt (instDeclCtxt1 poly_ty) $
 
        -- Typecheck the instance type itself.  We can't use 
@@ -210,7 +201,7 @@ tcLocalInstDecl1 decl@(InstDecl poly_ty binds uprags src_loc)
     checkValidInstHead tau                             `thenM` \ (clas,inst_tys) ->
     checkTc (checkInstFDs theta clas inst_tys)
            (instTypeErr (pprClassPred clas inst_tys) msg)      `thenM_`
-    newDFunName clas inst_tys src_loc                          `thenM` \ dfun_name ->
+    newDFunName clas inst_tys (srcSpanStart loc)               `thenM` \ dfun_name ->
     returnM (Just (InstInfo { iDFunId = mkDictFunId dfun_name tyvars theta clas inst_tys,
                              iBinds = VanillaInst binds uprags }))
   where
@@ -225,8 +216,8 @@ tcLocalInstDecl1 decl@(InstDecl poly_ty binds uprags src_loc)
 %************************************************************************
 
 \begin{code}
-tcInstDecls2 :: [RenamedTyClDecl] -> [InstInfo] 
-            -> TcM (TcLclEnv, TcMonoBinds)
+tcInstDecls2 :: [LTyClDecl Name] -> [InstInfo] 
+            -> TcM (TcLclEnv, LHsBinds Id)
 -- (a) From each class declaration, 
 --     generate any default-method bindings
 -- (b) From each instance decl
@@ -235,16 +226,16 @@ tcInstDecls2 :: [RenamedTyClDecl] -> [InstInfo]
 tcInstDecls2 tycl_decls inst_decls
   = do {       -- (a) Default methods from class decls
          (dm_binds_s, dm_ids_s) <- mapAndUnzipM tcClassDecl2 $
-                                   filter isClassDecl tycl_decls
-       ; tcExtendLocalValEnv (concat dm_ids_s)         $ do 
+                                   filter (isClassDecl.unLoc) tycl_decls
+       ; tcExtendIdEnv (concat dm_ids_s)       $ do 
     
                -- (b) instance declarations
        ; inst_binds_s <- mappM tcInstDecl2 inst_decls
 
                -- Done
        ; tcl_env <- getLclEnv
-       ; returnM (tcl_env, andMonoBindList dm_binds_s  `AndMonoBinds`
-                           andMonoBindList inst_binds_s) }
+       ; returnM (tcl_env, unionManyBags dm_binds_s    `unionBags`
+                           unionManyBags inst_binds_s) }
 \end{code}
 
 ======= New documentation starts here (Sept 92)         ==============
@@ -315,14 +306,15 @@ First comes the easy case of a non-local instance decl.
 
 
 \begin{code}
-tcInstDecl2 :: InstInfo -> TcM TcMonoBinds
+tcInstDecl2 :: InstInfo -> TcM (LHsBinds Id)
 
 tcInstDecl2 (InstInfo { iDFunId = dfun_id, iBinds = binds })
   =     -- Prime error recovery
-    recoverM (returnM EmptyMonoBinds)          $
-    addSrcLoc (getSrcLoc dfun_id)              $
+    recoverM (returnM emptyLHsBinds)           $
+    setSrcSpan (srcLocSpan (getSrcLoc dfun_id))        $
     addErrCtxt (instDeclCtxt2 (idType dfun_id))        $
     let
+       rigid_info       = InstSkol dfun_id
        inst_ty          = idType dfun_id
        (inst_tyvars, _) = tcSplitForAllTys inst_ty
                -- The tyvars of the instance decl scope over the 'where' part
@@ -331,18 +323,18 @@ tcInstDecl2 (InstInfo { iDFunId = dfun_id, iBinds = binds })
     in
 
        -- Instantiate the instance decl with tc-style type variables
-    tcInstType InstTv inst_ty          `thenM` \ (inst_tyvars', dfun_theta', inst_head') ->
+    tcSkolType rigid_info inst_ty      `thenM` \ (inst_tyvars', dfun_theta', inst_head') ->
     let
        Just pred         = tcSplitPredTy_maybe inst_head'
        (clas, inst_tys') = getClassPredTys pred
         (class_tyvars, sc_theta, _, op_items) = classBigSig clas
 
         -- Instantiate the super-class context with inst_tys
-       sc_theta' = substTheta (mkTyVarSubst class_tyvars inst_tys') sc_theta
-       origin    = InstanceDeclOrigin
+       sc_theta' = substTheta (zipTvSubst class_tyvars inst_tys') sc_theta
+       origin    = SigOrigin rigid_info
     in
         -- Create dictionary Ids from the specified instance contexts.
-    newDicts origin sc_theta'          `thenM` \ sc_dicts ->
+    newDicts InstScOrigin sc_theta'    `thenM` \ sc_dicts ->
     newDicts origin dfun_theta'                `thenM` \ dfun_arg_dicts ->
     newDicts origin [pred]             `thenM` \ [this_dict] ->
                -- Default-method Ids may be mentioned in synthesised RHSs,
@@ -353,13 +345,16 @@ tcInstDecl2 (InstInfo { iDFunId = dfun_id, iBinds = binds })
     let                -- These insts are in scope; quite a few, eh?
        avail_insts = [this_dict] ++ dfun_arg_dicts ++ sc_dicts
     in
-    tcMethods clas inst_tyvars inst_tyvars' 
+    tcMethods origin clas inst_tyvars inst_tyvars' 
              dfun_theta' inst_tys' avail_insts 
              op_items binds            `thenM` \ (meth_ids, meth_binds) ->
 
        -- Figure out bindings for the superclass context
     tcSuperClasses inst_tyvars' dfun_arg_dicts sc_dicts        
-               `thenM` \ (zonked_inst_tyvars, sc_binds_inner, sc_binds_outer) ->
+               `thenM` \ (sc_binds_inner, sc_binds_outer) ->
+
+       -- It's possible that the superclass stuff might have done unification
+    checkSigTyVars inst_tyvars'        `thenM_`
 
        -- Deal with 'SPECIALISE instance' pragmas by making them
        -- look like SPECIALISE pragmas for the dfun
@@ -367,8 +362,8 @@ tcInstDecl2 (InstInfo { iDFunId = dfun_id, iBinds = binds })
        uprags = case binds of
                       VanillaInst _ uprags -> uprags
                       other                -> []
-       spec_prags = [ SpecSig (idName dfun_id) ty loc
-                    | SpecInstSig ty loc <- uprags ]
+       spec_prags = [ L loc (SpecSig (L loc (idName dfun_id)) ty)
+                    | L loc (SpecInstSig ty) <- uprags ]
        xtve = inst_tyvars `zip` inst_tyvars'
     in
     tcExtendGlobalValEnv [dfun_id] (
@@ -402,8 +397,9 @@ tcInstDecl2 (InstInfo { iDFunId = dfun_id, iBinds = binds })
                -- emit an error message.  This in turn means that we don't
                -- mention the constructor, which doesn't exist for CCallable, CReturnable
                -- Hardly beautiful, but only three extra lines.
-           HsApp (TyApp (HsVar rUNTIME_ERROR_ID) [idType this_dict_id])
-                 (HsLit (HsStringPrim (mkFastString (stringToUtf8 msg))))
+           nlHsApp (noLoc $ TyApp (nlHsVar rUNTIME_ERROR_ID) 
+                                  [idType this_dict_id])
+                 (nlHsLit (HsStringPrim (mkFastString (stringToUtf8 msg))))
 
          | otherwise   -- The common case
          = mkHsConApp dict_constr inst_tys' (map HsVar scs_and_meths)
@@ -417,31 +413,33 @@ tcInstDecl2 (InstInfo { iDFunId = dfun_id, iBinds = binds })
          where
            msg = "Compiler error: bad dictionary " ++ showSDoc (ppr clas)
 
-       dict_bind  = VarMonoBind this_dict_id dict_rhs
-       all_binds  = sc_binds_inner `AndMonoBinds` meth_binds `AndMonoBinds` dict_bind
+       dict_bind  = noLoc (VarBind this_dict_id dict_rhs)
+       all_binds  = dict_bind `consBag` (sc_binds_inner `unionBags` meth_binds)
 
-       main_bind = AbsBinds
-                        zonked_inst_tyvars
-                        (map instToId dfun_arg_dicts)
-                        [(inst_tyvars', dfun_id, this_dict_id)] 
-                        inlines all_binds
+       main_bind = noLoc $ AbsBinds
+                           inst_tyvars'
+                           (map instToId dfun_arg_dicts)
+                           [(inst_tyvars', dfun_id, this_dict_id)] 
+                           inlines all_binds
     in
     showLIE (text "instance")          `thenM_`
-    returnM (main_bind `AndMonoBinds` prag_binds `AndMonoBinds` sc_binds_outer)
+    returnM (unitBag main_bind `unionBags` 
+            prag_binds `unionBags`
+            sc_binds_outer)
 
 
-tcMethods clas inst_tyvars inst_tyvars' dfun_theta' inst_tys' 
+tcMethods origin clas inst_tyvars inst_tyvars' dfun_theta' inst_tys' 
          avail_insts op_items (VanillaInst monobinds uprags)
   =    -- Check that all the method bindings come from this class
     let
        sel_names = [idName sel_id | (sel_id, _) <- op_items]
-       bad_bndrs = collectMonoBinders monobinds `minusList` sel_names
+       bad_bndrs = collectHsBindBinders monobinds `minusList` sel_names
     in
     mappM (addErrTc . badMethodErr clas) bad_bndrs     `thenM_`
 
        -- Make the method bindings
     let
-       mk_method_bind = mkMethodBind InstanceDeclOrigin clas inst_tys' monobinds
+       mk_method_bind = mkMethodBind origin clas inst_tys' monobinds
     in
     mapAndUnzipM mk_method_bind op_items       `thenM` \ (meth_insts, meth_infos) ->
 
@@ -478,17 +476,18 @@ tcMethods clas inst_tyvars inst_tyvars' dfun_theta' inst_tys'
        all_insts      = avail_insts ++ catMaybes meth_insts
        xtve           = inst_tyvars `zip` inst_tyvars'
        tc_method_bind = tcMethodBind xtve inst_tyvars' dfun_theta' all_insts uprags 
+       meth_ids       = [meth_id | (_,meth_id,_) <- meth_infos]
     in
+
     mapM tc_method_bind meth_infos             `thenM` \ meth_binds_s ->
    
-    returnM ([meth_id | (_,meth_id,_) <- meth_infos], 
-            andMonoBindList meth_binds_s)
+    returnM (meth_ids, unionManyBags meth_binds_s)
 
 
 -- Derived newtype instances
-tcMethods clas inst_tyvars inst_tyvars' dfun_theta' inst_tys' 
+tcMethods origin clas inst_tyvars inst_tyvars' dfun_theta' inst_tys' 
          avail_insts op_items (NewTypeDerived rep_tys)
-  = getInstLoc InstanceDeclOrigin              `thenM` \ inst_loc ->
+  = getInstLoc origin                          `thenM` \ inst_loc ->
     mapAndUnzip3M (do_one inst_loc) op_items   `thenM` \ (meth_ids, meth_binds, rhs_insts) ->
     
     tcSimplifyCheck
@@ -497,7 +496,7 @@ tcMethods clas inst_tyvars inst_tyvars' dfun_theta' inst_tys'
 
        -- I don't think we have to do the checkSigTyVars thing
 
-    returnM (meth_ids, lie_binds `AndMonoBinds` andMonoBindList meth_binds)
+    returnM (meth_ids, lie_binds `unionBags` listToBag meth_binds)
 
   where
     do_one inst_loc (sel_id, _)
@@ -510,11 +509,11 @@ tcMethods clas inst_tyvars inst_tyvars' dfun_theta' inst_tys'
          let
             meth_id = instToId meth_inst
          in
-         return (meth_id, VarMonoBind meth_id (HsVar (instToId rhs_inst)), rhs_inst)
+         return (meth_id, noLoc (VarBind meth_id (nlHsVar (instToId rhs_inst))), rhs_inst)
 
        -- Instantiate rep_tys with the relevant type variables
-    rep_tys' = map (substTy subst) rep_tys
-    subst    = mkTyVarSubst inst_tyvars (mkTyVarTys inst_tyvars')
+    rep_tys' = substTys subst rep_tys
+    subst    = zipTvSubst inst_tyvars (mkTyVarTys inst_tyvars')
 \end{code}
 
 Note: [Superclass loops]
@@ -565,15 +564,12 @@ tcSuperClasses inst_tyvars' dfun_arg_dicts sc_dicts
                            dfun_arg_dicts
                            sc_dicts)           `thenM` \ (sc_binds1, sc_lie) ->
 
-       -- It's possible that the superclass stuff might have done unification
-    checkSigTyVars inst_tyvars'        `thenM` \ zonked_inst_tyvars ->
-
        -- We must simplify this all the way down 
        -- lest we build superclass loops
        -- See Note [Superclass loops] above
     tcSimplifyTop sc_lie               `thenM` \ sc_binds2 ->
 
-    returnM (zonked_inst_tyvars, sc_binds1, sc_binds2)
+    returnM (sc_binds1, sc_binds2)
 
   where
     doc = ptext SLIT("instance declaration superclass context")
@@ -679,10 +675,10 @@ simplified: only zeze2 is extracted and its body is simplified.
 
 \begin{code}
 instDeclCtxt1 hs_inst_ty 
-  = inst_decl_ctxt (case hs_inst_ty of
-                       HsForAllTy _ _ (HsPredTy pred) -> ppr pred
-                       HsPredTy pred                  -> ppr pred
-                       other                          -> ppr hs_inst_ty)       -- Don't expect this
+  = inst_decl_ctxt (case unLoc hs_inst_ty of
+                       HsForAllTy _ _ _ (L _ (HsPredTy pred)) -> ppr pred
+                       HsPredTy pred                    -> ppr pred
+                       other                            -> ppr hs_inst_ty)     -- Don't expect this
 instDeclCtxt2 dfun_ty
   = inst_decl_ctxt (ppr (mkClassPred cls tys))
   where