HsDecls

Contents

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
Data id => Data (HsDecl id)
OutputableBndr name => Outputable (HsDecl name)

type LHsDecl id = Located (HsDecl id)Source

Class or type declarations

data TyClDecl name Source

A type or class declaration.

Constructors

ForeignType
Fields tcdLName :: Located name tcdExtName :: Maybe FastString
TyFamily	type/data family T :: ->
Fields tcdFlavour :: FamilyFlavour tcdLName :: Located name tcdTyVars :: [LHsTyVarBndr name] tcdKind :: Maybe Kind
TyData	Declares a data type or newtype, giving its construcors `data/newtype T a = constrs data/newtype instance T [a] = constrs`
Fields tcdND :: NewOrData tcdCtxt :: LHsContext name Context tcdLName :: Located name tcdTyVars :: [LHsTyVarBndr name] tcdTyPats :: Maybe [LHsType name] Type patterns. `Just [t1..tn]` for `data instance T t1..tn = ...` in this case `tcdTyVars = fv( tcdTyPats )`. `Nothing` for everything else. tcdKindSig :: Maybe Kind Optional kind signature. `(Just k)` for a GADT-style `data`, or `data instance` decl with explicit kind sig tcdCons :: [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`. tcdDerivs :: 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
TySynonym
Fields tcdLName :: Located name tcdTyVars :: [LHsTyVarBndr name] tcdTyPats :: Maybe [LHsType name] Type patterns. `Just [t1..tn]` for `data instance T t1..tn = ...` in this case `tcdTyVars = fv( tcdTyPats )`. `Nothing` for everything else. tcdSynRhs :: LHsType name synonym expansion
ClassDecl
Fields tcdCtxt :: LHsContext name Context tcdLName :: Located name tcdTyVars :: [LHsTyVarBndr name] tcdFDs :: [Located (FunDep name)] Functional deps tcdSigs :: [LSig name] Methods' signatures tcdMeths :: LHsBinds name Default methods tcdATs :: [LTyClDecl name] Associated types; ie only `TyFamily` and `TySynonym`; the latter for defaults tcdDocs :: [LDocDecl] Haddock docs

Instances

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

type LTyClDecl name = Located (TyClDecl name)Source

isClassDecl :: TyClDecl name -> Bool Source

type class

isSynDecl :: TyClDecl name -> Bool Source

vanilla Haskell type synonym (ie, not a type instance)

isDataDecl :: TyClDecl name -> Bool Source

True = argument is a data/newtype or data/newtype instance declaration.

isTypeDecl :: TyClDecl name -> Bool Source

type or type instance declaration

isFamilyDecl :: TyClDecl name -> Bool Source

type family declaration

isFamInstDecl :: TyClDecl name -> Bool Source

family instance (types, newtypes, and data types)

tcdName :: TyClDecl name -> nameSource

tyClDeclTyVars :: TyClDecl name -> [LHsTyVarBndr name]Source

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

Instance declarations

data InstDecl name Source

Constructors

InstDecl (LHsType name) (LHsBinds name) [LSig name] [LTyClDecl name]

Instances

Typeable1 InstDecl
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

instDeclATs :: [LInstDecl name] -> [LTyClDecl name]Source

Standalone deriving declarations

data DerivDecl name Source

Constructors

DerivDecl
Fields deriv_type :: LHsType name

Instances

Typeable1 DerivDecl
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
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) (LHsType name)

Instances

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

collectRuleBndrSigTys :: [RuleBndr name] -> [LHsType name]Source

`VECTORISE` declarations

data VectDecl name Source

Constructors

HsVect (Located name) (Maybe (LHsExpr name))
HsNoVect (Located name)

Instances

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

type LVectDecl name = Located (VectDecl name)Source

lvectDeclName :: LVectDecl name -> nameSource

`default` declarations

data DefaultDecl name Source

Constructors

DefaultDecl [LHsType name]

Instances

Typeable1 DefaultDecl
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
Data id => Data (SpliceDecl id)
OutputableBndr name => Outputable (SpliceDecl name)

Foreign function interface declarations

data ForeignDecl name Source

Constructors

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

Instances

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

type LForeignDecl name = Located (ForeignDecl name)Source

data ForeignImport Source

Constructors

CImport CCallConv Safety FastString CImportSpec

Instances

Data ForeignImport
Typeable ForeignImport
Outputable ForeignImport

data ForeignExport Source

Constructors

CExport CExportSpec

Instances

Data ForeignExport
Typeable ForeignExport
Outputable ForeignExport

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 :: [LHsTyVarBndr 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 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
Data name => Data (ConDecl name)
OutputableBndr name => Outputable (ConDecl name)

type LConDecl name = Located (ConDecl name)Source

data ResType name Source

Constructors

ResTyH98
ResTyGADT (LHsType name)

Instances

Typeable1 ResType
Data name => Data (ResType name)
OutputableBndr name => Outputable (ResType name)

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
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
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
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
Data id => Data (HsGroup id)
OutputableBndr name => Outputable (HsGroup name)

emptyRnGroup, emptyRdrGroup :: 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