Language.Haskell.Names

Core functions

computeInterfaces

Arguments

:: (MonadModule m, ModuleInfo m ~ Symbols, Data l, SrcInfo l, Ord l)

=> Language

base language

-> [Extension]

global extensions (e.g. specified on the command line)

-> [Module l]

input modules

-> m (Set (Error l))

errors in export or import lists

computeInterfaces takes a list of possibly recursive modules and computes the interface of each module. The computed interfaces are written into the m's cache and are available to further computations in this monad.

Returns the set of import/export errors. Note that the interfaces are registered in the cache regardless of whether there are any errors, but if there are errors, the interfaces may be incomplete.

getInterfaces

Arguments

:: (MonadModule m, ModuleInfo m ~ Symbols, Data l, SrcInfo l, Ord l)

=> Language

base language

-> [Extension]

global extensions (e.g. specified on the command line)

-> [Module l]

input modules

-> m ([Symbols], Set (Error l))

output modules, and errors in export or import lists

Like computeInterfaces, but also returns a list of interfaces, one per module and in the same order

annotateModule

Arguments

:: (MonadModule m, ModuleInfo m ~ Symbols, Data l, SrcInfo l, Eq l)

=> Language

base language

-> [Extension]

global extensions (e.g. specified on the command line)

-> Module l

input module

-> m (Module (Scoped l))

output (annotated) module

Annotate a module with scoping information. This assumes that all module dependencies have been resolved and cached — usually you need to run computeInterfaces first, unless you have one module in isolation.

qualifySymbols :: PackageId -> Symbols -> Symbols

Annotate all local symbols with the package name and version

Types

data SymValueInfo name

Information about a value-level entitity

Constructors

SymValue

value or function

Fields

sv_origName :: name

sv_fixity :: Maybe SymFixity

SymMethod

class method

Fields

sv_origName :: name

sv_fixity :: Maybe SymFixity

sv_className :: name

SymSelector

record field selector

Fields

sv_origName :: name

sv_fixity :: Maybe SymFixity

sv_typeName :: name

sv_constructors :: [name]

SymConstructor

data constructor

Fields

sv_origName :: name

sv_fixity :: Maybe SymFixity

sv_typeName :: name

Instances

Functor SymValueInfo

Typeable1 SymValueInfo

Foldable SymValueInfo

Traversable SymValueInfo

HasOrigName SymValueInfo

Eq name => Eq (SymValueInfo name)

Data name => Data (SymValueInfo name)

Ord name => Ord (SymValueInfo name)

Show name => Show (SymValueInfo name)

ToJSON name => ToJSON (SymValueInfo name)

FromJSON name => FromJSON (SymValueInfo name)

data SymTypeInfo name

Information about a type-level entitity

Constructors

SymType

type synonym

Fields

st_origName :: name

st_fixity :: Maybe SymFixity

SymData

data type

Fields

st_origName :: name

st_fixity :: Maybe SymFixity

SymNewType

newtype

Fields

st_origName :: name

st_fixity :: Maybe SymFixity

SymTypeFam

type family

Fields

st_origName :: name

st_fixity :: Maybe SymFixity

SymDataFam

data family

Fields

st_origName :: name

st_fixity :: Maybe SymFixity

SymClass

type class

Fields

st_origName :: name

st_fixity :: Maybe SymFixity

Instances

Functor SymTypeInfo

Typeable1 SymTypeInfo

Foldable SymTypeInfo

Traversable SymTypeInfo

HasOrigName SymTypeInfo

Eq name => Eq (SymTypeInfo name)

Data name => Data (SymTypeInfo name)

Ord name => Ord (SymTypeInfo name)

Show name => Show (SymTypeInfo name)

ToJSON name => ToJSON (SymTypeInfo name)

FromJSON name => FromJSON (SymTypeInfo name)

data Symbols

The set of symbols (entities) exported by a single module. Contains the sets of value-level and type-level entities.

Constructors

Symbols (Set (SymValueInfo OrigName)) (Set (SymTypeInfo OrigName))

Instances

Eq Symbols

Data Symbols

Ord Symbols

Show Symbols

Typeable Symbols

ToJSON Symbols

FromJSON Symbols

Monoid Symbols

data Scoped l

A pair of the name information and original annotation. Used as an annotation type for AST.

Constructors

Scoped (NameInfo l) l

Instances

Functor Scoped

Typeable1 Scoped

Foldable Scoped

Traversable Scoped

Eq l => Eq (Scoped l)

Data l => Data (Scoped l)

Ord l => Ord (Scoped l)

Show l => Show (Scoped l)

SrcInfo l => SrcInfo (Scoped l)

Typeable a => Resolvable (Scoped a)

data NameInfo l

Constructors

GlobalValue (SymValueInfo OrigName)

global value

GlobalType (SymTypeInfo OrigName)

global type

LocalValue SrcLoc

local value, and location where it is bound

TypeVar SrcLoc

type variable, and location where it is bound

ValueBinder

here the value name is bound

TypeBinder

here the type name is defined

Import Table

import declaration, and the table of symbols that it introduces

ImportPart Symbols

part of an import declaration

Export Symbols

export declaration, and the symbols it exports

RecPatWildcard [OrigName]

wildcard in a record pattern. The list contains resolved names of the fields that are brought in scope by this pattern.

RecExpWildcard [(OrigName, NameInfo l)]

wildcard in a record construction expression. The list contains resolved names of the fields and information about values assigned to those fields.

None

no annotation

ScopeError (Error l)

scope error

Instances

Functor NameInfo

Typeable1 NameInfo

Foldable NameInfo

Traversable NameInfo

Eq l => Eq (NameInfo l)

Data l => Data (NameInfo l)

Ord l => Ord (NameInfo l)

Show l => Show (NameInfo l)

type NameS = String

String representing an unqualified entity name

type ModuleNameS = String

String representing a module name

data GName

Possibly qualified name. If the name is not qualified, ModuleNameS is the empty string.

Constructors

GName

Fields

gModule :: ModuleNameS

gName :: NameS

Instances

Eq GName

Data GName

Ord GName

Show GName

Typeable GName

ppGName :: GName -> String

Display a GName

data OrigName

Qualified name, where ModuleNameS points to the module where the name was originally defined. The module part is never empty.

Also contains name and version of the package where it was defined. If it's Nothing, then the entity is defined in the "current" package.

Constructors

OrigName

Fields

origPackage :: Maybe PackageId

origGName :: GName

Instances

Eq OrigName

Data OrigName

Ord OrigName

Show OrigName

Typeable OrigName

ToJSON OrigName

FromJSON OrigName

ppOrigName :: OrigName -> String

Display an OrigName

data Error l

Constructors

ENotInScope (QName l)

name is not in scope

EAmbiguous (QName l) [OrigName]

name is ambiguous

ETypeAsClass (QName l)

type is used where a type class is expected

EClassAsType (QName l)

type class is used where a type is expected

ENotExported (Maybe (Name l)) (Name l) (ModuleName l)

Attempt to explicitly import a name which is not exported (or, possibly, does not even exist). For example:

import Prelude(Bool(Right))

The fields are:

1. optional parent in the import list, e.g. Bool in Bool(Right)
2. the name which is not exported
3. the module which does not export the name

EModNotFound (ModuleName l)

module not found

EInternal String

internal error

Instances

Functor Error

Typeable1 Error

Foldable Error

Traversable Error

Eq l => Eq (Error l)

Data l => Data (Error l)

Ord l => Ord (Error l)

Show l => Show (Error l)

ppError :: SrcInfo l => Error l -> String

Display an error.

Note: can span multiple lines; the trailing newline is included.

type SymFixity = (Assoc (), Int)

Repesents the symbol's fixity

class HasOrigName i where

Methods

origName :: i n -> n

Instances

HasOrigName SymTypeInfo

HasOrigName SymValueInfo