HsDecls

Contents

• 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

Description

Synopsis

• data HsDecl id
  • = TyClD (TyClDecl id)
  • | InstD (InstDecl id)
  • | DerivD (DerivDecl id)
  • | ValD (HsBind id)
  • | SigD (Sig id)
  • | DefD (DefaultDecl id)
  • | ForD (ForeignDecl id)
  • | WarningD (WarnDecls id)
  • | AnnD (AnnDecl id)
  • | RuleD (RuleDecls id)
  • | VectD (VectDecl id)
  • | SpliceD (SpliceDecl id)
  • | DocD DocDecl
  • | QuasiQuoteD (HsQuasiQuote id)
  • | RoleAnnotD (RoleAnnotDecl id)
• type LHsDecl id = Located (HsDecl id)
• data HsDataDefn name = HsDataDefn {
  • dd_ND :: NewOrData
  • dd_ctxt :: LHsContext name
  • dd_cType :: Maybe (Located CType)
  • dd_kindSig :: Maybe (LHsKind name)
  • dd_cons :: [LConDecl name]
  • dd_derivs :: Maybe (Located [LHsType name])
  }
• data TyClDecl name
  • = FamDecl {
    • tcdFam :: FamilyDecl name
    }
  • | SynDecl {
    • tcdLName :: Located name
    • tcdTyVars :: LHsTyVarBndrs name
    • tcdRhs :: LHsType name
    • tcdFVs :: PostRn name NameSet
    }
  • | DataDecl {
    • tcdLName :: Located name
    • tcdTyVars :: LHsTyVarBndrs name
    • tcdDataDefn :: HsDataDefn name
    • tcdFVs :: PostRn name NameSet
    }
  • | ClassDecl {
    • tcdCtxt :: LHsContext name
    • tcdLName :: Located name
    • tcdTyVars :: LHsTyVarBndrs name
    • tcdFDs :: [Located (FunDep (Located name))]
    • tcdSigs :: [LSig name]
    • tcdMeths :: LHsBinds name
    • tcdATs :: [LFamilyDecl name]
    • tcdATDefs :: [LTyFamDefltEqn name]
    • tcdDocs :: [LDocDecl]
    • tcdFVs :: PostRn name NameSet
    }
• type LTyClDecl name = Located (TyClDecl name)
• data TyClGroup name = TyClGroup {
  • group_tyclds :: [LTyClDecl name]
  • group_roles :: [LRoleAnnotDecl name]
  }
• tyClGroupConcat :: [TyClGroup name] -> [LTyClDecl name]
• mkTyClGroup :: [LTyClDecl name] -> TyClGroup name
• isClassDecl :: TyClDecl name -> Bool
• isDataDecl :: TyClDecl name -> Bool
• isSynDecl :: TyClDecl name -> Bool
• tcdName :: TyClDecl name -> name
• isFamilyDecl :: TyClDecl name -> Bool
• isTypeFamilyDecl :: TyClDecl name -> Bool
• isDataFamilyDecl :: TyClDecl name -> Bool
• isOpenTypeFamilyInfo :: FamilyInfo name -> Bool
• isClosedTypeFamilyInfo :: FamilyInfo name -> Bool
• tyFamInstDeclName :: OutputableBndr name => TyFamInstDecl name -> name
• tyFamInstDeclLName :: OutputableBndr name => TyFamInstDecl name -> Located name
• countTyClDecls :: [TyClDecl name] -> (Int, Int, Int, Int, Int)
• pprTyClDeclFlavour :: TyClDecl a -> SDoc
• tyClDeclLName :: TyClDecl name -> Located name
• tyClDeclTyVars :: OutputableBndr name => TyClDecl name -> LHsTyVarBndrs name
• hsDeclHasCusk :: TyClDecl name -> Bool
• famDeclHasCusk :: FamilyDecl name -> Bool
• data FamilyDecl name = FamilyDecl {
  • fdInfo :: FamilyInfo name
  • fdLName :: Located name
  • fdTyVars :: LHsTyVarBndrs name
  • fdKindSig :: Maybe (LHsKind name)
  }
• type LFamilyDecl name = Located (FamilyDecl name)
• data InstDecl name
  • = ClsInstD {
    • cid_inst :: ClsInstDecl name
    }
  • | DataFamInstD {
    • dfid_inst :: DataFamInstDecl name
    }
  • | TyFamInstD {
    • tfid_inst :: TyFamInstDecl name
    }
• type LInstDecl name = Located (InstDecl name)
• data NewOrData
  • = NewType
  • | DataType
• data FamilyInfo name
  • = DataFamily
  • | OpenTypeFamily
  • | ClosedTypeFamily [LTyFamInstEqn name]
• data TyFamInstDecl name = TyFamInstDecl {
  • tfid_eqn :: LTyFamInstEqn name
  • tfid_fvs :: PostRn name NameSet
  }
• type LTyFamInstDecl name = Located (TyFamInstDecl name)
• instDeclDataFamInsts :: [LInstDecl name] -> [DataFamInstDecl name]
• data DataFamInstDecl name = DataFamInstDecl {
  • dfid_tycon :: Located name
  • dfid_pats :: HsTyPats name
  • dfid_defn :: HsDataDefn name
  • dfid_fvs :: PostRn name NameSet
  }
• type LDataFamInstDecl name = Located (DataFamInstDecl name)
• pprDataFamInstFlavour :: DataFamInstDecl name -> SDoc
• data TyFamEqn name pats = TyFamEqn {
  • tfe_tycon :: Located name
  • tfe_pats :: pats
  • tfe_rhs :: LHsType name
  }
• type TyFamInstEqn name = TyFamEqn name (HsTyPats name)
• type LTyFamInstEqn name = Located (TyFamInstEqn name)
• type TyFamDefltEqn name = TyFamEqn name (LHsTyVarBndrs name)
• type LTyFamDefltEqn name = Located (TyFamDefltEqn name)
• type HsTyPats name = HsWithBndrs name [LHsType name]
• type LClsInstDecl name = Located (ClsInstDecl name)
• data ClsInstDecl name = ClsInstDecl {
  • cid_poly_ty :: LHsType name
  • cid_binds :: LHsBinds name
  • cid_sigs :: [LSig name]
  • cid_tyfam_insts :: [LTyFamInstDecl name]
  • cid_datafam_insts :: [LDataFamInstDecl name]
  • cid_overlap_mode :: Maybe (Located OverlapMode)
  }
• data DerivDecl name = DerivDecl {
  • deriv_type :: LHsType name
  • deriv_overlap_mode :: Maybe (Located OverlapMode)
  }
• type LDerivDecl name = Located (DerivDecl name)
• type LRuleDecls name = Located (RuleDecls name)
• data RuleDecls name = HsRules {
  • rds_src :: SourceText
  • rds_rules :: [LRuleDecl name]
  }
• data RuleDecl name = HsRule (Located RuleName) Activation [LRuleBndr name] (Located (HsExpr name)) (PostRn name NameSet) (Located (HsExpr name)) (PostRn name NameSet)
• type LRuleDecl name = Located (RuleDecl name)
• data RuleBndr name
  • = RuleBndr (Located name)
  • | RuleBndrSig (Located name) (HsWithBndrs name (LHsType name))
• type LRuleBndr name = Located (RuleBndr name)
• collectRuleBndrSigTys :: [RuleBndr name] -> [HsWithBndrs name (LHsType name)]
• flattenRuleDecls :: [LRuleDecls name] -> [LRuleDecl name]
• data VectDecl name
  • = HsVect SourceText (Located name) (LHsExpr name)
  • | HsNoVect SourceText (Located name)
  • | HsVectTypeIn SourceText Bool (Located name) (Maybe (Located name))
  • | HsVectTypeOut Bool TyCon (Maybe TyCon)
  • | HsVectClassIn SourceText (Located name)
  • | HsVectClassOut Class
  • | HsVectInstIn (LHsType name)
  • | HsVectInstOut ClsInst
• type LVectDecl name = Located (VectDecl name)
• lvectDeclName :: NamedThing name => LVectDecl name -> Name
• lvectInstDecl :: LVectDecl name -> Bool
• data DefaultDecl name = DefaultDecl [LHsType name]
• type LDefaultDecl name = Located (DefaultDecl name)
• data SpliceExplicitFlag
  • = ExplicitSplice
  • | ImplicitSplice
• data SpliceDecl id = SpliceDecl (Located (HsSplice id)) SpliceExplicitFlag
• type LSpliceDecl name = Located (SpliceDecl name)
• data ForeignDecl name
  • = ForeignImport (Located name) (LHsType name) (PostTc name Coercion) ForeignImport
  • | ForeignExport (Located name) (LHsType name) (PostTc name Coercion) ForeignExport
• type LForeignDecl name = Located (ForeignDecl name)
• data ForeignImport = CImport (Located CCallConv) (Located Safety) (Maybe Header) CImportSpec (Located SourceText)
• data ForeignExport = CExport (Located CExportSpec) (Located SourceText)
• noForeignImportCoercionYet :: PlaceHolder
• noForeignExportCoercionYet :: PlaceHolder
• data CImportSpec
  • = CLabel CLabelString
  • | CFunction CCallTarget
  • | CWrapper
• data ConDecl name = ConDecl {
  • con_names :: [Located name]
  • con_explicit :: HsExplicitFlag
  • con_qvars :: LHsTyVarBndrs name
  • con_cxt :: LHsContext name
  • con_details :: HsConDeclDetails name
  • con_res :: ResType (LHsType name)
  • con_doc :: Maybe LHsDocString
  • con_old_rec :: Bool
  }
• type LConDecl name = Located (ConDecl name)
• data ResType ty
  • = ResTyH98
  • | ResTyGADT SrcSpan ty
• type HsConDeclDetails name = HsConDetails (LBangType name) (Located [LConDeclField name])
• hsConDeclArgTys :: HsConDeclDetails name -> [LBangType name]
• data DocDecl
  • = DocCommentNext HsDocString
  • | DocCommentPrev HsDocString
  • | DocCommentNamed String HsDocString
  • | DocGroup Int HsDocString
• type LDocDecl = Located DocDecl
• docDeclDoc :: DocDecl -> HsDocString
• data WarnDecl name = Warning [Located name] WarningTxt
• type LWarnDecl name = Located (WarnDecl name)
• data WarnDecls name = Warnings {
  • wd_src :: SourceText
  • wd_warnings :: [LWarnDecl name]
  }
• type LWarnDecls name = Located (WarnDecls name)
• data AnnDecl name = HsAnnotation SourceText (AnnProvenance name) (Located (HsExpr name))
• type LAnnDecl name = Located (AnnDecl name)
• data AnnProvenance name
  • = ValueAnnProvenance (Located name)
  • | TypeAnnProvenance (Located name)
  • | ModuleAnnProvenance
• annProvenanceName_maybe :: AnnProvenance name -> Maybe name
• data RoleAnnotDecl name = RoleAnnotDecl (Located name) [Located (Maybe Role)]
• type LRoleAnnotDecl name = Located (RoleAnnotDecl name)
• roleAnnotDeclName :: RoleAnnotDecl name -> name
• data HsGroup id = HsGroup {
  • 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 :: [LWarnDecls id]
  • hs_annds :: [LAnnDecl id]
  • hs_ruleds :: [LRuleDecls id]
  • hs_vects :: [LVectDecl id]
  • hs_docs :: [LDocDecl]
  }
• emptyRdrGroup :: HsGroup a
• emptyRnGroup :: HsGroup a
• appendGroups :: HsGroup a -> HsGroup a -> HsGroup a

Toplevel declarations

Class or type declarations

type/data family T :: *->*

Instance declarations

newtype Blah ...

data Blah ...

Standalone deriving declarations

RULE declarations

VECTORISE declarations

default declarations

Template haskell declaration splice

Foreign function interface declarations

Data-constructor declarations

data T b = forall a. Eq a => MkT a b
  MkT :: forall b a. Eq a => MkT a b

data T b where
     MkT1 :: Int -> T Int

data T = Int MkT Int
       | MkT2

data T a where
     Int MkT Int :: T Int

Document comments

Deprecations

Annotations

Role annotations

Grouping