Safe Haskell	None
Language	Haskell98

Name

Contents

The main types
- Creating Names
- Manipulating and deconstructing Names
- Predicates on Names
Class NamedThing and overloaded friends

Description

GHC uses several kinds of name internally:

OccName: see "OccName#name_types"
RdrName: see "RdrName#name_types"
Name is the type of names that have had their scoping and binding resolved. They have an OccName but also a Unique that disambiguates Names that have the same OccName and indeed is used for all Name comparison. Names also contain information about where they originated from, see "Name#name_sorts"
Id: see "Id#name_types"
Var: see "Var#name_types"

Names are one of:

External, if they name things declared in other modules. Some external Names are wired in, i.e. they name primitives defined in the compiler itself
Internal, if they name things in the module being compiled. Some internal Names are system names, if they are names manufactured by the compiler

Synopsis

The main types

data Name Source

A unique, unambigious name for something, containing information about where that thing originated.

Instances

Eq Name
Data Name
Ord Name
OutputableBndr Name
Outputable Name
Uniquable Name
Binary Name
HasOccName Name
NamedThing Name
Typeable * Name

data BuiltInSyntax Source

BuiltInSyntax is for things like (:), [] and tuples, which have special syntactic forms. They aren't in scope as such.

Constructors

BuiltInSyntax
UserSyntax

Creating `Name`s

mkSystemName :: Unique -> OccName -> Name Source

Create a name brought into being by the compiler

mkSystemNameAt :: Unique -> OccName -> SrcSpan -> Name Source

mkInternalName :: Unique -> OccName -> SrcSpan -> Name Source

Create a name which is (for now at least) local to the current module and hence does not need a Module to disambiguate it from other Names

mkClonedInternalName :: Unique -> Name -> Name Source

mkDerivedInternalName :: (OccName -> OccName) -> Unique -> Name -> Name Source

mkSystemVarName :: Unique -> FastString -> Name Source

mkSysTvName :: Unique -> FastString -> Name Source

mkFCallName :: Unique -> String -> Name Source

Make a name for a foreign call

mkExternalName :: Unique -> Module -> OccName -> SrcSpan -> Name Source

Create a name which definitely originates in the given module

mkWiredInName :: Module -> OccName -> Unique -> TyThing -> BuiltInSyntax -> Name Source

Create a name which is actually defined by the compiler itself

Manipulating and deconstructing `Name`s

nameUnique :: Name -> Unique Source

setNameUnique :: Name -> Unique -> Name Source

nameOccName :: Name -> OccName Source

nameModule :: Name -> Module Source

nameModule_maybe :: Name -> Maybe Module Source

tidyNameOcc :: Name -> OccName -> Name Source

hashName :: Name -> Int Source

localiseName :: Name -> Name Source

Make the Name into an internal name, regardless of what it was to begin with

mkLocalisedOccName :: Module -> (Maybe String -> OccName -> OccName) -> Name -> OccName Source

Create a localised variant of a name.

If the name is external, encode the original's module name to disambiguate.

nameSrcLoc :: Name -> SrcLoc Source

nameSrcSpan :: Name -> SrcSpan Source

pprNameDefnLoc :: Name -> SDoc Source

pprDefinedAt :: Name -> SDoc Source

Predicates on `Name`s

isSystemName :: Name -> Bool Source

isInternalName :: Name -> Bool Source

isExternalName :: Name -> Bool Source

isTyVarName :: Name -> Bool Source

isTyConName :: Name -> Bool Source

isDataConName :: Name -> Bool Source

isValName :: Name -> Bool Source

isVarName :: Name -> Bool Source

isWiredInName :: Name -> Bool Source

isBuiltInSyntax :: Name -> Bool Source

wiredInNameTyThing_maybe :: Name -> Maybe TyThing Source

nameIsLocalOrFrom :: Module -> Name -> Bool Source

stableNameCmp :: Name -> Name -> Ordering Source

Class `NamedThing` and overloaded friends

class NamedThing a whereSource

A class allowing convenient access to the Name of various datatypes

Methods

getOccName :: a -> OccName Source

getName :: a -> Name Source

getSrcLoc :: NamedThing a => a -> SrcLoc Source

getSrcSpan :: NamedThing a => a -> SrcSpan Source

getOccString :: NamedThing a => a -> String Source

pprInfixName :: (Outputable a, NamedThing a) => a -> SDoc Source

pprPrefixName :: (Outputable a, NamedThing a) => a -> SDoc Source

pprModulePrefix :: PprStyle -> Module -> OccName -> SDoc Source

module OccName

NamedThing Name
NamedThing TyThing
NamedThing Var
NamedThing TyCon
NamedThing DataCon
NamedThing PatSyn
NamedThing ConLike
NamedThing Class
NamedThing ClsInst
NamedThing FamInst
NamedThing (CoAxiom br)

The main types

Creating Names

Manipulating and deconstructing Names

Predicates on Names

Class NamedThing and overloaded friends

Creating `Name`s

Manipulating and deconstructing `Name`s

Predicates on `Name`s

Class `NamedThing` and overloaded friends