ghc-7.8.2: The GHC API

Safe Haskell	None
Language	Haskell98

OccName

Contents

The NameSpace type
- Construction
- Pretty Printing
The OccName type
The OccEnv type
The OccSet type
Tidying up
Lexical characteristics of Haskell names

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_types"
Name: see "Name#name_types"
Id: see "Id#name_types"
Var: see "Var#name_types"

Synopsis

The `NameSpace` type

data NameSpace Source

Instances

Eq NameSpace
Ord NameSpace
Binary NameSpace

Construction

There are two forms of data constructor:

Source data constructors: The data constructors mentioned in Haskell source code
Real data constructors: The data constructors of the representation type, which may not be the same as the source type

For example:

data T = T !(Int, Int)

The source datacon has type (Int, Int) -> T The real datacon has type Int -> Int -> T

GHC chooses a representation based on the strictness etc.

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
Data OccName
Ord OccName
OutputableBndr OccName
Outputable OccName
Uniquable OccName
Binary OccName
Typeable * 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`

mkTupleOcc :: NameSpace -> TupleSort -> Arity -> OccName Source

setOccNameSpace :: NameSpace -> OccName -> OccName Source

demoteOccName :: OccName -> Maybe OccName Source

class HasOccName name where Source

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

Methods

occName :: name -> OccName Source

Instances

HasOccName Name
HasOccName RdrName

Derived `OccName`s

isDerivedOccName :: OccName -> Bool Source

mkDataConWrapperOcc :: OccName -> OccName Source

mkWorkerOcc :: OccName -> OccName Source

mkMatcherOcc :: OccName -> OccName Source

mkDefaultMethodOcc :: OccName -> OccName Source

mkGenDefMethodOcc :: OccName -> OccName Source

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

mkGenOcc1 :: OccName -> OccName Source

mkGenOcc2 :: OccName -> OccName Source

mkGenD :: OccName -> OccName Source

mkGenR :: OccName -> OccName Source

mkGen1R :: OccName -> OccName Source

mkGenRCo :: OccName -> OccName Source

mkGenC :: OccName -> Int -> OccName Source

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

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

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

isTupleOcc_maybe :: OccName -> Maybe (NameSpace, TupleSort, Arity) Source

The `OccEnv` type

data OccEnv a Source

Instances

Outputable a => Outputable (OccEnv a)

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

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

Tidying up

type TidyOccEnv = UniqFM Int Source

emptyTidyOccEnv :: TidyOccEnv Source

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

initTidyOccEnv :: [OccName] -> TidyOccEnv Source

Lexical characteristics of Haskell names

isLexCon :: FastString -> Bool Source

isLexVar :: FastString -> Bool Source

isLexId :: FastString -> Bool Source

isLexSym :: FastString -> Bool Source

isLexConId :: FastString -> Bool Source

isLexConSym :: FastString -> Bool Source

isLexVarId :: FastString -> Bool Source

isLexVarSym :: FastString -> Bool Source

startsVarSym :: Char -> Bool Source

startsVarId :: Char -> Bool Source

startsConSym :: Char -> Bool Source

startsConId :: Char -> Bool Source