wip: thread toolchains everywhere

Author: andreabedini

Cabal/src/Distribution/Simple/Program/Db.hs

@@ -67,6 +67,7 @@ module Distribution.Simple.Program.Db
   , ConfiguredProgs
   , updateUnconfiguredProgs
   , updateConfiguredProgs
+  , programDbSignature
   ) where
 
 import Distribution.Compat.Prelude
@@ -564,3 +565,17 @@ requireProgramVersion verbosity prog range programDb =
   join $
     either (dieWithException verbosity) return
       `fmap` lookupProgramVersion verbosity prog range programDb
+
+-- | Select the bits of a 'ProgramDb' to monitor for value changes.
+-- Use 'programsMonitorFiles' for the files to monitor.
+programDbSignature :: ProgramDb -> [ConfiguredProgram]
+programDbSignature progdb =
+  [ prog
+    { programMonitorFiles = []
+    , programOverrideEnv =
+        filter
+          ((/= "PATH") . fst)
+          (programOverrideEnv prog)
+    }
+  | prog <- configuredPrograms progdb
+  ]

cabal-install/src/Distribution/Client/CmdExec.hs

@@ -55,7 +55,7 @@ import Distribution.Client.ProjectPlanning
   )
 import qualified Distribution.Client.ProjectPlanning as Planning
 import Distribution.Client.ProjectPlanning.Types
-  ( dataDirsEnvironmentForPlan
+  ( dataDirsEnvironmentForPlan, Toolchain (..), Toolchains (..)
   )
 import Distribution.Client.Setup
   ( ConfigFlags (configCommonFlags)
@@ -170,7 +170,7 @@ execAction flags@NixStyleFlags{..} extraArgs globalFlags = do
 
   -- Some dependencies may have executables. Let's put those on the PATH.
   let extraPaths = pathAdditions baseCtx buildCtx
-      pkgProgs = pkgConfigCompilerProgs (elaboratedShared buildCtx)
+      pkgProgs = toolchainProgramDb $ buildToolchain $ pkgConfigToolchains (elaboratedShared buildCtx)
       extraEnvVars =
         dataDirsEnvironmentForPlan
           (distDirLayout baseCtx)
@@ -185,7 +185,7 @@ execAction flags@NixStyleFlags{..} extraArgs globalFlags = do
   -- point at the file.
   -- In case ghc is too old to support environment files,
   -- we pass the same info as arguments
-  let compiler = pkgConfigCompiler $ elaboratedShared buildCtx
+  let compiler = toolchainCompiler $ buildToolchain $ pkgConfigToolchains $ elaboratedShared buildCtx
       envFilesSupported = supportsPkgEnvFiles (getImplInfo compiler)
   case extraArgs of
     [] -> dieWithException verbosity SpecifyAnExecutable
@@ -243,7 +243,7 @@ matchCompilerPath elaboratedShared program =
   programPath program
     `elem` (programPath <$> configuredCompilers)
   where
-    configuredCompilers = configuredPrograms $ pkgConfigCompilerProgs elaboratedShared
+    configuredCompilers = configuredPrograms $ toolchainProgramDb $ buildToolchain $ pkgConfigToolchains elaboratedShared
 
 -- | Execute an action with a temporary .ghc.environment file reflecting the
 -- current environment. The action takes an environment containing the env

cabal-install/src/Distribution/Client/CmdHaddock.hs

@@ -153,13 +153,15 @@ haddockAction relFlags targetStrings globalFlags = do
     installDoc = fromFlagOrDefault True (installDocumentation installFlags)
     flags' = flags{installFlags = installFlags{installDocumentation = Flag installDoc}}
     cliConfig = commandLineFlagsToProjectConfig globalFlags flags' mempty -- ClientInstallFlags, not needed here
+
   projCtx <- establishProjectBaseContext verbosity cliConfig HaddockCommand
 
   let relBaseCtx@ProjectBaseContext{projectConfig = relProjectConfig}
         | fromFlagOrDefault False (openInBrowser extraFlags) =
             projCtx{buildSettings = (buildSettings projCtx){buildSettingHaddockOpen = True}}
         | otherwise =
             projCtx
+
   absProjectConfig <- mkConfigAbsolute relProjectConfig
   let baseCtx = relBaseCtx{projectConfig = absProjectConfig}
 
@@ -188,28 +190,32 @@ haddockAction relFlags targetStrings globalFlags = do
               TargetActionHaddock
               targets
               elaboratedPlan
+
       return (elaboratedPlan', targets)
 
   printPlan verbosity baseCtx buildCtx
 
-  progs <-
-    reconfigurePrograms
-      verbosity
-      (haddockProgramPaths haddockFlags)
-      (haddockProgramArgs haddockFlags)
-      -- we need to insert 'haddockProgram' before we reconfigure it,
-      -- otherwise 'set
-      . addKnownProgram haddockProgram
-      . pkgConfigCompilerProgs
-      . elaboratedShared
-      $ buildCtx
+  -- TODO
+  -- progs <-
+  --   reconfigurePrograms
+  --     verbosity
+  --     (haddockProgramPaths haddockFlags)
+  --     (haddockProgramArgs haddockFlags)
+  --     -- we need to insert 'haddockProgram' before we reconfigure it,
+  --     -- otherwise 'set
+  --     . addKnownProgram haddockProgram
+  --     . pkgConfigCompilerProgs
+  --     . elaboratedShared
+  --     $ buildCtx
+
+  -- TODO
   let buildCtx' =
         buildCtx
-          { elaboratedShared =
-              (elaboratedShared buildCtx)
-                { pkgConfigCompilerProgs = progs
-                }
-          }
+          -- { elaboratedShared =
+          --     (elaboratedShared buildCtx)
+          --       { pkgConfigCompilerProgs = progs
+          --       }
+          -- }
 
   buildOutcomes <- runProjectBuildPhase verbosity baseCtx buildCtx'
   runProjectPostBuildPhase verbosity baseCtx buildCtx' buildOutcomes

cabal-install/src/Distribution/Client/CmdHaddockProject.hs

@@ -37,7 +37,7 @@ import Distribution.Client.ProjectPlanning
   , TargetAction (..)
   )
 import Distribution.Client.ProjectPlanning.Types
-  ( elabDistDirParams
+  ( elabDistDirParams, Toolchain (..), Toolchains (..)
   )
 import Distribution.Client.ScriptUtils
   ( AcceptNoTargets (..)
@@ -166,24 +166,26 @@ haddockProjectAction flags _extraArgs globalFlags = do
           pkgs :: [Either InstalledPackageInfo ElaboratedConfiguredPackage]
           pkgs = matchingPackages elaboratedPlan
 
-      progs <-
-        reconfigurePrograms
-          verbosity
-          (haddockProjectProgramPaths flags)
-          (haddockProjectProgramArgs flags)
-          -- we need to insert 'haddockProgram' before we reconfigure it,
-          -- otherwise 'set
-          . addKnownProgram haddockProgram
-          . pkgConfigCompilerProgs
-          $ sharedConfig
-      let sharedConfig' = sharedConfig{pkgConfigCompilerProgs = progs}
-
-      _ <-
-        requireProgramVersion
-          verbosity
-          haddockProgram
-          (orLaterVersion (mkVersion [2, 26, 1]))
-          progs
+      -- TODO
+      -- progs <-
+      --   reconfigurePrograms
+      --     verbosity
+      --     (haddockProjectProgramPaths flags)
+      --     (haddockProjectProgramArgs flags)
+      --     -- we need to insert 'haddockProgram' before we reconfigure it,
+      --     -- otherwise 'set
+      --     . addKnownProgram haddockProgram
+      --     . pkgConfigCompilerProgs
+      --     $ sharedConfig
+      -- let sharedConfig' = sharedConfig{pkgConfigCompilerProgs = progs}
+      let sharedConfig' = sharedConfig
+
+      -- _ <-
+      --   requireProgramVersion
+      --     verbosity
+      --     haddockProgram
+      --     (orLaterVersion (mkVersion [2, 26, 1]))
+      --     progs
 
       --
       -- Build project; we need to build dependencies.
@@ -301,7 +303,7 @@ haddockProjectAction flags _extraArgs globalFlags = do
                     packageDir =
                       storePackageDirectory
                         (cabalStoreDirLayout cabalLayout)
-                        (pkgConfigCompiler sharedConfig')
+                        (toolchainCompiler $ buildToolchain $ pkgConfigToolchains sharedConfig')
                         (elabUnitId package)
                     -- TODO: use `InstallDirTemplates`
                     docDir = packageDir </> "share" </> "doc" </> "html"
@@ -344,11 +346,12 @@ haddockProjectAction flags _extraArgs globalFlags = do
                     ]
               , haddockProjectUseUnicode = NoFlag
               }
+      -- NOTE: this lives in Cabal
       createHaddockIndex
         verbosity
-        (pkgConfigCompilerProgs sharedConfig')
-        (pkgConfigCompiler sharedConfig')
-        (pkgConfigPlatform sharedConfig')
+        (toolchainProgramDb $ buildToolchain $ pkgConfigToolchains sharedConfig')
+        (toolchainCompiler $ buildToolchain $ pkgConfigToolchains sharedConfig')
+        (toolchainPlatform $ buildToolchain $ pkgConfigToolchains sharedConfig')
         Nothing
         flags'
   where

cabal-install/src/Distribution/Client/CmdListBin.hs

@@ -205,7 +205,7 @@ listbinAction flags@NixStyleFlags{..} args globalFlags = do
           _ -> []
 
         plat :: Platform
-        plat = pkgConfigPlatform elaboratedSharedConfig
+        plat = toolchainPlatform $ buildToolchain $ pkgConfigToolchains elaboratedSharedConfig
 
         -- here and in PlanOutput,
         -- use binDirectoryFor?

cabal-install/src/Distribution/Client/CmdPath.hs

@@ -1,5 +1,6 @@
 {-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE NamedFieldPuns #-}
 
 -- |
 -- Module      :  Distribution.Client.CmdPath
@@ -40,6 +41,7 @@ import Distribution.Client.ProjectConfig.Types
   )
 import Distribution.Client.ProjectOrchestration
 import Distribution.Client.ProjectPlanning
+import Distribution.Client.ProjectPlanning.Types (Toolchains(..), Toolchain(..))
 import Distribution.Client.RebuildMonad (runRebuild)
 import Distribution.Client.ScriptUtils
 import Distribution.Client.Setup
@@ -242,10 +244,11 @@ pathAction flags@NixStyleFlags{extraFlags = pathFlags', ..} cliTargetStrings glo
     if not $ fromFlagOrDefault False (pathCompiler pathFlags)
       then pure Nothing
       else do
-        (compiler, _, progDb) <- runRebuild (distProjectRootDirectory . distDirLayout $ baseCtx) $ configureCompiler verbosity (distDirLayout baseCtx) (projectConfig baseCtx)
-        compilerProg <- requireCompilerProg verbosity compiler
-        (configuredCompilerProg, _) <- requireProgram verbosity compilerProg progDb
-        pure $ Just $ mkCompilerInfo configuredCompilerProg compiler
+        let projectRoot = distProjectRootDirectory (distDirLayout baseCtx)
+        Toolchains{buildToolchain} <- runRebuild projectRoot $ configureCompiler verbosity (distDirLayout baseCtx) (projectConfig baseCtx)
+        compilerProg <- requireCompilerProg verbosity (toolchainCompiler buildToolchain)
+        (configuredCompilerProg, _) <- requireProgram verbosity compilerProg (toolchainProgramDb buildToolchain)
+        pure $ Just $ mkCompilerInfo configuredCompilerProg (toolchainCompiler buildToolchain)
 
   paths <- for (fromFlagOrDefault [] $ pathDirectories pathFlags) $ \p -> do
     t <- getPathLocation baseCtx p

cabal-install/src/Distribution/Client/CmdRepl.hs

@@ -56,7 +56,7 @@ import Distribution.Client.ProjectPlanning
   )
 import Distribution.Client.ProjectPlanning.Types
   ( elabOrderExeDependencies
-  , showElaboratedInstallPlan
+  , showElaboratedInstallPlan, Toolchains (..), Toolchain (..)
   )
 import Distribution.Client.ScriptUtils
   ( AcceptNoTargets (..)
@@ -344,7 +344,7 @@ replAction flags@NixStyleFlags{extraFlags = r@ReplFlags{..}, ..} targetStrings g
         -- especially in the no-project case.
         withInstallPlan (lessVerbose verbosity) baseCtx' $ \elaboratedPlan sharedConfig -> do
           -- targets should be non-empty map, but there's no NonEmptyMap yet.
-          targets <- validatedTargets (projectConfigShared (projectConfig ctx)) (pkgConfigCompiler sharedConfig) elaboratedPlan targetSelectors
+          targets <- validatedTargets (projectConfigShared (projectConfig ctx)) (toolchainCompiler $ buildToolchain $ pkgConfigToolchains sharedConfig) elaboratedPlan targetSelectors
 
           let
             (unitId, _) = fromMaybe (error "panic: targets should be non-empty") $ safeHead $ Map.toList targets
@@ -368,7 +368,7 @@ replAction flags@NixStyleFlags{extraFlags = r@ReplFlags{..}, ..} targetStrings g
         let ProjectBaseContext{..} = baseCtx''
 
         -- Recalculate with updated project.
-        targets <- validatedTargets (projectConfigShared projectConfig) (pkgConfigCompiler elaboratedShared') elaboratedPlan targetSelectors
+        targets <- validatedTargets (projectConfigShared projectConfig) (toolchainCompiler $ buildToolchain $ pkgConfigToolchains elaboratedShared') elaboratedPlan targetSelectors
 
         let
           elaboratedPlan' =
@@ -400,7 +400,7 @@ replAction flags@NixStyleFlags{extraFlags = r@ReplFlags{..}, ..} targetStrings g
               , targetsMap = targets
               }
 
-          ElaboratedSharedConfig{pkgConfigCompiler = compiler} = elaboratedShared'
+          ElaboratedSharedConfig{pkgConfigToolchains = Toolchains { hostToolchain = Toolchain { toolchainCompiler = compiler } }} = elaboratedShared'
 
           repl_flags = case originalComponent of
             Just oci -> generateReplFlags includeTransitive elaboratedPlan' oci
@@ -441,7 +441,7 @@ replAction flags@NixStyleFlags{extraFlags = r@ReplFlags{..}, ..} targetStrings g
         -- HACK: Just combine together all env overrides, placing the most common things last
 
         -- ghc program with overridden PATH
-        (ghcProg, _) <- requireProgram verbosity ghcProgram (pkgConfigCompilerProgs (elaboratedShared buildCtx'))
+        (ghcProg, _) <- requireProgram verbosity ghcProgram (toolchainProgramDb $ buildToolchain $ pkgConfigToolchains (elaboratedShared buildCtx'))
         let ghcProg' = ghcProg{programOverrideEnv = [("PATH", Just sp)]}
 
         -- Find what the unit files are, and start a repl based on all the response

cabal-install/src/Distribution/Client/ProjectBuilding.hs

@@ -343,8 +343,7 @@ rebuildTargets
   storeDirLayout
   installPlan
   sharedPackageConfig@ElaboratedSharedConfig
-    { pkgConfigCompiler = compiler
-    , pkgConfigCompilerProgs = progdb
+    { pkgConfigToolchains = Toolchains { hostToolchain = Toolchain { toolchainCompiler = compiler, toolchainProgramDb = progdb } }
     }
   pkgsBuildStatus
   buildSettings@BuildTimeSettings

cabal-install/src/Distribution/Client/ProjectBuilding/UnpackedPackage.hs

@@ -178,8 +178,12 @@ buildAndRegisterUnpackedPackage
   registerLock
   cacheLock
   pkgshared@ElaboratedSharedConfig
-    { pkgConfigCompiler = compiler
-    , pkgConfigCompilerProgs = progdb
+    { pkgConfigToolchains = Toolchains {
+        buildToolchain = Toolchain {
+          toolchainCompiler = compiler,
+          toolchainProgramDb = progdb
+        }
+      }
     }
   plan
   rpkg@(ReadyPackage pkg)
@@ -451,7 +455,13 @@ buildInplaceUnpackedPackage
   buildSettings@BuildTimeSettings{buildSettingHaddockOpen}
   registerLock
   cacheLock
-  pkgshared@ElaboratedSharedConfig{pkgConfigPlatform = Platform _ os}
+  pkgshared@ElaboratedSharedConfig{
+    pkgConfigToolchains = Toolchains {
+      buildToolchain = Toolchain {
+        toolchainPlatform = Platform _ os
+      }
+    }
+  }
   plan
   rpkg@(ReadyPackage pkg)
   buildStatus
@@ -657,8 +667,12 @@ buildAndInstallUnpackedPackage
   registerLock
   cacheLock
   pkgshared@ElaboratedSharedConfig
-    { pkgConfigCompiler = compiler
-    , pkgConfigPlatform = platform
+    { pkgConfigToolchains = Toolchains {
+        buildToolchain = Toolchain {
+          toolchainCompiler = compiler,
+          toolchainPlatform = platform
+        }
+      }
     }
   plan
   rpkg@(ReadyPackage pkg)
@@ -723,8 +737,8 @@ buildAndInstallUnpackedPackage
           runBuild
           -- not sure, if we want to care about a failed postBuildHook?
           postBuildHookFile <- canonicalizePath (hooksDir </> "postBuildHook")
-          hookExists <- doesFileExist postBuildHookFile
-          when hookExists $ do
+          hookExists' <- doesFileExist postBuildHookFile
+          when hookExists' $ do
             assertHookHash (pkgConfigHookHashes pkgshared) postBuildHookFile
             void $
               rawSystemExitCode