GHC.Types.Name.Occurrence · ghc-9.10.3

:: 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

#

valuedemoteOccTvName :: OccName -> Maybe OccName

#

valuepromoteOccName :: OccName -> Maybe OccName

#

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

#

valuerecFieldToVarOcc :: HasDebugCallStack => OccName -> OccName

#

classclass HasOccName name where

#

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

Derived OccNames

valueisDerivedOccName :: OccName -> Bool

#

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

#

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
```

#

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

#

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

valueisSymOcc :: OccName -> Bool

#

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

valueisValOcc :: OccName -> Bool

#

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

#

Wrap parens around an operator

valuestartsWithUnderscore :: OccName -> Bool

#

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

#

Is this a term variable or field name namespace?

The OccEnv type

30 declarations

newtypenewtype OccEnv a

#

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

Instances3Functor, NFData, Outputable

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

valueemptyOccEnv :: OccEnv a

#

The empty OccEnv.

valueunitOccEnv :: OccName -> a -> OccEnv a

#

A singleton OccEnv.

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

#

Add a single element to an OccEnv.

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

#

Map over an OccEnv (Functor instance).

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

#

Map over an OccEnv strictly.

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

#

mapMaybe for b OccEnv.

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

#

Look an element up in an OccEnv.

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

#

Lookup an element in an OccEnv, ignoring NameSpaces entirely.

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

#

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

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

#

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

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

#

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

#

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

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

#

Extend an OccEnv by a list.

OccNames later on in the list override earlier OccNames.

valueelemOccEnv :: OccName -> OccEnv a -> Bool

#

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

valuenonDetOccEnvElts :: OccEnv a -> [a]

#

Obtain the elements of an OccEnv.

The resulting order is non-deterministic.

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

#

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

#

Union of two OccEnvs, right-biased.

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

#

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

#

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

#

Filter out all elements in an OccEnv using a predicate.

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

#

Delete multiple elements from an OccEnv.

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

#

Delete one element from an OccEnv.

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

#

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

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

#

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

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

#

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

#

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

#

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

#

Force an OccEnv with the provided function.

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

#

The OccSet type

10 declarations

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

2 declarations

valuemainOcc :: OccName

#

valueppMainFn :: OccName -> SDoc

#

Tidying up

11 declarations

typetype TidyOccEnv = UniqFM FastString Int

#

valueemptyTidyOccEnv :: TidyOccEnv

#

valueinitTidyOccEnv :: [OccName] -> TidyOccEnv

#

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

#

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

#

valuedelTidyOccEnvList :: TidyOccEnv -> [FastString] -> TidyOccEnv

#

typetype FastStringEnv a = UniqFM FastString a

#

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

#