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) (SourceType, NameKind, NameVisibility)

  Values currently in scope

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

  Type names currently in scope

• dataConstructors :: Map (Qualified (ProperName ConstructorName)) (DataDeclType, ProperName TypeName, SourceType, [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 SourceKind)], SourceType)

  Type synonyms currently in scope

• typeClassDictionaries :: Map (Maybe ModuleName) (Map (Qualified (ProperName ClassName)) (Map (Qualified Ident) (NonEmpty 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

Defined in Language.PureScript.Environment

Methods

showsPrec :: Int -> Environment -> ShowS

show :: Environment -> String

showList :: [Environment] -> ShowS

Generic Environment

Defined in Language.PureScript.Environment

Associated Types

type Rep Environment :: Type -> Type

Methods

from :: Environment -> Rep Environment x

to :: Rep Environment x -> Environment

NFData Environment

Defined in Language.PureScript.Environment

Methods

rnf :: Environment -> ()

type Rep Environment

Defined in Language.PureScript.Environment

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

data TypeClassData

Information about a type class

Constructors

TypeClassData

Fields

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

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

• typeClassMembers :: [(Ident, SourceType)]

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

• typeClassSuperclasses :: [SourceConstraint]

  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

Defined in Language.PureScript.Environment

Methods

showsPrec :: Int -> TypeClassData -> ShowS

show :: TypeClassData -> String

showList :: [TypeClassData] -> ShowS

Generic TypeClassData

Defined in Language.PureScript.Environment

Associated Types

type Rep TypeClassData :: Type -> Type

Methods

from :: TypeClassData -> Rep TypeClassData x

to :: Rep TypeClassData x -> TypeClassData

NFData TypeClassData

Defined in Language.PureScript.Environment

Methods

rnf :: TypeClassData -> ()

type Rep TypeClassData

Defined in Language.PureScript.Environment

type Rep TypeClassData = D1 (MetaData "TypeClassData" "Language.PureScript.Environment" "purescript-0.13.2-3QkFEXX4DzwIft0Bgxs9Xq" False) (C1 (MetaCons "TypeClassData" PrefixI True) ((S1 (MetaSel (Just "typeClassArguments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Text, Maybe SourceKind)]) :*: (S1 (MetaSel (Just "typeClassMembers") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Ident, SourceType)]) :*: S1 (MetaSel (Just "typeClassSuperclasses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SourceConstraint]))) :*: (S1 (MetaSel (Just "typeClassDependencies") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FunctionalDependency]) :*: (S1 (MetaSel (Just "typeClassDeterminedArguments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set Int)) :*: S1 (MetaSel (Just "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

Defined in Language.PureScript.Environment

Methods

showsPrec :: Int -> FunctionalDependency -> ShowS

show :: FunctionalDependency -> String

showList :: [FunctionalDependency] -> ShowS

Generic FunctionalDependency

Defined in Language.PureScript.Environment

Associated Types

type Rep FunctionalDependency :: Type -> Type

Methods

from :: FunctionalDependency -> Rep FunctionalDependency x

to :: Rep FunctionalDependency x -> FunctionalDependency

NFData FunctionalDependency

Defined in Language.PureScript.Environment

Methods

rnf :: FunctionalDependency -> ()

ToJSON FunctionalDependency

Defined in Language.PureScript.Environment

Methods

toJSON :: FunctionalDependency -> Value

toEncoding :: FunctionalDependency -> Encoding

toJSONList :: [FunctionalDependency] -> Value

toEncodingList :: [FunctionalDependency] -> Encoding

FromJSON FunctionalDependency

Defined in Language.PureScript.Environment

Methods

parseJSON :: Value -> Parser FunctionalDependency

parseJSONList :: Value -> Parser [FunctionalDependency]

type Rep FunctionalDependency

Defined in Language.PureScript.Environment

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

initEnvironment :: Environment

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

makeTypeClassData :: [(Text, Maybe SourceKind)] -> [(Ident, SourceType)] -> [SourceConstraint] -> [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

Defined in Language.PureScript.Environment

Methods

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

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

Show NameVisibility

Defined in Language.PureScript.Environment

Methods

showsPrec :: Int -> NameVisibility -> ShowS

show :: NameVisibility -> String

showList :: [NameVisibility] -> ShowS

Generic NameVisibility

Defined in Language.PureScript.Environment

Associated Types

type Rep NameVisibility :: Type -> Type

Methods

from :: NameVisibility -> Rep NameVisibility x

to :: Rep NameVisibility x -> NameVisibility

NFData NameVisibility

Defined in Language.PureScript.Environment

Methods

rnf :: NameVisibility -> ()

type Rep NameVisibility

Defined in Language.PureScript.Environment

type Rep NameVisibility = D1 (MetaData "NameVisibility" "Language.PureScript.Environment" "purescript-0.13.2-3QkFEXX4DzwIft0Bgxs9Xq" False) (C1 (MetaCons "Undefined" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Defined" PrefixI False) (U1 :: Type -> Type))

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

Defined in Language.PureScript.Environment

Methods

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

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

Show NameKind

Defined in Language.PureScript.Environment

Methods

showsPrec :: Int -> NameKind -> ShowS

show :: NameKind -> String

showList :: [NameKind] -> ShowS

Generic NameKind

Defined in Language.PureScript.Environment

Associated Types

type Rep NameKind :: Type -> Type

Methods

from :: NameKind -> Rep NameKind x

to :: Rep NameKind x -> NameKind

NFData NameKind

Defined in Language.PureScript.Environment

Methods

rnf :: NameKind -> ()

type Rep NameKind

Defined in Language.PureScript.Environment

type Rep NameKind = D1 (MetaData "NameKind" "Language.PureScript.Environment" "purescript-0.13.2-3QkFEXX4DzwIft0Bgxs9Xq" False) (C1 (MetaCons "Private" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Public" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "External" PrefixI False) (U1 :: Type -> Type)))

data TypeKind

The kinds of a type

Constructors

DataType [(Text, Maybe SourceKind)] [(ProperName ConstructorName, [SourceType])]

Data type

TypeSynonym

Type synonym

ExternData

Foreign data

LocalTypeVariable

A local type variable

ScopedTypeVar

A scoped type variable

Instances

Eq TypeKind

Defined in Language.PureScript.Environment

Methods

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

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

Show TypeKind

Defined in Language.PureScript.Environment

Methods

showsPrec :: Int -> TypeKind -> ShowS

show :: TypeKind -> String

showList :: [TypeKind] -> ShowS

Generic TypeKind

Defined in Language.PureScript.Environment

Associated Types

type Rep TypeKind :: Type -> Type

Methods

from :: TypeKind -> Rep TypeKind x

to :: Rep TypeKind x -> TypeKind

NFData TypeKind

Defined in Language.PureScript.Environment

Methods

rnf :: TypeKind -> ()

ToJSON TypeKind

Defined in Language.PureScript.Environment

Methods

toJSON :: TypeKind -> Value

toEncoding :: TypeKind -> Encoding

toJSONList :: [TypeKind] -> Value

toEncodingList :: [TypeKind] -> Encoding

FromJSON TypeKind

Defined in Language.PureScript.Environment

Methods

parseJSON :: Value -> Parser TypeKind

parseJSONList :: Value -> Parser [TypeKind]

type Rep TypeKind

Defined in Language.PureScript.Environment

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

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

Defined in Language.PureScript.Environment

Methods

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

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

Ord DataDeclType

Defined in Language.PureScript.Environment

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

Defined in Language.PureScript.Environment

Methods

showsPrec :: Int -> DataDeclType -> ShowS

show :: DataDeclType -> String

showList :: [DataDeclType] -> ShowS

Generic DataDeclType

Defined in Language.PureScript.Environment

Associated Types

type Rep DataDeclType :: Type -> Type

Methods

from :: DataDeclType -> Rep DataDeclType x

to :: Rep DataDeclType x -> DataDeclType

NFData DataDeclType

Defined in Language.PureScript.Environment

Methods

rnf :: DataDeclType -> ()

ToJSON DataDeclType

Defined in Language.PureScript.Environment

Methods

toJSON :: DataDeclType -> Value

toEncoding :: DataDeclType -> Encoding

toJSONList :: [DataDeclType] -> Value

toEncodingList :: [DataDeclType] -> Encoding

FromJSON DataDeclType

Defined in Language.PureScript.Environment

Methods

parseJSON :: Value -> Parser DataDeclType

parseJSONList :: Value -> Parser [DataDeclType]

type Rep DataDeclType

Defined in Language.PureScript.Environment

type Rep DataDeclType = D1 (MetaData "DataDeclType" "Language.PureScript.Environment" "purescript-0.13.2-3QkFEXX4DzwIft0Bgxs9Xq" False) (C1 (MetaCons "Data" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Newtype" PrefixI False) (U1 :: Type -> Type))

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

primSubKind :: Text -> Text -> SourceKind

kindType :: SourceKind

Kind of ground types

kindConstraint :: SourceKind

isKindType :: Kind a -> Bool

(-:>) :: SourceKind -> SourceKind -> SourceKind infixr 4

kindSymbol :: SourceKind

kindDoc :: SourceKind

kindBoolean :: SourceKind

kindOrdering :: SourceKind

kindRowList :: SourceKind

kindRow :: SourceKind -> SourceKind

primTy :: Text -> SourceType

Construct a type in the Prim module

tyFunction :: SourceType

Type constructor for functions

tyString :: SourceType

Type constructor for strings

tyChar :: SourceType

Type constructor for strings

tyNumber :: SourceType

Type constructor for numbers

tyInt :: SourceType

Type constructor for integers

tyBoolean :: SourceType

Type constructor for booleans

tyArray :: SourceType

Type constructor for arrays

tyRecord :: SourceType

Type constructor for records

isObject :: Type a -> Bool

Check whether a type is a record

isFunction :: Type a -> Bool

Check whether a type is a function

isTypeOrApplied :: Type a -> Type b -> Bool

function :: SourceType -> SourceType -> SourceType

Smart constructor for function types

primKinds :: Set (Qualified (ProperName KindName))

Kinds in Prim

primBooleanKinds :: Set (Qualified (ProperName KindName))

Kinds in Prim.Boolean

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)) (SourceKind, 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)) (SourceKind, TypeKind)

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

primBooleanTypes :: Map (Qualified (ProperName TypeName)) (SourceKind, TypeKind)

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

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

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

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

primTypeErrorTypes :: Map (Qualified (ProperName TypeName)) (SourceKind, 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, SourceType, [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 (SourceType, NameKind, NameVisibility)

Finds information about values from the current environment.