Fix lint error (#575)
[hadrian.git] / src / Rules / Register.hs
index 14b085d..b66f085 100644 (file)
@@ -10,6 +10,7 @@ import Utilities
 import Distribution.ParseUtils
 import qualified Distribution.Compat.ReadP as Parse
 import Distribution.Version (Version)
+import qualified System.Directory as IO
 
 import Hadrian.Expression
 import Hadrian.Haskell.Cabal.Parse as Cabal
@@ -22,70 +23,74 @@ parseCabalName = readPToMaybe parse
 -- by running the @ghc-pkg@ utility.
 registerPackages :: [(Resource, Int)] -> Context -> Rules ()
 registerPackages rs context@Context {..} = do
-  root <- buildRootRules
-  root -/- relativePackageDbPath stage %>
-    buildStamp rs context
-
-  root -/- relativePackageDbPath stage -/- packageDbStamp %> \stamp ->
-    writeFileLines stamp []
-
-  root -/- relativePackageDbPath stage -/- "*.conf" %> \conf -> do
-    settings <- libPath context <&> (-/- "settings")
-    platformConstants <- libPath context <&> (-/- "platformConstants")
-    need [settings, platformConstants]
-    let Just pkgName | takeBaseName conf == "rts" = Just "rts"
-                     | otherwise = fst <$> parseCabalName (takeBaseName conf)
-    let Just pkg = findPackageByName pkgName
-    bootLibs <- filter isLibrary <$> stagePackages Stage0
-    case stage of
-      Stage0 | pkg `notElem` bootLibs -> copyConf rs (context { package = pkg }) conf
-      _                               -> buildConf rs (context { package = pkg }) conf
-
+    root <- buildRootRules
+    root -/- relativePackageDbPath stage %> buildStamp rs context
+
+    root -/- relativePackageDbPath stage -/- packageDbStamp %> \stamp ->
+        writeFileLines stamp []
+
+    -- TODO: Add proper error handling for partial functions.
+    root -/- relativePackageDbPath stage -/- "*.conf" %> \conf -> do
+        settings <- libPath context <&> (-/- "settings")
+        platformConstants <- libPath context <&> (-/- "platformConstants")
+        need [settings, platformConstants]
+        let Just pkgName | takeBaseName conf == "rts" = Just "rts"
+                         | otherwise = fst <$> parseCabalName (takeBaseName conf)
+        let Just pkg = findPackageByName pkgName
+        isBoot <- (pkg `notElem`) <$> stagePackages Stage0
+        case stage of
+            Stage0 | isBoot -> copyConf  rs (context { package = pkg }) conf
+            _               -> buildConf rs (context { package = pkg }) conf
 
 buildConf :: [(Resource, Int)] -> Context -> FilePath -> Action ()
 buildConf _ context@Context {..} _conf = do
     depPkgIds <- cabalDependencies context
 
-    -- setup-config, triggers `ghc-cabal configure`
-    -- everything of a package should depend on that
-    -- in the first place.
-    setupConfig <- (contextPath context) <&> (-/- "setup-config")
+    -- Calling 'need' on @setup-config@, triggers @ghc-cabal configure@
+    -- Building anything in a package transitively depends on its configuration.
+    setupConfig <- contextPath context <&> (-/- "setup-config")
     need [setupConfig]
     need =<< mapM (\pkgId -> packageDbPath stage <&> (-/- pkgId <.> "conf")) depPkgIds
 
     ways <- interpretInContext context (getLibraryWays <> if package == rts then getRtsWays else mempty)
     need =<< concatMapM (libraryTargets True) [ context { way = w } | w <- ways ]
 
-    -- might need some package-db resource to limit read/write,
-    -- see packageRules
-    bldPath <- buildPath context
+    -- We might need some package-db resource to limit read/write, see packageRules.
+    path <- buildPath context
 
-    -- special package cases (these should ideally be rolled into cabal one way or the other)
+    -- Special package cases (these should ideally be rolled into Cabal).
     when (package == rts) $
-      -- iif cabal new about "generated-headers", we could read them from the configuredCabal
-      -- information, and just "need" them here.
-      need [ bldPath -/- "DerivedConstants.h"
-           , bldPath -/- "ghcautoconf.h"
-           , bldPath -/- "ghcplatform.h"
-           , bldPath -/- "ghcversion.h"
-           , bldPath -/- "ffi.h"
-           ]
-
-    when (package == integerGmp) $
-      need [bldPath -/- "ghc-gmp.h"]
-
-    -- copy and register the package
+        -- If Cabal knew about "generated-headers", we could read them from the
+        -- 'configuredCabal' information, and just "need" them here.
+        need [ path -/- "DerivedConstants.h"
+             , path -/- "ghcautoconf.h"
+             , path -/- "ghcplatform.h"
+             , path -/- "ghcversion.h"
+             , path -/- "ffi.h" ]
+
+    when (package == integerGmp) $ need [path -/- "ghc-gmp.h"]
+
+    -- Copy and register the package.
     copyPackage context
     registerPackage context
 
 copyConf :: [(Resource, Int)] -> Context -> FilePath -> Action ()
 copyConf rs context@Context {..} conf = do
     depPkgIds <- fmap stdOutToPkgIds . askWithResources rs $
-      target context (GhcPkg Dependencies stage) [pkgName package] []
+        target context (GhcPkg Dependencies stage) [pkgName package] []
     need =<< mapM (\pkgId -> packageDbPath stage <&> (-/- pkgId <.> "conf")) depPkgIds
-    buildWithResources rs $
-      target context (GhcPkg Clone stage) [pkgName package] [conf]
-
+    -- We should unregister if the file exists since @ghc-pkg@ will complain
+    -- about existing package: https://github.com/snowleopard/hadrian/issues/543.
+    -- Also, we don't always do the unregistration + registration to avoid
+    -- repeated work after a full build.
+    -- We do not track 'doesFileExist' since we are going to create the file if
+    -- it is currently missing. TODO: Is this the right thing to do?
+    -- See https://github.com/snowleopard/hadrian/issues/569.
+    unlessM (liftIO $ IO.doesFileExist conf) $ do
+        buildWithResources rs $
+            target context (GhcPkg Unregister stage) [pkgName package] []
+        buildWithResources rs $
+            target context (GhcPkg Clone stage) [pkgName package] [conf]
   where
     stdOutToPkgIds :: String -> [String]
     stdOutToPkgIds = drop 1 . concatMap words . lines