[project @ 2005-02-25 13:06:31 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / Inst.lhs
index c8a50d0..f75d1d3 100644 (file)
@@ -12,10 +12,10 @@ module Inst (
 
        tidyInsts, tidyMoreInsts,
 
-       newDictsFromOld, newDicts, cloneDict, 
+       newDictsFromOld, newDicts, newDictsAtLoc, cloneDict, 
        newOverloadedLit, newIPDict, 
        newMethod, newMethodFromName, newMethodWithGivenTy, 
-       tcInstClassOp, tcInstCall, tcInstDataCon, 
+       tcInstClassOp, tcInstCall, tcInstStupidTheta,
        tcSyntaxName, tcStdSyntaxName,
 
        tyVarsOfInst, tyVarsOfInsts, tyVarsOfLIE, 
@@ -23,7 +23,7 @@ module Inst (
        instLoc, getDictClassTys, dictPred,
 
        lookupInst, LookupInstResult(..),
-       tcExtendLocalInstEnv, tcGetInstEnvs,
+       tcExtendLocalInstEnv, tcGetInstEnvs, 
 
        isDict, isClassDict, isMethod, 
        isLinearInst, linearInstType, isIPDict, isInheritableInst,
@@ -50,41 +50,45 @@ import TcRnMonad
 import TcEnv   ( tcLookupId, checkWellStaged, topIdLvl, tcMetaTy )
 import InstEnv ( DFunId, InstEnv, lookupInstEnv, checkFunDeps, extendInstEnv )
 import TcIface ( loadImportedInsts )
-import TcMType ( zonkTcType, zonkTcTypes, zonkTcPredType, 
-                 zonkTcThetaType, tcInstTyVar, tcInstType, tcInstTyVars
+import TcMType ( zonkTcType, zonkTcTypes, zonkTcPredType, zonkTcThetaType, 
+                 tcInstTyVar, tcInstType, tcSkolType
                )
-import TcType  ( Type, TcType, TcThetaType, TcTyVarSet,
-                 PredType(..), TyVarDetails(VanillaTv), typeKind,
-                 tcSplitForAllTys, tcSplitForAllTys, mkTyConApp,
-                 tcSplitPhiTy, tcIsTyVarTy, tcSplitDFunTy,
+import TcType  ( Type, TcType, TcThetaType, TcTyVarSet, TcTyVar, TcPredType,
+                 PredType(..), SkolemInfo(..), typeKind, mkSigmaTy,
+                 tcSplitForAllTys, tcSplitForAllTys, 
+                 tcSplitPhiTy, tcIsTyVarTy, tcSplitDFunTy, tcSplitDFunHead,
                  isIntTy,isFloatTy, isIntegerTy, isDoubleTy,
                  tcIsTyVarTy, mkPredTy, mkTyVarTy, mkTyVarTys,
                  tyVarsOfType, tyVarsOfTypes, tyVarsOfPred, tidyPred,
                  isClassPred, isTyVarClassPred, isLinearPred, 
                  getClassPredTys, getClassPredTys_maybe, mkPredName,
-                 isInheritablePred, isIPPred, matchTys,
+                 isInheritablePred, isIPPred, 
                  tidyType, tidyTypes, tidyFreeTyVars, tcSplitSigmaTy, 
                  pprPred, pprParendType, pprThetaArrow, pprTheta, pprClassPred
                )
+import Type    ( TvSubst, substTy, substTyVar, substTyWith, substTheta, zipTopTvSubst,
+                 notElemTvSubst, extendTvSubstList )
+import Unify   ( tcMatchTys )
 import Kind    ( isSubKind )
+import Packages        ( isHomeModule )
 import HscTypes        ( ExternalPackageState(..) )
 import CoreFVs ( idFreeTyVars )
-import DataCon ( DataCon,dataConSig )
-import Id      ( Id, idName, idType, mkUserLocal, mkSysLocal, mkLocalId, setIdUnique )
+import DataCon ( DataCon, dataConTyVars, dataConStupidTheta, dataConName )
+import Id      ( Id, idName, idType, mkUserLocal, mkLocalId )
 import PrelInfo        ( isStandardClass, isNoDictClass )
-import Name    ( Name, mkMethodOcc, getOccName, getSrcLoc, isHomePackageName, isInternalName )
+import Name    ( Name, mkMethodOcc, getOccName, getSrcLoc, nameModule,
+                 isInternalName, setNameUnique, mkSystemVarNameEncoded )
 import NameSet ( addOneToNameSet )
-import Subst   ( substTy, substTyWith, substTheta, mkTopTyVarSubst )
 import Literal ( inIntRange )
-import Var     ( TyVar, tyVarKind )
-import VarEnv  ( TidyEnv, emptyTidyEnv, lookupSubstEnv, SubstResult(..) )
+import Var     ( TyVar, tyVarKind, setIdType )
+import VarEnv  ( TidyEnv, emptyTidyEnv )
 import VarSet  ( elemVarSet, emptyVarSet, unionVarSet, mkVarSet )
 import TysWiredIn ( floatDataCon, doubleDataCon )
 import PrelNames       ( integerTyConName, fromIntegerName, fromRationalName, rationalTyConName )
 import BasicTypes( IPName(..), mapIPName, ipNameName )
 import UniqSupply( uniqsFromSupply )
 import SrcLoc  ( mkSrcSpan, noLoc, unLoc, Located(..) )
-import CmdLineOpts( DynFlags, DynFlag( Opt_AllowUndecidableInstances ), dopt )
+import CmdLineOpts( DynFlags )
 import Maybes  ( isJust )
 import Outputable
 \end{code}
@@ -97,9 +101,9 @@ instName :: Inst -> Name
 instName inst = idName (instToId inst)
 
 instToId :: Inst -> TcId
-instToId (Dict id _ _)        = id
+instToId (LitInst nm _ ty _)   = mkLocalId nm ty
+instToId (Dict nm pred _)      = mkLocalId nm (mkPredTy pred)
 instToId (Method id _ _ _ _ _) = id
-instToId (LitInst id _ _ _)    = id
 
 instLoc (Dict _ _         loc) = loc
 instLoc (Method _ _ _ _ _ loc) = loc
@@ -221,8 +225,8 @@ newDicts orig theta
     newDictsAtLoc loc theta
 
 cloneDict :: Inst -> TcM Inst
-cloneDict (Dict id ty loc) = newUnique `thenM` \ uniq ->
-                            returnM (Dict (setIdUnique id uniq) ty loc)
+cloneDict (Dict nm ty loc) = newUnique `thenM` \ uniq ->
+                            returnM (Dict (setNameUnique nm uniq) ty loc)
 
 newDictsFromOld :: Inst -> TcThetaType -> TcM [Inst]
 newDictsFromOld (Dict _ _ loc) theta = newDictsAtLoc loc theta
@@ -236,7 +240,7 @@ newDictsAtLoc inst_loc theta
   = newUniqueSupply            `thenM` \ us ->
     returnM (zipWith mk_dict (uniqsFromSupply us) theta)
   where
-    mk_dict uniq pred = Dict (mkLocalId (mkPredName uniq loc pred) (mkPredTy pred))
+    mk_dict uniq pred = Dict (mkPredName uniq loc pred)
                             pred inst_loc
     loc = instLocSrcLoc inst_loc
 
@@ -252,9 +256,9 @@ newIPDict orig ip_name ty
     let
        pred = IParam ip_name ty
         name = mkPredName uniq (instLocSrcLoc inst_loc) pred 
-       id   = mkLocalId name (mkPredTy pred)
+       dict = Dict name pred inst_loc
     in
-    returnM (mapIPName (\n -> id) ip_name, Dict id pred inst_loc)
+    returnM (mapIPName (\n -> instToId dict) ip_name, dict)
 \end{code}
 
 
@@ -267,53 +271,28 @@ newIPDict orig ip_name ty
 
 
 \begin{code}
-tcInstCall :: InstOrigin  -> TcType -> TcM (ExprCoFn, TcType)
+tcInstCall :: InstOrigin -> TcType -> TcM (ExprCoFn, [TcTyVar], TcType)
 tcInstCall orig fun_ty -- fun_ty is usually a sigma-type
-  = tcInstType VanillaTv fun_ty        `thenM` \ (tyvars, theta, tau) ->
-    newDicts orig theta                `thenM` \ dicts ->
-    extendLIEs dicts           `thenM_`
-    let
-       inst_fn e = DictApp (mkHsTyApp (noLoc e) (mkTyVarTys tyvars)) (map instToId dicts)
-    in
-    returnM (mkCoercion inst_fn, tau)
-
-tcInstDataCon :: InstOrigin
-             -> TyVarDetails   -- Use this for the existential tyvars
-                               -- ExistTv when pattern-matching, 
-                               -- VanillaTv at a call of the constructor
-             -> DataCon
-             -> TcM ([TcType], -- Types to instantiate at
-                     [Inst],   -- Existential dictionaries to apply to
-                     [TcType], -- Argument types of constructor
-                     TcType,   -- Result type
-                     [TyVar])  -- Existential tyvars
-tcInstDataCon orig ex_tv_details data_con
-  = let 
-       (tvs, stupid_theta, ex_tvs, ex_theta, arg_tys, tycon) = dataConSig data_con
-            -- We generate constraints for the stupid theta even when 
-            -- pattern matching (as the Report requires)
-    in
-    mappM (tcInstTyVar VanillaTv)     tvs      `thenM` \ tvs' ->
-    mappM (tcInstTyVar ex_tv_details) ex_tvs   `thenM` \ ex_tvs' ->
-    let
-       tv_tys'    = mkTyVarTys tvs'
-       ex_tv_tys' = mkTyVarTys ex_tvs'
-       all_tys'   = tv_tys' ++ ex_tv_tys'
-
-       tenv          = mkTopTyVarSubst (tvs ++ ex_tvs) all_tys'
-       stupid_theta' = substTheta tenv stupid_theta
-       ex_theta'     = substTheta tenv ex_theta
-       arg_tys'      = map (substTy tenv) arg_tys
-       result_ty'    = mkTyConApp tycon tv_tys'
-    in
-    newDicts orig stupid_theta'        `thenM` \ stupid_dicts ->
-    newDicts orig ex_theta'    `thenM` \ ex_dicts ->
-
-       -- Note that we return the stupid theta *only* in the LIE;
-       -- we don't otherwise use it at all
-    extendLIEs stupid_dicts    `thenM_`
-
-    returnM (all_tys', ex_dicts, arg_tys', result_ty', ex_tvs')
+  = do { (tyvars, theta, tau) <- tcInstType fun_ty
+       ; dicts <- newDicts orig theta
+       ; extendLIEs dicts
+       ; let inst_fn e = unLoc (mkHsDictApp (mkHsTyApp (noLoc e) (mkTyVarTys tyvars)) 
+                                            (map instToId dicts))
+       ; return (mkCoercion inst_fn, tyvars, tau) }
+
+tcInstStupidTheta :: DataCon -> [TcType] -> TcM ()
+-- Instantiate the "stupid theta" of the data con, and throw 
+-- the constraints into the constraint set
+tcInstStupidTheta data_con inst_tys
+  | null stupid_theta
+  = return ()
+  | otherwise
+  = do { stupid_dicts <- newDicts (OccurrenceOf (dataConName data_con))
+                                  (substTheta tenv stupid_theta)
+       ; extendLIEs stupid_dicts }
+  where
+    stupid_theta = dataConStupidTheta data_con
+    tenv = zipTopTvSubst (dataConTyVars data_con) inst_tys
 
 newMethodFromName :: InstOrigin -> TcType -> Name -> TcM TcId
 newMethodFromName origin ty name
@@ -363,7 +342,7 @@ checkKind tv ty
          then return ()
          else do
        { traceTc (text "checkKind: adding kind constraint" <+> ppr tv <+> ppr ty)
-       ; tv1 <- tcInstTyVar VanillaTv tv
+       ; tv1 <- tcInstTyVar tv
        ; unifyTauTy (mkTyVarTy tv1) ty1 }}
 
 
@@ -421,8 +400,10 @@ newLitInst orig lit expected_ty
   = getInstLoc orig            `thenM` \ loc ->
     newUnique                  `thenM` \ new_uniq ->
     let
-       lit_inst = LitInst lit_id lit expected_ty loc
-       lit_id   = mkSysLocal FSLIT("lit") new_uniq expected_ty
+       lit_nm   = mkSystemVarNameEncoded new_uniq FSLIT("lit")
+               -- The "encoded" bit means that we don't need to z-encode
+               -- the string every time we call this!
+       lit_inst = LitInst lit_nm lit expected_ty loc
     in
     extendLIE lit_inst         `thenM_`
     returnM (L (instLocSrcSpan loc) (HsVar (instToId lit_inst)))
@@ -463,15 +444,13 @@ mkRatLit r
 %*                                                                     *
 %************************************************************************
 
-Zonking makes sure that the instance types are fully zonked,
-but doesn't do the same for any of the Ids in an Inst.  There's no
-need, and it's a lot of extra work.
+Zonking makes sure that the instance types are fully zonked.
 
 \begin{code}
 zonkInst :: Inst -> TcM Inst
-zonkInst (Dict id pred loc)
+zonkInst (Dict name pred loc)
   = zonkTcPredType pred                        `thenM` \ new_pred ->
-    returnM (Dict id new_pred loc)
+    returnM (Dict name new_pred loc)
 
 zonkInst (Method m id tys theta tau loc) 
   = zonkId id                  `thenM` \ new_id ->
@@ -484,9 +463,9 @@ zonkInst (Method m id tys theta tau loc)
     zonkTcType tau             `thenM` \ new_tau ->
     returnM (Method m new_id new_tys new_theta new_tau loc)
 
-zonkInst (LitInst id lit ty loc)
+zonkInst (LitInst nm lit ty loc)
   = zonkTcType ty                      `thenM` \ new_ty ->
-    returnM (LitInst id lit new_ty loc)
+    returnM (LitInst nm lit new_ty loc)
 
 zonkInsts insts = mappM zonkInst insts
 \end{code}
@@ -522,8 +501,8 @@ pprInsts insts  = brackets (interpp'SP insts)
 
 pprInst, pprInstInFull :: Inst -> SDoc
 -- Debugging: print the evidence :: type
-pprInst (LitInst id lit ty loc) = ppr id <+> dcolon <+> ppr ty
-pprInst (Dict id pred loc)      = ppr id <+> dcolon <+> pprPred pred
+pprInst (LitInst nm lit ty loc) = ppr nm <+> dcolon <+> ppr ty
+pprInst (Dict nm pred loc)      = ppr nm <+> dcolon <+> pprPred pred
 
 pprInst m@(Method inst_id id tys theta tau loc)
   = ppr inst_id <+> dcolon <+> 
@@ -542,11 +521,9 @@ pprDFuns dfuns = vcat [ hang (ppr (getSrcLoc dfun) <> colon)
                      , let (_, theta, clas, tys) = tcSplitDFunTy (idType dfun) ]
        -- Print without the for-all, which the programmer doesn't write
 
-show_uniq u = ifPprDebug (text "{-" <> ppr u <> text "-}")
-
 tidyInst :: TidyEnv -> Inst -> Inst
-tidyInst env (LitInst u lit ty loc)         = LitInst u lit (tidyType env ty) loc
-tidyInst env (Dict u pred loc)              = Dict u (tidyPred env pred) loc
+tidyInst env (LitInst nm lit ty loc)        = LitInst nm lit (tidyType env ty) loc
+tidyInst env (Dict nm pred loc)             = Dict nm (tidyPred env pred) loc
 tidyInst env (Method u id tys theta tau loc) = Method u id (tidyTypes env tys) theta tau loc
 
 tidyMoreInsts :: TidyEnv -> [Inst] -> (TidyEnv, [Inst])
@@ -590,19 +567,30 @@ addInst :: DynFlags -> InstEnv -> DFunId -> TcM InstEnv
 -- Check that the proposed new instance is OK, 
 -- and then add it to the home inst env
 addInst dflags home_ie dfun
-  = do {       -- Load imported instances, so that we report
+  = do {       -- Instantiate the dfun type so that we extend the instance
+               -- envt with completely fresh template variables
+               -- This is important because the template variables must
+               -- not overlap with anything in the things being looked up
+               -- (since we do unification).  
+               -- We use tcSkolType because we don't want to allocate fresh
+               -- *meta* type variables.  
+         (tvs', theta', tau') <- tcSkolType (InstSkol dfun) (idType dfun)
+       ; let   (cls, tys') = tcSplitDFunHead tau'
+               dfun'       = setIdType dfun (mkSigmaTy tvs' theta' tau')           
+
+               -- Load imported instances, so that we report
                -- duplicates correctly
-         pkg_ie  <- loadImportedInsts cls tys
+       ; pkg_ie  <- loadImportedInsts cls tys'
 
                -- Check functional dependencies
-       ; case checkFunDeps (pkg_ie, home_ie) dfun of
+       ; case checkFunDeps (pkg_ie, home_ie) dfun' of
                Just dfuns -> funDepErr dfun dfuns
                Nothing    -> return ()
 
                -- Check for duplicate instance decls
-       ; let { (matches, _) = lookupInstEnv dflags (pkg_ie, home_ie) cls tys
+       ; let { (matches, _) = lookupInstEnv dflags (pkg_ie, home_ie) cls tys'
              ; dup_dfuns = [dup_dfun | (_, (_, dup_tys, dup_dfun)) <- matches,
-                                       isJust (matchTys (mkVarSet tvs) tys dup_tys)] }
+                                       isJust (tcMatchTys (mkVarSet tvs') tys' dup_tys)] }
                -- Find memebers of the match list which 
                -- dfun itself matches. If the match is 2-way, it's a duplicate
        ; case dup_dfuns of
@@ -610,9 +598,8 @@ addInst dflags home_ie dfun
            []           -> return ()
 
                -- OK, now extend the envt
-       ; return (extendInstEnv home_ie dfun) }
-  where
-    (tvs, _, cls, tys) = tcSplitDFunTy (idType dfun)
+       ; return (extendInstEnv home_ie dfun') }
+
 
 traceDFuns dfuns
   = traceTc (text "Adding instances:" <+> vcat (map pp dfuns))
@@ -629,10 +616,11 @@ dupInstErr dfun dup_dfun
               2 (pprDFuns [dfun, dup_dfun]))
 
 addDictLoc dfun thing_inside
-  = addSrcSpan (mkSrcSpan loc loc) thing_inside
+  = setSrcSpan (mkSrcSpan loc loc) thing_inside
   where
    loc = getSrcLoc dfun
 \end{code}
+    
 
 %************************************************************************
 %*                                                                     *
@@ -641,12 +629,12 @@ addDictLoc dfun thing_inside
 %************************************************************************
 
 \begin{code}
-data LookupInstResult s
+data LookupInstResult
   = NoInstance
   | SimpleInst (LHsExpr TcId)          -- Just a variable, type application, or literal
   | GenInst    [Inst] (LHsExpr TcId)   -- The expression and its needed insts
 
-lookupInst :: Inst -> TcM (LookupInstResult s)
+lookupInst :: Inst -> TcM LookupInstResult
 -- It's important that lookupInst does not put any new stuff into
 -- the LIE.  Instead, any Insts needed by the lookup are returned in
 -- the LookupInstResult, where they can be further processed by tcSimplify
@@ -669,7 +657,7 @@ lookupInst inst@(Method _ id tys theta _ loc)
 --  may have done some unification by now]             
 
 
-lookupInst inst@(LitInst u (HsIntegral i from_integer_name) ty loc)
+lookupInst inst@(LitInst _nm (HsIntegral i from_integer_name) ty loc)
   | Just expr <- shortCutIntLit i ty
   = returnM (GenInst [] expr)  -- GenInst, not SimpleInst, because 
                                        -- expr may be a constructor application
@@ -682,7 +670,7 @@ lookupInst inst@(LitInst u (HsIntegral i from_integer_name) ty loc)
                     (mkHsApp (L (instLocSrcSpan loc)
                                 (HsVar (instToId method_inst))) integer_lit))
 
-lookupInst inst@(LitInst u (HsFractional f from_rat_name) ty loc)
+lookupInst inst@(LitInst _nm (HsFractional f from_rat_name) ty loc)
   | Just expr <- shortCutFracLit f ty
   = returnM (GenInst [] expr)
 
@@ -716,36 +704,47 @@ lookupInst dict@(Dict _ pred@(ClassP clas tys) loc)
 lookupInst (Dict _ _ _) = returnM NoInstance
 
 -----------------
+instantiate_dfun :: TvSubst -> DFunId -> TcPredType -> InstLoc -> TcM LookupInstResult
 instantiate_dfun tenv dfun_id pred loc
-  = traceTc (text "lookupInst success" <+> 
+  = -- tenv is a substitution that instantiates the dfun_id 
+    -- to match the requested result type.   
+    -- 
+    -- We ASSUME that the dfun is quantified over the very same tyvars 
+    -- that are bound by the tenv.
+    -- 
+    -- However, the dfun
+    -- might have some tyvars that *only* appear in arguments
+    -- dfun :: forall a b. C a b, Ord b => D [a]
+    -- We instantiate b to a flexi type variable -- it'll presumably
+    -- become fixed later via functional dependencies
+    traceTc (text "lookupInst success" <+> 
                vcat [text "dict" <+> ppr pred, 
                      text "witness" <+> ppr dfun_id <+> ppr (idType dfun_id) ]) `thenM_`
        -- Record that this dfun is needed
     record_dfun_usage dfun_id          `thenM_`
 
+    getStage                                           `thenM` \ use_stage ->
+    checkWellStaged (ptext SLIT("instance for") <+> quotes (ppr pred))
+                   (topIdLvl dfun_id) use_stage        `thenM_`
+
        -- It's possible that not all the tyvars are in
        -- the substitution, tenv. For example:
        --      instance C X a => D X where ...
        -- (presumably there's a functional dependency in class C)
-       -- Hence the mk_ty_arg to instantiate any un-substituted tyvars.        
-    getStage                                           `thenM` \ use_stage ->
-    checkWellStaged (ptext SLIT("instance for") <+> quotes (ppr pred))
-                   (topIdLvl dfun_id) use_stage                `thenM_`
+       -- Hence the open_tvs to instantiate any un-substituted tyvars. 
     let
        (tyvars, rho) = tcSplitForAllTys (idType dfun_id)
-       mk_ty_arg tv  = case lookupSubstEnv tenv tv of
-                          Just (DoneTy ty) -> returnM ty
-                          Nothing          -> tcInstTyVar VanillaTv tv `thenM` \ tc_tv ->
-                                              returnM (mkTyVarTy tc_tv)
+       open_tvs      = filter (`notElemTvSubst` tenv) tyvars
     in
-    mappM mk_ty_arg tyvars     `thenM` \ ty_args ->
+    mappM tcInstTyVar open_tvs `thenM` \ open_tvs' ->
     let
-       dfun_rho   = substTy (mkTopTyVarSubst tyvars ty_args) rho
-               -- Since the tyvars are freshly made,
-               -- they cannot possibly be captured by
-               -- any existing for-alls.  Hence mkTopTyVarSubst
+       tenv' = extendTvSubstList tenv open_tvs (mkTyVarTys open_tvs')
+               -- Since the open_tvs' are freshly made, they cannot possibly be captured by
+               -- any nested for-alls in rho.  So the in-scope set is unchanged
+       dfun_rho   = substTy tenv' rho
        (theta, _) = tcSplitPhiTy dfun_rho
-       ty_app     = mkHsTyApp (L (instLocSrcSpan loc) (HsVar dfun_id)) ty_args
+       ty_app     = mkHsTyApp (L (instLocSrcSpan loc) (HsVar dfun_id)) 
+                              (map (substTyVar tenv') tyvars)
     in
     if null theta then
        returnM (SimpleInst ty_app)
@@ -756,14 +755,15 @@ instantiate_dfun tenv dfun_id pred loc
     in
     returnM (GenInst dicts rhs)
 
-record_dfun_usage dfun_id
-  | isInternalName dfun_name = return ()               -- From this module
-  | not (isHomePackageName dfun_name) = return ()      -- From another package package
-  | otherwise = getGblEnv      `thenM` \ tcg_env ->
-               updMutVar (tcg_inst_uses tcg_env)
+record_dfun_usage dfun_id = do
+  dflags <- getDOpts
+  let  dfun_name = idName dfun_id
+       dfun_mod  = nameModule dfun_name
+  if isInternalName dfun_name || not (isHomeModule dflags dfun_mod)
+       then return () -- internal, or in another package
+       else do tcg_env <- getGblEnv
+               updMutVar (tcg_inst_uses tcg_env)
                          (`addOneToNameSet` idName dfun_id)
-  where
-    dfun_name = idName dfun_id
 
 tcGetInstEnvs :: TcM (InstEnv, InstEnv)
 -- Gets both the external-package inst-env