2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 \section[Id]{@Ids@: Value and constructor identifiers}
10 -- Simple construction
11 mkGlobalId, mkLocalId, mkSpecPragmaId, mkLocalIdWithInfo,
12 mkSysLocal, mkSysLocalUnencoded, mkUserLocal, mkVanillaGlobal,
13 mkTemplateLocals, mkTemplateLocalsNum, mkWildId, mkTemplateLocal,
17 idName, idType, idUnique, idInfo,
18 idPrimRep, isId, globalIdDetails,
19 recordSelectorFieldLabel,
22 setIdName, setIdUnique, setIdType, setIdLocalExported, setGlobalIdDetails,
23 setIdInfo, lazySetIdInfo, modifyIdInfo, maybeModifyIdInfo,
24 zapLamIdInfo, zapDemandIdInfo,
27 isImplicitId, isDeadBinder,
28 isSpecPragmaId, isExportedId, isLocalId, isGlobalId,
30 isPrimOpId, isPrimOpId_maybe,
31 isFCallId, isFCallId_maybe,
32 isDataConWorkId, isDataConWorkId_maybe,
33 isDataConWrapId, isDataConWrapId_maybe,
37 -- Inline pragma stuff
38 idInlinePragma, setInlinePragma, modifyInlinePragma,
41 -- One shot lambda stuff
42 isOneShotLambda, setOneShotLambda, clearOneShotLambda,
48 setIdNewStrictness, zapIdNewStrictness,
64 idNewDemandInfo, idNewDemandInfo_maybe,
65 idNewStrictness, idNewStrictness_maybe,
68 idSpecialisation, idCoreRules,
75 newStrictnessFromOld -- Temporary
80 #include "HsVersions.h"
83 import CoreSyn ( Unfolding, CoreRules, IdCoreRule, rulesRules )
84 import BasicTypes ( Arity )
85 import Var ( Id, DictId,
86 isId, isExportedId, isSpecPragmaId, isLocalId,
87 idName, idType, idUnique, idInfo, isGlobalId,
88 setIdName, setVarType, setIdUnique, setIdLocalExported,
89 setIdInfo, lazySetIdInfo, modifyIdInfo,
91 globalIdDetails, setGlobalIdDetails
93 import qualified Var ( mkLocalId, mkGlobalId, mkSpecPragmaId )
94 import Type ( Type, typePrimRep, addFreeTyVars,
95 seqType, splitTyConApp_maybe )
99 import qualified Demand ( Demand )
100 import NewDemand ( Demand, StrictSig, topDmd, topSig, isBottomingSig )
101 import Name ( Name, OccName,
102 mkSystemName, mkSystemNameEncoded, mkInternalName,
103 getOccName, getSrcLoc
105 import OccName ( EncodedFS, mkWorkerOcc )
106 import PrimRep ( PrimRep )
107 import FieldLabel ( FieldLabel )
108 import Maybes ( orElse )
109 import SrcLoc ( SrcLoc )
111 import Unique ( Unique, mkBuiltinUnique )
113 -- infixl so you can say (id `set` a `set` b)
114 infixl 1 `setIdUnfolding`,
116 `setIdNewDemandInfo`,
117 `setIdNewStrictness`,
119 `setIdSpecialisation`,
122 #ifdef OLD_STRICTNESS
131 %************************************************************************
133 \subsection{Simple Id construction}
135 %************************************************************************
137 Absolutely all Ids are made by mkId. It is just like Var.mkId,
138 but in addition it pins free-tyvar-info onto the Id's type,
139 where it can easily be found.
142 mkLocalIdWithInfo :: Name -> Type -> IdInfo -> Id
143 mkLocalIdWithInfo name ty info = Var.mkLocalId name (addFreeTyVars ty) info
145 mkSpecPragmaId :: Name -> Type -> Id
146 mkSpecPragmaId name ty = Var.mkSpecPragmaId name (addFreeTyVars ty) vanillaIdInfo
148 mkGlobalId :: GlobalIdDetails -> Name -> Type -> IdInfo -> Id
149 mkGlobalId details name ty info = Var.mkGlobalId details name (addFreeTyVars ty) info
153 mkLocalId :: Name -> Type -> Id
154 mkLocalId name ty = mkLocalIdWithInfo name ty vanillaIdInfo
156 -- SysLocal: for an Id being created by the compiler out of thin air...
157 -- 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
162 -- for SysLocal, we assume the base name is already encoded, to avoid
163 -- re-encoding the same string over and over again.
164 mkSysLocal fs uniq ty = mkLocalId (mkSystemNameEncoded uniq fs) ty
166 -- version to use when the faststring needs to be encoded
167 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
173 Make some local @Ids@ for a template @CoreExpr@. These have bogus
174 @Uniques@, but that's OK because the templates are supposed to be
175 instantiated before use.
178 -- "Wild Id" typically used when you need a binder that you don't expect to use
179 mkWildId :: Type -> Id
180 mkWildId ty = mkSysLocal FSLIT("wild") (mkBuiltinUnique 1) ty
182 mkWorkerId :: Unique -> Id -> Type -> Id
183 -- A worker gets a local name. CoreTidy will externalise it if necessary.
184 mkWorkerId uniq unwrkr ty
185 = mkLocalId wkr_name ty
187 wkr_name = mkInternalName uniq (mkWorkerOcc (getOccName unwrkr)) (getSrcLoc unwrkr)
189 -- "Template locals" typically used in unfoldings
190 mkTemplateLocals :: [Type] -> [Id]
191 mkTemplateLocals tys = zipWith mkTemplateLocal [1..] tys
193 mkTemplateLocalsNum :: Int -> [Type] -> [Id]
194 -- The Int gives the starting point for unique allocation
195 mkTemplateLocalsNum n tys = zipWith mkTemplateLocal [n..] tys
197 mkTemplateLocal :: Int -> Type -> Id
198 mkTemplateLocal i ty = mkSysLocal FSLIT("tpl") (mkBuiltinUnique i) ty
202 %************************************************************************
204 \subsection[Id-general-funs]{General @Id@-related functions}
206 %************************************************************************
209 setIdType :: Id -> Type -> Id
210 -- Add free tyvar info to the type
211 setIdType id ty = seqType ty `seq` setVarType id (addFreeTyVars ty)
213 idPrimRep :: Id -> PrimRep
214 idPrimRep id = typePrimRep (idType id)
218 %************************************************************************
220 \subsection{Special Ids}
222 %************************************************************************
224 The @SpecPragmaId@ exists only to make Ids that are
225 on the *LHS* of bindings created by SPECIALISE pragmas;
227 The SpecPragmaId is never itself mentioned; it
228 exists solely so that the specialiser will find
229 the call to f, and make specialised version of it.
230 The SpecPragmaId binding is discarded by the specialiser
231 when it gathers up overloaded calls.
232 Meanwhile, it is not discarded as dead code.
236 recordSelectorFieldLabel :: Id -> FieldLabel
237 recordSelectorFieldLabel id = case globalIdDetails id of
238 RecordSelId lbl -> lbl
240 isRecordSelector id = case globalIdDetails id of
241 RecordSelId lbl -> True
244 isPrimOpId id = case globalIdDetails id of
248 isPrimOpId_maybe id = case globalIdDetails id of
249 PrimOpId op -> Just op
252 isFCallId id = case globalIdDetails id of
256 isFCallId_maybe id = case globalIdDetails id of
257 FCallId call -> Just call
260 isDataConWorkId id = case globalIdDetails id of
261 DataConWorkId _ -> True
264 isDataConWorkId_maybe id = case globalIdDetails id of
265 DataConWorkId con -> Just con
268 isDataConWrapId_maybe id = case globalIdDetails id of
269 DataConWrapId con -> Just con
272 isDataConWrapId id = case globalIdDetails id of
273 DataConWrapId con -> True
276 -- hasNoBinding returns True of an Id which may not have a
277 -- binding, even though it is defined in this module.
278 -- Data constructor workers used to be things of this kind, but
279 -- they aren't any more. Instead, we inject a binding for
280 -- them at the CorePrep stage.
281 hasNoBinding id = case globalIdDetails id of
286 isImplicitId :: Id -> Bool
287 -- isImplicitId tells whether an Id's info is implied by other
288 -- declarations, so we don't need to put its signature in an interface
289 -- file, even if it's mentioned in some other interface unfolding.
291 = case globalIdDetails id of
292 RecordSelId _ -> True
296 GenericOpId _ -> True
297 DataConWorkId _ -> True
298 DataConWrapId _ -> True
299 -- These are are implied by their type or class decl;
300 -- remember that all type and class decls appear in the interface file.
301 -- The dfun id is not an implicit Id; it must *not* be omitted, because
302 -- it carries version info for the instance decl
307 isDeadBinder :: Id -> Bool
308 isDeadBinder bndr | isId bndr = isDeadOcc (idOccInfo bndr)
309 | otherwise = False -- TyVars count as not dead
313 %************************************************************************
315 \subsection{IdInfo stuff}
317 %************************************************************************
320 ---------------------------------
322 idArity :: Id -> Arity
323 idArity id = arityInfo (idInfo id)
325 setIdArity :: Id -> Arity -> Id
326 setIdArity id arity = modifyIdInfo (`setArityInfo` arity) id
328 #ifdef OLD_STRICTNESS
329 ---------------------------------
331 idStrictness :: Id -> StrictnessInfo
332 idStrictness id = strictnessInfo (idInfo id)
334 setIdStrictness :: Id -> StrictnessInfo -> Id
335 setIdStrictness id strict_info = modifyIdInfo (`setStrictnessInfo` strict_info) id
338 -- isBottomingId returns true if an application to n args would diverge
339 isBottomingId :: Id -> Bool
340 isBottomingId id = isBottomingSig (idNewStrictness id)
342 idNewStrictness_maybe :: Id -> Maybe StrictSig
343 idNewStrictness :: Id -> StrictSig
345 idNewStrictness_maybe id = newStrictnessInfo (idInfo id)
346 idNewStrictness id = idNewStrictness_maybe id `orElse` topSig
348 setIdNewStrictness :: Id -> StrictSig -> Id
349 setIdNewStrictness id sig = modifyIdInfo (`setNewStrictnessInfo` Just sig) id
351 zapIdNewStrictness :: Id -> Id
352 zapIdNewStrictness id = modifyIdInfo (`setNewStrictnessInfo` Nothing) id
354 ---------------------------------
356 idWorkerInfo :: Id -> WorkerInfo
357 idWorkerInfo id = workerInfo (idInfo id)
359 setIdWorkerInfo :: Id -> WorkerInfo -> Id
360 setIdWorkerInfo id work_info = modifyIdInfo (`setWorkerInfo` work_info) id
362 ---------------------------------
364 idUnfolding :: Id -> Unfolding
365 idUnfolding id = unfoldingInfo (idInfo id)
367 setIdUnfolding :: Id -> Unfolding -> Id
368 setIdUnfolding id unfolding = modifyIdInfo (`setUnfoldingInfo` unfolding) id
370 #ifdef OLD_STRICTNESS
371 ---------------------------------
373 idDemandInfo :: Id -> Demand.Demand
374 idDemandInfo id = demandInfo (idInfo id)
376 setIdDemandInfo :: Id -> Demand.Demand -> Id
377 setIdDemandInfo id demand_info = modifyIdInfo (`setDemandInfo` demand_info) id
380 idNewDemandInfo_maybe :: Id -> Maybe NewDemand.Demand
381 idNewDemandInfo :: Id -> NewDemand.Demand
383 idNewDemandInfo_maybe id = newDemandInfo (idInfo id)
384 idNewDemandInfo id = newDemandInfo (idInfo id) `orElse` NewDemand.topDmd
386 setIdNewDemandInfo :: Id -> NewDemand.Demand -> Id
387 setIdNewDemandInfo id dmd = modifyIdInfo (`setNewDemandInfo` Just dmd) id
389 ---------------------------------
391 idSpecialisation :: Id -> CoreRules
392 idSpecialisation id = specInfo (idInfo id)
394 idCoreRules :: Id -> [IdCoreRule]
395 idCoreRules id = [(id,rule) | rule <- rulesRules (idSpecialisation id)]
397 setIdSpecialisation :: Id -> CoreRules -> Id
398 setIdSpecialisation id spec_info = modifyIdInfo (`setSpecInfo` spec_info) id
400 ---------------------------------
402 idCgInfo :: Id -> CgInfo
403 #ifdef OLD_STRICTNESS
404 idCgInfo id = case cgInfo (idInfo id) of
405 NoCgInfo -> pprPanic "idCgInfo" (ppr id)
408 idCgInfo id = cgInfo (idInfo id)
411 setIdCgInfo :: Id -> CgInfo -> Id
412 setIdCgInfo id cg_info = modifyIdInfo (`setCgInfo` cg_info) id
414 ---------------------------------
416 idCafInfo :: Id -> CafInfo
417 #ifdef OLD_STRICTNESS
418 idCafInfo id = case cgInfo (idInfo id) of
419 NoCgInfo -> pprPanic "idCafInfo" (ppr id)
420 info -> cgCafInfo info
422 idCafInfo id = cgCafInfo (idCgInfo id)
424 ---------------------------------
426 #ifdef OLD_STRICTNESS
427 idCprInfo :: Id -> CprInfo
428 idCprInfo id = cprInfo (idInfo id)
430 setIdCprInfo :: Id -> CprInfo -> Id
431 setIdCprInfo id cpr_info = modifyIdInfo (`setCprInfo` cpr_info) id
434 ---------------------------------
436 idOccInfo :: Id -> OccInfo
437 idOccInfo id = occInfo (idInfo id)
439 setIdOccInfo :: Id -> OccInfo -> Id
440 setIdOccInfo id occ_info = modifyIdInfo (`setOccInfo` occ_info) id
444 ---------------------------------
446 The inline pragma tells us to be very keen to inline this Id, but it's still
447 OK not to if optimisation is switched off.
450 idInlinePragma :: Id -> InlinePragInfo
451 idInlinePragma id = inlinePragInfo (idInfo id)
453 setInlinePragma :: Id -> InlinePragInfo -> Id
454 setInlinePragma id prag = modifyIdInfo (`setInlinePragInfo` prag) id
456 modifyInlinePragma :: Id -> (InlinePragInfo -> InlinePragInfo) -> Id
457 modifyInlinePragma id fn = modifyIdInfo (\info -> info `setInlinePragInfo` (fn (inlinePragInfo info))) id
461 ---------------------------------
464 idLBVarInfo :: Id -> LBVarInfo
465 idLBVarInfo id = lbvarInfo (idInfo id)
467 isOneShotLambda :: Id -> Bool
468 isOneShotLambda id = case idLBVarInfo id of
469 IsOneShotLambda -> True
472 setOneShotLambda :: Id -> Id
473 setOneShotLambda id = modifyIdInfo (`setLBVarInfo` IsOneShotLambda) id
475 clearOneShotLambda :: Id -> Id
476 clearOneShotLambda id
477 | isOneShotLambda id = modifyIdInfo (`setLBVarInfo` NoLBVarInfo) id
480 -- But watch out: this may change the type of something else
482 -- If we change the one-shot-ness of x, f's type changes
486 zapLamIdInfo :: Id -> Id
487 zapLamIdInfo id = maybeModifyIdInfo zapLamInfo id
489 zapDemandIdInfo id = maybeModifyIdInfo zapDemandInfo id