Configure.hs 42.2 KB
Newer Older
1 2
-----------------------------------------------------------------------------
-- |
ijones's avatar
ijones committed
3
-- Module      :  Distribution.Simple.Configure
4
-- Copyright   :  Isaac Jones 2003-2005
5
--
Duncan Coutts's avatar
Duncan Coutts committed
6
-- Maintainer  :  cabal-devel@haskell.org
ijones's avatar
ijones committed
7
-- Portability :  portable
8
--
Duncan Coutts's avatar
Duncan Coutts committed
9 10 11 12 13 14 15 16 17 18 19 20 21
-- This deals with the /configure/ phase. It provides the 'configure' action
-- which is given the package description and configure flags. It then tries
-- to: configure the compiler; resolves any conditionals in the package
-- description; resolve the package dependencies; check if all the extensions
-- used by this package are supported by the compiler; check that all the build
-- tools are available (including version checks if appropriate); checks for
-- any required @pkg-config@ packages (updating the 'BuildInfo' with the
-- results)
-- 
-- Then based on all this it saves the info in the 'LocalBuildInfo' and writes
-- it out to the @dist\/setup-config@ file. It also displays various details to
-- the user, the amount of information displayed depending on the verbosity
-- level.
22

ijones's avatar
ijones committed
23
{- All rights reserved.
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.

    * Neither the name of Isaac Jones nor the names of other
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -}

ijones's avatar
ijones committed
53 54
module Distribution.Simple.Configure (configure,
                                      writePersistBuildConfig,
ijones's avatar
ijones committed
55
                                      getPersistBuildConfig,
56
                                      checkPersistBuildConfig,
57
                                      maybeGetPersistBuildConfig,
58
--                                      getConfiguredPkgDescr,
ijones's avatar
ijones committed
59
                                      localBuildInfoFile,
60
                                      getInstalledPackages,
61
                                      configDependency,
62
                                      configCompiler, configCompilerAux,
63
                                      ccLdOptionsBuildInfo,
jpbernardy's avatar
jpbernardy committed
64
                                      tryGetConfigStateFile,
65
                                      checkForeignDeps,
ijones's avatar
ijones committed
66
                                     )
ijones's avatar
ijones committed
67
    where
68

69
import Distribution.Simple.Compiler
70
    ( CompilerFlavor(..), Compiler(compilerId), compilerFlavor, compilerVersion
71
    , showCompilerId, unsupportedExtensions, PackageDB(..), PackageDBStack )
72
import Distribution.Package
73 74
    ( PackageName(PackageName), PackageId, PackageIdentifier(PackageIdentifier)
    , packageName, packageVersion, Package(..), Dependency(Dependency) )
75
import Distribution.InstalledPackageInfo
76
    ( InstalledPackageInfo, emptyInstalledPackageInfo )
77 78
import qualified Distribution.InstalledPackageInfo as Installed
    ( InstalledPackageInfo_(..) )
79 80
import qualified Distribution.Simple.PackageIndex as PackageIndex
import Distribution.Simple.PackageIndex (PackageIndex)
81
import Distribution.PackageDescription as PD
82
    ( PackageDescription(..), GenericPackageDescription(..)
83
    , Library(..), hasLibs, Executable(..), BuildInfo(..)
84 85
    , HookedBuildInfo, updatePackageDescription, allBuildInfo
    , FlagName(..) )
86
import Distribution.PackageDescription.Configuration
87
    ( finalizePackageDescription )
88
import Distribution.PackageDescription.Check
89 90
    ( PackageCheck(..)
    , checkPackage, checkConfiguredPackage, checkPackageFiles )
91
import Distribution.Simple.Program
92
    ( Program(..), ProgramLocation(..), ConfiguredProgram(..)
Duncan Coutts's avatar
Duncan Coutts committed
93
    , ProgramConfiguration, defaultProgramConfiguration
94
    , configureAllKnownPrograms, knownPrograms, lookupKnownProgram
95
    , userSpecifyArgss, userSpecifyPaths
96
    , lookupProgram, requireProgram, pkgConfigProgram, gccProgram
97
    , rawSystemProgramStdoutConf )
98
import Distribution.Simple.Setup
99
    ( ConfigFlags(..), CopyDest(..), fromFlag, fromFlagOrDefault, flagToMaybe )
100
import Distribution.Simple.InstallDirs
101
    ( InstallDirs(..), defaultInstallDirs, combineInstallDirs )
102
import Distribution.Simple.LocalBuildInfo
103
    ( LocalBuildInfo(..), ComponentLocalBuildInfo(..)
104
    , absoluteInstallDirs, prefixRelativeInstallDirs, isInternalPackage )
105
import Distribution.Simple.Utils
106
    ( die, warn, info, setupMessage, createDirectoryIfMissingVerbose
107
    , intercalate, comparing, cabalVersion, cabalBootstrapping
108 109
    , withFileContents, writeFileAtomic 
    , withTempFile )
110 111 112
import Distribution.Simple.Register
    ( removeInstalledConfig )
import Distribution.System
113
    ( OS(..), buildOS, buildArch )
114
import Distribution.Version
115
    ( Version(..), orLaterVersion, withinRange, isSpecificVersion, isAnyVersion
116
    , LowerBound(..), asVersionIntervals, simplifyVersionRange )
117
import Distribution.Verbosity
118
    ( Verbosity, lessVerbose )
119

120 121
import qualified Distribution.Simple.GHC  as GHC
import qualified Distribution.Simple.JHC  as JHC
David Himmelstrup's avatar
David Himmelstrup committed
122
import qualified Distribution.Simple.LHC  as LHC
123 124 125
import qualified Distribution.Simple.NHC  as NHC
import qualified Distribution.Simple.Hugs as Hugs

126
import Control.Monad
127
    ( when, unless, foldM, filterM )
128
import Data.List
129
    ( nub, partition, isPrefixOf, maximumBy, inits )
130
import Data.Maybe
131
    ( fromMaybe, isNothing )
132 133
import Data.Monoid
    ( Monoid(..) )
134
import System.Directory
135
    ( doesFileExist, getModificationTime, createDirectoryIfMissing, getTemporaryDirectory )
136 137 138
import System.Exit
    ( ExitCode(..), exitWith )
import System.FilePath
139
    ( (</>), isAbsolute )
140
import qualified System.Info
141
    ( compilerName, compilerVersion )
142
import System.IO
143
    ( hPutStrLn, stderr, hClose )
144
import Distribution.Text
145
    ( Text(disp), display, simpleParse )
146 147
import Text.PrettyPrint.HughesPJ
    ( comma, punctuate, render, nest, sep )
148
import Distribution.Compat.Exception ( catchExit, catchIO )
149

150
import Prelude hiding (catch)
151

152 153
tryGetConfigStateFile :: (Read a) => FilePath -> IO (Either String a)
tryGetConfigStateFile filename = do
154 155 156
  exists <- doesFileExist filename
  if not exists
    then return (Left missing)
157 158
    else withFileContents filename $ \str ->
      case lines str of
159
        [headder, rest] -> case checkHeader headder of
160
          Just msg -> return (Left msg)
161
          Nothing  -> case reads rest of
162 163 164
            [(bi,_)] -> return (Right bi)
            _        -> return (Left cantParse)
        _            -> return (Left cantParse)
165 166 167
  where
    checkHeader :: String -> Maybe String
    checkHeader header = case parseHeader header of
168
      Just (cabalId, compId)
169 170
        | cabalId
       == currentCabalId -> Nothing
171
        | otherwise      -> Just (badVersion cabalId compId)
172 173 174 175 176
      Nothing            -> Just cantParse

    missing   = "Run the 'configure' command first."
    cantParse = "Saved package config file seems to be corrupt. "
             ++ "Try re-running the 'configure' command."
177
    badVersion cabalId compId
178 179
              = "You need to re-run the 'configure' command. "
             ++ "The version of Cabal being used has changed (was "
180 181
             ++ display cabalId ++ ", now "
             ++ display currentCabalId ++ ")."
182 183 184
             ++ badcompiler compId
    badcompiler compId | compId == currentCompilerId = ""
                       | otherwise
185
              = " Additionally the compiler is different (was "
186
             ++ display compId ++ ", now "
187
             ++ display currentCompilerId
188
             ++ ") which is probably the cause of the problem."
189

190
-- internal function
191 192 193
tryGetPersistBuildConfig :: FilePath -> IO (Either String LocalBuildInfo)
tryGetPersistBuildConfig distPref
    = tryGetConfigStateFile (localBuildInfoFile distPref)
194

195 196 197
-- |Read the 'localBuildInfoFile'.  Error if it doesn't exist.  Also
-- fail if the file containing LocalBuildInfo is older than the .cabal
-- file, indicating that a re-configure is required.
198 199 200
getPersistBuildConfig :: FilePath -> IO LocalBuildInfo
getPersistBuildConfig distPref = do
  lbi <- tryGetPersistBuildConfig distPref
201 202
  either die return lbi

ijones's avatar
ijones committed
203
-- |Try to read the 'localBuildInfoFile'.
204 205 206
maybeGetPersistBuildConfig :: FilePath -> IO (Maybe LocalBuildInfo)
maybeGetPersistBuildConfig distPref = do
  lbi <- tryGetPersistBuildConfig distPref
207
  return $ either (const Nothing) Just lbi
ijones's avatar
ijones committed
208

ijones's avatar
ijones committed
209 210
-- |After running configure, output the 'LocalBuildInfo' to the
-- 'localBuildInfoFile'.
211 212
writePersistBuildConfig :: FilePath -> LocalBuildInfo -> IO ()
writePersistBuildConfig distPref lbi = do
Ross Paterson's avatar
Ross Paterson committed
213
  createDirectoryIfMissing False distPref
214 215
  writeFileAtomic (localBuildInfoFile distPref)
                  (showHeader pkgid ++ '\n' : show lbi)
216 217 218 219 220
  where
    pkgid   = packageId (localPkgDescr lbi)

showHeader :: PackageIdentifier -> String
showHeader pkgid =
221 222 223
     "Saved package config for " ++ display pkgid
  ++ " written by " ++ display currentCabalId
  ++      " using " ++ display currentCompilerId
224 225 226
  where

currentCabalId :: PackageIdentifier
Duncan Coutts's avatar
Duncan Coutts committed
227
currentCabalId = PackageIdentifier (PackageName "Cabal") currentVersion
228 229 230 231
  where currentVersion | cabalBootstrapping = Version [0] []
                       | otherwise          = cabalVersion

currentCompilerId :: PackageIdentifier
Duncan Coutts's avatar
Duncan Coutts committed
232
currentCompilerId = PackageIdentifier (PackageName System.Info.compilerName)
233 234
                                      System.Info.compilerVersion

235
parseHeader :: String -> Maybe (PackageIdentifier, PackageIdentifier)
236 237 238
parseHeader header = case words header of
  ["Saved", "package", "config", "for", pkgid,
   "written", "by", cabalid, "using", compilerid]
239 240 241
    -> case (simpleParse pkgid :: Maybe PackageIdentifier,
             simpleParse cabalid,
             simpleParse compilerid) of
242 243 244 245 246
        (Just _,
         Just cabalid',
         Just compilerid') -> Just (cabalid', compilerid')
        _                  -> Nothing
  _                        -> Nothing
247

248 249
-- |Check that localBuildInfoFile is up-to-date with respect to the
-- .cabal file.
250 251
checkPersistBuildConfig :: FilePath -> FilePath -> IO ()
checkPersistBuildConfig distPref pkg_descr_file = do
252
  t0 <- getModificationTime pkg_descr_file
253
  t1 <- getModificationTime $ localBuildInfoFile distPref
254 255 256
  when (t0 > t1) $
    die (pkg_descr_file ++ " has been changed, please re-configure.")

Ross Paterson's avatar
Ross Paterson committed
257
-- |@dist\/setup-config@
258 259
localBuildInfoFile :: FilePath -> FilePath
localBuildInfoFile distPref = distPref </> "setup-config"
ijones's avatar
ijones committed
260

261
-- -----------------------------------------------------------------------------
ijones's avatar
ijones committed
262 263
-- * Configuration
-- -----------------------------------------------------------------------------
264

265 266
-- |Perform the \"@.\/setup configure@\" action.
-- Returns the @.setup-config@ file.
267
configure :: ( Either GenericPackageDescription PackageDescription
268
             , HookedBuildInfo)
269
          -> ConfigFlags -> IO LocalBuildInfo
Duncan Coutts's avatar
Duncan Coutts committed
270
configure (e_pkg_descr, pbi) cfg
271 272
  = do  let distPref = fromFlag (configDistPref cfg)
            verbosity = fromFlag (configVerbosity cfg)
Duncan Coutts's avatar
Duncan Coutts committed
273
            pkg_descr0 = either packageDescription id e_pkg_descr
274

Duncan Coutts's avatar
Duncan Coutts committed
275
        setupMessage verbosity "Configuring" (packageId pkg_descr0)
276

277
        createDirectoryIfMissingVerbose (lessVerbose verbosity) True distPref
278

279 280 281
        let programsConfig = userSpecifyArgss (configProgramArgs cfg)
                           . userSpecifyPaths (configProgramPaths cfg)
                           $ configPrograms cfg
282
            userInstall = fromFlag (configUserInstall cfg)
283 284
            packageDbs = implicitPackageDbStack userInstall
                           (flagToMaybe $ configPackageDB cfg)
285

286 287
        -- detect compiler
        (comp, programsConfig') <- configCompiler
288 289 290
          (flagToMaybe $ configHcFlavor cfg)
          (flagToMaybe $ configHcPath cfg) (flagToMaybe $ configHcPkg cfg)
          programsConfig (lessVerbose verbosity)
291 292
        let version = compilerVersion comp
            flavor  = compilerFlavor comp
293

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
        -- | Create a PackageIndex that makes *any libraries that might be*
        -- defined internally to this package look like installed packages, in
        -- case an executable should refer to any of them as dependencies.
        --
        -- It must be *any libraries that might be* defined rather than the
        -- actual definitions, because these depend on conditionals in the .cabal
        -- file, and we haven't resolved them yet.  finalizePackageDescription
        -- does the resolution of conditionals, and it takes internalPackageSet
        -- as part of its input.
        --
        -- Currently a package can define no more than one library (which has
        -- the same name as the package) but we could extend this later.
        -- If we later allowed private internal libraries, then here we would
        -- need to pre-scan the conditional data to make a list of all private
        -- libraries that could possibly be defined by the .cabal file.
        let internalPackageSet = PackageIndex.fromList [ emptyInstalledPackageInfo {
                  Installed.package = package pkg_descr0
              } ]
        maybeInstalledPackageSet <- getInstalledPackages (lessVerbose verbosity) comp
313
                                      packageDbs programsConfig'
314 315 316
        -- The merge of the internal and installed packages
        let maybePackageSet = (`PackageIndex.merge` internalPackageSet)
                                                    `fmap` maybeInstalledPackageSet
317

Duncan Coutts's avatar
Duncan Coutts committed
318
        (pkg_descr0', flags) <- case e_pkg_descr of
319 320
            Left ppd ->
                case finalizePackageDescription
321
                       (configConfigurationsFlags cfg)
322
                       maybePackageSet
323
                       Distribution.System.buildOS
324
                       Distribution.System.buildArch
325
                       (compilerId comp)
326
                       (configConstraints cfg)
327 328
                       ppd
                of Right r -> return r
329
                   Left missing ->
330
                       die $ "At least the following dependencies are missing:\n"
331 332 333 334
                         ++ (render . nest 4 . sep . punctuate comma)
                            [ disp (Dependency name range')
                            | Dependency name range <- missing
                            , let range' = simplifyVersionRange range ]
335
            Right pd -> return (pd,[])
336

337 338 339
        -- add extra include/lib dirs as specified in cfg
        -- we do it here so that those get checked too
        let pkg_descr = addExtraIncludeLibDirs pkg_descr0'
340

341
        when (not (null flags)) $
342 343 344
          info verbosity $ "Flags chosen: "
                        ++ intercalate ", " [ name ++ "=" ++ display value
                                            | (FlagName name, value) <- flags ]
345

346
        checkPackageProblems verbosity
Duncan Coutts's avatar
Duncan Coutts committed
347
          (either Just (\_->Nothing) e_pkg_descr) --TODO: make the Either go away
348
          (updatePackageDescription pbi pkg_descr)
349

350 351
        let installedPackageSet = fromMaybe bogusPackageSet maybeInstalledPackageSet
            packageSet          = fromMaybe bogusPackageSet maybePackageSet
352 353 354 355 356 357 358
            -- FIXME: For Hugs, nhc98 and other compilers we do not know what
            -- packages are already installed, so we just make some up, pretend
            -- that they do exist and just hope for the best. We make them up
            -- based on what other package the package we're currently building
            -- happens to depend on. See 'inventBogusPackageId' below.
            -- Let's hope they really are installed... :-)
            bogusDependencies = map inventBogusPackageId (buildDepends pkg_descr)
359
            bogusPackageSet = PackageIndex.fromList
360
              [ emptyInstalledPackageInfo {
361
                  Installed.package = bogusPackageId
362 363 364
                  -- note that these bogus packages have no other dependencies
                }
              | bogusPackageId <- bogusDependencies ]
365 366 367 368
        allPkgDeps <- case flavor of
          GHC -> mapM (configDependency verbosity internalPackageSet installedPackageSet) (buildDepends pkg_descr)
          JHC -> mapM (configDependency verbosity internalPackageSet installedPackageSet) (buildDepends pkg_descr)
          LHC -> mapM (configDependency verbosity internalPackageSet installedPackageSet) (buildDepends pkg_descr)
369
          _   -> return bogusDependencies
Simon Marlow's avatar
Simon Marlow committed
370

371 372 373 374 375 376 377 378
        let (internalPkgDeps, externalPkgDeps) = partition (isInternalPackage pkg_descr) allPkgDeps

        when (not (null internalPkgDeps)) $
            die $ "The field 'build-depends: "
               ++ intercalate ", " (map (display . packageName) internalPkgDeps)
               ++ "' refers to a library which defined within the same "
               ++ "package. This feature is not yet supported."

379
        packageDependsIndex <-
380
          case PackageIndex.dependencyClosure packageSet externalPkgDeps of
381 382 383
            Left packageDependsIndex -> return packageDependsIndex
            Right broken ->
              die $ "The following installed packages are broken because other"
384 385
                 ++ " packages they depend on are missing. These broken "
                 ++ "packages must be rebuilt before they can be used.\n"
386
                 ++ unlines [ "package "
387
                           ++ display (packageId pkg)
388
                           ++ " is broken due to missing package "
389
                           ++ intercalate ", " (map display deps)
390 391
                            | (pkg, deps) <- broken ]

392
        let pseudoTopPkg = emptyInstalledPackageInfo {
393
                Installed.package = packageId pkg_descr,
394
                Installed.depends = allPkgDeps
395
              }
396 397
        case PackageIndex.dependencyInconsistencies
           . PackageIndex.insert pseudoTopPkg
398
           $ packageDependsIndex of
399 400 401
          [] -> return ()
          inconsistencies ->
            warn verbosity $
402
                 "This package indirectly depends on multiple versions of the same "
403
              ++ "package. This is highly likely to cause a compile failure.\n"
404 405
              ++ unlines [ "package " ++ display pkg ++ " requires "
                        ++ display (PackageIdentifier name ver)
406 407
                         | (name, uses) <- inconsistencies
                         , (pkg, ver) <- uses ]
Simon Marlow's avatar
Simon Marlow committed
408

409
        removeInstalledConfig distPref
Simon Marlow's avatar
Simon Marlow committed
410

411 412 413
        -- installation directories
        defaultDirs <- defaultInstallDirs flavor userInstall (hasLibs pkg_descr)
        let installDirs = combineInstallDirs fromFlagOrDefault
414
                            defaultDirs (configInstallDirs cfg)
415

416
        -- check extensions
417
        let extlist = nub $ concatMap extensions (allBuildInfo pkg_descr)
418
        let exts = unsupportedExtensions comp extlist
419
        unless (null exts) $ warn verbosity $ -- Just warn, FIXME: Should this be an error?
420
            display flavor ++ " does not support the following extensions: " ++
421
            intercalate ", " (map display exts)
422

423
        let requiredBuildTools = concatMap buildTools (allBuildInfo pkg_descr)
424 425
        programsConfig'' <-
              configureAllKnownPrograms (lessVerbose verbosity) programsConfig'
426
          >>= configureRequiredPrograms verbosity requiredBuildTools
427

428 429
        (pkg_descr', programsConfig''') <- configurePkgconfigPackages verbosity
                                            pkg_descr programsConfig''
430

431 432 433 434 435 436
        split_objs <-
           if not (fromFlag $ configSplitObjs cfg)
                then return False
                else case flavor of
                            GHC | version >= Version [6,5] [] -> return True
                            _ -> do warn verbosity
Ian Lynagh's avatar
Ian Lynagh committed
437
                                         ("this compiler does not support " ++
438 439 440
                                          "--enable-split-objs; ignoring")
                                    return False

441
        -- The allPkgDeps contains all the package deps for the whole package
442 443 444 445 446 447 448 449 450
        -- but we need to select the subset for this specific component.
        -- we just take the subset for the package names this component
        -- needs. Note, this only works because we cannot yet depend on two
        -- versions of the same package.
        let configLib lib = configComponent (libBuildInfo lib)
            configExe exe = (exeName exe, configComponent(buildInfo exe))
            configComponent bi = ComponentLocalBuildInfo {
              componentPackageDeps =
                if newPackageDepsBehaviour pkg_descr'
451 452
                  then selectDependencies bi allPkgDeps
                  else allPkgDeps
453 454 455 456 457 458 459
            }
            selectDependencies :: BuildInfo -> [PackageId] -> [PackageId]
            selectDependencies bi pkgs =
                [ pkg | pkg <- pkgs, packageName pkg `elem` names ]
              where
                names = [ name | Dependency name _ <- targetBuildDepends bi ]

460 461 462 463 464
        let lbi = LocalBuildInfo{
                    installDirTemplates = installDirs,
                    compiler            = comp,
                    buildDir            = distPref </> "build",
                    scratchDir          = fromFlagOrDefault
465 466
                                            (distPref </> "scratch")
                                            (configScratchDir cfg),
467 468
                    libraryConfig       = configLib `fmap` library pkg_descr',
                    executableConfigs   = configExe `fmap` executables pkg_descr',
469
                    installedPkgs       = packageDependsIndex,
470
                    pkgDescrFile        = Nothing,
471 472 473 474 475 476 477 478 479
                    localPkgDescr       = pkg_descr',
                    withPrograms        = programsConfig''',
                    withVanillaLib      = fromFlag $ configVanillaLib cfg,
                    withProfLib         = fromFlag $ configProfLib cfg,
                    withSharedLib       = fromFlag $ configSharedLib cfg,
                    withProfExe         = fromFlag $ configProfExe cfg,
                    withOptimization    = fromFlag $ configOptimization cfg,
                    withGHCiLib         = fromFlag $ configGHCiLib cfg,
                    splitObjs           = split_objs,
480
                    stripExes           = fromFlag $ configStripExes cfg,
481
                    withPackageDB       = packageDbs,
482 483
                    progPrefix          = fromFlag $ configProgPrefix cfg,
                    progSuffix          = fromFlag $ configProgSuffix cfg
Duncan Coutts's avatar
Duncan Coutts committed
484
                  }
ijones's avatar
ijones committed
485

486 487
        let dirs = absoluteInstallDirs (packageId pkg_descr) lbi NoCopyDest
            relative = prefixRelativeInstallDirs (packageId pkg_descr) lbi
488

489 490 491
        unless (isAbsolute (prefix dirs)) $ die $
            "expected an absolute directory name for --prefix: " ++ prefix dirs

492 493
        info verbosity $ "Using " ++ display currentCabalId
                      ++ " compiled by " ++ display currentCompilerId
494 495
        info verbosity $ "Using compiler: " ++ showCompilerId comp
        info verbosity $ "Using install prefix: " ++ prefix dirs
496

497 498
        let dirinfo name dir isPrefixRelative =
              info verbosity $ name ++ " installed in: " ++ dir ++ relNote
499 500 501 502 503
              where relNote = case buildOS of
                      Windows | not (hasLibs pkg_descr)
                             && isNothing isPrefixRelative
                             -> "  (fixed location)"
                      _      -> ""
504

505 506 507 508 509 510 511
        dirinfo "Binaries"         (bindir dirs)     (bindir relative)
        dirinfo "Libraries"        (libdir dirs)     (libdir relative)
        dirinfo "Private binaries" (libexecdir dirs) (libexecdir relative)
        dirinfo "Data files"       (datadir dirs)    (datadir relative)
        dirinfo "Documentation"    (docdir dirs)     (docdir relative)

        sequence_ [ reportProgram verbosity prog configuredProg
512
                  | (prog, configuredProg) <- knownPrograms programsConfig''' ]
513

514
        return lbi
515

516 517 518
    where
      addExtraIncludeLibDirs pkg_descr =
          let extraBi = mempty { extraLibDirs = configExtraLibDirs cfg
Malcolm.Wallace's avatar
Malcolm.Wallace committed
519
                               , PD.includeDirs = configExtraIncludeDirs cfg}
520 521 522 523
              modifyLib l        = l{ libBuildInfo = libBuildInfo l `mappend` extraBi }
              modifyExecutable e = e{ buildInfo    = buildInfo e    `mappend` extraBi}
          in pkg_descr{ library     = modifyLib        `fmap` library pkg_descr
                      , executables = modifyExecutable  `map` executables pkg_descr}
524 525


526 527 528
-- -----------------------------------------------------------------------------
-- Configuring package dependencies

ijones's avatar
ijones committed
529 530
-- |Converts build dependencies to a versioned dependency.  only sets
-- version information for exact versioned dependencies.
531
inventBogusPackageId :: Dependency -> PackageIdentifier
Duncan Coutts's avatar
Duncan Coutts committed
532 533 534 535 536
inventBogusPackageId (Dependency s vr) = case isSpecificVersion vr of
  -- if they specify the exact version, use that:
  Just v -> PackageIdentifier s v
  -- otherwise, just set it to empty
  Nothing -> PackageIdentifier s (Version [] [])
ijones's avatar
ijones committed
537

538 539 540 541 542
reportProgram :: Verbosity -> Program -> Maybe ConfiguredProgram -> IO ()
reportProgram verbosity prog Nothing
    = info verbosity $ "No " ++ programName prog ++ " found"
reportProgram verbosity prog (Just configuredProg)
    = info verbosity $ "Using " ++ programName prog ++ version ++ location
543 544 545 546 547
    where location = case programLocation configuredProg of
            FoundOnSystem p -> " found on system at: " ++ p
            UserSpecified p -> " given by user at: " ++ p
          version = case programVersion configuredProg of
            Nothing -> ""
548
            Just v  -> " version " ++ display v
ijones's avatar
ijones committed
549

550 551
hackageUrl :: String
hackageUrl = "http://hackage.haskell.org/cgi-bin/hackage-scripts/package/"
552

ijones's avatar
ijones committed
553
-- | Test for a package dependency and record the version we have installed.
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
configDependency :: Verbosity
                 -> PackageIndex InstalledPackageInfo  -- ^ Internally defined packages
                 -> PackageIndex InstalledPackageInfo  -- ^ Installed packages
                 -> Dependency
                 -> IO PackageIdentifier
configDependency verbosity internalIndex installedIndex dep@(Dependency pkgname _) =
  -- If the dependency specification matches anything in the internal package
  -- index, then we prefer that match to anything in the second.
  -- For example:
  --
  -- Name: MyLibrary
  -- Version: 0.1
  -- Library
  --     ..
  -- Executable my-exec
  --     build-depends: MyLibrary
  --
  -- We want "build-depends: MyLibrary" always to match the internal library
  -- even if there is a newer installed library "MyLibrary-0.2".
  -- However, "build-depends: MyLibrary >= 0.2" should match the installed one.
  case PackageIndex.lookupDependency internalIndex dep
                       `inPreferenceTo`
                   PackageIndex.lookupDependency installedIndex dep of
577
        [] -> die $ "cannot satisfy dependency "
Duncan Coutts's avatar
Duncan Coutts committed
578
                      ++ display dep ++ "\n"
Duncan Coutts's avatar
Duncan Coutts committed
579
                      ++ "Perhaps you need to download and install it from\n"
Duncan Coutts's avatar
Duncan Coutts committed
580
                      ++ hackageUrl ++ display pkgname ++ "?"
581
        pkgs -> do let pkgid = maximumBy (comparing packageVersion) (map packageId pkgs)
Duncan Coutts's avatar
Duncan Coutts committed
582
                   info verbosity $ "Dependency " ++ display dep
583
                                ++ ": using " ++ display pkgid
584
                   return pkgid
585 586 587 588 589 590
  where
    -- If there are any matches in the first set, return them, otherwise return
    -- the second set.
    inPreferenceTo :: [a] -> [a] -> [a]
    inPreferenceTo [] second = second
    inPreferenceTo first _   = first
ijones's avatar
ijones committed
591

592 593
getInstalledPackages :: Verbosity -> Compiler
                     -> PackageDBStack -> ProgramConfiguration
594
                     -> IO (Maybe (PackageIndex InstalledPackageInfo))
595
getInstalledPackages verbosity comp packageDBs progconf = do
596
  info verbosity "Reading installed packages..."
597
  case compilerFlavor comp of
598 599 600
    GHC -> Just `fmap` GHC.getInstalledPackages verbosity packageDBs progconf
    JHC -> Just `fmap` JHC.getInstalledPackages verbosity packageDBs progconf
    LHC -> Just `fmap` LHC.getInstalledPackages verbosity packageDBs progconf
601
    _   -> return Nothing
ekarttun's avatar
ekarttun committed
602

603 604 605 606 607
-- | Currently the user interface specifies the package dbs to use with just a
-- single valued option, a 'PackageDB'. However internally we represent the
-- stack of 'PackageDB's explictly as a list. This function converts encodes
-- the package db stack implicit in a single packagedb.
--
608 609 610 611 612 613 614 615
implicitPackageDbStack :: Bool -> Maybe PackageDB -> PackageDBStack
implicitPackageDbStack userInstall maybePackageDB
  | userInstall = GlobalPackageDB : UserPackageDB : extra
  | otherwise   = GlobalPackageDB : extra
  where
    extra = case maybePackageDB of
      Just (SpecificPackageDB db) -> [SpecificPackageDB db]
      _                           -> []
616

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
newPackageDepsBehaviourMinVersion :: Version
newPackageDepsBehaviourMinVersion = Version { versionBranch = [1,7,1], versionTags = [] }

-- In older cabal versions, there was only one set of package dependencies for
-- the whole package. In this version, we can have separate dependencies per
-- target, but we only enable this behaviour if the minimum cabal version
-- specified is >= a certain minimum. Otherwise, for compatibility we use the
-- old behaviour.
newPackageDepsBehaviour :: PackageDescription -> Bool
newPackageDepsBehaviour pkg_descr =
   minVersionRequired >= newPackageDepsBehaviourMinVersion
  where
    minVersionRequired =
      case asVersionIntervals (descCabalVersion pkg_descr) of
        []                      -> Version [0] []
        ((LowerBound v _, _):_) -> v

634 635 636 637 638 639 640 641
-- -----------------------------------------------------------------------------
-- Configuring program dependencies

configureRequiredPrograms :: Verbosity -> [Dependency] -> ProgramConfiguration -> IO ProgramConfiguration
configureRequiredPrograms verbosity deps conf =
  foldM (configureRequiredProgram verbosity) conf deps

configureRequiredProgram :: Verbosity -> ProgramConfiguration -> Dependency -> IO ProgramConfiguration
Duncan Coutts's avatar
Duncan Coutts committed
642
configureRequiredProgram verbosity conf (Dependency (PackageName progName) verRange) =
643
  case lookupKnownProgram progName conf of
Duncan Coutts's avatar
Duncan Coutts committed
644
    Nothing -> die ("Unknown build tool " ++ progName)
645 646
    Just prog -> snd `fmap` requireProgram verbosity prog verRange conf

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
-- -----------------------------------------------------------------------------
-- Configuring pkg-config package dependencies

configurePkgconfigPackages :: Verbosity -> PackageDescription
                           -> ProgramConfiguration
                           -> IO (PackageDescription, ProgramConfiguration)
configurePkgconfigPackages verbosity pkg_descr conf
  | null allpkgs = return (pkg_descr, conf)
  | otherwise    = do
    (_, conf') <- requireProgram (lessVerbose verbosity) pkgConfigProgram
                    (orLaterVersion $ Version [0,9,0] []) conf
    mapM_ requirePkg allpkgs
    lib'  <- updateLibrary (library pkg_descr)
    exes' <- mapM updateExecutable (executables pkg_descr)
    let pkg_descr' = pkg_descr { library = lib', executables = exes' }
    return (pkg_descr', conf')
663 664

  where
665 666 667 668
    allpkgs = concatMap pkgconfigDepends (allBuildInfo pkg_descr)
    pkgconfig = rawSystemProgramStdoutConf (lessVerbose verbosity)
                  pkgConfigProgram conf

Duncan Coutts's avatar
Duncan Coutts committed
669
    requirePkg dep@(Dependency (PackageName pkg) range) = do
670
      version <- pkgconfig ["--modversion", pkg]
671 672
                 `catchIO`   (\_ -> die notFound)
                 `catchExit` (\_ -> die notFound)
673
      case simpleParse version of
674 675
        Nothing -> die "parsing output of pkg-config --modversion failed"
        Just v | not (withinRange v range) -> die (badVersion v)
676
               | otherwise                 -> info verbosity (depSatisfied v)
677
      where
678 679 680 681
        notFound     = "The pkg-config package " ++ pkg ++ versionRequirement
                    ++ " is required but it could not be found."
        badVersion v = "The pkg-config package " ++ pkg ++ versionRequirement
                    ++ " is required but the version installed on the"
682
                    ++ " system is version " ++ display v
Duncan Coutts's avatar
Duncan Coutts committed
683
        depSatisfied v = "Dependency " ++ display dep
684
                      ++ ": using version " ++ display v
685 686

        versionRequirement
Duncan Coutts's avatar
Duncan Coutts committed
687 688
          | isAnyVersion range = ""
          | otherwise          = " version " ++ display range
689 690 691

    updateLibrary Nothing    = return Nothing
    updateLibrary (Just lib) = do
692
      bi <- pkgconfigBuildInfo (pkgconfigDepends (libBuildInfo lib))
693
      return $ Just lib { libBuildInfo = libBuildInfo lib `mappend` bi }
694 695

    updateExecutable exe = do
696
      bi <- pkgconfigBuildInfo (pkgconfigDepends (buildInfo exe))
697
      return exe { buildInfo = buildInfo exe `mappend` bi }
698 699

    pkgconfigBuildInfo :: [Dependency] -> IO BuildInfo
700 701 702
    pkgconfigBuildInfo []      = return mempty
    pkgconfigBuildInfo pkgdeps = do
      let pkgs = nub [ display pkg | Dependency pkg _ <- pkgdeps ]
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
      ccflags <- pkgconfig ("--cflags" : pkgs)
      ldflags <- pkgconfig ("--libs"   : pkgs)
      return (ccLdOptionsBuildInfo (words ccflags) (words ldflags))

-- | Makes a 'BuildInfo' from C compiler and linker flags.
--
-- This can be used with the output from configuration programs like pkg-config
-- and similar package-specific programs like mysql-config, freealut-config etc.
-- For example:
--
-- > ccflags <- rawSystemProgramStdoutConf verbosity prog conf ["--cflags"]
-- > ldflags <- rawSystemProgramStdoutConf verbosity prog conf ["--libs"]
-- > return (ccldOptionsBuildInfo (words ccflags) (words ldflags))
--
ccLdOptionsBuildInfo :: [String] -> [String] -> BuildInfo
ccLdOptionsBuildInfo cflags ldflags =
  let (includeDirs',  cflags')   = partition ("-I" `isPrefixOf`) cflags
      (extraLibs',    ldflags')  = partition ("-l" `isPrefixOf`) ldflags
      (extraLibDirs', ldflags'') = partition ("-L" `isPrefixOf`) ldflags'
722
  in mempty {
723 724 725 726 727
       PD.includeDirs  = map (drop 2) includeDirs',
       PD.extraLibs    = map (drop 2) extraLibs',
       PD.extraLibDirs = map (drop 2) extraLibDirs',
       PD.ccOptions    = cflags',
       PD.ldOptions    = ldflags''
728
     }
729

730 731 732
-- -----------------------------------------------------------------------------
-- Determining the compiler details

733
configCompilerAux :: ConfigFlags -> IO (Compiler, ProgramConfiguration)
734 735 736
configCompilerAux cfg = configCompiler (flagToMaybe $ configHcFlavor cfg)
                                       (flagToMaybe $ configHcPath cfg)
                                       (flagToMaybe $ configHcPkg cfg)
737
                                       programsConfig
738
                                       (fromFlag (configVerbosity cfg))
739 740 741 742
  where
    programsConfig = userSpecifyArgss (configProgramArgs cfg)
                   . userSpecifyPaths (configProgramPaths cfg)
                   $ defaultProgramConfiguration
743

744
configCompiler :: Maybe CompilerFlavor -> Maybe FilePath -> Maybe FilePath
745 746 747 748 749 750 751
               -> ProgramConfiguration -> Verbosity
               -> IO (Compiler, ProgramConfiguration)
configCompiler Nothing _ _ _ _ = die "Unknown compiler"
configCompiler (Just hcFlavor) hcPath hcPkg conf verbosity = do
  case hcFlavor of
      GHC  -> GHC.configure  verbosity hcPath hcPkg conf
      JHC  -> JHC.configure  verbosity hcPath hcPkg conf
David Himmelstrup's avatar
David Himmelstrup committed
752 753
      LHC  -> do (_,ghcConf) <- GHC.configure  verbosity Nothing hcPkg conf
                 LHC.configure  verbosity hcPath Nothing ghcConf
754 755
      Hugs -> Hugs.configure verbosity hcPath hcPkg conf
      NHC  -> NHC.configure  verbosity hcPath hcPkg conf
756
      _    -> die "Unknown compiler"
ekarttun's avatar
ekarttun committed
757

758

759 760
checkForeignDeps :: PackageDescription -> LocalBuildInfo -> Verbosity -> IO ()
checkForeignDeps pkg lbi verbosity = do
761
  ifBuildsWith allHeaders (commonCcArgs ++ makeLdArgs allLibs) -- I'm feeling lucky
762 763
           (return ())
           (do missingLibs <- findMissingLibs
764
               missingHdr  <- findOffendingHdr
765
               explainErrors missingHdr missingLibs)
766
      where
767 768 769 770 771 772 773 774
        allHeaders = collectField PD.includes
        allLibs    = collectField PD.extraLibs

        ifBuildsWith headers args success failure = do
            ok <- builds (makeProgram headers) args
            if ok then success else failure

        -- NOTE: if some package-local header has errors,
775 776
        -- we will report that this header is missing.
        -- Maybe additional tests for local headers are needed
777 778 779 780 781 782 783 784 785 786
        -- for better diagnostics
        findOffendingHdr =
            ifBuildsWith allHeaders cppArgs
                         (return Nothing)
                         (go . tail . inits $ allHeaders)
            where
              go [] = return Nothing       -- cannot happen
              go (hdrs:hdrsInits) = do
                    ifBuildsWith hdrs cppArgs
                                 (go hdrsInits)
787
                                 (return . Just . last $ hdrs)
788

789
              cppArgs = "-c":commonCcArgs -- don't try to link
790 791 792 793

        findMissingLibs = ifBuildsWith [] (makeLdArgs allLibs)
                                       (return [])
                                       (filterM (fmap not . libExists) allLibs)
794

795 796
        libExists lib = builds (makeProgram []) (makeLdArgs [lib])

797 798 799 800
        commonCcArgs  = programArgs gccProg
                     ++ hcDefines (compiler lbi)
                     ++ [ "-I" ++ dir | dir <- collectField PD.includeDirs ]
                     ++ ["-I."]
801 802
                     ++ collectField PD.cppOptions
                     ++ collectField PD.ccOptions
803 804 805 806 807 808