IfaceSyn.hs 70.3 KB
Newer Older
Austin Seipp's avatar
Austin Seipp committed
1 2 3 4
{-
(c) The University of Glasgow 2006
(c) The GRASP/AQUA Project, Glasgow University, 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,
25
        ifaceDeclFingerprints,
26

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

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

#include "HsVersions.h"

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

64
import Control.Monad
65
import System.IO.Unsafe
66
import Data.Maybe (isJust)
67

68 69
infixl 3 &&&

Austin Seipp's avatar
Austin Seipp committed
70 71 72
{-
************************************************************************
*                                                                      *
73
                    Declarations
Austin Seipp's avatar
Austin Seipp committed
74 75 76
*                                                                      *
************************************************************************
-}
77

78 79 80 81
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
82 83 84
  -- very convenient.
  --
  -- We don't serialise the namespace onto the disk though; rather we
85 86
  -- drop it when serialising and add it back in when deserialising.

dterei's avatar
dterei committed
87
data IfaceDecl
88
  = IfaceId { ifName      :: IfaceTopBndr,
dterei's avatar
dterei committed
89 90 91 92
              ifType      :: IfaceType,
              ifIdDetails :: IfaceIdDetails,
              ifIdInfo    :: IfaceIdInfo }

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

107 108 109 110 111 112 113 114 115
  | 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
116 117 118
                   ifResVar  :: Maybe IfLclName,   -- Result variable name, used
                                                   -- only for pretty-printing
                                                   -- with --show-iface
119 120
                   ifFamKind :: IfaceKind,         -- Kind of the *rhs* (not of
                                                   -- the tycon)
Jan Stolarek's avatar
Jan Stolarek committed
121 122
                   ifFamFlav :: IfaceFamTyConFlav,
                   ifFamInj  :: Injectivity }      -- injectivity information
123

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

136
  | IfaceAxiom { ifName       :: IfaceTopBndr,        -- Axiom name
137
                 ifTyCon      :: IfaceTyCon,     -- LHS TyCon
138
                 ifRole       :: Role,           -- Role of axiom
139 140
                 ifAxBranches :: [IfaceAxBranch] -- Branches
    }
141

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


156 157 158 159 160
data IfaceTyConParent
  = IfNoParent
  | IfDataInstance IfExtName
                   IfaceTyCon
                   IfaceTcArgs
161

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

170
data IfaceClassOp = IfaceClassOp IfaceTopBndr DefMethSpec IfaceType
dterei's avatar
dterei committed
171 172 173
        -- Nothing    => no default method
        -- Just False => ordinary polymorphic default method
        -- Just True  => generic default method
174

175 176 177 178
data IfaceAT = IfaceAT  -- See Class.ClassATItem
                  IfaceDecl          -- The associated type declaration
                  (Maybe IfaceType)  -- Default associated type instance, if any

179

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

188
data IfaceConDecls
189
  = IfAbstractTyCon Bool        -- c.f TyCon.AbstractTyCon
190 191 192
  | IfDataFamTyCon              -- Data family
  | IfDataTyCon [IfaceConDecl]  -- Data type decls
  | IfNewTyCon  IfaceConDecl    -- Newtype decls
193

dterei's avatar
dterei committed
194
data IfaceConDecl
195
  = IfCon {
196
        ifConOcc     :: IfaceTopBndr,                -- Constructor name
dterei's avatar
dterei committed
197 198
        ifConWrapper :: Bool,                   -- True <=> has a wrapper
        ifConInfix   :: Bool,                   -- True <=> declared infix
199 200 201 202 203 204 205

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

206 207 208 209 210 211 212 213 214 215
        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
216

217
type IfaceEqSpec = [(IfLclName,IfaceType)]
218

219 220 221
-- | This corresponds to an HsImplBang; that is, the final
-- implementation decision about the data constructor arg
data IfaceBang
222 223
  = IfNoBang | IfStrict | IfUnpack | IfUnpackCo IfaceCoercion

224 225 226 227
-- | This corresponds to HsSrcBang
data IfaceSrcBang
  = IfSrcBang SrcUnpackedness SrcStrictness

228 229 230 231 232
data IfaceClsInst
  = IfaceClsInst { ifInstCls  :: IfExtName,                -- See comments with
                   ifInstTys  :: [Maybe IfaceTyCon],       -- the defn of ClsInst
                   ifDFun     :: IfExtName,                -- The dfun
                   ifOFlag    :: OverlapFlag,              -- Overlap flag
233
                   ifInstOrph :: IsOrphan }                -- See Note [Orphans] in InstEnv
dterei's avatar
dterei committed
234 235 236 237 238 239
        -- 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
240

241
-- The ifFamInstTys field of IfaceFamInst contains a list of the rough
242
-- match types
243
data IfaceFamInst
244
  = IfaceFamInst { ifFamInstFam      :: IfExtName            -- Family name
245
                 , ifFamInstTys      :: [Maybe IfaceTyCon]   -- See above
246
                 , ifFamInstAxiom    :: IfExtName            -- The axiom
247
                 , ifFamInstOrph     :: IsOrphan             -- Just like IfaceClsInst
dterei's avatar
dterei committed
248
                 }
249

250
data IfaceRule
dterei's avatar
dterei committed
251 252 253 254 255 256 257 258
  = 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,
259
        ifRuleOrph   :: IsOrphan   -- Just like IfaceClsInst
260 261
    }

262 263 264
data IfaceAnnotation
  = IfaceAnnotation {
        ifAnnotatedTarget :: IfaceAnnTarget,
265
        ifAnnotatedValue  :: AnnPayload
266 267 268 269
  }

type IfaceAnnTarget = AnnTarget OccName

270
-- Here's a tricky case:
271 272
--   * Compile with -O module A, and B which imports A.f
--   * Change function f in A, and recompile without -O
273
--   * When we read in old A.hi we read in its IdInfo (as a thunk)
dterei's avatar
dterei committed
274 275 276
--      (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
277
--   * The version comparison sees that new (=NoInfo) differs from old (=HasInfo *)
dterei's avatar
dterei committed
278
--      and so gives a new version.
279

280 281 282 283
data IfaceIdInfo
  = NoInfo                      -- When writing interface file without -O
  | HasInfo [IfaceInfoItem]     -- Has info, and here it is

284
data IfaceInfoItem
285 286 287 288 289
  = HsArity         Arity
  | HsStrictness    StrictSig
  | HsInline        InlinePragma
  | HsUnfold        Bool             -- True <=> isStrongLoopBreaker is true
                    IfaceUnfolding   -- See Note [Expose recursive functions]
290
  | HsNoCafRefs
291

292 293 294
-- 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
295
data IfaceUnfolding
296
  = IfCoreUnfold Bool IfaceExpr -- True <=> INLINABLE, False <=> regular unfolding
297 298
                                -- Possibly could eliminate the Bool here, the information
                                -- is also in the InlinePragma.
299

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

302
  | IfInlineRule Arity          -- INLINE pragmas
dterei's avatar
dterei committed
303 304 305
                 Bool           -- OK to inline even if *un*-saturated
                 Bool           -- OK to inline even if context is boring
                 IfaceExpr
306

307
  | IfDFunUnfold [IfaceBndr] [IfaceExpr]
308

309

310 311 312 313
-- 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
314

315 316 317
data IfaceIdDetails
  = IfVanillaId
  | IfRecSelId IfaceTyCon Bool
318
  | IfDFunId
319

Austin Seipp's avatar
Austin Seipp committed
320
{-
321 322
Note [Versioning of instances]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
323
See [http://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/RecompilationAvoidance#Instances]
324

325

Austin Seipp's avatar
Austin Seipp committed
326 327
************************************************************************
*                                                                      *
328
                Functions over declarations
Austin Seipp's avatar
Austin Seipp committed
329 330 331
*                                                                      *
************************************************************************
-}
332 333 334 335 336 337

visibleIfConDecls :: IfaceConDecls -> [IfaceConDecl]
visibleIfConDecls (IfAbstractTyCon {}) = []
visibleIfConDecls IfDataFamTyCon       = []
visibleIfConDecls (IfDataTyCon cs)     = cs
visibleIfConDecls (IfNewTyCon c)       = [c]
338

339
ifaceDeclImplicitBndrs :: IfaceDecl -> [OccName]
340 341 342
--  *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
343
-- See Note [Implicit TyThings] in HscTypes
344

345 346 347 348 349
-- 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.
350
ifaceDeclImplicitBndrs IfaceData {ifCons = IfAbstractTyCon {}}  = []
351 352

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

361

362 363 364 365 366
ifaceDeclImplicitBndrs (IfaceData {ifName = _tc_occ,
                              ifCons = IfDataTyCon cons })
  = -- for each data constructor in order,
    --    data constructor, worker, and (possibly) wrapper
    concatMap dc_occs cons
367 368
  where
    dc_occs con_decl
dterei's avatar
dterei committed
369 370 371 372 373 374 375 376 377
        | 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!

378
ifaceDeclImplicitBndrs (IfaceClass {ifCtxt = sc_ctxt, ifName = cls_tc_occ,
dterei's avatar
dterei committed
379
                               ifSigs = sigs, ifATs = ats })
batterseapower's avatar
batterseapower committed
380
  = --   (possibly) newtype coercion
381 382 383 384 385 386
    co_occs ++
    --    data constructor (DataCon namespace)
    --    data worker (Id namespace)
    --    no wrapper (class dictionaries never have a wrapper)
    [dc_occ, dcww_occ] ++
    -- associated types
387
    [ifName at | IfaceAT at _ <- ats ] ++
388
    -- superclass selectors
batterseapower's avatar
batterseapower committed
389
    [mkSuperDictSelOcc n cls_tc_occ | n <- [1..n_ctxt]] ++
390 391 392 393 394
    -- operation selectors
    [op | IfaceClassOp op  _ _ <- sigs]
  where
    n_ctxt = length sc_ctxt
    n_sigs = length sigs
batterseapower's avatar
batterseapower committed
395
    co_occs | is_newtype = [mkNewTyCoOcc cls_tc_occ]
dterei's avatar
dterei committed
396
            | otherwise  = []
397
    dcww_occ = mkDataConWorkerOcc dc_occ
batterseapower's avatar
batterseapower committed
398
    dc_occ = mkClassDataConOcc cls_tc_occ
dterei's avatar
dterei committed
399
    is_newtype = n_sigs + n_ctxt == 1 -- Sigh
400

401
ifaceDeclImplicitBndrs _ = []
402

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
-- -----------------------------------------------------------------------------
-- 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")
419

Austin Seipp's avatar
Austin Seipp committed
420 421 422
{-
************************************************************************
*                                                                      *
423
                Expressions
Austin Seipp's avatar
Austin Seipp committed
424 425 426
*                                                                      *
************************************************************************
-}
427 428 429 430 431 432

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

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
522

523 524
instance HasOccName IfaceConDecl where
  occName = ifConOcc
525

526 527 528
instance HasOccName IfaceDecl where
  occName = ifName

529
instance Outputable IfaceDecl where
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
  ppr = pprIfaceDecl showAll

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
551
ppShowIface _                                     _   = Outputable.empty
552 553

ppShowRhs :: ShowSub -> SDoc -> SDoc
554
ppShowRhs (ShowSub { ss_how_much = ShowHeader }) _   = Outputable.empty
555 556 557 558 559 560
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
561

Austin Seipp's avatar
Austin Seipp committed
562
{-
563 564 565 566 567 568 569
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.
570

571 572
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
573
-}
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588

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
589 590
-- NB: pprIfaceDecl is also used for pretty-printing TyThings in GHCi
--     See Note [Pretty-printing TyThings] in PprTyThing
591
pprIfaceDecl ss (IfaceData { ifName = tycon, ifCType = ctype,
592
                             ifCtxt = context, ifTyVars = tc_tyvars,
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
                             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
614
               IfNoParent -> pprIfaceDeclHead context ss tycon tc_tyvars
615 616 617
               _          -> ptext (sLit "instance") <+> pprIfaceTyConParent parent

    pp_roles
618
      | is_data_instance = Outputable.empty
619
      | otherwise        = pprRoles (== Representational) (pprPrefixIfDeclBndr ss tycon)
620
                                    tc_tyvars roles
621 622 623
            -- Don't display roles for data family instances (yet)
            -- See discussion on Trac #8672.

624
    add_bars []     = Outputable.empty
625 626 627 628 629 630 631
    add_bars (c:cs) = sep ((equals <+> c) : map (char '|' <+>) cs)

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

    show_con dc
      | ok_con dc = Just $ pprIfaceConDecl ss gadt_style mk_user_con_res_ty dc
      | otherwise = Nothing
632

633 634 635 636 637 638 639
    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))
640
      where
641 642 643
        gadt_subst = mkFsEnv eq_spec
        done_univ_tv (tv,_) = isJust (lookupFsEnv gadt_subst tv)
        con_univ_tvs = filterOut done_univ_tv tc_tyvars
644

645 646 647 648
    ppr_tc_app gadt_subst dflags
       = pprPrefixIfDeclBndr ss tycon
         <+> sep [ pprParendIfaceType (substIfaceTyVar gadt_subst tv)
                 | (tv,_kind) <- stripIfaceKindVars dflags tc_tyvars ]
649 650 651 652 653 654

    pp_nd = case condecls of
              IfAbstractTyCon d -> ptext (sLit "abstract") <> ppShowIface ss (parens (ppr d))
              IfDataFamTyCon    -> ptext (sLit "data family")
              IfDataTyCon _     -> ptext (sLit "data")
              IfNewTyCon _      -> ptext (sLit "newtype")
655

656 657 658
    pp_extra = vcat [pprCType ctype, pprRec isrec, pp_prom]

    pp_prom | is_prom   = ptext (sLit "Promotable")
659
            | otherwise = Outputable.empty
660 661 662 663 664 665


pprIfaceDecl ss (IfaceClass { ifATs = ats, ifSigs = sigs, ifRec = isrec
                            , ifCtxt   = context, ifName  = clas
                            , ifTyVars = tyvars,  ifRoles = roles
                            , ifFDs    = fds })
666
  = vcat [ pprRoles (== Nominal) (pprPrefixIfDeclBndr ss clas) tyvars roles
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
         , ptext (sLit "class") <+> pprIfaceDeclHead context ss clas tyvars
                                <+> pprFundeps fds <+> pp_where
         , nest 2 (vcat [vcat asocs, vcat dsigs, pprec])]
    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

687 688 689
pprIfaceDecl ss (IfaceSynonym { ifName   = tc
                              , ifTyVars = tv
                              , ifSynRhs = mono_ty })
690 691
  = hang (ptext (sLit "type") <+> pprIfaceDeclHead [] ss tc tv <+> equals)
       2 (sep [pprIfaceForAll tvs, pprIfaceContextArr theta, ppr tau])
692
  where
693
    (tvs, theta, tau) = splitIfaceSigmaTy mono_ty
694

695
pprIfaceDecl ss (IfaceFamily { ifName = tycon, ifTyVars = tyvars
Jan Stolarek's avatar
Jan Stolarek committed
696 697 698 699
                             , 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))
700
         , ppShowRhs ss (nest 2 (pp_branches rhs)) ]
701
  where
Jan Stolarek's avatar
Jan Stolarek committed
702 703 704 705 706 707 708 709 710 711
    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)]

712 713 714 715 716 717 718 719 720 721
    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)))
722
      = vcat (map (pprAxBranch (pprPrefixIfDeclBndr ss tycon)) brs)
723
        $$ ppShowIface ss (ptext (sLit "axiom") <+> ppr ax)
724
    pp_branches _ = Outputable.empty
725

726
pprIfaceDecl _ (IfacePatSyn { ifName = name, ifPatBuilder = builder,
727
                              ifPatUnivTvs = univ_tvs, ifPatExTvs = ex_tvs,
728
                              ifPatProvCtxt = prov_ctxt, ifPatReqCtxt = req_ctxt,
729 730 731 732 733 734 735
                              ifPatArgs = arg_tys,
                              ifPatTy = pat_ty} )
  = pprPatSynSig name is_bidirectional
                 (pprUserIfaceForAll tvs)
                 (pprIfaceContextMaybe prov_ctxt)
                 (pprIfaceContextMaybe req_ctxt)
                 (pprIfaceType ty)
Gergő Érdi's avatar
Gergő Érdi committed
736
  where
737
    is_bidirectional = isJust builder
738 739
    tvs = univ_tvs ++ ex_tvs
    ty = foldr IfaceFunTy pat_ty arg_tys
Gergő Érdi's avatar
Gergő Érdi committed
740

741 742
pprIfaceDecl ss (IfaceId { ifName = var, ifType = ty,
                              ifIdDetails = details, ifIdInfo = info })
743
  = vcat [ hang (pprPrefixIfDeclBndr ss var <+> dcolon)
744 745
              2 (pprIfaceSigmaType ty)
         , ppShowIface ss (ppr details)
746
         , ppShowIface ss (ppr info) ]
747 748 749 750 751 752 753

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


754
pprCType :: Maybe CType -> SDoc
755
pprCType Nothing      = Outputable.empty
756 757
pprCType (Just cType) = ptext (sLit "C type:") <+> ppr cType

758 759 760 761 762 763 764 765
-- 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)
766

Ian Lynagh's avatar
Ian Lynagh committed
767
pprRec :: RecFlag -> SDoc
768
pprRec NonRecursive = Outputable.empty
769
pprRec Recursive    = ptext (sLit "RecFlag: Recursive")
Ian Lynagh's avatar
Ian Lynagh committed
770

771
pprInfixIfDeclBndr, pprPrefixIfDeclBndr :: ShowSub -> OccName -> SDoc
772
pprInfixIfDeclBndr (ShowSub { ss_ppr_bndr = ppr_bndr }) occ
773 774 775
  = pprInfixVar (isSymOcc occ) (ppr_bndr occ)
pprPrefixIfDeclBndr (ShowSub { ss_ppr_bndr = ppr_bndr }) occ
  = parenSymOcc occ (ppr_bndr occ)
776

777
instance Outputable IfaceClassOp where
778 779 780 781
   ppr = pprIfaceClassOp showAll

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

785
instance Outputable IfaceAT where
786 787 788
   ppr = pprIfaceAT showAll

pprIfaceAT :: ShowSub -> IfaceAT -> SDoc
789
pprIfaceAT ss (IfaceAT d mb_def)
790
  = vcat [ pprIfaceDecl ss d
791
         , case mb_def of
792
              Nothing  -> Outputable.empty
793 794
              Just rhs -> nest 2 $
                          ptext (sLit "Default:") <+> ppr rhs ]
795 796 797 798 799 800

instance Outputable IfaceTyConParent where
  ppr p = pprIfaceTyConParent p

pprIfaceTyConParent :: IfaceTyConParent -> SDoc
pprIfaceTyConParent IfNoParent
801
  = Outputable.empty
802 803 804 805 806 807
pprIfaceTyConParent (IfDataInstance _ tc tys)
  = sdocWithDynFlags $ \dflags ->
    let ftys = stripKindArgs dflags tys
    in pprIfaceTypeApp tc ftys

pprIfaceDeclHead :: IfaceContext -> ShowSub -> OccName -> [IfaceTvBndr] -> SDoc
808
pprIfaceDeclHead context ss tc_occ tv_bndrs
809
  = sdocWithDynFlags $ \ dflags ->
810 811 812
    sep [ pprIfaceContextArr context
        , pprPrefixIfDeclBndr ss tc_occ
          <+> pprIfaceTvBndrs (stripIfaceKindVars dflags tv_bndrs) ]
813 814 815 816 817 818 819 820

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

pprIfaceConDecl :: ShowSub -> Bool
821
                -> (IfaceEqSpec -> ([IfaceTvBndr], SDoc))
822 823 824
                -> IfaceConDecl -> SDoc
pprIfaceConDecl ss gadt_style mk_user_con_res_ty
        (IfCon { ifConOcc = name, ifConInfix = is_infix,
825
                 ifConExTvs = ex_tvs,
dterei's avatar
dterei committed
826
                 ifConEqSpec = eq_spec, ifConCtxt = ctxt, ifConArgTys = arg_tys,
827
                 ifConStricts = stricts, ifConFields = labels })
828
  | gadt_style = pp_prefix_con <+> dcolon <+> ppr_ty
829
  | otherwise  = ppr_fields tys_w_strs
830
  where
831 832
    tys_w_strs :: [(IfaceBang, IfaceType)]
    tys_w_strs = zip stricts arg_tys
833
    pp_prefix_con = pprPrefixIfDeclBndr ss name
834

835 836
    (univ_tvs, pp_res_ty) = mk_user_con_res_ty eq_spec
    ppr_ty = pprIfaceForAllPart (univ_tvs ++ ex_tvs) ctxt pp_tau
dterei's avatar
dterei committed
837 838 839

        -- A bit gruesome this, but we can't form the full con_tau, and ppr it,
        -- because we don't have a Name for the tycon, only an OccName
840
    pp_tau = case map pprParendIfaceType arg_tys ++ [pp_res_ty] of
dterei's avatar
dterei committed
841 842
                (t:ts) -> fsep (t : map (arrow <+>) ts)
                []     -> panic "pp_con_taus"
843

844 845 846 847 848 849 850 851 852 853
    ppr_bang IfNoBang = ppWhen opt_PprStyle_Debug $ char '_'
    ppr_bang IfStrict = char '!'
    ppr_bang IfUnpack = ptext (sLit "{-# UNPACK #-}")
    ppr_bang (IfUnpackCo co) = ptext (sLit "! {-# UNPACK #-}") <>
                               pprParendIfaceCoercion co

    pprParendBangTy (bang, ty) = ppr_bang bang <> pprParendIfaceType ty
    pprBangTy       (bang, ty) = ppr_bang bang <> ppr ty

    maybe_show_label (lbl,bty)
854
      | showSub ss lbl = Just (pprPrefixIfDeclBndr ss lbl <+> dcolon <+> pprBangTy bty)
855 856 857 858
      | otherwise      = Nothing

    ppr_fields [ty1, ty2]
      | is_infix && null labels
859
      = sep [pprParendBangTy ty1, pprInfixIfDeclBndr ss name, pprParendBangTy ty2]
860
    ppr_fields fields
861 862
      | null labels = pp_prefix_con <+> sep (map pprParendBangTy fields)
      | otherwise   = pp_prefix_con <+> (braces $ sep $ punctuate comma $ ppr_trim $
863
                                    map maybe_show_label (zip labels fields))
864

865
instance Outputable IfaceRule where
866
  ppr (IfaceRule { ifRuleName = name, ifActivation = act, ifRuleBndrs = bndrs,
dterei's avatar
dterei committed
867
                   ifRuleHead = fn, ifRuleArgs = args, ifRuleRhs = rhs })
868
    = sep [hsep [pprRuleName name, ppr act,
dterei's avatar
dterei committed
869 870 871
                 ptext (sLit "forall") <+> pprIfaceBndrs bndrs],
           nest 2 (sep [ppr fn <+> sep (map pprParendIfaceExpr args),
                        ptext (sLit "=") <+> ppr rhs])
872 873
      ]

874
instance Outputable IfaceClsInst where
875 876
  ppr (IfaceClsInst { ifDFun = dfun_id, ifOFlag = flag
                    , ifInstCls = cls, ifInstTys = mb_tcs})
dterei's avatar
dterei committed
877 878