ghc/compiler/basicTypes/Id.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[Id]{@Ids@: Value and constructor identifiers}
   5
   6 \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         isSpecPragmaId, isExportedId, isLocalId, isGlobalId,
  29         isRecordSelector,
  30         isPrimOpId, isPrimOpId_maybe,
  31         isFCallId, isFCallId_maybe,
  32         isDataConWorkId, isDataConWorkId_maybe,
  33         isDataConWrapId, isDataConWrapId_maybe,
  34         isBottomingId,
  35         hasNoBinding,
  36
  37         -- Inline pragma stuff
  38         idInlinePragma, setInlinePragma, modifyInlinePragma,
  39
  40
  41         -- One shot lambda stuff
  42         isOneShotLambda, setOneShotLambda, clearOneShotLambda,
  43
  44         -- IdInfo stuff
  45         setIdUnfolding,
  46         setIdArity,
  47         setIdNewDemandInfo,
  48         setIdNewStrictness, zapIdNewStrictness,
  49         setIdWorkerInfo,
  50         setIdSpecialisation,
  51         setIdCgInfo,
  52         setIdOccInfo,
  53
  54 #ifdef OLD_STRICTNESS
  55         idDemandInfo,
  56         idStrictness,
  57         idCprInfo,
  58         setIdStrictness,
  59         setIdDemandInfo,
  60         setIdCprInfo,
  61 #endif
  62
  63         idArity,
  64         idNewDemandInfo, idNewDemandInfo_maybe,
  65         idNewStrictness, idNewStrictness_maybe,
  66         idWorkerInfo,
  67         idUnfolding,
  68         idSpecialisation, idCoreRules,
  69         idCgInfo,
  70         idCafInfo,
  71         idLBVarInfo,
  72         idOccInfo,
  73
  74 #ifdef OLD_STRICTNESS
  75         newStrictnessFromOld    -- Temporary
  76 #endif
  77
  78     ) where
  79
  80 #include "HsVersions.h"
  81
  82
  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,
  90                           maybeModifyIdInfo,
  91                           globalIdDetails, setGlobalIdDetails
  92                         )
  93 import qualified Var    ( mkLocalId, mkGlobalId, mkSpecPragmaId )
  94 import Type             ( Type, typePrimRep, addFreeTyVars,
  95                           seqType, splitTyConApp_maybe )
  96
  97 import IdInfo
  98
  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
 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           `setIdNewDemandInfo`,
 117           `setIdNewStrictness`,
 118           `setIdWorkerInfo`,
 119           `setIdSpecialisation`,
 120           `setInlinePragma`,
 121           `idCafInfo`
 122 #ifdef OLD_STRICTNESS
 123           ,`idCprInfo`
 124           ,`setIdStrictness`
 125           ,`setIdDemandInfo`
 126 #endif
 127 \end{code}
 128
 129
 130
 131 %************************************************************************
 132 %*                                                                      *
 133 \subsection{Simple Id construction}
 134 %*                                                                      *
 135 %************************************************************************
 136
 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.
 140
 141 \begin{code}
 142 mkLocalIdWithInfo :: Name -> Type -> IdInfo -> Id
 143 mkLocalIdWithInfo name ty info = Var.mkLocalId name (addFreeTyVars ty) info
 144
 145 mkSpecPragmaId :: Name -> Type -> Id
 146 mkSpecPragmaId name ty = Var.mkSpecPragmaId name (addFreeTyVars ty) vanillaIdInfo
 147
 148 mkGlobalId :: GlobalIdDetails -> Name -> Type -> IdInfo -> Id
 149 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 -- 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
 161
 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
 165
 166 -- version to use when the faststring needs to be encoded
 167 mkSysLocalUnencoded fs uniq ty = mkLocalId (mkSystemName uniq fs)        ty
 168
 169 mkUserLocal occ uniq ty loc = mkLocalId (mkInternalName    uniq occ loc) ty
 170 mkVanillaGlobal             = mkGlobalId VanillaGlobal
 171 \end{code}
 172
 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.
 176
 177 \begin{code}
 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
 181
 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
 186   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 \end{code}
 200
 201
 202 %************************************************************************
 203 %*                                                                      *
 204 \subsection[Id-general-funs]{General @Id@-related functions}
 205 %*                                                                      *
 206 %************************************************************************
 207
 208 \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)
 212
 213 idPrimRep :: Id -> PrimRep
 214 idPrimRep id = typePrimRep (idType id)
 215 \end{code}
 216
 217
 218 %************************************************************************
 219 %*                                                                      *
 220 \subsection{Special Ids}
 221 %*                                                                      *
 222 %************************************************************************
 223
 224 The @SpecPragmaId@ exists only to make Ids that are
 225 on the *LHS* of bindings created by SPECIALISE pragmas;
 226 eg:             s = f Int d
 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.
 233
 234
 235 \begin{code}
 236 recordSelectorFieldLabel :: Id -> FieldLabel
 237 recordSelectorFieldLabel id = case globalIdDetails id of
 238                                  RecordSelId lbl -> lbl
 239
 240 isRecordSelector id = case globalIdDetails id of
 241                         RecordSelId lbl -> True
 242                         other           -> False
 243
 244 isPrimOpId id = case globalIdDetails id of
 245                     PrimOpId op -> True
 246                     other       -> False
 247
 248 isPrimOpId_maybe id = case globalIdDetails id of
 249                             PrimOpId op -> Just op
 250                             other       -> Nothing
 251
 252 isFCallId id = case globalIdDetails id of
 253                     FCallId call -> True
 254                     other        -> False
 255
 256 isFCallId_maybe id = case globalIdDetails id of
 257                             FCallId call -> Just call
 258                             other        -> Nothing
 259
 260 isDataConWorkId id = case globalIdDetails id of
 261                         DataConWorkId _ -> True
 262                         other           -> False
 263
 264 isDataConWorkId_maybe id = case globalIdDetails id of
 265                           DataConWorkId con -> Just con
 266                           other             -> Nothing
 267
 268 isDataConWrapId_maybe id = case globalIdDetails id of
 269                                   DataConWrapId con -> Just con
 270                                   other             -> Nothing
 271
 272 isDataConWrapId id = case globalIdDetails id of
 273                         DataConWrapId con -> True
 274                         other             -> False
 275
 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
 282                         PrimOpId _  -> True
 283                         FCallId _   -> True
 284                         other       -> False
 285
 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.
 290 isImplicitId id
 291   = case globalIdDetails id of
 292         RecordSelId _   -> True -- Includes dictionary selectors
 293         FCallId _       -> True
 294         PrimOpId _      -> True
 295         DataConWorkId _ -> True
 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
 300                 -- the instance decl
 301         other           -> False
 302 \end{code}
 303
 304 \begin{code}
 305 isDeadBinder :: Id -> Bool
 306 isDeadBinder bndr | isId bndr = isDeadOcc (idOccInfo bndr)
 307                   | otherwise = False   -- TyVars count as not dead
 308 \end{code}
 309
 310
 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 setIdArity :: Id -> Arity -> Id
 324 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 -- isBottomingId returns true if an application to n args would diverge
 337 isBottomingId :: Id -> Bool
 338 isBottomingId id = isBottomingSig (idNewStrictness id)
 339
 340 idNewStrictness_maybe :: Id -> Maybe StrictSig
 341 idNewStrictness :: Id -> StrictSig
 342
 343 idNewStrictness_maybe id = newStrictnessInfo (idInfo id)
 344 idNewStrictness       id = idNewStrictness_maybe id `orElse` topSig
 345
 346 setIdNewStrictness :: Id -> StrictSig -> Id
 347 setIdNewStrictness id sig = modifyIdInfo (`setNewStrictnessInfo` Just sig) id
 348
 349 zapIdNewStrictness :: Id -> Id
 350 zapIdNewStrictness id = modifyIdInfo (`setNewStrictnessInfo` Nothing) id
 351
 352         ---------------------------------
 353         -- WORKER ID
 354 idWorkerInfo :: Id -> WorkerInfo
 355 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 idUnfolding :: Id -> Unfolding
 363 idUnfolding id = unfoldingInfo (idInfo id)
 364
 365 setIdUnfolding :: Id -> Unfolding -> Id
 366 setIdUnfolding id unfolding = modifyIdInfo (`setUnfoldingInfo` unfolding) id
 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 idNewDemandInfo_maybe :: Id -> Maybe NewDemand.Demand
 379 idNewDemandInfo       :: Id -> NewDemand.Demand
 380
 381 idNewDemandInfo_maybe id = newDemandInfo (idInfo id)
 382 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 idSpecialisation :: Id -> CoreRules
 390 idSpecialisation id = specInfo (idInfo id)
 391
 392 idCoreRules :: Id -> [IdCoreRule]
 393 idCoreRules id = [(id,rule) | rule <- rulesRules (idSpecialisation id)]
 394
 395 setIdSpecialisation :: Id -> CoreRules -> Id
 396 setIdSpecialisation id spec_info = modifyIdInfo (`setSpecInfo` spec_info) id
 397
 398         ---------------------------------
 399         -- CG INFO
 400 idCgInfo :: Id -> CgInfo
 401 #ifdef OLD_STRICTNESS
 402 idCgInfo id = case cgInfo (idInfo id) of
 403                   NoCgInfo -> pprPanic "idCgInfo" (ppr id)
 404                   info     -> info
 405 #else
 406 idCgInfo id = cgInfo (idInfo id)
 407 #endif
 408
 409 setIdCgInfo :: Id -> CgInfo -> Id
 410 setIdCgInfo id cg_info = modifyIdInfo (`setCgInfo` cg_info) id
 411
 412         ---------------------------------
 413         -- CAF INFO
 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
 419 #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 idOccInfo :: Id -> OccInfo
 435 idOccInfo id = occInfo (idInfo id)
 436
 437 setIdOccInfo :: Id -> OccInfo -> Id
 438 setIdOccInfo id occ_info = modifyIdInfo (`setOccInfo` occ_info) id
 439 \end{code}
 440
 441
 442         ---------------------------------
 443         -- INLINING
 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.
 446
 447 \begin{code}
 448 idInlinePragma :: Id -> InlinePragInfo
 449 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         -- ONE-SHOT LAMBDAS
 461 \begin{code}
 462 idLBVarInfo :: Id -> LBVarInfo
 463 idLBVarInfo id = lbvarInfo (idInfo id)
 464
 465 isOneShotLambda :: Id -> Bool
 466 isOneShotLambda id = case idLBVarInfo id of
 467                        IsOneShotLambda  -> True
 468                        NoLBVarInfo      -> False
 469
 470 setOneShotLambda :: Id -> Id
 471 setOneShotLambda id = modifyIdInfo (`setLBVarInfo` IsOneShotLambda) id
 472
 473 clearOneShotLambda :: Id -> Id
 474 clearOneShotLambda id
 475   | isOneShotLambda id = modifyIdInfo (`setLBVarInfo` NoLBVarInfo) id
 476   | otherwise          = id
 477
 478 -- But watch out: this may change the type of something else
 479 --      f = \x -> e
 480 -- If we change the one-shot-ness of x, f's type changes
 481 \end{code}
 482
 483 \begin{code}
 484 zapLamIdInfo :: Id -> Id
 485 zapLamIdInfo id = maybeModifyIdInfo zapLamInfo id
 486
 487 zapDemandIdInfo id = maybeModifyIdInfo zapDemandInfo id
 488 \end{code}
 489