Language.PureScript.Externs

This module generates code for "externs" files, i.e. files containing only foreign import declarations.

Documentation

data ExternsFile

The data which will be serialized to an externs file

Constructors

ExternsFile

Fields

efVersion :: String

The externs version

efModuleName :: ModuleName

Module name

efExports :: [DeclarationRef]

List of module exports

efImports :: [ExternsImport]

List of module imports

efFixities :: [ExternsFixity]

List of operators and their fixities

efDeclarations :: [ExternsDeclaration]

List of type and value declaration

Instances

Read ExternsFile

Show ExternsFile

FromJSON ExternsFile

ToJSON ExternsFile

data ExternsImport

A module import in an externs file

Constructors

ExternsImport

Fields

eiModule :: ModuleName

The imported module

eiImportType :: ImportDeclarationType

The import type: regular, qualified or hiding

eiImportedAs :: Maybe ModuleName

The imported-as name, for qualified imports

Instances

Read ExternsImport

Show ExternsImport

FromJSON ExternsImport

ToJSON ExternsImport

data ExternsFixity

A fixity declaration in an externs file

Constructors

ExternsFixity

Fields

efAssociativity :: Associativity

The associativity of the operator

efPrecedence :: Precedence

The precedence level of the operator

efOperator :: String

The operator symbol

efAlias :: Maybe (Qualified Ident)

The value the operator is an alias for

Instances

Read ExternsFixity

Show ExternsFixity

FromJSON ExternsFixity

ToJSON ExternsFixity

data ExternsDeclaration

A type or value declaration appearing in an externs file

Constructors

EDType

A type declaration

Fields

edTypeName :: ProperName TypeName

edTypeKind :: Kind

edTypeDeclarationKind :: TypeKind

EDTypeSynonym

A type synonym

Fields

edTypeSynonymName :: ProperName TypeName

edTypeSynonymArguments :: [(String, Maybe Kind)]

edTypeSynonymType :: Type

EDDataConstructor

A data construtor

Fields

edDataCtorName :: ProperName ConstructorName

edDataCtorOrigin :: DataDeclType

edDataCtorTypeCtor :: ProperName TypeName

edDataCtorType :: Type

edDataCtorFields :: [Ident]

EDValue

A value declaration

Fields

edValueName :: Ident

edValueType :: Type

EDClass

A type class declaration

Fields

edClassName :: ProperName ClassName

edClassTypeArguments :: [(String, Maybe Kind)]

edClassMembers :: [(Ident, Type)]

edClassConstraints :: [Constraint]

EDInstance

An instance declaration

Fields

edInstanceClassName :: Qualified (ProperName ClassName)

edInstanceName :: Ident

edInstanceTypes :: [Type]

edInstanceConstraints :: Maybe [Constraint]

Instances

Read ExternsDeclaration

Show ExternsDeclaration

FromJSON ExternsDeclaration

ToJSON ExternsDeclaration

moduleToExternsFile :: Module -> Environment -> ExternsFile

Generate an externs file for all declarations in a module

applyExternsFileToEnvironment :: ExternsFile -> Environment -> Environment

Convert an externs file back into a module