Id.lhs 14.3 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 33
	isDataConId, isDataConId_maybe, 
	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
	setIdCgInfo,
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
	idCgInfo,
70 71
	idCafInfo,
	idLBVarInfo,
72
	idOccInfo,
73

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

78
    ) where
79

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


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

import IdInfo 

99
import qualified Demand	( Demand )
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
isDataConId id = case globalIdDetails id of
261 262
			DataConId _ -> True
			other	    -> False
sof's avatar
sof committed
263

264
isDataConId_maybe id = case globalIdDetails id of
265 266
			  DataConId 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 280
-- 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 
-- them at the CorePrep stage.
281 282
hasNoBinding id = case globalIdDetails id of
			PrimOpId _  -> True
283
			FCallId _   -> True
284
			other	    -> False
285

286
isImplicitId :: Id -> Bool
287 288 289
	-- 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.
290
isImplicitId id
291
  = case globalIdDetails id of
292
	RecordSelId _   -> True	-- Includes dictionary selectors
293
        FCallId _       -> True
294 295 296 297
        PrimOpId _      -> True
        DataConId _     -> True
	DataConWrapId _ -> True
		-- These are are implied by their type or class decl;
298 299 300
		-- remember that all type and class decls appear in the interface file.
		-- The dfun id must *not* be omitted, because it carries version info for
		-- the instance decl
301
	other		-> False
302 303 304 305
\end{code}

\begin{code}
isDeadBinder :: Id -> Bool
306
isDeadBinder bndr | isId bndr = isDeadOcc (idOccInfo bndr)
307
		  | otherwise = False	-- TyVars count as not dead
308 309 310
\end{code}


311 312
%************************************************************************
%*									*
313
\subsection{IdInfo stuff}
314 315 316
%*									*
%************************************************************************

317
\begin{code}
318 319
	---------------------------------
	-- ARITY
320
idArity :: Id -> Arity
321
idArity id = arityInfo (idInfo id)
322

323 324
setIdArity :: Id -> Arity -> Id
setIdArity id arity = modifyIdInfo (`setArityInfo` arity) id
325

326
#ifdef OLD_STRICTNESS
327
	---------------------------------
328
	-- (OLD) STRICTNESS 
329
idStrictness :: Id -> StrictnessInfo
330
idStrictness id = strictnessInfo (idInfo id)
331

332
setIdStrictness :: Id -> StrictnessInfo -> Id
333
setIdStrictness id strict_info = modifyIdInfo (`setStrictnessInfo` strict_info) id
334
#endif
335

336 337
-- isBottomingId returns true if an application to n args would diverge
isBottomingId :: Id -> Bool
338 339 340 341 342 343 344 345 346 347
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
348

349 350 351
zapIdNewStrictness :: Id -> Id
zapIdNewStrictness id = modifyIdInfo (`setNewStrictnessInfo` Nothing) id

352
	---------------------------------
353
	-- WORKER ID
354 355
idWorkerInfo :: Id -> WorkerInfo
idWorkerInfo id = workerInfo (idInfo id)
356 357

setIdWorkerInfo :: Id -> WorkerInfo -> Id
358
setIdWorkerInfo id work_info = modifyIdInfo (`setWorkerInfo` work_info) id
359

360 361
	---------------------------------
	-- UNFOLDING
362 363
idUnfolding :: Id -> Unfolding
idUnfolding id = unfoldingInfo (idInfo id)
364

365
setIdUnfolding :: Id -> Unfolding -> Id
366
setIdUnfolding id unfolding = modifyIdInfo (`setUnfoldingInfo` unfolding) id
sof's avatar
sof committed
367

368
#ifdef OLD_STRICTNESS
369
	---------------------------------
370
	-- (OLD) DEMAND
371
idDemandInfo :: Id -> Demand.Demand
372
idDemandInfo id = demandInfo (idInfo id)
373

374
setIdDemandInfo :: Id -> Demand.Demand -> Id
375
setIdDemandInfo id demand_info = modifyIdInfo (`setDemandInfo` demand_info) id
376
#endif
377

378 379 380 381 382
idNewDemandInfo_maybe :: Id -> Maybe NewDemand.Demand
idNewDemandInfo       :: Id -> NewDemand.Demand

idNewDemandInfo_maybe id = newDemandInfo (idInfo id)
idNewDemandInfo       id = newDemandInfo (idInfo id) `orElse` NewDemand.topDmd
383 384

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

387 388
	---------------------------------
	-- SPECIALISATION
389 390
idSpecialisation :: Id -> CoreRules
idSpecialisation id = specInfo (idInfo id)
391

392 393 394
idCoreRules :: Id -> [IdCoreRule]
idCoreRules id = [(id,rule) | rule <- rulesRules (idSpecialisation id)]

395 396
setIdSpecialisation :: Id -> CoreRules -> Id
setIdSpecialisation id spec_info = modifyIdInfo (`setSpecInfo` spec_info) id
397

398 399 400
	---------------------------------
	-- CG INFO
idCgInfo :: Id -> CgInfo
401
#ifdef OLD_STRICTNESS
402 403 404 405
idCgInfo id = case cgInfo (idInfo id) of
		  NoCgInfo -> pprPanic "idCgInfo" (ppr id)
		  info     -> info
#else
406
idCgInfo id = cgInfo (idInfo id)
407
#endif		
408 409 410 411

setIdCgInfo :: Id -> CgInfo -> Id
setIdCgInfo id cg_info = modifyIdInfo (`setCgInfo` cg_info) id

412 413
	---------------------------------
	-- CAF INFO
414
idCafInfo :: Id -> CafInfo
415
#ifdef OLD_STRICTNESS
416 417 418 419
idCafInfo id = case cgInfo (idInfo id) of
		  NoCgInfo -> pprPanic "idCafInfo" (ppr id)
		  info     -> cgCafInfo info
#else
420
idCafInfo id = cgCafInfo (idCgInfo id)
421
#endif
422 423
	---------------------------------
	-- CPR INFO
424
#ifdef OLD_STRICTNESS
425
idCprInfo :: Id -> CprInfo
426
idCprInfo id = cprInfo (idInfo id)
427 428

setIdCprInfo :: Id -> CprInfo -> Id
429
setIdCprInfo id cpr_info = modifyIdInfo (`setCprInfo` cpr_info) id
430
#endif
431 432 433

	---------------------------------
	-- Occcurrence INFO
434 435
idOccInfo :: Id -> OccInfo
idOccInfo id = occInfo (idInfo id)
436 437 438

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

sof's avatar
sof committed
441

442 443 444 445
	---------------------------------
	-- 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.
446 447

\begin{code}
448 449
idInlinePragma :: Id -> InlinePragInfo
idInlinePragma id = inlinePragInfo (idInfo id)
450

451
setInlinePragma :: Id -> InlinePragInfo -> Id
452
setInlinePragma id prag = modifyIdInfo (`setInlinePragInfo` prag) id
453

454
modifyInlinePragma :: Id -> (InlinePragInfo -> InlinePragInfo) -> Id
455
modifyInlinePragma id fn = modifyIdInfo (\info -> info `setInlinePragInfo` (fn (inlinePragInfo info))) id
456
\end{code}
457 458 459 460 461


	---------------------------------
	-- ONE-SHOT LAMBDAS
\begin{code}
462 463 464
idLBVarInfo :: Id -> LBVarInfo
idLBVarInfo id = lbvarInfo (idInfo id)

465
isOneShotLambda :: Id -> Bool
466
isOneShotLambda id = analysis
467
  where analysis = case idLBVarInfo id of
468
                     LBVarInfo u    | u `eqUsage` usOnce      -> True
469
                     other                                    -> False
470 471

setOneShotLambda :: Id -> Id
472
setOneShotLambda id = modifyIdInfo (`setLBVarInfo` LBVarInfo usOnce) id
473 474 475 476 477 478 479 480 481

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
482
\end{code}
483 484 485 486 487

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

488 489
zapDemandIdInfo id = maybeModifyIdInfo zapDemandInfo id
\end{code}
490