Language.PureScript.AST.Declarations

Data types for modules and declarations

Documentation

type Context = [(Ident, SourceType)]

A map of locally-bound names in scope.

data TypeSearch

Holds the data necessary to do type directed search for typed holes

Constructors

TSBefore Environment

An Environment captured for later consumption by type directed search

TSAfter

Results of applying type directed search to the previously captured Environment

Fields

• tsAfterIdentifiers :: [(Qualified Text, SourceType)]

  The identifiers that fully satisfy the subsumption check

• tsAfterRecordFields :: Maybe [(Label, SourceType)]

  Record fields that are available on the first argument to the typed hole

Instances

Show TypeSearch

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> TypeSearch -> ShowS

show :: TypeSearch -> String

showList :: [TypeSearch] -> ShowS

onTypeSearchTypes :: (SourceType -> SourceType) -> TypeSearch -> TypeSearch

onTypeSearchTypesM :: Applicative m => (SourceType -> m SourceType) -> TypeSearch -> m TypeSearch

data ErrorMessageHint

Error message hints, providing more detailed information about failure.

Constructors

ErrorUnifyingTypes SourceType SourceType

ErrorInExpression Expr

ErrorInModule ModuleName

ErrorInInstance (Qualified (ProperName 'ClassName)) [SourceType]

ErrorInSubsumption SourceType SourceType

ErrorCheckingAccessor Expr PSString

ErrorCheckingType Expr SourceType

ErrorCheckingKind SourceType SourceType

ErrorCheckingGuard

ErrorInferringType Expr

ErrorInferringKind SourceType

ErrorInApplication Expr SourceType Expr

ErrorInDataConstructor (ProperName 'ConstructorName)

ErrorInTypeConstructor (ProperName 'TypeName)

ErrorInBindingGroup (NonEmpty Ident)

ErrorInDataBindingGroup [ProperName 'TypeName]

ErrorInTypeSynonym (ProperName 'TypeName)

ErrorInValueDeclaration Ident

ErrorInTypeDeclaration Ident

ErrorInTypeClassDeclaration (ProperName 'ClassName)

ErrorInKindDeclaration (ProperName 'TypeName)

ErrorInRoleDeclaration (ProperName 'TypeName)

ErrorInForeignImport Ident

ErrorSolvingConstraint SourceConstraint

MissingConstructorImportForCoercible (Qualified (ProperName 'ConstructorName))

PositionedError (NonEmpty SourceSpan)

Instances

Show ErrorMessageHint

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> ErrorMessageHint -> ShowS

show :: ErrorMessageHint -> String

showList :: [ErrorMessageHint] -> ShowS

data HintCategory

Categories of hints

Constructors

ExprHint

KindHint

CheckHint

PositionHint

SolverHint

OtherHint

Instances

Eq HintCategory

Defined in Language.PureScript.AST.Declarations

Methods

(==) :: HintCategory -> HintCategory -> Bool

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

Show HintCategory

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> HintCategory -> ShowS

show :: HintCategory -> String

showList :: [HintCategory] -> ShowS

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

Show Module

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> Module -> ShowS

show :: Module -> String

showList :: [Module] -> ShowS

getModuleName :: Module -> ModuleName

Return a module's name.

getModuleSourceSpan :: Module -> SourceSpan

Return a module's source span.

getModuleDeclarations :: Module -> [Declaration]

Return a module's declarations.

addDefaultImport :: Qualified ModuleName -> Module -> Module

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

Will not import an unqualified module if that module has already been imported qualified. (See #2197)

importPrim :: Module -> Module

Adds import declarations to a module for an implicit Prim import and Prim | qualified as Prim, as necessary.

data DeclarationRef

An item in a list of explicit imports or exports

Constructors

TypeClassRef SourceSpan (ProperName 'ClassName)

A type class

TypeOpRef SourceSpan (OpName 'TypeOpName)

A type operator

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

A type constructor with data constructors

ValueRef SourceSpan Ident

A value

ValueOpRef SourceSpan (OpName 'ValueOpName)

A value-level operator

TypeInstanceRef SourceSpan Ident

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

ModuleRef SourceSpan ModuleName

A module, in its entirety

ReExportRef SourceSpan ExportSource DeclarationRef

A value re-exported from another module. These will be inserted during elaboration in name desugaring.

Instances

Eq DeclarationRef

Defined in Language.PureScript.AST.Declarations

Methods

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

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

Ord DeclarationRef

Defined in Language.PureScript.AST.Declarations

Methods

compare :: DeclarationRef -> DeclarationRef -> Ordering

(<) :: DeclarationRef -> DeclarationRef -> Bool

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

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

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

max :: DeclarationRef -> DeclarationRef -> DeclarationRef

min :: DeclarationRef -> DeclarationRef -> DeclarationRef

Show DeclarationRef

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> DeclarationRef -> ShowS

show :: DeclarationRef -> String

showList :: [DeclarationRef] -> ShowS

Generic DeclarationRef

Defined in Language.PureScript.AST.Declarations

Associated Types

type Rep DeclarationRef :: Type -> Type

Methods

from :: DeclarationRef -> Rep DeclarationRef x

to :: Rep DeclarationRef x -> DeclarationRef

ToJSON DeclarationRef

Defined in Language.PureScript.AST.Declarations

Methods

toJSON :: DeclarationRef -> Value

toEncoding :: DeclarationRef -> Encoding

toJSONList :: [DeclarationRef] -> Value

toEncodingList :: [DeclarationRef] -> Encoding

FromJSON DeclarationRef

Defined in Language.PureScript.AST.Declarations

Methods

parseJSON :: Value -> Parser DeclarationRef

parseJSONList :: Value -> Parser [DeclarationRef]

NFData DeclarationRef

Defined in Language.PureScript.AST.Declarations

Methods

rnf :: DeclarationRef -> ()

Serialise DeclarationRef

Defined in Language.PureScript.AST.Declarations

Methods

encode :: DeclarationRef -> Encoding

decode :: Decoder s DeclarationRef

encodeList :: [DeclarationRef] -> Encoding

decodeList :: Decoder s [DeclarationRef]

type Rep DeclarationRef

Defined in Language.PureScript.AST.Declarations

type Rep DeclarationRef = D1 ('MetaData "DeclarationRef" "Language.PureScript.AST.Declarations" "purescript-ast-0.1.1.0-GLW6QEKazq2LhbbklNgI7y" 'False) (((C1 ('MetaCons "TypeClassRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceSpan) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ProperName 'ClassName))) :+: C1 ('MetaCons "TypeOpRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceSpan) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OpName 'TypeOpName)))) :+: (C1 ('MetaCons "TypeRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceSpan) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ProperName 'TypeName)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [ProperName 'ConstructorName])))) :+: C1 ('MetaCons "ValueRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceSpan) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Ident)))) :+: ((C1 ('MetaCons "ValueOpRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceSpan) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OpName 'ValueOpName))) :+: C1 ('MetaCons "TypeInstanceRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceSpan) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Ident))) :+: (C1 ('MetaCons "ModuleRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceSpan) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)) :+: C1 ('MetaCons "ReExportRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceSpan) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ExportSource) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DeclarationRef))))))

data ExportSource

Constructors

ExportSource

Fields

• exportSourceImportedFrom :: Maybe ModuleName
• exportSourceDefinedIn :: ModuleName

Instances

Eq ExportSource

Defined in Language.PureScript.AST.Declarations

Methods

(==) :: ExportSource -> ExportSource -> Bool

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

Ord ExportSource

Defined in Language.PureScript.AST.Declarations

Methods

compare :: ExportSource -> ExportSource -> Ordering

(<) :: ExportSource -> ExportSource -> Bool

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

(>) :: ExportSource -> ExportSource -> Bool

(>=) :: ExportSource -> ExportSource -> Bool

max :: ExportSource -> ExportSource -> ExportSource

min :: ExportSource -> ExportSource -> ExportSource

Show ExportSource

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> ExportSource -> ShowS

show :: ExportSource -> String

showList :: [ExportSource] -> ShowS

Generic ExportSource

Defined in Language.PureScript.AST.Declarations

Associated Types

type Rep ExportSource :: Type -> Type

Methods

from :: ExportSource -> Rep ExportSource x

to :: Rep ExportSource x -> ExportSource

ToJSON ExportSource

Defined in Language.PureScript.AST.Declarations

Methods

toJSON :: ExportSource -> Value

toEncoding :: ExportSource -> Encoding

toJSONList :: [ExportSource] -> Value

toEncodingList :: [ExportSource] -> Encoding

FromJSON ExportSource

Defined in Language.PureScript.AST.Declarations

Methods

parseJSON :: Value -> Parser ExportSource

parseJSONList :: Value -> Parser [ExportSource]

NFData ExportSource

Defined in Language.PureScript.AST.Declarations

Methods

rnf :: ExportSource -> ()

Serialise ExportSource

Defined in Language.PureScript.AST.Declarations

Methods

encode :: ExportSource -> Encoding

decode :: Decoder s ExportSource

encodeList :: [ExportSource] -> Encoding

decodeList :: Decoder s [ExportSource]

type Rep ExportSource

Defined in Language.PureScript.AST.Declarations

type Rep ExportSource = D1 ('MetaData "ExportSource" "Language.PureScript.AST.Declarations" "purescript-ast-0.1.1.0-GLW6QEKazq2LhbbklNgI7y" 'False) (C1 ('MetaCons "ExportSource" 'PrefixI 'True) (S1 ('MetaSel ('Just "exportSourceImportedFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ModuleName)) :*: S1 ('MetaSel ('Just "exportSourceDefinedIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)))

declRefSourceSpan :: DeclarationRef -> SourceSpan

declRefName :: DeclarationRef -> Name

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

Defined in Language.PureScript.AST.Declarations

Methods

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

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

Show ImportDeclarationType

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> ImportDeclarationType -> ShowS

show :: ImportDeclarationType -> String

showList :: [ImportDeclarationType] -> ShowS

Generic ImportDeclarationType

Defined in Language.PureScript.AST.Declarations

Associated Types

type Rep ImportDeclarationType :: Type -> Type

Methods

from :: ImportDeclarationType -> Rep ImportDeclarationType x

to :: Rep ImportDeclarationType x -> ImportDeclarationType

ToJSON ImportDeclarationType

Defined in Language.PureScript.AST.Declarations

Methods

toJSON :: ImportDeclarationType -> Value

toEncoding :: ImportDeclarationType -> Encoding

toJSONList :: [ImportDeclarationType] -> Value

toEncodingList :: [ImportDeclarationType] -> Encoding

FromJSON ImportDeclarationType

Defined in Language.PureScript.AST.Declarations

Methods

parseJSON :: Value -> Parser ImportDeclarationType

parseJSONList :: Value -> Parser [ImportDeclarationType]

Serialise ImportDeclarationType

Defined in Language.PureScript.AST.Declarations

Methods

encode :: ImportDeclarationType -> Encoding

decode :: Decoder s ImportDeclarationType

encodeList :: [ImportDeclarationType] -> Encoding

decodeList :: Decoder s [ImportDeclarationType]

type Rep ImportDeclarationType

Defined in Language.PureScript.AST.Declarations

type Rep ImportDeclarationType = D1 ('MetaData "ImportDeclarationType" "Language.PureScript.AST.Declarations" "purescript-ast-0.1.1.0-GLW6QEKazq2LhbbklNgI7y" 'False) (C1 ('MetaCons "Implicit" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Explicit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [DeclarationRef])) :+: C1 ('MetaCons "Hiding" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [DeclarationRef]))))

isImplicit :: ImportDeclarationType -> Bool

isExplicit :: ImportDeclarationType -> Bool

data RoleDeclarationData

A role declaration assigns a list of roles to a type constructor's parameters, e.g.:

type role T representational phantom

In this example, T is the identifier and [representational, phantom] is the list of roles (T presumably having two parameters).

Constructors

RoleDeclarationData

Fields

• rdeclSourceAnn :: !SourceAnn
• rdeclIdent :: !(ProperName 'TypeName)
• rdeclRoles :: ![Role]

Instances

Eq RoleDeclarationData

Defined in Language.PureScript.AST.Declarations

Methods

(==) :: RoleDeclarationData -> RoleDeclarationData -> Bool

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

Show RoleDeclarationData

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> RoleDeclarationData -> ShowS

show :: RoleDeclarationData -> String

showList :: [RoleDeclarationData] -> ShowS

data TypeDeclarationData

A type declaration assigns a type to an identifier, eg:

identity :: forall a. a -> a

In this example identity is the identifier and forall a. a -> a the type.

Constructors

TypeDeclarationData

Fields

• tydeclSourceAnn :: !SourceAnn
• tydeclIdent :: !Ident
• tydeclType :: !SourceType

Instances

Eq TypeDeclarationData

Defined in Language.PureScript.AST.Declarations

Methods

(==) :: TypeDeclarationData -> TypeDeclarationData -> Bool

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

Show TypeDeclarationData

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> TypeDeclarationData -> ShowS

show :: TypeDeclarationData -> String

showList :: [TypeDeclarationData] -> ShowS

overTypeDeclaration :: (TypeDeclarationData -> TypeDeclarationData) -> Declaration -> Declaration

getTypeDeclaration :: Declaration -> Maybe TypeDeclarationData

unwrapTypeDeclaration :: TypeDeclarationData -> (Ident, SourceType)

data ValueDeclarationData a

A value declaration assigns a name and potential binders, to an expression (or multiple guarded expressions).

double x = x + x

In this example double is the identifier, x is a binder and x + x is the expression.

Constructors

ValueDeclarationData

Fields

• valdeclSourceAnn :: !SourceAnn
• valdeclIdent :: !Ident

  The declared value's name

• valdeclName :: !NameKind

  Whether or not this value is exported/visible

• valdeclBinders :: ![Binder]
• valdeclExpression :: !a

Instances

Functor ValueDeclarationData

Defined in Language.PureScript.AST.Declarations

Methods

fmap :: (a -> b) -> ValueDeclarationData a -> ValueDeclarationData b

(<$) :: a -> ValueDeclarationData b -> ValueDeclarationData a

Foldable ValueDeclarationData

Defined in Language.PureScript.AST.Declarations

Methods

fold :: Monoid m => ValueDeclarationData m -> m

foldMap :: Monoid m => (a -> m) -> ValueDeclarationData a -> m

foldMap' :: Monoid m => (a -> m) -> ValueDeclarationData a -> m

foldr :: (a -> b -> b) -> b -> ValueDeclarationData a -> b

foldr' :: (a -> b -> b) -> b -> ValueDeclarationData a -> b

foldl :: (b -> a -> b) -> b -> ValueDeclarationData a -> b

foldl' :: (b -> a -> b) -> b -> ValueDeclarationData a -> b

foldr1 :: (a -> a -> a) -> ValueDeclarationData a -> a

foldl1 :: (a -> a -> a) -> ValueDeclarationData a -> a

toList :: ValueDeclarationData a -> [a]

null :: ValueDeclarationData a -> Bool

length :: ValueDeclarationData a -> Int

elem :: Eq a => a -> ValueDeclarationData a -> Bool

maximum :: Ord a => ValueDeclarationData a -> a

minimum :: Ord a => ValueDeclarationData a -> a

sum :: Num a => ValueDeclarationData a -> a

product :: Num a => ValueDeclarationData a -> a

Traversable ValueDeclarationData

Defined in Language.PureScript.AST.Declarations

Methods

traverse :: Applicative f => (a -> f b) -> ValueDeclarationData a -> f (ValueDeclarationData b)

sequenceA :: Applicative f => ValueDeclarationData (f a) -> f (ValueDeclarationData a)

mapM :: Monad m => (a -> m b) -> ValueDeclarationData a -> m (ValueDeclarationData b)

sequence :: Monad m => ValueDeclarationData (m a) -> m (ValueDeclarationData a)

Show a => Show (ValueDeclarationData a)

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> ValueDeclarationData a -> ShowS

show :: ValueDeclarationData a -> String

showList :: [ValueDeclarationData a] -> ShowS

overValueDeclaration :: (ValueDeclarationData [GuardedExpr] -> ValueDeclarationData [GuardedExpr]) -> Declaration -> Declaration

getValueDeclaration :: Declaration -> Maybe (ValueDeclarationData [GuardedExpr])

pattern ValueDecl :: SourceAnn -> Ident -> NameKind -> [Binder] -> [GuardedExpr] -> Declaration

data DataConstructorDeclaration

Constructors

DataConstructorDeclaration

Fields

• dataCtorAnn :: !SourceAnn
• dataCtorName :: !(ProperName 'ConstructorName)
• dataCtorFields :: ![(Ident, SourceType)]

Instances

Eq DataConstructorDeclaration

Defined in Language.PureScript.AST.Declarations

Methods

(==) :: DataConstructorDeclaration -> DataConstructorDeclaration -> Bool

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

Show DataConstructorDeclaration

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> DataConstructorDeclaration -> ShowS

show :: DataConstructorDeclaration -> String

showList :: [DataConstructorDeclaration] -> ShowS

mapDataCtorFields :: ([(Ident, SourceType)] -> [(Ident, SourceType)]) -> DataConstructorDeclaration -> DataConstructorDeclaration

traverseDataCtorFields :: Monad m => ([(Ident, SourceType)] -> m [(Ident, SourceType)]) -> DataConstructorDeclaration -> m DataConstructorDeclaration

data Declaration

The data type of declarations

Constructors

DataDeclaration SourceAnn DataDeclType (ProperName 'TypeName) [(Text, Maybe SourceType)] [DataConstructorDeclaration]

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

DataBindingGroupDeclaration (NonEmpty Declaration)

A minimal mutually recursive set of data type declarations

TypeSynonymDeclaration SourceAnn (ProperName 'TypeName) [(Text, Maybe SourceType)] SourceType

A type synonym declaration (name, arguments, type)

KindDeclaration SourceAnn KindSignatureFor (ProperName 'TypeName) SourceType

A kind signature declaration

RoleDeclaration !RoleDeclarationData

A role declaration (name, roles)

TypeDeclaration !TypeDeclarationData

A type declaration for a value (name, ty)

ValueDeclaration !(ValueDeclarationData [GuardedExpr])

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

BoundValueDeclaration SourceAnn Binder Expr

A declaration paired with pattern matching in let-in expression (binder, optional guard, value)

BindingGroupDeclaration (NonEmpty ((SourceAnn, Ident), NameKind, Expr))

A minimal mutually recursive set of value declarations

ExternDeclaration SourceAnn Ident SourceType

A foreign import declaration (name, type)

ExternDataDeclaration SourceAnn (ProperName 'TypeName) SourceType

A data type foreign import (name, kind)

FixityDeclaration SourceAnn (Either ValueFixity TypeFixity)

A fixity declaration

ImportDeclaration SourceAnn ModuleName ImportDeclarationType (Maybe ModuleName)

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

TypeClassDeclaration SourceAnn (ProperName 'ClassName) [(Text, Maybe SourceType)] [SourceConstraint] [FunctionalDependency] [Declaration]

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

TypeInstanceDeclaration SourceAnn [Ident] Integer Ident [SourceConstraint] (Qualified (ProperName 'ClassName)) [SourceType] TypeInstanceBody

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

Instances

Show Declaration

Defined in Language.PureScript.AST.Declarations

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

Defined in Language.PureScript.AST.Declarations

Methods

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

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

Ord ValueFixity

Defined in Language.PureScript.AST.Declarations

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

Show ValueFixity

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> ValueFixity -> ShowS

show :: ValueFixity -> String

showList :: [ValueFixity] -> ShowS

data TypeFixity

Constructors

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

Instances

Eq TypeFixity

Defined in Language.PureScript.AST.Declarations

Methods

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

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

Ord TypeFixity

Defined in Language.PureScript.AST.Declarations

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

Show TypeFixity

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> TypeFixity -> ShowS

show :: TypeFixity -> String

showList :: [TypeFixity] -> ShowS

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

pattern TypeFixityDeclaration :: SourceAnn -> Fixity -> Qualified (ProperName 'TypeName) -> OpName 'TypeOpName -> Declaration

data TypeInstanceBody

The members of a type class instance declaration

Constructors

DerivedInstance

This is a derived instance

NewtypeInstance

This is an instance derived from a newtype

NewtypeInstanceWithDictionary Expr

This is an instance derived from a newtype, desugared to include a dictionary for the type under the newtype.

ExplicitInstance [Declaration]

This is a regular (explicit) instance

Instances

Show TypeInstanceBody

Defined in Language.PureScript.AST.Declarations

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

data KindSignatureFor

What sort of declaration the kind signature applies to.

Constructors

DataSig

NewtypeSig

TypeSynonymSig

ClassSig

Instances

Eq KindSignatureFor

Defined in Language.PureScript.AST.Declarations

Methods

(==) :: KindSignatureFor -> KindSignatureFor -> Bool

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

Ord KindSignatureFor

Defined in Language.PureScript.AST.Declarations

Methods

compare :: KindSignatureFor -> KindSignatureFor -> Ordering

(<) :: KindSignatureFor -> KindSignatureFor -> Bool

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

(>) :: KindSignatureFor -> KindSignatureFor -> Bool

(>=) :: KindSignatureFor -> KindSignatureFor -> Bool

max :: KindSignatureFor -> KindSignatureFor -> KindSignatureFor

min :: KindSignatureFor -> KindSignatureFor -> KindSignatureFor

Show KindSignatureFor

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> KindSignatureFor -> ShowS

show :: KindSignatureFor -> String

showList :: [KindSignatureFor] -> ShowS

declSourceAnn :: Declaration -> SourceAnn

declSourceSpan :: Declaration -> SourceSpan

declName :: Declaration -> Maybe Name

isValueDecl :: Declaration -> Bool

Test if a declaration is a value declaration

isDataDecl :: Declaration -> Bool

Test if a declaration is a data type declaration

isTypeSynonymDecl :: Declaration -> Bool

Test if a declaration is a type synonym declaration

isImportDecl :: Declaration -> Bool

Test if a declaration is a module import

isRoleDecl :: Declaration -> Bool

Test if a declaration is a role declaration

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

isTypeClassInstanceDecl :: Declaration -> Bool

Test if a declaration is a type class instance declaration

isTypeClassDecl :: Declaration -> Bool

Test if a declaration is a type class declaration

isKindDecl :: Declaration -> Bool

Test if a declaration is a kind signature declaration.

flattenDecls :: [Declaration] -> [Declaration]

Recursively flatten data binding groups in the list of declarations

data Guard

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

Constructors

ConditionGuard Expr

PatternGuard Binder Expr

Instances

Show Guard

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> Guard -> ShowS

show :: Guard -> String

showList :: [Guard] -> ShowS

data GuardedExpr

The right hand side of a binder in value declarations and case expressions.

Constructors

GuardedExpr [Guard] Expr

Instances

Show GuardedExpr

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> GuardedExpr -> ShowS

show :: GuardedExpr -> String

showList :: [GuardedExpr] -> ShowS

pattern MkUnguarded :: Expr -> GuardedExpr

data Expr

Data type for expressions and terms

Constructors

Literal SourceSpan (Literal Expr)

A literal value

UnaryMinus SourceSpan 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.

Accessor PSString Expr

An record property accessor expression (e.g. `obj.x` or `_.x`). Anonymous arguments will be removed during desugaring and expanded into a lambda that reads a property from a record.

ObjectUpdate Expr [(PSString, Expr)]

Partial record update

ObjectUpdateNested Expr (PathTree Expr)

Object updates with nested support: `x { foo { bar = e } }` Replaced during desugaring into a Let and nested ObjectUpdates

Abs Binder Expr

Function introduction

App Expr Expr

Function application

Unused Expr

Hint that an expression is unused. This is used to ignore type class dictionaries that are necessarily empty. The inner expression lets us solve subgoals before eliminating the whole expression. The code gen will render this as undefined, regardless of what the inner expression is.

Var SourceSpan (Qualified Ident)

Variable

Op SourceSpan (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 SourceSpan (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 SourceType

A value with a type annotation

Let WhereProvenance [Declaration] Expr

A let binding

Do (Maybe ModuleName) [DoNotationElement]

A do-notation block

Ado (Maybe ModuleName) [DoNotationElement] Expr

An ado-notation block

TypeClassDictionaryConstructorApp (Qualified (ProperName 'ClassName)) Expr

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

TypeClassDictionary SourceConstraint (Map (Maybe ModuleName) (Map (Qualified (ProperName 'ClassName)) (Map (Qualified Ident) (NonEmpty NamedDict)))) [ErrorMessageHint]

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.

DeferredDictionary (Qualified (ProperName 'ClassName)) [SourceType]

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

AnonymousArgument

A placeholder for an anonymous function argument

Hole Text

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

PositionedValue SourceSpan [Comment] Expr

A value with source position information

Instances

Show Expr

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> Expr -> ShowS

show :: Expr -> String

showList :: [Expr] -> ShowS

data WhereProvenance

Metadata that tells where a let binding originated

Constructors

FromWhere

The let binding was originally a where clause

FromLet

The let binding was always a let binding

Instances

Show WhereProvenance

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> WhereProvenance -> ShowS

show :: WhereProvenance -> String

showList :: [WhereProvenance] -> 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 :: [GuardedExpr]

  The result expression or a collect of guarded expressions

Instances

Show CaseAlternative

Defined in Language.PureScript.AST.Declarations

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

Show DoNotationElement

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> DoNotationElement -> ShowS

show :: DoNotationElement -> String

showList :: [DoNotationElement] -> ShowS

newtype PathTree t

Constructors

PathTree (AssocList PSString (PathNode t))

Instances

Functor PathTree

Defined in Language.PureScript.AST.Declarations

Methods

fmap :: (a -> b) -> PathTree a -> PathTree b

(<$) :: a -> PathTree b -> PathTree a

Foldable PathTree

Defined in Language.PureScript.AST.Declarations

Methods

fold :: Monoid m => PathTree m -> m

foldMap :: Monoid m => (a -> m) -> PathTree a -> m

foldMap' :: Monoid m => (a -> m) -> PathTree a -> m

foldr :: (a -> b -> b) -> b -> PathTree a -> b

foldr' :: (a -> b -> b) -> b -> PathTree a -> b

foldl :: (b -> a -> b) -> b -> PathTree a -> b

foldl' :: (b -> a -> b) -> b -> PathTree a -> b

foldr1 :: (a -> a -> a) -> PathTree a -> a

foldl1 :: (a -> a -> a) -> PathTree a -> a

toList :: PathTree a -> [a]

null :: PathTree a -> Bool

length :: PathTree a -> Int

elem :: Eq a => a -> PathTree a -> Bool

maximum :: Ord a => PathTree a -> a

minimum :: Ord a => PathTree a -> a

sum :: Num a => PathTree a -> a

product :: Num a => PathTree a -> a

Traversable PathTree

Defined in Language.PureScript.AST.Declarations

Methods

traverse :: Applicative f => (a -> f b) -> PathTree a -> f (PathTree b)

sequenceA :: Applicative f => PathTree (f a) -> f (PathTree a)

mapM :: Monad m => (a -> m b) -> PathTree a -> m (PathTree b)

sequence :: Monad m => PathTree (m a) -> m (PathTree a)

Eq t => Eq (PathTree t)

Defined in Language.PureScript.AST.Declarations

Methods

(==) :: PathTree t -> PathTree t -> Bool

(/=) :: PathTree t -> PathTree t -> Bool

Ord t => Ord (PathTree t)

Defined in Language.PureScript.AST.Declarations

Methods

compare :: PathTree t -> PathTree t -> Ordering

(<) :: PathTree t -> PathTree t -> Bool

(<=) :: PathTree t -> PathTree t -> Bool

(>) :: PathTree t -> PathTree t -> Bool

(>=) :: PathTree t -> PathTree t -> Bool

max :: PathTree t -> PathTree t -> PathTree t

min :: PathTree t -> PathTree t -> PathTree t

Show t => Show (PathTree t)

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> PathTree t -> ShowS

show :: PathTree t -> String

showList :: [PathTree t] -> ShowS

data PathNode t

Constructors

Leaf t

Branch (PathTree t)

Instances

Functor PathNode

Defined in Language.PureScript.AST.Declarations

Methods

fmap :: (a -> b) -> PathNode a -> PathNode b

(<$) :: a -> PathNode b -> PathNode a

Foldable PathNode

Defined in Language.PureScript.AST.Declarations

Methods

fold :: Monoid m => PathNode m -> m

foldMap :: Monoid m => (a -> m) -> PathNode a -> m

foldMap' :: Monoid m => (a -> m) -> PathNode a -> m

foldr :: (a -> b -> b) -> b -> PathNode a -> b

foldr' :: (a -> b -> b) -> b -> PathNode a -> b

foldl :: (b -> a -> b) -> b -> PathNode a -> b

foldl' :: (b -> a -> b) -> b -> PathNode a -> b

foldr1 :: (a -> a -> a) -> PathNode a -> a

foldl1 :: (a -> a -> a) -> PathNode a -> a

toList :: PathNode a -> [a]

null :: PathNode a -> Bool

length :: PathNode a -> Int

elem :: Eq a => a -> PathNode a -> Bool

maximum :: Ord a => PathNode a -> a

minimum :: Ord a => PathNode a -> a

sum :: Num a => PathNode a -> a

product :: Num a => PathNode a -> a

Traversable PathNode

Defined in Language.PureScript.AST.Declarations

Methods

traverse :: Applicative f => (a -> f b) -> PathNode a -> f (PathNode b)

sequenceA :: Applicative f => PathNode (f a) -> f (PathNode a)

mapM :: Monad m => (a -> m b) -> PathNode a -> m (PathNode b)

sequence :: Monad m => PathNode (m a) -> m (PathNode a)

Eq t => Eq (PathNode t)

Defined in Language.PureScript.AST.Declarations

Methods

(==) :: PathNode t -> PathNode t -> Bool

(/=) :: PathNode t -> PathNode t -> Bool

Ord t => Ord (PathNode t)

Defined in Language.PureScript.AST.Declarations

Methods

compare :: PathNode t -> PathNode t -> Ordering

(<) :: PathNode t -> PathNode t -> Bool

(<=) :: PathNode t -> PathNode t -> Bool

(>) :: PathNode t -> PathNode t -> Bool

(>=) :: PathNode t -> PathNode t -> Bool

max :: PathNode t -> PathNode t -> PathNode t

min :: PathNode t -> PathNode t -> PathNode t

Show t => Show (PathNode t)

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> PathNode t -> ShowS

show :: PathNode t -> String

showList :: [PathNode t] -> ShowS

newtype AssocList k t

Constructors

AssocList

Fields

• runAssocList :: [(k, t)]

Instances

Functor (AssocList k)

Defined in Language.PureScript.AST.Declarations

Methods

fmap :: (a -> b) -> AssocList k a -> AssocList k b

(<$) :: a -> AssocList k b -> AssocList k a

Foldable (AssocList k)

Defined in Language.PureScript.AST.Declarations

Methods

fold :: Monoid m => AssocList k m -> m

foldMap :: Monoid m => (a -> m) -> AssocList k a -> m

foldMap' :: Monoid m => (a -> m) -> AssocList k a -> m

foldr :: (a -> b -> b) -> b -> AssocList k a -> b

foldr' :: (a -> b -> b) -> b -> AssocList k a -> b

foldl :: (b -> a -> b) -> b -> AssocList k a -> b

foldl' :: (b -> a -> b) -> b -> AssocList k a -> b

foldr1 :: (a -> a -> a) -> AssocList k a -> a

foldl1 :: (a -> a -> a) -> AssocList k a -> a

toList :: AssocList k a -> [a]

null :: AssocList k a -> Bool

length :: AssocList k a -> Int

elem :: Eq a => a -> AssocList k a -> Bool

maximum :: Ord a => AssocList k a -> a

minimum :: Ord a => AssocList k a -> a

sum :: Num a => AssocList k a -> a

product :: Num a => AssocList k a -> a

Traversable (AssocList k)

Defined in Language.PureScript.AST.Declarations

Methods

traverse :: Applicative f => (a -> f b) -> AssocList k a -> f (AssocList k b)

sequenceA :: Applicative f => AssocList k (f a) -> f (AssocList k a)

mapM :: Monad m => (a -> m b) -> AssocList k a -> m (AssocList k b)

sequence :: Monad m => AssocList k (m a) -> m (AssocList k a)

(Eq k, Eq t) => Eq (AssocList k t)

Defined in Language.PureScript.AST.Declarations

Methods

(==) :: AssocList k t -> AssocList k t -> Bool

(/=) :: AssocList k t -> AssocList k t -> Bool

(Ord k, Ord t) => Ord (AssocList k t)

Defined in Language.PureScript.AST.Declarations

Methods

compare :: AssocList k t -> AssocList k t -> Ordering

(<) :: AssocList k t -> AssocList k t -> Bool

(<=) :: AssocList k t -> AssocList k t -> Bool

(>) :: AssocList k t -> AssocList k t -> Bool

(>=) :: AssocList k t -> AssocList k t -> Bool

max :: AssocList k t -> AssocList k t -> AssocList k t

min :: AssocList k t -> AssocList k t -> AssocList k t

(Show k, Show t) => Show (AssocList k t)

Defined in Language.PureScript.AST.Declarations

Methods

showsPrec :: Int -> AssocList k t -> ShowS

show :: AssocList k t -> String

showList :: [AssocList k t] -> ShowS

isTrueExpr :: Expr -> Bool