Language.PureScript.AST.Declarations

Data types for modules and declarations

Documentation

data Module

A module declaration, consisting of comments about the module, a module name, a list of declarations, and a list of the declarations that are explicitly exported. If the export list is Nothing, everything is exported.

Constructors

Module SourceSpan [Comment] ModuleName [Declaration] (Maybe [DeclarationRef])

Instances

Read Module

Show Module

getModuleName :: Module -> ModuleName

Return a module's name.

addDefaultImport :: ModuleName -> Module -> Module

Add an import declaration for a module if it does not already explicitly import it.

data DeclarationRef

An item in a list of explicit imports or exports

Constructors

TypeRef (ProperName TypeName) (Maybe [ProperName ConstructorName])

A type constructor with data constructors

ValueRef Ident

A value

TypeClassRef (ProperName ClassName)

A type class

TypeInstanceRef Ident

A type class instance, created during typeclass desugaring (name, class name, instance types)

ModuleRef ModuleName

A module, in its entirety

ProperRef String

An unspecified ProperName ref. This will be replaced with a TypeClassRef or TypeRef during name desugaring.

PositionedDeclarationRef SourceSpan [Comment] DeclarationRef

A declaration reference with source position information

Instances

Eq DeclarationRef

Read DeclarationRef

Show DeclarationRef

ToJSON DeclarationRef

FromJSON DeclarationRef

isModuleRef :: DeclarationRef -> Bool

findDuplicateRefs :: [DeclarationRef] -> ([DeclarationRef], [ProperName ConstructorName])

Finds duplicate values in a list of declaration refs. The returned values are the duplicate refs with data constructors elided, and then a separate list of duplicate data constructors.

data ImportDeclarationType

The data type which specifies type of import declaration

Constructors

Implicit

An import with no explicit list: `import M`.

Explicit [DeclarationRef]

An import with an explicit list of references to import: `import M (foo)`

Hiding [DeclarationRef]

An import with a list of references to hide: `import M hiding (foo)`

Instances

Eq ImportDeclarationType

Read ImportDeclarationType

Show ImportDeclarationType

ToJSON ImportDeclarationType

FromJSON ImportDeclarationType

isImplicit :: ImportDeclarationType -> Bool

isExplicit :: ImportDeclarationType -> Bool

data Declaration

The data type of declarations

Constructors

DataDeclaration DataDeclType (ProperName TypeName) [(String, Maybe Kind)] [(ProperName ConstructorName, [Type])]

A data type declaration (data or newtype, name, arguments, data constructors)

DataBindingGroupDeclaration [Declaration]

A minimal mutually recursive set of data type declarations

TypeSynonymDeclaration (ProperName TypeName) [(String, Maybe Kind)] Type

A type synonym declaration (name, arguments, type)

TypeDeclaration Ident Type

A type declaration for a value (name, ty)

ValueDeclaration Ident NameKind [Binder] (Either [(Guard, Expr)] Expr)

A value declaration (name, top-level binders, optional guard, value)

BindingGroupDeclaration [(Ident, NameKind, Expr)]

A minimal mutually recursive set of value declarations

ExternDeclaration Ident Type

A foreign import declaration (name, type)

ExternDataDeclaration (ProperName TypeName) Kind

A data type foreign import (name, kind)

FixityDeclaration Fixity String (Maybe (Either (Qualified Ident) (Qualified (ProperName ConstructorName))))

A fixity declaration (fixity data, operator name, value the operator is an alias for)

ImportDeclaration ModuleName ImportDeclarationType (Maybe ModuleName) Bool

A module import (module name, qualifiedunqualifiedhiding, optional "qualified as" name) TODO: also a boolean specifying whether the old qualified syntax was used, so a warning can be raised in desugaring (remove for 0.9)

TypeClassDeclaration (ProperName ClassName) [(String, Maybe Kind)] [Constraint] [Declaration]

A type class declaration (name, argument, implies, member declarations)

TypeInstanceDeclaration Ident [Constraint] (Qualified (ProperName ClassName)) [Type] TypeInstanceBody

A type instance declaration (name, dependencies, class name, instance types, member declarations)

PositionedDeclaration SourceSpan [Comment] Declaration

A declaration with source position information

Instances

Read Declaration

Show Declaration

data TypeInstanceBody

The members of a type class instance declaration

Constructors

DerivedInstance

This is a derived instance

ExplicitInstance [Declaration]

This is a regular (explicit) instance

Instances

Read TypeInstanceBody

Show TypeInstanceBody

mapTypeInstanceBody :: ([Declaration] -> [Declaration]) -> TypeInstanceBody -> TypeInstanceBody

traverseTypeInstanceBody :: Applicative f => ([Declaration] -> f [Declaration]) -> TypeInstanceBody -> f TypeInstanceBody

A traversal for TypeInstanceBody

isValueDecl :: Declaration -> Bool

Test if a declaration is a value declaration

isDataDecl :: Declaration -> Bool

Test if a declaration is a data type or type synonym declaration

isImportDecl :: Declaration -> Bool

Test if a declaration is a module import

isExternDataDecl :: Declaration -> Bool

Test if a declaration is a data type foreign import

isFixityDecl :: Declaration -> Bool

Test if a declaration is a fixity declaration

isExternDecl :: Declaration -> Bool

Test if a declaration is a foreign import

isTypeClassInstanceDeclaration :: Declaration -> Bool

Test if a declaration is a type class instance declaration

isTypeClassDeclaration :: Declaration -> Bool

Test if a declaration is a type class declaration

flattenDecls :: [Declaration] -> [Declaration]

Recursively flatten data binding groups in the list of declarations

type Guard = Expr

A guard is just a boolean-valued expression that appears alongside a set of binders

data Expr

Data type for expressions and terms

Constructors

Literal (Literal Expr)

A literal value

UnaryMinus Expr

A prefix -, will be desugared

BinaryNoParens Expr Expr Expr

Binary operator application. During the rebracketing phase of desugaring, this data constructor will be removed.

Parens Expr

Explicit parentheses. During the rebracketing phase of desugaring, this data constructor will be removed.

Note: although it seems this constructor is not used, it _is_ useful, since it prevents certain traversals from matching.

OperatorSection Expr (Either Expr Expr)

Operator section. This will be removed during desugaring and replaced with lambda.

ObjectGetter String

An object property getter (e.g. `_.x`). This will be removed during desugaring and expanded into a lambda that reads a property from an object.

Accessor String Expr

An record property accessor expression

ObjectUpdate Expr [(String, Expr)]

Partial record update

Abs (Either Ident Binder) Expr

Function introduction

App Expr Expr

Function application

Var (Qualified Ident)

Variable

IfThenElse Expr Expr Expr

Conditional (if-then-else expression)

Constructor (Qualified (ProperName ConstructorName))

A data constructor

Case [Expr] [CaseAlternative]

A case expression. During the case expansion phase of desugaring, top-level binders will get desugared into case expressions, hence the need for guards and multiple binders per branch here.

TypedValue Bool Expr Type

A value with a type annotation

Let [Declaration] Expr

A let binding

Do [DoNotationElement]

A do-notation block

TypeClassDictionaryConstructorApp (Qualified (ProperName ClassName)) Expr

An application of a typeclass dictionary constructor. The value should be an ObjectLiteral.

TypeClassDictionary Constraint (Map (Maybe ModuleName) (Map (Qualified (ProperName ClassName)) (Map (Qualified Ident) TypeClassDictionaryInScope)))

A placeholder for a type class dictionary to be inserted later. At the end of type checking, these placeholders will be replaced with actual expressions representing type classes dictionaries which can be evaluated at runtime. The constructor arguments represent (in order): whether or not to look at superclass implementations when searching for a dictionary, the type class name and instance type, and the type class dictionaries in scope.

TypeClassDictionaryAccessor (Qualified (ProperName ClassName)) Ident

A typeclass dictionary accessor, the implementation is left unspecified until CoreFn desugaring.

SuperClassDictionary (Qualified (ProperName ClassName)) [Type]

A placeholder for a superclass dictionary to be turned into a TypeClassDictionary during typechecking

AnonymousArgument

A placeholder for an anonymous function argument

PositionedValue SourceSpan [Comment] Expr

A value with source position information

Instances

Read Expr

Show Expr

data CaseAlternative

An alternative in a case statement

Constructors

CaseAlternative

Fields

caseAlternativeBinders :: [Binder]

A collection of binders with which to match the inputs

caseAlternativeResult :: Either [(Guard, Expr)] Expr

The result expression or a collect of guarded expressions

Instances

Read CaseAlternative

Show CaseAlternative

data DoNotationElement

A statement in a do-notation block

Constructors

DoNotationValue Expr

A monadic value without a binder

DoNotationBind Binder Expr

A monadic value with a binder

DoNotationLet [Declaration]

A let statement, i.e. a pure value with a binder

PositionedDoNotationElement SourceSpan [Comment] DoNotationElement

A do notation element with source position information

Instances

Read DoNotationElement

Show DoNotationElement