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 isDataConId, isDataConId_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 isDataConId id = case globalIdDetails id of
264 isDataConId_maybe id = case globalIdDetails id of
265 DataConId 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 -- Includes dictionary selectors
296 DataConWrapId _ -> True
297 -- These are are implied by their type or class decl;
298 -- remember that all type and class decls appear in the interface file.
299 -- The dfun id must *not* be omitted, because it carries version info for
305 isDeadBinder :: Id -> Bool
306 isDeadBinder bndr | isId bndr = isDeadOcc (idOccInfo bndr)
307 | otherwise = False -- TyVars count as not dead
311 %************************************************************************
313 \subsection{IdInfo stuff}
315 %************************************************************************
318 ---------------------------------
320 idArity :: Id -> Arity
321 idArity id = arityInfo (idInfo id)
323 setIdArity :: Id -> Arity -> Id
324 setIdArity id arity = modifyIdInfo (`setArityInfo` arity) id
326 #ifdef OLD_STRICTNESS
327 ---------------------------------
329 idStrictness :: Id -> StrictnessInfo
330 idStrictness id = strictnessInfo (idInfo id)
332 setIdStrictness :: Id -> StrictnessInfo -> Id
333 setIdStrictness id strict_info = modifyIdInfo (`setStrictnessInfo` strict_info) id
336 -- isBottomingId returns true if an application to n args would diverge
337 isBottomingId :: Id -> Bool
338 isBottomingId id = isBottomingSig (idNewStrictness id)
340 idNewStrictness_maybe :: Id -> Maybe StrictSig
341 idNewStrictness :: Id -> StrictSig
343 idNewStrictness_maybe id = newStrictnessInfo (idInfo id)
344 idNewStrictness id = idNewStrictness_maybe id `orElse` topSig
346 setIdNewStrictness :: Id -> StrictSig -> Id
347 setIdNewStrictness id sig = modifyIdInfo (`setNewStrictnessInfo` Just sig) id
349 zapIdNewStrictness :: Id -> Id
350 zapIdNewStrictness id = modifyIdInfo (`setNewStrictnessInfo` Nothing) id
352 ---------------------------------
354 idWorkerInfo :: Id -> WorkerInfo
355 idWorkerInfo id = workerInfo (idInfo id)
357 setIdWorkerInfo :: Id -> WorkerInfo -> Id
358 setIdWorkerInfo id work_info = modifyIdInfo (`setWorkerInfo` work_info) id
360 ---------------------------------
362 idUnfolding :: Id -> Unfolding
363 idUnfolding id = unfoldingInfo (idInfo id)
365 setIdUnfolding :: Id -> Unfolding -> Id
366 setIdUnfolding id unfolding = modifyIdInfo (`setUnfoldingInfo` unfolding) id
368 #ifdef OLD_STRICTNESS
369 ---------------------------------
371 idDemandInfo :: Id -> Demand.Demand
372 idDemandInfo id = demandInfo (idInfo id)
374 setIdDemandInfo :: Id -> Demand.Demand -> Id
375 setIdDemandInfo id demand_info = modifyIdInfo (`setDemandInfo` demand_info) id
378 idNewDemandInfo_maybe :: Id -> Maybe NewDemand.Demand
379 idNewDemandInfo :: Id -> NewDemand.Demand
381 idNewDemandInfo_maybe id = newDemandInfo (idInfo id)
382 idNewDemandInfo id = newDemandInfo (idInfo id) `orElse` NewDemand.topDmd
384 setIdNewDemandInfo :: Id -> NewDemand.Demand -> Id
385 setIdNewDemandInfo id dmd = modifyIdInfo (`setNewDemandInfo` Just dmd) id
387 ---------------------------------
389 idSpecialisation :: Id -> CoreRules
390 idSpecialisation id = specInfo (idInfo id)
392 idCoreRules :: Id -> [IdCoreRule]
393 idCoreRules id = [(id,rule) | rule <- rulesRules (idSpecialisation id)]
395 setIdSpecialisation :: Id -> CoreRules -> Id
396 setIdSpecialisation id spec_info = modifyIdInfo (`setSpecInfo` spec_info) id
398 ---------------------------------
400 idCgInfo :: Id -> CgInfo
401 #ifdef OLD_STRICTNESS
402 idCgInfo id = case cgInfo (idInfo id) of
403 NoCgInfo -> pprPanic "idCgInfo" (ppr id)
406 idCgInfo id = cgInfo (idInfo id)
409 setIdCgInfo :: Id -> CgInfo -> Id
410 setIdCgInfo id cg_info = modifyIdInfo (`setCgInfo` cg_info) id
412 ---------------------------------
414 idCafInfo :: Id -> CafInfo
415 #ifdef OLD_STRICTNESS
416 idCafInfo id = case cgInfo (idInfo id) of
417 NoCgInfo -> pprPanic "idCafInfo" (ppr id)
418 info -> cgCafInfo info
420 idCafInfo id = cgCafInfo (idCgInfo id)
422 ---------------------------------
424 #ifdef OLD_STRICTNESS
425 idCprInfo :: Id -> CprInfo
426 idCprInfo id = cprInfo (idInfo id)
428 setIdCprInfo :: Id -> CprInfo -> Id
429 setIdCprInfo id cpr_info = modifyIdInfo (`setCprInfo` cpr_info) id
432 ---------------------------------
434 idOccInfo :: Id -> OccInfo
435 idOccInfo id = occInfo (idInfo id)
437 setIdOccInfo :: Id -> OccInfo -> Id
438 setIdOccInfo id occ_info = modifyIdInfo (`setOccInfo` occ_info) id
442 ---------------------------------
444 The inline pragma tells us to be very keen to inline this Id, but it's still
445 OK not to if optimisation is switched off.
448 idInlinePragma :: Id -> InlinePragInfo
449 idInlinePragma id = inlinePragInfo (idInfo id)
451 setInlinePragma :: Id -> InlinePragInfo -> Id
452 setInlinePragma id prag = modifyIdInfo (`setInlinePragInfo` prag) id
454 modifyInlinePragma :: Id -> (InlinePragInfo -> InlinePragInfo) -> Id
455 modifyInlinePragma id fn = modifyIdInfo (\info -> info `setInlinePragInfo` (fn (inlinePragInfo info))) id
459 ---------------------------------
462 idLBVarInfo :: Id -> LBVarInfo
463 idLBVarInfo id = lbvarInfo (idInfo id)
465 isOneShotLambda :: Id -> Bool
466 isOneShotLambda id = case idLBVarInfo id of
467 IsOneShotLambda -> True
470 setOneShotLambda :: Id -> Id
471 setOneShotLambda id = modifyIdInfo (`setLBVarInfo` IsOneShotLambda) id
473 clearOneShotLambda :: Id -> Id
474 clearOneShotLambda id
475 | isOneShotLambda id = modifyIdInfo (`setLBVarInfo` NoLBVarInfo) id
478 -- But watch out: this may change the type of something else
480 -- If we change the one-shot-ness of x, f's type changes
484 zapLamIdInfo :: Id -> Id
485 zapLamIdInfo id = maybeModifyIdInfo zapLamInfo id
487 zapDemandIdInfo id = maybeModifyIdInfo zapDemandInfo id