{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998
-}

{-# LANGUAGE DeriveDataTypeable, DeriveFunctor, DeriveFoldable,
             DeriveTraversable #-}
{-# LANGUAGE StandaloneDeriving #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE UndecidableInstances #-} -- Note [Pass sensitive types]
                                      -- in module GHC.Hs.PlaceHolder
{-# LANGUAGE ConstraintKinds #-}
{-# LANGUAGE TypeFamilies #-}

-- | Abstract syntax of global declarations.
--
-- Definitions for: @SynDecl@ and @ConDecl@, @ClassDecl@,
-- @InstDecl@, @DefaultDecl@ and @ForeignDecl@.
module GHC.Hs.Decls (
  -- * Toplevel declarations
  HsDecl(..), LHsDecl, HsDataDefn(..), HsDeriving, LHsFunDep,
  HsDerivingClause(..), LHsDerivingClause, NewOrData(..), newOrDataToFlavour,
  StandaloneKindSig(..), LStandaloneKindSig, standaloneKindSigName,

  -- ** Class or type declarations
  TyClDecl(..), LTyClDecl, DataDeclRn(..),
  TyClGroup(..),
  tyClGroupTyClDecls, tyClGroupInstDecls, tyClGroupRoleDecls,
  tyClGroupKindSigs,
  isClassDecl, isDataDecl, isSynDecl, tcdName,
  isFamilyDecl, isTypeFamilyDecl, isDataFamilyDecl,
  isOpenTypeFamilyInfo, isClosedTypeFamilyInfo,
  tyFamInstDeclName, tyFamInstDeclLName,
  countTyClDecls, pprTyClDeclFlavour,
  tyClDeclLName, tyClDeclTyVars,
  hsDeclHasCusk, famResultKindSignature,
  FamilyDecl(..), LFamilyDecl,

  -- ** Instance declarations
  InstDecl(..), LInstDecl, FamilyInfo(..),
  TyFamInstDecl(..), LTyFamInstDecl, instDeclDataFamInsts,
  TyFamDefltDecl, LTyFamDefltDecl,
  DataFamInstDecl(..), LDataFamInstDecl,
  pprDataFamInstFlavour, pprTyFamInstDecl, pprHsFamInstLHS,
  FamInstEqn, LFamInstEqn, FamEqn(..),
  TyFamInstEqn, LTyFamInstEqn, HsTyPats,
  LClsInstDecl, ClsInstDecl(..),

  -- ** Standalone deriving declarations
  DerivDecl(..), LDerivDecl,
  -- ** Deriving strategies
  DerivStrategy(..), LDerivStrategy,
  derivStrategyName, foldDerivStrategy, mapDerivStrategy,
  -- ** @RULE@ declarations
  LRuleDecls,RuleDecls(..),RuleDecl(..),LRuleDecl,HsRuleRn(..),
  RuleBndr(..),LRuleBndr,
  collectRuleBndrSigTys,
  flattenRuleDecls, pprFullRuleName,
  -- ** @default@ declarations
  DefaultDecl(..), LDefaultDecl,
  -- ** Template haskell declaration splice
  SpliceExplicitFlag(..),
  SpliceDecl(..), LSpliceDecl,
  -- ** Foreign function interface declarations
  ForeignDecl(..), LForeignDecl, ForeignImport(..), ForeignExport(..),
  CImportSpec(..),
  -- ** Data-constructor declarations
  ConDecl(..), LConDecl,
  HsConDeclDetails, hsConDeclArgTys, hsConDeclTheta,
  getConNames, getConArgs,
  -- ** Document comments
  DocDecl(..), LDocDecl, docDeclDoc,
  -- ** Deprecations
  WarnDecl(..),  LWarnDecl,
  WarnDecls(..), LWarnDecls,
  -- ** Annotations
  AnnDecl(..), LAnnDecl,
  AnnProvenance(..), annProvenanceName_maybe,
  -- ** Role annotations
  RoleAnnotDecl(..), LRoleAnnotDecl, roleAnnotDeclName,
  -- ** Injective type families
  FamilyResultSig(..), LFamilyResultSig, InjectivityAnn(..), LInjectivityAnn,
  resultVariableName,

  -- * Grouping
  HsGroup(..),  emptyRdrGroup, emptyRnGroup, appendGroups, hsGroupInstDecls

    ) where

-- friends:
import GhcPrelude

import {-# SOURCE #-} GHC.Hs.Expr( HsExpr, HsSplice, pprExpr,
                                   pprSpliceDecl )
        -- Because Expr imports Decls via HsBracket

import GHC.Hs.Binds
import GHC.Hs.Types
import GHC.Hs.Doc
import TyCon
import BasicTypes
import Coercion
import ForeignCall
import GHC.Hs.Extension
import NameSet

-- others:
import Class
import Outputable
import Util
import SrcLoc
import Type

import Bag
import Maybes
import Data.Data        hiding (TyCon,Fixity, Infix)

{-
************************************************************************
*                                                                      *
\subsection[HsDecl]{Declarations}
*                                                                      *
************************************************************************
-}

type LHsDecl p = Located (HsDecl p)
        -- ^ When in a list this may have
        --
        --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnSemi'
        --

-- For details on above see note [Api annotations] in ApiAnnotation

-- | A Haskell Declaration
data HsDecl p
  = TyClD      (XTyClD p)      (TyClDecl p)      -- ^ Type or Class Declaration
  | InstD      (XInstD p)      (InstDecl  p)     -- ^ Instance declaration
  | DerivD     (XDerivD p)     (DerivDecl p)     -- ^ Deriving declaration
  | ValD       (XValD p)       (HsBind p)        -- ^ Value declaration
  | SigD       (XSigD p)       (Sig p)           -- ^ Signature declaration
  | KindSigD   (XKindSigD p)   (StandaloneKindSig p) -- ^ Standalone kind signature
  | DefD       (XDefD p)       (DefaultDecl p)   -- ^ 'default' declaration
  | ForD       (XForD p)       (ForeignDecl p)   -- ^ Foreign declaration
  | WarningD   (XWarningD p)   (WarnDecls p)     -- ^ Warning declaration
  | AnnD       (XAnnD p)       (AnnDecl p)       -- ^ Annotation declaration
  | RuleD      (XRuleD p)      (RuleDecls p)     -- ^ Rule declaration
  | SpliceD    (XSpliceD p)    (SpliceDecl p)    -- ^ Splice declaration
                                                 -- (Includes quasi-quotes)
  | DocD       (XDocD p)       (DocDecl)  -- ^ Documentation comment declaration
  | RoleAnnotD (XRoleAnnotD p) (RoleAnnotDecl p) -- ^Role annotation declaration
  | XHsDecl    (XXHsDecl p)

type instance XTyClD      (GhcPass _) = NoExtField
type instance XInstD      (GhcPass _) = NoExtField
type instance XDerivD     (GhcPass _) = NoExtField
type instance XValD       (GhcPass _) = NoExtField
type instance XSigD       (GhcPass _) = NoExtField
type instance XKindSigD   (GhcPass _) = NoExtField
type instance XDefD       (GhcPass _) = NoExtField
type instance XForD       (GhcPass _) = NoExtField
type instance XWarningD   (GhcPass _) = NoExtField
type instance XAnnD       (GhcPass _) = NoExtField
type instance XRuleD      (GhcPass _) = NoExtField
type instance XSpliceD    (GhcPass _) = NoExtField
type instance XDocD       (GhcPass _) = NoExtField
type instance XRoleAnnotD (GhcPass _) = NoExtField
type instance XXHsDecl    (GhcPass _) = NoExtCon

-- NB: all top-level fixity decls are contained EITHER
-- EITHER SigDs
-- OR     in the ClassDecls in TyClDs
--
-- The former covers
--      a) data constructors
--      b) class methods (but they can be also done in the
--              signatures of class decls)
--      c) imported functions (that have an IfacSig)
--      d) top level decls
--
-- The latter is for class methods only

-- | Haskell Group
--
-- A 'HsDecl' is categorised into a 'HsGroup' before being
-- fed to the renamer.
data HsGroup p
  = HsGroup {
        HsGroup p -> XCHsGroup p
hs_ext    :: XCHsGroup p,
        HsGroup p -> HsValBinds p
hs_valds  :: HsValBinds p,
        HsGroup p -> [LSpliceDecl p]
hs_splcds :: [LSpliceDecl p],

        HsGroup p -> [TyClGroup p]
hs_tyclds :: [TyClGroup p],
                -- A list of mutually-recursive groups;
                -- This includes `InstDecl`s as well;
                -- Parser generates a singleton list;
                -- renamer does dependency analysis

        HsGroup p -> [LDerivDecl p]
hs_derivds :: [LDerivDecl p],

        HsGroup p -> [LFixitySig p]
hs_fixds  :: [LFixitySig p],
                -- Snaffled out of both top-level fixity signatures,
                -- and those in class declarations

        HsGroup p -> [LDefaultDecl p]
hs_defds  :: [LDefaultDecl p],
        HsGroup p -> [LForeignDecl p]
hs_fords  :: [LForeignDecl p],
        HsGroup p -> [LWarnDecls p]
hs_warnds :: [LWarnDecls p],
        HsGroup p -> [LAnnDecl p]
hs_annds  :: [LAnnDecl p],
        HsGroup p -> [LRuleDecls p]
hs_ruleds :: [LRuleDecls p],

        HsGroup p -> [LDocDecl]
hs_docs   :: [LDocDecl]
    }
  | XHsGroup (XXHsGroup p)

type instance XCHsGroup (GhcPass _) = NoExtField
type instance XXHsGroup (GhcPass _) = NoExtCon


emptyGroup, emptyRdrGroup, emptyRnGroup :: HsGroup (GhcPass p)
emptyRdrGroup :: HsGroup (GhcPass p)
emptyRdrGroup = HsGroup (GhcPass p)
forall (p :: Pass). HsGroup (GhcPass p)
emptyGroup { hs_valds :: HsValBinds (GhcPass p)
hs_valds = HsValBinds (GhcPass p)
forall (a :: Pass) (b :: Pass).
HsValBindsLR (GhcPass a) (GhcPass b)
emptyValBindsIn }
emptyRnGroup :: HsGroup (GhcPass p)
emptyRnGroup  = HsGroup (GhcPass p)
forall (p :: Pass). HsGroup (GhcPass p)
emptyGroup { hs_valds :: HsValBinds (GhcPass p)
hs_valds = HsValBinds (GhcPass p)
forall (a :: Pass) (b :: Pass).
HsValBindsLR (GhcPass a) (GhcPass b)
emptyValBindsOut }

hsGroupInstDecls :: HsGroup id -> [LInstDecl id]
hsGroupInstDecls :: HsGroup id -> [LInstDecl id]
hsGroupInstDecls = (TyClGroup id -> [LInstDecl id])
-> [TyClGroup id] -> [LInstDecl id]
forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
(=<<) TyClGroup id -> [LInstDecl id]
forall pass. TyClGroup pass -> [LInstDecl pass]
group_instds ([TyClGroup id] -> [LInstDecl id])
-> (HsGroup id -> [TyClGroup id]) -> HsGroup id -> [LInstDecl id]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. HsGroup id -> [TyClGroup id]
forall p. HsGroup p -> [TyClGroup p]
hs_tyclds

emptyGroup :: HsGroup (GhcPass p)
emptyGroup = HsGroup :: forall p.
XCHsGroup p
-> HsValBinds p
-> [LSpliceDecl p]
-> [TyClGroup p]
-> [LDerivDecl p]
-> [LFixitySig p]
-> [LDefaultDecl p]
-> [LForeignDecl p]
-> [LWarnDecls p]
-> [LAnnDecl p]
-> [LRuleDecls p]
-> [LDocDecl]
-> HsGroup p
HsGroup { hs_ext :: XCHsGroup (GhcPass p)
hs_ext = XCHsGroup (GhcPass p)
NoExtField
noExtField,
                       hs_tyclds :: [TyClGroup (GhcPass p)]
hs_tyclds = [],
                       hs_derivds :: [LDerivDecl (GhcPass p)]
hs_derivds = [],
                       hs_fixds :: [LFixitySig (GhcPass p)]
hs_fixds = [], hs_defds :: [LDefaultDecl (GhcPass p)]
hs_defds = [], hs_annds :: [LAnnDecl (GhcPass p)]
hs_annds = [],
                       hs_fords :: [LForeignDecl (GhcPass p)]
hs_fords = [], hs_warnds :: [LWarnDecls (GhcPass p)]
hs_warnds = [], hs_ruleds :: [LRuleDecls (GhcPass p)]
hs_ruleds = [],
                       hs_valds :: HsValBinds (GhcPass p)
hs_valds = [Char] -> HsValBinds (GhcPass p)
forall a. HasCallStack => [Char] -> a
error [Char]
"emptyGroup hs_valds: Can't happen",
                       hs_splcds :: [LSpliceDecl (GhcPass p)]
hs_splcds = [],
                       hs_docs :: [LDocDecl]
hs_docs = [] }

appendGroups :: HsGroup (GhcPass p) -> HsGroup (GhcPass p)
             -> HsGroup (GhcPass p)
appendGroups :: HsGroup (GhcPass p) -> HsGroup (GhcPass p) -> HsGroup (GhcPass p)
appendGroups
    HsGroup {
        hs_valds :: forall p. HsGroup p -> HsValBinds p
hs_valds  = HsValBinds (GhcPass p)
val_groups1,
        hs_splcds :: forall p. HsGroup p -> [LSpliceDecl p]
hs_splcds = [LSpliceDecl (GhcPass p)]
spliceds1,
        hs_tyclds :: forall p. HsGroup p -> [TyClGroup p]
hs_tyclds = [TyClGroup (GhcPass p)]
tyclds1,
        hs_derivds :: forall p. HsGroup p -> [LDerivDecl p]
hs_derivds = [LDerivDecl (GhcPass p)]
derivds1,
        hs_fixds :: forall p. HsGroup p -> [LFixitySig p]
hs_fixds  = [LFixitySig (GhcPass p)]
fixds1,
        hs_defds :: forall p. HsGroup p -> [LDefaultDecl p]
hs_defds  = [LDefaultDecl (GhcPass p)]
defds1,
        hs_annds :: forall p. HsGroup p -> [LAnnDecl p]
hs_annds  = [LAnnDecl (GhcPass p)]
annds1,
        hs_fords :: forall p. HsGroup p -> [LForeignDecl p]
hs_fords  = [LForeignDecl (GhcPass p)]
fords1,
        hs_warnds :: forall p. HsGroup p -> [LWarnDecls p]
hs_warnds = [LWarnDecls (GhcPass p)]
warnds1,
        hs_ruleds :: forall p. HsGroup p -> [LRuleDecls p]
hs_ruleds = [LRuleDecls (GhcPass p)]
rulds1,
        hs_docs :: forall p. HsGroup p -> [LDocDecl]
hs_docs   = [LDocDecl]
docs1 }
    HsGroup {
        hs_valds :: forall p. HsGroup p -> HsValBinds p
hs_valds  = HsValBinds (GhcPass p)
val_groups2,
        hs_splcds :: forall p. HsGroup p -> [LSpliceDecl p]
hs_splcds = [LSpliceDecl (GhcPass p)]
spliceds2,
        hs_tyclds :: forall p. HsGroup p -> [TyClGroup p]
hs_tyclds = [TyClGroup (GhcPass p)]
tyclds2,
        hs_derivds :: forall p. HsGroup p -> [LDerivDecl p]
hs_derivds = [LDerivDecl (GhcPass p)]
derivds2,
        hs_fixds :: forall p. HsGroup p -> [LFixitySig p]
hs_fixds  = [LFixitySig (GhcPass p)]
fixds2,
        hs_defds :: forall p. HsGroup p -> [LDefaultDecl p]
hs_defds  = [LDefaultDecl (GhcPass p)]
defds2,
        hs_annds :: forall p. HsGroup p -> [LAnnDecl p]
hs_annds  = [LAnnDecl (GhcPass p)]
annds2,
        hs_fords :: forall p. HsGroup p -> [LForeignDecl p]
hs_fords  = [LForeignDecl (GhcPass p)]
fords2,
        hs_warnds :: forall p. HsGroup p -> [LWarnDecls p]
hs_warnds = [LWarnDecls (GhcPass p)]
warnds2,
        hs_ruleds :: forall p. HsGroup p -> [LRuleDecls p]
hs_ruleds = [LRuleDecls (GhcPass p)]
rulds2,
        hs_docs :: forall p. HsGroup p -> [LDocDecl]
hs_docs   = [LDocDecl]
docs2 }
  =
    HsGroup :: forall p.
XCHsGroup p
-> HsValBinds p
-> [LSpliceDecl p]
-> [TyClGroup p]
-> [LDerivDecl p]
-> [LFixitySig p]
-> [LDefaultDecl p]
-> [LForeignDecl p]
-> [LWarnDecls p]
-> [LAnnDecl p]
-> [LRuleDecls p]
-> [LDocDecl]
-> HsGroup p
HsGroup {
        hs_ext :: XCHsGroup (GhcPass p)
hs_ext    = XCHsGroup (GhcPass p)
NoExtField
noExtField,
        hs_valds :: HsValBinds (GhcPass p)
hs_valds  = HsValBinds (GhcPass p)
val_groups1 HsValBinds (GhcPass p)
-> HsValBinds (GhcPass p) -> HsValBinds (GhcPass p)
forall (a :: Pass).
HsValBinds (GhcPass a)
-> HsValBinds (GhcPass a) -> HsValBinds (GhcPass a)
`plusHsValBinds` HsValBinds (GhcPass p)
val_groups2,
        hs_splcds :: [LSpliceDecl (GhcPass p)]
hs_splcds = [LSpliceDecl (GhcPass p)]
spliceds1 [LSpliceDecl (GhcPass p)]
-> [LSpliceDecl (GhcPass p)] -> [LSpliceDecl (GhcPass p)]
forall a. [a] -> [a] -> [a]
++ [LSpliceDecl (GhcPass p)]
spliceds2,
        hs_tyclds :: [TyClGroup (GhcPass p)]
hs_tyclds = [TyClGroup (GhcPass p)]
tyclds1 [TyClGroup (GhcPass p)]
-> [TyClGroup (GhcPass p)] -> [TyClGroup (GhcPass p)]
forall a. [a] -> [a] -> [a]
++ [TyClGroup (GhcPass p)]
tyclds2,
        hs_derivds :: [LDerivDecl (GhcPass p)]
hs_derivds = [LDerivDecl (GhcPass p)]
derivds1 [LDerivDecl (GhcPass p)]
-> [LDerivDecl (GhcPass p)] -> [LDerivDecl (GhcPass p)]
forall a. [a] -> [a] -> [a]
++ [LDerivDecl (GhcPass p)]
derivds2,
        hs_fixds :: [LFixitySig (GhcPass p)]
hs_fixds  = [LFixitySig (GhcPass p)]
fixds1 [LFixitySig (GhcPass p)]
-> [LFixitySig (GhcPass p)] -> [LFixitySig (GhcPass p)]
forall a. [a] -> [a] -> [a]
++ [LFixitySig (GhcPass p)]
fixds2,
        hs_annds :: [LAnnDecl (GhcPass p)]
hs_annds  = [LAnnDecl (GhcPass p)]
annds1 [LAnnDecl (GhcPass p)]
-> [LAnnDecl (GhcPass p)] -> [LAnnDecl (GhcPass p)]
forall a. [a] -> [a] -> [a]
++ [LAnnDecl (GhcPass p)]
annds2,
        hs_defds :: [LDefaultDecl (GhcPass p)]
hs_defds  = [LDefaultDecl (GhcPass p)]
defds1 [LDefaultDecl (GhcPass p)]
-> [LDefaultDecl (GhcPass p)] -> [LDefaultDecl (GhcPass p)]
forall a. [a] -> [a] -> [a]
++ [LDefaultDecl (GhcPass p)]
defds2,
        hs_fords :: [LForeignDecl (GhcPass p)]
hs_fords  = [LForeignDecl (GhcPass p)]
fords1 [LForeignDecl (GhcPass p)]
-> [LForeignDecl (GhcPass p)] -> [LForeignDecl (GhcPass p)]
forall a. [a] -> [a] -> [a]
++ [LForeignDecl (GhcPass p)]
fords2,
        hs_warnds :: [LWarnDecls (GhcPass p)]
hs_warnds = [LWarnDecls (GhcPass p)]
warnds1 [LWarnDecls (GhcPass p)]
-> [LWarnDecls (GhcPass p)] -> [LWarnDecls (GhcPass p)]
forall a. [a] -> [a] -> [a]
++ [LWarnDecls (GhcPass p)]
warnds2,
        hs_ruleds :: [LRuleDecls (GhcPass p)]
hs_ruleds = [LRuleDecls (GhcPass p)]
rulds1 [LRuleDecls (GhcPass p)]
-> [LRuleDecls (GhcPass p)] -> [LRuleDecls (GhcPass p)]
forall a. [a] -> [a] -> [a]
++ [LRuleDecls (GhcPass p)]
rulds2,
        hs_docs :: [LDocDecl]
hs_docs   = [LDocDecl]
docs1  [LDocDecl] -> [LDocDecl] -> [LDocDecl]
forall a. [a] -> [a] -> [a]
++ [LDocDecl]
docs2 }
appendGroups HsGroup (GhcPass p)
_ HsGroup (GhcPass p)
_ = [Char] -> HsGroup (GhcPass p)
forall a. [Char] -> a
panic [Char]
"appendGroups"

instance (OutputableBndrId p) => Outputable (HsDecl (GhcPass p)) where
    ppr :: HsDecl (GhcPass p) -> SDoc
ppr (TyClD XTyClD (GhcPass p)
_ TyClDecl (GhcPass p)
dcl)             = TyClDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr TyClDecl (GhcPass p)
dcl
    ppr (ValD XValD (GhcPass p)
_ HsBind (GhcPass p)
binds)            = HsBind (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr HsBind (GhcPass p)
binds
    ppr (DefD XDefD (GhcPass p)
_ DefaultDecl (GhcPass p)
def)              = DefaultDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr DefaultDecl (GhcPass p)
def
    ppr (InstD XInstD (GhcPass p)
_ InstDecl (GhcPass p)
inst)            = InstDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr InstDecl (GhcPass p)
inst
    ppr (DerivD XDerivD (GhcPass p)
_ DerivDecl (GhcPass p)
deriv)          = DerivDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr DerivDecl (GhcPass p)
deriv
    ppr (ForD XForD (GhcPass p)
_ ForeignDecl (GhcPass p)
fd)               = ForeignDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr ForeignDecl (GhcPass p)
fd
    ppr (SigD XSigD (GhcPass p)
_ Sig (GhcPass p)
sd)               = Sig (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr Sig (GhcPass p)
sd
    ppr (KindSigD XKindSigD (GhcPass p)
_ StandaloneKindSig (GhcPass p)
ksd)          = StandaloneKindSig (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr StandaloneKindSig (GhcPass p)
ksd
    ppr (RuleD XRuleD (GhcPass p)
_ RuleDecls (GhcPass p)
rd)              = RuleDecls (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr RuleDecls (GhcPass p)
rd
    ppr (WarningD XWarningD (GhcPass p)
_ WarnDecls (GhcPass p)
wd)           = WarnDecls (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr WarnDecls (GhcPass p)
wd
    ppr (AnnD XAnnD (GhcPass p)
_ AnnDecl (GhcPass p)
ad)               = AnnDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr AnnDecl (GhcPass p)
ad
    ppr (SpliceD XSpliceD (GhcPass p)
_ SpliceDecl (GhcPass p)
dd)            = SpliceDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr SpliceDecl (GhcPass p)
dd
    ppr (DocD XDocD (GhcPass p)
_ DocDecl
doc)              = DocDecl -> SDoc
forall a. Outputable a => a -> SDoc
ppr DocDecl
doc
    ppr (RoleAnnotD XRoleAnnotD (GhcPass p)
_ RoleAnnotDecl (GhcPass p)
ra)         = RoleAnnotDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr RoleAnnotDecl (GhcPass p)
ra
    ppr (XHsDecl XXHsDecl (GhcPass p)
x)               = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsDecl (GhcPass p)
NoExtCon
x

instance (OutputableBndrId p) => Outputable (HsGroup (GhcPass p)) where
    ppr :: HsGroup (GhcPass p) -> SDoc
ppr (HsGroup { hs_valds :: forall p. HsGroup p -> HsValBinds p
hs_valds  = HsValBinds (GhcPass p)
val_decls,
                   hs_tyclds :: forall p. HsGroup p -> [TyClGroup p]
hs_tyclds = [TyClGroup (GhcPass p)]
tycl_decls,
                   hs_derivds :: forall p. HsGroup p -> [LDerivDecl p]
hs_derivds = [LDerivDecl (GhcPass p)]
deriv_decls,
                   hs_fixds :: forall p. HsGroup p -> [LFixitySig p]
hs_fixds  = [LFixitySig (GhcPass p)]
fix_decls,
                   hs_warnds :: forall p. HsGroup p -> [LWarnDecls p]
hs_warnds = [LWarnDecls (GhcPass p)]
deprec_decls,
                   hs_annds :: forall p. HsGroup p -> [LAnnDecl p]
hs_annds  = [LAnnDecl (GhcPass p)]
ann_decls,
                   hs_fords :: forall p. HsGroup p -> [LForeignDecl p]
hs_fords  = [LForeignDecl (GhcPass p)]
foreign_decls,
                   hs_defds :: forall p. HsGroup p -> [LDefaultDecl p]
hs_defds  = [LDefaultDecl (GhcPass p)]
default_decls,
                   hs_ruleds :: forall p. HsGroup p -> [LRuleDecls p]
hs_ruleds = [LRuleDecls (GhcPass p)]
rule_decls })
        = SDoc -> [Maybe SDoc] -> SDoc
vcat_mb SDoc
empty
            [[LFixitySig (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LFixitySig (GhcPass p)]
fix_decls, [LDefaultDecl (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LDefaultDecl (GhcPass p)]
default_decls,
             [LWarnDecls (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LWarnDecls (GhcPass p)]
deprec_decls, [LAnnDecl (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LAnnDecl (GhcPass p)]
ann_decls,
             [LRuleDecls (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LRuleDecls (GhcPass p)]
rule_decls,
             if HsValBinds (GhcPass p) -> Bool
forall (a :: Pass) (b :: Pass).
HsValBindsLR (GhcPass a) (GhcPass b) -> Bool
isEmptyValBinds HsValBinds (GhcPass p)
val_decls
                then Maybe SDoc
forall a. Maybe a
Nothing
                else SDoc -> Maybe SDoc
forall a. a -> Maybe a
Just (HsValBinds (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr HsValBinds (GhcPass p)
val_decls),
             [LRoleAnnotDecl (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds ([TyClGroup (GhcPass p)] -> [LRoleAnnotDecl (GhcPass p)]
forall pass. [TyClGroup pass] -> [LRoleAnnotDecl pass]
tyClGroupRoleDecls [TyClGroup (GhcPass p)]
tycl_decls),
             [LStandaloneKindSig (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds ([TyClGroup (GhcPass p)] -> [LStandaloneKindSig (GhcPass p)]
forall pass. [TyClGroup pass] -> [LStandaloneKindSig pass]
tyClGroupKindSigs  [TyClGroup (GhcPass p)]
tycl_decls),
             [LTyClDecl (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds ([TyClGroup (GhcPass p)] -> [LTyClDecl (GhcPass p)]
forall pass. [TyClGroup pass] -> [LTyClDecl pass]
tyClGroupTyClDecls [TyClGroup (GhcPass p)]
tycl_decls),
             [LInstDecl (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds ([TyClGroup (GhcPass p)] -> [LInstDecl (GhcPass p)]
forall pass. [TyClGroup pass] -> [LInstDecl pass]
tyClGroupInstDecls [TyClGroup (GhcPass p)]
tycl_decls),
             [LDerivDecl (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LDerivDecl (GhcPass p)]
deriv_decls,
             [LForeignDecl (GhcPass p)] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LForeignDecl (GhcPass p)]
foreign_decls]
        where
          ppr_ds :: Outputable a => [a] -> Maybe SDoc
          ppr_ds :: [a] -> Maybe SDoc
ppr_ds [] = Maybe SDoc
forall a. Maybe a
Nothing
          ppr_ds [a]
ds = SDoc -> Maybe SDoc
forall a. a -> Maybe a
Just ([SDoc] -> SDoc
vcat ((a -> SDoc) -> [a] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map a -> SDoc
forall a. Outputable a => a -> SDoc
ppr [a]
ds))

          vcat_mb :: SDoc -> [Maybe SDoc] -> SDoc
          -- Concatenate vertically with white-space between non-blanks
          vcat_mb :: SDoc -> [Maybe SDoc] -> SDoc
vcat_mb SDoc
_    []             = SDoc
empty
          vcat_mb SDoc
gap (Maybe SDoc
Nothing : [Maybe SDoc]
ds) = SDoc -> [Maybe SDoc] -> SDoc
vcat_mb SDoc
gap [Maybe SDoc]
ds
          vcat_mb SDoc
gap (Just SDoc
d  : [Maybe SDoc]
ds) = SDoc
gap SDoc -> SDoc -> SDoc
$$ SDoc
d SDoc -> SDoc -> SDoc
$$ SDoc -> [Maybe SDoc] -> SDoc
vcat_mb SDoc
blankLine [Maybe SDoc]
ds
    ppr (XHsGroup XXHsGroup (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsGroup (GhcPass p)
NoExtCon
x

-- | Located Splice Declaration
type LSpliceDecl pass = Located (SpliceDecl pass)

-- | Splice Declaration
data SpliceDecl p
  = SpliceDecl                  -- Top level splice
        (XSpliceDecl p)
        (Located (HsSplice p))
        SpliceExplicitFlag
  | XSpliceDecl (XXSpliceDecl p)

type instance XSpliceDecl      (GhcPass _) = NoExtField
type instance XXSpliceDecl     (GhcPass _) = NoExtCon

instance OutputableBndrId p
       => Outputable (SpliceDecl (GhcPass p)) where
   ppr :: SpliceDecl (GhcPass p) -> SDoc
ppr (SpliceDecl XSpliceDecl (GhcPass p)
_ (L SrcSpan
_ HsSplice (GhcPass p)
e) SpliceExplicitFlag
f) = HsSplice (GhcPass p) -> SpliceExplicitFlag -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
HsSplice (GhcPass p) -> SpliceExplicitFlag -> SDoc
pprSpliceDecl HsSplice (GhcPass p)
e SpliceExplicitFlag
f
   ppr (XSpliceDecl XXSpliceDecl (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXSpliceDecl (GhcPass p)
NoExtCon
x

{-
************************************************************************
*                                                                      *
            Type and class declarations
*                                                                      *
************************************************************************

Note [The Naming story]
~~~~~~~~~~~~~~~~~~~~~~~
Here is the story about the implicit names that go with type, class,
and instance decls.  It's a bit tricky, so pay attention!

"Implicit" (or "system") binders
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  Each data type decl defines
        a worker name for each constructor
        to-T and from-T convertors
  Each class decl defines
        a tycon for the class
        a data constructor for that tycon
        the worker for that constructor
        a selector for each superclass

All have occurrence names that are derived uniquely from their parent
declaration.

None of these get separate definitions in an interface file; they are
fully defined by the data or class decl.  But they may *occur* in
interface files, of course.  Any such occurrence must haul in the
relevant type or class decl.

Plan of attack:
 - Ensure they "point to" the parent data/class decl
   when loading that decl from an interface file
   (See RnHiFiles.getSysBinders)

 - When typechecking the decl, we build the implicit TyCons and Ids.
   When doing so we look them up in the name cache (RnEnv.lookupSysName),
   to ensure correct module and provenance is set

These are the two places that we have to conjure up the magic derived
names.  (The actual magic is in OccName.mkWorkerOcc, etc.)

Default methods
~~~~~~~~~~~~~~~
 - Occurrence name is derived uniquely from the method name
   E.g. $dmmax

 - If there is a default method name at all, it's recorded in
   the ClassOpSig (in GHC.Hs.Binds), in the DefMethInfo field.
   (DefMethInfo is defined in Class.hs)

Source-code class decls and interface-code class decls are treated subtly
differently, which has given me a great deal of confusion over the years.
Here's the deal.  (We distinguish the two cases because source-code decls
have (Just binds) in the tcdMeths field, whereas interface decls have Nothing.

In *source-code* class declarations:

 - When parsing, every ClassOpSig gets a DefMeth with a suitable RdrName
   This is done by RdrHsSyn.mkClassOpSigDM

 - The renamer renames it to a Name

 - During typechecking, we generate a binding for each $dm for
   which there's a programmer-supplied default method:
        class Foo a where
          op1 :: <type>
          op2 :: <type>
          op1 = ...
   We generate a binding for $dmop1 but not for $dmop2.
   The Class for Foo has a Nothing for op2 and
                         a Just ($dm_op1, VanillaDM) for op1.
   The Name for $dmop2 is simply discarded.

In *interface-file* class declarations:
  - When parsing, we see if there's an explicit programmer-supplied default method
    because there's an '=' sign to indicate it:
        class Foo a where
          op1 = :: <type>       -- NB the '='
          op2   :: <type>
    We use this info to generate a DefMeth with a suitable RdrName for op1,
    and a NoDefMeth for op2
  - The interface file has a separate definition for $dmop1, with unfolding etc.
  - The renamer renames it to a Name.
  - The renamer treats $dmop1 as a free variable of the declaration, so that
    the binding for $dmop1 will be sucked in.  (See RnHsSyn.tyClDeclFVs)
    This doesn't happen for source code class decls, because they *bind* the default method.

Dictionary functions
~~~~~~~~~~~~~~~~~~~~
Each instance declaration gives rise to one dictionary function binding.

The type checker makes up new source-code instance declarations
(e.g. from 'deriving' or generic default methods --- see
TcInstDcls.tcInstDecls1).  So we can't generate the names for
dictionary functions in advance (we don't know how many we need).

On the other hand for interface-file instance declarations, the decl
specifies the name of the dictionary function, and it has a binding elsewhere
in the interface file:
        instance {Eq Int} = dEqInt
        dEqInt :: {Eq Int} <pragma info>

So again we treat source code and interface file code slightly differently.

Source code:
  - Source code instance decls have a Nothing in the (Maybe name) field
    (see data InstDecl below)

  - The typechecker makes up a Local name for the dict fun for any source-code
    instance decl, whether it comes from a source-code instance decl, or whether
    the instance decl is derived from some other construct (e.g. 'deriving').

  - The occurrence name it chooses is derived from the instance decl (just for
    documentation really) --- e.g. dNumInt.  Two dict funs may share a common
    occurrence name, but will have different uniques.  E.g.
        instance Foo [Int]  where ...
        instance Foo [Bool] where ...
    These might both be dFooList

  - The CoreTidy phase externalises the name, and ensures the occurrence name is
    unique (this isn't special to dict funs).  So we'd get dFooList and dFooList1.

  - We can take this relaxed approach (changing the occurrence name later)
    because dict fun Ids are not captured in a TyCon or Class (unlike default
    methods, say).  Instead, they are kept separately in the InstEnv.  This
    makes it easy to adjust them after compiling a module.  (Once we've finished
    compiling that module, they don't change any more.)


Interface file code:
  - The instance decl gives the dict fun name, so the InstDecl has a (Just name)
    in the (Maybe name) field.

  - RnHsSyn.instDeclFVs treats the dict fun name as free in the decl, so that we
    suck in the dfun binding
-}

-- | Located Declaration of a Type or Class
type LTyClDecl pass = Located (TyClDecl pass)

-- | A type or class declaration.
data TyClDecl pass
  = -- | @type/data family T :: *->*@
    --
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnType',
    --             'ApiAnnotation.AnnData',
    --             'ApiAnnotation.AnnFamily','ApiAnnotation.AnnDcolon',
    --             'ApiAnnotation.AnnWhere','ApiAnnotation.AnnOpenP',
    --             'ApiAnnotation.AnnDcolon','ApiAnnotation.AnnCloseP',
    --             'ApiAnnotation.AnnEqual','ApiAnnotation.AnnRarrow',
    --             'ApiAnnotation.AnnVbar'

    -- For details on above see note [Api annotations] in ApiAnnotation
    FamDecl { TyClDecl pass -> XFamDecl pass
tcdFExt :: XFamDecl pass, TyClDecl pass -> FamilyDecl pass
tcdFam :: FamilyDecl pass }

  | -- | @type@ declaration
    --
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnType',
    --             'ApiAnnotation.AnnEqual',

    -- For details on above see note [Api annotations] in ApiAnnotation
    SynDecl { TyClDecl pass -> XSynDecl pass
tcdSExt   :: XSynDecl pass          -- ^ Post renameer, FVs
            , TyClDecl pass -> Located (IdP pass)
tcdLName  :: Located (IdP pass)     -- ^ Type constructor
            , TyClDecl pass -> LHsQTyVars pass
tcdTyVars :: LHsQTyVars pass        -- ^ Type variables; for an
                                                  -- associated type these
                                                  -- include outer binders
            , TyClDecl pass -> LexicalFixity
tcdFixity :: LexicalFixity    -- ^ Fixity used in the declaration
            , TyClDecl pass -> LHsType pass
tcdRhs    :: LHsType pass }         -- ^ RHS of type declaration

  | -- | @data@ declaration
    --
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnData',
    --              'ApiAnnotation.AnnFamily',
    --              'ApiAnnotation.AnnNewType',
    --              'ApiAnnotation.AnnNewType','ApiAnnotation.AnnDcolon'
    --              'ApiAnnotation.AnnWhere',

    -- For details on above see note [Api annotations] in ApiAnnotation
    DataDecl { TyClDecl pass -> XDataDecl pass
tcdDExt     :: XDataDecl pass       -- ^ Post renamer, CUSK flag, FVs
             , tcdLName    :: Located (IdP pass)   -- ^ Type constructor
             , tcdTyVars   :: LHsQTyVars pass      -- ^ Type variables
                              -- See Note [TyVar binders for associated declarations]
             , tcdFixity   :: LexicalFixity        -- ^ Fixity used in the declaration
             , TyClDecl pass -> HsDataDefn pass
tcdDataDefn :: HsDataDefn pass }

  | ClassDecl { TyClDecl pass -> XClassDecl pass
tcdCExt    :: XClassDecl pass,         -- ^ Post renamer, FVs
                TyClDecl pass -> LHsContext pass
tcdCtxt    :: LHsContext pass,         -- ^ Context...
                tcdLName   :: Located (IdP pass),      -- ^ Name of the class
                tcdTyVars  :: LHsQTyVars pass,         -- ^ Class type variables
                tcdFixity  :: LexicalFixity, -- ^ Fixity used in the declaration
                TyClDecl pass -> [LHsFunDep pass]
tcdFDs     :: [LHsFunDep pass],         -- ^ Functional deps
                TyClDecl pass -> [LSig pass]
tcdSigs    :: [LSig pass],              -- ^ Methods' signatures
                TyClDecl pass -> LHsBinds pass
tcdMeths   :: LHsBinds pass,            -- ^ Default methods
                TyClDecl pass -> [LFamilyDecl pass]
tcdATs     :: [LFamilyDecl pass],       -- ^ Associated types;
                TyClDecl pass -> [LTyFamDefltDecl pass]
tcdATDefs  :: [LTyFamDefltDecl pass],   -- ^ Associated type defaults
                TyClDecl pass -> [LDocDecl]
tcdDocs    :: [LDocDecl]                -- ^ Haddock docs
    }
        -- ^ - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnClass',
        --           'ApiAnnotation.AnnWhere','ApiAnnotation.AnnOpen',
        --           'ApiAnnotation.AnnClose'
        --   - The tcdFDs will have 'ApiAnnotation.AnnVbar',
        --                          'ApiAnnotation.AnnComma'
        --                          'ApiAnnotation.AnnRarrow'

        -- For details on above see note [Api annotations] in ApiAnnotation
  | XTyClDecl (XXTyClDecl pass)

type LHsFunDep pass = Located (FunDep (Located (IdP pass)))

data DataDeclRn = DataDeclRn
             { DataDeclRn -> Bool
tcdDataCusk :: Bool    -- ^ does this have a CUSK?
                 -- See Note [CUSKs: complete user-supplied kind signatures]
             , DataDeclRn -> NameSet
tcdFVs      :: NameSet }
  deriving Typeable DataDeclRn
DataType
Constr
Typeable DataDeclRn
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> DataDeclRn -> c DataDeclRn)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c DataDeclRn)
-> (DataDeclRn -> Constr)
-> (DataDeclRn -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c DataDeclRn))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e))
    -> Maybe (c DataDeclRn))
-> ((forall b. Data b => b -> b) -> DataDeclRn -> DataDeclRn)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> DataDeclRn -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> DataDeclRn -> r)
-> (forall u. (forall d. Data d => d -> u) -> DataDeclRn -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> DataDeclRn -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn)
-> Data DataDeclRn
DataDeclRn -> DataType
DataDeclRn -> Constr
(forall b. Data b => b -> b) -> DataDeclRn -> DataDeclRn
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> DataDeclRn -> c DataDeclRn
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c DataDeclRn
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> DataDeclRn -> u
forall u. (forall d. Data d => d -> u) -> DataDeclRn -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> DataDeclRn -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> DataDeclRn -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c DataDeclRn
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> DataDeclRn -> c DataDeclRn
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c DataDeclRn)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DataDeclRn)
$cDataDeclRn :: Constr
$tDataDeclRn :: DataType
gmapMo :: (forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn
gmapMp :: (forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn
gmapM :: (forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> DataDeclRn -> m DataDeclRn
gmapQi :: Int -> (forall d. Data d => d -> u) -> DataDeclRn -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> DataDeclRn -> u
gmapQ :: (forall d. Data d => d -> u) -> DataDeclRn -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> DataDeclRn -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> DataDeclRn -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> DataDeclRn -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> DataDeclRn -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> DataDeclRn -> r
gmapT :: (forall b. Data b => b -> b) -> DataDeclRn -> DataDeclRn
$cgmapT :: (forall b. Data b => b -> b) -> DataDeclRn -> DataDeclRn
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DataDeclRn)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DataDeclRn)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c DataDeclRn)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c DataDeclRn)
dataTypeOf :: DataDeclRn -> DataType
$cdataTypeOf :: DataDeclRn -> DataType
toConstr :: DataDeclRn -> Constr
$ctoConstr :: DataDeclRn -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c DataDeclRn
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c DataDeclRn
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> DataDeclRn -> c DataDeclRn
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> DataDeclRn -> c DataDeclRn
$cp1Data :: Typeable DataDeclRn
Data

{- Note [TyVar binders for associated decls]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For an /associated/ data, newtype, or type-family decl, the LHsQTyVars
/includes/ outer binders.  For example
    class T a where
       data D a c
       type F a b :: *
       type F a b = a -> a
Here the data decl for 'D', and type-family decl for 'F', both include 'a'
in their LHsQTyVars (tcdTyVars and fdTyVars resp).

Ditto any implicit binders in the hsq_implicit field of the LHSQTyVars.

The idea is that the associated type is really a top-level decl in its
own right.  However we are careful to use the same name 'a', so that
we can match things up.

c.f. Note [Associated type tyvar names] in Class.hs
     Note [Family instance declaration binders]
-}

type instance XFamDecl      (GhcPass _) = NoExtField

type instance XSynDecl      GhcPs = NoExtField
type instance XSynDecl      GhcRn = NameSet -- FVs
type instance XSynDecl      GhcTc = NameSet -- FVs

type instance XDataDecl     GhcPs = NoExtField
type instance XDataDecl     GhcRn = DataDeclRn
type instance XDataDecl     GhcTc = DataDeclRn

type instance XClassDecl    GhcPs = NoExtField
type instance XClassDecl    GhcRn = NameSet -- FVs
type instance XClassDecl    GhcTc = NameSet -- FVs

type instance XXTyClDecl    (GhcPass _) = NoExtCon

-- Simple classifiers for TyClDecl
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-- | @True@ <=> argument is a @data@\/@newtype@
-- declaration.
isDataDecl :: TyClDecl pass -> Bool
isDataDecl :: TyClDecl pass -> Bool
isDataDecl (DataDecl {}) = Bool
True
isDataDecl TyClDecl pass
_other        = Bool
False

-- | type or type instance declaration
isSynDecl :: TyClDecl pass -> Bool
isSynDecl :: TyClDecl pass -> Bool
isSynDecl (SynDecl {})   = Bool
True
isSynDecl TyClDecl pass
_other        = Bool
False

-- | type class
isClassDecl :: TyClDecl pass -> Bool
isClassDecl :: TyClDecl pass -> Bool
isClassDecl (ClassDecl {}) = Bool
True
isClassDecl TyClDecl pass
_              = Bool
False

-- | type/data family declaration
isFamilyDecl :: TyClDecl pass -> Bool
isFamilyDecl :: TyClDecl pass -> Bool
isFamilyDecl (FamDecl {})  = Bool
True
isFamilyDecl TyClDecl pass
_other        = Bool
False

-- | type family declaration
isTypeFamilyDecl :: TyClDecl pass -> Bool
isTypeFamilyDecl :: TyClDecl pass -> Bool
isTypeFamilyDecl (FamDecl XFamDecl pass
_ (FamilyDecl { fdInfo :: forall pass. FamilyDecl pass -> FamilyInfo pass
fdInfo = FamilyInfo pass
info })) = case FamilyInfo pass
info of
  FamilyInfo pass
OpenTypeFamily      -> Bool
True
  ClosedTypeFamily {} -> Bool
True
  FamilyInfo pass
_                   -> Bool
False
isTypeFamilyDecl TyClDecl pass
_ = Bool
False

-- | open type family info
isOpenTypeFamilyInfo :: FamilyInfo pass -> Bool
isOpenTypeFamilyInfo :: FamilyInfo pass -> Bool
isOpenTypeFamilyInfo FamilyInfo pass
OpenTypeFamily = Bool
True
isOpenTypeFamilyInfo FamilyInfo pass
_              = Bool
False

-- | closed type family info
isClosedTypeFamilyInfo :: FamilyInfo pass -> Bool
isClosedTypeFamilyInfo :: FamilyInfo pass -> Bool
isClosedTypeFamilyInfo (ClosedTypeFamily {}) = Bool
True
isClosedTypeFamilyInfo FamilyInfo pass
_                     = Bool
False

-- | data family declaration
isDataFamilyDecl :: TyClDecl pass -> Bool
isDataFamilyDecl :: TyClDecl pass -> Bool
isDataFamilyDecl (FamDecl XFamDecl pass
_ (FamilyDecl { fdInfo :: forall pass. FamilyDecl pass -> FamilyInfo pass
fdInfo = FamilyInfo pass
DataFamily })) = Bool
True
isDataFamilyDecl TyClDecl pass
_other      = Bool
False

-- Dealing with names

tyFamInstDeclName :: TyFamInstDecl (GhcPass p) -> IdP (GhcPass p)
tyFamInstDeclName :: TyFamInstDecl (GhcPass p) -> IdP (GhcPass p)
tyFamInstDeclName = Located (IdP (GhcPass p)) -> IdP (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc (Located (IdP (GhcPass p)) -> IdP (GhcPass p))
-> (TyFamInstDecl (GhcPass p) -> Located (IdP (GhcPass p)))
-> TyFamInstDecl (GhcPass p)
-> IdP (GhcPass p)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. TyFamInstDecl (GhcPass p) -> Located (IdP (GhcPass p))
forall (p :: Pass).
TyFamInstDecl (GhcPass p) -> Located (IdP (GhcPass p))
tyFamInstDeclLName

tyFamInstDeclLName :: TyFamInstDecl (GhcPass p) -> Located (IdP (GhcPass p))
tyFamInstDeclLName :: TyFamInstDecl (GhcPass p) -> Located (IdP (GhcPass p))
tyFamInstDeclLName (TyFamInstDecl { tfid_eqn :: forall pass. TyFamInstDecl pass -> TyFamInstEqn pass
tfid_eqn =
                     (HsIB { hsib_body :: forall pass thing. HsImplicitBndrs pass thing -> thing
hsib_body = FamEqn { feqn_tycon :: forall pass rhs. FamEqn pass rhs -> Located (IdP pass)
feqn_tycon = Located (IdP (GhcPass p))
ln }}) })
  = Located (IdP (GhcPass p))
ln
tyFamInstDeclLName (TyFamInstDecl (HsIB XHsIB (GhcPass p) (FamEqn (GhcPass p) (LHsType (GhcPass p)))
_ (XFamEqn XXFamEqn (GhcPass p) (LHsType (GhcPass p))
nec)))
  = NoExtCon -> Located (IdP (GhcPass p))
forall a. NoExtCon -> a
noExtCon XXFamEqn (GhcPass p) (LHsType (GhcPass p))
NoExtCon
nec
tyFamInstDeclLName (TyFamInstDecl (XHsImplicitBndrs XXHsImplicitBndrs
  (GhcPass p) (FamEqn (GhcPass p) (LHsType (GhcPass p)))
nec))
  = NoExtCon -> Located (IdP (GhcPass p))
forall a. NoExtCon -> a
noExtCon XXHsImplicitBndrs
  (GhcPass p) (FamEqn (GhcPass p) (LHsType (GhcPass p)))
NoExtCon
nec

tyClDeclLName :: TyClDecl pass -> Located (IdP pass)
tyClDeclLName :: TyClDecl pass -> Located (IdP pass)
tyClDeclLName (FamDecl { tcdFam :: forall pass. TyClDecl pass -> FamilyDecl pass
tcdFam = FamilyDecl { fdLName :: forall pass. FamilyDecl pass -> Located (IdP pass)
fdLName = Located (IdP pass)
ln } }) = Located (IdP pass)
ln
tyClDeclLName TyClDecl pass
decl = TyClDecl pass -> Located (IdP pass)
forall pass. TyClDecl pass -> Located (IdP pass)
tcdLName TyClDecl pass
decl

tcdName :: TyClDecl pass -> IdP pass
tcdName :: TyClDecl pass -> IdP pass
tcdName = Located (IdP pass) -> IdP pass
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc (Located (IdP pass) -> IdP pass)
-> (TyClDecl pass -> Located (IdP pass))
-> TyClDecl pass
-> IdP pass
forall b c a. (b -> c) -> (a -> b) -> a -> c
. TyClDecl pass -> Located (IdP pass)
forall pass. TyClDecl pass -> Located (IdP pass)
tyClDeclLName

tyClDeclTyVars :: TyClDecl pass -> LHsQTyVars pass
tyClDeclTyVars :: TyClDecl pass -> LHsQTyVars pass
tyClDeclTyVars (FamDecl { tcdFam :: forall pass. TyClDecl pass -> FamilyDecl pass
tcdFam = FamilyDecl { fdTyVars :: forall pass. FamilyDecl pass -> LHsQTyVars pass
fdTyVars = LHsQTyVars pass
tvs } }) = LHsQTyVars pass
tvs
tyClDeclTyVars TyClDecl pass
d = TyClDecl pass -> LHsQTyVars pass
forall pass. TyClDecl pass -> LHsQTyVars pass
tcdTyVars TyClDecl pass
d

countTyClDecls :: [TyClDecl pass] -> (Int, Int, Int, Int, Int)
        -- class, synonym decls, data, newtype, family decls
countTyClDecls :: [TyClDecl pass] -> (Int, Int, Int, Int, Int)
countTyClDecls [TyClDecl pass]
decls
 = ((TyClDecl pass -> Bool) -> [TyClDecl pass] -> Int
forall a. (a -> Bool) -> [a] -> Int
count TyClDecl pass -> Bool
forall pass. TyClDecl pass -> Bool
isClassDecl    [TyClDecl pass]
decls,
    (TyClDecl pass -> Bool) -> [TyClDecl pass] -> Int
forall a. (a -> Bool) -> [a] -> Int
count TyClDecl pass -> Bool
forall pass. TyClDecl pass -> Bool
isSynDecl      [TyClDecl pass]
decls,  -- excluding...
    (TyClDecl pass -> Bool) -> [TyClDecl pass] -> Int
forall a. (a -> Bool) -> [a] -> Int
count TyClDecl pass -> Bool
forall pass. TyClDecl pass -> Bool
isDataTy       [TyClDecl pass]
decls,  -- ...family...
    (TyClDecl pass -> Bool) -> [TyClDecl pass] -> Int
forall a. (a -> Bool) -> [a] -> Int
count TyClDecl pass -> Bool
forall pass. TyClDecl pass -> Bool
isNewTy        [TyClDecl pass]
decls,  -- ...instances
    (TyClDecl pass -> Bool) -> [TyClDecl pass] -> Int
forall a. (a -> Bool) -> [a] -> Int
count TyClDecl pass -> Bool
forall pass. TyClDecl pass -> Bool
isFamilyDecl   [TyClDecl pass]
decls)
 where
   isDataTy :: TyClDecl pass -> Bool
isDataTy DataDecl{ tcdDataDefn :: forall pass. TyClDecl pass -> HsDataDefn pass
tcdDataDefn = HsDataDefn { dd_ND :: forall pass. HsDataDefn pass -> NewOrData
dd_ND = NewOrData
DataType } } = Bool
True
   isDataTy TyClDecl pass
_                                                       = Bool
False

   isNewTy :: TyClDecl pass -> Bool
isNewTy DataDecl{ tcdDataDefn :: forall pass. TyClDecl pass -> HsDataDefn pass
tcdDataDefn = HsDataDefn { dd_ND :: forall pass. HsDataDefn pass -> NewOrData
dd_ND = NewOrData
NewType } } = Bool
True
   isNewTy TyClDecl pass
_                                                      = Bool
False

-- | Does this declaration have a complete, user-supplied kind signature?
-- See Note [CUSKs: complete user-supplied kind signatures]
hsDeclHasCusk :: TyClDecl GhcRn -> Bool
hsDeclHasCusk :: TyClDecl GhcRn -> Bool
hsDeclHasCusk (FamDecl { tcdFam :: forall pass. TyClDecl pass -> FamilyDecl pass
tcdFam =
    FamilyDecl { fdInfo :: forall pass. FamilyDecl pass -> FamilyInfo pass
fdInfo      = FamilyInfo GhcRn
fam_info
               , fdTyVars :: forall pass. FamilyDecl pass -> LHsQTyVars pass
fdTyVars    = LHsQTyVars GhcRn
tyvars
               , fdResultSig :: forall pass. FamilyDecl pass -> LFamilyResultSig pass
fdResultSig = L SrcSpan
_ FamilyResultSig GhcRn
resultSig } }) =
    case FamilyInfo GhcRn
fam_info of
      ClosedTypeFamily {} -> LHsQTyVars GhcRn -> Bool
forall pass. LHsQTyVars pass -> Bool
hsTvbAllKinded LHsQTyVars GhcRn
tyvars
                          Bool -> Bool -> Bool
&& Maybe (LHsKind GhcRn) -> Bool
forall a. Maybe a -> Bool
isJust (FamilyResultSig GhcRn -> Maybe (LHsKind GhcRn)
forall (p :: Pass).
FamilyResultSig (GhcPass p) -> Maybe (LHsKind (GhcPass p))
famResultKindSignature FamilyResultSig GhcRn
resultSig)
      FamilyInfo GhcRn
_ -> Bool
True -- Un-associated open type/data families have CUSKs
hsDeclHasCusk (SynDecl { tcdTyVars :: forall pass. TyClDecl pass -> LHsQTyVars pass
tcdTyVars = LHsQTyVars GhcRn
tyvars, tcdRhs :: forall pass. TyClDecl pass -> LHsType pass
tcdRhs = LHsKind GhcRn
rhs })
  = LHsQTyVars GhcRn -> Bool
forall pass. LHsQTyVars pass -> Bool
hsTvbAllKinded LHsQTyVars GhcRn
tyvars Bool -> Bool -> Bool
&& Maybe (LHsKind GhcRn) -> Bool
forall a. Maybe a -> Bool
isJust (LHsKind GhcRn -> Maybe (LHsKind GhcRn)
forall pass. LHsType pass -> Maybe (LHsType pass)
hsTyKindSig LHsKind GhcRn
rhs)
hsDeclHasCusk (DataDecl { tcdDExt :: forall pass. TyClDecl pass -> XDataDecl pass
tcdDExt = DataDeclRn { tcdDataCusk = cusk }}) = Bool
cusk
hsDeclHasCusk (ClassDecl { tcdTyVars :: forall pass. TyClDecl pass -> LHsQTyVars pass
tcdTyVars = LHsQTyVars GhcRn
tyvars }) = LHsQTyVars GhcRn -> Bool
forall pass. LHsQTyVars pass -> Bool
hsTvbAllKinded LHsQTyVars GhcRn
tyvars
hsDeclHasCusk (FamDecl { tcdFam :: forall pass. TyClDecl pass -> FamilyDecl pass
tcdFam = XFamilyDecl XXFamilyDecl GhcRn
nec }) = NoExtCon -> Bool
forall a. NoExtCon -> a
noExtCon XXFamilyDecl GhcRn
NoExtCon
nec
hsDeclHasCusk (XTyClDecl XXTyClDecl GhcRn
nec) = NoExtCon -> Bool
forall a. NoExtCon -> a
noExtCon XXTyClDecl GhcRn
NoExtCon
nec

-- Pretty-printing TyClDecl
-- ~~~~~~~~~~~~~~~~~~~~~~~~

instance (OutputableBndrId p) => Outputable (TyClDecl (GhcPass p)) where

    ppr :: TyClDecl (GhcPass p) -> SDoc
ppr (FamDecl { tcdFam :: forall pass. TyClDecl pass -> FamilyDecl pass
tcdFam = FamilyDecl (GhcPass p)
decl }) = FamilyDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr FamilyDecl (GhcPass p)
decl
    ppr (SynDecl { tcdLName :: forall pass. TyClDecl pass -> Located (IdP pass)
tcdLName = Located (IdP (GhcPass p))
ltycon, tcdTyVars :: forall pass. TyClDecl pass -> LHsQTyVars pass
tcdTyVars = LHsQTyVars (GhcPass p)
tyvars, tcdFixity :: forall pass. TyClDecl pass -> LexicalFixity
tcdFixity = LexicalFixity
fixity
                 , tcdRhs :: forall pass. TyClDecl pass -> LHsType pass
tcdRhs = LHsType (GhcPass p)
rhs })
      = SDoc -> Int -> SDoc -> SDoc
hang ([Char] -> SDoc
text [Char]
"type" SDoc -> SDoc -> SDoc
<+>
              Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
forall (p :: Pass).
OutputableBndrId p =>
Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
pp_vanilla_decl_head Located (IdP (GhcPass p))
ltycon LHsQTyVars (GhcPass p)
tyvars LexicalFixity
fixity LHsContext (GhcPass p)
forall pass. LHsContext pass
noLHsContext SDoc -> SDoc -> SDoc
<+> SDoc
equals)
          Int
4 (LHsType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsType (GhcPass p)
rhs)

    ppr (DataDecl { tcdLName :: forall pass. TyClDecl pass -> Located (IdP pass)
tcdLName = Located (IdP (GhcPass p))
ltycon, tcdTyVars :: forall pass. TyClDecl pass -> LHsQTyVars pass
tcdTyVars = LHsQTyVars (GhcPass p)
tyvars, tcdFixity :: forall pass. TyClDecl pass -> LexicalFixity
tcdFixity = LexicalFixity
fixity
                  , tcdDataDefn :: forall pass. TyClDecl pass -> HsDataDefn pass
tcdDataDefn = HsDataDefn (GhcPass p)
defn })
      = (LHsContext (GhcPass p) -> SDoc) -> HsDataDefn (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
(LHsContext (GhcPass p) -> SDoc) -> HsDataDefn (GhcPass p) -> SDoc
pp_data_defn (Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
forall (p :: Pass).
OutputableBndrId p =>
Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
pp_vanilla_decl_head Located (IdP (GhcPass p))
ltycon LHsQTyVars (GhcPass p)
tyvars LexicalFixity
fixity) HsDataDefn (GhcPass p)
defn

    ppr (ClassDecl {tcdCtxt :: forall pass. TyClDecl pass -> LHsContext pass
tcdCtxt = LHsContext (GhcPass p)
context, tcdLName :: forall pass. TyClDecl pass -> Located (IdP pass)
tcdLName = Located (IdP (GhcPass p))
lclas, tcdTyVars :: forall pass. TyClDecl pass -> LHsQTyVars pass
tcdTyVars = LHsQTyVars (GhcPass p)
tyvars,
                    tcdFixity :: forall pass. TyClDecl pass -> LexicalFixity
tcdFixity = LexicalFixity
fixity,
                    tcdFDs :: forall pass. TyClDecl pass -> [LHsFunDep pass]
tcdFDs  = [LHsFunDep (GhcPass p)]
fds,
                    tcdSigs :: forall pass. TyClDecl pass -> [LSig pass]
tcdSigs = [LSig (GhcPass p)]
sigs, tcdMeths :: forall pass. TyClDecl pass -> LHsBinds pass
tcdMeths = LHsBinds (GhcPass p)
methods,
                    tcdATs :: forall pass. TyClDecl pass -> [LFamilyDecl pass]
tcdATs = [LFamilyDecl (GhcPass p)]
ats, tcdATDefs :: forall pass. TyClDecl pass -> [LTyFamDefltDecl pass]
tcdATDefs = [LTyFamDefltDecl (GhcPass p)]
at_defs})
      | [LSig (GhcPass p)] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LSig (GhcPass p)]
sigs Bool -> Bool -> Bool
&& LHsBinds (GhcPass p) -> Bool
forall a. Bag a -> Bool
isEmptyBag LHsBinds (GhcPass p)
methods Bool -> Bool -> Bool
&& [LFamilyDecl (GhcPass p)] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LFamilyDecl (GhcPass p)]
ats Bool -> Bool -> Bool
&& [LTyFamDefltDecl (GhcPass p)] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LTyFamDefltDecl (GhcPass p)]
at_defs -- No "where" part
      = SDoc
top_matter

      | Bool
otherwise       -- Laid out
      = [SDoc] -> SDoc
vcat [ SDoc
top_matter SDoc -> SDoc -> SDoc
<+> [Char] -> SDoc
text [Char]
"where"
             , Int -> SDoc -> SDoc
nest Int
2 (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ [SDoc] -> SDoc
pprDeclList ((LFamilyDecl (GhcPass p) -> SDoc)
-> [LFamilyDecl (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (TopLevelFlag -> FamilyDecl (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
TopLevelFlag -> FamilyDecl (GhcPass p) -> SDoc
pprFamilyDecl TopLevelFlag
NotTopLevel (FamilyDecl (GhcPass p) -> SDoc)
-> (LFamilyDecl (GhcPass p) -> FamilyDecl (GhcPass p))
-> LFamilyDecl (GhcPass p)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LFamilyDecl (GhcPass p) -> FamilyDecl (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) [LFamilyDecl (GhcPass p)]
ats [SDoc] -> [SDoc] -> [SDoc]
forall a. [a] -> [a] -> [a]
++
                                     (LTyFamDefltDecl (GhcPass p) -> SDoc)
-> [LTyFamDefltDecl (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (TyFamDefltDecl (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
TyFamDefltDecl (GhcPass p) -> SDoc
pprTyFamDefltDecl (TyFamDefltDecl (GhcPass p) -> SDoc)
-> (LTyFamDefltDecl (GhcPass p) -> TyFamDefltDecl (GhcPass p))
-> LTyFamDefltDecl (GhcPass p)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LTyFamDefltDecl (GhcPass p) -> TyFamDefltDecl (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) [LTyFamDefltDecl (GhcPass p)]
at_defs [SDoc] -> [SDoc] -> [SDoc]
forall a. [a] -> [a] -> [a]
++
                                     LHsBinds (GhcPass p) -> [LSig (GhcPass p)] -> [SDoc]
forall (idL :: Pass) (idR :: Pass) (id2 :: Pass).
(OutputableBndrId idL, OutputableBndrId idR,
 OutputableBndrId id2) =>
LHsBindsLR (GhcPass idL) (GhcPass idR)
-> [LSig (GhcPass id2)] -> [SDoc]
pprLHsBindsForUser LHsBinds (GhcPass p)
methods [LSig (GhcPass p)]
sigs) ]
      where
        top_matter :: SDoc
top_matter = [Char] -> SDoc
text [Char]
"class"
                    SDoc -> SDoc -> SDoc
<+> Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
forall (p :: Pass).
OutputableBndrId p =>
Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
pp_vanilla_decl_head Located (IdP (GhcPass p))
lclas LHsQTyVars (GhcPass p)
tyvars LexicalFixity
fixity LHsContext (GhcPass p)
context
                    SDoc -> SDoc -> SDoc
<+> [FunDep (Located (IdP (GhcPass p)))] -> SDoc
forall a. Outputable a => [FunDep a] -> SDoc
pprFundeps ((LHsFunDep (GhcPass p) -> FunDep (Located (IdP (GhcPass p))))
-> [LHsFunDep (GhcPass p)] -> [FunDep (Located (IdP (GhcPass p)))]
forall a b. (a -> b) -> [a] -> [b]
map LHsFunDep (GhcPass p) -> FunDep (Located (IdP (GhcPass p)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc [LHsFunDep (GhcPass p)]
fds)

    ppr (XTyClDecl XXTyClDecl (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXTyClDecl (GhcPass p)
NoExtCon
x

instance OutputableBndrId p
       => Outputable (TyClGroup (GhcPass p)) where
  ppr :: TyClGroup (GhcPass p) -> SDoc
ppr (TyClGroup { group_tyclds :: forall pass. TyClGroup pass -> [LTyClDecl pass]
group_tyclds = [LTyClDecl (GhcPass p)]
tyclds
                 , group_roles :: forall pass. TyClGroup pass -> [LRoleAnnotDecl pass]
group_roles = [LRoleAnnotDecl (GhcPass p)]
roles
                 , group_kisigs :: forall pass. TyClGroup pass -> [LStandaloneKindSig pass]
group_kisigs = [LStandaloneKindSig (GhcPass p)]
kisigs
                 , group_instds :: forall pass. TyClGroup pass -> [LInstDecl pass]
group_instds = [LInstDecl (GhcPass p)]
instds
                 }
      )
    = SDoc -> Int -> SDoc -> SDoc
hang ([Char] -> SDoc
text [Char]
"TyClGroup") Int
2 (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$
      [LStandaloneKindSig (GhcPass p)] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LStandaloneKindSig (GhcPass p)]
kisigs SDoc -> SDoc -> SDoc
$$
      [LTyClDecl (GhcPass p)] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LTyClDecl (GhcPass p)]
tyclds SDoc -> SDoc -> SDoc
$$
      [LRoleAnnotDecl (GhcPass p)] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LRoleAnnotDecl (GhcPass p)]
roles SDoc -> SDoc -> SDoc
$$
      [LInstDecl (GhcPass p)] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LInstDecl (GhcPass p)]
instds
  ppr (XTyClGroup XXTyClGroup (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXTyClGroup (GhcPass p)
NoExtCon
x

pp_vanilla_decl_head :: (OutputableBndrId p)
   => Located (IdP (GhcPass p))
   -> LHsQTyVars (GhcPass p)
   -> LexicalFixity
   -> LHsContext (GhcPass p)
   -> SDoc
pp_vanilla_decl_head :: Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
pp_vanilla_decl_head Located (IdP (GhcPass p))
thing (HsQTvs { hsq_explicit :: forall pass. LHsQTyVars pass -> [LHsTyVarBndr pass]
hsq_explicit = [LHsTyVarBndr (GhcPass p)]
tyvars }) LexicalFixity
fixity LHsContext (GhcPass p)
context
 = [SDoc] -> SDoc
hsep [LHsContext (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
LHsContext (GhcPass p) -> SDoc
pprLHsContext LHsContext (GhcPass p)
context, [LHsTyVarBndr (GhcPass p)] -> SDoc
pp_tyvars [LHsTyVarBndr (GhcPass p)]
tyvars]
  where
    pp_tyvars :: [LHsTyVarBndr (GhcPass p)] -> SDoc
pp_tyvars (LHsTyVarBndr (GhcPass p)
varl:[LHsTyVarBndr (GhcPass p)]
varsr)
      | LexicalFixity
fixity LexicalFixity -> LexicalFixity -> Bool
forall a. Eq a => a -> a -> Bool
== LexicalFixity
Infix Bool -> Bool -> Bool
&& [LHsTyVarBndr (GhcPass p)] -> Int
forall (t :: * -> *) a. Foldable t => t a -> Int
length [LHsTyVarBndr (GhcPass p)]
varsr Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
> Int
1
         = [SDoc] -> SDoc
hsep [Char -> SDoc
char Char
'(',HsTyVarBndr (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr (LHsTyVarBndr (GhcPass p) -> SrcSpanLess (LHsTyVarBndr (GhcPass p))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc LHsTyVarBndr (GhcPass p)
varl), IdP (GhcPass p) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprInfixOcc (Located (IdP (GhcPass p))
-> SrcSpanLess (Located (IdP (GhcPass p)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (IdP (GhcPass p))
thing)
                , (HsTyVarBndr (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr(HsTyVarBndr (GhcPass p) -> SDoc)
-> (LHsTyVarBndr (GhcPass p) -> HsTyVarBndr (GhcPass p))
-> LHsTyVarBndr (GhcPass p)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
.LHsTyVarBndr (GhcPass p) -> HsTyVarBndr (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) ([LHsTyVarBndr (GhcPass p)] -> LHsTyVarBndr (GhcPass p)
forall a. [a] -> a
head [LHsTyVarBndr (GhcPass p)]
varsr), Char -> SDoc
char Char
')'
                , [SDoc] -> SDoc
hsep ((LHsTyVarBndr (GhcPass p) -> SDoc)
-> [LHsTyVarBndr (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (HsTyVarBndr (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr(HsTyVarBndr (GhcPass p) -> SDoc)
-> (LHsTyVarBndr (GhcPass p) -> HsTyVarBndr (GhcPass p))
-> LHsTyVarBndr (GhcPass p)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
.LHsTyVarBndr (GhcPass p) -> HsTyVarBndr (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) ([LHsTyVarBndr (GhcPass p)] -> [LHsTyVarBndr (GhcPass p)]
forall a. [a] -> [a]
tail [LHsTyVarBndr (GhcPass p)]
varsr))]
      | LexicalFixity
fixity LexicalFixity -> LexicalFixity -> Bool
forall a. Eq a => a -> a -> Bool
== LexicalFixity
Infix
         = [SDoc] -> SDoc
hsep [HsTyVarBndr (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr (LHsTyVarBndr (GhcPass p) -> SrcSpanLess (LHsTyVarBndr (GhcPass p))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc LHsTyVarBndr (GhcPass p)
varl), IdP (GhcPass p) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprInfixOcc (Located (IdP (GhcPass p))
-> SrcSpanLess (Located (IdP (GhcPass p)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (IdP (GhcPass p))
thing)
         , [SDoc] -> SDoc
hsep ((LHsTyVarBndr (GhcPass p) -> SDoc)
-> [LHsTyVarBndr (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (HsTyVarBndr (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr(HsTyVarBndr (GhcPass p) -> SDoc)
-> (LHsTyVarBndr (GhcPass p) -> HsTyVarBndr (GhcPass p))
-> LHsTyVarBndr (GhcPass p)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
.LHsTyVarBndr (GhcPass p) -> HsTyVarBndr (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) [LHsTyVarBndr (GhcPass p)]
varsr)]
      | Bool
otherwise = [SDoc] -> SDoc
hsep [ IdP (GhcPass p) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc (Located (IdP (GhcPass p))
-> SrcSpanLess (Located (IdP (GhcPass p)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (IdP (GhcPass p))
thing)
                  , [SDoc] -> SDoc
hsep ((LHsTyVarBndr (GhcPass p) -> SDoc)
-> [LHsTyVarBndr (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (HsTyVarBndr (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr(HsTyVarBndr (GhcPass p) -> SDoc)
-> (LHsTyVarBndr (GhcPass p) -> HsTyVarBndr (GhcPass p))
-> LHsTyVarBndr (GhcPass p)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
.LHsTyVarBndr (GhcPass p) -> HsTyVarBndr (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) (LHsTyVarBndr (GhcPass p)
varlLHsTyVarBndr (GhcPass p)
-> [LHsTyVarBndr (GhcPass p)] -> [LHsTyVarBndr (GhcPass p)]
forall a. a -> [a] -> [a]
:[LHsTyVarBndr (GhcPass p)]
varsr))]
    pp_tyvars [] = IdP (GhcPass p) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc (Located (IdP (GhcPass p))
-> SrcSpanLess (Located (IdP (GhcPass p)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (IdP (GhcPass p))
thing)
pp_vanilla_decl_head Located (IdP (GhcPass p))
_ (XLHsQTyVars XXLHsQTyVars (GhcPass p)
x) LexicalFixity
_ LHsContext (GhcPass p)
_ = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXLHsQTyVars (GhcPass p)
NoExtCon
x

pprTyClDeclFlavour :: TyClDecl (GhcPass p) -> SDoc
pprTyClDeclFlavour :: TyClDecl (GhcPass p) -> SDoc
pprTyClDeclFlavour (ClassDecl {})   = [Char] -> SDoc
text [Char]
"class"
pprTyClDeclFlavour (SynDecl {})     = [Char] -> SDoc
text [Char]
"type"
pprTyClDeclFlavour (FamDecl { tcdFam :: forall pass. TyClDecl pass -> FamilyDecl pass
tcdFam = FamilyDecl { fdInfo :: forall pass. FamilyDecl pass -> FamilyInfo pass
fdInfo = FamilyInfo (GhcPass p)
info }})
  = FamilyInfo (GhcPass p) -> SDoc
forall pass. FamilyInfo pass -> SDoc
pprFlavour FamilyInfo (GhcPass p)
info SDoc -> SDoc -> SDoc
<+> [Char] -> SDoc
text [Char]
"family"
pprTyClDeclFlavour (FamDecl { tcdFam :: forall pass. TyClDecl pass -> FamilyDecl pass
tcdFam = XFamilyDecl XXFamilyDecl (GhcPass p)
nec })
  = NoExtCon -> SDoc
forall a. NoExtCon -> a
noExtCon XXFamilyDecl (GhcPass p)
NoExtCon
nec
pprTyClDeclFlavour (DataDecl { tcdDataDefn :: forall pass. TyClDecl pass -> HsDataDefn pass
tcdDataDefn = HsDataDefn { dd_ND :: forall pass. HsDataDefn pass -> NewOrData
dd_ND = NewOrData
nd } })
  = NewOrData -> SDoc
forall a. Outputable a => a -> SDoc
ppr NewOrData
nd
pprTyClDeclFlavour (DataDecl { tcdDataDefn :: forall pass. TyClDecl pass -> HsDataDefn pass
tcdDataDefn = XHsDataDefn XXHsDataDefn (GhcPass p)
x })
  = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsDataDefn (GhcPass p)
NoExtCon
x
pprTyClDeclFlavour (XTyClDecl XXTyClDecl (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXTyClDecl (GhcPass p)
NoExtCon
x


{- Note [CUSKs: complete user-supplied kind signatures]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We kind-check declarations differently if they have a complete, user-supplied
kind signature (CUSK). This is because we can safely generalise a CUSKed
declaration before checking all of the others, supporting polymorphic recursion.
See https://gitlab.haskell.org/ghc/ghc/wikis/ghc-kinds/kind-inference#proposed-new-strategy
and #9200 for lots of discussion of how we got here.

The detection of CUSKs is enabled by the -XCUSKs extension, switched on by default.
Under -XNoCUSKs, all declarations are treated as if they have no CUSK.
See https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0036-kind-signatures.rst

PRINCIPLE:
  a type declaration has a CUSK iff we could produce a separate kind signature
  for it, just like a type signature for a function,
  looking only at the header of the declaration.

Examples:
  * data T1 (a :: *->*) (b :: *) = ....
    -- Has CUSK; equivalant to   T1 :: (*->*) -> * -> *

 * data T2 a b = ...
   -- No CUSK; we do not want to guess T2 :: * -> * -> *
   -- because the full decl might be   data T a b = MkT (a b)

  * data T3 (a :: k -> *) (b :: *) = ...
    -- CUSK; equivalent to   T3 :: (k -> *) -> * -> *
    -- We lexically generalise over k to get
    --    T3 :: forall k. (k -> *) -> * -> *
    -- The generalisation is here is purely lexical, just like
    --    f3 :: a -> a
    -- means
    --    f3 :: forall a. a -> a

  * data T4 (a :: j k) = ...
     -- CUSK; equivalent to   T4 :: j k -> *
     -- which we lexically generalise to  T4 :: forall j k. j k -> *
     -- and then, if PolyKinds is on, we further generalise to
     --   T4 :: forall kk (j :: kk -> *) (k :: kk). j k -> *
     -- Again this is exactly like what happens as the term level
     -- when you write
     --    f4 :: forall a b. a b -> Int

NOTE THAT
  * A CUSK does /not/ mean that everything about the kind signature is
    fully specified by the user.  Look at T4 and f4: we had do do kind
    inference to figure out the kind-quantification.  But in both cases
    (T4 and f4) that inference is done looking /only/ at the header of T4
    (or signature for f4), not at the definition thereof.

  * The CUSK completely fixes the kind of the type constructor, forever.

  * The precise rules, for each declaration form, for whethher a declaration
    has a CUSK are given in the user manual section "Complete user-supplied
    kind signatures and polymorphic recursion".  BUt they simply implement
    PRINCIPLE above.

  * Open type families are interesting:
      type family T5 a b :: *
    There simply /is/ no accompanying declaration, so that info is all
    we'll ever get.  So we it has a CUSK by definition, and we default
    any un-fixed kind variables to *.

  * Associated types are a bit tricker:
      class C6 a where
         type family T6 a b :: *
         op :: a Int -> Int
    Here C6 does not have a CUSK (in fact we ultimately discover that
    a :: * -> *).  And hence neither does T6, the associated family,
    because we can't fix its kind until we have settled C6.  Another
    way to say it: unlike a top-level, we /may/ discover more about
    a's kind from C6's definition.

  * A data definition with a top-level :: must explicitly bind all
    kind variables to the right of the ::. See test
    dependent/should_compile/KindLevels, which requires this
    case. (Naturally, any kind variable mentioned before the :: should
    not be bound after it.)

    This last point is much more debatable than the others; see
    #15142 comment:22

    Because this is fiddly to check, there is a field in the DataDeclRn
    structure (included in a DataDecl after the renamer) that stores whether
    or not the declaration has a CUSK.
-}


{- *********************************************************************
*                                                                      *
                         TyClGroup
        Strongly connected components of
      type, class, instance, and role declarations
*                                                                      *
********************************************************************* -}

{- Note [TyClGroups and dependency analysis]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A TyClGroup represents a strongly connected components of type/class/instance
decls, together with the role annotations for the type/class declarations.

The hs_tyclds :: [TyClGroup] field of a HsGroup is a dependency-order
sequence of strongly-connected components.

Invariants
 * The type and class declarations, group_tyclds, may depend on each
   other, or earlier TyClGroups, but not on later ones

 * The role annotations, group_roles, are role-annotations for some or
   all of the types and classes in group_tyclds (only).

 * The instance declarations, group_instds, may (and usually will)
   depend on group_tyclds, or on earlier TyClGroups, but not on later
   ones.

See Note [Dependency analsis of type, class, and instance decls]
in RnSource for more info.
-}

-- | Type or Class Group
data TyClGroup pass  -- See Note [TyClGroups and dependency analysis]
  = TyClGroup { TyClGroup pass -> XCTyClGroup pass
group_ext    :: XCTyClGroup pass
              , TyClGroup pass -> [LTyClDecl pass]
group_tyclds :: [LTyClDecl pass]
              , TyClGroup pass -> [LRoleAnnotDecl pass]
group_roles  :: [LRoleAnnotDecl pass]
              , TyClGroup pass -> [LStandaloneKindSig pass]
group_kisigs :: [LStandaloneKindSig pass]
              , TyClGroup pass -> [LInstDecl pass]
group_instds :: [LInstDecl pass] }
  | XTyClGroup (XXTyClGroup pass)

type instance XCTyClGroup (GhcPass _) = NoExtField
type instance XXTyClGroup (GhcPass _) = NoExtCon


tyClGroupTyClDecls :: [TyClGroup pass] -> [LTyClDecl pass]
tyClGroupTyClDecls :: [TyClGroup pass] -> [LTyClDecl pass]
tyClGroupTyClDecls = (TyClGroup pass -> [LTyClDecl pass])
-> [TyClGroup pass] -> [LTyClDecl pass]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap TyClGroup pass -> [LTyClDecl pass]
forall pass. TyClGroup pass -> [LTyClDecl pass]
group_tyclds

tyClGroupInstDecls :: [TyClGroup pass] -> [LInstDecl pass]
tyClGroupInstDecls :: [TyClGroup pass] -> [LInstDecl pass]
tyClGroupInstDecls = (TyClGroup pass -> [LInstDecl pass])
-> [TyClGroup pass] -> [LInstDecl pass]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap TyClGroup pass -> [LInstDecl pass]
forall pass. TyClGroup pass -> [LInstDecl pass]
group_instds

tyClGroupRoleDecls :: [TyClGroup pass] -> [LRoleAnnotDecl pass]
tyClGroupRoleDecls :: [TyClGroup pass] -> [LRoleAnnotDecl pass]
tyClGroupRoleDecls = (TyClGroup pass -> [LRoleAnnotDecl pass])
-> [TyClGroup pass] -> [LRoleAnnotDecl pass]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap TyClGroup pass -> [LRoleAnnotDecl pass]
forall pass. TyClGroup pass -> [LRoleAnnotDecl pass]
group_roles

tyClGroupKindSigs :: [TyClGroup pass] -> [LStandaloneKindSig pass]
tyClGroupKindSigs :: [TyClGroup pass] -> [LStandaloneKindSig pass]
tyClGroupKindSigs = (TyClGroup pass -> [LStandaloneKindSig pass])
-> [TyClGroup pass] -> [LStandaloneKindSig pass]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap TyClGroup pass -> [LStandaloneKindSig pass]
forall pass. TyClGroup pass -> [LStandaloneKindSig pass]
group_kisigs


{- *********************************************************************
*                                                                      *
               Data and type family declarations
*                                                                      *
********************************************************************* -}

{- Note [FamilyResultSig]
~~~~~~~~~~~~~~~~~~~~~~~~~

This data type represents the return signature of a type family.  Possible
values are:

 * NoSig - the user supplied no return signature:
      type family Id a where ...

 * KindSig - the user supplied the return kind:
      type family Id a :: * where ...

 * TyVarSig - user named the result with a type variable and possibly
   provided a kind signature for that variable:
      type family Id a = r where ...
      type family Id a = (r :: *) where ...

   Naming result of a type family is required if we want to provide
   injectivity annotation for a type family:
      type family Id a = r | r -> a where ...

See also: Note [Injectivity annotation]

Note [Injectivity annotation]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A user can declare a type family to be injective:

   type family Id a = r | r -> a where ...

 * The part after the "|" is called "injectivity annotation".
 * "r -> a" part is called "injectivity condition"; at the moment terms
   "injectivity annotation" and "injectivity condition" are synonymous
   because we only allow a single injectivity condition.
 * "r" is the "LHS of injectivity condition". LHS can only contain the
   variable naming the result of a type family.

 * "a" is the "RHS of injectivity condition". RHS contains space-separated
   type and kind variables representing the arguments of a type
   family. Variables can be omitted if a type family is not injective in
   these arguments. Example:
         type family Foo a b c = d | d -> a c where ...

Note that:
 (a) naming of type family result is required to provide injectivity
     annotation
 (b) for associated types if the result was named then injectivity annotation
     is mandatory. Otherwise result type variable is indistinguishable from
     associated type default.

It is possible that in the future this syntax will be extended to support
more complicated injectivity annotations. For example we could declare that
if we know the result of Plus and one of its arguments we can determine the
other argument:

   type family Plus a b = (r :: Nat) | r a -> b, r b -> a where ...

Here injectivity annotation would consist of two comma-separated injectivity
conditions.

See also Note [Injective type families] in TyCon
-}

-- | Located type Family Result Signature
type LFamilyResultSig pass = Located (FamilyResultSig pass)

-- | type Family Result Signature
data FamilyResultSig pass = -- see Note [FamilyResultSig]
    NoSig (XNoSig pass)
  -- ^ - 'ApiAnnotation.AnnKeywordId' :

  -- For details on above see note [Api annotations] in ApiAnnotation

  | KindSig  (XCKindSig pass) (LHsKind pass)
  -- ^ - 'ApiAnnotation.AnnKeywordId' :
  --             'ApiAnnotation.AnnOpenP','ApiAnnotation.AnnDcolon',
  --             'ApiAnnotation.AnnCloseP'

  -- For details on above see note [Api annotations] in ApiAnnotation

  | TyVarSig (XTyVarSig pass) (LHsTyVarBndr pass)
  -- ^ - 'ApiAnnotation.AnnKeywordId' :
  --             'ApiAnnotation.AnnOpenP','ApiAnnotation.AnnDcolon',
  --             'ApiAnnotation.AnnCloseP', 'ApiAnnotation.AnnEqual'
  | XFamilyResultSig (XXFamilyResultSig pass)

  -- For details on above see note [Api annotations] in ApiAnnotation

type instance XNoSig            (GhcPass _) = NoExtField
type instance XCKindSig         (GhcPass _) = NoExtField

type instance XTyVarSig         (GhcPass _) = NoExtField
type instance XXFamilyResultSig (GhcPass _) = NoExtCon


-- | Located type Family Declaration
type LFamilyDecl pass = Located (FamilyDecl pass)

-- | type Family Declaration
data FamilyDecl pass = FamilyDecl
  { FamilyDecl pass -> XCFamilyDecl pass
fdExt            :: XCFamilyDecl pass
  , FamilyDecl pass -> FamilyInfo pass
fdInfo           :: FamilyInfo pass              -- type/data, closed/open
  , FamilyDecl pass -> Located (IdP pass)
fdLName          :: Located (IdP pass)           -- type constructor
  , FamilyDecl pass -> LHsQTyVars pass
fdTyVars         :: LHsQTyVars pass              -- type variables
                       -- See Note [TyVar binders for associated declarations]
  , FamilyDecl pass -> LexicalFixity
fdFixity         :: LexicalFixity                -- Fixity used in the declaration
  , FamilyDecl pass -> LFamilyResultSig pass
fdResultSig      :: LFamilyResultSig pass        -- result signature
  , FamilyDecl pass -> Maybe (LInjectivityAnn pass)
fdInjectivityAnn :: Maybe (LInjectivityAnn pass) -- optional injectivity ann
  }
  | XFamilyDecl (XXFamilyDecl pass)
  -- ^ - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnType',
  --             'ApiAnnotation.AnnData', 'ApiAnnotation.AnnFamily',
  --             'ApiAnnotation.AnnWhere', 'ApiAnnotation.AnnOpenP',
  --             'ApiAnnotation.AnnDcolon', 'ApiAnnotation.AnnCloseP',
  --             'ApiAnnotation.AnnEqual', 'ApiAnnotation.AnnRarrow',
  --             'ApiAnnotation.AnnVbar'

  -- For details on above see note [Api annotations] in ApiAnnotation

type instance XCFamilyDecl    (GhcPass _) = NoExtField
type instance XXFamilyDecl    (GhcPass _) = NoExtCon


-- | Located Injectivity Annotation
type LInjectivityAnn pass = Located (InjectivityAnn pass)

-- | If the user supplied an injectivity annotation it is represented using
-- InjectivityAnn. At the moment this is a single injectivity condition - see
-- Note [Injectivity annotation]. `Located name` stores the LHS of injectivity
-- condition. `[Located name]` stores the RHS of injectivity condition. Example:
--
--   type family Foo a b c = r | r -> a c where ...
--
-- This will be represented as "InjectivityAnn `r` [`a`, `c`]"
data InjectivityAnn pass
  = InjectivityAnn (Located (IdP pass)) [Located (IdP pass)]
  -- ^ - 'ApiAnnotation.AnnKeywordId' :
  --             'ApiAnnotation.AnnRarrow', 'ApiAnnotation.AnnVbar'

  -- For details on above see note [Api annotations] in ApiAnnotation

data FamilyInfo pass
  = DataFamily
  | OpenTypeFamily
     -- | 'Nothing' if we're in an hs-boot file and the user
     -- said "type family Foo x where .."
  | ClosedTypeFamily (Maybe [LTyFamInstEqn pass])

famResultKindSignature :: FamilyResultSig (GhcPass p) -> Maybe (LHsKind (GhcPass p))
famResultKindSignature :: FamilyResultSig (GhcPass p) -> Maybe (LHsKind (GhcPass p))
famResultKindSignature (NoSig XNoSig (GhcPass p)
_) = Maybe (LHsKind (GhcPass p))
forall a. Maybe a
Nothing
famResultKindSignature (KindSig XCKindSig (GhcPass p)
_ LHsKind (GhcPass p)
ki) = LHsKind (GhcPass p) -> Maybe (LHsKind (GhcPass p))
forall a. a -> Maybe a
Just LHsKind (GhcPass p)
ki
famResultKindSignature (TyVarSig XTyVarSig (GhcPass p)
_ LHsTyVarBndr (GhcPass p)
bndr) =
  case LHsTyVarBndr (GhcPass p) -> SrcSpanLess (LHsTyVarBndr (GhcPass p))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc LHsTyVarBndr (GhcPass p)
bndr of
    UserTyVar _ _ -> Maybe (LHsKind (GhcPass p))
forall a. Maybe a
Nothing
    KindedTyVar _ _ ki -> LHsKind (GhcPass p) -> Maybe (LHsKind (GhcPass p))
forall a. a -> Maybe a
Just LHsKind (GhcPass p)
ki
    XTyVarBndr nec -> NoExtCon -> Maybe (LHsKind (GhcPass p))
forall a. NoExtCon -> a
noExtCon XXTyVarBndr (GhcPass p)
NoExtCon
nec
famResultKindSignature (XFamilyResultSig XXFamilyResultSig (GhcPass p)
nec) = NoExtCon -> Maybe (LHsKind (GhcPass p))
forall a. NoExtCon -> a
noExtCon XXFamilyResultSig (GhcPass p)
NoExtCon
nec

-- | Maybe return name of the result type variable
resultVariableName :: FamilyResultSig (GhcPass a) -> Maybe (IdP (GhcPass a))
resultVariableName :: FamilyResultSig (GhcPass a) -> Maybe (IdP (GhcPass a))
resultVariableName (TyVarSig XTyVarSig (GhcPass a)
_ LHsTyVarBndr (GhcPass a)
sig) = IdP (GhcPass a) -> Maybe (IdP (GhcPass a))
forall a. a -> Maybe a
Just (IdP (GhcPass a) -> Maybe (IdP (GhcPass a)))
-> IdP (GhcPass a) -> Maybe (IdP (GhcPass a))
forall a b. (a -> b) -> a -> b
$ LHsTyVarBndr (GhcPass a) -> IdP (GhcPass a)
forall (p :: Pass). LHsTyVarBndr (GhcPass p) -> IdP (GhcPass p)
hsLTyVarName LHsTyVarBndr (GhcPass a)
sig
resultVariableName FamilyResultSig (GhcPass a)
_                = Maybe (IdP (GhcPass a))
forall a. Maybe a
Nothing

instance OutputableBndrId p
       => Outputable (FamilyDecl (GhcPass p)) where
  ppr :: FamilyDecl (GhcPass p) -> SDoc
ppr = TopLevelFlag -> FamilyDecl (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
TopLevelFlag -> FamilyDecl (GhcPass p) -> SDoc
pprFamilyDecl TopLevelFlag
TopLevel

pprFamilyDecl :: (OutputableBndrId p)
              => TopLevelFlag -> FamilyDecl (GhcPass p) -> SDoc
pprFamilyDecl :: TopLevelFlag -> FamilyDecl (GhcPass p) -> SDoc
pprFamilyDecl TopLevelFlag
top_level (FamilyDecl { fdInfo :: forall pass. FamilyDecl pass -> FamilyInfo pass
fdInfo = FamilyInfo (GhcPass p)
info, fdLName :: forall pass. FamilyDecl pass -> Located (IdP pass)
fdLName = Located (IdP (GhcPass p))
ltycon
                                    , fdTyVars :: forall pass. FamilyDecl pass -> LHsQTyVars pass
fdTyVars = LHsQTyVars (GhcPass p)
tyvars
                                    , fdFixity :: forall pass. FamilyDecl pass -> LexicalFixity
fdFixity = LexicalFixity
fixity
                                    , fdResultSig :: forall pass. FamilyDecl pass -> LFamilyResultSig pass
fdResultSig = L SrcSpan
_ FamilyResultSig (GhcPass p)
result
                                    , fdInjectivityAnn :: forall pass. FamilyDecl pass -> Maybe (LInjectivityAnn pass)
fdInjectivityAnn = Maybe (LInjectivityAnn (GhcPass p))
mb_inj })
  = [SDoc] -> SDoc
vcat [ FamilyInfo (GhcPass p) -> SDoc
forall pass. FamilyInfo pass -> SDoc
pprFlavour FamilyInfo (GhcPass p)
info SDoc -> SDoc -> SDoc
<+> SDoc
pp_top_level SDoc -> SDoc -> SDoc
<+>
           Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
forall (p :: Pass).
OutputableBndrId p =>
Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
pp_vanilla_decl_head Located (IdP (GhcPass p))
ltycon LHsQTyVars (GhcPass p)
tyvars LexicalFixity
fixity LHsContext (GhcPass p)
forall pass. LHsContext pass
noLHsContext SDoc -> SDoc -> SDoc
<+>
           SDoc
pp_kind SDoc -> SDoc -> SDoc
<+> SDoc
pp_inj SDoc -> SDoc -> SDoc
<+> SDoc
pp_where
         , Int -> SDoc -> SDoc
nest Int
2 (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ SDoc
pp_eqns ]
  where
    pp_top_level :: SDoc
pp_top_level = case TopLevelFlag
top_level of
                     TopLevelFlag
TopLevel    -> [Char] -> SDoc
text [Char]
"family"
                     TopLevelFlag
NotTopLevel -> SDoc
empty

    pp_kind :: SDoc
pp_kind = case FamilyResultSig (GhcPass p)
result of
                NoSig    XNoSig (GhcPass p)
_         -> SDoc
empty
                KindSig  XCKindSig (GhcPass p)
_ LHsKind (GhcPass p)
kind    -> SDoc
dcolon SDoc -> SDoc -> SDoc
<+> LHsKind (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsKind (GhcPass p)
kind
                TyVarSig XTyVarSig (GhcPass p)
_ LHsTyVarBndr (GhcPass p)
tv_bndr -> [Char] -> SDoc
text [Char]
"=" SDoc -> SDoc -> SDoc
<+> LHsTyVarBndr (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsTyVarBndr (GhcPass p)
tv_bndr
                XFamilyResultSig XXFamilyResultSig (GhcPass p)
nec -> NoExtCon -> SDoc
forall a. NoExtCon -> a
noExtCon XXFamilyResultSig (GhcPass p)
NoExtCon
nec
    pp_inj :: SDoc
pp_inj = case Maybe (LInjectivityAnn (GhcPass p))
mb_inj of
               Just (L SrcSpan
_ (InjectivityAnn Located (IdP (GhcPass p))
lhs [Located (IdP (GhcPass p))]
rhs)) ->
                 [SDoc] -> SDoc
hsep [ SDoc
vbar, Located (IdP (GhcPass p)) -> SDoc
forall a. Outputable a => a -> SDoc
ppr Located (IdP (GhcPass p))
lhs, [Char] -> SDoc
text [Char]
"->", [SDoc] -> SDoc
hsep ((Located (IdP (GhcPass p)) -> SDoc)
-> [Located (IdP (GhcPass p))] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map Located (IdP (GhcPass p)) -> SDoc
forall a. Outputable a => a -> SDoc
ppr [Located (IdP (GhcPass p))]
rhs) ]
               Maybe (LInjectivityAnn (GhcPass p))
Nothing -> SDoc
empty
    (SDoc
pp_where, SDoc
pp_eqns) = case FamilyInfo (GhcPass p)
info of
      ClosedTypeFamily Maybe [LTyFamInstEqn (GhcPass p)]
mb_eqns ->
        ( [Char] -> SDoc
text [Char]
"where"
        , case Maybe [LTyFamInstEqn (GhcPass p)]
mb_eqns of
            Maybe [LTyFamInstEqn (GhcPass p)]
Nothing   -> [Char] -> SDoc
text [Char]
".."
            Just [LTyFamInstEqn (GhcPass p)]
eqns -> [SDoc] -> SDoc
vcat ([SDoc] -> SDoc) -> [SDoc] -> SDoc
forall a b. (a -> b) -> a -> b
$ (LTyFamInstEqn (GhcPass p) -> SDoc)
-> [LTyFamInstEqn (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (TyFamInstEqn (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
TyFamInstEqn (GhcPass p) -> SDoc
ppr_fam_inst_eqn (TyFamInstEqn (GhcPass p) -> SDoc)
-> (LTyFamInstEqn (GhcPass p) -> TyFamInstEqn (GhcPass p))
-> LTyFamInstEqn (GhcPass p)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LTyFamInstEqn (GhcPass p) -> TyFamInstEqn (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) [LTyFamInstEqn (GhcPass p)]
eqns )
      FamilyInfo (GhcPass p)
_ -> (SDoc
empty, SDoc
empty)
pprFamilyDecl TopLevelFlag
_ (XFamilyDecl XXFamilyDecl (GhcPass p)
nec) = NoExtCon -> SDoc
forall a. NoExtCon -> a
noExtCon XXFamilyDecl (GhcPass p)
NoExtCon
nec

pprFlavour :: FamilyInfo pass -> SDoc
pprFlavour :: FamilyInfo pass -> SDoc
pprFlavour FamilyInfo pass
DataFamily            = [Char] -> SDoc
text [Char]
"data"
pprFlavour FamilyInfo pass
OpenTypeFamily        = [Char] -> SDoc
text [Char]
"type"
pprFlavour (ClosedTypeFamily {}) = [Char] -> SDoc
text [Char]
"type"

instance Outputable (FamilyInfo pass) where
  ppr :: FamilyInfo pass -> SDoc
ppr FamilyInfo pass
info = FamilyInfo pass -> SDoc
forall pass. FamilyInfo pass -> SDoc
pprFlavour FamilyInfo pass
info SDoc -> SDoc -> SDoc
<+> [Char] -> SDoc
text [Char]
"family"



{- *********************************************************************
*                                                                      *
               Data types and data constructors
*                                                                      *
********************************************************************* -}

-- | Haskell Data type Definition
data HsDataDefn pass   -- The payload of a data type defn
                       -- Used *both* for vanilla data declarations,
                       --       *and* for data family instances
  = -- | Declares a data type or newtype, giving its constructors
    -- @
    --  data/newtype T a = <constrs>
    --  data/newtype instance T [a] = <constrs>
    -- @
    HsDataDefn { HsDataDefn pass -> XCHsDataDefn pass
dd_ext    :: XCHsDataDefn pass,
                 HsDataDefn pass -> NewOrData
dd_ND     :: NewOrData,
                 HsDataDefn pass -> LHsContext pass
dd_ctxt   :: LHsContext pass,           -- ^ Context
                 HsDataDefn pass -> Maybe (Located CType)
dd_cType  :: Maybe (Located CType),
                 HsDataDefn pass -> Maybe (LHsKind pass)
dd_kindSig:: Maybe (LHsKind pass),
                     -- ^ Optional kind signature.
                     --
                     -- @(Just k)@ for a GADT-style @data@,
                     -- or @data instance@ decl, with explicit kind sig
                     --
                     -- Always @Nothing@ for H98-syntax decls

                 HsDataDefn pass -> [LConDecl pass]
dd_cons   :: [LConDecl pass],
                     -- ^ Data constructors
                     --
                     -- For @data T a = T1 | T2 a@
                     --   the 'LConDecl's all have 'ConDeclH98'.
                     -- For @data T a where { T1 :: T a }@
                     --   the 'LConDecls' all have 'ConDeclGADT'.

                 HsDataDefn pass -> HsDeriving pass
dd_derivs :: HsDeriving pass  -- ^ Optional 'deriving' claues

             -- For details on above see note [Api annotations] in ApiAnnotation
   }
  | XHsDataDefn (XXHsDataDefn pass)

type instance XCHsDataDefn    (GhcPass _) = NoExtField

type instance XXHsDataDefn    (GhcPass _) = NoExtCon

-- | Haskell Deriving clause
type HsDeriving pass = Located [LHsDerivingClause pass]
  -- ^ The optional @deriving@ clauses of a data declaration. "Clauses" is
  -- plural because one can specify multiple deriving clauses using the
  -- @-XDerivingStrategies@ language extension.
  --
  -- The list of 'LHsDerivingClause's corresponds to exactly what the user
  -- requested to derive, in order. If no deriving clauses were specified,
  -- the list is empty.

type LHsDerivingClause pass = Located (HsDerivingClause pass)

-- | A single @deriving@ clause of a data declaration.
--
--  - 'ApiAnnotation.AnnKeywordId' :
--       'ApiAnnotation.AnnDeriving', 'ApiAnnotation.AnnStock',
--       'ApiAnnotation.AnnAnyClass', 'Api.AnnNewtype',
--       'ApiAnnotation.AnnOpen','ApiAnnotation.AnnClose'
data HsDerivingClause pass
  -- See Note [Deriving strategies] in TcDeriv
  = HsDerivingClause
    { HsDerivingClause pass -> XCHsDerivingClause pass
deriv_clause_ext :: XCHsDerivingClause pass
    , HsDerivingClause pass -> Maybe (LDerivStrategy pass)
deriv_clause_strategy :: Maybe (LDerivStrategy pass)
      -- ^ The user-specified strategy (if any) to use when deriving
      -- 'deriv_clause_tys'.
    , HsDerivingClause pass -> Located [LHsSigType pass]
deriv_clause_tys :: Located [LHsSigType pass]
      -- ^ The types to derive.
      --
      -- It uses 'LHsSigType's because, with @-XGeneralizedNewtypeDeriving@,
      -- we can mention type variables that aren't bound by the datatype, e.g.
      --
      -- > data T b = ... deriving (C [a])
      --
      -- should produce a derived instance for @C [a] (T b)@.
    }
  | XHsDerivingClause (XXHsDerivingClause pass)

type instance XCHsDerivingClause    (GhcPass _) = NoExtField
type instance XXHsDerivingClause    (GhcPass _) = NoExtCon

instance OutputableBndrId p
       => Outputable (HsDerivingClause (GhcPass p)) where
  ppr :: HsDerivingClause (GhcPass p) -> SDoc
ppr (HsDerivingClause { deriv_clause_strategy :: forall pass. HsDerivingClause pass -> Maybe (LDerivStrategy pass)
deriv_clause_strategy = Maybe (LDerivStrategy (GhcPass p))
dcs
                        , deriv_clause_tys :: forall pass. HsDerivingClause pass -> Located [LHsSigType pass]
deriv_clause_tys      = L SrcSpan
_ [LHsSigType (GhcPass p)]
dct })
    = [SDoc] -> SDoc
hsep [ [Char] -> SDoc
text [Char]
"deriving"
           , SDoc
pp_strat_before
           , [LHsSigType (GhcPass p)] -> SDoc
pp_dct [LHsSigType (GhcPass p)]
dct
           , SDoc
pp_strat_after ]
      where
        -- This complexity is to distinguish between
        --    deriving Show
        --    deriving (Show)
        pp_dct :: [LHsSigType (GhcPass p)] -> SDoc
pp_dct [HsIB { hsib_body :: forall pass thing. HsImplicitBndrs pass thing -> thing
hsib_body = LHsType (GhcPass p)
ty }]
                 = LHsType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr (PprPrec -> LHsType (GhcPass p) -> LHsType (GhcPass p)
forall (p :: Pass).
PprPrec -> LHsType (GhcPass p) -> LHsType (GhcPass p)
parenthesizeHsType PprPrec
appPrec LHsType (GhcPass p)
ty)
        pp_dct [LHsSigType (GhcPass p)]
_ = SDoc -> SDoc
parens ([LHsSigType (GhcPass p)] -> SDoc
forall a. Outputable a => [a] -> SDoc
interpp'SP [LHsSigType (GhcPass p)]
dct)

        -- @via@ is unique in that in comes /after/ the class being derived,
        -- so we must special-case it.
        (SDoc
pp_strat_before, SDoc
pp_strat_after) =
          case Maybe (LDerivStrategy (GhcPass p))
dcs of
            Just (L SrcSpan
_ via :: DerivStrategy (GhcPass p)
via@ViaStrategy{}) -> (SDoc
empty, DerivStrategy (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr DerivStrategy (GhcPass p)
via)
            Maybe (LDerivStrategy (GhcPass p))
_                            -> (Maybe (LDerivStrategy (GhcPass p)) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
Maybe (LDerivStrategy (GhcPass p)) -> SDoc
ppDerivStrategy Maybe (LDerivStrategy (GhcPass p))
dcs, SDoc
empty)
  ppr (XHsDerivingClause XXHsDerivingClause (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsDerivingClause (GhcPass p)
NoExtCon
x

-- | Located Standalone Kind Signature
type LStandaloneKindSig pass = Located (StandaloneKindSig pass)

data StandaloneKindSig pass
  = StandaloneKindSig (XStandaloneKindSig pass)
      (Located (IdP pass))  -- Why a single binder? See #16754
      (LHsSigType pass)     -- Why not LHsSigWcType? See Note [Wildcards in standalone kind signatures]
  | XStandaloneKindSig (XXStandaloneKindSig pass)

type instance XStandaloneKindSig (GhcPass p) = NoExtField
type instance XXStandaloneKindSig (GhcPass p) = NoExtCon

standaloneKindSigName :: StandaloneKindSig (GhcPass p) -> IdP (GhcPass p)
standaloneKindSigName :: StandaloneKindSig (GhcPass p) -> IdP (GhcPass p)
standaloneKindSigName (StandaloneKindSig XStandaloneKindSig (GhcPass p)
_ Located (IdP (GhcPass p))
lname LHsSigType (GhcPass p)
_) = Located (IdP (GhcPass p))
-> SrcSpanLess (Located (IdP (GhcPass p)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (IdP (GhcPass p))
lname
standaloneKindSigName (XStandaloneKindSig XXStandaloneKindSig (GhcPass p)
nec) = NoExtCon -> IdP (GhcPass p)
forall a. NoExtCon -> a
noExtCon XXStandaloneKindSig (GhcPass p)
NoExtCon
nec

{- Note [Wildcards in standalone kind signatures]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Standalone kind signatures enable polymorphic recursion, and it is unclear how
to reconcile this with partial type signatures, so we disallow wildcards in
them.

We reject wildcards in 'rnStandaloneKindSignature' by returning False for
'StandaloneKindSigCtx' in 'wildCardsAllowed'.

The alternative design is to have special treatment for partial standalone kind
signatures, much like we have special treatment for partial type signatures in
terms. However, partial standalone kind signatures are not a proper replacement
for CUSKs, so this would be a separate feature.
-}

data NewOrData
  = NewType                     -- ^ @newtype Blah ...@
  | DataType                    -- ^ @data Blah ...@
  deriving( NewOrData -> NewOrData -> Bool
(NewOrData -> NewOrData -> Bool)
-> (NewOrData -> NewOrData -> Bool) -> Eq NewOrData
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: NewOrData -> NewOrData -> Bool
$c/= :: NewOrData -> NewOrData -> Bool
== :: NewOrData -> NewOrData -> Bool
$c== :: NewOrData -> NewOrData -> Bool
Eq, Typeable NewOrData
DataType
Constr
Typeable NewOrData
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> NewOrData -> c NewOrData)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c NewOrData)
-> (NewOrData -> Constr)
-> (NewOrData -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c NewOrData))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NewOrData))
-> ((forall b. Data b => b -> b) -> NewOrData -> NewOrData)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> NewOrData -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> NewOrData -> r)
-> (forall u. (forall d. Data d => d -> u) -> NewOrData -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> NewOrData -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> NewOrData -> m NewOrData)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> NewOrData -> m NewOrData)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> NewOrData -> m NewOrData)
-> Data NewOrData
NewOrData -> DataType
NewOrData -> Constr
(forall b. Data b => b -> b) -> NewOrData -> NewOrData
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> NewOrData -> c NewOrData
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c NewOrData
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> NewOrData -> u
forall u. (forall d. Data d => d -> u) -> NewOrData -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> NewOrData -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> NewOrData -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> NewOrData -> m NewOrData
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> NewOrData -> m NewOrData
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c NewOrData
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> NewOrData -> c NewOrData
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c NewOrData)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NewOrData)
$cDataType :: Constr
$cNewType :: Constr
$tNewOrData :: DataType
gmapMo :: (forall d. Data d => d -> m d) -> NewOrData -> m NewOrData
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> NewOrData -> m NewOrData
gmapMp :: (forall d. Data d => d -> m d) -> NewOrData -> m NewOrData
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> NewOrData -> m NewOrData
gmapM :: (forall d. Data d => d -> m d) -> NewOrData -> m NewOrData
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> NewOrData -> m NewOrData
gmapQi :: Int -> (forall d. Data d => d -> u) -> NewOrData -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> NewOrData -> u
gmapQ :: (forall d. Data d => d -> u) -> NewOrData -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> NewOrData -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> NewOrData -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> NewOrData -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> NewOrData -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> NewOrData -> r
gmapT :: (forall b. Data b => b -> b) -> NewOrData -> NewOrData
$cgmapT :: (forall b. Data b => b -> b) -> NewOrData -> NewOrData
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NewOrData)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NewOrData)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c NewOrData)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c NewOrData)
dataTypeOf :: NewOrData -> DataType
$cdataTypeOf :: NewOrData -> DataType
toConstr :: NewOrData -> Constr
$ctoConstr :: NewOrData -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c NewOrData
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c NewOrData
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> NewOrData -> c NewOrData
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> NewOrData -> c NewOrData
$cp1Data :: Typeable NewOrData
Data )                -- Needed because Demand derives Eq

-- | Convert a 'NewOrData' to a 'TyConFlavour'
newOrDataToFlavour :: NewOrData -> TyConFlavour
newOrDataToFlavour :: NewOrData -> TyConFlavour
newOrDataToFlavour NewOrData
NewType  = TyConFlavour
NewtypeFlavour
newOrDataToFlavour NewOrData
DataType = TyConFlavour
DataTypeFlavour


-- | Located data Constructor Declaration
type LConDecl pass = Located (ConDecl pass)
      -- ^ May have 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnSemi' when
      --   in a GADT constructor list

  -- For details on above see note [Api annotations] in ApiAnnotation

-- |
--
-- @
-- 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
-- @
--
-- - 'ApiAnnotation.AnnKeywordId's : 'ApiAnnotation.AnnOpen',
--            'ApiAnnotation.AnnDotdot','ApiAnnotation.AnnCLose',
--            'ApiAnnotation.AnnEqual','ApiAnnotation.AnnVbar',
--            'ApiAnnotation.AnnDarrow','ApiAnnotation.AnnDarrow',
--            'ApiAnnotation.AnnForall','ApiAnnotation.AnnDot'

-- For details on above see note [Api annotations] in ApiAnnotation

-- | data Constructor Declaration
data ConDecl pass
  = ConDeclGADT
      { ConDecl pass -> XConDeclGADT pass
con_g_ext   :: XConDeclGADT pass
      , ConDecl pass -> [Located (IdP pass)]
con_names   :: [Located (IdP pass)]

      -- The next four fields describe the type after the '::'
      -- See Note [GADT abstract syntax]
      -- The following field is Located to anchor API Annotations,
      -- AnnForall and AnnDot.
      , ConDecl pass -> Located Bool
con_forall  :: Located Bool      -- ^ True <=> explicit forall
                                         --   False => hsq_explicit is empty
      , ConDecl pass -> LHsQTyVars pass
con_qvars   :: LHsQTyVars pass
                       -- Whether or not there is an /explicit/ forall, we still
                       -- need to capture the implicitly-bound type/kind variables

      , ConDecl pass -> Maybe (LHsContext pass)
con_mb_cxt  :: Maybe (LHsContext pass) -- ^ User-written context (if any)
      , ConDecl pass -> HsConDeclDetails pass
con_args    :: HsConDeclDetails pass   -- ^ Arguments; never InfixCon
      , ConDecl pass -> LHsType pass
con_res_ty  :: LHsType pass            -- ^ Result type

      , ConDecl pass -> Maybe LHsDocString
con_doc     :: Maybe LHsDocString
          -- ^ A possible Haddock comment.
      }

  | ConDeclH98
      { ConDecl pass -> XConDeclH98 pass
con_ext     :: XConDeclH98 pass
      , ConDecl pass -> Located (IdP pass)
con_name    :: Located (IdP pass)

      , con_forall  :: Located Bool
                              -- ^ True <=> explicit user-written forall
                              --     e.g. data T a = forall b. MkT b (b->a)
                              --     con_ex_tvs = {b}
                              -- False => con_ex_tvs is empty
      , ConDecl pass -> [LHsTyVarBndr pass]
con_ex_tvs :: [LHsTyVarBndr pass]      -- ^ Existentials only
      , con_mb_cxt :: Maybe (LHsContext pass)  -- ^ User-written context (if any)
      , con_args   :: HsConDeclDetails pass    -- ^ Arguments; can be InfixCon

      , con_doc       :: Maybe LHsDocString
          -- ^ A possible Haddock comment.
      }
  | XConDecl (XXConDecl pass)

type instance XConDeclGADT (GhcPass _) = NoExtField
type instance XConDeclH98  (GhcPass _) = NoExtField
type instance XXConDecl    (GhcPass _) = NoExtCon

{- Note [GADT abstract syntax]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There's a wrinkle in ConDeclGADT

* For record syntax, it's all uniform.  Given:
      data T a where
        K :: forall a. Ord a => { x :: [a], ... } -> T a
    we make the a ConDeclGADT for K with
       con_qvars  = {a}
       con_mb_cxt = Just [Ord a]
       con_args   = RecCon <the record fields>
       con_res_ty = T a

  We need the RecCon before the reanmer, so we can find the record field
  binders in GHC.Hs.Utils.hsConDeclsBinders.

* However for a GADT constr declaration which is not a record, it can
  be hard parse until we know operator fixities. Consider for example
     C :: a :*: b -> a :*: b -> a :+: b
  Initially this type will parse as
      a :*: (b -> (a :*: (b -> (a :+: b))))
  so it's hard to split up the arguments until we've done the precedence
  resolution (in the renamer).

  So:  - In the parser (RdrHsSyn.mkGadtDecl), we put the whole constr
         type into the res_ty for a ConDeclGADT for now, and use
         PrefixCon []
            con_args   = PrefixCon []
            con_res_ty = a :*: (b -> (a :*: (b -> (a :+: b))))

       - In the renamer (RnSource.rnConDecl), we unravel it afer
         operator fixities are sorted. So we generate. So we end
         up with
            con_args   = PrefixCon [ a :*: b, a :*: b ]
            con_res_ty = a :+: b
-}

-- | Haskell data Constructor Declaration Details
type HsConDeclDetails pass
   = HsConDetails (LBangType pass) (Located [LConDeclField pass])

getConNames :: ConDecl (GhcPass p) -> [Located (IdP (GhcPass p))]
getConNames :: ConDecl (GhcPass p) -> [Located (IdP (GhcPass p))]
getConNames ConDeclH98  {con_name :: forall pass. ConDecl pass -> Located (IdP pass)
con_name  = Located (IdP (GhcPass p))
name}  = [Located (IdP (GhcPass p))
name]
getConNames ConDeclGADT {con_names :: forall pass. ConDecl pass -> [Located (IdP pass)]
con_names = [Located (IdP (GhcPass p))]
names} = [Located (IdP (GhcPass p))]
names
getConNames (XConDecl XXConDecl (GhcPass p)
nec) = NoExtCon -> [Located (IdP (GhcPass p))]
forall a. NoExtCon -> a
noExtCon XXConDecl (GhcPass p)
NoExtCon
nec

getConArgs :: ConDecl pass -> HsConDeclDetails pass
getConArgs :: ConDecl pass -> HsConDeclDetails pass
getConArgs ConDecl pass
d = ConDecl pass -> HsConDeclDetails pass
forall pass. ConDecl pass -> HsConDeclDetails pass
con_args ConDecl pass
d

hsConDeclArgTys :: HsConDeclDetails pass -> [LBangType pass]
hsConDeclArgTys :: HsConDeclDetails pass -> [LBangType pass]
hsConDeclArgTys (PrefixCon [LBangType pass]
tys)    = [LBangType pass]
tys
hsConDeclArgTys (InfixCon LBangType pass
ty1 LBangType pass
ty2) = [LBangType pass
ty1,LBangType pass
ty2]
hsConDeclArgTys (RecCon Located [LConDeclField pass]
flds)      = (LConDeclField pass -> LBangType pass)
-> [LConDeclField pass] -> [LBangType pass]
forall a b. (a -> b) -> [a] -> [b]
map (ConDeclField pass -> LBangType pass
forall pass. ConDeclField pass -> LBangType pass
cd_fld_type (ConDeclField pass -> LBangType pass)
-> (LConDeclField pass -> ConDeclField pass)
-> LConDeclField pass
-> LBangType pass
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LConDeclField pass -> ConDeclField pass
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) (Located [LConDeclField pass]
-> SrcSpanLess (Located [LConDeclField pass])
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located [LConDeclField pass]
flds)

hsConDeclTheta :: Maybe (LHsContext pass) -> [LHsType pass]
hsConDeclTheta :: Maybe (LHsContext pass) -> [LHsType pass]
hsConDeclTheta Maybe (LHsContext pass)
Nothing            = []
hsConDeclTheta (Just (L SrcSpan
_ [LHsType pass]
theta)) = [LHsType pass]
theta

pp_data_defn :: (OutputableBndrId p)
                  => (LHsContext (GhcPass p) -> SDoc)   -- Printing the header
                  -> HsDataDefn (GhcPass p)
                  -> SDoc
pp_data_defn :: (LHsContext (GhcPass p) -> SDoc) -> HsDataDefn (GhcPass p) -> SDoc
pp_data_defn LHsContext (GhcPass p) -> SDoc
pp_hdr (HsDataDefn { dd_ND :: forall pass. HsDataDefn pass -> NewOrData
dd_ND = NewOrData
new_or_data, dd_ctxt :: forall pass. HsDataDefn pass -> LHsContext pass
dd_ctxt = LHsContext (GhcPass p)
context
                                , dd_cType :: forall pass. HsDataDefn pass -> Maybe (Located CType)
dd_cType = Maybe (Located CType)
mb_ct
                                , dd_kindSig :: forall pass. HsDataDefn pass -> Maybe (LHsKind pass)
dd_kindSig = Maybe (LHsKind (GhcPass p))
mb_sig
                                , dd_cons :: forall pass. HsDataDefn pass -> [LConDecl pass]
dd_cons = [LConDecl (GhcPass p)]
condecls, dd_derivs :: forall pass. HsDataDefn pass -> HsDeriving pass
dd_derivs = HsDeriving (GhcPass p)
derivings })
  | [LConDecl (GhcPass p)] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LConDecl (GhcPass p)]
condecls
  = NewOrData -> SDoc
forall a. Outputable a => a -> SDoc
ppr NewOrData
new_or_data SDoc -> SDoc -> SDoc
<+> SDoc
pp_ct SDoc -> SDoc -> SDoc
<+> LHsContext (GhcPass p) -> SDoc
pp_hdr LHsContext (GhcPass p)
context SDoc -> SDoc -> SDoc
<+> SDoc
pp_sig
    SDoc -> SDoc -> SDoc
<+> HsDeriving (GhcPass p) -> SDoc
forall a l. Outputable a => GenLocated l [a] -> SDoc
pp_derivings HsDeriving (GhcPass p)
derivings

  | Bool
otherwise
  = SDoc -> Int -> SDoc -> SDoc
hang (NewOrData -> SDoc
forall a. Outputable a => a -> SDoc
ppr NewOrData
new_or_data SDoc -> SDoc -> SDoc
<+> SDoc
pp_ct  SDoc -> SDoc -> SDoc
<+> LHsContext (GhcPass p) -> SDoc
pp_hdr LHsContext (GhcPass p)
context SDoc -> SDoc -> SDoc
<+> SDoc
pp_sig)
       Int
2 ([LConDecl (GhcPass p)] -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
[LConDecl (GhcPass p)] -> SDoc
pp_condecls [LConDecl (GhcPass p)]
condecls SDoc -> SDoc -> SDoc
$$ HsDeriving (GhcPass p) -> SDoc
forall a l. Outputable a => GenLocated l [a] -> SDoc
pp_derivings HsDeriving (GhcPass p)
derivings)
  where
    pp_ct :: SDoc
pp_ct = case Maybe (Located CType)
mb_ct of
               Maybe (Located CType)
Nothing   -> SDoc
empty
               Just Located CType
ct -> Located CType -> SDoc
forall a. Outputable a => a -> SDoc
ppr Located CType
ct
    pp_sig :: SDoc
pp_sig = case Maybe (LHsKind (GhcPass p))
mb_sig of
               Maybe (LHsKind (GhcPass p))
Nothing   -> SDoc
empty
               Just LHsKind (GhcPass p)
kind -> SDoc
dcolon SDoc -> SDoc -> SDoc
<+> LHsKind (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsKind (GhcPass p)
kind
    pp_derivings :: GenLocated l [a] -> SDoc
pp_derivings (L l
_ [a]
ds) = [SDoc] -> SDoc
vcat ((a -> SDoc) -> [a] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map a -> SDoc
forall a. Outputable a => a -> SDoc
ppr [a]
ds)
pp_data_defn LHsContext (GhcPass p) -> SDoc
_ (XHsDataDefn XXHsDataDefn (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsDataDefn (GhcPass p)
NoExtCon
x

instance OutputableBndrId p
       => Outputable (HsDataDefn (GhcPass p)) where
   ppr :: HsDataDefn (GhcPass p) -> SDoc
ppr HsDataDefn (GhcPass p)
d = (LHsContext (GhcPass p) -> SDoc) -> HsDataDefn (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
(LHsContext (GhcPass p) -> SDoc) -> HsDataDefn (GhcPass p) -> SDoc
pp_data_defn (\LHsContext (GhcPass p)
_ -> [Char] -> SDoc
text [Char]
"Naked HsDataDefn") HsDataDefn (GhcPass p)
d

instance OutputableBndrId p
       => Outputable (StandaloneKindSig (GhcPass p)) where
  ppr :: StandaloneKindSig (GhcPass p) -> SDoc
ppr (StandaloneKindSig XStandaloneKindSig (GhcPass p)
_ Located (IdP (GhcPass p))
v LHsSigType (GhcPass p)
ki)
    = [Char] -> SDoc
text [Char]
"type" SDoc -> SDoc -> SDoc
<+> IdP (GhcPass p) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc (Located (IdP (GhcPass p))
-> SrcSpanLess (Located (IdP (GhcPass p)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (IdP (GhcPass p))
v) SDoc -> SDoc -> SDoc
<+> [Char] -> SDoc
text [Char]
"::" SDoc -> SDoc -> SDoc
<+> LHsSigType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsSigType (GhcPass p)
ki
  ppr (XStandaloneKindSig XXStandaloneKindSig (GhcPass p)
nec) = NoExtCon -> SDoc
forall a. NoExtCon -> a
noExtCon XXStandaloneKindSig (GhcPass p)
NoExtCon
nec

instance Outputable NewOrData where
  ppr :: NewOrData -> SDoc
ppr NewOrData
NewType  = [Char] -> SDoc
text [Char]
"newtype"
  ppr NewOrData
DataType = [Char] -> SDoc
text [Char]
"data"

pp_condecls :: (OutputableBndrId p) => [LConDecl (GhcPass p)] -> SDoc
pp_condecls :: [LConDecl (GhcPass p)] -> SDoc
pp_condecls cs :: [LConDecl (GhcPass p)]
cs@(L SrcSpan
_ ConDeclGADT{} : [LConDecl (GhcPass p)]
_) -- In GADT syntax
  = SDoc -> Int -> SDoc -> SDoc
hang ([Char] -> SDoc
text [Char]
"where") Int
2 ([SDoc] -> SDoc
vcat ((LConDecl (GhcPass p) -> SDoc) -> [LConDecl (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LConDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LConDecl (GhcPass p)]
cs))
pp_condecls [LConDecl (GhcPass p)]
cs                    -- In H98 syntax
  = SDoc
equals SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
sep (SDoc -> [SDoc] -> [SDoc]
punctuate ([Char] -> SDoc
text [Char]
" |") ((LConDecl (GhcPass p) -> SDoc) -> [LConDecl (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LConDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LConDecl (GhcPass p)]
cs))

instance (OutputableBndrId p) => Outputable (ConDecl (GhcPass p)) where
    ppr :: ConDecl (GhcPass p) -> SDoc
ppr = ConDecl (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
ConDecl (GhcPass p) -> SDoc
pprConDecl

pprConDecl :: (OutputableBndrId p) => ConDecl (GhcPass p) -> SDoc
pprConDecl :: ConDecl (GhcPass p) -> SDoc
pprConDecl (ConDeclH98 { con_name :: forall pass. ConDecl pass -> Located (IdP pass)
con_name = L SrcSpan
_ IdP (GhcPass p)
con
                       , con_ex_tvs :: forall pass. ConDecl pass -> [LHsTyVarBndr pass]
con_ex_tvs = [LHsTyVarBndr (GhcPass p)]
ex_tvs
                       , con_mb_cxt :: forall pass. ConDecl pass -> Maybe (LHsContext pass)
con_mb_cxt = Maybe (LHsContext (GhcPass p))
mcxt
                       , con_args :: forall pass. ConDecl pass -> HsConDeclDetails pass
con_args = HsConDeclDetails (GhcPass p)
args
                       , con_doc :: forall pass. ConDecl pass -> Maybe LHsDocString
con_doc = Maybe LHsDocString
doc })
  = [SDoc] -> SDoc
sep [Maybe LHsDocString -> SDoc
ppr_mbDoc Maybe LHsDocString
doc, ForallVisFlag
-> [LHsTyVarBndr (GhcPass p)] -> LHsContext (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
ForallVisFlag
-> [LHsTyVarBndr (GhcPass p)] -> LHsContext (GhcPass p) -> SDoc
pprHsForAll ForallVisFlag
ForallInvis [LHsTyVarBndr (GhcPass p)]
ex_tvs LHsContext (GhcPass p)
cxt, HsConDeclDetails (GhcPass p) -> SDoc
ppr_details HsConDeclDetails (GhcPass p)
args]
  where
    ppr_details :: HsConDeclDetails (GhcPass p) -> SDoc
ppr_details (InfixCon LBangType (GhcPass p)
t1 LBangType (GhcPass p)
t2) = [SDoc] -> SDoc
hsep [LBangType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LBangType (GhcPass p)
t1, IdP (GhcPass p) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprInfixOcc IdP (GhcPass p)
con, LBangType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LBangType (GhcPass p)
t2]
    ppr_details (PrefixCon [LBangType (GhcPass p)]
tys)  = [SDoc] -> SDoc
hsep (IdP (GhcPass p) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc IdP (GhcPass p)
con
                                   SDoc -> [SDoc] -> [SDoc]
forall a. a -> [a] -> [a]
: (LBangType (GhcPass p) -> SDoc)
-> [LBangType (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (HsType (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
HsType (GhcPass p) -> SDoc
pprHsType (HsType (GhcPass p) -> SDoc)
-> (LBangType (GhcPass p) -> HsType (GhcPass p))
-> LBangType (GhcPass p)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LBangType (GhcPass p) -> HsType (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) [LBangType (GhcPass p)]
tys)
    ppr_details (RecCon Located [LConDeclField (GhcPass p)]
fields)  = IdP (GhcPass p) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc IdP (GhcPass p)
con
                                 SDoc -> SDoc -> SDoc
<+> [LConDeclField (GhcPass p)] -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
[LConDeclField (GhcPass p)] -> SDoc
pprConDeclFields (Located [LConDeclField (GhcPass p)]
-> SrcSpanLess (Located [LConDeclField (GhcPass p)])
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located [LConDeclField (GhcPass p)]
fields)
    cxt :: LHsContext (GhcPass p)
cxt = LHsContext (GhcPass p)
-> Maybe (LHsContext (GhcPass p)) -> LHsContext (GhcPass p)
forall a. a -> Maybe a -> a
fromMaybe LHsContext (GhcPass p)
forall pass. LHsContext pass
noLHsContext Maybe (LHsContext (GhcPass p))
mcxt

pprConDecl (ConDeclGADT { con_names :: forall pass. ConDecl pass -> [Located (IdP pass)]
con_names = [GenLocated SrcSpan (IdP (GhcPass p))]
cons, con_qvars :: forall pass. ConDecl pass -> LHsQTyVars pass
con_qvars = LHsQTyVars (GhcPass p)
qvars
                        , con_mb_cxt :: forall pass. ConDecl pass -> Maybe (LHsContext pass)
con_mb_cxt = Maybe (LHsContext (GhcPass p))
mcxt, con_args :: forall pass. ConDecl pass -> HsConDeclDetails pass
con_args = HsConDeclDetails (GhcPass p)
args
                        , con_res_ty :: forall pass. ConDecl pass -> LHsType pass
con_res_ty = LBangType (GhcPass p)
res_ty, con_doc :: forall pass. ConDecl pass -> Maybe LHsDocString
con_doc = Maybe LHsDocString
doc })
  = Maybe LHsDocString -> SDoc
ppr_mbDoc Maybe LHsDocString
doc SDoc -> SDoc -> SDoc
<+> [GenLocated SrcSpan (IdP (GhcPass p))] -> SDoc
forall a. OutputableBndr a => [Located a] -> SDoc
ppr_con_names [GenLocated SrcSpan (IdP (GhcPass p))]
cons SDoc -> SDoc -> SDoc
<+> SDoc
dcolon
    SDoc -> SDoc -> SDoc
<+> ([SDoc] -> SDoc
sep [ForallVisFlag
-> [LHsTyVarBndr (GhcPass p)] -> LHsContext (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
ForallVisFlag
-> [LHsTyVarBndr (GhcPass p)] -> LHsContext (GhcPass p) -> SDoc
pprHsForAll ForallVisFlag
ForallInvis (LHsQTyVars (GhcPass p) -> [LHsTyVarBndr (GhcPass p)]
forall pass. LHsQTyVars pass -> [LHsTyVarBndr pass]
hsq_explicit LHsQTyVars (GhcPass p)
qvars) LHsContext (GhcPass p)
cxt,
              [SDoc] -> SDoc
ppr_arrow_chain (HsConDeclDetails (GhcPass p) -> [SDoc]
get_args HsConDeclDetails (GhcPass p)
args [SDoc] -> [SDoc] -> [SDoc]
forall a. [a] -> [a] -> [a]
++ [LBangType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LBangType (GhcPass p)
res_ty]) ])
  where
    get_args :: HsConDeclDetails (GhcPass p) -> [SDoc]
get_args (PrefixCon [LBangType (GhcPass p)]
args) = (LBangType (GhcPass p) -> SDoc)
-> [LBangType (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LBangType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LBangType (GhcPass p)]
args
    get_args (RecCon Located [LConDeclField (GhcPass p)]
fields)  = [[LConDeclField (GhcPass p)] -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
[LConDeclField (GhcPass p)] -> SDoc
pprConDeclFields (Located [LConDeclField (GhcPass p)]
-> SrcSpanLess (Located [LConDeclField (GhcPass p)])
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located [LConDeclField (GhcPass p)]
fields)]
    get_args (InfixCon {})    = [Char] -> SDoc -> [SDoc]
forall a. HasCallStack => [Char] -> SDoc -> a
pprPanic [Char]
"pprConDecl:GADT" ([GenLocated SrcSpan (IdP (GhcPass p))] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [GenLocated SrcSpan (IdP (GhcPass p))]
cons)

    cxt :: LHsContext (GhcPass p)
cxt = LHsContext (GhcPass p)
-> Maybe (LHsContext (GhcPass p)) -> LHsContext (GhcPass p)
forall a. a -> Maybe a -> a
fromMaybe LHsContext (GhcPass p)
forall pass. LHsContext pass
noLHsContext Maybe (LHsContext (GhcPass p))
mcxt

    ppr_arrow_chain :: [SDoc] -> SDoc
ppr_arrow_chain (SDoc
a:[SDoc]
as) = [SDoc] -> SDoc
sep (SDoc
a SDoc -> [SDoc] -> [SDoc]
forall a. a -> [a] -> [a]
: (SDoc -> SDoc) -> [SDoc] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (SDoc
arrow SDoc -> SDoc -> SDoc
<+>) [SDoc]
as)
    ppr_arrow_chain []     = SDoc
empty

pprConDecl (XConDecl XXConDecl (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXConDecl (GhcPass p)
NoExtCon
x

ppr_con_names :: (OutputableBndr a) => [Located a] -> SDoc
ppr_con_names :: [Located a] -> SDoc
ppr_con_names = (Located a -> SDoc) -> [Located a] -> SDoc
forall a. (a -> SDoc) -> [a] -> SDoc
pprWithCommas (a -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc (a -> SDoc) -> (Located a -> a) -> Located a -> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located a -> a
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc)

{-
************************************************************************
*                                                                      *
                Instance declarations
*                                                                      *
************************************************************************

Note [Type family instance declarations in HsSyn]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The data type FamEqn represents one equation of a type family instance.
Aside from the pass, it is also parameterised over another field, feqn_rhs.
feqn_rhs is either an HsDataDefn (for data family instances) or an LHsType
(for type family instances).

Type family instances also include associated type family default equations.
That is because a default for a type family looks like this:

  class C a where
    type family F a b :: Type
    type F c d = (c,d)   -- Default instance

The default declaration is really just a `type instance` declaration, but one
with particularly simple patterns: they must all be distinct type variables.
That's because we will instantiate it (in an instance declaration for `C`) if
we don't give an explicit instance for `F`. Note that the names of the
variables don't need to match those of the class: it really is like a
free-standing `type instance` declaration.
-}

----------------- Type synonym family instances -------------

-- | Located Type Family Instance Equation
type LTyFamInstEqn pass = Located (TyFamInstEqn pass)
  -- ^ May have 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnSemi'
  --   when in a list

-- For details on above see note [Api annotations] in ApiAnnotation

-- | Haskell Type Patterns
type HsTyPats pass = [LHsTypeArg pass]

{- Note [Family instance declaration binders]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The feqn_pats field of FamEqn (family instance equation) stores the LHS type
(and kind) patterns. Any type (and kind) variables contained
in these type patterns are bound in the hsib_vars field of the HsImplicitBndrs
in FamInstEqn depending on whether or not an explicit forall is present. In
the case of an explicit forall, the hsib_vars only includes kind variables not
bound in the forall. Otherwise, all type (and kind) variables are bound in
the hsib_vars. In the latter case, note that in particular

* The hsib_vars *includes* any anonymous wildcards.  For example
     type instance F a _ = a
  The hsib_vars will be {a, _}.  Remember that each separate wildcard
  '_' gets its own unique.  In this context wildcards behave just like
  an ordinary type variable, only anonymous.

* The hsib_vars *includes* type variables that are already in scope

   Eg   class C s t where
          type F t p :: *
        instance C w (a,b) where
          type F (a,b) x = x->a
   The hsib_vars of the F decl are {a,b,x}, even though the F decl
   is nested inside the 'instance' decl.

   However after the renamer, the uniques will match up:
        instance C w7 (a8,b9) where
          type F (a8,b9) x10 = x10->a8
   so that we can compare the type pattern in the 'instance' decl and
   in the associated 'type' decl

c.f. Note [TyVar binders for associated decls]
-}

-- | Type Family Instance Equation
type TyFamInstEqn pass = FamInstEqn pass (LHsType pass)

-- | Type family default declarations.
-- A convenient synonym for 'TyFamInstDecl'.
-- See @Note [Type family instance declarations in HsSyn]@.
type TyFamDefltDecl = TyFamInstDecl

-- | Located type family default declarations.
type LTyFamDefltDecl pass = Located (TyFamDefltDecl pass)

-- | Located Type Family Instance Declaration
type LTyFamInstDecl pass = Located (TyFamInstDecl pass)

-- | Type Family Instance Declaration
newtype TyFamInstDecl pass = TyFamInstDecl { TyFamInstDecl pass -> TyFamInstEqn pass
tfid_eqn :: TyFamInstEqn pass }
    -- ^
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnType',
    --           'ApiAnnotation.AnnInstance',

    -- For details on above see note [Api annotations] in ApiAnnotation

----------------- Data family instances -------------

-- | Located Data Family Instance Declaration
type LDataFamInstDecl pass = Located (DataFamInstDecl pass)

-- | Data Family Instance Declaration
newtype DataFamInstDecl pass
  = DataFamInstDecl { DataFamInstDecl pass -> FamInstEqn pass (HsDataDefn pass)
dfid_eqn :: FamInstEqn pass (HsDataDefn pass) }
    -- ^
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnData',
    --           'ApiAnnotation.AnnNewType','ApiAnnotation.AnnInstance',
    --           'ApiAnnotation.AnnDcolon'
    --           'ApiAnnotation.AnnWhere','ApiAnnotation.AnnOpen',
    --           'ApiAnnotation.AnnClose'

    -- For details on above see note [Api annotations] in ApiAnnotation

----------------- Family instances (common types) -------------

-- | Located Family Instance Equation
type LFamInstEqn pass rhs = Located (FamInstEqn pass rhs)

-- | Family Instance Equation
type FamInstEqn pass rhs = HsImplicitBndrs pass (FamEqn pass rhs)
            -- ^ Here, the @pats@ are type patterns (with kind and type bndrs).
            -- See Note [Family instance declaration binders]

-- | Family Equation
--
-- One equation in a type family instance declaration, data family instance
-- declaration, or type family default.
-- See Note [Type family instance declarations in HsSyn]
-- See Note [Family instance declaration binders]
data FamEqn pass rhs
  = FamEqn
       { FamEqn pass rhs -> XCFamEqn pass rhs
feqn_ext    :: XCFamEqn pass rhs
       , FamEqn pass rhs -> Located (IdP pass)
feqn_tycon  :: Located (IdP pass)
       , FamEqn pass rhs -> Maybe [LHsTyVarBndr pass]
feqn_bndrs  :: Maybe [LHsTyVarBndr pass] -- ^ Optional quantified type vars
       , FamEqn pass rhs -> HsTyPats pass
feqn_pats   :: HsTyPats pass
       , FamEqn pass rhs -> LexicalFixity
feqn_fixity :: LexicalFixity -- ^ Fixity used in the declaration
       , FamEqn pass rhs -> rhs
feqn_rhs    :: rhs
       }
    -- ^
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnEqual'
  | XFamEqn (XXFamEqn pass rhs)

    -- For details on above see note [Api annotations] in ApiAnnotation

type instance XCFamEqn    (GhcPass _) r = NoExtField
type instance XXFamEqn    (GhcPass _) r = NoExtCon

----------------- Class instances -------------

-- | Located Class Instance Declaration
type LClsInstDecl pass = Located (ClsInstDecl pass)

-- | Class Instance Declaration
data ClsInstDecl pass
  = ClsInstDecl
      { ClsInstDecl pass -> XCClsInstDecl pass
cid_ext     :: XCClsInstDecl pass
      , ClsInstDecl pass -> LHsSigType pass
cid_poly_ty :: LHsSigType pass    -- Context => Class Instance-type
                                          -- Using a polytype means that the renamer conveniently
                                          -- figures out the quantified type variables for us.
      , ClsInstDecl pass -> LHsBinds pass
cid_binds         :: LHsBinds pass       -- Class methods
      , ClsInstDecl pass -> [LSig pass]
cid_sigs          :: [LSig pass]         -- User-supplied pragmatic info
      , ClsInstDecl pass -> [LTyFamInstDecl pass]
cid_tyfam_insts   :: [LTyFamInstDecl pass]   -- Type family instances
      , ClsInstDecl pass -> [LDataFamInstDecl pass]
cid_datafam_insts :: [LDataFamInstDecl pass] -- Data family instances
      , ClsInstDecl pass -> Maybe (Located OverlapMode)
cid_overlap_mode  :: Maybe (Located OverlapMode)
         -- ^ - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnOpen',
         --                                    'ApiAnnotation.AnnClose',

        -- For details on above see note [Api annotations] in ApiAnnotation
      }
    -- ^
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnInstance',
    --           'ApiAnnotation.AnnWhere',
    --           'ApiAnnotation.AnnOpen','ApiAnnotation.AnnClose',

    -- For details on above see note [Api annotations] in ApiAnnotation
  | XClsInstDecl (XXClsInstDecl pass)

type instance XCClsInstDecl    (GhcPass _) = NoExtField
type instance XXClsInstDecl    (GhcPass _) = NoExtCon

----------------- Instances of all kinds -------------

-- | Located Instance Declaration
type LInstDecl pass = Located (InstDecl pass)

-- | Instance Declaration
data InstDecl pass  -- Both class and family instances
  = ClsInstD
      { InstDecl pass -> XClsInstD pass
cid_d_ext :: XClsInstD pass
      , InstDecl pass -> ClsInstDecl pass
cid_inst  :: ClsInstDecl pass }
  | DataFamInstD              -- data family instance
      { InstDecl pass -> XDataFamInstD pass
dfid_ext  :: XDataFamInstD pass
      , InstDecl pass -> DataFamInstDecl pass
dfid_inst :: DataFamInstDecl pass }
  | TyFamInstD              -- type family instance
      { InstDecl pass -> XTyFamInstD pass
tfid_ext  :: XTyFamInstD pass
      , InstDecl pass -> TyFamInstDecl pass
tfid_inst :: TyFamInstDecl pass }
  | XInstDecl (XXInstDecl pass)

type instance XClsInstD     (GhcPass _) = NoExtField
type instance XDataFamInstD (GhcPass _) = NoExtField
type instance XTyFamInstD   (GhcPass _) = NoExtField
type instance XXInstDecl    (GhcPass _) = NoExtCon

instance OutputableBndrId p
       => Outputable (TyFamInstDecl (GhcPass p)) where
  ppr :: TyFamInstDecl (GhcPass p) -> SDoc
ppr = TopLevelFlag -> TyFamInstDecl (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
TopLevelFlag -> TyFamInstDecl (GhcPass p) -> SDoc
pprTyFamInstDecl TopLevelFlag
TopLevel

pprTyFamInstDecl :: (OutputableBndrId p)
                 => TopLevelFlag -> TyFamInstDecl (GhcPass p) -> SDoc
pprTyFamInstDecl :: TopLevelFlag -> TyFamInstDecl (GhcPass p) -> SDoc
pprTyFamInstDecl TopLevelFlag
top_lvl (TyFamInstDecl { tfid_eqn :: forall pass. TyFamInstDecl pass -> TyFamInstEqn pass
tfid_eqn = TyFamInstEqn (GhcPass p)
eqn })
   = [Char] -> SDoc
text [Char]
"type" SDoc -> SDoc -> SDoc
<+> TopLevelFlag -> SDoc
ppr_instance_keyword TopLevelFlag
top_lvl SDoc -> SDoc -> SDoc
<+> TyFamInstEqn (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
TyFamInstEqn (GhcPass p) -> SDoc
ppr_fam_inst_eqn TyFamInstEqn (GhcPass p)
eqn

ppr_instance_keyword :: TopLevelFlag -> SDoc
ppr_instance_keyword :: TopLevelFlag -> SDoc
ppr_instance_keyword TopLevelFlag
TopLevel    = [Char] -> SDoc
text [Char]
"instance"
ppr_instance_keyword TopLevelFlag
NotTopLevel = SDoc
empty

pprTyFamDefltDecl :: (OutputableBndrId p)
                  => TyFamDefltDecl (GhcPass p) -> SDoc
pprTyFamDefltDecl :: TyFamDefltDecl (GhcPass p) -> SDoc
pprTyFamDefltDecl = TopLevelFlag -> TyFamDefltDecl (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
TopLevelFlag -> TyFamInstDecl (GhcPass p) -> SDoc
pprTyFamInstDecl TopLevelFlag
NotTopLevel

ppr_fam_inst_eqn :: (OutputableBndrId p)
                 => TyFamInstEqn (GhcPass p) -> SDoc
ppr_fam_inst_eqn :: TyFamInstEqn (GhcPass p) -> SDoc
ppr_fam_inst_eqn (HsIB { hsib_body :: forall pass thing. HsImplicitBndrs pass thing -> thing
hsib_body = FamEqn { feqn_tycon :: forall pass rhs. FamEqn pass rhs -> Located (IdP pass)
feqn_tycon  = L SrcSpan
_ IdP (GhcPass p)
tycon
                                            , feqn_bndrs :: forall pass rhs. FamEqn pass rhs -> Maybe [LHsTyVarBndr pass]
feqn_bndrs  = Maybe [LHsTyVarBndr (GhcPass p)]
bndrs
                                            , feqn_pats :: forall pass rhs. FamEqn pass rhs -> HsTyPats pass
feqn_pats   = HsTyPats (GhcPass p)
pats
                                            , feqn_fixity :: forall pass rhs. FamEqn pass rhs -> LexicalFixity
feqn_fixity = LexicalFixity
fixity
                                            , feqn_rhs :: forall pass rhs. FamEqn pass rhs -> rhs
feqn_rhs    = LHsType (GhcPass p)
rhs }})
    = IdP (GhcPass p)
-> Maybe [LHsTyVarBndr (GhcPass p)]
-> HsTyPats (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
forall (p :: Pass).
OutputableBndrId p =>
IdP (GhcPass p)
-> Maybe [LHsTyVarBndr (GhcPass p)]
-> HsTyPats (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
pprHsFamInstLHS IdP (GhcPass p)
tycon Maybe [LHsTyVarBndr (GhcPass p)]
bndrs HsTyPats (GhcPass p)
pats LexicalFixity
fixity LHsContext (GhcPass p)
forall pass. LHsContext pass
noLHsContext SDoc -> SDoc -> SDoc
<+> SDoc
equals SDoc -> SDoc -> SDoc
<+> LHsType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsType (GhcPass p)
rhs
ppr_fam_inst_eqn (HsIB { hsib_body :: forall pass thing. HsImplicitBndrs pass thing -> thing
hsib_body = XFamEqn XXFamEqn (GhcPass p) (LHsType (GhcPass p))
x }) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXFamEqn (GhcPass p) (LHsType (GhcPass p))
NoExtCon
x
ppr_fam_inst_eqn (XHsImplicitBndrs XXHsImplicitBndrs
  (GhcPass p) (FamEqn (GhcPass p) (LHsType (GhcPass p)))
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsImplicitBndrs
  (GhcPass p) (FamEqn (GhcPass p) (LHsType (GhcPass p)))
NoExtCon
x

instance OutputableBndrId p
       => Outputable (DataFamInstDecl (GhcPass p)) where
  ppr :: DataFamInstDecl (GhcPass p) -> SDoc
ppr = TopLevelFlag -> DataFamInstDecl (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
TopLevelFlag -> DataFamInstDecl (GhcPass p) -> SDoc
pprDataFamInstDecl TopLevelFlag
TopLevel

pprDataFamInstDecl :: (OutputableBndrId p)
                   => TopLevelFlag -> DataFamInstDecl (GhcPass p) -> SDoc
pprDataFamInstDecl :: TopLevelFlag -> DataFamInstDecl (GhcPass p) -> SDoc
pprDataFamInstDecl TopLevelFlag
top_lvl (DataFamInstDecl { dfid_eqn :: forall pass.
DataFamInstDecl pass -> FamInstEqn pass (HsDataDefn pass)
dfid_eqn = HsIB { hsib_body :: forall pass thing. HsImplicitBndrs pass thing -> thing
hsib_body =
                             FamEqn { feqn_tycon :: forall pass rhs. FamEqn pass rhs -> Located (IdP pass)
feqn_tycon  = L SrcSpan
_ IdP (GhcPass p)
tycon
                                    , feqn_bndrs :: forall pass rhs. FamEqn pass rhs -> Maybe [LHsTyVarBndr pass]
feqn_bndrs  = Maybe [LHsTyVarBndr (GhcPass p)]
bndrs
                                    , feqn_pats :: forall pass rhs. FamEqn pass rhs -> HsTyPats pass
feqn_pats   = HsTyPats (GhcPass p)
pats
                                    , feqn_fixity :: forall pass rhs. FamEqn pass rhs -> LexicalFixity
feqn_fixity = LexicalFixity
fixity
                                    , feqn_rhs :: forall pass rhs. FamEqn pass rhs -> rhs
feqn_rhs    = HsDataDefn (GhcPass p)
defn }}})
  = (LHsContext (GhcPass p) -> SDoc) -> HsDataDefn (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
(LHsContext (GhcPass p) -> SDoc) -> HsDataDefn (GhcPass p) -> SDoc
pp_data_defn LHsContext (GhcPass p) -> SDoc
pp_hdr HsDataDefn (GhcPass p)
defn
  where
    pp_hdr :: LHsContext (GhcPass p) -> SDoc
pp_hdr LHsContext (GhcPass p)
ctxt = TopLevelFlag -> SDoc
ppr_instance_keyword TopLevelFlag
top_lvl
              SDoc -> SDoc -> SDoc
<+> IdP (GhcPass p)
-> Maybe [LHsTyVarBndr (GhcPass p)]
-> HsTyPats (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
forall (p :: Pass).
OutputableBndrId p =>
IdP (GhcPass p)
-> Maybe [LHsTyVarBndr (GhcPass p)]
-> HsTyPats (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
pprHsFamInstLHS IdP (GhcPass p)
tycon Maybe [LHsTyVarBndr (GhcPass p)]
bndrs HsTyPats (GhcPass p)
pats LexicalFixity
fixity LHsContext (GhcPass p)
ctxt
                  -- pp_data_defn pretty-prints the kind sig. See #14817.

pprDataFamInstDecl TopLevelFlag
_ (DataFamInstDecl (HsIB XHsIB (GhcPass p) (FamEqn (GhcPass p) (HsDataDefn (GhcPass p)))
_ (XFamEqn XXFamEqn (GhcPass p) (HsDataDefn (GhcPass p))
x)))
  = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXFamEqn (GhcPass p) (HsDataDefn (GhcPass p))
NoExtCon
x
pprDataFamInstDecl TopLevelFlag
_ (DataFamInstDecl (XHsImplicitBndrs XXHsImplicitBndrs
  (GhcPass p) (FamEqn (GhcPass p) (HsDataDefn (GhcPass p)))
x))
  = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsImplicitBndrs
  (GhcPass p) (FamEqn (GhcPass p) (HsDataDefn (GhcPass p)))
NoExtCon
x

pprDataFamInstFlavour :: DataFamInstDecl (GhcPass p) -> SDoc
pprDataFamInstFlavour :: DataFamInstDecl (GhcPass p) -> SDoc
pprDataFamInstFlavour (DataFamInstDecl { dfid_eqn :: forall pass.
DataFamInstDecl pass -> FamInstEqn pass (HsDataDefn pass)
dfid_eqn = HsIB { hsib_body :: forall pass thing. HsImplicitBndrs pass thing -> thing
hsib_body =
                        FamEqn { feqn_rhs :: forall pass rhs. FamEqn pass rhs -> rhs
feqn_rhs = HsDataDefn { dd_ND :: forall pass. HsDataDefn pass -> NewOrData
dd_ND = NewOrData
nd }}}})
  = NewOrData -> SDoc
forall a. Outputable a => a -> SDoc
ppr NewOrData
nd
pprDataFamInstFlavour (DataFamInstDecl { dfid_eqn :: forall pass.
DataFamInstDecl pass -> FamInstEqn pass (HsDataDefn pass)
dfid_eqn = HsIB { hsib_body :: forall pass thing. HsImplicitBndrs pass thing -> thing
hsib_body =
                        FamEqn { feqn_rhs :: forall pass rhs. FamEqn pass rhs -> rhs
feqn_rhs = XHsDataDefn XXHsDataDefn (GhcPass p)
x}}})
  = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsDataDefn (GhcPass p)
NoExtCon
x
pprDataFamInstFlavour (DataFamInstDecl (HsIB XHsIB (GhcPass p) (FamEqn (GhcPass p) (HsDataDefn (GhcPass p)))
_ (XFamEqn XXFamEqn (GhcPass p) (HsDataDefn (GhcPass p))
x)))
  = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXFamEqn (GhcPass p) (HsDataDefn (GhcPass p))
NoExtCon
x
pprDataFamInstFlavour (DataFamInstDecl (XHsImplicitBndrs XXHsImplicitBndrs
  (GhcPass p) (FamEqn (GhcPass p) (HsDataDefn (GhcPass p)))
x))
  = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsImplicitBndrs
  (GhcPass p) (FamEqn (GhcPass p) (HsDataDefn (GhcPass p)))
NoExtCon
x

pprHsFamInstLHS :: (OutputableBndrId p)
   => IdP (GhcPass p)
   -> Maybe [LHsTyVarBndr (GhcPass p)]
   -> HsTyPats (GhcPass p)
   -> LexicalFixity
   -> LHsContext (GhcPass p)
   -> SDoc
pprHsFamInstLHS :: IdP (GhcPass p)
-> Maybe [LHsTyVarBndr (GhcPass p)]
-> HsTyPats (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
pprHsFamInstLHS IdP (GhcPass p)
thing Maybe [LHsTyVarBndr (GhcPass p)]
bndrs HsTyPats (GhcPass p)
typats LexicalFixity
fixity LHsContext (GhcPass p)
mb_ctxt
   = [SDoc] -> SDoc
hsep [ ForallVisFlag -> Maybe [LHsTyVarBndr (GhcPass p)] -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
ForallVisFlag -> Maybe [LHsTyVarBndr (GhcPass p)] -> SDoc
pprHsExplicitForAll ForallVisFlag
ForallInvis Maybe [LHsTyVarBndr (GhcPass p)]
bndrs
          , LHsContext (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
LHsContext (GhcPass p) -> SDoc
pprLHsContext LHsContext (GhcPass p)
mb_ctxt
          , HsTyPats (GhcPass p) -> SDoc
pp_pats HsTyPats (GhcPass p)
typats ]
   where
     pp_pats :: HsTyPats (GhcPass p) -> SDoc
pp_pats (LHsTypeArg (GhcPass p)
patl:LHsTypeArg (GhcPass p)
patr:HsTyPats (GhcPass p)
pats)
       | LexicalFixity
Infix <- LexicalFixity
fixity
       = let pp_op_app :: SDoc
pp_op_app = [SDoc] -> SDoc
hsep [ LHsTypeArg (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsTypeArg (GhcPass p)
patl, IdP (GhcPass p) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprInfixOcc IdP (GhcPass p)
thing, LHsTypeArg (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsTypeArg (GhcPass p)
patr ] in
         case HsTyPats (GhcPass p)
pats of
           [] -> SDoc
pp_op_app
           HsTyPats (GhcPass p)
_  -> [SDoc] -> SDoc
hsep (SDoc -> SDoc
parens SDoc
pp_op_app SDoc -> [SDoc] -> [SDoc]
forall a. a -> [a] -> [a]
: (LHsTypeArg (GhcPass p) -> SDoc) -> HsTyPats (GhcPass p) -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LHsTypeArg (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr HsTyPats (GhcPass p)
pats)

     pp_pats HsTyPats (GhcPass p)
pats = [SDoc] -> SDoc
hsep [ IdP (GhcPass p) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc IdP (GhcPass p)
thing
                         , [SDoc] -> SDoc
hsep ((LHsTypeArg (GhcPass p) -> SDoc) -> HsTyPats (GhcPass p) -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LHsTypeArg (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr HsTyPats (GhcPass p)
pats)]

instance OutputableBndrId p
       => Outputable (ClsInstDecl (GhcPass p)) where
    ppr :: ClsInstDecl (GhcPass p) -> SDoc
ppr (ClsInstDecl { cid_poly_ty :: forall pass. ClsInstDecl pass -> LHsSigType pass
cid_poly_ty = LHsSigType (GhcPass p)
inst_ty, cid_binds :: forall pass. ClsInstDecl pass -> LHsBinds pass
cid_binds = LHsBinds (GhcPass p)
binds
                     , cid_sigs :: forall pass. ClsInstDecl pass -> [LSig pass]
cid_sigs = [LSig (GhcPass p)]
sigs, cid_tyfam_insts :: forall pass. ClsInstDecl pass -> [LTyFamInstDecl pass]
cid_tyfam_insts = [LTyFamInstDecl (GhcPass p)]
ats
                     , cid_overlap_mode :: forall pass. ClsInstDecl pass -> Maybe (Located OverlapMode)
cid_overlap_mode = Maybe (Located OverlapMode)
mbOverlap
                     , cid_datafam_insts :: forall pass. ClsInstDecl pass -> [LDataFamInstDecl pass]
cid_datafam_insts = [LDataFamInstDecl (GhcPass p)]
adts })
      | [LSig (GhcPass p)] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LSig (GhcPass p)]
sigs, [LTyFamInstDecl (GhcPass p)] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LTyFamInstDecl (GhcPass p)]
ats, [LDataFamInstDecl (GhcPass p)] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LDataFamInstDecl (GhcPass p)]
adts, LHsBinds (GhcPass p) -> Bool
forall a. Bag a -> Bool
isEmptyBag LHsBinds (GhcPass p)
binds  -- No "where" part
      = SDoc
top_matter

      | Bool
otherwise       -- Laid out
      = [SDoc] -> SDoc
vcat [ SDoc
top_matter SDoc -> SDoc -> SDoc
<+> [Char] -> SDoc
text [Char]
"where"
             , Int -> SDoc -> SDoc
nest Int
2 (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ [SDoc] -> SDoc
pprDeclList ([SDoc] -> SDoc) -> [SDoc] -> SDoc
forall a b. (a -> b) -> a -> b
$
               (LTyFamInstDecl (GhcPass p) -> SDoc)
-> [LTyFamInstDecl (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (TopLevelFlag -> TyFamInstDecl (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
TopLevelFlag -> TyFamInstDecl (GhcPass p) -> SDoc
pprTyFamInstDecl TopLevelFlag
NotTopLevel (TyFamInstDecl (GhcPass p) -> SDoc)
-> (LTyFamInstDecl (GhcPass p) -> TyFamInstDecl (GhcPass p))
-> LTyFamInstDecl (GhcPass p)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LTyFamInstDecl (GhcPass p) -> TyFamInstDecl (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc)   [LTyFamInstDecl (GhcPass p)]
ats [SDoc] -> [SDoc] -> [SDoc]
forall a. [a] -> [a] -> [a]
++
               (LDataFamInstDecl (GhcPass p) -> SDoc)
-> [LDataFamInstDecl (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (TopLevelFlag -> DataFamInstDecl (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
TopLevelFlag -> DataFamInstDecl (GhcPass p) -> SDoc
pprDataFamInstDecl TopLevelFlag
NotTopLevel (DataFamInstDecl (GhcPass p) -> SDoc)
-> (LDataFamInstDecl (GhcPass p) -> DataFamInstDecl (GhcPass p))
-> LDataFamInstDecl (GhcPass p)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LDataFamInstDecl (GhcPass p) -> DataFamInstDecl (GhcPass p)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) [LDataFamInstDecl (GhcPass p)]
adts [SDoc] -> [SDoc] -> [SDoc]
forall a. [a] -> [a] -> [a]
++
               LHsBinds (GhcPass p) -> [LSig (GhcPass p)] -> [SDoc]
forall (idL :: Pass) (idR :: Pass) (id2 :: Pass).
(OutputableBndrId idL, OutputableBndrId idR,
 OutputableBndrId id2) =>
LHsBindsLR (GhcPass idL) (GhcPass idR)
-> [LSig (GhcPass id2)] -> [SDoc]
pprLHsBindsForUser LHsBinds (GhcPass p)
binds [LSig (GhcPass p)]
sigs ]
      where
        top_matter :: SDoc
top_matter = [Char] -> SDoc
text [Char]
"instance" SDoc -> SDoc -> SDoc
<+> Maybe (Located OverlapMode) -> SDoc
ppOverlapPragma Maybe (Located OverlapMode)
mbOverlap
                                             SDoc -> SDoc -> SDoc
<+> LHsSigType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsSigType (GhcPass p)
inst_ty
    ppr (XClsInstDecl XXClsInstDecl (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXClsInstDecl (GhcPass p)
NoExtCon
x

ppDerivStrategy :: OutputableBndrId p
                => Maybe (LDerivStrategy (GhcPass p)) -> SDoc
ppDerivStrategy :: Maybe (LDerivStrategy (GhcPass p)) -> SDoc
ppDerivStrategy Maybe (LDerivStrategy (GhcPass p))
mb =
  case Maybe (LDerivStrategy (GhcPass p))
mb of
    Maybe (LDerivStrategy (GhcPass p))
Nothing       -> SDoc
empty
    Just (L SrcSpan
_ DerivStrategy (GhcPass p)
ds) -> DerivStrategy (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr DerivStrategy (GhcPass p)
ds

ppOverlapPragma :: Maybe (Located OverlapMode) -> SDoc
ppOverlapPragma :: Maybe (Located OverlapMode) -> SDoc
ppOverlapPragma Maybe (Located OverlapMode)
mb =
  case Maybe (Located OverlapMode)
mb of
    Maybe (Located OverlapMode)
Nothing           -> SDoc
empty
    Just (L SrcSpan
_ (NoOverlap SourceText
s))    -> SourceText -> [Char] -> SDoc
maybe_stext SourceText
s [Char]
"{-# NO_OVERLAP #-}"
    Just (L SrcSpan
_ (Overlappable SourceText
s)) -> SourceText -> [Char] -> SDoc
maybe_stext SourceText
s [Char]
"{-# OVERLAPPABLE #-}"
    Just (L SrcSpan
_ (Overlapping SourceText
s))  -> SourceText -> [Char] -> SDoc
maybe_stext SourceText
s [Char]
"{-# OVERLAPPING #-}"
    Just (L SrcSpan
_ (Overlaps SourceText
s))     -> SourceText -> [Char] -> SDoc
maybe_stext SourceText
s [Char]
"{-# OVERLAPS #-}"
    Just (L SrcSpan
_ (Incoherent SourceText
s))   -> SourceText -> [Char] -> SDoc
maybe_stext SourceText
s [Char]
"{-# INCOHERENT #-}"
  where
    maybe_stext :: SourceText -> [Char] -> SDoc
maybe_stext SourceText
NoSourceText     [Char]
alt = [Char] -> SDoc
text [Char]
alt
    maybe_stext (SourceText [Char]
src) [Char]
_   = [Char] -> SDoc
text [Char]
src SDoc -> SDoc -> SDoc
<+> [Char] -> SDoc
text [Char]
"#-}"


instance (OutputableBndrId p) => Outputable (InstDecl (GhcPass p)) where
    ppr :: InstDecl (GhcPass p) -> SDoc
ppr (ClsInstD     { cid_inst :: forall pass. InstDecl pass -> ClsInstDecl pass
cid_inst  = ClsInstDecl (GhcPass p)
decl }) = ClsInstDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr ClsInstDecl (GhcPass p)
decl
    ppr (TyFamInstD   { tfid_inst :: forall pass. InstDecl pass -> TyFamInstDecl pass
tfid_inst = TyFamInstDecl (GhcPass p)
decl }) = TyFamInstDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr TyFamInstDecl (GhcPass p)
decl
    ppr (DataFamInstD { dfid_inst :: forall pass. InstDecl pass -> DataFamInstDecl pass
dfid_inst = DataFamInstDecl (GhcPass p)
decl }) = DataFamInstDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr DataFamInstDecl (GhcPass p)
decl
    ppr (XInstDecl XXInstDecl (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXInstDecl (GhcPass p)
NoExtCon
x

-- Extract the declarations of associated data types from an instance

instDeclDataFamInsts :: [LInstDecl (GhcPass p)] -> [DataFamInstDecl (GhcPass p)]
instDeclDataFamInsts :: [LInstDecl (GhcPass p)] -> [DataFamInstDecl (GhcPass p)]
instDeclDataFamInsts [LInstDecl (GhcPass p)]
inst_decls
  = (LInstDecl (GhcPass p) -> [DataFamInstDecl (GhcPass p)])
-> [LInstDecl (GhcPass p)] -> [DataFamInstDecl (GhcPass p)]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap LInstDecl (GhcPass p) -> [DataFamInstDecl (GhcPass p)]
forall pass l.
(XXClsInstDecl pass ~ NoExtCon, XXInstDecl pass ~ NoExtCon) =>
GenLocated l (InstDecl pass) -> [DataFamInstDecl pass]
do_one [LInstDecl (GhcPass p)]
inst_decls
  where
    do_one :: GenLocated l (InstDecl pass) -> [DataFamInstDecl pass]
do_one (L l
_ (ClsInstD { cid_inst :: forall pass. InstDecl pass -> ClsInstDecl pass
cid_inst = ClsInstDecl { cid_datafam_insts :: forall pass. ClsInstDecl pass -> [LDataFamInstDecl pass]
cid_datafam_insts = [LDataFamInstDecl pass]
fam_insts } }))
      = (LDataFamInstDecl pass -> DataFamInstDecl pass)
-> [LDataFamInstDecl pass] -> [DataFamInstDecl pass]
forall a b. (a -> b) -> [a] -> [b]
map LDataFamInstDecl pass -> DataFamInstDecl pass
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc [LDataFamInstDecl pass]
fam_insts
    do_one (L l
_ (DataFamInstD { dfid_inst :: forall pass. InstDecl pass -> DataFamInstDecl pass
dfid_inst = DataFamInstDecl pass
fam_inst }))      = [DataFamInstDecl pass
fam_inst]
    do_one (L l
_ (TyFamInstD {}))                              = []
    do_one (L l
_ (ClsInstD XClsInstD pass
_ (XClsInstDecl XXClsInstDecl pass
nec))) = NoExtCon -> [DataFamInstDecl pass]
forall a. NoExtCon -> a
noExtCon XXClsInstDecl pass
NoExtCon
nec
    do_one (L l
_ (XInstDecl XXInstDecl pass
nec))                 = NoExtCon -> [DataFamInstDecl pass]
forall a. NoExtCon -> a
noExtCon XXInstDecl pass
NoExtCon
nec

{-
************************************************************************
*                                                                      *
\subsection[DerivDecl]{A stand-alone instance deriving declaration}
*                                                                      *
************************************************************************
-}

-- | Located stand-alone 'deriving instance' declaration
type LDerivDecl pass = Located (DerivDecl pass)

-- | Stand-alone 'deriving instance' declaration
data DerivDecl pass = DerivDecl
        { DerivDecl pass -> XCDerivDecl pass
deriv_ext          :: XCDerivDecl pass
        , DerivDecl pass -> LHsSigWcType pass
deriv_type         :: LHsSigWcType pass
          -- ^ The instance type to derive.
          --
          -- It uses an 'LHsSigWcType' because the context is allowed to be a
          -- single wildcard:
          --
          -- > deriving instance _ => Eq (Foo a)
          --
          -- Which signifies that the context should be inferred.

          -- See Note [Inferring the instance context] in TcDerivInfer.

        , DerivDecl pass -> Maybe (LDerivStrategy pass)
deriv_strategy     :: Maybe (LDerivStrategy pass)
        , DerivDecl pass -> Maybe (Located OverlapMode)
deriv_overlap_mode :: Maybe (Located OverlapMode)
         -- ^ - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnDeriving',
         --        'ApiAnnotation.AnnInstance', 'ApiAnnotation.AnnStock',
         --        'ApiAnnotation.AnnAnyClass', 'Api.AnnNewtype',
         --        'ApiAnnotation.AnnOpen','ApiAnnotation.AnnClose'

  -- For details on above see note [Api annotations] in ApiAnnotation
        }
  | XDerivDecl (XXDerivDecl pass)

type instance XCDerivDecl    (GhcPass _) = NoExtField
type instance XXDerivDecl    (GhcPass _) = NoExtCon

instance OutputableBndrId p
       => Outputable (DerivDecl (GhcPass p)) where
    ppr :: DerivDecl (GhcPass p) -> SDoc
ppr (DerivDecl { deriv_type :: forall pass. DerivDecl pass -> LHsSigWcType pass
deriv_type = LHsSigWcType (GhcPass p)
ty
                   , deriv_strategy :: forall pass. DerivDecl pass -> Maybe (LDerivStrategy pass)
deriv_strategy = Maybe (LDerivStrategy (GhcPass p))
ds
                   , deriv_overlap_mode :: forall pass. DerivDecl pass -> Maybe (Located OverlapMode)
deriv_overlap_mode = Maybe (Located OverlapMode)
o })
        = [SDoc] -> SDoc
hsep [ [Char] -> SDoc
text [Char]
"deriving"
               , Maybe (LDerivStrategy (GhcPass p)) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
Maybe (LDerivStrategy (GhcPass p)) -> SDoc
ppDerivStrategy Maybe (LDerivStrategy (GhcPass p))
ds
               , [Char] -> SDoc
text [Char]
"instance"
               , Maybe (Located OverlapMode) -> SDoc
ppOverlapPragma Maybe (Located OverlapMode)
o
               , LHsSigWcType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsSigWcType (GhcPass p)
ty ]
    ppr (XDerivDecl XXDerivDecl (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXDerivDecl (GhcPass p)
NoExtCon
x

{-
************************************************************************
*                                                                      *
                Deriving strategies
*                                                                      *
************************************************************************
-}

-- | A 'Located' 'DerivStrategy'.
type LDerivStrategy pass = Located (DerivStrategy pass)

-- | Which technique the user explicitly requested when deriving an instance.
data DerivStrategy pass
  -- See Note [Deriving strategies] in TcDeriv
  = StockStrategy    -- ^ GHC's \"standard\" strategy, which is to implement a
                     --   custom instance for the data type. This only works
                     --   for certain types that GHC knows about (e.g., 'Eq',
                     --   'Show', 'Functor' when @-XDeriveFunctor@ is enabled,
                     --   etc.)
  | AnyclassStrategy -- ^ @-XDeriveAnyClass@
  | NewtypeStrategy  -- ^ @-XGeneralizedNewtypeDeriving@
  | ViaStrategy (XViaStrategy pass)
                     -- ^ @-XDerivingVia@

type instance XViaStrategy GhcPs = LHsSigType GhcPs
type instance XViaStrategy GhcRn = LHsSigType GhcRn
type instance XViaStrategy GhcTc = Type

instance OutputableBndrId p
        => Outputable (DerivStrategy (GhcPass p)) where
    ppr :: DerivStrategy (GhcPass p) -> SDoc
ppr DerivStrategy (GhcPass p)
StockStrategy    = [Char] -> SDoc
text [Char]
"stock"
    ppr DerivStrategy (GhcPass p)
AnyclassStrategy = [Char] -> SDoc
text [Char]
"anyclass"
    ppr DerivStrategy (GhcPass p)
NewtypeStrategy  = [Char] -> SDoc
text [Char]
"newtype"
    ppr (ViaStrategy XViaStrategy (GhcPass p)
ty) = [Char] -> SDoc
text [Char]
"via" SDoc -> SDoc -> SDoc
<+> XViaStrategy (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr XViaStrategy (GhcPass p)
ty

-- | A short description of a @DerivStrategy'@.
derivStrategyName :: DerivStrategy a -> SDoc
derivStrategyName :: DerivStrategy a -> SDoc
derivStrategyName = [Char] -> SDoc
text ([Char] -> SDoc)
-> (DerivStrategy a -> [Char]) -> DerivStrategy a -> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. DerivStrategy a -> [Char]
forall pass. DerivStrategy pass -> [Char]
go
  where
    go :: DerivStrategy pass -> [Char]
go DerivStrategy pass
StockStrategy    = [Char]
"stock"
    go DerivStrategy pass
AnyclassStrategy = [Char]
"anyclass"
    go DerivStrategy pass
NewtypeStrategy  = [Char]
"newtype"
    go (ViaStrategy {}) = [Char]
"via"

-- | Eliminate a 'DerivStrategy'.
foldDerivStrategy :: (p ~ GhcPass pass)
                  => r -> (XViaStrategy p -> r) -> DerivStrategy p -> r
foldDerivStrategy :: r -> (XViaStrategy p -> r) -> DerivStrategy p -> r
foldDerivStrategy r
other XViaStrategy p -> r
_   DerivStrategy p
StockStrategy    = r
other
foldDerivStrategy r
other XViaStrategy p -> r
_   DerivStrategy p
AnyclassStrategy = r
other
foldDerivStrategy r
other XViaStrategy p -> r
_   DerivStrategy p
NewtypeStrategy  = r
other
foldDerivStrategy r
_     XViaStrategy p -> r
via (ViaStrategy XViaStrategy p
t)  = XViaStrategy p -> r
via XViaStrategy p
t

-- | Map over the @via@ type if dealing with 'ViaStrategy'. Otherwise,
-- return the 'DerivStrategy' unchanged.
mapDerivStrategy :: (p ~ GhcPass pass)
                 => (XViaStrategy p -> XViaStrategy p)
                 -> DerivStrategy p -> DerivStrategy p
mapDerivStrategy :: (XViaStrategy p -> XViaStrategy p)
-> DerivStrategy p -> DerivStrategy p
mapDerivStrategy XViaStrategy p -> XViaStrategy p
f DerivStrategy p
ds = DerivStrategy p
-> (XViaStrategy p -> DerivStrategy p)
-> DerivStrategy p
-> DerivStrategy p
forall p (pass :: Pass) r.
(p ~ GhcPass pass) =>
r -> (XViaStrategy p -> r) -> DerivStrategy p -> r
foldDerivStrategy DerivStrategy p
ds (XViaStrategy (GhcPass pass) -> DerivStrategy p
forall pass. XViaStrategy pass -> DerivStrategy pass
ViaStrategy (XViaStrategy (GhcPass pass) -> DerivStrategy p)
-> (XViaStrategy (GhcPass pass) -> XViaStrategy (GhcPass pass))
-> XViaStrategy (GhcPass pass)
-> DerivStrategy p
forall b c a. (b -> c) -> (a -> b) -> a -> c
. XViaStrategy p -> XViaStrategy p
XViaStrategy (GhcPass pass) -> XViaStrategy (GhcPass pass)
f) DerivStrategy p
ds

{-
************************************************************************
*                                                                      *
\subsection[DefaultDecl]{A @default@ declaration}
*                                                                      *
************************************************************************

There can only be one default declaration per module, but it is hard
for the parser to check that; we pass them all through in the abstract
syntax, and that restriction must be checked in the front end.
-}

-- | Located Default Declaration
type LDefaultDecl pass = Located (DefaultDecl pass)

-- | Default Declaration
data DefaultDecl pass
  = DefaultDecl (XCDefaultDecl pass) [LHsType pass]
        -- ^ - 'ApiAnnotation.AnnKeywordId's : 'ApiAnnotation.AnnDefault',
        --          'ApiAnnotation.AnnOpen','ApiAnnotation.AnnClose'

        -- For details on above see note [Api annotations] in ApiAnnotation
  | XDefaultDecl (XXDefaultDecl pass)

type instance XCDefaultDecl    (GhcPass _) = NoExtField
type instance XXDefaultDecl    (GhcPass _) = NoExtCon

instance OutputableBndrId p
       => Outputable (DefaultDecl (GhcPass p)) where
    ppr :: DefaultDecl (GhcPass p) -> SDoc
ppr (DefaultDecl XCDefaultDecl (GhcPass p)
_ [LHsType (GhcPass p)]
tys)
      = [Char] -> SDoc
text [Char]
"default" SDoc -> SDoc -> SDoc
<+> SDoc -> SDoc
parens ([LHsType (GhcPass p)] -> SDoc
forall a. Outputable a => [a] -> SDoc
interpp'SP [LHsType (GhcPass p)]
tys)
    ppr (XDefaultDecl XXDefaultDecl (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXDefaultDecl (GhcPass p)
NoExtCon
x

{-
************************************************************************
*                                                                      *
\subsection{Foreign function interface declaration}
*                                                                      *
************************************************************************
-}

-- foreign declarations are distinguished as to whether they define or use a
-- Haskell name
--
--  * the Boolean value indicates whether the pre-standard deprecated syntax
--   has been used

-- | Located Foreign Declaration
type LForeignDecl pass = Located (ForeignDecl pass)

-- | Foreign Declaration
data ForeignDecl pass
  = ForeignImport
      { ForeignDecl pass -> XForeignImport pass
fd_i_ext  :: XForeignImport pass   -- Post typechecker, rep_ty ~ sig_ty
      , ForeignDecl pass -> Located (IdP pass)
fd_name   :: Located (IdP pass)    -- defines this name
      , ForeignDecl pass -> LHsSigType pass
fd_sig_ty :: LHsSigType pass       -- sig_ty
      , ForeignDecl pass -> ForeignImport
fd_fi     :: ForeignImport }

  | ForeignExport
      { ForeignDecl pass -> XForeignExport pass
fd_e_ext  :: XForeignExport pass   -- Post typechecker, rep_ty ~ sig_ty
      , fd_name   :: Located (IdP pass)    -- uses this name
      , fd_sig_ty :: LHsSigType pass       -- sig_ty
      , ForeignDecl pass -> ForeignExport
fd_fe     :: ForeignExport }
        -- ^
        --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnForeign',
        --           'ApiAnnotation.AnnImport','ApiAnnotation.AnnExport',
        --           'ApiAnnotation.AnnDcolon'

        -- For details on above see note [Api annotations] in ApiAnnotation
  | XForeignDecl (XXForeignDecl pass)

{-
    In both ForeignImport and ForeignExport:
        sig_ty is the type given in the Haskell code
        rep_ty is the representation for this type, i.e. with newtypes
               coerced away and type functions evaluated.
    Thus if the declaration is valid, then rep_ty will only use types
    such as Int and IO that we know how to make foreign calls with.
-}

type instance XForeignImport   GhcPs = NoExtField
type instance XForeignImport   GhcRn = NoExtField
type instance XForeignImport   GhcTc = Coercion

type instance XForeignExport   GhcPs = NoExtField
type instance XForeignExport   GhcRn = NoExtField
type instance XForeignExport   GhcTc = Coercion

type instance XXForeignDecl    (GhcPass _) = NoExtCon

-- Specification Of an imported external entity in dependence on the calling
-- convention
--
data ForeignImport = -- import of a C entity
                     --
                     --  * the two strings specifying a header file or library
                     --   may be empty, which indicates the absence of a
                     --   header or object specification (both are not used
                     --   in the case of `CWrapper' and when `CFunction'
                     --   has a dynamic target)
                     --
                     --  * the calling convention is irrelevant for code
                     --   generation in the case of `CLabel', but is needed
                     --   for pretty printing
                     --
                     --  * `Safety' is irrelevant for `CLabel' and `CWrapper'
                     --
                     CImport  (Located CCallConv) -- ccall or stdcall
                              (Located Safety)  -- interruptible, safe or unsafe
                              (Maybe Header)       -- name of C header
                              CImportSpec          -- details of the C entity
                              (Located SourceText) -- original source text for
                                                   -- the C entity
  deriving Typeable ForeignImport
DataType
Constr
Typeable ForeignImport
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> ForeignImport -> c ForeignImport)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c ForeignImport)
-> (ForeignImport -> Constr)
-> (ForeignImport -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c ForeignImport))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e))
    -> Maybe (c ForeignImport))
-> ((forall b. Data b => b -> b) -> ForeignImport -> ForeignImport)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> ForeignImport -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> ForeignImport -> r)
-> (forall u. (forall d. Data d => d -> u) -> ForeignImport -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> ForeignImport -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport)
-> Data ForeignImport
ForeignImport -> DataType
ForeignImport -> Constr
(forall b. Data b => b -> b) -> ForeignImport -> ForeignImport
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ForeignImport -> c ForeignImport
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ForeignImport
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> ForeignImport -> u
forall u. (forall d. Data d => d -> u) -> ForeignImport -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignImport -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignImport -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ForeignImport
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ForeignImport -> c ForeignImport
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c ForeignImport)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c ForeignImport)
$cCImport :: Constr
$tForeignImport :: DataType
gmapMo :: (forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport
gmapMp :: (forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport
gmapM :: (forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> ForeignImport -> m ForeignImport
gmapQi :: Int -> (forall d. Data d => d -> u) -> ForeignImport -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> ForeignImport -> u
gmapQ :: (forall d. Data d => d -> u) -> ForeignImport -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> ForeignImport -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignImport -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignImport -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignImport -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignImport -> r
gmapT :: (forall b. Data b => b -> b) -> ForeignImport -> ForeignImport
$cgmapT :: (forall b. Data b => b -> b) -> ForeignImport -> ForeignImport
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c ForeignImport)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c ForeignImport)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c ForeignImport)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c ForeignImport)
dataTypeOf :: ForeignImport -> DataType
$cdataTypeOf :: ForeignImport -> DataType
toConstr :: ForeignImport -> Constr
$ctoConstr :: ForeignImport -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ForeignImport
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ForeignImport
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ForeignImport -> c ForeignImport
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ForeignImport -> c ForeignImport
$cp1Data :: Typeable ForeignImport
Data

-- details of an external C entity
--
data CImportSpec = CLabel    CLabelString     -- import address of a C label
                 | CFunction CCallTarget      -- static or dynamic function
                 | CWrapper                   -- wrapper to expose closures
                                              -- (former f.e.d.)
  deriving Typeable CImportSpec
DataType
Constr
Typeable CImportSpec
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> CImportSpec -> c CImportSpec)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c CImportSpec)
-> (CImportSpec -> Constr)
-> (CImportSpec -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c CImportSpec))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e))
    -> Maybe (c CImportSpec))
-> ((forall b. Data b => b -> b) -> CImportSpec -> CImportSpec)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> CImportSpec -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> CImportSpec -> r)
-> (forall u. (forall d. Data d => d -> u) -> CImportSpec -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> CImportSpec -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec)
-> Data CImportSpec
CImportSpec -> DataType
CImportSpec -> Constr
(forall b. Data b => b -> b) -> CImportSpec -> CImportSpec
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> CImportSpec -> c CImportSpec
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c CImportSpec
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> CImportSpec -> u
forall u. (forall d. Data d => d -> u) -> CImportSpec -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> CImportSpec -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> CImportSpec -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c CImportSpec
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> CImportSpec -> c CImportSpec
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c CImportSpec)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c CImportSpec)
$cCWrapper :: Constr
$cCFunction :: Constr
$cCLabel :: Constr
$tCImportSpec :: DataType
gmapMo :: (forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec
gmapMp :: (forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec
gmapM :: (forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> CImportSpec -> m CImportSpec
gmapQi :: Int -> (forall d. Data d => d -> u) -> CImportSpec -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> CImportSpec -> u
gmapQ :: (forall d. Data d => d -> u) -> CImportSpec -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> CImportSpec -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> CImportSpec -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> CImportSpec -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> CImportSpec -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> CImportSpec -> r
gmapT :: (forall b. Data b => b -> b) -> CImportSpec -> CImportSpec
$cgmapT :: (forall b. Data b => b -> b) -> CImportSpec -> CImportSpec
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c CImportSpec)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c CImportSpec)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c CImportSpec)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c CImportSpec)
dataTypeOf :: CImportSpec -> DataType
$cdataTypeOf :: CImportSpec -> DataType
toConstr :: CImportSpec -> Constr
$ctoConstr :: CImportSpec -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c CImportSpec
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c CImportSpec
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> CImportSpec -> c CImportSpec
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> CImportSpec -> c CImportSpec
$cp1Data :: Typeable CImportSpec
Data

-- specification of an externally exported entity in dependence on the calling
-- convention
--
data ForeignExport = CExport  (Located CExportSpec) -- contains the calling
                                                    -- convention
                              (Located SourceText)  -- original source text for
                                                    -- the C entity
  deriving Typeable ForeignExport
DataType
Constr
Typeable ForeignExport
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> ForeignExport -> c ForeignExport)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c ForeignExport)
-> (ForeignExport -> Constr)
-> (ForeignExport -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c ForeignExport))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e))
    -> Maybe (c ForeignExport))
-> ((forall b. Data b => b -> b) -> ForeignExport -> ForeignExport)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> ForeignExport -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> ForeignExport -> r)
-> (forall u. (forall d. Data d => d -> u) -> ForeignExport -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> ForeignExport -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport)
-> Data ForeignExport
ForeignExport -> DataType
ForeignExport -> Constr
(forall b. Data b => b -> b) -> ForeignExport -> ForeignExport
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ForeignExport -> c ForeignExport
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ForeignExport
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> ForeignExport -> u
forall u. (forall d. Data d => d -> u) -> ForeignExport -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignExport -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignExport -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ForeignExport
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ForeignExport -> c ForeignExport
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c ForeignExport)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c ForeignExport)
$cCExport :: Constr
$tForeignExport :: DataType
gmapMo :: (forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport
gmapMp :: (forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport
gmapM :: (forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> ForeignExport -> m ForeignExport
gmapQi :: Int -> (forall d. Data d => d -> u) -> ForeignExport -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> ForeignExport -> u
gmapQ :: (forall d. Data d => d -> u) -> ForeignExport -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> ForeignExport -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignExport -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignExport -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignExport -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> ForeignExport -> r
gmapT :: (forall b. Data b => b -> b) -> ForeignExport -> ForeignExport
$cgmapT :: (forall b. Data b => b -> b) -> ForeignExport -> ForeignExport
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c ForeignExport)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c ForeignExport)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c ForeignExport)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c ForeignExport)
dataTypeOf :: ForeignExport -> DataType
$cdataTypeOf :: ForeignExport -> DataType
toConstr :: ForeignExport -> Constr
$ctoConstr :: ForeignExport -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ForeignExport
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c ForeignExport
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ForeignExport -> c ForeignExport
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> ForeignExport -> c ForeignExport
$cp1Data :: Typeable ForeignExport
Data

-- pretty printing of foreign declarations
--

instance OutputableBndrId p
       => Outputable (ForeignDecl (GhcPass p)) where
  ppr :: ForeignDecl (GhcPass p) -> SDoc
ppr (ForeignImport { fd_name :: forall pass. ForeignDecl pass -> Located (IdP pass)
fd_name = Located (IdP (GhcPass p))
n, fd_sig_ty :: forall pass. ForeignDecl pass -> LHsSigType pass
fd_sig_ty = LHsSigType (GhcPass p)
ty, fd_fi :: forall pass. ForeignDecl pass -> ForeignImport
fd_fi = ForeignImport
fimport })
    = SDoc -> Int -> SDoc -> SDoc
hang ([Char] -> SDoc
text [Char]
"foreign import" SDoc -> SDoc -> SDoc
<+> ForeignImport -> SDoc
forall a. Outputable a => a -> SDoc
ppr ForeignImport
fimport SDoc -> SDoc -> SDoc
<+> Located (IdP (GhcPass p)) -> SDoc
forall a. Outputable a => a -> SDoc
ppr Located (IdP (GhcPass p))
n)
         Int
2 (SDoc
dcolon SDoc -> SDoc -> SDoc
<+> LHsSigType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsSigType (GhcPass p)
ty)
  ppr (ForeignExport { fd_name :: forall pass. ForeignDecl pass -> Located (IdP pass)
fd_name = Located (IdP (GhcPass p))
n, fd_sig_ty :: forall pass. ForeignDecl pass -> LHsSigType pass
fd_sig_ty = LHsSigType (GhcPass p)
ty, fd_fe :: forall pass. ForeignDecl pass -> ForeignExport
fd_fe = ForeignExport
fexport }) =
    SDoc -> Int -> SDoc -> SDoc
hang ([Char] -> SDoc
text [Char]
"foreign export" SDoc -> SDoc -> SDoc
<+> ForeignExport -> SDoc
forall a. Outputable a => a -> SDoc
ppr ForeignExport
fexport SDoc -> SDoc -> SDoc
<+> Located (IdP (GhcPass p)) -> SDoc
forall a. Outputable a => a -> SDoc
ppr Located (IdP (GhcPass p))
n)
       Int
2 (SDoc
dcolon SDoc -> SDoc -> SDoc
<+> LHsSigType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsSigType (GhcPass p)
ty)
  ppr (XForeignDecl XXForeignDecl (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXForeignDecl (GhcPass p)
NoExtCon
x

instance Outputable ForeignImport where
  ppr :: ForeignImport -> SDoc
ppr (CImport  Located CCallConv
cconv Located Safety
safety Maybe Header
mHeader CImportSpec
spec (L SrcSpan
_ SourceText
srcText)) =
    Located CCallConv -> SDoc
forall a. Outputable a => a -> SDoc
ppr Located CCallConv
cconv SDoc -> SDoc -> SDoc
<+> Located Safety -> SDoc
forall a. Outputable a => a -> SDoc
ppr Located Safety
safety
      SDoc -> SDoc -> SDoc
<+> SourceText -> SDoc -> SDoc
pprWithSourceText SourceText
srcText (CImportSpec -> [Char] -> SDoc
pprCEntity CImportSpec
spec [Char]
"")
    where
      pp_hdr :: SDoc
pp_hdr = case Maybe Header
mHeader of
               Maybe Header
Nothing -> SDoc
empty
               Just (Header SourceText
_ FastString
header) -> FastString -> SDoc
ftext FastString
header

      pprCEntity :: CImportSpec -> [Char] -> SDoc
pprCEntity (CLabel FastString
lbl) [Char]
_ =
        SDoc -> SDoc
doubleQuotes (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ [Char] -> SDoc
text [Char]
"static" SDoc -> SDoc -> SDoc
<+> SDoc
pp_hdr SDoc -> SDoc -> SDoc
<+> Char -> SDoc
char Char
'&' SDoc -> SDoc -> SDoc
<> FastString -> SDoc
forall a. Outputable a => a -> SDoc
ppr FastString
lbl
      pprCEntity (CFunction (StaticTarget SourceText
st FastString
_lbl Maybe UnitId
_ Bool
isFun)) [Char]
src =
        if Bool
dqNeeded then SDoc -> SDoc
doubleQuotes SDoc
ce else SDoc
empty
          where
            dqNeeded :: Bool
dqNeeded = (Int -> [Char] -> [Char]
forall a. Int -> [a] -> [a]
take Int
6 [Char]
src [Char] -> [Char] -> Bool
forall a. Eq a => a -> a -> Bool
== [Char]
"static")
                    Bool -> Bool -> Bool
|| Maybe Header -> Bool
forall a. Maybe a -> Bool
isJust Maybe Header
mHeader
                    Bool -> Bool -> Bool
|| Bool -> Bool
not Bool
isFun
                    Bool -> Bool -> Bool
|| SourceText
st SourceText -> SourceText -> Bool
forall a. Eq a => a -> a -> Bool
/= SourceText
NoSourceText
            ce :: SDoc
ce =
                  -- We may need to drop leading spaces first
                  (if Int -> [Char] -> [Char]
forall a. Int -> [a] -> [a]
take Int
6 [Char]
src [Char] -> [Char] -> Bool
forall a. Eq a => a -> a -> Bool
== [Char]
"static" then [Char] -> SDoc
text [Char]
"static" else SDoc
empty)
              SDoc -> SDoc -> SDoc
<+> SDoc
pp_hdr
              SDoc -> SDoc -> SDoc
<+> (if Bool
isFun then SDoc
empty else [Char] -> SDoc
text [Char]
"value")
              SDoc -> SDoc -> SDoc
<+> (SourceText -> SDoc -> SDoc
pprWithSourceText SourceText
st SDoc
empty)
      pprCEntity (CFunction CCallTarget
DynamicTarget) [Char]
_ =
        SDoc -> SDoc
doubleQuotes (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ [Char] -> SDoc
text [Char]
"dynamic"
      pprCEntity CImportSpec
CWrapper [Char]
_ = SDoc -> SDoc
doubleQuotes (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ [Char] -> SDoc
text [Char]
"wrapper"

instance Outputable ForeignExport where
  ppr :: ForeignExport -> SDoc
ppr (CExport  (L SrcSpan
_ (CExportStatic SourceText
_ FastString
lbl CCallConv
cconv)) GenLocated SrcSpan SourceText
_) =
    CCallConv -> SDoc
forall a. Outputable a => a -> SDoc
ppr CCallConv
cconv SDoc -> SDoc -> SDoc
<+> Char -> SDoc
char Char
'"' SDoc -> SDoc -> SDoc
<> FastString -> SDoc
forall a. Outputable a => a -> SDoc
ppr FastString
lbl SDoc -> SDoc -> SDoc
<> Char -> SDoc
char Char
'"'

{-
************************************************************************
*                                                                      *
\subsection{Transformation rules}
*                                                                      *
************************************************************************
-}

-- | Located Rule Declarations
type LRuleDecls pass = Located (RuleDecls pass)

  -- Note [Pragma source text] in BasicTypes
-- | Rule Declarations
data RuleDecls pass = HsRules { RuleDecls pass -> XCRuleDecls pass
rds_ext   :: XCRuleDecls pass
                              , RuleDecls pass -> SourceText
rds_src   :: SourceText
                              , RuleDecls pass -> [LRuleDecl pass]
rds_rules :: [LRuleDecl pass] }
  | XRuleDecls (XXRuleDecls pass)

type instance XCRuleDecls    (GhcPass _) = NoExtField
type instance XXRuleDecls    (GhcPass _) = NoExtCon

-- | Located Rule Declaration
type LRuleDecl pass = Located (RuleDecl pass)

-- | Rule Declaration
data RuleDecl pass
  = HsRule -- Source rule
       { RuleDecl pass -> XHsRule pass
rd_ext  :: XHsRule pass
           -- ^ After renamer, free-vars from the LHS and RHS
       , RuleDecl pass -> Located (SourceText, FastString)
rd_name :: Located (SourceText,RuleName)
           -- ^ Note [Pragma source text] in BasicTypes
       , RuleDecl pass -> Activation
rd_act  :: Activation
       , RuleDecl pass -> Maybe [LHsTyVarBndr (NoGhcTc pass)]
rd_tyvs :: Maybe [LHsTyVarBndr (NoGhcTc pass)]
           -- ^ Forall'd type vars
       , RuleDecl pass -> [LRuleBndr pass]
rd_tmvs :: [LRuleBndr pass]
           -- ^ Forall'd term vars, before typechecking; after typechecking
           --    this includes all forall'd vars
       , RuleDecl pass -> Located (HsExpr pass)
rd_lhs  :: Located (HsExpr pass)
       , RuleDecl pass -> Located (HsExpr pass)
rd_rhs  :: Located (HsExpr pass)
       }
    -- ^
    --  - 'ApiAnnotation.AnnKeywordId' :
    --           'ApiAnnotation.AnnOpen','ApiAnnotation.AnnTilde',
    --           'ApiAnnotation.AnnVal',
    --           'ApiAnnotation.AnnClose',
    --           'ApiAnnotation.AnnForall','ApiAnnotation.AnnDot',
    --           'ApiAnnotation.AnnEqual',
  | XRuleDecl (XXRuleDecl pass)

data HsRuleRn = HsRuleRn NameSet NameSet -- Free-vars from the LHS and RHS
  deriving Typeable HsRuleRn
DataType
Constr
Typeable HsRuleRn
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> HsRuleRn -> c HsRuleRn)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c HsRuleRn)
-> (HsRuleRn -> Constr)
-> (HsRuleRn -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c HsRuleRn))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HsRuleRn))
-> ((forall b. Data b => b -> b) -> HsRuleRn -> HsRuleRn)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> HsRuleRn -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> HsRuleRn -> r)
-> (forall u. (forall d. Data d => d -> u) -> HsRuleRn -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> HsRuleRn -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn)
-> Data HsRuleRn
HsRuleRn -> DataType
HsRuleRn -> Constr
(forall b. Data b => b -> b) -> HsRuleRn -> HsRuleRn
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> HsRuleRn -> c HsRuleRn
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c HsRuleRn
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> HsRuleRn -> u
forall u. (forall d. Data d => d -> u) -> HsRuleRn -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> HsRuleRn -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> HsRuleRn -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c HsRuleRn
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> HsRuleRn -> c HsRuleRn
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c HsRuleRn)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HsRuleRn)
$cHsRuleRn :: Constr
$tHsRuleRn :: DataType
gmapMo :: (forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn
gmapMp :: (forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn
gmapM :: (forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> HsRuleRn -> m HsRuleRn
gmapQi :: Int -> (forall d. Data d => d -> u) -> HsRuleRn -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> HsRuleRn -> u
gmapQ :: (forall d. Data d => d -> u) -> HsRuleRn -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> HsRuleRn -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> HsRuleRn -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> HsRuleRn -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> HsRuleRn -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> HsRuleRn -> r
gmapT :: (forall b. Data b => b -> b) -> HsRuleRn -> HsRuleRn
$cgmapT :: (forall b. Data b => b -> b) -> HsRuleRn -> HsRuleRn
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HsRuleRn)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HsRuleRn)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c HsRuleRn)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c HsRuleRn)
dataTypeOf :: HsRuleRn -> DataType
$cdataTypeOf :: HsRuleRn -> DataType
toConstr :: HsRuleRn -> Constr
$ctoConstr :: HsRuleRn -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c HsRuleRn
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c HsRuleRn
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> HsRuleRn -> c HsRuleRn
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> HsRuleRn -> c HsRuleRn
$cp1Data :: Typeable HsRuleRn
Data

type instance XHsRule       GhcPs = NoExtField
type instance XHsRule       GhcRn = HsRuleRn
type instance XHsRule       GhcTc = HsRuleRn

type instance XXRuleDecl    (GhcPass _) = NoExtCon

flattenRuleDecls :: [LRuleDecls pass] -> [LRuleDecl pass]
flattenRuleDecls :: [LRuleDecls pass] -> [LRuleDecl pass]
flattenRuleDecls [LRuleDecls pass]
decls = (LRuleDecls pass -> [LRuleDecl pass])
-> [LRuleDecls pass] -> [LRuleDecl pass]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap (RuleDecls pass -> [LRuleDecl pass]
forall pass. RuleDecls pass -> [LRuleDecl pass]
rds_rules (RuleDecls pass -> [LRuleDecl pass])
-> (LRuleDecls pass -> RuleDecls pass)
-> LRuleDecls pass
-> [LRuleDecl pass]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LRuleDecls pass -> RuleDecls pass
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) [LRuleDecls pass]
decls

-- | Located Rule Binder
type LRuleBndr pass = Located (RuleBndr pass)

-- | Rule Binder
data RuleBndr pass
  = RuleBndr (XCRuleBndr pass)  (Located (IdP pass))
  | RuleBndrSig (XRuleBndrSig pass) (Located (IdP pass)) (LHsSigWcType pass)
  | XRuleBndr (XXRuleBndr pass)
        -- ^
        --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnOpen',
        --     'ApiAnnotation.AnnDcolon','ApiAnnotation.AnnClose'

        -- For details on above see note [Api annotations] in ApiAnnotation

type instance XCRuleBndr    (GhcPass _) = NoExtField
type instance XRuleBndrSig  (GhcPass _) = NoExtField
type instance XXRuleBndr    (GhcPass _) = NoExtCon

collectRuleBndrSigTys :: [RuleBndr pass] -> [LHsSigWcType pass]
collectRuleBndrSigTys :: [RuleBndr pass] -> [LHsSigWcType pass]
collectRuleBndrSigTys [RuleBndr pass]
bndrs = [LHsSigWcType pass
ty | RuleBndrSig XRuleBndrSig pass
_ Located (IdP pass)
_ LHsSigWcType pass
ty <- [RuleBndr pass]
bndrs]

pprFullRuleName :: Located (SourceText, RuleName) -> SDoc
pprFullRuleName :: Located (SourceText, FastString) -> SDoc
pprFullRuleName (L SrcSpan
_ (SourceText
st, FastString
n)) = SourceText -> SDoc -> SDoc
pprWithSourceText SourceText
st (SDoc -> SDoc
doubleQuotes (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ FastString -> SDoc
ftext FastString
n)

instance (OutputableBndrId p) => Outputable (RuleDecls (GhcPass p)) where
  ppr :: RuleDecls (GhcPass p) -> SDoc
ppr (HsRules { rds_src :: forall pass. RuleDecls pass -> SourceText
rds_src = SourceText
st
               , rds_rules :: forall pass. RuleDecls pass -> [LRuleDecl pass]
rds_rules = [LRuleDecl (GhcPass p)]
rules })
    = SourceText -> SDoc -> SDoc
pprWithSourceText SourceText
st ([Char] -> SDoc
text [Char]
"{-# RULES")
          SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
vcat (SDoc -> [SDoc] -> [SDoc]
punctuate SDoc
semi ((LRuleDecl (GhcPass p) -> SDoc)
-> [LRuleDecl (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LRuleDecl (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LRuleDecl (GhcPass p)]
rules)) SDoc -> SDoc -> SDoc
<+> [Char] -> SDoc
text [Char]
"#-}"
  ppr (XRuleDecls XXRuleDecls (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXRuleDecls (GhcPass p)
NoExtCon
x

instance (OutputableBndrId p) => Outputable (RuleDecl (GhcPass p)) where
  ppr :: RuleDecl (GhcPass p) -> SDoc
ppr (HsRule { rd_name :: forall pass. RuleDecl pass -> Located (SourceText, FastString)
rd_name = Located (SourceText, FastString)
name
              , rd_act :: forall pass. RuleDecl pass -> Activation
rd_act  = Activation
act
              , rd_tyvs :: forall pass. RuleDecl pass -> Maybe [LHsTyVarBndr (NoGhcTc pass)]
rd_tyvs = Maybe [LHsTyVarBndr (NoGhcTc (GhcPass p))]
tys
              , rd_tmvs :: forall pass. RuleDecl pass -> [LRuleBndr pass]
rd_tmvs = [LRuleBndr (GhcPass p)]
tms
              , rd_lhs :: forall pass. RuleDecl pass -> Located (HsExpr pass)
rd_lhs  = Located (HsExpr (GhcPass p))
lhs
              , rd_rhs :: forall pass. RuleDecl pass -> Located (HsExpr pass)
rd_rhs  = Located (HsExpr (GhcPass p))
rhs })
        = [SDoc] -> SDoc
sep [Located (SourceText, FastString) -> SDoc
pprFullRuleName Located (SourceText, FastString)
name SDoc -> SDoc -> SDoc
<+> Activation -> SDoc
forall a. Outputable a => a -> SDoc
ppr Activation
act,
               Int -> SDoc -> SDoc
nest Int
4 (Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass p)))]
-> SDoc
forall a. Outputable a => Maybe [a] -> SDoc
pp_forall_ty Maybe [LHsTyVarBndr (NoGhcTc (GhcPass p))]
Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass p)))]
tys SDoc -> SDoc -> SDoc
<+> Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass p)))]
-> SDoc
pp_forall_tm Maybe [LHsTyVarBndr (NoGhcTc (GhcPass p))]
Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass p)))]
tys
                                        SDoc -> SDoc -> SDoc
<+> HsExpr (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
HsExpr (GhcPass p) -> SDoc
pprExpr (Located (HsExpr (GhcPass p))
-> SrcSpanLess (Located (HsExpr (GhcPass p)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (HsExpr (GhcPass p))
lhs)),
               Int -> SDoc -> SDoc
nest Int
6 (SDoc
equals SDoc -> SDoc -> SDoc
<+> HsExpr (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId p =>
HsExpr (GhcPass p) -> SDoc
pprExpr (Located (HsExpr (GhcPass p))
-> SrcSpanLess (Located (HsExpr (GhcPass p)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (HsExpr (GhcPass p))
rhs)) ]
        where
          pp_forall_ty :: Maybe [a] -> SDoc
pp_forall_ty Maybe [a]
Nothing     = SDoc
empty
          pp_forall_ty (Just [a]
qtvs) = SDoc
forAllLit SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
fsep ((a -> SDoc) -> [a] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map a -> SDoc
forall a. Outputable a => a -> SDoc
ppr [a]
qtvs) SDoc -> SDoc -> SDoc
<> SDoc
dot
          pp_forall_tm :: Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass p)))]
-> SDoc
pp_forall_tm Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass p)))]
Nothing | [LRuleBndr (GhcPass p)] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LRuleBndr (GhcPass p)]
tms = SDoc
empty
          pp_forall_tm Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass p)))]
_ = SDoc
forAllLit SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
fsep ((LRuleBndr (GhcPass p) -> SDoc)
-> [LRuleBndr (GhcPass p)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LRuleBndr (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LRuleBndr (GhcPass p)]
tms) SDoc -> SDoc -> SDoc
<> SDoc
dot
  ppr (XRuleDecl XXRuleDecl (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXRuleDecl (GhcPass p)
NoExtCon
x

instance (OutputableBndrId p) => Outputable (RuleBndr (GhcPass p)) where
   ppr :: RuleBndr (GhcPass p) -> SDoc
ppr (RuleBndr XCRuleBndr (GhcPass p)
_ Located (IdP (GhcPass p))
name) = Located (IdP (GhcPass p)) -> SDoc
forall a. Outputable a => a -> SDoc
ppr Located (IdP (GhcPass p))
name
   ppr (RuleBndrSig XRuleBndrSig (GhcPass p)
_ Located (IdP (GhcPass p))
name LHsSigWcType (GhcPass p)
ty) = SDoc -> SDoc
parens (Located (IdP (GhcPass p)) -> SDoc
forall a. Outputable a => a -> SDoc
ppr Located (IdP (GhcPass p))
name SDoc -> SDoc -> SDoc
<> SDoc
dcolon SDoc -> SDoc -> SDoc
<> LHsSigWcType (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsSigWcType (GhcPass p)
ty)
   ppr (XRuleBndr XXRuleBndr (GhcPass p)
x) = NoExtCon -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXRuleBndr (GhcPass p)
NoExtCon
x

{-
************************************************************************
*                                                                      *
\subsection[DocDecl]{Document comments}
*                                                                      *
************************************************************************
-}

-- | Located Documentation comment Declaration
type LDocDecl = Located (DocDecl)

-- | Documentation comment Declaration
data DocDecl
  = DocCommentNext HsDocString
  | DocCommentPrev HsDocString
  | DocCommentNamed String HsDocString
  | DocGroup Int HsDocString
  deriving Typeable DocDecl
DataType
Constr
Typeable DocDecl
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> DocDecl -> c DocDecl)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c DocDecl)
-> (DocDecl -> Constr)
-> (DocDecl -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c DocDecl))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocDecl))
-> ((forall b. Data b => b -> b) -> DocDecl -> DocDecl)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> DocDecl -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> DocDecl -> r)
-> (forall u. (forall d. Data d => d -> u) -> DocDecl -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> DocDecl -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> DocDecl -> m DocDecl)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> DocDecl -> m DocDecl)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> DocDecl -> m DocDecl)
-> Data DocDecl
DocDecl -> DataType
DocDecl -> Constr
(forall b. Data b => b -> b) -> DocDecl -> DocDecl
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> DocDecl -> c DocDecl
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c DocDecl
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> DocDecl -> u
forall u. (forall d. Data d => d -> u) -> DocDecl -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> DocDecl -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> DocDecl -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> DocDecl -> m DocDecl
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> DocDecl -> m DocDecl
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c DocDecl
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> DocDecl -> c DocDecl
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c DocDecl)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocDecl)
$cDocGroup :: Constr
$cDocCommentNamed :: Constr
$cDocCommentPrev :: Constr
$cDocCommentNext :: Constr
$tDocDecl :: DataType
gmapMo :: (forall d. Data d => d -> m d) -> DocDecl -> m DocDecl
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> DocDecl -> m DocDecl
gmapMp :: (forall d. Data d => d -> m d) -> DocDecl -> m DocDecl
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> DocDecl -> m DocDecl
gmapM :: (forall d. Data d => d -> m d) -> DocDecl -> m DocDecl
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> DocDecl -> m DocDecl
gmapQi :: Int -> (forall d. Data d => d -> u) -> DocDecl -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> DocDecl -> u
gmapQ :: (forall d. Data d => d -> u) -> DocDecl -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> DocDecl -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> DocDecl -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> DocDecl -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> DocDecl -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> DocDecl -> r
gmapT :: (forall b. Data b => b -> b) -> DocDecl -> DocDecl
$cgmapT :: (forall b. Data b => b -> b) -> DocDecl -> DocDecl
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocDecl)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocDecl)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c DocDecl)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c DocDecl)
dataTypeOf :: DocDecl -> DataType
$cdataTypeOf :: DocDecl -> DataType
toConstr :: DocDecl -> Constr
$ctoConstr :: DocDecl -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c DocDecl
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c DocDecl
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> DocDecl -> c DocDecl
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> DocDecl -> c DocDecl
$cp1Data :: Typeable DocDecl
Data

-- Okay, I need to reconstruct the document comments, but for now:
instance Outputable DocDecl where
  ppr :: DocDecl -> SDoc
ppr DocDecl
_ = [Char] -> SDoc
text [Char]
"<document comment>"

docDeclDoc :: DocDecl -> HsDocString
docDeclDoc :: DocDecl -> HsDocString
docDeclDoc (DocCommentNext HsDocString
d) = HsDocString
d
docDeclDoc (DocCommentPrev HsDocString
d) = HsDocString
d
docDeclDoc (DocCommentNamed [Char]
_ HsDocString
d) = HsDocString
d
docDeclDoc (DocGroup Int
_ HsDocString
d) = HsDocString
d

{-
************************************************************************
*                                                                      *
\subsection[DeprecDecl]{Deprecations}
*                                                                      *
************************************************************************

We use exported entities for things to deprecate.
-}

-- | Located Warning Declarations
type LWarnDecls pass = Located (WarnDecls pass)

 -- Note [Pragma source text] in BasicTypes
-- | Warning pragma Declarations
data WarnDecls pass = Warnings { WarnDecls pass -> XWarnings pass
wd_ext      :: XWarnings pass
                               , WarnDecls pass -> SourceText
wd_src      :: SourceText
                               , WarnDecls pass -> [LWarnDecl pass]
wd_warnings :: [LWarnDecl pass]
                               }
  | XWarnDecls (XXWarnDecls pass)

type instance XWarnings      (GhcPass _) = NoExtField
type instance XXWarnDecls    (GhcPass _) = NoExtCon

-- | Located Warning pragma Declaration
type LWarnDecl pass = Located (WarnDecl pass)

-- | Warning pragma Declaration
data WarnDecl pass = Warning (XWarning pass) [Located (IdP pass)] WarningTxt
                   | XWarnDecl (XXWarnDecl pass)

type instance XWarning      (GhcPass _) = NoExtField
type instance XXWarnDecl    (GhcPass _) = NoExtCon