Per-component new-build support (no Custom support yet)

Cabal/Cabal.cabal

@@ -98,6 +98,10 @@ extra-source-files:
   tests/PackageTests/BuildDeps/TargetSpecificDeps3/lemon.hs
   tests/PackageTests/BuildDeps/TargetSpecificDeps3/my.cabal
   tests/PackageTests/BuildTestSuiteDetailedV09/Dummy2.hs
+  tests/PackageTests/BuildToolsPath/A.hs
+  tests/PackageTests/BuildToolsPath/MyCustomPreprocessor.hs
+  tests/PackageTests/BuildToolsPath/build-tools-path.cabal
+  tests/PackageTests/BuildToolsPath/hello/Hello.hs
   tests/PackageTests/BuildableField/BuildableField.cabal
   tests/PackageTests/BuildableField/Main.hs
   tests/PackageTests/CMain/Bar.hs
@@ -108,6 +112,17 @@ extra-source-files:
   tests/PackageTests/Configure/include/HsZlibConfig.h.in
   tests/PackageTests/Configure/zlib.buildinfo.in
   tests/PackageTests/Configure/zlib.cabal
+  tests/PackageTests/ConfigureComponent/Exe/Bad.hs
+  tests/PackageTests/ConfigureComponent/Exe/Exe.cabal
+  tests/PackageTests/ConfigureComponent/Exe/Good.hs
+  tests/PackageTests/ConfigureComponent/SubLib/Lib.cabal
+  tests/PackageTests/ConfigureComponent/SubLib/Lib.hs
+  tests/PackageTests/ConfigureComponent/SubLib/exe/Exe.hs
+  tests/PackageTests/ConfigureComponent/Test/Lib.hs
+  tests/PackageTests/ConfigureComponent/Test/Test.cabal
+  tests/PackageTests/ConfigureComponent/Test/testlib/TestLib.hs
+  tests/PackageTests/ConfigureComponent/Test/testlib/testlib.cabal
+  tests/PackageTests/ConfigureComponent/Test/tests/Test.hs
   tests/PackageTests/CopyAssumeDepsUpToDate/CopyAssumeDepsUpToDate.cabal
   tests/PackageTests/CopyAssumeDepsUpToDate/Main.hs
   tests/PackageTests/CopyAssumeDepsUpToDate/P.hs

Cabal/Distribution/InstalledPackageInfo.hs

@@ -108,6 +108,9 @@ installedComponentId ipi = case installedUnitId ipi of
 
 {-# DEPRECATED installedPackageId "Use installedUnitId instead" #-}
 -- | Backwards compatibility with Cabal pre-1.24.
+-- This type synonym is slightly awful because in cabal-install
+-- we define an 'InstalledPackageId' but it's a ComponentId,
+-- not a UnitId!
 installedPackageId :: InstalledPackageInfo -> UnitId
 installedPackageId = installedUnitId
 

Cabal/Distribution/Package.hs

@@ -27,6 +27,7 @@ module Distribution.Package (
         UnitId(..),
         mkUnitId,
         mkLegacyUnitId,
+        unitIdComponentId,
         getHSLibraryName,
         InstalledPackageId, -- backwards compat
 
@@ -176,6 +177,10 @@ mkUnitId = SimpleUnitId . ComponentId
 mkLegacyUnitId :: PackageId -> UnitId
 mkLegacyUnitId = SimpleUnitId . ComponentId . display
 
+-- | Extract 'ComponentId' from 'UnitId'.
+unitIdComponentId :: UnitId -> ComponentId
+unitIdComponentId (SimpleUnitId cid) = cid
+
 -- ------------------------------------------------------------
 -- * Package source dependencies
 -- ------------------------------------------------------------
@@ -234,7 +239,7 @@ packageVersion  = pkgVersion . packageId
 instance Package PackageIdentifier where
   packageId = id
 
--- | Packages that have an installed package ID
+-- | Packages that have an installed unit ID
 class Package pkg => HasUnitId pkg where
   installedUnitId :: pkg -> UnitId
 

Cabal/Distribution/PackageDescription/Configuration.hs

@@ -421,11 +421,14 @@ overallDependencies enabled (TargetSet targets) = mconcat depss
   where
     (depss, _) = unzip $ filter (removeDisabledSections . snd) targets
     removeDisabledSections :: PDTagged -> Bool
-    removeDisabledSections (Lib l)     = componentEnabled enabled (CLib l)
-    removeDisabledSections (SubLib _ l) = componentEnabled enabled (CLib l)
-    removeDisabledSections (Exe _ e)   = componentEnabled enabled (CExe e)
-    removeDisabledSections (Test _ t)  = componentEnabled enabled (CTest t)
-    removeDisabledSections (Bench _ b) = componentEnabled enabled (CBench b)
+    -- UGH. The embedded componentName in the 'Component's here is
+    -- BLANK.  I don't know whose fault this is but I'll use the tag
+    -- instead. -- ezyang
+    removeDisabledSections (Lib _)     = componentNameEnabled enabled CLibName
+    removeDisabledSections (SubLib t _) = componentNameEnabled enabled (CSubLibName t)
+    removeDisabledSections (Exe t _)   = componentNameEnabled enabled (CExeName t)
+    removeDisabledSections (Test t _)  = componentNameEnabled enabled (CTestName t)
+    removeDisabledSections (Bench t _) = componentNameEnabled enabled (CBenchName t)
     removeDisabledSections PDNull      = True
 
 -- Apply extra constraints to a dependency map.

Cabal/Distribution/PackageDescription/Parse.hs

@@ -24,6 +24,10 @@ module Distribution.PackageDescription.Parse (
         FieldDescr(..),
         LineNo,
 
+        -- ** Private, but needed for pretty-printer
+        TestSuiteStanza(..),
+        BenchmarkStanza(..),
+
         -- ** Supplementary build information
         readHookedBuildInfo,
         parseHookedBuildInfo,
@@ -34,6 +38,7 @@ module Distribution.PackageDescription.Parse (
         binfoFieldDescrs,
         sourceRepoFieldDescrs,
         testSuiteFieldDescrs,
+        benchmarkFieldDescrs,
         flagFieldDescrs
   ) where
 
@@ -189,12 +194,7 @@ storeXFieldsLib _ _ = Nothing
 
 executableFieldDescrs :: [FieldDescr Executable]
 executableFieldDescrs =
-  [ -- note ordering: configuration must come first, for
-    -- showPackageDescription.
-    simpleField "executable"
-                           showToken          parseTokenQ
-                           exeName            (\xs    exe -> exe{exeName=xs})
-  , simpleField "main-is"
+  [ simpleField "main-is"
                            showFilePath       parseFilePathQ
                            modulePath         (\xs    exe -> exe{modulePath=xs})
   ]
@@ -1094,7 +1094,7 @@ parsePackageDescription file = do
 
     -- Note: we don't parse the "executable" field here, hence the tail hack.
     parseExeFields :: [Field] -> PM Executable
-    parseExeFields = lift . parseFields (tail executableFieldDescrs)
+    parseExeFields = lift . parseFields executableFieldDescrs
                                         storeXFieldsExe emptyExecutable
 
     parseTestFields :: LineNo -> [Field] -> PM TestSuite

Cabal/Distribution/PackageDescription/PrettyPrint.hs

@@ -35,6 +35,7 @@ import Distribution.ParseUtils
 import Distribution.PackageDescription.Parse
 import Distribution.Package
 import Distribution.Text
+import Distribution.ModuleName
 
 import Text.PrettyPrint
        (hsep, space, parens, char, nest, isEmpty, ($$), (<+>),
@@ -58,11 +59,11 @@ ppGenericPackageDescription :: GenericPackageDescription -> Doc
 ppGenericPackageDescription gpd          =
         ppPackageDescription (packageDescription gpd)
         $+$ ppGenPackageFlags (genPackageFlags gpd)
-        $+$ ppLibrary (condLibrary gpd)
-        $+$ ppSubLibraries (condSubLibraries gpd)
-        $+$ ppExecutables (condExecutables gpd)
-        $+$ ppTestSuites (condTestSuites gpd)
-        $+$ ppBenchmarks (condBenchmarks gpd)
+        $+$ ppCondLibrary (condLibrary gpd)
+        $+$ ppCondSubLibraries (condSubLibraries gpd)
+        $+$ ppCondExecutables (condExecutables gpd)
+        $+$ ppCondTestSuites (condTestSuites gpd)
+        $+$ ppCondBenchmarks (condBenchmarks gpd)
 
 ppPackageDescription :: PackageDescription -> Doc
 ppPackageDescription pd                  =      ppFields pkgDescrFieldDescrs pd
@@ -119,14 +120,14 @@ ppFlag flag@(MkFlag name _ _ _)    =
   where
     fields = ppFieldsFiltered flagDefaults flagFieldDescrs flag
 
-ppLibrary :: Maybe (CondTree ConfVar [Dependency] Library) -> Doc
-ppLibrary Nothing = mempty
-ppLibrary (Just condTree) =
+ppCondLibrary :: Maybe (CondTree ConfVar [Dependency] Library) -> Doc
+ppCondLibrary Nothing = mempty
+ppCondLibrary (Just condTree) =
     emptyLine $ text "library"
         $+$ nest indentWith (ppCondTree condTree Nothing ppLib)
 
-ppSubLibraries :: [(String, CondTree ConfVar [Dependency] Library)] -> Doc
-ppSubLibraries libs                           =
+ppCondSubLibraries :: [(String, CondTree ConfVar [Dependency] Library)] -> Doc
+ppCondSubLibraries libs                           =
     vcat [emptyLine $ text ("library " ++ n)
               $+$ nest indentWith (ppCondTree condTree Nothing ppLib)| (n,condTree) <- libs]
 
@@ -136,8 +137,8 @@ ppLib lib Nothing     = ppFieldsFiltered libDefaults libFieldDescrs lib
 ppLib lib (Just plib) = ppDiffFields libFieldDescrs lib plib
                         $$  ppCustomFields (customFieldsBI (libBuildInfo lib))
 
-ppExecutables :: [(String, CondTree ConfVar [Dependency] Executable)] -> Doc
-ppExecutables exes                       =
+ppCondExecutables :: [(String, CondTree ConfVar [Dependency] Executable)] -> Doc
+ppCondExecutables exes                       =
     vcat [emptyLine $ text ("executable " ++ n)
               $+$ nest indentWith (ppCondTree condTree Nothing ppExe)| (n,condTree) <- exes]
   where
@@ -152,8 +153,8 @@ ppExecutables exes                       =
             $+$ ppDiffFields binfoFieldDescrs buildInfo' buildInfo2
             $+$ ppCustomFields (customFieldsBI buildInfo')
 
-ppTestSuites :: [(String, CondTree ConfVar [Dependency] TestSuite)] -> Doc
-ppTestSuites suites =
+ppCondTestSuites :: [(String, CondTree ConfVar [Dependency] TestSuite)] -> Doc
+ppCondTestSuites suites =
     emptyLine $ vcat [     text ("test-suite " ++ n)
                        $+$ nest indentWith (ppCondTree condTree Nothing ppTestSuite)
                      | (n,condTree) <- suites]
@@ -184,8 +185,8 @@ ppTestSuites suites =
       TestSuiteLibV09 _ m -> Just m
       _                   -> Nothing
 
-ppBenchmarks :: [(String, CondTree ConfVar [Dependency] Benchmark)] -> Doc
-ppBenchmarks suites =
+ppCondBenchmarks :: [(String, CondTree ConfVar [Dependency] Benchmark)] -> Doc
+ppCondBenchmarks suites =
     emptyLine $ vcat [     text ("benchmark " ++ n)
                        $+$ nest indentWith (ppCondTree condTree Nothing ppBenchmark)
                      | (n,condTree) <- suites]
@@ -280,17 +281,80 @@ writePackageDescription fpath pkg = writeUTF8File fpath (showPackageDescription
 -- | @since 1.26.0.0@
 showPackageDescription :: PackageDescription -> String
 showPackageDescription pkg = render $
-     ppPackage pkg
-  $$ ppCustomFields (customFieldsPD pkg)
-  $$ (case library pkg of
-        Nothing -> mempty
-        Just lib -> ppLibrary' lib)
-  $$ vcat [ space $$ ppLibrary' lib | lib <- subLibraries pkg ]
-  $$ vcat [ space $$ ppExecutable exe | exe <- executables pkg ]
-  where
-    ppPackage    = ppFields pkgDescrFieldDescrs
-    ppLibrary'   = ppFields libFieldDescrs
-    ppExecutable = ppFields executableFieldDescrs
+     ppPackageDescription pkg
+     $+$ ppMaybeLibrary (library pkg)
+     $+$ ppSubLibraries (subLibraries pkg)
+     $+$ ppExecutables  (executables pkg)
+     $+$ ppTestSuites   (testSuites pkg)
+     $+$ ppBenchmarks   (benchmarks pkg)
+
+ppMaybeLibrary :: Maybe Library -> Doc
+ppMaybeLibrary Nothing = mempty
+ppMaybeLibrary (Just lib) =
+    emptyLine $ text "library"
+        $+$ nest indentWith (ppFields libFieldDescrs lib)
+
+ppSubLibraries :: [Library] -> Doc
+ppSubLibraries libs = vcat [
+    emptyLine $ text "library" <+> text libname
+        $+$ nest indentWith (ppFields libFieldDescrs lib)
+    | lib@Library{ libName = Just libname } <- libs ]
+
+ppExecutables :: [Executable] -> Doc
+ppExecutables exes = vcat [
+    emptyLine $ text "executable" <+> text (exeName exe)
+        $+$ nest indentWith (ppFields executableFieldDescrs exe)
+    | exe <- exes ]
+
+ppTestSuites :: [TestSuite] -> Doc
+ppTestSuites tests = vcat [
+    emptyLine $ text "test-suite" <+> text (testName test)
+        $+$ nest indentWith (ppFields testSuiteFieldDescrs test_stanza)
+    | test <- tests
+    , let test_stanza
+            = TestSuiteStanza {
+                testStanzaTestType = Just (testSuiteInterfaceToTestType (testInterface test)),
+                testStanzaMainIs = testSuiteInterfaceToMaybeMainIs (testInterface test),
+                testStanzaTestModule = testSuiteInterfaceToMaybeModule (testInterface test),
+                testStanzaBuildInfo = testBuildInfo test
+            }
+    ]
+
+testSuiteInterfaceToTestType :: TestSuiteInterface -> TestType
+testSuiteInterfaceToTestType (TestSuiteExeV10 ver _) = TestTypeExe ver
+testSuiteInterfaceToTestType (TestSuiteLibV09 ver _) = TestTypeLib ver
+testSuiteInterfaceToTestType (TestSuiteUnsupported ty) = ty
+
+testSuiteInterfaceToMaybeMainIs :: TestSuiteInterface -> Maybe FilePath
+testSuiteInterfaceToMaybeMainIs (TestSuiteExeV10 _ fp) = Just fp
+testSuiteInterfaceToMaybeMainIs TestSuiteLibV09{} = Nothing
+testSuiteInterfaceToMaybeMainIs TestSuiteUnsupported{} = Nothing
+
+testSuiteInterfaceToMaybeModule :: TestSuiteInterface -> Maybe ModuleName
+testSuiteInterfaceToMaybeModule (TestSuiteLibV09 _ mod_name) = Just mod_name
+testSuiteInterfaceToMaybeModule TestSuiteExeV10{} = Nothing
+testSuiteInterfaceToMaybeModule TestSuiteUnsupported{} = Nothing
+
+ppBenchmarks :: [Benchmark] -> Doc
+ppBenchmarks benchs = vcat [
+    emptyLine $ text "benchmark" <+> text (benchmarkName bench)
+        $+$ nest indentWith (ppFields benchmarkFieldDescrs bench_stanza)
+    | bench <- benchs
+    , let bench_stanza = BenchmarkStanza {
+                benchmarkStanzaBenchmarkType = Just (benchmarkInterfaceToBenchmarkType (benchmarkInterface bench)),
+                benchmarkStanzaMainIs = benchmarkInterfaceToMaybeMainIs (benchmarkInterface bench),
+                benchmarkStanzaBenchmarkModule = Nothing,
+                benchmarkStanzaBuildInfo = benchmarkBuildInfo bench
+            }]
+
+benchmarkInterfaceToBenchmarkType :: BenchmarkInterface -> BenchmarkType
+benchmarkInterfaceToBenchmarkType (BenchmarkExeV10 ver _)   = BenchmarkTypeExe ver
+benchmarkInterfaceToBenchmarkType (BenchmarkUnsupported ty) = ty
+
+benchmarkInterfaceToMaybeMainIs :: BenchmarkInterface -> Maybe FilePath
+benchmarkInterfaceToMaybeMainIs (BenchmarkExeV10 _ fp) = Just fp
+benchmarkInterfaceToMaybeMainIs BenchmarkUnsupported{} = Nothing
+
 
 -- | @since 1.26.0.0@
 writeHookedBuildInfo :: FilePath -> HookedBuildInfo -> IO ()

Cabal/Distribution/Simple.hs

@@ -187,7 +187,8 @@ allSuffixHandlers hooks
 configureAction :: UserHooks -> ConfigFlags -> Args -> IO LocalBuildInfo
 configureAction hooks flags args = do
     distPref <- findDistPrefOrDefault (configDistPref flags)
-    let flags' = flags { configDistPref = toFlag distPref }
+    let flags' = flags { configDistPref = toFlag distPref
+                       , configArgs = args }
 
     -- See docs for 'HookedBuildInfo'
     pbi <- preConf hooks args flags'
@@ -578,7 +579,6 @@ defaultUserHooks = autoconfUserHooks {
     -- https://github.com/haskell/cabal/issues/158
     where oldCompatPostConf args flags pkg_descr lbi
               = do let verbosity = fromFlag (configVerbosity flags)
-                   noExtraFlags args
                    confExists <- doesFileExist "configure"
                    when confExists $
                        runConfigureScript verbosity
@@ -609,7 +609,6 @@ autoconfUserHooks
     where defaultPostConf :: Args -> ConfigFlags -> PackageDescription -> LocalBuildInfo -> IO ()
           defaultPostConf args flags pkg_descr lbi
               = do let verbosity = fromFlag (configVerbosity flags)
-                   noExtraFlags args
                    confExists <- doesFileExist "configure"
                    if confExists
                      then runConfigureScript verbosity

Cabal/Distribution/Simple/Build.hs

@@ -425,6 +425,7 @@ testSuiteLibV09AsLibAndExe pkg_descr
     libClbi = LibComponentLocalBuildInfo
                 { componentPackageDeps = componentPackageDeps clbi
                 , componentInternalDeps = componentInternalDeps clbi
+                , componentExeDeps = componentExeDeps clbi
                 , componentLocalName = CSubLibName (testName test)
                 , componentIsPublic = False
                 , componentIncludes = componentIncludes clbi
@@ -465,6 +466,7 @@ testSuiteLibV09AsLibAndExe pkg_descr
                 -- (doesn't clobber something) we won't run into trouble
                 componentUnitId = mkUnitId (stubName test),
                 componentInternalDeps = [componentUnitId clbi],
+                componentExeDeps = [],
                 componentLocalName = CExeName (stubName test),
                 componentPackageDeps = deps,
                 componentIncludes = zip (map fst deps) (repeat defaultRenaming)
@@ -488,6 +490,7 @@ benchmarkExeV10asExe bm@Benchmark { benchmarkInterface = BenchmarkExeV10 _ f }
                 componentUnitId = componentUnitId clbi,
                 componentLocalName = CExeName (benchmarkName bm),
                 componentInternalDeps = componentInternalDeps clbi,
+                componentExeDeps = componentExeDeps clbi,
                 componentPackageDeps = componentPackageDeps clbi,
                 componentIncludes = componentIncludes clbi
               }

Cabal/Distribution/Simple/BuildTarget.hs

@@ -12,6 +12,7 @@
 module Distribution.Simple.BuildTarget (
     -- * Main interface
     readTargetInfos,
+    readBuildTargets, -- in case you don't have LocalBuildInfo
 
     -- * Build targets
     BuildTarget(..),
@@ -232,10 +233,21 @@ showUserBuildTarget = intercalate ":" . getComponents
     getComponents (UserBuildTargetDouble s1 s2)    = [s1,s2]
     getComponents (UserBuildTargetTriple s1 s2 s3) = [s1,s2,s3]
 
-showBuildTarget :: QualLevel -> PackageId -> BuildTarget -> String
-showBuildTarget ql pkgid bt =
+-- | Unless you use 'QL1', this function is PARTIAL;
+-- use 'showBuildTarget' instead.
+showBuildTarget' :: QualLevel -> PackageId -> BuildTarget -> String
+showBuildTarget' ql pkgid bt =
     showUserBuildTarget (renderBuildTarget ql bt pkgid)
 
+-- | Unambiguously render a 'BuildTarget', so that it can
+-- be parsed in all situations.
+showBuildTarget :: PackageId -> BuildTarget -> String
+showBuildTarget pkgid t =
+    showBuildTarget' (qlBuildTarget t) pkgid t
+  where
+    qlBuildTarget BuildTargetComponent{} = QL2
+    qlBuildTarget _                      = QL3
+
 
 -- ------------------------------------------------------------
 -- * Resolving user targets to build targets
@@ -998,3 +1010,7 @@ checkBuildTargets verbosity pkg_descr lbi targets = do
     formatReason cn DisabledAllBenchmarks =
         "Cannot process the " ++ cn ++ " because benchmarks are not "
      ++ "enabled. Re-run configure with the flag --enable-benchmarks"
+    formatReason cn (DisabledAllButOne cn') =
+        "Cannot process the " ++ cn ++ " because this package was "
+     ++ "configured only to build " ++ cn' ++ ". Re-run configure "
+     ++ "with the argument " ++ cn