ghc-7.10.2: The GHC API

Safe HaskellNone
LanguageHaskell2010

Var

Contents

Description

GHC uses several kinds of name internally:

These Var names may either be global or local, see Var

Global Ids and Vars are those that are imported or correspond to a data constructor, primitive operation, or record selectors. Local Ids and Vars are those bound within an expression (e.g. by a lambda) or at the top level of the module being compiled.

Synopsis

The main data type and synonyms

data Var

Essentially a typed Name, that may also contain some additional information about the Var and it's use sites.

Instances

Eq Var 
Data Var 
Ord Var 
Outputable Var 
Uniquable Var 
NamedThing Var 
type PostRn Id ty = ty 
type PostTc Id ty = ty 

type CoVar = Id

type Id = Var

type DictId = EvId

type DFunId = Id

type EvVar = EvId

type EqVar = EvId

type EvId = Id

type IpId = EvId

type TyVar = Var

type TypeVar = Var

type KindVar = Var

type TKVar = Var

Taking Vars apart

varType :: Var -> Kind

The type or kind of the Var in question

Modifying Vars

setVarType :: Id -> Type -> Id

Constructing, taking apart, modifying Ids

mkExportedLocalVar :: IdDetails -> Name -> Type -> IdInfo -> Id

Exported Vars will not be removed as dead code

globaliseId :: Id -> Id

If it's a local, make it global

setIdExported :: Id -> Id

Exports the given local Id. Can also be called on global Ids, such as data constructors and class operations, which are born as global Ids and automatically exported

setIdNotExported :: Id -> Id

We can only do this to LocalIds

Predicates

isId :: Var -> Bool

isLocalVar :: Var -> Bool

isLocalVar returns True for type variables as well as local Ids These are the variables that we need to pay attention to when finding free variables, or doing dependency analysis.

isExportedId :: Var -> Bool

isExportedIdVar means "don't throw this away"

mustHaveLocalBinding :: Var -> Bool

mustHaveLocalBinding returns True of Ids and TyVars that must have a binding in this module. The converse is not quite right: there are some global Ids that must have bindings, such as record selectors. But that doesn't matter, because it's only used for assertions

Constructing TyVars

Taking TyVars apart

Modifying TyVars

updateTyVarKindM :: Monad m => (Kind -> m Kind) -> TyVar -> m TyVar