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 :: Text

  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

• efTypeFixities :: [ExternsTypeFixity]

  List of type operators and their fixities

• efDeclarations :: [ExternsDeclaration]

  List of type and value declaration

• efSourceSpan :: SourceSpan

  Source span for error reporting

Instances

Show ExternsFile

Methods

showsPrec :: Int -> ExternsFile -> ShowS

show :: ExternsFile -> String

showList :: [ExternsFile] -> ShowS

ToJSON ExternsFile

Methods

toJSON :: ExternsFile -> Value

toEncoding :: ExternsFile -> Encoding

toJSONList :: [ExternsFile] -> Value

toEncodingList :: [ExternsFile] -> Encoding

FromJSON ExternsFile

Methods

parseJSON :: Value -> Parser ExternsFile

parseJSONList :: Value -> Parser [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

Show ExternsImport

Methods

showsPrec :: Int -> ExternsImport -> ShowS

show :: ExternsImport -> String

showList :: [ExternsImport] -> ShowS

ToJSON ExternsImport

Methods

toJSON :: ExternsImport -> Value

toEncoding :: ExternsImport -> Encoding

toJSONList :: [ExternsImport] -> Value

toEncodingList :: [ExternsImport] -> Encoding

FromJSON ExternsImport

Methods

parseJSON :: Value -> Parser ExternsImport

parseJSONList :: Value -> Parser [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 :: OpName ValueOpName

  The operator symbol

• efAlias :: Qualified (Either Ident (ProperName ConstructorName))

  The value the operator is an alias for

Instances

Show ExternsFixity

Methods

showsPrec :: Int -> ExternsFixity -> ShowS

show :: ExternsFixity -> String

showList :: [ExternsFixity] -> ShowS

ToJSON ExternsFixity

Methods

toJSON :: ExternsFixity -> Value

toEncoding :: ExternsFixity -> Encoding

toJSONList :: [ExternsFixity] -> Value

toEncodingList :: [ExternsFixity] -> Encoding

FromJSON ExternsFixity

Methods

parseJSON :: Value -> Parser ExternsFixity

parseJSONList :: Value -> Parser [ExternsFixity]

data ExternsTypeFixity

A type fixity declaration in an externs file

Constructors

ExternsTypeFixity

Fields

• efTypeAssociativity :: Associativity

  The associativity of the operator

• efTypePrecedence :: Precedence

  The precedence level of the operator

• efTypeOperator :: OpName TypeOpName

  The operator symbol

• efTypeAlias :: Qualified (ProperName TypeName)

  The value the operator is an alias for

Instances

Show ExternsTypeFixity

Methods

showsPrec :: Int -> ExternsTypeFixity -> ShowS

show :: ExternsTypeFixity -> String

showList :: [ExternsTypeFixity] -> ShowS

ToJSON ExternsTypeFixity

Methods

toJSON :: ExternsTypeFixity -> Value

toEncoding :: ExternsTypeFixity -> Encoding

toJSONList :: [ExternsTypeFixity] -> Value

toEncodingList :: [ExternsTypeFixity] -> Encoding

FromJSON ExternsTypeFixity

Methods

parseJSON :: Value -> Parser ExternsTypeFixity

parseJSONList :: Value -> Parser [ExternsTypeFixity]

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 :: [(Text, 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 :: [(Text, Maybe Kind)]
• edClassMembers :: [(Ident, Type)]
• edClassConstraints :: [Constraint]
• edFunctionalDependencies :: [FunctionalDependency]

EDInstance

An instance declaration

Fields

• edInstanceClassName :: Qualified (ProperName ClassName)
• edInstanceName :: Ident
• edInstanceTypes :: [Type]
• edInstanceConstraints :: Maybe [Constraint]

EDKind

A kind declaration

Fields

• edKindName :: ProperName KindName

Instances

Show ExternsDeclaration

Methods

showsPrec :: Int -> ExternsDeclaration -> ShowS

show :: ExternsDeclaration -> String

showList :: [ExternsDeclaration] -> ShowS

ToJSON ExternsDeclaration

Methods

toJSON :: ExternsDeclaration -> Value

toEncoding :: ExternsDeclaration -> Encoding

toJSONList :: [ExternsDeclaration] -> Value

toEncodingList :: [ExternsDeclaration] -> Encoding

FromJSON ExternsDeclaration

Methods

parseJSON :: Value -> Parser ExternsDeclaration

parseJSONList :: Value -> Parser [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