Safe Haskell	None
Language	Haskell98

HsDecls

Contents

Toplevel declarations
Grouping

Description

Abstract syntax of global declarations.

Definitions for: SynDecl and ConDecl, ClassDecl, InstDecl, DefaultDecl and ForeignDecl.

Synopsis

Toplevel declarations

data HsDecl idSource

A Haskell Declaration

Constructors

TyClD (TyClDecl id)	A type or class declaration.
InstD (InstDecl id)	An instance declaration.
DerivD (DerivDecl id)
ValD (HsBind id)
SigD (Sig id)
DefD (DefaultDecl id)
ForD (ForeignDecl id)
WarningD (WarnDecl id)
AnnD (AnnDecl id)
RuleD (RuleDecl id)
VectD (VectDecl id)
SpliceD (SpliceDecl id)
DocD DocDecl
QuasiQuoteD (HsQuasiQuote id)
RoleAnnotD (RoleAnnotDecl id)

Instances

Data id => Data (HsDecl id)
OutputableBndr name => Outputable (HsDecl name)
Typeable (* -> *) HsDecl

type LHsDecl id = Located (HsDecl id)Source

data HsDataDefn nameSource

Constructors

HsDataDefn

Declares a data type or newtype, giving its constructors data/newtype T a = constrs data/newtype instance T [a] = constrs

Fields

dd_ND :: NewOrData

dd_ctxt :: LHsContext name

Context

dd_cType :: Maybe CType

dd_kindSig :: Maybe (LHsKind name)

Optional kind signature.

(Just k) for a GADT-style data, or data instance decl, with explicit kind sig

Always Nothing for H98-syntax decls

dd_cons :: [LConDecl name]

Data constructors

For data T a = T1 | T2 a the LConDecls all have ResTyH98. For data T a where { T1 :: T a } the LConDecls all have ResTyGADT.

dd_derivs :: Maybe [LHsType name]

Derivings; Nothing => not specified, Just [] => derive exactly what is asked

These "types" must be of form forall ab. C ty1 ty2 Typically the foralls and ty args are empty, but they are non-empty for the newtype-deriving case

Instances

Data name => Data (HsDataDefn name)
OutputableBndr name => Outputable (HsDataDefn name)
Typeable (* -> *) HsDataDefn

Class or type declarations

data TyClDecl nameSource

A type or class declaration.

Constructors

ForeignType
Fields tcdLName :: Located name Name of the class Type constructor Type constructor tcdExtName :: Maybe FastString
FamDecl	type/data family T :: ->
Fields tcdFam :: FamilyDecl name
SynDecl	`type` declaration
Fields tcdLName :: Located name Name of the class Type constructor Type constructor tcdTyVars :: LHsTyVarBndrs name Class type variables Type variables; for an assoicated type these include outer binders Eg class T a where type F a :: * type F a = a -> a Here the type decl for `f` includes `a` in its tcdTyVars Type variables; for an associated type these include outer binders tcdRhs :: LHsType name RHS of type declaration tcdFVs :: NameSet
DataDecl	`data` declaration
Fields tcdLName :: Located name Name of the class Type constructor Type constructor tcdTyVars :: LHsTyVarBndrs name Class type variables Type variables; for an assoicated type these include outer binders Eg class T a where type F a :: * type F a = a -> a Here the type decl for `f` includes `a` in its tcdTyVars Type variables; for an associated type these include outer binders tcdDataDefn :: HsDataDefn name tcdFVs :: NameSet
ClassDecl
Fields tcdCtxt :: LHsContext name Context... tcdLName :: Located name Name of the class Type constructor Type constructor tcdTyVars :: LHsTyVarBndrs name Class type variables Type variables; for an assoicated type these include outer binders Eg class T a where type F a :: * type F a = a -> a Here the type decl for `f` includes `a` in its tcdTyVars Type variables; for an associated type these include outer binders tcdFDs :: [Located (FunDep name)] Functional deps tcdSigs :: [LSig name] Methods' signatures tcdMeths :: LHsBinds name Default methods tcdATs :: [LFamilyDecl name] Associated types; ie tcdATDefs :: [LTyFamInstDecl name] Associated type defaults tcdDocs :: [LDocDecl] Haddock docs tcdFVs :: NameSet

Instances

Data name => Data (TyClDecl name)
OutputableBndr name => Outputable (TyClDecl name)
Typeable (* -> *) TyClDecl

type LTyClDecl name = Located (TyClDecl name)Source

data TyClGroup nameSource

Constructors

TyClGroup
Fields group_tyclds :: [LTyClDecl name] group_roles :: [LRoleAnnotDecl name]

Instances

Data name => Data (TyClGroup name)
OutputableBndr name => Outputable (TyClGroup name)
Typeable (* -> *) TyClGroup

tyClGroupConcat :: [TyClGroup name] -> [LTyClDecl name]Source

mkTyClGroup :: [LTyClDecl name] -> TyClGroup nameSource

isClassDecl :: TyClDecl name -> Bool Source

type class

isDataDecl :: TyClDecl name -> Bool Source

True = argument is a data/newtype declaration.

isSynDecl :: TyClDecl name -> Bool Source

type or type instance declaration

tcdName :: TyClDecl name -> nameSource

isFamilyDecl :: TyClDecl name -> Bool Source

type/data family declaration

isTypeFamilyDecl :: TyClDecl name -> Bool Source

type family declaration

isDataFamilyDecl :: TyClDecl name -> Bool Source

data family declaration

isOpenTypeFamilyInfo :: FamilyInfo name -> Bool Source

open type family info

isClosedTypeFamilyInfo :: FamilyInfo name -> Bool Source

closed type family info

tyFamInstDeclName :: OutputableBndr name => TyFamInstDecl name -> nameSource

tyFamInstDeclLName :: OutputableBndr name => TyFamInstDecl name -> Located nameSource

countTyClDecls :: [TyClDecl name] -> (Int, Int, Int, Int, Int)Source

pprTyClDeclFlavour :: TyClDecl a -> SDoc Source

tyClDeclLName :: TyClDecl name -> Located nameSource

tyClDeclTyVars :: OutputableBndr name => TyClDecl name -> LHsTyVarBndrs nameSource

data FamilyDecl nameSource

Constructors

FamilyDecl
Fields fdInfo :: FamilyInfo name fdLName :: Located name fdTyVars :: LHsTyVarBndrs name fdKindSig :: Maybe (LHsKind name)

Instances

Data name => Data (FamilyDecl name)
OutputableBndr name => Outputable (FamilyDecl name)
Typeable (* -> *) FamilyDecl

type LFamilyDecl name = Located (FamilyDecl name)Source

Instance declarations

data InstDecl nameSource

Constructors

ClsInstD
Fields cid_inst :: ClsInstDecl name
DataFamInstD
Fields dfid_inst :: DataFamInstDecl name
TyFamInstD
Fields tfid_inst :: TyFamInstDecl name

Instances

Data name => Data (InstDecl name)
OutputableBndr name => Outputable (InstDecl name)
Typeable (* -> *) InstDecl

type LInstDecl name = Located (InstDecl name)Source

data NewOrData Source

Constructors

NewType	newtype Blah ...
DataType	data Blah ...

Instances

Eq NewOrData
Data NewOrData
Outputable NewOrData
Typeable * NewOrData

data FamilyInfo nameSource

Constructors

DataFamily
OpenTypeFamily
ClosedTypeFamily [LTyFamInstEqn name]

Instances

Data name => Data (FamilyInfo name)
Outputable (FamilyInfo name)
Typeable (* -> *) FamilyInfo

data TyFamInstDecl nameSource

Constructors

TyFamInstDecl
Fields tfid_eqn :: LTyFamInstEqn name tfid_fvs :: NameSet

Instances

Data name => Data (TyFamInstDecl name)
OutputableBndr name => Outputable (TyFamInstDecl name)
Typeable (* -> *) TyFamInstDecl

type LTyFamInstDecl name = Located (TyFamInstDecl name)Source

instDeclDataFamInsts :: [LInstDecl name] -> [DataFamInstDecl name]Source

data DataFamInstDecl nameSource

Constructors

DataFamInstDecl
Fields dfid_tycon :: Located name dfid_pats :: HsWithBndrs [LHsType name] Type patterns (with kind and type bndrs) See Note [Family instance declaration binders] dfid_defn :: HsDataDefn name dfid_fvs :: NameSet

Instances

Data name => Data (DataFamInstDecl name)
OutputableBndr name => Outputable (DataFamInstDecl name)
Typeable (* -> *) DataFamInstDecl

type LDataFamInstDecl name = Located (DataFamInstDecl name)Source

pprDataFamInstFlavour :: DataFamInstDecl name -> SDoc Source

data TyFamInstEqn nameSource

One equation in a type family instance declaration

Constructors

TyFamInstEqn
Fields tfie_tycon :: Located name tfie_pats :: HsWithBndrs [LHsType name] Type patterns (with kind and type bndrs) See Note [Family instance declaration binders] tfie_rhs :: LHsType name

Instances

Data name => Data (TyFamInstEqn name)
OutputableBndr name => Outputable (TyFamInstEqn name)
Typeable (* -> *) TyFamInstEqn

type LTyFamInstEqn name = Located (TyFamInstEqn name)Source

type LClsInstDecl name = Located (ClsInstDecl name)Source

data ClsInstDecl nameSource

Constructors

ClsInstDecl
Fields cid_poly_ty :: LHsType name cid_binds :: LHsBinds name cid_sigs :: [LSig name] cid_tyfam_insts :: [LTyFamInstDecl name] cid_datafam_insts :: [LDataFamInstDecl name]

Instances

Data name => Data (ClsInstDecl name)
OutputableBndr name => Outputable (ClsInstDecl name)
Typeable (* -> *) ClsInstDecl

Standalone deriving declarations

data DerivDecl nameSource

Constructors

DerivDecl
Fields deriv_type :: LHsType name

Instances

Data name => Data (DerivDecl name)
OutputableBndr name => Outputable (DerivDecl name)
Typeable (* -> *) DerivDecl

type LDerivDecl name = Located (DerivDecl name)Source

`RULE` declarations

data RuleDecl nameSource

Constructors

HsRule RuleName Activation [RuleBndr name] (Located (HsExpr name)) NameSet (Located (HsExpr name)) NameSet

Instances

Data name => Data (RuleDecl name)
OutputableBndr name => Outputable (RuleDecl name)
Typeable (* -> *) RuleDecl

type LRuleDecl name = Located (RuleDecl name)Source

data RuleBndr nameSource

Constructors

RuleBndr (Located name)
RuleBndrSig (Located name) (HsWithBndrs (LHsType name))

Instances

Data name => Data (RuleBndr name)
OutputableBndr name => Outputable (RuleBndr name)
Typeable (* -> *) RuleBndr

collectRuleBndrSigTys :: [RuleBndr name] -> [HsWithBndrs (LHsType name)]Source

`VECTORISE` declarations

data VectDecl nameSource

Constructors

HsVect (Located name) (LHsExpr name)
HsNoVect (Located name)
HsVectTypeIn Bool (Located name) (Maybe (Located name))
HsVectTypeOut Bool TyCon (Maybe TyCon)
HsVectClassIn (Located name)
HsVectClassOut Class
HsVectInstIn (LHsType name)
HsVectInstOut ClsInst

Instances

Data name => Data (VectDecl name)
OutputableBndr name => Outputable (VectDecl name)
Typeable (* -> *) VectDecl

type LVectDecl name = Located (VectDecl name)Source

lvectDeclName :: NamedThing name => LVectDecl name -> Name Source

lvectInstDecl :: LVectDecl name -> Bool Source

`default` declarations

data DefaultDecl nameSource

Constructors

DefaultDecl [LHsType name]

Instances

Data name => Data (DefaultDecl name)
OutputableBndr name => Outputable (DefaultDecl name)
Typeable (* -> *) DefaultDecl

type LDefaultDecl name = Located (DefaultDecl name)Source

Template haskell declaration splice

data SpliceDecl idSource

Constructors

SpliceDecl (Located (HsSplice id)) HsExplicitFlag

Instances

Data id => Data (SpliceDecl id)
OutputableBndr name => Outputable (SpliceDecl name)
Typeable (* -> *) SpliceDecl

type LSpliceDecl name = Located (SpliceDecl name)Source

Foreign function interface declarations

data ForeignDecl nameSource

Constructors

ForeignImport (Located name) (LHsType name) Coercion ForeignImport
ForeignExport (Located name) (LHsType name) Coercion ForeignExport

Instances

Data name => Data (ForeignDecl name)
OutputableBndr name => Outputable (ForeignDecl name)
Typeable (* -> *) ForeignDecl

type LForeignDecl name = Located (ForeignDecl name)Source

data ForeignImport Source

Constructors

CImport CCallConv Safety (Maybe Header) CImportSpec

Instances

Data ForeignImport
Outputable ForeignImport
Typeable * ForeignImport

data ForeignExport Source

Constructors

CExport CExportSpec

Instances

Data ForeignExport
Outputable ForeignExport
Typeable * ForeignExport

noForeignImportCoercionYet :: Coercion Source

noForeignExportCoercionYet :: Coercion Source

data CImportSpec Source

Constructors

CLabel CLabelString
CFunction CCallTarget
CWrapper

Instances

Data CImportSpec
Typeable * CImportSpec

Data-constructor declarations

data ConDecl nameSource

Constructors

ConDecl

Fields

con_name :: Located name

Constructor name. This is used for the DataCon itself, and for the user-callable wrapper Id.

con_explicit :: HsExplicitFlag

Is there an user-written forall? (cf. HsForAllTy)

con_qvars :: LHsTyVarBndrs name

Type variables. Depending on con_res this describes the following entities

ResTyH98: the constructor's *existential* type variables
ResTyGADT: *all* the constructor's quantified type variables

If con_explicit is Implicit, then con_qvars is irrelevant until after renaming.

con_cxt :: LHsContext name

The context. This does not include the "stupid theta" which lives only in the TyData decl.

con_details :: HsConDeclDetails name

The main payload

con_res :: ResType (LHsType name)

Result type of the constructor

con_doc :: Maybe LHsDocString

A possible Haddock comment.

con_old_rec :: Bool

TEMPORARY field; True = user has employed now-deprecated syntax for GADT-style record decl C { blah } :: T a b Remove this when we no longer parse this stuff, and hence do not need to report decprecated use

Instances

Data name => Data (ConDecl name)
OutputableBndr name => Outputable (ConDecl name)
Typeable (* -> *) ConDecl

type LConDecl name = Located (ConDecl name)Source

data ResType tySource

Constructors

ResTyH98
ResTyGADT ty

Instances

Data ty => Data (ResType ty)
Outputable ty => Outputable (ResType ty)
Typeable (* -> *) ResType

type HsConDeclDetails name = HsConDetails (LBangType name) [ConDeclField name]Source

hsConDeclArgTys :: HsConDeclDetails name -> [LBangType name]Source

Document comments

data DocDecl Source

Constructors

DocCommentNext HsDocString
DocCommentPrev HsDocString
DocCommentNamed String HsDocString
DocGroup Int HsDocString

Instances

Data DocDecl
Outputable DocDecl
Typeable * DocDecl

type LDocDecl = Located DocDecl Source

docDeclDoc :: DocDecl -> HsDocString Source

Deprecations

data WarnDecl nameSource

Constructors

Warning name WarningTxt

Instances

Data name => Data (WarnDecl name)
OutputableBndr name => Outputable (WarnDecl name)
Typeable (* -> *) WarnDecl

type LWarnDecl name = Located (WarnDecl name)Source

Annotations

data AnnDecl nameSource

Constructors

HsAnnotation (AnnProvenance name) (Located (HsExpr name))

Instances

Data name => Data (AnnDecl name)
OutputableBndr name => Outputable (AnnDecl name)
Typeable (* -> *) AnnDecl

type LAnnDecl name = Located (AnnDecl name)Source

data AnnProvenance nameSource

Constructors

ValueAnnProvenance name
TypeAnnProvenance name
ModuleAnnProvenance

Instances

Functor AnnProvenance
Foldable AnnProvenance
Traversable AnnProvenance
Data name => Data (AnnProvenance name)
Typeable (* -> *) AnnProvenance

annProvenanceName_maybe :: AnnProvenance name -> Maybe nameSource

Role annotations

data RoleAnnotDecl nameSource

Constructors

RoleAnnotDecl (Located name) [Located (Maybe Role)]

Instances

Data name => Data (RoleAnnotDecl name)
OutputableBndr name => Outputable (RoleAnnotDecl name)
Typeable (* -> *) RoleAnnotDecl

type LRoleAnnotDecl name = Located (RoleAnnotDecl name)Source

roleAnnotDeclName :: RoleAnnotDecl name -> nameSource

Grouping

data HsGroup idSource

A HsDecl is categorised into a HsGroup before being fed to the renamer.

Constructors

HsGroup
Fields hs_valds :: HsValBinds id hs_splcds :: [LSpliceDecl id] hs_tyclds :: [TyClGroup id] hs_instds :: [LInstDecl id] hs_derivds :: [LDerivDecl id] hs_fixds :: [LFixitySig id] hs_defds :: [LDefaultDecl id] hs_fords :: [LForeignDecl id] hs_warnds :: [LWarnDecl id] hs_annds :: [LAnnDecl id] hs_ruleds :: [LRuleDecl id] hs_vects :: [LVectDecl id] hs_docs :: [LDocDecl]

Instances

Data id => Data (HsGroup id)
OutputableBndr name => Outputable (HsGroup name)
Typeable (* -> *) HsGroup

emptyRdrGroup :: HsGroup aSource

emptyRnGroup :: HsGroup aSource

appendGroups :: HsGroup a -> HsGroup a -> HsGroup aSource

Toplevel declarations

Class or type declarations

Instance declarations

Standalone deriving declarations

RULE declarations

VECTORISE declarations

default declarations

Template haskell declaration splice

Foreign function interface declarations

Data-constructor declarations

Document comments

Deprecations

Annotations

Role annotations

Grouping

`RULE` declarations

`VECTORISE` declarations

`default` declarations