HsDecls.lhs 20.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
	DeprecDecl(..), DeprecTxt,
18
	hsDeclName, instDeclName, 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 (InstD   decl)			    = instDeclName decl
hsDeclName (SigD    (IfaceSig 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

93
tyClDeclName :: TyClDecl name pat -> name
94
tyClDeclName (TyData _ _ name _ _ _ _ _ _)          = name
95 96
tyClDeclName (TySynonym name _ _ _)                 = name
tyClDeclName (ClassDecl _ name _ _ _ _ _ _ _ _ _ _) = name
97 98 99

instDeclName :: InstDecl name pat -> name
instDeclName (InstDecl _ _ _ (Just name) _) = name
100 101 102
\end{code}

\begin{code}
103
instance (Outputable name, Outputable pat)
104
	=> Outputable (HsDecl name pat) where
105

106
    ppr (TyClD dcl)  = ppr dcl
107 108 109 110
    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
111
    ppr (ForD fd)    = ppr fd
112
    ppr (FixD fd)    = ppr fd
113
    ppr (RuleD rd)   = ppr rd
114 115 116 117 118 119 120
    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
121
   (SigD s1)  == (SigD s2)  = s1 == s2
122
   (TyClD d1) == (TyClD d2) = d1 == d2
123
   _          == _          = False
124 125
\end{code}

126

127 128 129 130 131 132
%************************************************************************
%*									*
\subsection[TyDecl]{@data@, @newtype@ or @type@ (synonym) type declaration}
%*									*
%************************************************************************

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
Type and class declarations carry 'implicit names'.  In particular:

Type A.  
~~~~~~~
  Each data type decl defines 
	a worker name for each constructor
	to-T and from-T convertors
  Each class decl defines
	a tycon for the class
	a data constructor for that tycon
	the worker for that constructor
	a selector for each superclass

All have occurrence names that are derived uniquely from their parent declaration.

None of these get separate definitions in an interface file; they are
fully defined by the data or class decl.  But they may *occur* in
interface files, of course.  Any such occurrence must haul in the
relevant type or class decl.

Plan of attack:
 - Make up their occurrence names immediately

 - Ensure they "point to" the parent data/class decl 
   when loading that decl from an interface file

 - When renaming the decl look them up in the name cache,
   ensure correct module and provenance is set

Type B: Default methods and dictionary functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Have their own binding in an interface file.

Default methods : occurrence name is derived uniquely from the class decl.
Dict functions  : occurrence name is derived from the instance decl, plus a unique number.

Plan of attack: 
  - Do *not* make them point to the parent class decl
  - Interface-file decls: treat just like Type A
  - Source-file decls:    the names aren't in the decl at all; 
			  instead the typechecker makes them up

175
\begin{code}
176
data TyClDecl name pat
sof's avatar
sof committed
177
  = TyData	NewOrData
178 179
		(HsContext name) -- context
		name		 -- type constructor
180
		[HsTyVarBndr name]	 -- type variables
181
		[ConDecl name]	 -- data constructors (empty if abstract)
182
		Int		 -- Number of data constructors (valid even if type is abstract)
183 184 185 186
		(Maybe [name])	 -- derivings; Nothing => not specified
				 -- (i.e., derive default); Just [] => derive
				 -- *nothing*; Just <list> => as you would
				 -- expect...
187 188 189 190
		(DataPragmas name)
		SrcLoc

  | TySynonym	name		-- type constructor
191
		[HsTyVarBndr name]	-- type variables
192
		(HsType name)	-- synonym expansion
193 194
		SrcLoc

195
  | ClassDecl	(HsContext name)    	-- context...
196
		name		    	-- name of the class
197 198
		[HsTyVarBndr name]	-- the class type variables
		[FunDep name]		-- functional dependencies
199
		[Sig name]		-- methods' signatures
200 201
		(MonoBinds name pat)	-- default methods
		(ClassPragmas name)
202 203 204
		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.
205
		SrcLoc
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

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
       )

232 233 234
  (==) _ _ = False	-- default case


235 236 237
eq_hsFD env (ns1,ms1) (ns2,ms2)
  = eqListBy (eq_hsVar env) ns1 ns2 && eqListBy (eq_hsVar env) ms1 ms2

238 239 240 241 242 243 244 245 246 247
eq_cls_sig env (ClassOpSig n1 dm1 ty1 _) (ClassOpSig n2 dm2 ty2 _)
  = n1==n2 && dm1 `eq_dm` dm2 && eq_hsType env ty1 ty2
  where
	-- Ignore the name of the default method.
	-- This is used for comparing declarations before putting
	-- them into interface files, and the name of the default 
	-- method isn't relevant
    (Just (_,explicit_dm1)) `eq_dm` (Just (_,explicit_dm2)) = explicit_dm1 == explicit_dm2
    Nothing		    `eq_dm` Nothing		    = True
    dm1			    `eq_dm` dm2			    = False
248 249 250
\end{code}

\begin{code}
251 252 253
countTyClDecls :: [TyClDecl name pat] -> (Int, Int, Int, Int)
	-- class, data, newtype, synonym decls
countTyClDecls decls 
254
 = (length [() | ClassDecl _ _ _ _ _ _ _ _ _ _ _ _ <- decls],
255 256
    length [() | TyData DataType _ _ _ _ _ _ _ _   <- decls],
    length [() | TyData NewType  _ _ _ _ _ _ _ _   <- decls],
257
    length [() | TySynonym _ _ _ _	           <- decls])
258 259 260 261 262 263

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

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

264 265
isDataDecl (TyData _ _ _ _ _ _ _ _ _) = True
isDataDecl other		      = False
266

267 268
isClassDecl (ClassDecl _ _ _ _ _ _ _ _ _ _ _ _) = True
isClassDecl other		 	        = False
269 270 271
\end{code}

\begin{code}
272
instance (Outputable name, Outputable pat)
273
	      => Outputable (TyClDecl name pat) where
274

275
    ppr (TySynonym tycon tyvars mono_ty src_loc)
276
      = hang (ptext SLIT("type") <+> pp_decl_head [] tycon tyvars <+> equals)
277
	     4 (ppr mono_ty)
278

279
    ppr (TyData new_or_data context tycon tyvars condecls ncons derivings pragmas src_loc)
280
      = pp_tydecl
281 282
		  (ptext keyword <+> pp_decl_head context tycon tyvars <+> equals)
		  (pp_condecls condecls ncons)
283
		  derivings
sof's avatar
sof committed
284 285 286 287
      where
	keyword = case new_or_data of
			NewType  -> SLIT("newtype")
			DataType -> SLIT("data")
288

289
    ppr (ClassDecl context clas tyvars fds sigs methods pragmas _ _ _ _ src_loc)
290 291 292 293 294
      | null sigs	-- No "where" part
      = top_matter

      | otherwise	-- Laid out
      = sep [hsep [top_matter, ptext SLIT("where {")],
295
	     nest 4 (sep [sep (map ppr_sig sigs), pp_methods, char '}'])]
296
      where
297
        top_matter  = ptext SLIT("class") <+> pp_decl_head context clas tyvars <+> pprFundeps fds
298
	ppr_sig sig = ppr sig <> semi
299 300 301
	pp_methods = getPprStyle $ \ sty ->
        	     if ifaceStyle sty then empty else ppr methods
        
302

303 304
pp_decl_head :: Outputable name => HsContext name -> name -> [HsTyVarBndr name] -> SDoc
pp_decl_head context thing tyvars = hsep [pprHsContext context, ppr thing, interppSP tyvars]
305

306 307
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)
308

309
pp_tydecl pp_head pp_decl_rhs derivings
sof's avatar
sof committed
310
  = hang pp_head 4 (sep [
311
	pp_decl_rhs,
312 313 314
	case derivings of
	  Nothing 	   -> empty
	  Just ds	   -> hsep [ptext SLIT("deriving"), parens (interpp'SP ds)]
315
    ])
316 317 318 319 320 321 322 323 324
\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
325
		(HsType name)
326 327
		SrcLoc

328
instance (Outputable name)
329 330
	      => Outputable (SpecDataSig name) where

331 332
    ppr (SpecDataSig tycon ty _)
      = hsep [text "{-# SPECIALIZE data", ppr ty, text "#-}"]
333 334 335 336 337 338 339 340 341 342
\end{code}

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

\begin{code}
data ConDecl name
343 344 345 346 347
  = 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
348

349
		[HsTyVarBndr name]		-- Existentially quantified type variables
350
		(HsContext name)	-- ...and context
351 352
					-- If both are empty then there are no existentials

sof's avatar
sof committed
353
		(ConDetails name)
354 355
		SrcLoc

sof's avatar
sof committed
356 357 358 359 360 361
data ConDetails name
  = VanillaCon			-- prefix-style con decl
		[BangType name]

  | InfixCon			-- infix-style con decl
		(BangType name)
362 363
		(BangType name)

sof's avatar
sof committed
364
  | RecCon			-- record-style con decl
365
		[([name], BangType name)]	-- list of "fields"
366

sof's avatar
sof committed
367
  | NewCon	 		-- newtype con decl, possibly with a labelled field.
368
		(HsType name)
sof's avatar
sof committed
369
		(Maybe name)	-- Just x => labelled field 'x'
370

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
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

390 391 392 393 394 395 396 397 398 399
  
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

400 401 402
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
403
eq_btype env _		   _		 = False
404 405 406
\end{code}

\begin{code}
407
instance (Outputable name) => Outputable (ConDecl name) where
408
    ppr (ConDecl con _ tvs cxt con_details  loc)
409
      = sep [pprHsForAll tvs cxt, ppr_con_details con con_details]
410

411 412
ppr_con_details con (InfixCon ty1 ty2)
  = hsep [ppr_bang ty1, ppr con, ppr_bang ty2]
413

414 415
ppr_con_details con (VanillaCon tys)
  = ppr con <+> hsep (map (ppr_bang) tys)
sof's avatar
sof committed
416

sof's avatar
sof committed
417
ppr_con_details con (NewCon ty Nothing)
418
  = ppr con <+> pprParendHsType ty
419

sof's avatar
sof committed
420 421 422 423 424
ppr_con_details con (NewCon ty (Just x))
  = ppr con <+> braces pp_field 
   where
    pp_field = ppr x <+> dcolon <+> pprParendHsType ty
 
425 426
ppr_con_details con (RecCon fields)
  = ppr con <+> braces (hsep (punctuate comma (map ppr_field fields)))
sof's avatar
sof committed
427
  where
428
    ppr_field (ns, ty) = hsep (map (ppr) ns) <+> 
429
			 dcolon <+>
430
			 ppr_bang ty
sof's avatar
sof committed
431

432 433 434
instance Outputable name => Outputable (BangType name) where
    ppr = ppr_bang

435 436
ppr_bang (Banged   ty) = ptext SLIT("!") <> pprParendHsType ty
ppr_bang (Unbanged ty) = pprParendHsType ty
437
ppr_bang (Unpacked ty) = ptext SLIT("! !") <> pprParendHsType ty
438 439 440 441 442
\end{code}


%************************************************************************
%*									*
sof's avatar
sof committed
443
\subsection[InstDecl]{An instance declaration
444 445 446 447
%*									*
%************************************************************************

\begin{code}
448
data InstDecl name pat
449
  = InstDecl	(HsType name)	-- Context => Class Instance-type
450 451 452
				-- Using a polytype means that the renamer conveniently
				-- figures out the quantified type variables for us.

453
		(MonoBinds name pat)
454

455
		[Sig name]		-- User-supplied pragmatic info
456

457 458
		(Maybe name)		-- Name for the dictionary function
					-- Nothing for source-file instance decls
459 460 461 462 463

		SrcLoc
\end{code}

\begin{code}
464
instance (Outputable name, Outputable pat)
465
	      => Outputable (InstDecl name pat) where
466

467
    ppr (InstDecl inst_ty binds uprags maybe_dfun_name src_loc)
468
      = getPprStyle $ \ sty ->
469
        if ifaceStyle sty then
470
           hsep [ptext SLIT("instance"), ppr inst_ty, equals, pp_dfun]
471 472 473 474
	else
	   vcat [hsep [ptext SLIT("instance"), ppr inst_ty, ptext SLIT("where")],
	         nest 4 (ppr uprags),
	         nest 4 (ppr binds) ]
475 476 477 478
      where
	pp_dfun = case maybe_dfun_name of
		    Just df -> ppr df
		    Nothing -> empty
479 480
\end{code}

481 482 483 484 485 486 487
\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}

488 489 490 491 492 493 494 495 496 497 498 499 500

%************************************************************************
%*									*
\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
501
  = DefaultDecl	[HsType name]
502 503
		SrcLoc

504
instance (Outputable name)
505 506
	      => Outputable (DefaultDecl name) where

507 508
    ppr (DefaultDecl tys src_loc)
      = ptext SLIT("default") <+> parens (interpp'SP tys)
509
\end{code}
510

sof's avatar
sof committed
511 512 513 514 515 516 517 518 519 520
%************************************************************************
%*									*
\subsection{Foreign function interface declaration}
%*									*
%************************************************************************

\begin{code}
data ForeignDecl name = 
   ForeignDecl 
        name 
sof's avatar
sof committed
521
	ForKind   
sof's avatar
sof committed
522 523 524 525 526
	(HsType name)
	ExtName
	CallConv
	SrcLoc

527
instance (Outputable name)
sof's avatar
sof committed
528 529 530 531
	      => Outputable (ForeignDecl name) where

    ppr (ForeignDecl nm imp_exp ty ext_name cconv src_loc)
      = ptext SLIT("foreign") <+> ppr_imp_exp <+> pprCallConv cconv <+> 
532
        ppr ext_name <+> ppr_unsafe <+> ppr nm <+> dcolon <+> ppr ty
sof's avatar
sof committed
533 534 535
        where
         (ppr_imp_exp, ppr_unsafe) =
	   case imp_exp of
sof's avatar
sof committed
536 537 538 539 540 541 542 543 544 545
	     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
546 547 548

data ExtName
 = Dynamic 
549 550 551 552 553 554 555 556 557 558 559 560
 | 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
561 562 563 564 565

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) } <+> 
566
     doubleQuotes (pprCLabelString nm)
sof's avatar
sof committed
567 568
\end{code}

569 570
%************************************************************************
%*									*
571
\subsection{Transformation rules}
572 573 574 575
%*									*
%************************************************************************

\begin{code}
576
data RuleDecl name pat
577
  = HsRule			-- Source rule
578 579 580 581 582 583 584 585
	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		

586 587 588 589 590 591
  | 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
592 593
	SrcLoc		

594 595 596 597 598
  | IfaceRuleOut		-- Post typecheck
	name			-- Head of LHS
	CoreRule


599 600 601
data RuleBndr name
  = RuleBndr name
  | RuleBndrSig name (HsType name)
602

603 604 605 606 607 608 609
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))

610 611
instance (Outputable name, Outputable pat)
	      => Outputable (RuleDecl name pat) where
612
  ppr (HsRule name tvs ns lhs rhs loc)
613 614 615
	= sep [text "{-# RULES" <+> doubleQuotes (ptext name),
	       pp_forall, ppr lhs, equals <+> ppr rhs,
               text "#-}" ]
616 617 618 619 620
	where
	  pp_forall | null tvs && null ns = empty
		    | otherwise		  = text "forall" <+> 
					    fsep (map ppr tvs ++ map ppr ns)
					    <> dot
621 622 623 624 625 626 627 628 629

  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
630 631 632 633

instance Outputable name => Outputable (RuleBndr name) where
   ppr (RuleBndr name) = ppr name
   ppr (RuleBndrSig name ty) = ppr name <> dcolon <> ppr ty
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665

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 "#-}"]
666
\end{code}