2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[HsDecls]{Abstract syntax: global declarations}
6 Definitions for: @TyDecl@ and @ConDecl@, @ClassDecl@,
7 @InstDecl@, @DefaultDecl@ and @ForeignDecl@.
11 HsDecl(..), TyClDecl(..), InstDecl(..), RuleDecl(..), RuleBndr(..),
12 DefaultDecl(..), ForeignDecl(..), ForKind(..),
13 ExtName(..), isDynamicExtName, extNameStatic,
14 ConDecl(..), ConDetails(..),
15 BangType(..), getBangType,
16 DeprecDecl(..), DeprecTxt,
17 hsDeclName, instDeclName, tyClDeclName, tyClDeclNames,
18 isClassDecl, isSynDecl, isDataDecl, isIfaceSigDecl, countTyClDecls,
19 mkClassDeclSysNames, isIfaceRuleDecl, ifaceRuleDeclName,
20 getClassDeclSysNames, conDetailsTys
23 #include "HsVersions.h"
26 import HsBinds ( HsBinds, MonoBinds, Sig(..), FixitySig(..) )
27 import HsExpr ( HsExpr )
29 import PprCore ( pprCoreRule )
30 import HsCore ( UfExpr, UfBinder, HsIdInfo, pprHsIdInfo,
31 eq_ufBinders, eq_ufExpr, pprUfExpr
33 import CoreSyn ( CoreRule(..) )
34 import BasicTypes ( NewOrData(..) )
35 import CallConv ( CallConv, pprCallConv )
38 import Name ( NamedThing )
39 import FunDeps ( pprFundeps )
40 import Class ( FunDep, DefMeth(..) )
41 import CStrings ( CLabelString, pprCLabelString )
43 import SrcLoc ( SrcLoc )
47 %************************************************************************
49 \subsection[HsDecl]{Declarations}
51 %************************************************************************
55 = TyClD (TyClDecl name pat)
56 | InstD (InstDecl name pat)
57 | DefD (DefaultDecl name)
58 | ValD (HsBinds name pat)
59 | ForD (ForeignDecl name)
60 | FixD (FixitySig name)
61 | DeprecD (DeprecDecl name)
62 | RuleD (RuleDecl name pat)
64 -- NB: all top-level fixity decls are contained EITHER
66 -- OR in the ClassDecls in TyClDs
69 -- a) data constructors
70 -- b) class methods (but they can be also done in the
71 -- signatures of class decls)
72 -- c) imported functions (that have an IfacSig)
75 -- The latter is for class methods only
80 hsDeclName :: (NamedThing name, Outputable name, Outputable pat)
81 => HsDecl name pat -> name
83 hsDeclName (TyClD decl) = tyClDeclName decl
84 hsDeclName (InstD decl) = instDeclName decl
85 hsDeclName (ForD (ForeignDecl name _ _ _ _ _)) = name
86 hsDeclName (FixD (FixitySig name _ _)) = name
87 -- Others don't make sense
89 hsDeclName x = pprPanic "HsDecls.hsDeclName" (ppr x)
93 instDeclName :: InstDecl name pat -> name
94 instDeclName (InstDecl _ _ _ (Just name) _) = name
99 instance (NamedThing name, Outputable name, Outputable pat)
100 => Outputable (HsDecl name pat) where
102 ppr (TyClD dcl) = ppr dcl
103 ppr (ValD binds) = ppr binds
104 ppr (DefD def) = ppr def
105 ppr (InstD inst) = ppr inst
106 ppr (ForD fd) = ppr fd
107 ppr (FixD fd) = ppr fd
108 ppr (RuleD rd) = ppr rd
109 ppr (DeprecD dd) = ppr dd
113 %************************************************************************
115 \subsection[TyDecl]{@data@, @newtype@ or @type@ (synonym) type declaration}
117 %************************************************************************
119 Type and class declarations carry 'implicit names'. In particular:
123 Each data type decl defines
124 a worker name for each constructor
125 to-T and from-T convertors
126 Each class decl defines
127 a tycon for the class
128 a data constructor for that tycon
129 the worker for that constructor
130 a selector for each superclass
132 All have occurrence names that are derived uniquely from their parent declaration.
134 None of these get separate definitions in an interface file; they are
135 fully defined by the data or class decl. But they may *occur* in
136 interface files, of course. Any such occurrence must haul in the
137 relevant type or class decl.
140 - Make up their occurrence names immediately
142 - Ensure they "point to" the parent data/class decl
143 when loading that decl from an interface file
145 - When renaming the decl look them up in the name cache,
146 ensure correct module and provenance is set
148 Type B: Default methods and dictionary functions
149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
150 Have their own binding in an interface file.
152 Default methods : occurrence name is derived uniquely from the class decl.
153 Dict functions : occurrence name is derived from the instance decl, plus a unique number.
156 - Do *not* make them point to the parent class decl
157 - Interface-file decls: treat just like Type A
158 - Source-file decls: the names aren't in the decl at all;
159 instead the typechecker makes them up
162 data TyClDecl name pat
163 = IfaceSig name -- It may seem odd to classify an interface-file signature
164 (HsType name) -- as a 'TyClDecl', but it's very convenient. These three
165 [HsIdInfo name] -- are the kind that appear in interface files.
169 (HsContext name) -- context
170 name -- type constructor
171 [HsTyVarBndr name] -- type variables
172 [ConDecl name] -- data constructors (empty if abstract)
173 Int -- Number of data constructors (valid even if type is abstract)
174 (Maybe [name]) -- derivings; Nothing => not specified
175 -- (i.e., derive default); Just [] => derive
176 -- *nothing*; Just <list> => as you would
179 name -- generic converter functions
180 name -- generic converter functions
182 | TySynonym name -- type constructor
183 [HsTyVarBndr name] -- type variables
184 (HsType name) -- synonym expansion
187 | ClassDecl (HsContext name) -- context...
188 name -- name of the class
189 [HsTyVarBndr name] -- the class type variables
190 [FunDep name] -- functional dependencies
191 [Sig name] -- methods' signatures
192 (MonoBinds name pat) -- default methods
193 (ClassDeclSysNames name)
200 isIfaceSigDecl, isDataDecl, isSynDecl, isClassDecl :: TyClDecl name pat -> Bool
202 isIfaceSigDecl (IfaceSig _ _ _ _) = True
203 isIfaceSigDecl other = False
205 isSynDecl (TySynonym _ _ _ _) = True
206 isSynDecl other = False
208 isDataDecl (TyData _ _ _ _ _ _ _ _ _ _) = True
209 isDataDecl other = False
211 isClassDecl (ClassDecl _ _ _ _ _ _ _ _ ) = True
212 isClassDecl other = False
218 tyClDeclName :: TyClDecl name pat -> name
219 tyClDeclName (IfaceSig name _ _ _) = name
220 tyClDeclName (TyData _ _ name _ _ _ _ _ _ _) = name
221 tyClDeclName (TySynonym name _ _ _) = name
222 tyClDeclName (ClassDecl _ name _ _ _ _ _ _) = name
225 tyClDeclNames :: Eq name => TyClDecl name pat -> [(name, SrcLoc)]
226 -- Returns all the binding names of the decl, along with their SrcLocs
227 -- The first one is guaranteed to be the name of the decl
228 -- For record fields, the first one counts as the SrcLoc
229 -- We use the equality to filter out duplicate field names
231 tyClDeclNames (TySynonym name _ _ loc)
234 tyClDeclNames (ClassDecl _ cls_name _ _ sigs _ _ loc)
235 = (cls_name,loc) : [(n,loc) | ClassOpSig n _ _ loc <- sigs]
237 tyClDeclNames (TyData _ _ tc_name _ cons _ _ loc _ _)
238 = (tc_name,loc) : conDeclsNames cons
240 tyClDeclNames (IfaceSig name _ _ loc) = [(name,loc)]
242 type ClassDeclSysNames name = [name]
243 -- [tycon, datacon wrapper, datacon worker,
244 -- superclass selector 1, ..., superclass selector n]
245 -- They are kept in a list rather than a tuple to make the
248 mkClassDeclSysNames :: (name, name, name, [name]) -> [name]
249 getClassDeclSysNames :: [name] -> (name, name, name, [name])
250 mkClassDeclSysNames (a,b,c,ds) = a:b:c:ds
251 getClassDeclSysNames (a:b:c:ds) = (a,b,c,ds)
255 instance (NamedThing name, Ord name) => Eq (TyClDecl name pat) where
256 -- Used only when building interface files
257 (==) (IfaceSig n1 t1 i1 _)
258 (IfaceSig n2 t2 i2 _) = n1==n2 && t1==t2 && i1==i2
260 (==) (TyData nd1 cxt1 n1 tvs1 cons1 _ _ _ _ _)
261 (TyData nd2 cxt2 n2 tvs2 cons2 _ _ _ _ _)
264 eqWithHsTyVars tvs1 tvs2 (\ env ->
265 eq_hsContext env cxt1 cxt2 &&
266 eqListBy (eq_ConDecl env) cons1 cons2
269 (==) (TySynonym n1 tvs1 ty1 _)
270 (TySynonym n2 tvs2 ty2 _)
272 eqWithHsTyVars tvs1 tvs2 (\ env -> eq_hsType env ty1 ty2)
274 (==) (ClassDecl cxt1 n1 tvs1 fds1 sigs1 _ _ _ )
275 (ClassDecl cxt2 n2 tvs2 fds2 sigs2 _ _ _ )
277 eqWithHsTyVars tvs1 tvs2 (\ env ->
278 eq_hsContext env cxt1 cxt2 &&
279 eqListBy (eq_hsFD env) fds1 fds2 &&
280 eqListBy (eq_cls_sig env) sigs1 sigs2
283 (==) _ _ = False -- default case
286 eq_hsFD env (ns1,ms1) (ns2,ms2)
287 = eqListBy (eq_hsVar env) ns1 ns2 && eqListBy (eq_hsVar env) ms1 ms2
289 eq_cls_sig env (ClassOpSig n1 dm1 ty1 _) (ClassOpSig n2 dm2 ty2 _)
290 = n1==n2 && dm1 `eq_dm` dm2 && eq_hsType env ty1 ty2
292 -- Ignore the name of the default method for (DefMeth id)
293 -- This is used for comparing declarations before putting
294 -- them into interface files, and the name of the default
295 -- method isn't relevant
296 Nothing `eq_dm` Nothing = True
297 (Just NoDefMeth) `eq_dm` (Just NoDefMeth) = True
298 (Just GenDefMeth) `eq_dm` (Just GenDefMeth) = True
299 (Just (DefMeth _)) `eq_dm` (Just (DefMeth _)) = True
300 dm1 `eq_dm` dm2 = False
306 countTyClDecls :: [TyClDecl name pat] -> (Int, Int, Int, Int, Int)
307 -- class, data, newtype, synonym decls
309 = (length [() | ClassDecl _ _ _ _ _ _ _ _ <- decls],
310 length [() | TyData DataType _ _ _ _ _ _ _ _ _ <- decls],
311 length [() | TyData NewType _ _ _ _ _ _ _ _ _ <- decls],
312 length [() | TySynonym _ _ _ _ <- decls],
313 length [() | IfaceSig _ _ _ _ <- decls])
317 instance (NamedThing name, Outputable name, Outputable pat)
318 => Outputable (TyClDecl name pat) where
320 ppr (IfaceSig var ty info _) = hsep [ppr var, dcolon, ppr ty, pprHsIdInfo info]
322 ppr (TySynonym tycon tyvars mono_ty src_loc)
323 = hang (ptext SLIT("type") <+> pp_decl_head [] tycon tyvars <+> equals)
326 ppr (TyData new_or_data context tycon tyvars condecls ncons
327 derivings src_loc gen_conv1 gen_conv2) -- The generic names are not printed out ATM
329 (ptext keyword <+> pp_decl_head context tycon tyvars <+> equals)
330 (pp_condecls condecls ncons)
333 keyword = case new_or_data of
334 NewType -> SLIT("newtype")
335 DataType -> SLIT("data")
337 ppr (ClassDecl context clas tyvars fds sigs methods _ src_loc)
338 | null sigs -- No "where" part
341 | otherwise -- Laid out
342 = sep [hsep [top_matter, ptext SLIT("where {")],
343 nest 4 (sep [sep (map ppr_sig sigs), pp_methods, char '}'])]
345 top_matter = ptext SLIT("class") <+> pp_decl_head context clas tyvars <+> pprFundeps fds
346 ppr_sig sig = ppr sig <> semi
347 pp_methods = getPprStyle $ \ sty ->
348 if ifaceStyle sty then empty else ppr methods
350 pp_decl_head :: Outputable name => HsContext name -> name -> [HsTyVarBndr name] -> SDoc
351 pp_decl_head context thing tyvars = hsep [pprHsContext context, ppr thing, interppSP tyvars]
353 pp_condecls [] ncons = ptext SLIT("{- abstract with") <+> int ncons <+> ptext SLIT("constructors -}")
354 pp_condecls (c:cs) ncons = sep (ppr c : map (\ c -> ptext SLIT("|") <+> ppr c) cs)
356 pp_tydecl pp_head pp_decl_rhs derivings
357 = hang pp_head 4 (sep [
361 Just ds -> hsep [ptext SLIT("deriving"), parens (interpp'SP ds)]
366 %************************************************************************
368 \subsection[ConDecl]{A data-constructor declaration}
370 %************************************************************************
374 = ConDecl name -- Constructor name; this is used for the
375 -- DataCon itself, and for the user-callable wrapper Id
377 name -- Name of the constructor's 'worker Id'
378 -- Filled in as the ConDecl is built
380 [HsTyVarBndr name] -- Existentially quantified type variables
381 (HsContext name) -- ...and context
382 -- If both are empty then there are no existentials
388 = VanillaCon -- prefix-style con decl
391 | InfixCon -- infix-style con decl
395 | RecCon -- record-style con decl
396 [([name], BangType name)] -- list of "fields"
400 conDeclsNames :: Eq name => [ConDecl name] -> [(name,SrcLoc)]
401 -- See tyClDeclNames for what this does
402 -- The function is boringly complicated because of the records
403 -- And since we only have equality, we have to be a little careful
405 = snd (foldl do_one ([], []) cons)
407 do_one (flds_seen, acc) (ConDecl name _ _ _ details loc)
408 = do_details ((name,loc):acc) details
410 do_details acc (RecCon flds) = foldl do_fld (flds_seen, acc) flds
411 do_details acc other = (flds_seen, acc)
413 do_fld acc (flds, _) = foldl do_fld1 acc flds
415 do_fld1 (flds_seen, acc) fld
416 | fld `elem` flds_seen = (flds_seen,acc)
417 | otherwise = (fld:flds_seen, (fld,loc):acc)
421 conDetailsTys :: ConDetails name -> [HsType name]
422 conDetailsTys (VanillaCon btys) = map getBangType btys
423 conDetailsTys (InfixCon bty1 bty2) = [getBangType bty1, getBangType bty2]
424 conDetailsTys (RecCon fields) = [getBangType bty | (_, bty) <- fields]
427 eq_ConDecl env (ConDecl n1 _ tvs1 cxt1 cds1 _)
428 (ConDecl n2 _ tvs2 cxt2 cds2 _)
430 (eq_hsTyVars env tvs1 tvs2 $ \ env ->
431 eq_hsContext env cxt1 cxt2 &&
432 eq_ConDetails env cds1 cds2)
434 eq_ConDetails env (VanillaCon bts1) (VanillaCon bts2)
435 = eqListBy (eq_btype env) bts1 bts2
436 eq_ConDetails env (InfixCon bta1 btb1) (InfixCon bta2 btb2)
437 = eq_btype env bta1 bta2 && eq_btype env btb1 btb2
438 eq_ConDetails env (RecCon fs1) (RecCon fs2)
439 = eqListBy (eq_fld env) fs1 fs2
440 eq_ConDetails env _ _ = False
442 eq_fld env (ns1,bt1) (ns2, bt2) = ns1==ns2 && eq_btype env bt1 bt2
447 = Banged (HsType name) -- HsType: to allow Haskell extensions
448 | Unbanged (HsType name) -- (MonoType only needed for straight Haskell)
449 | Unpacked (HsType name) -- Field is strict and to be unpacked if poss.
451 getBangType (Banged ty) = ty
452 getBangType (Unbanged ty) = ty
453 getBangType (Unpacked ty) = ty
455 eq_btype env (Banged t1) (Banged t2) = eq_hsType env t1 t2
456 eq_btype env (Unbanged t1) (Unbanged t2) = eq_hsType env t1 t2
457 eq_btype env (Unpacked t1) (Unpacked t2) = eq_hsType env t1 t2
458 eq_btype env _ _ = False
462 instance (Outputable name) => Outputable (ConDecl name) where
463 ppr (ConDecl con _ tvs cxt con_details loc)
464 = sep [pprHsForAll tvs cxt, ppr_con_details con con_details]
466 ppr_con_details con (InfixCon ty1 ty2)
467 = hsep [ppr_bang ty1, ppr con, ppr_bang ty2]
469 ppr_con_details con (VanillaCon tys)
470 = ppr con <+> hsep (map (ppr_bang) tys)
472 ppr_con_details con (RecCon fields)
473 = ppr con <+> braces (hsep (punctuate comma (map ppr_field fields)))
475 ppr_field (ns, ty) = hsep (map (ppr) ns) <+>
479 instance Outputable name => Outputable (BangType name) where
482 ppr_bang (Banged ty) = ptext SLIT("!") <> pprParendHsType ty
483 ppr_bang (Unbanged ty) = pprParendHsType ty
484 ppr_bang (Unpacked ty) = ptext SLIT("! !") <> pprParendHsType ty
488 %************************************************************************
490 \subsection[InstDecl]{An instance declaration
492 %************************************************************************
495 data InstDecl name pat
496 = InstDecl (HsType name) -- Context => Class Instance-type
497 -- Using a polytype means that the renamer conveniently
498 -- figures out the quantified type variables for us.
502 [Sig name] -- User-supplied pragmatic info
504 (Maybe name) -- Name for the dictionary function
505 -- Nothing for source-file instance decls
511 instance (Outputable name, Outputable pat)
512 => Outputable (InstDecl name pat) where
514 ppr (InstDecl inst_ty binds uprags maybe_dfun_name src_loc)
515 = getPprStyle $ \ sty ->
516 if ifaceStyle sty then
517 hsep [ptext SLIT("instance"), ppr inst_ty, equals, pp_dfun]
519 vcat [hsep [ptext SLIT("instance"), ppr inst_ty, ptext SLIT("where")],
523 pp_dfun = case maybe_dfun_name of
529 instance Ord name => Eq (InstDecl name pat) where
530 -- Used for interface comparison only, so don't compare bindings
531 (==) (InstDecl inst_ty1 _ _ dfun1 _) (InstDecl inst_ty2 _ _ dfun2 _)
532 = inst_ty1 == inst_ty2 && dfun1 == dfun2
536 %************************************************************************
538 \subsection[DefaultDecl]{A @default@ declaration}
540 %************************************************************************
542 There can only be one default declaration per module, but it is hard
543 for the parser to check that; we pass them all through in the abstract
544 syntax, and that restriction must be checked in the front end.
547 data DefaultDecl name
548 = DefaultDecl [HsType name]
551 instance (Outputable name)
552 => Outputable (DefaultDecl name) where
554 ppr (DefaultDecl tys src_loc)
555 = ptext SLIT("default") <+> parens (interpp'SP tys)
558 %************************************************************************
560 \subsection{Foreign function interface declaration}
562 %************************************************************************
565 data ForeignDecl name =
574 instance (Outputable name)
575 => Outputable (ForeignDecl name) where
577 ppr (ForeignDecl nm imp_exp ty ext_name cconv src_loc)
578 = ptext SLIT("foreign") <+> ppr_imp_exp <+> pprCallConv cconv <+>
579 ppr ext_name <+> ppr_unsafe <+> ppr nm <+> dcolon <+> ppr ty
581 (ppr_imp_exp, ppr_unsafe) =
583 FoLabel -> (ptext SLIT("label"), empty)
584 FoExport -> (ptext SLIT("export"), empty)
586 | us -> (ptext SLIT("import"), ptext SLIT("unsafe"))
587 | otherwise -> (ptext SLIT("import"), empty)
592 | FoImport Bool -- True => unsafe call.
596 | ExtName CLabelString -- The external name of the foreign thing,
597 (Maybe CLabelString) -- and optionally its DLL or module name
598 -- Both of these are completely unencoded;
599 -- we just print them as they are
601 isDynamicExtName :: ExtName -> Bool
602 isDynamicExtName Dynamic = True
603 isDynamicExtName _ = False
605 extNameStatic :: ExtName -> CLabelString
606 extNameStatic (ExtName f _) = f
607 extNameStatic Dynamic = panic "staticExtName: Dynamic - shouldn't ever happen."
609 instance Outputable ExtName where
610 ppr Dynamic = ptext SLIT("dynamic")
611 ppr (ExtName nm mb_mod) =
612 case mb_mod of { Nothing -> empty; Just m -> doubleQuotes (ptext m) } <+>
613 doubleQuotes (pprCLabelString nm)
616 %************************************************************************
618 \subsection{Transformation rules}
620 %************************************************************************
623 data RuleDecl name pat
624 = HsRule -- Source rule
625 FAST_STRING -- Rule name
626 [name] -- Forall'd tyvars, filled in by the renamer with
627 -- tyvars mentioned in sigs; then filled out by typechecker
628 [RuleBndr name] -- Forall'd term vars
629 (HsExpr name pat) -- LHS
630 (HsExpr name pat) -- RHS
633 | IfaceRule -- One that's come in from an interface file; pre-typecheck
635 [UfBinder name] -- Tyvars and term vars
637 [UfExpr name] -- Args of LHS
638 (UfExpr name) -- Pre typecheck
641 | IfaceRuleOut -- Post typecheck
645 isIfaceRuleDecl (HsRule _ _ _ _ _ _) = False
646 isIfaceRuleDecl other = True
648 ifaceRuleDeclName :: RuleDecl name pat -> name
649 ifaceRuleDeclName (IfaceRule _ _ n _ _ _) = n
650 ifaceRuleDeclName (IfaceRuleOut n r) = n
651 ifaceRuleDeclName (HsRule fs _ _ _ _ _) = pprPanic "ifaceRuleDeclName" (ppr fs)
655 | RuleBndrSig name (HsType name)
657 instance (NamedThing name, Ord name) => Eq (RuleDecl name pat) where
658 -- Works for IfaceRules only; used when comparing interface file versions
659 (IfaceRule n1 bs1 f1 es1 rhs1 _) == (IfaceRule n2 bs2 f2 es2 rhs2 _)
660 = n1==n2 && f1 == f2 &&
661 eq_ufBinders emptyEqHsEnv bs1 bs2 (\env ->
662 eqListBy (eq_ufExpr env) (rhs1:es1) (rhs2:es2))
664 instance (NamedThing name, Outputable name, Outputable pat)
665 => Outputable (RuleDecl name pat) where
666 ppr (HsRule name tvs ns lhs rhs loc)
667 = sep [text "{-# RULES" <+> doubleQuotes (ptext name),
668 pp_forall, ppr lhs, equals <+> ppr rhs,
671 pp_forall | null tvs && null ns = empty
672 | otherwise = text "forall" <+>
673 fsep (map ppr tvs ++ map ppr ns)
676 ppr (IfaceRule name tpl_vars fn tpl_args rhs loc)
677 = hsep [ doubleQuotes (ptext name),
678 ptext SLIT("__forall") <+> braces (interppSP tpl_vars),
679 ppr fn <+> sep (map (pprUfExpr parens) tpl_args),
680 ptext SLIT("=") <+> ppr rhs
683 ppr (IfaceRuleOut fn rule) = pprCoreRule (ppr fn) rule
685 instance Outputable name => Outputable (RuleBndr name) where
686 ppr (RuleBndr name) = ppr name
687 ppr (RuleBndrSig name ty) = ppr name <> dcolon <> ppr ty
691 %************************************************************************
693 \subsection[DeprecDecl]{Deprecations}
695 %************************************************************************
697 We use exported entities for things to deprecate.
700 data DeprecDecl name = Deprecation name DeprecTxt SrcLoc
702 type DeprecTxt = FAST_STRING -- reason/explanation for deprecation
704 instance Outputable name => Outputable (DeprecDecl name) where
705 ppr (Deprecation thing txt _)
706 = hsep [text "{-# DEPRECATED", ppr thing, doubleQuotes (ppr txt), text "#-}"]