HsDecls.lhs 21.4 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(..),  
17
	DeprecDecl(..), DeprecTxt,
18 19 20 21
	hsDeclName, instDeclName, tyClDeclName, tyClDeclNames,
	isClassDecl, isSynDecl, isDataDecl, countTyClDecls, toHsRule,
	mkClassDeclSysNames,
	getClassDeclSysNames
22
    ) where
23

24
#include "HsVersions.h"
25 26

-- friends:
27
import HsBinds		( HsBinds, MonoBinds, Sig(..), FixitySig(..) )
28
import HsExpr		( HsExpr )
29
import HsTypes
30
import PprCore		( pprCoreRule )
31 32 33
import HsCore		( UfExpr(UfVar), UfBinder, IfaceSig(..), ifaceSigName,
			  eq_ufBinders, eq_ufExpr, pprUfExpr, toUfExpr, toUfBndr
			)
34
import CoreSyn		( CoreRule(..) )
35
import BasicTypes	( NewOrData(..) )
sof's avatar
sof committed
36
import CallConv		( CallConv, pprCallConv )
37
import Name		( getName )
38 39

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

47 48 49 50 51 52 53 54

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

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

-- 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
78 79 80
\end{code}

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

95 96 97

instDeclName :: InstDecl name pat -> name
instDeclName (InstDecl _ _ _ (Just name) _) = name
98

99 100 101
\end{code}

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

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

125

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

132 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
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

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

190 191 192
  | TySynonym	name		        -- type constructor
                [HsTyVarBndr name]	-- type variables
		(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
		(MonoBinds name pat)	-- default methods
201
		(ClassDeclSysNames name)
202
		SrcLoc
203

204 205 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 232 233 234 235 236 237 238 239 240 241 242 243
tyClDeclName :: TyClDecl name pat -> name
tyClDeclName (TyData _ _ name _ _ _ _ _ _ _) = name
tyClDeclName (TySynonym name _ _ _)          = name
tyClDeclName (ClassDecl _ name _ _ _ _ _ _)  = name


tyClDeclNames :: Eq name => TyClDecl name pat -> [(name, SrcLoc)]
-- Returns all the binding names of the decl, along with their SrcLocs
-- The first one is guaranteed to be the name of the decl
-- For record fields, the first one counts as the SrcLoc
-- We use the equality to filter out duplicate field names

tyClDeclNames (TySynonym name _ _ loc)
  = [(name,loc)]

tyClDeclNames (ClassDecl _ name _ _ sigs _ _ loc)
  = (name,loc) : [(name,loc) | ClassOpSig n _ _ loc <- sigs]

tyClDeclNames (TyData _ _ name _ cons _ _ loc _ _)
  = (name,loc) : conDeclsNames cons


type ClassDeclSysNames name = [name]
	-- 	[tycon, datacon wrapper, datacon worker, 
	--	 superclass selector 1, ..., superclass selector n]
	-- They are kept in a list rather than a tuple to make the
	-- renamer easier.

mkClassDeclSysNames  :: (name, name, name, [name]) -> [name]
getClassDeclSysNames :: [name] -> (name, name, name, [name])
mkClassDeclSysNames  (a,b,c,ds) = a:b:c:ds
getClassDeclSysNames (a:b:c:ds) = (a,b,c,ds)
\end{code}


\begin{code}
isDataDecl, isSynDecl, isClassDecl :: TyClDecl name pat -> Bool

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

245 246 247 248 249 250 251 252
isDataDecl (TyData _ _ _ _ _ _ _ _ _ _) = True
isDataDecl other		        = False

isClassDecl (ClassDecl _ _ _ _ _ _ _ _ ) = True
isClassDecl other		 	 = False
\end{code}

\begin{code}
253 254
instance Ord name => Eq (TyClDecl name pat) where
	-- Used only when building interface files
255 256
  (==) (TyData nd1 cxt1 n1 tvs1 cons1 _ _ _ _ _)
       (TyData nd2 cxt2 n2 tvs2 cons2 _ _ _ _ _)
257 258 259
    = n1 == n2 &&
      nd1 == nd2 &&
      eqWithHsTyVars tvs1 tvs2 (\ env -> 
260
   	  eq_hsContext env cxt1 cxt2  &&
261 262 263 264 265 266 267 268
	  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)

269 270
  (==) (ClassDecl cxt1 n1 tvs1 fds1 sigs1 _ _ _ )
       (ClassDecl cxt2 n2 tvs2 fds2 sigs2 _ _ _ )
271 272 273 274 275 276 277
    =  n1 == n2 &&
       eqWithHsTyVars tvs1 tvs2 (\ env -> 
	  eq_hsContext env cxt1 cxt2 &&
	  eqListBy (eq_hsFD env) fds1 fds2 &&
	  eqListBy (eq_cls_sig env) sigs1 sigs2
       )

278 279 280
  (==) _ _ = False	-- default case


281 282 283
eq_hsFD env (ns1,ms1) (ns2,ms2)
  = eqListBy (eq_hsVar env) ns1 ns2 && eqListBy (eq_hsVar env) ms1 ms2

284 285 286 287 288 289 290
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
291
    (Just (explicit_dm1)) `eq_dm` (Just (explicit_dm2)) = explicit_dm1 == explicit_dm2
292 293
    Nothing		    `eq_dm` Nothing		    = True
    dm1			    `eq_dm` dm2			    = False
294 295 296
\end{code}

\begin{code}
297 298 299
countTyClDecls :: [TyClDecl name pat] -> (Int, Int, Int, Int)
	-- class, data, newtype, synonym decls
countTyClDecls decls 
300 301 302
 = (length [() | ClassDecl _ _ _ _ _ _ _ _	   <- decls],
    length [() | TyData DataType _ _ _ _ _ _ _ _ _ <- decls],
    length [() | TyData NewType  _ _ _ _ _ _ _ _ _ <- decls],
303
    length [() | TySynonym _ _ _ _	           <- decls])
304 305 306
\end{code}

\begin{code}
307
instance (Outputable name, Outputable pat)
308
	      => Outputable (TyClDecl name pat) where
309

310
    ppr (TySynonym tycon tyvars mono_ty src_loc)
311
      = hang (ptext SLIT("type") <+> pp_decl_head [] tycon tyvars <+> equals)
312
	     4 (ppr mono_ty)
313

314 315
    ppr (TyData new_or_data context tycon tyvars condecls ncons 
		derivings src_loc gen_conv1 gen_conv2) -- The generic names are not printed out ATM
316
      = pp_tydecl
317 318
		  (ptext keyword <+> pp_decl_head context tycon tyvars <+> equals)
		  (pp_condecls condecls ncons)
319
		  derivings
sof's avatar
sof committed
320 321 322 323
      where
	keyword = case new_or_data of
			NewType  -> SLIT("newtype")
			DataType -> SLIT("data")
324

325
    ppr (ClassDecl context clas tyvars fds sigs methods _ src_loc)
326 327 328 329 330
      | null sigs	-- No "where" part
      = top_matter

      | otherwise	-- Laid out
      = sep [hsep [top_matter, ptext SLIT("where {")],
331
	     nest 4 (sep [sep (map ppr_sig sigs), pp_methods, char '}'])]
332
      where
333
        top_matter  = ptext SLIT("class") <+> pp_decl_head context clas tyvars <+> pprFundeps fds
334
	ppr_sig sig = ppr sig <> semi
335 336 337 338 339
	pp_methods = getPprStyle $ \ sty ->
        	     if ifaceStyle sty then empty else ppr methods
        
pp_decl_head :: Outputable name => HsContext name -> name -> [HsTyVarBndr name] -> SDoc
pp_decl_head context thing tyvars = hsep [pprHsContext context, ppr thing, interppSP tyvars]
340

341 342
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)
343

344
pp_tydecl pp_head pp_decl_rhs derivings
sof's avatar
sof committed
345
  = hang pp_head 4 (sep [
346
	pp_decl_rhs,
347 348 349
	case derivings of
	  Nothing 	   -> empty
	  Just ds	   -> hsep [ptext SLIT("deriving"), parens (interpp'SP ds)]
350
    ])
351 352 353 354 355 356 357 358 359 360 361
\end{code}


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

\begin{code}
data ConDecl name
362 363 364 365 366
  = 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
367

368
		[HsTyVarBndr name]		-- Existentially quantified type variables
369
		(HsContext name)	-- ...and context
370 371
					-- If both are empty then there are no existentials

sof's avatar
sof committed
372
		(ConDetails name)
373 374
		SrcLoc

sof's avatar
sof committed
375 376 377 378 379 380
data ConDetails name
  = VanillaCon			-- prefix-style con decl
		[BangType name]

  | InfixCon			-- infix-style con decl
		(BangType name)
381 382
		(BangType name)

sof's avatar
sof committed
383
  | RecCon			-- record-style con decl
384
		[([name], BangType name)]	-- list of "fields"
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
\end{code}

\begin{code}
conDeclsNames :: Eq name => [ConDecl name] -> [(name,SrcLoc)]
  -- See tyClDeclNames for what this does
  -- The function is boringly complicated because of the records
  -- And since we only have equality, we have to be a little careful
conDeclsNames cons
  = snd (foldl do_one ([], []) cons)
  where
    do_one (flds_seen, acc) (ConDecl name _ _ _ details loc)
	= do_details ((name,loc):acc) details
	where
	  do_details acc (RecCon flds) = foldl do_fld (flds_seen, acc) flds
	  do_details acc other	       = (flds_seen, acc)

	  do_fld acc (flds, _) = foldl do_fld1 acc flds
402

403 404 405 406 407 408
	  do_fld1 (flds_seen, acc) fld
		| fld `elem` flds_seen = (flds_seen,acc)
		| otherwise	       = (fld:flds_seen, (fld,loc):acc)
\end{code}

\begin{code}
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
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 _ _ = False

eq_fld env (ns1,bt1) (ns2, bt2) = ns1==ns2 && eq_btype env bt1 bt2
425
\end{code}
426
  
427
\begin{code}
428 429 430 431 432 433 434 435 436
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

437 438 439
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
440
eq_btype env _		   _		 = False
441 442 443
\end{code}

\begin{code}
444
instance (Outputable name) => Outputable (ConDecl name) where
445
    ppr (ConDecl con _ tvs cxt con_details  loc)
446
      = sep [pprHsForAll tvs cxt, ppr_con_details con con_details]
447

448 449
ppr_con_details con (InfixCon ty1 ty2)
  = hsep [ppr_bang ty1, ppr con, ppr_bang ty2]
450

451 452
ppr_con_details con (VanillaCon tys)
  = ppr con <+> hsep (map (ppr_bang) tys)
sof's avatar
sof committed
453

454 455
ppr_con_details con (RecCon fields)
  = ppr con <+> braces (hsep (punctuate comma (map ppr_field fields)))
sof's avatar
sof committed
456
  where
457
    ppr_field (ns, ty) = hsep (map (ppr) ns) <+> 
458
			 dcolon <+>
459
			 ppr_bang ty
sof's avatar
sof committed
460

461 462 463
instance Outputable name => Outputable (BangType name) where
    ppr = ppr_bang

464 465
ppr_bang (Banged   ty) = ptext SLIT("!") <> pprParendHsType ty
ppr_bang (Unbanged ty) = pprParendHsType ty
466
ppr_bang (Unpacked ty) = ptext SLIT("! !") <> pprParendHsType ty
467 468 469 470 471
\end{code}


%************************************************************************
%*									*
sof's avatar
sof committed
472
\subsection[InstDecl]{An instance declaration
473 474 475 476
%*									*
%************************************************************************

\begin{code}
477
data InstDecl name pat
478
  = InstDecl	(HsType name)	-- Context => Class Instance-type
479 480 481
				-- Using a polytype means that the renamer conveniently
				-- figures out the quantified type variables for us.

482
		(MonoBinds name pat)
483

484
		[Sig name]		-- User-supplied pragmatic info
485

486 487
		(Maybe name)		-- Name for the dictionary function
					-- Nothing for source-file instance decls
488 489 490 491 492

		SrcLoc
\end{code}

\begin{code}
493
instance (Outputable name, Outputable pat)
494
	      => Outputable (InstDecl name pat) where
495

496
    ppr (InstDecl inst_ty binds uprags maybe_dfun_name src_loc)
497
      = getPprStyle $ \ sty ->
498
        if ifaceStyle sty then
499
           hsep [ptext SLIT("instance"), ppr inst_ty, equals, pp_dfun]
500 501 502 503
	else
	   vcat [hsep [ptext SLIT("instance"), ppr inst_ty, ptext SLIT("where")],
	         nest 4 (ppr uprags),
	         nest 4 (ppr binds) ]
504 505 506 507
      where
	pp_dfun = case maybe_dfun_name of
		    Just df -> ppr df
		    Nothing -> empty
508 509
\end{code}

510 511 512 513 514 515 516
\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}

517 518 519 520 521 522 523 524 525 526 527 528 529

%************************************************************************
%*									*
\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
530
  = DefaultDecl	[HsType name]
531 532
		SrcLoc

533
instance (Outputable name)
534 535
	      => Outputable (DefaultDecl name) where

536 537
    ppr (DefaultDecl tys src_loc)
      = ptext SLIT("default") <+> parens (interpp'SP tys)
538
\end{code}
539

sof's avatar
sof committed
540 541 542 543 544 545 546 547 548 549
%************************************************************************
%*									*
\subsection{Foreign function interface declaration}
%*									*
%************************************************************************

\begin{code}
data ForeignDecl name = 
   ForeignDecl 
        name 
sof's avatar
sof committed
550
	ForKind   
sof's avatar
sof committed
551 552 553 554 555
	(HsType name)
	ExtName
	CallConv
	SrcLoc

556
instance (Outputable name)
sof's avatar
sof committed
557 558 559 560
	      => Outputable (ForeignDecl name) where

    ppr (ForeignDecl nm imp_exp ty ext_name cconv src_loc)
      = ptext SLIT("foreign") <+> ppr_imp_exp <+> pprCallConv cconv <+> 
561
        ppr ext_name <+> ppr_unsafe <+> ppr nm <+> dcolon <+> ppr ty
sof's avatar
sof committed
562 563 564
        where
         (ppr_imp_exp, ppr_unsafe) =
	   case imp_exp of
sof's avatar
sof committed
565 566 567 568 569 570 571 572 573 574
	     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
575 576 577

data ExtName
 = Dynamic 
578 579 580 581 582 583 584 585 586 587 588 589
 | 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
590 591 592 593 594

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

598 599
%************************************************************************
%*									*
600
\subsection{Transformation rules}
601 602 603 604
%*									*
%************************************************************************

\begin{code}
605
data RuleDecl name pat
606
  = HsRule			-- Source rule
607 608 609 610 611 612 613 614
	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		

615 616 617 618 619 620
  | 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
621 622
	SrcLoc		

623 624 625 626 627
  | IfaceRuleOut		-- Post typecheck
	name			-- Head of LHS
	CoreRule


628 629 630
data RuleBndr name
  = RuleBndr name
  | RuleBndrSig name (HsType name)
631

632 633 634 635 636 637 638
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))

639 640
instance (Outputable name, Outputable pat)
	      => Outputable (RuleDecl name pat) where
641
  ppr (HsRule name tvs ns lhs rhs loc)
642 643 644
	= sep [text "{-# RULES" <+> doubleQuotes (ptext name),
	       pp_forall, ppr lhs, equals <+> ppr rhs,
               text "#-}" ]
645 646 647 648 649
	where
	  pp_forall | null tvs && null ns = empty
		    | otherwise		  = text "forall" <+> 
					    fsep (map ppr tvs ++ map ppr ns)
					    <> dot
650 651 652 653 654 655 656 657 658

  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
659 660 661 662

instance Outputable name => Outputable (RuleBndr name) where
   ppr (RuleBndr name) = ppr name
   ppr (RuleBndrSig name ty) = ppr name <> dcolon <> ppr ty
663 664 665 666 667

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

toHsRule id (Rule name bndrs args rhs)
668
  = IfaceRule name (map toUfBndr bndrs) (getName id)
669 670 671
	      (map toUfExpr args) (toUfExpr rhs) noSrcLoc

bogusIfaceRule id
672
  = IfaceRule SLIT("bogus") [] (getName id) [] (UfVar (getName id)) noSrcLoc
673 674 675 676 677 678 679 680 681
\end{code}


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

682
We use exported entities for things to deprecate.
683 684

\begin{code}
685
data DeprecDecl name = Deprecation name DeprecTxt SrcLoc
686 687 688 689

type DeprecTxt = FAST_STRING	-- reason/explanation for deprecation

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