| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Language.Haskell.Tools.AST.Decls
Description
Representation of Haskell AST definitions. These include definition of data types, classes, instances and so on. The definition of value bindings are in the Binds module.
- data Decl dom stage
- = TypeDecl { }
- | TypeFamilyDecl {
- _declTypeFamily :: Ann TypeFamily dom stage
- | ClosedTypeFamilyDecl { }
- | DataDecl {
- _declNewtype :: Ann DataOrNewtypeKeyword dom stage
- _declCtx :: AnnMaybe Context dom stage
- _declHead :: Ann DeclHead dom stage
- _declCons :: AnnList ConDecl dom stage
- _declDeriving :: AnnMaybe Deriving dom stage
- | GDataDecl {
- _declNewtype :: Ann DataOrNewtypeKeyword dom stage
- _declCtx :: AnnMaybe Context dom stage
- _declHead :: Ann DeclHead dom stage
- _declKind :: AnnMaybe KindConstraint dom stage
- _declGadt :: AnnList GadtConDecl dom stage
- _declDeriving :: AnnMaybe Deriving dom stage
- | TypeInstDecl {
- _declInstance :: Ann InstanceRule dom stage
- _declAssignedType :: Ann Type dom stage
- | DataInstDecl {
- _declNewtype :: Ann DataOrNewtypeKeyword dom stage
- _declInstance :: Ann InstanceRule dom stage
- _declCons :: AnnList ConDecl dom stage
- _declDeriving :: AnnMaybe Deriving dom stage
- | GDataInstDecl {
- _declNewtype :: Ann DataOrNewtypeKeyword dom stage
- _declInstance :: Ann InstanceRule dom stage
- _declKind :: AnnMaybe KindConstraint dom stage
- _declGadt :: AnnList GadtConDecl dom stage
- | ClassDecl { }
- | InstDecl {
- _declOverlap :: AnnMaybe OverlapPragma dom stage
- _declInstRule :: Ann InstanceRule dom stage
- _declInstDecl :: AnnMaybe InstBody dom stage
- | PatternSynonymDecl {
- _declPatSyn :: Ann PatternSynonym dom stage
- | DerivDecl {
- _declOverlap :: AnnMaybe OverlapPragma dom stage
- _declInstRule :: Ann InstanceRule dom stage
- | FixityDecl {
- _declFixity :: Ann FixitySignature dom stage
- | DefaultDecl {
- _declTypes :: AnnList Type dom stage
- | TypeSigDecl {
- _declTypeSig :: Ann TypeSignature dom stage
- | PatTypeSigDecl {
- _declPatTypeSig :: Ann PatternTypeSignature dom stage
- | ValueBinding {
- _declValBind :: Ann ValueBind dom stage
- | ForeignImport { }
- | ForeignExport { }
- | PragmaDecl {
- _declPragma :: Ann TopLevelPragma dom stage
- | RoleDecl {
- _declRoleType :: Ann QualifiedName dom stage
- _declRoles :: AnnList Role dom stage
- | SpliceDecl {
- _declSplice :: Ann Splice dom stage
- data TypeFamily dom stage
- = TypeFamily { }
- | DataFamily { }
- data TypeFamilySpec dom stage
- = TypeFamilyKind {
- _tfSpecKind :: Ann KindConstraint dom stage
- | TypeFamilyInjectivity {
- _tfInjectivity :: Ann InjectivityAnn dom stage
- = TypeFamilyKind {
- data InjectivityAnn dom stage = InjectivityAnn {
- _injAnnRes :: Ann Name dom stage
- _injAnnDeps :: AnnList Name dom stage
- data ClassBody dom stage = ClassBody {
- _cbElements :: AnnList ClassElement dom stage
- data ClassElement dom stage
- = ClsSig {
- _ceTypeSig :: Ann TypeSignature dom stage
- | ClsDef { }
- | ClsTypeFam {
- _ceTypeFam :: Ann TypeFamily dom stage
- | ClsTypeDef { }
- | ClsDefSig { }
- | ClsMinimal {
- _pragmaFormula :: Ann MinimalFormula dom stage
- | ClsPatSig {
- _cePatSig :: Ann PatternTypeSignature dom stage
- = ClsSig {
- data DeclHead dom stage
- data InstBody dom stage = InstBody {
- _instBodyDecls :: AnnList InstBodyDecl dom stage
- data InstBodyDecl dom stage
- = InstBodyNormalDecl {
- _instBodyDeclFunbind :: Ann ValueBind dom stage
- | InstBodyTypeSig {
- _instBodyTypeSig :: Ann TypeSignature dom stage
- | InstBodyTypeDecl {
- _instBodyTypeEqn :: Ann TypeEqn dom stage
- | InstBodyDataDecl {
- _instBodyDataNew :: Ann DataOrNewtypeKeyword dom stage
- _instBodyLhsType :: Ann InstanceRule dom stage
- _instBodyDataCons :: AnnList ConDecl dom stage
- _instBodyDerivings :: AnnMaybe Deriving dom stage
- | InstBodyGadtDataDecl {
- _instBodyDataNew :: Ann DataOrNewtypeKeyword dom stage
- _instBodyLhsType :: Ann InstanceRule dom stage
- _instBodyDataKind :: AnnMaybe KindConstraint dom stage
- _instBodyGadtCons :: AnnList GadtConDecl dom stage
- _instBodyDerivings :: AnnMaybe Deriving dom stage
- | SpecializeInstance {
- _specializeInstanceType :: Ann Type dom stage
- | InstBodyPatSyn {
- _instBodyPatSyn :: Ann PatternSynonym dom stage
- = InstBodyNormalDecl {
- data GadtConDecl dom stage = GadtConDecl {
- _gadtConNames :: AnnList Name dom stage
- _gadtConType :: Ann GadtConType dom stage
- data GadtConType dom stage
- = GadtNormalType {
- _gadtConNormalType :: Ann Type dom stage
- | GadtRecordType {
- _gadtConRecordFields :: AnnList FieldDecl dom stage
- _gadtConResultType :: Ann Type dom stage
- = GadtNormalType {
- data FunDeps dom stage = FunDeps {}
- data FunDep dom stage = FunDep {
- _funDepLhs :: AnnList Name dom stage
- _funDepRhs :: AnnList Name dom stage
- data ConDecl dom stage
- = ConDecl {
- _conDeclName :: Ann Name dom stage
- _conDeclArgs :: AnnList Type dom stage
- | RecordDecl {
- _conDeclName :: Ann Name dom stage
- _conDeclFields :: AnnList FieldDecl dom stage
- | InfixConDecl {
- _conDeclLhs :: Ann Type dom stage
- _conDeclOp :: Ann Operator dom stage
- _conDeclRhs :: Ann Type dom stage
- = ConDecl {
- data FieldDecl dom stage = FieldDecl {
- _fieldNames :: AnnList Name dom stage
- _fieldType :: Ann Type dom stage
- data Deriving dom stage
- = DerivingOne {
- _oneDerived :: Ann InstanceHead dom stage
- | Derivings {
- _allDerived :: AnnList InstanceHead dom stage
- = DerivingOne {
- data InstanceRule dom stage
- = InstanceRule { }
- | InstanceParen {
- _irRule :: Ann InstanceRule dom stage
- data InstanceHead dom stage
- = InstanceHeadCon {
- _ihConName :: Ann Name dom stage
- | InstanceHeadInfix { }
- | InstanceHeadParen {
- _ihHead :: Ann InstanceHead dom stage
- | InstanceHeadApp { }
- = InstanceHeadCon {
- data TypeEqn dom stage = TypeEqn {}
- data PatternTypeSignature dom stage = PatternTypeSignature {
- _patSigName :: Ann Name dom stage
- _patSigType :: Ann Type dom stage
- data PatternSynonym dom stage = PatternSynonym {}
- data PatSynLhs dom stage
- = NormalPatSyn { }
- | InfixPatSyn {
- _patSynLhs :: Ann Name dom stage
- _patSynOp :: Ann Operator dom stage
- _patSynRhs :: Ann Name dom stage
- | RecordPatSyn { }
- data PatSynRhs dom stage
- = BidirectionalPatSyn {
- _patRhsPat :: Ann Pattern dom stage
- _patRhsOpposite :: AnnMaybe PatSynWhere dom stage
- | OneDirectionalPatSyn {
- _patRhsPat :: Ann Pattern dom stage
- = BidirectionalPatSyn {
- data PatSynWhere dom stage = PatSynWhere {
- _patOpposite :: AnnList Match dom stage
Documentation
Haskell declaration
Constructors
| TypeDecl | A type synonym ( |
| TypeFamilyDecl | |
Fields
| |
| ClosedTypeFamilyDecl | A closed type family declaration |
| DataDecl | A data or newtype declaration. Empty data type declarations without where keyword are always belong to DataDecl. |
Fields
| |
| GDataDecl | A data or newtype declaration. |
Fields
| |
| TypeInstDecl | Type instance declaration ( |
Fields
| |
| DataInstDecl | Data instance declaration ( |
Fields
| |
| GDataInstDecl | Gadt style data instance declaration ( |
Fields
| |
| ClassDecl | Type class declaration ( |
| InstDecl | Instance declaration ( |
Fields
| |
| PatternSynonymDecl | Pattern synonyms ( |
Fields
| |
| DerivDecl | Standalone deriving declaration ( |
Fields
| |
| FixityDecl | Fixity declaration ( |
Fields
| |
| DefaultDecl | Default types ( |
Fields
| |
| TypeSigDecl | Type signature declaration ( |
Fields
| |
| PatTypeSigDecl | Type signature declaration ( |
Fields
| |
| ValueBinding | Function binding ( |
Fields
| |
| ForeignImport | Foreign import ( |
| ForeignExport | foreign export ( |
| PragmaDecl | top level pragmas |
Fields
| |
| RoleDecl | role annotations ( |
Fields
| |
| SpliceDecl | A Template Haskell splice declaration ( |
Fields
| |
data TypeFamily dom stage Source #
Open type and data families
Constructors
| TypeFamily | A type family declaration ( |
| DataFamily | Data family declaration |
Instances
| type Rep (TypeFamily dom stage) Source # | |
data TypeFamilySpec dom stage Source #
Type family specification with kinds specification and injectivity.
Constructors
| TypeFamilyKind | |
Fields
| |
| TypeFamilyInjectivity | |
Fields
| |
Instances
| type Rep (TypeFamilySpec dom stage) Source # | |
data InjectivityAnn dom stage Source #
Injectivity annotation for type families ( = r | r -> a )
Constructors
| InjectivityAnn | |
Fields
| |
Instances
| type Rep (InjectivityAnn dom stage) Source # | |
data ClassBody dom stage Source #
The list of declarations that can appear in a typeclass
Constructors
| ClassBody | |
Fields
| |
data ClassElement dom stage Source #
Members of a class declaration
Constructors
| ClsSig | Signature: |
Fields
| |
| ClsDef | Default binding: |
| ClsTypeFam | Declaration of an associated type synonym: |
Fields
| |
| ClsTypeDef | Default choice for type synonym: |
| ClsDefSig | Default signature (by using |
| ClsMinimal | |
Fields
| |
| ClsPatSig | Pattern signature in a class declaration (by using |
Fields
| |
Instances
| type Rep (ClassElement dom stage) Source # | |
data InstBody dom stage Source #
Instance body is the implementation of the class functions ( where a x = 1; b x = 2 )
Constructors
| InstBody | |
Fields
| |
data InstBodyDecl dom stage Source #
Declarations inside an instance declaration.
Constructors
| InstBodyNormalDecl | A normal declaration ( |
Fields
| |
| InstBodyTypeSig | Type signature in instance definition with |
Fields
| |
| InstBodyTypeDecl | An associated type definition ( |
Fields
| |
| InstBodyDataDecl | An associated data type implementation ( |
Fields
| |
| InstBodyGadtDataDecl | An associated data type implemented using GADT style |
Fields
| |
| SpecializeInstance | Specialize instance pragma (no phase selection is allowed) not supported yet |
Fields
| |
| InstBodyPatSyn | A pattern synonym in a class instance |
Fields
| |
Instances
| type Rep (InstBodyDecl dom stage) Source # | |
data GadtConDecl dom stage Source #
GADT constructor declaration ( _D1 :: { _val :: Int } -> T String )
Constructors
| GadtConDecl | |
Fields
| |
Instances
| type Rep (GadtConDecl dom stage) Source # | |
data GadtConType dom stage Source #
Type of GADT constructors (can be record types: { _val :: Int })
Constructors
| GadtNormalType | |
Fields
| |
| GadtRecordType | |
Fields
| |
Instances
| type Rep (GadtConType dom stage) Source # | |
data FunDeps dom stage Source #
A list of functional dependencies: | a -> b, c -> d separated by commas
data FunDep dom stage Source #
A functional dependency, given on the form l1 ... ln -> r1 ... rn
Constructors
| FunDep | |
Fields
| |
data ConDecl dom stage Source #
A constructor declaration for a datatype
Constructors
| ConDecl | ordinary data constructor ( |
Fields
| |
| RecordDecl | record data constructor ( |
Fields
| |
| InfixConDecl | infix data constructor ( |
Fields
| |
data FieldDecl dom stage Source #
Field declaration ( _fld :: Int )
Constructors
| FieldDecl | |
Fields
| |
data Deriving dom stage Source #
A deriving clause following a data type declaration. ( deriving Show or deriving (Show, Eq) )
Constructors
| DerivingOne | |
Fields
| |
| Derivings | |
Fields
| |
data InstanceRule dom stage Source #
The instance declaration rule, which is, roughly, the part of the instance declaration before the where keyword.
Constructors
| InstanceRule | |
| InstanceParen | |
Fields
| |
Instances
| type Rep (InstanceRule dom stage) Source # | |
data InstanceHead dom stage Source #
The specification of the class instance declaration
Constructors
| InstanceHeadCon | Type or class name |
Fields
| |
| InstanceHeadInfix | Infix application of the type/class name to the left operand |
| InstanceHeadParen | Parenthesized instance head |
Fields
| |
| InstanceHeadApp | Application to one more type |
Instances
| type Rep (InstanceHead dom stage) Source # | |
data PatternTypeSignature dom stage Source #
A pattern type signature ( pattern p :: Int -> T )
Constructors
| PatternTypeSignature | |
Fields
| |
Instances
| type Rep (PatternTypeSignature dom stage) Source # | |
data PatternSynonym dom stage Source #
Pattern synonyms: pattern Arrow t1 t2 = App "->" [t1, t2]
Constructors
| PatternSynonym | |
Instances
| type Rep (PatternSynonym dom stage) Source # | |
data PatSynLhs dom stage Source #
Left hand side of a pattern synonym
Constructors
| NormalPatSyn | |
| InfixPatSyn | |
Fields
| |
| RecordPatSyn | |
data PatSynRhs dom stage Source #
Right-hand side of pattern synonym
Constructors
| BidirectionalPatSyn |
|
Fields
| |
| OneDirectionalPatSyn | pattern Int <- App Int [] |
Fields
| |
data PatSynWhere dom stage Source #
Where clause of pattern synonym (explicit expression direction)
Constructors
| PatSynWhere | |
Fields
| |
Instances
| type Rep (PatSynWhere dom stage) Source # | |