X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2Ftypecheck%2FTcDeriv.lhs;h=1798be31000767eb58731395b4dee68c7f84f8cc;hp=e121cc6e2ec7febb9dd566086813f6b8d9e6854a;hb=f67b457bb0271dd1590efcaa912fc441388531d9;hpb=5eb2190d2aebc6e1a11780a43d31cbc7e831dd78 diff --git a/compiler/typecheck/TcDeriv.lhs b/compiler/typecheck/TcDeriv.lhs index e121cc6..1798be3 100644 --- a/compiler/typecheck/TcDeriv.lhs +++ b/compiler/typecheck/TcDeriv.lhs @@ -68,10 +68,11 @@ Overall plan 3. Add the derived bindings, generating InstInfos + \begin{code} -- DerivSpec is purely local to this module data DerivSpec = DS { ds_loc :: SrcSpan - , ds_orig :: InstOrigin + , ds_orig :: CtOrigin , ds_name :: Name , ds_tvs :: [TyVar] , ds_theta :: ThetaType @@ -84,13 +85,30 @@ data DerivSpec = DS { ds_loc :: SrcSpan -- df :: forall tvs. theta => C tys -- The Name is the name for the DFun we'll build -- The tyvars bind all the variables in the theta - -- For family indexes, the tycon in + -- For type families, the tycon in -- in ds_tys is the *family* tycon -- in ds_tc, ds_tc_args is the *representation* tycon -- For non-family tycons, both are the same -- ds_newtype = True <=> Newtype deriving -- False <=> Vanilla deriving +\end{code} + +Example: + + newtype instance T [a] = MkT (Tree a) deriving( C s ) +==> + axiom T [a] = :RTList a + axiom :RTList a = Tree a + + DS { ds_tvs = [a,s], ds_cls = C, ds_tys = [s, T [a]] + , ds_tc = :RTList, ds_tc_args = [a] + , ds_newtype = True } + +\begin{code} +type DerivContext = Maybe ThetaType + -- Nothing <=> Vanilla deriving; infer the context of the instance decl + -- Just theta <=> Standalone deriving: context supplied by programmer type EarlyDerivSpec = Either DerivSpec DerivSpec -- Left ds => the context for the instance should be inferred @@ -283,31 +301,32 @@ tcDeriving tycl_decls inst_decls deriv_decls do { -- Fish the "deriving"-related information out of the TcEnv -- And make the necessary "equations". is_boot <- tcIsHsBoot - ; traceTc (text "tcDeriving" <+> ppr is_boot) + ; traceTc "tcDeriving" (ppr is_boot) ; early_specs <- makeDerivSpecs is_boot tycl_decls inst_decls deriv_decls ; overlap_flag <- getOverlapFlag ; let (infer_specs, given_specs) = splitEithers early_specs - ; insts1 <- mapM (genInst overlap_flag) given_specs + ; insts1 <- mapM (genInst True overlap_flag) given_specs ; final_specs <- extendLocalInstEnv (map (iSpec . fst) insts1) $ inferInstanceContexts overlap_flag infer_specs - ; insts2 <- mapM (genInst overlap_flag) final_specs + ; insts2 <- mapM (genInst False overlap_flag) final_specs -- Generate the generic to/from functions from each type declaration - ; gen_binds <- mkGenericBinds is_boot + ; gen_binds <- mkGenericBinds is_boot tycl_decls ; (inst_info, rn_binds, rn_dus) <- renameDeriv is_boot gen_binds (insts1 ++ insts2) - ; dflags <- getDOpts - ; liftIO (dumpIfSet_dyn dflags Opt_D_dump_deriv "Derived instances" - (ddump_deriving inst_info rn_binds)) + ; when (not (null inst_info)) $ + dumpDerivingInfo (ddump_deriving inst_info rn_binds) ; return (inst_info, rn_binds, rn_dus) } where ddump_deriving :: [InstInfo Name] -> HsValBinds Name -> SDoc ddump_deriving inst_infos extra_binds - = vcat (map pprInstInfoDetails inst_infos) $$ ppr extra_binds + = hang (ptext (sLit "Derived instances")) + 2 (vcat (map (\i -> pprInstInfoDetails i $$ text "") inst_infos) + $$ ppr extra_binds) renameDeriv :: Bool -> LHsBinds RdrName -> [(InstInfo RdrName, DerivAuxBinds)] @@ -330,13 +349,12 @@ renameDeriv is_boot gen_binds insts -- notably "con2tag" and/or "tag2con" functions. -- Bring those names into scope before renaming the instances themselves ; loc <- getSrcSpanM -- Generic loc for shared bindings - ; let aux_binds = listToBag $ map (genAuxBind loc) $ - rm_dups [] $ concat deriv_aux_binds - ; rn_aux_lhs <- rnTopBindsLHS emptyFsEnv (ValBindsIn aux_binds []) - ; let aux_names = map unLoc (collectHsValBinders rn_aux_lhs) - - ; bindLocalNames aux_names $ - do { (rn_aux, dus_aux) <- rnTopBindsRHS (mkNameSet aux_names) rn_aux_lhs + ; let (aux_binds, aux_sigs) = unzip $ map (genAuxBind loc) $ + rm_dups [] $ concat deriv_aux_binds + aux_val_binds = ValBindsIn (listToBag aux_binds) aux_sigs + ; rn_aux_lhs <- rnTopBindsLHS emptyFsEnv aux_val_binds + ; bindLocalNames (collectHsValBinders rn_aux_lhs) $ + do { (rn_aux, dus_aux) <- rnTopBindsRHS rn_aux_lhs ; (rn_inst_infos, fvs_insts) <- mapAndUnzipM rn_inst_info inst_infos ; return (rn_inst_infos, rn_aux `plusHsValBinds` rn_gen, dus_gen `plusDU` dus_aux `plusDU` usesOnly (plusFVs fvs_insts)) } } @@ -350,35 +368,58 @@ renameDeriv is_boot gen_binds insts | otherwise = rm_dups (b:acc) bs - rn_inst_info (InstInfo { iSpec = inst, iBinds = NewTypeDerived co }) - = return (InstInfo { iSpec = inst, iBinds = NewTypeDerived co }, emptyFVs) + rn_inst_info :: InstInfo RdrName -> TcM (InstInfo Name, FreeVars) + rn_inst_info info@(InstInfo { iBinds = NewTypeDerived coi tc }) + = return ( info { iBinds = NewTypeDerived coi tc } + , mkFVs (map dataConName (tyConDataCons tc))) + -- See Note [Newtype deriving and unused constructors] - rn_inst_info (InstInfo { iSpec = inst, iBinds = VanillaInst binds sigs }) + rn_inst_info inst_info@(InstInfo { iSpec = inst, iBinds = VanillaInst binds sigs standalone_deriv }) = -- Bring the right type variables into -- scope (yuk), and rename the method binds ASSERT( null sigs ) bindLocalNames (map Var.varName tyvars) $ do { (rn_binds, fvs) <- rnMethodBinds clas_nm (\_ -> []) [] binds - ; return (InstInfo { iSpec = inst, iBinds = VanillaInst rn_binds [] }, fvs) } + ; let binds' = VanillaInst rn_binds [] standalone_deriv + ; return (inst_info { iBinds = binds' }, fvs) } where - (tyvars,_,clas,_) = instanceHead inst - clas_nm = className clas + (tyvars,_, clas,_) = instanceHead inst + clas_nm = className clas ----------------------------------------- -mkGenericBinds :: Bool -> TcM (LHsBinds RdrName) -mkGenericBinds is_boot +mkGenericBinds :: Bool -> [LTyClDecl Name] -> TcM (LHsBinds RdrName) +mkGenericBinds is_boot tycl_decls | is_boot = return emptyBag | otherwise - = do { gbl_env <- getGblEnv - ; let tcs = typeEnvTyCons (tcg_type_env gbl_env) - ; return (unionManyBags [ mkTyConGenericBinds tc | - tc <- tcs, tyConHasGenerics tc ]) } + = do { tcs <- mapM tcLookupTyCon [ tcdName d + | L _ d <- tycl_decls, isDataDecl d ] + ; return (unionManyBags [ mkTyConGenericBinds tc + | tc <- tcs, tyConHasGenerics tc ]) } -- We are only interested in the data type declarations, -- and then only in the ones whose 'has-generics' flag is on -- The predicate tyConHasGenerics finds both of these \end{code} +Note [Newtype deriving and unused constructors] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Consider this (see Trac #1954): + + module Bug(P) where + newtype P a = MkP (IO a) deriving Monad + +If you compile with -fwarn-unused-binds you do not expect the warning +"Defined but not used: data consructor MkP". Yet the newtype deriving +code does not explicitly mention MkP, but it should behave as if you +had written + instance Monad P where + return x = MkP (return x) + ...etc... + +So we want to signal a user of the data constructor 'MkP'. That's +what we do in rn_inst_info, and it's the only reason we have the TyCon +stored in NewTypeDerived. + %************************************************************************ %* * @@ -409,10 +450,7 @@ makeDerivSpecs is_boot tycl_decls inst_decls deriv_decls all_tydata :: [(LHsType Name, LTyClDecl Name)] -- Derived predicate paired with its data type declaration - all_tydata = extractTyDataPreds tycl_decls ++ - [ pd -- Traverse assoc data families - | L _ (InstDecl _ _ _ ats) <- inst_decls - , pd <- extractTyDataPreds ats ] + all_tydata = extractTyDataPreds (instDeclATs inst_decls ++ tycl_decls) deriv_locs = map (getLoc . snd) all_tydata ++ map getLoc deriv_decls @@ -429,22 +467,22 @@ deriveStandalone :: LDerivDecl Name -> TcM EarlyDerivSpec deriveStandalone (L loc (DerivDecl deriv_ty)) = setSrcSpan loc $ addErrCtxt (standaloneCtxt deriv_ty) $ - do { traceTc (text "standalone deriving decl for" <+> ppr deriv_ty) - ; (tvs, theta, tau) <- tcHsInstHead deriv_ty - ; traceTc (text "standalone deriving;" - <+> text "tvs:" <+> ppr tvs - <+> text "theta:" <+> ppr theta - <+> text "tau:" <+> ppr tau) - ; (cls, inst_tys) <- checkValidInstHead tau - ; checkValidInstance tvs theta cls inst_tys + do { traceTc "Standalone deriving decl for" (ppr deriv_ty) + ; (tvs, theta, cls, inst_tys) <- tcHsInstHead deriv_ty + ; traceTc "Standalone deriving;" $ vcat + [ text "tvs:" <+> ppr tvs + , text "theta:" <+> ppr theta + , text "cls:" <+> ppr cls + , text "tys:" <+> ppr inst_tys ] + ; checkValidInstance deriv_ty tvs theta cls inst_tys -- C.f. TcInstDcls.tcLocalInstDecl1 ; let cls_tys = take (length inst_tys - 1) inst_tys inst_ty = last inst_tys - ; traceTc (text "standalone deriving;" - <+> text "class:" <+> ppr cls - <+> text "class types:" <+> ppr cls_tys - <+> text "type:" <+> ppr inst_ty) + ; traceTc "Standalone deriving:" $ vcat + [ text "class:" <+> ppr cls + , text "class types:" <+> ppr cls_tys + , text "type:" <+> ppr inst_ty ] ; mkEqnHelp StandAloneDerivOrigin tvs cls cls_tys inst_ty (Just theta) } @@ -494,7 +532,7 @@ deriveTyData (L loc deriv_pred, L _ decl@(TyData { tcdLName = L _ tycon_name, -- Type families can't be partially applied -- e.g. newtype instance T Int a = MkT [a] deriving( Monad ) -- Note [Deriving, type families, and partial applications] - ; checkTc (not (isOpenTyCon tc) || n_args_to_drop == 0) + ; checkTc (not (isFamilyTyCon tc) || n_args_to_drop == 0) (typeFamilyPapErr tc cls cls_tys inst_ty) ; mkEqnHelp DerivOrigin (varSetElems univ_tvs) cls cls_tys inst_ty Nothing } } @@ -525,8 +563,8 @@ When there are no type families, it's quite easy: newtype S a = MkS [a] -- :CoS :: S ~ [] -- Eta-reduced - instance Eq [a] => Eq (S a) -- by coercion sym (Eq (coMkS a)) : Eq [a] ~ Eq (S a) - instance Monad [] => Monad S -- by coercion sym (Monad coMkS) : Monad [] ~ Monad S + instance Eq [a] => Eq (S a) -- by coercion sym (Eq (:CoS a)) : Eq [a] ~ Eq (S a) + instance Monad [] => Monad S -- by coercion sym (Monad :CoS) : Monad [] ~ Monad S When type familes are involved it's trickier: @@ -547,8 +585,8 @@ After all, we can write it out ... etc ... \begin{code} -mkEqnHelp :: InstOrigin -> [TyVar] -> Class -> [Type] -> Type - -> Maybe ThetaType -- Just => context supplied (standalone deriving) +mkEqnHelp :: CtOrigin -> [TyVar] -> Class -> [Type] -> Type + -> DerivContext -- Just => context supplied (standalone deriving) -- Nothing => context inferred (deriving on data decl) -> TcRn EarlyDerivSpec -- Make the EarlyDerivSpec for an instance @@ -559,74 +597,46 @@ mkEqnHelp :: InstOrigin -> [TyVar] -> Class -> [Type] -> Type mkEqnHelp orig tvs cls cls_tys tc_app mtheta | Just (tycon, tc_args) <- tcSplitTyConApp_maybe tc_app , isAlgTyCon tycon -- Check for functions, primitive types etc - = do { (rep_tc, rep_tc_args) <- tcLookupFamInstExact tycon tc_args - -- Be careful to test rep_tc here: in the case of families, - -- we want to check the instance tycon, not the family tycon - - -- For standalone deriving (mtheta /= Nothing), - -- check that all the data constructors are in scope. - -- No need for this when deriving Typeable, becuase we don't need - -- the constructors for that. - ; rdr_env <- getGlobalRdrEnv - ; let hidden_data_cons = isAbstractTyCon rep_tc || any not_in_scope (tyConDataCons rep_tc) - not_in_scope dc = null (lookupGRE_Name rdr_env (dataConName dc)) - ; checkTc (isNothing mtheta || - not hidden_data_cons || - className cls `elem` typeableClassNames) - (derivingHiddenErr tycon) - - ; dflags <- getDOpts - ; if isDataTyCon rep_tc then - mkDataTypeEqn orig dflags tvs cls cls_tys - tycon tc_args rep_tc rep_tc_args mtheta - else - mkNewTypeEqn orig dflags tvs cls cls_tys - tycon tc_args rep_tc rep_tc_args mtheta } + = mk_alg_eqn tycon tc_args | otherwise - = failWithTc (derivingThingErr cls cls_tys tc_app + = failWithTc (derivingThingErr False cls cls_tys tc_app (ptext (sLit "The last argument of the instance must be a data or newtype application"))) -\end{code} -Note [Looking up family instances for deriving] -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -tcLookupFamInstExact is an auxiliary lookup wrapper which requires -that looked-up family instances exist. If called with a vanilla -tycon, the old type application is simply returned. - -If we have - data instance F () = ... deriving Eq - data instance F () = ... deriving Eq -then tcLookupFamInstExact will be confused by the two matches; -but that can't happen because tcInstDecls1 doesn't call tcDeriving -if there are any overlaps. - -There are two other things that might go wrong with the lookup. -First, we might see a standalone deriving clause - deriving Eq (F ()) -when there is no data instance F () in scope. - -Note that it's OK to have - data instance F [a] = ... - deriving Eq (F [(a,b)]) -where the match is not exact; the same holds for ordinary data types -with standalone deriving declrations. + where + bale_out msg = failWithTc (derivingThingErr False cls cls_tys tc_app msg) -\begin{code} -tcLookupFamInstExact :: TyCon -> [Type] -> TcM (TyCon, [Type]) -tcLookupFamInstExact tycon tys - | not (isOpenTyCon tycon) - = return (tycon, tys) - | otherwise - = do { maybeFamInst <- tcLookupFamInst tycon tys - ; case maybeFamInst of - Nothing -> famInstNotFound tycon tys - Just famInst -> return famInst - } - -famInstNotFound :: TyCon -> [Type] -> TcM a -famInstNotFound tycon tys - = failWithTc (ptext (sLit "No family instance for") - <+> quotes (pprTypeApp tycon tys)) + mk_alg_eqn tycon tc_args + | className cls `elem` typeableClassNames + = do { dflags <- getDOpts + ; case checkTypeableConditions (dflags, tycon) of + Just err -> bale_out err + Nothing -> mk_typeable_eqn orig tvs cls tycon tc_args mtheta } + + | isDataFamilyTyCon tycon + , length tc_args /= tyConArity tycon + = bale_out (ptext (sLit "Unsaturated data family application")) + + | otherwise + = do { (rep_tc, rep_tc_args) <- tcLookupDataFamInst tycon tc_args + -- Be careful to test rep_tc here: in the case of families, + -- we want to check the instance tycon, not the family tycon + + -- For standalone deriving (mtheta /= Nothing), + -- check that all the data constructors are in scope. + ; rdr_env <- getGlobalRdrEnv + ; let hidden_data_cons = isAbstractTyCon rep_tc || + any not_in_scope (tyConDataCons rep_tc) + not_in_scope dc = null (lookupGRE_Name rdr_env (dataConName dc)) + ; unless (isNothing mtheta || not hidden_data_cons) + (bale_out (derivingHiddenErr tycon)) + + ; dflags <- getDOpts + ; if isDataTyCon rep_tc then + mkDataTypeEqn orig dflags tvs cls cls_tys + tycon tc_args rep_tc rep_tc_args mtheta + else + mkNewTypeEqn orig dflags tvs cls cls_tys + tycon tc_args rep_tc rep_tc_args mtheta } \end{code} @@ -637,37 +647,34 @@ famInstNotFound tycon tys %************************************************************************ \begin{code} -mkDataTypeEqn :: InstOrigin +mkDataTypeEqn :: CtOrigin -> DynFlags -> [Var] -- Universally quantified type variables in the instance -> Class -- Class for which we need to derive an instance -> [Type] -- Other parameters to the class except the last - -> TyCon -- Type constructor for which the instance is requested (last parameter to the type class) + -> TyCon -- Type constructor for which the instance is requested + -- (last parameter to the type class) -> [Type] -- Parameters to the type constructor -> TyCon -- rep of the above (for type families) -> [Type] -- rep of the above - -> Maybe ThetaType -- Context of the instance, for standalone deriving + -> DerivContext -- Context of the instance, for standalone deriving -> TcRn EarlyDerivSpec -- Return 'Nothing' if error mkDataTypeEqn orig dflags tvs cls cls_tys tycon tc_args rep_tc rep_tc_args mtheta - = case checkSideConditions dflags cls cls_tys rep_tc of + = case checkSideConditions dflags mtheta cls cls_tys rep_tc of -- NB: pass the *representation* tycon to checkSideConditions - CanDerive -> mk_data_eqn orig tvs cls tycon tc_args rep_tc rep_tc_args mtheta + CanDerive -> go_for_it NonDerivableClass -> bale_out (nonStdErr cls) DerivableClassError msg -> bale_out msg where - bale_out msg = failWithTc (derivingThingErr cls cls_tys (mkTyConApp tycon tc_args) msg) + go_for_it = mk_data_eqn orig tvs cls tycon tc_args rep_tc rep_tc_args mtheta + bale_out msg = failWithTc (derivingThingErr False cls cls_tys (mkTyConApp tycon tc_args) msg) -mk_data_eqn, mk_typeable_eqn - :: InstOrigin -> [TyVar] -> Class - -> TyCon -> [TcType] -> TyCon -> [TcType] -> Maybe ThetaType - -> TcM EarlyDerivSpec +mk_data_eqn :: CtOrigin -> [TyVar] -> Class + -> TyCon -> [TcType] -> TyCon -> [TcType] -> DerivContext + -> TcM EarlyDerivSpec mk_data_eqn orig tvs cls tycon tc_args rep_tc rep_tc_args mtheta - | getName cls `elem` typeableClassNames - = mk_typeable_eqn orig tvs cls tycon tc_args rep_tc rep_tc_args mtheta - - | otherwise = do { dfun_name <- new_dfun_name cls tycon ; loc <- getSrcSpanM ; let inst_tys = [mkTyConApp tycon tc_args] @@ -682,7 +689,11 @@ mk_data_eqn orig tvs cls tycon tc_args rep_tc rep_tc_args mtheta ; return (if isJust mtheta then Right spec -- Specified context else Left spec) } -- Infer context -mk_typeable_eqn orig tvs cls tycon tc_args rep_tc rep_tc_args mtheta +---------------------- +mk_typeable_eqn :: CtOrigin -> [TyVar] -> Class + -> TyCon -> [TcType] -> DerivContext + -> TcM EarlyDerivSpec +mk_typeable_eqn orig tvs cls tycon tc_args mtheta -- The Typeable class is special in several ways -- data T a b = ... deriving( Typeable ) -- gives @@ -696,7 +707,7 @@ mk_typeable_eqn orig tvs cls tycon tc_args rep_tc rep_tc_args mtheta = do { checkTc (cls `hasKey` typeableClassKey) (ptext (sLit "Use deriving( Typeable ) on a data type declaration")) ; real_cls <- tcLookupClass (typeableClassNames !! tyConArity tycon) - ; mk_typeable_eqn orig tvs real_cls tycon [] rep_tc [] (Just []) } + ; mk_typeable_eqn orig tvs real_cls tycon [] (Just []) } | otherwise -- standaone deriving = do { checkTc (null tc_args) @@ -707,15 +718,15 @@ mk_typeable_eqn orig tvs cls tycon tc_args rep_tc rep_tc_args mtheta ; return (Right $ DS { ds_loc = loc, ds_orig = orig, ds_name = dfun_name, ds_tvs = [] , ds_cls = cls, ds_tys = [mkTyConApp tycon []] - , ds_tc = rep_tc, ds_tc_args = rep_tc_args + , ds_tc = tycon, ds_tc_args = [] , ds_theta = mtheta `orElse` [], ds_newtype = False }) } - +---------------------- inferConstraints :: [TyVar] -> Class -> [TcType] -> TyCon -> [TcType] -> ThetaType -- Generate a sufficiently large set of constraints that typechecking the -- generated method definitions should succeed. This set will be simplified -- before being used in the instance declaration -inferConstraints tvs cls inst_tys rep_tc rep_tc_args +inferConstraints _ cls inst_tys rep_tc rep_tc_args = ASSERT2( equalLength rep_tc_tvs all_rep_tc_args, ppr cls <+> ppr rep_tc ) stupid_constraints ++ extra_constraints ++ sc_constraints ++ con_arg_constraints @@ -739,7 +750,7 @@ inferConstraints tvs cls inst_tys rep_tc rep_tc_args get_constrained_tys :: [Type] -> [Type] get_constrained_tys tys - | is_functor_like = concatMap (deepSubtypesContaining last_tv) tys + | is_functor_like = concatMap (deepSubtypesContaining last_tv) tys | otherwise = tys rep_tc_tvs = tyConTyVars rep_tc @@ -756,15 +767,20 @@ inferConstraints tvs cls inst_tys rep_tc rep_tc_args stupid_constraints = substTheta subst (tyConStupidTheta rep_tc) subst = zipTopTvSubst rep_tc_tvs all_rep_tc_args - -- Extra constraints + -- Extra Data constraints -- The Data class (only) requires that for - -- instance (...) => Data (T a b) - -- then (Data a, Data b) are among the (...) constraints - -- Reason: that's what you need to typecheck the method - -- dataCast1 f = gcast1 f + -- instance (...) => Data (T t1 t2) + -- IF t1:*, t2:* + -- THEN (Data t1, Data t2) are among the (...) constraints + -- Reason: when the IF holds, we generate a method + -- dataCast2 f = gcast2 f + -- and we need the Data constraints to typecheck the method extra_constraints - | cls `hasKey` dataClassKey = [mkClassPred cls [mkTyVarTy tv] | tv <- tvs] - | otherwise = [] + | cls `hasKey` dataClassKey + , all (isLiftedTypeKind . typeKind) rep_tc_args + = [mkClassPred cls [ty] | ty <- rep_tc_args] + | otherwise + = [] ------------------------------------------------------------------ -- Check side conditions that dis-allow derivability for particular classes @@ -778,22 +794,27 @@ data DerivStatus = CanDerive | DerivableClassError SDoc -- Standard class, but can't do it | NonDerivableClass -- Non-standard class -checkSideConditions :: DynFlags -> Class -> [TcType] -> TyCon -> DerivStatus -checkSideConditions dflags cls cls_tys rep_tc - | Just cond <- sideConditions cls +checkSideConditions :: DynFlags -> DerivContext -> Class -> [TcType] -> TyCon -> DerivStatus +checkSideConditions dflags mtheta cls cls_tys rep_tc + | Just cond <- sideConditions mtheta cls = case (cond (dflags, rep_tc)) of Just err -> DerivableClassError err -- Class-specific error - Nothing | null cls_tys -> CanDerive + Nothing | null cls_tys -> CanDerive -- All derivable classes are unary, so + -- cls_tys (the type args other than last) + -- should be null | otherwise -> DerivableClassError ty_args_why -- e.g. deriving( Eq s ) | otherwise = NonDerivableClass -- Not a standard class where ty_args_why = quotes (ppr (mkClassPred cls cls_tys)) <+> ptext (sLit "is not a class") +checkTypeableConditions :: Condition +checkTypeableConditions = checkFlag Opt_DeriveDataTypeable `andCond` cond_typeableOK + nonStdErr :: Class -> SDoc nonStdErr cls = quotes (ppr cls) <+> ptext (sLit "is not a derivable class") -sideConditions :: Class -> Maybe Condition -sideConditions cls +sideConditions :: DerivContext -> Class -> Maybe Condition +sideConditions mtheta cls | cls_key == eqClassKey = Just cond_std | cls_key == ordClassKey = Just cond_std | cls_key == showClassKey = Just cond_std @@ -809,10 +830,10 @@ sideConditions cls cond_functorOK False) -- Functor/Fold/Trav works ok for rank-n types | cls_key == traversableClassKey = Just (checkFlag Opt_DeriveTraversable `andCond` cond_functorOK False) - | getName cls `elem` typeableClassNames = Just (checkFlag Opt_DeriveDataTypeable `andCond` cond_typeableOK) | otherwise = Nothing where cls_key = getUnique cls + cond_std = cond_stdOK mtheta type Condition = (DynFlags, TyCon) -> Maybe SDoc -- first Bool is whether or not we are allowed to derive Data and Typeable @@ -824,27 +845,29 @@ type Condition = (DynFlags, TyCon) -> Maybe SDoc orCond :: Condition -> Condition -> Condition orCond c1 c2 tc = case c1 tc of - Nothing -> Nothing -- c1 succeeds - Just x -> case c2 tc of -- c1 fails + Nothing -> Nothing -- c1 succeeds + Just x -> case c2 tc of -- c1 fails Nothing -> Nothing Just y -> Just (x $$ ptext (sLit " and") $$ y) - -- Both fail + -- Both fail andCond :: Condition -> Condition -> Condition andCond c1 c2 tc = case c1 tc of Nothing -> c2 tc -- c1 succeeds Just x -> Just x -- c1 fails -cond_std :: Condition -cond_std (_, rep_tc) - | null data_cons = Just no_cons_why - | not (null con_whys) = Just (vcat con_whys) +cond_stdOK :: DerivContext -> Condition +cond_stdOK (Just _) _ + = Nothing -- Don't check these conservative conditions for + -- standalone deriving; just generate the code + -- and let the typechecker handle the result +cond_stdOK Nothing (_, rep_tc) + | null data_cons = Just (no_cons_why rep_tc $$ suggestion) + | not (null con_whys) = Just (vcat con_whys $$ suggestion) | otherwise = Nothing where - data_cons = tyConDataCons rep_tc - no_cons_why = quotes (pprSourceTyCon rep_tc) <+> - ptext (sLit "has no data constructors") - + suggestion = ptext (sLit "Possible fix: use a standalone deriving declaration instead") + data_cons = tyConDataCons rep_tc con_whys = mapCatMaybes check_con data_cons check_con :: DataCon -> Maybe SDoc @@ -853,6 +876,10 @@ cond_std (_, rep_tc) , all isTauTy (dataConOrigArgTys con) = Nothing | otherwise = Just (badCon con (ptext (sLit "does not have a Haskell-98 type"))) +no_cons_why :: TyCon -> SDoc +no_cons_why rep_tc = quotes (pprSourceTyCon rep_tc) <+> + ptext (sLit "has no data constructors") + cond_enumOrProduct :: Condition cond_enumOrProduct = cond_isEnumeration `orCond` (cond_isProduct `andCond` cond_noUnliftedArgs) @@ -870,11 +897,13 @@ cond_noUnliftedArgs (_, tc) cond_isEnumeration :: Condition cond_isEnumeration (_, rep_tc) - | isEnumerationTyCon rep_tc = Nothing - | otherwise = Just why + | isEnumerationTyCon rep_tc = Nothing + | otherwise = Just why where - why = quotes (pprSourceTyCon rep_tc) <+> - ptext (sLit "has non-nullary constructors") + why = sep [ quotes (pprSourceTyCon rep_tc) <+> + ptext (sLit "is not an enumeration type") + , ptext (sLit "(an enumeration consists of one or more nullary, non-GADT constructors)") ] + -- See Note [Enumeration types] in TyCon cond_isProduct :: Condition cond_isProduct (_, rep_tc) @@ -882,42 +911,50 @@ cond_isProduct (_, rep_tc) | otherwise = Just why where why = quotes (pprSourceTyCon rep_tc) <+> - ptext (sLit "has more than one constructor") + ptext (sLit "does not have precisely one constructor") cond_typeableOK :: Condition -- OK for Typeable class -- Currently: (a) args all of kind * -- (b) 7 or fewer args -cond_typeableOK (_, rep_tc) - | tyConArity rep_tc > 7 = Just too_many - | not (all (isSubArgTypeKind . tyVarKind) (tyConTyVars rep_tc)) - = Just bad_kind - | isFamInstTyCon rep_tc = Just fam_inst -- no Typable for family insts - | otherwise = Nothing +cond_typeableOK (_, tc) + | tyConArity tc > 7 = Just too_many + | not (all (isSubArgTypeKind . tyVarKind) (tyConTyVars tc)) + = Just bad_kind + | otherwise = Nothing where - too_many = quotes (pprSourceTyCon rep_tc) <+> + too_many = quotes (pprSourceTyCon tc) <+> ptext (sLit "has too many arguments") - bad_kind = quotes (pprSourceTyCon rep_tc) <+> + bad_kind = quotes (pprSourceTyCon tc) <+> ptext (sLit "has arguments of kind other than `*'") - fam_inst = quotes (pprSourceTyCon rep_tc) <+> - ptext (sLit "is a type family") - functorLikeClassKeys :: [Unique] functorLikeClassKeys = [functorClassKey, foldableClassKey, traversableClassKey] cond_functorOK :: Bool -> Condition --- OK for Functor class +-- OK for Functor/Foldable/Traversable class -- Currently: (a) at least one argument -- (b) don't use argument contravariantly -- (c) don't use argument in the wrong place, e.g. data T a = T (X a a) -- (d) optionally: don't use function types -cond_functorOK allowFunctions (dflags, rep_tc) - | not (dopt Opt_DeriveFunctor dflags) - = Just (ptext (sLit "You need -XDeriveFunctor to derive an instance for this class")) +-- (e) no "stupid context" on data type +cond_functorOK allowFunctions (_, rep_tc) + | null tc_tvs + = Just (ptext (sLit "Data type") <+> quotes (ppr rep_tc) + <+> ptext (sLit "has no parameters")) + + | not (null bad_stupid_theta) + = Just (ptext (sLit "Data type") <+> quotes (ppr rep_tc) + <+> ptext (sLit "has a class context") <+> pprTheta bad_stupid_theta) + | otherwise = msum (map check_con data_cons) -- msum picks the first 'Just', if any where + tc_tvs = tyConTyVars rep_tc + Just (_, last_tv) = snocView tc_tvs + bad_stupid_theta = filter is_bad (tyConStupidTheta rep_tc) + is_bad pred = last_tv `elemVarSet` tyVarsOfPred pred + data_cons = tyConDataCons rep_tc check_con con = msum (check_vanilla con : foldDataConArgs (ft_check con) con) @@ -940,9 +977,9 @@ cond_functorOK allowFunctions (dflags, rep_tc) functions = ptext (sLit "contains function types") wrong_arg = ptext (sLit "uses the type variable in an argument other than the last") -checkFlag :: DynFlag -> Condition +checkFlag :: ExtensionFlag -> Condition checkFlag flag (dflags, _) - | dopt flag dflags = Nothing + | xopt flag dflags = Nothing | otherwise = Just why where why = ptext (sLit "You need -X") <> text flag_str @@ -952,13 +989,25 @@ checkFlag flag (dflags, _) other -> pprPanic "checkFlag" (ppr other) std_class_via_iso :: Class -> Bool -std_class_via_iso clas -- These standard classes can be derived for a newtype - -- using the isomorphism trick *even if no -fglasgow-exts* +-- These standard classes can be derived for a newtype +-- using the isomorphism trick *even if no -XGeneralizedNewtypeDeriving +-- because giving so gives the same results as generating the boilerplate +std_class_via_iso clas = classKey clas `elem` [eqClassKey, ordClassKey, ixClassKey, boundedClassKey] -- Not Read/Show because they respect the type -- Not Enum, because newtypes are never in Enum +non_iso_class :: Class -> Bool +-- *Never* derive Read,Show,Typeable,Data by isomorphism, +-- even with -XGeneralizedNewtypeDeriving +non_iso_class cls + = classKey cls `elem` ([readClassKey, showClassKey, dataClassKey] ++ + typeableClassKeys) + +typeableClassKeys :: [Unique] +typeableClassKeys = map getUnique typeableClassNames + new_dfun_name :: Class -> TyCon -> TcM Name new_dfun_name clas tycon -- Just a simple wrapper = do { loc <- getSrcSpanM -- The location of the instance decl, not of the tycon @@ -1002,15 +1051,15 @@ a context for the Data instances: %************************************************************************ \begin{code} -mkNewTypeEqn :: InstOrigin -> DynFlags -> [Var] -> Class +mkNewTypeEqn :: CtOrigin -> DynFlags -> [Var] -> Class -> [Type] -> TyCon -> [Type] -> TyCon -> [Type] - -> Maybe ThetaType + -> DerivContext -> TcRn EarlyDerivSpec mkNewTypeEqn orig dflags tvs cls cls_tys tycon tc_args rep_tycon rep_tc_args mtheta -- Want: instance (...) => cls (cls_tys ++ [tycon tc_args]) where ... | can_derive_via_isomorphism && (newtype_deriving || std_class_via_iso cls) - = do { traceTc (text "newtype deriving:" <+> ppr tycon <+> ppr rep_tys) + = do { traceTc "newtype deriving:" (ppr tycon <+> ppr rep_tys <+> ppr all_preds) ; dfun_name <- new_dfun_name cls tycon ; loc <- getSrcSpanM ; let spec = DS { ds_loc = loc, ds_orig = orig @@ -1023,20 +1072,22 @@ mkNewTypeEqn orig dflags tvs else Left spec) } | otherwise - = case check_conditions of - CanDerive -> mk_data_eqn orig tvs cls tycon tc_args rep_tycon rep_tc_args mtheta - -- Use the standard H98 method - DerivableClassError msg -> bale_out msg -- Error with standard class + = case checkSideConditions dflags mtheta cls cls_tys rep_tycon of + CanDerive -> go_for_it -- Use the standard H98 method + DerivableClassError msg -- Error with standard class + | can_derive_via_isomorphism -> bale_out (msg $$ suggest_nd) + | otherwise -> bale_out msg NonDerivableClass -- Must use newtype deriving - | newtype_deriving -> bale_out cant_derive_err -- Too hard, even with newtype deriving - | otherwise -> bale_out non_std_err -- Try newtype deriving! + | newtype_deriving -> bale_out cant_derive_err -- Too hard, even with newtype deriving + | can_derive_via_isomorphism -> bale_out (non_std $$ suggest_nd) -- Try newtype deriving! + | otherwise -> bale_out non_std where - newtype_deriving = dopt Opt_GeneralizedNewtypeDeriving dflags - check_conditions = checkSideConditions dflags cls cls_tys rep_tycon - bale_out msg = failWithTc (derivingThingErr cls cls_tys inst_ty msg) + newtype_deriving = xopt Opt_GeneralizedNewtypeDeriving dflags + go_for_it = mk_data_eqn orig tvs cls tycon tc_args rep_tycon rep_tc_args mtheta + bale_out msg = failWithTc (derivingThingErr newtype_deriving cls cls_tys inst_ty msg) - non_std_err = nonStdErr cls $$ - ptext (sLit "Try -XGeneralizedNewtypeDeriving for GHC's newtype-deriving extension") + non_std = nonStdErr cls + suggest_nd = ptext (sLit "Try -XGeneralizedNewtypeDeriving for GHC's newtype-deriving extension") -- Here is the plan for newtype derivings. We see -- newtype T a1...an = MkT (t ak+1...an) deriving (.., C s1 .. sm, ...) @@ -1120,10 +1171,6 @@ mkNewTypeEqn orig dflags tvs && ats_ok -- && not (isRecursiveTyCon tycon) -- Note [Recursive newtypes] - -- Never derive Read,Show,Typeable,Data by isomorphism - non_iso_class cls = className cls `elem` ([readClassName, showClassName, dataClassName] ++ - typeableClassNames) - arity_ok = length cls_tys + 1 == classArity cls -- Well kinded; eg not: newtype T ... deriving( ST ) -- because ST needs *2* type params @@ -1143,10 +1190,9 @@ mkNewTypeEqn orig dflags tvs -- so for 'data' instance decls cant_derive_err - = vcat [ ptext (sLit "even with cunning newtype deriving:") - , if arity_ok then empty else arity_msg - , if eta_ok then empty else eta_msg - , if ats_ok then empty else ats_msg ] + = vcat [ ppUnless arity_ok arity_msg + , ppUnless eta_ok eta_msg + , ppUnless ats_ok ats_msg ] arity_msg = quotes (ppr (mkClassPred cls cls_tys)) <+> ptext (sLit "does not have arity 1") eta_msg = ptext (sLit "cannot eta-reduce the representation type enough") ats_msg = ptext (sLit "the class has associated types") @@ -1194,7 +1240,7 @@ inferInstanceContexts :: OverlapFlag -> [DerivSpec] -> TcM [DerivSpec] inferInstanceContexts _ [] = return [] inferInstanceContexts oflag infer_specs - = do { traceTc (text "inferInstanceContexts" <+> vcat (map pprDerivSpec infer_specs)) + = do { traceTc "inferInstanceContexts" $ vcat (map pprDerivSpec infer_specs) ; iterate_deriv 1 initial_solutions } where ------------------------------------------------------------------ @@ -1236,25 +1282,33 @@ inferInstanceContexts oflag infer_specs gen_soln (DS { ds_loc = loc, ds_orig = orig, ds_tvs = tyvars , ds_cls = clas, ds_tys = inst_tys, ds_theta = deriv_rhs }) = setSrcSpan loc $ - addErrCtxt (derivInstCtxt clas inst_tys) $ - do { theta <- tcSimplifyDeriv orig tyvars deriv_rhs - -- checkValidInstance tyvars theta clas inst_tys - -- Not necessary; see Note [Exotic derived instance contexts] - -- in TcSimplify - - -- Check for a bizarre corner case, when the derived instance decl should + addErrCtxt (derivInstCtxt the_pred) $ + do { -- Check for a bizarre corner case, when the derived instance decl should -- have form instance C a b => D (T a) where ... -- Note that 'b' isn't a parameter of T. This gives rise to all sorts -- of problems; in particular, it's hard to compare solutions for - -- equality when finding the fixpoint. So I just rule it out for now. + -- equality when finding the fixpoint. Moreover, simplifyDeriv + -- has an assert failure because it finds a TyVar when it expects + -- only TcTyVars. So I just rule it out for now. I'm not + -- even sure how it can arise. + ; let tv_set = mkVarSet tyvars - weird_preds = [pred | pred <- theta, not (tyVarsOfPred pred `subVarSet` tv_set)] + weird_preds = [pred | pred <- deriv_rhs + , not (tyVarsOfPred pred `subVarSet` tv_set)] ; mapM_ (addErrTc . badDerivedPred) weird_preds + ; theta <- simplifyDeriv orig the_pred tyvars deriv_rhs + -- checkValidInstance tyvars theta clas inst_tys + -- Not necessary; see Note [Exotic derived instance contexts] + -- in TcSimplify + + ; traceTc "TcDeriv" (ppr deriv_rhs $$ ppr theta) -- Claim: the result instance declaration is guaranteed valid -- Hence no need to call: -- checkValidInstance tyvars theta clas inst_tys ; return (sortLe (<=) theta) } -- Canonicalise before returning the solution + where + the_pred = mkClassPred clas inst_tys ------------------------------------------------------------------ mkInstance :: OverlapFlag -> ThetaType -> DerivSpec -> Instance @@ -1347,37 +1401,38 @@ the renamer. What a great hack! -- Representation tycons differ from the tycon in the instance signature in -- case of instances for indexed families. -- -genInst :: OverlapFlag -> DerivSpec -> TcM (InstInfo RdrName, DerivAuxBinds) -genInst oflag spec - | ds_newtype spec - = return (InstInfo { iSpec = mkInstance oflag (ds_theta spec) spec - , iBinds = NewTypeDerived co }, []) +genInst :: Bool -- True <=> standalone deriving + -> OverlapFlag + -> DerivSpec -> TcM (InstInfo RdrName, DerivAuxBinds) +genInst standalone_deriv oflag + spec@(DS { ds_tc = rep_tycon, ds_tc_args = rep_tc_args + , ds_theta = theta, ds_newtype = is_newtype + , ds_name = name, ds_cls = clas }) + | is_newtype + = return (InstInfo { iSpec = inst_spec + , iBinds = NewTypeDerived co rep_tycon }, []) | otherwise - = do { let loc = getSrcSpan (ds_name spec) - inst = mkInstance oflag (ds_theta spec) spec - clas = ds_cls spec - - -- In case of a family instance, we need to use the representation - -- tycon (after all, it has the data constructors) - ; fix_env <- getFixityEnv - ; let (meth_binds, aux_binds) = genDerivBinds loc fix_env clas rep_tycon - - -- Build the InstInfo - ; return (InstInfo { iSpec = inst, - iBinds = VanillaInst meth_binds [] }, - aux_binds) - } + = do { fix_env <- getFixityEnv + ; let loc = getSrcSpan name + (meth_binds, aux_binds) = genDerivBinds loc fix_env clas rep_tycon + -- In case of a family instance, we need to use the representation + -- tycon (after all, it has the data constructors) + + ; return (InstInfo { iSpec = inst_spec + , iBinds = VanillaInst meth_binds [] standalone_deriv } + , aux_binds) } where - rep_tycon = ds_tc spec - rep_tc_args = ds_tc_args spec + inst_spec = mkInstance oflag theta spec co1 = case tyConFamilyCoercion_maybe rep_tycon of - Nothing -> IdCo Just co_con -> ACo (mkTyConApp co_con rep_tc_args) + Nothing -> id_co + -- Not a family => rep_tycon = main tycon co2 = case newTyConCo_maybe rep_tycon of - Nothing -> IdCo -- The newtype is transparent; no need for a cast Just co_con -> ACo (mkTyConApp co_con rep_tc_args) + Nothing -> id_co -- The newtype is transparent; no need for a cast co = co1 `mkTransCoI` co2 + id_co = IdCo (mkTyConApp rep_tycon rep_tc_args) -- Example: newtype instance N [a] = N1 (Tree a) -- deriving instance Eq b => Eq (N [(b,b)]) @@ -1385,6 +1440,7 @@ genInst oflag spec -- When dealing with the deriving clause -- co1 : N [(b,b)] ~ R1:N (b,b) -- co2 : R1:N (b,b) ~ Tree (b,b) +-- co : N [(b,b)] ~ Tree (b,b) genDerivBinds :: SrcSpan -> FixityEnv -> Class -> TyCon -> (LHsBinds RdrName, DerivAuxBinds) genDerivBinds loc fix_env clas tycon @@ -1437,12 +1493,15 @@ typeFamilyPapErr tc cls cls_tys inst_ty = hang (ptext (sLit "Derived instance") <+> quotes (pprClassPred cls (cls_tys ++ [inst_ty]))) 2 (ptext (sLit "requires illegal partial application of data type family") <+> ppr tc) -derivingThingErr :: Class -> [Type] -> Type -> Message -> Message -derivingThingErr clas tys ty why - = sep [hsep [ptext (sLit "Can't make a derived instance of"), - quotes (ppr pred)], - nest 2 (parens why)] +derivingThingErr :: Bool -> Class -> [Type] -> Type -> Message -> Message +derivingThingErr newtype_deriving clas tys ty why + = sep [(hang (ptext (sLit "Can't make a derived instance of")) + 2 (quotes (ppr pred)) + $$ nest 2 extra) <> colon, + nest 2 why] where + extra | newtype_deriving = ptext (sLit "(even with cunning newtype deriving)") + | otherwise = empty pred = mkClassPred clas (tys ++ [ty]) derivingHiddenErr :: TyCon -> SDoc @@ -1454,9 +1513,9 @@ standaloneCtxt :: LHsType Name -> SDoc standaloneCtxt ty = hang (ptext (sLit "In the stand-alone deriving instance for")) 2 (quotes (ppr ty)) -derivInstCtxt :: Class -> [Type] -> Message -derivInstCtxt clas inst_tys - = ptext (sLit "When deriving the instance for") <+> parens (pprClassPred clas inst_tys) +derivInstCtxt :: PredType -> Message +derivInstCtxt pred + = ptext (sLit "When deriving the instance for") <+> parens (ppr pred) badDerivedPred :: PredType -> Message badDerivedPred pred