HsDecls.hs 74.3 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,
49
  flattenRuleDecls, pprFullRuleName,
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
import HsBinds
92
import HsTypes
93
import HsDoc
94
import TyCon
95
import Name
96
import BasicTypes
97
import Coercion
98
import ForeignCall
99 100
import PlaceHolder ( PostTc,PostRn,PlaceHolder(..),DataId )
import NameSet
101 102

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

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

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

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

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

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

153 154

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

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

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

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

183
        hs_derivds :: [LDerivDecl id],
184

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

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

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

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

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

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

258
instance OutputableBndr name => Outputable (HsDecl name) where
259 260 261 262 263 264 265 266
    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
267
    ppr (VectD vect)            = ppr vect
Ian Lynagh's avatar
Ian Lynagh committed
268
    ppr (WarningD wd)           = ppr wd
269
    ppr (AnnD ad)               = ppr ad
270 271
    ppr (SpliceD dd)            = ppr dd
    ppr (DocD doc)              = ppr doc
272
    ppr (RoleAnnotD ra)         = ppr ra
273 274 275

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
276 277
                   hs_tyclds = tycl_decls,
                   hs_instds = inst_decls,
278
                   hs_derivds = deriv_decls,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
279 280 281 282 283 284 285
                   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 })
286 287
        = vcat_mb empty
            [ppr_ds fix_decls, ppr_ds default_decls,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
288 289 290
             ppr_ds deprec_decls, ppr_ds ann_decls,
             ppr_ds rule_decls,
             ppr_ds vect_decls,
291 292
             if isEmptyValBinds val_decls
                then Nothing
293
                else Just (ppr val_decls),
294
             ppr_ds (tyClGroupConcat tycl_decls),
295
             ppr_ds inst_decls,
296
             ppr_ds deriv_decls,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
297 298
             ppr_ds foreign_decls]
        where
299
          ppr_ds :: Outputable a => [a] -> Maybe SDoc
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
300 301
          ppr_ds [] = Nothing
          ppr_ds ds = Just (vcat (map ppr ds))
302 303

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 - The renamer renames it to a Name

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

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

440
  - The occurrence name it chooses is derived from the instance decl (just for
441 442
    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
443 444
        instance Foo [Int]  where ...
        instance Foo [Bool] where ...
445 446
    These might both be dFooList

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

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

461 462
  - 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
463
-}
464

465 466
type LTyClDecl name = Located (TyClDecl name)

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

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

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

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

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

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

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

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

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

538 539 540 541 542 543 544 545
 -- 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] }
546 547
    deriving (Typeable)
deriving instance (DataId id) => Data (TyClGroup id)
548 549 550 551 552 553 554

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
555 556
-- Simple classifiers for TyClDecl
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
557

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

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

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

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

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

587 588 589 590 591 592 593 594 595 596
-- | 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

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

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

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

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

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

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

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

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

635 636
   isNewTy DataDecl{ tcdDataDefn = HsDataDefn { dd_ND = NewType } } = True
   isNewTy _                                                      = False
637 638 639

-- | Does this declaration have a complete, user-supplied kind signature?
-- See Note [Complete user-supplied kind signatures]
640
hsDeclHasCusk :: TyClDecl Name -> Bool
641 642 643 644 645 646 647 648 649 650 651
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
652 653
-- Pretty-printing TyClDecl
-- ~~~~~~~~~~~~~~~~~~~~~~~~
654

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

658 659 660 661
    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)
662
          4 (ppr rhs)
663

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

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

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

684 685 686 687 688
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
689 690
pp_vanilla_decl_head :: OutputableBndr name
   => Located name
691
   -> LHsQTyVars name
Jan Stolarek's avatar
Jan Stolarek committed
692 693 694 695 696 697 698 699 700
   -> 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 }})
701
  = pprFlavour info <+> text "family"
Jan Stolarek's avatar
Jan Stolarek committed
702 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
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
802
  , fdTyVars         :: LHsQTyVars name              -- type variables
Jan Stolarek's avatar
Jan Stolarek committed
803 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
  , 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 *.
-}

890
instance (OutputableBndr name) => Outputable (FamilyDecl name) where
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
  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)) ->
913
                 hsep [ vbar, ppr lhs, text "->", hsep (map ppr rhs) ]
914 915 916 917 918 919 920 921
               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)
922 923

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

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

931

932

Jan Stolarek's avatar
Jan Stolarek committed
933
{- *********************************************************************
Austin Seipp's avatar
Austin Seipp committed
934
*                                                                      *
Jan Stolarek's avatar
Jan Stolarek committed
935
               Data types and data constructors
Austin Seipp's avatar
Austin Seipp committed
936
*                                                                      *
Jan Stolarek's avatar
Jan Stolarek committed
937
********************************************************************* -}