HsDecls.lhs 28.2 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(..), TyClDecl(..), InstDecl(..), RuleDecl(..), RuleBndr(..),
12 13
	DefaultDecl(..), 
	ForeignDecl(..), FoImport(..), FoExport(..), FoType(..),
14
	ConDecl(..), ConDetails(..), 
15
	BangType(..), getBangType, getBangStrictness, unbangedType,
16
	DeprecDecl(..), DeprecTxt,
17 18
	hsDeclName, instDeclName, 
	tyClDeclName, tyClDeclNames, tyClDeclSysNames, tyClDeclTyVars,
19
	isClassDecl, isSynDecl, isDataDecl, isIfaceSigDecl, countTyClDecls,
20
	mkClassDeclSysNames, isIfaceRuleDecl, ifaceRuleDeclName,
21
	getClassDeclSysNames, conDetailsTys
22
    ) where
23

24
#include "HsVersions.h"
25 26

-- friends:
27
import HsBinds		( HsBinds, MonoBinds, Sig(..), FixitySig(..) )
28
import HsExpr		( HsExpr )
29
import HsImpExp		( ppr_var )
30
import HsTypes
31
import PprCore		( pprCoreRule )
32 33
import HsCore		( UfExpr, UfBinder, HsIdInfo, pprHsIdInfo,
			  eq_ufBinders, eq_ufExpr, pprUfExpr 
34
			)
35 36
import CoreSyn		( CoreRule(..), RuleName )
import BasicTypes	( NewOrData(..), StrictnessMark(..), Activation(..) )
37
import ForeignCall	( CExportSpec, CCallSpec, DNCallSpec, CCallConv )
38 39

-- others:
40
import Name		( NamedThing )
41
import FunDeps		( pprFundeps )
42
import Class		( FunDep, DefMeth(..) )
43
import CStrings		( CLabelString )
44
import Outputable	
sof's avatar
sof committed
45
import Util		( eqListBy, count )
46
import SrcLoc		( SrcLoc )
rrt's avatar
rrt committed
47
import FastString
48 49

import Maybe		( isNothing, fromJust )	
50 51
\end{code}

52 53 54 55 56 57 58 59

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

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

-- 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
82 83 84
\end{code}

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

98 99 100

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

102 103 104
\end{code}

\begin{code}
105
instance (NamedThing name, Outputable name, Outputable pat)
106
	=> Outputable (HsDecl name pat) where
107

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

118

119 120 121 122 123 124
%************************************************************************
%*									*
\subsection[TyDecl]{@data@, @newtype@ or @type@ (synonym) type declaration}
%*									*
%************************************************************************

125 126 127
		--------------------------------
			THE NAMING STORY
		--------------------------------
128

129 130 131 132 133
Here is the story about the implicit names that go with type, class, and instance
decls.  It's a bit tricky, so pay attention!

"Implicit" (or "system") binders
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
  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
152
   This is done in RdrHsSyn.mkClassDecl, mkTyDecl, mkConDecl
153 154 155

 - Ensure they "point to" the parent data/class decl 
   when loading that decl from an interface file
156
   (See RnHiFiles.getTyClDeclSysNames)
157 158 159 160

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

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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 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 244 245 246 247 248 249
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:
 - 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

  - The CoreTidy phase globalises the name, and ensures the occurrence name is
    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.
250

251 252
  - RnHsSyn.instDeclFVs treats the dict fun name as free in the decl, so that we
    suck in the dfun binding
253 254


255
\begin{code}
256 257 258 259 260
-- 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

261
data TyClDecl name pat
262
  = IfaceSig {	tcdName :: name,		-- It may seem odd to classify an interface-file signature
263 264
		tcdType :: HsType name,		-- as a 'TyClDecl', but it's very convenient.  
		tcdIdInfo :: [HsIdInfo name],
265 266 267
		tcdLoc :: SrcLoc
    }

rrt's avatar
rrt committed
268 269 270 271
  | ForeignType { tcdName    :: name,		-- See remarks about IfaceSig above
		  tcdExtName :: Maybe FastString,
		  tcdFoType  :: FoType,
		  tcdLoc     :: SrcLoc }
272

273 274 275 276 277 278 279
  | TyData {	tcdND     :: NewOrData,
		tcdCtxt   :: HsContext name,	 -- context
		tcdName   :: name,		 -- type constructor
		tcdTyVars :: [HsTyVarBndr name], -- type variables
		tcdCons	  :: [ConDecl name],	 -- data constructors (empty if abstract)
		tcdNCons  :: Int,		 -- Number of data constructors (valid even if type is abstract)
		tcdDerivs :: Maybe [name],	 -- derivings; Nothing => not specified
280 281 282
				 -- (i.e., derive default); Just [] => derive
				 -- *nothing*; Just <list> => as you would
				 -- expect...
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
		tcdSysNames :: DataSysNames name,	-- Generic converter functions
		tcdLoc	    :: SrcLoc
    }

  | TySynonym {	tcdName :: name,		        -- type constructor
		tcdTyVars :: [HsTyVarBndr name],	-- type variables
		tcdSynRhs :: HsType name,	        -- synonym expansion
		tcdLoc    :: SrcLoc
    }

  | ClassDecl {	tcdCtxt    :: HsContext name, 	 	-- Context...
		tcdName    :: name,		    	-- Name of the class
		tcdTyVars  :: [HsTyVarBndr name],	-- The class type variables
		tcdFDs     :: [FunDep name],		-- Functional dependencies
		tcdSigs    :: [Sig name],		-- Methods' signatures
		tcdMeths   :: Maybe (MonoBinds name pat),	-- Default methods
								-- Nothing for imported class decls
								-- Just bs for source   class decls
		tcdSysNames :: ClassSysNames name,
		tcdLoc      :: SrcLoc
    }
304 305 306 307 308 309 310
\end{code}

Simple classifiers

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

311 312
isIfaceSigDecl (IfaceSig {}) = True
isIfaceSigDecl other	     = False
313

314 315
isSynDecl (TySynonym {}) = True
isSynDecl other		 = False
316

317 318
isDataDecl (TyData {}) = True
isDataDecl other       = False
319

320 321
isClassDecl (ClassDecl {}) = True
isClassDecl other	   = False
322 323 324
\end{code}

Dealing with names
325

326
\begin{code}
327
--------------------------------
328
tyClDeclName :: TyClDecl name pat -> name
329
tyClDeclName tycl_decl = tcdName tycl_decl
330

331
--------------------------------
332
tyClDeclNames :: Eq name => TyClDecl name pat -> [(name, SrcLoc)]
333
-- Returns all the *binding* names of the decl, along with their SrcLocs
334 335 336 337
-- 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

338 339 340
tyClDeclNames (TySynonym   {tcdName = name, tcdLoc = loc})  = [(name,loc)]
tyClDeclNames (IfaceSig    {tcdName = name, tcdLoc = loc})  = [(name,loc)]
tyClDeclNames (ForeignType {tcdName = name, tcdLoc = loc})  = [(name,loc)]
341

342
tyClDeclNames (ClassDecl {tcdName = cls_name, tcdSigs = sigs, tcdLoc = loc})
343
  = (cls_name,loc) : [(n,loc) | ClassOpSig n _ _ loc <- sigs]
344

345
tyClDeclNames (TyData {tcdName = tc_name, tcdCons = cons, tcdLoc = loc})
346
  = (tc_name,loc) : conDeclsNames cons
347 348


349 350 351 352 353 354 355
tyClDeclTyVars (TySynonym {tcdTyVars = tvs}) = tvs
tyClDeclTyVars (TyData    {tcdTyVars = tvs}) = tvs
tyClDeclTyVars (ClassDecl {tcdTyVars = tvs}) = tvs
tyClDeclTyVars (ForeignType {})		     = []
tyClDeclTyVars (IfaceSig {})		     = []


356
--------------------------------
357
-- The "system names" are extra implicit names *bound* by the decl.
358 359 360 361 362 363 364 365 366 367 368 369 370 371
-- They are kept in a list rather than a tuple 
-- to make the renamer easier.

type ClassSysNames name = [name]
-- For class decls they are:
-- 	[tycon, datacon wrapper, datacon worker, 
--	 superclass selector 1, ..., superclass selector n]

type DataSysNames name =  [name]
-- For data decls they are
--	[from, to]
-- where from :: T -> Tring
--	 to   :: Tring -> T

372 373 374 375
tyClDeclSysNames :: TyClDecl name pat -> [(name, SrcLoc)]
-- Similar to tyClDeclNames, but returns the "implicit" 
-- or "system" names of the declaration

376
tyClDeclSysNames (ClassDecl {tcdSysNames = names, tcdLoc = loc})
377
  = [(n,loc) | n <- names]
378 379 380 381
tyClDeclSysNames (TyData {tcdCons = cons, tcdSysNames = names, tcdLoc = loc})
  = [(n,loc) | n <- names] ++ 
    [(wkr_name,loc) | ConDecl _ wkr_name _ _ _ loc <- cons]
tyClDeclSysNames decl = []
382

383 384 385 386 387 388 389 390

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}
391
instance (NamedThing name, Ord name) => Eq (TyClDecl name pat) where
392
	-- Used only when building interface files
393 394 395 396 397
  (==) d1@(IfaceSig {}) d2@(IfaceSig {})
      = tcdName d1 == tcdName d2 && 
	tcdType d1 == tcdType d2 && 
	tcdIdInfo d1 == tcdIdInfo d2

398 399 400 401
  (==) d1@(ForeignType {}) d2@(ForeignType {})
      = tcdName d1 == tcdName d2 && 
	tcdFoType d1 == tcdFoType d2

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
  (==) d1@(TyData {}) d2@(TyData {})
      = tcdName d1 == tcdName d2 && 
	tcdND d1   == tcdND   d2 && 
	eqWithHsTyVars (tcdTyVars d1) (tcdTyVars d2) (\ env -> 
   	  eq_hsContext env (tcdCtxt d1) (tcdCtxt d2)  &&
	  eqListBy (eq_ConDecl env) (tcdCons d1) (tcdCons d2)
	)

  (==) d1@(TySynonym {}) d2@(TySynonym {})
      = tcdName d1 == tcdName d2 && 
	eqWithHsTyVars (tcdTyVars d1) (tcdTyVars d2) (\ env -> 
          eq_hsType env (tcdSynRhs d1) (tcdSynRhs d2)
        )

  (==) d1@(ClassDecl {}) d2@(ClassDecl {})
    = tcdName d1 == tcdName d2 && 
      eqWithHsTyVars (tcdTyVars d1) (tcdTyVars d2) (\ env -> 
   	  eq_hsContext env (tcdCtxt d1) (tcdCtxt d2)  &&
	  eqListBy (eq_hsFD env) (tcdFDs d1) (tcdFDs d2) &&
	  eqListBy (eq_cls_sig env) (tcdSigs d1) (tcdSigs d2)
422 423
       )

424 425
  (==) _ _ = False	-- default case

426 427 428
eq_hsFD env (ns1,ms1) (ns2,ms2)
  = eqListBy (eq_hsVar env) ns1 ns2 && eqListBy (eq_hsVar env) ms1 ms2

429 430 431
eq_cls_sig env (ClassOpSig n1 dm1 ty1 _) (ClassOpSig n2 dm2 ty2 _)
  = n1==n2 && dm1 `eq_dm` dm2 && eq_hsType env ty1 ty2
  where
432
	-- Ignore the name of the default method for (DefMeth id)
433 434 435
	-- This is used for comparing declarations before putting
	-- them into interface files, and the name of the default 
	-- method isn't relevant
436 437 438 439
    NoDefMeth  `eq_dm` NoDefMeth  = True
    GenDefMeth `eq_dm` GenDefMeth = True
    DefMeth _  `eq_dm` DefMeth _  = True
    dm1	       `eq_dm` dm2	  = False
440 441

    
442 443 444
\end{code}

\begin{code}
445
countTyClDecls :: [TyClDecl name pat] -> (Int, Int, Int, Int, Int)
446 447
	-- class, data, newtype, synonym decls
countTyClDecls decls 
sof's avatar
sof committed
448 449 450 451 452 453 454 455 456 457 458
 = (count isClassDecl     decls,
    count isSynDecl       decls,
    count isIfaceSigDecl  decls,
    count isDataTy        decls,
    count isNewTy         decls) 
 where
   isDataTy TyData{tcdND=DataType} = True
   isDataTy _                      = False
   
   isNewTy TyData{tcdND=NewType} = True
   isNewTy _                     = False
459 460 461
\end{code}

\begin{code}
462
instance (NamedThing name, Outputable name, Outputable pat)
463
	      => Outputable (TyClDecl name pat) where
464

465
    ppr (IfaceSig {tcdName = var, tcdType = ty, tcdIdInfo = info})
466 467 468 469
	= getPprStyle $ \ sty ->
	   hsep [ if ifaceStyle sty then ppr var else ppr_var var,
		  dcolon, ppr ty, pprHsIdInfo info
		]
470

471 472 473
    ppr (ForeignType {tcdName = tycon})
	= hsep [ptext SLIT("foreign import type dotnet"), ppr tycon]

474
    ppr (TySynonym {tcdName = tycon, tcdTyVars = tyvars, tcdSynRhs = mono_ty})
475
      = hang (ptext SLIT("type") <+> pp_decl_head [] tycon tyvars <+> equals)
476
	     4 (ppr mono_ty)
477

478 479 480
    ppr (TyData {tcdND = new_or_data, tcdCtxt = context, tcdName = tycon,
		 tcdTyVars = tyvars, tcdCons = condecls, tcdNCons = ncons,
		 tcdDerivs = derivings})
481
      = pp_tydecl (ptext keyword <+> pp_decl_head context tycon tyvars)
482
		  (pp_condecls condecls ncons)
483
		  derivings
sof's avatar
sof committed
484 485 486 487
      where
	keyword = case new_or_data of
			NewType  -> SLIT("newtype")
			DataType -> SLIT("data")
488

489 490
    ppr (ClassDecl {tcdCtxt = context, tcdName = clas, tcdTyVars = tyvars, tcdFDs = fds,
		    tcdSigs = sigs, tcdMeths = methods})
491 492 493 494 495
      | null sigs	-- No "where" part
      = top_matter

      | otherwise	-- Laid out
      = sep [hsep [top_matter, ptext SLIT("where {")],
496
	     nest 4 (sep [sep (map ppr_sig sigs), pp_methods, char '}'])]
497
      where
498
        top_matter  = ptext SLIT("class") <+> pp_decl_head context clas tyvars <+> pprFundeps fds
499
	ppr_sig sig = ppr sig <> semi
500

501
	pp_methods = getPprStyle $ \ sty ->
502 503 504
        	     if ifaceStyle sty || isNothing methods
			then empty
			else ppr (fromJust methods)
505 506 507
        
pp_decl_head :: Outputable name => HsContext name -> name -> [HsTyVarBndr name] -> SDoc
pp_decl_head context thing tyvars = hsep [pprHsContext context, ppr thing, interppSP tyvars]
508

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

512
pp_tydecl pp_head pp_decl_rhs derivings
sof's avatar
sof committed
513
  = hang pp_head 4 (sep [
514
	pp_decl_rhs,
515 516 517
	case derivings of
	  Nothing 	   -> empty
	  Just ds	   -> hsep [ptext SLIT("deriving"), parens (interpp'SP ds)]
518
    ])
519 520 521 522 523 524 525 526 527 528 529
\end{code}


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

\begin{code}
data ConDecl name
530 531 532 533 534
  = 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
535

536
		[HsTyVarBndr name]	-- Existentially quantified type variables
537
		(HsContext name)	-- ...and context
538 539
					-- If both are empty then there are no existentials

sof's avatar
sof committed
540
		(ConDetails name)
541 542
		SrcLoc

sof's avatar
sof committed
543 544 545 546 547 548
data ConDetails name
  = VanillaCon			-- prefix-style con decl
		[BangType name]

  | InfixCon			-- infix-style con decl
		(BangType name)
549 550
		(BangType name)

sof's avatar
sof committed
551
  | RecCon			-- record-style con decl
552
		[([name], BangType name)]	-- list of "fields"
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
\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
570

571 572 573 574 575 576
	  do_fld1 (flds_seen, acc) fld
		| fld `elem` flds_seen = (flds_seen,acc)
		| otherwise	       = (fld:flds_seen, (fld,loc):acc)
\end{code}

\begin{code}
577 578 579 580 581 582
conDetailsTys :: ConDetails name -> [HsType name]
conDetailsTys (VanillaCon btys)    = map getBangType btys
conDetailsTys (InfixCon bty1 bty2) = [getBangType bty1, getBangType bty2]
conDetailsTys (RecCon fields)	   = [getBangType bty | (_, bty) <- fields]


583 584 585
eq_ConDecl env (ConDecl n1 _ tvs1 cxt1 cds1 _)
	       (ConDecl n2 _ tvs2 cxt2 cds2 _)
  = n1 == n2 &&
586
    (eq_hsTyVars env tvs1 tvs2	$ \ env ->
587 588 589 590 591 592 593 594 595 596 597 598
     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
599
\end{code}
600
  
601
\begin{code}
602 603 604 605 606 607 608 609
data BangType name = BangType StrictnessMark (HsType name)

getBangType       (BangType _ ty) = ty
getBangStrictness (BangType s _)  = s

unbangedType ty = BangType NotMarkedStrict ty

eq_btype env (BangType s1 t1) (BangType s2 t2) = s1==s2 && eq_hsType env t1 t2
610 611 612
\end{code}

\begin{code}
613
instance (Outputable name) => Outputable (ConDecl name) where
614
    ppr (ConDecl con _ tvs cxt con_details  loc)
615
      = sep [pprHsForAll tvs cxt, ppr_con_details con con_details]
616

617 618
ppr_con_details con (InfixCon ty1 ty2)
  = hsep [ppr_bang ty1, ppr con, ppr_bang ty2]
619

620
-- ConDecls generated by MkIface.ifaceTyThing always have a VanillaCon, even
621 622 623
-- 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.
624
ppr_con_details con (VanillaCon tys)
625 626 627
  = getPprStyle $ \ sty ->
    hsep ((if ifaceStyle sty then ppr con else ppr_var con)
	  : map (ppr_bang) tys)
sof's avatar
sof committed
628

629
ppr_con_details con (RecCon fields)
630
  = ppr con <+> braces (sep (punctuate comma (map ppr_field fields)))
sof's avatar
sof committed
631
  where
632
    ppr_field (ns, ty) = hsep (map (ppr) ns) <+> 
633
			 dcolon <+>
634
			 ppr_bang ty
sof's avatar
sof committed
635

636 637 638
instance Outputable name => Outputable (BangType name) where
    ppr = ppr_bang

639
ppr_bang (BangType s ty) = ppr s <> pprParendHsType ty
640 641 642 643 644
\end{code}


%************************************************************************
%*									*
sof's avatar
sof committed
645
\subsection[InstDecl]{An instance declaration
646 647 648 649
%*									*
%************************************************************************

\begin{code}
650
data InstDecl name pat
651
  = InstDecl	(HsType name)	-- Context => Class Instance-type
652 653 654
				-- Using a polytype means that the renamer conveniently
				-- figures out the quantified type variables for us.

655
		(MonoBinds name pat)
656

657
		[Sig name]		-- User-supplied pragmatic info
658

659 660
		(Maybe name)		-- Name for the dictionary function
					-- Nothing for source-file instance decls
661 662 663 664 665

		SrcLoc
\end{code}

\begin{code}
666
instance (Outputable name, Outputable pat)
667
	      => Outputable (InstDecl name pat) where
668

669
    ppr (InstDecl inst_ty binds uprags maybe_dfun_name src_loc)
670
      = getPprStyle $ \ sty ->
671
        if ifaceStyle sty then
672
           hsep [ptext SLIT("instance"), ppr inst_ty, equals, pp_dfun]
673 674 675 676
	else
	   vcat [hsep [ptext SLIT("instance"), ppr inst_ty, ptext SLIT("where")],
	         nest 4 (ppr uprags),
	         nest 4 (ppr binds) ]
677 678 679 680
      where
	pp_dfun = case maybe_dfun_name of
		    Just df -> ppr df
		    Nothing -> empty
681 682
\end{code}

683 684 685 686 687 688 689
\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}

690 691 692 693 694 695 696 697 698 699 700 701 702

%************************************************************************
%*									*
\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
703
  = DefaultDecl	[HsType name]
704 705
		SrcLoc

706
instance (Outputable name)
707 708
	      => Outputable (DefaultDecl name) where

709 710
    ppr (DefaultDecl tys src_loc)
      = ptext SLIT("default") <+> parens (interpp'SP tys)
711
\end{code}
712

sof's avatar
sof committed
713 714 715 716 717 718 719
%************************************************************************
%*									*
\subsection{Foreign function interface declaration}
%*									*
%************************************************************************

\begin{code}
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
data ForeignDecl name
  = ForeignImport name (HsType name) FoImport 	  SrcLoc
  | ForeignExport name (HsType name) FoExport 	  SrcLoc

forDeclName (ForeignImport n _ _ _) = n
forDeclName (ForeignExport n _ _ _) = n

data FoImport 
  = LblImport  CLabelString	-- foreign label
  | CImport    CCallSpec	-- foreign import 
  | CDynImport CCallConv	-- foreign export dynamic
  | DNImport   DNCallSpec	-- foreign import dotnet

data FoExport = CExport CExportSpec

data FoType = DNType 		-- In due course we'll add subtype stuff
	    deriving( Eq )	-- Used for equality instance for TyClDecl

instance Outputable name => Outputable (ForeignDecl name) where
  ppr (ForeignImport nm ty (LblImport lbl) src_loc)
    = ptext SLIT("foreign label") <+> ppr lbl <+> ppr nm <+> dcolon <+> ppr ty
  ppr (ForeignImport nm ty decl src_loc)
    = ptext SLIT("foreign import") <+> ppr decl <+> ppr nm <+> dcolon <+> ppr ty
  ppr (ForeignExport nm ty decl src_loc)
    = ptext SLIT("foreign export") <+> ppr decl <+> ppr nm <+> dcolon <+> ppr ty

instance Outputable FoImport where
   ppr (CImport  d)      = ppr d
   ppr (CDynImport conv) = text "dynamic" <+> ppr conv
   ppr (DNImport d)   	 = ptext SLIT("dotnet") <+> ppr d
   ppr (LblImport l)  	 = ptext SLIT("label") <+> ppr l

instance Outputable FoExport where
   ppr (CExport d) = ppr d

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

759

760 761
%************************************************************************
%*									*
762
\subsection{Transformation rules}
763 764 765 766
%*									*
%************************************************************************

\begin{code}
767
data RuleDecl name pat
768
  = HsRule			-- Source rule
769 770
	RuleName		-- Rule name
	Activation
771 772 773 774 775 776 777
	[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		

778
  | IfaceRule	 		-- One that's come in from an interface file; pre-typecheck
779 780
	RuleName
	Activation
781 782 783 784
	[UfBinder name]		-- Tyvars and term vars
	name			-- Head of lhs
	[UfExpr name]		-- Args of LHS
	(UfExpr name)		-- Pre typecheck
785 786
	SrcLoc		

787 788 789 790
  | IfaceRuleOut		-- Post typecheck
	name			-- Head of LHS
	CoreRule

791
isIfaceRuleDecl :: RuleDecl name pat -> Bool
792 793
isIfaceRuleDecl (HsRule _ _ _ _ _ _ _) = False
isIfaceRuleDecl other		       = True
794

795
ifaceRuleDeclName :: RuleDecl name pat -> name
796 797 798
ifaceRuleDeclName (IfaceRule _ _ _ n _ _ _) = n
ifaceRuleDeclName (IfaceRuleOut n r)	    = n
ifaceRuleDeclName (HsRule fs _ _ _ _ _ _)   = pprPanic "ifaceRuleDeclName" (ppr fs)
799

800 801 802
data RuleBndr name
  = RuleBndr name
  | RuleBndrSig name (HsType name)
803

804
instance (NamedThing name, Ord name) => Eq (RuleDecl name pat) where
805
  -- Works for IfaceRules only; used when comparing interface file versions
806 807
  (IfaceRule n1 a1 bs1 f1 es1 rhs1 _) == (IfaceRule n2 a2 bs2 f2 es2 rhs2 _)
     = n1==n2 && f1 == f2 && a1==a2 &&
808 809 810
       eq_ufBinders emptyEqHsEnv bs1 bs2 (\env -> 
       eqListBy (eq_ufExpr env) (rhs1:es1) (rhs2:es2))

811
instance (NamedThing name, Outputable name, Outputable pat)
812
	      => Outputable (RuleDecl name pat) where
813 814
  ppr (HsRule name act tvs ns lhs rhs loc)
	= sep [text "{-# RULES" <+> doubleQuotes (ptext name) <+> ppr act,
815 816
	       pp_forall, ppr lhs, equals <+> ppr rhs,
               text "#-}" ]
817 818 819 820 821
	where
	  pp_forall | null tvs && null ns = empty
		    | otherwise		  = text "forall" <+> 
					    fsep (map ppr tvs ++ map ppr ns)
					    <> dot
822

823 824
  ppr (IfaceRule name act tpl_vars fn tpl_args rhs loc) 
    = hsep [ doubleQuotes (ptext name), ppr act,
825 826 827 828 829 830
	   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
831 832 833 834

instance Outputable name => Outputable (RuleBndr name) where
   ppr (RuleBndr name) = ppr name
   ppr (RuleBndrSig name ty) = ppr name <> dcolon <> ppr ty
835 836 837 838 839 840 841 842 843
\end{code}


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

844
We use exported entities for things to deprecate.
845 846

\begin{code}
847
data DeprecDecl name = Deprecation name DeprecTxt SrcLoc
848 849 850 851

type DeprecTxt = FAST_STRING	-- reason/explanation for deprecation

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