Language.PureScript.Environment

Documentation

data Environment

The Environment defines all values and types which are currently in scope:

Constructors

Environment

Fields

• names :: Map (Qualified Ident) (Type, NameKind, NameVisibility)

  Values currently in scope

• types :: Map (Qualified (ProperName TypeName)) (Kind, TypeKind)

  Type names currently in scope

• dataConstructors :: Map (Qualified (ProperName ConstructorName)) (DataDeclType, ProperName TypeName, Type, [Ident])

  Data constructors currently in scope, along with their associated type constructor name, argument types and return type.

• typeSynonyms :: Map (Qualified (ProperName TypeName)) ([(Text, Maybe Kind)], Type)

  Type synonyms currently in scope

• typeClassDictionaries :: Map (Maybe ModuleName) (Map (Qualified (ProperName ClassName)) (Map (Qualified Ident) NamedDict))

  Available type class dictionaries. When looking up Nothing in the outer map, this returns the map of type class dictionaries in local scope (ie dictionaries brought in by a constrained type).

• typeClasses :: Map (Qualified (ProperName ClassName)) TypeClassData

  Type classes

• kinds :: Set (Qualified (ProperName KindName))

  Kinds in scope

Instances

Show Environment

Methods

showsPrec :: Int -> Environment -> ShowS

show :: Environment -> String

showList :: [Environment] -> ShowS

Generic Environment

Associated Types

type Rep Environment :: * -> *

Methods

from :: Environment -> Rep Environment x

to :: Rep Environment x -> Environment

NFData Environment

Methods

rnf :: Environment -> ()

type Rep Environment

type Rep Environment = D1 * (MetaData "Environment" "Language.PureScript.Environment" "purescript-0.12.0-GnFPE64AyqYHZk4VD04uBy" False) (C1 * (MetaCons "Environment" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "names") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Map (Qualified Ident) (Type, NameKind, NameVisibility)))) ((:*:) * (S1 * (MetaSel (Just Symbol "types") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Map (Qualified (ProperName TypeName)) (Kind, TypeKind)))) (S1 * (MetaSel (Just Symbol "dataConstructors") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Map (Qualified (ProperName ConstructorName)) (DataDeclType, ProperName TypeName, Type, [Ident])))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "typeSynonyms") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Map (Qualified (ProperName TypeName)) ([(Text, Maybe Kind)], Type)))) (S1 * (MetaSel (Just Symbol "typeClassDictionaries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Map (Maybe ModuleName) (Map (Qualified (ProperName ClassName)) (Map (Qualified Ident) NamedDict)))))) ((:*:) * (S1 * (MetaSel (Just Symbol "typeClasses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Map (Qualified (ProperName ClassName)) TypeClassData))) (S1 * (MetaSel (Just Symbol "kinds") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Set (Qualified (ProperName KindName)))))))))

data TypeClassData

Information about a type class

Constructors

TypeClassData

Fields

• typeClassArguments :: [(Text, Maybe Kind)]

  A list of type argument names, and their kinds, where kind annotations were provided.

• typeClassMembers :: [(Ident, Type)]

  A list of type class members and their types. Type arguments listed above are considered bound in these types.

• typeClassSuperclasses :: [Constraint]

  A list of superclasses of this type class. Type arguments listed above are considered bound in the types appearing in these constraints.

• typeClassDependencies :: [FunctionalDependency]

  A list of functional dependencies for the type arguments of this class.

• typeClassDeterminedArguments :: Set Int

  A set of indexes of type argument that are fully determined by other arguments via functional dependencies. This can be computed from both typeClassArguments and typeClassDependencies.

• typeClassCoveringSets :: Set (Set Int)

  A sets of arguments that can be used to infer all other arguments.

Instances

Show TypeClassData

Methods

showsPrec :: Int -> TypeClassData -> ShowS

show :: TypeClassData -> String

showList :: [TypeClassData] -> ShowS

Generic TypeClassData

Associated Types

type Rep TypeClassData :: * -> *

Methods

from :: TypeClassData -> Rep TypeClassData x

to :: Rep TypeClassData x -> TypeClassData

NFData TypeClassData

Methods

rnf :: TypeClassData -> ()

type Rep TypeClassData

type Rep TypeClassData = D1 * (MetaData "TypeClassData" "Language.PureScript.Environment" "purescript-0.12.0-GnFPE64AyqYHZk4VD04uBy" False) (C1 * (MetaCons "TypeClassData" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "typeClassArguments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [(Text, Maybe Kind)])) ((:*:) * (S1 * (MetaSel (Just Symbol "typeClassMembers") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [(Ident, Type)])) (S1 * (MetaSel (Just Symbol "typeClassSuperclasses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Constraint])))) ((:*:) * (S1 * (MetaSel (Just Symbol "typeClassDependencies") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [FunctionalDependency])) ((:*:) * (S1 * (MetaSel (Just Symbol "typeClassDeterminedArguments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Set Int))) (S1 * (MetaSel (Just Symbol "typeClassCoveringSets") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Set (Set Int))))))))

data FunctionalDependency

A functional dependency indicates a relationship between two sets of type arguments in a class declaration.

Constructors

FunctionalDependency

Fields

• fdDeterminers :: [Int]

  the type arguments which determine the determined type arguments

• fdDetermined :: [Int]

  the determined type arguments

Instances

Show FunctionalDependency

Methods

showsPrec :: Int -> FunctionalDependency -> ShowS

show :: FunctionalDependency -> String

showList :: [FunctionalDependency] -> ShowS

Generic FunctionalDependency

Associated Types

type Rep FunctionalDependency :: * -> *

Methods

from :: FunctionalDependency -> Rep FunctionalDependency x

to :: Rep FunctionalDependency x -> FunctionalDependency

ToJSON FunctionalDependency

Methods

toJSON :: FunctionalDependency -> Value

toEncoding :: FunctionalDependency -> Encoding

toJSONList :: [FunctionalDependency] -> Value

toEncodingList :: [FunctionalDependency] -> Encoding

FromJSON FunctionalDependency

Methods

parseJSON :: Value -> Parser FunctionalDependency

parseJSONList :: Value -> Parser [FunctionalDependency]

NFData FunctionalDependency

Methods

rnf :: FunctionalDependency -> ()

type Rep FunctionalDependency

type Rep FunctionalDependency = D1 * (MetaData "FunctionalDependency" "Language.PureScript.Environment" "purescript-0.12.0-GnFPE64AyqYHZk4VD04uBy" False) (C1 * (MetaCons "FunctionalDependency" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "fdDeterminers") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Int])) (S1 * (MetaSel (Just Symbol "fdDetermined") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Int]))))

initEnvironment :: Environment

The initial environment with no values and only the default javascript types defined

makeTypeClassData :: [(Text, Maybe Kind)] -> [(Ident, Type)] -> [Constraint] -> [FunctionalDependency] -> TypeClassData

A constructor for TypeClassData that computes which type class arguments are fully determined and argument covering sets. Fully determined means that this argument cannot be used when selecting a type class instance. A covering set is a minimal collection of arguments that can be used to find an instance and therefore determine all other type arguments.

An example of the difference between determined and fully determined would be with the class: ```class C a b c | a -> b, b -> a, b -> c``` In this case, a must differ when b differs, and vice versa - each is determined by the other. Both a and b can be used in selecting a type class instance. However, c cannot - it is fully determined by a and b.

Define a graph of type class arguments with edges being fundep determiners to determined. Each argument also has a self looping edge. An argument is fully determined if doesn't appear at the start of a path of strongly connected components. An argument is not fully determined otherwise.

The way we compute this is by saying: an argument X is fully determined if there are arguments that determine X that X does not determine. This is the same thing: everything X determines includes everything in its SCC, and everything determining X is either before it in an SCC path, or in the same SCC.

data NameVisibility

The visibility of a name in scope

Constructors

Undefined

The name is defined in the current binding group, but is not visible

Defined

The name is defined in the another binding group, or has been made visible by a function binder

Instances

Eq NameVisibility

Methods

(==) :: NameVisibility -> NameVisibility -> Bool

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

Show NameVisibility

Methods

showsPrec :: Int -> NameVisibility -> ShowS

show :: NameVisibility -> String

showList :: [NameVisibility] -> ShowS

Generic NameVisibility

Associated Types

type Rep NameVisibility :: * -> *

Methods

from :: NameVisibility -> Rep NameVisibility x

to :: Rep NameVisibility x -> NameVisibility

NFData NameVisibility

Methods

rnf :: NameVisibility -> ()

type Rep NameVisibility

type Rep NameVisibility = D1 * (MetaData "NameVisibility" "Language.PureScript.Environment" "purescript-0.12.0-GnFPE64AyqYHZk4VD04uBy" False) ((:+:) * (C1 * (MetaCons "Undefined" PrefixI False) (U1 *)) (C1 * (MetaCons "Defined" PrefixI False) (U1 *)))

data NameKind

A flag for whether a name is for an private or public value - only public values will be included in a generated externs file.

Constructors

Private

A private value introduced as an artifact of code generation (class instances, class member accessors, etc.)

Public

A public value for a module member or foreing import declaration

External

A name for member introduced by foreign import

Instances

Eq NameKind

Methods

(==) :: NameKind -> NameKind -> Bool

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

Show NameKind

Methods

showsPrec :: Int -> NameKind -> ShowS

show :: NameKind -> String

showList :: [NameKind] -> ShowS

Generic NameKind

Associated Types

type Rep NameKind :: * -> *

Methods

from :: NameKind -> Rep NameKind x

to :: Rep NameKind x -> NameKind

NFData NameKind

Methods

rnf :: NameKind -> ()

type Rep NameKind

type Rep NameKind = D1 * (MetaData "NameKind" "Language.PureScript.Environment" "purescript-0.12.0-GnFPE64AyqYHZk4VD04uBy" False) ((:+:) * (C1 * (MetaCons "Private" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "Public" PrefixI False) (U1 *)) (C1 * (MetaCons "External" PrefixI False) (U1 *))))

data TypeKind

The kinds of a type

Constructors

DataType [(Text, Maybe Kind)] [(ProperName ConstructorName, [Type])]

Data type

TypeSynonym

Type synonym

ExternData

Foreign data

LocalTypeVariable

A local type variable

ScopedTypeVar

A scoped type variable

Instances

Eq TypeKind

Methods

(==) :: TypeKind -> TypeKind -> Bool

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

Show TypeKind

Methods

showsPrec :: Int -> TypeKind -> ShowS

show :: TypeKind -> String

showList :: [TypeKind] -> ShowS

Generic TypeKind

Associated Types

type Rep TypeKind :: * -> *

Methods

from :: TypeKind -> Rep TypeKind x

to :: Rep TypeKind x -> TypeKind

ToJSON TypeKind

Methods

toJSON :: TypeKind -> Value

toEncoding :: TypeKind -> Encoding

toJSONList :: [TypeKind] -> Value

toEncodingList :: [TypeKind] -> Encoding

FromJSON TypeKind

Methods

parseJSON :: Value -> Parser TypeKind

parseJSONList :: Value -> Parser [TypeKind]

NFData TypeKind

Methods

rnf :: TypeKind -> ()

type Rep TypeKind

type Rep TypeKind = D1 * (MetaData "TypeKind" "Language.PureScript.Environment" "purescript-0.12.0-GnFPE64AyqYHZk4VD04uBy" False) ((:+:) * ((:+:) * (C1 * (MetaCons "DataType" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [(Text, Maybe Kind)])) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [(ProperName ConstructorName, [Type])])))) (C1 * (MetaCons "TypeSynonym" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "ExternData" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "LocalTypeVariable" PrefixI False) (U1 *)) (C1 * (MetaCons "ScopedTypeVar" PrefixI False) (U1 *)))))

data DataDeclType

The type ('data' or 'newtype') of a data type declaration

Constructors

Data

A standard data constructor

Newtype

A newtype constructor

Instances

Eq DataDeclType

Methods

(==) :: DataDeclType -> DataDeclType -> Bool

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

Ord DataDeclType

Methods

compare :: DataDeclType -> DataDeclType -> Ordering

(<) :: DataDeclType -> DataDeclType -> Bool

(<=) :: DataDeclType -> DataDeclType -> Bool

(>) :: DataDeclType -> DataDeclType -> Bool

(>=) :: DataDeclType -> DataDeclType -> Bool

max :: DataDeclType -> DataDeclType -> DataDeclType

min :: DataDeclType -> DataDeclType -> DataDeclType

Show DataDeclType

Methods

showsPrec :: Int -> DataDeclType -> ShowS

show :: DataDeclType -> String

showList :: [DataDeclType] -> ShowS

Generic DataDeclType

Associated Types

type Rep DataDeclType :: * -> *

Methods

from :: DataDeclType -> Rep DataDeclType x

to :: Rep DataDeclType x -> DataDeclType

ToJSON DataDeclType

Methods

toJSON :: DataDeclType -> Value

toEncoding :: DataDeclType -> Encoding

toJSONList :: [DataDeclType] -> Value

toEncodingList :: [DataDeclType] -> Encoding

FromJSON DataDeclType

Methods

parseJSON :: Value -> Parser DataDeclType

parseJSONList :: Value -> Parser [DataDeclType]

NFData DataDeclType

Methods

rnf :: DataDeclType -> ()

type Rep DataDeclType

type Rep DataDeclType = D1 * (MetaData "DataDeclType" "Language.PureScript.Environment" "purescript-0.12.0-GnFPE64AyqYHZk4VD04uBy" False) ((:+:) * (C1 * (MetaCons "Data" PrefixI False) (U1 *)) (C1 * (MetaCons "Newtype" PrefixI False) (U1 *)))

showDataDeclType :: DataDeclType -> Text

primName :: Text -> Qualified (ProperName a)

Construct a ProperName in the Prim module

primSubName :: Text -> Text -> Qualified (ProperName a)

Construct a ProperName in the Prim.NAME module.

primKind :: Text -> Kind

primSubKind :: Text -> Text -> Kind

kindType :: Kind

Kind of ground types

kindConstraint :: Kind

(-:>) :: Kind -> Kind -> Kind infixr 4

kindSymbol :: Kind

kindDoc :: Kind

kindOrdering :: Kind

kindRowList :: Kind

primTy :: Text -> Type

Construct a type in the Prim module

tyFunction :: Type

Type constructor for functions

tyString :: Type

Type constructor for strings

tyChar :: Type

Type constructor for strings

tyNumber :: Type

Type constructor for numbers

tyInt :: Type

Type constructor for integers

tyBoolean :: Type

Type constructor for booleans

tyArray :: Type

Type constructor for arrays

tyRecord :: Type

Type constructor for records

isObject :: Type -> Bool

Check whether a type is a record

isFunction :: Type -> Bool

Check whether a type is a function

isTypeOrApplied :: Type -> Type -> Bool

function :: Type -> Type -> Type

Smart constructor for function types

primKinds :: Set (Qualified (ProperName KindName))

Kinds in Prim

primOrderingKinds :: Set (Qualified (ProperName KindName))

Kinds in Prim.Ordering

primRowListKinds :: Set (Qualified (ProperName KindName))

Kinds in Prim.RowList

primTypeErrorKinds :: Set (Qualified (ProperName KindName))

Kinds in Prim.TypeError

allPrimKinds :: Set (Qualified (ProperName KindName))

All primitive kinds

primTypes :: Map (Qualified (ProperName TypeName)) (Kind, TypeKind)

The primitive types in the external javascript environment with their associated kinds. There are also pseudo Fail, Warn, and Partial types that correspond to the classes with the same names.

allPrimTypes :: Map (Qualified (ProperName TypeName)) (Kind, TypeKind)

This Map contains all of the prim types from all Prim modules.

primOrderingTypes :: Map (Qualified (ProperName TypeName)) (Kind, TypeKind)

primRowTypes :: Map (Qualified (ProperName TypeName)) (Kind, TypeKind)

primRowListTypes :: Map (Qualified (ProperName TypeName)) (Kind, TypeKind)

primSymbolTypes :: Map (Qualified (ProperName TypeName)) (Kind, TypeKind)

primTypeErrorTypes :: Map (Qualified (ProperName TypeName)) (Kind, TypeKind)

primClasses :: Map (Qualified (ProperName ClassName)) TypeClassData

The primitive class map. This just contains the Partial class. Partial is used as a kind of magic constraint for partial functions.

allPrimClasses :: Map (Qualified (ProperName ClassName)) TypeClassData

This contains all of the type classes from all Prim modules.

primRowClasses :: Map (Qualified (ProperName ClassName)) TypeClassData

primRowListClasses :: Map (Qualified (ProperName ClassName)) TypeClassData

primSymbolClasses :: Map (Qualified (ProperName ClassName)) TypeClassData

primTypeErrorClasses :: Map (Qualified (ProperName ClassName)) TypeClassData

lookupConstructor :: Environment -> Qualified (ProperName ConstructorName) -> (DataDeclType, ProperName TypeName, Type, [Ident])

Finds information about data constructors from the current environment.

isNewtypeConstructor :: Environment -> Qualified (ProperName ConstructorName) -> Bool

Checks whether a data constructor is for a newtype.

lookupValue :: Environment -> Qualified Ident -> Maybe (Type, NameKind, NameVisibility)

Finds information about values from the current environment.