2 % (c) The University of Glasgow 2006
3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
5 \section{@Vars@: Variables}
10 -- GHC uses several kinds of name internally:
12 -- * 'OccName.OccName': see "OccName#name_types"
14 -- * 'RdrName.RdrName': see "RdrName#name_types"
16 -- * 'Name.Name': see "Name#name_types"
18 -- * 'Id.Id': see "Id#name_types"
20 -- * 'Var.Var' is a synonym for the 'Id.Id' type but it may additionally
21 -- potentially contain type variables, which have a 'TypeRep.Kind'
22 -- rather than a 'TypeRep.Type' and only contain some extra
23 -- details during typechecking.
25 -- These 'Var.Var' names may either be global or local, see "Var#globalvslocal"
28 -- Global 'Id's and 'Var's are those that are imported or correspond
29 -- to a data constructor, primitive operation, or record selectors.
30 -- Local 'Id's and 'Var's are those bound within an expression
31 -- (e.g. by a lambda) or at the top level of the module being compiled.
34 -- * The main data type and synonyms
35 Var, TyVar, CoVar, Id, DictId, DFunId, EvVar, EvId, IpId,
37 -- ** Taking 'Var's apart
38 varName, varUnique, varType,
40 -- ** Modifying 'Var's
41 setVarName, setVarUnique, setVarType,
43 -- ** Constructing, taking apart, modifying 'Id's
44 mkGlobalVar, mkLocalVar, mkExportedLocalVar,
46 lazySetIdInfo, setIdDetails, globaliseId,
47 setIdExported, setIdNotExported,
50 isCoVar, isId, isTyCoVar, isTyVar, isTcTyVar,
51 isLocalVar, isLocalId,
52 isGlobalId, isExportedId,
55 -- ** Constructing 'TyVar's
56 mkTyVar, mkTcTyVar, mkWildCoVar,
58 -- ** Taking 'TyVar's apart
59 tyVarName, tyVarKind, tcTyVarDetails, setTcTyVarDetails,
61 -- ** Modifying 'TyVar's
62 setTyVarName, setTyVarUnique, setTyVarKind,
64 -- ** Constructing 'CoVar's
67 -- ** Taking 'CoVar's apart
70 -- ** Modifying 'CoVar's
71 setCoVarUnique, setCoVarName
75 #include "HsVersions.h"
78 import {-# SOURCE #-} TypeRep( Type, Kind )
79 import {-# SOURCE #-} TcType( TcTyVarDetails, pprTcTyVarDetails )
80 import {-# SOURCE #-} IdInfo( IdDetails, IdInfo, pprIdDetails )
81 import {-# SOURCE #-} TypeRep( isCoercionKind )
83 import Name hiding (varName)
94 %************************************************************************
98 %************************************************************************
99 -- These synonyms are here and not in Id because otherwise we need a very
100 -- large number of SOURCE imports of Id.hs :-(
103 type EvVar = Var -- An evidence variable: dictionary or equality constraint
104 -- Could be an DictId or a CoVar
106 type Id = Var -- A term-level identifier
107 type DFunId = Id -- A dictionary function
108 type EvId = Id -- Term-level evidence: DictId or IpId
109 type DictId = EvId -- A dictionary variable
110 type IpId = EvId -- A term-level implicit parameter
113 type CoVar = TyVar -- A coercion variable is simply a type
114 -- variable of kind @ty1 ~ ty2@. Hence its
115 -- 'varType' is always @PredTy (EqPred t1 t2)@
118 %************************************************************************
120 \subsection{The main data type declarations}
122 %************************************************************************
125 Every @Var@ has a @Unique@, to uniquify it and for fast comparison, a
126 @Type@, and an @IdInfo@ (non-essential info about it, e.g.,
127 strictness). The essential info about different kinds of @Vars@ is
131 -- | Essentially a typed 'Name', that may also contain some additional information
132 -- about the 'Var' and it's use sites.
136 realUnique :: FastInt, -- Key for fast comparison
137 -- Identical to the Unique in the name,
138 -- cached here for speed
139 varType :: Kind, -- ^ The type or kind of the 'Var' in question
140 isCoercionVar :: Bool
143 | TcTyVar { -- Used only during type inference
144 -- Used for kind variables during
145 -- inference, as well
147 realUnique :: FastInt,
149 tc_tv_details :: TcTyVarDetails }
153 realUnique :: FastInt,
156 id_details :: IdDetails, -- Stable, doesn't change
157 id_info :: IdInfo } -- Unstable, updated by simplifier
160 data IdScope -- See Note [GlobalId/LocalId]
165 = NotExported -- ^ Not exported: may be discarded as dead code.
166 | Exported -- ^ Exported: kept alive
169 Note [GlobalId/LocalId]
170 ~~~~~~~~~~~~~~~~~~~~~~~
172 * always a constant (top-level)
173 * imported, or data constructor, or primop, or record selector
174 * has a Unique that is globally unique across the whole
175 GHC invocation (a single invocation may compile multiple modules)
176 * never treated as a candidate by the free-variable finder;
180 * bound within an expression (lambda, case, local let(rec))
181 * or defined at top level in the module being compiled
182 * always treated as a candidate by the free-variable finder
184 After CoreTidy, top-level LocalIds are turned into GlobalIds
187 instance Outputable Var where
188 ppr var = ppr (varName var) <+> ifPprDebug (brackets (ppr_debug var))
190 ppr_debug :: Var -> SDoc
191 ppr_debug (TyVar { isCoercionVar = False }) = ptext (sLit "tv")
192 ppr_debug (TyVar { isCoercionVar = True }) = ptext (sLit "co")
193 ppr_debug (TcTyVar {tc_tv_details = d}) = pprTcTyVarDetails d
194 ppr_debug (Id { idScope = s, id_details = d }) = ppr_id_scope s <> pprIdDetails d
196 ppr_id_scope :: IdScope -> SDoc
197 ppr_id_scope GlobalId = ptext (sLit "gid")
198 ppr_id_scope (LocalId Exported) = ptext (sLit "lidx")
199 ppr_id_scope (LocalId NotExported) = ptext (sLit "lid")
201 instance Show Var where
202 showsPrec p var = showsPrecSDoc p (ppr var)
204 instance NamedThing Var where
207 instance Uniquable Var where
208 getUnique = varUnique
210 instance Eq Var where
211 a == b = realUnique a ==# realUnique b
213 instance Ord Var where
214 a <= b = realUnique a <=# realUnique b
215 a < b = realUnique a <# realUnique b
216 a >= b = realUnique a >=# realUnique b
217 a > b = realUnique a ># realUnique b
218 a `compare` b = varUnique a `compare` varUnique b
220 instance Data Var where
222 toConstr _ = abstractConstr "Var"
223 gunfold _ _ = error "gunfold"
224 dataTypeOf _ = mkNoRepType "Var"
229 varUnique :: Var -> Unique
230 varUnique var = mkUniqueGrimily (iBox (realUnique var))
232 setVarUnique :: Var -> Unique -> Var
233 setVarUnique var uniq
234 = var { realUnique = getKeyFastInt uniq,
235 varName = setNameUnique (varName var) uniq }
237 setVarName :: Var -> Name -> Var
238 setVarName var new_name
239 = var { realUnique = getKeyFastInt (getUnique new_name),
242 setVarType :: Id -> Type -> Id
243 setVarType id ty = id { varType = ty }
247 %************************************************************************
249 \subsection{Type variables}
251 %************************************************************************
254 tyVarName :: TyVar -> Name
257 tyVarKind :: TyVar -> Kind
260 setTyVarUnique :: TyVar -> Unique -> TyVar
261 setTyVarUnique = setVarUnique
263 setTyVarName :: TyVar -> Name -> TyVar
264 setTyVarName = setVarName
266 setTyVarKind :: TyVar -> Kind -> TyVar
267 setTyVarKind tv k = tv {varType = k}
271 mkTyVar :: Name -> Kind -> TyVar
272 mkTyVar name kind = ASSERT( not (isCoercionKind kind ) )
273 TyVar { varName = name
274 , realUnique = getKeyFastInt (nameUnique name)
276 , isCoercionVar = False
279 mkTcTyVar :: Name -> Kind -> TcTyVarDetails -> TyVar
280 mkTcTyVar name kind details
281 = -- NB: 'kind' may be a coercion kind; cf, 'TcMType.newMetaCoVar'
282 TcTyVar { varName = name,
283 realUnique = getKeyFastInt (nameUnique name),
285 tc_tv_details = details
288 tcTyVarDetails :: TyVar -> TcTyVarDetails
289 tcTyVarDetails (TcTyVar { tc_tv_details = details }) = details
290 tcTyVarDetails var = pprPanic "tcTyVarDetails" (ppr var)
292 setTcTyVarDetails :: TyVar -> TcTyVarDetails -> TyVar
293 setTcTyVarDetails tv details = tv { tc_tv_details = details }
296 %************************************************************************
298 \subsection{Coercion variables}
300 %************************************************************************
303 coVarName :: CoVar -> Name
306 setCoVarUnique :: CoVar -> Unique -> CoVar
307 setCoVarUnique = setVarUnique
309 setCoVarName :: CoVar -> Name -> CoVar
310 setCoVarName = setVarName
312 mkCoVar :: Name -> Kind -> CoVar
313 mkCoVar name kind = ASSERT( isCoercionKind kind )
314 TyVar { varName = name
315 , realUnique = getKeyFastInt (nameUnique name)
317 , isCoercionVar = True
320 mkWildCoVar :: Kind -> TyVar
321 -- ^ Create a type variable that is never referred to, so its unique doesn't
323 mkWildCoVar = mkCoVar (mkSysTvName (mkBuiltinUnique 1) (fsLit "co_wild"))
326 %************************************************************************
330 %************************************************************************
333 idInfo :: Id -> IdInfo
334 idInfo (Id { id_info = info }) = info
335 idInfo other = pprPanic "idInfo" (ppr other)
337 idDetails :: Id -> IdDetails
338 idDetails (Id { id_details = details }) = details
339 idDetails other = pprPanic "idDetails" (ppr other)
341 -- The next three have a 'Var' suffix even though they always build
342 -- Ids, becuase Id.lhs uses 'mkGlobalId' etc with different types
343 mkGlobalVar :: IdDetails -> Name -> Type -> IdInfo -> Id
344 mkGlobalVar details name ty info
345 = mk_id name ty GlobalId details info
347 mkLocalVar :: IdDetails -> Name -> Type -> IdInfo -> Id
348 mkLocalVar details name ty info
349 = mk_id name ty (LocalId NotExported) details info
351 -- | Exported 'Var's will not be removed as dead code
352 mkExportedLocalVar :: IdDetails -> Name -> Type -> IdInfo -> Id
353 mkExportedLocalVar details name ty info
354 = mk_id name ty (LocalId Exported) details info
356 mk_id :: Name -> Type -> IdScope -> IdDetails -> IdInfo -> Id
357 mk_id name ty scope details info
358 = Id { varName = name,
359 realUnique = getKeyFastInt (nameUnique name),
362 id_details = details,
366 lazySetIdInfo :: Id -> IdInfo -> Var
367 lazySetIdInfo id info = id { id_info = info }
369 setIdDetails :: Id -> IdDetails -> Id
370 setIdDetails id details = id { id_details = details }
372 globaliseId :: Id -> Id
373 -- ^ If it's a local, make it global
374 globaliseId id = id { idScope = GlobalId }
376 setIdExported :: Id -> Id
377 -- ^ Exports the given local 'Id'. Can also be called on global 'Id's, such as data constructors
378 -- and class operations, which are born as global 'Id's and automatically exported
379 setIdExported id@(Id { idScope = LocalId {} }) = id { idScope = LocalId Exported }
380 setIdExported id@(Id { idScope = GlobalId }) = id
381 setIdExported tv = pprPanic "setIdExported" (ppr tv)
383 setIdNotExported :: Id -> Id
384 -- ^ We can only do this to LocalIds
385 setIdNotExported id = ASSERT( isLocalId id )
386 id { idScope = LocalId NotExported }
389 %************************************************************************
391 \subsection{Predicates over variables}
393 %************************************************************************
396 isTyCoVar :: Var -> Bool -- True of both type and coercion variables
397 isTyCoVar (TyVar {}) = True
398 isTyCoVar (TcTyVar {}) = True
401 isTyVar :: Var -> Bool -- True of both type variables only
402 isTyVar v@(TyVar {}) = not (isCoercionVar v)
403 isTyVar (TcTyVar {}) = True
406 isCoVar :: Var -> Bool -- Only works after type checking (sigh)
407 isCoVar v@(TyVar {}) = isCoercionVar v
410 isTcTyVar :: Var -> Bool
411 isTcTyVar (TcTyVar {}) = True
418 isLocalId :: Var -> Bool
419 isLocalId (Id { idScope = LocalId _ }) = True
422 -- | 'isLocalVar' returns @True@ for type variables as well as local 'Id's
423 -- These are the variables that we need to pay attention to when finding free
424 -- variables, or doing dependency analysis.
425 isLocalVar :: Var -> Bool
426 isLocalVar v = not (isGlobalId v)
428 isGlobalId :: Var -> Bool
429 isGlobalId (Id { idScope = GlobalId }) = True
432 -- | 'mustHaveLocalBinding' returns @True@ of 'Id's and 'TyVar's
433 -- that must have a binding in this module. The converse
434 -- is not quite right: there are some global 'Id's that must have
435 -- bindings, such as record selectors. But that doesn't matter,
436 -- because it's only used for assertions
437 mustHaveLocalBinding :: Var -> Bool
438 mustHaveLocalBinding var = isLocalVar var
440 -- | 'isExportedIdVar' means \"don't throw this away\"
441 isExportedId :: Var -> Bool
442 isExportedId (Id { idScope = GlobalId }) = True
443 isExportedId (Id { idScope = LocalId Exported}) = True
444 isExportedId _ = False