Safe Haskell	None
Language	Haskell2010

Language.PureScript.Externs

Description

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

Synopsis

data ExternsFile = ExternsFile {
- efVersion :: Text
- efModuleName :: ModuleName
- efExports :: [DeclarationRef]
- efImports :: [ExternsImport]
- efFixities :: [ExternsFixity]
- efTypeFixities :: [ExternsTypeFixity]
- efDeclarations :: [ExternsDeclaration]
- efSourceSpan :: SourceSpan
}
data ExternsImport = ExternsImport {
- eiModule :: ModuleName
- eiImportType :: ImportDeclarationType
- eiImportedAs :: Maybe ModuleName
}
data ExternsFixity = ExternsFixity {
- efAssociativity :: Associativity
- efPrecedence :: Precedence
- efOperator :: OpName ValueOpName
- efAlias :: Qualified (Either Ident (ProperName ConstructorName))
}
data ExternsTypeFixity = ExternsTypeFixity {
- efTypeAssociativity :: Associativity
- efTypePrecedence :: Precedence
- efTypeOperator :: OpName TypeOpName
- efTypeAlias :: Qualified (ProperName TypeName)
}
data ExternsDeclaration
- = EDType {
  - edTypeName :: ProperName TypeName
  - edTypeKind :: SourceKind
  - edTypeDeclarationKind :: TypeKind
  }
- | EDTypeSynonym {
  - edTypeSynonymName :: ProperName TypeName
  - edTypeSynonymArguments :: [(Text, Maybe SourceKind)]
  - edTypeSynonymType :: SourceType
  }
- | EDDataConstructor {
  - edDataCtorName :: ProperName ConstructorName
  - edDataCtorOrigin :: DataDeclType
  - edDataCtorTypeCtor :: ProperName TypeName
  - edDataCtorType :: SourceType
  - edDataCtorFields :: [Ident]
  }
- | EDValue {
  - edValueName :: Ident
  - edValueType :: SourceType
  }
- | EDClass {
  - edClassName :: ProperName ClassName
  - edClassTypeArguments :: [(Text, Maybe SourceKind)]
  - edClassMembers :: [(Ident, SourceType)]
  - edClassConstraints :: [SourceConstraint]
  - edFunctionalDependencies :: [FunctionalDependency]
  }
- | EDInstance {
  - edInstanceClassName :: Qualified (ProperName ClassName)
  - edInstanceName :: Ident
  - edInstanceTypes :: [SourceType]
  - edInstanceConstraints :: Maybe [SourceConstraint]
  - edInstanceChain :: [Qualified Ident]
  - edInstanceChainIndex :: Integer
  }
- | EDKind {
  - edKindName :: ProperName KindName
  }
moduleToExternsFile :: Module -> Environment -> ExternsFile
applyExternsFileToEnvironment :: ExternsFile -> Environment -> Environment
decodeExterns :: ByteString -> Maybe ExternsFile

Documentation

data ExternsFile Source #

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 Source #
Instance details Defined in Language.PureScript.Externs Methods showsPrec :: Int -> ExternsFile -> ShowS # show :: ExternsFile -> String # showList :: [ExternsFile] -> ShowS #
ToJSON ExternsFile Source #
Instance details Defined in Language.PureScript.Externs Methods toJSON :: ExternsFile -> Value # toEncoding :: ExternsFile -> Encoding # toJSONList :: [ExternsFile] -> Value # toEncodingList :: [ExternsFile] -> Encoding #
FromJSON ExternsFile Source #
Instance details Defined in Language.PureScript.Externs Methods parseJSON :: Value -> Parser ExternsFile # parseJSONList :: Value -> Parser [ExternsFile] #

data ExternsImport Source #

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 Source #
Instance details Defined in Language.PureScript.Externs Methods showsPrec :: Int -> ExternsImport -> ShowS # show :: ExternsImport -> String # showList :: [ExternsImport] -> ShowS #
ToJSON ExternsImport Source #
Instance details Defined in Language.PureScript.Externs Methods toJSON :: ExternsImport -> Value # toEncoding :: ExternsImport -> Encoding # toJSONList :: [ExternsImport] -> Value # toEncodingList :: [ExternsImport] -> Encoding #
FromJSON ExternsImport Source #
Instance details Defined in Language.PureScript.Externs Methods parseJSON :: Value -> Parser ExternsImport # parseJSONList :: Value -> Parser [ExternsImport] #

data ExternsFixity Source #

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 Source #
Instance details Defined in Language.PureScript.Externs Methods showsPrec :: Int -> ExternsFixity -> ShowS # show :: ExternsFixity -> String # showList :: [ExternsFixity] -> ShowS #
ToJSON ExternsFixity Source #
Instance details Defined in Language.PureScript.Externs Methods toJSON :: ExternsFixity -> Value # toEncoding :: ExternsFixity -> Encoding # toJSONList :: [ExternsFixity] -> Value # toEncodingList :: [ExternsFixity] -> Encoding #
FromJSON ExternsFixity Source #
Instance details Defined in Language.PureScript.Externs Methods parseJSON :: Value -> Parser ExternsFixity # parseJSONList :: Value -> Parser [ExternsFixity] #

data ExternsTypeFixity Source #

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 Source #
Instance details Defined in Language.PureScript.Externs Methods showsPrec :: Int -> ExternsTypeFixity -> ShowS # show :: ExternsTypeFixity -> String # showList :: [ExternsTypeFixity] -> ShowS #
ToJSON ExternsTypeFixity Source #
Instance details Defined in Language.PureScript.Externs Methods toJSON :: ExternsTypeFixity -> Value # toEncoding :: ExternsTypeFixity -> Encoding # toJSONList :: [ExternsTypeFixity] -> Value # toEncodingList :: [ExternsTypeFixity] -> Encoding #
FromJSON ExternsTypeFixity Source #
Instance details Defined in Language.PureScript.Externs Methods parseJSON :: Value -> Parser ExternsTypeFixity # parseJSONList :: Value -> Parser [ExternsTypeFixity] #

data ExternsDeclaration Source #

A type or value declaration appearing in an externs file

Constructors

EDType	A type declaration
Fields edTypeName :: ProperName TypeName edTypeKind :: SourceKind edTypeDeclarationKind :: TypeKind
EDTypeSynonym	A type synonym
Fields edTypeSynonymName :: ProperName TypeName edTypeSynonymArguments :: [(Text, Maybe SourceKind)] edTypeSynonymType :: SourceType
EDDataConstructor	A data construtor
Fields edDataCtorName :: ProperName ConstructorName edDataCtorOrigin :: DataDeclType edDataCtorTypeCtor :: ProperName TypeName edDataCtorType :: SourceType edDataCtorFields :: [Ident]
EDValue	A value declaration
Fields edValueName :: Ident edValueType :: SourceType
EDClass	A type class declaration
Fields edClassName :: ProperName ClassName edClassTypeArguments :: [(Text, Maybe SourceKind)] edClassMembers :: [(Ident, SourceType)] edClassConstraints :: [SourceConstraint] edFunctionalDependencies :: [FunctionalDependency]
EDInstance	An instance declaration
Fields edInstanceClassName :: Qualified (ProperName ClassName) edInstanceName :: Ident edInstanceTypes :: [SourceType] edInstanceConstraints :: Maybe [SourceConstraint] edInstanceChain :: [Qualified Ident] edInstanceChainIndex :: Integer
EDKind	A kind declaration
Fields edKindName :: ProperName KindName

Instances

Show ExternsDeclaration Source #
Instance details Defined in Language.PureScript.Externs Methods showsPrec :: Int -> ExternsDeclaration -> ShowS # show :: ExternsDeclaration -> String # showList :: [ExternsDeclaration] -> ShowS #
ToJSON ExternsDeclaration Source #
Instance details Defined in Language.PureScript.Externs Methods toJSON :: ExternsDeclaration -> Value # toEncoding :: ExternsDeclaration -> Encoding # toJSONList :: [ExternsDeclaration] -> Value # toEncodingList :: [ExternsDeclaration] -> Encoding #
FromJSON ExternsDeclaration Source #
Instance details Defined in Language.PureScript.Externs Methods parseJSON :: Value -> Parser ExternsDeclaration # parseJSONList :: Value -> Parser [ExternsDeclaration] #

moduleToExternsFile :: Module -> Environment -> ExternsFile Source #

Generate an externs file for all declarations in a module

applyExternsFileToEnvironment :: ExternsFile -> Environment -> Environment Source #

Convert an externs file back into a module

decodeExterns :: ByteString -> Maybe ExternsFile Source #