Id.lhs 14.2 KB
Newer Older
1 2
%
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
3 4 5 6
%
\section[Id]{@Ids@: Value and constructor identifiers}

\begin{code}
7
module Id (
8
	Id, DictId,
9

10
	-- Simple construction
11
	mkGlobalId, mkLocalId, mkSpecPragmaId, mkLocalIdWithInfo,
12
	mkSysLocal, mkSysLocalUnencoded, mkUserLocal, mkVanillaGlobal,
13
	mkTemplateLocals, mkTemplateLocalsNum, mkWildId, mkTemplateLocal,
14
	mkWorkerId,
15 16

	-- Taking an Id apart
17
	idName, idType, idUnique, idInfo,
18
	idPrimRep, isId, globalIdDetails,
19
	recordSelectorFieldLabel,
20

21
	-- Modifying an Id
22
	setIdName, setIdUnique, setIdType, setIdLocalExported, setGlobalIdDetails,
23
	setIdInfo, lazySetIdInfo, modifyIdInfo, maybeModifyIdInfo,
24
	zapLamIdInfo, zapDemandIdInfo, 
25 26

	-- Predicates
27
	isImplicitId, isDeadBinder,
28 29 30
	isSpecPragmaId,	isExportedId, isLocalId, isGlobalId,
	isRecordSelector,
	isPrimOpId, isPrimOpId_maybe, 
31
	isFCallId, isFCallId_maybe,
32
	isDataConWorkId, isDataConWorkId_maybe, 
33
	isDataConWrapId, isDataConWrapId_maybe,
34
	isBottomingId,
35 36 37 38 39
	hasNoBinding,

	-- Inline pragma stuff
	idInlinePragma, setInlinePragma, modifyInlinePragma, 

40

41
	-- One shot lambda stuff
42
	isOneShotLambda, setOneShotLambda, clearOneShotLambda,
43

44 45
	-- IdInfo stuff
	setIdUnfolding,
46
	setIdArity,
47 48
	setIdNewDemandInfo, 
	setIdNewStrictness, zapIdNewStrictness,
49
	setIdWorkerInfo,
50
	setIdSpecialisation,
51
	setIdCafInfo,
52
	setIdOccInfo,
53

54
#ifdef OLD_STRICTNESS
55 56 57 58 59 60 61 62
	idDemandInfo, 
	idStrictness, 
	idCprInfo,
	setIdStrictness, 
	setIdDemandInfo, 
	setIdCprInfo,
#endif

63
	idArity, 
64
	idNewDemandInfo, idNewDemandInfo_maybe,
65
	idNewStrictness, idNewStrictness_maybe, 
66 67
	idWorkerInfo,
	idUnfolding,
68
	idSpecialisation, idCoreRules,
69 70
	idCafInfo,
	idLBVarInfo,
71
	idOccInfo,
72

73
#ifdef OLD_STRICTNESS
74
	newStrictnessFromOld 	-- Temporary
75
#endif
76

77
    ) where
78

79
#include "HsVersions.h"
sof's avatar
sof committed
80 81


82
import CoreSyn		( Unfolding, CoreRules, IdCoreRule, rulesRules )
83
import BasicTypes	( Arity )
84
import Var		( Id, DictId,
85 86
			  isId, isExportedId, isSpecPragmaId, isLocalId,
			  idName, idType, idUnique, idInfo, isGlobalId,
87
			  setIdName, setVarType, setIdUnique, setIdLocalExported,
88 89
			  setIdInfo, lazySetIdInfo, modifyIdInfo, 
			  maybeModifyIdInfo,
90
			  globalIdDetails, setGlobalIdDetails
91
			)
92
import qualified Var	( mkLocalId, mkGlobalId, mkSpecPragmaId )
93
import Type		( Type, typePrimRep, addFreeTyVars, 
94
                          seqType, splitTyConApp_maybe )
95 96 97

import IdInfo 

98
import qualified Demand	( Demand )
99
import DataCon		( isUnboxedTupleCon )
100
import NewDemand	( Demand, StrictSig, topDmd, topSig, isBottomingSig )
sof's avatar
sof committed
101
import Name	 	( Name, OccName,
102
			  mkSystemName, mkSystemNameEncoded, mkInternalName,
103
			  getOccName, getSrcLoc
sof's avatar
sof committed
104
			) 
105
import OccName		( EncodedFS, mkWorkerOcc )
106
import PrimRep		( PrimRep )
107
import FieldLabel	( FieldLabel )
108
import Maybes		( orElse )
109
import SrcLoc		( SrcLoc )
110
import Outputable
111
import Unique		( Unique, mkBuiltinUnique )
112

113
-- infixl so you can say (id `set` a `set` b)
114
infixl 	1 `setIdUnfolding`,
115
	  `setIdArity`,
116 117
	  `setIdNewDemandInfo`,
	  `setIdNewStrictness`,
118
	  `setIdWorkerInfo`,
119
	  `setIdSpecialisation`,
120
	  `setInlinePragma`,
121
	  `idCafInfo`
122
#ifdef OLD_STRICTNESS
123 124 125 126
	  ,`idCprInfo`
	  ,`setIdStrictness`
	  ,`setIdDemandInfo`
#endif
127 128 129
\end{code}


130

131 132
%************************************************************************
%*									*
133
\subsection{Simple Id construction}
134 135 136
%*									*
%************************************************************************

137 138 139
Absolutely all Ids are made by mkId.  It is just like Var.mkId,
but in addition it pins free-tyvar-info onto the Id's type, 
where it can easily be found.
140

141
\begin{code}
142 143 144
mkLocalIdWithInfo :: Name -> Type -> IdInfo -> Id
mkLocalIdWithInfo name ty info = Var.mkLocalId name (addFreeTyVars ty) info

145 146
mkSpecPragmaId :: Name -> Type -> Id
mkSpecPragmaId name ty = Var.mkSpecPragmaId name (addFreeTyVars ty) vanillaIdInfo
147 148 149

mkGlobalId :: GlobalIdDetails -> Name -> Type -> IdInfo -> Id
mkGlobalId details name ty info = Var.mkGlobalId details name (addFreeTyVars ty) info
150
\end{code}
151

152
\begin{code}
153
mkLocalId :: Name -> Type -> Id
154
mkLocalId name ty = mkLocalIdWithInfo name ty vanillaIdInfo
155 156 157

-- SysLocal: for an Id being created by the compiler out of thin air...
-- UserLocal: an Id with a name the user might recognize...
158
mkUserLocal :: OccName -> Unique -> Type -> SrcLoc -> Id
159
mkSysLocal  :: EncodedFS  -> Unique -> Type -> Id
160
mkVanillaGlobal :: Name -> Type -> IdInfo -> Id
161

162 163
-- for SysLocal, we assume the base name is already encoded, to avoid
-- re-encoding the same string over and over again.
164 165 166 167 168
mkSysLocal          fs uniq ty = mkLocalId (mkSystemNameEncoded uniq fs) ty

-- version to use when the faststring needs to be encoded
mkSysLocalUnencoded fs uniq ty = mkLocalId (mkSystemName uniq fs)        ty

169
mkUserLocal occ uniq ty loc = mkLocalId (mkInternalName    uniq occ loc) ty
170
mkVanillaGlobal 	    = mkGlobalId VanillaGlobal
171
\end{code}
172 173 174 175

Make some local @Ids@ for a template @CoreExpr@.  These have bogus
@Uniques@, but that's OK because the templates are supposed to be
instantiated before use.
176
 
177
\begin{code}
178 179
-- "Wild Id" typically used when you need a binder that you don't expect to use
mkWildId :: Type -> Id
180
mkWildId ty = mkSysLocal FSLIT("wild") (mkBuiltinUnique 1) ty
181

182
mkWorkerId :: Unique -> Id -> Type -> Id
183
-- A worker gets a local name.  CoreTidy will externalise it if necessary.
184 185 186
mkWorkerId uniq unwrkr ty
  = mkLocalId wkr_name ty
  where
187
    wkr_name = mkInternalName uniq (mkWorkerOcc (getOccName unwrkr)) (getSrcLoc unwrkr)
188

189
-- "Template locals" typically used in unfoldings
190
mkTemplateLocals :: [Type] -> [Id]
191
mkTemplateLocals tys = zipWith mkTemplateLocal [1..] tys
192

193
mkTemplateLocalsNum :: Int -> [Type] -> [Id]
194
-- The Int gives the starting point for unique allocation
195
mkTemplateLocalsNum n tys = zipWith mkTemplateLocal [n..] tys
196

197
mkTemplateLocal :: Int -> Type -> Id
198
mkTemplateLocal i ty = mkSysLocal FSLIT("tpl") (mkBuiltinUnique i) ty
199 200 201
\end{code}


202 203 204 205 206 207 208
%************************************************************************
%*									*
\subsection[Id-general-funs]{General @Id@-related functions}
%*									*
%************************************************************************

\begin{code}
209
setIdType :: Id -> Type -> Id
210
	-- Add free tyvar info to the type
211
setIdType id ty = seqType ty `seq` setVarType id (addFreeTyVars ty)
sof's avatar
sof committed
212

213 214
idPrimRep :: Id -> PrimRep
idPrimRep id = typePrimRep (idType id)
215 216 217 218 219
\end{code}


%************************************************************************
%*									*
220
\subsection{Special Ids}
221 222 223
%*									*
%************************************************************************

224 225 226 227 228 229 230 231 232
The @SpecPragmaId@ exists only to make Ids that are
on the *LHS* of bindings created by SPECIALISE pragmas; 
eg:		s = f Int d
The SpecPragmaId is never itself mentioned; it
exists solely so that the specialiser will find
the call to f, and make specialised version of it.
The SpecPragmaId binding is discarded by the specialiser
when it gathers up overloaded calls.
Meanwhile, it is not discarded as dead code.
233 234


235
\begin{code}
236
recordSelectorFieldLabel :: Id -> FieldLabel
237 238
recordSelectorFieldLabel id = case globalIdDetails id of
				 RecordSelId lbl -> lbl
sof's avatar
sof committed
239

240
isRecordSelector id = case globalIdDetails id of
241 242
			RecordSelId lbl -> True
			other	  	-> False
sof's avatar
sof committed
243

244
isPrimOpId id = case globalIdDetails id of
245 246 247
		    PrimOpId op -> True
		    other	-> False

248
isPrimOpId_maybe id = case globalIdDetails id of
249 250 251
			    PrimOpId op -> Just op
			    other	-> Nothing

252 253 254 255 256 257 258 259
isFCallId id = case globalIdDetails id of
		    FCallId call -> True
		    other	 -> False

isFCallId_maybe id = case globalIdDetails id of
			    FCallId call -> Just call
			    other	 -> Nothing

260 261 262
isDataConWorkId id = case globalIdDetails id of
			DataConWorkId _ -> True
			other	        -> False
sof's avatar
sof committed
263

264 265 266
isDataConWorkId_maybe id = case globalIdDetails id of
			  DataConWorkId con -> Just con
			  other	            -> Nothing
sof's avatar
sof committed
267

268
isDataConWrapId_maybe id = case globalIdDetails id of
269 270
				  DataConWrapId con -> Just con
				  other	            -> Nothing
271

272
isDataConWrapId id = case globalIdDetails id of
273 274
			DataConWrapId con -> True
			other	          -> False
275

276 277 278 279
-- hasNoBinding returns True of an Id which may not have a
-- binding, even though it is defined in this module.  
-- Data constructor workers used to be things of this kind, but
-- they aren't any more.  Instead, we inject a binding for 
280 281
-- them at the CorePrep stage. 
-- EXCEPT: unboxed tuples, which definitely have no binding
282
hasNoBinding id = case globalIdDetails id of
283 284 285 286
			PrimOpId _  	 -> True
			FCallId _   	 -> True
			DataConWorkId dc -> isUnboxedTupleCon dc
			other	         -> False
287

288
isImplicitId :: Id -> Bool
289 290 291
	-- isImplicitId tells whether an Id's info is implied by other
	-- declarations, so we don't need to put its signature in an interface
	-- file, even if it's mentioned in some other interface unfolding.
292
isImplicitId id
293
  = case globalIdDetails id of
294
	RecordSelId _   -> True
295
        FCallId _       -> True
296
        PrimOpId _      -> True
297 298
	ClassOpId _	-> True
	GenericOpId _	-> True
299
        DataConWorkId _ -> True
300 301
	DataConWrapId _ -> True
		-- These are are implied by their type or class decl;
302
		-- remember that all type and class decls appear in the interface file.
303 304
		-- The dfun id is not an implicit Id; it must *not* be omitted, because 
		-- it carries version info for the instance decl
305
	other		-> False
306 307 308 309
\end{code}

\begin{code}
isDeadBinder :: Id -> Bool
310
isDeadBinder bndr | isId bndr = isDeadOcc (idOccInfo bndr)
311
		  | otherwise = False	-- TyVars count as not dead
312 313 314
\end{code}


315 316
%************************************************************************
%*									*
317
\subsection{IdInfo stuff}
318 319 320
%*									*
%************************************************************************

321
\begin{code}
322 323
	---------------------------------
	-- ARITY
324
idArity :: Id -> Arity
325
idArity id = arityInfo (idInfo id)
326

327 328
setIdArity :: Id -> Arity -> Id
setIdArity id arity = modifyIdInfo (`setArityInfo` arity) id
329

330
#ifdef OLD_STRICTNESS
331
	---------------------------------
332
	-- (OLD) STRICTNESS 
333
idStrictness :: Id -> StrictnessInfo
334
idStrictness id = strictnessInfo (idInfo id)
335

336
setIdStrictness :: Id -> StrictnessInfo -> Id
337
setIdStrictness id strict_info = modifyIdInfo (`setStrictnessInfo` strict_info) id
338
#endif
339

340 341
-- isBottomingId returns true if an application to n args would diverge
isBottomingId :: Id -> Bool
342 343 344 345 346 347 348 349 350 351
isBottomingId id = isBottomingSig (idNewStrictness id)

idNewStrictness_maybe :: Id -> Maybe StrictSig
idNewStrictness :: Id -> StrictSig

idNewStrictness_maybe id = newStrictnessInfo (idInfo id)
idNewStrictness       id = idNewStrictness_maybe id `orElse` topSig

setIdNewStrictness :: Id -> StrictSig -> Id
setIdNewStrictness id sig = modifyIdInfo (`setNewStrictnessInfo` Just sig) id
352

353 354 355
zapIdNewStrictness :: Id -> Id
zapIdNewStrictness id = modifyIdInfo (`setNewStrictnessInfo` Nothing) id

356
	---------------------------------
357
	-- WORKER ID
358 359
idWorkerInfo :: Id -> WorkerInfo
idWorkerInfo id = workerInfo (idInfo id)
360 361

setIdWorkerInfo :: Id -> WorkerInfo -> Id
362
setIdWorkerInfo id work_info = modifyIdInfo (`setWorkerInfo` work_info) id
363

364 365
	---------------------------------
	-- UNFOLDING
366 367
idUnfolding :: Id -> Unfolding
idUnfolding id = unfoldingInfo (idInfo id)
368

369
setIdUnfolding :: Id -> Unfolding -> Id
370
setIdUnfolding id unfolding = modifyIdInfo (`setUnfoldingInfo` unfolding) id
sof's avatar
sof committed
371

372
#ifdef OLD_STRICTNESS
373
	---------------------------------
374
	-- (OLD) DEMAND
375
idDemandInfo :: Id -> Demand.Demand
376
idDemandInfo id = demandInfo (idInfo id)
377

378
setIdDemandInfo :: Id -> Demand.Demand -> Id
379
setIdDemandInfo id demand_info = modifyIdInfo (`setDemandInfo` demand_info) id
380
#endif
381

382 383 384 385 386
idNewDemandInfo_maybe :: Id -> Maybe NewDemand.Demand
idNewDemandInfo       :: Id -> NewDemand.Demand

idNewDemandInfo_maybe id = newDemandInfo (idInfo id)
idNewDemandInfo       id = newDemandInfo (idInfo id) `orElse` NewDemand.topDmd
387 388

setIdNewDemandInfo :: Id -> NewDemand.Demand -> Id
389
setIdNewDemandInfo id dmd = modifyIdInfo (`setNewDemandInfo` Just dmd) id
390

391 392
	---------------------------------
	-- SPECIALISATION
393 394
idSpecialisation :: Id -> CoreRules
idSpecialisation id = specInfo (idInfo id)
395

396 397 398
idCoreRules :: Id -> [IdCoreRule]
idCoreRules id = [(id,rule) | rule <- rulesRules (idSpecialisation id)]

399 400
setIdSpecialisation :: Id -> CoreRules -> Id
setIdSpecialisation id spec_info = modifyIdInfo (`setSpecInfo` spec_info) id
401

402 403
	---------------------------------
	-- CAF INFO
404
idCafInfo :: Id -> CafInfo
405
#ifdef OLD_STRICTNESS
406 407 408 409
idCafInfo id = case cgInfo (idInfo id) of
		  NoCgInfo -> pprPanic "idCafInfo" (ppr id)
		  info     -> cgCafInfo info
#else
410
idCafInfo id = cafInfo (idInfo id)
411
#endif
412 413 414 415

setIdCafInfo :: Id -> CafInfo -> Id
setIdCafInfo id caf_info = modifyIdInfo (`setCafInfo` caf_info) id

416 417
	---------------------------------
	-- CPR INFO
418
#ifdef OLD_STRICTNESS
419
idCprInfo :: Id -> CprInfo
420
idCprInfo id = cprInfo (idInfo id)
421 422

setIdCprInfo :: Id -> CprInfo -> Id
423
setIdCprInfo id cpr_info = modifyIdInfo (`setCprInfo` cpr_info) id
424
#endif
425 426 427

	---------------------------------
	-- Occcurrence INFO
428 429
idOccInfo :: Id -> OccInfo
idOccInfo id = occInfo (idInfo id)
430 431 432

setIdOccInfo :: Id -> OccInfo -> Id
setIdOccInfo id occ_info = modifyIdInfo (`setOccInfo` occ_info) id
433 434
\end{code}

sof's avatar
sof committed
435

436 437 438 439
	---------------------------------
	-- INLINING
The inline pragma tells us to be very keen to inline this Id, but it's still
OK not to if optimisation is switched off.
440 441

\begin{code}
442 443
idInlinePragma :: Id -> InlinePragInfo
idInlinePragma id = inlinePragInfo (idInfo id)
444

445
setInlinePragma :: Id -> InlinePragInfo -> Id
446
setInlinePragma id prag = modifyIdInfo (`setInlinePragInfo` prag) id
447

448
modifyInlinePragma :: Id -> (InlinePragInfo -> InlinePragInfo) -> Id
449
modifyInlinePragma id fn = modifyIdInfo (\info -> info `setInlinePragInfo` (fn (inlinePragInfo info))) id
450
\end{code}
451 452 453 454 455


	---------------------------------
	-- ONE-SHOT LAMBDAS
\begin{code}
456 457 458
idLBVarInfo :: Id -> LBVarInfo
idLBVarInfo id = lbvarInfo (idInfo id)

459
isOneShotLambda :: Id -> Bool
460 461 462
isOneShotLambda id = case idLBVarInfo id of
                       IsOneShotLambda  -> True
                       NoLBVarInfo      -> False
463 464

setOneShotLambda :: Id -> Id
465
setOneShotLambda id = modifyIdInfo (`setLBVarInfo` IsOneShotLambda) id
466 467 468 469 470 471 472 473 474

clearOneShotLambda :: Id -> Id
clearOneShotLambda id 
  | isOneShotLambda id = modifyIdInfo (`setLBVarInfo` NoLBVarInfo) id
  | otherwise	       = id			

-- But watch out: this may change the type of something else
--	f = \x -> e
-- If we change the one-shot-ness of x, f's type changes
475
\end{code}
476 477 478 479 480

\begin{code}
zapLamIdInfo :: Id -> Id
zapLamIdInfo id = maybeModifyIdInfo zapLamInfo id

481 482
zapDemandIdInfo id = maybeModifyIdInfo zapDemandInfo id
\end{code}
483