[project @ 1998-04-06 18:38:36 by sof]
[ghc-hetmet.git] / ghc / compiler / typecheck / TcInstDcls.lhs
index 900d97f..1c1b1f0 100644 (file)
@@ -11,77 +11,62 @@ module TcInstDcls (
 
 #include "HsVersions.h"
 
-import HsSyn           ( HsDecl(..), InstDecl(..), HsType(..), 
+import HsSyn           ( HsDecl(..), InstDecl(..),
                          HsBinds(..), MonoBinds(..), GRHSsAndBinds(..), GRHS(..),
-                         HsExpr(..), InPat(..), HsLit(..),
+                         HsExpr(..), InPat(..), HsLit(..), Sig(..),
                          unguardedRHS,
                          collectMonoBinders, andMonoBinds
                        )
+import HsBinds         ( sigsForMe )
 import RnHsSyn         ( RenamedHsBinds, RenamedMonoBinds,
-                         RenamedInstDecl, RenamedFixityDecl, RenamedHsExpr,
-                         RenamedSig, RenamedSpecInstSig, RenamedHsDecl
+                         RenamedInstDecl, RenamedHsExpr,
+                         RenamedSig, RenamedHsDecl
+                       )
+import TcHsSyn         ( TcMonoBinds, TcIdOcc(..), TcIdBndr, 
+                         maybeBoxedPrimType, tcIdType
                        )
-import TcHsSyn         ( TcHsBinds,
-                         TcMonoBinds, TcExpr, TcIdOcc(..), TcIdBndr, 
-                         tcIdType, maybeBoxedPrimType, 
-                         mkHsTyLam, mkHsTyApp,
-                         mkHsDictLam, mkHsDictApp )
 
-import TcBinds         ( tcPragmaSigs, sigThetaCtxt )
+import TcBinds         ( tcPragmaSigs )
 import TcClassDcl      ( tcMethodBind, badMethodErr )
 import TcMonad
 import RnMonad         ( RnNameSupply )
-import Inst            ( Inst, InstOrigin(..), InstanceMapper,
-                         instToId, newDicts, newMethod, LIE, emptyLIE, plusLIE )
-import PragmaInfo      ( PragmaInfo(..) )
+import Inst            ( Inst, InstOrigin(..),
+                         newDicts, LIE, emptyLIE, plusLIE, plusLIEs )
 import TcDeriv         ( tcDeriving )
-import TcEnv           ( tcLookupClass, newLocalId, tcGetGlobalTyVars,
-                         tcExtendGlobalValEnv, tcAddImportedIdInfo
-                       )
-import TcInstUtil      ( InstInfo(..), mkInstanceRelatedIds, buildInstanceEnvs, classDataCon )
+import TcEnv           ( tcExtendGlobalValEnv, tcAddImportedIdInfo )
+import TcInstUtil      ( InstInfo(..), mkInstanceRelatedIds, classDataCon )
 import TcKind          ( TcKind, unifyKind )
-import TcMatches       ( tcMatchesFun )
-import TcMonoType      ( tcTyVarScope, tcContext, tcHsTypeKind, tcHsType )
+import TcMonoType      ( tcHsType )
 import TcSimplify      ( tcSimplifyAndCheck )
 import TcType          ( TcType, TcTyVar, TcTyVarSet, 
-                         zonkSigTyVar,
-                         tcInstSigTyVars, tcInstType, tcInstSigTcType, 
-                         tcInstTheta, tcInstTcType
+                         zonkSigTyVar, tcInstSigTyVars, tcInstType, tcInstTheta
                        )
-import Unify           ( unifyTauTy, unifyTauTyLists )
-
 
 import Bag             ( emptyBag, unitBag, unionBags, unionManyBags,
-                         concatBag, foldBag, bagToList, listToBag,
-                         Bag
+                         foldBag, bagToList, Bag
                        )
-import CmdLineOpts     ( opt_GlasgowExts, 
-                         opt_SpecialiseOverloaded, opt_WarnMissingMethods
-                       )
-import Class           ( classBigSig, classTyCon, Class )
-import Id              ( idType, replacePragmaInfo,
-                         isNullaryDataCon, dataConArgTys, Id )
-import ListSetOps      ( minusList )
-import Maybes          ( maybeToBool, expectJust, seqMaybe, catMaybes )
-import Name            ( nameOccName, getSrcLoc, mkLocalName,
+import CmdLineOpts     ( opt_GlasgowExts, opt_WarnMissingMethods )
+import Class           ( classBigSig, Class )
+import Id              ( isNullaryDataCon, dataConArgTys, replaceIdInfo, idName, Id )
+import Maybes          ( maybeToBool, seqMaybe, catMaybes )
+import Name            ( nameOccName, mkLocalName,
                          isLocallyDefined, Module,
                          NamedThing(..)
                        )
-import PrelVals                ( nO_METHOD_BINDING_ERROR_ID )
-import PprType         ( pprParendGenType,  pprConstraint )
+import PrelVals                ( nO_METHOD_BINDING_ERROR_ID, eRROR_ID )
+import PprType         ( pprParendType,  pprConstraint )
 import SrcLoc          ( SrcLoc, noSrcLoc )
-import TyCon           ( tyConDataCons, isSynTyCon, isDataTyCon, tyConDerivings )
-import Type            ( Type, ThetaType, mkTyVarTys, isUnpointedType,
-                         splitSigmaTy, splitAppTys, isTyVarTy, matchTy, mkSigmaTy,
-                         splitTyConApp_maybe, getTyVar, splitDictTy_maybe,
-                         splitAlgTyConApp_maybe, splitRhoTy, isSynTy,
+import TyCon           ( isSynTyCon, isDataTyCon, tyConDerivings )
+import Type            ( Type, ThetaType, isUnpointedType,
+                         splitSigmaTy, isTyVarTy, mkSigmaTy,
+                         splitTyConApp_maybe, splitDictTy_maybe,
+                         splitAlgTyConApp_maybe, splitRhoTy,
                          tyVarsOfTypes
                        )
 import TyVar           ( zipTyVarEnv, mkTyVarSet, tyVarSetToList, TyVar )
 import TysPrim         ( byteArrayPrimTyCon, mutableByteArrayPrimTyCon )
 import TysWiredIn      ( stringTy )
 import Unique          ( Unique, cCallableClassKey, cReturnableClassKey, Uniquable(..) )
-import Util            ( zipEqual, removeDups )
 import Outputable
 \end{code}
 
@@ -345,7 +330,6 @@ tcInstDecl2 (InstInfo clas inst_tyvars inst_tys
     tcInstTheta tenv inst_decl_theta   `thenNF_Tc` \ inst_decl_theta' ->
 
          -- Instantiate the super-class context with inst_tys
-    
     tcInstTheta (zipTyVarEnv class_tyvars inst_tys') sc_theta          `thenNF_Tc` \ sc_theta' ->
 
         -- Create dictionary Ids from the specified instance contexts.
@@ -354,10 +338,6 @@ tcInstDecl2 (InstInfo clas inst_tyvars inst_tys
     newDicts origin inst_decl_theta'   `thenNF_Tc` \ (inst_decl_dicts, _) ->
     newDicts origin [(clas,inst_tys')] `thenNF_Tc` \ (this_dict,       [this_dict_id]) ->
 
-       -- Now process any INLINE or SPECIALIZE pragmas for the methods
-       -- ...[NB May 97; all ignored except INLINE]
-    tcPragmaSigs uprags                      `thenTc` \ (prag_fn, spec_binds, spec_lie) ->
-
         -- Check that all the method bindings come from this class
     let
        check_from_this_class (bndr, loc)
@@ -372,10 +352,18 @@ tcInstDecl2 (InstInfo clas inst_tyvars inst_tys
     tcExtendGlobalValEnv (catMaybes defm_ids) (
 
                -- Default-method Ids may be mentioned in synthesised RHSs 
-       mapAndUnzip3Tc (tcInstMethodBind clas inst_tys' inst_tyvars' monobinds) 
+       mapAndUnzip3Tc (tcInstMethodBind clas inst_tys' inst_tyvars' monobinds uprags) 
                       (op_sel_ids `zip` defm_ids)
     )                  `thenTc` \ (method_binds_s, insts_needed_s, meth_lies_w_ids) ->
 
+       -- Deal with SPECIALISE instance pragmas
+    let
+       dfun_prags = [Sig (idName dfun_id) ty loc | SpecInstSig ty loc <- uprags]
+    in
+    tcExtendGlobalValEnv [dfun_id] (
+       tcPragmaSigs dfun_prags
+    )                                  `thenTc` \ (prag_info_fn, prag_binds, prag_lie) ->
+
        -- Check the overloading constraints of the methods and superclasses
     mapNF_Tc zonkSigTyVar inst_tyvars'         `thenNF_Tc` \ zonked_inst_tyvars ->
 
@@ -389,67 +377,85 @@ tcInstDecl2 (InstInfo clas inst_tyvars inst_tys
                      dfun_arg_dicts            `plusLIE`
                      sc_dicts                  `plusLIE`
                      unionManyBags meth_lies
-    in
-    tcAddErrCtxt superClassCtxt $
-    tcAddErrCtxtM (sigThetaCtxt sc_dicts) $
-                       
 
-               -- Deal with the LIE arising from the method bindings
-    tcSimplifyAndCheck (text "inst decl1a")
-                inst_tyvars_set                        -- Local tyvars
-                avail_insts
-                (unionManyBags insts_needed_s)         -- Need to get defns for all these
-                                                `thenTc` \ (const_lie1, op_binds) ->
-
-               -- Deal with the super-class bindings
-               -- Ignore errors because they come from the *next* tcSimplify
-    discardErrsTc (
-       tcSimplifyAndCheck (text "inst decl1b")
-                inst_tyvars_set
-                dfun_arg_dicts         -- NB! Don't include this_dict here, else the sc_dicts
-                                       -- get bound by just selecting from this_dict!!
-                sc_dicts
-    )                                           `thenTc` \ (const_lie2, sc_binds) ->
-       
+        methods_lie = plusLIEs insts_needed_s
+    in
 
        -- Check that we *could* construct the superclass dictionaries,
        -- even though we are *actually* going to pass the superclass dicts in;
        -- the check ensures that the caller will never have a problem building
        -- them.
-    tcSimplifyAndCheck (text "inst decl1c")
+    tcAddErrCtxt superClassCtxt (
+      tcSimplifyAndCheck
+                (ptext SLIT("instance declaration context"))
                 inst_tyvars_set                -- Local tyvars
                 inst_decl_dicts                -- The instance dictionaries available
                 sc_dicts                       -- The superclass dicationaries reqd
-                                       `thenTc_`
-                                               -- Ignore the result; we're only doing
+    )                                  `thenTc_`
+                                               -- Ignore the result; we're only doing
                                                -- this to make sure it can be done.
 
+       -- Ditto method bindings
+    tcAddErrCtxt methodCtxt (
+      tcSimplifyAndCheck
+                (ptext SLIT("instance declaration context"))
+                inst_tyvars_set                        -- Local tyvars
+                avail_insts
+                methods_lie
+    )                                           `thenTc_`
+    
+               -- Now do the simplification again, this time to get the
+               -- bindings; this time we use an enhanced "avails"
+               -- Ignore errors because they come from the *previous* tcSimplifys
+    discardErrsTc (
+       tcSimplifyAndCheck
+                (ptext SLIT("instance declaration context"))
+                inst_tyvars_set
+                dfun_arg_dicts         -- NB! Don't include this_dict here, else the sc_dicts
+                                       -- get bound by just selecting from this_dict!!
+                (sc_dicts `plusLIE` methods_lie `plusLIE` prag_lie)
+    )                                           `thenTc` \ (const_lie, lie_binds) ->
+       
+
        -- Create the result bindings
     let
-       const_lie = const_lie1 `plusLIE` const_lie2
-       lie_binds = op_binds `AndMonoBinds` sc_binds
-
-        dict_constr = classDataCon clas
-
-       con_app = foldl HsApp (TyApp (HsVar (RealId dict_constr)) inst_tys')
-                             (map HsVar (sc_dict_ids ++ meth_ids))
+        dict_constr   = classDataCon clas
+       scs_and_meths = sc_dict_ids ++ meth_ids
+
+       dict_rhs
+         | null scs_and_meths
+         =     -- Blatant special case for CCallable, CReturnable
+               -- If the dictionary is empty then we should never
+               -- select anything from it, so we make its RHS just
+               -- 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 (RealId eRROR_ID)) [tcIdType this_dict_id])
+                (HsLit (HsString (_PK_ ("Compiler error: bad dictionary " ++ showSDoc (ppr clas)))))
+
+         | otherwise   -- The common case
+         = foldl HsApp (TyApp (HsVar (RealId dict_constr)) inst_tys')
+                              (map HsVar (sc_dict_ids ++ meth_ids))
                -- We don't produce a binding for the dict_constr; instead we
                -- rely on the simplifier to unfold this saturated application
 
-       dict_bind    = VarMonoBind this_dict_id con_app
+       dict_bind    = VarMonoBind this_dict_id dict_rhs
        method_binds = andMonoBinds method_binds_s
 
+       final_dfun_id = replaceIdInfo dfun_id (prag_info_fn (idName dfun_id))
+                               -- Pretty truesome
        main_bind
          = AbsBinds
                 zonked_inst_tyvars
                 dfun_arg_dicts_ids
-                [(inst_tyvars', RealId dfun_id, this_dict_id)] 
+                [(inst_tyvars', RealId final_dfun_id, this_dict_id)] 
                 (lie_binds     `AndMonoBinds` 
                  method_binds  `AndMonoBinds`
+                 prag_binds    `AndMonoBinds`
                  dict_bind)
     in
-    returnTc (const_lie `plusLIE` spec_lie,
-             main_bind `AndMonoBinds` spec_binds)
+    returnTc (const_lie,
+             main_bind `AndMonoBinds` prag_binds)
 \end{code}
 
 
@@ -465,19 +471,22 @@ tcInstMethodBind
        -> [TcType s]                                   -- Instance types
        -> [TcTyVar s]                                  -- and their free (sig) tyvars
        -> RenamedMonoBinds                             -- Method binding
+       -> [RenamedSig]                                 -- Pragmas
        -> (Id, Maybe Id)                               -- Selector id and default-method id
        -> TcM s (TcMonoBinds s, LIE s, (LIE s, TcIdOcc s))
 
-tcInstMethodBind clas inst_tys inst_tyvars meth_binds (sel_id, maybe_dm_id)
+tcInstMethodBind clas inst_tys inst_tyvars meth_binds prags (sel_id, maybe_dm_id)
   = tcGetSrcLoc                        `thenNF_Tc` \ loc ->
     tcGetUnique                        `thenNF_Tc` \ uniq ->
     let
-       meth_occ          = getOccName sel_id
+       sel_name          = idName sel_id
+       meth_occ          = getOccName sel_name
        default_meth_name = mkLocalName uniq meth_occ loc
        maybe_meth_bind   = find meth_occ meth_binds 
         the_meth_bind     = case maybe_meth_bind of
                                  Just stuff -> stuff
                                  Nothing    -> mk_default_bind default_meth_name loc
+       meth_prags        = sigsForMe (== sel_name) prags
     in
 
        -- Warn if no method binding, only if -fwarn-missing-methods
@@ -488,7 +497,7 @@ tcInstMethodBind clas inst_tys inst_tyvars meth_binds (sel_id, maybe_dm_id)
        (omittedMethodWarn sel_id clas)         `thenNF_Tc_`
 
        -- Typecheck the method binding
-    tcMethodBind clas origin inst_tys inst_tyvars sel_id the_meth_bind
+    tcMethodBind clas origin inst_tys inst_tyvars sel_id the_meth_bind meth_prags
   where
     origin = InstanceDeclOrigin        -- Poor
 
@@ -517,7 +526,6 @@ tcInstMethodBind clas inst_tys inst_tyvars meth_binds (sel_id, maybe_dm_id)
                     (HsLit (HsString (_PK_ (error_msg loc))))
 
     error_msg loc = showSDoc (hcat [ppr loc, text "|", ppr sel_id ])
-
 \end{code}
 
 
@@ -615,12 +623,12 @@ tcSpecInstSig e ce tce inst_infos inst_mapper (SpecInstSig class_name ty src_loc
        (vcat [hsep [if null simpl_theta then empty else ppr simpl_theta,
                          if null simpl_theta then empty else ptext SLIT("=>"),
                          ppr clas,
-                         pprParendGenType inst_ty],
+                         pprParendType inst_ty],
                   hsep [ptext SLIT("        derived from:"),
                          if null unspec_theta then empty else ppr unspec_theta,
                          if null unspec_theta then empty else ptext SLIT("=>"),
                          ppr clas,
-                         pprParendGenType unspec_inst_ty]])
+                         pprParendType unspec_inst_ty]])
     else id) (
 
     returnTc (unitBag (InstInfo clas inst_tmpls inst_ty simpl_theta
@@ -679,8 +687,8 @@ scrutiniseInstanceType clas inst_taus
        --  
         -- We flag this separately to give a more precise error msg.
         --
-    (uniqueOf clas == cCallableClassKey   && not constructors_visible) ||
-    (uniqueOf clas == cReturnableClassKey && not constructors_visible)
+     (uniqueOf clas == cCallableClassKey || uniqueOf clas == cReturnableClassKey)
+  && is_alg_tycon_app && not constructors_visible
   = failWithTc (invisibleDataConPrimCCallErr clas first_inst_tau)
 
   |    -- CCALL CHECK (b) 
@@ -693,20 +701,16 @@ scrutiniseInstanceType clas inst_taus
        -- DERIVING CHECK
        -- It is obviously illegal to have an explicit instance
        -- for something that we are also planning to `derive'
-  | clas `elem` (tyConDerivings inst_tycon)
+  | maybeToBool alg_tycon_app_maybe && clas `elem` (tyConDerivings alg_tycon)
   = failWithTc (derivingWhenInstanceExistsErr clas first_inst_tau)
           -- Kind check will have ensured inst_taus is of length 1
 
-       -- ALL TYPE VARIABLES => bad
-  | all isTyVarTy inst_taus
-  = failWithTc (instTypeErr clas inst_taus (text "all the instance types are type variables"))
-
        -- WITH HASKELL 1.4, MUST HAVE C (T a b c)
-  |  not opt_GlasgowExts 
+  |  not opt_GlasgowExts
   && not (length inst_taus == 1 &&
-          maybeToBool tyconapp_maybe && 
-         not (isSynTyCon inst_tycon) &&
-          all isTyVarTy arg_tys && 
+         maybeToBool maybe_tycon_app &&        -- Yes, there's a type constuctor
+          not (isSynTyCon tycon) &&            -- ...but not a synonym
+          all isTyVarTy arg_tys &&             -- Applied to type variables
          length (tyVarSetToList (tyVarsOfTypes arg_tys)) == length arg_tys
                 -- This last condition checks that all the type variables are distinct
      )
@@ -719,14 +723,20 @@ scrutiniseInstanceType clas inst_taus
   = returnTc ()
 
   where
-    tyconapp_maybe            = splitTyConApp_maybe first_inst_tau
-    Just (inst_tycon, arg_tys) = tyconapp_maybe
     (first_inst_tau : _)       = inst_taus
 
-    constructors_visible      =
-        case splitAlgTyConApp_maybe first_inst_tau of
-           Just (_,_,[])   -> False
-          everything_else -> True
+       -- Stuff for algebraic or -> type
+    maybe_tycon_app      = splitTyConApp_maybe first_inst_tau
+    Just (tycon, arg_tys) = maybe_tycon_app
+
+       -- Stuff for an *algebraic* data type
+    alg_tycon_app_maybe                   = splitAlgTyConApp_maybe first_inst_tau
+                                       -- The "Alg" part looks through synonyms
+    is_alg_tycon_app              = maybeToBool alg_tycon_app_maybe
+    Just (alg_tycon, _, data_cons) = alg_tycon_app_maybe
+
+    constructors_visible = not (null data_cons)
 
 -- These conditions come directly from what the DsCCall is capable of.
 -- Totally grotesque.  Green card should solve this.
@@ -765,9 +775,6 @@ instTypeErr clas tys msg
         nest 4 (parens msg)
     ]
 
-instBndrErr bndr clas
-  = hsep [ptext SLIT("Class"), quotes (ppr clas), ptext SLIT("does not have a method"), quotes (ppr bndr)]
-
 derivingWhenInstanceExistsErr clas tycon
   = hang (hsep [ptext SLIT("Deriving class"), 
                       quotes (ppr clas), 
@@ -796,19 +803,6 @@ invisibleDataConPrimCCallErr clas inst_ty
         4 (hsep [text "(Try either importing", ppr inst_ty, 
                 text "non-abstractly or compile using -fno-prune-tydecls ..)"])
 
-instMethodNotInClassErr occ clas
-  = hang (ptext SLIT("Instance mentions a method not in the class"))
-        4 (hsep [ptext SLIT("class")  <+> quotes (ppr clas), 
-                 ptext SLIT("method") <+> quotes (ppr occ)])
-
-patMonoBindsCtxt pbind
-  = hang (ptext SLIT("In a pattern binding:"))
-        4 (ppr pbind)
-
-methodSigCtxt name ty
-  = hang (hsep [ptext SLIT("When matching the definition of class method"),
-               quotes (ppr name), ptext SLIT("to its signature :") ])
-        4 (ppr ty)
-
-superClassCtxt = ptext SLIT("From the superclasses of the instance declaration")
+methodCtxt     = ptext SLIT("When checking the methods of an instance declaration")
+superClassCtxt = ptext SLIT("When checking the superclasses of an instance declaration")
 \end{code}