HsDecls.hs 74 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2 3 4
{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 1992-1998
-}
5

6
{-# LANGUAGE CPP #-}
7 8
{-# LANGUAGE DeriveDataTypeable, DeriveFunctor, DeriveFoldable,
             DeriveTraversable #-}
9 10 11 12 13
{-# LANGUAGE StandaloneDeriving #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE UndecidableInstances #-} -- Note [Pass sensitive types]
                                      -- in module PlaceHolder
{-# LANGUAGE ConstraintKinds #-}
14
{-# LANGUAGE FlexibleInstances #-}
15

16 17
-- | Abstract syntax of global declarations.
--
18
-- Definitions for: @SynDecl@ and @ConDecl@, @ClassDecl@,
19
-- @InstDecl@, @DefaultDecl@ and @ForeignDecl@.
20
module HsDecls (
21
  -- * Toplevel declarations
22 23
  HsDecl(..), LHsDecl, HsDataDefn(..), HsDeriving,

24
  -- ** Class or type declarations
25 26
  TyClDecl(..), LTyClDecl,
  TyClGroup(..), tyClGroupConcat, mkTyClGroup,
27 28
  isClassDecl, isDataDecl, isSynDecl, tcdName,
  isFamilyDecl, isTypeFamilyDecl, isDataFamilyDecl,
29
  isOpenTypeFamilyInfo, isClosedTypeFamilyInfo,
30 31 32
  tyFamInstDeclName, tyFamInstDeclLName,
  countTyClDecls, pprTyClDeclFlavour,
  tyClDeclLName, tyClDeclTyVars,
33
  hsDeclHasCusk, famDeclHasCusk,
34
  FamilyDecl(..), LFamilyDecl,
35

36
  -- ** Instance declarations
37
  InstDecl(..), LInstDecl, NewOrData(..), FamilyInfo(..),
38 39
  TyFamInstDecl(..), LTyFamInstDecl, instDeclDataFamInsts,
  DataFamInstDecl(..), LDataFamInstDecl, pprDataFamInstFlavour,
40
  TyFamEqn(..), TyFamInstEqn, LTyFamInstEqn, TyFamDefltEqn, LTyFamDefltEqn,
Alan Zimmerman's avatar
Alan Zimmerman committed
41
  HsTyPats,
42
  LClsInstDecl, ClsInstDecl(..),
43

44 45 46
  -- ** Standalone deriving declarations
  DerivDecl(..), LDerivDecl,
  -- ** @RULE@ declarations
Alan Zimmerman's avatar
Alan Zimmerman committed
47
  LRuleDecls,RuleDecls(..),RuleDecl(..), LRuleDecl, RuleBndr(..),LRuleBndr,
48
  collectRuleBndrSigTys,
Alan Zimmerman's avatar
Alan Zimmerman committed
49
  flattenRuleDecls,
50 51
  -- ** @VECTORISE@ declarations
  VectDecl(..), LVectDecl,
52
  lvectDeclName, lvectInstDecl,
53 54
  -- ** @default@ declarations
  DefaultDecl(..), LDefaultDecl,
55
  -- ** Template haskell declaration splice
56
  SpliceExplicitFlag(..),
57
  SpliceDecl(..), LSpliceDecl,
58 59
  -- ** Foreign function interface declarations
  ForeignDecl(..), LForeignDecl, ForeignImport(..), ForeignExport(..),
60
  noForeignImportCoercionYet, noForeignExportCoercionYet,
61
  CImportSpec(..),
62
  -- ** Data-constructor declarations
Alan Zimmerman's avatar
Alan Zimmerman committed
63
  ConDecl(..), LConDecl,
64
  HsConDeclDetails, hsConDeclArgTys,
Alan Zimmerman's avatar
Alan Zimmerman committed
65 66 67
  getConNames,
  getConDetails,
  gadtDeclDetails,
68 69 70 71
  -- ** Document comments
  DocDecl(..), LDocDecl, docDeclDoc,
  -- ** Deprecations
  WarnDecl(..),  LWarnDecl,
Alan Zimmerman's avatar
Alan Zimmerman committed
72
  WarnDecls(..), LWarnDecls,
73
  -- ** Annotations
74
  AnnDecl(..), LAnnDecl,
75
  AnnProvenance(..), annProvenanceName_maybe,
76 77
  -- ** Role annotations
  RoleAnnotDecl(..), LRoleAnnotDecl, roleAnnotDeclName,
Jan Stolarek's avatar
Jan Stolarek committed
78 79 80
  -- ** Injective type families
  FamilyResultSig(..), LFamilyResultSig, InjectivityAnn(..), LInjectivityAnn,
  resultVariableName,
81 82

  -- * Grouping
83
  HsGroup(..),  emptyRdrGroup, emptyRnGroup, appendGroups
84

85
    ) where
86 87

-- friends:
88
import {-# SOURCE #-}   HsExpr( LHsExpr, HsExpr, HsSplice, pprExpr, pprSplice )
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
89
        -- Because Expr imports Decls via HsBracket
90

91 92
import HsBinds
import HsPat
93
import HsTypes
94
import HsDoc
95
import TyCon
96
import Name
97
import BasicTypes
98
import Coercion
99
import ForeignCall
100 101
import PlaceHolder ( PostTc,PostRn,PlaceHolder(..),DataId )
import NameSet
102 103

-- others:
104
import InstEnv
105
import Class
106
import Outputable
107 108
import Util
import SrcLoc
rrt's avatar
rrt committed
109
import FastString
110

111
import Bag
Alan Zimmerman's avatar
Alan Zimmerman committed
112
import Data.Maybe ( fromMaybe )
113
import Data.Data        hiding (TyCon,Fixity)
114 115 116 117
#if __GLASGOW_HASKELL__ < 709
import Data.Foldable ( Foldable )
import Data.Traversable ( Traversable )
#endif
118

Austin Seipp's avatar
Austin Seipp committed
119 120 121
{-
************************************************************************
*                                                                      *
122
\subsection[HsDecl]{Declarations}
Austin Seipp's avatar
Austin Seipp committed
123 124 125
*                                                                      *
************************************************************************
-}
126

127
type LHsDecl id = Located (HsDecl id)
Alan Zimmerman's avatar
Alan Zimmerman committed
128 129 130 131
        -- ^ When in a list this may have
        --
        --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnSemi'
        --
132

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

135
-- | A Haskell Declaration
136
data HsDecl id
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
137 138
  = TyClD       (TyClDecl id)     -- ^ A type or class declaration.
  | InstD       (InstDecl  id)    -- ^ An instance declaration.
139
  | DerivD      (DerivDecl id)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
140 141 142
  | ValD        (HsBind id)
  | SigD        (Sig id)
  | DefD        (DefaultDecl id)
143
  | ForD        (ForeignDecl id)
Alan Zimmerman's avatar
Alan Zimmerman committed
144
  | WarningD    (WarnDecls id)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
145
  | AnnD        (AnnDecl id)
Alan Zimmerman's avatar
Alan Zimmerman committed
146
  | RuleD       (RuleDecls id)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
147
  | VectD       (VectDecl id)
148
  | SpliceD     (SpliceDecl id)   -- Includes quasi-quotes
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
149
  | DocD        (DocDecl)
150
  | RoleAnnotD  (RoleAnnotDecl id)
151 152
  deriving (Typeable)
deriving instance (DataId id) => Data (HsDecl id)
153

154 155

-- NB: all top-level fixity decls are contained EITHER
156
-- EITHER SigDs
157 158 159
-- OR     in the ClassDecls in TyClDs
--
-- The former covers
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
160 161 162 163 164
--      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
165 166
--
-- The latter is for class methods only
167

168
-- | A 'HsDecl' is categorised into a 'HsGroup' before being
169 170 171
-- fed to the renamer.
data HsGroup id
  = HsGroup {
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
172
        hs_valds  :: HsValBinds id,
173
        hs_splcds :: [LSpliceDecl id],
174

175
        hs_tyclds :: [TyClGroup id],
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
176
                -- A list of mutually-recursive groups
177
                -- No family-instances here; they are in hs_instds
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
178 179
                -- Parser generates a singleton list;
                -- renamer does dependency analysis
180

181 182 183
        hs_instds  :: [LInstDecl id],
                -- Both class and family instance declarations in here

184
        hs_derivds :: [LDerivDecl id],
185

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
186 187 188
        hs_fixds  :: [LFixitySig id],
                -- Snaffled out of both top-level fixity signatures,
                -- and those in class declarations
189

190 191
        hs_defds  :: [LDefaultDecl id],
        hs_fords  :: [LForeignDecl id],
Alan Zimmerman's avatar
Alan Zimmerman committed
192
        hs_warnds :: [LWarnDecls id],
193
        hs_annds  :: [LAnnDecl id],
Alan Zimmerman's avatar
Alan Zimmerman committed
194
        hs_ruleds :: [LRuleDecls id],
195
        hs_vects  :: [LVectDecl id],
196

197
        hs_docs   :: [LDocDecl]
198 199
  } deriving (Typeable)
deriving instance (DataId id) => Data (HsGroup id)
200

201 202 203 204
emptyGroup, emptyRdrGroup, emptyRnGroup :: HsGroup a
emptyRdrGroup = emptyGroup { hs_valds = emptyValBindsIn }
emptyRnGroup  = emptyGroup { hs_valds = emptyValBindsOut }

205
emptyGroup = HsGroup { hs_tyclds = [], hs_instds = [],
206
                       hs_derivds = [],
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
207 208 209
                       hs_fixds = [], hs_defds = [], hs_annds = [],
                       hs_fords = [], hs_warnds = [], hs_ruleds = [], hs_vects = [],
                       hs_valds = error "emptyGroup hs_valds: Can't happen",
210
                       hs_splcds = [],
211
                       hs_docs = [] }
212 213

appendGroups :: HsGroup a -> HsGroup a -> HsGroup a
214 215
appendGroups
    HsGroup {
216
        hs_valds  = val_groups1,
217
        hs_splcds = spliceds1,
218
        hs_tyclds = tyclds1,
219
        hs_instds = instds1,
220
        hs_derivds = derivds1,
221
        hs_fixds  = fixds1,
222 223
        hs_defds  = defds1,
        hs_annds  = annds1,
224
        hs_fords  = fords1,
225 226 227
        hs_warnds = warnds1,
        hs_ruleds = rulds1,
        hs_vects = vects1,
228
  hs_docs   = docs1 }
229
    HsGroup {
230
        hs_valds  = val_groups2,
231
        hs_splcds = spliceds2,
232
        hs_tyclds = tyclds2,
233
        hs_instds = instds2,
234
        hs_derivds = derivds2,
235
        hs_fixds  = fixds2,
236 237
        hs_defds  = defds2,
        hs_annds  = annds2,
238
        hs_fords  = fords2,
239 240 241 242
        hs_warnds = warnds2,
        hs_ruleds = rulds2,
        hs_vects  = vects2,
        hs_docs   = docs2 }
243 244
  =
    HsGroup {
245
        hs_valds  = val_groups1 `plusHsValBinds` val_groups2,
246 247
        hs_splcds = spliceds1 ++ spliceds2,
        hs_tyclds = tyclds1 ++ tyclds2,
248
        hs_instds = instds1 ++ instds2,
249
        hs_derivds = derivds1 ++ derivds2,
250 251 252
        hs_fixds  = fixds1 ++ fixds2,
        hs_annds  = annds1 ++ annds2,
        hs_defds  = defds1 ++ defds2,
253
        hs_fords  = fords1 ++ fords2,
254 255 256 257
        hs_warnds = warnds1 ++ warnds2,
        hs_ruleds = rulds1 ++ rulds2,
        hs_vects  = vects1 ++ vects2,
        hs_docs   = docs1  ++ docs2 }
258

259
instance OutputableBndr name => Outputable (HsDecl name) where
260 261 262 263 264 265 266 267
    ppr (TyClD dcl)             = ppr dcl
    ppr (ValD binds)            = ppr binds
    ppr (DefD def)              = ppr def
    ppr (InstD inst)            = ppr inst
    ppr (DerivD deriv)          = ppr deriv
    ppr (ForD fd)               = ppr fd
    ppr (SigD sd)               = ppr sd
    ppr (RuleD rd)              = ppr rd
268
    ppr (VectD vect)            = ppr vect
Ian Lynagh's avatar
Ian Lynagh committed
269
    ppr (WarningD wd)           = ppr wd
270
    ppr (AnnD ad)               = ppr ad
271 272
    ppr (SpliceD dd)            = ppr dd
    ppr (DocD doc)              = ppr doc
273
    ppr (RoleAnnotD ra)         = ppr ra
274 275 276

instance OutputableBndr name => Outputable (HsGroup name) where
    ppr (HsGroup { hs_valds  = val_decls,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
277 278
                   hs_tyclds = tycl_decls,
                   hs_instds = inst_decls,
279
                   hs_derivds = deriv_decls,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
280 281 282 283 284 285 286
                   hs_fixds  = fix_decls,
                   hs_warnds = deprec_decls,
                   hs_annds  = ann_decls,
                   hs_fords  = foreign_decls,
                   hs_defds  = default_decls,
                   hs_ruleds = rule_decls,
                   hs_vects  = vect_decls })
287 288
        = vcat_mb empty
            [ppr_ds fix_decls, ppr_ds default_decls,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
289 290 291
             ppr_ds deprec_decls, ppr_ds ann_decls,
             ppr_ds rule_decls,
             ppr_ds vect_decls,
292 293
             if isEmptyValBinds val_decls
                then Nothing
294
                else Just (ppr val_decls),
295
             ppr_ds (tyClGroupConcat tycl_decls),
296
             ppr_ds inst_decls,
297
             ppr_ds deriv_decls,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
298 299
             ppr_ds foreign_decls]
        where
300
          ppr_ds :: Outputable a => [a] -> Maybe SDoc
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
301 302
          ppr_ds [] = Nothing
          ppr_ds ds = Just (vcat (map ppr ds))
303 304

          vcat_mb :: SDoc -> [Maybe SDoc] -> SDoc
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
305
          -- Concatenate vertically with white-space between non-blanks
306 307 308
          vcat_mb _    []             = empty
          vcat_mb gap (Nothing : ds) = vcat_mb gap ds
          vcat_mb gap (Just d  : ds) = gap $$ d $$ vcat_mb blankLine ds
309

310 311 312 313
data SpliceExplicitFlag = ExplicitSplice | -- <=> $(f x y)
                          ImplicitSplice   -- <=> f x y,  i.e. a naked top level expression
    deriving (Data, Typeable)

314
type LSpliceDecl name = Located (SpliceDecl name)
315
data SpliceDecl id
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
316
  = SpliceDecl                  -- Top level splice
317
        (Located (HsSplice id))
318
        SpliceExplicitFlag
319 320
    deriving (Typeable)
deriving instance (DataId id) => Data (SpliceDecl id)
321 322

instance OutputableBndr name => Outputable (SpliceDecl name) where
323
   ppr (SpliceDecl (L _ e) _) = pprSplice e
324

Austin Seipp's avatar
Austin Seipp committed
325 326 327
{-
************************************************************************
*                                                                      *
328
\subsection[SynDecl]{@data@, @newtype@ or @type@ (synonym) type declaration}
Austin Seipp's avatar
Austin Seipp committed
329 330
*                                                                      *
************************************************************************
331

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
332 333 334
                --------------------------------
                        THE NAMING STORY
                --------------------------------
335

336 337
Here is the story about the implicit names that go with type, class,
and instance decls.  It's a bit tricky, so pay attention!
338 339 340

"Implicit" (or "system") binders
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
341
  Each data type decl defines
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
342 343
        a worker name for each constructor
        to-T and from-T convertors
344
  Each class decl defines
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
345 346 347 348
        a tycon for the class
        a data constructor for that tycon
        the worker for that constructor
        a selector for each superclass
349

350 351
All have occurrence names that are derived uniquely from their parent
declaration.
352 353 354 355 356 357 358

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:
359
 - Ensure they "point to" the parent data/class decl
360
   when loading that decl from an interface file
361 362 363 364 365
   (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
366

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

370 371 372 373 374 375
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
376 377
   the ClassOpSig (in HsBinds), in the DefMethInfo field.
   (DefMethInfo is defined in Class.hs)
378 379 380 381 382 383 384

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

386 387 388 389 390
 - When parsing, every ClassOpSig gets a DefMeth with a suitable RdrName
   This is done by RdrHsSyn.mkClassOpSigDM

 - The renamer renames it to a Name

391
 - During typechecking, we generate a binding for each $dm for
392
   which there's a programmer-supplied default method:
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
393 394 395 396
        class Foo a where
          op1 :: <type>
          op2 :: <type>
          op1 = ...
397
   We generate a binding for $dmop1 but not for $dmop2.
398 399
   The Class for Foo has a Nothing for op2 and
                         a Just ($dm_op1, VanillaDM) for op1.
400 401 402 403 404
   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:
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
405 406 407
        class Foo a where
          op1 = :: <type>       -- NB the '='
          op2   :: <type>
408 409 410 411 412
    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
413
    the binding for $dmop1 will be sucked in.  (See RnHsSyn.tyClDeclFVs)
414 415 416 417 418 419 420 421 422 423 424 425 426 427
    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:
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
428 429
        instance {Eq Int} = dEqInt
        dEqInt :: {Eq Int} <pragma info>
430 431 432 433 434 435 436 437 438 439 440

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').

441
  - The occurrence name it chooses is derived from the instance decl (just for
442 443
    documentation really) --- e.g. dNumInt.  Two dict funs may share a common
    occurrence name, but will have different uniques.  E.g.
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
444 445
        instance Foo [Int]  where ...
        instance Foo [Bool] where ...
446 447
    These might both be dFooList

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

451
  - We can take this relaxed approach (changing the occurrence name later)
452 453 454 455 456 457 458 459 460
    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.
461

462 463
  - RnHsSyn.instDeclFVs treats the dict fun name as free in the decl, so that we
    suck in the dfun binding
Austin Seipp's avatar
Austin Seipp committed
464
-}
465

466 467
type LTyClDecl name = Located (TyClDecl name)

468
-- | A type or class declaration.
469
data TyClDecl name
Yuras's avatar
Yuras committed
470
  = -- | @type/data family T :: *->*@
Alan Zimmerman's avatar
Alan Zimmerman committed
471 472 473
    --
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnType',
    --             'ApiAnnotation.AnnData',
474
    --             'ApiAnnotation.AnnFamily','ApiAnnotation.AnnDcolon',
Jan Stolarek's avatar
Jan Stolarek committed
475 476 477 478
    --             'ApiAnnotation.AnnWhere','ApiAnnotation.AnnOpenP',
    --             'ApiAnnotation.AnnDcolon','ApiAnnotation.AnnCloseP',
    --             'ApiAnnotation.AnnEqual','ApiAnnotation.AnnRarrow',
    --             'ApiAnnotation.AnnVbar'
Alan Zimmerman's avatar
Alan Zimmerman committed
479

480
    -- For details on above see note [Api annotations] in ApiAnnotation
481
    FamDecl { tcdFam :: FamilyDecl name }
482

483
  | -- | @type@ declaration
Alan Zimmerman's avatar
Alan Zimmerman committed
484 485 486
    --
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnType',
    --             'ApiAnnotation.AnnEqual',
487 488

    -- For details on above see note [Api annotations] in ApiAnnotation
489 490
    SynDecl { tcdLName  :: Located name           -- ^ Type constructor
            , tcdTyVars :: LHsQTyVars name        -- ^ Type variables; for an associated type
491
                                                  --   these include outer binders
492
            , tcdRhs    :: LHsType name           -- ^ RHS of type declaration
493
            , tcdFVs    :: PostRn name NameSet }
494 495

  | -- | @data@ declaration
Alan Zimmerman's avatar
Alan Zimmerman committed
496 497 498 499
    --
    --  - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnData',
    --              'ApiAnnotation.AnnFamily',
    --              'ApiAnnotation.AnnNewType',
500 501
    --              'ApiAnnotation.AnnNewType','ApiAnnotation.AnnDcolon'
    --              'ApiAnnotation.AnnWhere',
502 503

    -- For details on above see note [Api annotations] in ApiAnnotation
504
    DataDecl { tcdLName    :: Located name        -- ^ Type constructor
505
             , tcdTyVars   :: LHsQTyVars name  -- ^ Type variables; for an associated type
506
                                                  --   these include outer binders
507 508 509
                                                  -- Eg  class T a where
                                                  --       type F a :: *
                                                  --       type F a = a -> a
510
                                                  -- Here the type decl for 'f' includes 'a'
511
                                                  -- in its tcdTyVars
512
             , tcdDataDefn :: HsDataDefn name
513
             , tcdFVs      :: PostRn name NameSet }
514

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
515 516
  | ClassDecl { tcdCtxt    :: LHsContext name,          -- ^ Context...
                tcdLName   :: Located name,             -- ^ Name of the class
517
                tcdTyVars  :: LHsQTyVars name,          -- ^ Class type variables
Alan Zimmerman's avatar
Alan Zimmerman committed
518 519
                tcdFDs     :: [Located (FunDep (Located name))],
                                                        -- ^ Functional deps
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
520 521
                tcdSigs    :: [LSig name],              -- ^ Methods' signatures
                tcdMeths   :: LHsBinds name,            -- ^ Default methods
Alan Zimmerman's avatar
Alan Zimmerman committed
522
                tcdATs     :: [LFamilyDecl name],       -- ^ Associated types;
523
                tcdATDefs  :: [LTyFamDefltEqn name],    -- ^ Associated type defaults
524
                tcdDocs    :: [LDocDecl],               -- ^ Haddock docs
525
                tcdFVs     :: PostRn name NameSet
526
    }
Alan Zimmerman's avatar
Alan Zimmerman committed
527 528 529 530 531 532
        -- ^ - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnClass',
        --           'ApiAnnotation.AnnWhere','ApiAnnotation.AnnOpen',
        --           'ApiAnnotation.AnnClose'
        --   - The tcdFDs will have 'ApiAnnotation.AnnVbar',
        --                          'ApiAnnotation.AnnComma'
        --                          'ApiAnnotation.AnnRarrow'
533

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

536 537
  deriving (Typeable)
deriving instance (DataId id) => Data (TyClDecl id)
538

539 540 541 542 543 544 545 546
 -- This is used in TcTyClsDecls to represent
 -- strongly connected components of decls
 -- No familiy instances in here
 -- The role annotations must be grouped with their decls for the
 -- type-checker to infer roles correctly
data TyClGroup name
  = TyClGroup { group_tyclds :: [LTyClDecl name]
              , group_roles  :: [LRoleAnnotDecl name] }
547 548
    deriving (Typeable)
deriving instance (DataId id) => Data (TyClGroup id)
549 550 551 552 553 554 555

tyClGroupConcat :: [TyClGroup name] -> [LTyClDecl name]
tyClGroupConcat = concatMap group_tyclds

mkTyClGroup :: [LTyClDecl name] -> TyClGroup name
mkTyClGroup decls = TyClGroup { group_tyclds = decls, group_roles = [] }

Jan Stolarek's avatar
Jan Stolarek committed
556 557
-- Simple classifiers for TyClDecl
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
558

559
-- | @True@ <=> argument is a @data@\/@newtype@
560 561
-- declaration.
isDataDecl :: TyClDecl name -> Bool
562 563
isDataDecl (DataDecl {}) = True
isDataDecl _other        = False
564

565 566
-- | type or type instance declaration
isSynDecl :: TyClDecl name -> Bool
567 568
isSynDecl (SynDecl {})   = True
isSynDecl _other        = False
569

570 571
-- | type class
isClassDecl :: TyClDecl name -> Bool
572
isClassDecl (ClassDecl {}) = True
573
isClassDecl _              = False
574

575
-- | type/data family declaration
576
isFamilyDecl :: TyClDecl name -> Bool
577
isFamilyDecl (FamDecl {})  = True
578
isFamilyDecl _other        = False
579 580 581

-- | type family declaration
isTypeFamilyDecl :: TyClDecl name -> Bool
582 583 584 585 586
isTypeFamilyDecl (FamDecl (FamilyDecl { fdInfo = info })) = case info of
  OpenTypeFamily      -> True
  ClosedTypeFamily {} -> True
  _                   -> False
isTypeFamilyDecl _ = False
587

588 589 590 591 592 593 594 595 596 597
-- | open type family info
isOpenTypeFamilyInfo :: FamilyInfo name -> Bool
isOpenTypeFamilyInfo OpenTypeFamily = True
isOpenTypeFamilyInfo _              = False

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

598 599
-- | data family declaration
isDataFamilyDecl :: TyClDecl name -> Bool
600
isDataFamilyDecl (FamDecl (FamilyDecl { fdInfo = DataFamily })) = True
601
isDataFamilyDecl _other      = False
602

Austin Seipp's avatar
Austin Seipp committed
603
-- Dealing with names
604

605
tyFamInstDeclName :: TyFamInstDecl name -> name
606 607
tyFamInstDeclName = unLoc . tyFamInstDeclLName

608
tyFamInstDeclLName :: TyFamInstDecl name -> Located name
609
tyFamInstDeclLName (TyFamInstDecl { tfid_eqn =
610
                     (L _ (TyFamEqn { tfe_tycon = ln })) })
611 612 613 614 615
  = ln

tyClDeclLName :: TyClDecl name -> Located name
tyClDeclLName (FamDecl { tcdFam = FamilyDecl { fdLName = ln } }) = ln
tyClDeclLName decl = tcdLName decl
616

617
tcdName :: TyClDecl name -> name
618 619
tcdName = unLoc . tyClDeclLName

620
tyClDeclTyVars :: TyClDecl name -> LHsQTyVars name
621 622
tyClDeclTyVars (FamDecl { tcdFam = FamilyDecl { fdTyVars = tvs } }) = tvs
tyClDeclTyVars d = tcdTyVars d
623

624 625
countTyClDecls :: [TyClDecl name] -> (Int, Int, Int, Int, Int)
        -- class, synonym decls, data, newtype, family decls
626
countTyClDecls decls
627 628 629 630
 = (count isClassDecl    decls,
    count isSynDecl      decls,  -- excluding...
    count isDataTy       decls,  -- ...family...
    count isNewTy        decls,  -- ...instances
631
    count isFamilyDecl   decls)
sof's avatar
sof committed
632
 where
633 634
   isDataTy DataDecl{ tcdDataDefn = HsDataDefn { dd_ND = DataType } } = True
   isDataTy _                                                       = False
635

636 637
   isNewTy DataDecl{ tcdDataDefn = HsDataDefn { dd_ND = NewType } } = True
   isNewTy _                                                      = False
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652

-- | Does this declaration have a complete, user-supplied kind signature?
-- See Note [Complete user-supplied kind signatures]
hsDeclHasCusk :: TyClDecl name -> Bool
hsDeclHasCusk (FamDecl { tcdFam = fam_decl }) = famDeclHasCusk fam_decl
hsDeclHasCusk (SynDecl { tcdTyVars = tyvars, tcdRhs = rhs })
  = hsTvbAllKinded tyvars && rhs_annotated rhs
  where
    rhs_annotated (L _ ty) = case ty of
      HsParTy lty  -> rhs_annotated lty
      HsKindSig {} -> True
      _            -> False
hsDeclHasCusk (DataDecl { tcdTyVars = tyvars })  = hsTvbAllKinded tyvars
hsDeclHasCusk (ClassDecl { tcdTyVars = tyvars }) = hsTvbAllKinded tyvars

Jan Stolarek's avatar
Jan Stolarek committed
653 654
-- Pretty-printing TyClDecl
-- ~~~~~~~~~~~~~~~~~~~~~~~~
655

656
instance OutputableBndr name
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
657
              => Outputable (TyClDecl name) where
658

659 660 661 662
    ppr (FamDecl { tcdFam = decl }) = ppr decl
    ppr (SynDecl { tcdLName = ltycon, tcdTyVars = tyvars, tcdRhs = rhs })
      = hang (ptext (sLit "type") <+>
              pp_vanilla_decl_head ltycon tyvars [] <+> equals)
663
          4 (ppr rhs)
664

665 666
    ppr (DataDecl { tcdLName = ltycon, tcdTyVars = tyvars, tcdDataDefn = defn })
      = pp_data_defn (pp_vanilla_decl_head ltycon tyvars) defn
667

668
    ppr (ClassDecl {tcdCtxt = context, tcdLName = lclas, tcdTyVars = tyvars,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
669
                    tcdFDs  = fds,
670 671 672
                    tcdSigs = sigs, tcdMeths = methods,
                    tcdATs = ats, tcdATDefs = at_defs})
      | null sigs && isEmptyBag methods && null ats && null at_defs -- No "where" part
673 674
      = top_matter

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
675
      | otherwise       -- Laid out
676
      = vcat [ top_matter <+> ptext (sLit "where")
677
             , nest 2 $ pprDeclList (map (pprFamilyDecl NotTopLevel . unLoc) ats ++
678
                                     map ppr_fam_deflt_eqn at_defs ++
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
679
                                     pprLHsBindsForUser methods sigs) ]
680
      where
681
        top_matter = ptext (sLit "class")
682
                     <+> pp_vanilla_decl_head lclas tyvars (unLoc context)
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
683
                     <+> pprFundeps (map unLoc fds)
684

685 686 687 688 689
instance OutputableBndr name => Outputable (TyClGroup name) where
  ppr (TyClGroup { group_tyclds = tyclds, group_roles = roles })
    = ppr tyclds $$
      ppr roles

Jan Stolarek's avatar
Jan Stolarek committed
690 691
pp_vanilla_decl_head :: OutputableBndr name
   => Located name
692
   -> LHsQTyVars name
Jan Stolarek's avatar
Jan Stolarek committed
693 694 695 696 697 698 699 700 701
   -> HsContext name
   -> SDoc
pp_vanilla_decl_head thing tyvars context
 = hsep [pprHsContext context, pprPrefixOcc (unLoc thing), ppr tyvars]

pprTyClDeclFlavour :: TyClDecl a -> SDoc
pprTyClDeclFlavour (ClassDecl {})   = ptext (sLit "class")
pprTyClDeclFlavour (SynDecl {})     = ptext (sLit "type")
pprTyClDeclFlavour (FamDecl { tcdFam = FamilyDecl { fdInfo = info }})
702
  = pprFlavour info <+> text "family"
Jan Stolarek's avatar
Jan Stolarek committed
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
pprTyClDeclFlavour (DataDecl { tcdDataDefn = HsDataDefn { dd_ND = nd } })
  = ppr nd


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

type LFamilyResultSig name = Located (FamilyResultSig name)
data FamilyResultSig name = -- see Note [FamilyResultSig]
    NoSig
  -- ^ - 'ApiAnnotation.AnnKeywordId' :

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

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

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

  | TyVarSig (LHsTyVarBndr name)
  -- ^ - 'ApiAnnotation.AnnKeywordId' :
  --             'ApiAnnotation.AnnOpenP','ApiAnnotation.AnnDcolon',
  --             'ApiAnnotation.AnnCloseP', 'ApiAnnotation.AnnEqual'

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

  deriving ( Typeable )
deriving instance (DataId name) => Data (FamilyResultSig name)

type LFamilyDecl name = Located (FamilyDecl name)
data FamilyDecl name = FamilyDecl
  { fdInfo           :: FamilyInfo name              -- type/data, closed/open
  , fdLName          :: Located name                 -- type constructor
803
  , fdTyVars         :: LHsQTyVars name              -- type variables
Jan Stolarek's avatar
Jan Stolarek committed
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
  , fdResultSig      :: LFamilyResultSig name        -- result signature
  , fdInjectivityAnn :: Maybe (LInjectivityAnn name) -- optional injectivity ann
  }
  -- ^ - '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
  deriving ( Typeable )

deriving instance (DataId id) => Data (FamilyDecl id)

type LInjectivityAnn name = Located (InjectivityAnn name)

-- | 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 name
  = InjectivityAnn (Located name) [Located name]
  -- ^ - 'ApiAnnotation.AnnKeywordId' :
  --             'ApiAnnotation.AnnRarrow', 'ApiAnnotation.AnnVbar'

  -- For details on above see note [Api annotations] in ApiAnnotation
  deriving ( Data, Typeable )

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

-- | Does this family declaration have a complete, user-supplied kind signature?
famDeclHasCusk :: FamilyDecl name -> Bool
famDeclHasCusk (FamilyDecl { fdInfo      = ClosedTypeFamily _
                           , fdTyVars    = tyvars
                           , fdResultSig = L _ resultSig })
  = hsTvbAllKinded tyvars && hasReturnKindSignature resultSig
famDeclHasCusk _ = True  -- all open families have CUSKs!

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

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

{-
Note [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.

A declaration has a CUSK if we can know its complete kind without doing any
inference, at all. Here are the rules:

 - A class or datatype is said to have a CUSK if and only if all of its type
variables are annotated. Its result kind is, by construction, Constraint or *
respectively.

 - A type synonym has a CUSK if and only if all of its type variables and its
RHS are annotated with kinds.

 - A closed type family is said to have a CUSK if and only if all of its type
variables and its return type are annotated.

 - An open type family always has a CUSK -- unannotated type variables (and
return type) default to *.
-}

891
instance (OutputableBndr name) => Outputable (FamilyDecl name) where
892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
  ppr = pprFamilyDecl TopLevel

pprFamilyDecl :: OutputableBndr name => TopLevelFlag -> FamilyDecl name -> SDoc
pprFamilyDecl top_level (FamilyDecl { fdInfo = info, fdLName = ltycon
                                    , fdTyVars = tyvars
                                    , fdResultSig = L _ result
                                    , fdInjectivityAnn = mb_inj })
  = vcat [ pprFlavour info <+> pp_top_level <+>
           pp_vanilla_decl_head ltycon tyvars [] <+>
           pp_kind <+> pp_inj <+> pp_where
         , nest 2 $ pp_eqns ]
  where
    pp_top_level = case top_level of
                     TopLevel    -> text "family"
                     NotTopLevel -> empty

    pp_kind = case result of
                NoSig            -> empty
                KindSig  kind    -> dcolon <+> ppr kind
                TyVarSig tv_bndr -> text "=" <+> ppr tv_bndr
    pp_inj = case mb_inj of
               Just (L _ (InjectivityAnn lhs rhs)) ->
914
                 hsep [ vbar, ppr lhs, text "->", hsep (map ppr rhs) ]
915 916 917 918 919 920 921 922
               Nothing -> empty
    (pp_where, pp_eqns) = case info of
      ClosedTypeFamily mb_eqns ->
        ( ptext (sLit "where")
        , case mb_eqns of
            Nothing   -> ptext (sLit "..")
            Just eqns -> vcat $ map ppr_fam_inst_eqn eqns )
      _ -> (empty, empty)
923 924

pprFlavour :: FamilyInfo name -> SDoc
925 926 927
pprFlavour DataFamily            = ptext (sLit "data")
pprFlavour OpenTypeFamily        = ptext (sLit "type")
pprFlavour (ClosedTypeFamily {}) = ptext (sLit "type")
928

929
instance Outputable (FamilyInfo name) where
930
  ppr info = pprFlavour info <+> text "family"
931

932

933

Jan Stolarek's avatar
Jan Stolarek committed
934
{- *********************************************************************
Austin Seipp's avatar
Austin Seipp committed
935
*                                                                      *
Jan Stolarek's avatar
Jan Stolarek committed
936
               Data types and data constructors
Austin Seipp's avatar
Austin Seipp committed
937
*                                                                      *
Jan Stolarek's avatar
Jan Stolarek committed
938
********************************************************************* -}
939 940 941 942

data HsDataDefn name   -- The payload of a data type defn
                       -- Used *both* for vanilla data declarations,
                       --       *and* for data family instances
Gabor Greif's avatar
Gabor Greif committed
943
  = -- | Declares a data type or newtype, giving its constructors
944 945 946 947 948 949
    -- @
    --  data/newtype T a = <constrs>
    --  data/newtype instance T [a] = <constrs>
    -- @
    HsDataDefn { dd_ND     :: NewOrData,
                 dd_ctxt   :: LHsContext name,           -- ^ Context
950
                 dd_cType  :: Maybe (Located CType),
951 952 953
                 dd_kindSig:: Maybe (LHsKind name),
                     -- ^ Optional kind signature.
                     --
954
                     -- @(Just k)@ for a GADT-style @data@,
955 956 957 958 959 960 961 962
                     -- or @data instance@ decl, with explicit kind sig
                     --
                     -- Always @Nothing@ for H98-syntax decls

                 dd_cons   :: [LConDecl name],
                     -- ^ Data constructors
                     --
                     -- For @data T a = T1 | T2 a@
Alan Zimmerman's avatar
Alan Zimmerman committed
963
                     --   the 'LConDecl's all have 'ConDeclH98'.
964
                     -- For @data T a where { T1 :: T a }@
Alan Zimmerman's avatar
Alan Zimmerman committed
965
                     --   the 'LConDecls' all have 'ConDeclGADT'.
966

967
                 dd_derivs :: HsDeriving name  -- ^ Optional 'deriving' claues
968 969

             -- For details on above see note [Api annotations] in ApiAnnotation
Alan Zimmerman's avatar
Alan Zimmerman committed
970
   }
971 972
    deriving( Typeable )
deriving instance (DataId id) => Data (HsDataDefn id)
973