| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Name
Contents
Description
GHC uses several kinds of name internally:
OccName: see OccNameRdrName: see RdrNameNameis the type of names that have had their scoping and binding resolved. They have anOccNamebut also aUniquethat disambiguates Names that have the sameOccNameand indeed is used for allNamecomparison. Names also contain information about where they originated from, see NameId: see IdVar: see Var
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
- data Name
- data BuiltInSyntax
- mkSystemName :: Unique -> OccName -> Name
- mkSystemNameAt :: Unique -> OccName -> SrcSpan -> Name
- mkInternalName :: Unique -> OccName -> SrcSpan -> Name
- mkClonedInternalName :: Unique -> Name -> Name
- mkDerivedInternalName :: (OccName -> OccName) -> Unique -> Name -> Name
- mkSystemVarName :: Unique -> FastString -> Name
- mkSysTvName :: Unique -> FastString -> Name
- mkFCallName :: Unique -> String -> Name
- mkExternalName :: Unique -> Module -> OccName -> SrcSpan -> Name
- mkWiredInName :: Module -> OccName -> Unique -> TyThing -> BuiltInSyntax -> Name
- nameUnique :: Name -> Unique
- setNameUnique :: Name -> Unique -> Name
- nameOccName :: Name -> OccName
- nameModule :: HasDebugCallStack => Name -> Module
- nameModule_maybe :: Name -> Maybe Module
- setNameLoc :: Name -> SrcSpan -> Name
- tidyNameOcc :: Name -> OccName -> Name
- localiseName :: Name -> Name
- nameSrcLoc :: Name -> SrcLoc
- nameSrcSpan :: Name -> SrcSpan
- pprNameDefnLoc :: Name -> SDoc
- pprDefinedAt :: Name -> SDoc
- isSystemName :: Name -> Bool
- isInternalName :: Name -> Bool
- isExternalName :: Name -> Bool
- isTyVarName :: Name -> Bool
- isTyConName :: Name -> Bool
- isDataConName :: Name -> Bool
- isValName :: Name -> Bool
- isVarName :: Name -> Bool
- isWiredInName :: Name -> Bool
- isBuiltInSyntax :: Name -> Bool
- isHoleName :: Name -> Bool
- wiredInNameTyThing_maybe :: Name -> Maybe TyThing
- nameIsLocalOrFrom :: Module -> Name -> Bool
- nameIsHomePackage :: Module -> Name -> Bool
- nameIsHomePackageImport :: Module -> Name -> Bool
- nameIsFromExternalPackage :: UnitId -> Name -> Bool
- stableNameCmp :: Name -> Name -> Ordering
- class NamedThing a where
- getOccName :: a -> OccName
- getName :: a -> Name
- getSrcLoc :: NamedThing a => a -> SrcLoc
- getSrcSpan :: NamedThing a => a -> SrcSpan
- getOccString :: NamedThing a => a -> String
- getOccFS :: NamedThing a => a -> FastString
- pprInfixName :: (Outputable a, NamedThing a) => a -> SDoc
- pprPrefixName :: NamedThing a => a -> SDoc
- pprModulePrefix :: PprStyle -> Module -> OccName -> SDoc
- pprNameUnqualified :: Name -> SDoc
- nameStableString :: Name -> String
- module OccName
The main types
A unique, unambiguous name for something, containing information about where that thing originated.
Instances
Instance details
Defined in Name
Methods
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Name -> c Name #
gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Name #
dataTypeOf :: Name -> DataType #
dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Name) #
dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Name) #
gmapT :: (forall b. Data b => b -> b) -> Name -> Name #
gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r #
gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r #
gmapQ :: (forall d. Data d => d -> u) -> Name -> [u] #
gmapQi :: Int -> (forall d. Data d => d -> u) -> Name -> u #
gmapM :: Monad m => (forall d. Data d => d -> m d) -> Name -> m Name #
gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name #
gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m 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 trac #15240 for a bug
caused by improper use of this instance.
Instance details
Defined in Name
Methods
composeSrcSpan :: Located (SrcSpanLess Name) -> Name Source #
decomposeSrcSpan :: Name -> Located (SrcSpanLess Name) Source #
Assumes that the Name is a non-binding one. See
putIfaceTopBndr and getIfaceTopBndr for serializing
binding Name s. See UserData for the rationale for this distinction.
data BuiltInSyntax Source #
BuiltInSyntax is for things like (:), [] and tuples,
which have special syntactic forms. They aren't in scope
as such.
Creating Name s
mkSystemVarName :: Unique -> FastString -> Name Source #
mkSysTvName :: Unique -> FastString -> Name Source #
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 #
nameOccName :: Name -> OccName Source #
nameModule :: HasDebugCallStack => Name -> Module Source #
localiseName :: Name -> Name Source #
Make the Name into an internal name, regardless of what it was to begin with
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 #
isWiredInName :: Name -> Bool Source #
isBuiltInSyntax :: Name -> Bool Source #
isHoleName :: Name -> Bool Source #
nameIsLocalOrFrom :: Module -> Name -> Bool Source #
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 HscTypes
nameIsFromExternalPackage :: UnitId -> Name -> Bool Source #
Returns True if the Name comes from some other package: neither this package nor the interactive package.
stableNameCmp :: Name -> Name -> Ordering Source #
Compare Names lexicographically This only works for Names that originate in the source code or have been tidied.
Class NamedThing and overloaded friends
class NamedThing a where Source #
A class allowing convenient access to the Name of various datatypes
Minimal complete definition
getSrcLoc :: NamedThing a => a -> SrcLoc Source #
getSrcSpan :: NamedThing a => a -> SrcSpan Source #
getOccString :: NamedThing a => a -> String Source #
getOccFS :: NamedThing a => a -> FastString Source #
pprInfixName :: (Outputable a, NamedThing a) => a -> SDoc Source #
pprPrefixName :: NamedThing a => a -> SDoc Source #
pprNameUnqualified :: Name -> SDoc Source #
Print the string of Name unqualifiedly directly.
nameStableString :: Name -> String Source #
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 OccName