Moduleghc-9.14.1GHC2021

GHC.Types.Name

GHC uses several kinds of name internally:

OccName: see GHC.Types.Name.Occurrence#name_types
RdrName: see GHC.Types.Name.Reader#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 GHC.Types.Name#name_sorts
GHC.Types.Id.Id: see GHC.Types.Id#name_types
Var: see GHC.Types.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

2 types
1 class
62 values

Packageghc-9.14.1
Exports65
LanguageGHC2021
LicenceBSD-3-Clause
SourceName.hs

The main types

2 declarations

datadata Name

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

Instances17Eq, Data, Ord, NFData, NamedThing, Uniquable, …

Eq NameDefined in ghc-9.14.1 · GHC.Types.Name
The same comments as for Name's Ord instance apply.
Data NameDefined in ghc-9.14.1 · GHC.Types.Name
Ord NameDefined in ghc-9.14.1 · GHC.Types.Name
Caution: This instance is implemented via nonDetCmpUnique, which means that the ordering is not stable across deserialization or rebuilds.
See nonDetCmpUnique for further information, and #15240 for a bug caused by improper use of this instance.
NFData NameDefined in ghc-9.14.1 · GHC.Types.Name
NamedThing NameDefined in ghc-9.14.1 · GHC.Types.Name
Outputable NameDefined in ghc-9.14.1 · GHC.Types.Name
Uniquable NameDefined in ghc-9.14.1 · GHC.Types.Name
Binary NameEntityInfoDefined in ghc-9.14.1 · GHC.Iface.Ext.Types
Binary NameDefined in ghc-9.14.1 · GHC.Types.Name
Assumes that the Name is a non-binding one. See putIfaceTopBndr and getIfaceTopBndr for serializing binding Names. See UserData for the rationale for this distinction.
OutputableBndr NameDefined in ghc-9.14.1 · GHC.Types.Name
HasOccName NameDefined in ghc-9.14.1 · GHC.Types.Name
ModifyState NameDefined in ghc-9.14.1 · GHC.Iface.Ext.Ast
Outputable (WithUserRdr Name)Defined in ghc-9.14.1 · GHC.Types.Name.Reader
OutputableBndr (WithUserRdr Name)Defined in ghc-9.14.1 · GHC.Types.Name.Reader
ToHie (Context (Located Name))Defined in ghc-9.14.1 · GHC.Iface.Ext.Ast
ToHie (Context (Located (WithUserRdr Name)))Defined in ghc-9.14.1 · GHC.Iface.Ext.Ast
type Anno Name = SrcSpanAnnNDefined in ghc-9.14.1 · GHC.Hs.Extension · orphan

datadata BuiltInSyntax

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

BuiltInSyntax UserSyntax

Creating Names

valuemkSystemName :: Unique -> OccName -> Name

Create a name brought into being by the compiler

valuemkSystemNameAt :: Unique -> OccName -> SrcSpan -> Name

valuemkInternalName :: Unique -> OccName -> SrcSpan -> Name

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

valuemkClonedInternalName :: Unique -> Name -> Name

valuemkDerivedInternalName :: (OccName -> OccName) -> Unique -> Name -> Name

valuemkSystemVarName :: Unique -> FastString -> Name

valuemkSysTvName :: Unique -> FastString -> Name

valuemkFCallName :: Unique -> FastString -> Name

Make a name for a foreign call

valuemkExternalName :: Unique -> Module -> OccName -> SrcSpan -> Name

Create a name which definitely originates in the given module

valuemkWiredInName

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

Create a name which is actually defined by the compiler itself

Manipulating and deconstructing Names

valuenameUnique :: Name -> Unique

valuesetNameUnique :: Name -> Unique -> Name

valuenameOccName :: Name -> OccName

valuenameNameSpace :: Name -> NameSpace

valuenameModule :: HasDebugCallStack => Name -> Module

valuenameModule_maybe :: Name -> Maybe Module

valuesetNameLoc :: Name -> SrcSpan -> Name

valuetidyNameOcc :: Name -> OccName -> Name

valuelocaliseName :: Name -> Name

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

valuenamePun_maybe :: Name -> Maybe FastString

valuepprName :: IsLine doc => Name -> doc

valuepprName_userQual :: IsLine doc => Maybe ModuleName -> Name -> doc

valuenameSrcLoc :: Name -> SrcLoc

valuenameSrcSpan :: Name -> SrcSpan

valuepprNameDefnLoc :: Name -> SDoc

valuepprDefinedAt :: Name -> SDoc

valuepprFullName :: Module -> Name -> SDoc

Print fully qualified name (with unit-id and module, but no unique)

valuepprFullNameWithUnique :: Module -> Name -> SDoc

Print fully qualified name (with unit-id and module, with the unique)

valuepprTickyName :: Module -> Name -> SDoc

Print a ticky ticky styled name

Module argument is the module to use for internal and system names. When printing the name in a ticky profile, the module name is included even for local things. However, ticky uses the format "x (M)" rather than "M.x". Hence, this function provides a separation from normal styling.

Predicates on Names

valueisSystemName :: Name -> Bool

valueisInternalName :: Name -> Bool

valueisExternalName :: Name -> Bool

valueisTyVarName :: Name -> Bool

valueisTyConName :: Name -> Bool

valueisDataConName :: Name -> Bool

valueisValName :: Name -> Bool

valueisVarName :: Name -> Bool

valueisDynLinkName :: Platform -> Module -> Name -> Bool

Will the Name come from a dynamically linked package?

valueisFieldName :: Name -> Bool

valueisWiredInName :: Name -> Bool

valueisWiredIn :: NamedThing thing => thing -> Bool

valueisBuiltInSyntax :: Name -> Bool

valueisTupleTyConName :: Name -> Bool

valueisSumTyConName :: Name -> Bool

valueisUnboxedTupleDataConLikeName :: Name -> Bool

This matches a datacon as well as its worker and promoted tycon.

valueisHoleName :: Name -> Bool

valuewiredInNameTyThing_maybe :: Name -> Maybe TyThing

valuenameIsLocalOrFrom :: Module -> Name -> Bool

Returns True if the name is (a) Internal (b) External but from the specified module (c) External but from the interactive package

The key idea is that False means: the entity is defined in some other module you can find the details (type, fixity, instances) in some interface file those details will be stored in the EPT or HPT

True means: the entity is defined in this module or earlier in the GHCi session you can find details (type, fixity, instances) in the TcGblEnv or TcLclEnv

The isInteractiveModule part is because successive interactions of a GHCi session each give rise to a fresh module (Ghci1, Ghci2, etc), but they all come from the magic interactive package; and all the details are kept in the TcLclEnv, TcGblEnv, NOT in the HPT or EPT. See Note [The interactive package] in GHC.Runtime.Context

valuenameIsExternalOrFrom :: Module -> Name -> Bool

Returns True if the name is external or from the interactive package See documentation of nameIsLocalOrFrom function

valuenameIsHomePackage :: Module -> Name -> Bool

valuenameIsHomePackageImport :: Module -> Name -> Bool

valuenameIsFromExternalPackage :: HomeUnit -> Name -> Bool

Returns True if the Name comes from some other package: neither this package nor the interactive package.

valuestableNameCmp :: Name -> Name -> Ordering

Compare Names lexicographically This only works for Names that originate in the source code or have been tidied.

Class NamedThing and overloaded friends

10 declarations

classclass NamedThing a where

A class allowing convenient access to the Name of various datatypes

Methods

getOccName :: a -> OccName
getName :: a -> Name

Instances21NamedThing, …

NamedThing ClassDefined in ghc-9.14.1 · GHC.Core.Class
NamedThing ConLikeDefined in ghc-9.14.1 · GHC.Core.ConLike
NamedThing DataConDefined in ghc-9.14.1 · GHC.Core.DataCon
NamedThing FamInstDefined in ghc-9.14.1 · GHC.Core.FamInstEnv
NamedThing ClsInstDefined in ghc-9.14.1 · GHC.Core.InstEnv
NamedThing PatSynDefined in ghc-9.14.1 · GHC.Core.PatSyn
NamedThing TyConDefined in ghc-9.14.1 · GHC.Core.TyCon
NamedThing IfaceClassOpDefined in ghc-9.14.1 · GHC.Iface.Syntax
NamedThing IfaceConDeclDefined in ghc-9.14.1 · GHC.Iface.Syntax
NamedThing IfaceDeclDefined in ghc-9.14.1 · GHC.Iface.Syntax
NamedThing HoleFitCandidateDefined in ghc-9.14.1 · GHC.Tc.Errors.Hole.FitTypes
NamedThing InvalidFamInstQTvDefined in ghc-9.14.1 · GHC.Tc.Errors.Types
NamedThing ConLikeNameDefined in ghc-9.14.1 · GHC.Types.GREInfo
NamedThing NameDefined in ghc-9.14.1 · GHC.Types.Name
NamedThing TyThingDefined in ghc-9.14.1 · GHC.Types.TyThing
NamedThing VarDefined in ghc-9.14.1 · GHC.Types.Var
NamedThing (CoAxiom br)Defined in ghc-9.14.1 · GHC.Core.Coercion.Axiom
NamedThing a => NamedThing (WithUserRdr a)Defined in ghc-9.14.1 · GHC.Types.Name.Reader
NamedThing e => NamedThing (Located e)Defined in ghc-9.14.1 · GHC.Types.Name
NamedThing (Located a) => NamedThing (LocatedAn an a)Defined in ghc-9.14.1 · GHC.Parser.Annotation
NamedThing tv => NamedThing (VarBndr tv flag)Defined in ghc-9.14.1 · GHC.Types.Var

valuegetSrcLoc :: NamedThing a => a -> SrcLoc

valuegetSrcSpan :: NamedThing a => a -> SrcSpan

valuegetOccString :: NamedThing a => a -> String

valuegetOccFS :: NamedThing a => a -> FastString

valuepprInfixName :: (Outputable a, NamedThing a) => a -> SDoc

valuepprPrefixName :: (Outputable a, NamedThing a) => a -> SDoc

valuepprModulePrefix :: PprStyle -> Module -> Maybe ModuleName -> OccName -> SDoc

valuepprNameUnqualified :: Name -> SDoc

Print the string of Name unqualifiedly directly.

valuenameStableString :: Name -> String

Get a string representation of a Name that's unique and stable across recompilations. Used for deterministic generation of binds for derived instances. eg. "$aeson_70dylHtv1FFGeai1IoxcQr$Data.Aeson.Types.Internal$String"

module GHC.Types.Name.Occurrence

Orphan instances

1 instance

NFData FieldLabel