IfaceSyn.hs 72.9 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, 1993-1998
-}
5

6
{-# LANGUAGE CPP #-}
Ian Lynagh's avatar
Ian Lynagh committed
7

8
module IfaceSyn (
dterei's avatar
dterei committed
9
        module IfaceType,
10

11
        IfaceDecl(..), IfaceFamTyConFlav(..), IfaceClassOp(..), IfaceAT(..),
12
        IfaceConDecl(..), IfaceConDecls(..), IfaceEqSpec,
13
        IfaceExpr(..), IfaceAlt, IfaceLetBndr(..),
dterei's avatar
dterei committed
14 15 16
        IfaceBinding(..), IfaceConAlt(..),
        IfaceIdInfo(..), IfaceIdDetails(..), IfaceUnfolding(..),
        IfaceInfoItem(..), IfaceRule(..), IfaceAnnotation(..), IfaceAnnTarget,
17
        IfaceClsInst(..), IfaceFamInst(..), IfaceTickish(..),
18 19 20
        IfaceBang(..),
        IfaceSrcBang(..), SrcUnpackedness(..), SrcStrictness(..),
        IfaceAxBranch(..),
21
        IfaceTyConParent(..),
22

dterei's avatar
dterei committed
23
        -- Misc
24
        ifaceDeclImplicitBndrs, visibleIfConDecls,
Adam Gundry's avatar
Adam Gundry committed
25
        ifaceConDeclFields,
26
        ifaceDeclFingerprints,
27

28
        -- Free Names
29
        freeNamesIfDecl, freeNamesIfRule, freeNamesIfFamInst,
30

dterei's avatar
dterei committed
31
        -- Pretty printing
32 33 34
        pprIfaceExpr,
        pprIfaceDecl,
        ShowSub(..), ShowHowMuch(..)
35 36 37 38 39
    ) where

#include "HsVersions.h"

import IfaceType
40
import PprCore()            -- Printing DFunArgs
41
import Demand
Simon Marlow's avatar
Simon Marlow committed
42
import Class
Adam Gundry's avatar
Adam Gundry committed
43
import FieldLabel
dterei's avatar
dterei committed
44
import NameSet
Adam Gundry's avatar
Adam Gundry committed
45
import CoAxiom ( BranchIndex )
Simon Marlow's avatar
Simon Marlow committed
46 47 48 49
import Name
import CostCentre
import Literal
import ForeignCall
50
import Annotations( AnnPayload, AnnTarget )
51
import BasicTypes
52 53
import Outputable
import FastString
54
import Module
Peter Wortmann's avatar
Peter Wortmann committed
55
import SrcLoc
56 57
import Fingerprint
import Binary
58
import BooleanFormula ( BooleanFormula, pprBooleanFormula, isTrue )
59
import HsBinds
Jan Stolarek's avatar
Jan Stolarek committed
60
import TyCon ( Role (..), Injectivity(..) )
61
import StaticFlags (opt_PprStyle_Debug)
Jan Stolarek's avatar
Jan Stolarek committed
62
import Util( filterOut, filterByList )
63
import InstEnv
64
import DataCon (SrcStrictness(..), SrcUnpackedness(..))
65
import Lexeme (isLexSym)
66

67
import Control.Monad
68
import System.IO.Unsafe
Adam Gundry's avatar
Adam Gundry committed
69
import Data.List (find)
70
import Data.Maybe (isJust)
71

72 73
infixl 3 &&&

Austin Seipp's avatar
Austin Seipp committed
74 75 76
{-
************************************************************************
*                                                                      *
77
                    Declarations
Austin Seipp's avatar
Austin Seipp committed
78 79 80
*                                                                      *
************************************************************************
-}
81

82 83 84 85
type IfaceTopBndr = OccName
  -- It's convenient to have an OccName in the IfaceSyn, altough in each
  -- case the namespace is implied by the context. However, having an
  -- OccNames makes things like ifaceDeclImplicitBndrs and ifaceDeclFingerprints
86 87 88
  -- very convenient.
  --
  -- We don't serialise the namespace onto the disk though; rather we
89 90
  -- drop it when serialising and add it back in when deserialising.

dterei's avatar
dterei committed
91
data IfaceDecl
92
  = IfaceId { ifName      :: IfaceTopBndr,
dterei's avatar
dterei committed
93 94 95 96
              ifType      :: IfaceType,
              ifIdDetails :: IfaceIdDetails,
              ifIdInfo    :: IfaceIdInfo }

97
  | IfaceData { ifName       :: IfaceTopBndr,        -- Type constructor
98
                ifCType      :: Maybe CType,    -- C type for CAPI FFI
dterei's avatar
dterei committed
99
                ifTyVars     :: [IfaceTvBndr],  -- Type variables
100
                ifRoles      :: [Role],         -- Roles
dterei's avatar
dterei committed
101
                ifCtxt       :: IfaceContext,   -- The "stupid theta"
102
                ifCons       :: IfaceConDecls,  -- Includes new/data/data family info
dterei's avatar
dterei committed
103
                ifRec        :: RecFlag,        -- Recursive or not?
104
                ifPromotable :: Bool,           -- Promotable to kind level?
dterei's avatar
dterei committed
105 106
                ifGadtSyntax :: Bool,           -- True <=> declared using
                                                -- GADT syntax
107 108
                ifParent     :: IfaceTyConParent -- The axiom, for a newtype,
                                                 -- or data/newtype family instance
109
    }
110

111 112 113 114 115 116 117 118 119
  | IfaceSynonym { ifName    :: IfaceTopBndr,      -- Type constructor
                   ifTyVars  :: [IfaceTvBndr],     -- Type variables
                   ifRoles   :: [Role],            -- Roles
                   ifSynKind :: IfaceKind,         -- Kind of the *rhs* (not of
                                                   -- the tycon)
                   ifSynRhs  :: IfaceType }

  | IfaceFamily  { ifName    :: IfaceTopBndr,      -- Type constructor
                   ifTyVars  :: [IfaceTvBndr],     -- Type variables
Jan Stolarek's avatar
Jan Stolarek committed
120 121 122
                   ifResVar  :: Maybe IfLclName,   -- Result variable name, used
                                                   -- only for pretty-printing
                                                   -- with --show-iface
123 124
                   ifFamKind :: IfaceKind,         -- Kind of the *rhs* (not of
                                                   -- the tycon)
Jan Stolarek's avatar
Jan Stolarek committed
125 126
                   ifFamFlav :: IfaceFamTyConFlav,
                   ifFamInj  :: Injectivity }      -- injectivity information
127

128
  | IfaceClass { ifCtxt    :: IfaceContext,             -- Superclasses
129 130 131 132
                 ifName    :: IfaceTopBndr,             -- Name of the class TyCon
                 ifTyVars  :: [IfaceTvBndr],            -- Type variables
                 ifRoles   :: [Role],                   -- Roles
                 ifFDs     :: [FunDep FastString],      -- Functional dependencies
133 134 135
                 ifATs     :: [IfaceAT],                -- Associated type families
                 ifSigs    :: [IfaceClassOp],           -- Method signatures
                 ifMinDef  :: BooleanFormula IfLclName, -- Minimal complete definition
136 137
                 ifRec     :: RecFlag                   -- Is newtype/datatype associated
                                                        --   with the class recursive?
138 139
    }

140
  | IfaceAxiom { ifName       :: IfaceTopBndr,        -- Axiom name
141
                 ifTyCon      :: IfaceTyCon,     -- LHS TyCon
142
                 ifRole       :: Role,           -- Role of axiom
143 144
                 ifAxBranches :: [IfaceAxBranch] -- Branches
    }
145

146
  | IfacePatSyn { ifName          :: IfaceTopBndr,           -- Name of the pattern synonym
Gergő Érdi's avatar
Gergő Érdi committed
147
                  ifPatIsInfix    :: Bool,
148 149
                  ifPatMatcher    :: (IfExtName, Bool),
                  ifPatBuilder    :: Maybe (IfExtName, Bool),
150 151
                  -- Everything below is redundant,
                  -- but needed to implement pprIfaceDecl
Gergő Érdi's avatar
Gergő Érdi committed
152 153 154 155
                  ifPatUnivTvs    :: [IfaceTvBndr],
                  ifPatExTvs      :: [IfaceTvBndr],
                  ifPatProvCtxt   :: IfaceContext,
                  ifPatReqCtxt    :: IfaceContext,
156
                  ifPatArgs       :: [IfaceType],
Matthew Pickering's avatar
Matthew Pickering committed
157 158
                  ifPatTy         :: IfaceType,
                  ifFieldLabels   :: [FieldLabel] }
Gergő Érdi's avatar
Gergő Érdi committed
159 160


161 162 163 164 165
data IfaceTyConParent
  = IfNoParent
  | IfDataInstance IfExtName
                   IfaceTyCon
                   IfaceTcArgs
166

167
data IfaceFamTyConFlav
168
  = IfaceOpenSynFamilyTyCon
169 170 171
  | IfaceClosedSynFamilyTyCon (Maybe (IfExtName, [IfaceAxBranch]))
    -- ^ Name of associated axiom and branches for pretty printing purposes,
    -- or 'Nothing' for an empty closed family without an axiom
172
  | IfaceAbstractClosedSynFamilyTyCon
173
  | IfaceBuiltInSynFamTyCon -- for pretty printing purposes only
174

175
data IfaceClassOp = IfaceClassOp IfaceTopBndr DefMethSpec IfaceType
dterei's avatar
dterei committed
176 177 178
        -- Nothing    => no default method
        -- Just False => ordinary polymorphic default method
        -- Just True  => generic default method
179

180 181 182 183
data IfaceAT = IfaceAT  -- See Class.ClassATItem
                  IfaceDecl          -- The associated type declaration
                  (Maybe IfaceType)  -- Default associated type instance, if any

184

185
-- This is just like CoAxBranch
186
data IfaceAxBranch = IfaceAxBranch { ifaxbTyVars  :: [IfaceTvBndr]
187
                                   , ifaxbLHS     :: IfaceTcArgs
188
                                   , ifaxbRoles   :: [Role]
189 190 191
                                   , ifaxbRHS     :: IfaceType
                                   , ifaxbIncomps :: [BranchIndex] }
                                     -- See Note [Storing compatibility] in CoAxiom
192

193
data IfaceConDecls
Adam Gundry's avatar
Adam Gundry committed
194
  = IfAbstractTyCon Bool                          -- c.f TyCon.AbstractTyCon
195
  | IfDataFamTyCon                                -- Data family
Adam Gundry's avatar
Adam Gundry committed
196 197 198 199 200 201 202 203
  | IfDataTyCon [IfaceConDecl] Bool [FieldLabelString] -- Data type decls
  | IfNewTyCon  IfaceConDecl   Bool [FieldLabelString] -- Newtype decls

-- For IfDataTyCon and IfNewTyCon we store:
--  * the data constructor(s);
--  * a boolean indicating whether DuplicateRecordFields was enabled
--    at the definition site; and
--  * a list of field labels.
204

dterei's avatar
dterei committed
205
data IfaceConDecl
206
  = IfCon {
207
        ifConOcc     :: IfaceTopBndr,                -- Constructor name
dterei's avatar
dterei committed
208 209
        ifConWrapper :: Bool,                   -- True <=> has a wrapper
        ifConInfix   :: Bool,                   -- True <=> declared infix
210 211 212 213 214 215 216

        -- The universal type variables are precisely those
        -- of the type constructor of this data constructor
        -- This is *easy* to guarantee when creating the IfCon
        -- but it's not so easy for the original TyCon/DataCon
        -- So this guarantee holds for IfaceConDecl, but *not* for DataCon

217 218 219 220 221 222 223 224 225 226
        ifConExTvs   :: [IfaceTvBndr],      -- Existential tyvars
        ifConEqSpec  :: IfaceEqSpec,        -- Equality constraints
        ifConCtxt    :: IfaceContext,       -- Non-stupid context
        ifConArgTys  :: [IfaceType],        -- Arg types
        ifConFields  :: [IfaceTopBndr],     -- ...ditto... (field labels)
        ifConStricts :: [IfaceBang],
          -- Empty (meaning all lazy),
          -- or 1-1 corresp with arg tys
          -- See Note [Bangs on imported data constructors] in MkId
        ifConSrcStricts :: [IfaceSrcBang] } -- empty meaning no src stricts
dterei's avatar
dterei committed
227

228
type IfaceEqSpec = [(IfLclName,IfaceType)]
229

230 231 232
-- | This corresponds to an HsImplBang; that is, the final
-- implementation decision about the data constructor arg
data IfaceBang
233 234
  = IfNoBang | IfStrict | IfUnpack | IfUnpackCo IfaceCoercion

235 236 237 238
-- | This corresponds to HsSrcBang
data IfaceSrcBang
  = IfSrcBang SrcUnpackedness SrcStrictness

239 240 241 242 243
data IfaceClsInst
  = IfaceClsInst { ifInstCls  :: IfExtName,                -- See comments with
                   ifInstTys  :: [Maybe IfaceTyCon],       -- the defn of ClsInst
                   ifDFun     :: IfExtName,                -- The dfun
                   ifOFlag    :: OverlapFlag,              -- Overlap flag
244
                   ifInstOrph :: IsOrphan }                -- See Note [Orphans] in InstEnv
dterei's avatar
dterei committed
245 246 247 248 249 250
        -- There's always a separate IfaceDecl for the DFun, which gives
        -- its IdInfo with its full type and version number.
        -- The instance declarations taken together have a version number,
        -- and we don't want that to wobble gratuitously
        -- If this instance decl is *used*, we'll record a usage on the dfun;
        -- and if the head does not change it won't be used if it wasn't before
251

252
-- The ifFamInstTys field of IfaceFamInst contains a list of the rough
253
-- match types
254
data IfaceFamInst
255
  = IfaceFamInst { ifFamInstFam      :: IfExtName            -- Family name
256
                 , ifFamInstTys      :: [Maybe IfaceTyCon]   -- See above
257
                 , ifFamInstAxiom    :: IfExtName            -- The axiom
258
                 , ifFamInstOrph     :: IsOrphan             -- Just like IfaceClsInst
dterei's avatar
dterei committed
259
                 }
260

261
data IfaceRule
dterei's avatar
dterei committed
262 263 264 265 266 267 268 269
  = IfaceRule {
        ifRuleName   :: RuleName,
        ifActivation :: Activation,
        ifRuleBndrs  :: [IfaceBndr],    -- Tyvars and term vars
        ifRuleHead   :: IfExtName,      -- Head of lhs
        ifRuleArgs   :: [IfaceExpr],    -- Args of LHS
        ifRuleRhs    :: IfaceExpr,
        ifRuleAuto   :: Bool,
270
        ifRuleOrph   :: IsOrphan   -- Just like IfaceClsInst
271 272
    }

273 274 275
data IfaceAnnotation
  = IfaceAnnotation {
        ifAnnotatedTarget :: IfaceAnnTarget,
276
        ifAnnotatedValue  :: AnnPayload
277 278 279 280
  }

type IfaceAnnTarget = AnnTarget OccName

281
-- Here's a tricky case:
282 283
--   * Compile with -O module A, and B which imports A.f
--   * Change function f in A, and recompile without -O
284
--   * When we read in old A.hi we read in its IdInfo (as a thunk)
dterei's avatar
dterei committed
285 286 287
--      (In earlier GHCs we used to drop IdInfo immediately on reading,
--       but we do not do that now.  Instead it's discarded when the
--       ModIface is read into the various decl pools.)
Gabor Greif's avatar
typo  
Gabor Greif committed
288
--   * The version comparison sees that new (=NoInfo) differs from old (=HasInfo *)
dterei's avatar
dterei committed
289
--      and so gives a new version.
290

291 292 293 294
data IfaceIdInfo
  = NoInfo                      -- When writing interface file without -O
  | HasInfo [IfaceInfoItem]     -- Has info, and here it is

295
data IfaceInfoItem
296 297 298 299 300
  = HsArity         Arity
  | HsStrictness    StrictSig
  | HsInline        InlinePragma
  | HsUnfold        Bool             -- True <=> isStrongLoopBreaker is true
                    IfaceUnfolding   -- See Note [Expose recursive functions]
301
  | HsNoCafRefs
302

303 304 305
-- NB: Specialisations and rules come in separately and are
-- only later attached to the Id.  Partial reason: some are orphans.

dterei's avatar
dterei committed
306
data IfaceUnfolding
307
  = IfCoreUnfold Bool IfaceExpr -- True <=> INLINABLE, False <=> regular unfolding
308 309
                                -- Possibly could eliminate the Bool here, the information
                                -- is also in the InlinePragma.
310

dterei's avatar
dterei committed
311
  | IfCompulsory IfaceExpr      -- Only used for default methods, in fact
312

313
  | IfInlineRule Arity          -- INLINE pragmas
dterei's avatar
dterei committed
314 315 316
                 Bool           -- OK to inline even if *un*-saturated
                 Bool           -- OK to inline even if context is boring
                 IfaceExpr
317

318
  | IfDFunUnfold [IfaceBndr] [IfaceExpr]
319

320

321 322 323 324
-- We only serialise the IdDetails of top-level Ids, and even then
-- we only need a very limited selection.  Notably, none of the
-- implicit ones are needed here, because they are not put it
-- interface files
325

326 327
data IfaceIdDetails
  = IfVanillaId
Matthew Pickering's avatar
Matthew Pickering committed
328
  | IfRecSelId (Either IfaceTyCon IfaceDecl) Bool
329
  | IfDFunId
330

Austin Seipp's avatar
Austin Seipp committed
331
{-
332 333
Note [Versioning of instances]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
334
See [http://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/RecompilationAvoidance#Instances]
335

336

Austin Seipp's avatar
Austin Seipp committed
337 338
************************************************************************
*                                                                      *
339
                Functions over declarations
Austin Seipp's avatar
Austin Seipp committed
340 341 342
*                                                                      *
************************************************************************
-}
343 344 345

visibleIfConDecls :: IfaceConDecls -> [IfaceConDecl]
visibleIfConDecls (IfAbstractTyCon {}) = []
346
visibleIfConDecls IfDataFamTyCon       = []
Adam Gundry's avatar
Adam Gundry committed
347 348 349 350 351 352
visibleIfConDecls (IfDataTyCon cs _ _) = cs
visibleIfConDecls (IfNewTyCon c   _ _) = [c]

ifaceConDeclFields :: IfaceConDecls -> [FieldLbl OccName]
ifaceConDeclFields x = case x of
    IfAbstractTyCon {}              -> []
353
    IfDataFamTyCon  {}              -> []
Adam Gundry's avatar
Adam Gundry committed
354 355 356 357 358
    IfDataTyCon cons is_over labels -> map (help cons  is_over) labels
    IfNewTyCon  con  is_over labels -> map (help [con] is_over) labels
  where
    help (dc:_) is_over lbl = mkFieldLabelOccs lbl (ifConOcc dc) is_over
    help [] _ _ = error "ifaceConDeclFields: data type has no constructors!"
359

360
ifaceDeclImplicitBndrs :: IfaceDecl -> [OccName]
361 362 363
--  *Excludes* the 'main' name, but *includes* the implicitly-bound names
-- Deeply revolting, because it has to predict what gets bound,
-- especially the question of whether there's a wrapper for a datacon
364
-- See Note [Implicit TyThings] in HscTypes
365

366 367 368 369 370
-- N.B. the set of names returned here *must* match the set of
-- TyThings returned by HscTypes.implicitTyThings, in the sense that
-- TyThing.getOccName should define a bijection between the two lists.
-- This invariant is used in LoadIface.loadDecl (see note [Tricky iface loop])
-- The order of the list does not matter.
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
ifaceDeclImplicitBndrs IfaceData {ifCons = IfAbstractTyCon {}}  = []

-- Newtype
ifaceDeclImplicitBndrs (IfaceData {ifName = tc_occ,
                              ifCons = IfNewTyCon (IfCon { ifConOcc = con_occ }) _ _})
  =   -- implicit newtype coercion
    (mkNewTyCoOcc tc_occ) : -- JPM: newtype coercions shouldn't be implicit
      -- data constructor and worker (newtypes don't have a wrapper)
    [con_occ, mkDataConWorkerOcc con_occ]


ifaceDeclImplicitBndrs (IfaceData {ifName = _tc_occ,
                              ifCons = IfDataTyCon cons _ _ })
  = -- for each data constructor in order,
    --    data constructor, worker, and (possibly) wrapper
    concatMap dc_occs cons
  where
    dc_occs con_decl
        | has_wrapper = [con_occ, work_occ, wrap_occ]
        | otherwise   = [con_occ, work_occ]
        where
          con_occ  = ifConOcc con_decl            -- DataCon namespace
          wrap_occ = mkDataConWrapperOcc con_occ  -- Id namespace
          work_occ = mkDataConWorkerOcc con_occ   -- Id namespace
          has_wrapper = ifConWrapper con_decl     -- This is the reason for
                                                  -- having the ifConWrapper field!

ifaceDeclImplicitBndrs (IfaceClass {ifCtxt = sc_ctxt, ifName = cls_tc_occ,
                               ifSigs = sigs, ifATs = ats })
batterseapower's avatar
batterseapower committed
400
  = --   (possibly) newtype coercion
401 402 403 404 405 406
    co_occs ++
    --    data constructor (DataCon namespace)
    --    data worker (Id namespace)
    --    no wrapper (class dictionaries never have a wrapper)
    [dc_occ, dcww_occ] ++
    -- associated types
407
    [ifName at | IfaceAT at _ <- ats ] ++
408
    -- superclass selectors
batterseapower's avatar
batterseapower committed
409
    [mkSuperDictSelOcc n cls_tc_occ | n <- [1..n_ctxt]] ++
410 411 412 413 414
    -- operation selectors
    [op | IfaceClassOp op  _ _ <- sigs]
  where
    n_ctxt = length sc_ctxt
    n_sigs = length sigs
batterseapower's avatar
batterseapower committed
415
    co_occs | is_newtype = [mkNewTyCoOcc cls_tc_occ]
dterei's avatar
dterei committed
416
            | otherwise  = []
417
    dcww_occ = mkDataConWorkerOcc dc_occ
batterseapower's avatar
batterseapower committed
418
    dc_occ = mkClassDataConOcc cls_tc_occ
dterei's avatar
dterei committed
419
    is_newtype = n_sigs + n_ctxt == 1 -- Sigh
420

421
ifaceDeclImplicitBndrs _ = []
422

423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
-- -----------------------------------------------------------------------------
-- The fingerprints of an IfaceDecl

       -- We better give each name bound by the declaration a
       -- different fingerprint!  So we calculate the fingerprint of
       -- each binder by combining the fingerprint of the whole
       -- declaration with the name of the binder. (#5614, #7215)
ifaceDeclFingerprints :: Fingerprint -> IfaceDecl -> [(OccName,Fingerprint)]
ifaceDeclFingerprints hash decl
  = (ifName decl, hash) :
    [ (occ, computeFingerprint' (hash,occ))
    | occ <- ifaceDeclImplicitBndrs decl ]
  where
     computeFingerprint' =
       unsafeDupablePerformIO
        . computeFingerprint (panic "ifaceDeclFingerprints")
439

Austin Seipp's avatar
Austin Seipp committed
440 441 442
{-
************************************************************************
*                                                                      *
443
                Expressions
Austin Seipp's avatar
Austin Seipp committed
444 445 446
*                                                                      *
************************************************************************
-}
447 448 449 450 451 452

data IfaceExpr
  = IfaceLcl    IfLclName
  | IfaceExt    IfExtName
  | IfaceType   IfaceType
  | IfaceCo     IfaceCoercion
453
  | IfaceTuple  TupleSort [IfaceExpr]   -- Saturated; type arguments omitted
454
  | IfaceLam    IfaceLamBndr IfaceExpr
455 456
  | IfaceApp    IfaceExpr IfaceExpr
  | IfaceCase   IfaceExpr IfLclName [IfaceAlt]
457
  | IfaceECase  IfaceExpr IfaceType     -- See Note [Empty case alternatives]
458
  | IfaceLet    IfaceBinding  IfaceExpr
459 460 461 462 463 464 465 466
  | IfaceCast   IfaceExpr IfaceCoercion
  | IfaceLit    Literal
  | IfaceFCall  ForeignCall IfaceType
  | IfaceTick   IfaceTickish IfaceExpr    -- from Tick tickish E

data IfaceTickish
  = IfaceHpcTick Module Int                -- from HpcTick x
  | IfaceSCC     CostCentre Bool Bool      -- from ProfNote
Peter Wortmann's avatar
Peter Wortmann committed
467
  | IfaceSource  RealSrcSpan String        -- from SourceNote
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
  -- no breakpoints: we never export these into interface files

type IfaceAlt = (IfaceConAlt, [IfLclName], IfaceExpr)
        -- Note: IfLclName, not IfaceBndr (and same with the case binder)
        -- We reconstruct the kind/type of the thing from the context
        -- thus saving bulk in interface files

data IfaceConAlt = IfaceDefault
                 | IfaceDataAlt IfExtName
                 | IfaceLitAlt Literal

data IfaceBinding
  = IfaceNonRec IfaceLetBndr IfaceExpr
  | IfaceRec    [(IfaceLetBndr, IfaceExpr)]

-- IfaceLetBndr is like IfaceIdBndr, but has IdInfo too
-- It's used for *non-top-level* let/rec binders
-- See Note [IdInfo on nested let-bindings]
data IfaceLetBndr = IfLetBndr IfLclName IfaceType IfaceIdInfo

Austin Seipp's avatar
Austin Seipp committed
488
{-
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
Note [Empty case alternatives]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In IfaceSyn an IfaceCase does not record the types of the alternatives,
unlike CorSyn Case.  But we need this type if the alternatives are empty.
Hence IfaceECase.  See Note [Empty case alternatives] in CoreSyn.

Note [Expose recursive functions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For supercompilation we want to put *all* unfoldings in the interface
file, even for functions that are recursive (or big).  So we need to
know when an unfolding belongs to a loop-breaker so that we can refrain
from inlining it (except during supercompilation).

Note [IdInfo on nested let-bindings]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Occasionally we want to preserve IdInfo on nested let bindings. The one
that came up was a NOINLINE pragma on a let-binding inside an INLINE
function.  The user (Duncan Coutts) really wanted the NOINLINE control
to cross the separate compilation boundary.

In general we retain all info that is left by CoreTidy.tidyLetBndr, since
that is what is seen by importing module with --make


Austin Seipp's avatar
Austin Seipp committed
513 514
************************************************************************
*                                                                      *
515
              Printing IfaceDecl
Austin Seipp's avatar
Austin Seipp committed
516 517 518
*                                                                      *
************************************************************************
-}
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541

pprAxBranch :: SDoc -> IfaceAxBranch -> SDoc
-- The TyCon might be local (just an OccName), or this might
-- be a branch for an imported TyCon, so it would be an ExtName
-- So it's easier to take an SDoc here
pprAxBranch pp_tc (IfaceAxBranch { ifaxbTyVars = tvs
                                  , ifaxbLHS = pat_tys
                                  , ifaxbRHS = rhs
                                  , ifaxbIncomps = incomps })
  = hang (pprUserIfaceForAll tvs)
       2 (hang pp_lhs 2 (equals <+> ppr rhs))
    $+$
    nest 2 maybe_incomps
  where
    pp_lhs = hang pp_tc 2 (pprParendIfaceTcArgs pat_tys)
    maybe_incomps = ppUnless (null incomps) $ parens $
                    ptext (sLit "incompatible indices:") <+> ppr incomps

instance Outputable IfaceAnnotation where
  ppr (IfaceAnnotation target value) = ppr target <+> colon <+> ppr value

instance HasOccName IfaceClassOp where
  occName (IfaceClassOp n _ _) = n
542

543 544
instance HasOccName IfaceConDecl where
  occName = ifConOcc
545

546 547 548
instance HasOccName IfaceDecl where
  occName = ifName

549
instance Outputable IfaceDecl where
550 551
  ppr = pprIfaceDecl showAll

552 553 554 555 556 557 558 559 560
{-
Note [Minimal complete definition] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The minimal complete definition should only be included if a complete
class definition is shown. Since the minimal complete definition is
anonymous we can't reuse the same mechanism that is used for the
filtering of method signatures. Instead we just check if anything at all is
filtered and hide it in that case.
-}

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
data ShowSub
  = ShowSub
      { ss_ppr_bndr :: OccName -> SDoc  -- Pretty-printer for binders in IfaceDecl
                                        -- See Note [Printing IfaceDecl binders]
      , ss_how_much :: ShowHowMuch }

data ShowHowMuch
  = ShowHeader   -- Header information only, not rhs
  | ShowSome [OccName]    -- []     <=> Print all sub-components
                          -- (n:ns) <=> print sub-component 'n' with ShowSub=ns
                          --            elide other sub-components to "..."
                          -- May 14: the list is max 1 element long at the moment
  | ShowIface    -- Everything including GHC-internal information (used in --show-iface)

showAll :: ShowSub
showAll = ShowSub { ss_how_much = ShowIface, ss_ppr_bndr = ppr }

ppShowIface :: ShowSub -> SDoc -> SDoc
ppShowIface (ShowSub { ss_how_much = ShowIface }) doc = doc
580
ppShowIface _                                     _   = Outputable.empty
581

582 583 584 585 586 587
-- show if all sub-components or the complete interface is shown
ppShowAllSubs :: ShowSub -> SDoc -> SDoc -- Note [Minimal complete definition]
ppShowAllSubs (ShowSub { ss_how_much = ShowSome [] }) doc = doc
ppShowAllSubs (ShowSub { ss_how_much = ShowIface }) doc = doc
ppShowAllSubs _                                      _   = Outputable.empty

588
ppShowRhs :: ShowSub -> SDoc -> SDoc
589
ppShowRhs (ShowSub { ss_how_much = ShowHeader }) _   = Outputable.empty
590 591 592 593 594 595
ppShowRhs _                                      doc = doc

showSub :: HasOccName n => ShowSub -> n -> Bool
showSub (ShowSub { ss_how_much = ShowHeader })     _     = False
showSub (ShowSub { ss_how_much = ShowSome (n:_) }) thing = n == occName thing
showSub (ShowSub { ss_how_much = _ })              _     = True
596

Austin Seipp's avatar
Austin Seipp committed
597
{-
598 599 600 601 602 603 604
Note [Printing IfaceDecl binders]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The binders in an IfaceDecl are just OccNames, so we don't know what module they
come from.  But when we pretty-print a TyThing by converting to an IfaceDecl
(see PprTyThing), the TyThing may come from some other module so we really need
the module qualifier.  We solve this by passing in a pretty-printer for the
binders.
605

606 607
When printing an interface file (--show-iface), we want to print
everything unqualified, so we can just print the OccName directly.
Austin Seipp's avatar
Austin Seipp committed
608
-}
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623

ppr_trim :: [Maybe SDoc] -> [SDoc]
-- Collapse a group of Nothings to a single "..."
ppr_trim xs
  = snd (foldr go (False, []) xs)
  where
    go (Just doc) (_,     so_far) = (False, doc : so_far)
    go Nothing    (True,  so_far) = (True, so_far)
    go Nothing    (False, so_far) = (True, ptext (sLit "...") : so_far)

isIfaceDataInstance :: IfaceTyConParent -> Bool
isIfaceDataInstance IfNoParent = False
isIfaceDataInstance _          = True

pprIfaceDecl :: ShowSub -> IfaceDecl -> SDoc
624 625
-- NB: pprIfaceDecl is also used for pretty-printing TyThings in GHCi
--     See Note [Pretty-printing TyThings] in PprTyThing
626
pprIfaceDecl ss (IfaceData { ifName = tycon, ifCType = ctype,
627
                             ifCtxt = context, ifTyVars = tc_tyvars,
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
                             ifRoles = roles, ifCons = condecls,
                             ifParent = parent, ifRec = isrec,
                             ifGadtSyntax = gadt,
                             ifPromotable = is_prom })

  | gadt_style = vcat [ pp_roles
                      , pp_nd <+> pp_lhs <+> pp_where
                      , nest 2 (vcat pp_cons)
                      , nest 2 $ ppShowIface ss pp_extra ]
  | otherwise  = vcat [ pp_roles
                      , hang (pp_nd <+> pp_lhs) 2 (add_bars pp_cons)
                      , nest 2 $ ppShowIface ss pp_extra ]
  where
    is_data_instance = isIfaceDataInstance parent

    gadt_style = gadt || any (not . isVanillaIfaceConDecl) cons
    cons       = visibleIfConDecls condecls
    pp_where   = ppWhen (gadt_style && not (null cons)) $ ptext (sLit "where")
    pp_cons    = ppr_trim (map show_con cons) :: [SDoc]

    pp_lhs = case parent of
649
               IfNoParent -> pprIfaceDeclHead context ss tycon tc_tyvars
650 651 652
               _          -> ptext (sLit "instance") <+> pprIfaceTyConParent parent

    pp_roles
653
      | is_data_instance = Outputable.empty
654
      | otherwise        = pprRoles (== Representational) (pprPrefixIfDeclBndr ss tycon)
655
                                    tc_tyvars roles
656 657 658
            -- Don't display roles for data family instances (yet)
            -- See discussion on Trac #8672.

659
    add_bars []     = Outputable.empty
660 661 662 663 664
    add_bars (c:cs) = sep ((equals <+> c) : map (char '|' <+>) cs)

    ok_con dc = showSub ss dc || any (showSub ss) (ifConFields dc)

    show_con dc
Adam Gundry's avatar
Adam Gundry committed
665
      | ok_con dc = Just $ pprIfaceConDecl ss gadt_style mk_user_con_res_ty fls dc
666
      | otherwise = Nothing
Adam Gundry's avatar
Adam Gundry committed
667
    fls = ifaceConDeclFields condecls
668

669 670 671 672 673 674 675
    mk_user_con_res_ty :: IfaceEqSpec -> ([IfaceTvBndr], SDoc)
    -- See Note [Result type of a data family GADT]
    mk_user_con_res_ty eq_spec
      | IfDataInstance _ tc tys <- parent
      = (con_univ_tvs, pprIfaceType (IfaceTyConApp tc (substIfaceTcArgs gadt_subst tys)))
      | otherwise
      = (con_univ_tvs, sdocWithDynFlags (ppr_tc_app gadt_subst))
676
      where
677 678 679
        gadt_subst = mkFsEnv eq_spec
        done_univ_tv (tv,_) = isJust (lookupFsEnv gadt_subst tv)
        con_univ_tvs = filterOut done_univ_tv tc_tyvars
680

681 682 683 684
    ppr_tc_app gadt_subst dflags
       = pprPrefixIfDeclBndr ss tycon
         <+> sep [ pprParendIfaceType (substIfaceTyVar gadt_subst tv)
                 | (tv,_kind) <- stripIfaceKindVars dflags tc_tyvars ]
685 686 687

    pp_nd = case condecls of
              IfAbstractTyCon d -> ptext (sLit "abstract") <> ppShowIface ss (parens (ppr d))
688
              IfDataFamTyCon    -> ptext (sLit "data family")
Adam Gundry's avatar
Adam Gundry committed
689 690
              IfDataTyCon{}     -> ptext (sLit "data")
              IfNewTyCon{}      -> ptext (sLit "newtype")
691

692 693 694
    pp_extra = vcat [pprCType ctype, pprRec isrec, pp_prom]

    pp_prom | is_prom   = ptext (sLit "Promotable")
695
            | otherwise = Outputable.empty
696 697 698 699

pprIfaceDecl ss (IfaceClass { ifATs = ats, ifSigs = sigs, ifRec = isrec
                            , ifCtxt   = context, ifName  = clas
                            , ifTyVars = tyvars,  ifRoles = roles
700
                            , ifFDs    = fds, ifMinDef = minDef })
701
  = vcat [ pprRoles (== Nominal) (pprPrefixIfDeclBndr ss clas) tyvars roles
702 703
         , ptext (sLit "class") <+> pprIfaceDeclHead context ss clas tyvars
                                <+> pprFundeps fds <+> pp_where
704 705
         , nest 2 (vcat [ vcat asocs, vcat dsigs, pprec
                        , ppShowAllSubs ss (pprMinDef minDef)])]
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
    where
      pp_where = ppShowRhs ss $ ppUnless (null sigs && null ats) (ptext (sLit "where"))

      asocs = ppr_trim $ map maybeShowAssoc ats
      dsigs = ppr_trim $ map maybeShowSig sigs
      pprec = ppShowIface ss (pprRec isrec)

      maybeShowAssoc :: IfaceAT -> Maybe SDoc
      maybeShowAssoc asc@(IfaceAT d _)
        | showSub ss d = Just $ pprIfaceAT ss asc
        | otherwise    = Nothing

      maybeShowSig :: IfaceClassOp -> Maybe SDoc
      maybeShowSig sg
        | showSub ss sg = Just $  pprIfaceClassOp ss sg
        | otherwise     = Nothing

723 724 725 726 727 728 729
      pprMinDef :: BooleanFormula IfLclName -> SDoc
      pprMinDef minDef = ppUnless (isTrue minDef) $ -- hide empty definitions
        ptext (sLit "{-# MINIMAL") <+>
        pprBooleanFormula
          (\_ def -> cparen (isLexSym def) (ppr def)) 0 minDef <+>
        ptext (sLit "#-}")

730 731 732
pprIfaceDecl ss (IfaceSynonym { ifName   = tc
                              , ifTyVars = tv
                              , ifSynRhs = mono_ty })
733 734
  = hang (ptext (sLit "type") <+> pprIfaceDeclHead [] ss tc tv <+> equals)
       2 (sep [pprIfaceForAll tvs, pprIfaceContextArr theta, ppr tau])
735
  where
736
    (tvs, theta, tau) = splitIfaceSigmaTy mono_ty
737

738
pprIfaceDecl ss (IfaceFamily { ifName = tycon, ifTyVars = tyvars
Jan Stolarek's avatar
Jan Stolarek committed
739 740
                             , ifFamFlav = rhs, ifFamKind = kind
                             , ifResVar = res_var, ifFamInj = inj })
741
  = vcat [ hang (text "type family" <+> pprIfaceDeclHead [] ss tycon tyvars)
Jan Stolarek's avatar
Jan Stolarek committed
742
              2 (pp_inj res_var inj <+> ppShowRhs ss (pp_rhs rhs))
743
         , ppShowRhs ss (nest 2 (pp_branches rhs)) ]
744
  where
Jan Stolarek's avatar
Jan Stolarek committed
745 746 747 748 749 750 751 752 753 754
    pp_inj Nothing    _   = dcolon <+> ppr kind
    pp_inj (Just res) inj
       | Injective injectivity <- inj = hsep [ equals, ppr res, dcolon, ppr kind
                                             , pp_inj_cond res injectivity]
       | otherwise = hsep [ equals, ppr res, dcolon, ppr kind ]

    pp_inj_cond res inj = case filterByList inj tyvars of
       []  -> empty
       tvs -> hsep [text "|", ppr res, text "->", interppSP (map fst tvs)]

755 756 757 758
    pp_rhs IfaceOpenSynFamilyTyCon
      = ppShowIface ss (ptext (sLit "open"))
    pp_rhs IfaceAbstractClosedSynFamilyTyCon
      = ppShowIface ss (ptext (sLit "closed, abstract"))
759
    pp_rhs (IfaceClosedSynFamilyTyCon _)
760 761 762 763 764
      = ptext (sLit "where")
    pp_rhs IfaceBuiltInSynFamTyCon
      = ppShowIface ss (ptext (sLit "built-in"))

    pp_branches (IfaceClosedSynFamilyTyCon (Just (ax, brs)))
765
      = vcat (map (pprAxBranch (pprPrefixIfDeclBndr ss tycon)) brs)
766
        $$ ppShowIface ss (ptext (sLit "axiom") <+> ppr ax)
767
    pp_branches _ = Outputable.empty
768

769
pprIfaceDecl _ (IfacePatSyn { ifName = name, ifPatBuilder = builder,
770
                              ifPatUnivTvs = univ_tvs, ifPatExTvs = ex_tvs,
771
                              ifPatProvCtxt = prov_ctxt, ifPatReqCtxt = req_ctxt,
772 773 774 775 776
                              ifPatArgs = arg_tys,
                              ifPatTy = pat_ty} )
  = pprPatSynSig name is_bidirectional
                 (pprUserIfaceForAll tvs)
                 (pprIfaceContextMaybe req_ctxt)
777
                 (pprIfaceContextMaybe prov_ctxt)
778
                 (pprIfaceType ty)
Gergő Érdi's avatar
Gergő Érdi committed
779
  where
780
    is_bidirectional = isJust builder
781 782
    tvs = univ_tvs ++ ex_tvs
    ty = foldr IfaceFunTy pat_ty arg_tys
Gergő Érdi's avatar
Gergő Érdi committed
783

784 785
pprIfaceDecl ss (IfaceId { ifName = var, ifType = ty,
                              ifIdDetails = details, ifIdInfo = info })
786
  = vcat [ hang (pprPrefixIfDeclBndr ss var <+> dcolon)
787 788
              2 (pprIfaceSigmaType ty)
         , ppShowIface ss (ppr details)
789
         , ppShowIface ss (ppr info) ]
790 791 792 793 794 795 796

pprIfaceDecl _ (IfaceAxiom { ifName = name, ifTyCon = tycon
                           , ifAxBranches = branches })
  = hang (ptext (sLit "axiom") <+> ppr name <> dcolon)
       2 (vcat $ map (pprAxBranch (ppr tycon)) branches)


797
pprCType :: Maybe CType -> SDoc
798
pprCType Nothing      = Outputable.empty
799 800
pprCType (Just cType) = ptext (sLit "C type:") <+> ppr cType

801 802 803 804 805 806 807 808
-- if, for each role, suppress_if role is True, then suppress the role
-- output
pprRoles :: (Role -> Bool) -> SDoc -> [IfaceTvBndr] -> [Role] -> SDoc
pprRoles suppress_if tyCon tyvars roles
  = sdocWithDynFlags $ \dflags ->
      let froles = suppressIfaceKinds dflags tyvars roles
      in ppUnless (all suppress_if roles || null froles) $
         ptext (sLit "type role") <+> tyCon <+> hsep (map ppr froles)
809

Ian Lynagh's avatar
Ian Lynagh committed
810
pprRec :: RecFlag -> SDoc
811
pprRec NonRecursive = Outputable.empty
812
pprRec Recursive    = ptext (sLit "RecFlag: Recursive")
Ian Lynagh's avatar
Ian Lynagh committed
813

814
pprInfixIfDeclBndr, pprPrefixIfDeclBndr :: ShowSub -> OccName -> SDoc
815
pprInfixIfDeclBndr (ShowSub { ss_ppr_bndr = ppr_bndr }) occ
816 817 818
  = pprInfixVar (isSymOcc occ) (ppr_bndr occ)
pprPrefixIfDeclBndr (ShowSub { ss_ppr_bndr = ppr_bndr }) occ
  = parenSymOcc occ (ppr_bndr occ)
819

820
instance Outputable IfaceClassOp where
821 822 823 824
   ppr = pprIfaceClassOp showAll

pprIfaceClassOp :: ShowSub -> IfaceClassOp -> SDoc
pprIfaceClassOp ss (IfaceClassOp n dm ty) = hang opHdr 2 (pprIfaceSigmaType ty)
825 826
  where opHdr = pprPrefixIfDeclBndr ss n
                <+> ppShowIface ss (ppr dm) <+> dcolon
827

828
instance Outputable IfaceAT where
829 830 831
   ppr = pprIfaceAT showAll

pprIfaceAT :: ShowSub -> IfaceAT -> SDoc
832
pprIfaceAT ss (IfaceAT d mb_def)
833
  = vcat [ pprIfaceDecl ss d
834
         , case mb_def of
835
              Nothing  -> Outputable.empty
836 837
              Just rhs -> nest 2 $
                          ptext (sLit "Default:") <+> ppr rhs ]
838 839 840 841 842 843

instance Outputable IfaceTyConParent where
  ppr p = pprIfaceTyConParent p

pprIfaceTyConParent :: IfaceTyConParent -> SDoc
pprIfaceTyConParent IfNoParent
844
  = Outputable.empty
845 846 847 848 849 850
pprIfaceTyConParent (IfDataInstance _ tc tys)
  = sdocWithDynFlags $ \dflags ->
    let ftys = stripKindArgs dflags tys
    in pprIfaceTypeApp tc ftys

pprIfaceDeclHead :: IfaceContext -> ShowSub -> OccName -> [IfaceTvBndr] -> SDoc
851
pprIfaceDeclHead context ss tc_occ tv_bndrs
852
  = sdocWithDynFlags $ \ dflags ->
853 854 855
    sep [ pprIfaceContextArr context
        , pprPrefixIfDeclBndr ss tc_occ
          <+> pprIfaceTvBndrs (stripIfaceKindVars dflags tv_bndrs) ]
856 857 858 859 860 861 862 863

isVanillaIfaceConDecl :: IfaceConDecl -> Bool
isVanillaIfaceConDecl (IfCon { ifConExTvs  = ex_tvs
                             , ifConEqSpec = eq_spec
                             , ifConCtxt   = ctxt })
  = (null ex_tvs) && (null eq_spec) && (null ctxt)

pprIfaceConDecl :: ShowSub -> Bool
864
                -> (IfaceEqSpec -> ([IfaceTvBndr], SDoc))
Adam Gundry's avatar
Adam Gundry committed
865
                -> [FieldLbl OccName]
866
                -> IfaceConDecl -> SDoc
Adam Gundry's avatar
Adam Gundry committed
867
pprIfaceConDecl ss gadt_style mk_user_con_res_ty fls
868
        (IfCon { ifConOcc = name, ifConInfix = is_infix,
869
                 ifConExTvs = ex_tvs,
dterei's avatar
dterei committed
870
                 ifConEqSpec = eq_spec, ifConCtxt = ctxt, ifConArgTys = arg_tys,
871
                 ifConStricts = stricts, ifConFields = labels })
872
  | gadt_style = pp_prefix_con <+> dcolon <+> ppr_ty
873
  | otherwise  = ppr_fields tys_w_strs
874
  where
875 876
    tys_w_strs :: [(IfaceBang, IfaceType)]
    tys_w_strs = zip stricts arg_tys
877
    pp_prefix_con = pprPrefixIfDeclBndr ss name
878

879 880
    (univ_tvs, pp_res_ty) = mk_user_con_res_ty eq_spec
    ppr_ty = pprIfaceForAllPart (univ_tvs ++ ex_tvs) ctxt pp_tau