IfaceSyn.hs 72.7 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],
Gergő Érdi's avatar
Gergő Érdi committed
157 158 159
                  ifPatTy         :: IfaceType }


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

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

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

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

183

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

192
data IfaceConDecls
Adam Gundry's avatar
Adam Gundry committed
193 194 195 196 197 198 199 200 201 202
  = IfAbstractTyCon Bool                          -- c.f TyCon.AbstractTyCon
  | IfDataFamTyCon                                -- Data family
  | 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.
203

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

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

216 217 218 219 220 221 222 223 224 225
        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
226

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

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

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

238 239 240 241 242
data IfaceClsInst
  = IfaceClsInst { ifInstCls  :: IfExtName,                -- See comments with
                   ifInstTys  :: [Maybe IfaceTyCon],       -- the defn of ClsInst
                   ifDFun     :: IfExtName,                -- The dfun
                   ifOFlag    :: OverlapFlag,              -- Overlap flag
243
                   ifInstOrph :: IsOrphan }                -- See Note [Orphans] in InstEnv
dterei's avatar
dterei committed
244 245 246 247 248 249
        -- 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
250

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

260
data IfaceRule
dterei's avatar
dterei committed
261 262 263 264 265 266 267 268
  = 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,
269
        ifRuleOrph   :: IsOrphan   -- Just like IfaceClsInst
270 271
    }

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

type IfaceAnnTarget = AnnTarget OccName

280
-- Here's a tricky case:
281 282
--   * Compile with -O module A, and B which imports A.f
--   * Change function f in A, and recompile without -O
283
--   * When we read in old A.hi we read in its IdInfo (as a thunk)
dterei's avatar
dterei committed
284 285 286
--      (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
287
--   * The version comparison sees that new (=NoInfo) differs from old (=HasInfo *)
dterei's avatar
dterei committed
288
--      and so gives a new version.
289

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

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

302 303 304
-- 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
305
data IfaceUnfolding
306
  = IfCoreUnfold Bool IfaceExpr -- True <=> INLINABLE, False <=> regular unfolding
307 308
                                -- Possibly could eliminate the Bool here, the information
                                -- is also in the InlinePragma.
309

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

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

317
  | IfDFunUnfold [IfaceBndr] [IfaceExpr]
318

319

320 321 322 323
-- 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
324

325 326 327
data IfaceIdDetails
  = IfVanillaId
  | IfRecSelId IfaceTyCon Bool
328
  | IfDFunId
329

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

335

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

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

ifaceConDeclFields :: IfaceConDecls -> [FieldLbl OccName]
ifaceConDeclFields x = case x of
    IfAbstractTyCon {}              -> []
    IfDataFamTyCon  {}              -> []
    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!"
358

359
ifaceDeclImplicitBndrs :: IfaceDecl -> [OccName]
360 361 362
--  *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
363
-- See Note [Implicit TyThings] in HscTypes
364

365 366 367 368 369
-- 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.
370
ifaceDeclImplicitBndrs IfaceData {ifCons = IfAbstractTyCon {}}  = []
371 372

-- Newtype
373
ifaceDeclImplicitBndrs (IfaceData {ifName = tc_occ,
Adam Gundry's avatar
Adam Gundry committed
374
                              ifCons = IfNewTyCon (IfCon { ifConOcc = con_occ }) _ _})
375 376
  =   -- implicit newtype coercion
    (mkNewTyCoOcc tc_occ) : -- JPM: newtype coercions shouldn't be implicit
377
      -- data constructor and worker (newtypes don't have a wrapper)
378 379
    [con_occ, mkDataConWorkerOcc con_occ]

380

381
ifaceDeclImplicitBndrs (IfaceData {ifName = _tc_occ,
Adam Gundry's avatar
Adam Gundry committed
382
                              ifCons = IfDataTyCon cons _ _ })
383 384 385
  = -- for each data constructor in order,
    --    data constructor, worker, and (possibly) wrapper
    concatMap dc_occs cons
386 387
  where
    dc_occs con_decl
dterei's avatar
dterei committed
388 389 390 391 392 393 394 395 396
        | 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!

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

420
ifaceDeclImplicitBndrs _ = []
421

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
-- -----------------------------------------------------------------------------
-- 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")
438

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

data IfaceExpr
  = IfaceLcl    IfLclName
  | IfaceExt    IfExtName
  | IfaceType   IfaceType
  | IfaceCo     IfaceCoercion
452
  | IfaceTuple  TupleSort [IfaceExpr]   -- Saturated; type arguments omitted
453
  | IfaceLam    IfaceLamBndr IfaceExpr
454 455
  | IfaceApp    IfaceExpr IfaceExpr
  | IfaceCase   IfaceExpr IfLclName [IfaceAlt]
456
  | IfaceECase  IfaceExpr IfaceType     -- See Note [Empty case alternatives]
457
  | IfaceLet    IfaceBinding  IfaceExpr
458 459 460 461 462 463 464 465
  | 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
466
  | IfaceSource  RealSrcSpan String        -- from SourceNote
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
  -- 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
487
{-
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
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
512 513
************************************************************************
*                                                                      *
514
              Printing IfaceDecl
Austin Seipp's avatar
Austin Seipp committed
515 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

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
541

542 543
instance HasOccName IfaceConDecl where
  occName = ifConOcc
544

545 546 547
instance HasOccName IfaceDecl where
  occName = ifName

548
instance Outputable IfaceDecl where
549 550
  ppr = pprIfaceDecl showAll

551 552 553 554 555 556 557 558 559
{-
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.
-}

560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
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
579
ppShowIface _                                     _   = Outputable.empty
580

581 582 583 584 585 586
-- 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

587
ppShowRhs :: ShowSub -> SDoc -> SDoc
588
ppShowRhs (ShowSub { ss_how_much = ShowHeader }) _   = Outputable.empty
589 590 591 592 593 594
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
595

Austin Seipp's avatar
Austin Seipp committed
596
{-
597 598 599 600 601 602 603
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.
604

605 606
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
607
-}
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622

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
623 624
-- NB: pprIfaceDecl is also used for pretty-printing TyThings in GHCi
--     See Note [Pretty-printing TyThings] in PprTyThing
625
pprIfaceDecl ss (IfaceData { ifName = tycon, ifCType = ctype,
626
                             ifCtxt = context, ifTyVars = tc_tyvars,
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
                             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
648
               IfNoParent -> pprIfaceDeclHead context ss tycon tc_tyvars
649 650 651
               _          -> ptext (sLit "instance") <+> pprIfaceTyConParent parent

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

658
    add_bars []     = Outputable.empty
659 660 661 662 663
    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
664
      | ok_con dc = Just $ pprIfaceConDecl ss gadt_style mk_user_con_res_ty fls dc
665
      | otherwise = Nothing
Adam Gundry's avatar
Adam Gundry committed
666
    fls = ifaceConDeclFields condecls
667

668 669 670 671 672 673 674
    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))
675
      where
676 677 678
        gadt_subst = mkFsEnv eq_spec
        done_univ_tv (tv,_) = isJust (lookupFsEnv gadt_subst tv)
        con_univ_tvs = filterOut done_univ_tv tc_tyvars
679

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

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

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

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

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

722 723 724 725 726 727 728
      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 "#-}")

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

737
pprIfaceDecl ss (IfaceFamily { ifName = tycon, ifTyVars = tyvars
Jan Stolarek's avatar
Jan Stolarek committed
738 739 740 741
                             , ifFamFlav = rhs, ifFamKind = kind
                             , ifResVar = res_var, ifFamInj = inj })
  = vcat [ hang (text "type family" <+> pprIfaceDeclHead [] ss tycon tyvars)
              2 (pp_inj res_var inj <+> ppShowRhs ss (pp_rhs rhs))
742
         , ppShowRhs ss (nest 2 (pp_branches rhs)) ]
743
  where
Jan Stolarek's avatar
Jan Stolarek committed
744 745 746 747 748 749 750 751 752 753
    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)]

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

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

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

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

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


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

800 801 802 803 804 805 806 807
-- 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)
808

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

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

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

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

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

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

instance Outputable IfaceTyConParent where
  ppr p = pprIfaceTyConParent p

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

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

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

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