Safe Haskell	None
Language	Haskell2010

RdrName

Contents

The main type
- Construction
- Destruction
Local mapping of RdrName to Name
Global mapping of RdrName to GlobalRdrElts
GlobalRdrElts
- Global RdrName mapping elements: GlobalRdrElt, Provenance, ImportSpec

Description

GHC uses several kinds of name internally:

OccName: see OccName
RdrName is the type of names that come directly from the parser. They have not yet had their scoping and binding resolved by the renamer and can be thought of to a first approximation as an OccName with an optional module qualifier
Name: see Name
Id: see Id
Var: see Var

Synopsis

The main type

data RdrName Source

Do not use the data constructors of RdrName directly: prefer the family of functions that creates them, such as mkRdrUnqual

Note: A Located RdrName will only have API Annotations if it is a compound one, e.g.

`bar`
( ~ )

AnnKeywordId : AnnType, AnnOpen '(' or '[' or '[:', AnnClose ')' or ']' or ':]',, AnnBackquote '`', AnnVal,AnnTildehsh, AnnTilde,

Constructors

Unqual OccName	Used for ordinary, unqualified occurrences, e.g. `x`, `y` or `Foo`. Create such a `RdrName` with `mkRdrUnqual`
Qual ModuleName OccName	A qualified name written by the user in source code. The module isn't necessarily the module where the thing is defined; just the one from which it is imported. Examples are `Bar.x`, `Bar.y` or `Bar.Foo`. Create such a `RdrName` with `mkRdrQual`
Orig Module OccName	An original name; the module is the defining module. This is used when GHC generates code that will be fed into the renamer (e.g. from deriving clauses), but where we want to say "Use Prelude.map dammit". One of these can be created with `mkOrig`
Exact Name	We know exactly the `Name`. This is used: When the parser parses built-in syntax like `[]` and `(,)`, but wants a `RdrName` from it By Template Haskell, when TH has generated a unique name Such a `RdrName` can be created by using `getRdrName` on a `Name`

Instances

Eq RdrName
Data RdrName
Ord RdrName
OutputableBndr RdrName
Outputable RdrName
HasOccName RdrName
Typeable * RdrName
type PostRn RdrName ty = PlaceHolder
type PostTc RdrName ty = PlaceHolder

Construction

mkRdrUnqual :: OccName -> RdrName Source

mkRdrQual :: ModuleName -> OccName -> RdrName Source

mkUnqual :: NameSpace -> FastString -> RdrName Source

mkVarUnqual :: FastString -> RdrName Source

mkQual :: NameSpace -> (FastString, FastString) -> RdrName Source

Make a qualified RdrName in the given namespace and where the ModuleName and the OccName are taken from the first and second elements of the tuple respectively

mkOrig :: Module -> OccName -> RdrName Source

nameRdrName :: Name -> RdrName Source

getRdrName :: NamedThing thing => thing -> RdrName Source

Destruction

rdrNameOcc :: RdrName -> OccName Source

rdrNameSpace :: RdrName -> NameSpace Source

setRdrNameSpace :: RdrName -> NameSpace -> RdrName Source

This rather gruesome function is used mainly by the parser. When parsing:

data T a = T | T1 Int

we parse the data constructors as types because of parser ambiguities, so then we need to change the type constr to a data constr

The exact-name case can occur when parsing:

data [] a = [] | a : [a]

For the exact-name case we return an original name.

demoteRdrName :: RdrName -> Maybe RdrName Source

isRdrDataCon :: RdrName -> Bool Source

isRdrTyVar :: RdrName -> Bool Source

isRdrTc :: RdrName -> Bool Source

isQual :: RdrName -> Bool Source

isQual_maybe :: RdrName -> Maybe (ModuleName, OccName) Source

isUnqual :: RdrName -> Bool Source

isOrig :: RdrName -> Bool Source

isOrig_maybe :: RdrName -> Maybe (Module, OccName) Source

isExact :: RdrName -> Bool Source

isExact_maybe :: RdrName -> Maybe Name Source

isSrcRdrName :: RdrName -> Bool Source

Local mapping of `RdrName` to `Name`

data LocalRdrEnv Source

This environment is used to store local bindings (let, where, lambda, case). It is keyed by OccName, because we never use it for qualified names We keep the current mapping, *and* the set of all Names in scope Reason: see Note [Splicing Exact Names] in RnEnv

Instances

Outputable LocalRdrEnv

emptyLocalRdrEnv :: LocalRdrEnv Source

extendLocalRdrEnv :: LocalRdrEnv -> Name -> LocalRdrEnv Source

extendLocalRdrEnvList :: LocalRdrEnv -> [Name] -> LocalRdrEnv Source

lookupLocalRdrEnv :: LocalRdrEnv -> RdrName -> Maybe Name Source

lookupLocalRdrOcc :: LocalRdrEnv -> OccName -> Maybe Name Source

elemLocalRdrEnv :: RdrName -> LocalRdrEnv -> Bool Source

inLocalRdrEnvScope :: Name -> LocalRdrEnv -> Bool Source

localRdrEnvElts :: LocalRdrEnv -> [Name] Source

delLocalRdrEnvList :: LocalRdrEnv -> [OccName] -> LocalRdrEnv Source

Global mapping of `RdrName` to `GlobalRdrElt`s

type GlobalRdrEnv = OccEnv [GlobalRdrElt] Source

Keyed by OccName; when looking up a qualified name we look up the OccName part, and then check the Provenance to see if the appropriate qualification is valid. This saves routinely doubling the size of the env by adding both qualified and unqualified names to the domain.

The list in the codomain is required because there may be name clashes These only get reported on lookup, not on construction

INVARIANT: All the members of the list have distinct gre_name fields; that is, no duplicate Names

INVARIANT: Imported provenance => Name is an ExternalName However LocalDefs can have an InternalName. This happens only when type-checking a [d| ... |] Template Haskell quotation; see this note in RnNames Note [Top-level Names in Template Haskell decl quotes]

emptyGlobalRdrEnv :: GlobalRdrEnv Source

mkGlobalRdrEnv :: [GlobalRdrElt] -> GlobalRdrEnv Source

plusGlobalRdrEnv :: GlobalRdrEnv -> GlobalRdrEnv -> GlobalRdrEnv Source

lookupGlobalRdrEnv :: GlobalRdrEnv -> OccName -> [GlobalRdrElt] Source

extendGlobalRdrEnv :: Bool -> GlobalRdrEnv -> [AvailInfo] -> GlobalRdrEnv Source

pprGlobalRdrEnv :: Bool -> GlobalRdrEnv -> SDoc Source

globalRdrEnvElts :: GlobalRdrEnv -> [GlobalRdrElt] Source

lookupGRE_RdrName :: RdrName -> GlobalRdrEnv -> [GlobalRdrElt] Source

lookupGRE_Name :: GlobalRdrEnv -> Name -> [GlobalRdrElt] Source

getGRE_NameQualifier_maybes :: GlobalRdrEnv -> Name -> [Maybe [ModuleName]] Source

transformGREs :: (GlobalRdrElt -> GlobalRdrElt) -> [OccName] -> GlobalRdrEnv -> GlobalRdrEnv Source

Apply a transformation function to the GREs for these OccNames

findLocalDupsRdrEnv :: GlobalRdrEnv -> [Name] -> [[GlobalRdrElt]] Source

For each OccName, see if there are multiple local definitions for it; return a list of all such and return a list of the duplicate bindings

pickGREs :: RdrName -> [GlobalRdrElt] -> [GlobalRdrElt] Source

Take a list of GREs which have the right OccName Pick those GREs that are suitable for this RdrName And for those, keep only only the Provenances that are suitable Only used for Qual and Unqual, not Orig or Exact

Consider:

      module A ( f ) where
      import qualified Foo( f )
      import Baz( f )
      f = undefined

Let's suppose that Foo.f and Baz.f are the same entity really. The export of f is ambiguous because it's in scope from the local def and the import. The lookup of Unqual f should return a GRE for the locally-defined f, and a GRE for the imported f, with a single provenance, namely the one for Baz(f).

GlobalRdrElts

gresFromAvails :: Provenance -> [AvailInfo] -> [GlobalRdrElt] Source

make a GlobalRdrEnv where all the elements point to the same Provenance (useful for "hiding" imports, or imports with no details).

gresFromAvail :: (Name -> Provenance) -> AvailInfo -> [GlobalRdrElt] Source

Global `RdrName` mapping elements: `GlobalRdrElt`, `Provenance`, `ImportSpec`

data GlobalRdrElt Source

An element of the GlobalRdrEnv

Constructors

GRE
Fields gre_name :: Name gre_par :: Parent gre_prov :: Provenance Why it's in scope

Instances

Outputable GlobalRdrElt

isLocalGRE :: GlobalRdrElt -> Bool Source

unQualOK :: GlobalRdrElt -> Bool Source

Test if an unqualifed version of this thing would be in scope

qualSpecOK :: ModuleName -> ImportSpec -> Bool Source

Is in scope qualified with the given module?

unQualSpecOK :: ImportSpec -> Bool Source

Is in scope unqualified?

data Provenance Source

The Provenance of something says how it came to be in scope. It's quite elaborate so that we can give accurate unused-name warnings.

Constructors

LocalDef

The thing was defined locally

Imported [ImportSpec]

The thing was imported.

INVARIANT: the list of ImportSpec is non-empty

Instances

Eq Provenance
Ord Provenance

pprNameProvenance :: GlobalRdrElt -> SDoc Source

Print out the place where the name was imported

data Parent Source

The children of a Name are the things that are abbreviated by the ".." notation in export lists. See Note [Parents]

Constructors

NoParent
ParentIs Name

Instances

Eq Parent
Outputable Parent

data ImportSpec Source

Constructors

ImpSpec
Fields is_decl :: ImpDeclSpec is_item :: ImpItemSpec

Instances

Eq ImportSpec
Ord ImportSpec
Outputable ImportSpec

data ImpDeclSpec Source

Describes a particular import declaration and is shared among all the Provenances for that decl

Constructors

ImpDeclSpec
Fields is_mod :: ModuleName Module imported, e.g. `import Muggle` Note the `Muggle` may well not be the defining module for this thing! is_as :: ModuleName Import alias, e.g. from `as M` (or `Muggle` if there is no `as` clause) is_qual :: Bool Was this import qualified? is_dloc :: SrcSpan The location of the entire import declaration

Instances

Eq ImpDeclSpec
Ord ImpDeclSpec

data ImpItemSpec Source

Describes import info a particular Name

Constructors

ImpAll

The import had no import list, or had a hiding list

ImpSome

The import had an import list. The is_explicit field is True iff the thing was named explicitly in the import specs rather than being imported as part of a "..." group. Consider: