Merge pull request #2076 from ttuegel/binary-lbi

Use Binary to save/restore persistent build config

Author: ttuegel

Cabal/Cabal.cabal

@@ -128,6 +128,7 @@ source-repository head
 library
   build-depends:
     base       >= 4.2 && < 5,
+    binary     >= 0.7 && < 0.8,
     deepseq    >= 1.3 && < 1.4,
     filepath   >= 1   && < 1.4,
     directory  >= 1   && < 1.3,
@@ -138,6 +139,10 @@ library
     pretty     >= 1   && < 1.2,
     bytestring >= 0.9
 
+  -- Needed for GHC.Generics before GHC 7.6
+  if impl(ghc < 7.6)
+    build-depends: ghc-prim >= 0.2 && < 0.3
+
   if !os(windows)
     build-depends:
       unix >= 2.0 && < 2.8
@@ -284,6 +289,7 @@ test-suite package-tests
   hs-source-dirs: tests
   build-depends:
     base,
+    binary     >= 0.7 && < 0.8,
     test-framework,
     test-framework-quickcheck2 >= 0.2.12,
     test-framework-hunit,

Cabal/Distribution/Compiler.hs

@@ -1,4 +1,6 @@
 {-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}
+
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Distribution.Compiler
@@ -35,10 +37,12 @@ module Distribution.Compiler (
   CompilerId(..),
   ) where
 
+import Data.Binary (Binary)
 import Data.Data (Data)
 import Data.Typeable (Typeable)
 import Data.Maybe (fromMaybe)
 import Distribution.Version (Version(..))
+import GHC.Generics (Generic)
 
 import qualified System.Info (compilerName, compilerVersion)
 import Distribution.Text (Text(..), display)
@@ -52,7 +56,9 @@ import Control.Monad (when)
 data CompilerFlavor = GHC | NHC | YHC | Hugs | HBC | Helium | JHC | LHC | UHC
                     | HaskellSuite String -- string is the id of the actual compiler
                     | OtherCompiler String
-  deriving (Show, Read, Eq, Ord, Typeable, Data)
+  deriving (Generic, Show, Read, Eq, Ord, Typeable, Data)
+
+instance Binary CompilerFlavor
 
 knownCompilerFlavors :: [CompilerFlavor]
 knownCompilerFlavors = [GHC, NHC, YHC, Hugs, HBC, Helium, JHC, LHC, UHC]
@@ -125,7 +131,9 @@ defaultCompilerFlavor = case buildCompilerFlavor of
 -- ------------------------------------------------------------
 
 data CompilerId = CompilerId CompilerFlavor Version
-  deriving (Eq, Ord, Read, Show)
+  deriving (Eq, Generic, Ord, Read, Show)
+
+instance Binary CompilerId
 
 instance Text CompilerId where
   disp (CompilerId f (Version [] _)) = disp f

Cabal/Distribution/InstalledPackageInfo.hs

@@ -1,3 +1,5 @@
+{-# LANGUAGE DeriveGeneric #-}
+
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Distribution.InstalledPackageInfo
@@ -89,6 +91,9 @@ import Distribution.Text
 import Text.PrettyPrint as Disp
 import qualified Distribution.Compat.ReadP as Parse
 
+import Data.Binary (Binary)
+import GHC.Generics (Generic)
+
 -- -----------------------------------------------------------------------------
 -- The InstalledPackageInfo type
 
@@ -131,7 +136,9 @@ data InstalledPackageInfo_ m
         haddockInterfaces :: [FilePath],
         haddockHTMLs      :: [FilePath]
     }
-    deriving (Read, Show)
+    deriving (Generic, Read, Show)
+
+instance Binary m => Binary (InstalledPackageInfo_ m)
 
 instance Package.Package          (InstalledPackageInfo_ str) where
    packageId = sourcePackageId
@@ -192,7 +199,9 @@ data ModuleReexport = ModuleReexport {
        moduleReexportDefiningName    :: ModuleName,
        moduleReexportName            :: ModuleName
     }
-    deriving (Read, Show)
+    deriving (Generic, Read, Show)
+
+instance Binary ModuleReexport
 
 instance Text ModuleReexport where
     disp (ModuleReexport pkgid origname newname) =

Cabal/Distribution/License.hs

@@ -1,4 +1,6 @@
 {-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}
+
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Distribution.License
@@ -51,9 +53,11 @@ import Distribution.Text (Text(..), display)
 import qualified Distribution.Compat.ReadP as Parse
 import qualified Text.PrettyPrint as Disp
 import Text.PrettyPrint ((<>))
+import Data.Binary (Binary)
 import qualified Data.Char as Char (isAlphaNum)
 import Data.Data (Data)
 import Data.Typeable (Typeable)
+import GHC.Generics (Generic)
 
 -- | Indicates the license under which a package's source code is released.
 -- Versions of the licenses not listed here will be rejected by Hackage and
@@ -110,7 +114,9 @@ data License =
 
     -- | Indicates an erroneous license name.
   | UnknownLicense String
-  deriving (Read, Show, Eq, Typeable, Data)
+  deriving (Generic, Read, Show, Eq, Typeable, Data)
+
+instance Binary License
 
 -- | The list of all currently recognised licenses.
 knownLicenses :: [License]

Cabal/Distribution/ModuleName.hs

@@ -1,4 +1,6 @@
 {-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}
+
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Distribution.ModuleName
@@ -22,21 +24,25 @@ module Distribution.ModuleName (
 import Distribution.Text
          ( Text(..) )
 
+import Data.Binary (Binary)
+import qualified Data.Char as Char
+         ( isAlphaNum, isUpper )
 import Data.Data (Data)
 import Data.Typeable (Typeable)
 import qualified Distribution.Compat.ReadP as Parse
 import qualified Text.PrettyPrint as Disp
-import qualified Data.Char as Char
-         ( isAlphaNum, isUpper )
-import System.FilePath
-         ( pathSeparator )
 import Data.List
          ( intercalate, intersperse )
+import GHC.Generics (Generic)
+import System.FilePath
+         ( pathSeparator )
 
 -- | A valid Haskell module name.
 --
 newtype ModuleName = ModuleName [String]
-  deriving (Eq, Ord, Read, Show, Typeable, Data)
+  deriving (Eq, Generic, Ord, Read, Show, Typeable, Data)
+
+instance Binary ModuleName
 
 instance Text ModuleName where
   disp (ModuleName ms) =

Cabal/Distribution/Package.hs

@@ -1,4 +1,6 @@
 {-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}
+
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Distribution.Package
@@ -46,19 +48,24 @@ import Distribution.Text (Text(..))
 import qualified Distribution.Compat.ReadP as Parse
 import Distribution.Compat.ReadP ((<++))
 import qualified Text.PrettyPrint as Disp
-import Text.PrettyPrint ((<>), (<+>), text)
+
 import Control.DeepSeq (NFData(..))
+import Data.Binary (Binary)
 import qualified Data.Char as Char
     ( isDigit, isAlphaNum, isUpper, isLower, ord, chr )
-import Data.List ( intercalate, sort, foldl' )
 import Data.Data ( Data )
+import Data.List ( intercalate, sort, foldl' )
 import Data.Typeable ( Typeable )
-import GHC.Fingerprint ( Fingerprint(..), fingerprintString )
 import Data.Word ( Word64 )
+import GHC.Fingerprint ( Fingerprint(..), fingerprintString )
+import GHC.Generics (Generic)
 import Numeric ( showIntAtBase )
+import Text.PrettyPrint ((<>), (<+>), text)
 
 newtype PackageName = PackageName { unPackageName :: String }
-    deriving (Read, Show, Eq, Ord, Typeable, Data)
+    deriving (Generic, Read, Show, Eq, Ord, Typeable, Data)
+
+instance Binary PackageName
 
 instance Text PackageName where
   disp (PackageName n) = Disp.text n
@@ -84,7 +91,9 @@ data PackageIdentifier
         pkgName    :: PackageName, -- ^The name of this package, eg. foo
         pkgVersion :: Version -- ^the version of this package, eg 1.2
      }
-     deriving (Read, Show, Eq, Ord, Typeable, Data)
+     deriving (Generic, Read, Show, Eq, Ord, Typeable, Data)
+
+instance Binary PackageIdentifier
 
 instance Text PackageIdentifier where
   disp (PackageIdentifier n v) = case v of
@@ -108,7 +117,9 @@ instance NFData PackageIdentifier where
 -- in a package database, or overlay of databases.
 --
 newtype InstalledPackageId = InstalledPackageId String
- deriving (Read,Show,Eq,Ord,Typeable,Data)
+ deriving (Generic, Read,Show,Eq,Ord,Typeable,Data)
+
+instance Binary InstalledPackageId
 
 instance Text InstalledPackageId where
   disp (InstalledPackageId str) = text str
@@ -137,7 +148,9 @@ data PackageKey
     -- old versions of GHC assume that the 'sourcePackageId' recorded for an
     -- installed package coincides with the package key it was compiled with.
     | OldPackageKey !PackageId
-    deriving (Read, Show, Eq, Ord, Typeable, Data)
+    deriving (Generic, Read, Show, Eq, Ord, Typeable, Data)
+
+instance Binary PackageKey
 
 -- | Convenience function which converts a fingerprint into a new-style package
 -- key.
@@ -231,7 +244,9 @@ instance NFData PackageKey where
 -- | Describes a dependency on a source package (API)
 --
 data Dependency = Dependency PackageName VersionRange
-                  deriving (Read, Show, Eq, Typeable, Data)
+                  deriving (Generic, Read, Show, Eq, Typeable, Data)
+
+instance Binary Dependency
 
 instance Text Dependency where
   disp (Dependency name ver) =