Moduleghc-10.0.0.20260917GHC2024

GHC.Types.Name.Occurrence

GHC uses several kinds of name internally:

OccName represents names as strings with just a little more information: the "namespace" that the name came from, e.g. the namespace of value, type constructors or data constructors
RdrName: see GHC.Types.Name.Reader#name_types
Name: see GHC.Types.Name#name_types
GHC.Types.Id.Id: see GHC.Types.Id#name_types
Var: see GHC.Types.Var#name_types

Contents

The NameSpace type
Construction
Pretty Printing
The OccName type
Construction
Derived OccNames
Deconstruction
The OccEnv type
The OccSet type
Dealing with main
Tidying up

Synopsis

data NameSpace
value tcName
value clsName
value tcClsName
value dataName
value varName
value fieldName
value tvName
value srcDataName
value pprNameSpace
value pprNonVarNameSpace
value pprNameSpaceBrief
data OccName
value pprOccName
value occNameMangledFS
value mkOccName
value mkOccNameFS
value mkVarOcc
value mkVarOccFS
value mkRecFieldOcc
value mkRecFieldOccFS
value mkDataOcc
value mkDataOccFS
value mkTyVarOcc
value mkTyVarOccFS
value mkTcOcc
value mkTcOccFS
value mkClsOcc
value mkClsOccFS
value mkDFunOcc
value setOccNameSpace
value demoteOccName
value demoteOccTcClsName
value demoteOccTvName
value promoteOccName
value varToRecFieldOcc
value recFieldToVarOcc
class HasOccName
value isDerivedOccName
value mkDataConWrapperOcc
value mkWorkerOcc
value mkMatcherOcc
value mkBuilderOcc
value mkDefaultMethodOcc
value isDefaultMethodOcc
value isTypeableBindOcc
value mkNewTyCoOcc
value mkClassOpAuxOcc
value mkCon2TagOcc
value mkTag2ConOcc
value mkMaxTagOcc
value mkClassDataConOcc
value mkDictOcc
value mkIPOcc
value mkSpecOcc
value mkForeignExportOcc
value mkRepEqOcc
value mkGenR
value mkGen1R
value mkDataTOcc
value mkDataCOcc
value mkDataConWorkerOcc
value mkSuperDictSelOcc
value mkSuperDictAuxOcc
value mkLocalOcc
value mkMethodOcc
value mkInstTyTcOcc
value mkInstTyCoOcc
value mkEqPredCoOcc
value mkTyConRepOcc
value occNameFS
value occNameString
value occNameSpace
value isVarOcc
value isTvOcc
value isTcOcc
value isDataOcc
value isDataSymOcc
value isSymOcc
value isValOcc
value isFieldOcc
value fieldOcc_maybe
value parenSymOcc
value startsWithUnderscore
value isUnderscore
value isTcClsNameSpace
value isTvNameSpace
value isDataConNameSpace
value isVarNameSpace
value isValNameSpace
value isFieldNameSpace
value isTermVarOrFieldNameSpace
newtype OccEnv
value emptyOccEnv
value unitOccEnv
value extendOccEnv
value mapOccEnv
value strictMapOccEnv
value mapMaybeOccEnv
value lookupOccEnv
value lookupOccEnv_AllNameSpaces
value lookupOccEnv_WithFields
value lookupFieldsOccEnv
value mkOccEnv
value mkOccEnv_C
value extendOccEnvList
value elemOccEnv
value nonDetOccEnvElts
value nonDetFoldOccEnv
value plusOccEnv
value plusOccEnv_C
value extendOccEnv_Acc
value filterOccEnv
value delListFromOccEnv
value delFromOccEnv
value alterOccEnv
value minusOccEnv
value minusOccEnv_C
value minusOccEnv_C_Ns
value sizeOccEnv
value pprOccEnv
value forceOccEnv
value intersectOccEnv_C
newtype OccSet
value emptyOccSet
value unitOccSet
value mkOccSet
value extendOccSet
value extendOccSetList
value unionOccSets
value unionManyOccSets
value elemOccSet
value isEmptyOccSet
value mainOcc
value ppMainFn
type TidyOccEnv
value emptyTidyOccEnv
value initTidyOccEnv
value trimTidyOccEnv
value tidyOccName
value avoidClashesOccEnv
value delTidyOccEnvList
type FastStringEnv
value emptyFsEnv
value lookupFsEnv
value extendFsEnv
value mkFsEnv

Packageghc-10.0.0.20260917
Exports147
LanguageGHC2024
LicenceBSD-3-Clause
SourceOccurrence.hs

The NameSpace type

datadata NameSpace

Instances5Eq, Ord, NFData, Uniquable, Binary

Eq NameSpaceDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
Ord NameSpaceDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
NFData NameSpaceDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
Uniquable NameSpaceDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
Binary NameSpaceDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence

Construction

valuetcName :: NameSpace

valueclsName :: NameSpace

valuetcClsName :: NameSpace

valuedataName :: NameSpace

valuevarName :: NameSpace

valuefieldName :: FastString -> NameSpace

valuetvName :: NameSpace

valuesrcDataName :: NameSpace

Pretty Printing

valuepprNameSpace :: NameSpace -> SDoc

valuepprNonVarNameSpace :: NameSpace -> SDoc

valuepprNameSpaceBrief :: NameSpace -> SDoc

The OccName type

datadata OccName

Source#

Occurrence Name

In this context that means: "classified (i.e. as a type name, value name, etc) but not qualified and not yet resolved"

Instances8Eq, Data, Ord, NFData, Outputable, Binary, …

Eq OccNameDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
Data OccNameDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
Ord OccNameDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
NFData OccNameDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
Outputable OccNameDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
Binary OccNameDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
OutputableBndr OccNameDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
HasOccName OccNameDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence

valuepprOccName :: IsLine doc => OccName -> doc

valueoccNameMangledFS :: OccName -> FastString

Source#

Mangle field names to avoid duplicate symbols.

See Note [Mangling OccNames].

Construction

valuemkOccName :: NameSpace -> String -> OccName

valuemkOccNameFS :: NameSpace -> FastString -> OccName

valuemkVarOcc :: String -> OccName

valuemkVarOccFS :: FastString -> OccName

valuemkRecFieldOcc :: FastString -> String -> OccName

valuemkRecFieldOccFS :: FastString -> FastString -> OccName

valuemkDataOcc :: String -> OccName

valuemkDataOccFS :: FastString -> OccName

valuemkTyVarOcc :: String -> OccName

valuemkTyVarOccFS :: FastString -> OccName

valuemkTcOcc :: String -> OccName

valuemkTcOccFS :: FastString -> OccName

valuemkClsOcc :: String -> OccName

valuemkClsOccFS :: FastString -> OccName

valuemkDFunOcc

:: String
Typically the class and type glommed together e.g. OrdMaybe. Only used in debug mode, for extra clarity
-> Bool
Is this a hs-boot instance DFun?
-> OccSet
avoid these Occs
-> OccName
E.g. $f3OrdMaybe

valuesetOccNameSpace :: NameSpace -> OccName -> OccName

valuedemoteOccName :: OccName -> Maybe OccName

valuedemoteOccTcClsName :: OccName -> Maybe OccName

valuedemoteOccTvName :: OccName -> Maybe OccName

valuepromoteOccName :: OccName -> Maybe OccName

valuevarToRecFieldOcc :: HasDebugCallStack => FastString -> OccName -> OccName

valuerecFieldToVarOcc :: HasDebugCallStack => OccName -> OccName

classclass HasOccName name where

Source#

Other names in the compiler add additional information to an OccName. This class provides a consistent way to access the underlying OccName.

Methods

occName :: name -> OccName

Instances12HasOccName, …

HasOccName IfaceClassOpDefined in ghc-10.0.0.20260917 · GHC.Iface.Syntax
HasOccName IfaceConDeclDefined in ghc-10.0.0.20260917 · GHC.Iface.Syntax
HasOccName IfaceDeclDefined in ghc-10.0.0.20260917 · GHC.Iface.Syntax
HasOccName HoleFitCandidateDefined in ghc-10.0.0.20260917 · GHC.Tc.Errors.Hole.FitTypes
HasOccName TcBinderDefined in ghc-10.0.0.20260917 · GHC.Tc.Types.BasicTypes
HasOccName FieldLabelDefined in ghc-10.0.0.20260917 · GHC.Types.FieldLabel
HasOccName NameDefined in ghc-10.0.0.20260917 · GHC.Types.Name
HasOccName OccNameDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
HasOccName RdrNameDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Reader
HasOccName VarDefined in ghc-10.0.0.20260917 · GHC.Types.Var
HasOccName (GlobalRdrEltX info)Defined in ghc-10.0.0.20260917 · GHC.Types.Name.Reader
(HasOccName (IdP (GhcPass p)), OutputableBndrId p) => HasOccName (IEWrappedName (GhcPass p))Defined in ghc-10.0.0.20260917 · GHC.Hs.ImpExp · orphan

Derived OccNames

valueisDerivedOccName :: OccName -> Bool

Source#

Test for definitions internally generated by GHC. This predicate is used to suppress printing of internal definitions in some debug prints

valuemkDataConWrapperOcc :: OccName -> OccName

valuemkWorkerOcc :: OccName -> OccName

valuemkMatcherOcc :: OccName -> OccName

valuemkBuilderOcc :: OccName -> OccName

valuemkDefaultMethodOcc :: OccName -> OccName

valueisDefaultMethodOcc :: OccName -> Bool

valueisTypeableBindOcc :: OccName -> Bool

Source#

Is an OccName one of a Typeable TyCon or Module binding? This is needed as these bindings are renamed differently. See Note [Grand plan for Typeable] in GHC.Tc.Instance.Typeable.

valuemkNewTyCoOcc :: OccName -> OccName

valuemkClassOpAuxOcc :: OccName -> OccName

valuemkCon2TagOcc :: OccName -> OccName

valuemkTag2ConOcc :: OccName -> OccName

valuemkMaxTagOcc :: OccName -> OccName

valuemkClassDataConOcc :: OccName -> OccName

valuemkDictOcc :: OccName -> OccName

valuemkIPOcc :: OccName -> OccName

valuemkSpecOcc :: OccName -> OccName

valuemkForeignExportOcc :: OccName -> OccName

valuemkRepEqOcc :: OccName -> OccName

valuemkGenR :: OccName -> OccName

valuemkGen1R :: OccName -> OccName

valuemkDataTOcc :: OccName -> OccName

valuemkDataCOcc :: OccName -> OccName

valuemkDataConWorkerOcc :: OccName -> OccName

valuemkSuperDictSelOcc

:: Int
Index of superclass, e.g. 3
-> OccName
Class, e.g. Ord
-> OccName
Derived Occname, e.g. $p3Ord

valuemkSuperDictAuxOcc :: Int -> OccName -> OccName

valuemkLocalOcc

:: Unique
Unique to combine with the OccName
-> OccName
Local name, e.g. sat
-> OccName
Nice unique version, e.g. $L23sat

valuemkMethodOcc :: OccName -> OccName

valuemkInstTyTcOcc

:: String
Family name, e.g. Map
-> OccSet
avoid these Occs
-> OccName
```
R:Map
```

Source#

Derive a name for the representation type constructor of a data/newtype instance.

valuemkInstTyCoOcc :: OccName -> OccName

valuemkEqPredCoOcc :: OccName -> OccName

valuemkTyConRepOcc :: OccName -> OccName

Deconstruction

valueoccNameFS :: OccName -> FastString

valueoccNameString :: OccName -> String

valueoccNameSpace :: OccName -> NameSpace

valueisVarOcc :: OccName -> Bool

valueisTvOcc :: OccName -> Bool

valueisTcOcc :: OccName -> Bool

valueisDataOcc :: OccName -> Bool

valueisDataSymOcc :: OccName -> Bool

Source#

Test if the OccName is a data constructor that starts with a symbol (e.g. :, or [])

valueisSymOcc :: OccName -> Bool

Source#

Test if the OccName is that for any operator (whether it is a data constructor or variable or whatever)

valueisValOcc :: OccName -> Bool

Source#

Value OccNamess are those that are either in the variable, field name or data constructor namespaces

valueisFieldOcc :: OccName -> Bool

valuefieldOcc_maybe :: OccName -> Maybe FastString

valueparenSymOcc :: OccName -> SDoc -> SDoc

Source#

Wrap parens around an operator

valuestartsWithUnderscore :: OccName -> Bool

Source#

Haskell 98 encourages compilers to suppress warnings about unused names in a pattern if they start with _: this implements that test

valueisUnderscore :: OccName -> Bool

valueisTcClsNameSpace :: NameSpace -> Bool

valueisTvNameSpace :: NameSpace -> Bool

valueisDataConNameSpace :: NameSpace -> Bool

valueisVarNameSpace :: NameSpace -> Bool

valueisValNameSpace :: NameSpace -> Bool

valueisFieldNameSpace :: NameSpace -> Bool

valueisTermVarOrFieldNameSpace :: NameSpace -> Bool

Source#

Is this a term variable or field name namespace?

The OccEnv type

newtypenewtype OccEnv a

Source#

A map keyed on OccName. See Note [OccEnv].

Instances3Functor, NFData, Outputable

Functor OccEnvDefined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
NFData a => NFData (OccEnv a)Defined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence
Outputable a => Outputable (OccEnv a)Defined in ghc-10.0.0.20260917 · GHC.Types.Name.Occurrence

valueemptyOccEnv :: OccEnv a

Source#

The empty OccEnv.

valueunitOccEnv :: OccName -> a -> OccEnv a

Source#

A singleton OccEnv.

valueextendOccEnv :: OccEnv a -> OccName -> a -> OccEnv a

Source#

Add a single element to an OccEnv.

valuemapOccEnv :: (a -> b) -> OccEnv a -> OccEnv b

Source#

Map over an OccEnv (Functor instance).

valuestrictMapOccEnv :: (a -> b) -> OccEnv a -> OccEnv b

Source#

Map over an OccEnv strictly.

valuemapMaybeOccEnv :: (a -> Maybe b) -> OccEnv a -> OccEnv b

Source#

mapMaybe for b OccEnv.

valuelookupOccEnv :: OccEnv a -> OccName -> Maybe a

Source#

Look an element up in an OccEnv.

valuelookupOccEnv_AllNameSpaces :: OccEnv a -> OccName -> [a]

Source#

Lookup an element in an OccEnv, ignoring NameSpaces entirely.

valuelookupOccEnv_WithFields :: OccEnv a -> OccName -> [a]

Source#

Lookup an element in an OccEnv, looking in the record field namespace for a variable.

valuelookupFieldsOccEnv :: OccEnv a -> FastString -> [a]

Source#

Look up all the record fields that match with the given FastString in an OccEnv.

valuemkOccEnv :: [(OccName, a)] -> OccEnv a

Source#

Create an OccEnv from a list.

OccNames later on in the list override earlier OccNames.

valuemkOccEnv_C

:: (a -> a -> a)
old -> new -> result
-> [(OccName, a)]
-> OccEnv a

Source#

Create an OccEnv from a list, combining different values with the same OccName using the combining function.

valueextendOccEnvList :: OccEnv a -> [(OccName, a)] -> OccEnv a

Source#

Extend an OccEnv by a list.

OccNames later on in the list override earlier OccNames.

valueelemOccEnv :: OccName -> OccEnv a -> Bool

Source#

Compute whether there is a value keyed by the given OccName.

valuenonDetOccEnvElts :: OccEnv a -> [a]

Source#

Obtain the elements of an OccEnv.

The resulting order is non-deterministic.

valuenonDetFoldOccEnv :: (a -> b -> b) -> b -> OccEnv a -> b

Source#

Fold over an OccEnv. Non-deterministic, unless the folding function is commutative (i.e. a1 f ( a2 f b ) == a2 f ( a1 f b ) for all a1, a2, b).

valueplusOccEnv :: OccEnv a -> OccEnv a -> OccEnv a

Source#

Union of two OccEnvs, right-biased.

valueplusOccEnv_C :: (a -> a -> a) -> OccEnv a -> OccEnv a -> OccEnv a

Source#

Union of two OccEnvs with a combining function.

valueextendOccEnv_Acc

:: (a -> b -> b)
add to existing
-> (a -> b)
new element
-> OccEnv b
old
-> OccName
-> a
new
-> OccEnv b

Source#

Add a single element to an OccEnv, using a different function whether the OccName already exists or not.

valuefilterOccEnv :: (a -> Bool) -> OccEnv a -> OccEnv a

Source#

Filter out all elements in an OccEnv using a predicate.

valuedelListFromOccEnv :: OccEnv a -> [OccName] -> OccEnv a

Source#

Delete multiple elements from an OccEnv.

valuedelFromOccEnv :: OccEnv a -> OccName -> OccEnv a

Source#

Delete one element from an OccEnv.

valuealterOccEnv :: (Maybe a -> Maybe a) -> OccEnv a -> OccName -> OccEnv a

Source#

Alter an OccEnv, adding or removing an element at the given key.

valueminusOccEnv :: OccEnv a -> OccEnv b -> OccEnv a

Source#

Remove elements of the first OccEnv that appear in the second OccEnv.

valueminusOccEnv_C :: (a -> b -> Maybe a) -> OccEnv a -> OccEnv b -> OccEnv a

Source#

Alters (replaces or removes) those elements of the first OccEnv that are mentioned in the second OccEnv.

Same idea as Data.Map.differenceWith.

valueminusOccEnv_C_Ns

:: UniqFM NameSpace a -> UniqFM NameSpace b -> UniqFM NameSpace a
-> OccEnv a
-> OccEnv b
-> OccEnv a

valuesizeOccEnv :: OccEnv a -> Int

valuepprOccEnv :: (a -> SDoc) -> OccEnv a -> SDoc

valueforceOccEnv :: (a -> ()) -> OccEnv a -> ()

Source#

Force an OccEnv with the provided function.

valueintersectOccEnv_C :: (a -> b -> c) -> OccEnv a -> OccEnv b -> OccEnv c

The OccSet type

newtypenewtype OccSet

valueemptyOccSet :: OccSet

valueunitOccSet :: OccName -> OccSet

valuemkOccSet :: [OccName] -> OccSet

valueextendOccSet :: OccSet -> OccName -> OccSet

valueextendOccSetList :: OccSet -> [OccName] -> OccSet

valueunionOccSets :: OccSet -> OccSet -> OccSet

valueunionManyOccSets :: [OccSet] -> OccSet

valueelemOccSet :: OccName -> OccSet -> Bool

valueisEmptyOccSet :: OccSet -> Bool

Dealing with main

valuemainOcc :: OccName

valueppMainFn :: OccName -> SDoc

Tidying up

typetype TidyOccEnv = UniqFM FastString Int

valueemptyTidyOccEnv :: TidyOccEnv

valueinitTidyOccEnv :: [OccName] -> TidyOccEnv

valuetrimTidyOccEnv :: TidyOccEnv -> [OccName] -> TidyOccEnv

valuetidyOccName :: TidyOccEnv -> OccName -> (TidyOccEnv, OccName)

valueavoidClashesOccEnv :: TidyOccEnv -> [OccName] -> TidyOccEnv

valuedelTidyOccEnvList :: TidyOccEnv -> [OccName] -> TidyOccEnv

typetype FastStringEnv a = UniqFM FastString a

Source#

A non-deterministic set of FastStrings. See Note [Deterministic UniqFM] in GHC.Types.Unique.DFM for explanation why it's not deterministic and why it matters. Use DFastStringEnv if the set eventually gets converted into a list or folded over in a way where the order changes the generated code.

valueemptyFsEnv :: FastStringEnv a

valuelookupFsEnv :: FastStringEnv a -> FastString -> Maybe a

valueextendFsEnv :: FastStringEnv a -> FastString -> a -> FastStringEnv a

valuemkFsEnv :: [(FastString, a)] -> FastStringEnv a