| Safe Haskell | None |
|---|---|
| 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
- | 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)
- data HintCategory
- 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 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
- | ModuleRef SourceSpan ModuleName
- | ReExportRef SourceSpan ExportSource DeclarationRef
- data ExportSource = ExportSource {}
- 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
- isImplicit :: ImportDeclarationType -> Bool
- isExplicit :: ImportDeclarationType -> Bool
- data RoleDeclarationData = RoleDeclarationData {
- rdeclSourceAnn :: !SourceAnn
- rdeclIdent :: !(ProperName 'TypeName)
- rdeclRoles :: ![Role]
- data TypeDeclarationData = TypeDeclarationData {
- tydeclSourceAnn :: !SourceAnn
- tydeclIdent :: !Ident
- tydeclType :: !SourceType
- overTypeDeclaration :: (TypeDeclarationData -> TypeDeclarationData) -> Declaration -> Declaration
- getTypeDeclaration :: Declaration -> Maybe TypeDeclarationData
- unwrapTypeDeclaration :: TypeDeclarationData -> (Ident, SourceType)
- data ValueDeclarationData a = ValueDeclarationData {
- valdeclSourceAnn :: !SourceAnn
- valdeclIdent :: !Ident
- valdeclName :: !NameKind
- valdeclBinders :: ![Binder]
- valdeclExpression :: !a
- overValueDeclaration :: (ValueDeclarationData [GuardedExpr] -> ValueDeclarationData [GuardedExpr]) -> Declaration -> Declaration
- 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 [Ident] Integer 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 TypeInstanceBody
- mapTypeInstanceBody :: ([Declaration] -> [Declaration]) -> TypeInstanceBody -> TypeInstanceBody
- traverseTypeInstanceBody :: Applicative f => ([Declaration] -> f [Declaration]) -> TypeInstanceBody -> f TypeInstanceBody
- data KindSignatureFor
- 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
- 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
- | 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
- | TypeClassDictionaryConstructorApp (Qualified (ProperName 'ClassName)) Expr
- | TypeClassDictionary SourceConstraint (Map (Maybe ModuleName) (Map (Qualified (ProperName 'ClassName)) (Map (Qualified Ident) (NonEmpty NamedDict)))) [ErrorMessageHint]
- | TypeClassDictionaryAccessor (Qualified (ProperName 'ClassName)) Ident
- | DeferredDictionary (Qualified (ProperName 'ClassName)) [SourceType]
- | AnonymousArgument
- | Hole Text
- | PositionedValue SourceSpan [Comment] Expr
- data WhereProvenance
- data CaseAlternative = CaseAlternative {}
- data DoNotationElement
- newtype PathTree t = PathTree (AssocList PSString (PathNode t))
- data PathNode t
- newtype AssocList k t = AssocList {
- runAssocList :: [(k, t)]
- isTrueExpr :: Expr -> Bool
Documentation
type Context = [(Ident, SourceType)] Source #
A map of locally-bound names in scope.
data TypeSearch Source #
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
| |
Instances
| Show TypeSearch Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> TypeSearch -> ShowS # show :: TypeSearch -> String # showList :: [TypeSearch] -> ShowS # | |
onTypeSearchTypes :: (SourceType -> SourceType) -> TypeSearch -> TypeSearch Source #
onTypeSearchTypesM :: Applicative m => (SourceType -> m SourceType) -> TypeSearch -> m TypeSearch Source #
data ErrorMessageHint Source #
Error message hints, providing more detailed information about failure.
Constructors
Instances
| Show ErrorMessageHint Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> ErrorMessageHint -> ShowS # show :: ErrorMessageHint -> String # showList :: [ErrorMessageHint] -> ShowS # | |
data HintCategory Source #
Categories of hints
Constructors
| ExprHint | |
| KindHint | |
| CheckHint | |
| PositionHint | |
| SolverHint | |
| OtherHint |
Instances
| Eq HintCategory Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Show HintCategory Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> HintCategory -> ShowS # show :: HintCategory -> String # showList :: [HintCategory] -> ShowS # | |
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]) |
getModuleName :: Module -> ModuleName Source #
Return a module's name.
getModuleSourceSpan :: Module -> SourceSpan Source #
Return a module's source span.
getModuleDeclarations :: Module -> [Declaration] Source #
Return a module's declarations.
addDefaultImport :: Qualified ModuleName -> Module -> Module Source #
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 Source #
Adds import declarations to a module for an implicit Prim import and Prim | qualified as Prim, as necessary.
data DeclarationRef Source #
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
data ExportSource Source #
Constructors
| ExportSource | |
Instances
declRefName :: DeclarationRef -> Name Source #
getTypeRef :: DeclarationRef -> Maybe (ProperName 'TypeName, Maybe [ProperName 'ConstructorName]) Source #
getTypeOpRef :: DeclarationRef -> Maybe (OpName 'TypeOpName) Source #
getValueRef :: DeclarationRef -> Maybe Ident Source #
getValueOpRef :: DeclarationRef -> Maybe (OpName 'ValueOpName) Source #
getTypeClassRef :: DeclarationRef -> Maybe (ProperName 'ClassName) Source #
isModuleRef :: DeclarationRef -> Bool Source #
data ImportDeclarationType Source #
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
data RoleDeclarationData Source #
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
| |
Instances
| Eq RoleDeclarationData Source # | |
Defined in Language.PureScript.AST.Declarations Methods (==) :: RoleDeclarationData -> RoleDeclarationData -> Bool # (/=) :: RoleDeclarationData -> RoleDeclarationData -> Bool # | |
| Show RoleDeclarationData Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> RoleDeclarationData -> ShowS # show :: RoleDeclarationData -> String # showList :: [RoleDeclarationData] -> ShowS # | |
data TypeDeclarationData Source #
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
| |
Instances
| Eq TypeDeclarationData Source # | |
Defined in Language.PureScript.AST.Declarations Methods (==) :: TypeDeclarationData -> TypeDeclarationData -> Bool # (/=) :: TypeDeclarationData -> TypeDeclarationData -> Bool # | |
| Show TypeDeclarationData Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> TypeDeclarationData -> ShowS # show :: TypeDeclarationData -> String # showList :: [TypeDeclarationData] -> ShowS # | |
overTypeDeclaration :: (TypeDeclarationData -> TypeDeclarationData) -> Declaration -> Declaration Source #
data ValueDeclarationData a Source #
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
| |
Instances
overValueDeclaration :: (ValueDeclarationData [GuardedExpr] -> ValueDeclarationData [GuardedExpr]) -> Declaration -> Declaration Source #
pattern ValueDecl :: SourceAnn -> Ident -> NameKind -> [Binder] -> [GuardedExpr] -> Declaration Source #
data DataConstructorDeclaration Source #
Constructors
| DataConstructorDeclaration | |
Fields
| |
Instances
| Eq DataConstructorDeclaration Source # | |
Defined in Language.PureScript.AST.Declarations Methods (==) :: DataConstructorDeclaration -> DataConstructorDeclaration -> Bool # (/=) :: DataConstructorDeclaration -> DataConstructorDeclaration -> Bool # | |
| Show DataConstructorDeclaration Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> DataConstructorDeclaration -> ShowS # show :: DataConstructorDeclaration -> String # showList :: [DataConstructorDeclaration] -> ShowS # | |
mapDataCtorFields :: ([(Ident, SourceType)] -> [(Ident, SourceType)]) -> DataConstructorDeclaration -> DataConstructorDeclaration Source #
traverseDataCtorFields :: Monad m => ([(Ident, SourceType)] -> m [(Ident, SourceType)]) -> DataConstructorDeclaration -> m DataConstructorDeclaration Source #
data Declaration Source #
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 Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS # | |
data ValueFixity Source #
Constructors
| ValueFixity Fixity (Qualified (Either Ident (ProperName 'ConstructorName))) (OpName 'ValueOpName) |
Instances
| Eq ValueFixity Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Ord ValueFixity Source # | |
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 Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> ValueFixity -> ShowS # show :: ValueFixity -> String # showList :: [ValueFixity] -> ShowS # | |
data TypeFixity Source #
Constructors
| TypeFixity Fixity (Qualified (ProperName 'TypeName)) (OpName 'TypeOpName) |
Instances
| Eq TypeFixity Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Ord TypeFixity Source # | |
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 Source # | |
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 Source #
pattern TypeFixityDeclaration :: SourceAnn -> Fixity -> Qualified (ProperName 'TypeName) -> OpName 'TypeOpName -> Declaration Source #
data TypeInstanceBody Source #
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 Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> TypeInstanceBody -> ShowS # show :: TypeInstanceBody -> String # showList :: [TypeInstanceBody] -> ShowS # | |
mapTypeInstanceBody :: ([Declaration] -> [Declaration]) -> TypeInstanceBody -> TypeInstanceBody Source #
traverseTypeInstanceBody :: Applicative f => ([Declaration] -> f [Declaration]) -> TypeInstanceBody -> f TypeInstanceBody Source #
A traversal for TypeInstanceBody
data KindSignatureFor Source #
What sort of declaration the kind signature applies to.
Constructors
| DataSig | |
| NewtypeSig | |
| TypeSynonymSig | |
| ClassSig |
Instances
| Eq KindSignatureFor Source # | |
Defined in Language.PureScript.AST.Declarations Methods (==) :: KindSignatureFor -> KindSignatureFor -> Bool # (/=) :: KindSignatureFor -> KindSignatureFor -> Bool # | |
| Ord KindSignatureFor Source # | |
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 Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> KindSignatureFor -> ShowS # show :: KindSignatureFor -> String # showList :: [KindSignatureFor] -> ShowS # | |
declSourceAnn :: Declaration -> SourceAnn Source #
isValueDecl :: Declaration -> Bool Source #
Test if a declaration is a value declaration
isDataDecl :: Declaration -> Bool Source #
Test if a declaration is a data type declaration
isTypeSynonymDecl :: Declaration -> Bool Source #
Test if a declaration is a type synonym declaration
isImportDecl :: Declaration -> Bool Source #
Test if a declaration is a module import
isRoleDecl :: Declaration -> Bool Source #
Test if a declaration is a role declaration
isExternDataDecl :: Declaration -> Bool Source #
Test if a declaration is a data type foreign import
isFixityDecl :: Declaration -> Bool Source #
Test if a declaration is a fixity declaration
isExternDecl :: Declaration -> Bool Source #
Test if a declaration is a foreign import
isTypeClassInstanceDecl :: Declaration -> Bool Source #
Test if a declaration is a type class instance declaration
isTypeClassDecl :: Declaration -> Bool Source #
Test if a declaration is a type class declaration
isKindDecl :: Declaration -> Bool Source #
Test if a declaration is a kind signature declaration.
flattenDecls :: [Declaration] -> [Declaration] Source #
Recursively flatten data binding groups in the list of declarations
A guard is just a boolean-valued expression that appears alongside a set of binders
Constructors
| ConditionGuard Expr | |
| PatternGuard Binder Expr |
data GuardedExpr Source #
The right hand side of a binder in value declarations and case expressions.
Constructors
| GuardedExpr [Guard] Expr |
Instances
| Show GuardedExpr Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> GuardedExpr -> ShowS # show :: GuardedExpr -> String # showList :: [GuardedExpr] -> ShowS # | |
pattern MkUnguarded :: Expr -> GuardedExpr Source #
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 |
| 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 |
| 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 |
data WhereProvenance Source #
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 Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> WhereProvenance -> ShowS # show :: WhereProvenance -> String # showList :: [WhereProvenance] -> ShowS # | |
data CaseAlternative Source #
An alternative in a case statement
Constructors
| CaseAlternative | |
Fields
| |
Instances
| Show CaseAlternative Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> CaseAlternative -> ShowS # show :: CaseAlternative -> String # showList :: [CaseAlternative] -> ShowS # | |
data DoNotationElement Source #
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 Source # | |
Defined in Language.PureScript.AST.Declarations Methods showsPrec :: Int -> DoNotationElement -> ShowS # show :: DoNotationElement -> String # showList :: [DoNotationElement] -> ShowS # | |
Instances
| Functor PathTree Source # | |
| Foldable PathTree Source # | |
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 # elem :: Eq a => a -> PathTree a -> Bool # maximum :: Ord a => PathTree a -> a # minimum :: Ord a => PathTree a -> a # | |
| Traversable PathTree Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Eq t => Eq (PathTree t) Source # | |
| Ord t => Ord (PathTree t) Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Show t => Show (PathTree t) Source # | |
Instances
| Functor PathNode Source # | |
| Foldable PathNode Source # | |
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 # elem :: Eq a => a -> PathNode a -> Bool # maximum :: Ord a => PathNode a -> a # minimum :: Ord a => PathNode a -> a # | |
| Traversable PathNode Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Eq t => Eq (PathNode t) Source # | |
| Ord t => Ord (PathNode t) Source # | |
Defined in Language.PureScript.AST.Declarations | |
| Show t => Show (PathNode t) Source # | |
newtype AssocList k t Source #
Constructors
| AssocList | |
Fields
| |
Instances
isTrueExpr :: Expr -> Bool Source #