HsDecls.lhs 24.1 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 @oCnDecl@, @ClassDecl@,
sof's avatar
sof committed
7
@InstDecl@, @DefaultDecl@ and @ForeignDecl@.
8 9

\begin{code}
10
module HsDecls (
11
	HsDecl(..), LHsDecl, TyClDecl(..), LTyClDecl, 
12
	InstDecl(..), LInstDecl, NewOrData(..),
13 14 15
	RuleDecl(..), LRuleDecl, RuleBndr(..),
	DefaultDecl(..), LDefaultDecl, HsGroup(..), SpliceDecl(..),
	ForeignDecl(..), LForeignDecl, ForeignImport(..), ForeignExport(..),
chak's avatar
chak committed
16
	CImportSpec(..), FoType(..),
17
	ConDecl(..), LConDecl,	
18 19
	DeprecDecl(..),  LDeprecDecl,
	tcdName, tyClDeclNames, tyClDeclTyVars,
20 21
	isClassDecl, isSynDecl, isDataDecl, 
	countTyClDecls,
22
	conDetailsTys,
23
	collectRuleBndrSigTys, 
24
    ) where
25

26
#include "HsVersions.h"
27 28

-- friends:
29 30 31
import {-# SOURCE #-}	HsExpr( HsExpr, pprExpr )
	-- Because Expr imports Decls via HsBracket

32
import HsBinds		( HsBindGroup, HsBind, LHsBinds, 
33
			  Sig(..), LSig, LFixitySig, pprLHsBinds )
34 35
import HsPat		( HsConDetails(..), hsConArgs )
import HsImpExp		( pprHsVar )
36
import HsTypes
37 38
import HscTypes		( DeprecTxt )
import CoreSyn		( RuleName )
39
import BasicTypes	( Activation(..) )
chak's avatar
chak committed
40
import ForeignCall	( CCallTarget(..), DNCallSpec, CCallConv, Safety,
41
			  CExportSpec(..), CLabelString ) 
42 43

-- others:
44
import FunDeps		( pprFundeps )
45
import Class		( FunDep )
46
import Outputable	
47
import Util		( count )
48
import SrcLoc		( Located(..), unLoc )
rrt's avatar
rrt committed
49
import FastString
50 51
\end{code}

52 53 54 55 56 57 58 59

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

\begin{code}
60 61
type LHsDecl id = Located (HsDecl id)

62 63 64
data HsDecl id
  = TyClD	(TyClDecl id)
  | InstD	(InstDecl  id)
65
  | ValD	(HsBind id)
66
  | SigD	(Sig id)
67 68 69 70
  | DefD	(DefaultDecl id)
  | ForD        (ForeignDecl id)
  | DeprecD	(DeprecDecl id)
  | RuleD	(RuleDecl id)
71
  | SpliceD	(SpliceDecl id)
72 73

-- NB: all top-level fixity decls are contained EITHER
74
-- EITHER SigDs
75 76 77 78 79 80 81 82 83 84
-- 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
85

86 87 88 89
-- A [HsDecl] is categorised into a HsGroup before being 
-- fed to the renamer.
data HsGroup id
  = HsGroup {
90 91
	hs_valds  :: [HsBindGroup id],
		-- Before the renamer, this is a single big HsBindGroup,
92
		-- with all the bindings, and all the signatures.
93 94
		-- The renamer does dependency analysis, splitting it up
		-- into several HsBindGroups.
95

96 97
	hs_tyclds :: [LTyClDecl id],
	hs_instds :: [LInstDecl id],
98

99
	hs_fixds  :: [LFixitySig id],
100 101 102
		-- Snaffled out of both top-level fixity signatures,
		-- and those in class declarations

103 104 105 106
	hs_defds  :: [LDefaultDecl id],
	hs_fords  :: [LForeignDecl id],
	hs_depds  :: [LDeprecDecl id],
	hs_ruleds :: [LRuleDecl id]
107
  }
108 109 110
\end{code}

\begin{code}
111
instance OutputableBndr name => Outputable (HsDecl name) where
112
    ppr (TyClD dcl)  = ppr dcl
113 114 115
    ppr (ValD binds) = ppr binds
    ppr (DefD def)   = ppr def
    ppr (InstD inst) = ppr inst
sof's avatar
sof committed
116
    ppr (ForD fd)    = ppr fd
117
    ppr (SigD sd)    = ppr sd
118
    ppr (RuleD rd)   = ppr rd
119
    ppr (DeprecD dd) = ppr dd
120
    ppr (SpliceD dd) = ppr dd
121 122 123 124 125 126 127 128 129

instance OutputableBndr name => Outputable (HsGroup name) where
    ppr (HsGroup { hs_valds  = val_decls,
		   hs_tyclds = tycl_decls,
		   hs_instds = inst_decls,
		   hs_fixds  = fix_decls,
		   hs_depds  = deprec_decls,
		   hs_fords  = foreign_decls,
		   hs_defds  = default_decls,
130
		   hs_ruleds = rule_decls })
131 132 133 134
	= vcat [ppr_ds fix_decls, ppr_ds default_decls, 
		ppr_ds deprec_decls, ppr_ds rule_decls,
		ppr val_decls,
		ppr_ds tycl_decls, ppr_ds inst_decls,
135
		ppr_ds foreign_decls]
136 137 138
	where
	  ppr_ds [] = empty
	  ppr_ds ds = text "" $$ vcat (map ppr ds)
139

140
data SpliceDecl id = SpliceDecl (Located (HsExpr id))	-- Top level splice
141 142

instance OutputableBndr name => Outputable (SpliceDecl name) where
143
   ppr (SpliceDecl e) = ptext SLIT("$") <> parens (pprExpr (unLoc e))
144 145
\end{code}

146

147 148 149 150 151 152
%************************************************************************
%*									*
\subsection[TyDecl]{@data@, @newtype@ or @type@ (synonym) type declaration}
%*									*
%************************************************************************

153 154 155
		--------------------------------
			THE NAMING STORY
		--------------------------------
156

157 158
Here is the story about the implicit names that go with type, class,
and instance decls.  It's a bit tricky, so pay attention!
159 160 161

"Implicit" (or "system") binders
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
162 163 164 165 166 167 168 169 170
  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

171 172
All have occurrence names that are derived uniquely from their parent
declaration.
173 174 175 176 177 178 179 180 181

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:
 - Ensure they "point to" the parent data/class decl 
   when loading that decl from an interface file
182 183 184 185 186
   (See RnHiFiles.getSysBinders)

 - When typechecking the decl, we build the implicit TyCons and Ids.
   When doing so we look them up in the name cache (RnEnv.lookupSysName),
   to ensure correct module and provenance is set
187

188 189
These are the two places that we have to conjure up the magic derived
names.  (The actual magic is in OccName.mkWorkerOcc, etc.)
190

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
Default methods
~~~~~~~~~~~~~~~
 - Occurrence name is derived uniquely from the method name
   E.g. $dmmax

 - If there is a default method name at all, it's recorded in
   the ClassOpSig (in HsBinds), in the DefMeth field.
   (DefMeth is defined in Class.lhs)

Source-code class decls and interface-code class decls are treated subtly
differently, which has given me a great deal of confusion over the years.
Here's the deal.  (We distinguish the two cases because source-code decls
have (Just binds) in the tcdMeths field, whereas interface decls have Nothing.

In *source-code* class declarations:
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 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
 - When parsing, every ClassOpSig gets a DefMeth with a suitable RdrName
   This is done by RdrHsSyn.mkClassOpSigDM

 - The renamer renames it to a Name

 - During typechecking, we generate a binding for each $dm for 
   which there's a programmer-supplied default method:
	class Foo a where
	  op1 :: <type>
	  op2 :: <type>
	  op1 = ...
   We generate a binding for $dmop1 but not for $dmop2.
   The Class for Foo has a NoDefMeth for op2 and a DefMeth for op1.
   The Name for $dmop2 is simply discarded.

In *interface-file* class declarations:
  - When parsing, we see if there's an explicit programmer-supplied default method
    because there's an '=' sign to indicate it:
	class Foo a where
	  op1 = :: <type>	-- NB the '='
  	  op2   :: <type>
    We use this info to generate a DefMeth with a suitable RdrName for op1,
    and a NoDefMeth for op2
  - The interface file has a separate definition for $dmop1, with unfolding etc.
  - The renamer renames it to a Name.
  - The renamer treats $dmop1 as a free variable of the declaration, so that
    the binding for $dmop1 will be sucked in.  (See RnHsSyn.tyClDeclFVs)  
    This doesn't happen for source code class decls, because they *bind* the default method.

Dictionary functions
~~~~~~~~~~~~~~~~~~~~
Each instance declaration gives rise to one dictionary function binding.

The type checker makes up new source-code instance declarations
(e.g. from 'deriving' or generic default methods --- see
TcInstDcls.tcInstDecls1).  So we can't generate the names for
dictionary functions in advance (we don't know how many we need).

On the other hand for interface-file instance declarations, the decl
specifies the name of the dictionary function, and it has a binding elsewhere
in the interface file:
	instance {Eq Int} = dEqInt
	dEqInt :: {Eq Int} <pragma info>

So again we treat source code and interface file code slightly differently.

Source code:
  - Source code instance decls have a Nothing in the (Maybe name) field
    (see data InstDecl below)

  - The typechecker makes up a Local name for the dict fun for any source-code
    instance decl, whether it comes from a source-code instance decl, or whether
    the instance decl is derived from some other construct (e.g. 'deriving').

  - The occurrence name it chooses is derived from the instance decl (just for 
    documentation really) --- e.g. dNumInt.  Two dict funs may share a common
    occurrence name, but will have different uniques.  E.g.
	instance Foo [Int]  where ...
	instance Foo [Bool] where ...
    These might both be dFooList

268
  - The CoreTidy phase externalises the name, and ensures the occurrence name is
269 270 271 272 273 274 275 276 277 278 279 280
    unique (this isn't special to dict funs).  So we'd get dFooList and dFooList1.

  - We can take this relaxed approach (changing the occurrence name later) 
    because dict fun Ids are not captured in a TyCon or Class (unlike default
    methods, say).  Instead, they are kept separately in the InstEnv.  This
    makes it easy to adjust them after compiling a module.  (Once we've finished
    compiling that module, they don't change any more.)


Interface file code:
  - The instance decl gives the dict fun name, so the InstDecl has a (Just name)
    in the (Maybe name) field.
281

282 283
  - RnHsSyn.instDeclFVs treats the dict fun name as free in the decl, so that we
    suck in the dfun binding
284 285


286
\begin{code}
287 288 289 290 291
-- TyClDecls are precisely the kind of declarations that can 
-- appear in interface files; or (internally) in GHC's interface
-- for a module.  That's why (despite the misnomer) IfaceSig and ForeignType
-- are both in TyClDecl

292 293
type LTyClDecl name = Located (TyClDecl name)

294
data TyClDecl name
295 296 297 298 299
  = ForeignType { 
		tcdLName    :: Located name,
		tcdExtName  :: Maybe FastString,
		tcdFoType   :: FoType
  }
300

301
  | TyData {	tcdND     :: NewOrData,
302 303 304 305
		tcdCtxt   :: LHsContext name,	 	-- Context
		tcdLName  :: Located name,	 	-- Type constructor
		tcdTyVars :: [LHsTyVarBndr name], 	-- Type variables
		tcdCons	  :: [LConDecl name],	 	-- Data constructors
306
		tcdDerivs :: Maybe [LHsType name]
307 308
			-- Derivings; Nothing => not specified
			-- 	      Just [] => derive exactly what is asked
309 310 311 312
			-- These "types" must be of form
			--	forall ab. C ty1 ty2
			-- Typically the foralls and ty args are empty, but they
			-- are non-empty for the newtype-deriving case
313 314
    }

315 316 317
  | TySynonym {	tcdLName  :: Located name,	        -- type constructor
		tcdTyVars :: [LHsTyVarBndr name],	-- type variables
		tcdSynRhs :: LHsType name	        -- synonym expansion
318 319
    }

320 321 322 323 324 325
  | ClassDecl {	tcdCtxt    :: LHsContext name, 	 	-- Context...
		tcdLName   :: Located name,	    	-- Name of the class
		tcdTyVars  :: [LHsTyVarBndr name],	-- Class type variables
		tcdFDs     :: [Located (FunDep name)],	-- Functional deps
		tcdSigs    :: [LSig name],		-- Methods' signatures
		tcdMeths   :: LHsBinds name		-- Default methods
326
    }
327 328 329 330 331

data NewOrData
  = NewType  	-- "newtype Blah ..."
  | DataType 	-- "data Blah ..."
  deriving( Eq )	-- Needed because Demand derives Eq
332 333 334 335 336
\end{code}

Simple classifiers

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

339 340
isSynDecl (TySynonym {}) = True
isSynDecl other		 = False
341

342 343
isDataDecl (TyData {}) = True
isDataDecl other       = False
344

345 346
isClassDecl (ClassDecl {}) = True
isClassDecl other	   = False
347 348 349
\end{code}

Dealing with names
350

351
\begin{code}
352 353
tcdName :: TyClDecl name -> name
tcdName decl = unLoc (tcdLName decl)
354

355
tyClDeclNames :: Eq name => TyClDecl name -> [Located name]
356
-- Returns all the *binding* names of the decl, along with their SrcLocs
357 358 359 360
-- 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

361 362
tyClDeclNames (TySynonym   {tcdLName = name})  = [name]
tyClDeclNames (ForeignType {tcdLName = name})  = [name]
363

364 365
tyClDeclNames (ClassDecl {tcdLName = cls_name, tcdSigs = sigs})
  = cls_name : [n | L _ (Sig n _) <- sigs]
366

367 368
tyClDeclNames (TyData {tcdLName = tc_name, tcdCons = cons})
  = tc_name : conDeclsNames (map unLoc cons)
369

370 371 372 373
tyClDeclTyVars (TySynonym {tcdTyVars = tvs}) = tvs
tyClDeclTyVars (TyData    {tcdTyVars = tvs}) = tvs
tyClDeclTyVars (ClassDecl {tcdTyVars = tvs}) = tvs
tyClDeclTyVars (ForeignType {})		     = []
374 375 376
\end{code}

\begin{code}
377
countTyClDecls :: [TyClDecl name] -> (Int, Int, Int, Int)
378 379
	-- class, data, newtype, synonym decls
countTyClDecls decls 
sof's avatar
sof committed
380 381 382 383 384 385 386 387 388 389
 = (count isClassDecl     decls,
    count isSynDecl       decls,
    count isDataTy        decls,
    count isNewTy         decls) 
 where
   isDataTy TyData{tcdND=DataType} = True
   isDataTy _                      = False
   
   isNewTy TyData{tcdND=NewType} = True
   isNewTy _                     = False
390 391 392
\end{code}

\begin{code}
393 394
instance OutputableBndr name
	      => Outputable (TyClDecl name) where
395

396 397
    ppr (ForeignType {tcdLName = ltycon})
	= hsep [ptext SLIT("foreign import type dotnet"), ppr ltycon]
398

399 400
    ppr (TySynonym {tcdLName = ltycon, tcdTyVars = tyvars, tcdSynRhs = mono_ty})
      = hang (ptext SLIT("type") <+> pp_decl_head [] ltycon tyvars <+> equals)
401
	     4 (ppr mono_ty)
402

403
    ppr (TyData {tcdND = new_or_data, tcdCtxt = context, tcdLName = ltycon,
404
		 tcdTyVars = tyvars, tcdCons = condecls, 
405
		 tcdDerivs = derivings})
406
      = pp_tydecl (ppr new_or_data <+> pp_decl_head (unLoc context) ltycon tyvars)
407
		  (pp_condecls condecls)
408 409
		  derivings

410
    ppr (ClassDecl {tcdCtxt = context, tcdLName = lclas, tcdTyVars = tyvars, tcdFDs = fds,
411
		    tcdSigs = sigs, tcdMeths = methods})
412 413 414 415 416
      | null sigs	-- No "where" part
      = top_matter

      | otherwise	-- Laid out
      = sep [hsep [top_matter, ptext SLIT("where {")],
417
	     nest 4 (sep [sep (map ppr_sig sigs), ppr methods, char '}'])]
418
      where
419
        top_matter  = ptext SLIT("class") <+> pp_decl_head (unLoc context) lclas tyvars <+> pprFundeps (map unLoc fds)
420
	ppr_sig sig = ppr sig <> semi
421

422 423 424 425 426 427 428
pp_decl_head :: OutputableBndr name
   => HsContext name
   -> Located name
   -> [LHsTyVarBndr name]
   -> SDoc
pp_decl_head context thing tyvars
  = hsep [pprHsContext context, ppr thing, interppSP tyvars]
429

430 431 432 433
pp_condecls cs@(L _ (GadtDecl _ _) : _) -- In GADT syntax
  = hang (ptext SLIT("where")) 2 (vcat (map ppr cs))
pp_condecls cs 			  -- In H98 syntax
  = equals <+> sep (punctuate (ptext SLIT(" |")) (map ppr cs))
434

435
pp_tydecl pp_head pp_decl_rhs derivings
sof's avatar
sof committed
436
  = hang pp_head 4 (sep [
437
	pp_decl_rhs,
438 439
	case derivings of
	  Nothing 	   -> empty
440
	  Just ds	   -> hsep [ptext SLIT("deriving"), parens (interpp'SP ds)]
441
    ])
442 443 444 445

instance Outputable NewOrData where
  ppr NewType  = ptext SLIT("newtype")
  ppr DataType = ptext SLIT("data")
446 447 448 449 450 451 452 453 454 455
\end{code}


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

\begin{code}
456 457
type LConDecl name = Located (ConDecl name)

458
data ConDecl name
459
  = ConDecl 	(Located name)		-- Constructor name; this is used for the
460 461
					-- DataCon itself, and for the user-callable wrapper Id

462 463
		[LHsTyVarBndr name]	-- Existentially quantified type variables
		(LHsContext name)	-- ...and context
464
					-- If both are empty then there are no existentials
465
		(HsConDetails name (LBangType name))
466 467 468 469 470

  | GadtDecl    (Located name)          -- Constructor name; this is used for the
					-- DataCon itself, and for the user-callable wrapper Id
                (LHsType name)          -- Constructor type; it may have HsBangs on the 
					-- argument types
471 472 473
\end{code}

\begin{code}
474
conDeclsNames :: Eq name => [ConDecl name] -> [Located name]
475 476 477 478
  -- 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
479
  = snd (foldl do_one ([], []) cons)
480
  where
481 482
    do_one (flds_seen, acc) (ConDecl lname _ _ (RecCon flds))
	= (map unLoc new_flds ++ flds_seen, lname : [f | f <- new_flds] ++ acc)
483
	where
484
	  new_flds = [ f | (f,_) <- flds, not (unLoc f `elem` flds_seen) ]
485

486 487
    do_one (flds_seen, acc) (ConDecl lname _ _ _)
	= (flds_seen, lname:acc)
488

489 490 491 492
-- gaw 2004
    do_one (flds_seen, acc) (GadtDecl lname _)
	= (flds_seen, lname:acc)

493
conDetailsTys details = map getBangType (hsConArgs details)
494
\end{code}
495
  
496 497

\begin{code}
498
instance (OutputableBndr name) => Outputable (ConDecl name) where
499
    ppr (ConDecl con tvs cxt con_details)
500
      = sep [pprHsForAll Explicit tvs cxt, ppr_con_details con con_details]
501 502
    ppr (GadtDecl con ty)
      = ppr con <+> dcolon <+> ppr ty
503

504
ppr_con_details con (InfixCon ty1 ty2)
505
  = hsep [ppr ty1, pprHsVar con, ppr ty2]
506

507
-- ConDecls generated by MkIface.ifaceTyThing always have a PrefixCon, even
508 509 510
-- if the constructor is an infix one.  This is because in an interface file
-- we don't distinguish between the two.  Hence when printing these for the
-- user, we need to parenthesise infix constructor names.
511
ppr_con_details con (PrefixCon tys)
512
  = hsep (pprHsVar con : map ppr tys)
sof's avatar
sof committed
513

514
ppr_con_details con (RecCon fields)
515
  = ppr con <+> braces (sep (punctuate comma (map ppr_field fields)))
sof's avatar
sof committed
516
  where
517
    ppr_field (n, ty) = ppr n <+> dcolon <+> ppr ty
sof's avatar
sof committed
518

519 520 521 522
\end{code}

%************************************************************************
%*									*
sof's avatar
sof committed
523
\subsection[InstDecl]{An instance declaration
524 525 526 527
%*									*
%************************************************************************

\begin{code}
528 529
type LInstDecl name = Located (InstDecl name)

530
data InstDecl name
531
  = InstDecl	(LHsType name)	-- Context => Class Instance-type
532 533
				-- Using a polytype means that the renamer conveniently
				-- figures out the quantified type variables for us.
534 535
		(LHsBinds name)
		[LSig name]		-- User-supplied pragmatic info
536

537
instance (OutputableBndr name) => Outputable (InstDecl name) where
538

539
    ppr (InstDecl inst_ty binds uprags)
540 541
      = vcat [hsep [ptext SLIT("instance"), ppr inst_ty, ptext SLIT("where")],
	      nest 4 (ppr uprags),
542
	      nest 4 (pprLHsBinds binds) ]
543 544
\end{code}

545 546 547 548 549 550 551 552 553 554 555
%************************************************************************
%*									*
\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}
556 557
type LDefaultDecl name = Located (DefaultDecl name)

558
data DefaultDecl name
559
  = DefaultDecl	[LHsType name]
560

561
instance (OutputableBndr name)
562 563
	      => Outputable (DefaultDecl name) where

564
    ppr (DefaultDecl tys)
565
      = ptext SLIT("default") <+> parens (interpp'SP tys)
566
\end{code}
567

sof's avatar
sof committed
568 569 570 571 572 573 574
%************************************************************************
%*									*
\subsection{Foreign function interface declaration}
%*									*
%************************************************************************

\begin{code}
chak's avatar
chak committed
575 576 577 578 579 580 581

-- foreign declarations are distinguished as to whether they define or use a
-- Haskell name
--
-- * the Boolean value indicates whether the pre-standard deprecated syntax
--   has been used
--
582 583
type LForeignDecl name = Located (ForeignDecl name)

584
data ForeignDecl name
585 586
  = ForeignImport (Located name) (LHsType name) ForeignImport Bool  -- defines name
  | ForeignExport (Located name) (LHsType name) ForeignExport Bool  -- uses name
587

chak's avatar
chak committed
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
-- specification of an imported external entity in dependence on the calling
-- convention 
--
data ForeignImport = -- import of a C entity
		     --
                     -- * the two strings specifying a header file or library
                     --   may be empty, which indicates the absence of a
                     --   header or object specification (both are not used
                     --   in the case of `CWrapper' and when `CFunction'
                     --   has a dynamic target)
		     --
		     -- * the calling convention is irrelevant for code
		     --   generation in the case of `CLabel', but is needed
		     --   for pretty printing 
		     --
		     -- * `Safety' is irrelevant for `CLabel' and `CWrapper'
		     --
		     CImport  CCallConv	      -- ccall or stdcall
			      Safety	      -- safe or unsafe
			      FastString      -- name of C header
			      FastString      -- name of library object
			      CImportSpec     -- details of the C entity

                     -- import of a .NET function
		     --
		   | DNImport DNCallSpec

-- details of an external C entity
--
data CImportSpec = CLabel    CLabelString     -- import address of a C label
		 | CFunction CCallTarget      -- static or dynamic function
		 | CWrapper		      -- wrapper to expose closures
					      -- (former f.e.d.)
621

chak's avatar
chak committed
622 623 624 625 626
-- specification of an externally exported entity in dependence on the calling
-- convention
--
data ForeignExport = CExport  CExportSpec    -- contains the calling convention
		   | DNExport		     -- presently unused
627

chak's avatar
chak committed
628 629
-- abstract type imported from .NET
--
630
data FoType = DNType 		-- In due course we'll add subtype stuff
chak's avatar
chak committed
631 632 633 634 635
	    deriving (Eq)	-- Used for equality instance for TyClDecl


-- pretty printing of foreign declarations
--
636

637
instance OutputableBndr name => Outputable (ForeignDecl name) where
638
  ppr (ForeignImport n ty fimport _) =
chak's avatar
chak committed
639 640
    ptext SLIT("foreign import") <+> ppr fimport <+> 
    ppr n <+> dcolon <+> ppr ty
641
  ppr (ForeignExport n ty fexport _) =
chak's avatar
chak committed
642 643 644 645 646 647 648 649 650 651 652
    ptext SLIT("foreign export") <+> ppr fexport <+> 
    ppr n <+> dcolon <+> ppr ty

instance Outputable ForeignImport where
  ppr (DNImport			        spec) = 
    ptext SLIT("dotnet") <+> ppr spec
  ppr (CImport  cconv safety header lib spec) =
    ppr cconv <+> ppr safety <+> 
    char '"' <> pprCEntity header lib spec <> char '"'
    where
      pprCEntity header lib (CLabel lbl) = 
653
        ptext SLIT("static") <+> ftext header <+> char '&' <>
chak's avatar
chak committed
654 655
	pprLib lib <> ppr lbl
      pprCEntity header lib (CFunction (StaticTarget lbl)) = 
656
        ptext SLIT("static") <+> ftext header <+> char '&' <>
chak's avatar
chak committed
657 658 659 660 661 662 663 664 665 666 667 668 669
	pprLib lib <> ppr lbl
      pprCEntity header lib (CFunction (DynamicTarget)) = 
        ptext SLIT("dynamic")
      pprCEntity _      _   (CWrapper) = ptext SLIT("wrapper")
      --
      pprLib lib | nullFastString lib = empty
		 | otherwise	      = char '[' <> ppr lib <> char ']'

instance Outputable ForeignExport where
  ppr (CExport  (CExportStatic lbl cconv)) = 
    ppr cconv <+> char '"' <> ppr lbl <> char '"'
  ppr (DNExport                          ) = 
    ptext SLIT("dotnet") <+> ptext SLIT("\"<unused>\"")
670 671

instance Outputable FoType where
chak's avatar
chak committed
672
  ppr DNType = ptext SLIT("type dotnet")
sof's avatar
sof committed
673 674
\end{code}

675

676 677
%************************************************************************
%*									*
678
\subsection{Transformation rules}
679 680 681 682
%*									*
%************************************************************************

\begin{code}
683 684
type LRuleDecl name = Located (RuleDecl name)

685
data RuleDecl name
686
  = HsRule			-- Source rule
687 688
	RuleName		-- Rule name
	Activation
689
	[RuleBndr name]		-- Forall'd vars; after typechecking this includes tyvars
690 691
	(Located (HsExpr name))	-- LHS
	(Located (HsExpr name))	-- RHS
692 693

data RuleBndr name
694 695
  = RuleBndr (Located name)
  | RuleBndrSig (Located name) (LHsType name)
696

697
collectRuleBndrSigTys :: [RuleBndr name] -> [LHsType name]
698 699
collectRuleBndrSigTys bndrs = [ty | RuleBndrSig _ ty <- bndrs]

700
instance OutputableBndr name => Outputable (RuleDecl name) where
701
  ppr (HsRule name act ns lhs rhs)
702
	= sep [text "{-# RULES" <+> doubleQuotes (ftext name) <+> ppr act,
703 704
	       nest 4 (pp_forall <+> pprExpr (unLoc lhs)), 
	       nest 4 (equals <+> pprExpr (unLoc rhs) <+> text "#-}") ]
705
	where
706 707
	  pp_forall | null ns   = empty
		    | otherwise	= text "forall" <+> fsep (map ppr ns) <> dot
708

709
instance OutputableBndr name => Outputable (RuleBndr name) where
710 711
   ppr (RuleBndr name) = ppr name
   ppr (RuleBndrSig name ty) = ppr name <> dcolon <> ppr ty
712 713 714 715 716 717 718 719 720
\end{code}


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

721
We use exported entities for things to deprecate.
722 723

\begin{code}
724 725 726
type LDeprecDecl name = Located (DeprecDecl name)

data DeprecDecl name = Deprecation name DeprecTxt
727

728
instance OutputableBndr name => Outputable (DeprecDecl name) where
729
    ppr (Deprecation thing txt)
730
      = hsep [text "{-# DEPRECATED", ppr thing, doubleQuotes (ppr txt), text "#-}"]
731
\end{code}