ghc-8.0.0.20160204: The GHC API

Safe HaskellNone
LanguageHaskell2010

OccName

Contents

Description

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 RdrName
  • Name: see Name
  • Id: see Id
  • Var: see Var

Synopsis

The NameSpace type

data NameSpace Source

Instances

nameSpacesRelated :: NameSpace -> NameSpace -> Bool Source

Construction

 

tcName :: NameSpace Source

clsName :: NameSpace Source

tcClsName :: NameSpace Source

dataName :: NameSpace Source

varName :: NameSpace Source

tvName :: NameSpace Source

srcDataName :: NameSpace Source

Pretty Printing

pprNameSpace :: NameSpace -> SDoc Source

pprNonVarNameSpace :: NameSpace -> SDoc Source

pprNameSpaceBrief :: NameSpace -> SDoc Source

The OccName type

data OccName Source

Instances

Eq OccName 

Methods

(==) :: OccName -> OccName -> Bool

(/=) :: OccName -> OccName -> Bool

Data OccName 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OccName -> c OccName Source

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OccName Source

toConstr :: OccName -> Constr Source

dataTypeOf :: OccName -> DataType Source

dataCast1 :: Typeable (TYPE Lifted -> TYPE Lifted) t => (forall d. Data d => c (t d)) -> Maybe (c OccName) Source

dataCast2 :: Typeable (TYPE Lifted -> TYPE Lifted -> TYPE Lifted) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OccName) Source

gmapT :: (forall b. Data b => b -> b) -> OccName -> OccName Source

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OccName -> r Source

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OccName -> r Source

gmapQ :: (forall d. Data d => d -> u) -> OccName -> [u] Source

gmapQi :: Int -> (forall d. Data d => d -> u) -> OccName -> u Source

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OccName -> m OccName Source

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OccName -> m OccName Source

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OccName -> m OccName Source

Ord OccName 
OutputableBndr OccName 
Outputable OccName 
Uniquable OccName 
Binary OccName 
HasOccName OccName 

pprOccName :: OccName -> SDoc Source

Construction

mkOccName :: NameSpace -> String -> OccName Source

mkOccNameFS :: NameSpace -> FastString -> OccName Source

mkVarOcc :: String -> OccName Source

mkVarOccFS :: FastString -> OccName Source

mkDataOcc :: String -> OccName Source

mkDataOccFS :: FastString -> OccName Source

mkTyVarOcc :: String -> OccName Source

mkTyVarOccFS :: FastString -> OccName Source

mkTcOcc :: String -> OccName Source

mkTcOccFS :: FastString -> OccName Source

mkClsOcc :: String -> OccName Source

mkClsOccFS :: FastString -> OccName Source

mkDFunOcc Source

Arguments

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

setOccNameSpace :: NameSpace -> OccName -> OccName Source

demoteOccName :: OccName -> Maybe OccName Source

class 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.

Minimal complete definition

occName

Methods

occName :: name -> OccName Source

Instances

Derived OccNames

isDerivedOccName :: OccName -> Bool Source

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

mkDataConWrapperOcc :: OccName -> OccName Source

mkWorkerOcc :: OccName -> OccName Source

mkMatcherOcc :: OccName -> OccName Source

mkBuilderOcc :: OccName -> OccName Source

mkDefaultMethodOcc :: OccName -> OccName Source

mkNewTyCoOcc :: OccName -> OccName Source

mkClassOpAuxOcc :: OccName -> OccName Source

mkCon2TagOcc :: OccName -> OccName Source

mkTag2ConOcc :: OccName -> OccName Source

mkMaxTagOcc :: OccName -> OccName Source

mkClassDataConOcc :: OccName -> OccName Source

mkDictOcc :: OccName -> OccName Source

mkIPOcc :: OccName -> OccName Source

mkSpecOcc :: OccName -> OccName Source

mkForeignExportOcc :: OccName -> OccName Source

mkRepEqOcc :: OccName -> OccName Source

mkGenD :: Module -> OccName -> OccName Source

mkGenR :: OccName -> OccName Source

mkGen1R :: OccName -> OccName Source

mkGenRCo :: OccName -> OccName Source

mkGenC :: Module -> OccName -> Int -> OccName Source

mkGenS :: Module -> OccName -> Int -> Int -> OccName Source

mkDataTOcc :: OccName -> OccName Source

mkDataCOcc :: OccName -> OccName Source

mkDataConWorkerOcc :: OccName -> OccName Source

mkSuperDictSelOcc Source

Arguments

:: Int

Index of superclass, e.g. 3

-> OccName

Class, e.g. Ord

-> OccName

Derived Occname, e.g. $p3Ord

mkSuperDictAuxOcc :: Int -> OccName -> OccName Source

mkLocalOcc Source

Arguments

:: Unique

Unique to combine with the OccName

-> OccName

Local name, e.g. sat

-> OccName

Nice unique version, e.g. $L23sat

mkMethodOcc :: OccName -> OccName Source

mkInstTyTcOcc Source

Arguments

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

mkInstTyCoOcc :: OccName -> OccName Source

mkEqPredCoOcc :: OccName -> OccName Source

mkVectOcc :: Maybe String -> OccName -> OccName Source

mkVectTyConOcc :: Maybe String -> OccName -> OccName Source

mkVectDataConOcc :: Maybe String -> OccName -> OccName Source

mkVectIsoOcc :: Maybe String -> OccName -> OccName Source

mkPDataTyConOcc :: Maybe String -> OccName -> OccName Source

mkPDataDataConOcc :: Maybe String -> OccName -> OccName Source

mkPDatasTyConOcc :: Maybe String -> OccName -> OccName Source

mkPDatasDataConOcc :: Maybe String -> OccName -> OccName Source

mkPReprTyConOcc :: Maybe String -> OccName -> OccName Source

mkPADFunOcc :: Maybe String -> OccName -> OccName Source

mkRecFldSelOcc :: String -> OccName Source

mkTyConRepOcc :: OccName -> OccName Source

Deconstruction

occNameFS :: OccName -> FastString Source

occNameString :: OccName -> String Source

occNameSpace :: OccName -> NameSpace Source

isVarOcc :: OccName -> Bool Source

isTvOcc :: OccName -> Bool Source

isTcOcc :: OccName -> Bool Source

isDataOcc :: OccName -> Bool Source

isDataSymOcc :: OccName -> Bool Source

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

isSymOcc :: OccName -> Bool Source

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

isValOcc :: OccName -> Bool Source

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

parenSymOcc :: OccName -> SDoc -> SDoc Source

Wrap parens around an operator

startsWithUnderscore :: OccName -> Bool Source

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

isTcClsNameSpace :: NameSpace -> Bool Source

isTvNameSpace :: NameSpace -> Bool Source

isDataConNameSpace :: NameSpace -> Bool Source

isVarNameSpace :: NameSpace -> Bool Source

isValNameSpace :: NameSpace -> Bool Source

The OccEnv type

data OccEnv a Source

Instances

emptyOccEnv :: OccEnv a Source

unitOccEnv :: OccName -> a -> OccEnv a Source

extendOccEnv :: OccEnv a -> OccName -> a -> OccEnv a Source

mapOccEnv :: (a -> b) -> OccEnv a -> OccEnv b Source

lookupOccEnv :: OccEnv a -> OccName -> Maybe a Source

mkOccEnv :: [(OccName, a)] -> OccEnv a Source

mkOccEnv_C :: (a -> a -> a) -> [(OccName, a)] -> OccEnv a Source

extendOccEnvList :: OccEnv a -> [(OccName, a)] -> OccEnv a Source

elemOccEnv :: OccName -> OccEnv a -> Bool Source

occEnvElts :: OccEnv a -> [a] Source

foldOccEnv :: (a -> b -> b) -> b -> OccEnv a -> b Source

plusOccEnv :: OccEnv a -> OccEnv a -> OccEnv a Source

plusOccEnv_C :: (a -> a -> a) -> OccEnv a -> OccEnv a -> OccEnv a Source

extendOccEnv_C :: (a -> a -> a) -> OccEnv a -> OccName -> a -> OccEnv a Source

extendOccEnv_Acc :: (a -> b -> b) -> (a -> b) -> OccEnv b -> OccName -> a -> OccEnv b Source

filterOccEnv :: (elt -> Bool) -> OccEnv elt -> OccEnv elt Source

delListFromOccEnv :: OccEnv a -> [OccName] -> OccEnv a Source

delFromOccEnv :: OccEnv a -> OccName -> OccEnv a Source

alterOccEnv :: (Maybe elt -> Maybe elt) -> OccEnv elt -> OccName -> OccEnv elt Source

pprOccEnv :: (a -> SDoc) -> OccEnv a -> SDoc Source

The OccSet type

type OccSet = UniqSet OccName Source

emptyOccSet :: OccSet Source

unitOccSet :: OccName -> OccSet Source

mkOccSet :: [OccName] -> OccSet Source

extendOccSet :: OccSet -> OccName -> OccSet Source

extendOccSetList :: OccSet -> [OccName] -> OccSet Source

unionOccSets :: OccSet -> OccSet -> OccSet Source

unionManyOccSets :: [OccSet] -> OccSet Source

minusOccSet :: OccSet -> OccSet -> OccSet Source

elemOccSet :: OccName -> OccSet -> Bool Source

occSetElts :: OccSet -> [OccName] Source

foldOccSet :: (OccName -> b -> b) -> b -> OccSet -> b Source

isEmptyOccSet :: OccSet -> Bool Source

intersectOccSet :: OccSet -> OccSet -> OccSet Source

intersectsOccSet :: OccSet -> OccSet -> Bool Source

filterOccSet :: (OccName -> Bool) -> OccSet -> OccSet Source

Tidying up

type TidyOccEnv = UniqFM Int Source

emptyTidyOccEnv :: TidyOccEnv Source

tidyOccName :: TidyOccEnv -> OccName -> (TidyOccEnv, OccName) Source

initTidyOccEnv :: [OccName] -> TidyOccEnv Source

type FastStringEnv a = UniqFM a Source

emptyFsEnv :: FastStringEnv a Source

lookupFsEnv :: FastStringEnv a -> FastString -> Maybe a Source

extendFsEnv :: FastStringEnv a -> FastString -> a -> FastStringEnv a Source

mkFsEnv :: [(FastString, a)] -> FastStringEnv a Source