[project @ 2001-11-26 10:26:59 by simonpj]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcInstDcls.lhs
index 8209b2e..49229c1 100644 (file)
@@ -9,11 +9,12 @@ module TcInstDcls ( tcInstDecls1, tcInstDecls2, tcAddDeclCtxt ) where
 #include "HsVersions.h"
 
 
-import CmdLineOpts     ( DynFlag(..), dopt )
+import CmdLineOpts     ( DynFlag(..) )
 
 import HsSyn           ( HsDecl(..), InstDecl(..), TyClDecl(..), HsType(..),
                          MonoBinds(..), HsExpr(..),  HsLit(..), Sig(..), HsTyVarBndr(..),
-                         andMonoBindList, collectMonoBinders, isClassDecl, toHsType
+                         andMonoBindList, collectMonoBinders, 
+                         isClassDecl, isIfaceInstDecl, toHsType
                        )
 import RnHsSyn         ( RenamedHsBinds, RenamedInstDecl, RenamedHsDecl, 
                          RenamedMonoBinds, RenamedTyClDecl, RenamedHsType, 
@@ -23,24 +24,27 @@ import TcHsSyn              ( TcMonoBinds, mkHsConApp )
 import TcBinds         ( tcSpecSigs )
 import TcClassDcl      ( tcMethodBind, badMethodErr )
 import TcMonad       
-import TcMType         ( tcInstTyVars, checkValidTheta, UserTypeCtxt(..), SourceTyCtxt(..) )
-import TcType          ( tcSplitDFunTy, tcIsTyVarTy, tcSplitTyConApp_maybe,
-                         tyVarsOfTypes, mkClassPred, mkTyVarTy,
-                         tcSplitSigmaTy, tcSplitPredTy_maybe, getClassPredTys_maybe
+import TcMType         ( tcInstSigTyVars, checkValidTheta, checkValidInstHead, instTypeErr, 
+                         UserTypeCtxt(..), SourceTyCtxt(..) )
+import TcType          ( tcSplitDFunTy, mkClassPred, mkTyVarTy, mkTyVarTys,
+                         tcSplitSigmaTy, tcSplitPredTy_maybe, getClassPredTys,
+                         TyVarDetails(..)
                        )
 import Inst            ( InstOrigin(..),
                          newDicts, instToId,
                          LIE, mkLIE, emptyLIE, plusLIE, plusLIEs )
 import TcDeriv         ( tcDeriving )
 import TcEnv           ( TcEnv, tcExtendGlobalValEnv, 
-                         tcExtendTyVarEnvForMeths, 
+                         tcExtendTyVarEnvForMeths, tcLookupId,
                          tcAddImportedIdInfo, tcLookupClass,
                          InstInfo(..), pprInstInfo, simpleInstInfoTyCon, 
                          simpleInstInfoTy, newDFunName,
                          isLocalThing,
                        )
 import InstEnv         ( InstEnv, extendInstEnv )
-import TcMonoType      ( tcHsTyVars, kcHsSigType, tcHsType, tcHsSigType, checkSigTyVars )
+import PprType         ( pprClassPred )
+import TcMonoType      ( tcHsTyVars, kcHsSigType, tcHsType, tcHsSigType )
+import TcUnify         ( checkSigTyVars )
 import TcSimplify      ( tcSimplifyCheck )
 import HscTypes                ( HomeSymbolTable, DFunId,
                          ModDetails(..), PackageInstEnv, PersistentRenamerState
@@ -48,28 +52,24 @@ import HscTypes             ( HomeSymbolTable, DFunId,
 
 import Subst           ( substTy, substTheta )
 import DataCon         ( classDataCon )
-import Class           ( Class, DefMeth(..), classBigSig )
+import Class           ( Class, classBigSig )
 import Var             ( idName, idType )
 import VarSet          ( emptyVarSet )
-import Maybes          ( maybeToBool )
+import Id              ( setIdLocalExported )
 import MkId            ( mkDictFunId )
 import FunDeps         ( checkInstFDs )
 import Generics                ( validGenericInstanceType )
 import Module          ( Module, foldModuleEnv )
 import Name            ( getSrcLoc )
-import NameSet         ( unitNameSet, nameSetToList )
+import NameSet         ( unitNameSet, emptyNameSet, nameSetToList )
 import PrelInfo                ( eRROR_ID )
-import PprType         ( pprClassPred )
-import TyCon           ( TyCon, isSynTyCon )
+import TyCon           ( TyCon )
 import Subst           ( mkTopTyVarSubst, substTheta )
-import VarSet          ( varSetElems )
-import TysWiredIn      ( genericTyCons, isFFIArgumentTy, isFFIImportResultTy )
-import ForeignCall     ( Safety(..) )
-import PrelNames       ( cCallableClassKey, cReturnableClassKey, hasKey )
+import TysWiredIn      ( genericTyCons )
 import Name             ( Name )
 import SrcLoc           ( SrcLoc )
-import VarSet           ( varSetElems )
 import Unique          ( Uniquable(..) )
+import Util             ( lengthExceeds )
 import BasicTypes      ( NewOrData(..), Fixity )
 import ErrUtils                ( dumpIfSet_dyn )
 import ListSetOps      ( Assoc, emptyAssoc, plusAssoc_C, mapAssoc, 
@@ -177,9 +177,11 @@ tcInstDecls1 inst_env0 prs hst unf_env get_fixity this_mod decls
        inst_decls = [inst_decl | InstD inst_decl <- decls]     
        tycl_decls = [decl      | TyClD decl <- decls]
        clas_decls = filter isClassDecl tycl_decls
+       (imported_inst_ds, local_inst_ds) = partition isIfaceInstDecl inst_decls
     in
        -- (1) Do the ordinary instance declarations
-    mapNF_Tc tcInstDecl1 inst_decls            `thenNF_Tc` \ inst_infos ->
+    mapNF_Tc tcInstDecl1 local_inst_ds         `thenNF_Tc` \ local_inst_infos ->
+    mapNF_Tc tcInstDecl1 imported_inst_ds      `thenNF_Tc` \ imported_inst_infos ->
 
        -- (2) Instances from generic class declarations
     getGenericInstances clas_decls             `thenTc` \ generic_inst_info -> 
@@ -192,17 +194,14 @@ tcInstDecls1 inst_env0 prs hst unf_env get_fixity this_mod decls
        --      e) generic instances                                    inst_env4
        -- The result of (b) replaces the cached InstEnv in the PCS
     let
-       (local_inst_info, imported_inst_info) 
-               = partition (isLocalThing this_mod . iDFunId) (concat inst_infos)
-
-       imported_dfuns   = map (tcAddImportedIdInfo unf_env . iDFunId) 
-                              imported_inst_info
-       hst_dfuns        = foldModuleEnv ((++) . md_insts) [] hst
+       local_inst_info    = concat local_inst_infos
+       imported_inst_info = concat imported_inst_infos
+       hst_dfuns          = foldModuleEnv ((++) . md_insts) [] hst
     in 
 
 --    pprTrace "tcInstDecls" (vcat [ppr imported_dfuns, ppr hst_dfuns]) $
 
-    addInstDFuns inst_env0 imported_dfuns      `thenNF_Tc` \ inst_env1 ->
+    addInstInfos inst_env0 imported_inst_info  `thenNF_Tc` \ inst_env1 ->
     addInstDFuns inst_env1 hst_dfuns           `thenNF_Tc` \ inst_env2 ->
     addInstInfos inst_env2 local_inst_info     `thenNF_Tc` \ inst_env3 ->
     addInstInfos inst_env3 generic_inst_info   `thenNF_Tc` \ inst_env4 ->
@@ -211,7 +210,7 @@ tcInstDecls1 inst_env0 prs hst unf_env get_fixity this_mod decls
        --     note that we only do derivings for things in this module; 
        --     we ignore deriving decls from interfaces!
        -- This stuff computes a context for the derived instance decl, so it
-       -- needs to know about all the instances possible; hecne inst_env4
+       -- needs to know about all the instances possible; hence inst_env4
     tcDeriving prs this_mod inst_env4 get_fixity tycl_decls
                                        `thenTc` \ (deriv_inst_info, deriv_binds) ->
     addInstInfos inst_env4 deriv_inst_info             `thenNF_Tc` \ final_inst_env ->
@@ -253,34 +252,32 @@ tcInstDecl1 decl@(InstDecl poly_ty binds uprags maybe_dfun_name src_loc)
     tcHsType poly_ty                   `thenTc` \ poly_ty' ->
     let
        (tyvars, theta, tau) = tcSplitSigmaTy poly_ty'
-       maybe_cls_tys         = case tcSplitPredTy_maybe tau of 
-                                  Just pred -> getClassPredTys_maybe pred
-                                  Nothing   -> Nothing 
-       Just (clas, inst_tys) = maybe_cls_tys
+       (clas,inst_tys)      = case tcSplitPredTy_maybe tau of { Just st -> getClassPredTys st }
+               -- The checkValidInstHead makes sure these splits succeed
     in
-    checkTc (maybeToBool maybe_cls_tys) (instHeadErr tau)      `thenTc_`    
-
     (case maybe_dfun_name of
        Nothing ->      -- A source-file instance declaration
-
                -- Check for respectable instance type, and context
                -- but only do this for non-imported instance decls.
                -- Imported ones should have been checked already, and may indeed
                -- contain something illegal in normal Haskell, notably
                --      instance CCallable [Char] 
-           getDOptsTc                                          `thenTc` \ dflags -> 
-           checkValidTheta InstDeclCtxt theta                  `thenTc_`
-           checkValidInstHead dflags theta clas inst_tys       `thenTc_`
-           newDFunName clas inst_tys src_loc
+           checkValidTheta InstThetaCtxt theta         `thenTc_`
+           checkValidInstHead tau                      `thenTc_`
+           checkTc (checkInstFDs theta clas inst_tys)
+                   (instTypeErr (pprClassPred clas inst_tys) msg)      `thenTc_`
+           newDFunName clas inst_tys src_loc                           `thenTc` \ dfun_name ->
+           returnTc (mkDictFunId dfun_name clas tyvars inst_tys theta)
 
        Just dfun_name ->       -- An interface-file instance declaration
-                           returnNF_Tc dfun_name
-    )                                          `thenNF_Tc` \ dfun_name ->
-
-    let
-       dfun_id = mkDictFunId dfun_name clas tyvars inst_tys theta
-    in
+                               -- Should be in scope by now, because we should
+                               -- have sucked in its interface-file definition
+                               -- So it will be replete with its unfolding etc
+                         tcLookupId dfun_name
+    )                                                  `thenNF_Tc` \ dfun_id ->
     returnTc [InstInfo { iDFunId = dfun_id, iBinds = binds, iPrags = uprags }]
+  where
+    msg  = parens (ptext SLIT("the instance types do not agree with the functional dependencies of the class"))
 \end{code}
 
 
@@ -337,7 +334,7 @@ get_generics decl@(ClassDecl {tcdName = class_name, tcdMeths = Just def_methods,
   | null groups                
   = returnTc [] -- The comon case: no generic default methods
 
-  | otherwise  -- A local class decl with generic default methods
+  | otherwise  -- A source class decl with generic default methods
   = recoverNF_Tc (returnNF_Tc [])                              $
     tcAddDeclCtxt decl                                         $
     tcLookupClass class_name                                   `thenTc` \ clas ->
@@ -355,7 +352,7 @@ get_generics decl@(ClassDecl {tcdName = class_name, tcdMeths = Just def_methods,
        tc_inst_infos = [(simpleInstInfoTyCon i, i) | i <- inst_infos]
 
        bad_groups = [group | group <- equivClassesByUniq get_uniq tc_inst_infos,
-                             length group > 1]
+                             group `lengthExceeds` 1]
        get_uniq (tc,_) = getUnique tc
     in
     mapTc (addErrTc . dupGenericInsts) bad_groups      `thenTc_`
@@ -530,15 +527,15 @@ tcInstDecl2 (InstInfo { iDFunId = dfun_id,
     let
        (inst_tyvars, dfun_theta, clas, inst_tys) = tcSplitDFunTy (idType dfun_id)
     in
-    tcInstTyVars inst_tyvars           `thenNF_Tc` \ (inst_tyvars', _, tenv) ->
+    tcInstSigTyVars InstTv inst_tyvars         `thenNF_Tc` \ inst_tyvars' ->
     let
+       tenv        = mkTopTyVarSubst inst_tyvars (mkTyVarTys inst_tyvars')
        inst_tys'   = map (substTy tenv) inst_tys
        dfun_theta' = substTheta tenv dfun_theta
        origin      = InstanceDeclOrigin
 
         (class_tyvars, sc_theta, _, op_items) = classBigSig clas
 
-       dm_ids    = [dm_id | (_, DefMeth dm_id) <- op_items]
        sel_names = [idName sel_id | (sel_id, _) <- op_items]
 
         -- Instantiate the super-class context with inst_tys
@@ -559,14 +556,15 @@ tcInstDecl2 (InstInfo { iDFunId = dfun_id,
        -- The type variable from the dict fun actually scope 
        -- over the bindings.  They were gotten from
        -- the original instance declaration
-       tcExtendGlobalValEnv dm_ids (
-               -- Default-method Ids may be mentioned in synthesised RHSs 
+
+               -- Default-method Ids may be mentioned in synthesised RHSs,
+               -- but they'll already be in the environment.
 
        mapAndUnzip3Tc (tcMethodBind clas origin inst_tyvars' inst_tys'
                                     dfun_theta'
                                     monobinds uprags True)
                       op_items
-    ))                 `thenTc` \ (method_binds_s, insts_needed_s, meth_insts) ->
+    )                  `thenTc` \ (method_binds_s, insts_needed_s, meth_insts) ->
 
        -- Deal with SPECIALISE instance pragmas by making them
        -- look like SPECIALISE pragmas for the dfun
@@ -611,14 +609,22 @@ tcInstDecl2 (InstInfo { iDFunId = dfun_id,
 
        -- Create the result bindings
     let
+       local_dfun_id = setIdLocalExported dfun_id
+               -- Reason for setIdLocalExported: see notes with MkId.mkDictFunId
+
         dict_constr   = classDataCon clas
        scs_and_meths = map instToId (sc_dicts ++ meth_insts)
        this_dict_id  = instToId this_dict
-       inlines       = unitNameSet (idName dfun_id)
+       inlines       | null dfun_arg_dicts = emptyNameSet
+                     | otherwise           = unitNameSet (idName dfun_id)
                -- Always inline the dfun; this is an experimental decision
                -- because it makes a big performance difference sometimes.
                -- Often it means we can do the method selection, and then
                -- inline the method as well.  Marcin's idea; see comments below.
+               --
+               -- BUT: don't inline it if it's a constant dictionary;
+               -- we'll get all the benefit without inlining, and we get
+               -- a **lot** of code duplication if we inline it
 
        dict_rhs
          | null scs_and_meths
@@ -650,7 +656,7 @@ tcInstDecl2 (InstInfo { iDFunId = dfun_id,
          = AbsBinds
                 zonked_inst_tyvars
                 (map instToId dfun_arg_dicts)
-                [(inst_tyvars', dfun_id, this_dict_id)] 
+                [(inst_tyvars', local_dfun_id, this_dict_id)] 
                 inlines
                 (lie_binds1    `AndMonoBinds` 
                  lie_binds2    `AndMonoBinds`
@@ -754,89 +760,6 @@ simplified: only zeze2 is extracted and its body is simplified.
 
 %************************************************************************
 %*                                                                     *
-\subsection{Checking for a decent instance type}
-%*                                                                     *
-%************************************************************************
-
-@checkValidInstHead@ checks the type {\em and} its syntactic constraints:
-it must normally look like: @instance Foo (Tycon a b c ...) ...@
-
-The exceptions to this syntactic checking: (1)~if the @GlasgowExts@
-flag is on, or (2)~the instance is imported (they must have been
-compiled elsewhere). In these cases, we let them go through anyway.
-
-We can also have instances for functions: @instance Foo (a -> b) ...@.
-
-\begin{code}
-checkValidInstHead dflags theta clas inst_tys
-  | null errs = returnTc ()
-  | otherwise = addErrsTc errs `thenNF_Tc_` failTc
-  where
-    errs = check_inst_head dflags theta clas inst_tys
-
-check_inst_head dflags theta clas inst_taus
-  |    -- CCALL CHECK
-       -- A user declaration of a CCallable/CReturnable instance
-       -- must be for a "boxed primitive" type.
-        (clas `hasKey` cCallableClassKey   
-            && not (ccallable_type dflags first_inst_tau)) 
-        ||
-        (clas `hasKey` cReturnableClassKey 
-            && not (creturnable_type first_inst_tau))
-  = [nonBoxedPrimCCallErr clas first_inst_tau]
-
-       -- If GlasgowExts then check at least one isn't a type variable
-  | dopt Opt_GlasgowExts dflags
-  =    -- GlasgowExts case
-    check_tyvars dflags clas inst_taus ++ check_fundeps dflags theta clas inst_taus
-
-       -- WITH HASKELL 1.4, MUST HAVE C (T a b c)
-  | not (length inst_taus == 1 &&
-         maybeToBool maybe_tycon_app &&                -- Yes, there's a type constuctor
-         not (isSynTyCon tycon) &&             -- ...but not a synonym
-         all tcIsTyVarTy arg_tys &&            -- Applied to type variables
-        length (varSetElems (tyVarsOfTypes arg_tys)) == length arg_tys
-          -- This last condition checks that all the type variables are distinct
-        )
-  = [instTypeErr clas inst_taus
-                (text "the instance type must be of form (T a b c)" $$
-                 text "where T is not a synonym, and a,b,c are distinct type variables")]
-
-  | otherwise
-  = []
-
-  where
-    (first_inst_tau : _)       = inst_taus
-
-       -- Stuff for algebraic or -> type
-    maybe_tycon_app      = tcSplitTyConApp_maybe first_inst_tau
-    Just (tycon, arg_tys) = maybe_tycon_app
-
-    ccallable_type   dflags ty = isFFIArgumentTy dflags PlayRisky ty
-    creturnable_type        ty = isFFIImportResultTy dflags ty
-       
-check_tyvars dflags clas inst_taus
-       -- Check that at least one isn't a type variable
-       -- unless -fallow-undecideable-instances
-  | dopt Opt_AllowUndecidableInstances dflags = []
-  | not (all tcIsTyVarTy inst_taus)          = []
-  | otherwise                                = [the_err]
-  where
-    the_err = instTypeErr clas inst_taus msg
-    msg     =  ptext SLIT("There must be at least one non-type-variable in the instance head")
-           $$ ptext SLIT("Use -fallow-undecidable-instances to lift this restriction")
-
-check_fundeps dflags theta clas inst_taus
-  | checkInstFDs theta clas inst_taus = []
-  | otherwise                        = [the_err]
-  where
-    the_err = instTypeErr clas inst_taus msg
-    msg  = ptext SLIT("the instance types do not agree with the functional dependencies of the class")
-\end{code}
-
-
-%************************************************************************
-%*                                                                     *
 \subsection{Error messages}
 %*                                                                     *
 %************************************************************************
@@ -872,8 +795,6 @@ badGenericInstanceType binds
 missingGenericInstances missing
   = ptext SLIT("Missing type patterns for") <+> pprQuotedList missing
          
-
-
 dupGenericInsts tc_inst_infos
   = vcat [ptext SLIT("More than one type pattern for a single generic type constructor:"),
          nest 4 (vcat (map ppr_inst_ty tc_inst_infos)),
@@ -882,20 +803,6 @@ dupGenericInsts tc_inst_infos
   where 
     ppr_inst_ty (tc,inst) = ppr (simpleInstInfoTy inst)
 
-instHeadErr ty
-  = vcat [ptext SLIT("Illegal instance head:") <+> ppr ty,
-         ptext SLIT("Instance head must be of form <context> => <class> <types>")]
-
-instTypeErr clas tys msg
-  = sep [ptext SLIT("Illegal instance declaration for") <+> 
-               quotes (pprClassPred clas tys),
-        nest 4 (parens msg)
-    ]
-
-nonBoxedPrimCCallErr clas inst_ty
-  = hang (ptext SLIT("Unacceptable instance type for ccall-ish class"))
-        4 (pprClassPred clas [inst_ty])
-
 methodCtxt     = ptext SLIT("When checking the methods of an instance declaration")
 superClassCtxt = ptext SLIT("When checking the super-classes of an instance declaration")
 \end{code}