in stage1, we should get isPrint and isUpper from Compat.Unicode, not Data.Char
[ghc-hetmet.git] / ghc / compiler / iface / BinIface.hs
index 255b86a..6d02fe0 100644 (file)
@@ -5,7 +5,7 @@
 -- 
 -- Binary interface file support.
 
-module BinIface ( writeBinIface, readBinIface, v_IgnoreHiVersion ) where
+module BinIface ( writeBinIface, readBinIface, v_IgnoreHiWay ) where
 
 #include "HsVersions.h"
 
@@ -14,16 +14,16 @@ import BasicTypes
 import NewDemand
 import IfaceSyn
 import VarEnv
-import TyCon           ( DataConDetails(..) )
+import InstEnv         ( OverlapFlag(..) )
+import Packages                ( PackageIdH(..) )
 import Class           ( DefMeth(..) )
 import CostCentre
-import Module          ( moduleName, mkModule )
-import OccName         ( OccName )
-import DriverState     ( v_Build_tag )
-import CmdLineOpts     ( opt_HiVersion )
+import StaticFlags     ( opt_HiVersion, v_Build_tag )
+import Kind            ( Kind(..) )
 import Panic
 import Binary
 import Util
+import Config          ( cGhcUnregisterised )
 
 import DATA_IOREF
 import EXCEPTION       ( throwDyn )
@@ -51,7 +51,6 @@ readBinIface hi_path = getBinFileWithDict hi_path
 {-! for IPName derive: Binary !-}
 {-! for Fixity derive: Binary !-}
 {-! for FixityDirection derive: Binary !-}
-{-! for NewOrData derive: Binary !-}
 {-! for Boxity derive: Binary !-}
 {-! for StrictnessMark derive: Binary !-}
 {-! for Activation derive: Binary !-}
@@ -62,9 +61,6 @@ readBinIface hi_path = getBinFileWithDict hi_path
 {-! for DmdResult derive: Binary !-}
 {-! for StrictSig derive: Binary !-}
 
--- TyCon
-{-! for DataConDetails derive: Binary !-}
-
 -- Class
 {-! for DefMeth derive: Binary !-}
 
@@ -99,8 +95,9 @@ readBinIface hi_path = getBinFileWithDict hi_path
 instance Binary ModIface where
    put_ bh (ModIface {
                 mi_module    = mod,
+                mi_boot      = is_boot,
                 mi_mod_vers  = mod_vers,
-                mi_package   = pkg_name,
+                mi_package   = _, -- we ignore the package on output
                 mi_orphan    = orphan,
                 mi_deps      = deps,
                 mi_usages    = usages,
@@ -112,10 +109,11 @@ instance Binary ModIface where
                 mi_insts     = insts,
                 mi_rules     = rules,
                 mi_rule_vers = rule_vers }) = do
-       build_tag <- readIORef v_Build_tag
-       put_ bh (show opt_HiVersion ++ build_tag)
-       put_ bh pkg_name
-       put_ bh (moduleName mod)
+       put_ bh (show opt_HiVersion)
+       way_descr <- getWayDescr
+       put  bh way_descr
+       put_ bh mod
+       put_ bh is_boot
        put_ bh mod_vers
        put_ bh orphan
        lazyPut bh deps
@@ -131,19 +129,26 @@ instance Binary ModIface where
 
    get bh = do
        check_ver  <- get bh
-        ignore_ver <- readIORef v_IgnoreHiVersion
-       build_tag <- readIORef v_Build_tag
-       let our_ver = show opt_HiVersion ++ build_tag
-        when (check_ver /= our_ver && not ignore_ver) $
+       let our_ver = show opt_HiVersion
+        when (check_ver /= our_ver) $
           -- use userError because this will be caught by readIface
           -- which will emit an error msg containing the iface module name.
           throwDyn (ProgramError (
                "mismatched interface file versions: expected "
                ++ our_ver ++ ", found " ++ check_ver))
 
-       pkg_name  <- get bh
-       mod_name  <- get bh
+       check_way <- get bh
+        ignore_way <- readIORef v_IgnoreHiWay
+       way_descr <- getWayDescr
+        when (not ignore_way && check_way /= way_descr) $
+          -- use userError because this will be caught by readIface
+          -- which will emit an error msg containing the iface module name.
+          throwDyn (ProgramError (
+               "mismatched interface file ways: expected "
+               ++ way_descr ++ ", found " ++ check_way))
 
+       mod_name  <- get bh
+       is_boot   <- get bh
        mod_vers  <- get bh
        orphan    <- get bh
        deps      <- lazyGet bh
@@ -157,14 +162,10 @@ instance Binary ModIface where
        rules     <- {-# SCC "bin_rules" #-} lazyGet bh
        rule_vers <- get bh
        return (ModIface {
-                mi_package   = pkg_name,
-                mi_module    = mkModule pkg_name mod_name,
-                       -- We write the module as a ModuleName, becuase whether
-                       -- or not it's a home-package module depends on the importer
-                       -- mkModule reconstructs the Module, by comparing the static 
-                       -- opt_InPackage flag with the package name in the interface file
+                mi_package   = HomePackage, -- to be filled in properly later
+                mi_module    = mod_name,
+                mi_boot      = is_boot,
                 mi_mod_vers  = mod_vers,
-                mi_boot      = False,          -- Binary interfaces are never .hi-boot files!
                 mi_orphan    = orphan,
                 mi_deps      = deps,
                 mi_usages    = usages,
@@ -173,6 +174,7 @@ instance Binary ModIface where
                 mi_fixities  = fixities,
                 mi_deprecs   = deprecs,
                 mi_decls     = decls,
+                mi_globals   = Nothing,
                 mi_insts     = insts,
                 mi_rules     = rules,
                 mi_rule_vers = rule_vers,
@@ -181,7 +183,14 @@ instance Binary ModIface where
                 mi_fix_fn = mkIfaceFixCache fixities,
                 mi_ver_fn = mkIfaceVerCache decls })
 
-GLOBAL_VAR(v_IgnoreHiVersion, False, Bool)
+GLOBAL_VAR(v_IgnoreHiWay, False, Bool)
+
+getWayDescr :: IO String
+getWayDescr = do
+  tag <- readIORef v_Build_tag
+  if cGhcUnregisterised == "YES" then return ('u':tag) else return tag
+       -- if this is an unregisterised build, make sure our interfaces
+       -- can't be used by a registerised build.
 
 -------------------------------------------------------------------------
 --             Types from: HscTypes
@@ -309,17 +318,6 @@ instance Binary TupCon where
          ac <- get bh
          return (TupCon ab ac)
 
-instance Binary NewOrData where
-    put_ bh NewType = do
-           putByte bh 0
-    put_ bh DataType = do
-           putByte bh 1
-    get bh = do
-           h <- getByte bh
-           case h of
-             0 -> do return NewType
-             _ -> do return DataType
-
 instance Binary RecFlag where
     put_ bh Recursive = do
            putByte bh 0
@@ -561,23 +559,29 @@ instance Binary IfaceBndr where
              _ -> do ab <- get bh
                      return (IfaceTvBndr ab)
 
-instance Binary IfaceKind where
-    put_ bh IfaceLiftedTypeKind   = putByte bh 0
-    put_ bh IfaceUnliftedTypeKind = putByte bh 1
-    put_ bh IfaceOpenTypeKind     = putByte bh 2
-    put_ bh (IfaceFunKind k1 k2)  = do 
-           putByte bh 3
+instance Binary Kind where
+    put_ bh LiftedTypeKind   = putByte bh 0
+    put_ bh UnliftedTypeKind = putByte bh 1
+    put_ bh OpenTypeKind     = putByte bh 2
+    put_ bh ArgTypeKind      = putByte bh 3
+    put_ bh UbxTupleKind     = putByte bh 4
+    put_ bh (FunKind k1 k2)  = do 
+           putByte bh 5
            put_ bh k1
            put_ bh k2
+    put_ bh (KindVar kv) = pprPanic "BinIface.put_: kind var" (ppr kv)
+
     get bh = do
            h <- getByte bh
            case h of
-             0 -> return IfaceLiftedTypeKind 
-             1 -> return IfaceUnliftedTypeKind
-             2 -> return IfaceOpenTypeKind
+             0 -> return LiftedTypeKind 
+             1 -> return UnliftedTypeKind
+             2 -> return OpenTypeKind
+             3 -> return ArgTypeKind
+             4 -> return UbxTupleKind
              _ -> do k1 <- get bh
                      k2 <- get bh
-                     return (IfaceFunKind k1 k2)
+                     return (FunKind k1 k2)
 
 instance Binary IfaceType where
     put_ bh (IfaceForAllTy aa ab) = do
@@ -640,17 +644,25 @@ instance Binary IfaceType where
 
 instance Binary IfaceTyCon where
        -- Int,Char,Bool can't show up here because they can't not be saturated
-   put_ bh IfaceListTc = putByte bh 1
-   put_ bh IfacePArrTc = putByte bh 2
-   put_ bh (IfaceTupTc bx ar) = do { putByte bh 3; put_ bh bx; put_ bh ar }
-   put_ bh tc = pprPanic "BinIface.put:" (ppr tc)      -- Dealt with by the IfaceType instance
+
+   put_ bh IfaceIntTc                = putByte bh 1
+   put_ bh IfaceBoolTc               = putByte bh 2
+   put_ bh IfaceCharTc               = putByte bh 3
+   put_ bh IfaceListTc               = putByte bh 4
+   put_ bh IfacePArrTc               = putByte bh 5
+   put_ bh (IfaceTupTc bx ar) = do { putByte bh 6; put_ bh bx; put_ bh ar }
+   put_ bh (IfaceTc ext)      = do { putByte bh 7; put_ bh ext }
 
    get bh = do
        h <- getByte bh
        case h of
-         1 -> return IfaceListTc
-         2 -> return IfacePArrTc
-         _ -> do { bx <- get bh; ar <- get bh; return (IfaceTupTc bx ar) }
+         1 -> return IfaceIntTc
+         2 -> return IfaceBoolTc
+         3 -> return IfaceCharTc
+         4 -> return IfaceListTc
+         5 -> return IfacePArrTc
+         6 -> do { bx <- get bh; ar <- get bh; return (IfaceTupTc bx ar) }
+         _ -> do { ext <- get bh; return (IfaceTc ext) }
 
 instance Binary IfacePredType where
     put_ bh (IfaceClassP aa ab) = do
@@ -694,10 +706,13 @@ instance Binary IfaceExpr where
            putByte bh 4
            put_ bh ag
            put_ bh ah
-    put_ bh (IfaceCase ai aj ak) = do
+-- gaw 2004
+    put_ bh (IfaceCase ai aj al ak) = do
            putByte bh 5
            put_ bh ai
            put_ bh aj
+-- gaw 2004
+            put_ bh al
            put_ bh ak
     put_ bh (IfaceLet al am) = do
            putByte bh 6
@@ -735,8 +750,11 @@ instance Binary IfaceExpr where
                      return (IfaceApp ag ah)
              5 -> do ai <- get bh
                      aj <- get bh
+-- gaw 2004
+                      al <- get bh                   
                      ak <- get bh
-                     return (IfaceCase ai aj ak)
+-- gaw 2004
+                     return (IfaceCase ai aj al ak)
              6 -> do al <- get bh
                      am <- get bh
                      return (IfaceLet al am)
@@ -795,14 +813,13 @@ instance Binary IfaceIdInfo where
     put_ bh NoInfo = putByte bh 0
     put_ bh (HasInfo i) = do
            putByte bh 1
-           lazyPut bh i
-    put_ bh DiscardedInfo = panic "BinIface:DiscardedInfo"
+           lazyPut bh i                        -- NB lazyPut
 
     get bh = do
            h <- getByte bh
            case h of
              0 -> return NoInfo
-             _ -> do info <- lazyGet bh
+             _ -> do info <- lazyGet bh        -- NB lazyGet
                      return (HasInfo info)
 
 instance Binary IfaceInfoItem where
@@ -876,7 +893,7 @@ instance Binary IfaceDecl where
            put_ bh idinfo
     put_ bh (IfaceForeign ae af) = 
        error "Binary.put_(IfaceDecl): IfaceForeign"
-    put_ bh (IfaceData a1 a2 a3 a4 a5 a6 a7 a8) = do
+    put_ bh (IfaceData a1 a2 a3 a4 a5 a6 a7) = do
            putByte bh 2
            put_ bh a1
            put_ bh a2
@@ -885,7 +902,6 @@ instance Binary IfaceDecl where
            put_ bh a5
            put_ bh a6
            put_ bh a7
-           put_ bh a8
 
     put_ bh (IfaceSyn aq ar as at) = do
            putByte bh 3
@@ -918,8 +934,7 @@ instance Binary IfaceDecl where
                    a5 <- get bh
                    a6 <- get bh
                    a7 <- get bh
-                   a8 <- get bh
-                   return (IfaceData a1 a2 a3 a4 a5 a6 a7 a8)
+                   return (IfaceData a1 a2 a3 a4 a5 a6 a7)
              3 -> do
                    aq <- get bh
                    ar <- get bh
@@ -937,15 +952,54 @@ instance Binary IfaceDecl where
                    return (IfaceClass a1 a2 a3 a4 a5 a6 a7)
 
 instance Binary IfaceInst where
-    put_ bh (IfaceInst ty dfun) = do
-           put_ bh ty
+    put_ bh (IfaceInst cls tys dfun flag orph) = do
+           put_ bh cls
+           put_ bh tys
            put_ bh dfun
-    get bh = do ty   <- get bh
+           put_ bh flag
+           put_ bh orph
+    get bh = do cls  <- get bh
+               tys  <- get bh
                dfun <- get bh
-               return (IfaceInst ty dfun)
+               flag <- get bh
+               orph <- get bh
+               return (IfaceInst cls tys dfun flag orph)
+
+instance Binary OverlapFlag where
+    put_ bh NoOverlap  = putByte bh 0
+    put_ bh OverlapOk  = putByte bh 1
+    put_ bh Incoherent = putByte bh 2
+    get bh = do h <- getByte bh
+               case h of
+                 0 -> return NoOverlap
+                 1 -> return OverlapOk
+                 2 -> return Incoherent
+
+instance Binary IfaceConDecls where
+    put_ bh IfAbstractTyCon = putByte bh 0
+    put_ bh (IfDataTyCon cs) = do { putByte bh 1
+                                 ; put_ bh cs }
+    put_ bh (IfNewTyCon c)  = do { putByte bh 2
+                                 ; put_ bh c }
+    get bh = do
+           h <- getByte bh
+           case h of
+             0 -> return IfAbstractTyCon
+             1 -> do cs <- get bh
+                     return (IfDataTyCon cs)
+             _ -> do aa <- get bh
+                     return (IfNewTyCon aa)
 
 instance Binary IfaceConDecl where
-    put_ bh (IfaceConDecl a1 a2 a3 a4 a5 a6) = do
+    put_ bh (IfVanillaCon a1 a2 a3 a4 a5) = do
+           putByte bh 0
+           put_ bh a1
+           put_ bh a2
+           put_ bh a3
+           put_ bh a4
+           put_ bh a5
+    put_ bh (IfGadtCon a1 a2 a3 a4 a5 a6) = do
+           putByte bh 1
            put_ bh a1
            put_ bh a2
            put_ bh a3
@@ -953,13 +1007,21 @@ instance Binary IfaceConDecl where
            put_ bh a5
            put_ bh a6
     get bh = do
-           a1 <- get bh
-           a2 <- get bh
-           a3 <- get bh
-           a4 <- get bh
-           a5 <- get bh
-           a6 <- get bh
-           return (IfaceConDecl a1 a2 a3 a4 a5 a6)
+           h <- getByte bh
+           case h of
+             0 -> do a1 <- get bh
+                     a2 <- get bh
+                     a3 <- get bh            
+                     a4 <- get bh
+                     a5 <- get bh
+                     return (IfVanillaCon a1 a2 a3 a4 a5)
+             _ -> do a1 <- get bh
+                     a2 <- get bh
+                     a3 <- get bh            
+                     a4 <- get bh
+                     a5 <- get bh
+                     a6 <- get bh
+                     return (IfGadtCon a1 a2 a3 a4 a5 a6)
 
 instance Binary IfaceClassOp where
    put_ bh (IfaceClassOp n def ty) = do        
@@ -973,14 +1035,14 @@ instance Binary IfaceClassOp where
        return (IfaceClassOp n def ty)
 
 instance Binary IfaceRule where
-       -- IfaceBuiltinRule should not happen here
-    put_ bh (IfaceRule a1 a2 a3 a4 a5 a6) = do
+    put_ bh (IfaceRule a1 a2 a3 a4 a5 a6 a7) = do
            put_ bh a1
            put_ bh a2
            put_ bh a3
            put_ bh a4
            put_ bh a5
            put_ bh a6
+           put_ bh a7
     get bh = do
            a1 <- get bh
            a2 <- get bh
@@ -988,18 +1050,7 @@ instance Binary IfaceRule where
            a4 <- get bh
            a5 <- get bh
            a6 <- get bh
-           return (IfaceRule a1 a2 a3 a4 a5 a6)
+           a7 <- get bh
+           return (IfaceRule a1 a2 a3 a4 a5 a6 a7)
 
-instance (Binary datacon) => Binary (DataConDetails datacon) where
-    put_ bh (DataCons aa) = do
-           putByte bh 0
-           put_ bh aa
-    put_ bh Unknown = do
-           putByte bh 1
-    get bh = do
-           h <- getByte bh
-           case h of
-             0 -> do aa <- get bh
-                     return (DataCons aa)
-             _ -> do return Unknown