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

Methods

readsPrec :: Int -> ReadS Module

readList :: ReadS [Module]

readPrec :: ReadPrec Module

readListPrec :: ReadPrec [Module]

Show Module

Methods

showsPrec :: Int -> Module -> ShowS

show :: Module -> String

showList :: [Module] -> ShowS

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

TypeOpRef (OpName TypeOpName)

A type operator

ValueRef Ident

A value

ValueOpRef (OpName ValueOpName)

A value-level operator

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

PositionedDeclarationRef SourceSpan [Comment] DeclarationRef

A declaration reference with source position information

Instances

Eq DeclarationRef

Methods

(==) :: DeclarationRef -> DeclarationRef -> Bool

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

Read DeclarationRef

Methods

readsPrec :: Int -> ReadS DeclarationRef

readList :: ReadS [DeclarationRef]

readPrec :: ReadPrec DeclarationRef

readListPrec :: ReadPrec [DeclarationRef]

Show DeclarationRef

Methods

showsPrec :: Int -> DeclarationRef -> ShowS

show :: DeclarationRef -> String

showList :: [DeclarationRef] -> ShowS

ToJSON DeclarationRef

Methods

toJSON :: DeclarationRef -> Value

toEncoding :: DeclarationRef -> Encoding

FromJSON DeclarationRef

Methods

parseJSON :: Value -> Parser DeclarationRef

getTypeRef :: DeclarationRef -> Maybe (ProperName TypeName, Maybe [ProperName ConstructorName])

getTypeOpRef :: DeclarationRef -> Maybe (OpName TypeOpName)

getValueRef :: DeclarationRef -> Maybe Ident

getValueOpRef :: DeclarationRef -> Maybe (OpName ValueOpName)

getTypeClassRef :: DeclarationRef -> Maybe (ProperName ClassName)

isModuleRef :: DeclarationRef -> Bool

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

Methods

(==) :: ImportDeclarationType -> ImportDeclarationType -> Bool

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

Read ImportDeclarationType

Methods

readsPrec :: Int -> ReadS ImportDeclarationType

readList :: ReadS [ImportDeclarationType]

readPrec :: ReadPrec ImportDeclarationType

readListPrec :: ReadPrec [ImportDeclarationType]

Show ImportDeclarationType

Methods

showsPrec :: Int -> ImportDeclarationType -> ShowS

show :: ImportDeclarationType -> String

showList :: [ImportDeclarationType] -> ShowS

ToJSON ImportDeclarationType

Methods

toJSON :: ImportDeclarationType -> Value

toEncoding :: ImportDeclarationType -> Encoding

FromJSON ImportDeclarationType

Methods

parseJSON :: Value -> Parser 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 (Either ValueFixity TypeFixity)

A fixity declaration

ImportDeclaration ModuleName ImportDeclarationType (Maybe ModuleName)

A module import (module name, qualifiedunqualifiedhiding, optional "qualified as" name)

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

Methods

readsPrec :: Int -> ReadS Declaration

readList :: ReadS [Declaration]

readPrec :: ReadPrec Declaration

readListPrec :: ReadPrec [Declaration]

Show Declaration

Methods

showsPrec :: Int -> Declaration -> ShowS

show :: Declaration -> String

showList :: [Declaration] -> ShowS

data ValueFixity

Constructors

ValueFixity Fixity (Qualified (Either Ident (ProperName ConstructorName))) (OpName ValueOpName)

Instances

Eq ValueFixity

Methods

(==) :: ValueFixity -> ValueFixity -> Bool

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

Ord ValueFixity

Methods

compare :: ValueFixity -> ValueFixity -> Ordering

(<) :: ValueFixity -> ValueFixity -> Bool

(<=) :: ValueFixity -> ValueFixity -> Bool

(>) :: ValueFixity -> ValueFixity -> Bool

(>=) :: ValueFixity -> ValueFixity -> Bool

max :: ValueFixity -> ValueFixity -> ValueFixity

min :: ValueFixity -> ValueFixity -> ValueFixity

Read ValueFixity

Methods

readsPrec :: Int -> ReadS ValueFixity

readList :: ReadS [ValueFixity]

readPrec :: ReadPrec ValueFixity

readListPrec :: ReadPrec [ValueFixity]

Show ValueFixity

Methods

showsPrec :: Int -> ValueFixity -> ShowS

show :: ValueFixity -> String

showList :: [ValueFixity] -> ShowS

data TypeFixity

Constructors

TypeFixity Fixity (Qualified (ProperName TypeName)) (OpName TypeOpName)

Instances

Eq TypeFixity

Methods

(==) :: TypeFixity -> TypeFixity -> Bool

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

Ord TypeFixity

Methods

compare :: TypeFixity -> TypeFixity -> Ordering

(<) :: TypeFixity -> TypeFixity -> Bool

(<=) :: TypeFixity -> TypeFixity -> Bool

(>) :: TypeFixity -> TypeFixity -> Bool

(>=) :: TypeFixity -> TypeFixity -> Bool

max :: TypeFixity -> TypeFixity -> TypeFixity

min :: TypeFixity -> TypeFixity -> TypeFixity

Read TypeFixity

Methods

readsPrec :: Int -> ReadS TypeFixity

readList :: ReadS [TypeFixity]

readPrec :: ReadPrec TypeFixity

readListPrec :: ReadPrec [TypeFixity]

Show TypeFixity

Methods

showsPrec :: Int -> TypeFixity -> ShowS

show :: TypeFixity -> String

showList :: [TypeFixity] -> ShowS

pattern ValueFixityDeclaration :: Fixity -> Qualified (Either Ident (ProperName ConstructorName)) -> OpName ValueOpName -> Declaration

pattern TypeFixityDeclaration :: Fixity -> Qualified (ProperName TypeName) -> OpName TypeOpName -> 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

Methods

readsPrec :: Int -> ReadS TypeInstanceBody

readList :: ReadS [TypeInstanceBody]

readPrec :: ReadPrec TypeInstanceBody

readListPrec :: ReadPrec [TypeInstanceBody]

Show TypeInstanceBody

Methods

showsPrec :: Int -> TypeInstanceBody -> ShowS

show :: TypeInstanceBody -> String

showList :: [TypeInstanceBody] -> ShowS

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

getFixityDecl :: Declaration -> Maybe (Either ValueFixity TypeFixity)

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.

ObjectGetter String

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

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

Op (Qualified (OpName ValueOpName))

An operator. This will be desugared into a function during the "operators" phase of desugaring.

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

Hole String

A typed hole that will be turned into a hint/error duing typechecking

PositionedValue SourceSpan [Comment] Expr

A value with source position information

Instances

Read Expr

Methods

readsPrec :: Int -> ReadS Expr

readList :: ReadS [Expr]

readPrec :: ReadPrec Expr

readListPrec :: ReadPrec [Expr]

Show Expr

Methods

showsPrec :: Int -> Expr -> ShowS

show :: Expr -> String

showList :: [Expr] -> ShowS

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

Methods

readsPrec :: Int -> ReadS CaseAlternative

readList :: ReadS [CaseAlternative]

readPrec :: ReadPrec CaseAlternative

readListPrec :: ReadPrec [CaseAlternative]

Show CaseAlternative

Methods

showsPrec :: Int -> CaseAlternative -> ShowS

show :: CaseAlternative -> String

showList :: [CaseAlternative] -> ShowS

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

Methods

readsPrec :: Int -> ReadS DoNotationElement

readList :: ReadS [DoNotationElement]

readPrec :: ReadPrec DoNotationElement

readListPrec :: ReadPrec [DoNotationElement]

Show DoNotationElement

Methods

showsPrec :: Int -> DoNotationElement -> ShowS

show :: DoNotationElement -> String

showList :: [DoNotationElement] -> ShowS