purescript-0.15.12: PureScript Programming Language Compiler

Safe Haskell | Safe-Inferred
Language | Haskell2010

Language.PureScript.AST.Declarations

Description

Data types for modules and declarations

Synopsis

- type Context = [(Ident, SourceType)]
- data TypeSearch
  - = TSBefore Environment
  - | TSAfter {
    - tsAfterIdentifiers :: [(Qualified Text, SourceType)]
    - tsAfterRecordFields :: Maybe [(Label, SourceType)]
    }
- onTypeSearchTypes :: (SourceType -> SourceType) -> TypeSearch -> TypeSearch
- onTypeSearchTypesM :: Applicative m => (SourceType -> m SourceType) -> TypeSearch -> m TypeSearch
- data ErrorMessageHint
  - = ErrorUnifyingTypes SourceType SourceType
  - | ErrorInExpression Expr
  - | ErrorInModule ModuleName
  - | ErrorInInstance (Qualified (ProperName 'ClassName)) [SourceType]
  - | ErrorInSubsumption SourceType SourceType
  - | ErrorInRowLabel Label
  - | 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
  - | ErrorInForeignImportData (ProperName 'TypeName)
  - | ErrorSolvingConstraint SourceConstraint
  - | MissingConstructorImportForCoercible (Qualified (ProperName 'ConstructorName))
  - | PositionedError (NonEmpty SourceSpan)
  - | RelatedPositions (NonEmpty SourceSpan)
- data HintCategory
  - = ExprHint
  - | KindHint
  - | CheckHint
  - | PositionHint
  - | SolverHint
  - | DeclarationHint
  - | OtherHint
- data Module = Module SourceSpan [Comment] ModuleName [Declaration] (Maybe [DeclarationRef])
- getModuleName :: Module -> ModuleName
- getModuleSourceSpan :: Module -> SourceSpan
- getModuleDeclarations :: Module -> [Declaration]
- addDefaultImport :: Qualified ModuleName -> Module -> Module
- importPrim :: Module -> Module
- data NameSource
  - = UserNamed
  - | CompilerNamed
- data DeclarationRef
  - = TypeClassRef SourceSpan (ProperName 'ClassName)
  - | TypeOpRef SourceSpan (OpName 'TypeOpName)
  - | TypeRef SourceSpan (ProperName 'TypeName) (Maybe [ProperName 'ConstructorName])
  - | ValueRef SourceSpan Ident
  - | ValueOpRef SourceSpan (OpName 'ValueOpName)
  - | TypeInstanceRef SourceSpan Ident NameSource
  - | ModuleRef SourceSpan ModuleName
  - | ReExportRef SourceSpan ExportSource DeclarationRef
- data ExportSource = ExportSource {
  - exportSourceImportedFrom :: Maybe ModuleName
  - exportSourceDefinedIn :: 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
  - = Implicit
  - | Explicit [DeclarationRef]
  - | Hiding [DeclarationRef]
- isExplicit :: ImportDeclarationType -> Bool
- data RoleDeclarationData = RoleDeclarationData {
  - rdeclSourceAnn :: !SourceAnn
  - rdeclIdent :: !(ProperName 'TypeName)
  - rdeclRoles :: ![Role]
  }
- data TypeDeclarationData = TypeDeclarationData {
  - tydeclSourceAnn :: !SourceAnn
  - tydeclIdent :: !Ident
  - tydeclType :: !SourceType
  }
- getTypeDeclaration :: Declaration -> Maybe TypeDeclarationData
- unwrapTypeDeclaration :: TypeDeclarationData -> (Ident, SourceType)
- data ValueDeclarationData a = ValueDeclarationData {
  - valdeclSourceAnn :: !SourceAnn
  - valdeclIdent :: !Ident
  - valdeclName :: !NameKind
  - valdeclBinders :: ![Binder]
  - valdeclExpression :: !a
  }
- getValueDeclaration :: Declaration -> Maybe (ValueDeclarationData [GuardedExpr])
- pattern ValueDecl :: SourceAnn -> Ident -> NameKind -> [Binder] -> [GuardedExpr] -> Declaration
- data DataConstructorDeclaration = DataConstructorDeclaration {
  - dataCtorAnn :: !SourceAnn
  - dataCtorName :: !(ProperName 'ConstructorName)
  - dataCtorFields :: ![(Ident, SourceType)]
  }
- mapDataCtorFields :: ([(Ident, SourceType)] -> [(Ident, SourceType)]) -> DataConstructorDeclaration -> DataConstructorDeclaration
- traverseDataCtorFields :: Monad m => ([(Ident, SourceType)] -> m [(Ident, SourceType)]) -> DataConstructorDeclaration -> m DataConstructorDeclaration
- data Declaration
  - = DataDeclaration SourceAnn DataDeclType (ProperName 'TypeName) [(Text, Maybe SourceType)] [DataConstructorDeclaration]
  - | DataBindingGroupDeclaration (NonEmpty Declaration)
  - | TypeSynonymDeclaration SourceAnn (ProperName 'TypeName) [(Text, Maybe SourceType)] SourceType
  - | KindDeclaration SourceAnn KindSignatureFor (ProperName 'TypeName) SourceType
  - | RoleDeclaration !RoleDeclarationData
  - | TypeDeclaration !TypeDeclarationData
  - | ValueDeclaration !(ValueDeclarationData [GuardedExpr])
  - | BoundValueDeclaration SourceAnn Binder Expr
  - | BindingGroupDeclaration (NonEmpty ((SourceAnn, Ident), NameKind, Expr))
  - | ExternDeclaration SourceAnn Ident SourceType
  - | ExternDataDeclaration SourceAnn (ProperName 'TypeName) SourceType
  - | FixityDeclaration SourceAnn (Either ValueFixity TypeFixity)
  - | ImportDeclaration SourceAnn ModuleName ImportDeclarationType (Maybe ModuleName)
  - | TypeClassDeclaration SourceAnn (ProperName 'ClassName) [(Text, Maybe SourceType)] [SourceConstraint] [FunctionalDependency] [Declaration]
  - | TypeInstanceDeclaration SourceAnn SourceAnn ChainId Integer (Either Text Ident) [SourceConstraint] (Qualified (ProperName 'ClassName)) [SourceType] TypeInstanceBody
- data ValueFixity = ValueFixity Fixity (Qualified (Either Ident (ProperName 'ConstructorName))) (OpName 'ValueOpName)
- data TypeFixity = TypeFixity Fixity (Qualified (ProperName 'TypeName)) (OpName 'TypeOpName)
- pattern ValueFixityDeclaration :: SourceAnn -> Fixity -> Qualified (Either Ident (ProperName 'ConstructorName)) -> OpName 'ValueOpName -> Declaration
- pattern TypeFixityDeclaration :: SourceAnn -> Fixity -> Qualified (ProperName 'TypeName) -> OpName 'TypeOpName -> Declaration
- data InstanceDerivationStrategy
  - = KnownClassStrategy
  - | NewtypeStrategy
- data TypeInstanceBody
  - = DerivedInstance
  - | NewtypeInstance
  - | ExplicitInstance [Declaration]
- mapTypeInstanceBody :: ([Declaration] -> [Declaration]) -> TypeInstanceBody -> TypeInstanceBody
- traverseTypeInstanceBody :: Applicative f => ([Declaration] -> f [Declaration]) -> TypeInstanceBody -> f TypeInstanceBody
- data KindSignatureFor
  - = DataSig
  - | NewtypeSig
  - | TypeSynonymSig
  - | ClassSig
- declSourceAnn :: Declaration -> SourceAnn
- declSourceSpan :: Declaration -> SourceSpan
- declName :: Declaration -> Maybe Name
- isValueDecl :: Declaration -> Bool
- isDataDecl :: Declaration -> Bool
- isTypeSynonymDecl :: Declaration -> Bool
- isImportDecl :: Declaration -> Bool
- isRoleDecl :: Declaration -> Bool
- isExternDataDecl :: Declaration -> Bool
- isFixityDecl :: Declaration -> Bool
- getFixityDecl :: Declaration -> Maybe (Either ValueFixity TypeFixity)
- isExternDecl :: Declaration -> Bool
- isTypeClassInstanceDecl :: Declaration -> Bool
- isTypeClassDecl :: Declaration -> Bool
- isKindDecl :: Declaration -> Bool
- flattenDecls :: [Declaration] -> [Declaration]
- data Guard
  - = ConditionGuard Expr
  - | PatternGuard Binder Expr
- data GuardedExpr = GuardedExpr [Guard] Expr
- pattern MkUnguarded :: Expr -> GuardedExpr
- data Expr
  - = Literal SourceSpan (Literal Expr)
  - | UnaryMinus SourceSpan Expr
  - | BinaryNoParens Expr Expr Expr
  - | Parens Expr
  - | Accessor PSString Expr
  - | ObjectUpdate Expr [(PSString, Expr)]
  - | ObjectUpdateNested Expr (PathTree Expr)
  - | Abs Binder Expr
  - | App Expr Expr
  - | VisibleTypeApp Expr SourceType
  - | Unused Expr
  - | Var SourceSpan (Qualified Ident)
  - | Op SourceSpan (Qualified (OpName 'ValueOpName))
  - | IfThenElse Expr Expr Expr
  - | Constructor SourceSpan (Qualified (ProperName 'ConstructorName))
  - | Case [Expr] [CaseAlternative]
  - | TypedValue Bool Expr SourceType
  - | Let WhereProvenance [Declaration] Expr
  - | Do (Maybe ModuleName) [DoNotationElement]
  - | Ado (Maybe ModuleName) [DoNotationElement] Expr
  - | TypeClassDictionary SourceConstraint (Map QualifiedBy (Map (Qualified (ProperName 'ClassName)) (Map (Qualified Ident) (NonEmpty NamedDict)))) [ErrorMessageHint]
  - | DeferredDictionary (Qualified (ProperName 'ClassName)) [SourceType]
  - | DerivedInstancePlaceholder (Qualified (ProperName 'ClassName)) InstanceDerivationStrategy
  - | AnonymousArgument
  - | Hole Text
  - | PositionedValue SourceSpan [Comment] Expr
- data WhereProvenance
  - = FromWhere
  - | FromLet
- data CaseAlternative = CaseAlternative {
  - caseAlternativeBinders :: [Binder]
  - caseAlternativeResult :: [GuardedExpr]
  }
- data DoNotationElement
  - = DoNotationValue Expr
  - | DoNotationBind Binder Expr
  - | DoNotationLet [Declaration]
  - | PositionedDoNotationElement SourceSpan [Comment] DoNotationElement
- newtype PathTree t = PathTree (AssocList PSString (PathNode t))
- data PathNode t
  - = Leaf t
  - | Branch (PathTree t)
- newtype AssocList k t = AssocList {
  - runAssocList :: [(k, t)]
  }
- isTrueExpr :: Expr -> Bool
- isAnonymousArgument :: Expr -> Bool

# 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

Instances details

Show TypeSearch # |
Instance details 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 |
ErrorInRowLabel Label |
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 |
ErrorInForeignImportData (ProperName 'TypeName) |
ErrorSolvingConstraint SourceConstraint |
MissingConstructorImportForCoercible (Qualified (ProperName 'ConstructorName)) |
PositionedError (NonEmpty SourceSpan) |
RelatedPositions (NonEmpty SourceSpan) |

#### Instances

Instances details

Show ErrorMessageHint # |
Instance details 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 |
DeclarationHint |
OtherHint |

#### Instances

Instances details

Show HintCategory # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> HintCategory -> ShowS # show :: HintCategory -> String # showList :: [HintCategory] -> ShowS #
Eq HintCategory # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: HintCategory -> HintCategory -> Bool # (/=) :: HintCategory -> HintCategory -> Bool #

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

Instances details

Show Module # |
Instance details 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 NameSource #

Constructors

UserNamed |
CompilerNamed |

#### Instances

Instances details

FromJSON NameSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods parseJSON :: Value -> Parser NameSource # parseJSONList :: Value -> Parser [NameSource] # omittedField :: Maybe NameSource #
ToJSON NameSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods toJSON :: NameSource -> Value # toEncoding :: NameSource -> Encoding # toJSONList :: [NameSource] -> Value # toEncodingList :: [NameSource] -> Encoding # omitField :: NameSource -> Bool #
Generic NameSource # |
Instance details Defined in Language.PureScript.AST.Declarations Associated Types type Rep NameSource :: Type -> Type # Methods from :: NameSource -> Rep NameSource x # to :: Rep NameSource x -> NameSource #
Show NameSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> NameSource -> ShowS # show :: NameSource -> String # showList :: [NameSource] -> ShowS #
NFData NameSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods rnf :: NameSource -> () #
Serialise NameSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods encode :: NameSource -> Encoding # decode :: Decoder s NameSource # encodeList :: [NameSource] -> Encoding # decodeList :: Decoder s [NameSource] #
type Rep NameSource # |
Instance details Defined in Language.PureScript.AST.Declarations type Rep NameSource = D1 ('MetaData "NameSource" "Language.PureScript.AST.Declarations" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "UserNamed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CompilerNamed" 'PrefixI 'False) (U1 :: Type -> Type))

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 NameSource | A type class instance, created during typeclass desugaring
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

Instances details

FromJSON DeclarationRef # |
Instance details Defined in Language.PureScript.AST.Declarations Methods parseJSON :: Value -> Parser DeclarationRef # parseJSONList :: Value -> Parser [DeclarationRef] # omittedField :: Maybe DeclarationRef #
ToJSON DeclarationRef # |
Instance details Defined in Language.PureScript.AST.Declarations Methods toJSON :: DeclarationRef -> Value # toEncoding :: DeclarationRef -> Encoding # toJSONList :: [DeclarationRef] -> Value # toEncodingList :: [DeclarationRef] -> Encoding # omitField :: DeclarationRef -> Bool #
Generic DeclarationRef # |
Instance details Defined in Language.PureScript.AST.Declarations Associated Types type Rep DeclarationRef :: Type -> Type # Methods from :: DeclarationRef -> Rep DeclarationRef x # to :: Rep DeclarationRef x -> DeclarationRef #
Show DeclarationRef # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> DeclarationRef -> ShowS # show :: DeclarationRef -> String # showList :: [DeclarationRef] -> ShowS #
NFData DeclarationRef # |
Instance details Defined in Language.PureScript.AST.Declarations Methods rnf :: DeclarationRef -> () #
Eq DeclarationRef # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: DeclarationRef -> DeclarationRef -> Bool # (/=) :: DeclarationRef -> DeclarationRef -> Bool #
Ord DeclarationRef # |
Instance details 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 #
Serialise DeclarationRef # |
Instance details Defined in Language.PureScript.AST.Declarations Methods encode :: DeclarationRef -> Encoding # decode :: Decoder s DeclarationRef # encodeList :: [DeclarationRef] -> Encoding # decodeList :: Decoder s [DeclarationRef] #
type Rep DeclarationRef # |
Instance details Defined in Language.PureScript.AST.Declarations type Rep DeclarationRef = D1 ('MetaData "DeclarationRef" "Language.PureScript.AST.Declarations" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" '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) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NameSource)))) :+: (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

Instances details

FromJSON ExportSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods parseJSON :: Value -> Parser ExportSource # parseJSONList :: Value -> Parser [ExportSource] # omittedField :: Maybe ExportSource #
ToJSON ExportSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods toJSON :: ExportSource -> Value # toEncoding :: ExportSource -> Encoding # toJSONList :: [ExportSource] -> Value # toEncodingList :: [ExportSource] -> Encoding # omitField :: ExportSource -> Bool #
Generic ExportSource # |
Instance details Defined in Language.PureScript.AST.Declarations Associated Types type Rep ExportSource :: Type -> Type # Methods from :: ExportSource -> Rep ExportSource x # to :: Rep ExportSource x -> ExportSource #
Show ExportSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> ExportSource -> ShowS # show :: ExportSource -> String # showList :: [ExportSource] -> ShowS #
NFData ExportSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods rnf :: ExportSource -> () #
Eq ExportSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: ExportSource -> ExportSource -> Bool # (/=) :: ExportSource -> ExportSource -> Bool #
Ord ExportSource # |
Instance details 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 #
Serialise ExportSource # |
Instance details Defined in Language.PureScript.AST.Declarations Methods encode :: ExportSource -> Encoding # decode :: Decoder s ExportSource # encodeList :: [ExportSource] -> Encoding # decodeList :: Decoder s [ExportSource] #
type Rep ExportSource # |
Instance details Defined in Language.PureScript.AST.Declarations type Rep ExportSource = D1 ('MetaData "ExportSource" "Language.PureScript.AST.Declarations" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" '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

Instances details

FromJSON ImportDeclarationType # |
Instance details Defined in Language.PureScript.AST.Declarations Methods parseJSON :: Value -> Parser ImportDeclarationType # parseJSONList :: Value -> Parser [ImportDeclarationType] # omittedField :: Maybe ImportDeclarationType #
ToJSON ImportDeclarationType # |
Instance details Defined in Language.PureScript.AST.Declarations Methods toJSON :: ImportDeclarationType -> Value # toEncoding :: ImportDeclarationType -> Encoding # toJSONList :: [ImportDeclarationType] -> Value # toEncodingList :: [ImportDeclarationType] -> Encoding # omitField :: ImportDeclarationType -> Bool #
Generic ImportDeclarationType # |
Instance details Defined in Language.PureScript.AST.Declarations Associated Types type Rep ImportDeclarationType :: Type -> Type # Methods from :: ImportDeclarationType -> Rep ImportDeclarationType x # to :: Rep ImportDeclarationType x -> ImportDeclarationType #
Show ImportDeclarationType # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> ImportDeclarationType -> ShowS # show :: ImportDeclarationType -> String # showList :: [ImportDeclarationType] -> ShowS #
Eq ImportDeclarationType # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: ImportDeclarationType -> ImportDeclarationType -> Bool # (/=) :: ImportDeclarationType -> ImportDeclarationType -> Bool #
Serialise ImportDeclarationType # |
Instance details Defined in Language.PureScript.AST.Declarations Methods encode :: ImportDeclarationType -> Encoding # decode :: Decoder s ImportDeclarationType # encodeList :: [ImportDeclarationType] -> Encoding # decodeList :: Decoder s [ImportDeclarationType] #
type Rep ImportDeclarationType # |
Instance details Defined in Language.PureScript.AST.Declarations type Rep ImportDeclarationType = D1 ('MetaData "ImportDeclarationType" "Language.PureScript.AST.Declarations" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" '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]))))

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

Instances details

Show RoleDeclarationData # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> RoleDeclarationData -> ShowS # show :: RoleDeclarationData -> String # showList :: [RoleDeclarationData] -> ShowS #
Eq RoleDeclarationData # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: RoleDeclarationData -> RoleDeclarationData -> Bool # (/=) :: RoleDeclarationData -> RoleDeclarationData -> Bool #

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

Instances details

Show TypeDeclarationData # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> TypeDeclarationData -> ShowS # show :: TypeDeclarationData -> String # showList :: [TypeDeclarationData] -> ShowS #
Eq TypeDeclarationData # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: TypeDeclarationData -> TypeDeclarationData -> Bool # (/=) :: TypeDeclarationData -> TypeDeclarationData -> Bool #

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

Instances details

Foldable ValueDeclarationData # |
Instance details 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 # |
Instance details 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)
Functor ValueDeclarationData # |
Instance details Defined in Language.PureScript.AST.Declarations Methods fmap :: (a -> b) -> ValueDeclarationData a -> ValueDeclarationData b # (<$) :: a -> ValueDeclarationData b -> ValueDeclarationData a #
Show a => Show (ValueDeclarationData a) # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> ValueDeclarationData a -> ShowS # show :: ValueDeclarationData a -> String # showList :: [ValueDeclarationData a] -> ShowS #

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

Instances details

Show DataConstructorDeclaration # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> DataConstructorDeclaration -> ShowS # show :: DataConstructorDeclaration -> String # showList :: [DataConstructorDeclaration] -> ShowS #
Eq DataConstructorDeclaration # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: DataConstructorDeclaration -> DataConstructorDeclaration -> Bool # (/=) :: DataConstructorDeclaration -> DataConstructorDeclaration -> Bool #

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 SourceAnn ChainId Integer (Either Text Ident) [SourceConstraint] (Qualified (ProperName 'ClassName)) [SourceType] TypeInstanceBody | A type instance declaration (instance chain, chain index, name, dependencies, class name, instance types, member declarations) The first `SourceAnn` serves as the annotation for the entire declaration, while the second `SourceAnn` serves as the annotation for the type class and its arguments.

#### Instances

Instances details

Show Declaration # |
Instance details 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

Instances details

Show ValueFixity # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> ValueFixity -> ShowS # show :: ValueFixity -> String # showList :: [ValueFixity] -> ShowS #
Eq ValueFixity # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: ValueFixity -> ValueFixity -> Bool # (/=) :: ValueFixity -> ValueFixity -> Bool #
Ord ValueFixity # |
Instance details 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 #

data TypeFixity #

Constructors

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

#### Instances

Instances details

Show TypeFixity # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> TypeFixity -> ShowS # show :: TypeFixity -> String # showList :: [TypeFixity] -> ShowS #
Eq TypeFixity # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: TypeFixity -> TypeFixity -> Bool # (/=) :: TypeFixity -> TypeFixity -> Bool #
Ord TypeFixity # |
Instance details 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 #

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

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

data InstanceDerivationStrategy #

Constructors

KnownClassStrategy |
NewtypeStrategy |

#### Instances

Instances details

Show InstanceDerivationStrategy # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> InstanceDerivationStrategy -> ShowS # show :: InstanceDerivationStrategy -> String # showList :: [InstanceDerivationStrategy] -> ShowS #

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
ExplicitInstance [Declaration] | This is a regular (explicit) instance

#### Instances

Instances details

Show TypeInstanceBody # |
Instance details 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

Instances details

Generic KindSignatureFor # |
Instance details Defined in Language.PureScript.AST.Declarations Associated Types type Rep KindSignatureFor :: Type -> Type # Methods from :: KindSignatureFor -> Rep KindSignatureFor x # to :: Rep KindSignatureFor x -> KindSignatureFor #
Show KindSignatureFor # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> KindSignatureFor -> ShowS # show :: KindSignatureFor -> String # showList :: [KindSignatureFor] -> ShowS #
NFData KindSignatureFor # |
Instance details Defined in Language.PureScript.AST.Declarations Methods rnf :: KindSignatureFor -> () #
Eq KindSignatureFor # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: KindSignatureFor -> KindSignatureFor -> Bool # (/=) :: KindSignatureFor -> KindSignatureFor -> Bool #
Ord KindSignatureFor # |
Instance details 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 #
type Rep KindSignatureFor # |
Instance details Defined in Language.PureScript.AST.Declarations type Rep KindSignatureFor = D1 ('MetaData "KindSignatureFor" "Language.PureScript.AST.Declarations" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) ((C1 ('MetaCons "DataSig" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NewtypeSig" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "TypeSynonymSig" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ClassSig" 'PrefixI 'False) (U1 :: Type -> Type)))

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

Instances details

Show Guard # |
Instance details 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

Instances details

Show GuardedExpr # |
Instance details 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 `ObjectUpdate`s
Abs Binder Expr | Function introduction
App Expr Expr | Function application
VisibleTypeApp Expr SourceType | A type application (e.g. `f @Int`)
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
TypeClassDictionary SourceConstraint (Map QualifiedBy (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.
DeferredDictionary (Qualified (ProperName 'ClassName)) [SourceType] | A placeholder for a superclass dictionary to be turned into a TypeClassDictionary during typechecking
DerivedInstancePlaceholder (Qualified (ProperName 'ClassName)) InstanceDerivationStrategy | A placeholder for a type class instance to be derived 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

Instances details

Show Expr # |
Instance details 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

Instances details

Show WhereProvenance # |
Instance details 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

Instances details

Show CaseAlternative # |
Instance details 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

Instances details

Show DoNotationElement # |
Instance details 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

Instances details

Foldable PathTree # |
Instance details 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 # |
Instance details 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)
Functor PathTree # |
Instance details Defined in Language.PureScript.AST.Declarations Methods fmap :: (a -> b) -> PathTree a -> PathTree b # (<$) :: a -> PathTree b -> PathTree a #
Show t => Show (PathTree t) # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> PathTree t -> ShowS # show :: PathTree t -> String # showList :: [PathTree t] -> ShowS #
Eq t => Eq (PathTree t) # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: PathTree t -> PathTree t -> Bool # (/=) :: PathTree t -> PathTree t -> Bool #
Ord t => Ord (PathTree t) # |
Instance details 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 #

data PathNode t #

Constructors

Leaf t |
Branch (PathTree t) |

#### Instances

Instances details

Foldable PathNode # |
Instance details 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 # |
Instance details 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)
Functor PathNode # |
Instance details Defined in Language.PureScript.AST.Declarations Methods fmap :: (a -> b) -> PathNode a -> PathNode b # (<$) :: a -> PathNode b -> PathNode a #
Show t => Show (PathNode t) # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> PathNode t -> ShowS # show :: PathNode t -> String # showList :: [PathNode t] -> ShowS #
Eq t => Eq (PathNode t) # |
Instance details Defined in Language.PureScript.AST.Declarations Methods (==) :: PathNode t -> PathNode t -> Bool # (/=) :: PathNode t -> PathNode t -> Bool #
Ord t => Ord (PathNode t) # |
Instance details 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 #

newtype AssocList k t #

Constructors

AssocList |
Fields runAssocList :: [(k, t)]

#### Instances

Instances details

Foldable (AssocList k) # |
Instance details 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) # |
Instance details 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)
Functor (AssocList k) # |
Instance details Defined in Language.PureScript.AST.Declarations Methods fmap :: (a -> b) -> AssocList k a -> AssocList k b # (<$) :: a -> AssocList k b -> AssocList k a #
(Show k, Show t) => Show (AssocList k t) # |
Instance details Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> AssocList k t -> ShowS # show :: AssocList k t -> String # showList :: [AssocList k t] -> ShowS #
(Eq k, Eq t) => Eq (AssocList k t) # |
Instance details 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) # |
Instance details 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 #

isTrueExpr :: Expr -> Bool #

isAnonymousArgument :: Expr -> Bool #