HsDecls.lhs 30.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 @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
	DefaultDecl(..), 
chak's avatar
chak committed
13 14
	ForeignDecl(..), ForeignImport(..), ForeignExport(..),
	CImportSpec(..), FoType(..),
15
	ConDecl(..), ConDetails(..), 
16
	BangType(..), getBangType, getBangStrictness, unbangedType,
17
	DeprecDecl(..), DeprecTxt,
18 19
	hsDeclName, instDeclName, 
	tyClDeclName, tyClDeclNames, tyClDeclSysNames, tyClDeclTyVars,
20
	isClassDecl, isSynDecl, isDataDecl, isIfaceSigDecl, countTyClDecls,
21
	mkClassDeclSysNames, isSourceInstDecl, ifaceRuleDeclName,
22 23
	getClassDeclSysNames, conDetailsTys,
	collectRuleBndrSigTys
24
    ) where
25

26
#include "HsVersions.h"
27 28

-- friends:
29
import HsBinds		( HsBinds, MonoBinds, Sig(..), FixitySig(..) )
30
import HsExpr		( HsExpr )
31
import HsImpExp		( ppr_var )
32
import HsTypes
33
import PprCore		( pprCoreRule )
34 35
import HsCore		( UfExpr, UfBinder, HsIdInfo, pprHsIdInfo,
			  eq_ufBinders, eq_ufExpr, pprUfExpr 
36
			)
37 38
import CoreSyn		( CoreRule(..), RuleName )
import BasicTypes	( NewOrData(..), StrictnessMark(..), Activation(..) )
chak's avatar
chak committed
39 40
import ForeignCall	( CCallTarget(..), DNCallSpec, CCallConv, Safety,
			  CExportSpec(..)) 
41 42

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

53
import Maybe		( isNothing, fromJust )	
54 55
\end{code}

56 57 58 59 60 61 62 63

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

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

-- 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
86 87 88
\end{code}

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

102 103 104

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

106 107 108
\end{code}

\begin{code}
109
instance (NamedThing name, Outputable name, Outputable pat)
110
	=> Outputable (HsDecl name pat) where
111

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 (FixD fd)    = ppr fd
118
    ppr (RuleD rd)   = ppr rd
119 120 121
    ppr (DeprecD dd) = ppr dd
\end{code}

122

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

129 130 131
		--------------------------------
			THE NAMING STORY
		--------------------------------
132

133 134 135 136 137
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
  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
156
   This is done in RdrHsSyn.mkClassDecl, mkTyDecl, mkConDecl
157 158 159

 - Ensure they "point to" the parent data/class decl 
   when loading that decl from an interface file
160
   (See RnHiFiles.getTyClDeclSysNames)
161 162 163 164

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

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 250 251 252 253
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.
254

255 256
  - RnHsSyn.instDeclFVs treats the dict fun name as free in the decl, so that we
    suck in the dfun binding
257 258


259
\begin{code}
260 261 262 263 264
-- 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

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

rrt's avatar
rrt committed
272 273 274 275
  | ForeignType { tcdName    :: name,		-- See remarks about IfaceSig above
		  tcdExtName :: Maybe FastString,
		  tcdFoType  :: FoType,
		  tcdLoc     :: SrcLoc }
276

277 278 279 280
  | TyData {	tcdND     :: NewOrData,
		tcdCtxt   :: HsContext name,	 -- context
		tcdName   :: name,		 -- type constructor
		tcdTyVars :: [HsTyVarBndr name], -- type variables
281
		tcdCons	  :: DataConDetails (ConDecl name),	 -- data constructors (empty if abstract)
282 283
		tcdDerivs :: Maybe (HsContext name),	-- derivings; Nothing => not specified
							-- Just [] => derive exactly what is asked
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
		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
    }
305 306 307 308 309 310 311
\end{code}

Simple classifiers

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

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

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

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

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

Dealing with names
326

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

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

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

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

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


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


357
--------------------------------
358
-- The "system names" are extra implicit names *bound* by the decl.
359 360 361 362 363 364 365 366 367 368 369 370 371 372
-- 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

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

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

384 385 386 387 388 389 390 391

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

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

403 404 405 406 407
  (==) 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)  &&
408
	  eq_hsCD      env (tcdCons d1) (tcdCons d2)
409 410 411 412 413 414 415 416 417 418 419 420 421 422
	)

  (==) 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)
423 424
       )

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

427 428 429 430 431
eq_hsCD env (DataCons c1) (DataCons c2) = eqListBy (eq_ConDecl env) c1 c2
eq_hsCD env Unknown	  Unknown	= True
eq_hsCD env (HasCons n1)  (HasCons n2)  = n1 == n2
eq_hsCD env d1		  d2		= False

432 433 434
eq_hsFD env (ns1,ms1) (ns2,ms2)
  = eqListBy (eq_hsVar env) ns1 ns2 && eqListBy (eq_hsVar env) ms1 ms2

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

    
448 449 450
\end{code}

\begin{code}
451
countTyClDecls :: [TyClDecl name pat] -> (Int, Int, Int, Int, Int)
452 453
	-- class, data, newtype, synonym decls
countTyClDecls decls 
sof's avatar
sof committed
454 455 456 457 458 459 460 461 462 463 464
 = (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
465 466 467
\end{code}

\begin{code}
468
instance (NamedThing name, Outputable name, Outputable pat)
469
	      => Outputable (TyClDecl name pat) where
470

471
    ppr (IfaceSig {tcdName = var, tcdType = ty, tcdIdInfo = info})
472 473 474 475
	= getPprStyle $ \ sty ->
	   hsep [ if ifaceStyle sty then ppr var else ppr_var var,
		  dcolon, ppr ty, pprHsIdInfo info
		]
476

477 478 479
    ppr (ForeignType {tcdName = tycon})
	= hsep [ptext SLIT("foreign import type dotnet"), ppr tycon]

480
    ppr (TySynonym {tcdName = tycon, tcdTyVars = tyvars, tcdSynRhs = mono_ty})
481
      = hang (ptext SLIT("type") <+> pp_decl_head [] tycon tyvars <+> equals)
482
	     4 (ppr mono_ty)
483

484
    ppr (TyData {tcdND = new_or_data, tcdCtxt = context, tcdName = tycon,
485
		 tcdTyVars = tyvars, tcdCons = condecls, 
486
		 tcdDerivs = derivings})
487
      = pp_tydecl (ptext keyword <+> pp_decl_head context tycon tyvars)
488
		  (pp_condecls condecls)
489
		  derivings
sof's avatar
sof committed
490 491 492 493
      where
	keyword = case new_or_data of
			NewType  -> SLIT("newtype")
			DataType -> SLIT("data")
494

495 496
    ppr (ClassDecl {tcdCtxt = context, tcdName = clas, tcdTyVars = tyvars, tcdFDs = fds,
		    tcdSigs = sigs, tcdMeths = methods})
497 498 499 500 501
      | null sigs	-- No "where" part
      = top_matter

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

507
	pp_methods = getPprStyle $ \ sty ->
508 509 510
        	     if ifaceStyle sty || isNothing methods
			then empty
			else ppr (fromJust methods)
511 512 513
        
pp_decl_head :: Outputable name => HsContext name -> name -> [HsTyVarBndr name] -> SDoc
pp_decl_head context thing tyvars = hsep [pprHsContext context, ppr thing, interppSP tyvars]
514

515 516 517
pp_condecls Unknown	  = ptext SLIT("{- abstract -}")
pp_condecls (HasCons n)   = ptext SLIT("{- abstract with") <+> int n <+> ptext SLIT("constructors -}")
pp_condecls (DataCons cs) = equals <+> sep (punctuate (ptext SLIT(" |")) (map ppr cs))
518

519
pp_tydecl pp_head pp_decl_rhs derivings
sof's avatar
sof committed
520
  = hang pp_head 4 (sep [
521
	pp_decl_rhs,
522 523
	case derivings of
	  Nothing 	   -> empty
524
	  Just ds	   -> hsep [ptext SLIT("deriving"), ppr_hs_context ds]
525
    ])
526 527 528 529 530 531 532 533 534 535 536
\end{code}


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

\begin{code}
data ConDecl name
537 538 539 540 541
  = 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
542

543
		[HsTyVarBndr name]	-- Existentially quantified type variables
544
		(HsContext name)	-- ...and context
545 546
					-- If both are empty then there are no existentials

sof's avatar
sof committed
547
		(ConDetails name)
548 549
		SrcLoc

sof's avatar
sof committed
550 551 552 553 554 555
data ConDetails name
  = VanillaCon			-- prefix-style con decl
		[BangType name]

  | InfixCon			-- infix-style con decl
		(BangType name)
556 557
		(BangType name)

sof's avatar
sof committed
558
  | RecCon			-- record-style con decl
559
		[([name], BangType name)]	-- list of "fields"
560 561 562
\end{code}

\begin{code}
563
conDeclsNames :: Eq name => DataConDetails (ConDecl name) -> [(name,SrcLoc)]
564 565 566 567
  -- 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
568
  = snd (foldl do_one ([], []) (visibleDataCons cons))
569 570 571 572 573 574 575 576
  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
577

578 579 580 581 582 583
	  do_fld1 (flds_seen, acc) fld
		| fld `elem` flds_seen = (flds_seen,acc)
		| otherwise	       = (fld:flds_seen, (fld,loc):acc)
\end{code}

\begin{code}
584 585 586 587 588 589
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]


590 591 592
eq_ConDecl env (ConDecl n1 _ tvs1 cxt1 cds1 _)
	       (ConDecl n2 _ tvs2 cxt2 cds2 _)
  = n1 == n2 &&
593
    (eq_hsTyVars env tvs1 tvs2	$ \ env ->
594 595 596 597 598 599 600 601 602 603 604 605
     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
606
\end{code}
607
  
608
\begin{code}
609 610 611 612 613 614 615 616
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
617 618 619
\end{code}

\begin{code}
620
instance (Outputable name) => Outputable (ConDecl name) where
621
    ppr (ConDecl con _ tvs cxt con_details  loc)
622
      = sep [pprHsForAll tvs cxt, ppr_con_details con con_details]
623

624 625
ppr_con_details con (InfixCon ty1 ty2)
  = hsep [ppr_bang ty1, ppr con, ppr_bang ty2]
626

627
-- ConDecls generated by MkIface.ifaceTyThing always have a VanillaCon, even
628 629 630
-- 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.
631
ppr_con_details con (VanillaCon tys)
632 633 634
  = getPprStyle $ \ sty ->
    hsep ((if ifaceStyle sty then ppr con else ppr_var con)
	  : map (ppr_bang) tys)
sof's avatar
sof committed
635

636
ppr_con_details con (RecCon fields)
637
  = ppr con <+> braces (sep (punctuate comma (map ppr_field fields)))
sof's avatar
sof committed
638
  where
639
    ppr_field (ns, ty) = hsep (map (ppr) ns) <+> 
640
			 dcolon <+>
641
			 ppr_bang ty
sof's avatar
sof committed
642

643 644 645
instance Outputable name => Outputable (BangType name) where
    ppr = ppr_bang

646
ppr_bang (BangType s ty) = ppr s <> pprParendHsType ty
647 648 649 650 651
\end{code}


%************************************************************************
%*									*
sof's avatar
sof committed
652
\subsection[InstDecl]{An instance declaration
653 654 655 656
%*									*
%************************************************************************

\begin{code}
657
data InstDecl name pat
658
  = InstDecl	(HsType name)	-- Context => Class Instance-type
659 660 661
				-- Using a polytype means that the renamer conveniently
				-- figures out the quantified type variables for us.

662
		(MonoBinds name pat)
663

664
		[Sig name]		-- User-supplied pragmatic info
665

666 667
		(Maybe name)		-- Name for the dictionary function
					-- Nothing for source-file instance decls
668 669

		SrcLoc
670

671 672
isSourceInstDecl :: InstDecl name pat -> Bool
isSourceInstDecl (InstDecl _ _ _ maybe_dfun _) = isNothing maybe_dfun
673 674 675
\end{code}

\begin{code}
676
instance (Outputable name, Outputable pat)
677
	      => Outputable (InstDecl name pat) where
678

679
    ppr (InstDecl inst_ty binds uprags maybe_dfun_name src_loc)
680
      = getPprStyle $ \ sty ->
681
        if ifaceStyle sty then
682
           hsep [ptext SLIT("instance"), ppr inst_ty, equals, pp_dfun]
683 684 685 686
	else
	   vcat [hsep [ptext SLIT("instance"), ppr inst_ty, ptext SLIT("where")],
	         nest 4 (ppr uprags),
	         nest 4 (ppr binds) ]
687 688 689 690
      where
	pp_dfun = case maybe_dfun_name of
		    Just df -> ppr df
		    Nothing -> empty
691 692
\end{code}

693 694 695 696 697 698 699
\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}

700 701 702 703 704 705 706 707 708 709 710 711 712

%************************************************************************
%*									*
\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
713
  = DefaultDecl	[HsType name]
714 715
		SrcLoc

716
instance (Outputable name)
717 718
	      => Outputable (DefaultDecl name) where

719 720
    ppr (DefaultDecl tys src_loc)
      = ptext SLIT("default") <+> parens (interpp'SP tys)
721
\end{code}
722

sof's avatar
sof committed
723 724 725 726 727 728 729
%************************************************************************
%*									*
\subsection{Foreign function interface declaration}
%*									*
%************************************************************************

\begin{code}
chak's avatar
chak committed
730 731 732 733 734 735 736

-- 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
--
737
data ForeignDecl name
chak's avatar
chak committed
738 739
  = ForeignImport name (HsType name) ForeignImport Bool SrcLoc  -- defines name
  | ForeignExport name (HsType name) ForeignExport Bool SrcLoc  -- uses name
740

chak's avatar
chak committed
741 742 743 744 745
-- yield the Haskell name defined or used in a foreign declaration
--
foreignDeclName                           :: ForeignDecl name -> name
foreignDeclName (ForeignImport n _ _ _ _)  = n
foreignDeclName (ForeignExport n _ _ _ _)  = n
746

chak's avatar
chak committed
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
-- 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.)
780

chak's avatar
chak committed
781 782 783 784 785
-- specification of an externally exported entity in dependence on the calling
-- convention
--
data ForeignExport = CExport  CExportSpec    -- contains the calling convention
		   | DNExport		     -- presently unused
786

chak's avatar
chak committed
787 788
-- abstract type imported from .NET
--
789
data FoType = DNType 		-- In due course we'll add subtype stuff
chak's avatar
chak committed
790 791 792 793 794
	    deriving (Eq)	-- Used for equality instance for TyClDecl


-- pretty printing of foreign declarations
--
795 796

instance Outputable name => Outputable (ForeignDecl name) where
chak's avatar
chak committed
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
  ppr (ForeignImport n ty fimport _ _) =
    ptext SLIT("foreign import") <+> ppr fimport <+> 
    ppr n <+> dcolon <+> ppr ty
  ppr (ForeignExport n ty fexport _ _) =
    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) = 
        ptext SLIT("static") <+> ptext header <+> char '&' <>
	pprLib lib <> ppr lbl
      pprCEntity header lib (CFunction (StaticTarget lbl)) = 
        ptext SLIT("static") <+> ptext header <+> char '&' <>
	pprLib lib <> ppr lbl
      pprCEntity header lib (CFunction (DynamicTarget)) = 
        ptext SLIT("dynamic")
      pprCEntity header lib (CFunction (CasmTarget _)) = 
        panic "HsDecls.pprCEntity: malformed C function target"
      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>\"")
831 832

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

836

837 838
%************************************************************************
%*									*
839
\subsection{Transformation rules}
840 841 842 843
%*									*
%************************************************************************

\begin{code}
844
data RuleDecl name pat
845
  = HsRule			-- Source rule
846 847
	RuleName		-- Rule name
	Activation
848
	[RuleBndr name]		-- Forall'd vars; after typechecking this includes tyvars
849 850 851 852
	(HsExpr name pat)	-- LHS
	(HsExpr name pat)	-- RHS
	SrcLoc		

853
  | IfaceRule	 		-- One that's come in from an interface file; pre-typecheck
854 855
	RuleName
	Activation
856 857 858 859
	[UfBinder name]		-- Tyvars and term vars
	name			-- Head of lhs
	[UfExpr name]		-- Args of LHS
	(UfExpr name)		-- Pre typecheck
860 861
	SrcLoc		

862 863 864 865
  | IfaceRuleOut		-- Post typecheck
	name			-- Head of LHS
	CoreRule

866
ifaceRuleDeclName :: RuleDecl name pat -> name
867 868
ifaceRuleDeclName (IfaceRule _ _ _ n _ _ _) = n
ifaceRuleDeclName (IfaceRuleOut n r)	    = n
869
ifaceRuleDeclName (HsRule fs _ _ _ _ _)     = pprPanic "ifaceRuleDeclName" (ppr fs)
870

871 872 873
data RuleBndr name
  = RuleBndr name
  | RuleBndrSig name (HsType name)
874

875 876 877
collectRuleBndrSigTys :: [RuleBndr name] -> [HsType name]
collectRuleBndrSigTys bndrs = [ty | RuleBndrSig _ ty <- bndrs]

878
instance (NamedThing name, Ord name) => Eq (RuleDecl name pat) where
879
  -- Works for IfaceRules only; used when comparing interface file versions
880 881
  (IfaceRule n1 a1 bs1 f1 es1 rhs1 _) == (IfaceRule n2 a2 bs2 f2 es2 rhs2 _)
     = n1==n2 && f1 == f2 && a1==a2 &&
882 883 884
       eq_ufBinders emptyEqHsEnv bs1 bs2 (\env -> 
       eqListBy (eq_ufExpr env) (rhs1:es1) (rhs2:es2))

885
instance (NamedThing name, Outputable name, Outputable pat)
886
	      => Outputable (RuleDecl name pat) where
887
  ppr (HsRule name act ns lhs rhs loc)
888
	= sep [text "{-# RULES" <+> doubleQuotes (ptext name) <+> ppr act,
889 890
	       pp_forall, ppr lhs, equals <+> ppr rhs,
               text "#-}" ]
891
	where
892 893
	  pp_forall | null ns   = empty
		    | otherwise	= text "forall" <+> fsep (map ppr ns) <> dot
894

895 896
  ppr (IfaceRule name act tpl_vars fn tpl_args rhs loc) 
    = hsep [ doubleQuotes (ptext name), ppr act,
897 898 899 900 901 902
	   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
903 904 905 906

instance Outputable name => Outputable (RuleBndr name) where
   ppr (RuleBndr name) = ppr name
   ppr (RuleBndrSig name ty) = ppr name <> dcolon <> ppr ty
907 908 909 910 911 912 913 914 915
\end{code}


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

916
We use exported entities for things to deprecate.
917 918

\begin{code}
919
data DeprecDecl name = Deprecation name DeprecTxt SrcLoc
920 921 922 923

type DeprecTxt = FAST_STRING	-- reason/explanation for deprecation

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