ghc-7.4.2: The GHC API

Safe HaskellNone




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


The NameSpace type


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.

Pretty Printing

The OccName type




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

Derived OccNames



:: Int

Index of superclass, e.g. 3

-> OccName

Class, e.g. Ord

-> OccName

Derived Occname, e.g. $p3Ord



:: Unique

Unique to combine with the OccName

-> OccName

Local name, e.g. sat

-> OccName

Nice unique version, e.g. $L23sat



:: String

Family name, e.g. Map

-> OccSet

avoid these Occs

-> OccName

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


isDataSymOcc :: OccName -> BoolSource

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

isSymOcc :: OccName -> BoolSource

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

isValOcc :: OccName -> BoolSource

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

parenSymOcc :: OccName -> SDoc -> SDocSource

Wrap parens around an operator

startsWithUnderscore :: OccName -> BoolSource

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

The OccEnv type

data OccEnv a Source


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

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

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

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

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

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

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

The OccSet type

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

Tidying up

Lexical characteristics of Haskell names