IfaceSyn.hs 84.2 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,
lukemaurer's avatar
lukemaurer committed
13
        IfaceExpr(..), IfaceAlt, IfaceLetBndr(..), IfaceJoinInfo(..),
dterei's avatar
dterei committed
14 15 16
        IfaceBinding(..), IfaceConAlt(..),
        IfaceIdInfo(..), IfaceIdDetails(..), IfaceUnfolding(..),
        IfaceInfoItem(..), IfaceRule(..), IfaceAnnotation(..), IfaceAnnTarget,
17
        IfaceClsInst(..), IfaceFamInst(..), IfaceTickish(..),
18
        IfaceClassBody(..),
19 20 21
        IfaceBang(..),
        IfaceSrcBang(..), SrcUnpackedness(..), SrcStrictness(..),
        IfaceAxBranch(..),
22
        IfaceTyConParent(..),
23
        IfaceCompleteMatch(..),
24

25 26 27 28
        -- * Binding names
        IfaceTopBndr,
        putIfaceTopBndr, getIfaceTopBndr,

dterei's avatar
dterei committed
29
        -- Misc
30
        ifaceDeclImplicitBndrs, visibleIfConDecls,
31
        ifaceDeclFingerprints,
32

33
        -- Free Names
34
        freeNamesIfDecl, freeNamesIfRule, freeNamesIfFamInst,
35

dterei's avatar
dterei committed
36
        -- Pretty printing
37 38
        pprIfaceExpr,
        pprIfaceDecl,
39
        AltPpr(..), ShowSub(..), ShowHowMuch(..), showToIface, showToHeader
40 41 42 43
    ) where

#include "HsVersions.h"

44 45
import GhcPrelude

46
import IfaceType
47
import BinFingerprint
48
import CoreSyn( IsOrphan, isOrphan )
49
import PprCore()            -- Printing DFunArgs
50
import Demand
Simon Marlow's avatar
Simon Marlow committed
51
import Class
Adam Gundry's avatar
Adam Gundry committed
52
import FieldLabel
dterei's avatar
dterei committed
53
import NameSet
Adam Gundry's avatar
Adam Gundry committed
54
import CoAxiom ( BranchIndex )
Simon Marlow's avatar
Simon Marlow committed
55 56 57 58
import Name
import CostCentre
import Literal
import ForeignCall
59
import Annotations( AnnPayload, AnnTarget )
60
import BasicTypes
61
import Outputable
62
import Module
Peter Wortmann's avatar
Peter Wortmann committed
63
import SrcLoc
64 65
import Fingerprint
import Binary
66
import BooleanFormula ( BooleanFormula, pprBooleanFormula, isTrue )
67
import Var( TyVarBndr(..) )
68
import TyCon ( Role (..), Injectivity(..) )
69
import Util( dropList, filterByList )
70
import DataCon (SrcStrictness(..), SrcUnpackedness(..))
71
import Lexeme (isLexSym)
72
import DynFlags
73

74
import Control.Monad
75
import System.IO.Unsafe
76

77 78
infixl 3 &&&

Austin Seipp's avatar
Austin Seipp committed
79 80 81
{-
************************************************************************
*                                                                      *
82
                    Declarations
Austin Seipp's avatar
Austin Seipp committed
83 84 85
*                                                                      *
************************************************************************
-}
86

87 88 89
-- | A binding top-level 'Name' in an interface file (e.g. the name of an
-- 'IfaceDecl').
type IfaceTopBndr = Name
Gabor Greif's avatar
Gabor Greif committed
90
  -- It's convenient to have a Name in the IfaceSyn, although in each
91
  -- case the namespace is implied by the context. However, having an
92 93 94 95
  -- Name makes things like ifaceDeclImplicitBndrs and ifaceDeclFingerprints
  -- very convenient. Moreover, having the key of the binder means that
  -- we can encode known-key things cleverly in the symbol table. See Note
  -- [Symbol table representation of Names]
96 97
  --
  -- We don't serialise the namespace onto the disk though; rather we
98 99
  -- drop it when serialising and add it back in when deserialising.

100 101 102 103 104 105 106 107 108 109
getIfaceTopBndr :: BinHandle -> IO IfaceTopBndr
getIfaceTopBndr bh = get bh

putIfaceTopBndr :: BinHandle -> IfaceTopBndr -> IO ()
putIfaceTopBndr bh name =
    case getUserData bh of
      UserData{ ud_put_binding_name = put_binding_name } ->
          --pprTrace "putIfaceTopBndr" (ppr name) $
          put_binding_name bh name

dterei's avatar
dterei committed
110
data IfaceDecl
111
  = IfaceId { ifName      :: IfaceTopBndr,
dterei's avatar
dterei committed
112 113 114 115
              ifType      :: IfaceType,
              ifIdDetails :: IfaceIdDetails,
              ifIdInfo    :: IfaceIdInfo }

116
  | IfaceData { ifName       :: IfaceTopBndr,   -- Type constructor
117 118
                ifBinders    :: [IfaceTyConBinder],
                ifResKind    :: IfaceType,      -- Result kind of type constructor
119
                ifCType      :: Maybe CType,    -- C type for CAPI FFI
120
                ifRoles      :: [Role],         -- Roles
dterei's avatar
dterei committed
121
                ifCtxt       :: IfaceContext,   -- The "stupid theta"
122
                ifCons       :: IfaceConDecls,  -- Includes new/data/data family info
dterei's avatar
dterei committed
123 124
                ifGadtSyntax :: Bool,           -- True <=> declared using
                                                -- GADT syntax
125 126
                ifParent     :: IfaceTyConParent -- The axiom, for a newtype,
                                                 -- or data/newtype family instance
127
    }
128

129 130
  | IfaceSynonym { ifName    :: IfaceTopBndr,      -- Type constructor
                   ifRoles   :: [Role],            -- Roles
131 132
                   ifBinders :: [IfaceTyConBinder],
                   ifResKind :: IfaceKind,         -- Kind of the *result*
133 134 135
                   ifSynRhs  :: IfaceType }

  | IfaceFamily  { ifName    :: IfaceTopBndr,      -- Type constructor
Jan Stolarek's avatar
Jan Stolarek committed
136 137 138
                   ifResVar  :: Maybe IfLclName,   -- Result variable name, used
                                                   -- only for pretty-printing
                                                   -- with --show-iface
139 140
                   ifBinders :: [IfaceTyConBinder],
                   ifResKind :: IfaceKind,         -- Kind of the *tycon*
Jan Stolarek's avatar
Jan Stolarek committed
141 142
                   ifFamFlav :: IfaceFamTyConFlav,
                   ifFamInj  :: Injectivity }      -- injectivity information
143

144
  | IfaceClass { ifName    :: IfaceTopBndr,             -- Name of the class TyCon
145
                 ifRoles   :: [Role],                   -- Roles
146
                 ifBinders :: [IfaceTyConBinder],
147 148
                 ifFDs     :: [FunDep IfLclName],       -- Functional dependencies
                 ifBody    :: IfaceClassBody            -- Methods, superclasses, ATs
149 150
    }

151
  | IfaceAxiom { ifName       :: IfaceTopBndr,        -- Axiom name
152
                 ifTyCon      :: IfaceTyCon,     -- LHS TyCon
153
                 ifRole       :: Role,           -- Role of axiom
154 155
                 ifAxBranches :: [IfaceAxBranch] -- Branches
    }
156

157
  | IfacePatSyn { ifName          :: IfaceTopBndr,           -- Name of the pattern synonym
Gergő Érdi's avatar
Gergő Érdi committed
158
                  ifPatIsInfix    :: Bool,
159 160
                  ifPatMatcher    :: (IfExtName, Bool),
                  ifPatBuilder    :: Maybe (IfExtName, Bool),
161 162
                  -- Everything below is redundant,
                  -- but needed to implement pprIfaceDecl
163 164
                  ifPatUnivBndrs  :: [IfaceForAllBndr],
                  ifPatExBndrs    :: [IfaceForAllBndr],
Gergő Érdi's avatar
Gergő Érdi committed
165 166
                  ifPatProvCtxt   :: IfaceContext,
                  ifPatReqCtxt    :: IfaceContext,
167
                  ifPatArgs       :: [IfaceType],
Matthew Pickering's avatar
Matthew Pickering committed
168 169
                  ifPatTy         :: IfaceType,
                  ifFieldLabels   :: [FieldLabel] }
Gergő Érdi's avatar
Gergő Érdi committed
170

171 172 173 174 175 176 177 178 179 180 181
-- See also 'ClassBody'
data IfaceClassBody
  -- Abstract classes don't specify their body; they only occur in @hs-boot@ and
  -- @hsig@ files.
  = IfAbstractClass
  | IfConcreteClass {
     ifClassCtxt :: IfaceContext,             -- Super classes
     ifATs       :: [IfaceAT],                -- Associated type families
     ifSigs      :: [IfaceClassOp],           -- Method signatures
     ifMinDef    :: BooleanFormula IfLclName  -- Minimal complete definition
    }
Gergő Érdi's avatar
Gergő Érdi committed
182

183 184 185 186
data IfaceTyConParent
  = IfNoParent
  | IfDataInstance IfExtName
                   IfaceTyCon
187
                   IfaceAppArgs
188

189
data IfaceFamTyConFlav
190 191
  = IfaceDataFamilyTyCon                      -- Data family
  | IfaceOpenSynFamilyTyCon
192 193 194
  | IfaceClosedSynFamilyTyCon (Maybe (IfExtName, [IfaceAxBranch]))
    -- ^ Name of associated axiom and branches for pretty printing purposes,
    -- or 'Nothing' for an empty closed family without an axiom
195
    -- See Note [Pretty-printing via IfaceSyn] in PprTyThing
196
  | IfaceAbstractClosedSynFamilyTyCon
197
  | IfaceBuiltInSynFamTyCon -- for pretty printing purposes only
198

199 200 201 202 203
data IfaceClassOp
  = IfaceClassOp IfaceTopBndr
                 IfaceType                         -- Class op type
                 (Maybe (DefMethSpec IfaceType))   -- Default method
                 -- The types of both the class op itself,
Gabor Greif's avatar
Gabor Greif committed
204
                 -- and the default method, are *not* quantified
205
                 -- over the class variables
206

207 208 209 210
data IfaceAT = IfaceAT  -- See Class.ClassATItem
                  IfaceDecl          -- The associated type declaration
                  (Maybe IfaceType)  -- Default associated type instance, if any

211

212
-- This is just like CoAxBranch
213 214
data IfaceAxBranch = IfaceAxBranch { ifaxbTyVars   :: [IfaceTvBndr]
                                   , ifaxbCoVars   :: [IfaceIdBndr]
215
                                   , ifaxbLHS      :: IfaceAppArgs
216 217 218
                                   , ifaxbRoles    :: [Role]
                                   , ifaxbRHS      :: IfaceType
                                   , ifaxbIncomps  :: [BranchIndex] }
219
                                     -- See Note [Storing compatibility] in CoAxiom
220

221
data IfaceConDecls
222
  = IfAbstractTyCon     -- c.f TyCon.AbstractTyCon
223 224
  | IfDataTyCon [IfaceConDecl] -- Data type decls
  | IfNewTyCon  IfaceConDecl   -- Newtype decls
Adam Gundry's avatar
Adam Gundry committed
225 226 227

-- For IfDataTyCon and IfNewTyCon we store:
--  * the data constructor(s);
228 229 230
-- The field labels are stored individually in the IfaceConDecl
-- (there is some redundancy here, because a field label may occur
-- in multiple IfaceConDecls and represent the same field label)
231

dterei's avatar
dterei committed
232
data IfaceConDecl
233
  = IfCon {
234
        ifConName    :: IfaceTopBndr,                -- Constructor name
dterei's avatar
dterei committed
235 236
        ifConWrapper :: Bool,                   -- True <=> has a wrapper
        ifConInfix   :: Bool,                   -- True <=> declared infix
237 238 239 240 241 242 243

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

244 245 246 247 248 249 250 251
        ifConExTvs   :: [IfaceTvBndr],  -- Existential tyvars
        ifConUserTvBinders :: [IfaceForAllBndr],
          -- The tyvars, in the order the user wrote them
          -- INVARIANT: the set of tyvars in ifConUserTvBinders is exactly the
          --            set of ifConExTvs, unioned with the set of ifBinders
          --            (from the parent IfaceDecl) whose tyvars do not appear
          --            in ifConEqSpec
          -- See Note [DataCon user type variable binders] in DataCon
252 253 254
        ifConEqSpec  :: IfaceEqSpec,        -- Equality constraints
        ifConCtxt    :: IfaceContext,       -- Non-stupid context
        ifConArgTys  :: [IfaceType],        -- Arg types
255
        ifConFields  :: [FieldLabel],  -- ...ditto... (field labels)
256 257 258 259 260
        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
261

262
type IfaceEqSpec = [(IfLclName,IfaceType)]
263

264 265 266
-- | This corresponds to an HsImplBang; that is, the final
-- implementation decision about the data constructor arg
data IfaceBang
267 268
  = IfNoBang | IfStrict | IfUnpack | IfUnpackCo IfaceCoercion

269 270 271 272
-- | This corresponds to HsSrcBang
data IfaceSrcBang
  = IfSrcBang SrcUnpackedness SrcStrictness

273 274 275 276 277
data IfaceClsInst
  = IfaceClsInst { ifInstCls  :: IfExtName,                -- See comments with
                   ifInstTys  :: [Maybe IfaceTyCon],       -- the defn of ClsInst
                   ifDFun     :: IfExtName,                -- The dfun
                   ifOFlag    :: OverlapFlag,              -- Overlap flag
278
                   ifInstOrph :: IsOrphan }                -- See Note [Orphans] in InstEnv
dterei's avatar
dterei committed
279 280 281 282 283 284
        -- 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
285

286
-- The ifFamInstTys field of IfaceFamInst contains a list of the rough
287
-- match types
288
data IfaceFamInst
289
  = IfaceFamInst { ifFamInstFam      :: IfExtName            -- Family name
290
                 , ifFamInstTys      :: [Maybe IfaceTyCon]   -- See above
291
                 , ifFamInstAxiom    :: IfExtName            -- The axiom
292
                 , ifFamInstOrph     :: IsOrphan             -- Just like IfaceClsInst
dterei's avatar
dterei committed
293
                 }
294

295
data IfaceRule
dterei's avatar
dterei committed
296 297 298 299 300 301 302 303
  = 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,
304
        ifRuleOrph   :: IsOrphan   -- Just like IfaceClsInst
305 306
    }

307 308 309
data IfaceAnnotation
  = IfaceAnnotation {
        ifAnnotatedTarget :: IfaceAnnTarget,
310
        ifAnnotatedValue  :: AnnPayload
311 312 313 314
  }

type IfaceAnnTarget = AnnTarget OccName

315 316
data IfaceCompleteMatch = IfaceCompleteMatch [IfExtName] IfExtName

317 318 319 320
instance Outputable IfaceCompleteMatch where
  ppr (IfaceCompleteMatch cls ty) = text "COMPLETE" <> colon <+> ppr cls
                                                    <+> dcolon <+> ppr ty

321 322 323



324
-- Here's a tricky case:
325 326
--   * Compile with -O module A, and B which imports A.f
--   * Change function f in A, and recompile without -O
327
--   * When we read in old A.hi we read in its IdInfo (as a thunk)
dterei's avatar
dterei committed
328 329 330
--      (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
331
--   * The version comparison sees that new (=NoInfo) differs from old (=HasInfo *)
dterei's avatar
dterei committed
332
--      and so gives a new version.
333

334 335 336 337
data IfaceIdInfo
  = NoInfo                      -- When writing interface file without -O
  | HasInfo [IfaceInfoItem]     -- Has info, and here it is

338
data IfaceInfoItem
339 340 341 342 343
  = HsArity         Arity
  | HsStrictness    StrictSig
  | HsInline        InlinePragma
  | HsUnfold        Bool             -- True <=> isStrongLoopBreaker is true
                    IfaceUnfolding   -- See Note [Expose recursive functions]
344
  | HsNoCafRefs
Richard Eisenberg's avatar
Richard Eisenberg committed
345
  | HsLevity                         -- Present <=> never levity polymorphic
346

347 348 349
-- 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
350
data IfaceUnfolding
351
  = IfCoreUnfold Bool IfaceExpr -- True <=> INLINABLE, False <=> regular unfolding
352 353
                                -- Possibly could eliminate the Bool here, the information
                                -- is also in the InlinePragma.
354

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

357
  | IfInlineRule Arity          -- INLINE pragmas
dterei's avatar
dterei committed
358 359 360
                 Bool           -- OK to inline even if *un*-saturated
                 Bool           -- OK to inline even if context is boring
                 IfaceExpr
361

362
  | IfDFunUnfold [IfaceBndr] [IfaceExpr]
363

364

365 366 367 368
-- 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
369

370 371
data IfaceIdDetails
  = IfVanillaId
Matthew Pickering's avatar
Matthew Pickering committed
372
  | IfRecSelId (Either IfaceTyCon IfaceDecl) Bool
373
  | IfDFunId
374

Austin Seipp's avatar
Austin Seipp committed
375
{-
376 377
Note [Versioning of instances]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
378
See [http://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/RecompilationAvoidance#Instances]
379

380

Austin Seipp's avatar
Austin Seipp committed
381 382
************************************************************************
*                                                                      *
383
                Functions over declarations
Austin Seipp's avatar
Austin Seipp committed
384 385 386
*                                                                      *
************************************************************************
-}
387 388

visibleIfConDecls :: IfaceConDecls -> [IfaceConDecl]
389
visibleIfConDecls IfAbstractTyCon  = []
390
visibleIfConDecls (IfDataTyCon cs) = cs
391
visibleIfConDecls (IfNewTyCon c)   = [c]
392

393
ifaceDeclImplicitBndrs :: IfaceDecl -> [OccName]
394 395 396
--  *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
397
-- See Note [Implicit TyThings] in HscTypes
398

399 400 401 402 403
-- 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.
404

405
ifaceDeclImplicitBndrs (IfaceData {ifName = tc_name, ifCons = cons })
406
  = case cons of
407
      IfAbstractTyCon -> []
408 409
      IfNewTyCon  cd  -> mkNewTyCoOcc (occName tc_name) : ifaceConDeclImplicitBndrs cd
      IfDataTyCon cds -> concatMap ifaceConDeclImplicitBndrs cds
410

411 412 413 414 415 416 417 418 419
ifaceDeclImplicitBndrs (IfaceClass { ifBody = IfAbstractClass })
  = []

ifaceDeclImplicitBndrs (IfaceClass { ifName = cls_tc_name
                                   , ifBody = IfConcreteClass {
                                        ifClassCtxt = sc_ctxt,
                                        ifSigs      = sigs,
                                        ifATs       = ats
                                     }})
batterseapower's avatar
batterseapower committed
420
  = --   (possibly) newtype coercion
421 422 423 424 425 426
    co_occs ++
    --    data constructor (DataCon namespace)
    --    data worker (Id namespace)
    --    no wrapper (class dictionaries never have a wrapper)
    [dc_occ, dcww_occ] ++
    -- associated types
427
    [occName (ifName at) | IfaceAT at _ <- ats ] ++
428
    -- superclass selectors
batterseapower's avatar
batterseapower committed
429
    [mkSuperDictSelOcc n cls_tc_occ | n <- [1..n_ctxt]] ++
430
    -- operation selectors
431
    [occName op | IfaceClassOp op  _ _ <- sigs]
432
  where
433
    cls_tc_occ = occName cls_tc_name
434 435
    n_ctxt = length sc_ctxt
    n_sigs = length sigs
batterseapower's avatar
batterseapower committed
436
    co_occs | is_newtype = [mkNewTyCoOcc cls_tc_occ]
dterei's avatar
dterei committed
437
            | otherwise  = []
438
    dcww_occ = mkDataConWorkerOcc dc_occ
batterseapower's avatar
batterseapower committed
439
    dc_occ = mkClassDataConOcc cls_tc_occ
440
    is_newtype = n_sigs + n_ctxt == 1 -- Sigh (keep this synced with buildClass)
441

442
ifaceDeclImplicitBndrs _ = []
443

444
ifaceConDeclImplicitBndrs :: IfaceConDecl -> [OccName]
445 446
ifaceConDeclImplicitBndrs (IfCon {
        ifConWrapper = has_wrapper, ifConName = con_name })
447
  = [occName con_name, work_occ] ++ wrap_occs
448
  where
449
    con_occ = occName con_name
450 451 452 453
    work_occ  = mkDataConWorkerOcc con_occ                   -- Id namespace
    wrap_occs | has_wrapper = [mkDataConWrapperOcc con_occ]  -- Id namespace
              | otherwise   = []

454 455 456 457 458 459 460 461 462
-- -----------------------------------------------------------------------------
-- 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
463
  = (getOccName decl, hash) :
464 465 466 467 468 469
    [ (occ, computeFingerprint' (hash,occ))
    | occ <- ifaceDeclImplicitBndrs decl ]
  where
     computeFingerprint' =
       unsafeDupablePerformIO
        . computeFingerprint (panic "ifaceDeclFingerprints")
470

Austin Seipp's avatar
Austin Seipp committed
471 472 473
{-
************************************************************************
*                                                                      *
474
                Expressions
Austin Seipp's avatar
Austin Seipp committed
475 476 477
*                                                                      *
************************************************************************
-}
478 479 480 481 482 483

data IfaceExpr
  = IfaceLcl    IfLclName
  | IfaceExt    IfExtName
  | IfaceType   IfaceType
  | IfaceCo     IfaceCoercion
484
  | IfaceTuple  TupleSort [IfaceExpr]   -- Saturated; type arguments omitted
485
  | IfaceLam    IfaceLamBndr IfaceExpr
486 487
  | IfaceApp    IfaceExpr IfaceExpr
  | IfaceCase   IfaceExpr IfLclName [IfaceAlt]
488
  | IfaceECase  IfaceExpr IfaceType     -- See Note [Empty case alternatives]
489
  | IfaceLet    IfaceBinding  IfaceExpr
490 491 492 493 494 495 496 497
  | 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
498
  | IfaceSource  RealSrcSpan String        -- from SourceNote
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
  -- 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]
lukemaurer's avatar
lukemaurer committed
517 518 519 520
data IfaceLetBndr = IfLetBndr IfLclName IfaceType IfaceIdInfo IfaceJoinInfo

data IfaceJoinInfo = IfaceNotJoinPoint
                   | IfaceJoinPoint JoinArity
521

Austin Seipp's avatar
Austin Seipp committed
522
{-
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
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
547 548
************************************************************************
*                                                                      *
549
              Printing IfaceDecl
Austin Seipp's avatar
Austin Seipp committed
550 551 552
*                                                                      *
************************************************************************
-}
553 554 555 556 557 558

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
559 560 561 562 563
                                 , ifaxbCoVars = cvs
                                 , ifaxbLHS = pat_tys
                                 , ifaxbRHS = rhs
                                 , ifaxbIncomps = incomps })
  = hang ppr_binders 2 (hang pp_lhs 2 (equals <+> ppr rhs))
564 565 566
    $+$
    nest 2 maybe_incomps
  where
567 568 569 570
    ppr_binders = sdocWithDynFlags $ \dflags ->
                  ppWhen (gopt Opt_PrintExplicitForalls dflags) ppr_binders'

    ppr_binders'
571
      | null tvs && null cvs = empty
Ben Gamari's avatar
Ben Gamari committed
572 573
      | null cvs
      = brackets (pprWithCommas (pprIfaceTvBndr True) tvs)
574
      | otherwise
Ben Gamari's avatar
Ben Gamari committed
575
      = brackets (pprWithCommas (pprIfaceTvBndr True) tvs <> semi <+>
576
                  pprWithCommas pprIfaceIdBndr cvs)
577
    pp_lhs = hang pp_tc 2 (pprParendIfaceAppArgs pat_tys)
578
    maybe_incomps = ppUnless (null incomps) $ parens $
579
                    text "incompatible indices:" <+> ppr incomps
580 581 582 583

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

584 585 586
instance NamedThing IfaceClassOp where
  getName (IfaceClassOp n _ _) = n

587
instance HasOccName IfaceClassOp where
588 589 590 591
  occName = getOccName

instance NamedThing IfaceConDecl where
  getName = ifConName
592

593
instance HasOccName IfaceConDecl where
594 595 596 597
  occName = getOccName

instance NamedThing IfaceDecl where
  getName = ifName
598

599
instance HasOccName IfaceDecl where
600
  occName = getOccName
601

602
instance Outputable IfaceDecl where
603
  ppr = pprIfaceDecl showToIface
604

605 606 607 608 609 610 611 612 613
{-
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.
-}

614 615
data ShowSub
  = ShowSub
616 617 618 619 620 621
      { ss_how_much :: ShowHowMuch
      , ss_forall :: ShowForAllFlag }

-- See Note [Printing IfaceDecl binders]
-- The alternative pretty printer referred to in the note.
newtype AltPpr = AltPpr (Maybe (OccName -> SDoc))
622 623

data ShowHowMuch
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
  = ShowHeader AltPpr -- ^Header information only, not rhs
  | ShowSome [OccName] AltPpr
  -- ^ Show only some sub-components. Specifically,
  --
  -- [@[]@] 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)

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

When printing an interface file (--show-iface), we want to print
everything unqualified, so we can just print the OccName directly.
-}
647

648
instance Outputable ShowHowMuch where
649 650 651 652 653 654 655
  ppr (ShowHeader _)    = text "ShowHeader"
  ppr ShowIface         = text "ShowIface"
  ppr (ShowSome occs _) = text "ShowSome" <+> ppr occs

showToHeader :: ShowSub
showToHeader = ShowSub { ss_how_much = ShowHeader $ AltPpr Nothing
                       , ss_forall = ShowForAllWhen }
656

657 658 659
showToIface :: ShowSub
showToIface = ShowSub { ss_how_much = ShowIface
                      , ss_forall = ShowForAllWhen }
660 661 662

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

665 666
-- show if all sub-components or the complete interface is shown
ppShowAllSubs :: ShowSub -> SDoc -> SDoc -- Note [Minimal complete definition]
667 668 669
ppShowAllSubs (ShowSub { ss_how_much = ShowSome [] _ }) doc = doc
ppShowAllSubs (ShowSub { ss_how_much = ShowIface })     doc = doc
ppShowAllSubs _                                         _   = Outputable.empty
670

671
ppShowRhs :: ShowSub -> SDoc -> SDoc
672 673
ppShowRhs (ShowSub { ss_how_much = ShowHeader _ }) _   = Outputable.empty
ppShowRhs _                                        doc = doc
674 675

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

680 681 682 683 684 685 686
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)
687
    go Nothing    (False, so_far) = (True, text "..." : so_far)
688 689 690 691 692

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

693 694 695 696 697 698 699
pprClassRoles :: ShowSub -> IfaceTopBndr -> [IfaceTyConBinder] -> [Role] -> SDoc
pprClassRoles ss clas binders roles =
    pprRoles (== Nominal)
             (pprPrefixIfDeclBndr (ss_how_much ss) (occName clas))
             binders
             roles

700
pprIfaceDecl :: ShowSub -> IfaceDecl -> SDoc
701 702
-- NB: pprIfaceDecl is also used for pretty-printing TyThings in GHCi
--     See Note [Pretty-printing TyThings] in PprTyThing
703
pprIfaceDecl ss (IfaceData { ifName = tycon, ifCType = ctype,
Edward Z. Yang's avatar
Edward Z. Yang committed
704
                             ifCtxt = context, ifResKind = kind,
705
                             ifRoles = roles, ifCons = condecls,
Edward Z. Yang's avatar
Edward Z. Yang committed
706
                             ifParent = parent,
707
                             ifGadtSyntax = gadt,
708
                             ifBinders = binders })
709

710
  | gadt      = vcat [ pp_roles
Edward Z. Yang's avatar
Edward Z. Yang committed
711
                     , pp_nd <+> pp_lhs <+> pp_kind <+> pp_where
712 713 714
                     , nest 2 (vcat pp_cons)
                     , nest 2 $ ppShowIface ss pp_extra ]
  | otherwise = vcat [ pp_roles
Edward Z. Yang's avatar
Edward Z. Yang committed
715
                     , hang (pp_nd <+> pp_lhs <+> pp_kind) 2 (add_bars pp_cons)
716
                     , nest 2 $ ppShowIface ss pp_extra ]
717 718 719 720
  where
    is_data_instance = isIfaceDataInstance parent

    cons       = visibleIfConDecls condecls
721
    pp_where   = ppWhen (gadt && not (null cons)) $ text "where"
722
    pp_cons    = ppr_trim (map show_con cons) :: [SDoc]
Edward Z. Yang's avatar
Edward Z. Yang committed
723 724 725
    pp_kind
      | isIfaceLiftedTypeKind kind = empty
      | otherwise = dcolon <+> ppr kind
726 727

    pp_lhs = case parent of
728
               IfNoParent -> pprIfaceDeclHead context ss tycon binders Nothing
729
               _          -> text "instance" <+> pprIfaceTyConParent parent
730 731

    pp_roles
732 733
      | is_data_instance = empty
      | otherwise        = pprRoles (== Representational)
734 735 736
                                    (pprPrefixIfDeclBndr
                                        (ss_how_much ss)
                                        (occName tycon))
737
                                    binders roles
738 739 740
            -- Don't display roles for data family instances (yet)
            -- See discussion on Trac #8672.

741
    add_bars []     = Outputable.empty
742
    add_bars (c:cs) = sep ((equals <+> c) : map (vbar <+>) cs)
743

744
    ok_con dc = showSub ss dc || any (showSub ss . flSelector) (ifConFields dc)
745 746

    show_con dc
747
      | ok_con dc = Just $ pprIfaceConDecl ss gadt tycon binders parent dc
748
      | otherwise = Nothing
749

750
    pp_nd = case condecls of
751
              IfAbstractTyCon{} -> text "data"
752 753
              IfDataTyCon{}     -> text "data"
              IfNewTyCon{}      -> text "newtype"
754

Edward Z. Yang's avatar
Edward Z. Yang committed
755
    pp_extra = vcat [pprCType ctype]
756

757
pprIfaceDecl ss (IfaceClass { ifName  = clas
758
                            , ifRoles = roles
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
                            , ifFDs    = fds
                            , ifBinders = binders
                            , ifBody = IfAbstractClass })
  = vcat [ pprClassRoles ss clas binders roles
         , text "class" <+> pprIfaceDeclHead [] ss clas binders Nothing
                                <+> pprFundeps fds ]

pprIfaceDecl ss (IfaceClass { ifName  = clas
                            , ifRoles = roles
                            , ifFDs    = fds
                            , ifBinders = binders
                            , ifBody = IfConcreteClass {
                                ifATs = ats,
                                ifSigs = sigs,
                                ifClassCtxt = context,
                                ifMinDef = minDef
                              }})
  = vcat [ pprClassRoles ss clas binders roles
777
         , text "class" <+> pprIfaceDeclHead context ss clas binders Nothing
778
                                <+> pprFundeps fds <+> pp_where
Edward Z. Yang's avatar
Edward Z. Yang committed
779
         , nest 2 (vcat [ vcat asocs, vcat dsigs
780
                        , ppShowAllSubs ss (pprMinDef minDef)])]
781
    where
782
      pp_where = ppShowRhs ss $ ppUnless (null sigs && null ats) (text "where")
783 784 785 786 787 788 789 790 791 792 793 794 795 796

      asocs = ppr_trim $ map maybeShowAssoc ats
      dsigs = ppr_trim $ map maybeShowSig sigs

      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

797 798
      pprMinDef :: BooleanFormula IfLclName -> SDoc
      pprMinDef minDef = ppUnless (isTrue minDef) $ -- hide empty definitions
799
        text "{-# MINIMAL" <+>
800 801
        pprBooleanFormula
          (\_ def -> cparen (isLexSym def) (ppr def)) 0 minDef <+>
802
        text "#-}"
803

804
pprIfaceDecl ss (IfaceSynonym { ifName    = tc
805
                              , ifBinders = binders
806
                              , ifSynRhs  = mono_ty
807 808 809 810
                              , ifResKind = res_kind})
  = hang (text "type" <+> pprIfaceDeclHead [] ss tc binders Nothing <+> equals)
       2 (sep [ pprIfaceForAll tvs, pprIfaceContextArr theta, ppr tau
              , ppUnless (isIfaceLiftedTypeKind res_kind) (dcolon <+> ppr res_kind) ])
811
  where
812
    (tvs, theta, tau) = splitIfaceSigmaTy mono_ty
813

814 815 816
pprIfaceDecl ss (IfaceFamily { ifName = tycon
                             , ifFamFlav = rhs, ifBinders = binders
                             , ifResKind = res_kind
Jan Stolarek's avatar
Jan Stolarek committed
817
                             , ifResVar = res_var, ifFamInj = inj })
818
  | IfaceDataFamilyTyCon <- rhs
819
  = text "data family" <+> pprIfaceDeclHead [] ss tycon binders Nothing
820 821

  | otherwise
822
  = hang (text "type family" <+> pprIfaceDeclHead [] ss tycon binders (Just res_kind))