HsDecls.lhs 18.8 KB
Newer Older
1
%
2
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
3 4 5
%
\section[HsDecls]{Abstract syntax: global declarations}

6
Definitions for: @TyDecl@ and @ConDecl@, @ClassDecl@,
sof's avatar
sof committed
7
@InstDecl@, @DefaultDecl@ and @ForeignDecl@.
8 9

\begin{code}
10
module HsDecls (
11
	HsDecl(..), TyClDecl(..), InstDecl(..), RuleDecl(..), RuleBndr(..),
12
	DefaultDecl(..), ForeignDecl(..), ForKind(..),
13
	ExtName(..), isDynamicExtName, extNameStatic,
14 15
	ConDecl(..), ConDetails(..), 
	BangType(..), getBangType,
16
	IfaceSig(..),  SpecDataSig(..), 
17 18
	DeprecDecl(..), DeprecTxt,
	hsDeclName, tyClDeclName, isClassDecl, isSynDecl, isDataDecl, countTyClDecls, toHsRule
19
    ) where
20

21
#include "HsVersions.h"
22 23

-- friends:
24
import HsBinds		( HsBinds, MonoBinds, Sig(..), FixitySig(..), nullMonoBinds )
25
import HsExpr		( HsExpr )
26
import HsPragmas	( DataPragmas, ClassPragmas )
27
import HsImpExp		( IE(..) )
28
import HsTypes
29 30 31
import PprCore		( pprCoreRule )
import HsCore		( UfExpr(UfVar), UfBinder, IfaceSig(..), eq_ufBinders, eq_ufExpr, pprUfExpr, toUfExpr, toUfBndr )
import CoreSyn		( CoreRule(..) )
sof's avatar
sof committed
32
import BasicTypes	( Fixity, NewOrData(..) )
sof's avatar
sof committed
33
import CallConv		( CallConv, pprCallConv )
34
import Name		( toRdrName )
35 36

-- others:
37 38
import FunDeps		( pprFundeps )
import Class		( FunDep )
39
import CStrings		( CLabelString, pprCLabelString )
40
import Outputable	
41
import SrcLoc		( SrcLoc, noSrcLoc )
42 43
\end{code}

44 45 46 47 48 49 50 51

%************************************************************************
%*									*
\subsection[HsDecl]{Declarations}
%*									*
%************************************************************************

\begin{code}
52 53 54
data HsDecl name pat
  = TyClD	(TyClDecl name pat)
  | InstD	(InstDecl  name pat)
55
  | DefD	(DefaultDecl name)
56
  | ValD	(HsBinds name pat)
sof's avatar
sof committed
57
  | ForD        (ForeignDecl name)
58 59
  | SigD	(IfaceSig name)
  | FixD	(FixitySig name)
60
  | DeprecD	(DeprecDecl name)
61
  | RuleD	(RuleDecl name pat)
62 63 64 65 66 67 68 69 70 71 72 73 74

-- NB: all top-level fixity decls are contained EITHER
-- EITHER FixDs
-- OR     in the ClassDecls in TyClDs
--
-- The former covers
-- 	a) data constructors
-- 	b) class methods (but they can be also done in the
-- 		signatures of class decls)
--	c) imported functions (that have an IfacSig)
--	d) top level decls
--
-- The latter is for class methods only
75 76 77
\end{code}

\begin{code}
sof's avatar
sof committed
78
#ifdef DEBUG
79
hsDeclName :: (Outputable name, Outputable pat)
80
	   => HsDecl name pat -> name
sof's avatar
sof committed
81
#endif
82 83 84 85 86
hsDeclName (TyClD decl)				  = tyClDeclName decl
hsDeclName (SigD    (IfaceSig name _ _ _))	  = name
hsDeclName (InstD   (InstDecl _ _ _ name _))      = name
hsDeclName (ForD    (ForeignDecl name _ _ _ _ _)) = name
hsDeclName (FixD    (FixitySig name _ _))	  = name
87
-- Others don't make sense
sof's avatar
sof committed
88
#ifdef DEBUG
89
hsDeclName x				      = pprPanic "HsDecls.hsDeclName" (ppr x)
sof's avatar
sof committed
90
#endif
91 92

tyClDeclName :: TyClDecl name pat -> name
93
tyClDeclName (TyData _ _ name _ _ _ _ _ _)          = name
94 95
tyClDeclName (TySynonym name _ _ _)                 = name
tyClDeclName (ClassDecl _ name _ _ _ _ _ _ _ _ _ _) = name
96 97 98
\end{code}

\begin{code}
99
instance (Outputable name, Outputable pat)
100
	=> Outputable (HsDecl name pat) where
101

102
    ppr (TyClD dcl)  = ppr dcl
103 104 105 106
    ppr (SigD sig)   = ppr sig
    ppr (ValD binds) = ppr binds
    ppr (DefD def)   = ppr def
    ppr (InstD inst) = ppr inst
sof's avatar
sof committed
107
    ppr (ForD fd)    = ppr fd
108
    ppr (FixD fd)    = ppr fd
109
    ppr (RuleD rd)   = ppr rd
110 111 112 113 114 115 116
    ppr (DeprecD dd) = ppr dd
\end{code}

\begin{code}
instance Ord name => Eq (HsDecl name pat) where
	-- Used only when comparing interfaces, 
	-- at which time only signature and type/class decls
117
   (SigD s1)  == (SigD s2)  = s1 == s2
118
   (TyClD d1) == (TyClD d2) = d1 == d2
119
   _          == _          = False
120 121
\end{code}

122

123 124 125 126 127 128 129
%************************************************************************
%*									*
\subsection[TyDecl]{@data@, @newtype@ or @type@ (synonym) type declaration}
%*									*
%************************************************************************

\begin{code}
130
data TyClDecl name pat
sof's avatar
sof committed
131
  = TyData	NewOrData
132 133
		(HsContext name) -- context
		name		 -- type constructor
134
		[HsTyVarBndr name]	 -- type variables
135
		[ConDecl name]	 -- data constructors (empty if abstract)
136
		Int		 -- Number of data constructors (valid even if type is abstract)
137 138 139 140
		(Maybe [name])	 -- derivings; Nothing => not specified
				 -- (i.e., derive default); Just [] => derive
				 -- *nothing*; Just <list> => as you would
				 -- expect...
141 142 143 144
		(DataPragmas name)
		SrcLoc

  | TySynonym	name		-- type constructor
145
		[HsTyVarBndr name]	-- type variables
146
		(HsType name)	-- synonym expansion
147 148
		SrcLoc

149
  | ClassDecl	(HsContext name)    	-- context...
150
		name		    	-- name of the class
151 152
		[HsTyVarBndr name]	-- the class type variables
		[FunDep name]		-- functional dependencies
153
		[Sig name]		-- methods' signatures
154 155
		(MonoBinds name pat)	-- default methods
		(ClassPragmas name)
156 157 158
		name name name [name]	-- The names of the tycon, datacon wrapper, datacon worker,
					-- and superclass selectors for this class.
					-- These are filled in as the ClassDecl is made.
159
		SrcLoc
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

instance Ord name => Eq (TyClDecl name pat) where
	-- Used only when building interface files
  (==) (TyData nd1 cxt1 n1 tvs1 cons1 _ _ _ _)
       (TyData nd2 cxt2 n2 tvs2 cons2 _ _ _ _)
    = n1 == n2 &&
      nd1 == nd2 &&
      eqWithHsTyVars tvs1 tvs2 (\ env -> 
   	  eq_hsContext env cxt1 cxt2 &&
	  eqListBy (eq_ConDecl env) cons1 cons2
      )

  (==) (TySynonym n1 tvs1 ty1 _)
       (TySynonym n2 tvs2 ty2 _)
    =  n1 == n2 &&
       eqWithHsTyVars tvs1 tvs2 (\ env -> eq_hsType env ty1 ty2)

  (==) (ClassDecl cxt1 n1 tvs1 fds1 sigs1 _ _ _ _ _ _ _)
       (ClassDecl cxt2 n2 tvs2 fds2 sigs2 _ _ _ _ _ _ _)
    =  n1 == n2 &&
       eqWithHsTyVars tvs1 tvs2 (\ env -> 
	  eq_hsContext env cxt1 cxt2 &&
	  eqListBy (eq_hsFD env) fds1 fds2 &&
	  eqListBy (eq_cls_sig env) sigs1 sigs2
       )

186 187 188
  (==) _ _ = False	-- default case


189 190 191 192 193
eq_hsFD env (ns1,ms1) (ns2,ms2)
  = eqListBy (eq_hsVar env) ns1 ns2 && eqListBy (eq_hsVar env) ms1 ms2

eq_cls_sig env (ClassOpSig n1 _ b1 ty1 _) (ClassOpSig n2 _ b2 ty2 _)
  = n1==n2 && b1==b2 && eq_hsType env ty1 ty2
194 195 196
\end{code}

\begin{code}
197 198 199
countTyClDecls :: [TyClDecl name pat] -> (Int, Int, Int, Int)
	-- class, data, newtype, synonym decls
countTyClDecls decls 
200
 = (length [() | ClassDecl _ _ _ _ _ _ _ _ _ _ _ _ <- decls],
201 202
    length [() | TyData DataType _ _ _ _ _ _ _ _   <- decls],
    length [() | TyData NewType  _ _ _ _ _ _ _ _   <- decls],
203
    length [() | TySynonym _ _ _ _	           <- decls])
204 205 206 207 208 209

isDataDecl, isSynDecl, isClassDecl :: TyClDecl name pat -> Bool

isSynDecl (TySynonym _ _ _ _) = True
isSynDecl other		      = False

210 211
isDataDecl (TyData _ _ _ _ _ _ _ _ _) = True
isDataDecl other		      = False
212

213 214
isClassDecl (ClassDecl _ _ _ _ _ _ _ _ _ _ _ _) = True
isClassDecl other		 	        = False
215 216 217
\end{code}

\begin{code}
218
instance (Outputable name, Outputable pat)
219
	      => Outputable (TyClDecl name pat) where
220

221
    ppr (TySynonym tycon tyvars mono_ty src_loc)
222
      = hang (ptext SLIT("type") <+> pp_decl_head [] tycon tyvars <+> equals)
223
	     4 (ppr mono_ty)
224

225
    ppr (TyData new_or_data context tycon tyvars condecls ncons derivings pragmas src_loc)
226
      = pp_tydecl
227 228
		  (ptext keyword <+> pp_decl_head context tycon tyvars <+> equals)
		  (pp_condecls condecls ncons)
229
		  derivings
sof's avatar
sof committed
230 231 232 233
      where
	keyword = case new_or_data of
			NewType  -> SLIT("newtype")
			DataType -> SLIT("data")
234

235
    ppr (ClassDecl context clas tyvars fds sigs methods pragmas _ _ _ _ src_loc)
236 237 238 239 240
      | null sigs	-- No "where" part
      = top_matter

      | otherwise	-- Laid out
      = sep [hsep [top_matter, ptext SLIT("where {")],
241
	     nest 4 (sep [sep (map ppr_sig sigs), pp_methods, char '}'])]
242
      where
243
        top_matter  = ptext SLIT("class") <+> pp_decl_head context clas tyvars <+> pprFundeps fds
244
	ppr_sig sig = ppr sig <> semi
245 246 247
	pp_methods = getPprStyle $ \ sty ->
        	     if ifaceStyle sty then empty else ppr methods
        
248

249 250
pp_decl_head :: Outputable name => HsContext name -> name -> [HsTyVarBndr name] -> SDoc
pp_decl_head context thing tyvars = hsep [pprHsContext context, ppr thing, interppSP tyvars]
251

252 253
pp_condecls []     ncons = ptext SLIT("{- abstract with") <+> int ncons <+> ptext SLIT("constructors -}")
pp_condecls (c:cs) ncons = sep (ppr c : map (\ c -> ptext SLIT("|") <+> ppr c) cs)
254

255
pp_tydecl pp_head pp_decl_rhs derivings
sof's avatar
sof committed
256
  = hang pp_head 4 (sep [
257
	pp_decl_rhs,
258 259 260
	case derivings of
	  Nothing 	   -> empty
	  Just ds	   -> hsep [ptext SLIT("deriving"), parens (interpp'SP ds)]
261
    ])
262 263 264 265 266 267 268 269 270
\end{code}

A type for recording what types a datatype should be specialised to.
It's called a ``Sig'' because it's sort of like a ``type signature''
for an datatype declaration.

\begin{code}
data SpecDataSig name
  = SpecDataSig name		-- tycon to specialise
271
		(HsType name)
272 273
		SrcLoc

274
instance (Outputable name)
275 276
	      => Outputable (SpecDataSig name) where

277 278
    ppr (SpecDataSig tycon ty _)
      = hsep [text "{-# SPECIALIZE data", ppr ty, text "#-}"]
279 280 281 282 283 284 285 286 287 288
\end{code}

%************************************************************************
%*									*
\subsection[ConDecl]{A data-constructor declaration}
%*									*
%************************************************************************

\begin{code}
data ConDecl name
289 290 291 292 293
  = ConDecl 	name			-- Constructor name; this is used for the
					-- DataCon itself, and for the user-callable wrapper Id

		name			-- Name of the constructor's 'worker Id'
					-- Filled in as the ConDecl is built
294

295
		[HsTyVarBndr name]		-- Existentially quantified type variables
296
		(HsContext name)	-- ...and context
297 298
					-- If both are empty then there are no existentials

sof's avatar
sof committed
299
		(ConDetails name)
300 301
		SrcLoc

sof's avatar
sof committed
302 303 304 305 306 307
data ConDetails name
  = VanillaCon			-- prefix-style con decl
		[BangType name]

  | InfixCon			-- infix-style con decl
		(BangType name)
308 309
		(BangType name)

sof's avatar
sof committed
310
  | RecCon			-- record-style con decl
311
		[([name], BangType name)]	-- list of "fields"
312

sof's avatar
sof committed
313
  | NewCon	 		-- newtype con decl, possibly with a labelled field.
314
		(HsType name)
sof's avatar
sof committed
315
		(Maybe name)	-- Just x => labelled field 'x'
316

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
eq_ConDecl env (ConDecl n1 _ tvs1 cxt1 cds1 _)
	       (ConDecl n2 _ tvs2 cxt2 cds2 _)
  = n1 == n2 &&
    (eqWithHsTyVars tvs1 tvs2	$ \ env ->
     eq_hsContext env cxt1 cxt2	&&
     eq_ConDetails env cds1 cds2)

eq_ConDetails env (VanillaCon bts1) (VanillaCon bts2)
  = eqListBy (eq_btype env) bts1 bts2
eq_ConDetails env (InfixCon bta1 btb1) (InfixCon bta2 btb2)
  = eq_btype env bta1 bta2 && eq_btype env btb1 btb2
eq_ConDetails env (RecCon fs1) (RecCon fs2)
  = eqListBy (eq_fld env) fs1 fs2
eq_ConDetails env (NewCon t1 mn1) (NewCon t2 mn2)
  = eq_hsType env t1 t2 && mn1 == mn2
eq_ConDetails env _ _ = False

eq_fld env (ns1,bt1) (ns2, bt2) = ns1==ns2 && eq_btype env bt1 bt2

336 337 338 339 340 341 342 343 344 345
  
data BangType name
  = Banged   (HsType name)	-- HsType: to allow Haskell extensions
  | Unbanged (HsType name)	-- (MonoType only needed for straight Haskell)
  | Unpacked (HsType name)	-- Field is strict and to be unpacked if poss.

getBangType (Banged ty)   = ty
getBangType (Unbanged ty) = ty
getBangType (Unpacked ty) = ty

346 347 348
eq_btype env (Banged t1)   (Banged t2)   = eq_hsType env t1 t2
eq_btype env (Unbanged t1) (Unbanged t2) = eq_hsType env t1 t2
eq_btype env (Unpacked t1) (Unpacked t2) = eq_hsType env t1 t2
349
eq_btype env _		   _		 = False
350 351 352
\end{code}

\begin{code}
353
instance (Outputable name) => Outputable (ConDecl name) where
354
    ppr (ConDecl con _ tvs cxt con_details  loc)
355
      = sep [pprHsForAll tvs cxt, ppr_con_details con con_details]
356

357 358
ppr_con_details con (InfixCon ty1 ty2)
  = hsep [ppr_bang ty1, ppr con, ppr_bang ty2]
359

360 361
ppr_con_details con (VanillaCon tys)
  = ppr con <+> hsep (map (ppr_bang) tys)
sof's avatar
sof committed
362

sof's avatar
sof committed
363
ppr_con_details con (NewCon ty Nothing)
364
  = ppr con <+> pprParendHsType ty
365

sof's avatar
sof committed
366 367 368 369 370
ppr_con_details con (NewCon ty (Just x))
  = ppr con <+> braces pp_field 
   where
    pp_field = ppr x <+> dcolon <+> pprParendHsType ty
 
371 372
ppr_con_details con (RecCon fields)
  = ppr con <+> braces (hsep (punctuate comma (map ppr_field fields)))
sof's avatar
sof committed
373
  where
374
    ppr_field (ns, ty) = hsep (map (ppr) ns) <+> 
375
			 dcolon <+>
376
			 ppr_bang ty
sof's avatar
sof committed
377

378 379 380
instance Outputable name => Outputable (BangType name) where
    ppr = ppr_bang

381 382
ppr_bang (Banged   ty) = ptext SLIT("!") <> pprParendHsType ty
ppr_bang (Unbanged ty) = pprParendHsType ty
383
ppr_bang (Unpacked ty) = ptext SLIT("! !") <> pprParendHsType ty
384 385 386 387 388
\end{code}


%************************************************************************
%*									*
sof's avatar
sof committed
389
\subsection[InstDecl]{An instance declaration
390 391 392 393
%*									*
%************************************************************************

\begin{code}
394
data InstDecl name pat
395
  = InstDecl	(HsType name)	-- Context => Class Instance-type
396 397 398
				-- Using a polytype means that the renamer conveniently
				-- figures out the quantified type variables for us.

399
		(MonoBinds name pat)
400

401
		[Sig name]		-- User-supplied pragmatic info
402

403
		name			-- Name for the dictionary function
404 405 406 407 408

		SrcLoc
\end{code}

\begin{code}
409
instance (Outputable name, Outputable pat)
410
	      => Outputable (InstDecl name pat) where
411 412 413

    ppr (InstDecl inst_ty binds uprags dfun_name src_loc)
      = getPprStyle $ \ sty ->
414 415
        if ifaceStyle sty then
           hsep [ptext SLIT("instance"), ppr inst_ty, equals, ppr dfun_name]
416 417 418 419
	else
	   vcat [hsep [ptext SLIT("instance"), ppr inst_ty, ptext SLIT("where")],
	         nest 4 (ppr uprags),
	         nest 4 (ppr binds) ]
420 421
\end{code}

422 423 424 425 426 427 428
\begin{code}
instance Ord name => Eq (InstDecl name pat) where
	-- Used for interface comparison only, so don't compare bindings
  (==) (InstDecl inst_ty1 _ _ dfun1 _) (InstDecl inst_ty2 _ _ dfun2 _)
       = inst_ty1 == inst_ty2 && dfun1 == dfun2
\end{code}

429 430 431 432 433 434 435 436 437 438 439 440 441

%************************************************************************
%*									*
\subsection[DefaultDecl]{A @default@ declaration}
%*									*
%************************************************************************

There can only be one default declaration per module, but it is hard
for the parser to check that; we pass them all through in the abstract
syntax, and that restriction must be checked in the front end.

\begin{code}
data DefaultDecl name
442
  = DefaultDecl	[HsType name]
443 444
		SrcLoc

445
instance (Outputable name)
446 447
	      => Outputable (DefaultDecl name) where

448 449
    ppr (DefaultDecl tys src_loc)
      = ptext SLIT("default") <+> parens (interpp'SP tys)
450
\end{code}
451

sof's avatar
sof committed
452 453 454 455 456 457 458 459 460 461
%************************************************************************
%*									*
\subsection{Foreign function interface declaration}
%*									*
%************************************************************************

\begin{code}
data ForeignDecl name = 
   ForeignDecl 
        name 
sof's avatar
sof committed
462
	ForKind   
sof's avatar
sof committed
463 464 465 466 467
	(HsType name)
	ExtName
	CallConv
	SrcLoc

468
instance (Outputable name)
sof's avatar
sof committed
469 470 471 472
	      => Outputable (ForeignDecl name) where

    ppr (ForeignDecl nm imp_exp ty ext_name cconv src_loc)
      = ptext SLIT("foreign") <+> ppr_imp_exp <+> pprCallConv cconv <+> 
473
        ppr ext_name <+> ppr_unsafe <+> ppr nm <+> dcolon <+> ppr ty
sof's avatar
sof committed
474 475 476
        where
         (ppr_imp_exp, ppr_unsafe) =
	   case imp_exp of
sof's avatar
sof committed
477 478 479 480 481 482 483 484 485 486
	     FoLabel     -> (ptext SLIT("label"), empty)
	     FoExport    -> (ptext SLIT("export"), empty)
	     FoImport us 
		| us        -> (ptext SLIT("import"), ptext SLIT("unsafe"))
		| otherwise -> (ptext SLIT("import"), empty)

data ForKind
 = FoLabel
 | FoExport
 | FoImport Bool -- True  => unsafe call.
sof's avatar
sof committed
487 488 489

data ExtName
 = Dynamic 
490 491 492 493 494 495 496 497 498 499 500 501
 | ExtName CLabelString 	-- The external name of the foreign thing,
	   (Maybe CLabelString)	-- and optionally its DLL or module name
				-- Both of these are completely unencoded; 
				-- we just print them as they are

isDynamicExtName :: ExtName -> Bool
isDynamicExtName Dynamic = True
isDynamicExtName _	 = False

extNameStatic :: ExtName -> CLabelString
extNameStatic (ExtName f _) = f
extNameStatic Dynamic	    = panic "staticExtName: Dynamic - shouldn't ever happen."
sof's avatar
sof committed
502 503 504 505 506

instance Outputable ExtName where
  ppr Dynamic	   = ptext SLIT("dynamic")
  ppr (ExtName nm mb_mod) = 
     case mb_mod of { Nothing -> empty; Just m -> doubleQuotes (ptext m) } <+> 
507
     doubleQuotes (pprCLabelString nm)
sof's avatar
sof committed
508 509
\end{code}

510 511
%************************************************************************
%*									*
512
\subsection{Transformation rules}
513 514 515 516
%*									*
%************************************************************************

\begin{code}
517
data RuleDecl name pat
518
  = HsRule			-- Source rule
519 520 521 522 523 524 525 526
	FAST_STRING		-- Rule name
	[name]			-- Forall'd tyvars, filled in by the renamer with
				-- tyvars mentioned in sigs; then filled out by typechecker
	[RuleBndr name]		-- Forall'd term vars
	(HsExpr name pat)	-- LHS
	(HsExpr name pat)	-- RHS
	SrcLoc		

527 528 529 530 531 532
  | IfaceRule	 		-- One that's come in from an interface file; pre-typecheck
	FAST_STRING
	[UfBinder name]		-- Tyvars and term vars
	name			-- Head of lhs
	[UfExpr name]		-- Args of LHS
	(UfExpr name)		-- Pre typecheck
533 534
	SrcLoc		

535 536 537 538 539
  | IfaceRuleOut		-- Post typecheck
	name			-- Head of LHS
	CoreRule


540 541 542
data RuleBndr name
  = RuleBndr name
  | RuleBndrSig name (HsType name)
543

544 545 546 547 548 549 550
instance Ord name => Eq (RuleDecl name pat) where
  -- Works for IfaceRules only; used when comparing interface file versions
  (IfaceRule n1 bs1 f1 es1 rhs1 _) == (IfaceRule n2 bs2 f2 es2 rhs2 _)
     = n1==n2 && f1 == f2 && 
       eq_ufBinders emptyEqHsEnv bs1 bs2 (\env -> 
       eqListBy (eq_ufExpr env) (rhs1:es1) (rhs2:es2))

551 552
instance (Outputable name, Outputable pat)
	      => Outputable (RuleDecl name pat) where
553
  ppr (HsRule name tvs ns lhs rhs loc)
554 555 556
	= sep [text "{-# RULES" <+> doubleQuotes (ptext name),
	       pp_forall, ppr lhs, equals <+> ppr rhs,
               text "#-}" ]
557 558 559 560 561
	where
	  pp_forall | null tvs && null ns = empty
		    | otherwise		  = text "forall" <+> 
					    fsep (map ppr tvs ++ map ppr ns)
					    <> dot
562 563 564 565 566 567 568 569 570

  ppr (IfaceRule name tpl_vars fn tpl_args rhs loc) 
    = hsep [ doubleQuotes (ptext name),
	   ptext SLIT("__forall") <+> braces (interppSP tpl_vars),
	   ppr fn <+> sep (map (pprUfExpr parens) tpl_args),
	   ptext SLIT("=") <+> ppr rhs
      ] <+> semi

  ppr (IfaceRuleOut fn rule) = pprCoreRule (ppr fn) rule
571 572 573 574

instance Outputable name => Outputable (RuleBndr name) where
   ppr (RuleBndr name) = ppr name
   ppr (RuleBndrSig name ty) = ppr name <> dcolon <> ppr ty
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606

toHsRule id (BuiltinRule _)
  = pprTrace "toHsRule: builtin" (ppr id) (bogusIfaceRule id)

toHsRule id (Rule name bndrs args rhs)
  = IfaceRule name (map toUfBndr bndrs) (toRdrName id)
	      (map toUfExpr args) (toUfExpr rhs) noSrcLoc

bogusIfaceRule id
  = IfaceRule SLIT("bogus") [] (toRdrName id) [] (UfVar (toRdrName id)) noSrcLoc
\end{code}


%************************************************************************
%*									*
\subsection[DeprecDecl]{Deprecations}
%*									*
%************************************************************************

We use exported entities for things to deprecate. Cunning trick (hack?):
`IEModuleContents undefined' is used for module deprecation.

\begin{code}
data DeprecDecl name = Deprecation (IE name) DeprecTxt SrcLoc

type DeprecTxt = FAST_STRING	-- reason/explanation for deprecation

instance Outputable name => Outputable (DeprecDecl name) where
   ppr (Deprecation (IEModuleContents _) txt _)
      = hsep [text "{-# DEPRECATED",            doubleQuotes (ppr txt), text "#-}"]
   ppr (Deprecation thing txt _)
      = hsep [text "{-# DEPRECATED", ppr thing, doubleQuotes (ppr txt), text "#-}"]
607
\end{code}