Merge pull request #319 from atsampson/shake0.16

Fix #288: Upgrade hptool for shake version 0.16

Author: gbaz

hptool/hptool.cabal

@@ -55,7 +55,7 @@ Executable hptool
     containers,
     directory,
     hastache >=0.6.0,
-    shake >= 0.14 && < 0.16,
+    shake >= 0.16,
     split,
     text,
     transformers,

hptool/src/Config.hs

@@ -1,5 +1,5 @@
 {-# LANGUAGE ConstraintKinds, DeriveDataTypeable, GeneralizedNewtypeDeriving,
-             RecordWildCards #-}
+             RecordWildCards, TypeFamilies #-}
 
 module Config
     ( askHpRelease
@@ -19,35 +19,22 @@ import Development.Shake.FilePath
 import Development.Shake.Rule
 
 import Types
-import Utils (readMaybe, version)
+import Utils (version)
 
 
-readOracle :: (ShakeValue q, Read a) => String -> q -> Action a
-readOracle name q = do
-    s <- askOracle q
-    maybe (error $ msg s) return $ readMaybe reads s
-  where
-    msg s = "readOracle failed to parse " ++ name ++ " from " ++ show s
-
-{-
-Release and BuildConfig are not used directly in the oracles because writing all
-the required instances is possible but lengthly, and Version is missing
-instances for both Hashable and Binary. It is easier to just rely on the
-generated instances of Show and Read for these, and use String in the oracle.
--}
-
 newtype HpReleaseQ = HpReleaseQ ()
     deriving (Show,Typeable,Eq,Hashable,Binary,NFData)
+type instance RuleResult HpReleaseQ = Release
 
 -- | Provide the Platform release information
 -- The release information will be tracked as a dependency
-
 askHpRelease :: Action Release
-askHpRelease = readOracle "HpRelease" (HpReleaseQ ())
+askHpRelease = askOracle $ HpReleaseQ ()
 
 
 newtype GhcBinDistTarFileQ = GhcBinDistTarFileQ ()
     deriving (Show,Typeable,Eq,Hashable,Binary,NFData)
+type instance RuleResult GhcBinDistTarFileQ = FilePath
 
 -- | Provide the bindist tar file.
 -- The filepath will be tracked as a dependency.
@@ -60,18 +47,17 @@ askGhcBinDistTarFile = do
 
 newtype BuildConfigQ = BuildConfigQ ()
     deriving (Show,Typeable,Eq,Hashable,Binary,NFData)
+type instance RuleResult BuildConfigQ = BuildConfig
 
 -- | Provide the Platform release information
 -- The release information will be tracked as a dependency
-
 askBuildConfig :: Action BuildConfig
-askBuildConfig = readOracle "BuildConfig" (BuildConfigQ ())
+askBuildConfig = askOracle $ BuildConfigQ ()
 
-newtype StackExeQ = StackExeQ ()
-    deriving (Show,Typeable,Eq,Hashable,Binary,NFData)
 
-newtype CabalExeQ = CabalExeQ ()
+newtype StackExeQ = StackExeQ ()
     deriving (Show,Typeable,Eq,Hashable,Binary,NFData)
+type instance RuleResult StackExeQ = FilePath
 
 -- | Provide the stack executable
 -- The filepath will be tracked as a dependency
@@ -81,6 +67,11 @@ askStackExe = do
     need [stackexe]
     return stackexe
 
+
+newtype CabalExeQ = CabalExeQ ()
+    deriving (Show,Typeable,Eq,Hashable,Binary,NFData)
+type instance RuleResult CabalExeQ = FilePath
+
 -- | Provide the stack executable
 -- The filepath will be tracked as a dependency
 askCabalExe :: Action FilePath
@@ -89,18 +80,19 @@ askCabalExe = do
     need [cabalexe]
     return cabalexe
 
+
 addConfigOracle :: Release -> FilePath -> (FilePath,FilePath) -> Maybe FilePath -> Bool -> Rules BuildConfig
 addConfigOracle hpRel tarFile (cabalexe,stackexe) prefix includeExtra = do
     _ <- addOracle $
-            \(HpReleaseQ _) -> return $ show hpRel
+            \(HpReleaseQ _) -> return hpRel
     _ <- addOracle $
             \(GhcBinDistTarFileQ _) -> return tarFile
     _ <- addOracle $
             \(CabalExeQ _) -> return cabalexe
     _ <- addOracle $
             \(StackExeQ _) -> return stackexe
     _ <- addOracle $
-            \(BuildConfigQ _) -> either fail (return . show) buildConfig
+            \(BuildConfigQ _) -> either fail return buildConfig
     either fail return buildConfig
   where
     buildConfig = extractBuildConfig hpRel tarFile prefix includeExtra

hptool/src/Types.hs

@@ -1,4 +1,4 @@
-{-# LANGUAGE CPP, RecordWildCards #-}
+{-# LANGUAGE CPP, RecordWildCards, DeriveAnyClass, DeriveGeneric #-}
 
 module Types
     ( PackageName
@@ -17,9 +17,11 @@ module Types
 
 import Control.Applicative
 import Data.Char (isDigit)
-import Data.List (intercalate)
+import Data.List (intercalate, sort)
 import Data.Version (Version, showVersion, parseVersion)
 import Development.Shake (Action)
+import Development.Shake.Classes (Binary, Hashable, NFData)
+import GHC.Generics
 import Text.ParserCombinators.ReadP (ReadP,
     char, endBy1, munch, readP_to_S, satisfy, skipSpaces)
 
@@ -32,6 +34,7 @@ type PackageName = String
 -- a hyphen between the two parts. i.e.: "acme-inator-0.1.0.0". Note that no
 -- component of a package name can start with a digit.
 data Package = Package { pkgName :: PackageName, pkgVersion :: Version }
+  deriving (Eq, Ord, Generic, Hashable, Binary, NFData)
 
 readPackageP :: ReadP Package
 readPackageP = do
@@ -58,7 +61,7 @@ instance Show Package where
 data IncludeType = IncGHC | IncGHCLib | IncGHCTool | IncLib | IncTool
                  | IncIfWindows IncludeType
                  | IncIfNotWindows IncludeType
-  deriving (Eq, Read, Show)
+  deriving (Eq, Read, Show, Ord, Generic, Hashable, Binary, NFData)
 
 
 readFixedPacakgeP :: (Version -> a) -> String -> ReadP a
@@ -72,6 +75,7 @@ readFixedPacakgeP f fixedName = do
 -- | Version of the platform itself.
 -- 'Read'/'Show' format is "haskell-platform-<version>"
 newtype HpVersion = HpVersion { hpVersion :: Version }
+  deriving (Eq, Generic, Hashable, Binary, NFData)
 instance Read HpVersion where
     readsPrec _ = readP_to_S $ readFixedPacakgeP HpVersion "haskell-platform"
 instance Show HpVersion where
@@ -80,6 +84,7 @@ instance Show HpVersion where
 -- | Version of the GHC.
 -- 'Read'/'Show' format is "ghc-<version>"
 newtype GhcVersion = GhcVersion { ghcVersion :: Version }
+  deriving (Eq, Generic, Hashable, Binary, NFData)
 instance Read GhcVersion where
     readsPrec _ = readP_to_S $ readFixedPacakgeP GhcVersion "ghc"
 instance Show GhcVersion where
@@ -94,7 +99,14 @@ data Release = Release
     , relMinimalIncludes :: [Include]
     , relIncludes :: [Include]
     }
-  deriving (Read, Show)
+  deriving (Read, Show, Generic, Hashable, Binary, NFData)
+-- The order of entries in the relMinimalIncludes and relIncludes does not
+-- matter for equality (and these lists will have 20-40 entries max with no
+-- duplicates), so this Eq instance addresses that.
+instance Eq Release where
+    (Release v1 m1 i1) == (Release v2 m2 i2) =
+        (v1 == v2) && (sortedEq m1 m2) && (sortedEq i1 i2)
+        where sortedEq as bs = (sort as) == (sort bs)
 
 -- | The configuration of a build. These are the parameters of the build that
 -- specify what type of system this build of Haskell Platform is for. It
@@ -111,7 +123,7 @@ data BuildConfig = BuildConfig
     , bcPrefix :: Maybe FilePath   -- ex.: "/usr/local/haskell"
     , bcIncludeExtra :: Bool
     }
-  deriving (Read, Show)
+  deriving (Read, Show, Eq, Generic, Hashable, Binary, NFData)
 
 -- | A function that is used for the actions after untar-ing GHC.
 -- The build configuration and file path of the untar-ed directory is