Configure.hs 15.1 KB
Newer Older
1
{-# LANGUAGE CPP #-}
2 3 4 5 6 7 8 9 10 11 12 13 14 15
-----------------------------------------------------------------------------
-- |
-- Module      :  Distribution.Client.Configure
-- Copyright   :  (c) David Himmelstrup 2005,
--                    Duncan Coutts 2005
-- License     :  BSD-like
--
-- Maintainer  :  cabal-devel@haskell.org
-- Portability :  portable
--
-- High level interface to configuring a package.
-----------------------------------------------------------------------------
module Distribution.Client.Configure (
    configure,
16
    configureSetupScript,
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
17
    chooseCabalVersion,
18
    checkConfigExFlags
19 20 21
  ) where

import Distribution.Client.Dependency
22
import Distribution.Client.Dependency.Types
23
         ( ConstraintSource(..)
24
         , LabeledPackageConstraint(..), showConstraintSource )
25 26 27
import qualified Distribution.Client.InstallPlan as InstallPlan
import Distribution.Client.InstallPlan (InstallPlan)
import Distribution.Client.IndexUtils as IndexUtils
28
         ( getSourcePackages, getInstalledPackages )
29
import Distribution.Client.PackageIndex ( PackageIndex, elemByPackageName )
30
import Distribution.Client.Setup
Edsko de Vries's avatar
Edsko de Vries committed
31 32
         ( ConfigExFlags(..), configureCommand, filterConfigureFlags
         , RepoContext(..) )
33
import Distribution.Client.Types as Source
34 35
import Distribution.Client.SetupWrapper
         ( setupWrapper, SetupScriptOptions(..), defaultSetupScriptOptions )
36
import Distribution.Client.Targets
37
         ( userToPackageConstraint, userConstraintPackageName )
38
import qualified Distribution.Client.ComponentDeps as CD
39 40
import Distribution.Package (PackageId)
import Distribution.Client.JobControl (Lock)
41 42

import Distribution.Simple.Compiler
43
         ( Compiler, CompilerInfo, compilerInfo, PackageDB(..), PackageDBStack )
44
import Distribution.Simple.Program (ProgramConfiguration )
45
import Distribution.Simple.Setup
46
         ( ConfigFlags(..), fromFlag, toFlag, flagToMaybe, fromFlagOrDefault )
47 48
import Distribution.Simple.PackageIndex
         ( InstalledPackageIndex, lookupPackageName )
49 50
import Distribution.Simple.Utils
         ( defaultPackageDesc )
51
import qualified Distribution.InstalledPackageInfo as Installed
52
import Distribution.Package
53
         ( Package(..), UnitId, packageName
54 55 56
         , Dependency(..), thisPackageVersion
         )
import qualified Distribution.PackageDescription as PkgDesc
57 58 59 60 61
import Distribution.PackageDescription.Parse
         ( readPackageDescription )
import Distribution.PackageDescription.Configuration
         ( finalizePackageDescription )
import Distribution.Version
62
         ( anyVersion, thisVersion )
63
import Distribution.Simple.Utils as Utils
64
         ( warn, notice, info, debug, die )
65
import Distribution.Simple.Setup
66
         ( isAllowNewer )
67
import Distribution.System
68
         ( Platform )
69
import Distribution.Text ( display )
70 71
import Distribution.Verbosity as Verbosity
         ( Verbosity )
72
import Distribution.Version
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
73
         ( Version(..), VersionRange, orLaterVersion )
74

75
import Control.Monad (unless)
76
#if !MIN_VERSION_base(4,8,0)
77
import Data.Monoid (Monoid(..))
78
#endif
79
import Data.Maybe (isJust, fromMaybe)
80

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
81 82
-- | Choose the Cabal version such that the setup scripts compiled against this
-- version will support the given command-line flags.
83 84
chooseCabalVersion :: ConfigFlags -> Maybe Version -> VersionRange
chooseCabalVersion configFlags maybeVersion =
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
85 86
  maybe defaultVersionRange thisVersion maybeVersion
  where
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
87 88
    -- Cabal < 1.19.2 doesn't support '--exact-configuration' which is needed
    -- for '--allow-newer' to work.
89
    allowNewer = isAllowNewer (configAllowNewer configFlags)
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
90 91 92 93 94

    defaultVersionRange = if allowNewer
                          then orLaterVersion (Version [1,19,2] [])
                          else anyVersion

95 96
-- | Configure the package found in the local directory
configure :: Verbosity
97
          -> PackageDBStack
Edsko de Vries's avatar
Edsko de Vries committed
98
          -> RepoContext
99
          -> Compiler
100
          -> Platform
101
          -> ProgramConfiguration
102
          -> ConfigFlags
103
          -> ConfigExFlags
104 105
          -> [String]
          -> IO ()
Edsko de Vries's avatar
Edsko de Vries committed
106
configure verbosity packageDBs repoCtxt comp platform conf
107 108
  configFlags configExFlags extraArgs = do

109
  installedPkgIndex <- getInstalledPackages verbosity comp packageDBs conf
Edsko de Vries's avatar
Edsko de Vries committed
110
  sourcePkgDb       <- getSourcePackages    verbosity repoCtxt
111 112
  checkConfigExFlags verbosity installedPkgIndex
                     (packageIndex sourcePkgDb) configExFlags
113

114
  progress <- planLocalPackage verbosity comp platform configFlags configExFlags
115
                               installedPkgIndex sourcePkgDb
116 117

  notice verbosity "Resolving dependencies..."
118 119
  maybePlan <- foldProgress logMsg (return . Left) (return . Right)
                            progress
120
  case maybePlan of
121
    Left message -> do
122 123 124 125
      info verbosity $
           "Warning: solver failed to find a solution:\n"
        ++ message
        ++ "Trying configure anyway."
126 127
      setupWrapper verbosity (setupScriptOptions installedPkgIndex Nothing)
        Nothing configureCommand (const configFlags) extraArgs
128 129

    Right installPlan -> case InstallPlan.ready installPlan of
130 131 132 133
      [pkg@(ReadyPackage
             (ConfiguredPackage (SourcePackage _ _ (LocalUnpackedPackage _) _)
                                 _ _ _)
             _)] -> do
134
        configurePackage verbosity
135
          platform (compilerInfo comp)
136
          (setupScriptOptions installedPkgIndex (Just pkg))
137 138 139 140 141 142
          configFlags pkg extraArgs

      _ -> die $ "internal error: configure install plan should have exactly "
              ++ "one local ready package."

  where
143
    setupScriptOptions :: InstalledPackageIndex
144
                       -> Maybe ReadyPackage
145
                       -> SetupScriptOptions
146 147 148 149 150 151 152 153 154 155
    setupScriptOptions =
      configureSetupScript
        packageDBs
        comp
        platform
        conf
        (fromFlagOrDefault
           (useDistPref defaultSetupScriptOptions)
           (configDistPref configFlags))
        (chooseCabalVersion
156
           configFlags
157 158 159
           (flagToMaybe (configCabalVersion configExFlags)))
        Nothing
        False
160

161 162
    logMsg message rest = debug verbosity message >> rest

163 164 165 166 167 168 169 170 171
configureSetupScript :: PackageDBStack
                     -> Compiler
                     -> Platform
                     -> ProgramConfiguration
                     -> FilePath
                     -> VersionRange
                     -> Maybe Lock
                     -> Bool
                     -> InstalledPackageIndex
172
                     -> Maybe ReadyPackage
173 174 175 176 177 178 179 180 181 182 183 184 185
                     -> SetupScriptOptions
configureSetupScript packageDBs
                     comp
                     platform
                     conf
                     distPref
                     cabalVersion
                     lock
                     forceExternal
                     index
                     mpkg
  = SetupScriptOptions {
      useCabalVersion   = cabalVersion
186
    , useCabalSpecVersion = Nothing
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
    , useCompiler       = Just comp
    , usePlatform       = Just platform
    , usePackageDB      = packageDBs'
    , usePackageIndex   = index'
    , useProgramConfig  = conf
    , useDistPref       = distPref
    , useLoggingHandle  = Nothing
    , useWorkingDir     = Nothing
    , setupCacheLock    = lock
    , useWin32CleanHack = False
    , forceExternalSetupMethod = forceExternal
      -- If we have explicit setup dependencies, list them; otherwise, we give
      -- the empty list of dependencies; ideally, we would fix the version of
      -- Cabal here, so that we no longer need the special case for that in
      -- `compileSetupExecutable` in `externalSetupMethod`, but we don't yet
      -- know the version of Cabal at this point, but only find this there.
      -- Therefore, for now, we just leave this blank.
    , useDependencies          = fromMaybe [] explicitSetupDeps
    , useDependenciesExclusive = isJust explicitSetupDeps
206
    , useVersionMacros         = isJust explicitSetupDeps
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
    }
  where
    -- When we are compiling a legacy setup script without an explicit
    -- setup stanza, we typically want to allow the UserPackageDB for
    -- finding the Cabal lib when compiling any Setup.hs even if we're doing
    -- a global install. However we also allow looking in a specific package
    -- db.
    packageDBs' :: PackageDBStack
    index'      :: Maybe InstalledPackageIndex
    (packageDBs', index') =
      case packageDBs of
        (GlobalPackageDB:dbs) | UserPackageDB `notElem` dbs
                              , Nothing <- explicitSetupDeps
            -> (GlobalPackageDB:UserPackageDB:dbs, Nothing)
        -- but if the user is using an odd db stack, don't touch it
        _otherwise -> (packageDBs, Just index)

224
    explicitSetupDeps :: Maybe [(UnitId, PackageId)]
225
    explicitSetupDeps = do
226 227
      ReadyPackage (ConfiguredPackage (SourcePackage _ gpkg _ _) _ _ _) deps
                 <- mpkg
228 229 230
      -- Check if there is an explicit setup stanza
      _buildInfo <- PkgDesc.setupBuildInfo (PkgDesc.packageDescription gpkg)
      -- Return the setup dependencies computed by the solver
231
      return [ ( Installed.installedUnitId deppkg
232 233 234 235 236
               , Installed.sourcePackageId    deppkg
               )
             | deppkg <- CD.setupDeps deps
             ]

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
-- | Warn if any constraints or preferences name packages that are not in the
-- source package index or installed package index.
checkConfigExFlags :: Package pkg
                   => Verbosity
                   -> InstalledPackageIndex
                   -> PackageIndex pkg
                   -> ConfigExFlags
                   -> IO ()
checkConfigExFlags verbosity installedPkgIndex sourcePkgIndex flags = do
  unless (null unknownConstraints) $ warn verbosity $
             "Constraint refers to an unknown package: "
          ++ showConstraint (head unknownConstraints)
  unless (null unknownPreferences) $ warn verbosity $
             "Preference refers to an unknown package: "
          ++ display (head unknownPreferences)
  where
    unknownConstraints = filter (unknown . userConstraintPackageName . fst) $
                         configExConstraints flags
    unknownPreferences = filter (unknown . \(Dependency name _) -> name) $
                         configPreferences flags
    unknown pkg = null (lookupPackageName installedPkgIndex pkg)
               && not (elemByPackageName sourcePkgIndex pkg)
    showConstraint (uc, src) =
        display uc ++ " (" ++ showConstraintSource src ++ ")"

262 263 264 265
-- | Make an 'InstallPlan' for the unpacked package in the current directory,
-- and all its dependencies.
--
planLocalPackage :: Verbosity -> Compiler
266
                 -> Platform
267
                 -> ConfigFlags -> ConfigExFlags
268
                 -> InstalledPackageIndex
269
                 -> SourcePackageDb
270
                 -> IO (Progress String String InstallPlan)
271 272
planLocalPackage verbosity comp platform configFlags configExFlags
  installedPkgIndex
273
  (SourcePackageDb _ packagePrefs) = do
274
  pkg <- readPackageDescription verbosity =<< defaultPackageDesc verbosity
275 276
  solver <- chooseSolver verbosity (fromFlag $ configSolver configExFlags)
            (compilerInfo comp)
277 278

  let -- We create a local package and ask to resolve a dependency on it
279 280 281
      localPkg = SourcePackage {
        packageInfoId             = packageId pkg,
        Source.packageDescription = pkg,
282 283
        packageSource             = LocalUnpackedPackage ".",
        packageDescrOverride      = Nothing
284
      }
285

286 287 288 289
      testsEnabled = fromFlagOrDefault False $ configTests configFlags
      benchmarksEnabled =
        fromFlagOrDefault False $ configBenchmarks configFlags

290
      resolverParams =
291
          removeUpperBounds (configAllowNewer configFlags)
292

293
        . addPreferences
294 295 296 297 298 299
            -- preferences from the config file or command line
            [ PackageVersionPreference name ver
            | Dependency name ver <- configPreferences configExFlags ]

        . addConstraints
            -- version constraints from the config file or command line
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
300 301
            -- TODO: should warn or error on constraints that are not on direct
            -- deps or flag constraints not on the package in question.
302
            [ LabeledPackageConstraint (userToPackageConstraint uc) src
303
            | (uc, src) <- configExConstraints configExFlags ]
304 305 306

        . addConstraints
            -- package flags from the config file or command line
307 308
            [ let pc = PackageConstraintFlags (packageName pkg)
                       (configConfigurationsFlags configFlags)
309 310
              in LabeledPackageConstraint pc ConstraintSourceConfigFlagOrTarget
            ]
311

312 313
        . addConstraints
            -- '--enable-tests' and '--enable-benchmarks' constraints from
314
            -- the config file or command line
315 316 317
            [ let pc = PackageConstraintStanzas (packageName pkg) $
                       [ TestStanzas  | testsEnabled ] ++
                       [ BenchStanzas | benchmarksEnabled ]
318
              in LabeledPackageConstraint pc ConstraintSourceConfigFlagOrTarget
319 320
            ]

321
        $ standardInstallPolicy
322 323
            installedPkgIndex
            (SourcePackageDb mempty packagePrefs)
324
            [SpecificSourcePackage localPkg]
325

326
  return (resolveDependencies platform (compilerInfo comp) solver resolverParams)
327

328

329
-- | Call an installer for an 'SourcePackage' but override the configure
330 331
-- flags with the ones given by the 'ReadyPackage'. In particular the
-- 'ReadyPackage' specifies an exact 'FlagAssignment' and exactly
332 333 334
-- versioned package dependencies. So we ignore any previous partial flag
-- assignment or dependency constraints and use the new ones.
--
335 336
-- NB: when updating this function, don't forget to also update
-- 'installReadyPackage' in D.C.Install.
337
configurePackage :: Verbosity
338
                 -> Platform -> CompilerInfo
339
                 -> SetupScriptOptions
340
                 -> ConfigFlags
341
                 -> ReadyPackage
342 343
                 -> [String]
                 -> IO ()
344
configurePackage verbosity platform comp scriptOptions configFlags
345 346 347 348
                 (ReadyPackage (ConfiguredPackage (SourcePackage _ gpkg _ _)
                                                  flags stanzas _)
                               deps)
                 extraArgs =
349 350 351 352 353 354

  setupWrapper verbosity
    scriptOptions (Just pkg) configureCommand configureFlags extraArgs

  where
    configureFlags   = filterConfigureFlags configFlags {
355
      configConfigurationsFlags = flags,
356 357 358 359
      -- We generate the legacy constraints as well as the new style precise
      -- deps.  In the end only one set gets passed to Setup.hs configure,
      -- depending on the Cabal version we are talking to.
      configConstraints  = [ thisPackageVersion (packageId deppkg)
360
                           | deppkg <- CD.nonSetupDeps deps ],
361
      configDependencies = [ (packageName (Installed.sourcePackageId deppkg),
362
                              Installed.installedUnitId deppkg)
363
                           | deppkg <- CD.nonSetupDeps deps ],
364 365
      -- Use '--exact-configuration' if supported.
      configExactConfiguration = toFlag True,
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
366 367 368
      configVerbosity          = toFlag verbosity,
      configBenchmarks         = toFlag (BenchStanzas `elem` stanzas),
      configTests              = toFlag (TestStanzas `elem` stanzas)
369 370 371
    }

    pkg = case finalizePackageDescription flags
372
           (const True)
373
           platform comp [] (enableStanzas stanzas gpkg) of
374
      Left _ -> error "finalizePackageDescription ReadyPackage failed"
375
      Right (desc, _) -> desc