Safe Haskell	None

HsDecls

Contents

Toplevel declarations
Grouping

Description

Abstract syntax of global declarations.

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

Synopsis

Toplevel declarations

data HsDecl id Source

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)

Instances

Typeable1 HsDecl
(Typeable (HsDecl id), Data id) => Data (HsDecl id)
OutputableBndr name => Outputable (HsDecl name)

type LHsDecl id = Located (HsDecl id)Source

data HsTyDefn name Source

Constructors

TySynonym	Synonym expansion
Fields td_synRhs :: LHsType name
TyData	Declares a data type or newtype, giving its construcors `data/newtype T a = constrs data/newtype instance T [a] = constrs`
Fields td_ND :: NewOrData td_ctxt :: LHsContext name Context td_cType :: Maybe CType td_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 td_cons :: [LConDecl name] Data constructors For `data T a = T1 \| T2 a` the `LConDecl`s all have `ResTyH98`. For `data T a where { T1 :: T a }` the `LConDecls` all have `ResTyGADT`. td_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

Typeable1 HsTyDefn
(Typeable (HsTyDefn name), Data name) => Data (HsTyDefn name)
OutputableBndr name => Outputable (HsTyDefn name)

Class or type declarations

data TyClDecl name Source

A type or class declaration.

Constructors

ForeignType
Fields tcdLName :: Located name Name of the class Type constructor tcdExtName :: Maybe FastString
TyFamily	type/data family T :: ->
Fields tcdFlavour :: FamilyFlavour tcdLName :: Located name Name of the class Type constructor tcdTyVars :: LHsTyVarBndrs name Class type variables Type variables; for an associated 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 tcdKindSig :: Maybe (LHsKind name)
TyDecl
Fields tcdLName :: Located name Name of the class Type constructor tcdTyVars :: LHsTyVarBndrs name Class type variables Type variables; for an associated 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 tcdTyDefn :: HsTyDefn name tcdFVs :: NameSet
ClassDecl
Fields tcdCtxt :: LHsContext name Context... tcdLName :: Located name Name of the class Type constructor tcdTyVars :: LHsTyVarBndrs name Class type variables Type variables; for an associated 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 tcdFDs :: [Located (FunDep name)] Functional deps tcdSigs :: [LSig name] Methods' signatures tcdMeths :: LHsBinds name Default methods tcdATs :: [LTyClDecl name] Associated types; ie only `TyFamily` tcdATDefs :: [LFamInstDecl name] Associated type defaults; ie only `TySynonym` tcdDocs :: [LDocDecl] Haddock docs tcdFVs :: NameSet

Instances

Typeable1 TyClDecl
(Typeable (TyClDecl name), Data name) => Data (TyClDecl name)
OutputableBndr name => Outputable (TyClDecl name)

type LTyClDecl name = Located (TyClDecl name)Source

type TyClGroup name = [LTyClDecl name]Source

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

isFamilyDecl :: TyClDecl name -> Bool Source

type family declaration

isHsDataDefn :: HsTyDefn name -> Bool Source

isHsSynDefn :: HsTyDefn name -> Bool Source

tcdName :: TyClDecl name -> nameSource

famInstDeclName :: LFamInstDecl a -> aSource

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

pprTyDefnFlavour :: HsTyDefn a -> SDoc Source

pprTyClDeclFlavour :: TyClDecl a -> SDoc Source

Instance declarations

data InstDecl name Source

Constructors

ClsInstD
Fields cid_poly_ty :: LHsType name cid_binds :: LHsBinds name cid_sigs :: [LSig name] cid_fam_insts :: [LFamInstDecl name]
FamInstD
Fields lid_inst :: FamInstDecl name

Instances

Typeable1 InstDecl
(Typeable (InstDecl name), Data name) => Data (InstDecl name)
OutputableBndr name => Outputable (InstDecl name)

type LInstDecl name = Located (InstDecl name)Source

data NewOrData Source

Constructors

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

Instances

Eq NewOrData
Data NewOrData
Typeable NewOrData
Outputable NewOrData

data FamilyFlavour Source

Constructors

TypeFamily	type family ...
DataFamily	data family ...

Instances

Data FamilyFlavour
Typeable FamilyFlavour

data FamInstDecl name Source

Constructors

FamInstDecl
Fields fid_tycon :: Located name fid_pats :: HsWithBndrs [LHsType name] Type patterns (with kind and type bndrs) See Note [Family instance declaration binders] fid_defn :: HsTyDefn name fid_fvs :: NameSet

Instances

Typeable1 FamInstDecl
(Typeable (FamInstDecl name), Data name) => Data (FamInstDecl name)
OutputableBndr name => Outputable (FamInstDecl name)

type LFamInstDecl name = Located (FamInstDecl name)Source

instDeclFamInsts :: [LInstDecl name] -> [FamInstDecl name]Source

Standalone deriving declarations

data DerivDecl name Source

Constructors

DerivDecl
Fields deriv_type :: LHsType name

Instances

Typeable1 DerivDecl
(Typeable (DerivDecl name), Data name) => Data (DerivDecl name)
OutputableBndr name => Outputable (DerivDecl name)

type LDerivDecl name = Located (DerivDecl name)Source

`RULE` declarations

data RuleDecl name Source

Constructors

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

Instances

Typeable1 RuleDecl
(Typeable (RuleDecl name), Data name) => Data (RuleDecl name)
OutputableBndr name => Outputable (RuleDecl name)

type LRuleDecl name = Located (RuleDecl name)Source

data RuleBndr name Source

Constructors

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

Instances

Typeable1 RuleBndr
(Typeable (RuleBndr name), Data name) => Data (RuleBndr name)
OutputableBndr name => Outputable (RuleBndr name)

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

`VECTORISE` declarations

data VectDecl name Source

Constructors

HsVect (Located name) (Maybe (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

Typeable1 VectDecl
(Typeable (VectDecl name), Data name) => Data (VectDecl name)
OutputableBndr name => Outputable (VectDecl name)

type LVectDecl name = Located (VectDecl name)Source

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

lvectInstDecl :: LVectDecl name -> Bool Source

`default` declarations

data DefaultDecl name Source

Constructors

DefaultDecl [LHsType name]

Instances

Typeable1 DefaultDecl
(Typeable (DefaultDecl name), Data name) => Data (DefaultDecl name)
OutputableBndr name => Outputable (DefaultDecl name)

type LDefaultDecl name = Located (DefaultDecl name)Source

Top-level template haskell splice

data SpliceDecl id Source

Constructors

SpliceDecl (Located (HsExpr id)) HsExplicitFlag

Instances

Typeable1 SpliceDecl
(Typeable (SpliceDecl id), Data id) => Data (SpliceDecl id)
OutputableBndr name => Outputable (SpliceDecl name)

Foreign function interface declarations

data ForeignDecl name Source

Constructors

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

Instances

Typeable1 ForeignDecl
(Typeable (ForeignDecl name), Data name) => Data (ForeignDecl name)
OutputableBndr name => Outputable (ForeignDecl name)

type LForeignDecl name = Located (ForeignDecl name)Source

data ForeignImport Source

Constructors

CImport CCallConv Safety (Maybe Header) CImportSpec

Instances

Data ForeignImport
Typeable ForeignImport
Outputable ForeignImport

data ForeignExport Source

Constructors

CExport CExportSpec

Instances

Data ForeignExport
Typeable ForeignExport
Outputable 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 name Source

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

Typeable1 ConDecl
(Typeable (ConDecl name), Data name) => Data (ConDecl name)
OutputableBndr name => Outputable (ConDecl name)

type LConDecl name = Located (ConDecl name)Source

data ResType ty Source

Constructors

ResTyH98
ResTyGADT ty

Instances

Typeable1 ResType
(Typeable (ResType ty), Data ty) => Data (ResType ty)
Outputable ty => Outputable (ResType ty)

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
Typeable DocDecl
Outputable DocDecl

type LDocDecl = Located DocDecl Source

docDeclDoc :: DocDecl -> HsDocString Source

Deprecations

data WarnDecl name Source

Constructors

Warning name WarningTxt

Instances

Typeable1 WarnDecl
(Typeable (WarnDecl name), Data name) => Data (WarnDecl name)
OutputableBndr name => Outputable (WarnDecl name)

type LWarnDecl name = Located (WarnDecl name)Source

Annotations

data AnnDecl name Source

Constructors

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

Instances

Typeable1 AnnDecl
(Typeable (AnnDecl name), Data name) => Data (AnnDecl name)
OutputableBndr name => Outputable (AnnDecl name)

type LAnnDecl name = Located (AnnDecl name)Source

data AnnProvenance name Source

Constructors

ValueAnnProvenance name
TypeAnnProvenance name
ModuleAnnProvenance

Instances

Typeable1 AnnProvenance
(Typeable (AnnProvenance name), Data name) => Data (AnnProvenance name)

annProvenanceName_maybe :: AnnProvenance name -> Maybe nameSource

modifyAnnProvenanceNameM :: Monad m => (before -> m after) -> AnnProvenance before -> m (AnnProvenance after)Source

Grouping

data HsGroup id Source

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

Constructors

HsGroup
Fields hs_valds :: HsValBinds id hs_tyclds :: [[LTyClDecl 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

Typeable1 HsGroup
(Typeable (HsGroup id), Data id) => Data (HsGroup id)
OutputableBndr name => Outputable (HsGroup name)

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

Top-level template haskell splice

Foreign function interface declarations

Data-constructor declarations

Document comments

Deprecations

Annotations

Grouping

`RULE` declarations

`VECTORISE` declarations

`default` declarations