ghc/compiler/iface/BinIface.hs

   1 {-% DrIFT (Automatic class derivations for Haskell) v1.1 %-}
   2 {-% DrIFT (Automatic class derivations for Haskell) v1.1 %-}
   3 --
   4 --  (c) The University of Glasgow 2002
   5 --
   6 -- Binary interface file support.
   7
   8 module BinIface ( writeBinIface, readBinIface, v_IgnoreHiWay ) where
   9
  10 #include "HsVersions.h"
  11
  12 import HscTypes
  13 import BasicTypes
  14 import NewDemand
  15 import IfaceSyn
  16 import VarEnv
  17 import Packages         ( PackageIdH(..) )
  18 import Class            ( DefMeth(..) )
  19 import CostCentre
  20 import DriverState      ( v_Build_tag )
  21 import CmdLineOpts      ( opt_HiVersion )
  22 import Kind             ( Kind(..) )
  23 import Panic
  24 import Binary
  25 import Util
  26
  27 import DATA_IOREF
  28 import EXCEPTION        ( throwDyn )
  29 import Monad            ( when )
  30 import Outputable
  31
  32 #include "HsVersions.h"
  33
  34 -- ---------------------------------------------------------------------------
  35 writeBinIface :: FilePath -> ModIface -> IO ()
  36 writeBinIface hi_path mod_iface
  37   = putBinFileWithDict hi_path mod_iface
  38
  39 readBinIface :: FilePath -> IO ModIface
  40 readBinIface hi_path = getBinFileWithDict hi_path
  41
  42
  43 -- %*********************************************************
  44 -- %*                                                       *
  45 --              All the Binary instances
  46 -- %*                                                       *
  47 -- %*********************************************************
  48
  49 -- BasicTypes
  50 {-! for IPName derive: Binary !-}
  51 {-! for Fixity derive: Binary !-}
  52 {-! for FixityDirection derive: Binary !-}
  53 {-! for Boxity derive: Binary !-}
  54 {-! for StrictnessMark derive: Binary !-}
  55 {-! for Activation derive: Binary !-}
  56
  57 -- NewDemand
  58 {-! for Demand derive: Binary !-}
  59 {-! for Demands derive: Binary !-}
  60 {-! for DmdResult derive: Binary !-}
  61 {-! for StrictSig derive: Binary !-}
  62
  63 -- Class
  64 {-! for DefMeth derive: Binary !-}
  65
  66 -- HsTypes
  67 {-! for HsPred derive: Binary !-}
  68 {-! for HsType derive: Binary !-}
  69 {-! for TupCon derive: Binary !-}
  70 {-! for HsTyVarBndr derive: Binary !-}
  71
  72 -- HsCore
  73 {-! for UfExpr derive: Binary !-}
  74 {-! for UfConAlt derive: Binary !-}
  75 {-! for UfBinding derive: Binary !-}
  76 {-! for UfBinder derive: Binary !-}
  77 {-! for HsIdInfo derive: Binary !-}
  78 {-! for UfNote derive: Binary !-}
  79
  80 -- HsDecls
  81 {-! for ConDetails derive: Binary !-}
  82 {-! for BangType derive: Binary !-}
  83
  84 -- CostCentre
  85 {-! for IsCafCC derive: Binary !-}
  86 {-! for IsDupdCC derive: Binary !-}
  87 {-! for CostCentre derive: Binary !-}
  88
  89
  90
  91 -- ---------------------------------------------------------------------------
  92 -- Reading a binary interface into ParsedIface
  93
  94 instance Binary ModIface where
  95    put_ bh (ModIface {
  96                  mi_module    = mod,
  97                  mi_boot      = is_boot,
  98                  mi_mod_vers  = mod_vers,
  99                  mi_package   = _, -- we ignore the package on output
 100                  mi_orphan    = orphan,
 101                  mi_deps      = deps,
 102                  mi_usages    = usages,
 103                  mi_exports   = exports,
 104                  mi_exp_vers  = exp_vers,
 105                  mi_fixities  = fixities,
 106                  mi_deprecs   = deprecs,
 107                  mi_decls     = decls,
 108                  mi_insts     = insts,
 109                  mi_rules     = rules,
 110                  mi_rule_vers = rule_vers }) = do
 111         put_ bh (show opt_HiVersion)
 112         build_tag <- readIORef v_Build_tag
 113         put  bh build_tag
 114         put_ bh mod
 115         put_ bh is_boot
 116         put_ bh mod_vers
 117         put_ bh orphan
 118         lazyPut bh deps
 119         lazyPut bh usages
 120         put_ bh exports
 121         put_ bh exp_vers
 122         put_ bh fixities
 123         lazyPut bh deprecs
 124         put_ bh decls
 125         put_ bh insts
 126         lazyPut bh rules
 127         put_ bh rule_vers
 128
 129    get bh = do
 130         check_ver  <- get bh
 131         let our_ver = show opt_HiVersion
 132         when (check_ver /= our_ver) $
 133            -- use userError because this will be caught by readIface
 134            -- which will emit an error msg containing the iface module name.
 135            throwDyn (ProgramError (
 136                 "mismatched interface file versions: expected "
 137                 ++ our_ver ++ ", found " ++ check_ver))
 138
 139         check_way <- get bh
 140         ignore_way <- readIORef v_IgnoreHiWay
 141         build_tag <- readIORef v_Build_tag
 142         when (not ignore_way && check_way /= build_tag) $
 143            -- use userError because this will be caught by readIface
 144            -- which will emit an error msg containing the iface module name.
 145            throwDyn (ProgramError (
 146                 "mismatched interface file ways: expected "
 147                 ++ build_tag ++ ", found " ++ check_way))
 148
 149         mod_name  <- get bh
 150         is_boot   <- get bh
 151         mod_vers  <- get bh
 152         orphan    <- get bh
 153         deps      <- lazyGet bh
 154         usages    <- {-# SCC "bin_usages" #-} lazyGet bh
 155         exports   <- {-# SCC "bin_exports" #-} get bh
 156         exp_vers  <- get bh
 157         fixities  <- {-# SCC "bin_fixities" #-} get bh
 158         deprecs   <- {-# SCC "bin_deprecs" #-} lazyGet bh
 159         decls     <- {-# SCC "bin_tycldecls" #-} get bh
 160         insts     <- {-# SCC "bin_insts" #-} get bh
 161         rules     <- {-# SCC "bin_rules" #-} lazyGet bh
 162         rule_vers <- get bh
 163         return (ModIface {
 164                  mi_package   = HomePackage, -- to be filled in properly later
 165                  mi_module    = mod_name,
 166                  mi_boot      = is_boot,
 167                  mi_mod_vers  = mod_vers,
 168                  mi_orphan    = orphan,
 169                  mi_deps      = deps,
 170                  mi_usages    = usages,
 171                  mi_exports   = exports,
 172                  mi_exp_vers  = exp_vers,
 173                  mi_fixities  = fixities,
 174                  mi_deprecs   = deprecs,
 175                  mi_decls     = decls,
 176                  mi_globals   = Nothing,
 177                  mi_insts     = insts,
 178                  mi_rules     = rules,
 179                  mi_rule_vers = rule_vers,
 180                         -- And build the cached values
 181                  mi_dep_fn = mkIfaceDepCache deprecs,
 182                  mi_fix_fn = mkIfaceFixCache fixities,
 183                  mi_ver_fn = mkIfaceVerCache decls })
 184
 185 GLOBAL_VAR(v_IgnoreHiWay, False, Bool)
 186
 187 -------------------------------------------------------------------------
 188 --              Types from: HscTypes
 189 -------------------------------------------------------------------------
 190
 191 instance Binary Dependencies where
 192     put_ bh deps = do put_ bh (dep_mods deps)
 193                       put_ bh (dep_pkgs deps)
 194                       put_ bh (dep_orphs deps)
 195
 196     get bh = do ms <- get bh
 197                 ps <- get bh
 198                 os <- get bh
 199                 return (Deps { dep_mods = ms, dep_pkgs = ps, dep_orphs = os })
 200
 201 instance (Binary name) => Binary (GenAvailInfo name) where
 202     put_ bh (Avail aa) = do
 203             putByte bh 0
 204             put_ bh aa
 205     put_ bh (AvailTC ab ac) = do
 206             putByte bh 1
 207             put_ bh ab
 208             put_ bh ac
 209     get bh = do
 210             h <- getByte bh
 211             case h of
 212               0 -> do aa <- get bh
 213                       return (Avail aa)
 214               _ -> do ab <- get bh
 215                       ac <- get bh
 216                       return (AvailTC ab ac)
 217
 218 instance Binary Usage where
 219     put_ bh usg = do
 220         put_ bh (usg_name     usg)
 221         put_ bh (usg_mod      usg)
 222         put_ bh (usg_exports  usg)
 223         put_ bh (usg_entities usg)
 224         put_ bh (usg_rules    usg)
 225
 226     get bh = do
 227         nm    <- get bh
 228         mod   <- get bh
 229         exps  <- get bh
 230         ents  <- get bh
 231         rules <- get bh
 232         return (Usage { usg_name = nm, usg_mod = mod,
 233                         usg_exports = exps, usg_entities = ents,
 234                         usg_rules = rules })
 235
 236 instance Binary a => Binary (Deprecs a) where
 237     put_ bh NoDeprecs     = putByte bh 0
 238     put_ bh (DeprecAll t) = do
 239             putByte bh 1
 240             put_ bh t
 241     put_ bh (DeprecSome ts) = do
 242             putByte bh 2
 243             put_ bh ts
 244
 245     get bh = do
 246             h <- getByte bh
 247             case h of
 248               0 -> return NoDeprecs
 249               1 -> do aa <- get bh
 250                       return (DeprecAll aa)
 251               _ -> do aa <- get bh
 252                       return (DeprecSome aa)
 253
 254 -------------------------------------------------------------------------
 255 --              Types from: BasicTypes
 256 -------------------------------------------------------------------------
 257
 258 instance Binary Activation where
 259     put_ bh NeverActive = do
 260             putByte bh 0
 261     put_ bh AlwaysActive = do
 262             putByte bh 1
 263     put_ bh (ActiveBefore aa) = do
 264             putByte bh 2
 265             put_ bh aa
 266     put_ bh (ActiveAfter ab) = do
 267             putByte bh 3
 268             put_ bh ab
 269     get bh = do
 270             h <- getByte bh
 271             case h of
 272               0 -> do return NeverActive
 273               1 -> do return AlwaysActive
 274               2 -> do aa <- get bh
 275                       return (ActiveBefore aa)
 276               _ -> do ab <- get bh
 277                       return (ActiveAfter ab)
 278
 279 instance Binary StrictnessMark where
 280     put_ bh MarkedStrict = do
 281             putByte bh 0
 282     put_ bh MarkedUnboxed = do
 283             putByte bh 1
 284     put_ bh NotMarkedStrict = do
 285             putByte bh 2
 286     get bh = do
 287             h <- getByte bh
 288             case h of
 289               0 -> do return MarkedStrict
 290               1 -> do return MarkedUnboxed
 291               _ -> do return NotMarkedStrict
 292
 293 instance Binary Boxity where
 294     put_ bh Boxed = do
 295             putByte bh 0
 296     put_ bh Unboxed = do
 297             putByte bh 1
 298     get bh = do
 299             h <- getByte bh
 300             case h of
 301               0 -> do return Boxed
 302               _ -> do return Unboxed
 303
 304 instance Binary TupCon where
 305     put_ bh (TupCon ab ac) = do
 306             put_ bh ab
 307             put_ bh ac
 308     get bh = do
 309           ab <- get bh
 310           ac <- get bh
 311           return (TupCon ab ac)
 312
 313 instance Binary RecFlag where
 314     put_ bh Recursive = do
 315             putByte bh 0
 316     put_ bh NonRecursive = do
 317             putByte bh 1
 318     get bh = do
 319             h <- getByte bh
 320             case h of
 321               0 -> do return Recursive
 322               _ -> do return NonRecursive
 323
 324 instance Binary DefMeth where
 325     put_ bh NoDefMeth  = putByte bh 0
 326     put_ bh DefMeth    = putByte bh 1
 327     put_ bh GenDefMeth = putByte bh 2
 328     get bh = do
 329             h <- getByte bh
 330             case h of
 331               0 -> return NoDefMeth
 332               1 -> return DefMeth
 333               _ -> return GenDefMeth
 334
 335 instance Binary FixityDirection where
 336     put_ bh InfixL = do
 337             putByte bh 0
 338     put_ bh InfixR = do
 339             putByte bh 1
 340     put_ bh InfixN = do
 341             putByte bh 2
 342     get bh = do
 343             h <- getByte bh
 344             case h of
 345               0 -> do return InfixL
 346               1 -> do return InfixR
 347               _ -> do return InfixN
 348
 349 instance Binary Fixity where
 350     put_ bh (Fixity aa ab) = do
 351             put_ bh aa
 352             put_ bh ab
 353     get bh = do
 354           aa <- get bh
 355           ab <- get bh
 356           return (Fixity aa ab)
 357
 358 instance (Binary name) => Binary (IPName name) where
 359     put_ bh (Dupable aa) = do
 360             putByte bh 0
 361             put_ bh aa
 362     put_ bh (Linear ab) = do
 363             putByte bh 1
 364             put_ bh ab
 365     get bh = do
 366             h <- getByte bh
 367             case h of
 368               0 -> do aa <- get bh
 369                       return (Dupable aa)
 370               _ -> do ab <- get bh
 371                       return (Linear ab)
 372
 373 -------------------------------------------------------------------------
 374 --              Types from: Demand
 375 -------------------------------------------------------------------------
 376
 377 instance Binary DmdType where
 378         -- Ignore DmdEnv when spitting out the DmdType
 379   put bh (DmdType _ ds dr) = do p <- put bh ds; put bh dr; return (castBin p)
 380   get bh = do ds <- get bh; dr <- get bh; return (DmdType emptyVarEnv ds dr)
 381
 382 instance Binary Demand where
 383     put_ bh Top = do
 384             putByte bh 0
 385     put_ bh Abs = do
 386             putByte bh 1
 387     put_ bh (Call aa) = do
 388             putByte bh 2
 389             put_ bh aa
 390     put_ bh (Eval ab) = do
 391             putByte bh 3
 392             put_ bh ab
 393     put_ bh (Defer ac) = do
 394             putByte bh 4
 395             put_ bh ac
 396     put_ bh (Box ad) = do
 397             putByte bh 5
 398             put_ bh ad
 399     put_ bh Bot = do
 400             putByte bh 6
 401     get bh = do
 402             h <- getByte bh
 403             case h of
 404               0 -> do return Top
 405               1 -> do return Abs
 406               2 -> do aa <- get bh
 407                       return (Call aa)
 408               3 -> do ab <- get bh
 409                       return (Eval ab)
 410               4 -> do ac <- get bh
 411                       return (Defer ac)
 412               5 -> do ad <- get bh
 413                       return (Box ad)
 414               _ -> do return Bot
 415
 416 instance Binary Demands where
 417     put_ bh (Poly aa) = do
 418             putByte bh 0
 419             put_ bh aa
 420     put_ bh (Prod ab) = do
 421             putByte bh 1
 422             put_ bh ab
 423     get bh = do
 424             h <- getByte bh
 425             case h of
 426               0 -> do aa <- get bh
 427                       return (Poly aa)
 428               _ -> do ab <- get bh
 429                       return (Prod ab)
 430
 431 instance Binary DmdResult where
 432     put_ bh TopRes = do
 433             putByte bh 0
 434     put_ bh RetCPR = do
 435             putByte bh 1
 436     put_ bh BotRes = do
 437             putByte bh 2
 438     get bh = do
 439             h <- getByte bh
 440             case h of
 441               0 -> do return TopRes
 442               1 -> do return RetCPR     -- Really use RetCPR even if -fcpr-off
 443                                         -- The wrapper was generated for CPR in
 444                                         -- the imported module!
 445               _ -> do return BotRes
 446
 447 instance Binary StrictSig where
 448     put_ bh (StrictSig aa) = do
 449             put_ bh aa
 450     get bh = do
 451           aa <- get bh
 452           return (StrictSig aa)
 453
 454
 455 -------------------------------------------------------------------------
 456 --              Types from: CostCentre
 457 -------------------------------------------------------------------------
 458
 459 instance Binary IsCafCC where
 460     put_ bh CafCC = do
 461             putByte bh 0
 462     put_ bh NotCafCC = do
 463             putByte bh 1
 464     get bh = do
 465             h <- getByte bh
 466             case h of
 467               0 -> do return CafCC
 468               _ -> do return NotCafCC
 469
 470 instance Binary IsDupdCC where
 471     put_ bh OriginalCC = do
 472             putByte bh 0
 473     put_ bh DupdCC = do
 474             putByte bh 1
 475     get bh = do
 476             h <- getByte bh
 477             case h of
 478               0 -> do return OriginalCC
 479               _ -> do return DupdCC
 480
 481 instance Binary CostCentre where
 482     put_ bh NoCostCentre = do
 483             putByte bh 0
 484     put_ bh (NormalCC aa ab ac ad) = do
 485             putByte bh 1
 486             put_ bh aa
 487             put_ bh ab
 488             put_ bh ac
 489             put_ bh ad
 490     put_ bh (AllCafsCC ae) = do
 491             putByte bh 2
 492             put_ bh ae
 493     get bh = do
 494             h <- getByte bh
 495             case h of
 496               0 -> do return NoCostCentre
 497               1 -> do aa <- get bh
 498                       ab <- get bh
 499                       ac <- get bh
 500                       ad <- get bh
 501                       return (NormalCC aa ab ac ad)
 502               _ -> do ae <- get bh
 503                       return (AllCafsCC ae)
 504
 505 -------------------------------------------------------------------------
 506 --              IfaceTypes and friends
 507 -------------------------------------------------------------------------
 508
 509 instance Binary IfaceExtName where
 510     put_ bh (ExtPkg mod occ) = do
 511             putByte bh 0
 512             put_ bh mod
 513             put_ bh occ
 514     put_ bh (HomePkg mod occ vers) = do
 515             putByte bh 1
 516             put_ bh mod
 517             put_ bh occ
 518             put_ bh vers
 519     put_ bh (LocalTop occ) = do
 520             putByte bh 2
 521             put_ bh occ
 522     put_ bh (LocalTopSub occ _) = do    -- Write LocalTopSub just like LocalTop
 523             putByte bh 2
 524             put_ bh occ
 525
 526     get bh = do
 527             h <- getByte bh
 528             case h of
 529               0 -> do mod <- get bh
 530                       occ <- get bh
 531                       return (ExtPkg mod occ)
 532               1 -> do mod <- get bh
 533                       occ <- get bh
 534                       vers <- get bh
 535                       return (HomePkg mod occ vers)
 536               _ -> do occ <- get bh
 537                       return (LocalTop occ)
 538
 539 instance Binary IfaceBndr where
 540     put_ bh (IfaceIdBndr aa) = do
 541             putByte bh 0
 542             put_ bh aa
 543     put_ bh (IfaceTvBndr ab) = do
 544             putByte bh 1
 545             put_ bh ab
 546     get bh = do
 547             h <- getByte bh
 548             case h of
 549               0 -> do aa <- get bh
 550                       return (IfaceIdBndr aa)
 551               _ -> do ab <- get bh
 552                       return (IfaceTvBndr ab)
 553
 554 instance Binary Kind where
 555     put_ bh LiftedTypeKind   = putByte bh 0
 556     put_ bh UnliftedTypeKind = putByte bh 1
 557     put_ bh OpenTypeKind     = putByte bh 2
 558     put_ bh ArgTypeKind      = putByte bh 3
 559     put_ bh UbxTupleKind     = putByte bh 4
 560     put_ bh (FunKind k1 k2)  = do
 561             putByte bh 5
 562             put_ bh k1
 563             put_ bh k2
 564     put_ bh (KindVar kv) = pprPanic "BinIface.put_: kind var" (ppr kv)
 565
 566     get bh = do
 567             h <- getByte bh
 568             case h of
 569               0 -> return LiftedTypeKind
 570               1 -> return UnliftedTypeKind
 571               2 -> return OpenTypeKind
 572               3 -> return ArgTypeKind
 573               4 -> return UbxTupleKind
 574               _ -> do k1 <- get bh
 575                       k2 <- get bh
 576                       return (FunKind k1 k2)
 577
 578 instance Binary IfaceType where
 579     put_ bh (IfaceForAllTy aa ab) = do
 580             putByte bh 0
 581             put_ bh aa
 582             put_ bh ab
 583     put_ bh (IfaceTyVar ad) = do
 584             putByte bh 1
 585             put_ bh ad
 586     put_ bh (IfaceAppTy ae af) = do
 587             putByte bh 2
 588             put_ bh ae
 589             put_ bh af
 590     put_ bh (IfaceFunTy ag ah) = do
 591             putByte bh 3
 592             put_ bh ag
 593             put_ bh ah
 594     put_ bh (IfacePredTy aq) = do
 595             putByte bh 5
 596             put_ bh aq
 597
 598         -- Simple compression for common cases of TyConApp
 599     put_ bh (IfaceTyConApp IfaceIntTc  [])   = putByte bh 6
 600     put_ bh (IfaceTyConApp IfaceCharTc [])   = putByte bh 7
 601     put_ bh (IfaceTyConApp IfaceBoolTc [])   = putByte bh 8
 602     put_ bh (IfaceTyConApp IfaceListTc [ty]) = do { putByte bh 9; put_ bh ty }
 603         -- Unit tuple and pairs
 604     put_ bh (IfaceTyConApp (IfaceTupTc Boxed 0) [])      = putByte bh 10
 605     put_ bh (IfaceTyConApp (IfaceTupTc Boxed 2) [t1,t2]) = do { putByte bh 11; put_ bh t1; put_ bh t2 }
 606         -- Generic cases
 607     put_ bh (IfaceTyConApp (IfaceTc tc) tys) = do { putByte bh 12; put_ bh tc; put_ bh tys }
 608     put_ bh (IfaceTyConApp tc tys)           = do { putByte bh 13; put_ bh tc; put_ bh tys }
 609
 610     get bh = do
 611             h <- getByte bh
 612             case h of
 613               0 -> do aa <- get bh
 614                       ab <- get bh
 615                       return (IfaceForAllTy aa ab)
 616               1 -> do ad <- get bh
 617                       return (IfaceTyVar ad)
 618               2 -> do ae <- get bh
 619                       af <- get bh
 620                       return (IfaceAppTy ae af)
 621               3 -> do ag <- get bh
 622                       ah <- get bh
 623                       return (IfaceFunTy ag ah)
 624               5 -> do ap <- get bh
 625                       return (IfacePredTy ap)
 626
 627                 -- Now the special cases for TyConApp
 628               6 -> return (IfaceTyConApp IfaceIntTc [])
 629               7 -> return (IfaceTyConApp IfaceCharTc [])
 630               8 -> return (IfaceTyConApp IfaceBoolTc [])
 631               9 -> do { ty <- get bh; return (IfaceTyConApp IfaceListTc [ty]) }
 632               10 -> return (IfaceTyConApp (IfaceTupTc Boxed 0) [])
 633               11 -> do { t1 <- get bh; t2 <- get bh; return (IfaceTyConApp (IfaceTupTc Boxed 2) [t1,t2]) }
 634               12 -> do { tc <- get bh; tys <- get bh; return (IfaceTyConApp (IfaceTc tc) tys) }
 635               _  -> do { tc <- get bh; tys <- get bh; return (IfaceTyConApp tc tys) }
 636
 637 instance Binary IfaceTyCon where
 638         -- Int,Char,Bool can't show up here because they can't not be saturated
 639    put_ bh IfaceListTc = putByte bh 1
 640    put_ bh IfacePArrTc = putByte bh 2
 641    put_ bh (IfaceTupTc bx ar) = do { putByte bh 3; put_ bh bx; put_ bh ar }
 642    put_ bh tc = pprPanic "BinIface.put:" (ppr tc)       -- Dealt with by the IfaceType instance
 643
 644    get bh = do
 645         h <- getByte bh
 646         case h of
 647           1 -> return IfaceListTc
 648           2 -> return IfacePArrTc
 649           _ -> do { bx <- get bh; ar <- get bh; return (IfaceTupTc bx ar) }
 650
 651 instance Binary IfacePredType where
 652     put_ bh (IfaceClassP aa ab) = do
 653             putByte bh 0
 654             put_ bh aa
 655             put_ bh ab
 656     put_ bh (IfaceIParam ac ad) = do
 657             putByte bh 1
 658             put_ bh ac
 659             put_ bh ad
 660     get bh = do
 661             h <- getByte bh
 662             case h of
 663               0 -> do aa <- get bh
 664                       ab <- get bh
 665                       return (IfaceClassP aa ab)
 666               _ -> do ac <- get bh
 667                       ad <- get bh
 668                       return (IfaceIParam ac ad)
 669
 670 -------------------------------------------------------------------------
 671 --              IfaceExpr and friends
 672 -------------------------------------------------------------------------
 673
 674 instance Binary IfaceExpr where
 675     put_ bh (IfaceLcl aa) = do
 676             putByte bh 0
 677             put_ bh aa
 678     put_ bh (IfaceType ab) = do
 679             putByte bh 1
 680             put_ bh ab
 681     put_ bh (IfaceTuple ac ad) = do
 682             putByte bh 2
 683             put_ bh ac
 684             put_ bh ad
 685     put_ bh (IfaceLam ae af) = do
 686             putByte bh 3
 687             put_ bh ae
 688             put_ bh af
 689     put_ bh (IfaceApp ag ah) = do
 690             putByte bh 4
 691             put_ bh ag
 692             put_ bh ah
 693 -- gaw 2004
 694     put_ bh (IfaceCase ai aj al ak) = do
 695             putByte bh 5
 696             put_ bh ai
 697             put_ bh aj
 698 -- gaw 2004
 699             put_ bh al
 700             put_ bh ak
 701     put_ bh (IfaceLet al am) = do
 702             putByte bh 6
 703             put_ bh al
 704             put_ bh am
 705     put_ bh (IfaceNote an ao) = do
 706             putByte bh 7
 707             put_ bh an
 708             put_ bh ao
 709     put_ bh (IfaceLit ap) = do
 710             putByte bh 8
 711             put_ bh ap
 712     put_ bh (IfaceFCall as at) = do
 713             putByte bh 9
 714             put_ bh as
 715             put_ bh at
 716     put_ bh (IfaceExt aa) = do
 717             putByte bh 10
 718             put_ bh aa
 719     get bh = do
 720             h <- getByte bh
 721             case h of
 722               0 -> do aa <- get bh
 723                       return (IfaceLcl aa)
 724               1 -> do ab <- get bh
 725                       return (IfaceType ab)
 726               2 -> do ac <- get bh
 727                       ad <- get bh
 728                       return (IfaceTuple ac ad)
 729               3 -> do ae <- get bh
 730                       af <- get bh
 731                       return (IfaceLam ae af)
 732               4 -> do ag <- get bh
 733                       ah <- get bh
 734                       return (IfaceApp ag ah)
 735               5 -> do ai <- get bh
 736                       aj <- get bh
 737 -- gaw 2004
 738                       al <- get bh
 739                       ak <- get bh
 740 -- gaw 2004
 741                       return (IfaceCase ai aj al ak)
 742               6 -> do al <- get bh
 743                       am <- get bh
 744                       return (IfaceLet al am)
 745               7 -> do an <- get bh
 746                       ao <- get bh
 747                       return (IfaceNote an ao)
 748               8 -> do ap <- get bh
 749                       return (IfaceLit ap)
 750               9 -> do as <- get bh
 751                       at <- get bh
 752                       return (IfaceFCall as at)
 753               _ -> do aa <- get bh
 754                       return (IfaceExt aa)
 755
 756 instance Binary IfaceConAlt where
 757     put_ bh IfaceDefault = do
 758             putByte bh 0
 759     put_ bh (IfaceDataAlt aa) = do
 760             putByte bh 1
 761             put_ bh aa
 762     put_ bh (IfaceTupleAlt ab) = do
 763             putByte bh 2
 764             put_ bh ab
 765     put_ bh (IfaceLitAlt ac) = do
 766             putByte bh 3
 767             put_ bh ac
 768     get bh = do
 769             h <- getByte bh
 770             case h of
 771               0 -> do return IfaceDefault
 772               1 -> do aa <- get bh
 773                       return (IfaceDataAlt aa)
 774               2 -> do ab <- get bh
 775                       return (IfaceTupleAlt ab)
 776               _ -> do ac <- get bh
 777                       return (IfaceLitAlt ac)
 778
 779 instance Binary IfaceBinding where
 780     put_ bh (IfaceNonRec aa ab) = do
 781             putByte bh 0
 782             put_ bh aa
 783             put_ bh ab
 784     put_ bh (IfaceRec ac) = do
 785             putByte bh 1
 786             put_ bh ac
 787     get bh = do
 788             h <- getByte bh
 789             case h of
 790               0 -> do aa <- get bh
 791                       ab <- get bh
 792                       return (IfaceNonRec aa ab)
 793               _ -> do ac <- get bh
 794                       return (IfaceRec ac)
 795
 796 instance Binary IfaceIdInfo where
 797     put_ bh NoInfo = putByte bh 0
 798     put_ bh (HasInfo i) = do
 799             putByte bh 1
 800             lazyPut bh i
 801
 802     get bh = do
 803             h <- getByte bh
 804             case h of
 805               0 -> return NoInfo
 806               _ -> do info <- lazyGet bh
 807                       return (HasInfo info)
 808
 809 instance Binary IfaceInfoItem where
 810     put_ bh (HsArity aa) = do
 811             putByte bh 0
 812             put_ bh aa
 813     put_ bh (HsStrictness ab) = do
 814             putByte bh 1
 815             put_ bh ab
 816     put_ bh (HsUnfold ac ad) = do
 817             putByte bh 2
 818             put_ bh ac
 819             put_ bh ad
 820     put_ bh HsNoCafRefs = do
 821             putByte bh 3
 822     put_ bh (HsWorker ae af) = do
 823             putByte bh 4
 824             put_ bh ae
 825             put_ bh af
 826     get bh = do
 827             h <- getByte bh
 828             case h of
 829               0 -> do aa <- get bh
 830                       return (HsArity aa)
 831               1 -> do ab <- get bh
 832                       return (HsStrictness ab)
 833               2 -> do ac <- get bh
 834                       ad <- get bh
 835                       return (HsUnfold ac ad)
 836               3 -> do return HsNoCafRefs
 837               _ -> do ae <- get bh
 838                       af <- get bh
 839                       return (HsWorker ae af)
 840
 841 instance Binary IfaceNote where
 842     put_ bh (IfaceSCC aa) = do
 843             putByte bh 0
 844             put_ bh aa
 845     put_ bh (IfaceCoerce ab) = do
 846             putByte bh 1
 847             put_ bh ab
 848     put_ bh IfaceInlineCall = do
 849             putByte bh 2
 850     put_ bh IfaceInlineMe = do
 851             putByte bh 3
 852     put_ bh (IfaceCoreNote s) = do
 853             putByte bh 4
 854             put_ bh s
 855     get bh = do
 856             h <- getByte bh
 857             case h of
 858               0 -> do aa <- get bh
 859                       return (IfaceSCC aa)
 860               1 -> do ab <- get bh
 861                       return (IfaceCoerce ab)
 862               2 -> do return IfaceInlineCall
 863               3 -> do return IfaceInlineMe
 864               _ -> do ac <- get bh
 865                       return (IfaceCoreNote ac)
 866
 867
 868 -------------------------------------------------------------------------
 869 --              IfaceDecl and friends
 870 -------------------------------------------------------------------------
 871
 872 instance Binary IfaceDecl where
 873     put_ bh (IfaceId name ty idinfo) = do
 874             putByte bh 0
 875             put_ bh name
 876             put_ bh ty
 877             put_ bh idinfo
 878     put_ bh (IfaceForeign ae af) =
 879         error "Binary.put_(IfaceDecl): IfaceForeign"
 880     put_ bh (IfaceData a1 a2 a3 a4 a5 a6) = do
 881             putByte bh 2
 882             put_ bh a1
 883             put_ bh a2
 884             put_ bh a3
 885             put_ bh a4
 886             put_ bh a5
 887             put_ bh a6
 888
 889     put_ bh (IfaceSyn aq ar as at) = do
 890             putByte bh 3
 891             put_ bh aq
 892             put_ bh ar
 893             put_ bh as
 894             put_ bh at
 895     put_ bh (IfaceClass a1 a2 a3 a4 a5 a6 a7) = do
 896             putByte bh 4
 897             put_ bh a1
 898             put_ bh a2
 899             put_ bh a3
 900             put_ bh a4
 901             put_ bh a5
 902             put_ bh a6
 903             put_ bh a7
 904     get bh = do
 905             h <- getByte bh
 906             case h of
 907               0 -> do name   <- get bh
 908                       ty     <- get bh
 909                       idinfo <- get bh
 910                       return (IfaceId name ty idinfo)
 911               1 -> error "Binary.get(TyClDecl): ForeignType"
 912               2 -> do
 913                     a1 <- get bh
 914                     a2 <- get bh
 915                     a3 <- get bh
 916                     a4 <- get bh
 917                     a5 <- get bh
 918                     a6 <- get bh
 919                     return (IfaceData a1 a2 a3 a4 a5 a6)
 920               3 -> do
 921                     aq <- get bh
 922                     ar <- get bh
 923                     as <- get bh
 924                     at <- get bh
 925                     return (IfaceSyn aq ar as at)
 926               _ -> do
 927                     a1 <- get bh
 928                     a2 <- get bh
 929                     a3 <- get bh
 930                     a4 <- get bh
 931                     a5 <- get bh
 932                     a6 <- get bh
 933                     a7 <- get bh
 934                     return (IfaceClass a1 a2 a3 a4 a5 a6 a7)
 935
 936 instance Binary IfaceInst where
 937     put_ bh (IfaceInst ty dfun) = do
 938             put_ bh ty
 939             put_ bh dfun
 940     get bh = do ty   <- get bh
 941                 dfun <- get bh
 942                 return (IfaceInst ty dfun)
 943
 944 instance Binary IfaceConDecls where
 945     put_ bh IfAbstractTyCon = putByte bh 0
 946     put_ bh (IfDataTyCon st cs) = do { putByte bh 1
 947                                      ; put_ bh st
 948                                      ; put_ bh cs }
 949     put_ bh (IfNewTyCon c)  = do { putByte bh 2
 950                                   ; put_ bh c }
 951     get bh = do
 952             h <- getByte bh
 953             case h of
 954               0 -> return IfAbstractTyCon
 955               1 -> do st <- get bh
 956                       cs <- get bh
 957                       return (IfDataTyCon st cs)
 958               _ -> do aa <- get bh
 959                       return (IfNewTyCon aa)
 960
 961 instance Binary IfaceConDecl where
 962     put_ bh (IfVanillaCon a1 a2 a3 a4 a5) = do
 963             putByte bh 0
 964             put_ bh a1
 965             put_ bh a2
 966             put_ bh a3
 967             put_ bh a4
 968             put_ bh a5
 969     put_ bh (IfGadtCon a1 a2 a3 a4 a5 a6) = do
 970             putByte bh 1
 971             put_ bh a1
 972             put_ bh a2
 973             put_ bh a3
 974             put_ bh a4
 975             put_ bh a5
 976             put_ bh a6
 977     get bh = do
 978             h <- getByte bh
 979             case h of
 980               0 -> do a1 <- get bh
 981                       a2 <- get bh
 982                       a3 <- get bh
 983                       a4 <- get bh
 984                       a5 <- get bh
 985                       return (IfVanillaCon a1 a2 a3 a4 a5)
 986               _ -> do a1 <- get bh
 987                       a2 <- get bh
 988                       a3 <- get bh
 989                       a4 <- get bh
 990                       a5 <- get bh
 991                       a6 <- get bh
 992                       return (IfGadtCon a1 a2 a3 a4 a5 a6)
 993
 994 instance Binary IfaceClassOp where
 995    put_ bh (IfaceClassOp n def ty) = do
 996         put_ bh n
 997         put_ bh def
 998         put_ bh ty
 999    get bh = do
1000         n <- get bh
1001         def <- get bh
1002         ty <- get bh
1003         return (IfaceClassOp n def ty)
1004
1005 instance Binary IfaceRule where
1006         -- IfaceBuiltinRule should not happen here
1007     put_ bh (IfaceRule a1 a2 a3 a4 a5 a6) = do
1008             put_ bh a1
1009             put_ bh a2
1010             put_ bh a3
1011             put_ bh a4
1012             put_ bh a5
1013             put_ bh a6
1014     get bh = do
1015             a1 <- get bh
1016             a2 <- get bh
1017             a3 <- get bh
1018             a4 <- get bh
1019             a5 <- get bh
1020             a6 <- get bh
1021             return (IfaceRule a1 a2 a3 a4 a5 a6)
1022
1023