{-
(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 UndecidableInstances #-} -- Note [Pass sensitive types]
                                      -- in module PlaceHolder
{-# LANGUAGE ConstraintKinds #-}
{-# LANGUAGE TypeFamilies #-}

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

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

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

  -- ** Standalone deriving declarations
  DerivDecl(..), LDerivDecl,
  -- ** Deriving strategies
  DerivStrategy(..), LDerivStrategy, derivStrategyName,
  -- ** @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 #-}   HsExpr( HsExpr, HsSplice, pprExpr,
                                pprSpliceDecl )
        -- Because Expr imports Decls via HsBracket

import HsBinds
import HsTypes
import HsDoc
import TyCon
import BasicTypes
import Coercion
import ForeignCall
import HsExtension
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
  | 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 _) = NoExt
type instance XInstD      (GhcPass _) = NoExt
type instance XDerivD     (GhcPass _) = NoExt
type instance XValD       (GhcPass _) = NoExt
type instance XSigD       (GhcPass _) = NoExt
type instance XDefD       (GhcPass _) = NoExt
type instance XForD       (GhcPass _) = NoExt
type instance XWarningD   (GhcPass _) = NoExt
type instance XAnnD       (GhcPass _) = NoExt
type instance XRuleD      (GhcPass _) = NoExt
type instance XSpliceD    (GhcPass _) = NoExt
type instance XDocD       (GhcPass _) = NoExt
type instance XRoleAnnotD (GhcPass _) = NoExt
type instance XXHsDecl    (GhcPass _) = NoExt

-- 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 _) = NoExt
type instance XXHsGroup (GhcPass _) = NoExt


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)
NoExt
noExt,
                       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 "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)
NoExt
noExt,
        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 _ _ = [Char] -> HsGroup (GhcPass p)
forall a. [Char] -> a
panic "appendGroups"

instance (p ~ GhcPass pass, OutputableBndrId p) => Outputable (HsDecl p) where
    ppr :: HsDecl p -> SDoc
ppr (TyClD _ dcl :: TyClDecl p
dcl)             = TyClDecl p -> SDoc
forall a. Outputable a => a -> SDoc
ppr TyClDecl p
dcl
    ppr (ValD _ binds :: HsBind p
binds)            = HsBind p -> SDoc
forall a. Outputable a => a -> SDoc
ppr HsBind p
binds
    ppr (DefD _ def :: DefaultDecl p
def)              = DefaultDecl p -> SDoc
forall a. Outputable a => a -> SDoc
ppr DefaultDecl p
def
    ppr (InstD _ inst :: InstDecl p
inst)            = InstDecl p -> SDoc
forall a. Outputable a => a -> SDoc
ppr InstDecl p
inst
    ppr (DerivD _ deriv :: DerivDecl p
deriv)          = DerivDecl p -> SDoc
forall a. Outputable a => a -> SDoc
ppr DerivDecl p
deriv
    ppr (ForD _ fd :: ForeignDecl p
fd)               = ForeignDecl p -> SDoc
forall a. Outputable a => a -> SDoc
ppr ForeignDecl p
fd
    ppr (SigD _ sd :: Sig p
sd)               = Sig p -> SDoc
forall a. Outputable a => a -> SDoc
ppr Sig p
sd
    ppr (RuleD _ rd :: RuleDecls p
rd)              = RuleDecls p -> SDoc
forall a. Outputable a => a -> SDoc
ppr RuleDecls p
rd
    ppr (WarningD _ wd :: WarnDecls p
wd)           = WarnDecls p -> SDoc
forall a. Outputable a => a -> SDoc
ppr WarnDecls p
wd
    ppr (AnnD _ ad :: AnnDecl p
ad)               = AnnDecl p -> SDoc
forall a. Outputable a => a -> SDoc
ppr AnnDecl p
ad
    ppr (SpliceD _ dd :: SpliceDecl p
dd)            = SpliceDecl p -> SDoc
forall a. Outputable a => a -> SDoc
ppr SpliceDecl p
dd
    ppr (DocD _ doc :: DocDecl
doc)              = DocDecl -> SDoc
forall a. Outputable a => a -> SDoc
ppr DocDecl
doc
    ppr (RoleAnnotD _ ra :: RoleAnnotDecl p
ra)         = RoleAnnotDecl p -> SDoc
forall a. Outputable a => a -> SDoc
ppr RoleAnnotDecl p
ra
    ppr (XHsDecl x :: XXHsDecl p
x)               = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsDecl p
NoExt
x

instance (p ~ GhcPass pass, OutputableBndrId p) => Outputable (HsGroup p) where
    ppr :: HsGroup p -> SDoc
ppr (HsGroup { hs_valds :: forall p. HsGroup p -> HsValBinds p
hs_valds  = HsValBinds p
val_decls,
                   hs_tyclds :: forall p. HsGroup p -> [TyClGroup p]
hs_tyclds = [TyClGroup p]
tycl_decls,
                   hs_derivds :: forall p. HsGroup p -> [LDerivDecl p]
hs_derivds = [LDerivDecl p]
deriv_decls,
                   hs_fixds :: forall p. HsGroup p -> [LFixitySig p]
hs_fixds  = [LFixitySig p]
fix_decls,
                   hs_warnds :: forall p. HsGroup p -> [LWarnDecls p]
hs_warnds = [LWarnDecls p]
deprec_decls,
                   hs_annds :: forall p. HsGroup p -> [LAnnDecl p]
hs_annds  = [LAnnDecl p]
ann_decls,
                   hs_fords :: forall p. HsGroup p -> [LForeignDecl p]
hs_fords  = [LForeignDecl p]
foreign_decls,
                   hs_defds :: forall p. HsGroup p -> [LDefaultDecl p]
hs_defds  = [LDefaultDecl p]
default_decls,
                   hs_ruleds :: forall p. HsGroup p -> [LRuleDecls p]
hs_ruleds = [LRuleDecls p]
rule_decls })
        = SDoc -> [Maybe SDoc] -> SDoc
vcat_mb SDoc
empty
            [[LFixitySig p] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LFixitySig p]
fix_decls, [LDefaultDecl p] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LDefaultDecl p]
default_decls,
             [LWarnDecls p] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LWarnDecls p]
deprec_decls, [LAnnDecl p] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LAnnDecl p]
ann_decls,
             [LRuleDecls p] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LRuleDecls p]
rule_decls,
             if HsValBindsLR (GhcPass pass) (GhcPass pass) -> Bool
forall (a :: Pass) (b :: Pass).
HsValBindsLR (GhcPass a) (GhcPass b) -> Bool
isEmptyValBinds HsValBinds p
HsValBindsLR (GhcPass pass) (GhcPass pass)
val_decls
                then Maybe SDoc
forall a. Maybe a
Nothing
                else SDoc -> Maybe SDoc
forall a. a -> Maybe a
Just (HsValBinds p -> SDoc
forall a. Outputable a => a -> SDoc
ppr HsValBinds p
val_decls),
             [LTyClDecl p] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds ([TyClGroup p] -> [LTyClDecl p]
forall pass. [TyClGroup pass] -> [LTyClDecl pass]
tyClGroupTyClDecls [TyClGroup p]
tycl_decls),
             [LInstDecl p] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds ([TyClGroup p] -> [LInstDecl p]
forall pass. [TyClGroup pass] -> [LInstDecl pass]
tyClGroupInstDecls [TyClGroup p]
tycl_decls),
             [LDerivDecl p] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LDerivDecl p]
deriv_decls,
             [LForeignDecl p] -> Maybe SDoc
forall a. Outputable a => [a] -> Maybe SDoc
ppr_ds [LForeignDecl 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 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
empty
          vcat_mb gap :: SDoc
gap (Nothing : ds :: [Maybe SDoc]
ds) = SDoc -> [Maybe SDoc] -> SDoc
vcat_mb SDoc
gap [Maybe SDoc]
ds
          vcat_mb gap :: SDoc
gap (Just d :: SDoc
d  : ds :: [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 x :: XXHsGroup p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsGroup p
NoExt
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 _) = NoExt
type instance XXSpliceDecl     (GhcPass _) = NoExt

instance (p ~ GhcPass pass, OutputableBndrId p)
       => Outputable (SpliceDecl p) where
   ppr :: SpliceDecl p -> SDoc
ppr (SpliceDecl _ (L _ e :: HsSplice p
e) f :: SpliceExplicitFlag
f) = HsSplice (GhcPass pass) -> SpliceExplicitFlag -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
HsSplice (GhcPass p) -> SpliceExplicitFlag -> SDoc
pprSpliceDecl HsSplice p
HsSplice (GhcPass pass)
e SpliceExplicitFlag
f
   ppr (XSpliceDecl x :: XXSpliceDecl p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXSpliceDecl p
NoExt
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 HsBinds), 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 -> [LTyFamDefltEqn pass]
tcdATDefs  :: [LTyFamDefltEqn 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?
             , 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 _) = NoExt

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

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

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

type instance XXTyClDecl    (GhcPass _) = NoExt

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

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

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

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

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

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

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

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

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

-- Dealing with names

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

tyFamInstDeclLName :: TyFamInstDecl pass -> Located (IdP pass)
tyFamInstDeclLName :: TyFamInstDecl pass -> Located (IdP pass)
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 pats rhs. FamEqn pass pats rhs -> Located (IdP pass)
feqn_tycon = Located (IdP pass)
ln }}) })
  = Located (IdP pass)
ln
tyFamInstDeclLName (TyFamInstDecl (HsIB _ (XFamEqn _)))
  = [Char] -> Located (IdP pass)
forall a. [Char] -> a
panic "tyFamInstDeclLName"
tyFamInstDeclLName (TyFamInstDecl (XHsImplicitBndrs _))
  = [Char] -> Located (IdP pass)
forall a. [Char] -> a
panic "tyFamInstDeclLName"

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 decl :: 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 d :: 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 decls :: [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 _                                                       = 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 _                                                      = 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 GhcRn
fam_decl }) = Maybe Bool -> FamilyDecl GhcRn -> Bool
forall pass. Maybe Bool -> FamilyDecl pass -> Bool
famDeclHasCusk Maybe Bool
forall a. Maybe a
Nothing FamilyDecl GhcRn
fam_decl
hsDeclHasCusk (SynDecl { tcdTyVars :: forall pass. TyClDecl pass -> LHsQTyVars pass
tcdTyVars = LHsQTyVars GhcRn
tyvars, tcdRhs :: forall pass. TyClDecl pass -> LHsType pass
tcdRhs = LHsType GhcRn
rhs })
  -- NB: Keep this synchronized with 'getInitialKind'
  = LHsQTyVars GhcRn -> Bool
forall pass. LHsQTyVars pass -> Bool
hsTvbAllKinded LHsQTyVars GhcRn
tyvars Bool -> Bool -> Bool
&& LHsType GhcRn -> Bool
forall pass. LHsType pass -> Bool
rhs_annotated LHsType GhcRn
rhs
  where
    rhs_annotated :: LHsType pass -> Bool
rhs_annotated (L _ ty :: HsType pass
ty) = case HsType pass
ty of
      HsParTy _ lty :: LHsType pass
lty  -> LHsType pass -> Bool
rhs_annotated LHsType pass
lty
      HsKindSig {}   -> Bool
True
      _              -> Bool
False
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 (XTyClDecl _) = [Char] -> Bool
forall a. [Char] -> a
panic "hsDeclHasCusk"

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

instance (p ~ GhcPass pass, OutputableBndrId p) => Outputable (TyClDecl p) where

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

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

    ppr (ClassDecl {tcdCtxt :: forall pass. TyClDecl pass -> LHsContext pass
tcdCtxt = LHsContext p
context, tcdLName :: forall pass. TyClDecl pass -> Located (IdP pass)
tcdLName = Located (IdP p)
lclas, tcdTyVars :: forall pass. TyClDecl pass -> LHsQTyVars pass
tcdTyVars = LHsQTyVars p
tyvars,
                    tcdFixity :: forall pass. TyClDecl pass -> LexicalFixity
tcdFixity = LexicalFixity
fixity,
                    tcdFDs :: forall pass. TyClDecl pass -> [LHsFunDep pass]
tcdFDs  = [LHsFunDep p]
fds,
                    tcdSigs :: forall pass. TyClDecl pass -> [LSig pass]
tcdSigs = [LSig p]
sigs, tcdMeths :: forall pass. TyClDecl pass -> LHsBinds pass
tcdMeths = LHsBinds p
methods,
                    tcdATs :: forall pass. TyClDecl pass -> [LFamilyDecl pass]
tcdATs = [LFamilyDecl p]
ats, tcdATDefs :: forall pass. TyClDecl pass -> [LTyFamDefltEqn pass]
tcdATDefs = [LTyFamDefltEqn p]
at_defs})
      | [LSig p] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LSig p]
sigs Bool -> Bool -> Bool
&& LHsBinds p -> Bool
forall a. Bag a -> Bool
isEmptyBag LHsBinds p
methods Bool -> Bool -> Bool
&& [LFamilyDecl p] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LFamilyDecl p]
ats Bool -> Bool -> Bool
&& [LTyFamDefltEqn p] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LTyFamDefltEqn 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 "where"
             , Int -> SDoc -> SDoc
nest 2 (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ [SDoc] -> SDoc
pprDeclList ((LFamilyDecl p -> SDoc) -> [LFamilyDecl p] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (TopLevelFlag -> FamilyDecl (GhcPass pass) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
TopLevelFlag -> FamilyDecl (GhcPass p) -> SDoc
pprFamilyDecl TopLevelFlag
NotTopLevel (FamilyDecl (GhcPass pass) -> SDoc)
-> (LFamilyDecl p -> FamilyDecl (GhcPass pass))
-> LFamilyDecl p
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LFamilyDecl p -> FamilyDecl (GhcPass pass)
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) [LFamilyDecl p]
ats [SDoc] -> [SDoc] -> [SDoc]
forall a. [a] -> [a] -> [a]
++
                                     (LTyFamDefltEqn (GhcPass pass) -> SDoc)
-> [LTyFamDefltEqn (GhcPass pass)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LTyFamDefltEqn (GhcPass pass) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
LTyFamDefltEqn (GhcPass p) -> SDoc
ppr_fam_deflt_eqn [LTyFamDefltEqn p]
[LTyFamDefltEqn (GhcPass pass)]
at_defs [SDoc] -> [SDoc] -> [SDoc]
forall a. [a] -> [a] -> [a]
++
                                     LHsBindsLR (GhcPass pass) (GhcPass pass)
-> [LSig (GhcPass pass)] -> [SDoc]
forall (idL :: Pass) (idR :: Pass) (id2 :: Pass).
(OutputableBndrId (GhcPass idL), OutputableBndrId (GhcPass idR),
 OutputableBndrId (GhcPass id2)) =>
LHsBindsLR (GhcPass idL) (GhcPass idR)
-> [LSig (GhcPass id2)] -> [SDoc]
pprLHsBindsForUser LHsBinds p
LHsBindsLR (GhcPass pass) (GhcPass pass)
methods [LSig p]
[LSig (GhcPass pass)]
sigs) ]
      where
        top_matter :: SDoc
top_matter = [Char] -> SDoc
text "class"
                    SDoc -> SDoc -> SDoc
<+> Located (IdP (GhcPass pass))
-> LHsQTyVars (GhcPass pass)
-> LexicalFixity
-> LHsContext (GhcPass pass)
-> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
pp_vanilla_decl_head Located (IdP p)
Located (IdP (GhcPass pass))
lclas LHsQTyVars p
LHsQTyVars (GhcPass pass)
tyvars LexicalFixity
fixity LHsContext p
LHsContext (GhcPass pass)
context
                    SDoc -> SDoc -> SDoc
<+> [FunDep (Located (IdP (GhcPass pass)))] -> SDoc
forall a. Outputable a => [FunDep a] -> SDoc
pprFundeps ((Located (FunDep (Located (IdP (GhcPass pass))))
 -> FunDep (Located (IdP (GhcPass pass))))
-> [Located (FunDep (Located (IdP (GhcPass pass))))]
-> [FunDep (Located (IdP (GhcPass pass)))]
forall a b. (a -> b) -> [a] -> [b]
map Located (FunDep (Located (IdP (GhcPass pass))))
-> FunDep (Located (IdP (GhcPass pass)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc [LHsFunDep p]
[Located (FunDep (Located (IdP (GhcPass pass))))]
fds)

    ppr (XTyClDecl x :: XXTyClDecl p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXTyClDecl p
NoExt
x

instance (p ~ GhcPass pass, OutputableBndrId p)
       => Outputable (TyClGroup p) where
  ppr :: TyClGroup p -> SDoc
ppr (TyClGroup { group_tyclds :: forall pass. TyClGroup pass -> [LTyClDecl pass]
group_tyclds = [LTyClDecl p]
tyclds
                 , group_roles :: forall pass. TyClGroup pass -> [LRoleAnnotDecl pass]
group_roles = [LRoleAnnotDecl p]
roles
                 , group_instds :: forall pass. TyClGroup pass -> [LInstDecl pass]
group_instds = [LInstDecl p]
instds
                 }
      )
    = [LTyClDecl p] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LTyClDecl p]
tyclds SDoc -> SDoc -> SDoc
$$
      [LRoleAnnotDecl p] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LRoleAnnotDecl p]
roles SDoc -> SDoc -> SDoc
$$
      [LInstDecl p] -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LInstDecl p]
instds
  ppr (XTyClGroup x :: XXTyClGroup p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXTyClGroup p
NoExt
x

pp_vanilla_decl_head :: (OutputableBndrId (GhcPass 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 thing :: Located (IdP (GhcPass p))
thing (HsQTvs { hsq_explicit :: forall pass. LHsQTyVars pass -> [LHsTyVarBndr pass]
hsq_explicit = [LHsTyVarBndr (GhcPass p)]
tyvars }) fixity :: LexicalFixity
fixity context :: LHsContext (GhcPass p)
context
 = [SDoc] -> SDoc
hsep [LHsContext (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass 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 (varl :: LHsTyVarBndr (GhcPass p)
varl:varsr :: [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
> 1
         = [SDoc] -> SDoc
hsep [Char -> SDoc
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 ')'
                , [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 _ (XLHsQTyVars x :: XXLHsQTyVars (GhcPass p)
x) _ _ = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXLHsQTyVars (GhcPass p)
NoExt
x

pprTyClDeclFlavour :: TyClDecl (GhcPass p) -> SDoc
pprTyClDeclFlavour :: TyClDecl (GhcPass p) -> SDoc
pprTyClDeclFlavour (ClassDecl {})   = [Char] -> SDoc
text "class"
pprTyClDeclFlavour (SynDecl {})     = [Char] -> SDoc
text "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 "family"
pprTyClDeclFlavour (FamDecl { tcdFam :: forall pass. TyClDecl pass -> FamilyDecl pass
tcdFam = XFamilyDecl x :: XXFamilyDecl (GhcPass p)
x})
  = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXFamilyDecl (GhcPass p)
NoExt
x
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 x :: XXHsDataDefn (GhcPass p)
x })
  = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsDataDefn (GhcPass p)
NoExt
x
pprTyClDeclFlavour (XTyClDecl x :: XXTyClDecl (GhcPass p)
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXTyClDecl (GhcPass p)
NoExt
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 ghc.haskell.org/trac/ghc/wiki/GhcKinds/KindInference#Proposednewstrategy
and #9200 for lots of discussion of how we got here.

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
    Trac #15142 comment:22
-}


{- *********************************************************************
*                                                                      *
                         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 -> [LInstDecl pass]
group_instds :: [LInstDecl pass] }
  | XTyClGroup (XXTyClGroup pass)

type instance XCTyClGroup (GhcPass _) = NoExt
type instance XXTyClGroup (GhcPass _) = NoExt


emptyTyClGroup :: TyClGroup (GhcPass p)
emptyTyClGroup :: TyClGroup (GhcPass p)
emptyTyClGroup = XCTyClGroup (GhcPass p)
-> [LTyClDecl (GhcPass p)]
-> [LRoleAnnotDecl (GhcPass p)]
-> [LInstDecl (GhcPass p)]
-> TyClGroup (GhcPass p)
forall pass.
XCTyClGroup pass
-> [LTyClDecl pass]
-> [LRoleAnnotDecl pass]
-> [LInstDecl pass]
-> TyClGroup pass
TyClGroup XCTyClGroup (GhcPass p)
NoExt
noExt [] [] []

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

mkTyClGroup :: [LTyClDecl (GhcPass p)] -> [LInstDecl (GhcPass p)]
            -> TyClGroup (GhcPass p)
mkTyClGroup :: [LTyClDecl (GhcPass p)]
-> [LInstDecl (GhcPass p)] -> TyClGroup (GhcPass p)
mkTyClGroup decls :: [LTyClDecl (GhcPass p)]
decls instds :: [LInstDecl (GhcPass p)]
instds = TyClGroup :: forall pass.
XCTyClGroup pass
-> [LTyClDecl pass]
-> [LRoleAnnotDecl pass]
-> [LInstDecl pass]
-> TyClGroup pass
TyClGroup
  { group_ext :: XCTyClGroup (GhcPass p)
group_ext = XCTyClGroup (GhcPass p)
NoExt
noExt
  , group_tyclds :: [LTyClDecl (GhcPass p)]
group_tyclds = [LTyClDecl (GhcPass p)]
decls
  , group_roles :: [LRoleAnnotDecl (GhcPass p)]
group_roles = []
  , group_instds :: [LInstDecl (GhcPass p)]
group_instds = [LInstDecl (GhcPass p)]
instds
  }



{- *********************************************************************
*                                                                      *
               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 _) = NoExt
type instance XCKindSig         (GhcPass _) = NoExt
type instance XTyVarSig         (GhcPass _) = NoExt
type instance XXFamilyResultSig (GhcPass _) = NoExt


-- | 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 _) = NoExt
type instance XXFamilyDecl    (GhcPass _) = NoExt


-- | 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])

-- | Does this family declaration have a complete, user-supplied kind signature?
-- See Note [CUSKs: complete user-supplied kind signatures]
famDeclHasCusk :: Maybe Bool
                   -- ^ if associated, does the enclosing class have a CUSK?
               -> FamilyDecl pass -> Bool
famDeclHasCusk :: Maybe Bool -> FamilyDecl pass -> Bool
famDeclHasCusk _ (FamilyDecl { fdInfo :: forall pass. FamilyDecl pass -> FamilyInfo pass
fdInfo      = ClosedTypeFamily _
                             , fdTyVars :: forall pass. FamilyDecl pass -> LHsQTyVars pass
fdTyVars    = LHsQTyVars pass
tyvars
                             , fdResultSig :: forall pass. FamilyDecl pass -> LFamilyResultSig pass
fdResultSig = L _ resultSig :: FamilyResultSig pass
resultSig })
  = LHsQTyVars pass -> Bool
forall pass. LHsQTyVars pass -> Bool
hsTvbAllKinded LHsQTyVars pass
tyvars Bool -> Bool -> Bool
&& FamilyResultSig pass -> Bool
forall a. FamilyResultSig a -> Bool
hasReturnKindSignature FamilyResultSig pass
resultSig
famDeclHasCusk mb_class_cusk :: Maybe Bool
mb_class_cusk _ = Maybe Bool
mb_class_cusk Maybe Bool -> Bool -> Bool
forall a. Maybe a -> a -> a
`orElse` Bool
True
        -- all un-associated open families have CUSKs

-- | Does this family declaration have user-supplied return kind signature?
hasReturnKindSignature :: FamilyResultSig a -> Bool
hasReturnKindSignature :: FamilyResultSig a -> Bool
hasReturnKindSignature (NoSig _)                        = Bool
False
hasReturnKindSignature (TyVarSig _ (L _ (UserTyVar{}))) = Bool
False
hasReturnKindSignature _                                = Bool
True

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

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

pprFamilyDecl :: (OutputableBndrId (GhcPass p))
              => TopLevelFlag -> FamilyDecl (GhcPass p) -> SDoc
pprFamilyDecl :: TopLevelFlag -> FamilyDecl (GhcPass p) -> SDoc
pprFamilyDecl top_level :: 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 _ result :: 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 (GhcPass 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 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
                     TopLevel    -> [Char] -> SDoc
text "family"
                     NotTopLevel -> SDoc
empty

    pp_kind :: SDoc
pp_kind = case FamilyResultSig (GhcPass p)
result of
                NoSig    _         -> SDoc
empty
                KindSig  _ kind :: 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 _ tv_bndr :: LHsTyVarBndr (GhcPass p)
tv_bndr -> [Char] -> SDoc
text "=" SDoc -> SDoc -> SDoc
<+> LHsTyVarBndr (GhcPass p) -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsTyVarBndr (GhcPass p)
tv_bndr
                XFamilyResultSig x :: XXFamilyResultSig (GhcPass p)
x -> NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXFamilyResultSig (GhcPass p)
NoExt
x
    pp_inj :: SDoc
pp_inj = case Maybe (LInjectivityAnn (GhcPass p))
mb_inj of
               Just (L _ (InjectivityAnn lhs :: Located (IdP (GhcPass p))
lhs rhs :: [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 "->", [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) ]
               Nothing -> SDoc
empty
    (pp_where :: SDoc
pp_where, pp_eqns :: SDoc
pp_eqns) = case FamilyInfo (GhcPass p)
info of
      ClosedTypeFamily mb_eqns :: Maybe [LTyFamInstEqn (GhcPass p)]
mb_eqns ->
        ( [Char] -> SDoc
text "where"
        , case Maybe [LTyFamInstEqn (GhcPass p)]
mb_eqns of
            Nothing   -> [Char] -> SDoc
text ".."
            Just eqns :: [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 (GhcPass 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 )
      _ -> (SDoc
empty, SDoc
empty)
pprFamilyDecl _ (XFamilyDecl x :: XXFamilyDecl (GhcPass p)
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXFamilyDecl (GhcPass p)
NoExt
x

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

instance Outputable (FamilyInfo pass) where
  ppr :: FamilyInfo pass -> SDoc
ppr info :: FamilyInfo pass
info = FamilyInfo pass -> SDoc
forall pass. FamilyInfo pass -> SDoc
pprFlavour FamilyInfo pass
info SDoc -> SDoc -> SDoc
<+> [Char] -> SDoc
text "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 _) = NoExt
type instance XXHsDataDefn    (GhcPass _) = NoExt

-- | 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 _) = NoExt
type instance XXHsDerivingClause    (GhcPass _) = NoExt

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

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

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 NewType  = TyConFlavour
NewtypeFlavour
newOrDataToFlavour 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 _) = NoExt
type instance XConDeclH98  (GhcPass _) = NoExt
type instance XXConDecl    (GhcPass _) = NoExt

{- 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 HsUtils.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 pass -> [Located (IdP pass)]
getConNames :: ConDecl pass -> [Located (IdP pass)]
getConNames ConDeclH98  {con_name :: forall pass. ConDecl pass -> Located (IdP pass)
con_name  = Located (IdP pass)
name}  = [Located (IdP pass)
name]
getConNames ConDeclGADT {con_names :: forall pass. ConDecl pass -> [Located (IdP pass)]
con_names = [Located (IdP pass)]
names} = [Located (IdP pass)]
names
getConNames XConDecl {} = [Char] -> [Located (IdP pass)]
forall a. [Char] -> a
panic "getConNames"

getConArgs :: ConDecl pass -> HsConDeclDetails pass
getConArgs :: ConDecl pass -> HsConDeclDetails pass
getConArgs d :: 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 tys :: [LBangType pass]
tys)    = [LBangType pass]
tys
hsConDeclArgTys (InfixCon ty1 :: LBangType pass
ty1 ty2 :: LBangType pass
ty2) = [LBangType pass
ty1,LBangType pass
ty2]
hsConDeclArgTys (RecCon flds :: 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 Nothing            = []
hsConDeclTheta (Just (L _ theta :: [LHsType pass]
theta)) = [LHsType pass]
theta

pp_data_defn :: (OutputableBndrId (GhcPass 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 pp_hdr :: 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)
       2 ([LConDecl (GhcPass p)] -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass 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
               Nothing   -> SDoc
empty
               Just ct :: 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
               Nothing   -> SDoc
empty
               Just kind :: 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 _ ds :: [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 _ (XHsDataDefn x :: XXHsDataDefn (GhcPass p)
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsDataDefn (GhcPass p)
NoExt
x

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

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

pp_condecls :: (OutputableBndrId (GhcPass p)) => [LConDecl (GhcPass p)] -> SDoc
pp_condecls :: [LConDecl (GhcPass p)] -> SDoc
pp_condecls cs :: [LConDecl (GhcPass p)]
cs@(L _ ConDeclGADT{} : _) -- In GADT syntax
  = SDoc -> Int -> SDoc -> SDoc
hang ([Char] -> SDoc
text "where") 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 cs :: [LConDecl (GhcPass p)]
cs                    -- In H98 syntax
  = SDoc
equals SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
sep (SDoc -> [SDoc] -> [SDoc]
punctuate ([Char] -> SDoc
text " |") ((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 (p ~ GhcPass pass, OutputableBndrId p) => Outputable (ConDecl p) where
    ppr :: ConDecl p -> SDoc
ppr = ConDecl p -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
ConDecl (GhcPass p) -> SDoc
pprConDecl

pprConDecl :: (OutputableBndrId (GhcPass p)) => ConDecl (GhcPass p) -> SDoc
pprConDecl :: ConDecl (GhcPass p) -> SDoc
pprConDecl (ConDeclH98 { con_name :: forall pass. ConDecl pass -> Located (IdP pass)
con_name = L _ con :: 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, [LHsTyVarBndr (GhcPass p)] -> LHsContext (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
[LHsTyVarBndr (GhcPass p)] -> LHsContext (GhcPass p) -> SDoc
pprHsForAll [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 t1 :: LBangType (GhcPass p)
t1 t2 :: 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 tys :: [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 (GhcPass 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 fields :: 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 (GhcPass 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 [[LHsTyVarBndr (GhcPass p)] -> LHsContext (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
[LHsTyVarBndr (GhcPass p)] -> LHsContext (GhcPass p) -> SDoc
pprHsForAll (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 args :: [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 fields :: Located [LConDeclField (GhcPass p)]
fields)  = [[LConDeclField (GhcPass p)] -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass 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 "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 (a :: SDoc
a:as :: [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 x :: XXConDecl (GhcPass p)
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXConDecl (GhcPass p)
NoExt
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 two fields:
feqn_pats and feqn_rhs.

feqn_pats is either LHsTypes (for ordinary data/type family instances) or
LHsQTyVars (for associated type family default instances). In particular:

 * An ordinary type family instance declaration looks like this in source Haskell
      type instance T [a] Int = a -> a
   (or something similar for a closed family)
   It is represented by a FamInstEqn, with a *type* (LHsType) in the feqn_pats
   field.

 * On the other hand, the *default instance* of an associated type looks like
   this in source Haskell
      class C a where
        type T a b
        type T a b = a -> b   -- The default instance
   It is represented by a TyFamDefltEqn, with *type variables* (LHsQTyVars) in
   the feqn_pats field.

feqn_rhs is either an HsDataDefn (for data family instances) or an LHsType
(for type family instances).
-}

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

-- | Located Type Family Default Equation
type LTyFamDefltEqn pass = Located (TyFamDefltEqn pass)

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

{- Note [Family instance declaration binders]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For ordinary data/type family instances, the feqn_pats field of FamEqn 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

For associated type family default instances (TyFamDefltEqn), instead of using
type patterns with binders in a surrounding HsImplicitBndrs, we use raw type
variables (LHsQTyVars) in the feqn_pats field of FamEqn.

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

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

-- | Type Family Default Equation
type TyFamDefltEqn pass = FamEqn pass (LHsQTyVars pass) (LHsType pass)
  -- See Note [Type family instance declarations in HsSyn]

-- | 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 (HsTyPats 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 pats rhs
  = FamEqn
       { FamEqn pass pats rhs -> XCFamEqn pass pats rhs
feqn_ext    :: XCFamEqn pass pats rhs
       , FamEqn pass pats rhs -> Located (IdP pass)
feqn_tycon  :: Located (IdP pass)
       , FamEqn pass pats rhs -> Maybe [LHsTyVarBndr pass]
feqn_bndrs  :: Maybe [LHsTyVarBndr pass] -- ^ Optional quantified type vars
       , FamEqn pass pats rhs -> pats
feqn_pats   :: pats
       , FamEqn pass pats rhs -> LexicalFixity
feqn_fixity :: LexicalFixity -- ^ Fixity used in the declaration
       , FamEqn pass pats rhs -> rhs
feqn_rhs    :: rhs
       }
    -- ^
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnEqual'
  | XFamEqn (XXFamEqn pass pats rhs)

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

type instance XCFamEqn    (GhcPass _) p r = NoExt
type instance XXFamEqn    (GhcPass _) p r = NoExt

----------------- 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 _) = NoExt
type instance XXClsInstDecl    (GhcPass _) = NoExt

----------------- 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 _) = NoExt
type instance XDataFamInstD (GhcPass _) = NoExt
type instance XTyFamInstD   (GhcPass _) = NoExt
type instance XXInstDecl    (GhcPass _) = NoExt

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

pprTyFamInstDecl :: (OutputableBndrId (GhcPass p))
                 => TopLevelFlag -> TyFamInstDecl (GhcPass p) -> SDoc
pprTyFamInstDecl :: TopLevelFlag -> TyFamInstDecl (GhcPass p) -> SDoc
pprTyFamInstDecl top_lvl :: TopLevelFlag
top_lvl (TyFamInstDecl { tfid_eqn :: forall pass. TyFamInstDecl pass -> TyFamInstEqn pass
tfid_eqn = TyFamInstEqn (GhcPass p)
eqn })
   = [Char] -> SDoc
text "type" SDoc -> SDoc -> SDoc
<+> TopLevelFlag -> SDoc
ppr_instance_keyword TopLevelFlag
top_lvl SDoc -> SDoc -> SDoc
<+> TyFamInstEqn (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass 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 TopLevel    = [Char] -> SDoc
text "instance"
ppr_instance_keyword NotTopLevel = SDoc
empty

ppr_fam_inst_eqn :: (OutputableBndrId (GhcPass 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 pats rhs. FamEqn pass pats rhs -> Located (IdP pass)
feqn_tycon  = L _ tycon :: IdP (GhcPass p)
tycon
                                            , feqn_bndrs :: forall pass pats rhs.
FamEqn pass pats rhs -> Maybe [LHsTyVarBndr pass]
feqn_bndrs  = Maybe [LHsTyVarBndr (GhcPass p)]
bndrs
                                            , feqn_pats :: forall pass pats rhs. FamEqn pass pats rhs -> pats
feqn_pats   = HsTyPats (GhcPass p)
pats
                                            , feqn_fixity :: forall pass pats rhs. FamEqn pass pats rhs -> LexicalFixity
feqn_fixity = LexicalFixity
fixity
                                            , feqn_rhs :: forall pass pats rhs. FamEqn pass pats 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 (GhcPass 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 x :: XXFamEqn (GhcPass p) (HsTyPats (GhcPass p)) (LHsType (GhcPass p))
x }) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXFamEqn (GhcPass p) (HsTyPats (GhcPass p)) (LHsType (GhcPass p))
NoExt
x
ppr_fam_inst_eqn (XHsImplicitBndrs x :: XXHsImplicitBndrs
  (GhcPass p)
  (FamEqn (GhcPass p) (HsTyPats (GhcPass p)) (LHsType (GhcPass p)))
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsImplicitBndrs
  (GhcPass p)
  (FamEqn (GhcPass p) (HsTyPats (GhcPass p)) (LHsType (GhcPass p)))
NoExt
x

ppr_fam_deflt_eqn :: (OutputableBndrId (GhcPass p))
                  => LTyFamDefltEqn (GhcPass p) -> SDoc
ppr_fam_deflt_eqn :: LTyFamDefltEqn (GhcPass p) -> SDoc
ppr_fam_deflt_eqn (L _ (FamEqn { feqn_tycon :: forall pass pats rhs. FamEqn pass pats rhs -> Located (IdP pass)
feqn_tycon  = Located (IdP (GhcPass p))
tycon
                               , feqn_pats :: forall pass pats rhs. FamEqn pass pats rhs -> pats
feqn_pats   = LHsQTyVars (GhcPass p)
tvs
                               , feqn_fixity :: forall pass pats rhs. FamEqn pass pats rhs -> LexicalFixity
feqn_fixity = LexicalFixity
fixity
                               , feqn_rhs :: forall pass pats rhs. FamEqn pass pats rhs -> rhs
feqn_rhs    = LHsType (GhcPass p)
rhs }))
    = [Char] -> SDoc
text "type" SDoc -> SDoc -> SDoc
<+> Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
Located (IdP (GhcPass p))
-> LHsQTyVars (GhcPass p)
-> LexicalFixity
-> LHsContext (GhcPass p)
-> SDoc
pp_vanilla_decl_head Located (IdP (GhcPass p))
tycon LHsQTyVars (GhcPass p)
tvs 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_deflt_eqn (L _ (XFamEqn x :: XXFamEqn (GhcPass p) (LHsQTyVars (GhcPass p)) (LHsType (GhcPass p))
x)) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXFamEqn (GhcPass p) (LHsQTyVars (GhcPass p)) (LHsType (GhcPass p))
NoExt
x

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

pprDataFamInstDecl :: (OutputableBndrId (GhcPass p))
                   => TopLevelFlag -> DataFamInstDecl (GhcPass p) -> SDoc
pprDataFamInstDecl :: TopLevelFlag -> DataFamInstDecl (GhcPass p) -> SDoc
pprDataFamInstDecl top_lvl :: 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 pats rhs. FamEqn pass pats rhs -> Located (IdP pass)
feqn_tycon  = L _ tycon :: IdP (GhcPass p)
tycon
                                    , feqn_bndrs :: forall pass pats rhs.
FamEqn pass pats rhs -> Maybe [LHsTyVarBndr pass]
feqn_bndrs  = Maybe [LHsTyVarBndr (GhcPass p)]
bndrs
                                    , feqn_pats :: forall pass pats rhs. FamEqn pass pats rhs -> pats
feqn_pats   = HsTyPats (GhcPass p)
pats
                                    , feqn_fixity :: forall pass pats rhs. FamEqn pass pats rhs -> LexicalFixity
feqn_fixity = LexicalFixity
fixity
                                    , feqn_rhs :: forall pass pats rhs. FamEqn pass pats rhs -> rhs
feqn_rhs    = HsDataDefn (GhcPass p)
defn }}})
  = (LHsContext (GhcPass p) -> SDoc) -> HsDataDefn (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass 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 ctxt :: 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 (GhcPass 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 _ (DataFamInstDecl (HsIB _ (XFamEqn x :: XXFamEqn
  (GhcPass p) (HsTyPats (GhcPass p)) (HsDataDefn (GhcPass p))
x)))
  = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXFamEqn
  (GhcPass p) (HsTyPats (GhcPass p)) (HsDataDefn (GhcPass p))
NoExt
x
pprDataFamInstDecl _ (DataFamInstDecl (XHsImplicitBndrs x :: XXHsImplicitBndrs
  (GhcPass p)
  (FamEqn
     (GhcPass p) (HsTyPats (GhcPass p)) (HsDataDefn (GhcPass p)))
x))
  = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsImplicitBndrs
  (GhcPass p)
  (FamEqn
     (GhcPass p) (HsTyPats (GhcPass p)) (HsDataDefn (GhcPass p)))
NoExt
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 pats rhs. FamEqn pass pats 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 pats rhs. FamEqn pass pats rhs -> rhs
feqn_rhs = XHsDataDefn x :: XXHsDataDefn (GhcPass p)
x}}})
  = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsDataDefn (GhcPass p)
NoExt
x
pprDataFamInstFlavour (DataFamInstDecl (HsIB _ (XFamEqn x :: XXFamEqn
  (GhcPass p) (HsTyPats (GhcPass p)) (HsDataDefn (GhcPass p))
x)))
  = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXFamEqn
  (GhcPass p) (HsTyPats (GhcPass p)) (HsDataDefn (GhcPass p))
NoExt
x
pprDataFamInstFlavour (DataFamInstDecl (XHsImplicitBndrs x :: XXHsImplicitBndrs
  (GhcPass p)
  (FamEqn
     (GhcPass p) (HsTyPats (GhcPass p)) (HsDataDefn (GhcPass p)))
x))
  = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXHsImplicitBndrs
  (GhcPass p)
  (FamEqn
     (GhcPass p) (HsTyPats (GhcPass p)) (HsDataDefn (GhcPass p)))
NoExt
x

pprHsFamInstLHS :: (OutputableBndrId (GhcPass 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 thing :: IdP (GhcPass p)
thing bndrs :: Maybe [LHsTyVarBndr (GhcPass p)]
bndrs typats :: HsTyPats (GhcPass p)
typats fixity :: LexicalFixity
fixity mb_ctxt :: LHsContext (GhcPass p)
mb_ctxt
   = [SDoc] -> SDoc
hsep [ Maybe [LHsTyVarBndr (GhcPass p)] -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
Maybe [LHsTyVarBndr (GhcPass p)] -> SDoc
pprHsExplicitForAll Maybe [LHsTyVarBndr (GhcPass p)]
bndrs
          , LHsContext (GhcPass p) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass 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 (patl :: LHsTypeArg (GhcPass p)
patl:patr :: LHsTypeArg (GhcPass p)
patr:pats :: 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
           _  -> [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 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 (p ~ GhcPass pass, OutputableBndrId p)
       => Outputable (ClsInstDecl p) where
    ppr :: ClsInstDecl p -> SDoc
ppr (ClsInstDecl { cid_poly_ty :: forall pass. ClsInstDecl pass -> LHsSigType pass
cid_poly_ty = LHsSigType p
inst_ty, cid_binds :: forall pass. ClsInstDecl pass -> LHsBinds pass
cid_binds = LHsBinds p
binds
                     , cid_sigs :: forall pass. ClsInstDecl pass -> [LSig pass]
cid_sigs = [LSig p]
sigs, cid_tyfam_insts :: forall pass. ClsInstDecl pass -> [LTyFamInstDecl pass]
cid_tyfam_insts = [LTyFamInstDecl 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 p]
adts })
      | [LSig p] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LSig p]
sigs, [LTyFamInstDecl p] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LTyFamInstDecl p]
ats, [LDataFamInstDecl p] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LDataFamInstDecl p]
adts, LHsBinds p -> Bool
forall a. Bag a -> Bool
isEmptyBag LHsBinds p
binds  -- No "where" part
      = SDoc
top_matter

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

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

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


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

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

instDeclDataFamInsts :: [LInstDecl pass] -> [DataFamInstDecl pass]
instDeclDataFamInsts :: [LInstDecl pass] -> [DataFamInstDecl pass]
instDeclDataFamInsts inst_decls :: [LInstDecl pass]
inst_decls
  = (LInstDecl pass -> [DataFamInstDecl pass])
-> [LInstDecl pass] -> [DataFamInstDecl pass]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap LInstDecl pass -> [DataFamInstDecl pass]
forall l pass.
GenLocated l (InstDecl pass) -> [DataFamInstDecl pass]
do_one [LInstDecl pass]
inst_decls
  where
    do_one :: GenLocated l (InstDecl pass) -> [DataFamInstDecl pass]
do_one (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 _ (DataFamInstD { dfid_inst :: forall pass. InstDecl pass -> DataFamInstDecl pass
dfid_inst = DataFamInstDecl pass
fam_inst }))      = [DataFamInstDecl pass
fam_inst]
    do_one (L _ (TyFamInstD {}))                              = []
    do_one (L _ (ClsInstD _ (XClsInstDecl _))) = [Char] -> [DataFamInstDecl pass]
forall a. [Char] -> a
panic "instDeclDataFamInsts"
    do_one (L _ (XInstDecl _))                 = [Char] -> [DataFamInstDecl pass]
forall a. [Char] -> a
panic "instDeclDataFamInsts"

{-
************************************************************************
*                                                                      *
\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 _) = NoExt
type instance XXDerivDecl    (GhcPass _) = NoExt

instance (p ~ GhcPass pass, OutputableBndrId p)
       => Outputable (DerivDecl p) where
    ppr :: DerivDecl p -> SDoc
ppr (DerivDecl { deriv_type :: forall pass. DerivDecl pass -> LHsSigWcType pass
deriv_type = LHsSigWcType p
ty
                   , deriv_strategy :: forall pass. DerivDecl pass -> Maybe (LDerivStrategy pass)
deriv_strategy = Maybe (LDerivStrategy 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 "deriving"
               , Maybe (LDerivStrategy p) -> SDoc
forall p (pass :: Pass).
(p ~ GhcPass pass, OutputableBndrId p) =>
Maybe (LDerivStrategy p) -> SDoc
ppDerivStrategy Maybe (LDerivStrategy p)
ds
               , [Char] -> SDoc
text "instance"
               , Maybe (Located OverlapMode) -> SDoc
ppOverlapPragma Maybe (Located OverlapMode)
o
               , LHsSigWcType p -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsSigWcType p
ty ]
    ppr (XDerivDecl x :: XXDerivDecl p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXDerivDecl p
NoExt
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 (p ~ GhcPass pass, OutputableBndrId p)
        => Outputable (DerivStrategy p) where
    ppr :: DerivStrategy p -> SDoc
ppr StockStrategy    = [Char] -> SDoc
text "stock"
    ppr AnyclassStrategy = [Char] -> SDoc
text "anyclass"
    ppr NewtypeStrategy  = [Char] -> SDoc
text "newtype"
    ppr (ViaStrategy ty :: XViaStrategy p
ty) = [Char] -> SDoc
text "via" SDoc -> SDoc -> SDoc
<+> XViaStrategy (GhcPass pass) -> SDoc
forall a. Outputable a => a -> SDoc
ppr XViaStrategy p
XViaStrategy (GhcPass pass)
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 StockStrategy    = "stock"
    go AnyclassStrategy = "anyclass"
    go NewtypeStrategy  = "newtype"
    go (ViaStrategy {}) = "via"

{-
************************************************************************
*                                                                      *
\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 _) = NoExt
type instance XXDefaultDecl    (GhcPass _) = NoExt

instance (p ~ GhcPass pass, OutputableBndrId p)
       => Outputable (DefaultDecl p) where
    ppr :: DefaultDecl p -> SDoc
ppr (DefaultDecl _ tys :: [LHsType p]
tys)
      = [Char] -> SDoc
text "default" SDoc -> SDoc -> SDoc
<+> SDoc -> SDoc
parens ([LHsType p] -> SDoc
forall a. Outputable a => [a] -> SDoc
interpp'SP [LHsType p]
tys)
    ppr (XDefaultDecl x :: XXDefaultDecl p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXDefaultDecl p
NoExt
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 = NoExt
type instance XForeignImport   GhcRn = NoExt
type instance XForeignImport   GhcTc = Coercion

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

type instance XXForeignDecl    (GhcPass _) = NoExt

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

instance Outputable ForeignImport where
  ppr :: ForeignImport -> SDoc
ppr (CImport  cconv :: Located CCallConv
cconv safety :: Located Safety
safety mHeader :: Maybe Header
mHeader spec :: CImportSpec
spec (L _ srcText :: 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 "")
    where
      pp_hdr :: SDoc
pp_hdr = case Maybe Header
mHeader of
               Nothing -> SDoc
empty
               Just (Header _ header :: FastString
header) -> FastString -> SDoc
ftext FastString
header

      pprCEntity :: CImportSpec -> [Char] -> SDoc
pprCEntity (CLabel lbl :: FastString
lbl) _ =
        SDoc -> SDoc
doubleQuotes (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ [Char] -> SDoc
text "static" SDoc -> SDoc -> SDoc
<+> SDoc
pp_hdr SDoc -> SDoc -> SDoc
<+> Char -> SDoc
char '&' SDoc -> SDoc -> SDoc
<> FastString -> SDoc
forall a. Outputable a => a -> SDoc
ppr FastString
lbl
      pprCEntity (CFunction (StaticTarget st :: SourceText
st _lbl :: FastString
_lbl _ isFun :: Bool
isFun)) src :: [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 6 [Char]
src [Char] -> [Char] -> Bool
forall a. Eq a => a -> a -> Bool
== "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 6 [Char]
src [Char] -> [Char] -> Bool
forall a. Eq a => a -> a -> Bool
== "static" then [Char] -> SDoc
text "static" else SDoc
empty)
              SDoc -> SDoc -> SDoc
<+> SDoc
pp_hdr
              SDoc -> SDoc -> SDoc
<+> (if Bool
isFun then SDoc
empty else [Char] -> SDoc
text "value")
              SDoc -> SDoc -> SDoc
<+> (SourceText -> SDoc -> SDoc
pprWithSourceText SourceText
st SDoc
empty)
      pprCEntity (CFunction DynamicTarget) _ =
        SDoc -> SDoc
doubleQuotes (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ [Char] -> SDoc
text "dynamic"
      pprCEntity CWrapper _ = SDoc -> SDoc
doubleQuotes (SDoc -> SDoc) -> SDoc -> SDoc
forall a b. (a -> b) -> a -> b
$ [Char] -> SDoc
text "wrapper"

instance Outputable ForeignExport where
  ppr :: ForeignExport -> SDoc
ppr (CExport  (L _ (CExportStatic _ lbl :: FastString
lbl cconv :: CCallConv
cconv)) _) =
    CCallConv -> SDoc
forall a. Outputable a => a -> SDoc
ppr CCallConv
cconv SDoc -> SDoc -> SDoc
<+> Char -> SDoc
char '"' SDoc -> SDoc -> SDoc
<> FastString -> SDoc
forall a. Outputable a => a -> SDoc
ppr FastString
lbl SDoc -> SDoc -> SDoc
<> Char -> SDoc
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 _) = NoExt
type instance XXRuleDecls    (GhcPass _) = NoExt

-- | 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 = NoExt
type instance XHsRule       GhcRn = HsRuleRn
type instance XHsRule       GhcTc = HsRuleRn

type instance XXRuleDecl    (GhcPass _) = NoExt

flattenRuleDecls :: [LRuleDecls pass] -> [LRuleDecl pass]
flattenRuleDecls :: [LRuleDecls pass] -> [LRuleDecl pass]
flattenRuleDecls decls :: [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 _) = NoExt
type instance XRuleBndrSig  (GhcPass _) = NoExt
type instance XXRuleBndr    (GhcPass _) = NoExt

collectRuleBndrSigTys :: [RuleBndr pass] -> [LHsSigWcType pass]
collectRuleBndrSigTys :: [RuleBndr pass] -> [LHsSigWcType pass]
collectRuleBndrSigTys bndrs :: [RuleBndr pass]
bndrs = [LHsSigWcType pass
ty | RuleBndrSig _ _ ty :: LHsSigWcType pass
ty <- [RuleBndr pass]
bndrs]

pprFullRuleName :: Located (SourceText, RuleName) -> SDoc
pprFullRuleName :: Located (SourceText, FastString) -> SDoc
pprFullRuleName (L _ (st :: SourceText
st, n :: 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 (p ~ GhcPass pass, OutputableBndrId p) => Outputable (RuleDecls p) where
  ppr :: RuleDecls 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 p]
rules })
    = SourceText -> SDoc -> SDoc
pprWithSourceText SourceText
st ([Char] -> SDoc
text "{-# RULES")
          SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
vcat (SDoc -> [SDoc] -> [SDoc]
punctuate SDoc
semi ((LRuleDecl p -> SDoc) -> [LRuleDecl p] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LRuleDecl p -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LRuleDecl p]
rules)) SDoc -> SDoc -> SDoc
<+> [Char] -> SDoc
text "#-}"
  ppr (XRuleDecls x :: XXRuleDecls p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXRuleDecls p
NoExt
x

instance (p ~ GhcPass pass, OutputableBndrId p) => Outputable (RuleDecl p) where
  ppr :: RuleDecl 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 p)]
tys
              , rd_tmvs :: forall pass. RuleDecl pass -> [LRuleBndr pass]
rd_tmvs = [LRuleBndr p]
tms
              , rd_lhs :: forall pass. RuleDecl pass -> Located (HsExpr pass)
rd_lhs  = Located (HsExpr p)
lhs
              , rd_rhs :: forall pass. RuleDecl pass -> Located (HsExpr pass)
rd_rhs  = Located (HsExpr 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 4 (Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass pass)))]
-> SDoc
forall a. Outputable a => Maybe [a] -> SDoc
pp_forall_ty Maybe [LHsTyVarBndr (NoGhcTc p)]
Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass pass)))]
tys SDoc -> SDoc -> SDoc
<+> Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass pass)))]
-> SDoc
pp_forall_tm Maybe [LHsTyVarBndr (NoGhcTc p)]
Maybe [LHsTyVarBndr (GhcPass (NoGhcTcPass (NoGhcTcPass pass)))]
tys
                                        SDoc -> SDoc -> SDoc
<+> HsExpr (GhcPass pass) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
HsExpr (GhcPass p) -> SDoc
pprExpr (Located (HsExpr p) -> SrcSpanLess (Located (HsExpr p))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (HsExpr p)
lhs)),
               Int -> SDoc -> SDoc
nest 6 (SDoc
equals SDoc -> SDoc -> SDoc
<+> HsExpr (GhcPass pass) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
HsExpr (GhcPass p) -> SDoc
pprExpr (Located (HsExpr p) -> SrcSpanLess (Located (HsExpr p))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (HsExpr p)
rhs)) ]
        where
          pp_forall_ty :: Maybe [a] -> SDoc
pp_forall_ty Nothing     = SDoc
empty
          pp_forall_ty (Just qtvs :: [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 pass)))]
-> SDoc
pp_forall_tm Nothing | [LRuleBndr p] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [LRuleBndr p]
tms = SDoc
empty
          pp_forall_tm _ = SDoc
forAllLit SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
fsep ((LRuleBndr p -> SDoc) -> [LRuleBndr p] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LRuleBndr p -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LRuleBndr p]
tms) SDoc -> SDoc -> SDoc
<> SDoc
dot
  ppr (XRuleDecl x :: XXRuleDecl p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXRuleDecl p
NoExt
x

instance (p ~ GhcPass pass, OutputableBndrId p) => Outputable (RuleBndr p) where
   ppr :: RuleBndr p -> SDoc
ppr (RuleBndr _ name :: Located (IdP p)
name) = Located (IdP (GhcPass pass)) -> SDoc
forall a. Outputable a => a -> SDoc
ppr Located (IdP p)
Located (IdP (GhcPass pass))
name
   ppr (RuleBndrSig _ name :: Located (IdP p)
name ty :: LHsSigWcType p
ty) = SDoc -> SDoc
parens (Located (IdP (GhcPass pass)) -> SDoc
forall a. Outputable a => a -> SDoc
ppr Located (IdP p)
Located (IdP (GhcPass pass))
name SDoc -> SDoc -> SDoc
<> SDoc
dcolon SDoc -> SDoc -> SDoc
<> LHsSigWcType p -> SDoc
forall a. Outputable a => a -> SDoc
ppr LHsSigWcType p
ty)
   ppr (XRuleBndr x :: XXRuleBndr p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXRuleBndr p
NoExt
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 _ = [Char] -> SDoc
text "<document comment>"

docDeclDoc :: DocDecl -> HsDocString
docDeclDoc :: DocDecl -> HsDocString
docDeclDoc (DocCommentNext d :: HsDocString
d) = HsDocString
d
docDeclDoc (DocCommentPrev d :: HsDocString
d) = HsDocString
d
docDeclDoc (DocCommentNamed _ d :: HsDocString
d) = HsDocString
d
docDeclDoc (DocGroup _ d :: 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 _) = NoExt
type instance XXWarnDecls    (GhcPass _) = NoExt

-- | 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 _) = NoExt
type instance XXWarnDecl    (GhcPass _) = NoExt


instance (p ~ GhcPass pass,OutputableBndr (IdP p))
        => Outputable (WarnDecls p) where
    ppr :: WarnDecls p -> SDoc
ppr (Warnings _ (SourceText src :: [Char]
src) decls :: [LWarnDecl p]
decls)
      = [Char] -> SDoc
text [Char]
src SDoc -> SDoc -> SDoc
<+> [SDoc] -> SDoc
vcat (SDoc -> [SDoc] -> [SDoc]
punctuate SDoc
comma ((LWarnDecl p -> SDoc) -> [LWarnDecl p] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map LWarnDecl p -> SDoc
forall a. Outputable a => a -> SDoc
ppr [LWarnDecl p]
decls)) SDoc -> SDoc -> SDoc
<+> [Char] -> SDoc
text "#-}"
    ppr (Warnings _ NoSourceText _decls :: [LWarnDecl p]
_decls) = [Char] -> SDoc
forall a. [Char] -> a
panic "WarnDecls"
    ppr (XWarnDecls x :: XXWarnDecls p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXWarnDecls p
NoExt
x

instance (p ~ GhcPass pass, OutputableBndr (IdP p))
       => Outputable (WarnDecl p) where
    ppr :: WarnDecl p -> SDoc
ppr (Warning _ thing :: [Located (IdP p)]
thing txt :: WarningTxt
txt)
      = [SDoc] -> SDoc
hsep ( SDoc -> [SDoc] -> [SDoc]
punctuate SDoc
comma ((Located (IdP (GhcPass pass)) -> SDoc)
-> [Located (IdP (GhcPass pass))] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map Located (IdP (GhcPass pass)) -> SDoc
forall a. Outputable a => a -> SDoc
ppr [Located (IdP p)]
[Located (IdP (GhcPass pass))]
thing))
              SDoc -> SDoc -> SDoc
<+> WarningTxt -> SDoc
forall a. Outputable a => a -> SDoc
ppr WarningTxt
txt
    ppr (XWarnDecl x :: XXWarnDecl p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXWarnDecl p
NoExt
x

{-
************************************************************************
*                                                                      *
\subsection[AnnDecl]{Annotations}
*                                                                      *
************************************************************************
-}

-- | Located Annotation Declaration
type LAnnDecl pass = Located (AnnDecl pass)

-- | Annotation Declaration
data AnnDecl pass = HsAnnotation
                      (XHsAnnotation pass)
                      SourceText -- Note [Pragma source text] in BasicTypes
                      (AnnProvenance (IdP pass)) (Located (HsExpr pass))
      -- ^ - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnOpen',
      --           'ApiAnnotation.AnnType'
      --           'ApiAnnotation.AnnModule'
      --           'ApiAnnotation.AnnClose'

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

type instance XHsAnnotation (GhcPass _) = NoExt
type instance XXAnnDecl     (GhcPass _) = NoExt

instance (p ~ GhcPass pass, OutputableBndrId p) => Outputable (AnnDecl p) where
    ppr :: AnnDecl p -> SDoc
ppr (HsAnnotation _ _ provenance :: AnnProvenance (IdP p)
provenance expr :: Located (HsExpr p)
expr)
      = [SDoc] -> SDoc
hsep [[Char] -> SDoc
text "{-#", AnnProvenance (IdP (GhcPass pass)) -> SDoc
forall name. OutputableBndr name => AnnProvenance name -> SDoc
pprAnnProvenance AnnProvenance (IdP p)
AnnProvenance (IdP (GhcPass pass))
provenance, HsExpr (GhcPass pass) -> SDoc
forall (p :: Pass).
OutputableBndrId (GhcPass p) =>
HsExpr (GhcPass p) -> SDoc
pprExpr (Located (HsExpr p) -> SrcSpanLess (Located (HsExpr p))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (HsExpr p)
expr), [Char] -> SDoc
text "#-}"]
    ppr (XAnnDecl x :: XXAnnDecl p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXAnnDecl p
NoExt
x

-- | Annotation Provenance
data AnnProvenance name = ValueAnnProvenance (Located name)
                        | TypeAnnProvenance (Located name)
                        | ModuleAnnProvenance
deriving instance Functor     AnnProvenance
deriving instance Foldable    AnnProvenance
deriving instance Traversable AnnProvenance
deriving instance (Data pass) => Data (AnnProvenance pass)

annProvenanceName_maybe :: AnnProvenance name -> Maybe name
annProvenanceName_maybe :: AnnProvenance name -> Maybe name
annProvenanceName_maybe (ValueAnnProvenance (L _ name :: name
name)) = name -> Maybe name
forall a. a -> Maybe a
Just name
name
annProvenanceName_maybe (TypeAnnProvenance (L _ name :: name
name))  = name -> Maybe name
forall a. a -> Maybe a
Just name
name
annProvenanceName_maybe ModuleAnnProvenance       = Maybe name
forall a. Maybe a
Nothing

pprAnnProvenance :: OutputableBndr name => AnnProvenance name -> SDoc
pprAnnProvenance :: AnnProvenance name -> SDoc
pprAnnProvenance ModuleAnnProvenance       = [Char] -> SDoc
text "ANN module"
pprAnnProvenance (ValueAnnProvenance (L _ name :: name
name))
  = [Char] -> SDoc
text "ANN" SDoc -> SDoc -> SDoc
<+> name -> SDoc
forall a. Outputable a => a -> SDoc
ppr name
name
pprAnnProvenance (TypeAnnProvenance (L _ name :: name
name))
  = [Char] -> SDoc
text "ANN type" SDoc -> SDoc -> SDoc
<+> name -> SDoc
forall a. Outputable a => a -> SDoc
ppr name
name

{-
************************************************************************
*                                                                      *
\subsection[RoleAnnot]{Role annotations}
*                                                                      *
************************************************************************
-}

-- | Located Role Annotation Declaration
type LRoleAnnotDecl pass = Located (RoleAnnotDecl pass)

-- See #8185 for more info about why role annotations are
-- top-level declarations
-- | Role Annotation Declaration
data RoleAnnotDecl pass
  = RoleAnnotDecl (XCRoleAnnotDecl pass)
                  (Located (IdP pass))   -- type constructor
                  [Located (Maybe Role)] -- optional annotations
      -- ^ - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnType',
      --           'ApiAnnotation.AnnRole'

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

type instance XCRoleAnnotDecl (GhcPass _) = NoExt
type instance XXRoleAnnotDecl (GhcPass _) = NoExt

instance (p ~ GhcPass pass, OutputableBndr (IdP p))
       => Outputable (RoleAnnotDecl p) where
  ppr :: RoleAnnotDecl p -> SDoc
ppr (RoleAnnotDecl _ ltycon :: Located (IdP p)
ltycon roles :: [Located (Maybe Role)]
roles)
    = [Char] -> SDoc
text "type role" SDoc -> SDoc -> SDoc
<+> IdP (GhcPass pass) -> SDoc
forall a. OutputableBndr a => a -> SDoc
pprPrefixOcc (Located (IdP (GhcPass pass))
-> SrcSpanLess (Located (IdP (GhcPass pass)))
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc Located (IdP p)
Located (IdP (GhcPass pass))
ltycon) SDoc -> SDoc -> SDoc
<+>
      [SDoc] -> SDoc
hsep ((Located (Maybe Role) -> SDoc) -> [Located (Maybe Role)] -> [SDoc]
forall a b. (a -> b) -> [a] -> [b]
map (Maybe Role -> SDoc
forall a. Outputable a => Maybe a -> SDoc
pp_role (Maybe Role -> SDoc)
-> (Located (Maybe Role) -> Maybe Role)
-> Located (Maybe Role)
-> SDoc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Maybe Role) -> Maybe Role
forall a. HasSrcSpan a => a -> SrcSpanLess a
unLoc) [Located (Maybe Role)]
roles)
    where
      pp_role :: Maybe a -> SDoc
pp_role Nothing  = SDoc
underscore
      pp_role (Just r :: a
r) = a -> SDoc
forall a. Outputable a => a -> SDoc
ppr a
r
  ppr (XRoleAnnotDecl x :: XXRoleAnnotDecl p
x) = NoExt -> SDoc
forall a. Outputable a => a -> SDoc
ppr XXRoleAnnotDecl p
NoExt
x

roleAnnotDeclName :: RoleAnnotDecl pass -> (IdP pass)
roleAnnotDeclName :: RoleAnnotDecl pass -> IdP pass
roleAnnotDeclName (RoleAnnotDecl _ (L _ name :: IdP pass
name) _) = IdP pass
name
roleAnnotDeclName (XRoleAnnotDecl _) = [Char] -> IdP pass
forall a. [Char] -> a
panic "roleAnnotDeclName"